mbed TLS v2.24.0
crypto_values.h
Go to the documentation of this file.
1 
17 /*
18  * Copyright The Mbed TLS Contributors
19  * SPDX-License-Identifier: Apache-2.0
20  *
21  * Licensed under the Apache License, Version 2.0 (the "License"); you may
22  * not use this file except in compliance with the License.
23  * You may obtain a copy of the License at
24  *
25  * http://www.apache.org/licenses/LICENSE-2.0
26  *
27  * Unless required by applicable law or agreed to in writing, software
28  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
29  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
30  * See the License for the specific language governing permissions and
31  * limitations under the License.
32  */
33 
34 #ifndef PSA_CRYPTO_VALUES_H
35 #define PSA_CRYPTO_VALUES_H
36 
41 /* PSA error codes */
42 
44 #define PSA_SUCCESS ((psa_status_t)0)
45 
51 #define PSA_ERROR_GENERIC_ERROR ((psa_status_t)-132)
52 
60 #define PSA_ERROR_NOT_SUPPORTED ((psa_status_t)-134)
61 
73 #define PSA_ERROR_NOT_PERMITTED ((psa_status_t)-133)
74 
85 #define PSA_ERROR_BUFFER_TOO_SMALL ((psa_status_t)-138)
86 
91 #define PSA_ERROR_ALREADY_EXISTS ((psa_status_t)-139)
92 
97 #define PSA_ERROR_DOES_NOT_EXIST ((psa_status_t)-140)
98 
113 #define PSA_ERROR_BAD_STATE ((psa_status_t)-137)
114 
124 #define PSA_ERROR_INVALID_ARGUMENT ((psa_status_t)-135)
125 
130 #define PSA_ERROR_INSUFFICIENT_MEMORY ((psa_status_t)-141)
131 
139 #define PSA_ERROR_INSUFFICIENT_STORAGE ((psa_status_t)-142)
140 
156 #define PSA_ERROR_COMMUNICATION_FAILURE ((psa_status_t)-145)
157 
181 #define PSA_ERROR_STORAGE_FAILURE ((psa_status_t)-146)
182 
187 #define PSA_ERROR_HARDWARE_FAILURE ((psa_status_t)-147)
188 
218 #define PSA_ERROR_CORRUPTION_DETECTED ((psa_status_t)-151)
219 
237 #define PSA_ERROR_INSUFFICIENT_ENTROPY ((psa_status_t)-148)
238 
247 #define PSA_ERROR_INVALID_SIGNATURE ((psa_status_t)-149)
248 
263 #define PSA_ERROR_INVALID_PADDING ((psa_status_t)-150)
264 
267 #define PSA_ERROR_INSUFFICIENT_DATA ((psa_status_t)-143)
268 
271 #define PSA_ERROR_INVALID_HANDLE ((psa_status_t)-136)
272 
283 #define PSA_KEY_TYPE_NONE ((psa_key_type_t)0x0000)
284 
292 #define PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t)0x8000)
293 
294 #define PSA_KEY_TYPE_CATEGORY_MASK ((psa_key_type_t)0x7000)
295 #define PSA_KEY_TYPE_CATEGORY_RAW ((psa_key_type_t)0x1000)
296 #define PSA_KEY_TYPE_CATEGORY_SYMMETRIC ((psa_key_type_t)0x2000)
297 #define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY ((psa_key_type_t)0x4000)
298 #define PSA_KEY_TYPE_CATEGORY_KEY_PAIR ((psa_key_type_t)0x7000)
299 
300 #define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR ((psa_key_type_t)0x3000)
301 
306 #define PSA_KEY_TYPE_IS_VENDOR_DEFINED(type) \
307  (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)
308 
313 #define PSA_KEY_TYPE_IS_UNSTRUCTURED(type) \
314  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
315  ((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)
316 
318 #define PSA_KEY_TYPE_IS_ASYMMETRIC(type) \
319  (((type) & PSA_KEY_TYPE_CATEGORY_MASK \
320  & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
321  PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
322 
323 #define PSA_KEY_TYPE_IS_PUBLIC_KEY(type) \
324  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
325 
327 #define PSA_KEY_TYPE_IS_KEY_PAIR(type) \
328  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)
329 
339 #define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type) \
340  ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
341 
351 #define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) \
352  ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
353 
358 #define PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t)0x1001)
359 
368 #define PSA_KEY_TYPE_HMAC ((psa_key_type_t)0x1100)
369 
375 #define PSA_KEY_TYPE_DERIVE ((psa_key_type_t)0x1200)
376 
382 #define PSA_KEY_TYPE_AES ((psa_key_type_t)0x2400)
383 
393 #define PSA_KEY_TYPE_DES ((psa_key_type_t)0x2301)
394 
397 #define PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t)0x2403)
398 
403 #define PSA_KEY_TYPE_ARC4 ((psa_key_type_t)0x2002)
404 
412 #define PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t)0x2004)
413 
415 #define PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t)0x4001)
416 
417 #define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t)0x7001)
418 
419 #define PSA_KEY_TYPE_IS_RSA(type) \
420  (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)
421 
422 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE ((psa_key_type_t)0x4100)
423 #define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE ((psa_key_type_t)0x7100)
424 #define PSA_KEY_TYPE_ECC_CURVE_MASK ((psa_key_type_t)0x00ff)
425 
430 #define PSA_KEY_TYPE_ECC_KEY_PAIR(curve) \
431  (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
432 
437 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve) \
438  (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
439 
441 #define PSA_KEY_TYPE_IS_ECC(type) \
442  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
443  ~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
444 
445 #define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type) \
446  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
447  PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)
448 
449 #define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type) \
450  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
451  PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
452 
454 #define PSA_KEY_TYPE_ECC_GET_FAMILY(type) \
455  ((psa_ecc_family_t) (PSA_KEY_TYPE_IS_ECC(type) ? \
456  ((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
457  0))
458 
467 #define PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t) 0x17)
468 
477 #define PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t) 0x12)
478 /* SECP160R2 (SEC2 v1, obsolete) */
479 #define PSA_ECC_FAMILY_SECP_R2 ((psa_ecc_family_t) 0x1b)
480 
489 #define PSA_ECC_FAMILY_SECT_K1 ((psa_ecc_family_t) 0x27)
490 
499 #define PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t) 0x22)
500 
509 #define PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t) 0x2b)
510 
518 #define PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t) 0x30)
519 
530 #define PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t) 0x41)
531 
532 #define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE ((psa_key_type_t)0x4200)
533 #define PSA_KEY_TYPE_DH_KEY_PAIR_BASE ((psa_key_type_t)0x7200)
534 #define PSA_KEY_TYPE_DH_GROUP_MASK ((psa_key_type_t)0x00ff)
535 
540 #define PSA_KEY_TYPE_DH_KEY_PAIR(group) \
541  (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))
542 
547 #define PSA_KEY_TYPE_DH_PUBLIC_KEY(group) \
548  (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))
549 
551 #define PSA_KEY_TYPE_IS_DH(type) \
552  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
553  ~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
554 
555 #define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type) \
556  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
557  PSA_KEY_TYPE_DH_KEY_PAIR_BASE)
558 
559 #define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type) \
560  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
561  PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
562 
564 #define PSA_KEY_TYPE_DH_GET_FAMILY(type) \
565  ((psa_dh_family_t) (PSA_KEY_TYPE_IS_DH(type) ? \
566  ((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
567  0))
568 
575 #define PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t) 0x03)
576 
577 #define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) \
578  (((type) >> 8) & 7)
579 
597 #define PSA_BLOCK_CIPHER_BLOCK_SIZE(type) \
598  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
599  1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
600  0u)
601 
609 #define PSA_ALG_VENDOR_FLAG ((psa_algorithm_t)0x80000000)
610 
611 #define PSA_ALG_CATEGORY_MASK ((psa_algorithm_t)0x7f000000)
612 #define PSA_ALG_CATEGORY_HASH ((psa_algorithm_t)0x01000000)
613 #define PSA_ALG_CATEGORY_MAC ((psa_algorithm_t)0x02000000)
614 #define PSA_ALG_CATEGORY_CIPHER ((psa_algorithm_t)0x04000000)
615 #define PSA_ALG_CATEGORY_AEAD ((psa_algorithm_t)0x06000000)
616 #define PSA_ALG_CATEGORY_SIGN ((psa_algorithm_t)0x10000000)
617 #define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION ((psa_algorithm_t)0x12000000)
618 #define PSA_ALG_CATEGORY_KEY_DERIVATION ((psa_algorithm_t)0x20000000)
619 #define PSA_ALG_CATEGORY_KEY_AGREEMENT ((psa_algorithm_t)0x30000000)
620 
625 #define PSA_ALG_IS_VENDOR_DEFINED(alg) \
626  (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
627 
636 #define PSA_ALG_IS_HASH(alg) \
637  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
638 
647 #define PSA_ALG_IS_MAC(alg) \
648  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
649 
658 #define PSA_ALG_IS_CIPHER(alg) \
659  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
660 
670 #define PSA_ALG_IS_AEAD(alg) \
671  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
672 
682 #define PSA_ALG_IS_SIGN(alg) \
683  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
684 
694 #define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg) \
695  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
696 
705 #define PSA_ALG_IS_KEY_AGREEMENT(alg) \
706  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
707 
716 #define PSA_ALG_IS_KEY_DERIVATION(alg) \
717  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_DERIVATION)
718 
719 #define PSA_ALG_HASH_MASK ((psa_algorithm_t)0x000000ff)
720 
721 #define PSA_ALG_MD2 ((psa_algorithm_t)0x01000001)
722 
723 #define PSA_ALG_MD4 ((psa_algorithm_t)0x01000002)
724 
725 #define PSA_ALG_MD5 ((psa_algorithm_t)0x01000003)
726 
727 #define PSA_ALG_RIPEMD160 ((psa_algorithm_t)0x01000004)
728 
729 #define PSA_ALG_SHA_1 ((psa_algorithm_t)0x01000005)
730 
731 #define PSA_ALG_SHA_224 ((psa_algorithm_t)0x01000008)
732 
733 #define PSA_ALG_SHA_256 ((psa_algorithm_t)0x01000009)
734 
735 #define PSA_ALG_SHA_384 ((psa_algorithm_t)0x0100000a)
736 
737 #define PSA_ALG_SHA_512 ((psa_algorithm_t)0x0100000b)
738 
739 #define PSA_ALG_SHA_512_224 ((psa_algorithm_t)0x0100000c)
740 
741 #define PSA_ALG_SHA_512_256 ((psa_algorithm_t)0x0100000d)
742 
743 #define PSA_ALG_SHA3_224 ((psa_algorithm_t)0x01000010)
744 
745 #define PSA_ALG_SHA3_256 ((psa_algorithm_t)0x01000011)
746 
747 #define PSA_ALG_SHA3_384 ((psa_algorithm_t)0x01000012)
748 
749 #define PSA_ALG_SHA3_512 ((psa_algorithm_t)0x01000013)
750 
784 #define PSA_ALG_ANY_HASH ((psa_algorithm_t)0x010000ff)
785 
786 #define PSA_ALG_MAC_SUBCATEGORY_MASK ((psa_algorithm_t)0x00c00000)
787 #define PSA_ALG_HMAC_BASE ((psa_algorithm_t)0x02800000)
788 
799 #define PSA_ALG_HMAC(hash_alg) \
800  (PSA_ALG_HMAC_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
801 
802 #define PSA_ALG_HMAC_GET_HASH(hmac_alg) \
803  (PSA_ALG_CATEGORY_HASH | ((hmac_alg) & PSA_ALG_HASH_MASK))
804 
815 #define PSA_ALG_IS_HMAC(alg) \
816  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
817  PSA_ALG_HMAC_BASE)
818 
819 /* In the encoding of a MAC algorithm, the bits corresponding to
820  * PSA_ALG_MAC_TRUNCATION_MASK encode the length to which the MAC is
821  * truncated. As an exception, the value 0 means the untruncated algorithm,
822  * whatever its length is. The length is encoded in 6 bits, so it can
823  * reach up to 63; the largest MAC is 64 bytes so its trivial truncation
824  * to full length is correctly encoded as 0 and any non-trivial truncation
825  * is correctly encoded as a value between 1 and 63. */
826 #define PSA_ALG_MAC_TRUNCATION_MASK ((psa_algorithm_t)0x00003f00)
827 #define PSA_MAC_TRUNCATION_OFFSET 8
828 
862 #define PSA_ALG_TRUNCATED_MAC(mac_alg, mac_length) \
863  (((mac_alg) & ~PSA_ALG_MAC_TRUNCATION_MASK) | \
864  ((mac_length) << PSA_MAC_TRUNCATION_OFFSET & PSA_ALG_MAC_TRUNCATION_MASK))
865 
878 #define PSA_ALG_FULL_LENGTH_MAC(mac_alg) \
879  ((mac_alg) & ~PSA_ALG_MAC_TRUNCATION_MASK)
880 
892 #define PSA_MAC_TRUNCATED_LENGTH(mac_alg) \
893  (((mac_alg) & PSA_ALG_MAC_TRUNCATION_MASK) >> PSA_MAC_TRUNCATION_OFFSET)
894 
895 #define PSA_ALG_CIPHER_MAC_BASE ((psa_algorithm_t)0x02c00000)
896 
901 #define PSA_ALG_CBC_MAC ((psa_algorithm_t)0x02c00001)
902 
903 #define PSA_ALG_CMAC ((psa_algorithm_t)0x02c00002)
904 
913 #define PSA_ALG_IS_BLOCK_CIPHER_MAC(alg) \
914  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_MAC_SUBCATEGORY_MASK)) == \
915  PSA_ALG_CIPHER_MAC_BASE)
916 
917 #define PSA_ALG_CIPHER_STREAM_FLAG ((psa_algorithm_t)0x00800000)
918 #define PSA_ALG_CIPHER_FROM_BLOCK_FLAG ((psa_algorithm_t)0x00400000)
919 
932 #define PSA_ALG_IS_STREAM_CIPHER(alg) \
933  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_CIPHER_STREAM_FLAG)) == \
934  (PSA_ALG_CATEGORY_CIPHER | PSA_ALG_CIPHER_STREAM_FLAG))
935 
938 #define PSA_ALG_ARC4 ((psa_algorithm_t)0x04800001)
939 
950 #define PSA_ALG_CHACHA20 ((psa_algorithm_t)0x04800005)
951 
959 #define PSA_ALG_CTR ((psa_algorithm_t)0x04c00001)
960 
965 #define PSA_ALG_CFB ((psa_algorithm_t)0x04c00002)
966 
971 #define PSA_ALG_OFB ((psa_algorithm_t)0x04c00003)
972 
979 #define PSA_ALG_XTS ((psa_algorithm_t)0x044000ff)
980 
988 #define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t)0x04600100)
989 
996 #define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t)0x04600101)
997 
998 #define PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t)0x00400000)
999 
1009 #define PSA_ALG_IS_AEAD_ON_BLOCK_CIPHER(alg) \
1010  (((alg) & (PSA_ALG_CATEGORY_MASK | PSA_ALG_AEAD_FROM_BLOCK_FLAG)) == \
1011  (PSA_ALG_CATEGORY_AEAD | PSA_ALG_AEAD_FROM_BLOCK_FLAG))
1012 
1017 #define PSA_ALG_CCM ((psa_algorithm_t)0x06401001)
1018 
1023 #define PSA_ALG_GCM ((psa_algorithm_t)0x06401002)
1024 
1034 #define PSA_ALG_CHACHA20_POLY1305 ((psa_algorithm_t)0x06001005)
1035 
1036 /* In the encoding of a AEAD algorithm, the bits corresponding to
1037  * PSA_ALG_AEAD_TAG_LENGTH_MASK encode the length of the AEAD tag.
1038  * The constants for default lengths follow this encoding.
1039  */
1040 #define PSA_ALG_AEAD_TAG_LENGTH_MASK ((psa_algorithm_t)0x00003f00)
1041 #define PSA_AEAD_TAG_LENGTH_OFFSET 8
1042 
1061 #define PSA_ALG_AEAD_WITH_TAG_LENGTH(aead_alg, tag_length) \
1062  (((aead_alg) & ~PSA_ALG_AEAD_TAG_LENGTH_MASK) | \
1063  ((tag_length) << PSA_AEAD_TAG_LENGTH_OFFSET & \
1064  PSA_ALG_AEAD_TAG_LENGTH_MASK))
1065 
1074 #define PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH(aead_alg) \
1075  ( \
1076  PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, PSA_ALG_CCM) \
1077  PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, PSA_ALG_GCM) \
1078  PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, PSA_ALG_CHACHA20_POLY1305) \
1079  0)
1080 #define PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH_CASE(aead_alg, ref) \
1081  PSA_ALG_AEAD_WITH_TAG_LENGTH(aead_alg, 0) == \
1082  PSA_ALG_AEAD_WITH_TAG_LENGTH(ref, 0) ? \
1083  ref :
1084 
1085 #define PSA_ALG_RSA_PKCS1V15_SIGN_BASE ((psa_algorithm_t)0x10020000)
1086 
1101 #define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg) \
1102  (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1103 
1109 #define PSA_ALG_RSA_PKCS1V15_SIGN_RAW PSA_ALG_RSA_PKCS1V15_SIGN_BASE
1110 #define PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) \
1111  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PKCS1V15_SIGN_BASE)
1112 
1113 #define PSA_ALG_RSA_PSS_BASE ((psa_algorithm_t)0x10030000)
1114 
1132 #define PSA_ALG_RSA_PSS(hash_alg) \
1133  (PSA_ALG_RSA_PSS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1134 #define PSA_ALG_IS_RSA_PSS(alg) \
1135  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_PSS_BASE)
1136 
1137 #define PSA_ALG_ECDSA_BASE ((psa_algorithm_t)0x10060000)
1138 
1158 #define PSA_ALG_ECDSA(hash_alg) \
1159  (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1160 
1169 #define PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE
1170 #define PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t)0x10070000)
1171 
1193 #define PSA_ALG_DETERMINISTIC_ECDSA(hash_alg) \
1194  (PSA_ALG_DETERMINISTIC_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1195 #define PSA_ALG_ECDSA_DETERMINISTIC_FLAG ((psa_algorithm_t)0x00010000)
1196 #define PSA_ALG_IS_ECDSA(alg) \
1197  (((alg) & ~PSA_ALG_HASH_MASK & ~PSA_ALG_ECDSA_DETERMINISTIC_FLAG) == \
1198  PSA_ALG_ECDSA_BASE)
1199 #define PSA_ALG_ECDSA_IS_DETERMINISTIC(alg) \
1200  (((alg) & PSA_ALG_ECDSA_DETERMINISTIC_FLAG) != 0)
1201 #define PSA_ALG_IS_DETERMINISTIC_ECDSA(alg) \
1202  (PSA_ALG_IS_ECDSA(alg) && PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1203 #define PSA_ALG_IS_RANDOMIZED_ECDSA(alg) \
1204  (PSA_ALG_IS_ECDSA(alg) && !PSA_ALG_ECDSA_IS_DETERMINISTIC(alg))
1205 
1219 #define PSA_ALG_IS_HASH_AND_SIGN(alg) \
1220  (PSA_ALG_IS_RSA_PSS(alg) || PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) || \
1221  PSA_ALG_IS_ECDSA(alg))
1222 
1241 #define PSA_ALG_SIGN_GET_HASH(alg) \
1242  (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1243  ((alg) & PSA_ALG_HASH_MASK) == 0 ? /*"raw" algorithm*/ 0 : \
1244  ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1245  0)
1246 
1249 #define PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t)0x12020000)
1250 
1251 #define PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t)0x12030000)
1252 
1266 #define PSA_ALG_RSA_OAEP(hash_alg) \
1267  (PSA_ALG_RSA_OAEP_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1268 #define PSA_ALG_IS_RSA_OAEP(alg) \
1269  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_RSA_OAEP_BASE)
1270 #define PSA_ALG_RSA_OAEP_GET_HASH(alg) \
1271  (PSA_ALG_IS_RSA_OAEP(alg) ? \
1272  ((alg) & PSA_ALG_HASH_MASK) | PSA_ALG_CATEGORY_HASH : \
1273  0)
1274 
1275 #define PSA_ALG_HKDF_BASE ((psa_algorithm_t)0x20000100)
1276 
1296 #define PSA_ALG_HKDF(hash_alg) \
1297  (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1298 
1309 #define PSA_ALG_IS_HKDF(alg) \
1310  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_HKDF_BASE)
1311 #define PSA_ALG_HKDF_GET_HASH(hkdf_alg) \
1312  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1313 
1314 #define PSA_ALG_TLS12_PRF_BASE ((psa_algorithm_t)0x20000200)
1315 
1341 #define PSA_ALG_TLS12_PRF(hash_alg) \
1342  (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1343 
1352 #define PSA_ALG_IS_TLS12_PRF(alg) \
1353  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PRF_BASE)
1354 #define PSA_ALG_TLS12_PRF_GET_HASH(hkdf_alg) \
1355  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1356 
1357 #define PSA_ALG_TLS12_PSK_TO_MS_BASE ((psa_algorithm_t)0x20000300)
1358 
1387 #define PSA_ALG_TLS12_PSK_TO_MS(hash_alg) \
1388  (PSA_ALG_TLS12_PSK_TO_MS_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1389 
1398 #define PSA_ALG_IS_TLS12_PSK_TO_MS(alg) \
1399  (((alg) & ~PSA_ALG_HASH_MASK) == PSA_ALG_TLS12_PSK_TO_MS_BASE)
1400 #define PSA_ALG_TLS12_PSK_TO_MS_GET_HASH(hkdf_alg) \
1401  (PSA_ALG_CATEGORY_HASH | ((hkdf_alg) & PSA_ALG_HASH_MASK))
1402 
1403 #define PSA_ALG_KEY_DERIVATION_MASK ((psa_algorithm_t)0x0803ffff)
1404 #define PSA_ALG_KEY_AGREEMENT_MASK ((psa_algorithm_t)0x10fc0000)
1405 
1420 #define PSA_ALG_KEY_AGREEMENT(ka_alg, kdf_alg) \
1421  ((ka_alg) | (kdf_alg))
1422 
1423 #define PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) \
1424  (((alg) & PSA_ALG_KEY_DERIVATION_MASK) | PSA_ALG_CATEGORY_KEY_DERIVATION)
1425 
1426 #define PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) \
1427  (((alg) & PSA_ALG_KEY_AGREEMENT_MASK) | PSA_ALG_CATEGORY_KEY_AGREEMENT)
1428 
1443 #define PSA_ALG_IS_RAW_KEY_AGREEMENT(alg) \
1444  (PSA_ALG_IS_KEY_AGREEMENT(alg) && \
1445  PSA_ALG_KEY_AGREEMENT_GET_KDF(alg) == PSA_ALG_CATEGORY_KEY_DERIVATION)
1446 
1447 #define PSA_ALG_IS_KEY_DERIVATION_OR_AGREEMENT(alg) \
1448  ((PSA_ALG_IS_KEY_DERIVATION(alg) || PSA_ALG_IS_KEY_AGREEMENT(alg)))
1449 
1457 #define PSA_ALG_FFDH ((psa_algorithm_t)0x30100000)
1458 
1471 #define PSA_ALG_IS_FFDH(alg) \
1472  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
1473 
1499 #define PSA_ALG_ECDH ((psa_algorithm_t)0x30200000)
1500 
1515 #define PSA_ALG_IS_ECDH(alg) \
1516  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
1517 
1531 #define PSA_ALG_IS_WILDCARD(alg) \
1532  (PSA_ALG_IS_HASH_AND_SIGN(alg) ? \
1533  PSA_ALG_SIGN_GET_HASH(alg) == PSA_ALG_ANY_HASH : \
1534  (alg) == PSA_ALG_ANY_HASH)
1535 
1553 #define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t)0x00000000)
1554 
1568 #define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t)0x00000001)
1569 
1574 #define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t)0x00)
1575 
1580 #define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t)0x01)
1581 
1586 #define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t)0xff)
1587 
1588 #define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \
1589  ((psa_key_persistence_t)((lifetime) & 0x000000ff))
1590 
1591 #define PSA_KEY_LIFETIME_GET_LOCATION(lifetime) \
1592  ((psa_key_location_t)((lifetime) >> 8))
1593 
1610 #define PSA_KEY_LIFETIME_IS_VOLATILE(lifetime) \
1611  (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == \
1612  PSA_KEY_PERSISTENCE_VOLATILE)
1613 
1623 #define PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(persistence, location) \
1624  ((location) << 8 | (persistence))
1625 
1633 #define PSA_KEY_LOCATION_LOCAL_STORAGE ((psa_key_location_t)0x000000)
1634 
1635 #define PSA_KEY_LOCATION_VENDOR_FLAG ((psa_key_location_t)0x800000)
1636 
1639 #define PSA_KEY_ID_USER_MIN ((psa_app_key_id_t)0x00000001)
1640 
1642 #define PSA_KEY_ID_USER_MAX ((psa_app_key_id_t)0x3fffffff)
1643 
1645 #define PSA_KEY_ID_VENDOR_MIN ((psa_app_key_id_t)0x40000000)
1646 
1648 #define PSA_KEY_ID_VENDOR_MAX ((psa_app_key_id_t)0x7fffffff)
1649 
1667 #define PSA_KEY_USAGE_EXPORT ((psa_key_usage_t)0x00000001)
1668 
1683 #define PSA_KEY_USAGE_COPY ((psa_key_usage_t)0x00000002)
1684 
1694 #define PSA_KEY_USAGE_ENCRYPT ((psa_key_usage_t)0x00000100)
1695 
1705 #define PSA_KEY_USAGE_DECRYPT ((psa_key_usage_t)0x00000200)
1706 
1715 #define PSA_KEY_USAGE_SIGN_HASH ((psa_key_usage_t)0x00000400)
1716 
1725 #define PSA_KEY_USAGE_VERIFY_HASH ((psa_key_usage_t)0x00000800)
1726 
1729 #define PSA_KEY_USAGE_DERIVE ((psa_key_usage_t)0x00001000)
1730 
1749 #define PSA_KEY_DERIVATION_INPUT_SECRET ((psa_key_derivation_step_t)0x0101)
1750 
1756 #define PSA_KEY_DERIVATION_INPUT_LABEL ((psa_key_derivation_step_t)0x0201)
1757 
1763 #define PSA_KEY_DERIVATION_INPUT_SALT ((psa_key_derivation_step_t)0x0202)
1764 
1770 #define PSA_KEY_DERIVATION_INPUT_INFO ((psa_key_derivation_step_t)0x0203)
1771 
1777 #define PSA_KEY_DERIVATION_INPUT_SEED ((psa_key_derivation_step_t)0x0204)
1778 
1781 #endif /* PSA_CRYPTO_VALUES_H */