TF-M Reference Manual  1.2.0
TrustedFirmware-M
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
crypto_values.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020, Arm Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  */
24 #ifndef PSA_CRYPTO_VALUES_H
25 #define PSA_CRYPTO_VALUES_H
26 
31 /* PSA error codes */
32 
34 #ifndef PSA_SUCCESS
35 #define PSA_SUCCESS ((psa_status_t)0)
36 #endif
37 
43 #define PSA_ERROR_GENERIC_ERROR ((psa_status_t)-132)
44 
52 #define PSA_ERROR_NOT_SUPPORTED ((psa_status_t)-134)
53 
65 #define PSA_ERROR_NOT_PERMITTED ((psa_status_t)-133)
66 
77 #define PSA_ERROR_BUFFER_TOO_SMALL ((psa_status_t)-138)
78 
83 #define PSA_ERROR_ALREADY_EXISTS ((psa_status_t)-139)
84 
89 #define PSA_ERROR_DOES_NOT_EXIST ((psa_status_t)-140)
90 
105 #define PSA_ERROR_BAD_STATE ((psa_status_t)-137)
106 
116 #define PSA_ERROR_INVALID_ARGUMENT ((psa_status_t)-135)
117 
122 #define PSA_ERROR_INSUFFICIENT_MEMORY ((psa_status_t)-141)
123 
131 #define PSA_ERROR_INSUFFICIENT_STORAGE ((psa_status_t)-142)
132 
148 #define PSA_ERROR_COMMUNICATION_FAILURE ((psa_status_t)-145)
149 
173 #define PSA_ERROR_STORAGE_FAILURE ((psa_status_t)-146)
174 
179 #define PSA_ERROR_HARDWARE_FAILURE ((psa_status_t)-147)
180 
210 #define PSA_ERROR_CORRUPTION_DETECTED ((psa_status_t)-151)
211 
229 #define PSA_ERROR_INSUFFICIENT_ENTROPY ((psa_status_t)-148)
230 
239 #define PSA_ERROR_INVALID_SIGNATURE ((psa_status_t)-149)
240 
255 #define PSA_ERROR_INVALID_PADDING ((psa_status_t)-150)
256 
259 #define PSA_ERROR_INSUFFICIENT_DATA ((psa_status_t)-143)
260 
263 #define PSA_ERROR_INVALID_HANDLE ((psa_status_t)-136)
264 
275 #define PSA_KEY_TYPE_NONE ((psa_key_type_t)0x0000)
276 
284 #define PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t)0x8000)
285 
286 #define PSA_KEY_TYPE_CATEGORY_MASK ((psa_key_type_t)0x7000)
287 #define PSA_KEY_TYPE_CATEGORY_RAW ((psa_key_type_t)0x1000)
288 #define PSA_KEY_TYPE_CATEGORY_SYMMETRIC ((psa_key_type_t)0x2000)
289 #define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY ((psa_key_type_t)0x4000)
290 #define PSA_KEY_TYPE_CATEGORY_KEY_PAIR ((psa_key_type_t)0x7000)
291 
292 #define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR ((psa_key_type_t)0x3000)
293 
298 #define PSA_KEY_TYPE_IS_VENDOR_DEFINED(type) \
299  (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)
300 
305 #define PSA_KEY_TYPE_IS_UNSTRUCTURED(type) \
306  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
307  ((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)
308 
310 #define PSA_KEY_TYPE_IS_ASYMMETRIC(type) \
311  (((type) & PSA_KEY_TYPE_CATEGORY_MASK \
312  & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
313  PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
314 
315 #define PSA_KEY_TYPE_IS_PUBLIC_KEY(type) \
316  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
317 
319 #define PSA_KEY_TYPE_IS_KEY_PAIR(type) \
320  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)
321 
331 #define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type) \
332  ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
333 
343 #define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) \
344  ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
345 
350 #define PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t)0x1001)
351 
360 #define PSA_KEY_TYPE_HMAC ((psa_key_type_t)0x1100)
361 
367 #define PSA_KEY_TYPE_DERIVE ((psa_key_type_t)0x1200)
368 
374 #define PSA_KEY_TYPE_AES ((psa_key_type_t)0x2400)
375 
385 #define PSA_KEY_TYPE_DES ((psa_key_type_t)0x2301)
386 
389 #define PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t)0x2403)
390 
395 #define PSA_KEY_TYPE_ARC4 ((psa_key_type_t)0x2002)
396 
404 #define PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t)0x2004)
405 
407 #define PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t)0x4001)
408 
409 #define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t)0x7001)
410 
411 #define PSA_KEY_TYPE_IS_RSA(type) \
412  (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)
413 
414 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE ((psa_key_type_t)0x4100)
415 #define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE ((psa_key_type_t)0x7100)
416 #define PSA_KEY_TYPE_ECC_CURVE_MASK ((psa_key_type_t)0x00ff)
417 
422 #define PSA_KEY_TYPE_ECC_KEY_PAIR(curve) \
423  (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
424 
429 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve) \
430  (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
431 
433 #define PSA_KEY_TYPE_IS_ECC(type) \
434  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
435  ~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
436 
437 #define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type) \
438  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
439  PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)
440 
441 #define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type) \
442  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
443  PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
444 
446 #define PSA_KEY_TYPE_ECC_GET_FAMILY(type) \
447  ((psa_ecc_family_t) (PSA_KEY_TYPE_IS_ECC(type) ? \
448  ((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
449  0))
450 
459 #define PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t) 0x17)
460 
469 #define PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t) 0x12)
470 /* SECP160R2 (SEC2 v1, obsolete) */
471 #define PSA_ECC_FAMILY_SECP_R2 ((psa_ecc_family_t) 0x1b)
472 
481 #define PSA_ECC_FAMILY_SECT_K1 ((psa_ecc_family_t) 0x27)
482 
491 #define PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t) 0x22)
492 
501 #define PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t) 0x2b)
502 
510 #define PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t) 0x30)
511 
522 #define PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t) 0x41)
523 
524 #define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE ((psa_key_type_t)0x4200)
525 #define PSA_KEY_TYPE_DH_KEY_PAIR_BASE ((psa_key_type_t)0x7200)
526 #define PSA_KEY_TYPE_DH_GROUP_MASK ((psa_key_type_t)0x00ff)
527 
532 #define PSA_KEY_TYPE_DH_KEY_PAIR(group) \
533  (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))
534 
539 #define PSA_KEY_TYPE_DH_PUBLIC_KEY(group) \
540  (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))
541 
543 #define PSA_KEY_TYPE_IS_DH(type) \
544  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
545  ~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
546 
547 #define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type) \
548  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
549  PSA_KEY_TYPE_DH_KEY_PAIR_BASE)
550 
551 #define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type) \
552  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
553  PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
554 
556 #define PSA_KEY_TYPE_DH_GET_FAMILY(type) \
557  ((psa_dh_family_t) (PSA_KEY_TYPE_IS_DH(type) ? \
558  ((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
559  0))
560 
567 #define PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t) 0x03)
568 
569 #define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) \
570  (((type) >> 8) & 7)
571 
589 #define PSA_BLOCK_CIPHER_BLOCK_SIZE(type) \
590  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
591  1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
592  0u)
593 
601 #define PSA_ALG_VENDOR_FLAG ((psa_algorithm_t)0x80000000)
602 
603 #define PSA_ALG_CATEGORY_MASK ((psa_algorithm_t)0x7f000000)
604 #define PSA_ALG_CATEGORY_HASH ((psa_algorithm_t)0x01000000)
605 #define PSA_ALG_CATEGORY_MAC ((psa_algorithm_t)0x02000000)
606 #define PSA_ALG_CATEGORY_CIPHER ((psa_algorithm_t)0x04000000)
607 #define PSA_ALG_CATEGORY_AEAD ((psa_algorithm_t)0x06000000)
608 #define PSA_ALG_CATEGORY_SIGN ((psa_algorithm_t)0x10000000)
609 #define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION ((psa_algorithm_t)0x12000000)
610 #define PSA_ALG_CATEGORY_KEY_DERIVATION ((psa_algorithm_t)0x20000000)
611 #define PSA_ALG_CATEGORY_KEY_AGREEMENT ((psa_algorithm_t)0x30000000)
612 
617 #define PSA_ALG_IS_VENDOR_DEFINED(alg) \
618  (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
619 
628 #define PSA_ALG_IS_HASH(alg) \
629  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
630 
639 #define PSA_ALG_IS_MAC(alg) \
640  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
641 
650 #define PSA_ALG_IS_CIPHER(alg) \
651  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
652 
662 #define PSA_ALG_IS_AEAD(alg) \
663  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
664 
674 #define PSA_ALG_IS_SIGN(alg) \
675  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
676 
686 #define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg) \
687  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
688 
697 #define PSA_ALG_IS_KEY_AGREEMENT(alg) \
698  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
699 
708 #define PSA_ALG_IS_KEY_DERIVATION(alg) \
709  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)
710 
711 #define PSA_ALG_HASH_MASK ((psa_algorithm_t)0x000000ff)
712 
713 #define PSA_ALG_MD2 ((psa_algorithm_t)0x01000001)
714 
715 #define PSA_ALG_MD4 ((psa_algorithm_t)0x01000002)
716 
717 #define PSA_ALG_MD5 ((psa_algorithm_t)0x01000003)
718 
719 #define PSA_ALG_RIPEMD160 ((psa_algorithm_t)0x01000004)
720 
721 #define PSA_ALG_SHA_1 ((psa_algorithm_t)0x01000005)
722 
723 #define PSA_ALG_SHA_224 ((psa_algorithm_t)0x01000008)
724 
725 #define PSA_ALG_SHA_256 ((psa_algorithm_t)0x01000009)
726 
727 #define PSA_ALG_SHA_384 ((psa_algorithm_t)0x0100000a)
728 
729 #define PSA_ALG_SHA_512 ((psa_algorithm_t)0x0100000b)
730 
731 #define PSA_ALG_SHA_512_224 ((psa_algorithm_t)0x0100000c)
732 
733 #define PSA_ALG_SHA_512_256 ((psa_algorithm_t)0x0100000d)
734 
735 #define PSA_ALG_SHA3_224 ((psa_algorithm_t)0x01000010)
736 
737 #define PSA_ALG_SHA3_256 ((psa_algorithm_t)0x01000011)
738 
739 #define PSA_ALG_SHA3_384 ((psa_algorithm_t)0x01000012)
740 
741 #define PSA_ALG_SHA3_512 ((psa_algorithm_t)0x01000013)
742 
776 #define PSA_ALG_ANY_HASH ((psa_algorithm_t)0x010000ff)
777 
778 #define PSA_ALG_MAC_SUBCATEGORY_MASK ((psa_algorithm_t)0x00c00000)
779 #define PSA_ALG_HMAC_BASE ((psa_algorithm_t)0x02800000)
780 
791 #define PSA_ALG_HMAC(hash_alg) \
792  (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
793 
794 #define PSA_ALG_HMAC_GET_HASH(hmac_alg) \
795  (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))
796 
807 #define PSA_ALG_IS_HMAC(alg) \
808  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
809  PSA_ALG_HMAC_BASE)
810 
811 /* In the encoding of a MAC algorithm, the bits corresponding to
812  * PSA_ALG_MAC_TRUNCATION_MASK encode the length to which the MAC is
813  * truncated. As an exception, the value 0 means the untruncated algorithm,
814  * whatever its length is. The length is encoded in 6 bits, so it can
815  * reach up to 63; the largest MAC is 64 bytes so its trivial truncation
816  * to full length is correctly encoded as 0 and any non-trivial truncation
817  * is correctly encoded as a value between 1 and 63. */
818 #define PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t)0x00003f00)
819 #define PSA_MAC_TRUNCATION_OFFSET 8
820 
854 #define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length) \
855  (((mac_alg) & ~PSA_ALG_MAC_TRUNCATION_MASK) | \
856  ((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))
857 
870 #define PSA_ALG_FULL_LENGTH_MAC(mac_alg) \
871  ((mac_alg) & ~PSA_ALG_MAC_TRUNCATION_MASK)
872 
884 #define PSA_MAC_TRUNCATED_LENGTH(mac_alg) \
885  (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)
886 
887 #define PSA_ALG_CIPHER_MAC_BASE ((psa_algorithm_t)0x02c00000)
888 
893 #define PSA_ALG_CBC_MAC ((psa_algorithm_t)0x02c00001)
894 
895 #define PSA_ALG_CMAC ((psa_algorithm_t)0x02c00002)
896 
905 #define PSA_ALG_IS_BLOCK_CIPHER_MAC(alg) \
906  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
907  PSA_ALG_CIPHER_MAC_BASE)
908 
909 #define PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t)0x00800000)
910 #define PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t)0x00400000)
911 
924 #define PSA_ALG_IS_STREAM_CIPHER(alg) \
925  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
926  (PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))
927 
930 #define PSA_ALG_ARC4 ((psa_algorithm_t)0x04800001)
931 
942 #define PSA_ALG_CHACHA20 ((psa_algorithm_t)0x04800005)
943 
951 #define PSA_ALG_CTR ((psa_algorithm_t)0x04c00001)
952 
957 #define PSA_ALG_CFB ((psa_algorithm_t)0x04c00002)
958 
963 #define PSA_ALG_OFB ((psa_algorithm_t)0x04c00003)
964 
971 #define PSA_ALG_XTS ((psa_algorithm_t)0x044000ff)
972 
980 #define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t)0x04600100)
981 
988 #define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t)0x04600101)
989 
990 #define PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t)0x00400000)
991 
1001 #define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) \
1002  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
1003  (PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))
1004 
1009 #define PSA_ALG_CCM ((psa_algorithm_t)0x06401001)
1010 
1015 #define PSA_ALG_GCM ((psa_algorithm_t)0x06401002)
1016 
1026 #define PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t)0x06001005)
1027 
1028 /* In the encoding of a AEAD algorithm, the bits corresponding to
1029  * PSA_ALG_AEAD_TAG_LENGTH_MASK encode the length of the AEAD tag.
1030  * The constants for default lengths follow this encoding.
1031  */
1032 #define PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t)0x00003f00)
1033 #define PSA_AEAD_TAG_LENGTH_OFFSET 8
1034 
1053 #define PSA_ALG_AEAD_WITH_TAG_LENGTH(aead_alg, tag_length) \
1054  (((aead_alg) & ~PSA_ALG_AEAD_TAG_LENGTH_MASK) | \
1055  ((tag_length) << PSA_AEAD_TAG_LENGTH_OFFSET & \
1056  PSA_ALG_AEAD_TAG_LENGTH_MASK))
1057 
1066 #define PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH(aead_alg) \
1067  ( \
1068  PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, PSA_ALG_CCM) \
1069  PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, PSA_ALG_GCM) \
1070  PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, PSA_ALG_CHACHA20_POLY1305) \
1071  0)
1072 #define PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, ref) \
1073  PSA_ALG_AEAD_WITH_TAG_LENGTH(aead_alg, 0) == \
1074  PSA_ALG_AEAD_WITH_TAG_LENGTH(ref, 0) ? \
1075  ref :
1076 
1077 #define PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t)0x10020000)
1078 
1093 #define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg) \
1094  (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1095 
1101 #define PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE
1102 #define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) \
1103  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)
1104 
1105 #define PSA_ALG_RSA_PSS_BASE ((psa_algorithm_t)0x10030000)
1106 
1124 #define PSA_ALG_RSA_PSS(hash_alg) \
1125  (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1126 #define PSA_ALG_IS_RSA_PSS(alg) \
1127  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)
1128 
1129 #define PSA_ALG_ECDSA_BASE ((psa_algorithm_t)0x10060000)
1130 
1150 #define PSA_ALG_ECDSA(hash_alg) \
1151  (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1152 
1161 #define PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE
1162 #define PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t)0x10070000)
1163 
1185 #define PSA_ALG_DETERMINISTIC_ECDSA(hash_alg) \
1186  (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1187 #define PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t)0x00010000)
1188 #define PSA_ALG_IS_ECDSA(alg) \
1189  (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
1190  PSA_ALG_ECDSA_BASE)
1191 #define PSA_ALG_ECDSA_IS_DETERMINISTIC(alg) \
1192  (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)
1193 #define PSA_ALG_IS_DETERMINISTIC_ECDSA(alg) \
1194  (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1195 #define PSA_ALG_IS_RANDOMIZED_ECDSA(alg) \
1196  (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1197 
1211 #define PSA_ALG_IS_HASH_AND_SIGN(alg) \
1212  (PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
1213  PSA_ALG_IS_ECDSA(alg))
1214 
1233 #define PSA_ALG_SIGN_GET_HASH(alg) \
1234  (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1235  ((alg) & PSA_ALG_HASH_MASK) == 0 ? /*"raw" algorithm*/ 0 : \
1236  ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1237  0)
1238 
1241 #define PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t)0x12020000)
1242 
1243 #define PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t)0x12030000)
1244 
1258 #define PSA_ALG_RSA_OAEP(hash_alg) \
1259  (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1260 #define PSA_ALG_IS_RSA_OAEP(alg) \
1261  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)
1262 #define PSA_ALG_RSA_OAEP_GET_HASH(alg) \
1263  (PSA_ALG_IS_RSA_OAEP(alg) ? \
1264  ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1265  0)
1266 
1267 #define PSA_ALG_HKDF_BASE ((psa_algorithm_t)0x20000100)
1268 
1288 #define PSA_ALG_HKDF(hash_alg) \
1289  (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1290 
1301 #define PSA_ALG_IS_HKDF(alg) \
1302  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)
1303 #define PSA_ALG_HKDF_GET_HASH(hkdf_alg) \
1304  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1305 
1306 #define PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t)0x20000200)
1307 
1333 #define PSA_ALG_TLS12_PRF(hash_alg) \
1334  (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1335 
1344 #define PSA_ALG_IS_TLS12_PRF(alg) \
1345  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)
1346 #define PSA_ALG_TLS12_PRF_GET_HASH(hkdf_alg) \
1347  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1348 
1349 #define PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t)0x20000300)
1350 
1379 #define PSA_ALG_TLS12_PSK_TO_MS(hash_alg) \
1380  (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1381 
1390 #define PSA_ALG_IS_TLS12_PSK_TO_MS(alg) \
1391  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)
1392 #define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH(hkdf_alg) \
1393  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1394 
1395 #define PSA_ALG_KEY_DERIVATION_MASK ((psa_algorithm_t)0x0803ffff)
1396 #define PSA_ALG_KEY_AGREEMENT_MASK ((psa_algorithm_t)0x10fc0000)
1397 
1412 #define PSA_ALG_KEY_AGREEMENT(ka_alg, kdf_alg) \
1413  ((ka_alg) | (kdf_alg))
1414 
1415 #define PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) \
1416  (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)
1417 
1418 #define PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) \
1419  (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)
1420 
1435 #define PSA_ALG_IS_RAW_KEY_AGREEMENT(alg) \
1436  (PSA_ALG_IS_KEY_AGREEMENT(alg) && \
1437  PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == PSA_ALG_CATEGORY_KEY_DERIVATION)
1438 
1439 #define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT(alg) \
1440  ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))
1441 
1449 #define PSA_ALG_FFDH ((psa_algorithm_t)0x30100000)
1450 
1463 #define PSA_ALG_IS_FFDH(alg) \
1464  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
1465 
1491 #define PSA_ALG_ECDH ((psa_algorithm_t)0x30200000)
1492 
1507 #define PSA_ALG_IS_ECDH(alg) \
1508  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
1509 
1523 #define PSA_ALG_IS_WILDCARD(alg) \
1524  (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1525  PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
1526  (alg) == PSA_ALG_ANY_HASH)
1527 
1545 #define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t)0x00000000)
1546 
1560 #define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t)0x00000001)
1561 
1566 #define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t)0x00)
1567 
1572 #define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t)0x01)
1573 
1578 #define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t)0xff)
1579 
1580 #define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \
1581  ((psa_key_persistence_t)((lifetime) & 0x000000ff))
1582 
1583 #define PSA_KEY_LIFETIME_GET_LOCATION(lifetime) \
1584  ((psa_key_location_t)((lifetime) >> 8))
1585 
1602 #define PSA_KEY_LIFETIME_IS_VOLATILE(lifetime) \
1603  (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
1604  PSA_KEY_PERSISTENCE_VOLATILE)
1605 
1615 #define PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(persistence, location) \
1616  ((location) << 8 | (persistence))
1617 
1625 #define PSA_KEY_LOCATION_LOCAL_STORAGE ((psa_key_location_t)0x000000)
1626 
1627 #define PSA_KEY_LOCATION_VENDOR_FLAG ((psa_key_location_t)0x800000)
1628 
1631 #define PSA_KEY_ID_USER_MIN ((psa_key_id_t)0x00000001)
1632 
1634 #define PSA_KEY_ID_USER_MAX ((psa_key_id_t)0x3fffffff)
1635 
1637 #define PSA_KEY_ID_VENDOR_MIN ((psa_key_id_t)0x40000000)
1638 
1640 #define PSA_KEY_ID_VENDOR_MAX ((psa_key_id_t)0x7fffffff)
1641 
1659 #define PSA_KEY_USAGE_EXPORT ((psa_key_usage_t)0x00000001)
1660 
1675 #define PSA_KEY_USAGE_COPY ((psa_key_usage_t)0x00000002)
1676 
1686 #define PSA_KEY_USAGE_ENCRYPT ((psa_key_usage_t)0x00000100)
1687 
1697 #define PSA_KEY_USAGE_DECRYPT ((psa_key_usage_t)0x00000200)
1698 
1707 #define PSA_KEY_USAGE_SIGN_HASH ((psa_key_usage_t)0x00000400)
1708 
1717 #define PSA_KEY_USAGE_VERIFY_HASH ((psa_key_usage_t)0x00000800)
1718 
1721 #define PSA_KEY_USAGE_DERIVE ((psa_key_usage_t)0x00001000)
1722 
1741 #define PSA_KEY_DERIVATION_INPUT_SECRET ((psa_key_derivation_step_t)0x0101)
1742 
1748 #define PSA_KEY_DERIVATION_INPUT_LABEL ((psa_key_derivation_step_t)0x0201)
1749 
1755 #define PSA_KEY_DERIVATION_INPUT_SALT ((psa_key_derivation_step_t)0x0202)
1756 
1762 #define PSA_KEY_DERIVATION_INPUT_INFO ((psa_key_derivation_step_t)0x0203)
1763 
1769 #define PSA_KEY_DERIVATION_INPUT_SEED ((psa_key_derivation_step_t)0x0204)
1770 
1773 #endif /* PSA_CRYPTO_VALUES_H */