Mbed TLS v4.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
crypto_values.h
Go to the documentation of this file.
1 
22 /*
23  * Copyright The Mbed TLS Contributors
24  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
25  */
26 
27 #ifndef PSA_CRYPTO_VALUES_H
28 #define PSA_CRYPTO_VALUES_H
29 #include "mbedtls/private_access.h"
30 #include <psa/crypto_types.h>
31 
36 /* PSA error codes */
37 
38 /* Error codes are standardized across PSA domains (framework, crypto, storage,
39  * etc.). Do not change the values in this section or even the expansions
40  * of each macro: it must be possible to `#include` both this header
41  * and some other PSA component's headers in the same C source,
42  * which will lead to duplicate definitions of the `PSA_SUCCESS` and
43  * `PSA_ERROR_xxx` macros, which is ok if and only if the macros expand
44  * to the same sequence of tokens.
45  *
46  * If you must add a new
47  * value, check with the Arm PSA framework group to pick one that other
48  * domains aren't already using. */
49 
50 /* Tell uncrustify not to touch the constant definitions, otherwise
51  * it might change the spacing to something that is not PSA-compliant
52  * (e.g. adding a space after casts).
53  *
54  * *INDENT-OFF*
55  */
56 
58 #define PSA_SUCCESS ((psa_status_t)0)
59 
65 #define PSA_ERROR_GENERIC_ERROR ((psa_status_t)-132)
66 
74 #define PSA_ERROR_NOT_SUPPORTED ((psa_status_t)-134)
75 
87 #define PSA_ERROR_NOT_PERMITTED ((psa_status_t)-133)
88 
99 #define PSA_ERROR_BUFFER_TOO_SMALL ((psa_status_t)-138)
100 
105 #define PSA_ERROR_ALREADY_EXISTS ((psa_status_t)-139)
106 
111 #define PSA_ERROR_DOES_NOT_EXIST ((psa_status_t)-140)
112 
127 #define PSA_ERROR_BAD_STATE ((psa_status_t)-137)
128 
138 #define PSA_ERROR_INVALID_ARGUMENT ((psa_status_t)-135)
139 
144 #define PSA_ERROR_INSUFFICIENT_MEMORY ((psa_status_t)-141)
145 
153 #define PSA_ERROR_INSUFFICIENT_STORAGE ((psa_status_t)-142)
154 
170 #define PSA_ERROR_COMMUNICATION_FAILURE ((psa_status_t)-145)
171 
195 #define PSA_ERROR_STORAGE_FAILURE ((psa_status_t)-146)
196 
201 #define PSA_ERROR_HARDWARE_FAILURE ((psa_status_t)-147)
202 
232 #define PSA_ERROR_CORRUPTION_DETECTED ((psa_status_t)-151)
233 
251 #define PSA_ERROR_INSUFFICIENT_ENTROPY ((psa_status_t)-148)
252 
261 #define PSA_ERROR_INVALID_SIGNATURE ((psa_status_t)-149)
262 
277 #define PSA_ERROR_INVALID_PADDING ((psa_status_t)-150)
278 
281 #define PSA_ERROR_INSUFFICIENT_DATA ((psa_status_t)-143)
282 
286 #define PSA_ERROR_SERVICE_FAILURE ((psa_status_t)-144)
287 
290 #define PSA_ERROR_INVALID_HANDLE ((psa_status_t)-136)
291 
314 #define PSA_ERROR_DATA_CORRUPT ((psa_status_t)-152)
315 
330 #define PSA_ERROR_DATA_INVALID ((psa_status_t)-153)
331 
337 #define PSA_OPERATION_INCOMPLETE ((psa_status_t)-248)
338 
339 /* *INDENT-ON* */
340 
347 /* Note that key type values, including ECC family and DH group values, are
348  * embedded in the persistent key store, as part of key metadata. As a
349  * consequence, they must not be changed (unless the storage format version
350  * changes).
351  */
352 
357 #define PSA_KEY_TYPE_NONE ((psa_key_type_t) 0x0000)
358 
366 #define PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t) 0x8000)
367 
368 #define PSA_KEY_TYPE_CATEGORY_MASK ((psa_key_type_t) 0x7000)
369 #define PSA_KEY_TYPE_CATEGORY_RAW ((psa_key_type_t) 0x1000)
370 #define PSA_KEY_TYPE_CATEGORY_SYMMETRIC ((psa_key_type_t) 0x2000)
371 #define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY ((psa_key_type_t) 0x4000)
372 #define PSA_KEY_TYPE_CATEGORY_KEY_PAIR ((psa_key_type_t) 0x7000)
373 
374 #define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR ((psa_key_type_t) 0x3000)
375 
380 #define PSA_KEY_TYPE_IS_VENDOR_DEFINED(type) \
381  (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)
382 
387 #define PSA_KEY_TYPE_IS_UNSTRUCTURED(type) \
388  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
389  ((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)
390 
392 #define PSA_KEY_TYPE_IS_ASYMMETRIC(type) \
393  (((type) & PSA_KEY_TYPE_CATEGORY_MASK \
394  & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
395  PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
396 
397 #define PSA_KEY_TYPE_IS_PUBLIC_KEY(type) \
398  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
399 
401 #define PSA_KEY_TYPE_IS_KEY_PAIR(type) \
402  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)
403 
413 #define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type) \
414  ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
415 
425 #define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) \
426  ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
427 
432 #define PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t) 0x1001)
433 
442 #define PSA_KEY_TYPE_HMAC ((psa_key_type_t) 0x1100)
443 
455 #define PSA_KEY_TYPE_DERIVE ((psa_key_type_t) 0x1200)
456 
478 #define PSA_KEY_TYPE_PASSWORD ((psa_key_type_t) 0x1203)
479 
486 #define PSA_KEY_TYPE_PASSWORD_HASH ((psa_key_type_t) 0x1205)
487 
493 #define PSA_KEY_TYPE_PEPPER ((psa_key_type_t) 0x1206)
494 
500 #define PSA_KEY_TYPE_AES ((psa_key_type_t) 0x2400)
501 
504 #define PSA_KEY_TYPE_ARIA ((psa_key_type_t) 0x2406)
505 
508 #define PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t) 0x2403)
509 
521 #define PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t) 0x2004)
522 
527 #define PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t) 0x4001)
528 
532 #define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t) 0x7001)
533 
534 #define PSA_KEY_TYPE_IS_RSA(type) \
535  (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)
536 
537 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE ((psa_key_type_t) 0x4100)
538 #define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE ((psa_key_type_t) 0x7100)
539 #define PSA_KEY_TYPE_ECC_CURVE_MASK ((psa_key_type_t) 0x00ff)
540 
549 #define PSA_KEY_TYPE_ECC_KEY_PAIR(curve) \
550  (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
551 
560 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve) \
561  (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
562 
564 #define PSA_KEY_TYPE_IS_ECC(type) \
565  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
566  ~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
567 
568 #define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type) \
569  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
570  PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)
571 
572 #define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type) \
573  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
574  PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
575 
576 #define PSA_KEY_TYPE_HAS_ECC_FAMILY(type) \
577  (PSA_KEY_TYPE_IS_ECC(type) || PSA_KEY_TYPE_IS_SPAKE2P(type))
578 
580 #define PSA_KEY_TYPE_ECC_GET_FAMILY(type) \
581  ((psa_ecc_family_t) (PSA_KEY_TYPE_HAS_ECC_FAMILY(type) ? \
582  ((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
583  0))
584 
586 #define PSA_ECC_FAMILY_IS_WEIERSTRASS(family) ((family & 0xc0) == 0)
587 
596 #define PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t) 0x17)
597 
606 #define PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t) 0x12)
607 /* SECP160R2 (SEC2 v1, obsolete, not supported in Mbed TLS) */
608 #define PSA_ECC_FAMILY_SECP_R2 ((psa_ecc_family_t) 0x1b)
609 
620 #define PSA_ECC_FAMILY_SECT_K1 ((psa_ecc_family_t) 0x27)
621 
632 #define PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t) 0x22)
633 
644 #define PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t) 0x2b)
645 
656 #define PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t) 0x30)
657 
668 #define PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t) 0x41)
669 
686 #define PSA_ECC_FAMILY_TWISTED_EDWARDS ((psa_ecc_family_t) 0x42)
687 
688 #define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE ((psa_key_type_t) 0x4200)
689 #define PSA_KEY_TYPE_DH_KEY_PAIR_BASE ((psa_key_type_t) 0x7200)
690 #define PSA_KEY_TYPE_DH_GROUP_MASK ((psa_key_type_t) 0x00ff)
691 
696 #define PSA_KEY_TYPE_DH_KEY_PAIR(group) \
697  (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))
698 
703 #define PSA_KEY_TYPE_DH_PUBLIC_KEY(group) \
704  (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))
705 
707 #define PSA_KEY_TYPE_IS_DH(type) \
708  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
709  ~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
710 
711 #define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type) \
712  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
713  PSA_KEY_TYPE_DH_KEY_PAIR_BASE)
714 
715 #define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type) \
716  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
717  PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
718 
720 #define PSA_KEY_TYPE_DH_GET_FAMILY(type) \
721  ((psa_dh_family_t) (PSA_KEY_TYPE_IS_DH(type) ? \
722  ((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
723  0))
724 
731 #define PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t) 0x03)
732 
733 #define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) \
734  (((type) >> 8) & 7)
735 
753 #define PSA_BLOCK_CIPHER_BLOCK_LENGTH(type) \
754  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
755  1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
756  0u)
757 
758 /* Note that algorithm values are embedded in the persistent key store,
759  * as part of key metadata. As a consequence, they must not be changed
760  * (unless the storage format version changes).
761  */
762 
770 #define PSA_ALG_VENDOR_FLAG ((psa_algorithm_t) 0x80000000)
771 
772 #define PSA_ALG_CATEGORY_MASK ((psa_algorithm_t) 0x7f000000)
773 #define PSA_ALG_CATEGORY_HASH ((psa_algorithm_t) 0x02000000)
774 #define PSA_ALG_CATEGORY_MAC ((psa_algorithm_t) 0x03000000)
775 #define PSA_ALG_CATEGORY_CIPHER ((psa_algorithm_t) 0x04000000)
776 #define PSA_ALG_CATEGORY_AEAD ((psa_algorithm_t) 0x05000000)
777 #define PSA_ALG_CATEGORY_SIGN ((psa_algorithm_t) 0x06000000)
778 #define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION ((psa_algorithm_t) 0x07000000)
779 #define PSA_ALG_CATEGORY_KEY_DERIVATION ((psa_algorithm_t) 0x08000000)
780 #define PSA_ALG_CATEGORY_KEY_AGREEMENT ((psa_algorithm_t) 0x09000000)
781 
786 #define PSA_ALG_IS_VENDOR_DEFINED(alg) \
787  (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
788 
797 #define PSA_ALG_IS_HASH(alg) \
798  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
799 
808 #define PSA_ALG_IS_MAC(alg) \
809  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
810 
819 #define PSA_ALG_IS_CIPHER(alg) \
820  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
821 
831 #define PSA_ALG_IS_AEAD(alg) \
832  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
833 
843 #define PSA_ALG_IS_SIGN(alg) \
844  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
845 
855 #define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg) \
856  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
857 
866 #define PSA_ALG_IS_KEY_AGREEMENT(alg) \
867  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
868 
877 #define PSA_ALG_IS_KEY_DERIVATION(alg) \
878  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)
879 
894 #define PSA_ALG_IS_KEY_DERIVATION_STRETCHING(alg) \
895  (PSA_ALG_IS_KEY_DERIVATION(alg) && \
896  (alg) & PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG)
897 
899 /* *INDENT-OFF* (https://github.com/ARM-software/psa-arch-tests/issues/337) */
900 #define PSA_ALG_NONE ((psa_algorithm_t)0)
901 /* *INDENT-ON* */
902 
903 #define PSA_ALG_HASH_MASK ((psa_algorithm_t) 0x000000ff)
904 
905 #define PSA_ALG_MD5 ((psa_algorithm_t) 0x02000003)
906 
907 #define PSA_ALG_RIPEMD160 ((psa_algorithm_t) 0x02000004)
908 
909 #define PSA_ALG_SHA_1 ((psa_algorithm_t) 0x02000005)
910 
911 #define PSA_ALG_SHA_224 ((psa_algorithm_t) 0x02000008)
912 
913 #define PSA_ALG_SHA_256 ((psa_algorithm_t) 0x02000009)
914 
915 #define PSA_ALG_SHA_384 ((psa_algorithm_t) 0x0200000a)
916 
917 #define PSA_ALG_SHA_512 ((psa_algorithm_t) 0x0200000b)
918 
919 #define PSA_ALG_SHA_512_224 ((psa_algorithm_t) 0x0200000c)
920 
921 #define PSA_ALG_SHA_512_256 ((psa_algorithm_t) 0x0200000d)
922 
923 #define PSA_ALG_SHA3_224 ((psa_algorithm_t) 0x02000010)
924 
925 #define PSA_ALG_SHA3_256 ((psa_algorithm_t) 0x02000011)
926 
927 #define PSA_ALG_SHA3_384 ((psa_algorithm_t) 0x02000012)
928 
929 #define PSA_ALG_SHA3_512 ((psa_algorithm_t) 0x02000013)
930 
936 #define PSA_ALG_SHAKE256_512 ((psa_algorithm_t) 0x02000015)
937 
971 #define PSA_ALG_ANY_HASH ((psa_algorithm_t) 0x020000ff)
972 
973 #define PSA_ALG_MAC_SUBCATEGORY_MASK ((psa_algorithm_t) 0x00c00000)
974 #define PSA_ALG_HMAC_BASE ((psa_algorithm_t) 0x03800000)
975 
986 #define PSA_ALG_HMAC(hash_alg) \
987  (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
988 
989 #define PSA_ALG_HMAC_GET_HASH(hmac_alg) \
990  (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))
991 
1002 #define PSA_ALG_IS_HMAC(alg) \
1003  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
1004  PSA_ALG_HMAC_BASE)
1005 
1006 /* In the encoding of a MAC algorithm, the bits corresponding to
1007  * PSA_ALG_MAC_TRUNCATION_MASK encode the length to which the MAC is
1008  * truncated. As an exception, the value 0 means the untruncated algorithm,
1009  * whatever its length is. The length is encoded in 6 bits, so it can
1010  * reach up to 63; the largest MAC is 64 bytes so its trivial truncation
1011  * to full length is correctly encoded as 0 and any non-trivial truncation
1012  * is correctly encoded as a value between 1 and 63. */
1013 #define PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t) 0x003f0000)
1014 #define PSA_MAC_TRUNCATION_OFFSET 16
1015 
1016 /* In the encoding of a MAC algorithm, the bit corresponding to
1017  * #PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG encodes the fact that the algorithm
1018  * is a wildcard algorithm. A key with such wildcard algorithm as permitted
1019  * algorithm policy can be used with any algorithm corresponding to the
1020  * same base class and having a (potentially truncated) MAC length greater or
1021  * equal than the one encoded in #PSA_ALG_MAC_TRUNCATION_MASK. */
1022 #define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ((psa_algorithm_t) 0x00008000)
1023 
1057 #define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length) \
1058  (((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
1059  PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)) | \
1060  ((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))
1061 
1074 #define PSA_ALG_FULL_LENGTH_MAC(mac_alg) \
1075  ((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
1076  PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG))
1077 
1089 #define PSA_MAC_TRUNCATED_LENGTH(mac_alg) \
1090  (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)
1091 
1116 #define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(mac_alg, min_mac_length) \
1117  (PSA_ALG_TRUNCATED_MAC(mac_alg, min_mac_length) | \
1118  PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)
1119 
1120 #define PSA_ALG_CIPHER_MAC_BASE ((psa_algorithm_t) 0x03c00000)
1121 
1126 #define PSA_ALG_CBC_MAC ((psa_algorithm_t) 0x03c00100)
1127 
1128 #define PSA_ALG_CMAC ((psa_algorithm_t) 0x03c00200)
1129 
1138 #define PSA_ALG_IS_BLOCK_CIPHER_MAC(alg) \
1139  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
1140  PSA_ALG_CIPHER_MAC_BASE)
1141 
1142 #define PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t) 0x00800000)
1143 #define PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
1144 
1157 #define PSA_ALG_IS_STREAM_CIPHER(alg) \
1158  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
1159  (PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))
1160 
1166 #define PSA_ALG_STREAM_CIPHER ((psa_algorithm_t) 0x04800100)
1167 
1175 #define PSA_ALG_CTR ((psa_algorithm_t) 0x04c01000)
1176 
1181 #define PSA_ALG_CFB ((psa_algorithm_t) 0x04c01100)
1182 
1187 #define PSA_ALG_OFB ((psa_algorithm_t) 0x04c01200)
1188 
1195 #define PSA_ALG_XTS ((psa_algorithm_t) 0x0440ff00)
1196 
1215 #define PSA_ALG_ECB_NO_PADDING ((psa_algorithm_t) 0x04404400)
1216 
1224 #define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t) 0x04404000)
1225 
1232 #define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t) 0x04404100)
1233 
1234 #define PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
1235 
1245 #define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) \
1246  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
1247  (PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))
1248 
1253 #define PSA_ALG_CCM ((psa_algorithm_t) 0x05500100)
1254 
1264 #define PSA_ALG_CCM_STAR_NO_TAG ((psa_algorithm_t) 0x04c01300)
1265 
1270 #define PSA_ALG_GCM ((psa_algorithm_t) 0x05500200)
1271 
1281 #define PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t) 0x05100500)
1282 
1283 /* In the encoding of an AEAD algorithm, the bits corresponding to
1284  * PSA_ALG_AEAD_TAG_LENGTH_MASK encode the length of the AEAD tag.
1285  * The constants for default lengths follow this encoding.
1286  */
1287 #define PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t) 0x003f0000)
1288 #define PSA_AEAD_TAG_LENGTH_OFFSET 16
1289 
1290 /* In the encoding of an AEAD algorithm, the bit corresponding to
1291  * #PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG encodes the fact that the algorithm
1292  * is a wildcard algorithm. A key with such wildcard algorithm as permitted
1293  * algorithm policy can be used with any algorithm corresponding to the
1294  * same base class and having a tag length greater than or equal to the one
1295  * encoded in #PSA_ALG_AEAD_TAG_LENGTH_MASK. */
1296 #define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ((psa_algorithm_t) 0x00008000)
1297 
1316 #define PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, tag_length) \
1317  (((aead_alg) & ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | \
1318  PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)) | \
1319  ((tag_length) << PSA_AEAD_TAG_LENGTH_OFFSET & \
1320  PSA_ALG_AEAD_TAG_LENGTH_MASK))
1321 
1332 #define PSA_ALG_AEAD_GET_TAG_LENGTH(aead_alg) \
1333  (((aead_alg) & PSA_ALG_AEAD_TAG_LENGTH_MASK) >> \
1334  PSA_AEAD_TAG_LENGTH_OFFSET)
1335 
1344 #define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(aead_alg) \
1345  ( \
1346  PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CCM) \
1347  PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_GCM) \
1348  PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CHACHA20_POLY1305) \
1349  0)
1350 #define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, ref) \
1351  PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, 0) == \
1352  PSA_ALG_AEAD_WITH_SHORTENED_TAG(ref, 0) ? \
1353  ref :
1354 
1379 #define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(aead_alg, min_tag_length) \
1380  (PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, min_tag_length) | \
1381  PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)
1382 
1383 #define PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t) 0x06000200)
1384 
1399 #define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg) \
1400  (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1401 
1407 #define PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE
1408 #define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) \
1409  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)
1410 
1411 #define PSA_ALG_RSA_PSS_BASE ((psa_algorithm_t) 0x06000300)
1412 #define PSA_ALG_RSA_PSS_ANY_SALT_BASE ((psa_algorithm_t) 0x06001300)
1413 
1433 #define PSA_ALG_RSA_PSS(hash_alg) \
1434  (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1435 
1451 #define PSA_ALG_RSA_PSS_ANY_SALT(hash_alg) \
1452  (PSA_ALG_RSA_PSS_ANY_SALT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1453 
1465 #define PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) \
1466  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)
1467 
1479 #define PSA_ALG_IS_RSA_PSS_ANY_SALT(alg) \
1480  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_ANY_SALT_BASE)
1481 
1497 #define PSA_ALG_IS_RSA_PSS(alg) \
1498  (PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) || \
1499  PSA_ALG_IS_RSA_PSS_ANY_SALT(alg))
1500 
1501 #define PSA_ALG_ECDSA_BASE ((psa_algorithm_t) 0x06000600)
1502 
1522 #define PSA_ALG_ECDSA(hash_alg) \
1523  (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1524 
1533 #define PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE
1534 #define PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t) 0x06000700)
1535 
1557 #define PSA_ALG_DETERMINISTIC_ECDSA(hash_alg) \
1558  (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1559 #define PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t) 0x00000100)
1560 #define PSA_ALG_IS_ECDSA(alg) \
1561  (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
1562  PSA_ALG_ECDSA_BASE)
1563 #define PSA_ALG_ECDSA_IS_DETERMINISTIC(alg) \
1564  (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)
1565 #define PSA_ALG_IS_DETERMINISTIC_ECDSA(alg) \
1566  (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1567 #define PSA_ALG_IS_RANDOMIZED_ECDSA(alg) \
1568  (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1569 
1598 #define PSA_ALG_PURE_EDDSA ((psa_algorithm_t) 0x06000800)
1599 
1600 #define PSA_ALG_HASH_EDDSA_BASE ((psa_algorithm_t) 0x06000900)
1601 #define PSA_ALG_IS_HASH_EDDSA(alg) \
1602  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HASH_EDDSA_BASE)
1603 
1625 #define PSA_ALG_ED25519PH \
1626  (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHA_512 & PSA_ALG_HASH_MASK))
1627 
1650 #define PSA_ALG_ED448PH \
1651  (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHAKE256_512 & PSA_ALG_HASH_MASK))
1652 
1653 /* Default definition, to be overridden if the library is extended with
1654  * more hash-and-sign algorithms that we want to keep out of this header
1655  * file. */
1656 #define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg) 0
1657 
1675 #define PSA_ALG_IS_SIGN_HASH(alg) \
1676  (PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
1677  PSA_ALG_IS_ECDSA(alg) || PSA_ALG_IS_HASH_EDDSA(alg) || \
1678  PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg))
1679 
1691 #define PSA_ALG_IS_SIGN_MESSAGE(alg) \
1692  (PSA_ALG_IS_SIGN_HASH(alg) || (alg) == PSA_ALG_PURE_EDDSA)
1693 
1720 #define PSA_ALG_IS_HASH_AND_SIGN(alg) \
1721  (PSA_ALG_IS_SIGN_HASH(alg) && \
1722  ((alg) & PSA_ALG_HASH_MASK) != 0)
1723 
1742 #define PSA_ALG_SIGN_GET_HASH(alg) \
1743  (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1744  ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1745  0)
1746 
1756 #define PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t) 0x07000200)
1757 
1758 #define PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t) 0x07000300)
1759 
1773 #define PSA_ALG_RSA_OAEP(hash_alg) \
1774  (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1775 #define PSA_ALG_IS_RSA_OAEP(alg) \
1776  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)
1777 #define PSA_ALG_RSA_OAEP_GET_HASH(alg) \
1778  (PSA_ALG_IS_RSA_OAEP(alg) ? \
1779  ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1780  0)
1781 
1782 #define PSA_ALG_HKDF_BASE ((psa_algorithm_t) 0x08000100)
1783 
1809 #define PSA_ALG_HKDF(hash_alg) \
1810  (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1811 
1822 #define PSA_ALG_IS_HKDF(alg) \
1823  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)
1824 #define PSA_ALG_HKDF_GET_HASH(hkdf_alg) \
1825  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1826 
1827 #define PSA_ALG_HKDF_EXTRACT_BASE ((psa_algorithm_t) 0x08000400)
1828 
1860 #define PSA_ALG_HKDF_EXTRACT(hash_alg) \
1861  (PSA_ALG_HKDF_EXTRACT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1862 
1873 #define PSA_ALG_IS_HKDF_EXTRACT(alg) \
1874  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXTRACT_BASE)
1875 
1876 #define PSA_ALG_HKDF_EXPAND_BASE ((psa_algorithm_t) 0x08000500)
1877 
1902 #define PSA_ALG_HKDF_EXPAND(hash_alg) \
1903  (PSA_ALG_HKDF_EXPAND_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1904 
1915 #define PSA_ALG_IS_HKDF_EXPAND(alg) \
1916  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXPAND_BASE)
1917 
1928 #define PSA_ALG_IS_ANY_HKDF(alg) \
1929  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE || \
1930  ((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXTRACT_BASE || \
1931  ((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXPAND_BASE)
1932 
1933 #define PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t) 0x08000200)
1934 
1960 #define PSA_ALG_TLS12_PRF(hash_alg) \
1961  (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1962 
1971 #define PSA_ALG_IS_TLS12_PRF(alg) \
1972  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)
1973 #define PSA_ALG_TLS12_PRF_GET_HASH(hkdf_alg) \
1974  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1975 
1976 #define PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t) 0x08000300)
1977 
2023 #define PSA_ALG_TLS12_PSK_TO_MS(hash_alg) \
2024  (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
2025 
2034 #define PSA_ALG_IS_TLS12_PSK_TO_MS(alg) \
2035  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)
2036 #define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH(hkdf_alg) \
2037  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
2038 
2039 /* The TLS 1.2 ECJPAKE-to-PMS KDF. It takes the shared secret K (an EC point
2040  * in case of EC J-PAKE) and calculates SHA256(K.X) that the rest of TLS 1.2
2041  * will use to derive the session secret, as defined by step 2 of
2042  * https://datatracker.ietf.org/doc/html/draft-cragie-tls-ecjpake-01#section-8.7.
2043  * Uses PSA_ALG_SHA_256.
2044  * This function takes a single input:
2045  * #PSA_KEY_DERIVATION_INPUT_SECRET is the shared secret K from EC J-PAKE.
2046  * The only supported curve is secp256r1 (the 256-bit curve in
2047  * #PSA_ECC_FAMILY_SECP_R1), so the input must be exactly 65 bytes.
2048  * The output has to be read as a single chunk of 32 bytes, defined as
2049  * PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE.
2050  */
2051 #define PSA_ALG_TLS12_ECJPAKE_TO_PMS ((psa_algorithm_t) 0x08000609)
2052 
2053 /* This flag indicates whether the key derivation algorithm is suitable for
2054  * use on low-entropy secrets such as password - these algorithms are also
2055  * known as key stretching or password hashing schemes. These are also the
2056  * algorithms that accepts inputs of type #PSA_KEY_DERIVATION_INPUT_PASSWORD.
2057  *
2058  * Those algorithms cannot be combined with a key agreement algorithm.
2059  */
2060 #define PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG ((psa_algorithm_t) 0x00800000)
2061 
2062 #define PSA_ALG_PBKDF2_HMAC_BASE ((psa_algorithm_t) 0x08800100)
2063 
2089 #define PSA_ALG_PBKDF2_HMAC(hash_alg) \
2090  (PSA_ALG_PBKDF2_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
2091 
2100 #define PSA_ALG_IS_PBKDF2_HMAC(alg) \
2101  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_PBKDF2_HMAC_BASE)
2102 #define PSA_ALG_PBKDF2_HMAC_GET_HASH(pbkdf2_alg) \
2103  (PSA_ALG_CATEGORY_HASH | ((pbkdf2_alg) & PSA_ALG_HASH_MASK))
2104 
2113 #define PSA_ALG_PBKDF2_AES_CMAC_PRF_128 ((psa_algorithm_t) 0x08800200)
2114 
2115 #define PSA_ALG_IS_PBKDF2(kdf_alg) \
2116  (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg) || \
2117  ((kdf_alg) == PSA_ALG_PBKDF2_AES_CMAC_PRF_128))
2118 
2119 #define PSA_ALG_KEY_DERIVATION_MASK ((psa_algorithm_t) 0xfe00ffff)
2120 #define PSA_ALG_KEY_AGREEMENT_MASK ((psa_algorithm_t) 0xffff0000)
2121 
2136 #define PSA_ALG_KEY_AGREEMENT(ka_alg, kdf_alg) \
2137  ((ka_alg) | (kdf_alg))
2138 
2139 #define PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) \
2140  (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)
2141 
2142 #define PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) \
2143  (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)
2144 
2159 #define PSA_ALG_IS_RAW_KEY_AGREEMENT(alg) \
2160  (PSA_ALG_IS_KEY_AGREEMENT(alg) && \
2161  PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == PSA_ALG_CATEGORY_KEY_DERIVATION)
2162 
2163 #define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT(alg) \
2164  ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))
2165 
2173 #define PSA_ALG_FFDH ((psa_algorithm_t) 0x09010000)
2174 
2187 #define PSA_ALG_IS_FFDH(alg) \
2188  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
2189 
2215 #define PSA_ALG_ECDH ((psa_algorithm_t) 0x09020000)
2216 
2231 #define PSA_ALG_IS_ECDH(alg) \
2232  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
2233 
2247 #define PSA_ALG_IS_WILDCARD(alg) \
2248  (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
2249  PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
2250  PSA_ALG_IS_MAC(alg) ? \
2251  (alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
2252  PSA_ALG_IS_AEAD(alg) ? \
2253  (alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
2254  (alg) == PSA_ALG_ANY_HASH)
2255 
2265 #define PSA_ALG_GET_HASH(alg) \
2266  (((alg) & 0x000000ff) == 0 ? ((psa_algorithm_t) 0) : 0x02000000 | ((alg) & 0x000000ff))
2267 
2274 /* Note that location and persistence level values are embedded in the
2275  * persistent key store, as part of key metadata. As a consequence, they
2276  * must not be changed (unless the storage format version changes).
2277  */
2278 
2290 #define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t) 0x00000000)
2291 
2304 #define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t) 0x00000001)
2305 
2310 #define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t) 0x00)
2311 
2316 #define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t) 0x01)
2317 
2322 #define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t) 0xff)
2323 
2324 #define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \
2325  ((psa_key_persistence_t) ((lifetime) & 0x000000ff))
2326 
2327 #define PSA_KEY_LIFETIME_GET_LOCATION(lifetime) \
2328  ((psa_key_location_t) ((lifetime) >> 8))
2329 
2346 #define PSA_KEY_LIFETIME_IS_VOLATILE(lifetime) \
2347  (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
2348  PSA_KEY_PERSISTENCE_VOLATILE)
2349 
2367 #define PSA_KEY_LIFETIME_IS_READ_ONLY(lifetime) \
2368  (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
2369  PSA_KEY_PERSISTENCE_READ_ONLY)
2370 
2380 #define PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(persistence, location) \
2381  ((location) << 8 | (persistence))
2382 
2390 #define PSA_KEY_LOCATION_LOCAL_STORAGE ((psa_key_location_t) 0x000000)
2391 
2392 #define PSA_KEY_LOCATION_VENDOR_FLAG ((psa_key_location_t) 0x800000)
2393 
2394 /* Note that key identifier values are embedded in the
2395  * persistent key store, as part of key metadata. As a consequence, they
2396  * must not be changed (unless the storage format version changes).
2397  */
2398 
2401 /* *INDENT-OFF* (https://github.com/ARM-software/psa-arch-tests/issues/337) */
2402 #define PSA_KEY_ID_NULL ((psa_key_id_t)0)
2403 /* *INDENT-ON* */
2406 #define PSA_KEY_ID_USER_MIN ((psa_key_id_t) 0x00000001)
2407 
2409 #define PSA_KEY_ID_USER_MAX ((psa_key_id_t) 0x3fffffff)
2410 
2412 #define PSA_KEY_ID_VENDOR_MIN ((psa_key_id_t) 0x40000000)
2413 
2415 #define PSA_KEY_ID_VENDOR_MAX ((psa_key_id_t) 0x7fffffff)
2416 
2417 
2418 #if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
2419 
2420 #define MBEDTLS_SVC_KEY_ID_INIT ((psa_key_id_t) 0)
2421 #define MBEDTLS_SVC_KEY_ID_GET_KEY_ID(id) (id)
2422 #define MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(id) (0)
2423 
2430  unsigned int unused, psa_key_id_t key_id)
2431 {
2432  (void) unused;
2433 
2434  return key_id;
2435 }
2436 
2444 static inline int mbedtls_svc_key_id_equal(mbedtls_svc_key_id_t id1,
2446 {
2447  return id1 == id2;
2448 }
2449 
2456 static inline int mbedtls_svc_key_id_is_null(mbedtls_svc_key_id_t key)
2457 {
2458  return key == 0;
2459 }
2460 
2461 #else /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
2462 
2463 #define MBEDTLS_SVC_KEY_ID_INIT ((mbedtls_svc_key_id_t){ 0, 0 })
2464 #define MBEDTLS_SVC_KEY_ID_GET_KEY_ID(id) ((id).MBEDTLS_PRIVATE(key_id))
2465 #define MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(id) ((id).MBEDTLS_PRIVATE(owner))
2466 
2473  mbedtls_key_owner_id_t owner_id, psa_key_id_t key_id)
2474 {
2475  return (mbedtls_svc_key_id_t){ .MBEDTLS_PRIVATE(key_id) = key_id,
2476  .MBEDTLS_PRIVATE(owner) = owner_id };
2477 }
2478 
2488 {
2489  return (id1.MBEDTLS_PRIVATE(key_id) == id2.MBEDTLS_PRIVATE(key_id)) &&
2490  mbedtls_key_owner_id_equal(id1.MBEDTLS_PRIVATE(owner), id2.MBEDTLS_PRIVATE(owner));
2491 }
2492 
2500 {
2501  return key.MBEDTLS_PRIVATE(key_id) == 0;
2502 }
2503 
2504 #endif /* !MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
2505 
2512 /* Note that key usage flags are embedded in the
2513  * persistent key store, as part of key metadata. As a consequence, they
2514  * must not be changed (unless the storage format version changes).
2515  */
2516 
2528 #define PSA_KEY_USAGE_EXPORT ((psa_key_usage_t) 0x00000001)
2529 
2544 #define PSA_KEY_USAGE_COPY ((psa_key_usage_t) 0x00000002)
2545 
2563 #define PSA_KEY_USAGE_DERIVE_PUBLIC ((psa_key_usage_t) 0x00000080)
2564 
2574 #define PSA_KEY_USAGE_ENCRYPT ((psa_key_usage_t) 0x00000100)
2575 
2585 #define PSA_KEY_USAGE_DECRYPT ((psa_key_usage_t) 0x00000200)
2586 
2595 #define PSA_KEY_USAGE_SIGN_MESSAGE ((psa_key_usage_t) 0x00000400)
2596 
2605 #define PSA_KEY_USAGE_VERIFY_MESSAGE ((psa_key_usage_t) 0x00000800)
2606 
2615 #define PSA_KEY_USAGE_SIGN_HASH ((psa_key_usage_t) 0x00001000)
2616 
2625 #define PSA_KEY_USAGE_VERIFY_HASH ((psa_key_usage_t) 0x00002000)
2626 
2639 #define PSA_KEY_USAGE_DERIVE ((psa_key_usage_t) 0x00004000)
2640 
2654 #define PSA_KEY_USAGE_VERIFY_DERIVATION ((psa_key_usage_t) 0x00008000)
2655 
2662 /* Key input steps are not embedded in the persistent storage, so you can
2663  * change them if needed: it's only an ABI change. */
2664 
2680 #define PSA_KEY_DERIVATION_INPUT_SECRET ((psa_key_derivation_step_t) 0x0101)
2681 
2698 #define PSA_KEY_DERIVATION_INPUT_PASSWORD ((psa_key_derivation_step_t) 0x0102)
2699 
2707 #define PSA_KEY_DERIVATION_INPUT_OTHER_SECRET \
2708  ((psa_key_derivation_step_t) 0x0103)
2709 
2715 #define PSA_KEY_DERIVATION_INPUT_LABEL ((psa_key_derivation_step_t) 0x0201)
2716 
2723 #define PSA_KEY_DERIVATION_INPUT_SALT ((psa_key_derivation_step_t) 0x0202)
2724 
2730 #define PSA_KEY_DERIVATION_INPUT_INFO ((psa_key_derivation_step_t) 0x0203)
2731 
2737 #define PSA_KEY_DERIVATION_INPUT_SEED ((psa_key_derivation_step_t) 0x0204)
2738 
2743 #define PSA_KEY_DERIVATION_INPUT_COST ((psa_key_derivation_step_t) 0x0205)
2744 
2751 /* Helper macros */
2752 
2764 #define MBEDTLS_PSA_ALG_AEAD_EQUAL(aead_alg_1, aead_alg_2) \
2765  (!(((aead_alg_1) ^ (aead_alg_2)) & \
2766  ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)))
2767 
2780 #define PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED UINT32_MAX
2781 
2784 #endif /* PSA_CRYPTO_VALUES_H */
PSA cryptography module: type aliases.
uint32_t psa_key_id_t
Definition: crypto_types.h:268
int32_t mbedtls_key_owner_id_t
static mbedtls_svc_key_id_t mbedtls_svc_key_id_make(mbedtls_key_owner_id_t owner_id, psa_key_id_t key_id)
static int mbedtls_key_owner_id_equal(mbedtls_key_owner_id_t id1, mbedtls_key_owner_id_t id2)
static int mbedtls_svc_key_id_equal(mbedtls_svc_key_id_t id1, mbedtls_svc_key_id_t id2)
static int mbedtls_svc_key_id_is_null(mbedtls_svc_key_id_t key)