ChibiOS/HAL  6.1.0
hal_crypto_lld.h
Go to the documentation of this file.
1 /*
2  ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
3 
4  Licensed under the Apache License, Version 2.0 (the "License");
5  you may not use this file except in compliance with the License.
6  You may obtain a copy of the License at
7 
8  http://www.apache.org/licenses/LICENSE-2.0
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 */
16 
17 /**
18  * @file hal_crypto_lld.h
19  * @brief PLATFORM cryptographic subsystem low level driver header.
20  *
21  * @addtogroup CRYPTO
22  * @{
23  */
24 
25 #ifndef HAL_CRYPTO_LLD_H
26 #define HAL_CRYPTO_LLD_H
27 
28 #if (HAL_USE_CRY == TRUE) || defined(__DOXYGEN__)
29 
30 /*===========================================================================*/
31 /* Driver constants. */
32 /*===========================================================================*/
33 
34 /**
35  * @name Driver capability switches
36  * @{
37  */
38 #define CRY_LLD_SUPPORTS_AES TRUE
39 #define CRY_LLD_SUPPORTS_AES_ECB TRUE
40 #define CRY_LLD_SUPPORTS_AES_CBC TRUE
41 #define CRY_LLD_SUPPORTS_AES_CFB TRUE
42 #define CRY_LLD_SUPPORTS_AES_CTR TRUE
43 #define CRY_LLD_SUPPORTS_AES_GCM TRUE
44 #define CRY_LLD_SUPPORTS_DES TRUE
45 #define CRY_LLD_SUPPORTS_DES_ECB TRUE
46 #define CRY_LLD_SUPPORTS_DES_CBC TRUE
47 #define CRY_LLD_SUPPORTS_SHA1 TRUE
48 #define CRY_LLD_SUPPORTS_SHA256 TRUE
49 #define CRY_LLD_SUPPORTS_SHA512 TRUE
50 #define CRY_LLD_SUPPORTS_TRNG TRUE
51 /** @{ */
52 
53 /*===========================================================================*/
54 /* Driver pre-compile time settings. */
55 /*===========================================================================*/
56 
57 /**
58  * @name PLATFORM configuration options
59  * @{
60  */
61 /**
62  * @brief CRY1 driver enable switch.
63  * @details If set to @p TRUE the support for CRY1 is included.
64  * @note The default is @p FALSE.
65  */
66 #if !defined(PLATFORM_CRY_USE_CRY1) || defined(__DOXYGEN__)
67 #define PLATFORM_CRY_USE_CRY1 FALSE
68 #endif
69 /** @} */
70 
71 /*===========================================================================*/
72 /* Derived constants and error checks. */
73 /*===========================================================================*/
74 
75 /*===========================================================================*/
76 /* Driver data structures and types. */
77 /*===========================================================================*/
78 
79 /**
80  * @brief CRY key identifier type.
81  */
82 typedef uint32_t crykey_t;
83 
84 /**
85  * @brief Type of a structure representing an CRY driver.
86  */
87 typedef struct CRYDriver CRYDriver;
88 
89 /**
90  * @brief Driver configuration structure.
91  * @note It could be empty on some architectures.
92  */
93 typedef struct {
94  uint32_t dummy;
95 } CRYConfig;
96 
97 /**
98  * @brief Structure representing an CRY driver.
99  */
100 struct CRYDriver {
101  /**
102  * @brief Driver state.
103  */
104  crystate_t state;
105  /**
106  * @brief Current configuration data.
107  */
108  const CRYConfig *config;
109  /**
110  * @brief Algorithm type of transient key.
111  */
112  cryalgorithm_t key0_type;
113  /**
114  * @brief Size of transient key.
115  */
116  size_t key0_size;
117 #if (HAL_CRY_USE_FALLBACK == TRUE) || defined(__DOXYGEN__)
118  /**
119  * @brief Key buffer for the fall-back implementation.
120  */
121  uint8_t key0_buffer[HAL_CRY_MAX_KEY_SIZE];
122 #endif
123 #if defined(CRY_DRIVER_EXT_FIELDS)
124  CRY_DRIVER_EXT_FIELDS
125 #endif
126  /* End of the mandatory fields.*/
127 };
128 
129 #if (CRY_LLD_SUPPORTS_SHA1 == TRUE) || defined(__DOXYGEN__)
130 /**
131  * @brief Type of a SHA1 context.
132  */
133 typedef struct {
134  uint32_t dummy;
135 } SHA1Context;
136 #endif
137 
138 #if (CRY_LLD_SUPPORTS_SHA256 == TRUE) || defined(__DOXYGEN__)
139 /**
140  * @brief Type of a SHA256 context.
141  */
142 typedef struct {
143  uint32_t dummy;
144 } SHA256Context;
145 #endif
146 
147 #if (CRY_LLD_SUPPORTS_SHA512 == TRUE) || defined(__DOXYGEN__)
148 /**
149  * @brief Type of a SHA512 context.
150  */
151 typedef struct {
152  uint32_t dummy;
153 } SHA512Context;
154 #endif
155 
156 /*===========================================================================*/
157 /* Driver macros. */
158 /*===========================================================================*/
159 
160 /*===========================================================================*/
161 /* External declarations. */
162 /*===========================================================================*/
163 
164 #if (PLATFORM_CRY_USE_CRY1 == TRUE) && !defined(__DOXYGEN__)
165 extern CRYDriver CRYD1;
166 #endif
167 
168 #ifdef __cplusplus
169 extern "C" {
170 #endif
171  void cry_lld_init(void);
172  void cry_lld_start(CRYDriver *cryp);
173  void cry_lld_stop(CRYDriver *cryp);
174  cryerror_t cry_lld_loadkey(CRYDriver *cryp,
175  cryalgorithm_t algorithm,
176  size_t size,
177  const uint8_t *keyp);
178  cryerror_t cry_lld_encrypt_AES(CRYDriver *cryp,
179  crykey_t key_id,
180  const uint8_t *in,
181  uint8_t *out);
182  cryerror_t cry_lld_decrypt_AES(CRYDriver *cryp,
183  crykey_t key_id,
184  const uint8_t *in,
185  uint8_t *out);
186  cryerror_t cry_lld_encrypt_AES_ECB(CRYDriver *cryp,
187  crykey_t key_id,
188  size_t size,
189  const uint8_t *in,
190  uint8_t *out);
191  cryerror_t cry_lld_decrypt_AES_ECB(CRYDriver *cryp,
192  crykey_t key_id,
193  size_t size,
194  const uint8_t *in,
195  uint8_t *out);
196  cryerror_t cry_lld_encrypt_AES_CBC(CRYDriver *cryp,
197  crykey_t key_id,
198  size_t size,
199  const uint8_t *in,
200  uint8_t *out,
201  const uint8_t *iv);
202  cryerror_t cry_lld_decrypt_AES_CBC(CRYDriver *cryp,
203  crykey_t key_id,
204  size_t size,
205  const uint8_t *in,
206  uint8_t *out,
207  const uint8_t *iv);
208  cryerror_t cry_lld_encrypt_AES_CFB(CRYDriver *cryp,
209  crykey_t key_id,
210  size_t size,
211  const uint8_t *in,
212  uint8_t *out,
213  const uint8_t *iv);
214  cryerror_t cry_lld_decrypt_AES_CFB(CRYDriver *cryp,
215  crykey_t key_id,
216  size_t size,
217  const uint8_t *in,
218  uint8_t *out,
219  const uint8_t *iv);
220  cryerror_t cry_lld_encrypt_AES_CTR(CRYDriver *cryp,
221  crykey_t key_id,
222  size_t size,
223  const uint8_t *in,
224  uint8_t *out,
225  const uint8_t *iv);
226  cryerror_t cry_lld_decrypt_AES_CTR(CRYDriver *cryp,
227  crykey_t key_id,
228  size_t size,
229  const uint8_t *in,
230  uint8_t *out,
231  const uint8_t *iv);
232  cryerror_t cry_lld_encrypt_AES_GCM(CRYDriver *cryp,
233  crykey_t key_id,
234  size_t size,
235  const uint8_t *in,
236  uint8_t *out,
237  const uint8_t *iv,
238  size_t aadsize,
239  const uint8_t *aad,
240  uint8_t *authtag);
241  cryerror_t cry_lld_decrypt_AES_GCM(CRYDriver *cryp,
242  crykey_t key_id,
243  size_t size,
244  const uint8_t *in,
245  uint8_t *out,
246  const uint8_t *iv,
247  size_t aadsize,
248  const uint8_t *aad,
249  uint8_t *authtag);
250  cryerror_t cry_lld_encrypt_DES(CRYDriver *cryp,
251  crykey_t key_id,
252  const uint8_t *in,
253  uint8_t *out);
254  cryerror_t cry_lld_decrypt_DES(CRYDriver *cryp,
255  crykey_t key_id,
256  const uint8_t *in,
257  uint8_t *out);
258  cryerror_t cry_lld_encrypt_DES_ECB(CRYDriver *cryp,
259  crykey_t key_id,
260  size_t size,
261  const uint8_t *in,
262  uint8_t *out);
263  cryerror_t cry_lld_decrypt_DES_ECB(CRYDriver *cryp,
264  crykey_t key_id,
265  size_t size,
266  const uint8_t *in,
267  uint8_t *out);
268  cryerror_t cry_lld_encrypt_DES_CBC(CRYDriver *cryp,
269  crykey_t key_id,
270  size_t size,
271  const uint8_t *in,
272  uint8_t *out,
273  const uint8_t *iv);
274  cryerror_t cry_lld_decrypt_DES_CBC(CRYDriver *cryp,
275  crykey_t key_id,
276  size_t size,
277  const uint8_t *in,
278  uint8_t *out,
279  const uint8_t *iv);
280  cryerror_t cry_lld_SHA1_init(CRYDriver *cryp, SHA1Context *sha1ctxp);
281  cryerror_t cry_lld_SHA1_update(CRYDriver *cryp, SHA1Context *sha1ctxp,
282  size_t size, const uint8_t *in);
283  cryerror_t cry_lld_SHA1_final(CRYDriver *cryp, SHA1Context *sha1ctxp,
284  uint8_t *out);
285  cryerror_t cry_lld_SHA256_init(CRYDriver *cryp, SHA256Context *sha256ctxp);
286  cryerror_t cry_lld_SHA256_update(CRYDriver *cryp, SHA256Context *sha256ctxp,
287  size_t size, const uint8_t *in);
288  cryerror_t cry_lld_SHA256_final(CRYDriver *cryp, SHA256Context *sha256ctxp,
289  uint8_t *out);
290  cryerror_t cry_lld_SHA512_init(CRYDriver *cryp, SHA512Context *sha512ctxp);
291  cryerror_t cry_lld_SHA512_update(CRYDriver *cryp, SHA512Context *sha512ctxp,
292  size_t size, const uint8_t *in);
293  cryerror_t cry_lld_SHA512_final(CRYDriver *cryp, SHA512Context *sha512ctxp,
294  uint8_t *out);
295  cryerror_t cry_lld_TRNG(CRYDriver *cryp, uint8_t *out);
296 #ifdef __cplusplus
297 }
298 #endif
299 
300 #endif /* HAL_USE_CRY == TRUE */
301 
302 #endif /* HAL_CRYPTO_LLD_H */
303 
304 /** @} */
cry_lld_SHA1_init
cryerror_t cry_lld_SHA1_init(CRYDriver *cryp, SHA1Context *sha1ctxp)
Hash initialization using SHA1.
Definition: hal_crypto_lld.c:874
cry_lld_decrypt_AES_GCM
cryerror_t cry_lld_decrypt_AES_GCM(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv, size_t aadsize, const uint8_t *aad, uint8_t *authtag)
Decryption operation using AES-GCM.
Definition: hal_crypto_lld.c:608
cry_lld_decrypt_AES_CFB
cryerror_t cry_lld_decrypt_AES_CFB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Decryption operation using AES-CFB.
Definition: hal_crypto_lld.c:420
cry_lld_encrypt_AES_CBC
cryerror_t cry_lld_encrypt_AES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Encryption operation using AES-CBC.
Definition: hal_crypto_lld.c:294
cry_lld_SHA1_final
cryerror_t cry_lld_SHA1_final(CRYDriver *cryp, SHA1Context *sha1ctxp, uint8_t *out)
Hash finalization using SHA1.
Definition: hal_crypto_lld.c:922
cry_lld_SHA1_update
cryerror_t cry_lld_SHA1_update(CRYDriver *cryp, SHA1Context *sha1ctxp, size_t size, const uint8_t *in)
Hash update using SHA1.
Definition: hal_crypto_lld.c:897
SHA512Context
Type of a SHA512 context.
Definition: hal_crypto.h:190
cry_lld_decrypt_DES_ECB
cryerror_t cry_lld_decrypt_DES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out)
Decryption operation using (T)DES-ECB.
Definition: hal_crypto_lld.c:763
cry_lld_TRNG
cryerror_t cry_lld_TRNG(CRYDriver *cryp, uint8_t *out)
True random numbers generator.
Definition: hal_crypto_lld.c:1078
CRYDriver
Structure representing an CRY driver.
Definition: hal_crypto_lld.h:100
cry_lld_encrypt_DES_CBC
cryerror_t cry_lld_encrypt_DES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Encryption operation using (T)DES-CBC.
Definition: hal_crypto_lld.c:803
HAL_CRY_MAX_KEY_SIZE
#define HAL_CRY_MAX_KEY_SIZE
Maximum size of a key for all supported algorithms.
Definition: hal_crypto.h:37
cry_lld_stop
void cry_lld_stop(CRYDriver *cryp)
Deactivates the crypto peripheral.
Definition: hal_crypto_lld.c:88
cry_lld_encrypt_AES_CFB
cryerror_t cry_lld_encrypt_AES_CFB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Encryption operation using AES-CFB.
Definition: hal_crypto_lld.c:378
cryerror_t
cryerror_t
Driver error codes.
Definition: hal_crypto.h:94
cry_lld_encrypt_AES_GCM
cryerror_t cry_lld_encrypt_AES_GCM(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv, size_t aadsize, const uint8_t *aad, uint8_t *authtag)
Encryption operation using AES-GCM.
Definition: hal_crypto_lld.c:554
cry_lld_decrypt_AES_ECB
cryerror_t cry_lld_decrypt_AES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out)
Decryption operation using AES-ECB.
Definition: hal_crypto_lld.c:254
CRYConfig
Driver configuration structure.
Definition: hal_crypto_lld.h:93
CRYDriver::key0_type
cryalgorithm_t key0_type
Algorithm type of transient key.
Definition: hal_crypto_lld.h:112
cry_lld_start
void cry_lld_start(CRYDriver *cryp)
Configures and activates the crypto peripheral.
Definition: hal_crypto_lld.c:74
crykey_t
uint32_t crykey_t
CRY key identifier type.
Definition: hal_crypto_lld.h:82
cry_lld_decrypt_AES
cryerror_t cry_lld_decrypt_AES(CRYDriver *cryp, crykey_t key_id, const uint8_t *in, uint8_t *out)
Decryption of a single block using AES.
Definition: hal_crypto_lld.c:178
cry_lld_SHA512_init
cryerror_t cry_lld_SHA512_init(CRYDriver *cryp, SHA512Context *sha512ctxp)
Hash initialization using SHA512.
Definition: hal_crypto_lld.c:1010
cry_lld_init
void cry_lld_init(void)
Low level crypto driver initialization.
Definition: hal_crypto_lld.c:63
cry_lld_SHA512_final
cryerror_t cry_lld_SHA512_final(CRYDriver *cryp, SHA512Context *sha512ctxp, uint8_t *out)
Hash finalization using SHA512.
Definition: hal_crypto_lld.c:1056
cry_lld_decrypt_AES_CTR
cryerror_t cry_lld_decrypt_AES_CTR(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Decryption operation using AES-CTR.
Definition: hal_crypto_lld.c:506
cryalgorithm_t
cryalgorithm_t
Type of an algorithm identifier.
Definition: hal_crypto.h:106
cry_lld_encrypt_AES_ECB
cryerror_t cry_lld_encrypt_AES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out)
Encryption operation using AES-ECB.
Definition: hal_crypto_lld.c:215
CRYD1
CRYDriver CRYD1
CRY1 driver identifier.
Definition: hal_crypto_lld.c:39
cry_lld_decrypt_DES_CBC
cryerror_t cry_lld_decrypt_DES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Decryption operation using (T)DES-CBC.
Definition: hal_crypto_lld.c:845
cry_lld_encrypt_DES_ECB
cryerror_t cry_lld_encrypt_DES_ECB(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out)
Encryption operation using (T)DES-ECB.
Definition: hal_crypto_lld.c:724
cry_lld_decrypt_DES
cryerror_t cry_lld_decrypt_DES(CRYDriver *cryp, crykey_t key_id, const uint8_t *in, uint8_t *out)
Decryption of a single block using (T)DES.
Definition: hal_crypto_lld.c:687
CRYDriver::key0_size
size_t key0_size
Size of transient key.
Definition: hal_crypto_lld.h:116
cry_lld_encrypt_AES
cryerror_t cry_lld_encrypt_AES(CRYDriver *cryp, crykey_t key_id, const uint8_t *in, uint8_t *out)
Encryption of a single block using AES.
Definition: hal_crypto_lld.c:144
crystate_t
crystate_t
Driver state machine possible states.
Definition: hal_crypto.h:85
cry_lld_SHA512_update
cryerror_t cry_lld_SHA512_update(CRYDriver *cryp, SHA512Context *sha512ctxp, size_t size, const uint8_t *in)
Hash update using SHA512.
Definition: hal_crypto_lld.c:1032
in
USBInEndpointState in
IN EP0 state.
Definition: hal_usb_lld.c:57
cry_lld_SHA256_init
cryerror_t cry_lld_SHA256_init(CRYDriver *cryp, SHA256Context *sha256ctxp)
Hash initialization using SHA256.
Definition: hal_crypto_lld.c:943
cry_lld_decrypt_AES_CBC
cryerror_t cry_lld_decrypt_AES_CBC(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Decryption operation using AES-CBC.
Definition: hal_crypto_lld.c:336
CRYDriver::state
crystate_t state
Driver state.
Definition: hal_crypto_lld.h:104
SHA1Context
Type of a SHA1 context.
Definition: hal_crypto.h:174
out
USBOutEndpointState out
OUT EP0 state.
Definition: hal_usb_lld.c:61
cry_lld_encrypt_DES
cryerror_t cry_lld_encrypt_DES(CRYDriver *cryp, crykey_t key_id, const uint8_t *in, uint8_t *out)
Encryption of a single block using (T)DES.
Definition: hal_crypto_lld.c:652
cry_lld_loadkey
cryerror_t cry_lld_loadkey(CRYDriver *cryp, cryalgorithm_t algorithm, size_t size, const uint8_t *keyp)
Initializes the transient key for a specific algorithm.
Definition: hal_crypto_lld.c:110
cry_lld_SHA256_update
cryerror_t cry_lld_SHA256_update(CRYDriver *cryp, SHA256Context *sha256ctxp, size_t size, const uint8_t *in)
Hash update using SHA256.
Definition: hal_crypto_lld.c:965
SHA256Context
Type of a SHA256 context.
Definition: hal_crypto.h:182
cry_lld_SHA256_final
cryerror_t cry_lld_SHA256_final(CRYDriver *cryp, SHA256Context *sha256ctxp, uint8_t *out)
Hash finalization using SHA256.
Definition: hal_crypto_lld.c:989
CRYDriver::config
const CRYConfig * config
Current configuration data.
Definition: hal_crypto_lld.h:108
CRYDriver::key0_buffer
uint8_t key0_buffer[HAL_CRY_MAX_KEY_SIZE]
Key buffer for the fall-back implementation.
Definition: hal_crypto_lld.h:121
cry_lld_encrypt_AES_CTR
cryerror_t cry_lld_encrypt_AES_CTR(CRYDriver *cryp, crykey_t key_id, size_t size, const uint8_t *in, uint8_t *out, const uint8_t *iv)
Encryption operation using AES-CTR.
Definition: hal_crypto_lld.c:463