mbed TLS v2.28.3
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
25 *
26 * Licensed under the Apache License, Version 2.0 (the "License"); you may
27 * not use this file except in compliance with the License.
28 * You may obtain a copy of the License at
29 *
30 * http://www.apache.org/licenses/LICENSE-2.0
31 *
32 * Unless required by applicable law or agreed to in writing, software
33 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
34 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35 * See the License for the specific language governing permissions and
36 * limitations under the License.
37 */
38
39#ifndef PSA_CRYPTO_VALUES_H
40#define PSA_CRYPTO_VALUES_H
41
46/* PSA error codes */
47
48/* Error codes are standardized across PSA domains (framework, crypto, storage,
49 * etc.). Do not change the values in this section or even the expansions
50 * of each macro: it must be possible to `#include` both this header
51 * and some other PSA component's headers in the same C source,
52 * which will lead to duplicate definitions of the `PSA_SUCCESS` and
53 * `PSA_ERROR_xxx` macros, which is ok if and only if the macros expand
54 * to the same sequence of tokens.
55 *
56 * If you must add a new
57 * value, check with the Arm PSA framework group to pick one that other
58 * domains aren't already using. */
59
60/* Tell uncrustify not to touch the constant definitions, otherwise
61 * it might change the spacing to something that is not PSA-compliant
62 * (e.g. adding a space after casts).
63 *
64 * *INDENT-OFF*
65 */
66
68#define PSA_SUCCESS ((psa_status_t)0)
69
75#define PSA_ERROR_GENERIC_ERROR ((psa_status_t)-132)
76
84#define PSA_ERROR_NOT_SUPPORTED ((psa_status_t)-134)
85
97#define PSA_ERROR_NOT_PERMITTED ((psa_status_t)-133)
98
109#define PSA_ERROR_BUFFER_TOO_SMALL ((psa_status_t)-138)
110
115#define PSA_ERROR_ALREADY_EXISTS ((psa_status_t)-139)
116
121#define PSA_ERROR_DOES_NOT_EXIST ((psa_status_t)-140)
122
137#define PSA_ERROR_BAD_STATE ((psa_status_t)-137)
138
148#define PSA_ERROR_INVALID_ARGUMENT ((psa_status_t)-135)
149
154#define PSA_ERROR_INSUFFICIENT_MEMORY ((psa_status_t)-141)
155
163#define PSA_ERROR_INSUFFICIENT_STORAGE ((psa_status_t)-142)
164
180#define PSA_ERROR_COMMUNICATION_FAILURE ((psa_status_t)-145)
181
205#define PSA_ERROR_STORAGE_FAILURE ((psa_status_t)-146)
206
211#define PSA_ERROR_HARDWARE_FAILURE ((psa_status_t)-147)
212
242#define PSA_ERROR_CORRUPTION_DETECTED ((psa_status_t)-151)
243
261#define PSA_ERROR_INSUFFICIENT_ENTROPY ((psa_status_t)-148)
262
271#define PSA_ERROR_INVALID_SIGNATURE ((psa_status_t)-149)
272
287#define PSA_ERROR_INVALID_PADDING ((psa_status_t)-150)
288
291#define PSA_ERROR_INSUFFICIENT_DATA ((psa_status_t)-143)
292
295#define PSA_ERROR_INVALID_HANDLE ((psa_status_t)-136)
296
319#define PSA_ERROR_DATA_CORRUPT ((psa_status_t)-152)
320
335#define PSA_ERROR_DATA_INVALID ((psa_status_t)-153)
336
337/* *INDENT-ON* */
338
345/* Note that key type values, including ECC family and DH group values, are
346 * embedded in the persistent key store, as part of key metadata. As a
347 * consequence, they must not be changed (unless the storage format version
348 * changes).
349 */
350
355#define PSA_KEY_TYPE_NONE ((psa_key_type_t) 0x0000)
356
364#define PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t) 0x8000)
365
366#define PSA_KEY_TYPE_CATEGORY_MASK ((psa_key_type_t) 0x7000)
367#define PSA_KEY_TYPE_CATEGORY_RAW ((psa_key_type_t) 0x1000)
368#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC ((psa_key_type_t) 0x2000)
369#define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY ((psa_key_type_t) 0x4000)
370#define PSA_KEY_TYPE_CATEGORY_KEY_PAIR ((psa_key_type_t) 0x7000)
371
372#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR ((psa_key_type_t) 0x3000)
373
378#define PSA_KEY_TYPE_IS_VENDOR_DEFINED(type) \
379 (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)
380
385#define PSA_KEY_TYPE_IS_UNSTRUCTURED(type) \
386 (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
387 ((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)
388
390#define PSA_KEY_TYPE_IS_ASYMMETRIC(type) \
391 (((type) & PSA_KEY_TYPE_CATEGORY_MASK \
392 & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
393 PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
395#define PSA_KEY_TYPE_IS_PUBLIC_KEY(type) \
396 (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
399#define PSA_KEY_TYPE_IS_KEY_PAIR(type) \
400 (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)
411#define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type) \
412 ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
423#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) \
424 ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
425
430#define PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t) 0x1001)
431
440#define PSA_KEY_TYPE_HMAC ((psa_key_type_t) 0x1100)
441
447#define PSA_KEY_TYPE_DERIVE ((psa_key_type_t) 0x1200)
448
454#define PSA_KEY_TYPE_AES ((psa_key_type_t) 0x2400)
455
458#define PSA_KEY_TYPE_ARIA ((psa_key_type_t) 0x2406)
459
469#define PSA_KEY_TYPE_DES ((psa_key_type_t) 0x2301)
470
473#define PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t) 0x2403)
474
479#define PSA_KEY_TYPE_ARC4 ((psa_key_type_t) 0x2002)
480
488#define PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t) 0x2004)
489
494#define PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t) 0x4001)
499#define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t) 0x7001)
501#define PSA_KEY_TYPE_IS_RSA(type) \
502 (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)
503
504#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE ((psa_key_type_t) 0x4100)
505#define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE ((psa_key_type_t) 0x7100)
506#define PSA_KEY_TYPE_ECC_CURVE_MASK ((psa_key_type_t) 0x00ff)
516#define PSA_KEY_TYPE_ECC_KEY_PAIR(curve) \
517 (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
527#define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve) \
528 (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
529
531#define PSA_KEY_TYPE_IS_ECC(type) \
532 ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
533 ~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
535#define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type) \
536 (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
537 PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)
539#define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type) \
540 (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
541 PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
542
544#define PSA_KEY_TYPE_ECC_GET_FAMILY(type) \
545 ((psa_ecc_family_t) (PSA_KEY_TYPE_IS_ECC(type) ? \
546 ((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
547 0))
548
557#define PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t) 0x17)
558
567#define PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t) 0x12)
568/* SECP160R2 (SEC2 v1, obsolete) */
569#define PSA_ECC_FAMILY_SECP_R2 ((psa_ecc_family_t) 0x1b)
570
579#define PSA_ECC_FAMILY_SECT_K1 ((psa_ecc_family_t) 0x27)
580
589#define PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t) 0x22)
590
599#define PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t) 0x2b)
600
608#define PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t) 0x30)
609
620#define PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t) 0x41)
621
636#define PSA_ECC_FAMILY_TWISTED_EDWARDS ((psa_ecc_family_t) 0x42)
637
638#define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE ((psa_key_type_t) 0x4200)
639#define PSA_KEY_TYPE_DH_KEY_PAIR_BASE ((psa_key_type_t) 0x7200)
640#define PSA_KEY_TYPE_DH_GROUP_MASK ((psa_key_type_t) 0x00ff)
646#define PSA_KEY_TYPE_DH_KEY_PAIR(group) \
647 (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))
653#define PSA_KEY_TYPE_DH_PUBLIC_KEY(group) \
654 (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))
655
657#define PSA_KEY_TYPE_IS_DH(type) \
658 ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
659 ~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
661#define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type) \
662 (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
663 PSA_KEY_TYPE_DH_KEY_PAIR_BASE)
665#define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type) \
666 (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
667 PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
668
670#define PSA_KEY_TYPE_DH_GET_FAMILY(type) \
671 ((psa_dh_family_t) (PSA_KEY_TYPE_IS_DH(type) ? \
672 ((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
673 0))
674
681#define PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t) 0x03)
682
683#define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) \
684 (((type) >> 8) & 7)
703#define PSA_BLOCK_CIPHER_BLOCK_LENGTH(type) \
704 (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
705 1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
706 0u)
707
708/* Note that algorithm values are embedded in the persistent key store,
709 * as part of key metadata. As a consequence, they must not be changed
710 * (unless the storage format version changes).
711 */
712
720#define PSA_ALG_VENDOR_FLAG ((psa_algorithm_t) 0x80000000)
721
722#define PSA_ALG_CATEGORY_MASK ((psa_algorithm_t) 0x7f000000)
723#define PSA_ALG_CATEGORY_HASH ((psa_algorithm_t) 0x02000000)
724#define PSA_ALG_CATEGORY_MAC ((psa_algorithm_t) 0x03000000)
725#define PSA_ALG_CATEGORY_CIPHER ((psa_algorithm_t) 0x04000000)
726#define PSA_ALG_CATEGORY_AEAD ((psa_algorithm_t) 0x05000000)
727#define PSA_ALG_CATEGORY_SIGN ((psa_algorithm_t) 0x06000000)
728#define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION ((psa_algorithm_t) 0x07000000)
729#define PSA_ALG_CATEGORY_KEY_DERIVATION ((psa_algorithm_t) 0x08000000)
730#define PSA_ALG_CATEGORY_KEY_AGREEMENT ((psa_algorithm_t) 0x09000000)
731
736#define PSA_ALG_IS_VENDOR_DEFINED(alg) \
737 (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
738
747#define PSA_ALG_IS_HASH(alg) \
748 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
749
758#define PSA_ALG_IS_MAC(alg) \
759 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
760
769#define PSA_ALG_IS_CIPHER(alg) \
770 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
771
781#define PSA_ALG_IS_AEAD(alg) \
782 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
783
793#define PSA_ALG_IS_SIGN(alg) \
794 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
795
805#define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg) \
806 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
807
816#define PSA_ALG_IS_KEY_AGREEMENT(alg) \
817 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
818
827#define PSA_ALG_IS_KEY_DERIVATION(alg) \
828 (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)
829
831/* *INDENT-OFF* (https://github.com/ARM-software/psa-arch-tests/issues/337) */
832#define PSA_ALG_NONE ((psa_algorithm_t)0)
833/* *INDENT-ON* */
834
835#define PSA_ALG_HASH_MASK ((psa_algorithm_t) 0x000000ff)
837#define PSA_ALG_MD2 ((psa_algorithm_t) 0x02000001)
839#define PSA_ALG_MD4 ((psa_algorithm_t) 0x02000002)
841#define PSA_ALG_MD5 ((psa_algorithm_t) 0x02000003)
843#define PSA_ALG_RIPEMD160 ((psa_algorithm_t) 0x02000004)
845#define PSA_ALG_SHA_1 ((psa_algorithm_t) 0x02000005)
847#define PSA_ALG_SHA_224 ((psa_algorithm_t) 0x02000008)
849#define PSA_ALG_SHA_256 ((psa_algorithm_t) 0x02000009)
851#define PSA_ALG_SHA_384 ((psa_algorithm_t) 0x0200000a)
853#define PSA_ALG_SHA_512 ((psa_algorithm_t) 0x0200000b)
855#define PSA_ALG_SHA_512_224 ((psa_algorithm_t) 0x0200000c)
857#define PSA_ALG_SHA_512_256 ((psa_algorithm_t) 0x0200000d)
859#define PSA_ALG_SHA3_224 ((psa_algorithm_t) 0x02000010)
861#define PSA_ALG_SHA3_256 ((psa_algorithm_t) 0x02000011)
863#define PSA_ALG_SHA3_384 ((psa_algorithm_t) 0x02000012)
865#define PSA_ALG_SHA3_512 ((psa_algorithm_t) 0x02000013)
872#define PSA_ALG_SHAKE256_512 ((psa_algorithm_t) 0x02000015)
873
907#define PSA_ALG_ANY_HASH ((psa_algorithm_t) 0x020000ff)
908
909#define PSA_ALG_MAC_SUBCATEGORY_MASK ((psa_algorithm_t) 0x00c00000)
910#define PSA_ALG_HMAC_BASE ((psa_algorithm_t) 0x03800000)
922#define PSA_ALG_HMAC(hash_alg) \
923 (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
924
925#define PSA_ALG_HMAC_GET_HASH(hmac_alg) \
926 (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))
927
938#define PSA_ALG_IS_HMAC(alg) \
939 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
940 PSA_ALG_HMAC_BASE)
941
942/* In the encoding of a MAC algorithm, the bits corresponding to
943 * PSA_ALG_MAC_TRUNCATION_MASK encode the length to which the MAC is
944 * truncated. As an exception, the value 0 means the untruncated algorithm,
945 * whatever its length is. The length is encoded in 6 bits, so it can
946 * reach up to 63; the largest MAC is 64 bytes so its trivial truncation
947 * to full length is correctly encoded as 0 and any non-trivial truncation
948 * is correctly encoded as a value between 1 and 63. */
949#define PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t) 0x003f0000)
950#define PSA_MAC_TRUNCATION_OFFSET 16
951
952/* In the encoding of a MAC algorithm, the bit corresponding to
953 * #PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG encodes the fact that the algorithm
954 * is a wildcard algorithm. A key with such wildcard algorithm as permitted
955 * algorithm policy can be used with any algorithm corresponding to the
956 * same base class and having a (potentially truncated) MAC length greater or
957 * equal than the one encoded in #PSA_ALG_MAC_TRUNCATION_MASK. */
958#define PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ((psa_algorithm_t) 0x00008000)
959
993#define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length) \
994 (((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
995 PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)) | \
996 ((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))
997
1010#define PSA_ALG_FULL_LENGTH_MAC(mac_alg) \
1011 ((mac_alg) & ~(PSA_ALG_MAC_TRUNCATION_MASK | \
1012 PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG))
1013
1025#define PSA_MAC_TRUNCATED_LENGTH(mac_alg) \
1026 (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)
1027
1052#define PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(mac_alg, min_mac_length) \
1053 (PSA_ALG_TRUNCATED_MAC(mac_alg, min_mac_length) | \
1054 PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG)
1055
1056#define PSA_ALG_CIPHER_MAC_BASE ((psa_algorithm_t) 0x03c00000)
1062#define PSA_ALG_CBC_MAC ((psa_algorithm_t) 0x03c00100)
1064#define PSA_ALG_CMAC ((psa_algorithm_t) 0x03c00200)
1065
1074#define PSA_ALG_IS_BLOCK_CIPHER_MAC(alg) \
1075 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
1076 PSA_ALG_CIPHER_MAC_BASE)
1077
1078#define PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t) 0x00800000)
1079#define PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
1080
1093#define PSA_ALG_IS_STREAM_CIPHER(alg) \
1094 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
1095 (PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))
1096
1103#define PSA_ALG_STREAM_CIPHER ((psa_algorithm_t) 0x04800100)
1104
1112#define PSA_ALG_CTR ((psa_algorithm_t) 0x04c01000)
1113
1118#define PSA_ALG_CFB ((psa_algorithm_t) 0x04c01100)
1119
1124#define PSA_ALG_OFB ((psa_algorithm_t) 0x04c01200)
1125
1132#define PSA_ALG_XTS ((psa_algorithm_t) 0x0440ff00)
1133
1152#define PSA_ALG_ECB_NO_PADDING ((psa_algorithm_t) 0x04404400)
1153
1161#define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t) 0x04404000)
1162
1169#define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t) 0x04404100)
1170
1171#define PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t) 0x00400000)
1172
1182#define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) \
1183 (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
1184 (PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))
1185
1190#define PSA_ALG_CCM ((psa_algorithm_t) 0x05500100)
1191
1196#define PSA_ALG_GCM ((psa_algorithm_t) 0x05500200)
1197
1207#define PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t) 0x05100500)
1208
1209/* In the encoding of an AEAD algorithm, the bits corresponding to
1210 * PSA_ALG_AEAD_TAG_LENGTH_MASK encode the length of the AEAD tag.
1211 * The constants for default lengths follow this encoding.
1212 */
1213#define PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t) 0x003f0000)
1214#define PSA_AEAD_TAG_LENGTH_OFFSET 16
1215
1216/* In the encoding of an AEAD algorithm, the bit corresponding to
1217 * #PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG encodes the fact that the algorithm
1218 * is a wildcard algorithm. A key with such wildcard algorithm as permitted
1219 * algorithm policy can be used with any algorithm corresponding to the
1220 * same base class and having a tag length greater than or equal to the one
1221 * encoded in #PSA_ALG_AEAD_TAG_LENGTH_MASK. */
1222#define PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ((psa_algorithm_t) 0x00008000)
1223
1242#define PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, tag_length) \
1243 (((aead_alg) & ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | \
1244 PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)) | \
1245 ((tag_length) << PSA_AEAD_TAG_LENGTH_OFFSET & \
1246 PSA_ALG_AEAD_TAG_LENGTH_MASK))
1247
1258#define PSA_ALG_AEAD_GET_TAG_LENGTH(aead_alg) \
1259 (((aead_alg) & PSA_ALG_AEAD_TAG_LENGTH_MASK) >> \
1260 PSA_AEAD_TAG_LENGTH_OFFSET)
1261
1270#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(aead_alg) \
1271 ( \
1272 PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CCM) \
1273 PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_GCM) \
1274 PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, PSA_ALG_CHACHA20_POLY1305) \
1275 0)
1276#define PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG_CASE(aead_alg, ref) \
1277 PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, 0) == \
1278 PSA_ALG_AEAD_WITH_SHORTENED_TAG(ref, 0) ? \
1279 ref :
1280
1305#define PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(aead_alg, min_tag_length) \
1306 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(aead_alg, min_tag_length) | \
1307 PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)
1308
1309#define PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t) 0x06000200)
1325#define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg) \
1326 (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1333#define PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE
1334#define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) \
1335 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)
1336
1337#define PSA_ALG_RSA_PSS_BASE ((psa_algorithm_t) 0x06000300)
1338#define PSA_ALG_RSA_PSS_ANY_SALT_BASE ((psa_algorithm_t) 0x06001300)
1359#define PSA_ALG_RSA_PSS(hash_alg) \
1360 (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1361
1377#define PSA_ALG_RSA_PSS_ANY_SALT(hash_alg) \
1378 (PSA_ALG_RSA_PSS_ANY_SALT_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1379
1391#define PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) \
1392 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)
1393
1405#define PSA_ALG_IS_RSA_PSS_ANY_SALT(alg) \
1406 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_ANY_SALT_BASE)
1407
1423#define PSA_ALG_IS_RSA_PSS(alg) \
1424 (PSA_ALG_IS_RSA_PSS_STANDARD_SALT(alg) || \
1425 PSA_ALG_IS_RSA_PSS_ANY_SALT(alg))
1426
1427#define PSA_ALG_ECDSA_BASE ((psa_algorithm_t) 0x06000600)
1448#define PSA_ALG_ECDSA(hash_alg) \
1449 (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1459#define PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE
1460#define PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t) 0x06000700)
1483#define PSA_ALG_DETERMINISTIC_ECDSA(hash_alg) \
1484 (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1485#define PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t) 0x00000100)
1486#define PSA_ALG_IS_ECDSA(alg) \
1487 (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
1488 PSA_ALG_ECDSA_BASE)
1489#define PSA_ALG_ECDSA_IS_DETERMINISTIC(alg) \
1490 (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)
1491#define PSA_ALG_IS_DETERMINISTIC_ECDSA(alg) \
1492 (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1493#define PSA_ALG_IS_RANDOMIZED_ECDSA(alg) \
1494 (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1495
1524#define PSA_ALG_PURE_EDDSA ((psa_algorithm_t) 0x06000800)
1525
1526#define PSA_ALG_HASH_EDDSA_BASE ((psa_algorithm_t) 0x06000900)
1527#define PSA_ALG_IS_HASH_EDDSA(alg) \
1528 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HASH_EDDSA_BASE)
1529
1551#define PSA_ALG_ED25519PH \
1552 (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHA_512 & PSA_ALG_HASH_MASK))
1553
1576#define PSA_ALG_ED448PH \
1577 (PSA_ALG_HASH_EDDSA_BASE | (PSA_ALG_SHAKE256_512 & PSA_ALG_HASH_MASK))
1578
1579/* Default definition, to be overridden if the library is extended with
1580 * more hash-and-sign algorithms that we want to keep out of this header
1581 * file. */
1582#define PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg) 0
1583
1601#define PSA_ALG_IS_SIGN_HASH(alg) \
1602 (PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
1603 PSA_ALG_IS_ECDSA(alg) || PSA_ALG_IS_HASH_EDDSA(alg) || \
1604 PSA_ALG_IS_VENDOR_HASH_AND_SIGN(alg))
1605
1617#define PSA_ALG_IS_SIGN_MESSAGE(alg) \
1618 (PSA_ALG_IS_SIGN_HASH(alg) || (alg) == PSA_ALG_PURE_EDDSA)
1619
1646#define PSA_ALG_IS_HASH_AND_SIGN(alg) \
1647 (PSA_ALG_IS_SIGN_HASH(alg) && \
1648 ((alg) & PSA_ALG_HASH_MASK) != 0)
1649
1668#define PSA_ALG_SIGN_GET_HASH(alg) \
1669 (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1670 ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1671 0)
1672
1675#define PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t) 0x07000200)
1676
1677#define PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t) 0x07000300)
1692#define PSA_ALG_RSA_OAEP(hash_alg) \
1693 (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1694#define PSA_ALG_IS_RSA_OAEP(alg) \
1695 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)
1696#define PSA_ALG_RSA_OAEP_GET_HASH(alg) \
1697 (PSA_ALG_IS_RSA_OAEP(alg) ? \
1698 ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1699 0)
1700
1701#define PSA_ALG_HKDF_BASE ((psa_algorithm_t) 0x08000100)
1722#define PSA_ALG_HKDF(hash_alg) \
1723 (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1735#define PSA_ALG_IS_HKDF(alg) \
1736 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)
1737#define PSA_ALG_HKDF_GET_HASH(hkdf_alg) \
1738 (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1739
1740#define PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t) 0x08000200)
1767#define PSA_ALG_TLS12_PRF(hash_alg) \
1768 (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1769
1778#define PSA_ALG_IS_TLS12_PRF(alg) \
1779 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)
1780#define PSA_ALG_TLS12_PRF_GET_HASH(hkdf_alg) \
1781 (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1782
1783#define PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t) 0x08000300)
1813#define PSA_ALG_TLS12_PSK_TO_MS(hash_alg) \
1814 (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1815
1824#define PSA_ALG_IS_TLS12_PSK_TO_MS(alg) \
1825 (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)
1826#define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH(hkdf_alg) \
1827 (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1828
1829#define PSA_ALG_KEY_DERIVATION_MASK ((psa_algorithm_t) 0xfe00ffff)
1830#define PSA_ALG_KEY_AGREEMENT_MASK ((psa_algorithm_t) 0xffff0000)
1831
1846#define PSA_ALG_KEY_AGREEMENT(ka_alg, kdf_alg) \
1847 ((ka_alg) | (kdf_alg))
1848
1849#define PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) \
1850 (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)
1851
1852#define PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) \
1853 (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)
1854
1869#define PSA_ALG_IS_RAW_KEY_AGREEMENT(alg) \
1870 (PSA_ALG_IS_KEY_AGREEMENT(alg) && \
1871 PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == PSA_ALG_CATEGORY_KEY_DERIVATION)
1872
1873#define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT(alg) \
1874 ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))
1875
1883#define PSA_ALG_FFDH ((psa_algorithm_t) 0x09010000)
1884
1897#define PSA_ALG_IS_FFDH(alg) \
1898 (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
1899
1925#define PSA_ALG_ECDH ((psa_algorithm_t) 0x09020000)
1926
1941#define PSA_ALG_IS_ECDH(alg) \
1942 (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
1943
1957#define PSA_ALG_IS_WILDCARD(alg) \
1958 (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1959 PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
1960 PSA_ALG_IS_MAC(alg) ? \
1961 (alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
1962 PSA_ALG_IS_AEAD(alg) ? \
1963 (alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0 : \
1964 (alg) == PSA_ALG_ANY_HASH)
1965
1972/* Note that location and persistence level values are embedded in the
1973 * persistent key store, as part of key metadata. As a consequence, they
1974 * must not be changed (unless the storage format version changes).
1975 */
1976
1988#define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t) 0x00000000)
1989
2002#define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t) 0x00000001)
2003
2008#define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t) 0x00)
2009
2014#define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t) 0x01)
2015
2020#define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t) 0xff)
2021
2022#define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \
2023 ((psa_key_persistence_t) ((lifetime) & 0x000000ff))
2024
2025#define PSA_KEY_LIFETIME_GET_LOCATION(lifetime) \
2026 ((psa_key_location_t) ((lifetime) >> 8))
2027
2044#define PSA_KEY_LIFETIME_IS_VOLATILE(lifetime) \
2045 (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
2046 PSA_KEY_PERSISTENCE_VOLATILE)
2047
2065#define PSA_KEY_LIFETIME_IS_READ_ONLY(lifetime) \
2066 (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
2067 PSA_KEY_PERSISTENCE_READ_ONLY)
2068
2078#define PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(persistence, location) \
2079 ((location) << 8 | (persistence))
2080
2088#define PSA_KEY_LOCATION_LOCAL_STORAGE ((psa_key_location_t) 0x000000)
2089
2090#define PSA_KEY_LOCATION_VENDOR_FLAG ((psa_key_location_t) 0x800000)
2091
2092/* Note that key identifier values are embedded in the
2093 * persistent key store, as part of key metadata. As a consequence, they
2094 * must not be changed (unless the storage format version changes).
2095 */
2096
2099/* *INDENT-OFF* (https://github.com/ARM-software/psa-arch-tests/issues/337) */
2100#define PSA_KEY_ID_NULL ((psa_key_id_t)0)
2101/* *INDENT-ON* */
2104#define PSA_KEY_ID_USER_MIN ((psa_key_id_t) 0x00000001)
2107#define PSA_KEY_ID_USER_MAX ((psa_key_id_t) 0x3fffffff)
2110#define PSA_KEY_ID_VENDOR_MIN ((psa_key_id_t) 0x40000000)
2113#define PSA_KEY_ID_VENDOR_MAX ((psa_key_id_t) 0x7fffffff)
2114
2115
2116#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
2117
2118#define MBEDTLS_SVC_KEY_ID_INIT ((psa_key_id_t) 0)
2119#define MBEDTLS_SVC_KEY_ID_GET_KEY_ID(id) (id)
2120#define MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(id) (0)
2121
2128 unsigned int unused, psa_key_id_t key_id)
2129{
2130 (void) unused;
2131
2132 return key_id;
2133}
2134
2144{
2145 return id1 == id2;
2146}
2147
2155{
2156 return key == 0;
2157}
2158
2159#else /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
2160
2161#define MBEDTLS_SVC_KEY_ID_INIT ((mbedtls_svc_key_id_t){ 0, 0 })
2162#define MBEDTLS_SVC_KEY_ID_GET_KEY_ID(id) ((id).key_id)
2163#define MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(id) ((id).owner)
2164
2171 mbedtls_key_owner_id_t owner_id, psa_key_id_t key_id)
2172{
2173 return (mbedtls_svc_key_id_t){ .key_id = key_id,
2174 .owner = owner_id };
2175}
2176
2186{
2187 return (id1.key_id == id2.key_id) &&
2188 mbedtls_key_owner_id_equal(id1.owner, id2.owner);
2189}
2190
2198{
2199 return key.key_id == 0;
2200}
2201
2202#endif /* !MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
2203
2210/* Note that key usage flags are embedded in the
2211 * persistent key store, as part of key metadata. As a consequence, they
2212 * must not be changed (unless the storage format version changes).
2213 */
2214
2226#define PSA_KEY_USAGE_EXPORT ((psa_key_usage_t) 0x00000001)
2227
2242#define PSA_KEY_USAGE_COPY ((psa_key_usage_t) 0x00000002)
2243
2253#define PSA_KEY_USAGE_ENCRYPT ((psa_key_usage_t) 0x00000100)
2254
2264#define PSA_KEY_USAGE_DECRYPT ((psa_key_usage_t) 0x00000200)
2265
2274#define PSA_KEY_USAGE_SIGN_MESSAGE ((psa_key_usage_t) 0x00000400)
2275
2284#define PSA_KEY_USAGE_VERIFY_MESSAGE ((psa_key_usage_t) 0x00000800)
2285
2294#define PSA_KEY_USAGE_SIGN_HASH ((psa_key_usage_t) 0x00001000)
2295
2304#define PSA_KEY_USAGE_VERIFY_HASH ((psa_key_usage_t) 0x00002000)
2305
2308#define PSA_KEY_USAGE_DERIVE ((psa_key_usage_t) 0x00004000)
2309
2316/* Key input steps are not embedded in the persistent storage, so you can
2317 * change them if needed: it's only an ABI change. */
2318
2331#define PSA_KEY_DERIVATION_INPUT_SECRET ((psa_key_derivation_step_t) 0x0101)
2332
2338#define PSA_KEY_DERIVATION_INPUT_LABEL ((psa_key_derivation_step_t) 0x0201)
2339
2345#define PSA_KEY_DERIVATION_INPUT_SALT ((psa_key_derivation_step_t) 0x0202)
2346
2352#define PSA_KEY_DERIVATION_INPUT_INFO ((psa_key_derivation_step_t) 0x0203)
2353
2359#define PSA_KEY_DERIVATION_INPUT_SEED ((psa_key_derivation_step_t) 0x0204)
2360
2367/* Helper macros */
2368
2380#define MBEDTLS_PSA_ALG_AEAD_EQUAL(aead_alg_1, aead_alg_2) \
2381 (!(((aead_alg_1) ^ (aead_alg_2)) & \
2382 ~(PSA_ALG_AEAD_TAG_LENGTH_MASK | PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG)))
2383
2386#endif /* PSA_CRYPTO_VALUES_H */
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
Definition: crypto_types.h:278
static int mbedtls_svc_key_id_is_null(mbedtls_svc_key_id_t key)
psa_key_id_t mbedtls_svc_key_id_t
Definition: crypto_types.h:295
static int mbedtls_svc_key_id_equal(mbedtls_svc_key_id_t id1, mbedtls_svc_key_id_t id2)