crypto.h
Go to the documentation of this file.
1 /**
2  * @file crypto.h
3  * @brief General definitions for cryptographic algorithms
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2021 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.1.2
29  **/
30 
31 #ifndef _CRYPTO_H
32 #define _CRYPTO_H
33 
34 //Dependencies
35 #include "os_port.h"
36 #include "crypto_config.h"
37 #include "crypto_legacy.h"
38 #include "cpu_endian.h"
39 #include "error.h"
40 
41 
42 /*
43  * CycloneCRYPTO Open is licensed under GPL version 2. In particular:
44  *
45  * - If you link your program to CycloneCRYPTO Open, the result is a derivative
46  * work that can only be distributed under the same GPL license terms.
47  *
48  * - If additions or changes to CycloneCRYPTO Open are made, the result is a
49  * derivative work that can only be distributed under the same license terms.
50  *
51  * - The GPL license requires that you make the source code available to
52  * whoever you make the binary available to.
53  *
54  * - If you sell or distribute a hardware product that runs CycloneCRYPTO Open,
55  * the GPL license requires you to provide public and full access to all
56  * source code on a nondiscriminatory basis.
57  *
58  * If you fully understand and accept the terms of the GPL license, then edit
59  * the os_port_config.h header and add the following directive:
60  *
61  * #define GPL_LICENSE_TERMS_ACCEPTED
62  */
63 
64 #ifndef GPL_LICENSE_TERMS_ACCEPTED
65  #error Before compiling CycloneCRYPTO Open, you must accept the terms of the GPL license
66 #endif
67 
68 //Version string
69 #define CYCLONE_CRYPTO_VERSION_STRING "2.1.2"
70 //Major version
71 #define CYCLONE_CRYPTO_MAJOR_VERSION 2
72 //Minor version
73 #define CYCLONE_CRYPTO_MINOR_VERSION 1
74 //Revision number
75 #define CYCLONE_CRYPTO_REV_NUMBER 2
76 
77 //Multiple precision integer support
78 #ifndef MPI_SUPPORT
79  #define MPI_SUPPORT ENABLED
80 #elif (MPI_SUPPORT != ENABLED && MPI_SUPPORT != DISABLED)
81  #error MPI_SUPPORT parameter is not valid
82 #endif
83 
84 //Assembly optimizations for time-critical routines
85 #ifndef MPI_ASM_SUPPORT
86  #define MPI_ASM_SUPPORT DISABLED
87 #elif (MPI_ASM_SUPPORT != ENABLED && MPI_ASM_SUPPORT != DISABLED)
88  #error MPI_ASM_SUPPORT parameter is not valid
89 #endif
90 
91 //Base64 encoding support
92 #ifndef BASE64_SUPPORT
93  #define BASE64_SUPPORT ENABLED
94 #elif (BASE64_SUPPORT != ENABLED && BASE64_SUPPORT != DISABLED)
95  #error BASE64_SUPPORT parameter is not valid
96 #endif
97 
98 //Base64url encoding support
99 #ifndef BASE64URL_SUPPORT
100  #define BASE64URL_SUPPORT ENABLED
101 #elif (BASE64URL_SUPPORT != ENABLED && BASE64URL_SUPPORT != DISABLED)
102  #error BASE64URL_SUPPORT parameter is not valid
103 #endif
104 
105 //Radix64 encoding support
106 #ifndef RADIX64_SUPPORT
107  #define RADIX64_SUPPORT ENABLED
108 #elif (RADIX64_SUPPORT != ENABLED && RADIX64_SUPPORT != DISABLED)
109  #error RADIX64_SUPPORT parameter is not valid
110 #endif
111 
112 //MD2 hash support
113 #ifndef MD2_SUPPORT
114  #define MD2_SUPPORT DISABLED
115 #elif (MD2_SUPPORT != ENABLED && MD2_SUPPORT != DISABLED)
116  #error MD2_SUPPORT parameter is not valid
117 #endif
118 
119 //MD4 hash support
120 #ifndef MD4_SUPPORT
121  #define MD4_SUPPORT DISABLED
122 #elif (MD4_SUPPORT != ENABLED && MD4_SUPPORT != DISABLED)
123  #error MD4_SUPPORT parameter is not valid
124 #endif
125 
126 //MD5 hash support
127 #ifndef MD5_SUPPORT
128  #define MD5_SUPPORT ENABLED
129 #elif (MD5_SUPPORT != ENABLED && MD5_SUPPORT != DISABLED)
130  #error MD5_SUPPORT parameter is not valid
131 #endif
132 
133 //RIPEMD-128 hash support
134 #ifndef RIPEMD128_SUPPORT
135  #define RIPEMD128_SUPPORT DISABLED
136 #elif (RIPEMD128_SUPPORT != ENABLED && RIPEMD128_SUPPORT != DISABLED)
137  #error RIPEMD128_SUPPORT parameter is not valid
138 #endif
139 
140 //RIPEMD-160 hash support
141 #ifndef RIPEMD160_SUPPORT
142  #define RIPEMD160_SUPPORT DISABLED
143 #elif (RIPEMD160_SUPPORT != ENABLED && RIPEMD160_SUPPORT != DISABLED)
144  #error RIPEMD160_SUPPORT parameter is not valid
145 #endif
146 
147 //SHA-1 hash support
148 #ifndef SHA1_SUPPORT
149  #define SHA1_SUPPORT ENABLED
150 #elif (SHA1_SUPPORT != ENABLED && SHA1_SUPPORT != DISABLED)
151  #error SHA1_SUPPORT parameter is not valid
152 #endif
153 
154 //SHA-224 hash support
155 #ifndef SHA224_SUPPORT
156  #define SHA224_SUPPORT ENABLED
157 #elif (SHA224_SUPPORT != ENABLED && SHA224_SUPPORT != DISABLED)
158  #error SHA224_SUPPORT parameter is not valid
159 #endif
160 
161 //SHA-256 hash support
162 #ifndef SHA256_SUPPORT
163  #define SHA256_SUPPORT ENABLED
164 #elif (SHA256_SUPPORT != ENABLED && SHA256_SUPPORT != DISABLED)
165  #error SHA256_SUPPORT parameter is not valid
166 #endif
167 
168 //SHA-384 hash support
169 #ifndef SHA384_SUPPORT
170  #define SHA384_SUPPORT ENABLED
171 #elif (SHA384_SUPPORT != ENABLED && SHA384_SUPPORT != DISABLED)
172  #error SHA384_SUPPORT parameter is not valid
173 #endif
174 
175 //SHA-512 hash support
176 #ifndef SHA512_SUPPORT
177  #define SHA512_SUPPORT ENABLED
178 #elif (SHA512_SUPPORT != ENABLED && SHA512_SUPPORT != DISABLED)
179  #error SHA512_SUPPORT parameter is not valid
180 #endif
181 
182 //SHA-512/224 hash support
183 #ifndef SHA512_224_SUPPORT
184  #define SHA512_224_SUPPORT DISABLED
185 #elif (SHA512_224_SUPPORT != ENABLED && SHA512_224_SUPPORT != DISABLED)
186  #error SHA512_224_SUPPORT parameter is not valid
187 #endif
188 
189 //SHA-512/256 hash support
190 #ifndef SHA512_256_SUPPORT
191  #define SHA512_256_SUPPORT DISABLED
192 #elif (SHA512_256_SUPPORT != ENABLED && SHA512_256_SUPPORT != DISABLED)
193  #error SHA512_256_SUPPORT parameter is not valid
194 #endif
195 
196 //SHA3-224 hash support
197 #ifndef SHA3_224_SUPPORT
198  #define SHA3_224_SUPPORT DISABLED
199 #elif (SHA3_224_SUPPORT != ENABLED && SHA3_224_SUPPORT != DISABLED)
200  #error SHA3_224_SUPPORT parameter is not valid
201 #endif
202 
203 //SHA3-256 hash support
204 #ifndef SHA3_256_SUPPORT
205  #define SHA3_256_SUPPORT DISABLED
206 #elif (SHA3_256_SUPPORT != ENABLED && SHA3_256_SUPPORT != DISABLED)
207  #error SHA3_256_SUPPORT parameter is not valid
208 #endif
209 
210 //SHA3-384 hash support
211 #ifndef SHA3_384_SUPPORT
212  #define SHA3_384_SUPPORT DISABLED
213 #elif (SHA3_384_SUPPORT != ENABLED && SHA3_384_SUPPORT != DISABLED)
214  #error SHA3_384_SUPPORT parameter is not valid
215 #endif
216 
217 //SHA3-512 hash support
218 #ifndef SHA3_512_SUPPORT
219  #define SHA3_512_SUPPORT DISABLED
220 #elif (SHA3_512_SUPPORT != ENABLED && SHA3_512_SUPPORT != DISABLED)
221  #error SHA3_512_SUPPORT parameter is not valid
222 #endif
223 
224 //SHAKE support
225 #ifndef SHAKE_SUPPORT
226  #define SHAKE_SUPPORT DISABLED
227 #elif (SHAKE_SUPPORT != ENABLED && SHAKE_SUPPORT != DISABLED)
228  #error SHAKE_SUPPORT parameter is not valid
229 #endif
230 
231 //cSHAKE support
232 #ifndef CSHAKE_SUPPORT
233  #define CSHAKE_SUPPORT DISABLED
234 #elif (CSHAKE_SUPPORT != ENABLED && CSHAKE_SUPPORT != DISABLED)
235  #error CSHAKE_SUPPORT parameter is not valid
236 #endif
237 
238 //Keccak support
239 #ifndef KECCAK_SUPPORT
240  #define KECCAK_SUPPORT DISABLED
241 #elif (KECCAK_SUPPORT != ENABLED && KECCAK_SUPPORT != DISABLED)
242  #error KECCAK_SUPPORT parameter is not valid
243 #endif
244 
245 //BLAKE2b support
246 #ifndef BLAKE2B_SUPPORT
247  #define BLAKE2B_SUPPORT DISABLED
248 #elif (BLAKE2B_SUPPORT != ENABLED && BLAKE2B_SUPPORT != DISABLED)
249  #error BLAKE2B_SUPPORT parameter is not valid
250 #endif
251 
252 //BLAKE2b-160 hash support
253 #ifndef BLAKE2B160_SUPPORT
254  #define BLAKE2B160_SUPPORT DISABLED
255 #elif (BLAKE2B160_SUPPORT != ENABLED && BLAKE2B160_SUPPORT != DISABLED)
256  #error BLAKE2B160_SUPPORT parameter is not valid
257 #endif
258 
259 //BLAKE2b-256 hash support
260 #ifndef BLAKE2B256_SUPPORT
261  #define BLAKE2B256_SUPPORT DISABLED
262 #elif (BLAKE2B256_SUPPORT != ENABLED && BLAKE2B256_SUPPORT != DISABLED)
263  #error BLAKE2B256_SUPPORT parameter is not valid
264 #endif
265 
266 //BLAKE2b-384 hash support
267 #ifndef BLAKE2B384_SUPPORT
268  #define BLAKE2B384_SUPPORT DISABLED
269 #elif (BLAKE2B384_SUPPORT != ENABLED && BLAKE2B384_SUPPORT != DISABLED)
270  #error BLAKE2B384_SUPPORT parameter is not valid
271 #endif
272 
273 //BLAKE2b-512 hash support
274 #ifndef BLAKE2B512_SUPPORT
275  #define BLAKE2B512_SUPPORT DISABLED
276 #elif (BLAKE2B512_SUPPORT != ENABLED && BLAKE2B512_SUPPORT != DISABLED)
277  #error BLAKE2B512_SUPPORT parameter is not valid
278 #endif
279 
280 //BLAKE2s support
281 #ifndef BLAKE2S_SUPPORT
282  #define BLAKE2S_SUPPORT DISABLED
283 #elif (BLAKE2S_SUPPORT != ENABLED && BLAKE2S_SUPPORT != DISABLED)
284  #error BLAKE2S_SUPPORT parameter is not valid
285 #endif
286 
287 //BLAKE2s-128 hash support
288 #ifndef BLAKE2S128_SUPPORT
289  #define BLAKE2S128_SUPPORT DISABLED
290 #elif (BLAKE2S128_SUPPORT != ENABLED && BLAKE2S128_SUPPORT != DISABLED)
291  #error BLAKE2S128_SUPPORT parameter is not valid
292 #endif
293 
294 //BLAKE2s-160 hash support
295 #ifndef BLAKE2S160_SUPPORT
296  #define BLAKE2S160_SUPPORT DISABLED
297 #elif (BLAKE2S160_SUPPORT != ENABLED && BLAKE2S160_SUPPORT != DISABLED)
298  #error BLAKE2S160_SUPPORT parameter is not valid
299 #endif
300 
301 //BLAKE2s-224 hash support
302 #ifndef BLAKE2S224_SUPPORT
303  #define BLAKE2S224_SUPPORT DISABLED
304 #elif (BLAKE2S224_SUPPORT != ENABLED && BLAKE2S224_SUPPORT != DISABLED)
305  #error BLAKE2S224_SUPPORT parameter is not valid
306 #endif
307 
308 //BLAKE2s-256 hash support
309 #ifndef BLAKE2S256_SUPPORT
310  #define BLAKE2S256_SUPPORT DISABLED
311 #elif (BLAKE2S256_SUPPORT != ENABLED && BLAKE2S256_SUPPORT != DISABLED)
312  #error BLAKE2S256_SUPPORT parameter is not valid
313 #endif
314 
315 //Tiger hash support
316 #ifndef TIGER_SUPPORT
317  #define TIGER_SUPPORT DISABLED
318 #elif (TIGER_SUPPORT != ENABLED && TIGER_SUPPORT != DISABLED)
319  #error TIGER_SUPPORT parameter is not valid
320 #endif
321 
322 //Whirlpool hash support
323 #ifndef WHIRLPOOL_SUPPORT
324  #define WHIRLPOOL_SUPPORT DISABLED
325 #elif (WHIRLPOOL_SUPPORT != ENABLED && WHIRLPOOL_SUPPORT != DISABLED)
326  #error WHIRLPOOL_SUPPORT parameter is not valid
327 #endif
328 
329 //CMAC support
330 #ifndef CMAC_SUPPORT
331  #define CMAC_SUPPORT DISABLED
332 #elif (CMAC_SUPPORT != ENABLED && CMAC_SUPPORT != DISABLED)
333  #error CMAC_SUPPORT parameter is not valid
334 #endif
335 
336 //GMAC support
337 #ifndef GMAC_SUPPORT
338  #define GMAC_SUPPORT DISABLED
339 #elif (GMAC_SUPPORT != ENABLED && GMAC_SUPPORT != DISABLED)
340  #error GMAC_SUPPORT parameter is not valid
341 #endif
342 
343 //HMAC support
344 #ifndef HMAC_SUPPORT
345  #define HMAC_SUPPORT ENABLED
346 #elif (HMAC_SUPPORT != ENABLED && HMAC_SUPPORT != DISABLED)
347  #error HMAC_SUPPORT parameter is not valid
348 #endif
349 
350 //KMAC support
351 #ifndef KMAC_SUPPORT
352  #define KMAC_SUPPORT DISABLED
353 #elif (KMAC_SUPPORT != ENABLED && GMAC_SUPPORT != DISABLED)
354  #error KMAC_SUPPORT parameter is not valid
355 #endif
356 
357 //RC2 encryption support
358 #ifndef RC2_SUPPORT
359  #define RC2_SUPPORT DISABLED
360 #elif (RC2_SUPPORT != ENABLED && RC2_SUPPORT != DISABLED)
361  #error RC2_SUPPORT parameter is not valid
362 #endif
363 
364 //RC4 encryption support
365 #ifndef RC4_SUPPORT
366  #define RC4_SUPPORT DISABLED
367 #elif (RC4_SUPPORT != ENABLED && RC4_SUPPORT != DISABLED)
368  #error RC4_SUPPORT parameter is not valid
369 #endif
370 
371 //RC6 encryption support
372 #ifndef RC6_SUPPORT
373  #define RC6_SUPPORT DISABLED
374 #elif (RC6_SUPPORT != ENABLED && RC6_SUPPORT != DISABLED)
375  #error RC6_SUPPORT parameter is not valid
376 #endif
377 
378 //IDEA encryption support
379 #ifndef IDEA_SUPPORT
380  #define IDEA_SUPPORT DISABLED
381 #elif (IDEA_SUPPORT != ENABLED && IDEA_SUPPORT != DISABLED)
382  #error IDEA_SUPPORT parameter is not valid
383 #endif
384 
385 //DES encryption support
386 #ifndef DES_SUPPORT
387  #define DES_SUPPORT ENABLED
388 #elif (DES_SUPPORT != ENABLED && DES_SUPPORT != DISABLED)
389  #error DES_SUPPORT parameter is not valid
390 #endif
391 
392 //Triple DES encryption support
393 #ifndef DES3_SUPPORT
394  #define DES3_SUPPORT ENABLED
395 #elif (DES3_SUPPORT != ENABLED && DES3_SUPPORT != DISABLED)
396  #error DES3_SUPPORT parameter is not valid
397 #endif
398 
399 //AES encryption support
400 #ifndef AES_SUPPORT
401  #define AES_SUPPORT ENABLED
402 #elif (AES_SUPPORT != ENABLED && AES_SUPPORT != DISABLED)
403  #error AES_SUPPORT parameter is not valid
404 #endif
405 
406 //Blowfish encryption support
407 #ifndef BLOWFISH_SUPPORT
408  #define BLOWFISH_SUPPORT DISABLED
409 #elif (BLOWFISH_SUPPORT != ENABLED && BLOWFISH_SUPPORT != DISABLED)
410  #error BLOWFISH_SUPPORT parameter is not valid
411 #endif
412 
413 //Camellia encryption support
414 #ifndef CAMELLIA_SUPPORT
415  #define CAMELLIA_SUPPORT ENABLED
416 #elif (CAMELLIA_SUPPORT != ENABLED && CAMELLIA_SUPPORT != DISABLED)
417  #error CAMELLIA_SUPPORT parameter is not valid
418 #endif
419 
420 //ARIA encryption support
421 #ifndef ARIA_SUPPORT
422  #define ARIA_SUPPORT ENABLED
423 #elif (ARIA_SUPPORT != ENABLED && ARIA_SUPPORT != DISABLED)
424  #error ARIA_SUPPORT parameter is not valid
425 #endif
426 
427 //SEED encryption support
428 #ifndef SEED_SUPPORT
429  #define SEED_SUPPORT ENABLED
430 #elif (SEED_SUPPORT != ENABLED && SEED_SUPPORT != DISABLED)
431  #error SEED_SUPPORT parameter is not valid
432 #endif
433 
434 //PRESENT encryption support
435 #ifndef PRESENT_SUPPORT
436  #define PRESENT_SUPPORT DISABLED
437 #elif (PRESENT_SUPPORT != ENABLED && PRESENT_SUPPORT != DISABLED)
438  #error PRESENT_SUPPORT parameter is not valid
439 #endif
440 
441 //Trivium encryption support
442 #ifndef TRIVIUM_SUPPORT
443  #define TRIVIUM_SUPPORT DISABLED
444 #elif (TRIVIUM_SUPPORT != ENABLED && TRIVIUM_SUPPORT != DISABLED)
445  #error TRIVIUM_SUPPORT parameter is not valid
446 #endif
447 
448 //ECB mode support
449 #ifndef ECB_SUPPORT
450  #define ECB_SUPPORT ENABLED
451 #elif (ECB_SUPPORT != ENABLED && ECB_SUPPORT != DISABLED)
452  #error ECB_SUPPORT parameter is not valid
453 #endif
454 
455 //CBC mode support
456 #ifndef CBC_SUPPORT
457  #define CBC_SUPPORT ENABLED
458 #elif (CBC_SUPPORT != ENABLED && CBC_SUPPORT != DISABLED)
459  #error CBC_SUPPORT parameter is not valid
460 #endif
461 
462 //CFB mode support
463 #ifndef CFB_SUPPORT
464  #define CFB_SUPPORT ENABLED
465 #elif (CFB_SUPPORT != ENABLED && CFB_SUPPORT != DISABLED)
466  #error CFB_SUPPORT parameter is not valid
467 #endif
468 
469 //OFB mode support
470 #ifndef OFB_SUPPORT
471  #define OFB_SUPPORT ENABLED
472 #elif (OFB_SUPPORT != ENABLED && OFB_SUPPORT != DISABLED)
473  #error OFB_SUPPORT parameter is not valid
474 #endif
475 
476 //CTR mode support
477 #ifndef CTR_SUPPORT
478  #define CTR_SUPPORT ENABLED
479 #elif (CTR_SUPPORT != ENABLED && CTR_SUPPORT != DISABLED)
480  #error CTR_SUPPORT parameter is not valid
481 #endif
482 
483 //XTS mode support
484 #ifndef XTS_SUPPORT
485  #define XTS_SUPPORT ENABLED
486 #elif (XTS_SUPPORT != ENABLED && XTS_SUPPORT != DISABLED)
487  #error XTS_SUPPORT parameter is not valid
488 #endif
489 
490 //CCM mode support
491 #ifndef CCM_SUPPORT
492  #define CCM_SUPPORT ENABLED
493 #elif (CCM_SUPPORT != ENABLED && CCM_SUPPORT != DISABLED)
494  #error CCM_SUPPORT parameter is not valid
495 #endif
496 
497 //GCM mode support
498 #ifndef GCM_SUPPORT
499  #define GCM_SUPPORT ENABLED
500 #elif (GCM_SUPPORT != ENABLED && GCM_SUPPORT != DISABLED)
501  #error GCM_SUPPORT parameter is not valid
502 #endif
503 
504 //Salsa20 support
505 #ifndef SALSA20_SUPPORT
506  #define SALSA20_SUPPORT DISABLED
507 #elif (SALSA20_SUPPORT != ENABLED && SALSA20_SUPPORT != DISABLED)
508  #error SALSA20_SUPPORT parameter is not valid
509 #endif
510 
511 //Chacha support
512 #ifndef CHACHA_SUPPORT
513  #define CHACHA_SUPPORT DISABLED
514 #elif (CHACHA_SUPPORT != ENABLED && CHACHA_SUPPORT != DISABLED)
515  #error CHACHA_SUPPORT parameter is not valid
516 #endif
517 
518 //Poly1305 support
519 #ifndef POLY1305_SUPPORT
520  #define POLY1305_SUPPORT DISABLED
521 #elif (POLY1305_SUPPORT != ENABLED && POLY1305_SUPPORT != DISABLED)
522  #error POLY1305_SUPPORT parameter is not valid
523 #endif
524 
525 //Chacha20Poly1305 support
526 #ifndef CHACHA20_POLY1305_SUPPORT
527  #define CHACHA20_POLY1305_SUPPORT DISABLED
528 #elif (CHACHA20_POLY1305_SUPPORT != ENABLED && CHACHA20_POLY1305_SUPPORT != DISABLED)
529  #error CHACHA20_POLY1305_SUPPORT parameter is not valid
530 #endif
531 
532 //Diffie-Hellman support
533 #ifndef DH_SUPPORT
534  #define DH_SUPPORT ENABLED
535 #elif (DH_SUPPORT != ENABLED && DH_SUPPORT != DISABLED)
536  #error DH_SUPPORT parameter is not valid
537 #endif
538 
539 //RSA support
540 #ifndef RSA_SUPPORT
541  #define RSA_SUPPORT ENABLED
542 #elif (RSA_SUPPORT != ENABLED && RSA_SUPPORT != DISABLED)
543  #error RSA_SUPPORT parameter is not valid
544 #endif
545 
546 //DSA support
547 #ifndef DSA_SUPPORT
548  #define DSA_SUPPORT ENABLED
549 #elif (DSA_SUPPORT != ENABLED && DSA_SUPPORT != DISABLED)
550  #error DSA_SUPPORT parameter is not valid
551 #endif
552 
553 //Elliptic curve cryptography support
554 #ifndef EC_SUPPORT
555  #define EC_SUPPORT ENABLED
556 #elif (EC_SUPPORT != ENABLED && EC_SUPPORT != DISABLED)
557  #error EC_SUPPORT parameter is not valid
558 #endif
559 
560 //ECDH support
561 #ifndef ECDH_SUPPORT
562  #define ECDH_SUPPORT ENABLED
563 #elif (ECDH_SUPPORT != ENABLED && ECDH_SUPPORT != DISABLED)
564  #error ECDH_SUPPORT parameter is not valid
565 #endif
566 
567 //ECDSA support
568 #ifndef ECDSA_SUPPORT
569  #define ECDSA_SUPPORT ENABLED
570 #elif (ECDSA_SUPPORT != ENABLED && ECDSA_SUPPORT != DISABLED)
571  #error ECDSA_SUPPORT parameter is not valid
572 #endif
573 
574 //HKDF support
575 #ifndef HKDF_SUPPORT
576  #define HKDF_SUPPORT DISABLED
577 #elif (HKDF_SUPPORT != ENABLED && HKDF_SUPPORT != DISABLED)
578  #error HKDF_SUPPORT parameter is not valid
579 #endif
580 
581 //PBKDF support
582 #ifndef PBKDF_SUPPORT
583  #define PBKDF_SUPPORT ENABLED
584 #elif (PBKDF_SUPPORT != ENABLED && PBKDF_SUPPORT != DISABLED)
585  #error PBKDF_SUPPORT parameter is not valid
586 #endif
587 
588 //bcrypt support
589 #ifndef BCRYPT_SUPPORT
590  #define BCRYPT_SUPPORT ENABLED
591 #elif (BCRYPT_SUPPORT != ENABLED && BCRYPT_SUPPORT != DISABLED)
592  #error BCRYPT_SUPPORT parameter is not valid
593 #endif
594 
595 //scrypt support
596 #ifndef SCRYPT_SUPPORT
597  #define SCRYPT_SUPPORT ENABLED
598 #elif (SCRYPT_SUPPORT != ENABLED && SCRYPT_SUPPORT != DISABLED)
599  #error SCRYPT_SUPPORT parameter is not valid
600 #endif
601 
602 //Yarrow PRNG support
603 #ifndef YARROW_SUPPORT
604  #define YARROW_SUPPORT ENABLED
605 #elif (YARROW_SUPPORT != ENABLED && YARROW_SUPPORT != DISABLED)
606  #error YARROW_SUPPORT parameter is not valid
607 #endif
608 
609 //Object identifier support
610 #ifndef OID_SUPPORT
611  #define OID_SUPPORT ENABLED
612 #elif (OID_SUPPORT != ENABLED && OID_SUPPORT != DISABLED)
613  #error OID_SUPPORT parameter is not valid
614 #endif
615 
616 //ASN.1 syntax support
617 #ifndef ASN1_SUPPORT
618  #define ASN1_SUPPORT ENABLED
619 #elif (ASN1_SUPPORT != ENABLED && ASN1_SUPPORT != DISABLED)
620  #error ASN1_SUPPORT parameter is not valid
621 #endif
622 
623 //PEM file support
624 #ifndef PEM_SUPPORT
625  #define PEM_SUPPORT ENABLED
626 #elif (PEM_SUPPORT != ENABLED && PEM_SUPPORT != DISABLED)
627  #error PEM_SUPPORT parameter is not valid
628 #endif
629 
630 //X.509 certificate support
631 #ifndef X509_SUPPORT
632  #define X509_SUPPORT ENABLED
633 #elif (X509_SUPPORT != ENABLED && X509_SUPPORT != DISABLED)
634  #error X509_SUPPORT parameter is not valid
635 #endif
636 
637 //Allocate memory block
638 #ifndef cryptoAllocMem
639  #define cryptoAllocMem(size) osAllocMem(size)
640 #endif
641 
642 //Deallocate memory block
643 #ifndef cryptoFreeMem
644  #define cryptoFreeMem(p) osFreeMem(p)
645 #endif
646 
647 //Rotate left operation
648 #define ROL8(a, n) (((a) << (n)) | ((a) >> (8 - (n))))
649 #define ROL16(a, n) (((a) << (n)) | ((a) >> (16 - (n))))
650 #define ROL32(a, n) (((a) << (n)) | ((a) >> (32 - (n))))
651 #define ROL64(a, n) (((a) << (n)) | ((a) >> (64 - (n))))
652 
653 //Rotate right operation
654 #define ROR8(a, n) (((a) >> (n)) | ((a) << (8 - (n))))
655 #define ROR16(a, n) (((a) >> (n)) | ((a) << (16 - (n))))
656 #define ROR32(a, n) (((a) >> (n)) | ((a) << (32 - (n))))
657 #define ROR64(a, n) (((a) >> (n)) | ((a) << (64 - (n))))
658 
659 //Shift left operation
660 #define SHL8(a, n) ((a) << (n))
661 #define SHL16(a, n) ((a) << (n))
662 #define SHL32(a, n) ((a) << (n))
663 #define SHL64(a, n) ((a) << (n))
664 
665 //Shift right operation
666 #define SHR8(a, n) ((a) >> (n))
667 #define SHR16(a, n) ((a) >> (n))
668 #define SHR32(a, n) ((a) >> (n))
669 #define SHR64(a, n) ((a) >> (n))
670 
671 //Micellaneous macros
672 #define _U8(x) ((uint8_t) (x))
673 #define _U16(x) ((uint16_t) (x))
674 #define _U32(x) ((uint32_t) (x))
675 #define _U64(x) ((uint64_t) (x))
676 
677 //Test if a 8-bit integer is zero
678 #define CRYPTO_TEST_Z_8(a) \
679  _U8((_U8((_U8(a) | (~_U8(a) + 1U))) >> 7U) ^ 1U)
680 
681 //Test if a 8-bit integer is nonzero
682 #define CRYPTO_TEST_NZ_8(a) \
683  _U8(_U8((_U8(a) | (~_U8(a) + 1U))) >> 7U)
684 
685 //Test if two 8-bit integers are equal
686 #define CRYPTO_TEST_EQ_8(a, b) \
687  _U8((_U8(((_U8(a) ^ _U8(b)) | (~(_U8(a) ^ _U8(b)) + 1U))) >> 7U) ^ 1U)
688 
689 //Test if two 8-bit integers are not equal
690 #define CRYPTO_TEST_NEQ_8(a, b) \
691  _U8(_U8(((_U8(a) ^ _U8(b)) | (~(_U8(a) ^ _U8(b)) + 1U))) >> 7U)
692 
693 //Test if a 8-bit integer is lower than another 8-bit integer
694 #define CRYPTO_TEST_LT_8(a, b) \
695  _U8(_U8((((_U8(a) - _U8(b)) ^ _U8(b)) | (_U8(a) ^ _U8(b))) ^ _U8(a)) >> 7U)
696 
697 //Test if a 8-bit integer is lower or equal than another 8-bit integer
698 #define CRYPTO_TEST_LTE_8(a, b) \
699  _U8((_U8((((_U8(b) - _U8(a)) ^ _U8(a)) | (_U8(a) ^ _U8(b))) ^ _U8(b)) >> 7U) ^ 1U)
700 
701 //Test if a 8-bit integer is greater than another 8-bit integer
702 #define CRYPTO_TEST_GT_8(a, b) \
703  _U8(_U8((((_U8(b) - _U8(a)) ^ _U8(a)) | (_U8(a) ^ _U8(b))) ^ _U8(b)) >> 7U)
704 
705 //Test if a 8-bit integer is greater or equal than another 8-bit integer
706 #define CRYPTO_TEST_GTE_8(a, b) \
707  _U8((_U8((((_U8(a) - _U8(b)) ^ _U8(b)) | (_U8(a) ^ _U8(b))) ^ _U8(a)) >> 7U) ^ 1U)
708 
709 //Select between two 8-bit integers
710 #define CRYPTO_SELECT_8(a, b, c) \
711  _U8((_U8(a) & (_U8(c) - 1U)) | (_U8(b) & ~(_U8(c) - 1U)))
712 
713 //Test if a 16-bit integer is zero
714 #define CRYPTO_TEST_Z_16(a) \
715  _U16((_U16((_U16(a) | (~_U16(a) + 1U))) >> 15U) ^ 1U)
716 
717 //Test if a 16-bit integer is nonzero
718 #define CRYPTO_TEST_NZ_16(a) \
719  _U16(_U16((_U16(a) | (~_U16(a) + 1U))) >> 15U)
720 
721 //Test if two 16-bit integers are equal
722 #define CRYPTO_TEST_EQ_16(a, b) \
723  _U16((_U16(((_U16(a) ^ _U16(b)) | (~(_U16(a) ^ _U16(b)) + 1U))) >> 15U) ^ 1U)
724 
725 //Test if two 16-bit integers are not equal
726 #define CRYPTO_TEST_NEQ_16(a, b) \
727  _U16(_U16(((_U16(a) ^ _U16(b)) | (~(_U16(a) ^ _U16(b)) + 1U))) >> 15U)
728 
729 //Test if a 16-bit integer is lower than another 16-bit integer
730 #define CRYPTO_TEST_LT_16(a, b) \
731  _U16(_U16((((_U16(a) - _U16(b)) ^ _U16(b)) | (_U16(a) ^ _U16(b))) ^ _U16(a)) >> 15U)
732 
733 //Test if a 16-bit integer is lower or equal than another 16-bit integer
734 #define CRYPTO_TEST_LTE_16(a, b) \
735  _U16((_U16((((_U16(b) - _U16(a)) ^ _U16(a)) | (_U16(a) ^ _U16(b))) ^ _U16(b)) >> 15U) ^ 1U)
736 
737 //Test if a 16-bit integer is greater than another 16-bit integer
738 #define CRYPTO_TEST_GT_16(a, b) \
739  _U16(_U16((((_U16(b) - _U16(a)) ^ _U16(a)) | (_U16(a) ^ _U16(b))) ^ _U16(b)) >> 15U)
740 
741 //Test if a 16-bit integer is greater or equal than another 16-bit integer
742 #define CRYPTO_TEST_GTE_16(a, b) \
743  _U16((_U16((((_U16(a) - _U16(b)) ^ _U16(b)) | (_U16(a) ^ _U16(b))) ^ _U16(a)) >> 15U) ^ 1U)
744 
745 //Select between two 16-bit integers
746 #define CRYPTO_SELECT_16(a, b, c) \
747  _U16((_U16(a) & (_U16(c) - 1U)) | (_U16(b) & ~(_U16(c) - 1U)))
748 
749 //Test if a 32-bit integer is zero
750 #define CRYPTO_TEST_Z_32(a) \
751  _U32((_U32((_U32(a) | (~_U32(a) + 1U))) >> 31U) ^ 1U)
752 
753 //Test if a 32-bit integer is nonzero
754 #define CRYPTO_TEST_NZ_32(a) \
755  _U32(_U32((_U32(a) | (~_U32(a) + 1U))) >> 31U)
756 
757 //Test if two 32-bit integers are equal
758 #define CRYPTO_TEST_EQ_32(a, b) \
759  _U32((_U32(((_U32(a) ^ _U32(b)) | (~(_U32(a) ^ _U32(b)) + 1U))) >> 31U) ^ 1U)
760 
761 //Test if two 32-bit integers are not equal
762 #define CRYPTO_TEST_NEQ_32(a, b) \
763  _U32(_U32(((_U32(a) ^ _U32(b)) | (~(_U32(a) ^ _U32(b)) + 1U))) >> 31U)
764 
765 //Test if a 32-bit integer is lower than another 32-bit integer
766 #define CRYPTO_TEST_LT_32(a, b) \
767  _U32(_U32((((_U32(a) - _U32(b)) ^ _U32(b)) | (_U32(a) ^ _U32(b))) ^ _U32(a)) >> 31U)
768 
769 //Test if a 32-bit integer is lower or equal than another 32-bit integer
770 #define CRYPTO_TEST_LTE_32(a, b) \
771  _U32((_U32((((_U32(b) - _U32(a)) ^ _U32(a)) | (_U32(a) ^ _U32(b))) ^ _U32(b)) >> 31U) ^ 1U)
772 
773 //Test if a 32-bit integer is greater than another 32-bit integer
774 #define CRYPTO_TEST_GT_32(a, b) \
775  _U32(_U32((((_U32(b) - _U32(a)) ^ _U32(a)) | (_U32(a) ^ _U32(b))) ^ _U32(b)) >> 31U)
776 
777 //Test if a 32-bit integer is greater or equal than another 32-bit integer
778 #define CRYPTO_TEST_GTE_32(a, b) \
779  _U32((_U32((((_U32(a) - _U32(b)) ^ _U32(b)) | (_U32(a) ^ _U32(b))) ^ _U32(a)) >> 31U) ^ 1U)
780 
781 //Select between two 32-bit integers
782 #define CRYPTO_SELECT_32(a, b, c) \
783  _U32((_U32(a) & (_U32(c) - 1U)) | (_U32(b) & ~(_U32(c) - 1U)))
784 
785 //Select between two 64-bit integers
786 #define CRYPTO_SELECT_64(a, b, c) \
787  _U64((_U64(a) & (_U64(c) - 1U)) | (_U64(b) & ~(_U64(c) - 1U)))
788 
789 //C++ guard
790 #ifdef __cplusplus
791 extern "C" {
792 #endif
793 
794 
795 /**
796  * @brief Encryption algorithm type
797  **/
798 
799 typedef enum
800 {
804 
805 
806 /**
807  * @brief Cipher operation modes
808  **/
809 
810 typedef enum
811 {
822 } CipherMode;
823 
824 
825 //Common API for hash algorithms
826 typedef error_t (*HashAlgoCompute)(const void *data, size_t length, uint8_t *digest);
827 typedef void (*HashAlgoInit)(void *context);
828 typedef void (*HashAlgoUpdate)(void *context, const void *data, size_t length);
829 typedef void (*HashAlgoFinal)(void *context, uint8_t *digest);
830 typedef void (*HashAlgoFinalRaw)(void *context, uint8_t *digest);
831 
832 //Common API for encryption algorithms
833 typedef error_t (*CipherAlgoInit)(void *context, const uint8_t *key, size_t keyLen);
834 typedef void (*CipherAlgoEncryptStream)(void *context, const uint8_t *input, uint8_t *output, size_t length);
835 typedef void (*CipherAlgoDecryptStream)(void *context, const uint8_t *input, uint8_t *output, size_t length);
836 typedef void (*CipherAlgoEncryptBlock)(void *context, const uint8_t *input, uint8_t *output);
837 typedef void (*CipherAlgoDecryptBlock)(void *context, const uint8_t *input, uint8_t *output);
838 
839 //Common API for pseudo-random number generators
840 typedef error_t (*PrngAlgoInit)(void *context);
841 typedef void (*PrngAlgoRelease)(void *context);
842 typedef error_t (*PrngAlgoSeed)(void *context, const uint8_t *input, size_t length);
843 typedef error_t (*PrngAlgoAddEntropy)(void *context, uint_t source, const uint8_t *input, size_t length, size_t entropy);
844 typedef error_t (*PrngAlgoRead)(void *context, uint8_t *output, size_t length);
845 
846 
847 /**
848  * @brief Common interface for hash algorithms
849  **/
850 
851 typedef struct
852 {
853  const char_t *name;
854  const uint8_t *oid;
855  size_t oidSize;
856  size_t contextSize;
857  size_t blockSize;
858  size_t digestSize;
859  size_t minPadSize;
866 } HashAlgo;
867 
868 
869 /**
870  * @brief Common interface for encryption algorithms
871  **/
872 
873 typedef struct
874 {
875  const char_t *name;
876  size_t contextSize;
878  size_t blockSize;
884 } CipherAlgo;
885 
886 
887 /**
888  * @brief Common interface for pseudo-random number generators
889  **/
890 
891 typedef struct
892 {
893  const char_t *name;
894  size_t contextSize;
900 } PrngAlgo;
901 
902 
903 //C++ guard
904 #ifdef __cplusplus
905 }
906 #endif
907 
908 #endif
uint8_t length
Definition: coap_common.h:191
void(* CipherAlgoDecryptStream)(void *context, const uint8_t *input, uint8_t *output, size_t length)
Definition: crypto.h:835
HashAlgoInit init
Definition: crypto.h:862
int bool_t
Definition: compiler_port.h:49
void(* HashAlgoInit)(void *context)
Definition: crypto.h:827
@ CIPHER_MODE_CBC
Definition: crypto.h:815
const uint8_t * oid
Definition: crypto.h:854
uint8_t data[]
Definition: ethernet.h:217
Common interface for pseudo-random number generators.
Definition: crypto.h:892
void(* CipherAlgoEncryptBlock)(void *context, const uint8_t *input, uint8_t *output)
Definition: crypto.h:836
CipherAlgoDecryptBlock decryptBlock
Definition: crypto.h:883
PrngAlgoRead read
Definition: crypto.h:899
void(* PrngAlgoRelease)(void *context)
Definition: crypto.h:841
@ CIPHER_MODE_OFB
Definition: crypto.h:817
@ CIPHER_MODE_GCM
Definition: crypto.h:820
Legacy definitions.
@ CIPHER_ALGO_TYPE_BLOCK
Definition: crypto.h:802
size_t digestSize
Definition: crypto.h:858
const char_t * name
Definition: crypto.h:875
HashAlgoUpdate update
Definition: crypto.h:863
CipherAlgoType
Encryption algorithm type.
Definition: crypto.h:800
size_t blockSize
Definition: crypto.h:878
error_t(* PrngAlgoAddEntropy)(void *context, uint_t source, const uint8_t *input, size_t length, size_t entropy)
Definition: crypto.h:843
size_t blockSize
Definition: crypto.h:857
size_t contextSize
Definition: crypto.h:894
@ CIPHER_MODE_CTR
Definition: crypto.h:818
const char_t * name
Definition: crypto.h:893
@ CIPHER_MODE_ECB
Definition: crypto.h:814
CipherAlgoEncryptBlock encryptBlock
Definition: crypto.h:882
void(* HashAlgoUpdate)(void *context, const void *data, size_t length)
Definition: crypto.h:828
size_t contextSize
Definition: crypto.h:856
size_t oidSize
Definition: crypto.h:855
CipherAlgoInit init
Definition: crypto.h:879
CipherAlgoEncryptStream encryptStream
Definition: crypto.h:880
PrngAlgoRelease release
Definition: crypto.h:896
error_t
Error codes.
Definition: error.h:43
@ CIPHER_MODE_CFB
Definition: crypto.h:816
HashAlgoCompute compute
Definition: crypto.h:861
CipherAlgoType type
Definition: crypto.h:877
void(* CipherAlgoDecryptBlock)(void *context, const uint8_t *input, uint8_t *output)
Definition: crypto.h:837
const char_t * name
Definition: crypto.h:853
void(* CipherAlgoEncryptStream)(void *context, const uint8_t *input, uint8_t *output, size_t length)
Definition: crypto.h:834
PrngAlgoInit init
Definition: crypto.h:895
CipherAlgoDecryptStream decryptStream
Definition: crypto.h:881
Error codes description.
PrngAlgoSeed seed
Definition: crypto.h:897
@ CIPHER_MODE_STREAM
Definition: crypto.h:813
Byte order conversion.
CipherMode
Cipher operation modes.
Definition: crypto.h:811
error_t(* PrngAlgoRead)(void *context, uint8_t *output, size_t length)
Definition: crypto.h:844
error_t(* CipherAlgoInit)(void *context, const uint8_t *key, size_t keyLen)
Definition: crypto.h:833
PrngAlgoAddEntropy addEntropy
Definition: crypto.h:898
void(* HashAlgoFinal)(void *context, uint8_t *digest)
Definition: crypto.h:829
char char_t
Definition: compiler_port.h:43
@ CIPHER_MODE_CCM
Definition: crypto.h:819
size_t contextSize
Definition: crypto.h:876
size_t minPadSize
Definition: crypto.h:859
Common interface for encryption algorithms.
Definition: crypto.h:874
@ CIPHER_ALGO_TYPE_STREAM
Definition: crypto.h:801
Common interface for hash algorithms.
Definition: crypto.h:852
@ CIPHER_MODE_NULL
Definition: crypto.h:812
@ CIPHER_MODE_CHACHA20_POLY1305
Definition: crypto.h:821
bool_t bigEndian
Definition: crypto.h:860
unsigned int uint_t
Definition: compiler_port.h:45
error_t(* HashAlgoCompute)(const void *data, size_t length, uint8_t *digest)
Definition: crypto.h:826
error_t(* PrngAlgoSeed)(void *context, const uint8_t *input, size_t length)
Definition: crypto.h:842
error_t(* PrngAlgoInit)(void *context)
Definition: crypto.h:840
void(* HashAlgoFinalRaw)(void *context, uint8_t *digest)
Definition: crypto.h:830
RTOS abstraction layer.
HashAlgoFinalRaw finalRaw
Definition: crypto.h:865