blob: fc7e7785cc10dd48d4e4b8cddb864f65ef482f09 [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
63
Jaeden Amero8013f442019-08-16 16:13:51 +010064#ifdef __cplusplus
65extern "C" {
66#endif
67
Gilles Peskine9ef733f2018-02-07 21:05:37 +010068/* Include the Mbed TLS configuration file, the way Mbed TLS does it
69 * in each of its header files. */
70#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Amerod58a00d2019-06-07 11:49:59 +010071#include "mbedtls/config.h"
Gilles Peskine9ef733f2018-02-07 21:05:37 +010072#else
73#include MBEDTLS_CONFIG_FILE
74#endif
75
Gilles Peskine9ef733f2018-02-07 21:05:37 +010076#include "mbedtls/cmac.h"
77#include "mbedtls/gcm.h"
Steven Cooremandbf8ced2021-03-04 13:01:18 +010078
Steven Cooreman61398ec2021-04-26 12:04:53 +020079/* Include the context definition for the compiled-in drivers for the primitive
80 * algorithms. */
Steven Cooreman675501d2021-04-26 11:54:58 +020081#include "psa/crypto_driver_contexts_primitives.h"
Gilles Peskine9ef733f2018-02-07 21:05:37 +010082
83struct psa_hash_operation_s
84{
Steven Cooremandbf8ced2021-03-04 13:01:18 +010085 /** Unique ID indicating which driver got assigned to do the
86 * operation. Since driver contexts are driver-specific, swapping
87 * drivers halfway through the operation is not supported.
Ronald Cron980230e2021-04-01 15:37:49 +020088 * ID values are auto-generated in psa_driver_wrappers.h.
Steven Cooremandbf8ced2021-03-04 13:01:18 +010089 * ID value zero means the context is not valid or not assigned to
Ronald Cron980230e2021-04-01 15:37:49 +020090 * any driver (i.e. the driver context is not active, in use). */
Steven Cooremandbf8ced2021-03-04 13:01:18 +010091 unsigned int id;
Steven Cooremanb1777312021-03-04 15:22:38 +010092 psa_driver_hash_context_t ctx;
Gilles Peskine9ef733f2018-02-07 21:05:37 +010093};
94
Steven Cooremandbf8ced2021-03-04 13:01:18 +010095#define PSA_HASH_OPERATION_INIT {0, {0}}
Jaeden Amero6a25b412019-01-04 11:47:44 +000096static inline struct psa_hash_operation_s psa_hash_operation_init( void )
97{
98 const struct psa_hash_operation_s v = PSA_HASH_OPERATION_INIT;
99 return( v );
100}
101
Steven Cooreman61398ec2021-04-26 12:04:53 +0200102struct psa_cipher_operation_s
103{
104 /** Unique ID indicating which driver got assigned to do the
105 * operation. Since driver contexts are driver-specific, swapping
106 * drivers halfway through the operation is not supported.
107 * ID values are auto-generated in psa_crypto_driver_wrappers.h
108 * ID value zero means the context is not valid or not assigned to
109 * any driver (i.e. none of the driver contexts are active). */
110 unsigned int id;
111
112 unsigned int iv_required : 1;
113 unsigned int iv_set : 1;
114
115 uint8_t default_iv_length;
116
117 psa_driver_cipher_context_t ctx;
118};
119
120#define PSA_CIPHER_OPERATION_INIT {0, 0, 0, 0, {0}}
121static inline struct psa_cipher_operation_s psa_cipher_operation_init( void )
122{
123 const struct psa_cipher_operation_s v = PSA_CIPHER_OPERATION_INIT;
124 return( v );
125}
126
Steven Cooreman3c8dd632021-04-26 12:16:27 +0200127/* Include the context definition for the compiled-in drivers for the composite
128 * algorithms. */
129#include "psa/crypto_driver_contexts_composites.h"
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +0300130
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100131struct psa_mac_operation_s
132{
Steven Cooreman77e2cc52021-03-19 17:05:52 +0100133 /** Unique ID indicating which driver got assigned to do the
134 * operation. Since driver contexts are driver-specific, swapping
135 * drivers halfway through the operation is not supported.
136 * ID values are auto-generated in psa_driver_wrappers.h
137 * ID value zero means the context is not valid or not assigned to
138 * any driver (i.e. none of the driver contexts are active). */
Steven Cooremand13a70f2021-03-19 15:24:23 +0100139 unsigned int id;
Steven Cooreman77e2cc52021-03-19 17:05:52 +0100140 psa_driver_mac_context_t ctx;
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100141};
142
Steven Cooreman77e2cc52021-03-19 17:05:52 +0100143#define PSA_MAC_OPERATION_INIT {0, {0}}
Jaeden Amero769ce272019-01-04 11:48:03 +0000144static inline struct psa_mac_operation_s psa_mac_operation_init( void )
145{
146 const struct psa_mac_operation_s v = PSA_MAC_OPERATION_INIT;
147 return( v );
148}
149
Gilles Peskine30a9e412019-01-14 18:36:12 +0100150struct psa_aead_operation_s
151{
152 psa_algorithm_t alg;
153 unsigned int key_set : 1;
154 unsigned int iv_set : 1;
155 uint8_t iv_size;
156 uint8_t block_size;
157 union
158 {
159 unsigned dummy; /* Enable easier initializing of the union. */
160 mbedtls_cipher_context_t cipher;
161 } ctx;
162};
163
164#define PSA_AEAD_OPERATION_INIT {0, 0, 0, 0, 0, {0}}
165static inline struct psa_aead_operation_s psa_aead_operation_init( void )
166{
167 const struct psa_aead_operation_s v = PSA_AEAD_OPERATION_INIT;
168 return( v );
169}
170
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200171#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinebef7f142018-07-12 17:22:21 +0200172typedef struct
173{
174 uint8_t *info;
175 size_t info_length;
Steven Cooremand1ed1d92021-04-29 19:11:25 +0200176 psa_mac_operation_t hmac;
Gilles Peskinebef7f142018-07-12 17:22:21 +0200177 uint8_t prk[PSA_HASH_MAX_SIZE];
178 uint8_t output_block[PSA_HASH_MAX_SIZE];
179#if PSA_HASH_MAX_SIZE > 0xff
180#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
181#endif
182 uint8_t offset_in_block;
183 uint8_t block_number;
Gilles Peskine22c51512019-04-12 15:07:32 +0200184 unsigned int state : 2;
185 unsigned int info_set : 1;
Gilles Peskinecbe66502019-05-16 16:59:18 +0200186} psa_hkdf_key_derivation_t;
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200187#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Gilles Peskinebef7f142018-07-12 17:22:21 +0200188
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200189#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
190 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath999f6482019-06-11 12:04:10 +0100191typedef enum
192{
Gilles Peskine43f958b2020-12-13 14:55:14 +0100193 PSA_TLS12_PRF_STATE_INIT, /* no input provided */
194 PSA_TLS12_PRF_STATE_SEED_SET, /* seed has been set */
195 PSA_TLS12_PRF_STATE_KEY_SET, /* key has been set */
196 PSA_TLS12_PRF_STATE_LABEL_SET, /* label has been set */
197 PSA_TLS12_PRF_STATE_OUTPUT /* output has been started */
Janos Follath999f6482019-06-11 12:04:10 +0100198} psa_tls12_prf_key_derivation_state_t;
199
200typedef struct psa_tls12_prf_key_derivation_s
201{
202#if PSA_HASH_MAX_SIZE > 0xff
203#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
204#endif
205
206 /* Indicates how many bytes in the current HMAC block have
Janos Follath844eb0e2019-06-19 12:10:49 +0100207 * not yet been read by the user. */
208 uint8_t left_in_block;
Janos Follath999f6482019-06-11 12:04:10 +0100209
210 /* The 1-based number of the block. */
211 uint8_t block_number;
212
213 psa_tls12_prf_key_derivation_state_t state;
214
Steven Cooremana6df6042021-04-29 19:32:25 +0200215 uint8_t *secret;
216 size_t secret_length;
Janos Follath999f6482019-06-11 12:04:10 +0100217 uint8_t *seed;
218 size_t seed_length;
219 uint8_t *label;
220 size_t label_length;
Steven Cooremana6df6042021-04-29 19:32:25 +0200221
Janos Follath999f6482019-06-11 12:04:10 +0100222 uint8_t Ai[PSA_HASH_MAX_SIZE];
223
224 /* `HMAC_hash( prk, A(i) + seed )` in the notation of RFC 5246, Sect. 5. */
225 uint8_t output_block[PSA_HASH_MAX_SIZE];
226} psa_tls12_prf_key_derivation_t;
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200227#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
228 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Hanno Beckerc8a41d72018-10-09 17:33:01 +0100229
Gilles Peskinecbe66502019-05-16 16:59:18 +0200230struct psa_key_derivation_s
Gilles Peskineeab56e42018-07-12 17:12:33 +0200231{
232 psa_algorithm_t alg;
Gilles Peskine178c9aa2019-09-24 18:21:06 +0200233 unsigned int can_output_key : 1;
Gilles Peskineeab56e42018-07-12 17:12:33 +0200234 size_t capacity;
235 union
236 {
Janos Follathadbec812019-06-14 11:05:39 +0100237 /* Make the union non-empty even with no supported algorithms. */
238 uint8_t dummy;
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200239#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +0200240 psa_hkdf_key_derivation_t hkdf;
Steven Cooremanac8d82a2021-04-29 18:01:53 +0200241#endif
242#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
243 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskinecbe66502019-05-16 16:59:18 +0200244 psa_tls12_prf_key_derivation_t tls12_prf;
Gilles Peskinebef7f142018-07-12 17:22:21 +0200245#endif
Gilles Peskineeab56e42018-07-12 17:12:33 +0200246 } ctx;
247};
248
Janos Follathadbec812019-06-14 11:05:39 +0100249/* This only zeroes out the first byte in the union, the rest is unspecified. */
Gilles Peskine178c9aa2019-09-24 18:21:06 +0200250#define PSA_KEY_DERIVATION_OPERATION_INIT {0, 0, 0, {0}}
Gilles Peskinecbe66502019-05-16 16:59:18 +0200251static inline struct psa_key_derivation_s psa_key_derivation_operation_init( void )
Gilles Peskineeab56e42018-07-12 17:12:33 +0200252{
Gilles Peskinecbe66502019-05-16 16:59:18 +0200253 const struct psa_key_derivation_s v = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskineeab56e42018-07-12 17:12:33 +0200254 return( v );
255}
256
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100257struct psa_key_policy_s
258{
259 psa_key_usage_t usage;
260 psa_algorithm_t alg;
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200261 psa_algorithm_t alg2;
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100262};
Gilles Peskinea3dd7372019-04-19 19:42:26 +0200263typedef struct psa_key_policy_s psa_key_policy_t;
Gilles Peskine7698bcf2018-03-03 21:30:44 +0100264
Gilles Peskine96f0b3b2019-05-10 19:33:38 +0200265#define PSA_KEY_POLICY_INIT {0, 0, 0}
Jaeden Amero70261c52019-01-04 11:47:20 +0000266static inline struct psa_key_policy_s psa_key_policy_init( void )
267{
268 const struct psa_key_policy_s v = PSA_KEY_POLICY_INIT;
269 return( v );
270}
271
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200272/* The type used internally for key sizes.
273 * Public interfaces use size_t, but internally we use a smaller type. */
274typedef uint16_t psa_key_bits_t;
275/* The maximum value of the type used to represent bit-sizes.
276 * This is used to mark an invalid key size. */
277#define PSA_KEY_BITS_TOO_LARGE ( (psa_key_bits_t) ( -1 ) )
Gilles Peskinec744d992019-07-30 17:26:54 +0200278/* The maximum size of a key in bits.
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200279 * Currently defined as the maximum that can be represented, rounded down
280 * to a whole number of bytes.
281 * This is an uncast value so that it can be used in preprocessor
282 * conditionals. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200283#define PSA_MAX_KEY_BITS 0xfff8
284
Gilles Peskine91e8c332019-08-02 19:19:39 +0200285/** A mask of flags that can be stored in key attributes.
286 *
287 * This type is also used internally to store flags in slots. Internal
288 * flags are defined in library/psa_crypto_core.h. Internal flags may have
289 * the same value as external flags if they are properly handled during
290 * key creation and in psa_get_key_attributes.
291 */
292typedef uint16_t psa_key_attributes_flag_t;
293
Gilles Peskinec8000c02019-08-02 20:15:51 +0200294#define MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER \
295 ( (psa_key_attributes_flag_t) 0x0001 )
Gilles Peskine91e8c332019-08-02 19:19:39 +0200296
297/* A mask of key attribute flags used externally only.
298 * Only meant for internal checks inside the library. */
299#define MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ( \
Gilles Peskinec8000c02019-08-02 20:15:51 +0200300 MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER | \
Gilles Peskine91e8c332019-08-02 19:19:39 +0200301 0 )
302
303/* A mask of key attribute flags used both internally and externally.
304 * Currently there aren't any. */
305#define MBEDTLS_PSA_KA_MASK_DUAL_USE ( \
306 0 )
307
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200308typedef struct
309{
310 psa_key_type_t type;
Gilles Peskinef65ed6f2019-12-04 17:18:41 +0100311 psa_key_bits_t bits;
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200312 psa_key_lifetime_t lifetime;
Ronald Cron71016a92020-08-28 19:01:50 +0200313 mbedtls_svc_key_id_t id;
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200314 psa_key_policy_t policy;
Gilles Peskine91e8c332019-08-02 19:19:39 +0200315 psa_key_attributes_flag_t flags;
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200316} psa_core_key_attributes_t;
317
Ronald Cron71016a92020-08-28 19:01:50 +0200318#define PSA_CORE_KEY_ATTRIBUTES_INIT {PSA_KEY_TYPE_NONE, 0, PSA_KEY_LIFETIME_VOLATILE, MBEDTLS_SVC_KEY_ID_INIT, PSA_KEY_POLICY_INIT, 0}
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200319
Gilles Peskine4747d192019-04-17 15:05:45 +0200320struct psa_key_attributes_s
321{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200322 psa_core_key_attributes_t core;
Gilles Peskinec8000c02019-08-02 20:15:51 +0200323#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
324 psa_key_slot_number_t slot_number;
325#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +0200326 void *domain_parameters;
327 size_t domain_parameters_size;
Gilles Peskine4747d192019-04-17 15:05:45 +0200328};
329
Gilles Peskinec8000c02019-08-02 20:15:51 +0200330#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
331#define PSA_KEY_ATTRIBUTES_INIT {PSA_CORE_KEY_ATTRIBUTES_INIT, 0, NULL, 0}
332#else
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200333#define PSA_KEY_ATTRIBUTES_INIT {PSA_CORE_KEY_ATTRIBUTES_INIT, NULL, 0}
Gilles Peskinec8000c02019-08-02 20:15:51 +0200334#endif
335
Gilles Peskine4747d192019-04-17 15:05:45 +0200336static inline struct psa_key_attributes_s psa_key_attributes_init( void )
337{
338 const struct psa_key_attributes_s v = PSA_KEY_ATTRIBUTES_INIT;
339 return( v );
340}
341
Ronald Cron71016a92020-08-28 19:01:50 +0200342static inline void psa_set_key_id( psa_key_attributes_t *attributes,
343 mbedtls_svc_key_id_t key )
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200344{
Ronald Crond98059d2020-10-23 18:00:55 +0200345 psa_key_lifetime_t lifetime = attributes->core.lifetime;
346
Ronald Cron27238fc2020-07-23 12:30:41 +0200347 attributes->core.id = key;
Ronald Crond98059d2020-10-23 18:00:55 +0200348
349 if( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
350 {
351 attributes->core.lifetime =
352 PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(
353 PSA_KEY_LIFETIME_PERSISTENT,
354 PSA_KEY_LIFETIME_GET_LOCATION( lifetime ) );
355 }
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200356}
357
Ronald Cron71016a92020-08-28 19:01:50 +0200358static inline mbedtls_svc_key_id_t psa_get_key_id(
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200359 const psa_key_attributes_t *attributes)
360{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200361 return( attributes->core.id );
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200362}
363
Ronald Cron6b5ff532020-10-16 14:38:19 +0200364#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
365static inline void mbedtls_set_key_owner_id( psa_key_attributes_t *attributes,
366 mbedtls_key_owner_id_t owner )
367{
368 attributes->core.id.owner = owner;
369}
370#endif
371
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200372static inline void psa_set_key_lifetime(psa_key_attributes_t *attributes,
373 psa_key_lifetime_t lifetime)
374{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200375 attributes->core.lifetime = lifetime;
Ronald Crond98059d2020-10-23 18:00:55 +0200376 if( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100377 {
Ronald Cron71016a92020-08-28 19:01:50 +0200378#ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100379 attributes->core.id.key_id = 0;
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100380#else
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200381 attributes->core.id = 0;
Jaeden Ameroe3cdf282019-08-20 12:58:20 +0100382#endif
383 }
Gilles Peskinedc8219a2019-05-15 16:11:15 +0200384}
385
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200386static inline psa_key_lifetime_t psa_get_key_lifetime(
387 const psa_key_attributes_t *attributes)
388{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200389 return( attributes->core.lifetime );
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200390}
391
Gilles Peskine4747d192019-04-17 15:05:45 +0200392static inline void psa_set_key_usage_flags(psa_key_attributes_t *attributes,
393 psa_key_usage_t usage_flags)
394{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200395 attributes->core.policy.usage = usage_flags;
Gilles Peskine4747d192019-04-17 15:05:45 +0200396}
397
398static inline psa_key_usage_t psa_get_key_usage_flags(
399 const psa_key_attributes_t *attributes)
400{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200401 return( attributes->core.policy.usage );
Gilles Peskine4747d192019-04-17 15:05:45 +0200402}
403
404static inline void psa_set_key_algorithm(psa_key_attributes_t *attributes,
405 psa_algorithm_t alg)
406{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200407 attributes->core.policy.alg = alg;
Gilles Peskine4747d192019-04-17 15:05:45 +0200408}
409
410static inline psa_algorithm_t psa_get_key_algorithm(
411 const psa_key_attributes_t *attributes)
412{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200413 return( attributes->core.policy.alg );
Gilles Peskine4747d192019-04-17 15:05:45 +0200414}
415
Gilles Peskine24f10f82019-05-16 12:18:32 +0200416/* This function is declared in crypto_extra.h, which comes after this
417 * header file, but we need the function here, so repeat the declaration. */
418psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes,
419 psa_key_type_t type,
420 const uint8_t *data,
421 size_t data_length);
422
Gilles Peskine4747d192019-04-17 15:05:45 +0200423static inline void psa_set_key_type(psa_key_attributes_t *attributes,
424 psa_key_type_t type)
425{
Gilles Peskineb699f072019-04-26 16:06:02 +0200426 if( attributes->domain_parameters == NULL )
427 {
428 /* Common case: quick path */
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200429 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +0200430 }
431 else
432 {
433 /* Call the bigger function to free the old domain paramteres.
434 * Ignore any errors which may arise due to type requiring
435 * non-default domain parameters, since this function can't
436 * report errors. */
437 (void) psa_set_key_domain_parameters( attributes, type, NULL, 0 );
438 }
Gilles Peskine4747d192019-04-17 15:05:45 +0200439}
440
441static inline psa_key_type_t psa_get_key_type(
442 const psa_key_attributes_t *attributes)
443{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200444 return( attributes->core.type );
Gilles Peskine4747d192019-04-17 15:05:45 +0200445}
446
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200447static inline void psa_set_key_bits(psa_key_attributes_t *attributes,
448 size_t bits)
449{
Gilles Peskine68cc433b2019-07-30 17:42:47 +0200450 if( bits > PSA_MAX_KEY_BITS )
451 attributes->core.bits = PSA_KEY_BITS_TOO_LARGE;
452 else
453 attributes->core.bits = (psa_key_bits_t) bits;
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200454}
455
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200456static inline size_t psa_get_key_bits(
457 const psa_key_attributes_t *attributes)
458{
Gilles Peskine7e0cff92019-07-30 13:48:52 +0200459 return( attributes->core.bits );
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +0200460}
461
Jaeden Amero8013f442019-08-16 16:13:51 +0100462#ifdef __cplusplus
463}
464#endif
465
Gilles Peskine9ef733f2018-02-07 21:05:37 +0100466#endif /* PSA_CRYPTO_STRUCT_H */