blob: 574d4b05ed8417d11d3c5c3db0b512c91e0a2100 [file] [log] [blame]
Darryl Greendb2b8db2018-06-15 13:06:04 +01001/*
2 * PSA persistent key storage
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Darryl Greendb2b8db2018-06-15 13:06:04 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Darryl Greendb2b8db2018-06-15 13:06:04 +010019 */
20
Mateusz Starzyk88fa17d2021-05-19 17:32:14 +020021#include "common.h"
22
Darryl Greendb2b8db2018-06-15 13:06:04 +010023#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
24
25#include <stdlib.h>
26#include <string.h>
27
28#include "psa/crypto.h"
29#include "psa_crypto_storage.h"
Darryl Greendb2b8db2018-06-15 13:06:04 +010030#include "mbedtls/platform_util.h"
31
Gilles Peskine5e80d912019-02-24 17:10:18 +010032#if defined(MBEDTLS_PSA_ITS_FILE_C)
33#include "psa_crypto_its.h"
34#else /* Native ITS implementation */
35#include "psa/error.h"
36#include "psa/internal_trusted_storage.h"
37#endif
38
Darryl Greendb2b8db2018-06-15 13:06:04 +010039#include "mbedtls/platform.h"
Darryl Greendb2b8db2018-06-15 13:06:04 +010040
Gilles Peskinec8336cb2019-07-22 19:26:12 +020041
42
43/****************************************************************/
44/* Key storage */
45/****************************************************************/
46
Ronald Cron71016a92020-08-28 19:01:50 +020047/* Determine a file name (ITS file identifier) for the given key identifier.
48 * The file name must be distinct from any file that is used for a purpose
49 * other than storing a key. Currently, the only such file is the random seed
50 * file whose name is PSA_CRYPTO_ITS_RANDOM_SEED_UID and whose value is
51 * 0xFFFFFF52. */
Gilles Peskine449bd832023-01-11 14:50:10 +010052static psa_storage_uid_t psa_its_identifier_of_slot(mbedtls_svc_key_id_t key)
Gilles Peskine088b77f2019-02-24 17:00:27 +010053{
Ronald Cronecfb2372020-07-23 17:13:42 +020054#if defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
Gilles Peskine088b77f2019-02-24 17:00:27 +010055 /* Encode the owner in the upper 32 bits. This means that if
56 * owner values are nonzero (as they are on a PSA platform),
57 * no key file will ever have a value less than 0x100000000, so
58 * the whole range 0..0xffffffff is available for non-key files. */
Gilles Peskine449bd832023-01-11 14:50:10 +010059 uint32_t unsigned_owner_id = MBEDTLS_SVC_KEY_ID_GET_OWNER_ID(key);
60 return ((uint64_t) unsigned_owner_id << 32) |
61 MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key);
Gilles Peskine088b77f2019-02-24 17:00:27 +010062#else
63 /* Use the key id directly as a file name.
Ronald Cron71016a92020-08-28 19:01:50 +020064 * psa_is_key_id_valid() in psa_crypto_slot_management.c
Gilles Peskine088b77f2019-02-24 17:00:27 +010065 * is responsible for ensuring that key identifiers do not have a
66 * value that is reserved for non-key files. */
Gilles Peskine449bd832023-01-11 14:50:10 +010067 return key;
Gilles Peskine088b77f2019-02-24 17:00:27 +010068#endif
69}
70
Gilles Peskine5e80d912019-02-24 17:10:18 +010071/**
72 * \brief Load persistent data for the given key slot number.
73 *
74 * This function reads data from a storage backend and returns the data in a
75 * buffer.
76 *
77 * \param key Persistent identifier of the key to be loaded. This
78 * should be an occupied storage location.
79 * \param[out] data Buffer where the data is to be written.
80 * \param data_size Size of the \c data buffer in bytes.
81 *
Gilles Peskineed733552023-02-14 19:21:09 +010082 * \retval #PSA_SUCCESS \emptydescription
83 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
84 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
85 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
86 * \retval #PSA_ERROR_DOES_NOT_EXIST \emptydescription
Gilles Peskine5e80d912019-02-24 17:10:18 +010087 */
Ronald Cron71016a92020-08-28 19:01:50 +020088static psa_status_t psa_crypto_storage_load(
Gilles Peskine449bd832023-01-11 14:50:10 +010089 const mbedtls_svc_key_id_t key, uint8_t *data, size_t data_size)
Gilles Peskine088b77f2019-02-24 17:00:27 +010090{
91 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +010092 psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key);
Gilles Peskine088b77f2019-02-24 17:00:27 +010093 struct psa_storage_info_t data_identifier_info;
Simon D Hughesbda5a212019-07-10 16:34:21 +010094 size_t data_length = 0;
Gilles Peskine088b77f2019-02-24 17:00:27 +010095
Gilles Peskine449bd832023-01-11 14:50:10 +010096 status = psa_its_get_info(data_identifier, &data_identifier_info);
97 if (status != PSA_SUCCESS) {
98 return status;
99 }
Gilles Peskine088b77f2019-02-24 17:00:27 +0100100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 status = psa_its_get(data_identifier, 0, (uint32_t) data_size, data, &data_length);
102 if (data_size != data_length) {
103 return PSA_ERROR_DATA_INVALID;
104 }
Gilles Peskine088b77f2019-02-24 17:00:27 +0100105
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 return status;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100107}
108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109int psa_is_key_present_in_storage(const mbedtls_svc_key_id_t key)
Gilles Peskine088b77f2019-02-24 17:00:27 +0100110{
111 psa_status_t ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key);
Gilles Peskine088b77f2019-02-24 17:00:27 +0100113 struct psa_storage_info_t data_identifier_info;
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 ret = psa_its_get_info(data_identifier, &data_identifier_info);
Gilles Peskine088b77f2019-02-24 17:00:27 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (ret == PSA_ERROR_DOES_NOT_EXIST) {
118 return 0;
119 }
120 return 1;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100121}
122
Gilles Peskine5e80d912019-02-24 17:10:18 +0100123/**
124 * \brief Store persistent data for the given key slot number.
125 *
126 * This function stores the given data buffer to a persistent storage.
127 *
128 * \param key Persistent identifier of the key to be stored. This
129 * should be an unoccupied storage location.
130 * \param[in] data Buffer containing the data to be stored.
131 * \param data_length The number of bytes
132 * that make up the data.
133 *
Gilles Peskineed733552023-02-14 19:21:09 +0100134 * \retval #PSA_SUCCESS \emptydescription
135 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
136 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
137 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
138 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
Gilles Peskine5e80d912019-02-24 17:10:18 +0100139 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100140static psa_status_t psa_crypto_storage_store(const mbedtls_svc_key_id_t key,
141 const uint8_t *data,
142 size_t data_length)
Gilles Peskine088b77f2019-02-24 17:00:27 +0100143{
144 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key);
Gilles Peskine088b77f2019-02-24 17:00:27 +0100146 struct psa_storage_info_t data_identifier_info;
147
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (psa_is_key_present_in_storage(key) == 1) {
149 return PSA_ERROR_ALREADY_EXISTS;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100150 }
151
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 status = psa_its_set(data_identifier, (uint32_t) data_length, data, 0);
153 if (status != PSA_SUCCESS) {
154 return PSA_ERROR_DATA_INVALID;
155 }
156
157 status = psa_its_get_info(data_identifier, &data_identifier_info);
158 if (status != PSA_SUCCESS) {
Gilles Peskine088b77f2019-02-24 17:00:27 +0100159 goto exit;
160 }
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 if (data_identifier_info.size != data_length) {
gabor-mezei-armfe309242020-11-09 17:39:56 +0100163 status = PSA_ERROR_DATA_INVALID;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100164 goto exit;
165 }
166
167exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 if (status != PSA_SUCCESS) {
Gilles Peskine169ca7f2020-08-25 22:50:06 +0200169 /* Remove the file in case we managed to create it but something
170 * went wrong. It's ok if the file doesn't exist. If the file exists
171 * but the removal fails, we're already reporting an error so there's
172 * nothing else we can do. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 (void) psa_its_remove(data_identifier);
Gilles Peskine169ca7f2020-08-25 22:50:06 +0200174 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return status;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100176}
177
Gilles Peskine449bd832023-01-11 14:50:10 +0100178psa_status_t psa_destroy_persistent_key(const mbedtls_svc_key_id_t key)
Gilles Peskine088b77f2019-02-24 17:00:27 +0100179{
180 psa_status_t ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key);
Gilles Peskine088b77f2019-02-24 17:00:27 +0100182 struct psa_storage_info_t data_identifier_info;
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 ret = psa_its_get_info(data_identifier, &data_identifier_info);
185 if (ret == PSA_ERROR_DOES_NOT_EXIST) {
186 return PSA_SUCCESS;
187 }
Gilles Peskine088b77f2019-02-24 17:00:27 +0100188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 if (psa_its_remove(data_identifier) != PSA_SUCCESS) {
190 return PSA_ERROR_DATA_INVALID;
191 }
Gilles Peskine088b77f2019-02-24 17:00:27 +0100192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 ret = psa_its_get_info(data_identifier, &data_identifier_info);
194 if (ret != PSA_ERROR_DOES_NOT_EXIST) {
195 return PSA_ERROR_DATA_INVALID;
196 }
Gilles Peskine088b77f2019-02-24 17:00:27 +0100197
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return PSA_SUCCESS;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100199}
200
Gilles Peskine5e80d912019-02-24 17:10:18 +0100201/**
202 * \brief Get data length for given key slot number.
203 *
204 * \param key Persistent identifier whose stored data length
205 * is to be obtained.
206 * \param[out] data_length The number of bytes that make up the data.
207 *
Gilles Peskineed733552023-02-14 19:21:09 +0100208 * \retval #PSA_SUCCESS \emptydescription
209 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
210 * \retval #PSA_ERROR_DOES_NOT_EXIST \emptydescription
211 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
Gilles Peskine5e80d912019-02-24 17:10:18 +0100212 */
213static psa_status_t psa_crypto_storage_get_data_length(
Ronald Cron71016a92020-08-28 19:01:50 +0200214 const mbedtls_svc_key_id_t key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 size_t *data_length)
Gilles Peskine088b77f2019-02-24 17:00:27 +0100216{
217 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key);
Gilles Peskine088b77f2019-02-24 17:00:27 +0100219 struct psa_storage_info_t data_identifier_info;
220
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 status = psa_its_get_info(data_identifier, &data_identifier_info);
222 if (status != PSA_SUCCESS) {
223 return status;
224 }
Gilles Peskine088b77f2019-02-24 17:00:27 +0100225
226 *data_length = (size_t) data_identifier_info.size;
227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 return PSA_SUCCESS;
Gilles Peskine088b77f2019-02-24 17:00:27 +0100229}
230
Moran Peker96ebf9e2018-06-28 18:02:17 +0300231/**
232 * Persistent key storage magic header.
233 */
234#define PSA_KEY_STORAGE_MAGIC_HEADER "PSA\0KEY"
Gilles Peskine449bd832023-01-11 14:50:10 +0100235#define PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH (sizeof(PSA_KEY_STORAGE_MAGIC_HEADER))
Moran Peker96ebf9e2018-06-28 18:02:17 +0300236
Darryl Greendb2b8db2018-06-15 13:06:04 +0100237typedef struct {
Moran Peker96ebf9e2018-06-28 18:02:17 +0300238 uint8_t magic[PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH];
Darryl Greendb2b8db2018-06-15 13:06:04 +0100239 uint8_t version[4];
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 uint8_t lifetime[sizeof(psa_key_lifetime_t)];
Torstein Nesse162a1102020-10-07 10:50:15 +0200241 uint8_t type[2];
242 uint8_t bits[2];
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 uint8_t policy[sizeof(psa_key_policy_t)];
Darryl Greendb2b8db2018-06-15 13:06:04 +0100244 uint8_t data_len[4];
245 uint8_t key_data[];
246} psa_persistent_key_storage_format;
247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248void psa_format_key_data_for_storage(const uint8_t *data,
249 const size_t data_length,
250 const psa_core_key_attributes_t *attr,
251 uint8_t *storage_data)
Darryl Greendb2b8db2018-06-15 13:06:04 +0100252{
253 psa_persistent_key_storage_format *storage_format =
254 (psa_persistent_key_storage_format *) storage_data;
255
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 memcpy(storage_format->magic, PSA_KEY_STORAGE_MAGIC_HEADER,
257 PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH);
258 MBEDTLS_PUT_UINT32_LE(0, storage_format->version, 0);
259 MBEDTLS_PUT_UINT32_LE(attr->lifetime, storage_format->lifetime, 0);
260 MBEDTLS_PUT_UINT16_LE((uint16_t) attr->type, storage_format->type, 0);
261 MBEDTLS_PUT_UINT16_LE((uint16_t) attr->bits, storage_format->bits, 0);
262 MBEDTLS_PUT_UINT32_LE(attr->policy.usage, storage_format->policy, 0);
263 MBEDTLS_PUT_UINT32_LE(attr->policy.alg, storage_format->policy, sizeof(uint32_t));
264 MBEDTLS_PUT_UINT32_LE(attr->policy.alg2, storage_format->policy, 2 * sizeof(uint32_t));
265 MBEDTLS_PUT_UINT32_LE(data_length, storage_format->data_len, 0);
266 memcpy(storage_format->key_data, data, data_length);
Darryl Greendb2b8db2018-06-15 13:06:04 +0100267}
268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269static psa_status_t check_magic_header(const uint8_t *data)
Moran Peker96ebf9e2018-06-28 18:02:17 +0300270{
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 if (memcmp(data, PSA_KEY_STORAGE_MAGIC_HEADER,
272 PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH) != 0) {
273 return PSA_ERROR_DATA_INVALID;
274 }
275 return PSA_SUCCESS;
Moran Peker96ebf9e2018-06-28 18:02:17 +0300276}
277
Gilles Peskine449bd832023-01-11 14:50:10 +0100278psa_status_t psa_parse_key_data_from_storage(const uint8_t *storage_data,
279 size_t storage_data_length,
280 uint8_t **key_data,
281 size_t *key_data_length,
282 psa_core_key_attributes_t *attr)
Darryl Greendb2b8db2018-06-15 13:06:04 +0100283{
Moran Peker96ebf9e2018-06-28 18:02:17 +0300284 psa_status_t status;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100285 const psa_persistent_key_storage_format *storage_format =
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 (const psa_persistent_key_storage_format *) storage_data;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100287 uint32_t version;
288
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (storage_data_length < sizeof(*storage_format)) {
290 return PSA_ERROR_DATA_INVALID;
291 }
Moran Peker96ebf9e2018-06-28 18:02:17 +0300292
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 status = check_magic_header(storage_data);
294 if (status != PSA_SUCCESS) {
295 return status;
296 }
Moran Peker96ebf9e2018-06-28 18:02:17 +0300297
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 version = MBEDTLS_GET_UINT32_LE(storage_format->version, 0);
299 if (version != 0) {
300 return PSA_ERROR_DATA_INVALID;
301 }
Darryl Greendb2b8db2018-06-15 13:06:04 +0100302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 *key_data_length = MBEDTLS_GET_UINT32_LE(storage_format->data_len, 0);
304 if (*key_data_length > (storage_data_length - sizeof(*storage_format)) ||
305 *key_data_length > PSA_CRYPTO_MAX_STORAGE_SIZE) {
306 return PSA_ERROR_DATA_INVALID;
307 }
Darryl Greendb2b8db2018-06-15 13:06:04 +0100308
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 if (*key_data_length == 0) {
Gilles Peskine3495b582019-04-25 13:47:06 +0200310 *key_data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 } else {
312 *key_data = mbedtls_calloc(1, *key_data_length);
313 if (*key_data == NULL) {
314 return PSA_ERROR_INSUFFICIENT_MEMORY;
315 }
316 memcpy(*key_data, storage_format->key_data, *key_data_length);
Gilles Peskine3495b582019-04-25 13:47:06 +0200317 }
Darryl Greendb2b8db2018-06-15 13:06:04 +0100318
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 attr->lifetime = MBEDTLS_GET_UINT32_LE(storage_format->lifetime, 0);
320 attr->type = MBEDTLS_GET_UINT16_LE(storage_format->type, 0);
321 attr->bits = MBEDTLS_GET_UINT16_LE(storage_format->bits, 0);
322 attr->policy.usage = MBEDTLS_GET_UINT32_LE(storage_format->policy, 0);
323 attr->policy.alg = MBEDTLS_GET_UINT32_LE(storage_format->policy, sizeof(uint32_t));
324 attr->policy.alg2 = MBEDTLS_GET_UINT32_LE(storage_format->policy, 2 * sizeof(uint32_t));
Darryl Greendb2b8db2018-06-15 13:06:04 +0100325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_SUCCESS;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100327}
328
Gilles Peskine449bd832023-01-11 14:50:10 +0100329psa_status_t psa_save_persistent_key(const psa_core_key_attributes_t *attr,
330 const uint8_t *data,
331 const size_t data_length)
Darryl Greendb2b8db2018-06-15 13:06:04 +0100332{
333 size_t storage_data_length;
334 uint8_t *storage_data;
335 psa_status_t status;
336
Steven Cooremand80e8a42021-01-26 12:45:39 +0100337 /* All keys saved to persistent storage always have a key context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (data == NULL || data_length == 0) {
339 return PSA_ERROR_INVALID_ARGUMENT;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100340 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100341
342 if (data_length > PSA_CRYPTO_MAX_STORAGE_SIZE) {
343 return PSA_ERROR_INSUFFICIENT_STORAGE;
344 }
345 storage_data_length = data_length + sizeof(psa_persistent_key_storage_format);
346
347 storage_data = mbedtls_calloc(1, storage_data_length);
348 if (storage_data == NULL) {
349 return PSA_ERROR_INSUFFICIENT_MEMORY;
350 }
351
352 psa_format_key_data_for_storage(data, data_length, attr, storage_data);
353
354 status = psa_crypto_storage_store(attr->id,
355 storage_data, storage_data_length);
356
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100357 mbedtls_zeroize_and_free(storage_data, storage_data_length);
Gilles Peskine449bd832023-01-11 14:50:10 +0100358
359 return status;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100360}
361
Gilles Peskine449bd832023-01-11 14:50:10 +0100362void psa_free_persistent_key_data(uint8_t *key_data, size_t key_data_length)
363{
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100364 mbedtls_zeroize_and_free(key_data, key_data_length);
Gilles Peskine449bd832023-01-11 14:50:10 +0100365}
366
367psa_status_t psa_load_persistent_key(psa_core_key_attributes_t *attr,
368 uint8_t **data,
369 size_t *data_length)
Darryl Greendb2b8db2018-06-15 13:06:04 +0100370{
371 psa_status_t status = PSA_SUCCESS;
372 uint8_t *loaded_data;
373 size_t storage_data_length = 0;
Ronald Cron71016a92020-08-28 19:01:50 +0200374 mbedtls_svc_key_id_t key = attr->id;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100375
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 status = psa_crypto_storage_get_data_length(key, &storage_data_length);
377 if (status != PSA_SUCCESS) {
378 return status;
379 }
Darryl Greendb2b8db2018-06-15 13:06:04 +0100380
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 loaded_data = mbedtls_calloc(1, storage_data_length);
Darryl Greendb2b8db2018-06-15 13:06:04 +0100382
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 if (loaded_data == NULL) {
384 return PSA_ERROR_INSUFFICIENT_MEMORY;
385 }
Darryl Greendb2b8db2018-06-15 13:06:04 +0100386
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 status = psa_crypto_storage_load(key, loaded_data, storage_data_length);
388 if (status != PSA_SUCCESS) {
Darryl Greendb2b8db2018-06-15 13:06:04 +0100389 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 }
Darryl Greendb2b8db2018-06-15 13:06:04 +0100391
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 status = psa_parse_key_data_from_storage(loaded_data, storage_data_length,
393 data, data_length, attr);
Darryl Greendb2b8db2018-06-15 13:06:04 +0100394
Steven Cooremand80e8a42021-01-26 12:45:39 +0100395 /* All keys saved to persistent storage always have a key context */
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 if (status == PSA_SUCCESS &&
397 (*data == NULL || *data_length == 0)) {
Steven Cooremand80e8a42021-01-26 12:45:39 +0100398 status = PSA_ERROR_STORAGE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 }
Steven Cooremand80e8a42021-01-26 12:45:39 +0100400
Darryl Greendb2b8db2018-06-15 13:06:04 +0100401exit:
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100402 mbedtls_zeroize_and_free(loaded_data, storage_data_length);
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return status;
Darryl Greendb2b8db2018-06-15 13:06:04 +0100404}
405
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200406
407
408/****************************************************************/
409/* Transactions */
410/****************************************************************/
411
412#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
413
414psa_crypto_transaction_t psa_crypto_transaction;
415
Gilles Peskine449bd832023-01-11 14:50:10 +0100416psa_status_t psa_crypto_save_transaction(void)
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200417{
418 struct psa_storage_info_t p_info;
419 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 status = psa_its_get_info(PSA_CRYPTO_ITS_TRANSACTION_UID, &p_info);
421 if (status == PSA_SUCCESS) {
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200422 /* This shouldn't happen: we're trying to start a transaction while
423 * there is still a transaction that hasn't been replayed. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 return PSA_ERROR_CORRUPTION_DETECTED;
425 } else if (status != PSA_ERROR_DOES_NOT_EXIST) {
426 return status;
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200427 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return psa_its_set(PSA_CRYPTO_ITS_TRANSACTION_UID,
429 sizeof(psa_crypto_transaction),
430 &psa_crypto_transaction,
431 0);
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200432}
433
Gilles Peskine449bd832023-01-11 14:50:10 +0100434psa_status_t psa_crypto_load_transaction(void)
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200435{
Gilles Peskine8b663892019-07-31 17:57:57 +0200436 psa_status_t status;
437 size_t length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 status = psa_its_get(PSA_CRYPTO_ITS_TRANSACTION_UID, 0,
439 sizeof(psa_crypto_transaction),
440 &psa_crypto_transaction, &length);
441 if (status != PSA_SUCCESS) {
442 return status;
443 }
444 if (length != sizeof(psa_crypto_transaction)) {
445 return PSA_ERROR_DATA_INVALID;
446 }
447 return PSA_SUCCESS;
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200448}
449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450psa_status_t psa_crypto_stop_transaction(void)
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200451{
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 psa_status_t status = psa_its_remove(PSA_CRYPTO_ITS_TRANSACTION_UID);
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200453 /* Whether or not updating the storage succeeded, the transaction is
454 * finished now. It's too late to go back, so zero out the in-memory
455 * data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 memset(&psa_crypto_transaction, 0, sizeof(psa_crypto_transaction));
457 return status;
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200458}
459
460#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
461
462
463
464/****************************************************************/
465/* Random generator state */
466/****************************************************************/
467
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100468#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +0100469psa_status_t mbedtls_psa_storage_inject_entropy(const unsigned char *seed,
470 size_t seed_size)
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100471{
472 psa_status_t status;
473 struct psa_storage_info_t p_info;
474
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 status = psa_its_get_info(PSA_CRYPTO_ITS_RANDOM_SEED_UID, &p_info);
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100476
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 if (PSA_ERROR_DOES_NOT_EXIST == status) { /* No seed exists */
478 status = psa_its_set(PSA_CRYPTO_ITS_RANDOM_SEED_UID, seed_size, seed, 0);
479 } else if (PSA_SUCCESS == status) {
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100480 /* You should not be here. Seed needs to be injected only once */
481 status = PSA_ERROR_NOT_PERMITTED;
482 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 return status;
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100484}
485#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
486
Gilles Peskinec8336cb2019-07-22 19:26:12 +0200487
488
489/****************************************************************/
490/* The end */
491/****************************************************************/
492
Darryl Greendb2b8db2018-06-15 13:06:04 +0100493#endif /* MBEDTLS_PSA_CRYPTO_STORAGE_C */