Mbed TLS v4.1.1
Loading...
Searching...
No Matches
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
35
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
342
346
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)
532#define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t) 0x7001)
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)
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)
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#define PSA_ALG_CATEGORY_XOF ((psa_algorithm_t) 0x0d000000)
782
787#define PSA_ALG_IS_VENDOR_DEFINED(alg) \
788 (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
789
798#define PSA_ALG_IS_HASH(alg) \
799 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
800
809#define PSA_ALG_IS_MAC(alg) \
810 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
811
820#define PSA_ALG_IS_CIPHER(alg) \
821 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
822
832#define PSA_ALG_IS_AEAD(alg) \
833 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
834
844#define PSA_ALG_IS_SIGN(alg) \
845 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
846
856#define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg) \
857 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
858
867#define PSA_ALG_IS_KEY_AGREEMENT(alg) \
868 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
869
878#define PSA_ALG_IS_KEY_DERIVATION(alg) \
879 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)
880
895#define PSA_ALG_IS_KEY_DERIVATION_STRETCHING(alg) \
896 (PSA_ALG_IS_KEY_DERIVATION(alg) && \
897 (alg) & PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG)
898
908#define PSA_ALG_IS_XOF(alg) \
909 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_XOF)
910
912/* *INDENT-OFF* (https://github.com/ARM-software/psa-arch-tests/issues/337) */
913#define PSA_ALG_NONE ((psa_algorithm_t)0)
914/* *INDENT-ON* */
915
916#define PSA_ALG_HASH_MASK ((psa_algorithm_t) 0x000000ff)
918#define PSA_ALG_MD5 ((psa_algorithm_t) 0x02000003)
920#define PSA_ALG_RIPEMD160 ((psa_algorithm_t) 0x02000004)
922#define PSA_ALG_SHA_1 ((psa_algorithm_t) 0x02000005)
924#define PSA_ALG_SHA_224 ((psa_algorithm_t) 0x02000008)
926#define PSA_ALG_SHA_256 ((psa_algorithm_t) 0x02000009)
928#define PSA_ALG_SHA_384 ((psa_algorithm_t) 0x0200000a)
930#define PSA_ALG_SHA_512 ((psa_algorithm_t) 0x0200000b)
932#define PSA_ALG_SHA_512_224 ((psa_algorithm_t) 0x0200000c)
934#define PSA_ALG_SHA_512_256 ((psa_algorithm_t) 0x0200000d)
936#define PSA_ALG_SHA3_224 ((psa_algorithm_t) 0x02000010)
938#define PSA_ALG_SHA3_256 ((psa_algorithm_t) 0x02000011)
940#define PSA_ALG_SHA3_384 ((psa_algorithm_t) 0x02000012)
942#define PSA_ALG_SHA3_512 ((psa_algorithm_t) 0x02000013)
949#define PSA_ALG_SHAKE256_512 ((psa_algorithm_t) 0x02000015)
950
984#define PSA_ALG_ANY_HASH ((psa_algorithm_t) 0x020000ff)
985
991#define PSA_ALG_SHAKE128 ((psa_algorithm_t) 0x0d000100)
992
998#define PSA_ALG_SHAKE256 ((psa_algorithm_t) 0x0d000200)
999
1000#define PSA_ALG_XOF_CONTEXT_FLAG ((psa_algorithm_t) 0x00008000)
1013#define PSA_ALG_XOF_HAS_CONTEXT(xof_alg) \
1014 (((xof_alg) & PSA_ALG_XOF_CONTEXT_FLAG) != 0)
1015
1016#define PSA_ALG_MAC_SUBCATEGORY_MASK ((psa_algorithm_t) 0x00c00000)
1017#define PSA_ALG_HMAC_BASE ((psa_algorithm_t) 0x03800000)
1029#define PSA_ALG_HMAC(hash_alg) \
1030 (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1031
1032#define PSA_ALG_HMAC_GET_HASH(hmac_alg) \
1033 (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))
1034
1045#define PSA_ALG_IS_HMAC(alg) \
1046 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
1047 PSA_ALG_HMAC_BASE)
1048
1049/* In the encoding of a MAC algorithm, the bits corresponding to
1050 * PSA_ALG_MAC_TRUNCATION_MASK encode the length to which the MAC is
1051 * truncated. As an exception, the value 0 means the untruncated algorithm,
1052 * whatever its length is. The length is encoded in 6 bits, so it can
1053 * reach up to 63; the largest MAC is 64 bytes so its trivial truncation
1054 * to full length is correctly encoded as 0 and any non-trivial truncation
1055 * is correctly encoded as a value between 1 and 63. */
1056#define PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t) 0x003f0000)
1057#define PSA_MAC_TRUNCATION_OFFSET 16
1058
1059/* In the encoding of a MAC algorithm, the bit corresponding to
1060 * #PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG encodes the fact that the algorithm
1061 * is a wildcard algorithm. A key with such wildcard algorithm as permitted
1062 * algorithm policy can be used with any algorithm corresponding to the
1063 * same base class and having a (potentially truncated) MAC length greater or
1064 * equal than the one encoded in #PSA_ALG_MAC_TRUNCATION_MASK. */
1065#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ((psa_algorithm_t) 0x00008000)
1066
1100#define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length) \
1101 (((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
1102 PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)) | \
1103 ((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))
1104
1117#define PSA_ALG_FULL_LENGTH_MAC(mac_alg) \
1118 ((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
1119 PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG))
1120
1132#define PSA_MAC_TRUNCATED_LENGTH(mac_alg) \
1133 (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)
1134
1159#define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(mac_alg, min_mac_length) \
1160 (PSA_ALG_TRUNCATED_MAC(mac_alg, min_mac_length) | \
1161 PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)
1162
1163#define PSA_ALG_CIPHER_MAC_BASE ((psa_algorithm_t) 0x03c00000)
1169#define PSA_ALG_CBC_MAC ((psa_algorithm_t) 0x03c00100)
1171#define PSA_ALG_CMAC ((psa_algorithm_t) 0x03c00200)
1172
1181#define PSA_ALG_IS_BLOCK_CIPHER_MAC(alg) \
1182 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
1183 PSA_ALG_CIPHER_MAC_BASE)
1184
1185#define PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t) 0x00800000)
1186#define PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
1187
1200#define PSA_ALG_IS_STREAM_CIPHER(alg) \
1201 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
1202 (PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))
1203
1209#define PSA_ALG_STREAM_CIPHER ((psa_algorithm_t) 0x04800100)
1210
1218#define PSA_ALG_CTR ((psa_algorithm_t) 0x04c01000)
1219
1224#define PSA_ALG_CFB ((psa_algorithm_t) 0x04c01100)
1225
1230#define PSA_ALG_OFB ((psa_algorithm_t) 0x04c01200)
1231
1238#define PSA_ALG_XTS ((psa_algorithm_t) 0x0440ff00)
1239
1258#define PSA_ALG_ECB_NO_PADDING ((psa_algorithm_t) 0x04404400)
1259
1267#define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t) 0x04404000)
1268
1275#define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t) 0x04404100)
1276
1277#define PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
1278
1288#define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) \
1289 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
1290 (PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))
1291
1296#define PSA_ALG_CCM ((psa_algorithm_t) 0x05500100)
1297
1307#define PSA_ALG_CCM_STAR_NO_TAG ((psa_algorithm_t) 0x04c01300)
1308
1313#define PSA_ALG_GCM ((psa_algorithm_t) 0x05500200)
1314
1324#define PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t) 0x05100500)
1325
1326/* In the encoding of an AEAD algorithm, the bits corresponding to
1327 * PSA_ALG_AEAD_TAG_LENGTH_MASK encode the length of the AEAD tag.
1328 * The constants for default lengths follow this encoding.
1329 */
1330#define PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t) 0x003f0000)
1331#define PSA_AEAD_TAG_LENGTH_OFFSET 16
1332
1333/* In the encoding of an AEAD algorithm, the bit corresponding to
1334 * #PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG encodes the fact that the algorithm
1335 * is a wildcard algorithm. A key with such wildcard algorithm as permitted
1336 * algorithm policy can be used with any algorithm corresponding to the
1337 * same base class and having a tag length greater than or equal to the one
1338 * encoded in #PSA_ALG_AEAD_TAG_LENGTH_MASK. */
1339#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ((psa_algorithm_t) 0x00008000)
1340
1359#define PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, tag_length) \
1360 (((aead_alg) & ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | \
1361 PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)) | \
1362 ((tag_length) << PSA_AEAD_TAG_LENGTH_OFFSET & \
1363 PSA_ALG_AEAD_TAG_LENGTH_MASK))
1364
1375#define PSA_ALG_AEAD_GET_TAG_LENGTH(aead_alg) \
1376 (((aead_alg) & PSA_ALG_AEAD_TAG_LENGTH_MASK) >> \
1377 PSA_AEAD_TAG_LENGTH_OFFSET)
1378
1387#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(aead_alg) \
1388 ( \
1389 PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CCM) \
1390 PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_GCM) \
1391 PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CHACHA20_POLY1305) \
1392 0)
1393#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, ref) \
1394 PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, 0) == \
1395 PSA_ALG_AEAD_WITH_SHORTENED_TAG(ref, 0) ? \
1396 ref :
1397
1422#define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(aead_alg, min_tag_length) \
1423 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, min_tag_length) | \
1424 PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)
1425
1426#define PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t) 0x06000200)
1442#define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg) \
1443 (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1444
1450#define PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE
1451#define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) \
1452 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)
1453
1454#define PSA_ALG_RSA_PSS_BASE ((psa_algorithm_t) 0x06000300)
1455#define PSA_ALG_RSA_PSS_ANY_SALT_BASE ((psa_algorithm_t) 0x06001300)
1476#define PSA_ALG_RSA_PSS(hash_alg) \
1477 (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1478
1494#define PSA_ALG_RSA_PSS_ANY_SALT(hash_alg) \
1495 (PSA_ALG_RSA_PSS_ANY_SALT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1496
1508#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) \
1509 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)
1510
1522#define PSA_ALG_IS_RSA_PSS_ANY_SALT(alg) \
1523 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_ANY_SALT_BASE)
1524
1540#define PSA_ALG_IS_RSA_PSS(alg) \
1541 (PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) || \
1542 PSA_ALG_IS_RSA_PSS_ANY_SALT(alg))
1543
1544#define PSA_ALG_ECDSA_BASE ((psa_algorithm_t) 0x06000600)
1565#define PSA_ALG_ECDSA(hash_alg) \
1566 (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1567
1576#define PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE
1577#define PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t) 0x06000700)
1600#define PSA_ALG_DETERMINISTIC_ECDSA(hash_alg) \
1601 (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1602#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t) 0x00000100)
1603#define PSA_ALG_IS_ECDSA(alg) \
1604 (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
1605 PSA_ALG_ECDSA_BASE)
1606#define PSA_ALG_ECDSA_IS_DETERMINISTIC(alg) \
1607 (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)
1608#define PSA_ALG_IS_DETERMINISTIC_ECDSA(alg) \
1609 (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1610#define PSA_ALG_IS_RANDOMIZED_ECDSA(alg) \
1611 (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1612
1641#define PSA_ALG_PURE_EDDSA ((psa_algorithm_t) 0x06000800)
1642
1643#define PSA_ALG_HASH_EDDSA_BASE ((psa_algorithm_t) 0x06000900)
1644#define PSA_ALG_IS_HASH_EDDSA(alg) \
1645 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HASH_EDDSA_BASE)
1646
1668#define PSA_ALG_ED25519PH \
1669 (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHA_512 & PSA_ALG_HASH_MASK))
1670
1693#define PSA_ALG_ED448PH \
1694 (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHAKE256_512 & PSA_ALG_HASH_MASK))
1695
1696/* Default definition, to be overridden if the library is extended with
1697 * more hash-and-sign algorithms that we want to keep out of this header
1698 * file. */
1699#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg) 0
1700
1718#define PSA_ALG_IS_SIGN_HASH(alg) \
1719 (PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
1720 PSA_ALG_IS_ECDSA(alg) || PSA_ALG_IS_HASH_EDDSA(alg) || \
1721 PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg))
1722
1734#define PSA_ALG_IS_SIGN_MESSAGE(alg) \
1735 (PSA_ALG_IS_SIGN_HASH(alg) || (alg) == PSA_ALG_PURE_EDDSA)
1736
1763#define PSA_ALG_IS_HASH_AND_SIGN(alg) \
1764 (PSA_ALG_IS_SIGN_HASH(alg) && \
1765 ((alg) & PSA_ALG_HASH_MASK) != 0)
1766
1785#define PSA_ALG_SIGN_GET_HASH(alg) \
1786 (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1787 ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1788 0)
1789
1799#define PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t) 0x07000200)
1800
1801#define PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t) 0x07000300)
1816#define PSA_ALG_RSA_OAEP(hash_alg) \
1817 (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1818#define PSA_ALG_IS_RSA_OAEP(alg) \
1819 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)
1820#define PSA_ALG_RSA_OAEP_GET_HASH(alg) \
1821 (PSA_ALG_IS_RSA_OAEP(alg) ? \
1822 ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1823 0)
1824
1825#define PSA_ALG_HKDF_BASE ((psa_algorithm_t) 0x08000100)
1852#define PSA_ALG_HKDF(hash_alg) \
1853 (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1854
1865#define PSA_ALG_IS_HKDF(alg) \
1866 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)
1867#define PSA_ALG_HKDF_GET_HASH(hkdf_alg) \
1868 (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1869
1870#define PSA_ALG_HKDF_EXTRACT_BASE ((psa_algorithm_t) 0x08000400)
1903#define PSA_ALG_HKDF_EXTRACT(hash_alg) \
1904 (PSA_ALG_HKDF_EXTRACT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1905
1916#define PSA_ALG_IS_HKDF_EXTRACT(alg) \
1917 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXTRACT_BASE)
1918
1919#define PSA_ALG_HKDF_EXPAND_BASE ((psa_algorithm_t) 0x08000500)
1945#define PSA_ALG_HKDF_EXPAND(hash_alg) \
1946 (PSA_ALG_HKDF_EXPAND_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1947
1958#define PSA_ALG_IS_HKDF_EXPAND(alg) \
1959 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXPAND_BASE)
1960
1971#define PSA_ALG_IS_ANY_HKDF(alg) \
1972 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE || \
1973 ((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXTRACT_BASE || \
1974 ((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_EXPAND_BASE)
1975
1976#define PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t) 0x08000200)
2003#define PSA_ALG_TLS12_PRF(hash_alg) \
2004 (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
2005
2014#define PSA_ALG_IS_TLS12_PRF(alg) \
2015 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)
2016#define PSA_ALG_TLS12_PRF_GET_HASH(hkdf_alg) \
2017 (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
2018
2019#define PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t) 0x08000300)
2066#define PSA_ALG_TLS12_PSK_TO_MS(hash_alg) \
2067 (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
2068
2077#define PSA_ALG_IS_TLS12_PSK_TO_MS(alg) \
2078 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)
2079#define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH(hkdf_alg) \
2080 (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
2081
2082/* The TLS 1.2 ECJPAKE-to-PMS KDF. It takes the shared secret K (an EC point
2083 * in case of EC J-PAKE) and calculates SHA256(K.X) that the rest of TLS 1.2
2084 * will use to derive the session secret, as defined by step 2 of
2085 * https://datatracker.ietf.org/doc/html/draft-cragie-tls-ecjpake-01#section-8.7.
2086 * Uses PSA_ALG_SHA_256.
2087 * This function takes a single input:
2088 * #PSA_KEY_DERIVATION_INPUT_SECRET is the shared secret K from EC J-PAKE.
2089 * The only supported curve is secp256r1 (the 256-bit curve in
2090 * #PSA_ECC_FAMILY_SECP_R1), so the input must be exactly 65 bytes.
2091 * The output has to be read as a single chunk of 32 bytes, defined as
2092 * PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE.
2093 */
2094#define PSA_ALG_TLS12_ECJPAKE_TO_PMS ((psa_algorithm_t) 0x08000609)
2095
2096/* This flag indicates whether the key derivation algorithm is suitable for
2097 * use on low-entropy secrets such as password - these algorithms are also
2098 * known as key stretching or password hashing schemes. These are also the
2099 * algorithms that accepts inputs of type #PSA_KEY_DERIVATION_INPUT_PASSWORD.
2100 *
2101 * Those algorithms cannot be combined with a key agreement algorithm.
2102 */
2103#define PSA_ALG_KEY_DERIVATION_STRETCHING_FLAG ((psa_algorithm_t) 0x00800000)
2104
2105#define PSA_ALG_PBKDF2_HMAC_BASE ((psa_algorithm_t) 0x08800100)
2132#define PSA_ALG_PBKDF2_HMAC(hash_alg) \
2133 (PSA_ALG_PBKDF2_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
2134
2143#define PSA_ALG_IS_PBKDF2_HMAC(alg) \
2144 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_PBKDF2_HMAC_BASE)
2145#define PSA_ALG_PBKDF2_HMAC_GET_HASH(pbkdf2_alg) \
2146 (PSA_ALG_CATEGORY_HASH | ((pbkdf2_alg) & PSA_ALG_HASH_MASK))
2147
2156#define PSA_ALG_PBKDF2_AES_CMAC_PRF_128 ((psa_algorithm_t) 0x08800200)
2157
2158#define PSA_ALG_IS_PBKDF2(kdf_alg) \
2159 (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg) || \
2160 ((kdf_alg) == PSA_ALG_PBKDF2_AES_CMAC_PRF_128))
2161
2162#define PSA_ALG_KEY_DERIVATION_MASK ((psa_algorithm_t) 0xfe00ffff)
2163#define PSA_ALG_KEY_AGREEMENT_MASK ((psa_algorithm_t) 0xffff0000)
2164
2179#define PSA_ALG_KEY_AGREEMENT(ka_alg, kdf_alg) \
2180 ((ka_alg) | (kdf_alg))
2181
2182#define PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) \
2183 (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)
2184
2185#define PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) \
2186 (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)
2187
2202#define PSA_ALG_IS_RAW_KEY_AGREEMENT(alg) \
2203 (PSA_ALG_IS_KEY_AGREEMENT(alg) && \
2204 PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == PSA_ALG_CATEGORY_KEY_DERIVATION)
2205
2206#define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT(alg) \
2207 ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))
2208
2216#define PSA_ALG_FFDH ((psa_algorithm_t) 0x09010000)
2217
2230#define PSA_ALG_IS_FFDH(alg) \
2231 (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
2232
2258#define PSA_ALG_ECDH ((psa_algorithm_t) 0x09020000)
2259
2274#define PSA_ALG_IS_ECDH(alg) \
2275 (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
2276
2290#define PSA_ALG_IS_WILDCARD(alg) \
2291 (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
2292 PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
2293 PSA_ALG_IS_MAC(alg) ? \
2294 (alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
2295 PSA_ALG_IS_AEAD(alg) ? \
2296 (alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
2297 (alg) == PSA_ALG_ANY_HASH)
2298
2308#define PSA_ALG_GET_HASH(alg) \
2309 (((alg) & 0x000000ff) == 0 ? ((psa_algorithm_t) 0) : 0x02000000 | ((alg) & 0x000000ff))
2310
2312
2316
2317/* Note that location and persistence level values are embedded in the
2318 * persistent key store, as part of key metadata. As a consequence, they
2319 * must not be changed (unless the storage format version changes).
2320 */
2321
2333#define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t) 0x00000000)
2334
2347#define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t) 0x00000001)
2348
2353#define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t) 0x00)
2354
2359#define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t) 0x01)
2360
2365#define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t) 0xff)
2366
2367#define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \
2368 ((psa_key_persistence_t) ((lifetime) & 0x000000ff))
2369
2370#define PSA_KEY_LIFETIME_GET_LOCATION(lifetime) \
2371 ((psa_key_location_t) ((lifetime) >> 8))
2372
2389#define PSA_KEY_LIFETIME_IS_VOLATILE(lifetime) \
2390 (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
2391 PSA_KEY_PERSISTENCE_VOLATILE)
2392
2410#define PSA_KEY_LIFETIME_IS_READ_ONLY(lifetime) \
2411 (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
2412 PSA_KEY_PERSISTENCE_READ_ONLY)
2413
2423#define PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(persistence, location) \
2424 ((location) << 8 | (persistence))
2425
2433#define PSA_KEY_LOCATION_LOCAL_STORAGE ((psa_key_location_t) 0x000000)
2434
2435#define PSA_KEY_LOCATION_VENDOR_FLAG ((psa_key_location_t) 0x800000)
2436
2437/* Note that key identifier values are embedded in the
2438 * persistent key store, as part of key metadata. As a consequence, they
2439 * must not be changed (unless the storage format version changes).
2440 */
2441
2444/* *INDENT-OFF* (https://github.com/ARM-software/psa-arch-tests/issues/337) */
2445#define PSA_KEY_ID_NULL ((psa_key_id_t)0)
2446/* *INDENT-ON* */
2449#define PSA_KEY_ID_USER_MIN ((psa_key_id_t) 0x00000001)
2452#define PSA_KEY_ID_USER_MAX ((psa_key_id_t) 0x3fffffff)
2455#define PSA_KEY_ID_VENDOR_MIN ((psa_key_id_t) 0x40000000)
2458#define PSA_KEY_ID_VENDOR_MAX ((psa_key_id_t) 0x7fffffff)
2459
2460
2461#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
2462
2463#define MBEDTLS_SVC_KEY_ID_INIT ((psa_key_id_t) 0)
2464#define MBEDTLS_SVC_KEY_ID_GET_KEY_ID(id) (id)
2465#define MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(id) (0)
2466
2473 unsigned int unused, psa_key_id_t key_id)
2474{
2475 (void) unused;
2476
2477 return key_id;
2478}
2479
2489{
2490 return id1 == id2;
2491}
2492
2500{
2501 return key == 0;
2502}
2503
2504#else /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
2505
2506#define MBEDTLS_SVC_KEY_ID_INIT ((mbedtls_svc_key_id_t){ 0, 0 })
2507#define MBEDTLS_SVC_KEY_ID_GET_KEY_ID(id) ((id).MBEDTLS_PRIVATE(key_id))
2508#define MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(id) ((id).MBEDTLS_PRIVATE(owner))
2509
2516 mbedtls_key_owner_id_t owner_id, psa_key_id_t key_id)
2517{
2518 return (mbedtls_svc_key_id_t){ .MBEDTLS_PRIVATE(key_id) = key_id,
2519 .MBEDTLS_PRIVATE(owner) = owner_id };
2520}
2521
2531{
2532 return (id1.MBEDTLS_PRIVATE(key_id) == id2.MBEDTLS_PRIVATE(key_id)) &&
2533 mbedtls_key_owner_id_equal(id1.MBEDTLS_PRIVATE(owner), id2.MBEDTLS_PRIVATE(owner));
2534}
2535
2543{
2544 return key.MBEDTLS_PRIVATE(key_id) == 0;
2545}
2546
2547#endif /* !MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
2548
2550
2554
2555/* Note that key usage flags are embedded in the
2556 * persistent key store, as part of key metadata. As a consequence, they
2557 * must not be changed (unless the storage format version changes).
2558 */
2559
2571#define PSA_KEY_USAGE_EXPORT ((psa_key_usage_t) 0x00000001)
2572
2587#define PSA_KEY_USAGE_COPY ((psa_key_usage_t) 0x00000002)
2588
2606#define PSA_KEY_USAGE_DERIVE_PUBLIC ((psa_key_usage_t) 0x00000080)
2607
2617#define PSA_KEY_USAGE_ENCRYPT ((psa_key_usage_t) 0x00000100)
2618
2628#define PSA_KEY_USAGE_DECRYPT ((psa_key_usage_t) 0x00000200)
2629
2638#define PSA_KEY_USAGE_SIGN_MESSAGE ((psa_key_usage_t) 0x00000400)
2639
2648#define PSA_KEY_USAGE_VERIFY_MESSAGE ((psa_key_usage_t) 0x00000800)
2649
2658#define PSA_KEY_USAGE_SIGN_HASH ((psa_key_usage_t) 0x00001000)
2659
2668#define PSA_KEY_USAGE_VERIFY_HASH ((psa_key_usage_t) 0x00002000)
2669
2682#define PSA_KEY_USAGE_DERIVE ((psa_key_usage_t) 0x00004000)
2683
2697#define PSA_KEY_USAGE_VERIFY_DERIVATION ((psa_key_usage_t) 0x00008000)
2698
2700
2704
2705/* Key input steps are not embedded in the persistent storage, so you can
2706 * change them if needed: it's only an ABI change. */
2707
2723#define PSA_KEY_DERIVATION_INPUT_SECRET ((psa_key_derivation_step_t) 0x0101)
2724
2741#define PSA_KEY_DERIVATION_INPUT_PASSWORD ((psa_key_derivation_step_t) 0x0102)
2742
2750#define PSA_KEY_DERIVATION_INPUT_OTHER_SECRET \
2751 ((psa_key_derivation_step_t) 0x0103)
2752
2758#define PSA_KEY_DERIVATION_INPUT_LABEL ((psa_key_derivation_step_t) 0x0201)
2759
2766#define PSA_KEY_DERIVATION_INPUT_SALT ((psa_key_derivation_step_t) 0x0202)
2767
2773#define PSA_KEY_DERIVATION_INPUT_INFO ((psa_key_derivation_step_t) 0x0203)
2774
2780#define PSA_KEY_DERIVATION_INPUT_SEED ((psa_key_derivation_step_t) 0x0204)
2781
2786#define PSA_KEY_DERIVATION_INPUT_COST ((psa_key_derivation_step_t) 0x0205)
2787
2789
2793
2794/* Helper macros */
2795
2807#define MBEDTLS_PSA_ALG_AEAD_EQUAL(aead_alg_1, aead_alg_2) \
2808 (!(((aead_alg_1) ^ (aead_alg_2)) & \
2809 ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)))
2810
2812
2814
2818
2823#define PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED UINT32_MAX
2824
2826
2827#endif /* PSA_CRYPTO_VALUES_H */
PSA cryptography module: type aliases.
static mbedtls_svc_key_id_t mbedtls_svc_key_id_make(unsigned int unused, psa_key_id_t key_id)
uint32_t psa_key_id_t
static int mbedtls_svc_key_id_is_null(mbedtls_svc_key_id_t key)
psa_key_id_t mbedtls_svc_key_id_t
static int mbedtls_svc_key_id_equal(mbedtls_svc_key_id_t id1, mbedtls_svc_key_id_t id2)