blob: ba9875fa92e036517b0bf958ab8aa78887bbacc5 [file] [log] [blame]
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001/**
2 * \file psa/crypto_struct.h
3 *
4 * \brief PSA cryptography module: Mbed TLS structured type implementations
Gilles Peskine07c91f52018-06-28 18:02:53 +02005 *
6 * \note This file may not be included directly. Applications must
7 * include psa/crypto.h.
8 *
9 * This file contains the definitions of some data structures with
10 * implementation-specific definitions.
11 *
12 * In implementations with isolation between the application and the
13 * cryptography module, it is expected that the front-end and the back-end
14 * would have different versions of this file.
Gilles Peskineb4e73e92019-08-13 15:00:57 +020015 *
16 * <h3>Design notes about multipart operation structures</h3>
17 *
Ronald Cron980230e2021-04-01 15:37:49 +020018 * For multipart operations without driver delegation support, each multipart
19 * operation structure contains a `psa_algorithm_t alg` field which indicates
20 * which specific algorithm the structure is for. When the structure is not in
21 * use, `alg` is 0. Most of the structure consists of a union which is
22 * discriminated by `alg`.
Gilles Peskineb4e73e92019-08-13 15:00:57 +020023 *
Ronald Cron980230e2021-04-01 15:37:49 +020024 * For multipart operations with driver delegation support, each multipart
25 * operation structure contains an `unsigned int id` field indicating which
26 * driver got assigned to do the operation. When the structure is not in use,
27 * 'id' is 0. The structure contains also a driver context which is the union
28 * of the contexts of all drivers able to handle the type of multipart
29 * operation.
30 *
31 * Note that when `alg` or `id` is 0, the content of other fields is undefined.
Gilles Peskineb4e73e92019-08-13 15:00:57 +020032 * In particular, it is not guaranteed that a freshly-initialized structure
33 * is all-zero: we initialize structures to something like `{0, 0}`, which
34 * is only guaranteed to initializes the first member of the union;
35 * GCC and Clang initialize the whole structure to 0 (at the time of writing),
36 * but MSVC and CompCert don't.
37 *
38 * In Mbed Crypto, multipart operation structures live independently from
39 * the key. This allows Mbed Crypto to free the key objects when destroying
40 * a key slot. If a multipart operation needs to remember the key after
41 * the setup function returns, the operation structure needs to contain a
42 * copy of the key.
Gilles Peskine9ef733f2018-02-07 21:05:37 +010043 */
44/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020045 * Copyright The Mbed TLS Contributors
Gilles Peskine9ef733f2018-02-07 21:05:37 +010046 * SPDX-License-Identifier: Apache-2.0
47 *
48 * Licensed under the Apache License, Version 2.0 (the "License"); you may
49 * not use this file except in compliance with the License.
50 * You may obtain a copy of the License at
51 *
52 * http://www.apache.org/licenses/LICENSE-2.0
53 *
54 * Unless required by applicable law or agreed to in writing, software
55 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
56 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
57 * See the License for the specific language governing permissions and
58 * limitations under the License.
Gilles Peskine9ef733f2018-02-07 21:05:37 +010059 */
60
61#ifndef PSA_CRYPTO_STRUCT_H
62#define PSA_CRYPTO_STRUCT_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020063#include "mbedtls/private_access.h"
Gilles Peskine9ef733f2018-02-07 21:05:37 +010064
Jaeden Amero8013f442019-08-16 16:13:51 +010065#ifdef __cplusplus
66extern "C" {
67#endif
68
Gilles Peskine9ef733f2018-02-07 21:05:37 +010069/* Include the Mbed TLS configuration file, the way Mbed TLS does it
70 * in each of its header files. */
Bence Szépkútic662b362021-05-27 11:25:03 +020071#include "mbedtls/build_info.h"
Gilles Peskine9ef733f2018-02-07 21:05:37 +010072
Steven Cooreman61398ec2021-04-26 12:04:53 +020073/* Include the context definition for the compiled-in drivers for the primitive
74 * algorithms. */
Steven Cooreman675501d2021-04-26 11:54:58 +020075#include "psa/crypto_driver_contexts_primitives.h"
Gilles Peskine9ef733f2018-02-07 21:05:37 +010076
Gilles Peskine449bd832023-01-11 14:50:10 +010077struct psa_hash_operation_s {
Steven Cooremandbf8ced2021-03-04 13:01:18 +010078 /** Unique ID indicating which driver got assigned to do the
79 * operation. Since driver contexts are driver-specific, swapping
80 * drivers halfway through the operation is not supported.
Ronald Cron980230e2021-04-01 15:37:49 +020081 * ID values are auto-generated in psa_driver_wrappers.h.
Steven Cooremandbf8ced2021-03-04 13:01:18 +010082 * ID value zero means the context is not valid or not assigned to
Ronald Cron980230e2021-04-01 15:37:49 +020083 * any driver (i.e. the driver context is not active, in use). */
Mateusz Starzyk846f0212021-05-19 19:44:07 +020084 unsigned int MBEDTLS_PRIVATE(id);
85 psa_driver_hash_context_t MBEDTLS_PRIVATE(ctx);
Gilles Peskine9ef733f2018-02-07 21:05:37 +010086};
87
Janos Follath33434a92021-05-26 09:25:33 +010088#define PSA_HASH_OPERATION_INIT { 0, { 0 } }
Gilles Peskine449bd832023-01-11 14:50:10 +010089static inline struct psa_hash_operation_s psa_hash_operation_init(void)
Jaeden Amero6a25b412019-01-04 11:47:44 +000090{
91 const struct psa_hash_operation_s v = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +010092 return v;
Jaeden Amero6a25b412019-01-04 11:47:44 +000093}
94
Gilles Peskine449bd832023-01-11 14:50:10 +010095struct psa_cipher_operation_s {
Steven Cooreman61398ec2021-04-26 12:04:53 +020096 /** Unique ID indicating which driver got assigned to do the
97 * operation. Since driver contexts are driver-specific, swapping
98 * drivers halfway through the operation is not supported.
99 * ID values are auto-generated in psa_crypto_driver_wrappers.h
100 * ID value zero means the context is not valid or not assigned to
101 * any driver (i.e. none of the driver contexts are active). */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200102 unsigned int MBEDTLS_PRIVATE(id);
Steven Cooreman61398ec2021-04-26 12:04:53 +0200103
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200104 unsigned int MBEDTLS_PRIVATE(iv_required) : 1;
105 unsigned int MBEDTLS_PRIVATE(iv_set) : 1;
Steven Cooreman61398ec2021-04-26 12:04:53 +0200106
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200107 uint8_t MBEDTLS_PRIVATE(default_iv_length);
Steven Cooreman61398ec2021-04-26 12:04:53 +0200108
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200109 psa_driver_cipher_context_t MBEDTLS_PRIVATE(ctx);
Steven Cooreman61398ec2021-04-26 12:04:53 +0200110};
111
Janos Follath33434a92021-05-26 09:25:33 +0100112#define PSA_CIPHER_OPERATION_INIT { 0, 0, 0, 0, { 0 } }
Gilles Peskine449bd832023-01-11 14:50:10 +0100113static inline struct psa_cipher_operation_s psa_cipher_operation_init(void)
Steven Cooreman61398ec2021-04-26 12:04:53 +0200114{
115 const struct psa_cipher_operation_s v = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100116 return v;
Steven Cooreman61398ec2021-04-26 12:04:53 +0200117}
118
Steven Cooreman3c8dd632021-04-26 12:16:27 +0200119/* Include the context definition for the compiled-in drivers for the composite
120 * algorithms. */
121#include "psa/crypto_driver_contexts_composites.h"
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +0300122
Gilles Peskine449bd832023-01-11 14:50:10 +0100123struct psa_mac_operation_s {
Steven Cooreman77e2cc52021-03-19 17:05:52 +0100124 /** Unique ID indicating which driver got assigned to do the
125 * operation. Since driver contexts are driver-specific, swapping
126 * drivers halfway through the operation is not supported.
127 * ID values are auto-generated in psa_driver_wrappers.h
128 * ID value zero means the context is not valid or not assigned to
129 * any driver (i.e. none of the driver contexts are active). */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200130 unsigned int MBEDTLS_PRIVATE(id);
131 uint8_t MBEDTLS_PRIVATE(mac_size);
132 unsigned int MBEDTLS_PRIVATE(is_sign) : 1;
133 psa_driver_mac_context_t MBEDTLS_PRIVATE(ctx);
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100134};
135
Janos Follath33434a92021-05-26 09:25:33 +0100136#define PSA_MAC_OPERATION_INIT { 0, 0, 0, { 0 } }
Gilles Peskine449bd832023-01-11 14:50:10 +0100137static inline struct psa_mac_operation_s psa_mac_operation_init(void)
Jaeden Amero769ce272019-01-04 11:48:03 +0000138{
139 const struct psa_mac_operation_s v = PSA_MAC_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 return v;
Jaeden Amero769ce272019-01-04 11:48:03 +0000141}
142
Gilles Peskine449bd832023-01-11 14:50:10 +0100143struct psa_aead_operation_s {
Paul Elliottadb8b162021-04-20 16:06:57 +0100144
Paul Elliott6504aa62021-04-20 17:09:36 +0100145 /** Unique ID indicating which driver got assigned to do the
146 * operation. Since driver contexts are driver-specific, swapping
147 * drivers halfway through the operation is not supported.
148 * ID values are auto-generated in psa_crypto_driver_wrappers.h
149 * ID value zero means the context is not valid or not assigned to
150 * any driver (i.e. none of the driver contexts are active). */
Paul Elliottc7e7fe52021-09-27 09:23:40 +0100151 unsigned int MBEDTLS_PRIVATE(id);
Paul Elliott6504aa62021-04-20 17:09:36 +0100152
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200153 psa_algorithm_t MBEDTLS_PRIVATE(alg);
Paul Elliott71b05672021-09-24 11:18:13 +0100154 psa_key_type_t MBEDTLS_PRIVATE(key_type);
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100155
Paul Elliott71b05672021-09-24 11:18:13 +0100156 size_t MBEDTLS_PRIVATE(ad_remaining);
157 size_t MBEDTLS_PRIVATE(body_remaining);
Paul Elliottee4ffe02021-05-20 17:25:06 +0100158
Paul Elliott71b05672021-09-24 11:18:13 +0100159 unsigned int MBEDTLS_PRIVATE(nonce_set) : 1;
160 unsigned int MBEDTLS_PRIVATE(lengths_set) : 1;
161 unsigned int MBEDTLS_PRIVATE(ad_started) : 1;
162 unsigned int MBEDTLS_PRIVATE(body_started) : 1;
163 unsigned int MBEDTLS_PRIVATE(is_encrypt) : 1;
Paul Elliott07a30c42021-04-20 14:13:23 +0100164
Paul Elliott71b05672021-09-24 11:18:13 +0100165 psa_driver_aead_context_t MBEDTLS_PRIVATE(ctx);
Gilles Peskine30a9e412019-01-14 18:36:12 +0100166};
167
Gilles Peskine449bd832023-01-11 14:50:10 +0100168#define PSA_AEAD_OPERATION_INIT { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, { 0 } }
169static inline struct psa_aead_operation_s psa_aead_operation_init(void)
Gilles Peskine30a9e412019-01-14 18:36:12 +0100170{
171 const struct psa_aead_operation_s v = PSA_AEAD_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 return v;
Gilles Peskine30a9e412019-01-14 18:36:12 +0100173}
174
Przemek Stekiel3e8249c2022-06-03 14:05:07 +0200175#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
176 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
177 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +0100178typedef struct {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200179 uint8_t *MBEDTLS_PRIVATE(info);
180 size_t MBEDTLS_PRIVATE(info_length);
Gilles Peskinebef7f142018-07-12 17:22:21 +0200181#if PSA_HASH_MAX_SIZE > 0xff
182#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
183#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200184 uint8_t MBEDTLS_PRIVATE(offset_in_block);
185 uint8_t MBEDTLS_PRIVATE(block_number);
186 unsigned int MBEDTLS_PRIVATE(state) : 2;
187 unsigned int MBEDTLS_PRIVATE(info_set) : 1;
Gilles Peskinee3d9c9d2021-11-08 22:12:47 +0100188 uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE];
189 uint8_t MBEDTLS_PRIVATE(prk)[PSA_HASH_MAX_SIZE];
190 struct psa_mac_operation_s MBEDTLS_PRIVATE(hmac);
Gilles Peskinecbe66502019-05-16 16:59:18 +0200191} psa_hkdf_key_derivation_t;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +0200192#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF ||
193 MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
194 MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400195#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100196typedef struct {
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400197 uint8_t MBEDTLS_PRIVATE(data)[PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE];
198} psa_tls12_ecjpake_to_pms_t;
199#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskinebef7f142018-07-12 17:22:21 +0200200
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200201#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
202 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100203typedef enum {
Przemek Stekielc4b814a2022-04-07 12:28:08 +0200204 PSA_TLS12_PRF_STATE_INIT, /* no input provided */
205 PSA_TLS12_PRF_STATE_SEED_SET, /* seed has been set */
206 PSA_TLS12_PRF_STATE_OTHER_KEY_SET, /* other key has been set - optional */
207 PSA_TLS12_PRF_STATE_KEY_SET, /* key has been set */
208 PSA_TLS12_PRF_STATE_LABEL_SET, /* label has been set */
209 PSA_TLS12_PRF_STATE_OUTPUT /* output has been started */
Janos Follath999f6482019-06-11 12:04:10 +0100210} psa_tls12_prf_key_derivation_state_t;
211
Gilles Peskine449bd832023-01-11 14:50:10 +0100212typedef struct psa_tls12_prf_key_derivation_s {
Janos Follath999f6482019-06-11 12:04:10 +0100213#if PSA_HASH_MAX_SIZE > 0xff
214#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
215#endif
216
217 /* Indicates how many bytes in the current HMAC block have
Janos Follath844eb0e2019-06-19 12:10:49 +0100218 * not yet been read by the user. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200219 uint8_t MBEDTLS_PRIVATE(left_in_block);
Janos Follath999f6482019-06-11 12:04:10 +0100220
221 /* The 1-based number of the block. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200222 uint8_t MBEDTLS_PRIVATE(block_number);
Janos Follath999f6482019-06-11 12:04:10 +0100223
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200224 psa_tls12_prf_key_derivation_state_t MBEDTLS_PRIVATE(state);
Janos Follath999f6482019-06-11 12:04:10 +0100225
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200226 uint8_t *MBEDTLS_PRIVATE(secret);
227 size_t MBEDTLS_PRIVATE(secret_length);
228 uint8_t *MBEDTLS_PRIVATE(seed);
229 size_t MBEDTLS_PRIVATE(seed_length);
230 uint8_t *MBEDTLS_PRIVATE(label);
231 size_t MBEDTLS_PRIVATE(label_length);
Przemek Stekiel7f1c89d2022-04-19 14:00:37 +0200232#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Przemek Stekielf4e8f012022-04-07 12:23:31 +0200233 uint8_t *MBEDTLS_PRIVATE(other_secret);
234 size_t MBEDTLS_PRIVATE(other_secret_length);
Przemek Stekiel7f1c89d2022-04-19 14:00:37 +0200235#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +0200236
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200237 uint8_t MBEDTLS_PRIVATE(Ai)[PSA_HASH_MAX_SIZE];
Janos Follath999f6482019-06-11 12:04:10 +0100238
Janos Follath33434a92021-05-26 09:25:33 +0100239 /* `HMAC_hash( prk, A( i ) + seed )` in the notation of RFC 5246, Sect. 5. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200240 uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE];
Janos Follath999f6482019-06-11 12:04:10 +0100241} psa_tls12_prf_key_derivation_t;
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200242#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
243 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Hanno Beckerc8a41d72018-10-09 17:33:01 +0100244
Gilles Peskine449bd832023-01-11 14:50:10 +0100245struct psa_key_derivation_s {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200246 psa_algorithm_t MBEDTLS_PRIVATE(alg);
247 unsigned int MBEDTLS_PRIVATE(can_output_key) : 1;
248 size_t MBEDTLS_PRIVATE(capacity);
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 union {
Janos Follathadbec812019-06-14 11:05:39 +0100250 /* Make the union non-empty even with no supported algorithms. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200251 uint8_t MBEDTLS_PRIVATE(dummy);
Przemek Stekiel3e8249c2022-06-03 14:05:07 +0200252#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
254 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200255 psa_hkdf_key_derivation_t MBEDTLS_PRIVATE(hkdf);
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200256#endif
257#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200259 psa_tls12_prf_key_derivation_t MBEDTLS_PRIVATE(tls12_prf);
Gilles Peskinebef7f142018-07-12 17:22:21 +0200260#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400261#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
262 psa_tls12_ecjpake_to_pms_t MBEDTLS_PRIVATE(tls12_ecjpake_to_pms);
263#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200264 } MBEDTLS_PRIVATE(ctx);
Gilles Peskineeab56e42018-07-12 17:12:33 +0200265};
266
Janos Follathadbec812019-06-14 11:05:39 +0100267/* This only zeroes out the first byte in the union, the rest is unspecified. */
Janos Follath33434a92021-05-26 09:25:33 +0100268#define PSA_KEY_DERIVATION_OPERATION_INIT { 0, 0, 0, { 0 } }
Janos Follath0dcda952021-06-07 14:52:13 +0100269static inline struct psa_key_derivation_s psa_key_derivation_operation_init(
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 void)
Gilles Peskineeab56e42018-07-12 17:12:33 +0200271{
Gilles Peskinecbe66502019-05-16 16:59:18 +0200272 const struct psa_key_derivation_s v = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return v;
Gilles Peskineeab56e42018-07-12 17:12:33 +0200274}
275
Gilles Peskine449bd832023-01-11 14:50:10 +0100276struct psa_key_policy_s {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200277 psa_key_usage_t MBEDTLS_PRIVATE(usage);
278 psa_algorithm_t MBEDTLS_PRIVATE(alg);
279 psa_algorithm_t MBEDTLS_PRIVATE(alg2);
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100280};
Gilles Peskinea3dd7372019-04-19 19:42:26 +0200281typedef struct psa_key_policy_s psa_key_policy_t;
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100282
Janos Follath33434a92021-05-26 09:25:33 +0100283#define PSA_KEY_POLICY_INIT { 0, 0, 0 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100284static inline struct psa_key_policy_s psa_key_policy_init(void)
Jaeden Amero70261c52019-01-04 11:47:20 +0000285{
286 const struct psa_key_policy_s v = PSA_KEY_POLICY_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 return v;
Jaeden Amero70261c52019-01-04 11:47:20 +0000288}
289
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200290/* The type used internally for key sizes.
291 * Public interfaces use size_t, but internally we use a smaller type. */
292typedef uint16_t psa_key_bits_t;
293/* The maximum value of the type used to represent bit-sizes.
294 * This is used to mark an invalid key size. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100295#define PSA_KEY_BITS_TOO_LARGE ((psa_key_bits_t) -1)
Gilles Peskinec744d992019-07-30 17:26:54 +0200296/* The maximum size of a key in bits.
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200297 * Currently defined as the maximum that can be represented, rounded down
298 * to a whole number of bytes.
299 * This is an uncast value so that it can be used in preprocessor
300 * conditionals. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200301#define PSA_MAX_KEY_BITS 0xfff8
302
Gilles Peskine91e8c332019-08-02 19:19:39 +0200303/** A mask of flags that can be stored in key attributes.
304 *
305 * This type is also used internally to store flags in slots. Internal
306 * flags are defined in library/psa_crypto_core.h. Internal flags may have
307 * the same value as external flags if they are properly handled during
308 * key creation and in psa_get_key_attributes.
309 */
310typedef uint16_t psa_key_attributes_flag_t;
311
Gilles Peskinec8000c02019-08-02 20:15:51 +0200312#define MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER \
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 ((psa_key_attributes_flag_t) 0x0001)
Gilles Peskine91e8c332019-08-02 19:19:39 +0200314
315/* A mask of key attribute flags used externally only.
316 * Only meant for internal checks inside the library. */
317#define MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ( \
Gilles Peskinec8000c02019-08-02 20:15:51 +0200318 MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER | \
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 0)
Gilles Peskine91e8c332019-08-02 19:19:39 +0200320
321/* A mask of key attribute flags used both internally and externally.
322 * Currently there aren't any. */
323#define MBEDTLS_PSA_KA_MASK_DUAL_USE ( \
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 0)
Gilles Peskine91e8c332019-08-02 19:19:39 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326typedef struct {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200327 psa_key_type_t MBEDTLS_PRIVATE(type);
328 psa_key_bits_t MBEDTLS_PRIVATE(bits);
329 psa_key_lifetime_t MBEDTLS_PRIVATE(lifetime);
330 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(id);
331 psa_key_policy_t MBEDTLS_PRIVATE(policy);
332 psa_key_attributes_flag_t MBEDTLS_PRIVATE(flags);
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200333} psa_core_key_attributes_t;
334
Janos Follath33434a92021-05-26 09:25:33 +0100335#define PSA_CORE_KEY_ATTRIBUTES_INIT { PSA_KEY_TYPE_NONE, 0, \
336 PSA_KEY_LIFETIME_VOLATILE, \
337 MBEDTLS_SVC_KEY_ID_INIT, \
338 PSA_KEY_POLICY_INIT, 0 }
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200339
Gilles Peskine449bd832023-01-11 14:50:10 +0100340struct psa_key_attributes_s {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200341 psa_core_key_attributes_t MBEDTLS_PRIVATE(core);
Gilles Peskinec8000c02019-08-02 20:15:51 +0200342#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200343 psa_key_slot_number_t MBEDTLS_PRIVATE(slot_number);
Gilles Peskinec8000c02019-08-02 20:15:51 +0200344#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200345 void *MBEDTLS_PRIVATE(domain_parameters);
346 size_t MBEDTLS_PRIVATE(domain_parameters_size);
Gilles Peskine4747d192019-04-17 15:05:45 +0200347};
348
Gilles Peskinec8000c02019-08-02 20:15:51 +0200349#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath33434a92021-05-26 09:25:33 +0100350#define PSA_KEY_ATTRIBUTES_INIT { PSA_CORE_KEY_ATTRIBUTES_INIT, 0, NULL, 0 }
Gilles Peskinec8000c02019-08-02 20:15:51 +0200351#else
Janos Follath33434a92021-05-26 09:25:33 +0100352#define PSA_KEY_ATTRIBUTES_INIT { PSA_CORE_KEY_ATTRIBUTES_INIT, NULL, 0 }
Gilles Peskinec8000c02019-08-02 20:15:51 +0200353#endif
354
Gilles Peskine449bd832023-01-11 14:50:10 +0100355static inline struct psa_key_attributes_s psa_key_attributes_init(void)
Gilles Peskine4747d192019-04-17 15:05:45 +0200356{
357 const struct psa_key_attributes_s v = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 return v;
Gilles Peskine4747d192019-04-17 15:05:45 +0200359}
360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361static inline void psa_set_key_id(psa_key_attributes_t *attributes,
362 mbedtls_svc_key_id_t key)
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200363{
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200364 psa_key_lifetime_t lifetime = attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime);
Ronald Crond98059d2020-10-23 18:00:55 +0200365
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200366 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id) = key;
Ronald Crond98059d2020-10-23 18:00:55 +0200367
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200369 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime) =
Ronald Crond98059d2020-10-23 18:00:55 +0200370 PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(
371 PSA_KEY_LIFETIME_PERSISTENT,
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 PSA_KEY_LIFETIME_GET_LOCATION(lifetime));
Ronald Crond98059d2020-10-23 18:00:55 +0200373 }
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200374}
375
Ronald Cron71016a92020-08-28 19:01:50 +0200376static inline mbedtls_svc_key_id_t psa_get_key_id(
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 const psa_key_attributes_t *attributes)
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200378{
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id);
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200380}
381
Ronald Cron6b5ff532020-10-16 14:38:19 +0200382#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine449bd832023-01-11 14:50:10 +0100383static inline void mbedtls_set_key_owner_id(psa_key_attributes_t *attributes,
384 mbedtls_key_owner_id_t owner)
Ronald Cron6b5ff532020-10-16 14:38:19 +0200385{
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200386 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id).MBEDTLS_PRIVATE(owner) = owner;
Ronald Cron6b5ff532020-10-16 14:38:19 +0200387}
388#endif
389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static inline void psa_set_key_lifetime(psa_key_attributes_t *attributes,
391 psa_key_lifetime_t lifetime)
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200392{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200393 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime) = lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
Ronald Cron71016a92020-08-28 19:01:50 +0200395#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200396 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id).MBEDTLS_PRIVATE(key_id) = 0;
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100397#else
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200398 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id) = 0;
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100399#endif
400 }
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200401}
402
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200403static inline psa_key_lifetime_t psa_get_key_lifetime(
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 const psa_key_attributes_t *attributes)
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200405{
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime);
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200407}
408
Gilles Peskine449bd832023-01-11 14:50:10 +0100409static inline void psa_extend_key_usage_flags(psa_key_usage_t *usage_flags)
Gilles Peskine4747d192019-04-17 15:05:45 +0200410{
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 if (*usage_flags & PSA_KEY_USAGE_SIGN_HASH) {
gabor-mezei-arm43110b62021-06-23 16:48:08 +0200412 *usage_flags |= PSA_KEY_USAGE_SIGN_MESSAGE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 }
gabor-mezei-arm86bf0082021-04-29 15:57:57 +0200414
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 if (*usage_flags & PSA_KEY_USAGE_VERIFY_HASH) {
gabor-mezei-arm43110b62021-06-23 16:48:08 +0200416 *usage_flags |= PSA_KEY_USAGE_VERIFY_MESSAGE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 }
Gilles Peskine4747d192019-04-17 15:05:45 +0200418}
419
420static inline void psa_set_key_usage_flags(psa_key_attributes_t *attributes,
421 psa_key_usage_t usage_flags)
422{
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 psa_extend_key_usage_flags(&usage_flags);
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200424 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(usage) = usage_flags;
Gilles Peskine4747d192019-04-17 15:05:45 +0200425}
426
427static inline psa_key_usage_t psa_get_key_usage_flags(
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 const psa_key_attributes_t *attributes)
Gilles Peskine4747d192019-04-17 15:05:45 +0200429{
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(usage);
Gilles Peskine4747d192019-04-17 15:05:45 +0200431}
432
Gilles Peskine449bd832023-01-11 14:50:10 +0100433static inline void psa_set_key_algorithm(psa_key_attributes_t *attributes,
434 psa_algorithm_t alg)
Gilles Peskine4747d192019-04-17 15:05:45 +0200435{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200436 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg) = alg;
Gilles Peskine4747d192019-04-17 15:05:45 +0200437}
438
439static inline psa_algorithm_t psa_get_key_algorithm(
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 const psa_key_attributes_t *attributes)
Gilles Peskine4747d192019-04-17 15:05:45 +0200441{
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg);
Gilles Peskine4747d192019-04-17 15:05:45 +0200443}
444
Gilles Peskine24f10f82019-05-16 12:18:32 +0200445/* This function is declared in crypto_extra.h, which comes after this
446 * header file, but we need the function here, so repeat the declaration. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100447psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes,
Gilles Peskine24f10f82019-05-16 12:18:32 +0200448 psa_key_type_t type,
449 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 size_t data_length);
Gilles Peskine24f10f82019-05-16 12:18:32 +0200451
Gilles Peskine449bd832023-01-11 14:50:10 +0100452static inline void psa_set_key_type(psa_key_attributes_t *attributes,
453 psa_key_type_t type)
Gilles Peskine4747d192019-04-17 15:05:45 +0200454{
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 if (attributes->MBEDTLS_PRIVATE(domain_parameters) == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +0200456 /* Common case: quick path */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200457 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(type) = type;
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 } else {
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800459 /* Call the bigger function to free the old domain parameters.
Gilles Peskineb699f072019-04-26 16:06:02 +0200460 * Ignore any errors which may arise due to type requiring
461 * non-default domain parameters, since this function can't
462 * report errors. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 (void) psa_set_key_domain_parameters(attributes, type, NULL, 0);
Gilles Peskineb699f072019-04-26 16:06:02 +0200464 }
Gilles Peskine4747d192019-04-17 15:05:45 +0200465}
466
467static inline psa_key_type_t psa_get_key_type(
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 const psa_key_attributes_t *attributes)
Gilles Peskine4747d192019-04-17 15:05:45 +0200469{
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(type);
Gilles Peskine4747d192019-04-17 15:05:45 +0200471}
472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473static inline void psa_set_key_bits(psa_key_attributes_t *attributes,
474 size_t bits)
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200475{
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 if (bits > PSA_MAX_KEY_BITS) {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200477 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits) = PSA_KEY_BITS_TOO_LARGE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 } else {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200479 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits) = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 }
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200481}
482
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200483static inline size_t psa_get_key_bits(
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 const psa_key_attributes_t *attributes)
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200485{
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits);
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200487}
488
Paul Elliott1265f002022-09-09 17:15:43 +0100489/**
490 * \brief The context for PSA interruptible hash signing.
Paul Elliott1265f002022-09-09 17:15:43 +0100491 */
492struct psa_sign_hash_interruptible_operation_s {
Paul Elliott2d247922022-11-29 14:54:44 +0000493 /** Unique ID indicating which driver got assigned to do the
494 * operation. Since driver contexts are driver-specific, swapping
495 * drivers halfway through the operation is not supported.
496 * ID values are auto-generated in psa_crypto_driver_wrappers.h
497 * ID value zero means the context is not valid or not assigned to
498 * any driver (i.e. none of the driver contexts are active). */
499 unsigned int MBEDTLS_PRIVATE(id);
500
Paul Elliott588f8ed2022-12-02 18:10:26 +0000501 psa_driver_sign_hash_interruptible_context_t MBEDTLS_PRIVATE(ctx);
502
Paul Elliottc9774412023-02-06 15:14:07 +0000503 unsigned int MBEDTLS_PRIVATE(error_occurred) : 1;
504
Paul Elliott296ede92022-12-15 17:00:30 +0000505 uint32_t MBEDTLS_PRIVATE(num_ops);
Paul Elliott1265f002022-09-09 17:15:43 +0100506};
507
Paul Elliottc9774412023-02-06 15:14:07 +0000508#define PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { 0, { 0 }, 0, 0 }
Paul Elliott1265f002022-09-09 17:15:43 +0100509
510static inline struct psa_sign_hash_interruptible_operation_s
511psa_sign_hash_interruptible_operation_init(void)
512{
513 const struct psa_sign_hash_interruptible_operation_s v =
514 PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT;
515
516 return v;
517}
518
519/**
520 * \brief The context for PSA interruptible hash verification.
Paul Elliott1265f002022-09-09 17:15:43 +0100521 */
522struct psa_verify_hash_interruptible_operation_s {
Paul Elliott2d247922022-11-29 14:54:44 +0000523 /** Unique ID indicating which driver got assigned to do the
524 * operation. Since driver contexts are driver-specific, swapping
525 * drivers halfway through the operation is not supported.
526 * ID values are auto-generated in psa_crypto_driver_wrappers.h
527 * ID value zero means the context is not valid or not assigned to
528 * any driver (i.e. none of the driver contexts are active). */
529 unsigned int MBEDTLS_PRIVATE(id);
530
Paul Elliott588f8ed2022-12-02 18:10:26 +0000531 psa_driver_verify_hash_interruptible_context_t MBEDTLS_PRIVATE(ctx);
532
Paul Elliottc9774412023-02-06 15:14:07 +0000533 unsigned int MBEDTLS_PRIVATE(error_occurred) : 1;
534
Paul Elliott296ede92022-12-15 17:00:30 +0000535 uint32_t MBEDTLS_PRIVATE(num_ops);
Paul Elliott1265f002022-09-09 17:15:43 +0100536};
537
Paul Elliottc9774412023-02-06 15:14:07 +0000538#define PSA_VERIFY_HASH_INTERRUPTIBLE_OPERATION_INIT { 0, { 0 }, 0, 0 }
Paul Elliott1265f002022-09-09 17:15:43 +0100539
540static inline struct psa_verify_hash_interruptible_operation_s
541psa_verify_hash_interruptible_operation_init(void)
542{
543 const struct psa_verify_hash_interruptible_operation_s v =
544 PSA_VERIFY_HASH_INTERRUPTIBLE_OPERATION_INIT;
545
546 return v;
547}
548
Jaeden Amero8013f442019-08-16 16:13:51 +0100549#ifdef __cplusplus
550}
551#endif
552
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100553#endif /* PSA_CRYPTO_STRUCT_H */