Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 1 | /* |
| 2 | * PSA persistent key storage |
| 3 | */ |
Bence Szépkúti | 8697465 | 2020-06-15 11:59:37 +0200 | [diff] [blame] | 4 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 5 | * Copyright The Mbed TLS Contributors |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 6 | * 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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 19 | */ |
| 20 | |
Mateusz Starzyk | 88fa17d | 2021-05-19 17:32:14 +0200 | [diff] [blame] | 21 | #include "common.h" |
| 22 | |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 23 | #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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 30 | #include "mbedtls/platform_util.h" |
| 31 | |
Gilles Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 32 | #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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 39 | #include "mbedtls/platform.h" |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 40 | |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 41 | |
| 42 | |
| 43 | /****************************************************************/ |
| 44 | /* Key storage */ |
| 45 | /****************************************************************/ |
| 46 | |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 47 | /* 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 Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 52 | static psa_storage_uid_t psa_its_identifier_of_slot(mbedtls_svc_key_id_t key) |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 53 | { |
Ronald Cron | ecfb237 | 2020-07-23 17:13:42 +0200 | [diff] [blame] | 54 | #if defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER) |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 55 | /* 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 Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 59 | 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 Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 62 | #else |
| 63 | /* Use the key id directly as a file name. |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 64 | * psa_is_key_id_valid() in psa_crypto_slot_management.c |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 65 | * is responsible for ensuring that key identifiers do not have a |
| 66 | * value that is reserved for non-key files. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 67 | return key; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 68 | #endif |
| 69 | } |
| 70 | |
Gilles Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 71 | /** |
| 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 Peskine | ed73355 | 2023-02-14 19:21:09 +0100 | [diff] [blame] | 82 | * \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 Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 87 | */ |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 88 | static psa_status_t psa_crypto_storage_load( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 89 | const mbedtls_svc_key_id_t key, uint8_t *data, size_t data_size) |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 90 | { |
| 91 | psa_status_t status; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 92 | psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key); |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 93 | struct psa_storage_info_t data_identifier_info; |
Simon D Hughes | bda5a21 | 2019-07-10 16:34:21 +0100 | [diff] [blame] | 94 | size_t data_length = 0; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 95 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 96 | status = psa_its_get_info(data_identifier, &data_identifier_info); |
| 97 | if (status != PSA_SUCCESS) { |
| 98 | return status; |
| 99 | } |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 100 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 101 | 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 Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 105 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 106 | return status; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 107 | } |
| 108 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 109 | int psa_is_key_present_in_storage(const mbedtls_svc_key_id_t key) |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 110 | { |
| 111 | psa_status_t ret; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 112 | psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key); |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 113 | struct psa_storage_info_t data_identifier_info; |
| 114 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 115 | ret = psa_its_get_info(data_identifier, &data_identifier_info); |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 116 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 117 | if (ret == PSA_ERROR_DOES_NOT_EXIST) { |
| 118 | return 0; |
| 119 | } |
| 120 | return 1; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 121 | } |
| 122 | |
Gilles Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 123 | /** |
| 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 Peskine | ed73355 | 2023-02-14 19:21:09 +0100 | [diff] [blame] | 134 | * \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 Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 139 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 140 | static 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 Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 143 | { |
| 144 | psa_status_t status; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 145 | psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key); |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 146 | struct psa_storage_info_t data_identifier_info; |
| 147 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 148 | if (psa_is_key_present_in_storage(key) == 1) { |
| 149 | return PSA_ERROR_ALREADY_EXISTS; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 150 | } |
| 151 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 152 | 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 Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 159 | goto exit; |
| 160 | } |
| 161 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 162 | if (data_identifier_info.size != data_length) { |
gabor-mezei-arm | fe30924 | 2020-11-09 17:39:56 +0100 | [diff] [blame] | 163 | status = PSA_ERROR_DATA_INVALID; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 164 | goto exit; |
| 165 | } |
| 166 | |
| 167 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 168 | if (status != PSA_SUCCESS) { |
Gilles Peskine | 169ca7f | 2020-08-25 22:50:06 +0200 | [diff] [blame] | 169 | /* 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 Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 173 | (void) psa_its_remove(data_identifier); |
Gilles Peskine | 169ca7f | 2020-08-25 22:50:06 +0200 | [diff] [blame] | 174 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 175 | return status; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 176 | } |
| 177 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 178 | psa_status_t psa_destroy_persistent_key(const mbedtls_svc_key_id_t key) |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 179 | { |
| 180 | psa_status_t ret; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 181 | psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key); |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 182 | struct psa_storage_info_t data_identifier_info; |
| 183 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 184 | ret = psa_its_get_info(data_identifier, &data_identifier_info); |
| 185 | if (ret == PSA_ERROR_DOES_NOT_EXIST) { |
| 186 | return PSA_SUCCESS; |
| 187 | } |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 188 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 189 | if (psa_its_remove(data_identifier) != PSA_SUCCESS) { |
| 190 | return PSA_ERROR_DATA_INVALID; |
| 191 | } |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 192 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 193 | 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 Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 197 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 198 | return PSA_SUCCESS; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 199 | } |
| 200 | |
Gilles Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 201 | /** |
| 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 Peskine | ed73355 | 2023-02-14 19:21:09 +0100 | [diff] [blame] | 208 | * \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 Peskine | 5e80d91 | 2019-02-24 17:10:18 +0100 | [diff] [blame] | 212 | */ |
| 213 | static psa_status_t psa_crypto_storage_get_data_length( |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 214 | const mbedtls_svc_key_id_t key, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 215 | size_t *data_length) |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 216 | { |
| 217 | psa_status_t status; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 218 | psa_storage_uid_t data_identifier = psa_its_identifier_of_slot(key); |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 219 | struct psa_storage_info_t data_identifier_info; |
| 220 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 221 | status = psa_its_get_info(data_identifier, &data_identifier_info); |
| 222 | if (status != PSA_SUCCESS) { |
| 223 | return status; |
| 224 | } |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 225 | |
| 226 | *data_length = (size_t) data_identifier_info.size; |
| 227 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 228 | return PSA_SUCCESS; |
Gilles Peskine | 088b77f | 2019-02-24 17:00:27 +0100 | [diff] [blame] | 229 | } |
| 230 | |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 231 | /** |
| 232 | * Persistent key storage magic header. |
| 233 | */ |
| 234 | #define PSA_KEY_STORAGE_MAGIC_HEADER "PSA\0KEY" |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 235 | #define PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH (sizeof(PSA_KEY_STORAGE_MAGIC_HEADER)) |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 236 | |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 237 | typedef struct { |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 238 | uint8_t magic[PSA_KEY_STORAGE_MAGIC_HEADER_LENGTH]; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 239 | uint8_t version[4]; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 240 | uint8_t lifetime[sizeof(psa_key_lifetime_t)]; |
Torstein Nesse | 162a110 | 2020-10-07 10:50:15 +0200 | [diff] [blame] | 241 | uint8_t type[2]; |
| 242 | uint8_t bits[2]; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 243 | uint8_t policy[sizeof(psa_key_policy_t)]; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 244 | uint8_t data_len[4]; |
| 245 | uint8_t key_data[]; |
| 246 | } psa_persistent_key_storage_format; |
| 247 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 248 | void 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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 252 | { |
| 253 | psa_persistent_key_storage_format *storage_format = |
| 254 | (psa_persistent_key_storage_format *) storage_data; |
| 255 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 256 | 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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 267 | } |
| 268 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 269 | static psa_status_t check_magic_header(const uint8_t *data) |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 270 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 271 | 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 Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 276 | } |
| 277 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 278 | psa_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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 283 | { |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 284 | psa_status_t status; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 285 | const psa_persistent_key_storage_format *storage_format = |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 286 | (const psa_persistent_key_storage_format *) storage_data; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 287 | uint32_t version; |
| 288 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 289 | if (storage_data_length < sizeof(*storage_format)) { |
| 290 | return PSA_ERROR_DATA_INVALID; |
| 291 | } |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 292 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 293 | status = check_magic_header(storage_data); |
| 294 | if (status != PSA_SUCCESS) { |
| 295 | return status; |
| 296 | } |
Moran Peker | 96ebf9e | 2018-06-28 18:02:17 +0300 | [diff] [blame] | 297 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 298 | version = MBEDTLS_GET_UINT32_LE(storage_format->version, 0); |
| 299 | if (version != 0) { |
| 300 | return PSA_ERROR_DATA_INVALID; |
| 301 | } |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 302 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 303 | *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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 308 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 309 | if (*key_data_length == 0) { |
Gilles Peskine | 3495b58 | 2019-04-25 13:47:06 +0200 | [diff] [blame] | 310 | *key_data = NULL; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 311 | } 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 Peskine | 3495b58 | 2019-04-25 13:47:06 +0200 | [diff] [blame] | 317 | } |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 318 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 319 | 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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 325 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 326 | return PSA_SUCCESS; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 327 | } |
| 328 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 329 | psa_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 Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 332 | { |
| 333 | size_t storage_data_length; |
| 334 | uint8_t *storage_data; |
| 335 | psa_status_t status; |
| 336 | |
Steven Cooreman | d80e8a4 | 2021-01-26 12:45:39 +0100 | [diff] [blame] | 337 | /* All keys saved to persistent storage always have a key context */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 338 | if (data == NULL || data_length == 0) { |
| 339 | return PSA_ERROR_INVALID_ARGUMENT; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 340 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 341 | |
| 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 Cosgrove | ca8c61b | 2023-07-17 15:17:40 +0100 | [diff] [blame^] | 357 | mbedtls_zeroize_and_free(storage_data, storage_data_length); |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 358 | |
| 359 | return status; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 360 | } |
| 361 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 362 | void psa_free_persistent_key_data(uint8_t *key_data, size_t key_data_length) |
| 363 | { |
Tom Cosgrove | ca8c61b | 2023-07-17 15:17:40 +0100 | [diff] [blame^] | 364 | mbedtls_zeroize_and_free(key_data, key_data_length); |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 365 | } |
| 366 | |
| 367 | psa_status_t psa_load_persistent_key(psa_core_key_attributes_t *attr, |
| 368 | uint8_t **data, |
| 369 | size_t *data_length) |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 370 | { |
| 371 | psa_status_t status = PSA_SUCCESS; |
| 372 | uint8_t *loaded_data; |
| 373 | size_t storage_data_length = 0; |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 374 | mbedtls_svc_key_id_t key = attr->id; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 375 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 376 | status = psa_crypto_storage_get_data_length(key, &storage_data_length); |
| 377 | if (status != PSA_SUCCESS) { |
| 378 | return status; |
| 379 | } |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 380 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 381 | loaded_data = mbedtls_calloc(1, storage_data_length); |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 382 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 383 | if (loaded_data == NULL) { |
| 384 | return PSA_ERROR_INSUFFICIENT_MEMORY; |
| 385 | } |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 386 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 387 | status = psa_crypto_storage_load(key, loaded_data, storage_data_length); |
| 388 | if (status != PSA_SUCCESS) { |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 389 | goto exit; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 390 | } |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 391 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 392 | status = psa_parse_key_data_from_storage(loaded_data, storage_data_length, |
| 393 | data, data_length, attr); |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 394 | |
Steven Cooreman | d80e8a4 | 2021-01-26 12:45:39 +0100 | [diff] [blame] | 395 | /* All keys saved to persistent storage always have a key context */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 396 | if (status == PSA_SUCCESS && |
| 397 | (*data == NULL || *data_length == 0)) { |
Steven Cooreman | d80e8a4 | 2021-01-26 12:45:39 +0100 | [diff] [blame] | 398 | status = PSA_ERROR_STORAGE_FAILURE; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 399 | } |
Steven Cooreman | d80e8a4 | 2021-01-26 12:45:39 +0100 | [diff] [blame] | 400 | |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 401 | exit: |
Tom Cosgrove | ca8c61b | 2023-07-17 15:17:40 +0100 | [diff] [blame^] | 402 | mbedtls_zeroize_and_free(loaded_data, storage_data_length); |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 403 | return status; |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 404 | } |
| 405 | |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 406 | |
| 407 | |
| 408 | /****************************************************************/ |
| 409 | /* Transactions */ |
| 410 | /****************************************************************/ |
| 411 | |
| 412 | #if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) |
| 413 | |
| 414 | psa_crypto_transaction_t psa_crypto_transaction; |
| 415 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 416 | psa_status_t psa_crypto_save_transaction(void) |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 417 | { |
| 418 | struct psa_storage_info_t p_info; |
| 419 | psa_status_t status; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 420 | status = psa_its_get_info(PSA_CRYPTO_ITS_TRANSACTION_UID, &p_info); |
| 421 | if (status == PSA_SUCCESS) { |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 422 | /* This shouldn't happen: we're trying to start a transaction while |
| 423 | * there is still a transaction that hasn't been replayed. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 424 | return PSA_ERROR_CORRUPTION_DETECTED; |
| 425 | } else if (status != PSA_ERROR_DOES_NOT_EXIST) { |
| 426 | return status; |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 427 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 428 | return psa_its_set(PSA_CRYPTO_ITS_TRANSACTION_UID, |
| 429 | sizeof(psa_crypto_transaction), |
| 430 | &psa_crypto_transaction, |
| 431 | 0); |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 432 | } |
| 433 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 434 | psa_status_t psa_crypto_load_transaction(void) |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 435 | { |
Gilles Peskine | 8b66389 | 2019-07-31 17:57:57 +0200 | [diff] [blame] | 436 | psa_status_t status; |
| 437 | size_t length; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 438 | 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 Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 448 | } |
| 449 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 450 | psa_status_t psa_crypto_stop_transaction(void) |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 451 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 452 | psa_status_t status = psa_its_remove(PSA_CRYPTO_ITS_TRANSACTION_UID); |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 453 | /* 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 Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 456 | memset(&psa_crypto_transaction, 0, sizeof(psa_crypto_transaction)); |
| 457 | return status; |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 458 | } |
| 459 | |
| 460 | #endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */ |
| 461 | |
| 462 | |
| 463 | |
| 464 | /****************************************************************/ |
| 465 | /* Random generator state */ |
| 466 | /****************************************************************/ |
| 467 | |
Gilles Peskine | e3dbdd8 | 2019-02-25 11:04:06 +0100 | [diff] [blame] | 468 | #if defined(MBEDTLS_PSA_INJECT_ENTROPY) |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 469 | psa_status_t mbedtls_psa_storage_inject_entropy(const unsigned char *seed, |
| 470 | size_t seed_size) |
Gilles Peskine | e3dbdd8 | 2019-02-25 11:04:06 +0100 | [diff] [blame] | 471 | { |
| 472 | psa_status_t status; |
| 473 | struct psa_storage_info_t p_info; |
| 474 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 475 | status = psa_its_get_info(PSA_CRYPTO_ITS_RANDOM_SEED_UID, &p_info); |
Gilles Peskine | e3dbdd8 | 2019-02-25 11:04:06 +0100 | [diff] [blame] | 476 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 477 | 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 Peskine | e3dbdd8 | 2019-02-25 11:04:06 +0100 | [diff] [blame] | 480 | /* You should not be here. Seed needs to be injected only once */ |
| 481 | status = PSA_ERROR_NOT_PERMITTED; |
| 482 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 483 | return status; |
Gilles Peskine | e3dbdd8 | 2019-02-25 11:04:06 +0100 | [diff] [blame] | 484 | } |
| 485 | #endif /* MBEDTLS_PSA_INJECT_ENTROPY */ |
| 486 | |
Gilles Peskine | c8336cb | 2019-07-22 19:26:12 +0200 | [diff] [blame] | 487 | |
| 488 | |
| 489 | /****************************************************************/ |
| 490 | /* The end */ |
| 491 | /****************************************************************/ |
| 492 | |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 493 | #endif /* MBEDTLS_PSA_CRYPTO_STORAGE_C */ |