Mistake on this page?
Report an issue in GitHub or email us
TARGET_MBED_PSA_SRV/inc/psa/crypto_values.h
1 /**
2  * \file psa/crypto_values.h
3  *
4  * \brief PSA cryptography module: macros to build and analyze integer values.
5  *
6  * \note This file may not be included directly. Applications must
7  * include psa/crypto.h. Drivers must include the appropriate driver
8  * header file.
9  *
10  * This file contains portable definitions of macros to build and analyze
11  * values of integral types that encode properties of cryptographic keys,
12  * designations of cryptographic algorithms, and error codes returned by
13  * the library.
14  *
15  * This header file only defines preprocessor macros.
16  */
17 /*
18  * Copyright (C) 2018, ARM Limited, All Rights Reserved
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  * This file is part of mbed TLS (https://tls.mbed.org)
34  */
35 
36 #ifndef PSA_CRYPTO_VALUES_H
37 #define PSA_CRYPTO_VALUES_H
38 
39 /** \defgroup error Error codes
40  * @{
41  */
42 
43 /* PSA error codes */
44 
45 /** The action was completed successfully. */
46 #define PSA_SUCCESS ((psa_status_t)0)
47 
48 /** An error occurred that does not correspond to any defined
49  * failure cause.
50  *
51  * Implementations may use this error code if none of the other standard
52  * error codes are applicable. */
53 #define PSA_ERROR_GENERIC_ERROR ((psa_status_t)-132)
54 
55 /** The requested operation or a parameter is not supported
56  * by this implementation.
57  *
58  * Implementations should return this error code when an enumeration
59  * parameter such as a key type, algorithm, etc. is not recognized.
60  * If a combination of parameters is recognized and identified as
61  * not valid, return #PSA_ERROR_INVALID_ARGUMENT instead. */
62 #define PSA_ERROR_NOT_SUPPORTED ((psa_status_t)-134)
63 
64 /** The requested action is denied by a policy.
65  *
66  * Implementations should return this error code when the parameters
67  * are recognized as valid and supported, and a policy explicitly
68  * denies the requested operation.
69  *
70  * If a subset of the parameters of a function call identify a
71  * forbidden operation, and another subset of the parameters are
72  * not valid or not supported, it is unspecified whether the function
73  * returns #PSA_ERROR_NOT_PERMITTED, #PSA_ERROR_NOT_SUPPORTED or
74  * #PSA_ERROR_INVALID_ARGUMENT. */
75 #define PSA_ERROR_NOT_PERMITTED ((psa_status_t)-133)
76 
77 /** An output buffer is too small.
78  *
79  * Applications can call the \c PSA_xxx_SIZE macro listed in the function
80  * description to determine a sufficient buffer size.
81  *
82  * Implementations should preferably return this error code only
83  * in cases when performing the operation with a larger output
84  * buffer would succeed. However implementations may return this
85  * error if a function has invalid or unsupported parameters in addition
86  * to the parameters that determine the necessary output buffer size. */
87 #define PSA_ERROR_BUFFER_TOO_SMALL ((psa_status_t)-138)
88 
89 /** Asking for an item that already exists
90  *
91  * Implementations should return this error, when attempting
92  * to write an item (like a key) that already exists. */
93 #define PSA_ERROR_ALREADY_EXISTS ((psa_status_t)-139)
94 
95 /** Asking for an item that doesn't exist
96  *
97  * Implementations should return this error, if a requested item (like
98  * a key) does not exist. */
99 #define PSA_ERROR_DOES_NOT_EXIST ((psa_status_t)-140)
100 
101 /** The requested action cannot be performed in the current state.
102  *
103  * Multipart operations return this error when one of the
104  * functions is called out of sequence. Refer to the function
105  * descriptions for permitted sequencing of functions.
106  *
107  * Implementations shall not return this error code to indicate
108  * that a key either exists or not,
109  * but shall instead return #PSA_ERROR_ALREADY_EXISTS or #PSA_ERROR_DOES_NOT_EXIST
110  * as applicable.
111  *
112  * Implementations shall not return this error code to indicate that a
113  * key handle is invalid, but shall return #PSA_ERROR_INVALID_HANDLE
114  * instead. */
115 #define PSA_ERROR_BAD_STATE ((psa_status_t)-137)
116 
117 /** The parameters passed to the function are invalid.
118  *
119  * Implementations may return this error any time a parameter or
120  * combination of parameters are recognized as invalid.
121  *
122  * Implementations shall not return this error code to indicate that a
123  * key handle is invalid, but shall return #PSA_ERROR_INVALID_HANDLE
124  * instead.
125  */
126 #define PSA_ERROR_INVALID_ARGUMENT ((psa_status_t)-135)
127 
128 /** There is not enough runtime memory.
129  *
130  * If the action is carried out across multiple security realms, this
131  * error can refer to available memory in any of the security realms. */
132 #define PSA_ERROR_INSUFFICIENT_MEMORY ((psa_status_t)-141)
133 
134 /** There is not enough persistent storage.
135  *
136  * Functions that modify the key storage return this error code if
137  * there is insufficient storage space on the host media. In addition,
138  * many functions that do not otherwise access storage may return this
139  * error code if the implementation requires a mandatory log entry for
140  * the requested action and the log storage space is full. */
141 #define PSA_ERROR_INSUFFICIENT_STORAGE ((psa_status_t)-142)
142 
143 /** There was a communication failure inside the implementation.
144  *
145  * This can indicate a communication failure between the application
146  * and an external cryptoprocessor or between the cryptoprocessor and
147  * an external volatile or persistent memory. A communication failure
148  * may be transient or permanent depending on the cause.
149  *
150  * \warning If a function returns this error, it is undetermined
151  * whether the requested action has completed or not. Implementations
152  * should return #PSA_SUCCESS on successful completion whenever
153  * possible, however functions may return #PSA_ERROR_COMMUNICATION_FAILURE
154  * if the requested action was completed successfully in an external
155  * cryptoprocessor but there was a breakdown of communication before
156  * the cryptoprocessor could report the status to the application.
157  */
158 #define PSA_ERROR_COMMUNICATION_FAILURE ((psa_status_t)-145)
159 
160 /** There was a storage failure that may have led to data loss.
161  *
162  * This error indicates that some persistent storage is corrupted.
163  * It should not be used for a corruption of volatile memory
164  * (use #PSA_ERROR_CORRUPTION_DETECTED), for a communication error
165  * between the cryptoprocessor and its external storage (use
166  * #PSA_ERROR_COMMUNICATION_FAILURE), or when the storage is
167  * in a valid state but is full (use #PSA_ERROR_INSUFFICIENT_STORAGE).
168  *
169  * Note that a storage failure does not indicate that any data that was
170  * previously read is invalid. However this previously read data may no
171  * longer be readable from storage.
172  *
173  * When a storage failure occurs, it is no longer possible to ensure
174  * the global integrity of the keystore. Depending on the global
175  * integrity guarantees offered by the implementation, access to other
176  * data may or may not fail even if the data is still readable but
177  * its integrity cannot be guaranteed.
178  *
179  * Implementations should only use this error code to report a
180  * permanent storage corruption. However application writers should
181  * keep in mind that transient errors while reading the storage may be
182  * reported using this error code. */
183 #define PSA_ERROR_STORAGE_FAILURE ((psa_status_t)-146)
184 
185 /** A hardware failure was detected.
186  *
187  * A hardware failure may be transient or permanent depending on the
188  * cause. */
189 #define PSA_ERROR_HARDWARE_FAILURE ((psa_status_t)-147)
190 
191 /** A tampering attempt was detected.
192  *
193  * If an application receives this error code, there is no guarantee
194  * that previously accessed or computed data was correct and remains
195  * confidential. Applications should not perform any security function
196  * and should enter a safe failure state.
197  *
198  * Implementations may return this error code if they detect an invalid
199  * state that cannot happen during normal operation and that indicates
200  * that the implementation's security guarantees no longer hold. Depending
201  * on the implementation architecture and on its security and safety goals,
202  * the implementation may forcibly terminate the application.
203  *
204  * This error code is intended as a last resort when a security breach
205  * is detected and it is unsure whether the keystore data is still
206  * protected. Implementations shall only return this error code
207  * to report an alarm from a tampering detector, to indicate that
208  * the confidentiality of stored data can no longer be guaranteed,
209  * or to indicate that the integrity of previously returned data is now
210  * considered compromised. Implementations shall not use this error code
211  * to indicate a hardware failure that merely makes it impossible to
212  * perform the requested operation (use #PSA_ERROR_COMMUNICATION_FAILURE,
213  * #PSA_ERROR_STORAGE_FAILURE, #PSA_ERROR_HARDWARE_FAILURE,
214  * #PSA_ERROR_INSUFFICIENT_ENTROPY or other applicable error code
215  * instead).
216  *
217  * This error indicates an attack against the application. Implementations
218  * shall not return this error code as a consequence of the behavior of
219  * the application itself. */
220 #define PSA_ERROR_CORRUPTION_DETECTED ((psa_status_t)-151)
221 
222 /** There is not enough entropy to generate random data needed
223  * for the requested action.
224  *
225  * This error indicates a failure of a hardware random generator.
226  * Application writers should note that this error can be returned not
227  * only by functions whose purpose is to generate random data, such
228  * as key, IV or nonce generation, but also by functions that execute
229  * an algorithm with a randomized result, as well as functions that
230  * use randomization of intermediate computations as a countermeasure
231  * to certain attacks.
232  *
233  * Implementations should avoid returning this error after psa_crypto_init()
234  * has succeeded. Implementations should generate sufficient
235  * entropy during initialization and subsequently use a cryptographically
236  * secure pseudorandom generator (PRNG). However implementations may return
237  * this error at any time if a policy requires the PRNG to be reseeded
238  * during normal operation. */
239 #define PSA_ERROR_INSUFFICIENT_ENTROPY ((psa_status_t)-148)
240 
241 /** The signature, MAC or hash is incorrect.
242  *
243  * Verification functions return this error if the verification
244  * calculations completed successfully, and the value to be verified
245  * was determined to be incorrect.
246  *
247  * If the value to verify has an invalid size, implementations may return
248  * either #PSA_ERROR_INVALID_ARGUMENT or #PSA_ERROR_INVALID_SIGNATURE. */
249 #define PSA_ERROR_INVALID_SIGNATURE ((psa_status_t)-149)
250 
251 /** The decrypted padding is incorrect.
252  *
253  * \warning In some protocols, when decrypting data, it is essential that
254  * the behavior of the application does not depend on whether the padding
255  * is correct, down to precise timing. Applications should prefer
256  * protocols that use authenticated encryption rather than plain
257  * encryption. If the application must perform a decryption of
258  * unauthenticated data, the application writer should take care not
259  * to reveal whether the padding is invalid.
260  *
261  * Implementations should strive to make valid and invalid padding
262  * as close as possible to indistinguishable to an external observer.
263  * In particular, the timing of a decryption operation should not
264  * depend on the validity of the padding. */
265 #define PSA_ERROR_INVALID_PADDING ((psa_status_t)-150)
266 
267 /** Return this error when there's insufficient data when attempting
268  * to read from a resource. */
269 #define PSA_ERROR_INSUFFICIENT_DATA ((psa_status_t)-143)
270 
271 /** The key handle is not valid. See also :ref:\`key-handles\`.
272  */
273 #define PSA_ERROR_INVALID_HANDLE ((psa_status_t)-136)
274 
275 /**@}*/
276 
277 /** \defgroup crypto_types Key and algorithm types
278  * @{
279  */
280 
281 /** An invalid key type value.
282  *
283  * Zero is not the encoding of any key type.
284  */
285 #define PSA_KEY_TYPE_NONE ((psa_key_type_t)0x0000)
286 
287 /** Vendor-defined key type flag.
288  *
289  * Key types defined by this standard will never have the
290  * #PSA_KEY_TYPE_VENDOR_FLAG bit set. Vendors who define additional key types
291  * must use an encoding with the #PSA_KEY_TYPE_VENDOR_FLAG bit set and should
292  * respect the bitwise structure used by standard encodings whenever practical.
293  */
294 #define PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t)0x8000)
295 
296 #define PSA_KEY_TYPE_CATEGORY_MASK ((psa_key_type_t)0x7000)
297 #define PSA_KEY_TYPE_CATEGORY_RAW ((psa_key_type_t)0x1000)
298 #define PSA_KEY_TYPE_CATEGORY_SYMMETRIC ((psa_key_type_t)0x2000)
299 #define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY ((psa_key_type_t)0x4000)
300 #define PSA_KEY_TYPE_CATEGORY_KEY_PAIR ((psa_key_type_t)0x7000)
301 
302 #define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR ((psa_key_type_t)0x3000)
303 
304 /** Whether a key type is vendor-defined.
305  *
306  * See also #PSA_KEY_TYPE_VENDOR_FLAG.
307  */
308 #define PSA_KEY_TYPE_IS_VENDOR_DEFINED(type) \
309  (((type) & PSA_KEY_TYPE_VENDOR_FLAG) != 0)
310 
311 /** Whether a key type is an unstructured array of bytes.
312  *
313  * This encompasses both symmetric keys and non-key data.
314  */
315 #define PSA_KEY_TYPE_IS_UNSTRUCTURED(type) \
316  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_RAW || \
317  ((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC)
318 
319 /** Whether a key type is asymmetric: either a key pair or a public key. */
320 #define PSA_KEY_TYPE_IS_ASYMMETRIC(type) \
321  (((type) & PSA_KEY_TYPE_CATEGORY_MASK \
322  & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR) == \
323  PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
324 /** Whether a key type is the public part of a key pair. */
325 #define PSA_KEY_TYPE_IS_PUBLIC_KEY(type) \
326  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY)
327 /** Whether a key type is a key pair containing a private part and a public
328  * part. */
329 #define PSA_KEY_TYPE_IS_KEY_PAIR(type) \
330  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_KEY_PAIR)
331 /** The key pair type corresponding to a public key type.
332  *
333  * You may also pass a key pair type as \p type, it will be left unchanged.
334  *
335  * \param type A public key type or key pair type.
336  *
337  * \return The corresponding key pair type.
338  * If \p type is not a public key or a key pair,
339  * the return value is undefined.
340  */
341 #define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type) \
342  ((type) | PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
343 /** The public key type corresponding to a key pair type.
344  *
345  * You may also pass a key pair type as \p type, it will be left unchanged.
346  *
347  * \param type A public key type or key pair type.
348  *
349  * \return The corresponding public key type.
350  * If \p type is not a public key or a key pair,
351  * the return value is undefined.
352  */
353 #define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) \
354  ((type) & ~PSA_KEY_TYPE_CATEGORY_FLAG_PAIR)
355 
356 /** Raw data.
357  *
358  * A "key" of this type cannot be used for any cryptographic operation.
359  * Applications may use this type to store arbitrary data in the keystore. */
360 #define PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t)0x1001)
361 
362 /** HMAC key.
363  *
364  * The key policy determines which underlying hash algorithm the key can be
365  * used for.
366  *
367  * HMAC keys should generally have the same size as the underlying hash.
368  * This size can be calculated with #PSA_HASH_SIZE(\c alg) where
369  * \c alg is the HMAC algorithm or the underlying hash algorithm. */
370 #define PSA_KEY_TYPE_HMAC ((psa_key_type_t)0x1100)
371 
372 /** A secret for key derivation.
373  *
374  * The key policy determines which key derivation algorithm the key
375  * can be used for.
376  */
377 #define PSA_KEY_TYPE_DERIVE ((psa_key_type_t)0x1200)
378 
379 /** Key for a cipher, AEAD or MAC algorithm based on the AES block cipher.
380  *
381  * The size of the key can be 16 bytes (AES-128), 24 bytes (AES-192) or
382  * 32 bytes (AES-256).
383  */
384 #define PSA_KEY_TYPE_AES ((psa_key_type_t)0x2400)
385 
386 /** Key for a cipher or MAC algorithm based on DES or 3DES (Triple-DES).
387  *
388  * The size of the key can be 8 bytes (single DES), 16 bytes (2-key 3DES) or
389  * 24 bytes (3-key 3DES).
390  *
391  * Note that single DES and 2-key 3DES are weak and strongly
392  * deprecated and should only be used to decrypt legacy data. 3-key 3DES
393  * is weak and deprecated and should only be used in legacy protocols.
394  */
395 #define PSA_KEY_TYPE_DES ((psa_key_type_t)0x2301)
396 
397 /** Key for a cipher, AEAD or MAC algorithm based on the
398  * Camellia block cipher. */
399 #define PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t)0x2403)
400 
401 /** Key for the RC4 stream cipher.
402  *
403  * Note that RC4 is weak and deprecated and should only be used in
404  * legacy protocols. */
405 #define PSA_KEY_TYPE_ARC4 ((psa_key_type_t)0x2002)
406 
407 /** Key for the ChaCha20 stream cipher or the Chacha20-Poly1305 AEAD algorithm.
408  *
409  * ChaCha20 and the ChaCha20_Poly1305 construction are defined in RFC 7539.
410  *
411  * Implementations must support 12-byte nonces, may support 8-byte nonces,
412  * and should reject other sizes.
413  */
414 #define PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t)0x2004)
415 
416 /** RSA public key. */
417 #define PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t)0x4001)
418 /** RSA key pair (private and public key). */
419 #define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t)0x7001)
420 /** Whether a key type is an RSA key (pair or public-only). */
421 #define PSA_KEY_TYPE_IS_RSA(type) \
422  (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == PSA_KEY_TYPE_RSA_PUBLIC_KEY)
423 
424 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE ((psa_key_type_t)0x4100)
425 #define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE ((psa_key_type_t)0x7100)
426 #define PSA_KEY_TYPE_ECC_CURVE_MASK ((psa_key_type_t)0x00ff)
427 /** Elliptic curve key pair.
428  *
429  * \param curve A value of type ::psa_ecc_curve_t that identifies the
430  * ECC curve to be used.
431  */
432 #define PSA_KEY_TYPE_ECC_KEY_PAIR(curve) \
433  (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
434 /** Elliptic curve public key.
435  *
436  * \param curve A value of type ::psa_ecc_curve_t that identifies the
437  * ECC curve to be used.
438  */
439 #define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve) \
440  (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
441 
442 /** Whether a key type is an elliptic curve key (pair or public-only). */
443 #define PSA_KEY_TYPE_IS_ECC(type) \
444  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
445  ~PSA_KEY_TYPE_ECC_CURVE_MASK) == PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
446 /** Whether a key type is an elliptic curve key pair. */
447 #define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type) \
448  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
449  PSA_KEY_TYPE_ECC_KEY_PAIR_BASE)
450 /** Whether a key type is an elliptic curve public key. */
451 #define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type) \
452  (((type) & ~PSA_KEY_TYPE_ECC_CURVE_MASK) == \
453  PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE)
454 
455 /** Extract the curve from an elliptic curve key type. */
456 #define PSA_KEY_TYPE_GET_CURVE(type) \
457  ((psa_ecc_curve_t) (PSA_KEY_TYPE_IS_ECC(type) ? \
458  ((type) & PSA_KEY_TYPE_ECC_CURVE_MASK) : \
459  0))
460 
461 /** SEC Koblitz curves over prime fields.
462  *
463  * This family comprises the following curves:
464  * secp192k1, secp224k1, secp256k1.
465  * They are defined in _Standards for Efficient Cryptography_,
466  * _SEC 2: Recommended Elliptic Curve Domain Parameters_.
467  * https://www.secg.org/sec2-v2.pdf
468  */
469 #define PSA_ECC_CURVE_SECP_K1 ((psa_ecc_curve_t) 0x17)
470 
471 /** SEC random curves over prime fields.
472  *
473  * This family comprises the following curves:
474  * secp192k1, secp224r1, secp256r1, secp384r1, secp521r1.
475  * They are defined in _Standards for Efficient Cryptography_,
476  * _SEC 2: Recommended Elliptic Curve Domain Parameters_.
477  * https://www.secg.org/sec2-v2.pdf
478  */
479 #define PSA_ECC_CURVE_SECP_R1 ((psa_ecc_curve_t) 0x12)
480 /* SECP160R2 (SEC2 v1, obsolete) */
481 #define PSA_ECC_CURVE_SECP_R2 ((psa_ecc_curve_t) 0x1b)
482 
483 /** SEC Koblitz curves over binary fields.
484  *
485  * This family comprises the following curves:
486  * sect163k1, sect233k1, sect239k1, sect283k1, sect409k1, sect571k1.
487  * They are defined in _Standards for Efficient Cryptography_,
488  * _SEC 2: Recommended Elliptic Curve Domain Parameters_.
489  * https://www.secg.org/sec2-v2.pdf
490  */
491 #define PSA_ECC_CURVE_SECT_K1 ((psa_ecc_curve_t) 0x27)
492 
493 /** SEC random curves over binary fields.
494  *
495  * This family comprises the following curves:
496  * sect163r1, sect233r1, sect283r1, sect409r1, sect571r1.
497  * They are defined in _Standards for Efficient Cryptography_,
498  * _SEC 2: Recommended Elliptic Curve Domain Parameters_.
499  * https://www.secg.org/sec2-v2.pdf
500  */
501 #define PSA_ECC_CURVE_SECT_R1 ((psa_ecc_curve_t) 0x22)
502 
503 /** SEC additional random curves over binary fields.
504  *
505  * This family comprises the following curve:
506  * sect163r2.
507  * It is defined in _Standards for Efficient Cryptography_,
508  * _SEC 2: Recommended Elliptic Curve Domain Parameters_.
509  * https://www.secg.org/sec2-v2.pdf
510  */
511 #define PSA_ECC_CURVE_SECT_R2 ((psa_ecc_curve_t) 0x2b)
512 
513 /** Brainpool P random curves.
514  *
515  * This family comprises the following curves:
516  * brainpoolP160r1, brainpoolP192r1, brainpoolP224r1, brainpoolP256r1,
517  * brainpoolP320r1, brainpoolP384r1, brainpoolP512r1.
518  * It is defined in RFC 5639.
519  */
520 #define PSA_ECC_CURVE_BRAINPOOL_P_R1 ((psa_ecc_curve_t) 0x30)
521 
522 /** Curve25519 and Curve448.
523  *
524  * This family comprises the following Montgomery curves:
525  * - 255-bit: Bernstein et al.,
526  * _Curve25519: new Diffie-Hellman speed records_, LNCS 3958, 2006.
527  * The algorithm #PSA_ALG_ECDH performs X25519 when used with this curve.
528  * - 448-bit: Hamburg,
529  * _Ed448-Goldilocks, a new elliptic curve_, NIST ECC Workshop, 2015.
530  * The algorithm #PSA_ALG_ECDH performs X448 when used with this curve.
531  */
532 #define PSA_ECC_CURVE_MONTGOMERY ((psa_ecc_curve_t) 0x41)
533 
534 #define PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE ((psa_key_type_t)0x4200)
535 #define PSA_KEY_TYPE_DH_KEY_PAIR_BASE ((psa_key_type_t)0x7200)
536 #define PSA_KEY_TYPE_DH_GROUP_MASK ((psa_key_type_t)0x00ff)
537 /** Diffie-Hellman key pair.
538  *
539  * \param group A value of type ::psa_dh_group_t that identifies the
540  * Diffie-Hellman group to be used.
541  */
542 #define PSA_KEY_TYPE_DH_KEY_PAIR(group) \
543  (PSA_KEY_TYPE_DH_KEY_PAIR_BASE | (group))
544 /** Diffie-Hellman public key.
545  *
546  * \param group A value of type ::psa_dh_group_t that identifies the
547  * Diffie-Hellman group to be used.
548  */
549 #define PSA_KEY_TYPE_DH_PUBLIC_KEY(group) \
550  (PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE | (group))
551 
552 /** Whether a key type is a Diffie-Hellman key (pair or public-only). */
553 #define PSA_KEY_TYPE_IS_DH(type) \
554  ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & \
555  ~PSA_KEY_TYPE_DH_GROUP_MASK) == PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
556 /** Whether a key type is a Diffie-Hellman key pair. */
557 #define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type) \
558  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
559  PSA_KEY_TYPE_DH_KEY_PAIR_BASE)
560 /** Whether a key type is a Diffie-Hellman public key. */
561 #define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type) \
562  (((type) & ~PSA_KEY_TYPE_DH_GROUP_MASK) == \
563  PSA_KEY_TYPE_DH_PUBLIC_KEY_BASE)
564 
565 /** Extract the group from a Diffie-Hellman key type. */
566 #define PSA_KEY_TYPE_GET_GROUP(type) \
567  ((psa_dh_group_t) (PSA_KEY_TYPE_IS_DH(type) ? \
568  ((type) & PSA_KEY_TYPE_DH_GROUP_MASK) : \
569  0))
570 
571 /** Diffie-Hellman groups defined in RFC 7919 Appendix A.
572  *
573  * This family includes groups with the following key sizes (in bits):
574  * 2048, 3072, 4096, 6144, 8192. A given implementation may support
575  * all of these sizes or only a subset.
576  */
577 #define PSA_DH_GROUP_RFC7919 ((psa_dh_group_t) 0x03)
578 
579 #define PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) \
580  (((type) >> 8) & 7)
581 /** The block size of a block cipher.
582  *
583  * \param type A cipher key type (value of type #psa_key_type_t).
584  *
585  * \return The block size for a block cipher, or 1 for a stream cipher.
586  * The return value is undefined if \p type is not a supported
587  * cipher key type.
588  *
589  * \note It is possible to build stream cipher algorithms on top of a block
590  * cipher, for example CTR mode (#PSA_ALG_CTR).
591  * This macro only takes the key type into account, so it cannot be
592  * used to determine the size of the data that #psa_cipher_update()
593  * might buffer for future processing in general.
594  *
595  * \note This macro returns a compile-time constant if its argument is one.
596  *
597  * \warning This macro may evaluate its argument multiple times.
598  */
599 #define PSA_BLOCK_CIPHER_BLOCK_SIZE(type) \
600  (((type) & PSA_KEY_TYPE_CATEGORY_MASK) == PSA_KEY_TYPE_CATEGORY_SYMMETRIC ? \
601  1u << PSA_GET_KEY_TYPE_BLOCK_SIZE_EXPONENT(type) : \
602  0u)
603 
604 /** Vendor-defined algorithm flag.
605  *
606  * Algorithms defined by this standard will never have the #PSA_ALG_VENDOR_FLAG
607  * bit set. Vendors who define additional algorithms must use an encoding with
608  * the #PSA_ALG_VENDOR_FLAG bit set and should respect the bitwise structure
609  * used by standard encodings whenever practical.
610  */
611 #define PSA_ALG_VENDOR_FLAG ((psa_algorithm_t)0x80000000)
612 
613 #define PSA_ALG_CATEGORY_MASK ((psa_algorithm_t)0x7f000000)
614 #define PSA_ALG_CATEGORY_HASH ((psa_algorithm_t)0x01000000)
615 #define PSA_ALG_CATEGORY_MAC ((psa_algorithm_t)0x02000000)
616 #define PSA_ALG_CATEGORY_CIPHER ((psa_algorithm_t)0x04000000)
617 #define PSA_ALG_CATEGORY_AEAD ((psa_algorithm_t)0x06000000)
618 #define PSA_ALG_CATEGORY_SIGN ((psa_algorithm_t)0x10000000)
619 #define PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION ((psa_algorithm_t)0x12000000)
620 #define PSA_ALG_CATEGORY_KEY_DERIVATION ((psa_algorithm_t)0x20000000)
621 #define PSA_ALG_CATEGORY_KEY_AGREEMENT ((psa_algorithm_t)0x30000000)
622 
623 /** Whether an algorithm is vendor-defined.
624  *
625  * See also #PSA_ALG_VENDOR_FLAG.
626  */
627 #define PSA_ALG_IS_VENDOR_DEFINED(alg) \
628  (((alg) & PSA_ALG_VENDOR_FLAG) != 0)
629 
630 /** Whether the specified algorithm is a hash algorithm.
631  *
632  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
633  *
634  * \return 1 if \p alg is a hash algorithm, 0 otherwise.
635  * This macro may return either 0 or 1 if \p alg is not a supported
636  * algorithm identifier.
637  */
638 #define PSA_ALG_IS_HASH(alg) \
639  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_HASH)
640 
641 /** Whether the specified algorithm is a MAC algorithm.
642  *
643  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
644  *
645  * \return 1 if \p alg is a MAC algorithm, 0 otherwise.
646  * This macro may return either 0 or 1 if \p alg is not a supported
647  * algorithm identifier.
648  */
649 #define PSA_ALG_IS_MAC(alg) \
650  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_MAC)
651 
652 /** Whether the specified algorithm is a symmetric cipher algorithm.
653  *
654  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
655  *
656  * \return 1 if \p alg is a symmetric cipher algorithm, 0 otherwise.
657  * This macro may return either 0 or 1 if \p alg is not a supported
658  * algorithm identifier.
659  */
660 #define PSA_ALG_IS_CIPHER(alg) \
661  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_CIPHER)
662 
663 /** Whether the specified algorithm is an authenticated encryption
664  * with associated data (AEAD) algorithm.
665  *
666  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
667  *
668  * \return 1 if \p alg is an AEAD algorithm, 0 otherwise.
669  * This macro may return either 0 or 1 if \p alg is not a supported
670  * algorithm identifier.
671  */
672 #define PSA_ALG_IS_AEAD(alg) \
673  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_AEAD)
674 
675 /** Whether the specified algorithm is a public-key signature algorithm.
676  *
677  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
678  *
679  * \return 1 if \p alg is a public-key signature algorithm, 0 otherwise.
680  * This macro may return either 0 or 1 if \p alg is not a supported
681  * algorithm identifier.
682  */
683 #define PSA_ALG_IS_SIGN(alg) \
684  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_SIGN)
685 
686 /** Whether the specified algorithm is a public-key encryption algorithm.
687  *
688  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
689  *
690  * \return 1 if \p alg is a public-key encryption algorithm, 0 otherwise.
691  * This macro may return either 0 or 1 if \p alg is not a supported
692  * algorithm identifier.
693  */
694 #define PSA_ALG_IS_ASYMMETRIC_ENCRYPTION(alg) \
695  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_ASYMMETRIC_ENCRYPTION)
696 
697 /** Whether the specified algorithm is a key agreement algorithm.
698  *
699  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
700  *
701  * \return 1 if \p alg is a key agreement algorithm, 0 otherwise.
702  * This macro may return either 0 or 1 if \p alg is not a supported
703  * algorithm identifier.
704  */
705 #define PSA_ALG_IS_KEY_AGREEMENT(alg) \
706  (((alg) & PSA_ALG_CATEGORY_MASK) == PSA_ALG_CATEGORY_KEY_AGREEMENT)
707 
708 /** Whether the specified algorithm is a key derivation algorithm.
709  *
710  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
711  *
712  * \return 1 if \p alg is a key derivation algorithm, 0 otherwise.
713  * This macro may return either 0 or 1 if \p alg is not a supported
714  * algorithm identifier.
715  */
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 /** MD2 */
721 #define PSA_ALG_MD2 ((psa_algorithm_t)0x01000001)
722 /** MD4 */
723 #define PSA_ALG_MD4 ((psa_algorithm_t)0x01000002)
724 /** MD5 */
725 #define PSA_ALG_MD5 ((psa_algorithm_t)0x01000003)
726 /** PSA_ALG_RIPEMD160 */
727 #define PSA_ALG_RIPEMD160 ((psa_algorithm_t)0x01000004)
728 /** SHA1 */
729 #define PSA_ALG_SHA_1 ((psa_algorithm_t)0x01000005)
730 /** SHA2-224 */
731 #define PSA_ALG_SHA_224 ((psa_algorithm_t)0x01000008)
732 /** SHA2-256 */
733 #define PSA_ALG_SHA_256 ((psa_algorithm_t)0x01000009)
734 /** SHA2-384 */
735 #define PSA_ALG_SHA_384 ((psa_algorithm_t)0x0100000a)
736 /** SHA2-512 */
737 #define PSA_ALG_SHA_512 ((psa_algorithm_t)0x0100000b)
738 /** SHA2-512/224 */
739 #define PSA_ALG_SHA_512_224 ((psa_algorithm_t)0x0100000c)
740 /** SHA2-512/256 */
741 #define PSA_ALG_SHA_512_256 ((psa_algorithm_t)0x0100000d)
742 /** SHA3-224 */
743 #define PSA_ALG_SHA3_224 ((psa_algorithm_t)0x01000010)
744 /** SHA3-256 */
745 #define PSA_ALG_SHA3_256 ((psa_algorithm_t)0x01000011)
746 /** SHA3-384 */
747 #define PSA_ALG_SHA3_384 ((psa_algorithm_t)0x01000012)
748 /** SHA3-512 */
749 #define PSA_ALG_SHA3_512 ((psa_algorithm_t)0x01000013)
750 
751 /** In a hash-and-sign algorithm policy, allow any hash algorithm.
752  *
753  * This value may be used to form the algorithm usage field of a policy
754  * for a signature algorithm that is parametrized by a hash. The key
755  * may then be used to perform operations using the same signature
756  * algorithm parametrized with any supported hash.
757  *
758  * That is, suppose that `PSA_xxx_SIGNATURE` is one of the following macros:
759  * - #PSA_ALG_RSA_PKCS1V15_SIGN, #PSA_ALG_RSA_PSS,
760  * - #PSA_ALG_ECDSA, #PSA_ALG_DETERMINISTIC_ECDSA.
761  * Then you may create and use a key as follows:
762  * - Set the key usage field using #PSA_ALG_ANY_HASH, for example:
763  * ```
764  * psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH); // or VERIFY
765  * psa_set_key_algorithm(&attributes, PSA_xxx_SIGNATURE(PSA_ALG_ANY_HASH));
766  * ```
767  * - Import or generate key material.
768  * - Call psa_sign_hash() or psa_verify_hash(), passing
769  * an algorithm built from `PSA_xxx_SIGNATURE` and a specific hash. Each
770  * call to sign or verify a message may use a different hash.
771  * ```
772  * psa_sign_hash(handle, PSA_xxx_SIGNATURE(PSA_ALG_SHA_256), ...);
773  * psa_sign_hash(handle, PSA_xxx_SIGNATURE(PSA_ALG_SHA_512), ...);
774  * psa_sign_hash(handle, PSA_xxx_SIGNATURE(PSA_ALG_SHA3_256), ...);
775  * ```
776  *
777  * This value may not be used to build other algorithms that are
778  * parametrized over a hash. For any valid use of this macro to build
779  * an algorithm \c alg, #PSA_ALG_IS_HASH_AND_SIGN(\c alg) is true.
780  *
781  * This value may not be used to build an algorithm specification to
782  * perform an operation. It is only valid to build policies.
783  */
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 /** Macro to build an HMAC algorithm.
789  *
790  * For example, #PSA_ALG_HMAC(#PSA_ALG_SHA_256) is HMAC-SHA-256.
791  *
792  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
793  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
794  *
795  * \return The corresponding HMAC algorithm.
796  * \return Unspecified if \p hash_alg is not a supported
797  * hash algorithm.
798  */
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 
805 /** Whether the specified algorithm is an HMAC algorithm.
806  *
807  * HMAC is a family of MAC algorithms that are based on a hash function.
808  *
809  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
810  *
811  * \return 1 if \p alg is an HMAC algorithm, 0 otherwise.
812  * This macro may return either 0 or 1 if \p alg is not a supported
813  * algorithm identifier.
814  */
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 
829 /** Macro to build a truncated MAC algorithm.
830  *
831  * A truncated MAC algorithm is identical to the corresponding MAC
832  * algorithm except that the MAC value for the truncated algorithm
833  * consists of only the first \p mac_length bytes of the MAC value
834  * for the untruncated algorithm.
835  *
836  * \note This macro may allow constructing algorithm identifiers that
837  * are not valid, either because the specified length is larger
838  * than the untruncated MAC or because the specified length is
839  * smaller than permitted by the implementation.
840  *
841  * \note It is implementation-defined whether a truncated MAC that
842  * is truncated to the same length as the MAC of the untruncated
843  * algorithm is considered identical to the untruncated algorithm
844  * for policy comparison purposes.
845  *
846  * \param mac_alg A MAC algorithm identifier (value of type
847  * #psa_algorithm_t such that #PSA_ALG_IS_MAC(\p alg)
848  * is true). This may be a truncated or untruncated
849  * MAC algorithm.
850  * \param mac_length Desired length of the truncated MAC in bytes.
851  * This must be at most the full length of the MAC
852  * and must be at least an implementation-specified
853  * minimum. The implementation-specified minimum
854  * shall not be zero.
855  *
856  * \return The corresponding MAC algorithm with the specified
857  * length.
858  * \return Unspecified if \p alg is not a supported
859  * MAC algorithm or if \p mac_length is too small or
860  * too large for the specified MAC algorithm.
861  */
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 
866 /** Macro to build the base MAC algorithm corresponding to a truncated
867  * MAC algorithm.
868  *
869  * \param mac_alg A MAC algorithm identifier (value of type
870  * #psa_algorithm_t such that #PSA_ALG_IS_MAC(\p alg)
871  * is true). This may be a truncated or untruncated
872  * MAC algorithm.
873  *
874  * \return The corresponding base MAC algorithm.
875  * \return Unspecified if \p alg is not a supported
876  * MAC algorithm.
877  */
878 #define PSA_ALG_FULL_LENGTH_MAC(mac_alg) \
879  ((mac_alg) & ~PSA_ALG_MAC_TRUNCATION_MASK)
880 
881 /** Length to which a MAC algorithm is truncated.
882  *
883  * \param mac_alg A MAC algorithm identifier (value of type
884  * #psa_algorithm_t such that #PSA_ALG_IS_MAC(\p alg)
885  * is true).
886  *
887  * \return Length of the truncated MAC in bytes.
888  * \return 0 if \p alg is a non-truncated MAC algorithm.
889  * \return Unspecified if \p alg is not a supported
890  * MAC algorithm.
891  */
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 /** The CBC-MAC construction over a block cipher
897  *
898  * \warning CBC-MAC is insecure in many cases.
899  * A more secure mode, such as #PSA_ALG_CMAC, is recommended.
900  */
901 #define PSA_ALG_CBC_MAC ((psa_algorithm_t)0x02c00001)
902 /** The CMAC construction over a block cipher */
903 #define PSA_ALG_CMAC ((psa_algorithm_t)0x02c00002)
904 
905 /** Whether the specified algorithm is a MAC algorithm based on a block cipher.
906  *
907  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
908  *
909  * \return 1 if \p alg is a MAC algorithm based on a block cipher, 0 otherwise.
910  * This macro may return either 0 or 1 if \p alg is not a supported
911  * algorithm identifier.
912  */
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 
920 /** Whether the specified algorithm is a stream cipher.
921  *
922  * A stream cipher is a symmetric cipher that encrypts or decrypts messages
923  * by applying a bitwise-xor with a stream of bytes that is generated
924  * from a key.
925  *
926  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
927  *
928  * \return 1 if \p alg is a stream cipher algorithm, 0 otherwise.
929  * This macro may return either 0 or 1 if \p alg is not a supported
930  * algorithm identifier or if it is not a symmetric cipher algorithm.
931  */
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 
936 /** The ARC4 stream cipher algorithm.
937  */
938 #define PSA_ALG_ARC4 ((psa_algorithm_t)0x04800001)
939 
940 /** The ChaCha20 stream cipher.
941  *
942  * ChaCha20 is defined in RFC 7539.
943  *
944  * The nonce size for psa_cipher_set_iv() or psa_cipher_generate_iv()
945  * must be 12.
946  *
947  * The initial block counter is always 0.
948  *
949  */
950 #define PSA_ALG_CHACHA20 ((psa_algorithm_t)0x04800005)
951 
952 /** The CTR stream cipher mode.
953  *
954  * CTR is a stream cipher which is built from a block cipher.
955  * The underlying block cipher is determined by the key type.
956  * For example, to use AES-128-CTR, use this algorithm with
957  * a key of type #PSA_KEY_TYPE_AES and a length of 128 bits (16 bytes).
958  */
959 #define PSA_ALG_CTR ((psa_algorithm_t)0x04c00001)
960 
961 /** The CFB stream cipher mode.
962  *
963  * The underlying block cipher is determined by the key type.
964  */
965 #define PSA_ALG_CFB ((psa_algorithm_t)0x04c00002)
966 
967 /** The OFB stream cipher mode.
968  *
969  * The underlying block cipher is determined by the key type.
970  */
971 #define PSA_ALG_OFB ((psa_algorithm_t)0x04c00003)
972 
973 /** The XTS cipher mode.
974  *
975  * XTS is a cipher mode which is built from a block cipher. It requires at
976  * least one full block of input, but beyond this minimum the input
977  * does not need to be a whole number of blocks.
978  */
979 #define PSA_ALG_XTS ((psa_algorithm_t)0x044000ff)
980 
981 /** The CBC block cipher chaining mode, with no padding.
982  *
983  * The underlying block cipher is determined by the key type.
984  *
985  * This symmetric cipher mode can only be used with messages whose lengths
986  * are whole number of blocks for the chosen block cipher.
987  */
988 #define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t)0x04600100)
989 
990 /** The CBC block cipher chaining mode with PKCS#7 padding.
991  *
992  * The underlying block cipher is determined by the key type.
993  *
994  * This is the padding method defined by PKCS#7 (RFC 2315) &sect;10.3.
995  */
996 #define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t)0x04600101)
997 
998 #define PSA_ALG_AEAD_FROM_BLOCK_FLAG ((psa_algorithm_t)0x00400000)
999 
1000 /** Whether the specified algorithm is an AEAD mode on a block cipher.
1001  *
1002  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1003  *
1004  * \return 1 if \p alg is an AEAD algorithm which is an AEAD mode based on
1005  * a block cipher, 0 otherwise.
1006  * This macro may return either 0 or 1 if \p alg is not a supported
1007  * algorithm identifier.
1008  */
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 
1013 /** The CCM authenticated encryption algorithm.
1014  *
1015  * The underlying block cipher is determined by the key type.
1016  */
1017 #define PSA_ALG_CCM ((psa_algorithm_t)0x06401001)
1018 
1019 /** The GCM authenticated encryption algorithm.
1020  *
1021  * The underlying block cipher is determined by the key type.
1022  */
1023 #define PSA_ALG_GCM ((psa_algorithm_t)0x06401002)
1024 
1025 /** The Chacha20-Poly1305 AEAD algorithm.
1026  *
1027  * The ChaCha20_Poly1305 construction is defined in RFC 7539.
1028  *
1029  * Implementations must support 12-byte nonces, may support 8-byte nonces,
1030  * and should reject other sizes.
1031  *
1032  * Implementations must support 16-byte tags and should reject other sizes.
1033  */
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 
1043 /** Macro to build a shortened AEAD algorithm.
1044  *
1045  * A shortened AEAD algorithm is similar to the corresponding AEAD
1046  * algorithm, but has an authentication tag that consists of fewer bytes.
1047  * Depending on the algorithm, the tag length may affect the calculation
1048  * of the ciphertext.
1049  *
1050  * \param aead_alg An AEAD algorithm identifier (value of type
1051  * #psa_algorithm_t such that #PSA_ALG_IS_AEAD(\p alg)
1052  * is true).
1053  * \param tag_length Desired length of the authentication tag in bytes.
1054  *
1055  * \return The corresponding AEAD algorithm with the specified
1056  * length.
1057  * \return Unspecified if \p alg is not a supported
1058  * AEAD algorithm or if \p tag_length is not valid
1059  * for the specified AEAD algorithm.
1060  */
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 
1066 /** Calculate the corresponding AEAD algorithm with the default tag length.
1067  *
1068  * \param aead_alg An AEAD algorithm (\c PSA_ALG_XXX value such that
1069  * #PSA_ALG_IS_AEAD(\p alg) is true).
1070  *
1071  * \return The corresponding AEAD algorithm with the default
1072  * tag length for that algorithm.
1073  */
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 /** RSA PKCS#1 v1.5 signature with hashing.
1087  *
1088  * This is the signature scheme defined by RFC 8017
1089  * (PKCS#1: RSA Cryptography Specifications) under the name
1090  * RSASSA-PKCS1-v1_5.
1091  *
1092  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1093  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1094  * This includes #PSA_ALG_ANY_HASH
1095  * when specifying the algorithm in a usage policy.
1096  *
1097  * \return The corresponding RSA PKCS#1 v1.5 signature algorithm.
1098  * \return Unspecified if \p hash_alg is not a supported
1099  * hash algorithm.
1100  */
1101 #define PSA_ALG_RSA_PKCS1V15_SIGN(hash_alg) \
1102  (PSA_ALG_RSA_PKCS1V15_SIGN_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1103 /** Raw PKCS#1 v1.5 signature.
1104  *
1105  * The input to this algorithm is the DigestInfo structure used by
1106  * RFC 8017 (PKCS#1: RSA Cryptography Specifications), &sect;9.2
1107  * steps 3&ndash;6.
1108  */
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 /** RSA PSS signature with hashing.
1115  *
1116  * This is the signature scheme defined by RFC 8017
1117  * (PKCS#1: RSA Cryptography Specifications) under the name
1118  * RSASSA-PSS, with the message generation function MGF1, and with
1119  * a salt length equal to the length of the hash. The specified
1120  * hash algorithm is used to hash the input message, to create the
1121  * salted hash, and for the mask generation.
1122  *
1123  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1124  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1125  * This includes #PSA_ALG_ANY_HASH
1126  * when specifying the algorithm in a usage policy.
1127  *
1128  * \return The corresponding RSA PSS signature algorithm.
1129  * \return Unspecified if \p hash_alg is not a supported
1130  * hash algorithm.
1131  */
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 /** ECDSA signature with hashing.
1139  *
1140  * This is the ECDSA signature scheme defined by ANSI X9.62,
1141  * with a random per-message secret number (*k*).
1142  *
1143  * The representation of the signature as a byte string consists of
1144  * the concatentation of the signature values *r* and *s*. Each of
1145  * *r* and *s* is encoded as an *N*-octet string, where *N* is the length
1146  * of the base point of the curve in octets. Each value is represented
1147  * in big-endian order (most significant octet first).
1148  *
1149  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1150  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1151  * This includes #PSA_ALG_ANY_HASH
1152  * when specifying the algorithm in a usage policy.
1153  *
1154  * \return The corresponding ECDSA signature algorithm.
1155  * \return Unspecified if \p hash_alg is not a supported
1156  * hash algorithm.
1157  */
1158 #define PSA_ALG_ECDSA(hash_alg) \
1159  (PSA_ALG_ECDSA_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1160 /** ECDSA signature without hashing.
1161  *
1162  * This is the same signature scheme as #PSA_ALG_ECDSA(), but
1163  * without specifying a hash algorithm. This algorithm may only be
1164  * used to sign or verify a sequence of bytes that should be an
1165  * already-calculated hash. Note that the input is padded with
1166  * zeros on the left or truncated on the left as required to fit
1167  * the curve size.
1168  */
1169 #define PSA_ALG_ECDSA_ANY PSA_ALG_ECDSA_BASE
1170 #define PSA_ALG_DETERMINISTIC_ECDSA_BASE ((psa_algorithm_t)0x10070000)
1171 /** Deterministic ECDSA signature with hashing.
1172  *
1173  * This is the deterministic ECDSA signature scheme defined by RFC 6979.
1174  *
1175  * The representation of a signature is the same as with #PSA_ALG_ECDSA().
1176  *
1177  * Note that when this algorithm is used for verification, signatures
1178  * made with randomized ECDSA (#PSA_ALG_ECDSA(\p hash_alg)) with the
1179  * same private key are accepted. In other words,
1180  * #PSA_ALG_DETERMINISTIC_ECDSA(\p hash_alg) differs from
1181  * #PSA_ALG_ECDSA(\p hash_alg) only for signature, not for verification.
1182  *
1183  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1184  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1185  * This includes #PSA_ALG_ANY_HASH
1186  * when specifying the algorithm in a usage policy.
1187  *
1188  * \return The corresponding deterministic ECDSA signature
1189  * algorithm.
1190  * \return Unspecified if \p hash_alg is not a supported
1191  * hash algorithm.
1192  */
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 
1206 /** Whether the specified algorithm is a hash-and-sign algorithm.
1207  *
1208  * Hash-and-sign algorithms are public-key signature algorithms structured
1209  * in two parts: first the calculation of a hash in a way that does not
1210  * depend on the key, then the calculation of a signature from the
1211  * hash value and the key.
1212  *
1213  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1214  *
1215  * \return 1 if \p alg is a hash-and-sign algorithm, 0 otherwise.
1216  * This macro may return either 0 or 1 if \p alg is not a supported
1217  * algorithm identifier.
1218  */
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 
1223 /** Get the hash used by a hash-and-sign signature algorithm.
1224  *
1225  * A hash-and-sign algorithm is a signature algorithm which is
1226  * composed of two phases: first a hashing phase which does not use
1227  * the key and produces a hash of the input message, then a signing
1228  * phase which only uses the hash and the key and not the message
1229  * itself.
1230  *
1231  * \param alg A signature algorithm (\c PSA_ALG_XXX value such that
1232  * #PSA_ALG_IS_SIGN(\p alg) is true).
1233  *
1234  * \return The underlying hash algorithm if \p alg is a hash-and-sign
1235  * algorithm.
1236  * \return 0 if \p alg is a signature algorithm that does not
1237  * follow the hash-and-sign structure.
1238  * \return Unspecified if \p alg is not a signature algorithm or
1239  * if it is not supported by the implementation.
1240  */
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 
1247 /** RSA PKCS#1 v1.5 encryption.
1248  */
1249 #define PSA_ALG_RSA_PKCS1V15_CRYPT ((psa_algorithm_t)0x12020000)
1250 
1251 #define PSA_ALG_RSA_OAEP_BASE ((psa_algorithm_t)0x12030000)
1252 /** RSA OAEP encryption.
1253  *
1254  * This is the encryption scheme defined by RFC 8017
1255  * (PKCS#1: RSA Cryptography Specifications) under the name
1256  * RSAES-OAEP, with the message generation function MGF1.
1257  *
1258  * \param hash_alg The hash algorithm (\c PSA_ALG_XXX value such that
1259  * #PSA_ALG_IS_HASH(\p hash_alg) is true) to use
1260  * for MGF1.
1261  *
1262  * \return The corresponding RSA OAEP signature algorithm.
1263  * \return Unspecified if \p hash_alg is not a supported
1264  * hash algorithm.
1265  */
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 /** Macro to build an HKDF algorithm.
1277  *
1278  * For example, `PSA_ALG_HKDF(PSA_ALG_SHA256)` is HKDF using HMAC-SHA-256.
1279  *
1280  * This key derivation algorithm uses the following inputs:
1281  * - #PSA_KEY_DERIVATION_INPUT_SALT is the salt used in the "extract" step.
1282  * It is optional; if omitted, the derivation uses an empty salt.
1283  * - #PSA_KEY_DERIVATION_INPUT_SECRET is the secret key used in the "extract" step.
1284  * - #PSA_KEY_DERIVATION_INPUT_INFO is the info string used in the "expand" step.
1285  * You must pass #PSA_KEY_DERIVATION_INPUT_SALT before #PSA_KEY_DERIVATION_INPUT_SECRET.
1286  * You may pass #PSA_KEY_DERIVATION_INPUT_INFO at any time after steup and before
1287  * starting to generate output.
1288  *
1289  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1290  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1291  *
1292  * \return The corresponding HKDF algorithm.
1293  * \return Unspecified if \p hash_alg is not a supported
1294  * hash algorithm.
1295  */
1296 #define PSA_ALG_HKDF(hash_alg) \
1297  (PSA_ALG_HKDF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1298 /** Whether the specified algorithm is an HKDF algorithm.
1299  *
1300  * HKDF is a family of key derivation algorithms that are based on a hash
1301  * function and the HMAC construction.
1302  *
1303  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1304  *
1305  * \return 1 if \c alg is an HKDF algorithm, 0 otherwise.
1306  * This macro may return either 0 or 1 if \c alg is not a supported
1307  * key derivation algorithm identifier.
1308  */
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 /** Macro to build a TLS-1.2 PRF algorithm.
1316  *
1317  * TLS 1.2 uses a custom pseudorandom function (PRF) for key schedule,
1318  * specified in Section 5 of RFC 5246. It is based on HMAC and can be
1319  * used with either SHA-256 or SHA-384.
1320  *
1321  * This key derivation algorithm uses the following inputs, which must be
1322  * passed in the order given here:
1323  * - #PSA_KEY_DERIVATION_INPUT_SEED is the seed.
1324  * - #PSA_KEY_DERIVATION_INPUT_SECRET is the secret key.
1325  * - #PSA_KEY_DERIVATION_INPUT_LABEL is the label.
1326  *
1327  * For the application to TLS-1.2 key expansion, the seed is the
1328  * concatenation of ServerHello.Random + ClientHello.Random,
1329  * and the label is "key expansion".
1330  *
1331  * For example, `PSA_ALG_TLS12_PRF(PSA_ALG_SHA256)` represents the
1332  * TLS 1.2 PRF using HMAC-SHA-256.
1333  *
1334  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1335  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1336  *
1337  * \return The corresponding TLS-1.2 PRF algorithm.
1338  * \return Unspecified if \p hash_alg is not a supported
1339  * hash algorithm.
1340  */
1341 #define PSA_ALG_TLS12_PRF(hash_alg) \
1342  (PSA_ALG_TLS12_PRF_BASE | ((hash_alg) & PSA_ALG_HASH_MASK))
1343 
1344 /** Whether the specified algorithm is a TLS-1.2 PRF algorithm.
1345  *
1346  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1347  *
1348  * \return 1 if \c alg is a TLS-1.2 PRF algorithm, 0 otherwise.
1349  * This macro may return either 0 or 1 if \c alg is not a supported
1350  * key derivation algorithm identifier.
1351  */
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 /** Macro to build a TLS-1.2 PSK-to-MasterSecret algorithm.
1359  *
1360  * In a pure-PSK handshake in TLS 1.2, the master secret is derived
1361  * from the PreSharedKey (PSK) through the application of padding
1362  * (RFC 4279, Section 2) and the TLS-1.2 PRF (RFC 5246, Section 5).
1363  * The latter is based on HMAC and can be used with either SHA-256
1364  * or SHA-384.
1365  *
1366  * This key derivation algorithm uses the following inputs, which must be
1367  * passed in the order given here:
1368  * - #PSA_KEY_DERIVATION_INPUT_SEED is the seed.
1369  * - #PSA_KEY_DERIVATION_INPUT_SECRET is the secret key.
1370  * - #PSA_KEY_DERIVATION_INPUT_LABEL is the label.
1371  *
1372  * For the application to TLS-1.2, the seed (which is
1373  * forwarded to the TLS-1.2 PRF) is the concatenation of the
1374  * ClientHello.Random + ServerHello.Random,
1375  * and the label is "master secret" or "extended master secret".
1376  *
1377  * For example, `PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA256)` represents the
1378  * TLS-1.2 PSK to MasterSecret derivation PRF using HMAC-SHA-256.
1379  *
1380  * \param hash_alg A hash algorithm (\c PSA_ALG_XXX value such that
1381  * #PSA_ALG_IS_HASH(\p hash_alg) is true).
1382  *
1383  * \return The corresponding TLS-1.2 PSK to MS algorithm.
1384  * \return Unspecified if \p hash_alg is not a supported
1385  * hash algorithm.
1386  */
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 
1390 /** Whether the specified algorithm is a TLS-1.2 PSK to MS algorithm.
1391  *
1392  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1393  *
1394  * \return 1 if \c alg is a TLS-1.2 PSK to MS algorithm, 0 otherwise.
1395  * This macro may return either 0 or 1 if \c alg is not a supported
1396  * key derivation algorithm identifier.
1397  */
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 
1406 /** Macro to build a combined algorithm that chains a key agreement with
1407  * a key derivation.
1408  *
1409  * \param ka_alg A key agreement algorithm (\c PSA_ALG_XXX value such
1410  * that #PSA_ALG_IS_KEY_AGREEMENT(\p ka_alg) is true).
1411  * \param kdf_alg A key derivation algorithm (\c PSA_ALG_XXX value such
1412  * that #PSA_ALG_IS_KEY_DERIVATION(\p kdf_alg) is true).
1413  *
1414  * \return The corresponding key agreement and derivation
1415  * algorithm.
1416  * \return Unspecified if \p ka_alg is not a supported
1417  * key agreement algorithm or \p kdf_alg is not a
1418  * supported key derivation algorithm.
1419  */
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 
1429 /** Whether the specified algorithm is a raw key agreement algorithm.
1430  *
1431  * A raw key agreement algorithm is one that does not specify
1432  * a key derivation function.
1433  * Usually, raw key agreement algorithms are constructed directly with
1434  * a \c PSA_ALG_xxx macro while non-raw key agreement algorithms are
1435  * constructed with PSA_ALG_KEY_AGREEMENT().
1436  *
1437  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1438  *
1439  * \return 1 if \p alg is a raw key agreement algorithm, 0 otherwise.
1440  * This macro may return either 0 or 1 if \p alg is not a supported
1441  * algorithm identifier.
1442  */
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 
1450 /** The finite-field Diffie-Hellman (DH) key agreement algorithm.
1451  *
1452  * The shared secret produced by key agreement is
1453  * `g^{ab}` in big-endian format.
1454  * It is `ceiling(m / 8)` bytes long where `m` is the size of the prime `p`
1455  * in bits.
1456  */
1457 #define PSA_ALG_FFDH ((psa_algorithm_t)0x30100000)
1458 
1459 /** Whether the specified algorithm is a finite field Diffie-Hellman algorithm.
1460  *
1461  * This includes the raw finite field Diffie-Hellman algorithm as well as
1462  * finite-field Diffie-Hellman followed by any supporter key derivation
1463  * algorithm.
1464  *
1465  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1466  *
1467  * \return 1 if \c alg is a finite field Diffie-Hellman algorithm, 0 otherwise.
1468  * This macro may return either 0 or 1 if \c alg is not a supported
1469  * key agreement algorithm identifier.
1470  */
1471 #define PSA_ALG_IS_FFDH(alg) \
1472  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_FFDH)
1473 
1474 /** The elliptic curve Diffie-Hellman (ECDH) key agreement algorithm.
1475  *
1476  * The shared secret produced by key agreement is the x-coordinate of
1477  * the shared secret point. It is always `ceiling(m / 8)` bytes long where
1478  * `m` is the bit size associated with the curve, i.e. the bit size of the
1479  * order of the curve's coordinate field. When `m` is not a multiple of 8,
1480  * the byte containing the most significant bit of the shared secret
1481  * is padded with zero bits. The byte order is either little-endian
1482  * or big-endian depending on the curve type.
1483  *
1484  * - For Montgomery curves (curve types `PSA_ECC_CURVE_CURVEXXX`),
1485  * the shared secret is the x-coordinate of `d_A Q_B = d_B Q_A`
1486  * in little-endian byte order.
1487  * The bit size is 448 for Curve448 and 255 for Curve25519.
1488  * - For Weierstrass curves over prime fields (curve types
1489  * `PSA_ECC_CURVE_SECPXXX` and `PSA_ECC_CURVE_BRAINPOOL_PXXX`),
1490  * the shared secret is the x-coordinate of `d_A Q_B = d_B Q_A`
1491  * in big-endian byte order.
1492  * The bit size is `m = ceiling(log_2(p))` for the field `F_p`.
1493  * - For Weierstrass curves over binary fields (curve types
1494  * `PSA_ECC_CURVE_SECTXXX`),
1495  * the shared secret is the x-coordinate of `d_A Q_B = d_B Q_A`
1496  * in big-endian byte order.
1497  * The bit size is `m` for the field `F_{2^m}`.
1498  */
1499 #define PSA_ALG_ECDH ((psa_algorithm_t)0x30200000)
1500 
1501 /** Whether the specified algorithm is an elliptic curve Diffie-Hellman
1502  * algorithm.
1503  *
1504  * This includes the raw elliptic curve Diffie-Hellman algorithm as well as
1505  * elliptic curve Diffie-Hellman followed by any supporter key derivation
1506  * algorithm.
1507  *
1508  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1509  *
1510  * \return 1 if \c alg is an elliptic curve Diffie-Hellman algorithm,
1511  * 0 otherwise.
1512  * This macro may return either 0 or 1 if \c alg is not a supported
1513  * key agreement algorithm identifier.
1514  */
1515 #define PSA_ALG_IS_ECDH(alg) \
1516  (PSA_ALG_KEY_AGREEMENT_GET_BASE(alg) == PSA_ALG_ECDH)
1517 
1518 /** Whether the specified algorithm encoding is a wildcard.
1519  *
1520  * Wildcard values may only be used to set the usage algorithm field in
1521  * a policy, not to perform an operation.
1522  *
1523  * \param alg An algorithm identifier (value of type #psa_algorithm_t).
1524  *
1525  * \return 1 if \c alg is a wildcard algorithm encoding.
1526  * \return 0 if \c alg is a non-wildcard algorithm encoding (suitable for
1527  * an operation).
1528  * \return This macro may return either 0 or 1 if \c alg is not a supported
1529  * algorithm identifier.
1530  */
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 
1536 /**@}*/
1537 
1538 /** \defgroup key_lifetimes Key lifetimes
1539  * @{
1540  */
1541 
1542 /** A volatile key only exists as long as the handle to it is not closed.
1543  * The key material is guaranteed to be erased on a power reset.
1544  */
1545 #define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t)0x00000000)
1546 
1547 /** The default storage area for persistent keys.
1548  *
1549  * A persistent key remains in storage until it is explicitly destroyed or
1550  * until the corresponding storage area is wiped. This specification does
1551  * not define any mechanism to wipe a storage area, but implementations may
1552  * provide their own mechanism (for example to perform a factory reset,
1553  * to prepare for device refurbishment, or to uninstall an application).
1554  *
1555  * This lifetime value is the default storage area for the calling
1556  * application. Implementations may offer other storage areas designated
1557  * by other lifetime values as implementation-specific extensions.
1558  */
1559 #define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t)0x00000001)
1560 
1561 /** The minimum value for a key identifier chosen by the application.
1562  */
1563 #define PSA_KEY_ID_USER_MIN ((psa_app_key_id_t)0x00000001)
1564 /** The maximum value for a key identifier chosen by the application.
1565  */
1566 #define PSA_KEY_ID_USER_MAX ((psa_app_key_id_t)0x3fffffff)
1567 /** The minimum value for a key identifier chosen by the implementation.
1568  */
1569 #define PSA_KEY_ID_VENDOR_MIN ((psa_app_key_id_t)0x40000000)
1570 /** The maximum value for a key identifier chosen by the implementation.
1571  */
1572 #define PSA_KEY_ID_VENDOR_MAX ((psa_app_key_id_t)0x7fffffff)
1573 
1574 /**@}*/
1575 
1576 /** \defgroup policy Key policies
1577  * @{
1578  */
1579 
1580 /** Whether the key may be exported.
1581  *
1582  * A public key or the public part of a key pair may always be exported
1583  * regardless of the value of this permission flag.
1584  *
1585  * If a key does not have export permission, implementations shall not
1586  * allow the key to be exported in plain form from the cryptoprocessor,
1587  * whether through psa_export_key() or through a proprietary interface.
1588  * The key may however be exportable in a wrapped form, i.e. in a form
1589  * where it is encrypted by another key.
1590  */
1591 #define PSA_KEY_USAGE_EXPORT ((psa_key_usage_t)0x00000001)
1592 
1593 /** Whether the key may be copied.
1594  *
1595  * This flag allows the use of psa_copy_key() to make a copy of the key
1596  * with the same policy or a more restrictive policy.
1597  *
1598  * For lifetimes for which the key is located in a secure element which
1599  * enforce the non-exportability of keys, copying a key outside the secure
1600  * element also requires the usage flag #PSA_KEY_USAGE_EXPORT.
1601  * Copying the key inside the secure element is permitted with just
1602  * #PSA_KEY_USAGE_COPY if the secure element supports it.
1603  * For keys with the lifetime #PSA_KEY_LIFETIME_VOLATILE or
1604  * #PSA_KEY_LIFETIME_PERSISTENT, the usage flag #PSA_KEY_USAGE_COPY
1605  * is sufficient to permit the copy.
1606  */
1607 #define PSA_KEY_USAGE_COPY ((psa_key_usage_t)0x00000002)
1608 
1609 /** Whether the key may be used to encrypt a message.
1610  *
1611  * This flag allows the key to be used for a symmetric encryption operation,
1612  * for an AEAD encryption-and-authentication operation,
1613  * or for an asymmetric encryption operation,
1614  * if otherwise permitted by the key's type and policy.
1615  *
1616  * For a key pair, this concerns the public key.
1617  */
1618 #define PSA_KEY_USAGE_ENCRYPT ((psa_key_usage_t)0x00000100)
1619 
1620 /** Whether the key may be used to decrypt a message.
1621  *
1622  * This flag allows the key to be used for a symmetric decryption operation,
1623  * for an AEAD decryption-and-verification operation,
1624  * or for an asymmetric decryption operation,
1625  * if otherwise permitted by the key's type and policy.
1626  *
1627  * For a key pair, this concerns the private key.
1628  */
1629 #define PSA_KEY_USAGE_DECRYPT ((psa_key_usage_t)0x00000200)
1630 
1631 /** Whether the key may be used to sign a message.
1632  *
1633  * This flag allows the key to be used for a MAC calculation operation
1634  * or for an asymmetric signature operation,
1635  * if otherwise permitted by the key's type and policy.
1636  *
1637  * For a key pair, this concerns the private key.
1638  */
1639 #define PSA_KEY_USAGE_SIGN_HASH ((psa_key_usage_t)0x00000400)
1640 
1641 /** Whether the key may be used to verify a message signature.
1642  *
1643  * This flag allows the key to be used for a MAC verification operation
1644  * or for an asymmetric signature verification operation,
1645  * if otherwise permitted by by the key's type and policy.
1646  *
1647  * For a key pair, this concerns the public key.
1648  */
1649 #define PSA_KEY_USAGE_VERIFY_HASH ((psa_key_usage_t)0x00000800)
1650 
1651 /** Whether the key may be used to derive other keys.
1652  */
1653 #define PSA_KEY_USAGE_DERIVE ((psa_key_usage_t)0x00001000)
1654 
1655 /**@}*/
1656 
1657 /** \defgroup derivation Key derivation
1658  * @{
1659  */
1660 
1661 /** A secret input for key derivation.
1662  *
1663  * This should be a key of type #PSA_KEY_TYPE_DERIVE
1664  * (passed to psa_key_derivation_input_key())
1665  * or the shared secret resulting from a key agreement
1666  * (obtained via psa_key_derivation_key_agreement()).
1667  *
1668  * The secret can also be a direct input (passed to
1669  * key_derivation_input_bytes()). In this case, the derivation operation
1670  * may not be used to derive keys: the operation will only allow
1671  * psa_key_derivation_output_bytes(), not psa_key_derivation_output_key().
1672  */
1673 #define PSA_KEY_DERIVATION_INPUT_SECRET ((psa_key_derivation_step_t)0x0101)
1674 
1675 /** A label for key derivation.
1676  *
1677  * This should be a direct input.
1678  * It can also be a key of type #PSA_KEY_TYPE_RAW_DATA.
1679  */
1680 #define PSA_KEY_DERIVATION_INPUT_LABEL ((psa_key_derivation_step_t)0x0201)
1681 
1682 /** A salt for key derivation.
1683  *
1684  * This should be a direct input.
1685  * It can also be a key of type #PSA_KEY_TYPE_RAW_DATA.
1686  */
1687 #define PSA_KEY_DERIVATION_INPUT_SALT ((psa_key_derivation_step_t)0x0202)
1688 
1689 /** An information string for key derivation.
1690  *
1691  * This should be a direct input.
1692  * It can also be a key of type #PSA_KEY_TYPE_RAW_DATA.
1693  */
1694 #define PSA_KEY_DERIVATION_INPUT_INFO ((psa_key_derivation_step_t)0x0203)
1695 
1696 /** A seed for key derivation.
1697  *
1698  * This should be a direct input.
1699  * It can also be a key of type #PSA_KEY_TYPE_RAW_DATA.
1700  */
1701 #define PSA_KEY_DERIVATION_INPUT_SEED ((psa_key_derivation_step_t)0x0204)
1702 
1703 /**@}*/
1704 
1705 #endif /* PSA_CRYPTO_VALUES_H */
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.