blob: b01f948face3a4e00d1450da04e503b081cd5407 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman7ff79652023-11-03 12:04:52 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010010
11#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030012
John Durkop07cc04a2020-11-16 22:08:34 -080013#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
14#include "check_crypto_config.h"
15#endif
16
Gilles Peskinee59236f2018-01-27 23:32:46 +010017#include "psa/crypto.h"
18
Ronald Crond6d28882020-12-14 14:56:02 +010019#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010020#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010021#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020022#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010023#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010024#include "psa_crypto_hash.h"
Steven Cooreman32d56942021-03-19 17:39:17 +010025#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010027#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020028#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020029#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020030#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010031#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010032/* Include internal declarations that are useful for implementing persistently
33 * stored keys. */
34#include "psa_crypto_storage.h"
35
Gilles Peskineb2b64d32020-12-14 16:43:58 +010036#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010037
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010038#include <stdlib.h>
39#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010041
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010042#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010043#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020044#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000045#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020046#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010047#include "mbedtls/blowfish.h"
48#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020049#include "mbedtls/chacha20.h"
50#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010051#include "mbedtls/cipher.h"
52#include "mbedtls/ccm.h"
53#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010054#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020055#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010056#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010057#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010058#include "mbedtls/error.h"
59#include "mbedtls/gcm.h"
60#include "mbedtls/md2.h"
61#include "mbedtls/md4.h"
62#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010063#include "mbedtls/md.h"
64#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010065#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010067#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000068#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010070#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/sha1.h"
72#include "mbedtls/sha256.h"
73#include "mbedtls/sha512.h"
74#include "mbedtls/xtea.h"
75
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010076#define ARRAY_LENGTH(array) (sizeof(array) / sizeof(*(array)))
Gilles Peskine996deb12018-08-01 15:45:45 +020077
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078/****************************************************************/
79/* Global data, support functions and library management */
80/****************************************************************/
81
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010082static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020083{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010084 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020085}
86
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010087/* Values for psa_global_data_t::rng_state */
88#define RNG_NOT_INITIALIZED 0
89#define RNG_INITIALIZED 1
90#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010091
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010092typedef struct {
Gilles Peskinec6b69072018-11-20 21:42:52 +010093 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010094 unsigned rng_state : 2;
Gilles Peskineb8006a62021-11-08 22:20:03 +010095 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +010096} psa_global_data_t;
97
98static psa_global_data_t global_data;
99
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100100#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
101mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
102 &global_data.rng.drbg;
103#endif
104
itayzafrir0adf0fc2018-09-06 16:24:41 +0300105#define GUARD_MODULE_INITIALIZED \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100106 if (global_data.initialized == 0) \
107 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300108
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100109psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100110{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100111 /* Mbed TLS error codes can combine a high-level error code and a
112 * low-level error code. The low-level error usually reflects the
113 * root cause better, so dispatch on that preferably. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100114 int low_level_ret = -(-ret & 0x007f);
115 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116 case 0:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100117 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100118
119 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
120 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
121 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100122 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100123 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100124 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100125
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200126 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100127 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200128
Gilles Peskine9a944802018-06-21 09:35:35 +0200129 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
130 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
131 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
132 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
133 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100134 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200135 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100136 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200137 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100138 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskine9a944802018-06-21 09:35:35 +0200139
Jaeden Amero93e21112019-02-20 13:57:28 +0000140#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000141 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000142#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
143 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
144#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100145 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100146 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100147 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100148 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100149
Jaeden Amero93e21112019-02-20 13:57:28 +0000150#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000151 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000152#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
153 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
154#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100155 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100156 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100157 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100158 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100159
160 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100161 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100162 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100163 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100164 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100165 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100166
Gilles Peskine26869f22019-05-06 15:25:00 +0200167 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100168 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine26869f22019-05-06 15:25:00 +0200169
170 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100171 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200172 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100173 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200174
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100176 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100178 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100179 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100180 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100181 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100182 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100183 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100184 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100186 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100187 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100188 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100189 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100190 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100191
192 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100193 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100194
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100195#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
196 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100197 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
198 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100200 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
202 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100203 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100204 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100205 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100206#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100207
208 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100209 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100210 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100211 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100212
Gilles Peskinee59236f2018-01-27 23:32:46 +0100213 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
214 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
215 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100216 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100217
218 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100219 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100221 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100223 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100224
Gilles Peskine82e57d12020-11-13 21:31:17 +0100225#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100226 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100227 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
228 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100229 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100230 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100231 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
232 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100233 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100234 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100235 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100236#endif
237
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200238 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
239 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100241 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200242
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100244 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100245 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100246 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100247 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100248 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100249 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100250 return PSA_ERROR_STORAGE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200251 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100252 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100255 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100257 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100259 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100261 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100265 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100267 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100269 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100272 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100275 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100277 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100280 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100282 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100285 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100287 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100291 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100293 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100295 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100298 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100300 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200301
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200302 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100303 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100308 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100309 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100310 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100311 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100312 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100313 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
314 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100315 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100317 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100319 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100321 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100323 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100325 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100326
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200327 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
328 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100330 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200331
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100333 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100335 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336
itayzafrir5c753392018-05-08 11:18:38 +0300337 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300338 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100339 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300340 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100341 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300342 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100343 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300344 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
345 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100346 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300347 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100348 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100349 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100350 return PSA_ERROR_INSUFFICIENT_ENTROPY;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300351 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100352 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskine40d81602020-11-25 00:09:47 +0100353
Janos Follatha13b9052019-11-22 12:48:59 +0000354 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100355 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300356
Gilles Peskinee59236f2018-01-27 23:32:46 +0100357 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100358 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100359 }
360}
361
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200362
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200363
364
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100365/****************************************************************/
366/* Key management */
367/****************************************************************/
368
John Durkop9814fa22020-11-04 12:28:15 -0800369#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800370 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cron9ecdd972021-11-19 18:02:34 +0100371 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
372 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
373 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100374mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
375 size_t bits,
376 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200377{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100378 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100379 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100380 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100381#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 192:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100383 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
385#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100386 case 224:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100387 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100388#endif
389#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100390 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100391 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100392#endif
393#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 384:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100395 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#endif
397#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 521:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100399 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 528:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100401 if (bits_is_sloppy) {
402 return MBEDTLS_ECP_DP_SECP521R1;
403 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100404 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100405#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 }
407 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100408
Paul Elliott8ff510a2020-06-02 17:19:28 +0100409 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100410 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100413 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 384:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100417 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 512:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100421 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 }
424 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100425
Paul Elliott8ff510a2020-06-02 17:19:28 +0100426 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100427 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100428#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100429 case 255:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100430 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100432 if (bits_is_sloppy) {
433 return MBEDTLS_ECP_DP_CURVE25519;
434 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100435 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
437#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100438 case 448:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100439 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100440#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 }
442 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100443
Paul Elliott8ff510a2020-06-02 17:19:28 +0100444 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100445 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100446#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100447 case 192:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100448 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100449#endif
450#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100451 case 224:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100452 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100453#endif
454#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100455 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100456 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100457#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100458 }
459 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200460 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100461
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100462 (void) bits_is_sloppy;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100463 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200464}
John Durkop9814fa22020-11-04 12:28:15 -0800465#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cron9ecdd972021-11-19 18:02:34 +0100466 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
467 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
468 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
469 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200470
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100471static psa_status_t validate_unstructured_key_bit_size(psa_key_type_t type,
472 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473{
474 /* Check that the bit size is acceptable for the key type */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100475 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200476 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200477 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200478 case PSA_KEY_TYPE_DERIVE:
479 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100480#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200481 case PSA_KEY_TYPE_AES:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100482 if (bits != 128 && bits != 192 && bits != 256) {
483 return PSA_ERROR_INVALID_ARGUMENT;
484 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200485 break;
486#endif
Gilles Peskine8890f642021-09-21 11:59:39 +0200487#if defined(PSA_WANT_KEY_TYPE_ARIA)
488 case PSA_KEY_TYPE_ARIA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100489 if (bits != 128 && bits != 192 && bits != 256) {
490 return PSA_ERROR_INVALID_ARGUMENT;
491 }
Gilles Peskine8890f642021-09-21 11:59:39 +0200492 break;
493#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100494#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200495 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100496 if (bits != 128 && bits != 192 && bits != 256) {
497 return PSA_ERROR_INVALID_ARGUMENT;
498 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200499 break;
500#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100501#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200502 case PSA_KEY_TYPE_DES:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100503 if (bits != 64 && bits != 128 && bits != 192) {
504 return PSA_ERROR_INVALID_ARGUMENT;
505 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200506 break;
507#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100508#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200509 case PSA_KEY_TYPE_ARC4:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100510 if (bits < 8 || bits > 2048) {
511 return PSA_ERROR_INVALID_ARGUMENT;
512 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200513 break;
514#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100515#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200516 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100517 if (bits != 256) {
518 return PSA_ERROR_INVALID_ARGUMENT;
519 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200520 break;
521#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200522 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100523 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200524 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100525 if (bits % 8 != 0) {
526 return PSA_ERROR_INVALID_ARGUMENT;
527 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200528
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100529 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200530}
531
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100532/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100533 *
Steven Cooremancd640932021-03-08 12:00:27 +0100534 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
535 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100536 *
537 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100538 * \param[in] key_type The key type of the key to be used with the
539 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100540 *
541 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100542 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100543 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100544 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100545 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100546MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100547 psa_algorithm_t algorithm,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100548 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100549{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100550 if (PSA_ALG_IS_HMAC(algorithm)) {
551 if (key_type == PSA_KEY_TYPE_HMAC) {
552 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100553 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100554 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100555
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100556 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
557 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
558 * key. */
559 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
560 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
561 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
562 * the block length (larger than 1) for block ciphers. */
563 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
564 return PSA_SUCCESS;
565 }
566 }
567 }
568
569 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100570}
571
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100572psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
573 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200574{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100575 if (slot->key.data != NULL) {
576 return PSA_ERROR_ALREADY_EXISTS;
577 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200578
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100579 slot->key.data = mbedtls_calloc(1, buffer_length);
580 if (slot->key.data == NULL) {
581 return PSA_ERROR_INSUFFICIENT_MEMORY;
582 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200583
Ronald Cronea0f8a62020-11-25 17:52:23 +0100584 slot->key.bytes = buffer_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100585 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200586}
587
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100588psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
589 const uint8_t *data,
590 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200591{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100592 psa_status_t status = psa_allocate_buffer_to_slot(slot,
593 data_length);
594 if (status != PSA_SUCCESS) {
595 return status;
596 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200597
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100598 memcpy(slot->key.data, data, data_length);
599 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200600}
601
Ronald Crona0fe59f2020-11-29 11:14:53 +0100602psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100603 const psa_key_attributes_t *attributes,
604 const uint8_t *data, size_t data_length,
605 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100606 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100607{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100608 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
609 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100610
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200611 /* zero-length keys are never supported. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100612 if (data_length == 0) {
613 return PSA_ERROR_NOT_SUPPORTED;
614 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200615
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100616 if (key_type_is_raw_bytes(type)) {
617 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200618
Steven Cooreman75b74362020-07-28 14:30:13 +0200619 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100620 if (data_length > SIZE_MAX / 8) {
621 return PSA_ERROR_NOT_SUPPORTED;
622 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200623
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200624 /* Enforce a size limit, and in particular ensure that the bit
625 * size fits in its representation type. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100626 if ((*bits) > PSA_MAX_KEY_BITS) {
627 return PSA_ERROR_NOT_SUPPORTED;
628 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200629
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100630 status = validate_unstructured_key_bit_size(type, *bits);
631 if (status != PSA_SUCCESS) {
632 return status;
633 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200634
Ronald Crondd04d422020-11-28 15:14:42 +0100635 /* Copy the key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100636 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100637 *key_buffer_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100638 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200639
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100640 return PSA_SUCCESS;
641 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
John Durkop9814fa22020-11-04 12:28:15 -0800642#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100643 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
644 if (PSA_KEY_TYPE_IS_ECC(type)) {
645 return mbedtls_psa_ecp_import_key(attributes,
646 data, data_length,
647 key_buffer, key_buffer_size,
648 key_buffer_length,
649 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100650 }
John Durkop9814fa22020-11-04 12:28:15 -0800651#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
652 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700653#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100654 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
655 if (PSA_KEY_TYPE_IS_RSA(type)) {
656 return mbedtls_psa_rsa_import_key(attributes,
657 data, data_length,
658 key_buffer, key_buffer_size,
659 key_buffer_length,
660 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200661 }
John Durkop9814fa22020-11-04 12:28:15 -0800662#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
663 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100664 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100665
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100666 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100667}
668
Gilles Peskinef603c712019-01-19 13:40:11 +0100669/** Calculate the intersection of two algorithm usage policies.
670 *
671 * Return 0 (which allows no operation) on incompatibility.
672 */
673static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100674 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100675 psa_algorithm_t alg1,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100676 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100677{
Gilles Peskine549ea862019-05-22 11:45:59 +0200678 /* Common case: both sides actually specify the same policy. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100679 if (alg1 == alg2) {
680 return alg1;
681 }
Steven Cooreman03488022021-02-18 12:07:20 +0100682 /* If the policies are from the same hash-and-sign family, check
683 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100684 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
685 PSA_ALG_IS_SIGN_HASH(alg2) &&
686 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
687 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
688 return alg2;
689 }
690 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
691 return alg1;
692 }
Steven Cooreman03488022021-02-18 12:07:20 +0100693 }
694 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100695 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100696 * restrictive tag length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100697 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
698 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
699 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
700 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
701 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100702 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100703
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100704 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100705 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
706 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
707 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
708 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100709 }
710 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100711 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
712 (alg1_len <= alg2_len)) {
713 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100714 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100715 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
716 (alg2_len <= alg1_len)) {
717 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100718 }
719 }
720 /* If the policies are from the same MAC family, check whether one
721 * of them is a minimum-MAC-length policy. Calculate the most
722 * restrictive tag length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100723 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
724 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
725 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100726 /* Validate the combination of key type and algorithm. Since the base
727 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100728 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
729 return 0;
730 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100731
Steven Cooreman31a876d2021-03-03 20:47:40 +0100732 /* Get the (exact or at-least) output lengths for both sides of the
733 * requested intersection. None of the currently supported algorithms
734 * have an output length dependent on the actual key size, so setting it
735 * to a bogus value of 0 is currently OK.
736 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100737 * Note that for at-least-this-length wildcard algorithms, the output
738 * length is set to the shortest allowed length, which allows us to
739 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100740 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
741 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100742 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100743
Steven Cooremana1d83222021-02-25 10:20:29 +0100744 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100745 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
746 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
747 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100748 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100749
750 /* If only one is an at-least-this-length policy, the intersection would
751 * be the other (fixed-length) policy as long as said fixed length is
752 * equal to or larger than the shortest allowed length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100753 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
754 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100756 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
757 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100758 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100759
Steven Cooremancd640932021-03-08 12:00:27 +0100760 /* If none of them are wildcards, check whether they define the same tag
761 * length. This is still possible here when one is default-length and
762 * the other specific-length. Ensure to always return the
763 * specific-length version for the intersection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100764 if (alg1_len == alg2_len) {
765 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
766 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100767 }
768 /* If the policies are incompatible, allow nothing. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100769 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100770}
771
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100772static int psa_key_algorithm_permits(psa_key_type_t key_type,
773 psa_algorithm_t policy_alg,
774 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200775{
Gilles Peskine549ea862019-05-22 11:45:59 +0200776 /* Common case: the policy only allows requested_alg. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100777 if (requested_alg == policy_alg) {
778 return 1;
779 }
Steven Cooreman03488022021-02-18 12:07:20 +0100780 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
781 * and requested_alg is the same hash-and-sign family with any hash,
782 * then requested_alg is compliant with policy_alg. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100783 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
784 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
785 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
786 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100787 }
788 /* If policy_alg is a wildcard AEAD algorithm of the same base as
789 * the requested algorithm, check the requested tag length to be
790 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100791 if (PSA_ALG_IS_AEAD(policy_alg) &&
792 PSA_ALG_IS_AEAD(requested_alg) &&
793 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
794 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
795 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
796 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
797 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100798 }
Steven Cooremancd640932021-03-08 12:00:27 +0100799 /* If policy_alg is a MAC algorithm of the same base as the requested
800 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100801 if (PSA_ALG_IS_MAC(policy_alg) &&
802 PSA_ALG_IS_MAC(requested_alg) &&
803 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
804 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100805 /* Validate the combination of key type and algorithm. Since the policy
806 * and requested algorithms are the same, we only need this once. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100807 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
808 return 0;
809 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100810
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811 /* Get both the requested output length for the algorithm which is to be
812 * verified, and the default output length for the base algorithm.
813 * Note that none of the currently supported algorithms have an output
814 * length dependent on actual key size, so setting it to a bogus value
815 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100816 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100817 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100818 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100819 key_type, 0,
820 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100821
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100822 /* If the policy is default-length, only allow an algorithm with
823 * a declared exact-length matching the default. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100824 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
825 return requested_output_length == default_output_length;
826 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100827
828 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100829 * length exactly matches the default length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100830 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
831 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
832 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100833 }
834
Steven Cooremancd640932021-03-08 12:00:27 +0100835 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
836 * check for the requested MAC length to be equal to or longer than the
837 * minimum allowed length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100838 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
839 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
840 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100841 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200842 }
Steven Cooremance48e852020-10-05 16:02:45 +0200843 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200844 * a key derivation with that key agreement should also be allowed. This
845 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100846 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
847 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
848 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
849 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200850 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100851 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100852 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200853}
854
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100855/** Test whether a policy permits an algorithm.
856 *
857 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100858 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100859 * \note This function requires providing the key type for which the policy is
860 * being validated, since some algorithm policy definitions (e.g. MAC)
861 * have different properties depending on what kind of cipher it is
862 * combined with.
863 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100864 * \retval PSA_SUCCESS When \p alg is a specific algorithm
865 * allowed by the \p policy.
866 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
867 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
868 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100869 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100870static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
871 psa_key_type_t key_type,
872 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100873{
Steven Cooremand788fab2021-02-25 11:29:17 +0100874 /* '0' is not a valid algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100875 if (alg == 0) {
876 return PSA_ERROR_INVALID_ARGUMENT;
877 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100878
Steven Cooreman7e39f052021-02-23 14:18:32 +0100879 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100880 if (PSA_ALG_IS_WILDCARD(alg)) {
881 return PSA_ERROR_INVALID_ARGUMENT;
882 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100883
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100884 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
885 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
886 return PSA_SUCCESS;
887 } else {
888 return PSA_ERROR_NOT_PERMITTED;
889 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100890}
891
Gilles Peskinef603c712019-01-19 13:40:11 +0100892/** Restrict a key policy based on a constraint.
893 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100894 * \note This function requires providing the key type for which the policy is
895 * being restricted, since some algorithm policy definitions (e.g. MAC)
896 * have different properties depending on what kind of cipher it is
897 * combined with.
898 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100899 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100900 * \param[in,out] policy The policy to restrict.
901 * \param[in] constraint The policy constraint to apply.
902 *
903 * \retval #PSA_SUCCESS
904 * \c *policy contains the intersection of the original value of
905 * \c *policy and \c *constraint.
906 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100907 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100908 * \c *policy is unchanged.
909 */
910static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100911 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100912 psa_key_policy_t *policy,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100913 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100914{
915 psa_algorithm_t intersection_alg =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100916 psa_key_policy_algorithm_intersection(key_type, policy->alg,
917 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200918 psa_algorithm_t intersection_alg2 =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100919 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
920 constraint->alg2);
921 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
922 return PSA_ERROR_INVALID_ARGUMENT;
923 }
924 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
925 return PSA_ERROR_INVALID_ARGUMENT;
926 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100927 policy->usage &= constraint->usage;
928 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200929 policy->alg2 = intersection_alg2;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100930 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100931}
932
Ronald Cron5c522922020-11-14 16:35:34 +0100933/** Get the description of a key given its identifier and policy constraints
934 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200935 *
Ronald Cron5c522922020-11-14 16:35:34 +0100936 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100937 * nonzero, the key must allow operations with this algorithm. If \p alg is
938 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100939 *
Ronald Cron5c522922020-11-14 16:35:34 +0100940 * In case of a persistent key, the function loads the description of the key
941 * into a key slot if not already done.
942 *
943 * On success, the returned key slot is locked. It is the responsibility of
944 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200945 */
Ronald Cron5c522922020-11-14 16:35:34 +0100946static psa_status_t psa_get_and_lock_key_slot_with_policy(
947 mbedtls_svc_key_id_t key,
948 psa_key_slot_t **p_slot,
949 psa_key_usage_t usage,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100950 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100951{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
953 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100954
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100955 status = psa_get_and_lock_key_slot(key, p_slot);
956 if (status != PSA_SUCCESS) {
957 return status;
958 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100960
961 /* Enforce that usage policy for the key slot contains all the flags
962 * required by the usage parameter. There is one exception: public
963 * keys can always be exported, so we treat public key objects as
964 * if they had the export flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100965 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100966 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100967 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200968
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100969 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100970 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100972 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100973
Shaun Case0e7791f2021-12-20 21:14:10 -0800974 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100975 if (alg != 0) {
976 status = psa_key_policy_permits(&slot->attr.policy,
977 slot->attr.type,
978 alg);
979 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100980 goto error;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100981 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100982 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100983
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100984 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200985
986error:
987 *p_slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100988 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200989
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100990 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100991}
Darryl Green940d72c2018-07-13 13:18:51 +0100992
Ronald Cron5c522922020-11-14 16:35:34 +0100993/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200994 *
995 * A transparent key is a key for which the key material is directly
Ronald Cron8a0466a2021-08-24 15:39:44 +0200996 * available, as opposed to a key in a secure element and/or to be used
997 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200998 *
Ronald Cron8a0466a2021-08-24 15:39:44 +0200999 * This is a temporary function that may be used instead of
1000 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1001 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001002 *
Ronald Cron5c522922020-11-14 16:35:34 +01001003 * On success, the returned key slot is locked. It is the responsibility of the
1004 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001005 */
Ronald Cron5c522922020-11-14 16:35:34 +01001006static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1007 mbedtls_svc_key_id_t key,
1008 psa_key_slot_t **p_slot,
1009 psa_key_usage_t usage,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001010 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001011{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001012 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1013 usage, alg);
1014 if (status != PSA_SUCCESS) {
1015 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001016 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001017
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001018 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1019 psa_unlock_key_slot(*p_slot);
1020 *p_slot = NULL;
1021 return PSA_ERROR_NOT_SUPPORTED;
1022 }
1023
1024 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001025}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001026
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001027psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001028{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001029 /* Data pointer will always be either a valid pointer or NULL in an
1030 * initialized slot, so we can just free it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001031 if (slot->key.data != NULL) {
1032 mbedtls_platform_zeroize(slot->key.data, slot->key.bytes);
1033 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001034
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001035 mbedtls_free(slot->key.data);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001036 slot->key.data = NULL;
1037 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001038
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001039 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001040}
1041
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001042/** Completely wipe a slot in memory, including its policy.
1043 * Persistent storage is not affected. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001044psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001045{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001046 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001047
1048 /*
1049 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001050 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001051 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1052 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001053 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001054 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001055 if (slot->lock_count != 1) {
Ronald Cronddd3d052020-10-30 14:07:07 +01001056#ifdef MBEDTLS_CHECK_PARAMS
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001057 MBEDTLS_PARAM_FAILED(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001058#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001059 status = PSA_ERROR_CORRUPTION_DETECTED;
1060 }
1061
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001062 /* Multipart operations may still be using the key. This is safe
1063 * because all multipart operation objects are independent from
1064 * the key slot: if they need to access the key after the setup
1065 * phase, they have a copy of the key. Note that this means that
1066 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001067 /* At this point, key material and other type-specific content has
1068 * been wiped. Clear remaining metadata. We can call memset and not
1069 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001070 memset(slot, 0, sizeof(*slot));
1071 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001072}
1073
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001074psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001075{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001076 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001077 psa_status_t status; /* status of the last operation */
1078 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001079#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1080 psa_se_drv_table_entry_t *driver;
1081#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001082
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001083 if (mbedtls_svc_key_id_is_null(key)) {
1084 return PSA_SUCCESS;
1085 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001086
Ronald Cronf2911112020-10-29 17:51:10 +01001087 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001088 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001089 * key, this will load the key description from persistent memory if not
1090 * done yet. We cannot avoid this loading as without it we don't know if
1091 * the key is operated by an SE or not and this information is needed by
1092 * the current implementation.
1093 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001094 status = psa_get_and_lock_key_slot(key, &slot);
1095 if (status != PSA_SUCCESS) {
1096 return status;
1097 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001098
Ronald Cronf2911112020-10-29 17:51:10 +01001099 /*
1100 * If the key slot containing the key description is under access by the
1101 * library (apart from the present access), the key cannot be destroyed
1102 * yet. For the time being, just return in error. Eventually (to be
1103 * implemented), the key should be destroyed when all accesses have
1104 * stopped.
1105 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001106 if (slot->lock_count > 1) {
1107 psa_unlock_key_slot(slot);
1108 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001109 }
1110
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001111 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine251c7742021-04-21 22:32:05 +02001112 /* Refuse the destruction of a read-only key (which may or may not work
1113 * if we attempt it, depending on whether the key is merely read-only
1114 * by policy or actually physically read-only).
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001115 * Just do the best we can, which is to wipe the copy in memory
1116 * (done in this function's cleanup code). */
1117 overall_status = PSA_ERROR_NOT_PERMITTED;
1118 goto exit;
Gilles Peskine251c7742021-04-21 22:32:05 +02001119 }
1120
Gilles Peskine354f7672019-07-12 23:46:38 +02001121#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001122 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1123 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001124 /* For a key in a secure element, we need to do three things:
1125 * remove the key file in internal storage, destroy the
1126 * key inside the secure element, and update the driver's
1127 * persistent data. Start a transaction that will encompass these
1128 * three actions. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001129 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001130 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001131 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001132 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001133 status = psa_crypto_save_transaction();
1134 if (status != PSA_SUCCESS) {
1135 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136 /* We should still try to destroy the key in the secure
1137 * element and the key metadata in storage. This is especially
1138 * important if the error is that the storage is full.
1139 * But how to do it exactly without risking an inconsistent
1140 * state after a reset?
1141 * https://github.com/ARMmbed/mbed-crypto/issues/215
1142 */
1143 overall_status = status;
1144 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001145 }
1146
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001147 status = psa_destroy_se_key(driver,
1148 psa_key_slot_get_slot_number(slot));
1149 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001150 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001151 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001152 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001153#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1154
Darryl Greend49a4992018-06-18 17:27:26 +01001155#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001156 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1157 status = psa_destroy_persistent_key(slot->attr.id);
1158 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001159 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001160 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001161
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001162 /* TODO: other slots may have a copy of the same key. We should
1163 * invalidate them.
1164 * https://github.com/ARMmbed/mbed-crypto/issues/214
1165 */
Darryl Greend49a4992018-06-18 17:27:26 +01001166 }
1167#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001168
Gilles Peskinefc762652019-07-22 19:30:34 +02001169#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001170 if (driver != NULL) {
1171 status = psa_save_se_persistent_data(driver);
1172 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001173 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001174 }
1175 status = psa_crypto_stop_transaction();
1176 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001177 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001178 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001179 }
1180#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1181
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001182exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001183 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001184 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001185 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001186 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001187 }
1188 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001189}
1190
John Durkop07cc04a2020-11-16 22:08:34 -08001191#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001192 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001193static psa_status_t psa_get_rsa_public_exponent(
1194 const mbedtls_rsa_context *rsa,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001195 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001196{
1197 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001199 uint8_t *buffer = NULL;
1200 size_t buflen;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001201 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001202
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001203 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1204 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001205 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001206 }
1207 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001208 /* It's the default value, which is reported as an empty string,
1209 * so there's nothing to do. */
1210 goto exit;
1211 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001212
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001213 buflen = mbedtls_mpi_size(&mpi);
1214 buffer = mbedtls_calloc(1, buflen);
1215 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001216 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1217 goto exit;
1218 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001219 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1220 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001221 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001222 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 attributes->domain_parameters = buffer;
1224 attributes->domain_parameters_size = buflen;
1225
1226exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001227 mbedtls_mpi_free(&mpi);
1228 if (ret != 0) {
1229 mbedtls_free(buffer);
1230 }
1231 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001232}
John Durkop07cc04a2020-11-16 22:08:34 -08001233#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001234 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001235
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001236/** Retrieve all the publicly-accessible attributes of a key.
1237 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001238psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1239 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001240{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001242 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001243 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001244
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001245 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001246
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001247 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1248 if (status != PSA_SUCCESS) {
1249 return status;
1250 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001251
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001252 attributes->core = slot->attr;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001253 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1254 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001255
1256#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001257 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1258 psa_set_key_slot_number(attributes,
1259 psa_key_slot_get_slot_number(slot));
1260 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001262
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001263 switch (slot->attr.type) {
John Durkop07cc04a2020-11-16 22:08:34 -08001264#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001265 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001266 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001267 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001268 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001269 * is not yet implemented.
1270 * https://github.com/ARMmbed/mbed-crypto/issues/216
1271 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001272 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001273 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001274
Ronald Cron90857082020-11-25 14:58:33 +01001275 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001276 slot->attr.type,
1277 slot->key.data,
1278 slot->key.bytes,
1279 &rsa);
1280 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001281 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001282 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001283
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001284 status = psa_get_rsa_public_exponent(rsa,
1285 attributes);
1286 mbedtls_rsa_free(rsa);
1287 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001288 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001289 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001290#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001291 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001292 default:
1293 /* Nothing else to do. */
1294 break;
1295 }
1296
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001297 if (status != PSA_SUCCESS) {
1298 psa_reset_key_attributes(attributes);
1299 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001300
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001301 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001302
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001303 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001304}
1305
Gilles Peskinec8000c02019-08-02 20:15:51 +02001306#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1307psa_status_t psa_get_key_slot_number(
1308 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001309 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001310{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001311 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001312 *slot_number = attributes->slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001313 return PSA_SUCCESS;
1314 } else {
1315 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001316 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001317}
1318#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1319
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001320static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1321 size_t key_buffer_size,
1322 uint8_t *data,
1323 size_t data_size,
1324 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001325{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001326 if (key_buffer_size > data_size) {
1327 return PSA_ERROR_BUFFER_TOO_SMALL;
1328 }
1329 memcpy(data, key_buffer, key_buffer_size);
1330 memset(data + key_buffer_size, 0,
1331 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001332 *data_length = key_buffer_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001333 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001334}
1335
Ronald Cron7285cda2020-11-26 14:46:37 +01001336psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001337 const psa_key_attributes_t *attributes,
1338 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001339 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001340{
Ronald Crond18b5f82020-11-25 16:46:05 +01001341 psa_key_type_t type = attributes->core.type;
1342
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001343 if (key_type_is_raw_bytes(type) ||
1344 PSA_KEY_TYPE_IS_RSA(type) ||
1345 PSA_KEY_TYPE_IS_ECC(type)) {
1346 return psa_export_key_buffer_internal(
1347 key_buffer, key_buffer_size,
1348 data, data_size, data_length);
1349 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001350 /* This shouldn't happen in the reference implementation, but
1351 it is valid for a special-purpose implementation to omit
1352 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001353 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354 }
1355}
1356
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001357psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1358 uint8_t *data,
1359 size_t data_size,
1360 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001361{
1362 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1363 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1364 psa_key_slot_t *slot;
1365
Ronald Crone907e552021-01-18 13:22:38 +01001366 /* Reject a zero-length output buffer now, since this can never be a
1367 * valid key representation. This way we know that data must be a valid
1368 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001369 if (data_size == 0) {
1370 return PSA_ERROR_BUFFER_TOO_SMALL;
1371 }
Ronald Crone907e552021-01-18 13:22:38 +01001372
Ronald Cron9486f9d2020-11-26 13:36:23 +01001373 /* Set the key to empty now, so that even when there are errors, we always
1374 * set data_length to a value between 0 and data_size. On error, setting
1375 * the key to empty is a good choice because an empty key representation is
1376 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001377 *data_length = 0;
1378
Ronald Cron9486f9d2020-11-26 13:36:23 +01001379 /* Export requires the EXPORT flag. There is an exception for public keys,
1380 * which don't require any flag, but
1381 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1382 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001383 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1384 PSA_KEY_USAGE_EXPORT, 0);
1385 if (status != PSA_SUCCESS) {
1386 return status;
1387 }
mohammad160306e79202018-03-28 13:17:44 +03001388
Ronald Crond18b5f82020-11-25 16:46:05 +01001389 psa_key_attributes_t attributes = {
1390 .core = slot->attr
1391 };
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001392 status = psa_driver_wrapper_export_key(&attributes,
1393 slot->key.data, slot->key.bytes,
1394 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001396 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001397
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001398 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399}
1400
Ronald Cron7285cda2020-11-26 14:46:37 +01001401psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001402 const psa_key_attributes_t *attributes,
1403 const uint8_t *key_buffer,
1404 size_t key_buffer_size,
1405 uint8_t *data,
1406 size_t data_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001407 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001408{
Ronald Crond18b5f82020-11-25 16:46:05 +01001409 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001410
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001411 if (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type)) {
1412 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type)) {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001413 /* Exporting public -> public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001414 return psa_export_key_buffer_internal(
1415 key_buffer, key_buffer_size,
1416 data, data_size, data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001417 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001418
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001419 if (PSA_KEY_TYPE_IS_RSA(type)) {
John Durkop0e005192020-10-31 22:06:54 -07001420#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001421 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1422 return mbedtls_psa_rsa_export_public_key(attributes,
1423 key_buffer,
1424 key_buffer_size,
1425 data,
1426 data_size,
1427 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001428#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001429 /* We don't know how to convert a private RSA key to public. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001430 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001431#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1432 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001433 } else {
John Durkop6ba40d12020-11-10 08:50:04 -08001434#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001435 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1436 return mbedtls_psa_ecp_export_public_key(attributes,
1437 key_buffer,
1438 key_buffer_size,
1439 data,
1440 data_size,
1441 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001442#else
1443 /* We don't know how to convert a private ECC key to public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001444 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001445#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1446 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001447 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001448 } else {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001449 /* This shouldn't happen in the reference implementation, but
1450 it is valid for a special-purpose implementation to omit
1451 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001452 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001453 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001454}
Ronald Crond18b5f82020-11-25 16:46:05 +01001455
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001456psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1457 uint8_t *data,
1458 size_t data_size,
1459 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001460{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001461 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001462 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001463 psa_key_attributes_t attributes;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001464 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001465
Ronald Crone907e552021-01-18 13:22:38 +01001466 /* Reject a zero-length output buffer now, since this can never be a
1467 * valid key representation. This way we know that data must be a valid
1468 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001469 if (data_size == 0) {
1470 return PSA_ERROR_BUFFER_TOO_SMALL;
1471 }
Ronald Crone907e552021-01-18 13:22:38 +01001472
Darryl Greendd8fb772018-11-07 16:00:44 +00001473 /* Set the key to empty now, so that even when there are errors, we always
1474 * set data_length to a value between 0 and data_size. On error, setting
1475 * the key to empty is a good choice because an empty key representation is
1476 * unlikely to be accepted anywhere. */
1477 *data_length = 0;
1478
1479 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001480 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1481 if (status != PSA_SUCCESS) {
1482 return status;
1483 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001484
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001485 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1486 status = PSA_ERROR_INVALID_ARGUMENT;
1487 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001488 }
1489
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001490 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001491 .core = slot->attr
1492 };
Ronald Cron67227982020-11-26 15:16:05 +01001493 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001494 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001495 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001496
1497exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001498 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001499
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001500 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001501}
1502
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001503MBEDTLS_STATIC_ASSERT((MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1504 "One or more key attribute flag is listed as both external-only and dual-use")
1505MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1506 "One or more key attribute flag is listed as both internal-only and dual-use")
1507MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1508 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001509
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001510/** Validate that a key policy is internally well-formed.
1511 *
1512 * This function only rejects invalid policies. It does not validate the
1513 * consistency of the policy with respect to other attributes of the key
1514 * such as the key type.
1515 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001516static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001517{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001518 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1519 PSA_KEY_USAGE_COPY |
1520 PSA_KEY_USAGE_ENCRYPT |
1521 PSA_KEY_USAGE_DECRYPT |
1522 PSA_KEY_USAGE_SIGN_MESSAGE |
1523 PSA_KEY_USAGE_VERIFY_MESSAGE |
1524 PSA_KEY_USAGE_SIGN_HASH |
1525 PSA_KEY_USAGE_VERIFY_HASH |
1526 PSA_KEY_USAGE_DERIVE)) != 0) {
1527 return PSA_ERROR_INVALID_ARGUMENT;
1528 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001529
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001530 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001531}
1532
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001533/** Validate the internal consistency of key attributes.
1534 *
1535 * This function only rejects invalid attribute values. If does not
1536 * validate the consistency of the attributes with any key data that may
1537 * be involved in the creation of the key.
1538 *
1539 * Call this function early in the key creation process.
1540 *
1541 * \param[in] attributes Key attributes for the new key.
1542 * \param[out] p_drv On any return, the driver for the key, if any.
1543 * NULL for a transparent key.
1544 *
1545 */
1546static psa_status_t psa_validate_key_attributes(
1547 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001548 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001549{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001550 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001551 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1552 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001553
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001554 status = psa_validate_key_location(lifetime, p_drv);
1555 if (status != PSA_SUCCESS) {
1556 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001557 }
1558
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001559 status = psa_validate_key_persistence(lifetime);
1560 if (status != PSA_SUCCESS) {
1561 return status;
1562 }
1563
1564 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1565 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1566 return PSA_ERROR_INVALID_ARGUMENT;
1567 }
1568 } else {
1569 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1570 return PSA_ERROR_INVALID_ARGUMENT;
1571 }
1572 }
1573
1574 status = psa_validate_key_policy(&attributes->core.policy);
1575 if (status != PSA_SUCCESS) {
1576 return status;
1577 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001578
1579 /* Refuse to create overly large keys.
1580 * Note that this doesn't trigger on import if the attributes don't
1581 * explicitly specify a size (so psa_get_key_bits returns 0), so
1582 * psa_import_key() needs its own checks. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001583 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1584 return PSA_ERROR_NOT_SUPPORTED;
1585 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001586
Gilles Peskine91e8c332019-08-02 19:19:39 +02001587 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001588 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1589 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1590 return PSA_ERROR_INVALID_ARGUMENT;
1591 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001592
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001593 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001594}
1595
Gilles Peskine4747d192019-04-17 15:05:45 +02001596/** Prepare a key slot to receive key material.
1597 *
1598 * This function allocates a key slot and sets its metadata.
1599 *
1600 * If this function fails, call psa_fail_key_creation().
1601 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001602 * This function is intended to be used as follows:
1603 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001604 * it with the specified attributes, and in case of a volatile key assign it
1605 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001606 * -# Populate the slot with the key material.
1607 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1608 * In case of failure at any step, stop the sequence and call
1609 * psa_fail_key_creation().
1610 *
Ronald Cron5c522922020-11-14 16:35:34 +01001611 * On success, the key slot is locked. It is the responsibility of the caller
1612 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001613 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001614 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001615 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001616 * \param[out] p_slot On success, a pointer to the prepared slot.
1617 * \param[out] p_drv On any return, the driver for the key, if any.
1618 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001619 *
1620 * \retval #PSA_SUCCESS
1621 * The key slot is ready to receive key material.
1622 * \return If this function fails, the key slot is an invalid state.
1623 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001624 */
1625static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001626 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001627 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001628 psa_key_slot_t **p_slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001629 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001630{
1631 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001632 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001633 psa_key_slot_t *slot;
1634
Gilles Peskinedf179142019-07-15 22:02:14 +02001635 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001636 *p_drv = NULL;
1637
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001638 status = psa_validate_key_attributes(attributes, p_drv);
1639 if (status != PSA_SUCCESS) {
1640 return status;
1641 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001642
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001643 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1644 if (status != PSA_SUCCESS) {
1645 return status;
1646 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001647 slot = *p_slot;
1648
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001649 /* We're storing the declared bit-size of the key. It's up to each
1650 * creation mechanism to verify that this information is correct.
1651 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001652 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001653 * is optional (import, copy). In case of a volatile key, assign it the
1654 * volatile key identifier associated to the slot returned to contain its
1655 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001656
1657 slot->attr = attributes->core;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001658 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001659#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1660 slot->attr.id = volatile_key_id;
1661#else
1662 slot->attr.id.key_id = volatile_key_id;
1663#endif
1664 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001665
Gilles Peskine91e8c332019-08-02 19:19:39 +02001666 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001667 * external-only flags, query `attributes`. Thanks to the check
1668 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001669 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001670 * may have set. */
1671 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001672
Gilles Peskinecbaff462019-07-12 23:46:04 +02001673#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001674 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001675 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001676 * create the key file in internal storage, create the
1677 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001678 * persistent data. This is done by starting a transaction that will
1679 * encompass these three actions.
1680 * For registering a volatile key, we just need to find an appropriate
1681 * slot number inside the SE. Since the key is designated volatile, creating
1682 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001683 /* The first thing to do is to find a slot number for the new key.
1684 * We save the slot number in persistent storage as part of the
1685 * transaction data. It will be needed to recover if the power
1686 * fails during the key creation process, to clean up on the secure
1687 * element side after restarting. Obtaining a slot number from the
1688 * secure element driver updates its persistent state, but we do not yet
1689 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001690 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001691 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001692 psa_key_slot_number_t slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001693 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1694 &slot_number);
1695 if (status != PSA_SUCCESS) {
1696 return status;
1697 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001698
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001699 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1700 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001701 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001702 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001703 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001704 status = psa_crypto_save_transaction();
1705 if (status != PSA_SUCCESS) {
1706 (void) psa_crypto_stop_transaction();
1707 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001708 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001709 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001710
1711 status = psa_copy_key_material_into_slot(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001712 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001713 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001714
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001715 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001716 /* Key registration only makes sense with a secure element. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001717 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001718 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001719#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1720
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001721 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001722}
Gilles Peskine4747d192019-04-17 15:05:45 +02001723
1724/** Finalize the creation of a key once its key material has been set.
1725 *
1726 * This entails writing the key to persistent storage.
1727 *
1728 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001729 * See the documentation of psa_start_key_creation() for the intended use
1730 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001731 *
Ronald Cron5c522922020-11-14 16:35:34 +01001732 * If the finalization succeeds, the function unlocks the key slot (it was
1733 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1734 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001735 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001736 * \param[in,out] slot Pointer to the slot with key material.
1737 * \param[in] driver The secure element driver for the key,
1738 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001739 * \param[out] key On success, identifier of the key. Note that the
1740 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001741 *
1742 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001743 * The key was successfully created.
Gilles Peskineec1eff32023-02-14 19:21:09 +01001744 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1745 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1746 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1747 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1748 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1749 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001750 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001751 * \return If this function fails, the key slot is an invalid state.
1752 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001753 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001754static psa_status_t psa_finish_key_creation(
1755 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001756 psa_se_drv_table_entry_t *driver,
1757 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001758{
1759 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001760 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001761 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001762
1763#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001764 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001765#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001766 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001767 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001768 psa_key_slot_number_t slot_number =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001769 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001770
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001771 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1772 sizeof(data.slot_number),
1773 "Slot number size does not match psa_se_key_data_storage_t");
1774
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001775 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1776 status = psa_save_persistent_key(&slot->attr,
1777 (uint8_t *) &data,
1778 sizeof(data));
1779 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001780#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1781 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001782 /* Key material is saved in export representation in the slot, so
1783 * just pass the slot buffer for storage. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001784 status = psa_save_persistent_key(&slot->attr,
1785 slot->key.data,
1786 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001787 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001789#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1790
Gilles Peskinecbaff462019-07-12 23:46:04 +02001791#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001792 /* Finish the transaction for a key creation. This does not
1793 * happen when registering an existing key. Detect this case
1794 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001795 * creation of a persistent key in a secure element requires a transaction,
1796 * but registration or volatile key creation doesn't use one). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001797 if (driver != NULL &&
1798 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1799 status = psa_save_se_persistent_data(driver);
1800 if (status != PSA_SUCCESS) {
1801 psa_destroy_persistent_key(slot->attr.id);
1802 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001803 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001804 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001805 }
1806#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1807
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001808 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001809 *key = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001810 status = psa_unlock_key_slot(slot);
1811 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001812 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001813 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001814 }
Ronald Cron50972942020-11-14 11:28:25 +01001815
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001816 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001817}
1818
1819/** Abort the creation of a key.
1820 *
1821 * You may call this function after calling psa_start_key_creation(),
1822 * or after psa_finish_key_creation() fails. In other circumstances, this
1823 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001824 * See the documentation of psa_start_key_creation() for the intended use
1825 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001826 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001827 * \param[in,out] slot Pointer to the slot with key material.
1828 * \param[in] driver The secure element driver for the key,
1829 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001830 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001831static void psa_fail_key_creation(psa_key_slot_t *slot,
1832 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001833{
Gilles Peskine011e4282019-06-26 18:34:38 +02001834 (void) driver;
1835
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001836 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001837 return;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001838 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001839
1840#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001841 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001842 * element, and the failure happened later (when saving metadata
1843 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001844 * element.
1845 * https://github.com/ARMmbed/mbed-crypto/issues/217
1846 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001847
Gilles Peskined7729582019-08-05 15:55:54 +02001848 /* Abort the ongoing transaction if any (there may not be one if
1849 * the creation process failed before starting one, or if the
1850 * key creation is a registration of a key in a secure element).
1851 * Earlier functions must already have done what it takes to undo any
1852 * partial creation. All that's left is to update the transaction data
1853 * itself. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001854 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001855#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1856
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001857 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001858}
1859
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001860/** Validate optional attributes during key creation.
1861 *
1862 * Some key attributes are optional during key creation. If they are
1863 * specified in the attributes structure, check that they are consistent
1864 * with the data in the slot.
1865 *
1866 * This function should be called near the end of key creation, after
1867 * the slot in memory is fully populated but before saving persistent data.
1868 */
1869static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001870 const psa_key_slot_t *slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001871 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001872{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001873 if (attributes->core.type != 0) {
1874 if (attributes->core.type != slot->attr.type) {
1875 return PSA_ERROR_INVALID_ARGUMENT;
1876 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 }
1878
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001879 if (attributes->domain_parameters_size != 0) {
John Durkop0e005192020-10-31 22:06:54 -07001880#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001881 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1882 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001883 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001884 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001885 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001886
Ronald Cron90857082020-11-25 14:58:33 +01001887 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001888 slot->attr.type,
1889 slot->key.data,
1890 slot->key.bytes,
1891 &rsa);
1892 if (status != PSA_SUCCESS) {
1893 return status;
1894 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001895
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001896 mbedtls_mpi_init(&actual);
1897 mbedtls_mpi_init(&required);
1898 ret = mbedtls_rsa_export(rsa,
1899 NULL, NULL, NULL, NULL, &actual);
1900 mbedtls_rsa_free(rsa);
1901 mbedtls_free(rsa);
1902 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001904 }
1905 ret = mbedtls_mpi_read_binary(&required,
1906 attributes->domain_parameters,
1907 attributes->domain_parameters_size);
1908 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001910 }
1911 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001913 }
1914rsa_exit:
1915 mbedtls_mpi_free(&actual);
1916 mbedtls_mpi_free(&required);
1917 if (ret != 0) {
1918 return mbedtls_to_psa_error(ret);
1919 }
1920 } else
John Durkop9814fa22020-11-04 12:28:15 -08001921#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1922 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001923 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001924 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 }
1926 }
1927
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001928 if (attributes->core.bits != 0) {
1929 if (attributes->core.bits != slot->attr.bits) {
1930 return PSA_ERROR_INVALID_ARGUMENT;
1931 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001932 }
1933
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001934 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001935}
1936
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001937psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1938 const uint8_t *data,
1939 size_t data_length,
1940 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001941{
1942 psa_status_t status;
1943 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001944 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001945 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 *key = MBEDTLS_SVC_KEY_ID_INIT;
1948
Gilles Peskine0f84d622019-09-12 19:03:13 +02001949 /* Reject zero-length symmetric keys (including raw data key objects).
1950 * This also rejects any key which might be encoded as an empty string,
1951 * which is never valid. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001952 if (data_length == 0) {
1953 return PSA_ERROR_INVALID_ARGUMENT;
1954 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001955
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001956 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1957 &slot, &driver);
1958 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001959 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001960 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001961
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001962 /* In the case of a transparent key or an opaque key stored in local
1963 * storage (thus not in the case of generating a key in a secure element
1964 * or cryptoprocessor with storage), we have to allocate a buffer to
1965 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001966 if (slot->key.data == NULL) {
1967 status = psa_allocate_buffer_to_slot(slot, data_length);
1968 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001969 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001970 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001971 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001972
1973 bits = slot->attr.bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001974 status = psa_driver_wrapper_import_key(attributes,
1975 data, data_length,
1976 slot->key.data,
1977 slot->key.bytes,
1978 &slot->key.bytes, &bits);
1979 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001980 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001981 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001982
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001983 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001984 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001985 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001986 status = PSA_ERROR_INVALID_ARGUMENT;
1987 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001988 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001989
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001990 status = psa_validate_optional_attributes(slot, attributes);
1991 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001992 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001993 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001994
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001995 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001996exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001997 if (status != PSA_SUCCESS) {
1998 psa_fail_key_creation(slot, driver);
1999 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002000
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002001 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002002}
2003
Gilles Peskined7729582019-08-05 15:55:54 +02002004#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2005psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002006 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002007{
2008 psa_status_t status;
2009 psa_key_slot_t *slot = NULL;
2010 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002011 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002012
2013 /* Leaving attributes unspecified is not currently supported.
2014 * It could make sense to query the key type and size from the
2015 * secure element, but not all secure elements support this
2016 * and the driver HAL doesn't currently support it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002017 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2018 return PSA_ERROR_NOT_SUPPORTED;
2019 }
2020 if (psa_get_key_bits(attributes) == 0) {
2021 return PSA_ERROR_NOT_SUPPORTED;
2022 }
Gilles Peskined7729582019-08-05 15:55:54 +02002023
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002024 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2025 &slot, &driver);
2026 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002027 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002028 }
Gilles Peskined7729582019-08-05 15:55:54 +02002029
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002030 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002031
2032exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002033 if (status != PSA_SUCCESS) {
2034 psa_fail_key_creation(slot, driver);
2035 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002036
Gilles Peskined7729582019-08-05 15:55:54 +02002037 /* Registration doesn't keep the key in RAM. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002038 psa_close_key(key);
2039 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002040}
2041#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2042
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002043static psa_status_t psa_copy_key_material(const psa_key_slot_t *source,
2044 psa_key_slot_t *target)
Gilles Peskinef603c712019-01-19 13:40:11 +01002045{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002046 psa_status_t status = psa_copy_key_material_into_slot(target,
2047 source->key.data,
2048 source->key.bytes);
2049 if (status != PSA_SUCCESS) {
2050 return status;
2051 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002052
Steven Cooreman398aee52020-10-13 14:35:45 +02002053 target->attr.type = source->attr.type;
2054 target->attr.bits = source->attr.bits;
2055
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002056 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01002057}
2058
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002059psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2060 const psa_key_attributes_t *specified_attributes,
2061 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002062{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002064 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002065 psa_key_slot_t *source_slot = NULL;
2066 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002068 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002069
Ronald Cron81709fc2020-11-14 12:10:32 +01002070 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2071
Ronald Cron5c522922020-11-14 16:35:34 +01002072 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002073 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2074 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002075 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002076 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002077
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002078 status = psa_validate_optional_attributes(source_slot,
2079 specified_attributes);
2080 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002081 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002082 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002083
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002084 status = psa_restrict_key_policy(source_slot->attr.type,
2085 &actual_attributes.core.policy,
2086 &source_slot->attr.policy);
2087 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002088 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002089 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002090
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002091 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2092 &target_slot, &driver);
2093 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002095 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002096
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002097#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002098 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002099 /* Copying to a secure element is not implemented yet. */
2100 status = PSA_ERROR_NOT_SUPPORTED;
2101 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002102 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002103#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002104
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002105 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
Ronald Cron6cc66312021-04-02 12:27:47 +02002106 /*
2107 * Copying through an opaque driver is not implemented yet, consider
2108 * a lifetime with an external location as an invalid parameter for
2109 * now.
2110 */
2111 status = PSA_ERROR_INVALID_ARGUMENT;
2112 goto exit;
2113 }
2114
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002115 status = psa_copy_key_material(source_slot, target_slot);
2116 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002117 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002118 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002119
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002120 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002121exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002122 if (status != PSA_SUCCESS) {
2123 psa_fail_key_creation(target_slot, driver);
2124 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002125
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002126 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002127
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002128 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002129}
2130
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002131
2132
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002133/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002134/* Message digests */
2135/****************************************************************/
2136
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002137psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002138{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002139 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002140 if (operation->id == 0) {
2141 return PSA_SUCCESS;
2142 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002143
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002144 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002145 operation->id = 0;
2146
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002147 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002148}
2149
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002150psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2151 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002152{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002154
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002156 if (operation->id != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002157 status = PSA_ERROR_BAD_STATE;
2158 goto exit;
2159 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002160
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002161 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002162 status = PSA_ERROR_INVALID_ARGUMENT;
2163 goto exit;
2164 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002165
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002166 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2167 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002168 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002169
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002170 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002171
2172exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002173 if (status != PSA_SUCCESS) {
2174 psa_hash_abort(operation);
2175 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002176
2177 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002178}
2179
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002180psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2181 const uint8_t *input,
2182 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2185
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002186 if (operation->id == 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002187 status = PSA_ERROR_BAD_STATE;
2188 goto exit;
2189 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002190
Steven Cooremanc8288352021-03-04 14:02:19 +01002191 /* Don't require hash implementations to behave correctly on a
2192 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002193 if (input_length == 0) {
2194 return PSA_SUCCESS;
2195 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002196
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002197 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002198
2199exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002200 if (status != PSA_SUCCESS) {
2201 psa_hash_abort(operation);
2202 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002203
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002204 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002205}
2206
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002207psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2208 uint8_t *hash,
2209 size_t hash_size,
2210 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002211{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002212 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002213 if (operation->id == 0) {
2214 return PSA_ERROR_BAD_STATE;
2215 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002216
Steven Cooreman1e582352021-02-18 17:24:37 +01002217 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002218 operation, hash, hash_size, hash_length);
2219 psa_hash_abort(operation);
2220 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221}
2222
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002223psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2224 const uint8_t *hash,
2225 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002226{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002227 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002228 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002229 psa_status_t status = psa_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002230 operation,
2231 actual_hash, sizeof(actual_hash),
2232 &actual_hash_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002233
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002234 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002235 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002236 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002237
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002238 if (actual_hash_length != hash_length) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002239 status = PSA_ERROR_INVALID_SIGNATURE;
2240 goto exit;
2241 }
2242
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002243 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002244 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002245 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002246
2247exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002248 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2249 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002250 psa_hash_abort(operation);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002251 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002252
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002253 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254}
2255
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002256psa_status_t psa_hash_compute(psa_algorithm_t alg,
2257 const uint8_t *input, size_t input_length,
2258 uint8_t *hash, size_t hash_size,
2259 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002260{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002261 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002262 if (!PSA_ALG_IS_HASH(alg)) {
2263 return PSA_ERROR_INVALID_ARGUMENT;
2264 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002265
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002266 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2267 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002268}
2269
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002270psa_status_t psa_hash_compare(psa_algorithm_t alg,
2271 const uint8_t *input, size_t input_length,
2272 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002273{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002274 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002275 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002276
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002277 if (!PSA_ALG_IS_HASH(alg)) {
2278 return PSA_ERROR_INVALID_ARGUMENT;
2279 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002280
Steven Cooreman1e582352021-02-18 17:24:37 +01002281 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002282 alg, input, input_length,
2283 actual_hash, sizeof(actual_hash),
2284 &actual_hash_length);
2285 if (status != PSA_SUCCESS) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002286 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002287 }
2288 if (actual_hash_length != hash_length) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002289 status = PSA_ERROR_INVALID_SIGNATURE;
2290 goto exit;
2291 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002292 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002293 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002294 }
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002295
2296exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002297 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2298 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002299}
2300
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002301psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2302 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002303{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002304 if (source_operation->id == 0 ||
2305 target_operation->id != 0) {
2306 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002307 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002308
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002309 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2310 target_operation);
2311 if (status != PSA_SUCCESS) {
2312 psa_hash_abort(target_operation);
2313 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002314
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002315 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002316}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002317
2318
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320/* MAC */
2321/****************************************************************/
2322
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002323psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002324{
Steven Cooreman07897832021-03-19 18:28:56 +01002325 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002326 if (operation->id == 0) {
2327 return PSA_SUCCESS;
2328 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002329
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002330 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002331 operation->mac_size = 0;
2332 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002333 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002334
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002335 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002336}
2337
Ronald Cron1c650a12021-06-17 16:33:22 +02002338static psa_status_t psa_mac_finalize_alg_and_key_validation(
2339 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002340 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002341 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002342{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002344 psa_key_type_t key_type = psa_get_key_type(attributes);
2345 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002346
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002347 if (!PSA_ALG_IS_MAC(alg)) {
2348 return PSA_ERROR_INVALID_ARGUMENT;
2349 }
Steven Cooreman07897832021-03-19 18:28:56 +01002350
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002351 /* Validate the combination of key type and algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002352 status = psa_mac_key_can_do(alg, key_type);
2353 if (status != PSA_SUCCESS) {
2354 return status;
2355 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002356
Steven Cooremana6474de2021-05-10 11:13:41 +02002357 /* Get the output length for the algorithm and key combination */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002358 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002359
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002360 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002361 /* A very short MAC is too short for security since it can be
2362 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2363 * so we make this our minimum, even though 32 bits is still
2364 * too small for security. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002365 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002366 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002367
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002368 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2369 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002370 /* It's impossible to "truncate" to a larger length than the full length
2371 * of the algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002372 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002373 }
2374
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002375 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinebc795822022-03-16 13:54:49 +01002376 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2377 * that is disabled in the compile-time configuration. The result can
2378 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2379 * configuration into account. In this case, force a return of
2380 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2381 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2382 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2383 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2384 * systematically generated tests. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002385 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinebc795822022-03-16 13:54:49 +01002386 }
2387
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002388 return PSA_SUCCESS;
Ronald Cron1c650a12021-06-17 16:33:22 +02002389}
2390
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002391static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2392 mbedtls_svc_key_id_t key,
2393 psa_algorithm_t alg,
2394 int is_sign)
Ronald Cron1c650a12021-06-17 16:33:22 +02002395{
2396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2397 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002398 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002399 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002400
2401 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002402 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002403 status = PSA_ERROR_BAD_STATE;
2404 goto exit;
2405 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002406
2407 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002408 key,
2409 &slot,
2410 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2411 alg);
2412 if (status != PSA_SUCCESS) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002413 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002414 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002415
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002416 attributes = (psa_key_attributes_t) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002417 .core = slot->attr
2418 };
2419
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002420 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2421 &operation->mac_size);
2422 if (status != PSA_SUCCESS) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002423 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002424 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002425
2426 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002427 /* Dispatch the MAC setup call with validated input */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002428 if (is_sign) {
2429 status = psa_driver_wrapper_mac_sign_setup(operation,
2430 &attributes,
2431 slot->key.data,
2432 slot->key.bytes,
2433 alg);
2434 } else {
2435 status = psa_driver_wrapper_mac_verify_setup(operation,
2436 &attributes,
2437 slot->key.data,
2438 slot->key.bytes,
2439 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002440 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002441
Gilles Peskinefbfac682018-07-08 20:51:54 +02002442exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002443 if (status != PSA_SUCCESS) {
2444 psa_mac_abort(operation);
2445 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002446
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002447 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002448
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002449 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002450}
2451
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002452psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2453 mbedtls_svc_key_id_t key,
2454 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002455{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002456 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002457}
2458
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002459psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2460 mbedtls_svc_key_id_t key,
2461 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002462{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002463 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002464}
2465
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002466psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2467 const uint8_t *input,
2468 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002469{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002470 if (operation->id == 0) {
2471 return PSA_ERROR_BAD_STATE;
2472 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002473
Steven Cooreman11743f92021-03-19 18:38:46 +01002474 /* Don't require hash implementations to behave correctly on a
2475 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002476 if (input_length == 0) {
2477 return PSA_SUCCESS;
2478 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002479
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002480 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2481 input, input_length);
2482 if (status != PSA_SUCCESS) {
2483 psa_mac_abort(operation);
2484 }
Steven Cooreman11743f92021-03-19 18:38:46 +01002485
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002486 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487}
2488
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002489psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2490 uint8_t *mac,
2491 size_t mac_size,
2492 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002493{
Steven Cooreman87885df2021-03-19 19:04:39 +01002494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2495 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002496
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002497 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002498 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002499 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002500 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002501
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002502 if (!operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002503 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002504 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002505 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002506
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002507 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2508 * once all the error checks are done. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002509 if (operation->mac_size == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002510 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002511 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002512 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002513
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002514 if (mac_size < operation->mac_size) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002515 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002516 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002517 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002518
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002519 status = psa_driver_wrapper_mac_sign_finish(operation,
2520 mac, operation->mac_size,
2521 mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002522
Dave Rodgman478ab542021-06-25 09:09:02 +01002523exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002524 /* In case of success, set the potential excess room in the output buffer
2525 * to an invalid value, to avoid potentially leaking a longer MAC.
2526 * In case of error, set the output length and content to a safe default,
2527 * such that in case the caller misses an error check, the output would be
2528 * an unachievable MAC.
2529 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002530 if (status != PSA_SUCCESS) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002531 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002532 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002533 }
mohammad16036df908f2018-04-02 08:34:15 -07002534
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002535 if (mac_size > operation->mac_size) {
2536 memset(&mac[operation->mac_size], '!',
2537 mac_size - operation->mac_size);
2538 }
Ronald Cron882eb782021-06-18 13:05:48 +02002539
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002540 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002541
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002542 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002543}
2544
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002545psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2546 const uint8_t *mac,
2547 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002548{
Steven Cooreman87885df2021-03-19 19:04:39 +01002549 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2550 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002551
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002552 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002553 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002554 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002555 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002556
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002557 if (operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002558 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002559 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002560 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002561
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002562 if (operation->mac_size != mac_length) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002563 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002564 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002565 }
2566
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002567 status = psa_driver_wrapper_mac_verify_finish(operation,
2568 mac, mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002569
Dave Rodgman478ab542021-06-25 09:09:02 +01002570exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002571 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002572
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002573 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002574}
2575
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002576static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2577 psa_algorithm_t alg,
2578 const uint8_t *input,
2579 size_t input_length,
2580 uint8_t *mac,
2581 size_t mac_size,
2582 size_t *mac_length,
2583 int is_sign)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002584{
2585 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002586 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002587 psa_key_attributes_t attributes;
Ronald Crondbb86462021-06-17 17:17:20 +02002588 psa_key_slot_t *slot;
2589 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002590
Ronald Crondbb86462021-06-17 17:17:20 +02002591 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002592 key,
2593 &slot,
2594 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2595 alg);
2596 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002597 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002598 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002599
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002600 attributes = (psa_key_attributes_t) {
Ronald Crondbb86462021-06-17 17:17:20 +02002601 .core = slot->attr
2602 };
2603
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002604 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2605 &operation_mac_size);
2606 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002607 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002608 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002609
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002610 if (mac_size < operation_mac_size) {
Ronald Crondbb86462021-06-17 17:17:20 +02002611 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002612 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002613 }
2614
2615 status = psa_driver_wrapper_mac_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002616 &attributes,
2617 slot->key.data, slot->key.bytes,
2618 alg,
2619 input, input_length,
2620 mac, operation_mac_size, mac_length);
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002621
2622exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002623 /* In case of success, set the potential excess room in the output buffer
2624 * to an invalid value, to avoid potentially leaking a longer MAC.
2625 * In case of error, set the output length and content to a safe default,
2626 * such that in case the caller misses an error check, the output would be
2627 * an unachievable MAC.
2628 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002629 if (status != PSA_SUCCESS) {
Ronald Crondbb86462021-06-17 17:17:20 +02002630 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002631 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002632 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002633 if (mac_size > operation_mac_size) {
2634 memset(&mac[operation_mac_size], '!', mac_size - operation_mac_size);
2635 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002636
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002637 unlock_status = psa_unlock_key_slot(slot);
Ronald Crondbb86462021-06-17 17:17:20 +02002638
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002639 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002640}
2641
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002642psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002643 psa_algorithm_t alg,
2644 const uint8_t *input,
2645 size_t input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002646 uint8_t *mac,
2647 size_t mac_size,
2648 size_t *mac_length)
2649{
2650 return psa_mac_compute_internal(key, alg,
2651 input, input_length,
2652 mac, mac_size, mac_length, 1);
2653}
2654
2655psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2656 psa_algorithm_t alg,
2657 const uint8_t *input,
2658 size_t input_length,
2659 const uint8_t *mac,
2660 size_t mac_length)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002661{
2662 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002663 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2664 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002665
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002666 status = psa_mac_compute_internal(key, alg,
2667 input, input_length,
2668 actual_mac, sizeof(actual_mac),
2669 &actual_mac_length, 0);
2670 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002671 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002672 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002673
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002674 if (mac_length != actual_mac_length) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002675 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002676 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002677 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002678 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002679 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002680 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002681 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002682
2683exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002684 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002685
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002686 return status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002687}
Gilles Peskine20035e32018-02-03 22:44:14 +01002688
Gilles Peskine20035e32018-02-03 22:44:14 +01002689/****************************************************************/
2690/* Asymmetric cryptography */
2691/****************************************************************/
2692
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002693static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2694 psa_algorithm_t alg)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002695{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002696 if (input_is_message) {
2697 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2698 return PSA_ERROR_INVALID_ARGUMENT;
2699 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002700
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002701 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2702 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2703 return PSA_ERROR_INVALID_ARGUMENT;
2704 }
2705 }
2706 } else {
2707 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2708 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002709 }
2710 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002711
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002712 return PSA_SUCCESS;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002713}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002714
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002715static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2716 int input_is_message,
2717 psa_algorithm_t alg,
2718 const uint8_t *input,
2719 size_t input_length,
2720 uint8_t *signature,
2721 size_t signature_size,
2722 size_t *signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002723{
2724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2725 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002726 psa_key_attributes_t attributes;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002727 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002728
2729 *signature_length = 0;
2730
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002731 status = psa_sign_verify_check_alg(input_is_message, alg);
2732 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002733 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002734 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002735
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002736 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002737 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002738 * buffer can in principle be empty since it doesn't actually have
2739 * to be a hash.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002740 if (signature_size == 0) {
2741 return PSA_ERROR_BUFFER_TOO_SMALL;
2742 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002743
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002744 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002745 key, &slot,
2746 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2747 PSA_KEY_USAGE_SIGN_HASH,
2748 alg);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002749
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002750 if (status != PSA_SUCCESS) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002751 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002752 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002753
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002754 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002755 status = PSA_ERROR_INVALID_ARGUMENT;
2756 goto exit;
2757 }
2758
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002759 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002760 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002761 };
2762
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002763 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002764 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002765 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002766 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002767 signature, signature_size, signature_length);
2768 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002769
2770 status = psa_driver_wrapper_sign_hash(
2771 &attributes, slot->key.data, slot->key.bytes,
2772 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002773 signature, signature_size, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002774 }
2775
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002776
2777exit:
2778 /* Fill the unused part of the output buffer (the whole buffer on error,
2779 * the trailing part on success) with something that isn't a valid signature
2780 * (barring an attack on the signature and deliberately-crafted input),
2781 * in case the caller doesn't check the return status properly. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002782 if (status == PSA_SUCCESS) {
2783 memset(signature + *signature_length, '!',
2784 signature_size - *signature_length);
2785 } else {
2786 memset(signature, '!', signature_size);
2787 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002788 /* If signature_size is 0 then we have nothing to do. We must not call
2789 * memset because signature may be NULL in this case. */
2790
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002791 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002792
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002793 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002794}
2795
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002796static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2797 int input_is_message,
2798 psa_algorithm_t alg,
2799 const uint8_t *input,
2800 size_t input_length,
2801 const uint8_t *signature,
2802 size_t signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002803{
2804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2805 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2806 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002807
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002808 status = psa_sign_verify_check_alg(input_is_message, alg);
2809 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002810 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002811 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002812
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002813 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002814 key, &slot,
2815 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2816 PSA_KEY_USAGE_VERIFY_HASH,
2817 alg);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002818
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002819 if (status != PSA_SUCCESS) {
2820 return status;
2821 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002822
2823 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002824 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002825 };
2826
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002827 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002828 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002829 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002830 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002831 signature, signature_length);
2832 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002833 status = psa_driver_wrapper_verify_hash(
2834 &attributes, slot->key.data, slot->key.bytes,
2835 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002836 signature, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002837 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002838
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002839 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002840
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002841 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002842
2843}
2844
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002845psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002846 const psa_key_attributes_t *attributes,
2847 const uint8_t *key_buffer,
2848 size_t key_buffer_size,
2849 psa_algorithm_t alg,
2850 const uint8_t *input,
2851 size_t input_length,
2852 uint8_t *signature,
2853 size_t signature_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002854 size_t *signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002855{
2856 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002857
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002858 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002859 size_t hash_length;
2860 uint8_t hash[PSA_HASH_MAX_SIZE];
2861
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002862 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002863 PSA_ALG_SIGN_GET_HASH(alg),
2864 input, input_length,
2865 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002866
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002867 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002868 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002869 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002870
2871 return psa_driver_wrapper_sign_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002872 attributes, key_buffer, key_buffer_size,
2873 alg, hash, hash_length,
2874 signature, signature_size, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002875 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002876
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002877 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002878}
2879
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002880psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2881 psa_algorithm_t alg,
2882 const uint8_t *input,
2883 size_t input_length,
2884 uint8_t *signature,
2885 size_t signature_size,
2886 size_t *signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002887{
2888 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002889 key, 1, alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002890 signature, signature_size, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002891}
2892
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002893psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002894 const psa_key_attributes_t *attributes,
2895 const uint8_t *key_buffer,
2896 size_t key_buffer_size,
2897 psa_algorithm_t alg,
2898 const uint8_t *input,
2899 size_t input_length,
2900 const uint8_t *signature,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002901 size_t signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002902{
2903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002904
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002905 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002906 size_t hash_length;
2907 uint8_t hash[PSA_HASH_MAX_SIZE];
2908
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002909 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002910 PSA_ALG_SIGN_GET_HASH(alg),
2911 input, input_length,
2912 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002913
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002914 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002915 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002916 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002917
2918 return psa_driver_wrapper_verify_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002919 attributes, key_buffer, key_buffer_size,
2920 alg, hash, hash_length,
2921 signature, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002922 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002923
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002924 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002925}
2926
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002927psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2928 psa_algorithm_t alg,
2929 const uint8_t *input,
2930 size_t input_length,
2931 const uint8_t *signature,
2932 size_t signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002933{
2934 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002935 key, 1, alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002936 signature, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002937}
2938
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002939psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002940 const psa_key_attributes_t *attributes,
2941 const uint8_t *key_buffer, size_t key_buffer_size,
2942 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002943 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskine20035e32018-02-03 22:44:14 +01002944{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002945 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2946 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2947 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002948#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002949 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2950 return mbedtls_psa_rsa_sign_hash(
2951 attributes,
2952 key_buffer, key_buffer_size,
2953 alg, hash, hash_length,
2954 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002955#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2956 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002957 } else {
2958 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002959 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002960 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2961 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002962#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002963 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2964 return mbedtls_psa_ecdsa_sign_hash(
2965 attributes,
2966 key_buffer, key_buffer_size,
2967 alg, hash, hash_length,
2968 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2970 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002971 } else {
2972 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002973 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002974 }
Ronald Cron4501c982021-03-19 20:09:32 +01002975
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002976 (void) key_buffer;
2977 (void) key_buffer_size;
2978 (void) hash;
2979 (void) hash_length;
2980 (void) signature;
2981 (void) signature_size;
2982 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002983
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002984 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002985}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002986
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002987psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2988 psa_algorithm_t alg,
2989 const uint8_t *hash,
2990 size_t hash_length,
2991 uint8_t *signature,
2992 size_t signature_size,
2993 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002994{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002995 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002996 key, 0, alg, hash, hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002997 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002998}
2999
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003000psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003001 const psa_key_attributes_t *attributes,
3002 const uint8_t *key_buffer, size_t key_buffer_size,
3003 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003004 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003005{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003006 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3007 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3008 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003009#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003010 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3011 return mbedtls_psa_rsa_verify_hash(
3012 attributes,
3013 key_buffer, key_buffer_size,
3014 alg, hash, hash_length,
3015 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003016#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3017 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003018 } else {
3019 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003020 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003021 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3022 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003023#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003024 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3025 return mbedtls_psa_ecdsa_verify_hash(
3026 attributes,
3027 key_buffer, key_buffer_size,
3028 alg, hash, hash_length,
3029 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003030#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3031 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003032 } else {
3033 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003034 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003035 }
Ronald Cron4501c982021-03-19 20:09:32 +01003036
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003037 (void) key_buffer;
3038 (void) key_buffer_size;
3039 (void) hash;
3040 (void) hash_length;
3041 (void) signature;
3042 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003043
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003044 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003045}
3046
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003047psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3048 psa_algorithm_t alg,
3049 const uint8_t *hash,
3050 size_t hash_length,
3051 const uint8_t *signature,
3052 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003053{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003054 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003055 key, 0, alg, hash, hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003056 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003057}
3058
John Durkop0e005192020-10-31 22:06:54 -07003059#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003060static void psa_rsa_oaep_set_padding_mode(psa_algorithm_t alg,
3061 mbedtls_rsa_context *rsa)
Gilles Peskine072ac562018-06-30 00:21:29 +02003062{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003063 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH(alg);
3064 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa(hash_alg);
3065 mbedtls_md_type_t md_alg = mbedtls_md_get_type(md_info);
3066 mbedtls_rsa_set_padding(rsa, MBEDTLS_RSA_PKCS_V21, md_alg);
Gilles Peskine072ac562018-06-30 00:21:29 +02003067}
John Durkop0e005192020-10-31 22:06:54 -07003068#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003069
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003070psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3071 psa_algorithm_t alg,
3072 const uint8_t *input,
3073 size_t input_length,
3074 const uint8_t *salt,
3075 size_t salt_length,
3076 uint8_t *output,
3077 size_t output_size,
3078 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003079{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003081 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003082 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003083
Darryl Green5cc689a2018-07-24 15:34:10 +01003084 (void) input;
3085 (void) input_length;
3086 (void) salt;
3087 (void) output;
3088 (void) output_size;
3089
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003090 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003091
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003092 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3093 return PSA_ERROR_INVALID_ARGUMENT;
3094 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003095
Ronald Cron5c522922020-11-14 16:35:34 +01003096 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003097 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3098 if (status != PSA_SUCCESS) {
3099 return status;
3100 }
3101 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3102 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003103 status = PSA_ERROR_INVALID_ARGUMENT;
3104 goto exit;
3105 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003106
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003107 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003108#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003109 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003110 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003111 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3112 slot->key.data,
3113 slot->key.bytes,
3114 &rsa);
3115 if (status != PSA_SUCCESS) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003116 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003117 }
Steven Cooremana2371e52020-07-28 14:30:39 +02003118
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003119 if (output_size < mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003120 status = PSA_ERROR_BUFFER_TOO_SMALL;
3121 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003122 }
Ronald Cron7207d572021-09-08 14:28:35 +02003123#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3124 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003125 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003126#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003127 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003128 mbedtls_rsa_pkcs1_encrypt(rsa,
3129 mbedtls_psa_get_random,
3130 MBEDTLS_PSA_RANDOM_STATE,
3131 MBEDTLS_RSA_PUBLIC,
3132 input_length,
3133 input,
3134 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003135#else
3136 status = PSA_ERROR_NOT_SUPPORTED;
3137#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003138 } else
3139 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003140#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003141 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003142 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003143 mbedtls_rsa_rsaes_oaep_encrypt(rsa,
3144 mbedtls_psa_get_random,
3145 MBEDTLS_PSA_RANDOM_STATE,
3146 MBEDTLS_RSA_PUBLIC,
3147 salt, salt_length,
3148 input_length,
3149 input,
3150 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003151#else
3152 status = PSA_ERROR_NOT_SUPPORTED;
3153#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003154 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003155 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156 }
Ronald Cron7207d572021-09-08 14:28:35 +02003157#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003158 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003159rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003160 if (status == PSA_SUCCESS) {
3161 *output_length = mbedtls_rsa_get_len(rsa);
3162 }
Steven Cooremana01795d2020-07-24 22:48:15 +02003163
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003164 mbedtls_rsa_free(rsa);
3165 mbedtls_free(rsa);
John Durkop9814fa22020-11-04 12:28:15 -08003166#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003167 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003168 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003169 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171
3172exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003173 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003174
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003175 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003176}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003177
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003178psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3179 psa_algorithm_t alg,
3180 const uint8_t *input,
3181 size_t input_length,
3182 const uint8_t *salt,
3183 size_t salt_length,
3184 uint8_t *output,
3185 size_t output_size,
3186 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003187{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003189 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003190 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003191
Darryl Green5cc689a2018-07-24 15:34:10 +01003192 (void) input;
3193 (void) input_length;
3194 (void) salt;
3195 (void) output;
3196 (void) output_size;
3197
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003198 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003199
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003200 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3201 return PSA_ERROR_INVALID_ARGUMENT;
3202 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003203
Ronald Cron5c522922020-11-14 16:35:34 +01003204 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003205 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3206 if (status != PSA_SUCCESS) {
3207 return status;
3208 }
3209 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003210 status = PSA_ERROR_INVALID_ARGUMENT;
3211 goto exit;
3212 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003214 if (slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Ronald Cron7207d572021-09-08 14:28:35 +02003215#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003216 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003217 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003218 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3219 slot->key.data,
3220 slot->key.bytes,
3221 &rsa);
3222 if (status != PSA_SUCCESS) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003223 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003224 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003225
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003226 if (input_length != mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003227 status = PSA_ERROR_INVALID_ARGUMENT;
3228 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003229 }
Ronald Cron7207d572021-09-08 14:28:35 +02003230#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3231 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003232
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003233 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003234#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003235 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003236 mbedtls_rsa_pkcs1_decrypt(rsa,
3237 mbedtls_psa_get_random,
3238 MBEDTLS_PSA_RANDOM_STATE,
3239 MBEDTLS_RSA_PRIVATE,
3240 output_length,
3241 input,
3242 output,
3243 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003244#else
3245 status = PSA_ERROR_NOT_SUPPORTED;
3246#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003247 } else
3248 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003249#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003250 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003251 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003252 mbedtls_rsa_rsaes_oaep_decrypt(rsa,
3253 mbedtls_psa_get_random,
3254 MBEDTLS_PSA_RANDOM_STATE,
3255 MBEDTLS_RSA_PRIVATE,
3256 salt, salt_length,
3257 output_length,
3258 input,
3259 output,
3260 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003261#else
3262 status = PSA_ERROR_NOT_SUPPORTED;
3263#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003264 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003265 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003266 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003267
Ronald Cron7207d572021-09-08 14:28:35 +02003268#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003269 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003270rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003271 mbedtls_rsa_free(rsa);
3272 mbedtls_free(rsa);
John Durkop6ba40d12020-11-10 08:50:04 -08003273#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3274 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003275 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003276 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003277 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003278
3279exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003280 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003281
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003282 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003283}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003284
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003285
3286
mohammad1603503973b2018-03-12 15:59:30 +02003287/****************************************************************/
3288/* Symmetric cryptography */
3289/****************************************************************/
3290
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003291static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3292 mbedtls_svc_key_id_t key,
3293 psa_algorithm_t alg,
3294 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003295{
3296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3297 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003298 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003299 psa_key_slot_t *slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003300 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3301 PSA_KEY_USAGE_ENCRYPT :
3302 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003303
3304 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003305 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003306 status = PSA_ERROR_BAD_STATE;
3307 goto exit;
3308 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003309
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003310 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003311 status = PSA_ERROR_INVALID_ARGUMENT;
3312 goto exit;
3313 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003314
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003315 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3316 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003317 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003318 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003319
Ronald Cron49fafa92021-03-10 08:34:23 +01003320 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003321 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003322 * so we only set it (in the driver wrapper) after resources have been
3323 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003324 operation->iv_set = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003325 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003326 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003327 } else if (slot->attr.type == PSA_KEY_TYPE_ARC4) {
Gilles Peskine4a83c102022-04-20 17:00:22 +02003328 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003329 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003330 operation->iv_required = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003331 }
3332 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003333
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003334 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003335 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003336 };
3337
Ronald Cronab99ac22020-10-01 16:38:28 +02003338 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003339 if (cipher_operation == MBEDTLS_ENCRYPT) {
3340 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3341 &attributes,
3342 slot->key.data,
3343 slot->key.bytes,
3344 alg);
3345 } else {
3346 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3347 &attributes,
3348 slot->key.data,
3349 slot->key.bytes,
3350 alg);
3351 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003352
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003353exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003354 if (status != PSA_SUCCESS) {
3355 psa_cipher_abort(operation);
3356 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003357
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003358 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003359
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003360 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003361}
3362
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003363psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3364 mbedtls_svc_key_id_t key,
3365 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003366{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003367 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003368}
3369
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003370psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3371 mbedtls_svc_key_id_t key,
3372 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003373{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003374 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003375}
3376
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003377psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3378 uint8_t *iv,
3379 size_t iv_size,
3380 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003381{
Ronald Cron6d051732020-10-01 14:10:20 +02003382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc423acb2021-07-05 12:31:44 +02003383 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergey04eb7c02023-03-06 15:37:23 -07003384 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003385
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003386 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003387 status = PSA_ERROR_BAD_STATE;
3388 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003389 }
3390
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003391 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003392 status = PSA_ERROR_BAD_STATE;
3393 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003394 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003395
Ronald Cronc423acb2021-07-05 12:31:44 +02003396 default_iv_length = operation->default_iv_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003397 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003398 status = PSA_ERROR_BUFFER_TOO_SMALL;
3399 goto exit;
3400 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003401
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003402 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc423acb2021-07-05 12:31:44 +02003403 status = PSA_ERROR_GENERIC_ERROR;
3404 goto exit;
3405 }
3406
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003407 status = psa_generate_random(local_iv, default_iv_length);
3408 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003409 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003410 }
Ronald Cron5618a392021-03-26 09:52:26 +01003411
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003412 status = psa_driver_wrapper_cipher_set_iv(operation,
3413 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003414
3415exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003416 if (status == PSA_SUCCESS) {
3417 memcpy(iv, local_iv, default_iv_length);
Ronald Cronc423acb2021-07-05 12:31:44 +02003418 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003419 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003420 } else {
Ronald Cronc423acb2021-07-05 12:31:44 +02003421 *iv_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003422 psa_cipher_abort(operation);
Ronald Cronc423acb2021-07-05 12:31:44 +02003423 }
Ronald Cron6d051732020-10-01 14:10:20 +02003424
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003425 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003426}
3427
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003428psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3429 const uint8_t *iv,
3430 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003431{
Ronald Cron6d051732020-10-01 14:10:20 +02003432 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003433
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003434 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003435 status = PSA_ERROR_BAD_STATE;
3436 goto exit;
3437 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003438
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003439 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003440 status = PSA_ERROR_BAD_STATE;
3441 goto exit;
3442 }
Ronald Crona0d68172021-03-26 10:15:08 +01003443
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003444 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003445 status = PSA_ERROR_INVALID_ARGUMENT;
3446 goto exit;
3447 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003448
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003449 status = psa_driver_wrapper_cipher_set_iv(operation,
3450 iv,
3451 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003452
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003453exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003454 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003455 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003456 } else {
3457 psa_cipher_abort(operation);
3458 }
3459 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003460}
3461
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003462psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3463 const uint8_t *input,
3464 size_t input_length,
3465 uint8_t *output,
3466 size_t output_size,
3467 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003468{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003469 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003470
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003471 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003472 status = PSA_ERROR_BAD_STATE;
3473 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003474 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003475
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003476 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003477 status = PSA_ERROR_BAD_STATE;
3478 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003479 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003480
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003481 status = psa_driver_wrapper_cipher_update(operation,
3482 input,
3483 input_length,
3484 output,
3485 output_size,
3486 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003487
3488exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003489 if (status != PSA_SUCCESS) {
3490 psa_cipher_abort(operation);
3491 }
Ronald Cron6d051732020-10-01 14:10:20 +02003492
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003493 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003494}
3495
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003496psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
3497 uint8_t *output,
3498 size_t output_size,
3499 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003500{
David Saadab4ecc272019-02-14 13:48:10 +02003501 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003502
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003503 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003504 status = PSA_ERROR_BAD_STATE;
3505 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003506 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003507
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003508 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003509 status = PSA_ERROR_BAD_STATE;
3510 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003511 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003512
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003513 status = psa_driver_wrapper_cipher_finish(operation,
3514 output,
3515 output_size,
3516 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003517
3518exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003519 if (status == PSA_SUCCESS) {
3520 return psa_cipher_abort(operation);
3521 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003522 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003523 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01003524
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003525 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003526 }
mohammad1603503973b2018-03-12 15:59:30 +02003527}
3528
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003529psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02003530{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003531 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02003532 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003533 * in use. It's ok to call abort on such an object, and there's
3534 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003535 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02003536 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003537
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003538 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02003539
Ronald Cron49fafa92021-03-10 08:34:23 +01003540 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003541 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003542 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003543
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003544 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02003545}
3546
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003547psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
3548 psa_algorithm_t alg,
3549 const uint8_t *input,
3550 size_t input_length,
3551 uint8_t *output,
3552 size_t output_size,
3553 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003554{
3555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003556 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003557 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003558 psa_key_slot_t *slot = NULL;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003559 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3560 size_t default_iv_length = 0;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003561
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003562 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003563 status = PSA_ERROR_INVALID_ARGUMENT;
3564 goto exit;
3565 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003566
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003567 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3568 PSA_KEY_USAGE_ENCRYPT,
3569 alg);
3570 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003571 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003572 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003573
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003574 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003575 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003576 };
3577
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003578 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
3579 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron4c224fe2021-07-09 18:44:58 +02003580 status = PSA_ERROR_GENERIC_ERROR;
3581 goto exit;
3582 }
3583
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003584 if (default_iv_length > 0) {
3585 if (output_size < default_iv_length) {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003586 status = PSA_ERROR_BUFFER_TOO_SMALL;
3587 goto exit;
3588 }
3589
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003590 status = psa_generate_random(local_iv, default_iv_length);
3591 if (status != PSA_SUCCESS) {
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003592 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003593 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003594 }
3595
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003596 status = psa_driver_wrapper_cipher_encrypt(
3597 &attributes, slot->key.data, slot->key.bytes,
Ronald Cron4c224fe2021-07-09 18:44:58 +02003598 alg, local_iv, default_iv_length, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003599 mbedtls_buffer_offset(output, default_iv_length),
3600 output_size - default_iv_length, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003601
3602exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003603 unlock_status = psa_unlock_key_slot(slot);
3604 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003605 status = unlock_status;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003606 }
Ronald Cron16377072021-07-08 19:00:07 +02003607
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003608 if (status == PSA_SUCCESS) {
3609 if (default_iv_length > 0) {
3610 memcpy(output, local_iv, default_iv_length);
3611 }
3612 *output_length += default_iv_length;
3613 } else {
3614 *output_length = 0;
3615 }
3616
3617 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003618}
3619
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003620psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
3621 psa_algorithm_t alg,
3622 const uint8_t *input,
3623 size_t input_length,
3624 uint8_t *output,
3625 size_t output_size,
3626 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003627{
3628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003629 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003630 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003631 psa_key_slot_t *slot = NULL;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003632
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003633 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003634 status = PSA_ERROR_INVALID_ARGUMENT;
3635 goto exit;
3636 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003637
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003638 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3639 PSA_KEY_USAGE_DECRYPT,
3640 alg);
3641 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003642 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003643 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003644
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003645 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003646 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003647 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003648
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003649 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003650 status = PSA_ERROR_INVALID_ARGUMENT;
3651 goto exit;
3652 }
3653
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003654 status = psa_driver_wrapper_cipher_decrypt(
3655 &attributes, slot->key.data, slot->key.bytes,
3656 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003657 output, output_size, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003658
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003659exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003660 unlock_status = psa_unlock_key_slot(slot);
3661 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003662 status = unlock_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003663 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003664
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003665 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003666 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003667 }
Ronald Cron16377072021-07-08 19:00:07 +02003668
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003669 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003670}
3671
3672
mohammad16035955c982018-04-26 00:53:03 +03003673/****************************************************************/
3674/* AEAD */
3675/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003676
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003677psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
3678 psa_algorithm_t alg,
3679 const uint8_t *nonce,
3680 size_t nonce_length,
3681 const uint8_t *additional_data,
3682 size_t additional_data_length,
3683 const uint8_t *plaintext,
3684 size_t plaintext_length,
3685 uint8_t *ciphertext,
3686 size_t ciphertext_size,
3687 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03003688{
Ronald Cron215633c2021-03-16 17:15:37 +01003689 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3690 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003691
mohammad1603f08a5502018-06-03 15:05:47 +03003692 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003693
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003694 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3695 return PSA_ERROR_NOT_SUPPORTED;
3696 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003697
Ronald Cron9a986162021-03-26 12:40:07 +01003698 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003699 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3700 if (status != PSA_SUCCESS) {
3701 return status;
3702 }
mohammad16035955c982018-04-26 00:53:03 +03003703
Ronald Cron215633c2021-03-16 17:15:37 +01003704 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003705 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003706 };
mohammad16035955c982018-04-26 00:53:03 +03003707
Ronald Cronde822812021-03-17 16:08:20 +01003708 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003709 &attributes, slot->key.data, slot->key.bytes,
3710 alg,
3711 nonce, nonce_length,
3712 additional_data, additional_data_length,
3713 plaintext, plaintext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003714 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02003715
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003716 if (status != PSA_SUCCESS && ciphertext_size != 0) {
3717 memset(ciphertext, 0, ciphertext_size);
3718 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003719
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003720 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03003721
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003722 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02003723}
3724
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003725psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
3726 psa_algorithm_t alg,
3727 const uint8_t *nonce,
3728 size_t nonce_length,
3729 const uint8_t *additional_data,
3730 size_t additional_data_length,
3731 const uint8_t *ciphertext,
3732 size_t ciphertext_length,
3733 uint8_t *plaintext,
3734 size_t plaintext_size,
3735 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03003736{
Ronald Cron215633c2021-03-16 17:15:37 +01003737 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3738 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003739
Gilles Peskineee652a32018-06-01 19:23:52 +02003740 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003741
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003742 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3743 return PSA_ERROR_NOT_SUPPORTED;
3744 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003745
Ronald Cron9a986162021-03-26 12:40:07 +01003746 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003747 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3748 if (status != PSA_SUCCESS) {
3749 return status;
3750 }
mohammad16035955c982018-04-26 00:53:03 +03003751
Ronald Cron215633c2021-03-16 17:15:37 +01003752 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003753 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003754 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003755
Ronald Cronde822812021-03-17 16:08:20 +01003756 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003757 &attributes, slot->key.data, slot->key.bytes,
3758 alg,
3759 nonce, nonce_length,
3760 additional_data, additional_data_length,
3761 ciphertext, ciphertext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003762 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02003763
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003764 if (status != PSA_SUCCESS && plaintext_size != 0) {
3765 memset(plaintext, 0, plaintext_size);
3766 }
mohammad160360a64d02018-06-03 17:20:42 +03003767
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003768 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01003769
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003770 return status;
mohammad16035955c982018-04-26 00:53:03 +03003771}
3772
Gilles Peskinee59236f2018-01-27 23:32:46 +01003773/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003774/* Generators */
3775/****************************************************************/
3776
John Durkop07cc04a2020-11-16 22:08:34 -08003777#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3778 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3779 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3780#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003781#endif /* At least one builtin KDF */
3782
3783#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3784 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3785 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3786static psa_status_t psa_key_derivation_start_hmac(
3787 psa_mac_operation_t *operation,
3788 psa_algorithm_t hash_alg,
3789 const uint8_t *hmac_key,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003790 size_t hmac_key_length)
Steven Cooreman9878a162021-05-06 17:58:36 +02003791{
3792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3793 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003794 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
3795 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
3796 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman9878a162021-05-06 17:58:36 +02003797
Steven Cooreman15f0d922021-05-07 14:14:37 +02003798 operation->is_sign = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003799 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman15f0d922021-05-07 14:14:37 +02003800
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003801 status = psa_driver_wrapper_mac_sign_setup(operation,
3802 &attributes,
3803 hmac_key, hmac_key_length,
3804 PSA_ALG_HMAC(hash_alg));
Steven Cooreman9878a162021-05-06 17:58:36 +02003805
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003806 psa_reset_key_attributes(&attributes);
3807 return status;
Steven Cooreman9878a162021-05-06 17:58:36 +02003808}
3809#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003810
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003811#define HKDF_STATE_INIT 0 /* no input yet */
3812#define HKDF_STATE_STARTED 1 /* got salt */
3813#define HKDF_STATE_KEYED 2 /* got key */
3814#define HKDF_STATE_OUTPUT 3 /* output started */
3815
Gilles Peskinecbe66502019-05-16 16:59:18 +02003816static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003817 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003818{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003819 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
3820 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
3821 } else {
3822 return operation->alg;
3823 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01003824}
3825
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003826psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02003827{
3828 psa_status_t status = PSA_SUCCESS;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003829 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
3830 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02003831 /* The object has (apparently) been initialized but it is not
3832 * in use. It's ok to call abort on such an object, and there's
3833 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003834 } else
John Durkopd0321952020-10-29 21:37:36 -07003835#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003836 if (PSA_ALG_IS_HKDF(kdf_alg)) {
3837 mbedtls_free(operation->ctx.hkdf.info);
3838 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
3839 } else
John Durkop07cc04a2020-11-16 22:08:34 -08003840#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3841#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3842 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003843 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
3844 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
3845 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
3846 if (operation->ctx.tls12_prf.secret != NULL) {
3847 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
3848 operation->ctx.tls12_prf.secret_length);
3849 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003850 }
3851
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003852 if (operation->ctx.tls12_prf.seed != NULL) {
3853 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
3854 operation->ctx.tls12_prf.seed_length);
3855 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01003856 }
3857
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003858 if (operation->ctx.tls12_prf.label != NULL) {
3859 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
3860 operation->ctx.tls12_prf.label_length);
3861 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01003862 }
3863
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003864 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003865
3866 /* We leave the fields Ai and output_block to be erased safely by the
3867 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003868 } else
John Durkop07cc04a2020-11-16 22:08:34 -08003869#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3870 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003871 {
3872 status = PSA_ERROR_BAD_STATE;
3873 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003874 mbedtls_platform_zeroize(operation, sizeof(*operation));
3875 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003876}
3877
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003878psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003879 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02003880{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003881 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003882 /* This is a blank key derivation operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003883 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003884 }
3885
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003886 *capacity = operation->capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003887 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003888}
3889
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003890psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
3891 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003892{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003893 if (operation->alg == 0) {
3894 return PSA_ERROR_BAD_STATE;
3895 }
3896 if (capacity > operation->capacity) {
3897 return PSA_ERROR_INVALID_ARGUMENT;
3898 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003899 operation->capacity = capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003900 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003901}
3902
John Durkopd0321952020-10-29 21:37:36 -07003903#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003905 * of the expand phase of the HKDF algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003906static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
3907 psa_algorithm_t hash_alg,
3908 uint8_t *output,
3909 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02003910{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003911 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremanb27e3502021-04-29 19:11:25 +02003912 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003913 psa_status_t status;
3914
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003915 if (hkdf->state < HKDF_STATE_KEYED || !hkdf->info_set) {
3916 return PSA_ERROR_BAD_STATE;
3917 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003918 hkdf->state = HKDF_STATE_OUTPUT;
3919
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003920 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02003921 /* Copy what remains of the current block */
3922 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003923 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02003924 n = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003925 }
3926 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02003927 output += n;
3928 output_length -= n;
3929 hkdf->offset_in_block += n;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003930 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02003931 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003932 }
Gilles Peskined54931c2018-07-17 21:06:59 +02003933 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003934 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003935 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003936 * object was corrupted or if this function is called directly
3937 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003938 if (hkdf->block_number == 0xff) {
3939 return PSA_ERROR_BAD_STATE;
3940 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003941
3942 /* We need a new block */
3943 ++hkdf->block_number;
3944 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02003945
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003946 status = psa_key_derivation_start_hmac(&hkdf->hmac,
3947 hash_alg,
3948 hkdf->prk,
3949 hash_length);
3950 if (status != PSA_SUCCESS) {
3951 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003952 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003953
3954 if (hkdf->block_number != 1) {
3955 status = psa_mac_update(&hkdf->hmac,
3956 hkdf->output_block,
3957 hash_length);
3958 if (status != PSA_SUCCESS) {
3959 return status;
3960 }
3961 }
3962 status = psa_mac_update(&hkdf->hmac,
3963 hkdf->info,
3964 hkdf->info_length);
3965 if (status != PSA_SUCCESS) {
3966 return status;
3967 }
3968 status = psa_mac_update(&hkdf->hmac,
3969 &hkdf->block_number, 1);
3970 if (status != PSA_SUCCESS) {
3971 return status;
3972 }
3973 status = psa_mac_sign_finish(&hkdf->hmac,
3974 hkdf->output_block,
3975 sizeof(hkdf->output_block),
3976 &hmac_output_length);
3977 if (status != PSA_SUCCESS) {
3978 return status;
3979 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003980 }
3981
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003982 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003983}
John Durkop07cc04a2020-11-16 22:08:34 -08003984#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003985
John Durkop07cc04a2020-11-16 22:08:34 -08003986#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3987 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003988static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3989 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003990 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01003991{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003992 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
3993 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003994 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3995 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003996 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003997
Janos Follath7742fee2019-06-17 12:58:10 +01003998 /* We can't be wanting more output after block 0xff, otherwise
3999 * the capacity check in psa_key_derivation_output_bytes() would have
4000 * prevented this call. It could happen only if the operation
4001 * object was corrupted or if this function is called directly
4002 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004003 if (tls12_prf->block_number == 0xff) {
4004 return PSA_ERROR_CORRUPTION_DETECTED;
4005 }
Janos Follath7742fee2019-06-17 12:58:10 +01004006
4007 /* We need a new block */
4008 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004009 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004010
4011 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4012 *
4013 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4014 *
4015 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4016 * HMAC_hash(secret, A(2) + seed) +
4017 * HMAC_hash(secret, A(3) + seed) + ...
4018 *
4019 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004020 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004021 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004022 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004023 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004024 * is currently extracted as `output_block` and where i is
4025 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004026 */
4027
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004028 status = psa_key_derivation_start_hmac(&hmac,
4029 hash_alg,
4030 tls12_prf->secret,
4031 tls12_prf->secret_length);
4032 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004033 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004034 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004035
4036 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004037 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004038 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4039 * the variable seed and in this instance means it in the context of the
4040 * P_hash function, where seed = label + seed.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004041 status = psa_mac_update(&hmac,
4042 tls12_prf->label,
4043 tls12_prf->label_length);
4044 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004045 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004046 }
4047 status = psa_mac_update(&hmac,
4048 tls12_prf->seed,
4049 tls12_prf->seed_length);
4050 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004051 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004052 }
4053 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01004054 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004055 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4056 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004057 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004058 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004059 }
4060
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004061 status = psa_mac_sign_finish(&hmac,
4062 tls12_prf->Ai, hash_length,
4063 &hmac_output_length);
4064 if (hmac_output_length != hash_length) {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004065 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004066 }
4067 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004068 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004069 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004070
4071 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004072 status = psa_key_derivation_start_hmac(&hmac,
4073 hash_alg,
4074 tls12_prf->secret,
4075 tls12_prf->secret_length);
4076 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004077 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004078 }
4079 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4080 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004081 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004082 }
4083 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
4084 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004085 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004086 }
4087 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
4088 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004089 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004090 }
4091 status = psa_mac_sign_finish(&hmac,
4092 tls12_prf->output_block, hash_length,
4093 &hmac_output_length);
4094 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004095 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004096 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004097
Janos Follath7742fee2019-06-17 12:58:10 +01004098
4099cleanup:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004100 cleanup_status = psa_mac_abort(&hmac);
4101 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004102 status = cleanup_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004103 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004104
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004105 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01004106}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004107
Janos Follath844eb0e2019-06-19 12:10:49 +01004108static psa_status_t psa_key_derivation_tls12_prf_read(
4109 psa_tls12_prf_key_derivation_t *tls12_prf,
4110 psa_algorithm_t alg,
4111 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004112 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01004113{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004114 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
4115 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01004116 psa_status_t status;
4117 uint8_t offset, length;
4118
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004119 switch (tls12_prf->state) {
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004120 case PSA_TLS12_PRF_STATE_LABEL_SET:
4121 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4122 break;
4123 case PSA_TLS12_PRF_STATE_OUTPUT:
4124 break;
4125 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004126 return PSA_ERROR_BAD_STATE;
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004127 }
4128
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004129 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004130 /* Check if we have fully processed the current block. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004131 if (tls12_prf->left_in_block == 0) {
4132 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
4133 alg);
4134 if (status != PSA_SUCCESS) {
4135 return status;
4136 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004137
4138 continue;
4139 }
4140
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004141 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004142 length = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004143 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01004144 length = tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004145 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004146
4147 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004148 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01004149 output += length;
4150 output_length -= length;
4151 tls12_prf->left_in_block -= length;
4152 }
4153
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004154 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01004155}
John Durkop07cc04a2020-11-16 22:08:34 -08004156#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4157 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004158
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004159psa_status_t psa_key_derivation_output_bytes(
4160 psa_key_derivation_operation_t *operation,
4161 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004162 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004163{
4164 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004165 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004166
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004167 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004168 /* This is a blank operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004169 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004170 }
4171
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004172 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004173 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004174 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004175 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004176 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004177 goto exit;
4178 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004179 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004180 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004181 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004182 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4183 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004184 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004185 * output_length > 0. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004186 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004187 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004188 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004189
John Durkopd0321952020-10-29 21:37:36 -07004190#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004191 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4192 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4193 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, hash_alg,
4194 output, output_length);
4195 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004196#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4197#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4198 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004199 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4200 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4201 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
4202 kdf_alg, output,
4203 output_length);
4204 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004205#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4206 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004207 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004208 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004209 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004210 }
4211
4212exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004213 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004214 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004215 * This allows us to differentiate between exhausted operations and
4216 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4217 * operations. */
4218 psa_algorithm_t alg = operation->alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004219 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004220 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004221 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004222 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004223 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004224}
4225
David Brown7807bf72021-02-09 16:28:23 -07004226#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004227static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02004228{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004229 if (data_size >= 8) {
4230 mbedtls_des_key_set_parity(data);
4231 }
4232 if (data_size >= 16) {
4233 mbedtls_des_key_set_parity(data + 8);
4234 }
4235 if (data_size >= 24) {
4236 mbedtls_des_key_set_parity(data + 16);
4237 }
Gilles Peskine08542d82018-07-19 17:05:42 +02004238}
David Brown7807bf72021-02-09 16:28:23 -07004239#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004240
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004241static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004242 psa_key_slot_t *slot,
4243 size_t bits,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004244 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004245{
4246 uint8_t *data = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004247 size_t bytes = PSA_BITS_TO_BYTES(bits);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004248 psa_status_t status;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004249 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004250
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004251 if (!key_type_is_raw_bytes(slot->attr.type)) {
4252 return PSA_ERROR_INVALID_ARGUMENT;
4253 }
4254 if (bits % 8 != 0) {
4255 return PSA_ERROR_INVALID_ARGUMENT;
4256 }
4257 data = mbedtls_calloc(1, bytes);
4258 if (data == NULL) {
4259 return PSA_ERROR_INSUFFICIENT_MEMORY;
4260 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004261
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004262 status = psa_key_derivation_output_bytes(operation, data, bytes);
4263 if (status != PSA_SUCCESS) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004264 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004265 }
David Brown12ca5032021-02-11 11:02:00 -07004266#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004267 if (slot->attr.type == PSA_KEY_TYPE_DES) {
4268 psa_des_set_key_parity(data, bytes);
4269 }
David Brown8107e312021-02-12 08:08:46 -07004270#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004271
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004272 status = psa_allocate_buffer_to_slot(slot, bytes);
4273 if (status != PSA_SUCCESS) {
Paul Elliottda3e7db2021-02-09 18:58:20 +00004274 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004275 }
Ronald Crondd04d422020-11-28 15:14:42 +01004276
Ronald Cronbf33c932020-11-28 18:06:53 +01004277 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004278 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004279 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004280 };
4281
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004282 status = psa_driver_wrapper_import_key(&attributes,
4283 data, bytes,
4284 slot->key.data,
4285 slot->key.bytes,
4286 &slot->key.bytes, &bits);
4287 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01004288 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004289 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004290
4291exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004292 mbedtls_free(data);
4293 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004294}
4295
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004296psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
4297 psa_key_derivation_operation_t *operation,
4298 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004299{
4300 psa_status_t status;
4301 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004302 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004303
Ronald Cron81709fc2020-11-14 12:10:32 +01004304 *key = MBEDTLS_SVC_KEY_ID_INIT;
4305
Gilles Peskine0f84d622019-09-12 19:03:13 +02004306 /* Reject any attempt to create a zero-length key so that we don't
4307 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004308 if (psa_get_key_bits(attributes) == 0) {
4309 return PSA_ERROR_INVALID_ARGUMENT;
4310 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02004311
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004312 if (operation->alg == PSA_ALG_NONE) {
4313 return PSA_ERROR_BAD_STATE;
4314 }
Dave Rodgman021e7242021-11-16 10:32:48 +00004315
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004316 if (!operation->can_output_key) {
4317 return PSA_ERROR_NOT_PERMITTED;
4318 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004319
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004320 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
4321 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004322#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004323 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004324 /* Deriving a key in a secure element is not implemented yet. */
4325 status = PSA_ERROR_NOT_SUPPORTED;
4326 }
4327#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004328 if (status == PSA_SUCCESS) {
4329 status = psa_generate_derived_key_internal(slot,
4330 attributes->core.bits,
4331 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004332 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004333 if (status == PSA_SUCCESS) {
4334 status = psa_finish_key_creation(slot, driver, key);
4335 }
4336 if (status != PSA_SUCCESS) {
4337 psa_fail_key_creation(slot, driver);
4338 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004339
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004340 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004341}
4342
Gilles Peskineeab56e42018-07-12 17:12:33 +02004343
4344
4345/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004346/* Key derivation */
4347/****************************************************************/
4348
Steven Cooreman932ffb72021-02-15 12:14:32 +01004349#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004350static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskinecdacf042021-04-29 21:10:00 +02004351{
4352#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004353 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4354 return 1;
4355 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004356#endif
4357#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004358 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4359 return 1;
4360 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004361#endif
4362#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004363 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4364 return 1;
4365 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004366#endif
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004367 return 0;
Gilles Peskinecdacf042021-04-29 21:10:00 +02004368}
4369
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004370static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004371{
4372 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004373 psa_status_t status = psa_hash_setup(&operation, alg);
4374 psa_hash_abort(&operation);
4375 return status;
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004376}
4377
Kusumit Ghoderaobfa27e32024-02-02 16:32:55 +05304378static psa_status_t psa_key_derivation_set_maximum_capacity(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004379 psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004380 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004381{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004382 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4383 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
4384 if (hash_size == 0) {
4385 return PSA_ERROR_NOT_SUPPORTED;
4386 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004387
4388 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
4389 * we might fail later, which is somewhat unfriendly and potentially
4390 * risk-prone. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004391 psa_status_t status = psa_hash_try_support(hash_alg);
4392 if (status != PSA_SUCCESS) {
4393 return status;
4394 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004395
Kusumit Ghoderaobfa27e32024-02-02 16:32:55 +05304396#if defined(PSA_WANT_ALG_HKDF)
4397 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4398 operation->capacity = 255 * hash_size;
4399 } else
4400#endif
4401#if defined(PSA_WANT_ALG_TLS12_PRF)
4402 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
4403 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
4404 operation->capacity = SIZE_MAX;
4405 } else
4406#endif
4407#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
4408 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
4409 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
4410 /* Master Secret is always 48 bytes
4411 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
4412 operation->capacity = 48U;
4413 } else
4414#endif
4415 {
4416 (void) hash_size;
4417 status = PSA_ERROR_NOT_SUPPORTED;
4418 }
4419 return status;
4420}
4421
4422
4423static psa_status_t psa_key_derivation_setup_kdf(
4424 psa_key_derivation_operation_t *operation,
4425 psa_algorithm_t kdf_alg)
4426{
4427 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4428 * initialisers for this union leave some bytes unspecified.) */
4429 memset(&operation->ctx, 0, sizeof(operation->ctx));
4430 /* Make sure that kdf_alg is a supported key derivation algorithm. */
4431 if (!is_kdf_alg_supported(kdf_alg)) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004432 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004433 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004434
Kusumit Ghoderaobfa27e32024-02-02 16:32:55 +05304435 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
4436 kdf_alg);
4437 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004438}
Gilles Peskine739c98c2021-04-29 21:34:33 +02004439
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004440static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine739c98c2021-04-29 21:34:33 +02004441{
4442#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004443 if (alg == PSA_ALG_ECDH) {
4444 return PSA_SUCCESS;
4445 }
Gilles Peskine739c98c2021-04-29 21:34:33 +02004446#endif
4447 (void) alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004448 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine739c98c2021-04-29 21:34:33 +02004449}
John Durkop07cc04a2020-11-16 22:08:34 -08004450#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004451
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004452psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
4453 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004454{
4455 psa_status_t status;
4456
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004457 if (operation->alg != 0) {
4458 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004459 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004460
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004461 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
4462 return PSA_ERROR_INVALID_ARGUMENT;
4463 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
4464#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4465 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
4466 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
4467 status = psa_key_agreement_try_support(ka_alg);
4468 if (status != PSA_SUCCESS) {
4469 return status;
4470 }
4471 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
4472#else
4473 return PSA_ERROR_NOT_SUPPORTED;
4474#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4475 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
4476#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4477 status = psa_key_derivation_setup_kdf(operation, alg);
4478#else
4479 return PSA_ERROR_NOT_SUPPORTED;
4480#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4481 } else {
4482 return PSA_ERROR_INVALID_ARGUMENT;
4483 }
4484
4485 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004486 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004487 }
4488 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004489}
4490
John Durkopd0321952020-10-29 21:37:36 -07004491#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004492static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
4493 psa_algorithm_t hash_alg,
4494 psa_key_derivation_step_t step,
4495 const uint8_t *data,
4496 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004497{
4498 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004499 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02004500 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004501 if (hkdf->state != HKDF_STATE_INIT) {
4502 return PSA_ERROR_BAD_STATE;
4503 } else {
4504 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4505 hash_alg,
4506 data, data_length);
4507 if (status != PSA_SUCCESS) {
4508 return status;
4509 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02004510 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004511 return PSA_SUCCESS;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004512 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004513 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004514 /* If no salt was provided, use an empty salt. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004515 if (hkdf->state == HKDF_STATE_INIT) {
4516 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4517 hash_alg,
4518 NULL, 0);
4519 if (status != PSA_SUCCESS) {
4520 return status;
4521 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004522 hkdf->state = HKDF_STATE_STARTED;
4523 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004524 if (hkdf->state != HKDF_STATE_STARTED) {
4525 return PSA_ERROR_BAD_STATE;
4526 }
4527 status = psa_mac_update(&hkdf->hmac,
4528 data, data_length);
4529 if (status != PSA_SUCCESS) {
4530 return status;
4531 }
4532 status = psa_mac_sign_finish(&hkdf->hmac,
4533 hkdf->prk,
4534 sizeof(hkdf->prk),
4535 &data_length);
4536 if (status != PSA_SUCCESS) {
4537 return status;
4538 }
4539 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Gilles Peskine2b522db2019-04-12 15:11:49 +02004540 hkdf->block_number = 0;
4541 hkdf->state = HKDF_STATE_KEYED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004542 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02004543 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004544 if (hkdf->state == HKDF_STATE_OUTPUT) {
4545 return PSA_ERROR_BAD_STATE;
4546 }
4547 if (hkdf->info_set) {
4548 return PSA_ERROR_BAD_STATE;
4549 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004550 hkdf->info_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004551 if (data_length != 0) {
4552 hkdf->info = mbedtls_calloc(1, data_length);
4553 if (hkdf->info == NULL) {
4554 return PSA_ERROR_INSUFFICIENT_MEMORY;
4555 }
4556 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004557 }
4558 hkdf->info_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004559 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004560 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004561 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004562 }
4563}
John Durkop07cc04a2020-11-16 22:08:34 -08004564#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004565
John Durkop07cc04a2020-11-16 22:08:34 -08004566#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4567 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004568static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
4569 const uint8_t *data,
4570 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01004571{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004572 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
4573 return PSA_ERROR_BAD_STATE;
4574 }
Janos Follathf08e2652019-06-13 09:05:41 +01004575
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004576 if (data_length != 0) {
4577 prf->seed = mbedtls_calloc(1, data_length);
4578 if (prf->seed == NULL) {
4579 return PSA_ERROR_INSUFFICIENT_MEMORY;
4580 }
Janos Follathf08e2652019-06-13 09:05:41 +01004581
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004582 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004583 prf->seed_length = data_length;
4584 }
Janos Follathf08e2652019-06-13 09:05:41 +01004585
Gilles Peskine43f958b2020-12-13 14:55:14 +01004586 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004587
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004588 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01004589}
4590
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004591static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
4592 const uint8_t *data,
4593 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01004594{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004595 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
4596 return PSA_ERROR_BAD_STATE;
4597 }
Janos Follath81550542019-06-13 14:26:34 +01004598
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004599 if (data_length != 0) {
4600 prf->secret = mbedtls_calloc(1, data_length);
4601 if (prf->secret == NULL) {
4602 return PSA_ERROR_INSUFFICIENT_MEMORY;
4603 }
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004604
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004605 memcpy(prf->secret, data, data_length);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004606 prf->secret_length = data_length;
4607 }
Janos Follath81550542019-06-13 14:26:34 +01004608
Gilles Peskine43f958b2020-12-13 14:55:14 +01004609 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004610
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004611 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01004612}
4613
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004614static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
4615 const uint8_t *data,
4616 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01004617{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004618 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
4619 return PSA_ERROR_BAD_STATE;
4620 }
Janos Follath63028dd2019-06-13 09:15:47 +01004621
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004622 if (data_length != 0) {
4623 prf->label = mbedtls_calloc(1, data_length);
4624 if (prf->label == NULL) {
4625 return PSA_ERROR_INSUFFICIENT_MEMORY;
4626 }
Janos Follath63028dd2019-06-13 09:15:47 +01004627
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004628 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004629 prf->label_length = data_length;
4630 }
Janos Follath63028dd2019-06-13 09:15:47 +01004631
Gilles Peskine43f958b2020-12-13 14:55:14 +01004632 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004633
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004634 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01004635}
4636
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004637static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
4638 psa_key_derivation_step_t step,
4639 const uint8_t *data,
4640 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01004641{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004642 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01004643 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004644 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01004645 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004646 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01004647 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004648 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01004649 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004650 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01004651 }
4652}
John Durkop07cc04a2020-11-16 22:08:34 -08004653#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4654 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4655
4656#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4657static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4658 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004659 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004660 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08004661{
4662 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004663 uint8_t pms[4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE];
John Durkop07cc04a2020-11-16 22:08:34 -08004664 uint8_t *cur = pms;
4665
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004666 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
4667 return PSA_ERROR_INVALID_ARGUMENT;
4668 }
John Durkop07cc04a2020-11-16 22:08:34 -08004669
4670 /* Quoting RFC 4279, Section 2:
4671 *
4672 * The premaster secret is formed as follows: if the PSK is N octets
4673 * long, concatenate a uint16 with the value N, N zero octets, a second
4674 * uint16 with the value N, and the PSK itself.
4675 */
4676
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004677 *cur++ = MBEDTLS_BYTE_1(data_length);
4678 *cur++ = MBEDTLS_BYTE_0(data_length);
4679 memset(cur, 0, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004680 cur += data_length;
4681 *cur++ = pms[0];
4682 *cur++ = pms[1];
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004683 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004684 cur += data_length;
4685
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004686 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08004687
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004688 mbedtls_platform_zeroize(pms, sizeof(pms));
4689 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08004690}
Janos Follath6660f0e2019-06-17 08:44:03 +01004691
4692static psa_status_t psa_tls12_prf_psk_to_ms_input(
4693 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004694 psa_key_derivation_step_t step,
4695 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004696 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01004697{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004698 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
4699 return psa_tls12_prf_psk_to_ms_set_key(prf,
4700 data, data_length);
Janos Follath0c1ed842019-06-28 13:35:36 +01004701 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004702
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004703 return psa_tls12_prf_input(prf, step, data, data_length);
Janos Follath6660f0e2019-06-17 08:44:03 +01004704}
John Durkop07cc04a2020-11-16 22:08:34 -08004705#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004706
Gilles Peskineb8965192019-09-24 16:21:10 +02004707/** Check whether the given key type is acceptable for the given
4708 * input step of a key derivation.
4709 *
4710 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4711 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4712 * Both secret and non-secret inputs can alternatively have the type
4713 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4714 * that the input was passed as a buffer rather than via a key object.
4715 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004716static int psa_key_derivation_check_input_type(
4717 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004718 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02004719{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004720 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004721 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004722 if (key_type == PSA_KEY_TYPE_DERIVE) {
4723 return PSA_SUCCESS;
4724 }
4725 if (key_type == PSA_KEY_TYPE_NONE) {
4726 return PSA_SUCCESS;
4727 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004728 break;
4729 case PSA_KEY_DERIVATION_INPUT_LABEL:
4730 case PSA_KEY_DERIVATION_INPUT_SALT:
4731 case PSA_KEY_DERIVATION_INPUT_INFO:
4732 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004733 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
4734 return PSA_SUCCESS;
4735 }
4736 if (key_type == PSA_KEY_TYPE_NONE) {
4737 return PSA_SUCCESS;
4738 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004739 break;
4740 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004741 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02004742}
4743
Janos Follathb80a94e2019-06-12 15:54:46 +01004744static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004745 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004746 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004747 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004748 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004749 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004750{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004751 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004752 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004753
Waleed Elmelegy254cada2025-03-11 12:27:34 +00004754 if (kdf_alg == PSA_ALG_NONE) {
Waleed Elmelegye0148872025-03-03 15:01:38 +00004755 /* This is a blank or aborted operation. */
Waleed Elmelegyc8c89ed2025-03-03 12:35:28 +00004756 status = PSA_ERROR_BAD_STATE;
4757 goto exit;
4758 }
4759
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004760 status = psa_key_derivation_check_input_type(step, key_type);
4761 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004762 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004763 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004764
John Durkopd0321952020-10-29 21:37:36 -07004765#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004766 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4767 status = psa_hkdf_input(&operation->ctx.hkdf,
4768 PSA_ALG_HKDF_GET_HASH(kdf_alg),
4769 step, data, data_length);
4770 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004771#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4772#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004773 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4774 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
4775 step, data, data_length);
4776 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004777#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4778#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004779 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4780 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
4781 step, data, data_length);
4782 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004783#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004784 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004785 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004786 (void) data;
4787 (void) data_length;
4788 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004789 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004790 }
4791
Gilles Peskine224b0d62019-09-23 18:13:17 +02004792exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004793 if (status != PSA_SUCCESS) {
4794 psa_key_derivation_abort(operation);
4795 }
4796 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004797}
4798
Janos Follath51f4a0f2019-06-14 11:35:55 +01004799psa_status_t psa_key_derivation_input_bytes(
4800 psa_key_derivation_operation_t *operation,
4801 psa_key_derivation_step_t step,
4802 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004803 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004804{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004805 return psa_key_derivation_input_internal(operation, step,
4806 PSA_KEY_TYPE_NONE,
4807 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004808}
4809
Janos Follath51f4a0f2019-06-14 11:35:55 +01004810psa_status_t psa_key_derivation_input_key(
4811 psa_key_derivation_operation_t *operation,
4812 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004813 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004814{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004815 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004816 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004818
Ronald Cron5c522922020-11-14 16:35:34 +01004819 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004820 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
4821 if (status != PSA_SUCCESS) {
4822 psa_key_derivation_abort(operation);
4823 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02004824 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004825
4826 /* Passing a key object as a SECRET input unlocks the permission
4827 * to output to a key object. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004828 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004829 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004830 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004831
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004832 status = psa_key_derivation_input_internal(operation,
4833 step, slot->attr.type,
4834 slot->key.data,
4835 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004836
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004837 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004838
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004839 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004840}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004841
4842
4843
4844/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004845/* Key agreement */
4846/****************************************************************/
4847
John Durkop6ba40d12020-11-10 08:50:04 -08004848#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004849static psa_status_t psa_key_agreement_ecdh(const uint8_t *peer_key,
4850 size_t peer_key_length,
4851 const mbedtls_ecp_keypair *our_key,
4852 uint8_t *shared_secret,
4853 size_t shared_secret_size,
4854 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004855{
Steven Cooremand4867872020-08-05 16:31:39 +02004856 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004857 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004858 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004859 size_t bits = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004860 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa(our_key->grp.id, &bits);
4861 mbedtls_ecdh_init(&ecdh);
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004862
Ronald Cron90857082020-11-25 14:58:33 +01004863 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004864 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
4865 bits,
4866 peer_key,
4867 peer_key_length,
4868 &their_key);
4869 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004870 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004871 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004872
Jaeden Amero97271b32019-01-10 19:38:51 +00004873 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004874 mbedtls_ecdh_get_params(&ecdh, their_key, MBEDTLS_ECDH_THEIRS));
4875 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004876 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004877 }
Jaeden Amero97271b32019-01-10 19:38:51 +00004878 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004879 mbedtls_ecdh_get_params(&ecdh, our_key, MBEDTLS_ECDH_OURS));
4880 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004881 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004882 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004883
Jaeden Amero97271b32019-01-10 19:38:51 +00004884 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004885 mbedtls_ecdh_calc_secret(&ecdh,
4886 shared_secret_length,
4887 shared_secret, shared_secret_size,
4888 mbedtls_psa_get_random,
4889 MBEDTLS_PSA_RANDOM_STATE));
4890 if (status != PSA_SUCCESS) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004891 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004892 }
4893 if (PSA_BITS_TO_BYTES(bits) != *shared_secret_length) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004894 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004895 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004896
4897exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004898 if (status != PSA_SUCCESS) {
4899 mbedtls_platform_zeroize(shared_secret, shared_secret_size);
4900 }
4901 mbedtls_ecdh_free(&ecdh);
4902 mbedtls_ecp_keypair_free(their_key);
4903 mbedtls_free(their_key);
Steven Cooremana2371e52020-07-28 14:30:39 +02004904
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004905 return status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004906}
John Durkop6ba40d12020-11-10 08:50:04 -08004907#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004908
Gilles Peskine01d718c2018-09-18 12:01:02 +02004909#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4910
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004911static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
4912 psa_key_slot_t *private_key,
4913 const uint8_t *peer_key,
4914 size_t peer_key_length,
4915 uint8_t *shared_secret,
4916 size_t shared_secret_size,
4917 size_t *shared_secret_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02004918{
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004919 mbedtls_ecp_keypair *ecp = NULL;
4920 psa_status_t status;
Agathiyan Bragadeeshe7eb8052023-07-31 16:16:38 +01004921
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004922 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08004923#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004924 case PSA_ALG_ECDH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004925 if (!PSA_KEY_TYPE_IS_ECC_KEY_PAIR(private_key->attr.type)) {
4926 return PSA_ERROR_INVALID_ARGUMENT;
4927 }
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004928 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004929 private_key->attr.type,
4930 private_key->attr.bits,
4931 private_key->key.data,
4932 private_key->key.bytes,
4933 &ecp);
4934 if (status != PSA_SUCCESS) {
4935 return status;
4936 }
4937 status = psa_key_agreement_ecdh(peer_key, peer_key_length,
4938 ecp,
4939 shared_secret, shared_secret_size,
4940 shared_secret_length);
4941 mbedtls_ecp_keypair_free(ecp);
4942 mbedtls_free(ecp);
4943 return status;
John Durkop6ba40d12020-11-10 08:50:04 -08004944#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004945 default:
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004946 (void) ecp;
4947 (void) status;
Gilles Peskine93f85002018-11-16 16:43:31 +01004948 (void) private_key;
4949 (void) peer_key;
4950 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004951 (void) shared_secret;
4952 (void) shared_secret_size;
4953 (void) shared_secret_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004954 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004955 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004956}
4957
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004958/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004959 * to potentially free embedded data structures and wipe confidential data.
4960 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004961static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
4962 psa_key_derivation_step_t step,
4963 psa_key_slot_t *private_key,
4964 const uint8_t *peer_key,
4965 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02004966{
4967 psa_status_t status;
4968 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4969 size_t shared_secret_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004970 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02004971
4972 /* Step 1: run the secret agreement algorithm to generate the shared
4973 * secret. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004974 status = psa_key_agreement_raw_internal(ka_alg,
4975 private_key,
4976 peer_key, peer_key_length,
4977 shared_secret,
4978 sizeof(shared_secret),
4979 &shared_secret_length);
4980 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02004981 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004982 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02004983
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004984 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004985 * the shared secret. A shared secret is permitted wherever a key
4986 * of type DERIVE is permitted. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004987 status = psa_key_derivation_input_internal(operation, step,
4988 PSA_KEY_TYPE_DERIVE,
4989 shared_secret,
4990 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02004991exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004992 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
4993 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02004994}
4995
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004996psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
4997 psa_key_derivation_step_t step,
4998 mbedtls_svc_key_id_t private_key,
4999 const uint8_t *peer_key,
5000 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02005001{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005003 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005004 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005005
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005006 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5007 return PSA_ERROR_INVALID_ARGUMENT;
5008 }
Ronald Cron5c522922020-11-14 16:35:34 +01005009 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005010 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
5011 if (status != PSA_SUCCESS) {
5012 return status;
5013 }
5014 status = psa_key_agreement_internal(operation, step,
5015 slot,
5016 peer_key, peer_key_length);
5017 if (status != PSA_SUCCESS) {
5018 psa_key_derivation_abort(operation);
5019 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005020 /* If a private key has been added as SECRET, we allow the derived
5021 * key material to be used as a key in PSA Crypto. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005022 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005023 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005024 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005025 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005026
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005027 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005028
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005029 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005030}
5031
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005032psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
5033 mbedtls_svc_key_id_t private_key,
5034 const uint8_t *peer_key,
5035 size_t peer_key_length,
5036 uint8_t *output,
5037 size_t output_size,
5038 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005039{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005040 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005041 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005042 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005043 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005044
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005045 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005046 status = PSA_ERROR_INVALID_ARGUMENT;
5047 goto exit;
5048 }
Ronald Cron5c522922020-11-14 16:35:34 +01005049 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005050 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
5051 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005052 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005053 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005054
Gilles Peskine42313fb2022-04-14 00:17:15 +02005055 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5056 * for the output size. The PSA specification only guarantees that this
5057 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5058 * but it might be nice to allow smaller buffers if the output fits.
5059 * At the time of writing this comment, with only ECDH implemented,
5060 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5061 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5062 * be exact for it as well. */
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005063 expected_length =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005064 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
5065 if (output_size < expected_length) {
Gilles Peskine42313fb2022-04-14 00:17:15 +02005066 status = PSA_ERROR_BUFFER_TOO_SMALL;
5067 goto exit;
5068 }
5069
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005070 status = psa_key_agreement_raw_internal(alg, slot,
5071 peer_key, peer_key_length,
5072 output, output_size,
5073 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005074
5075exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005076 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005077 /* If an error happens and is not handled properly, the output
5078 * may be used as a key to protect sensitive data. Arrange for such
5079 * a key to be random, which is likely to result in decryption or
5080 * verification errors. This is better than filling the buffer with
5081 * some constant data such as zeros, which would result in the data
5082 * being protected with a reproducible, easily knowable key.
5083 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005084 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005085 *output_length = output_size;
5086 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005087
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005088 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005089
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005090 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005091}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005092
5093
Gilles Peskine30524eb2020-11-13 17:02:26 +01005094
Gilles Peskine86a440b2018-11-12 18:39:40 +01005095/****************************************************************/
5096/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005097/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005098
Gilles Peskine9a9d5ee2023-04-28 21:00:28 +02005099#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5100#include "mbedtls/entropy_poll.h"
5101#endif
5102
Gilles Peskine30524eb2020-11-13 17:02:26 +01005103/** Initialize the PSA random generator.
5104 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005105static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005106{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005107#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005108 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005109#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5110
Gilles Peskine30524eb2020-11-13 17:02:26 +01005111 /* Set default configuration if
5112 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005113 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005114 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005115 }
5116 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005117 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005118 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005119
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005120 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005121#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5122 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5123 /* The PSA entropy injection feature depends on using NV seed as an entropy
5124 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005125 mbedtls_entropy_add_source(&rng->entropy,
5126 mbedtls_nv_seed_poll, NULL,
5127 MBEDTLS_ENTROPY_BLOCK_SIZE,
5128 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005129#endif
5130
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005131 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005132#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005133}
5134
5135/** Deinitialize the PSA random generator.
5136 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005137static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005138{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005139#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005140 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005141#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005142 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
5143 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005144#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005145}
5146
5147/** Seed the PSA random generator.
5148 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005149static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005150{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005151#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5152 /* Do nothing: the external RNG seeds itself. */
5153 (void) rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005154 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005155#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005156 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005157 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
5158 drbg_seed, sizeof(drbg_seed) - 1);
5159 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005160#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005161}
5162
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005163psa_status_t psa_generate_random(uint8_t *output,
5164 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005165{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005166 GUARD_MODULE_INITIALIZED;
5167
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005168#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5169
5170 size_t output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005171 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
5172 output, output_size,
5173 &output_length);
5174 if (status != PSA_SUCCESS) {
5175 return status;
5176 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005177 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00005178 * for the external RNG interface. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005179 if (output_length != output_size) {
5180 return PSA_ERROR_INSUFFICIENT_ENTROPY;
5181 }
5182 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005183
5184#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5185
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005186 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005187 size_t request_size =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005188 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5189 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5190 output_size);
5191 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
5192 output, request_size);
5193 if (ret != 0) {
5194 return mbedtls_to_psa_error(ret);
5195 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01005196 output_size -= request_size;
5197 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005198 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005199 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005200#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005201}
5202
Gilles Peskine8814fc42020-12-14 15:33:44 +01005203/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005204 *
5205 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5206 * `psa_generate_random(...)`. The state parameter is ignored since the
5207 * PSA API doesn't support passing an explicit state.
5208 *
5209 * In the non-external case, psa_generate_random() calls an
5210 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5211 * and semantics as mbedtls_psa_get_random(). As an optimization,
5212 * instead of doing this back-and-forth between the PSA API and the
5213 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5214 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005215 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005216#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5217int mbedtls_psa_get_random(void *p_rng,
5218 unsigned char *output,
5219 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01005220{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005221 /* This function takes a pointer to the RNG state because that's what
5222 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5223 * its own state internally and doesn't let the caller access that state.
5224 * So we just ignore the state parameter, and in practice we'll pass
5225 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005226 (void) p_rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005227 psa_status_t status = psa_generate_random(output, output_size);
5228 if (status == PSA_SUCCESS) {
5229 return 0;
5230 } else {
5231 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
5232 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01005233}
5234#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5235
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005236#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005237psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
5238 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005239{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005240 if (global_data.initialized) {
5241 return PSA_ERROR_NOT_PERMITTED;
5242 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005243
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005244 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
5245 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
5246 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
5247 return PSA_ERROR_INVALID_ARGUMENT;
5248 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005249
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005250 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005251}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005252#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005253
Ronald Cron3772afe2021-02-08 16:10:05 +01005254/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005255 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005256 * \param type The key type
5257 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005258 *
5259 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005260 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005261 * \retval #PSA_ERROR_INVALID_ARGUMENT
5262 * The size in bits of the key is not valid.
5263 * \retval #PSA_ERROR_NOT_SUPPORTED
5264 * The type and/or the size in bits of the key or the combination of
5265 * the two is not supported.
5266 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005267static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005268 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005269{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005271
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005272 if (key_type_is_raw_bytes(type)) {
5273 status = validate_unstructured_key_bit_size(type, bits);
5274 if (status != PSA_SUCCESS) {
5275 return status;
5276 }
5277 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005278#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005279 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5280 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
5281 return PSA_ERROR_NOT_SUPPORTED;
5282 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005283
Ronald Cron01b2aba2020-10-05 09:42:02 +02005284 /* Accept only byte-aligned keys, for the same reasons as
5285 * in psa_import_rsa_key(). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005286 if (bits % 8 != 0) {
5287 return PSA_ERROR_NOT_SUPPORTED;
5288 }
5289 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005290#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005291
Ronald Cron5c4d3862020-12-07 11:07:24 +01005292#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005293 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01005294 /* To avoid empty block, return successfully here. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005295 return PSA_SUCCESS;
5296 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005297#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005298 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005299 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005300 }
5301
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005302 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005303}
5304
Ronald Cron55ed0592020-10-05 10:30:40 +02005305psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005306 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005307 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005308{
5309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005310 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005311
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005312 if ((attributes->domain_parameters == NULL) &&
5313 (attributes->domain_parameters_size != 0)) {
5314 return PSA_ERROR_INVALID_ARGUMENT;
5315 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02005316
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005317 if (key_type_is_raw_bytes(type)) {
5318 status = psa_generate_random(key_buffer, key_buffer_size);
5319 if (status != PSA_SUCCESS) {
5320 return status;
5321 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005322
David Brown12ca5032021-02-11 11:02:00 -07005323#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005324 if (type == PSA_KEY_TYPE_DES) {
5325 psa_des_set_key_parity(key_buffer, key_buffer_size);
5326 }
David Brown8107e312021-02-12 08:08:46 -07005327#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005328 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01005329
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5331 defined(MBEDTLS_GENPRIME)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005332 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
5333 return mbedtls_psa_rsa_generate_key(attributes,
5334 key_buffer,
5335 key_buffer_size,
5336 key_buffer_length);
5337 } else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005338#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5339 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005340
John Durkop9814fa22020-11-04 12:28:15 -08005341#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005342 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5343 return mbedtls_psa_ecp_generate_key(attributes,
5344 key_buffer,
5345 key_buffer_size,
5346 key_buffer_length);
5347 } else
John Durkop9814fa22020-11-04 12:28:15 -08005348#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005349 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005350 (void) key_buffer_length;
5351 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02005352 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005353
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005354 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005355}
Darryl Green0c6575a2018-11-07 16:05:30 +00005356
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005357psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
5358 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005359{
5360 psa_status_t status;
5361 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005362 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005363 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005364
Ronald Cron81709fc2020-11-14 12:10:32 +01005365 *key = MBEDTLS_SVC_KEY_ID_INIT;
5366
Gilles Peskine0f84d622019-09-12 19:03:13 +02005367 /* Reject any attempt to create a zero-length key so that we don't
5368 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005369 if (psa_get_key_bits(attributes) == 0) {
5370 return PSA_ERROR_INVALID_ARGUMENT;
5371 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005372
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005373 /* Reject any attempt to create a public key. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005374 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
5375 return PSA_ERROR_INVALID_ARGUMENT;
5376 }
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005377
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005378 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
5379 &slot, &driver);
5380 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02005381 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005382 }
Gilles Peskine11792082019-08-06 18:36:36 +02005383
Ronald Cron977c2472020-10-13 08:32:21 +02005384 /* In the case of a transparent key or an opaque key stored in local
5385 * storage (thus not in the case of generating a key in a secure element
5386 * or cryptoprocessor with storage), we have to allocate a buffer to
5387 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005388 if (slot->key.data == NULL) {
5389 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
5390 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005391 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005392 attributes->core.type, attributes->core.bits);
5393 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005394 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005395 }
Ronald Cron3772afe2021-02-08 16:10:05 +01005396
5397 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005398 attributes->core.type,
5399 attributes->core.bits);
5400 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02005401 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005402 attributes, &key_buffer_size);
5403 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005404 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005405 }
Ronald Cron977c2472020-10-13 08:32:21 +02005406 }
Ronald Cron977c2472020-10-13 08:32:21 +02005407
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005408 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
5409 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02005410 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005411 }
Ronald Cron977c2472020-10-13 08:32:21 +02005412 }
5413
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005414 status = psa_driver_wrapper_generate_key(attributes,
5415 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02005416
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005417 if (status != PSA_SUCCESS) {
5418 psa_remove_key_data_from_memory(slot);
5419 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02005420
Gilles Peskine11792082019-08-06 18:36:36 +02005421exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005422 if (status == PSA_SUCCESS) {
5423 status = psa_finish_key_creation(slot, driver, key);
5424 }
5425 if (status != PSA_SUCCESS) {
5426 psa_fail_key_creation(slot, driver);
5427 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005428
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005429 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005430}
5431
Gilles Peskinee59236f2018-01-27 23:32:46 +01005432/****************************************************************/
5433/* Module setup */
5434/****************************************************************/
5435
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005436#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005437psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005438 void (* entropy_init)(mbedtls_entropy_context *ctx),
5439 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01005440{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005441 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5442 return PSA_ERROR_BAD_STATE;
5443 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005444 global_data.rng.entropy_init = entropy_init;
5445 global_data.rng.entropy_free = entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005446 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01005447}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005448#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005449
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005450void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005451{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005452 psa_wipe_all_key_slots();
5453 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5454 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005455 }
5456 /* Wipe all remaining data, including configuration.
5457 * In particular, this sets all state indicator to the value
5458 * indicating "uninitialized". */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005459 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron088d5d02021-04-10 16:57:30 +02005460
5461 /* Terminate drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005462 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01005463}
5464
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005465#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5466/** Recover a transaction that was interrupted by a power failure.
5467 *
5468 * This function is called during initialization, before psa_crypto_init()
5469 * returns. If this function returns a failure status, the initialization
5470 * fails.
5471 */
5472static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005473 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005474{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005475 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005476 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5477 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005478 /* TODO - fall through to the failure case until this
5479 * is implemented.
5480 * https://github.com/ARMmbed/mbed-crypto/issues/218
5481 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005482 default:
5483 /* We found an unsupported transaction in the storage.
5484 * We don't know what state the storage is in. Give up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005485 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005486 }
5487}
5488#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5489
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005490psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005491{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005492 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005493
Gilles Peskinec6b69072018-11-20 21:42:52 +01005494 /* Double initialization is explicitly allowed. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005495 if (global_data.initialized != 0) {
5496 return PSA_SUCCESS;
5497 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005498
Gilles Peskine30524eb2020-11-13 17:02:26 +01005499 /* Initialize and seed the random generator. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005500 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005501 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005502 status = mbedtls_psa_random_seed(&global_data.rng);
5503 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01005504 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005505 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005506 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005507
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005508 status = psa_initialize_key_slots();
5509 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01005510 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005511 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005512
Ronald Cron088d5d02021-04-10 16:57:30 +02005513 /* Init drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005514 status = psa_driver_wrapper_init();
5515 if (status != PSA_SUCCESS) {
Gilles Peskined9348f22019-10-01 15:22:29 +02005516 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005517 }
Gilles Peskined9348f22019-10-01 15:22:29 +02005518
Gilles Peskine4b734222019-07-24 15:56:31 +02005519#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005520 status = psa_crypto_load_transaction();
5521 if (status == PSA_SUCCESS) {
5522 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
5523 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005524 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005525 }
5526 status = psa_crypto_stop_transaction();
5527 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02005528 /* There's no transaction to complete. It's all good. */
5529 status = PSA_SUCCESS;
5530 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005531#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005532
Gilles Peskinec6b69072018-11-20 21:42:52 +01005533 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005534 global_data.initialized = 1;
5535
5536exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005537 if (status != PSA_SUCCESS) {
5538 mbedtls_psa_crypto_free();
5539 }
5540 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005541}
5542
5543#endif /* MBEDTLS_PSA_CRYPTO_C */