blob: 934bc176effa002f93071b5f3a72e5496e56aff2 [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
Gilles Peskine9ef733f2018-02-07 21:05:37 +010073#include "mbedtls/cmac.h"
74#include "mbedtls/gcm.h"
Paul Elliott07a30c42021-04-20 14:13:23 +010075#include "mbedtls/ccm.h"
76#include "mbedtls/chachapoly.h"
Steven Cooremandbf8ced2021-03-04 13:01:18 +010077
Steven Cooreman61398ec2021-04-26 12:04:53 +020078/* Include the context definition for the compiled-in drivers for the primitive
79 * algorithms. */
Steven Cooreman675501d2021-04-26 11:54:58 +020080#include "psa/crypto_driver_contexts_primitives.h"
Gilles Peskine9ef733f2018-02-07 21:05:37 +010081
Gilles Peskine449bd832023-01-11 14:50:10 +010082struct psa_hash_operation_s {
Steven Cooremandbf8ced2021-03-04 13:01:18 +010083 /** Unique ID indicating which driver got assigned to do the
84 * operation. Since driver contexts are driver-specific, swapping
85 * drivers halfway through the operation is not supported.
Ronald Cron980230e2021-04-01 15:37:49 +020086 * ID values are auto-generated in psa_driver_wrappers.h.
Steven Cooremandbf8ced2021-03-04 13:01:18 +010087 * ID value zero means the context is not valid or not assigned to
Ronald Cron980230e2021-04-01 15:37:49 +020088 * any driver (i.e. the driver context is not active, in use). */
Mateusz Starzyk846f0212021-05-19 19:44:07 +020089 unsigned int MBEDTLS_PRIVATE(id);
90 psa_driver_hash_context_t MBEDTLS_PRIVATE(ctx);
Gilles Peskine9ef733f2018-02-07 21:05:37 +010091};
92
Janos Follath33434a92021-05-26 09:25:33 +010093#define PSA_HASH_OPERATION_INIT { 0, { 0 } }
Gilles Peskine449bd832023-01-11 14:50:10 +010094static inline struct psa_hash_operation_s psa_hash_operation_init(void)
Jaeden Amero6a25b412019-01-04 11:47:44 +000095{
96 const struct psa_hash_operation_s v = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return v;
Jaeden Amero6a25b412019-01-04 11:47:44 +000098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100struct psa_cipher_operation_s {
Steven Cooreman61398ec2021-04-26 12:04:53 +0200101 /** Unique ID indicating which driver got assigned to do the
102 * operation. Since driver contexts are driver-specific, swapping
103 * drivers halfway through the operation is not supported.
104 * ID values are auto-generated in psa_crypto_driver_wrappers.h
105 * ID value zero means the context is not valid or not assigned to
106 * any driver (i.e. none of the driver contexts are active). */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200107 unsigned int MBEDTLS_PRIVATE(id);
Steven Cooreman61398ec2021-04-26 12:04:53 +0200108
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200109 unsigned int MBEDTLS_PRIVATE(iv_required) : 1;
110 unsigned int MBEDTLS_PRIVATE(iv_set) : 1;
Steven Cooreman61398ec2021-04-26 12:04:53 +0200111
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200112 uint8_t MBEDTLS_PRIVATE(default_iv_length);
Steven Cooreman61398ec2021-04-26 12:04:53 +0200113
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200114 psa_driver_cipher_context_t MBEDTLS_PRIVATE(ctx);
Steven Cooreman61398ec2021-04-26 12:04:53 +0200115};
116
Janos Follath33434a92021-05-26 09:25:33 +0100117#define PSA_CIPHER_OPERATION_INIT { 0, 0, 0, 0, { 0 } }
Gilles Peskine449bd832023-01-11 14:50:10 +0100118static inline struct psa_cipher_operation_s psa_cipher_operation_init(void)
Steven Cooreman61398ec2021-04-26 12:04:53 +0200119{
120 const struct psa_cipher_operation_s v = PSA_CIPHER_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 return v;
Steven Cooreman61398ec2021-04-26 12:04:53 +0200122}
123
Steven Cooreman3c8dd632021-04-26 12:16:27 +0200124/* Include the context definition for the compiled-in drivers for the composite
125 * algorithms. */
126#include "psa/crypto_driver_contexts_composites.h"
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +0300127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128struct psa_mac_operation_s {
Steven Cooreman77e2cc52021-03-19 17:05:52 +0100129 /** Unique ID indicating which driver got assigned to do the
130 * operation. Since driver contexts are driver-specific, swapping
131 * drivers halfway through the operation is not supported.
132 * ID values are auto-generated in psa_driver_wrappers.h
133 * ID value zero means the context is not valid or not assigned to
134 * any driver (i.e. none of the driver contexts are active). */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200135 unsigned int MBEDTLS_PRIVATE(id);
136 uint8_t MBEDTLS_PRIVATE(mac_size);
137 unsigned int MBEDTLS_PRIVATE(is_sign) : 1;
138 psa_driver_mac_context_t MBEDTLS_PRIVATE(ctx);
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100139};
140
Janos Follath33434a92021-05-26 09:25:33 +0100141#define PSA_MAC_OPERATION_INIT { 0, 0, 0, { 0 } }
Gilles Peskine449bd832023-01-11 14:50:10 +0100142static inline struct psa_mac_operation_s psa_mac_operation_init(void)
Jaeden Amero769ce272019-01-04 11:48:03 +0000143{
144 const struct psa_mac_operation_s v = PSA_MAC_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 return v;
Jaeden Amero769ce272019-01-04 11:48:03 +0000146}
147
Gilles Peskine449bd832023-01-11 14:50:10 +0100148struct psa_aead_operation_s {
Paul Elliottadb8b162021-04-20 16:06:57 +0100149
Paul Elliott6504aa62021-04-20 17:09:36 +0100150 /** Unique ID indicating which driver got assigned to do the
151 * operation. Since driver contexts are driver-specific, swapping
152 * drivers halfway through the operation is not supported.
153 * ID values are auto-generated in psa_crypto_driver_wrappers.h
154 * ID value zero means the context is not valid or not assigned to
155 * any driver (i.e. none of the driver contexts are active). */
Paul Elliottc7e7fe52021-09-27 09:23:40 +0100156 unsigned int MBEDTLS_PRIVATE(id);
Paul Elliott6504aa62021-04-20 17:09:36 +0100157
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200158 psa_algorithm_t MBEDTLS_PRIVATE(alg);
Paul Elliott71b05672021-09-24 11:18:13 +0100159 psa_key_type_t MBEDTLS_PRIVATE(key_type);
Paul Elliottcbbde5f2021-05-10 18:19:46 +0100160
Paul Elliott71b05672021-09-24 11:18:13 +0100161 size_t MBEDTLS_PRIVATE(ad_remaining);
162 size_t MBEDTLS_PRIVATE(body_remaining);
Paul Elliottee4ffe02021-05-20 17:25:06 +0100163
Paul Elliott71b05672021-09-24 11:18:13 +0100164 unsigned int MBEDTLS_PRIVATE(nonce_set) : 1;
165 unsigned int MBEDTLS_PRIVATE(lengths_set) : 1;
166 unsigned int MBEDTLS_PRIVATE(ad_started) : 1;
167 unsigned int MBEDTLS_PRIVATE(body_started) : 1;
168 unsigned int MBEDTLS_PRIVATE(is_encrypt) : 1;
Paul Elliott07a30c42021-04-20 14:13:23 +0100169
Paul Elliott71b05672021-09-24 11:18:13 +0100170 psa_driver_aead_context_t MBEDTLS_PRIVATE(ctx);
Gilles Peskine30a9e412019-01-14 18:36:12 +0100171};
172
Gilles Peskine449bd832023-01-11 14:50:10 +0100173#define PSA_AEAD_OPERATION_INIT { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, { 0 } }
174static inline struct psa_aead_operation_s psa_aead_operation_init(void)
Gilles Peskine30a9e412019-01-14 18:36:12 +0100175{
176 const struct psa_aead_operation_s v = PSA_AEAD_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100177 return v;
Gilles Peskine30a9e412019-01-14 18:36:12 +0100178}
179
Przemek Stekiel3e8249c2022-06-03 14:05:07 +0200180#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
181 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
182 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +0100183typedef struct {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200184 uint8_t *MBEDTLS_PRIVATE(info);
185 size_t MBEDTLS_PRIVATE(info_length);
Gilles Peskinebef7f142018-07-12 17:22:21 +0200186#if PSA_HASH_MAX_SIZE > 0xff
187#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
188#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200189 uint8_t MBEDTLS_PRIVATE(offset_in_block);
190 uint8_t MBEDTLS_PRIVATE(block_number);
191 unsigned int MBEDTLS_PRIVATE(state) : 2;
192 unsigned int MBEDTLS_PRIVATE(info_set) : 1;
Gilles Peskinee3d9c9d2021-11-08 22:12:47 +0100193 uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE];
194 uint8_t MBEDTLS_PRIVATE(prk)[PSA_HASH_MAX_SIZE];
195 struct psa_mac_operation_s MBEDTLS_PRIVATE(hmac);
Gilles Peskinecbe66502019-05-16 16:59:18 +0200196} psa_hkdf_key_derivation_t;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +0200197#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF ||
198 MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
199 MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400200#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100201typedef struct {
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400202 uint8_t MBEDTLS_PRIVATE(data)[PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE];
203} psa_tls12_ecjpake_to_pms_t;
204#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskinebef7f142018-07-12 17:22:21 +0200205
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200206#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
207 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100208typedef enum {
Przemek Stekielc4b814a2022-04-07 12:28:08 +0200209 PSA_TLS12_PRF_STATE_INIT, /* no input provided */
210 PSA_TLS12_PRF_STATE_SEED_SET, /* seed has been set */
211 PSA_TLS12_PRF_STATE_OTHER_KEY_SET, /* other key has been set - optional */
212 PSA_TLS12_PRF_STATE_KEY_SET, /* key has been set */
213 PSA_TLS12_PRF_STATE_LABEL_SET, /* label has been set */
214 PSA_TLS12_PRF_STATE_OUTPUT /* output has been started */
Janos Follath999f6482019-06-11 12:04:10 +0100215} psa_tls12_prf_key_derivation_state_t;
216
Gilles Peskine449bd832023-01-11 14:50:10 +0100217typedef struct psa_tls12_prf_key_derivation_s {
Janos Follath999f6482019-06-11 12:04:10 +0100218#if PSA_HASH_MAX_SIZE > 0xff
219#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
220#endif
221
222 /* Indicates how many bytes in the current HMAC block have
Janos Follath844eb0e2019-06-19 12:10:49 +0100223 * not yet been read by the user. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200224 uint8_t MBEDTLS_PRIVATE(left_in_block);
Janos Follath999f6482019-06-11 12:04:10 +0100225
226 /* The 1-based number of the block. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200227 uint8_t MBEDTLS_PRIVATE(block_number);
Janos Follath999f6482019-06-11 12:04:10 +0100228
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200229 psa_tls12_prf_key_derivation_state_t MBEDTLS_PRIVATE(state);
Janos Follath999f6482019-06-11 12:04:10 +0100230
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200231 uint8_t *MBEDTLS_PRIVATE(secret);
232 size_t MBEDTLS_PRIVATE(secret_length);
233 uint8_t *MBEDTLS_PRIVATE(seed);
234 size_t MBEDTLS_PRIVATE(seed_length);
235 uint8_t *MBEDTLS_PRIVATE(label);
236 size_t MBEDTLS_PRIVATE(label_length);
Przemek Stekiel7f1c89d2022-04-19 14:00:37 +0200237#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Przemek Stekielf4e8f012022-04-07 12:23:31 +0200238 uint8_t *MBEDTLS_PRIVATE(other_secret);
239 size_t MBEDTLS_PRIVATE(other_secret_length);
Przemek Stekiel7f1c89d2022-04-19 14:00:37 +0200240#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +0200241
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200242 uint8_t MBEDTLS_PRIVATE(Ai)[PSA_HASH_MAX_SIZE];
Janos Follath999f6482019-06-11 12:04:10 +0100243
Janos Follath33434a92021-05-26 09:25:33 +0100244 /* `HMAC_hash( prk, A( i ) + seed )` in the notation of RFC 5246, Sect. 5. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200245 uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE];
Janos Follath999f6482019-06-11 12:04:10 +0100246} psa_tls12_prf_key_derivation_t;
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200247#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
248 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Hanno Beckerc8a41d72018-10-09 17:33:01 +0100249
Gilles Peskine449bd832023-01-11 14:50:10 +0100250struct psa_key_derivation_s {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200251 psa_algorithm_t MBEDTLS_PRIVATE(alg);
252 unsigned int MBEDTLS_PRIVATE(can_output_key) : 1;
253 size_t MBEDTLS_PRIVATE(capacity);
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 union {
Janos Follathadbec812019-06-14 11:05:39 +0100255 /* Make the union non-empty even with no supported algorithms. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200256 uint8_t MBEDTLS_PRIVATE(dummy);
Przemek Stekiel3e8249c2022-06-03 14:05:07 +0200257#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
259 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200260 psa_hkdf_key_derivation_t MBEDTLS_PRIVATE(hkdf);
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200261#endif
262#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200264 psa_tls12_prf_key_derivation_t MBEDTLS_PRIVATE(tls12_prf);
Gilles Peskinebef7f142018-07-12 17:22:21 +0200265#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -0400266#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
267 psa_tls12_ecjpake_to_pms_t MBEDTLS_PRIVATE(tls12_ecjpake_to_pms);
268#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200269 } MBEDTLS_PRIVATE(ctx);
Gilles Peskineeab56e42018-07-12 17:12:33 +0200270};
271
Janos Follathadbec812019-06-14 11:05:39 +0100272/* This only zeroes out the first byte in the union, the rest is unspecified. */
Janos Follath33434a92021-05-26 09:25:33 +0100273#define PSA_KEY_DERIVATION_OPERATION_INIT { 0, 0, 0, { 0 } }
Janos Follath0dcda952021-06-07 14:52:13 +0100274static inline struct psa_key_derivation_s psa_key_derivation_operation_init(
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 void)
Gilles Peskineeab56e42018-07-12 17:12:33 +0200276{
Gilles Peskinecbe66502019-05-16 16:59:18 +0200277 const struct psa_key_derivation_s v = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 return v;
Gilles Peskineeab56e42018-07-12 17:12:33 +0200279}
280
Gilles Peskine449bd832023-01-11 14:50:10 +0100281struct psa_key_policy_s {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200282 psa_key_usage_t MBEDTLS_PRIVATE(usage);
283 psa_algorithm_t MBEDTLS_PRIVATE(alg);
284 psa_algorithm_t MBEDTLS_PRIVATE(alg2);
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100285};
Gilles Peskinea3dd7372019-04-19 19:42:26 +0200286typedef struct psa_key_policy_s psa_key_policy_t;
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100287
Janos Follath33434a92021-05-26 09:25:33 +0100288#define PSA_KEY_POLICY_INIT { 0, 0, 0 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100289static inline struct psa_key_policy_s psa_key_policy_init(void)
Jaeden Amero70261c52019-01-04 11:47:20 +0000290{
291 const struct psa_key_policy_s v = PSA_KEY_POLICY_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 return v;
Jaeden Amero70261c52019-01-04 11:47:20 +0000293}
294
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200295/* The type used internally for key sizes.
296 * Public interfaces use size_t, but internally we use a smaller type. */
297typedef uint16_t psa_key_bits_t;
298/* The maximum value of the type used to represent bit-sizes.
299 * This is used to mark an invalid key size. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100300#define PSA_KEY_BITS_TOO_LARGE ((psa_key_bits_t) -1)
Gilles Peskinec744d992019-07-30 17:26:54 +0200301/* The maximum size of a key in bits.
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200302 * Currently defined as the maximum that can be represented, rounded down
303 * to a whole number of bytes.
304 * This is an uncast value so that it can be used in preprocessor
305 * conditionals. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200306#define PSA_MAX_KEY_BITS 0xfff8
307
Gilles Peskine91e8c332019-08-02 19:19:39 +0200308/** A mask of flags that can be stored in key attributes.
309 *
310 * This type is also used internally to store flags in slots. Internal
311 * flags are defined in library/psa_crypto_core.h. Internal flags may have
312 * the same value as external flags if they are properly handled during
313 * key creation and in psa_get_key_attributes.
314 */
315typedef uint16_t psa_key_attributes_flag_t;
316
Gilles Peskinec8000c02019-08-02 20:15:51 +0200317#define MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER \
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 ((psa_key_attributes_flag_t) 0x0001)
Gilles Peskine91e8c332019-08-02 19:19:39 +0200319
320/* A mask of key attribute flags used externally only.
321 * Only meant for internal checks inside the library. */
322#define MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ( \
Gilles Peskinec8000c02019-08-02 20:15:51 +0200323 MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER | \
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 0)
Gilles Peskine91e8c332019-08-02 19:19:39 +0200325
326/* A mask of key attribute flags used both internally and externally.
327 * Currently there aren't any. */
328#define MBEDTLS_PSA_KA_MASK_DUAL_USE ( \
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 0)
Gilles Peskine91e8c332019-08-02 19:19:39 +0200330
Gilles Peskine449bd832023-01-11 14:50:10 +0100331typedef struct {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200332 psa_key_type_t MBEDTLS_PRIVATE(type);
333 psa_key_bits_t MBEDTLS_PRIVATE(bits);
334 psa_key_lifetime_t MBEDTLS_PRIVATE(lifetime);
335 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(id);
336 psa_key_policy_t MBEDTLS_PRIVATE(policy);
337 psa_key_attributes_flag_t MBEDTLS_PRIVATE(flags);
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200338} psa_core_key_attributes_t;
339
Janos Follath33434a92021-05-26 09:25:33 +0100340#define PSA_CORE_KEY_ATTRIBUTES_INIT { PSA_KEY_TYPE_NONE, 0, \
341 PSA_KEY_LIFETIME_VOLATILE, \
342 MBEDTLS_SVC_KEY_ID_INIT, \
343 PSA_KEY_POLICY_INIT, 0 }
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200344
Gilles Peskine449bd832023-01-11 14:50:10 +0100345struct psa_key_attributes_s {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200346 psa_core_key_attributes_t MBEDTLS_PRIVATE(core);
Gilles Peskinec8000c02019-08-02 20:15:51 +0200347#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200348 psa_key_slot_number_t MBEDTLS_PRIVATE(slot_number);
Gilles Peskinec8000c02019-08-02 20:15:51 +0200349#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200350 void *MBEDTLS_PRIVATE(domain_parameters);
351 size_t MBEDTLS_PRIVATE(domain_parameters_size);
Gilles Peskine4747d192019-04-17 15:05:45 +0200352};
353
Gilles Peskinec8000c02019-08-02 20:15:51 +0200354#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath33434a92021-05-26 09:25:33 +0100355#define PSA_KEY_ATTRIBUTES_INIT { PSA_CORE_KEY_ATTRIBUTES_INIT, 0, NULL, 0 }
Gilles Peskinec8000c02019-08-02 20:15:51 +0200356#else
Janos Follath33434a92021-05-26 09:25:33 +0100357#define PSA_KEY_ATTRIBUTES_INIT { PSA_CORE_KEY_ATTRIBUTES_INIT, NULL, 0 }
Gilles Peskinec8000c02019-08-02 20:15:51 +0200358#endif
359
Gilles Peskine449bd832023-01-11 14:50:10 +0100360static inline struct psa_key_attributes_s psa_key_attributes_init(void)
Gilles Peskine4747d192019-04-17 15:05:45 +0200361{
362 const struct psa_key_attributes_s v = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 return v;
Gilles Peskine4747d192019-04-17 15:05:45 +0200364}
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366static inline void psa_set_key_id(psa_key_attributes_t *attributes,
367 mbedtls_svc_key_id_t key)
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200368{
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200369 psa_key_lifetime_t lifetime = attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime);
Ronald Crond98059d2020-10-23 18:00:55 +0200370
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200371 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id) = key;
Ronald Crond98059d2020-10-23 18:00:55 +0200372
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200374 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime) =
Ronald Crond98059d2020-10-23 18:00:55 +0200375 PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(
376 PSA_KEY_LIFETIME_PERSISTENT,
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 PSA_KEY_LIFETIME_GET_LOCATION(lifetime));
Ronald Crond98059d2020-10-23 18:00:55 +0200378 }
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200379}
380
Ronald Cron71016a92020-08-28 19:01:50 +0200381static inline mbedtls_svc_key_id_t psa_get_key_id(
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 const psa_key_attributes_t *attributes)
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200383{
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id);
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200385}
386
Ronald Cron6b5ff532020-10-16 14:38:19 +0200387#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine449bd832023-01-11 14:50:10 +0100388static inline void mbedtls_set_key_owner_id(psa_key_attributes_t *attributes,
389 mbedtls_key_owner_id_t owner)
Ronald Cron6b5ff532020-10-16 14:38:19 +0200390{
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200391 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id).MBEDTLS_PRIVATE(owner) = owner;
Ronald Cron6b5ff532020-10-16 14:38:19 +0200392}
393#endif
394
Gilles Peskine449bd832023-01-11 14:50:10 +0100395static inline void psa_set_key_lifetime(psa_key_attributes_t *attributes,
396 psa_key_lifetime_t lifetime)
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200397{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200398 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime) = lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
Ronald Cron71016a92020-08-28 19:01:50 +0200400#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Mateusz Starzyk363eb292021-05-19 17:32:44 +0200401 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id).MBEDTLS_PRIVATE(key_id) = 0;
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100402#else
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200403 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id) = 0;
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100404#endif
405 }
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200406}
407
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200408static inline psa_key_lifetime_t psa_get_key_lifetime(
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 const psa_key_attributes_t *attributes)
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200410{
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime);
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200412}
413
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static inline void psa_extend_key_usage_flags(psa_key_usage_t *usage_flags)
Gilles Peskine4747d192019-04-17 15:05:45 +0200415{
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 if (*usage_flags & PSA_KEY_USAGE_SIGN_HASH) {
gabor-mezei-arm43110b62021-06-23 16:48:08 +0200417 *usage_flags |= PSA_KEY_USAGE_SIGN_MESSAGE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 }
gabor-mezei-arm86bf0082021-04-29 15:57:57 +0200419
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 if (*usage_flags & PSA_KEY_USAGE_VERIFY_HASH) {
gabor-mezei-arm43110b62021-06-23 16:48:08 +0200421 *usage_flags |= PSA_KEY_USAGE_VERIFY_MESSAGE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 }
Gilles Peskine4747d192019-04-17 15:05:45 +0200423}
424
425static inline void psa_set_key_usage_flags(psa_key_attributes_t *attributes,
426 psa_key_usage_t usage_flags)
427{
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 psa_extend_key_usage_flags(&usage_flags);
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200429 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(usage) = usage_flags;
Gilles Peskine4747d192019-04-17 15:05:45 +0200430}
431
432static inline psa_key_usage_t psa_get_key_usage_flags(
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 const psa_key_attributes_t *attributes)
Gilles Peskine4747d192019-04-17 15:05:45 +0200434{
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(usage);
Gilles Peskine4747d192019-04-17 15:05:45 +0200436}
437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438static inline void psa_set_key_algorithm(psa_key_attributes_t *attributes,
439 psa_algorithm_t alg)
Gilles Peskine4747d192019-04-17 15:05:45 +0200440{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200441 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg) = alg;
Gilles Peskine4747d192019-04-17 15:05:45 +0200442}
443
444static inline psa_algorithm_t psa_get_key_algorithm(
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 const psa_key_attributes_t *attributes)
Gilles Peskine4747d192019-04-17 15:05:45 +0200446{
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg);
Gilles Peskine4747d192019-04-17 15:05:45 +0200448}
449
Gilles Peskine24f10f82019-05-16 12:18:32 +0200450/* This function is declared in crypto_extra.h, which comes after this
451 * header file, but we need the function here, so repeat the declaration. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100452psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes,
Gilles Peskine24f10f82019-05-16 12:18:32 +0200453 psa_key_type_t type,
454 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 size_t data_length);
Gilles Peskine24f10f82019-05-16 12:18:32 +0200456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457static inline void psa_set_key_type(psa_key_attributes_t *attributes,
458 psa_key_type_t type)
Gilles Peskine4747d192019-04-17 15:05:45 +0200459{
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 if (attributes->MBEDTLS_PRIVATE(domain_parameters) == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +0200461 /* Common case: quick path */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200462 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(type) = type;
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 } else {
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800464 /* Call the bigger function to free the old domain parameters.
Gilles Peskineb699f072019-04-26 16:06:02 +0200465 * Ignore any errors which may arise due to type requiring
466 * non-default domain parameters, since this function can't
467 * report errors. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 (void) psa_set_key_domain_parameters(attributes, type, NULL, 0);
Gilles Peskineb699f072019-04-26 16:06:02 +0200469 }
Gilles Peskine4747d192019-04-17 15:05:45 +0200470}
471
472static inline psa_key_type_t psa_get_key_type(
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 const psa_key_attributes_t *attributes)
Gilles Peskine4747d192019-04-17 15:05:45 +0200474{
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(type);
Gilles Peskine4747d192019-04-17 15:05:45 +0200476}
477
Gilles Peskine449bd832023-01-11 14:50:10 +0100478static inline void psa_set_key_bits(psa_key_attributes_t *attributes,
479 size_t bits)
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200480{
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (bits > PSA_MAX_KEY_BITS) {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200482 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits) = PSA_KEY_BITS_TOO_LARGE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 } else {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200484 attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits) = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 }
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200486}
487
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200488static inline size_t psa_get_key_bits(
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 const psa_key_attributes_t *attributes)
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200490{
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits);
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200492}
493
Paul Elliott1265f002022-09-09 17:15:43 +0100494/**
495 * \brief The context for PSA interruptible hash signing.
Paul Elliott1265f002022-09-09 17:15:43 +0100496 */
497struct psa_sign_hash_interruptible_operation_s {
Paul Elliott2d247922022-11-29 14:54:44 +0000498 /** Unique ID indicating which driver got assigned to do the
499 * operation. Since driver contexts are driver-specific, swapping
500 * drivers halfway through the operation is not supported.
501 * ID values are auto-generated in psa_crypto_driver_wrappers.h
502 * ID value zero means the context is not valid or not assigned to
503 * any driver (i.e. none of the driver contexts are active). */
504 unsigned int MBEDTLS_PRIVATE(id);
505
Paul Elliott588f8ed2022-12-02 18:10:26 +0000506 psa_driver_sign_hash_interruptible_context_t MBEDTLS_PRIVATE(ctx);
507
Paul Elliottc9774412023-02-06 15:14:07 +0000508 unsigned int MBEDTLS_PRIVATE(error_occurred) : 1;
509
Paul Elliott296ede92022-12-15 17:00:30 +0000510 uint32_t MBEDTLS_PRIVATE(num_ops);
Paul Elliott1265f002022-09-09 17:15:43 +0100511};
512
Paul Elliottc9774412023-02-06 15:14:07 +0000513#define PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { 0, { 0 }, 0, 0 }
Paul Elliott1265f002022-09-09 17:15:43 +0100514
515static inline struct psa_sign_hash_interruptible_operation_s
516psa_sign_hash_interruptible_operation_init(void)
517{
518 const struct psa_sign_hash_interruptible_operation_s v =
519 PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT;
520
521 return v;
522}
523
524/**
525 * \brief The context for PSA interruptible hash verification.
Paul Elliott1265f002022-09-09 17:15:43 +0100526 */
527struct psa_verify_hash_interruptible_operation_s {
Paul Elliott2d247922022-11-29 14:54:44 +0000528 /** Unique ID indicating which driver got assigned to do the
529 * operation. Since driver contexts are driver-specific, swapping
530 * drivers halfway through the operation is not supported.
531 * ID values are auto-generated in psa_crypto_driver_wrappers.h
532 * ID value zero means the context is not valid or not assigned to
533 * any driver (i.e. none of the driver contexts are active). */
534 unsigned int MBEDTLS_PRIVATE(id);
535
Paul Elliott588f8ed2022-12-02 18:10:26 +0000536 psa_driver_verify_hash_interruptible_context_t MBEDTLS_PRIVATE(ctx);
537
Paul Elliottc9774412023-02-06 15:14:07 +0000538 unsigned int MBEDTLS_PRIVATE(error_occurred) : 1;
539
Paul Elliott296ede92022-12-15 17:00:30 +0000540 uint32_t MBEDTLS_PRIVATE(num_ops);
Paul Elliott1265f002022-09-09 17:15:43 +0100541};
542
Paul Elliottc9774412023-02-06 15:14:07 +0000543#define PSA_VERIFY_HASH_INTERRUPTIBLE_OPERATION_INIT { 0, { 0 }, 0, 0 }
Paul Elliott1265f002022-09-09 17:15:43 +0100544
545static inline struct psa_verify_hash_interruptible_operation_s
546psa_verify_hash_interruptible_operation_init(void)
547{
548 const struct psa_verify_hash_interruptible_operation_s v =
549 PSA_VERIFY_HASH_INTERRUPTIBLE_OPERATION_INIT;
550
551 return v;
552}
553
Jaeden Amero8013f442019-08-16 16:13:51 +0100554#ifdef __cplusplus
555}
556#endif
557
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100558#endif /* PSA_CRYPTO_STRUCT_H */