Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 1 | /** |
| 2 | * PSA API key derivation demonstration |
| 3 | * |
| 4 | * This program calculates a key ladder: a chain of secret material, each |
| 5 | * derived from the previous one in a deterministic way based on a label. |
| 6 | * Two keys are identical if and only if they are derived from the same key |
| 7 | * using the same label. |
| 8 | * |
| 9 | * The initial key is called the master key. The master key is normally |
| 10 | * randomly generated, but it could itself be derived from another key. |
| 11 | * |
| 12 | * This program derives a series of keys called intermediate keys. |
| 13 | * The first intermediate key is derived from the master key using the |
| 14 | * first label passed on the command line. Each subsequent intermediate |
| 15 | * key is derived from the previous one using the next label passed |
| 16 | * on the command line. |
| 17 | * |
| 18 | * This program has four modes of operation: |
| 19 | * |
| 20 | * - "generate": generate a random master key. |
| 21 | * - "wrap": derive a wrapping key from the last intermediate key, |
| 22 | * and use that key to encrypt-and-authenticate some data. |
| 23 | * - "unwrap": derive a wrapping key from the last intermediate key, |
| 24 | * and use that key to decrypt-and-authenticate some |
| 25 | * ciphertext created by wrap mode. |
| 26 | * - "save": save the last intermediate key so that it can be reused as |
| 27 | * the master key in another run of the program. |
| 28 | * |
| 29 | * See the usage() output for the command line usage. See the file |
| 30 | * `key_ladder_demo.sh` for an example run. |
| 31 | */ |
| 32 | |
Bence Szépkúti | 8697465 | 2020-06-15 11:59:37 +0200 | [diff] [blame] | 33 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 34 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 35 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 36 | */ |
| 37 | |
| 38 | /* First include Mbed TLS headers to get the Mbed TLS configuration and |
| 39 | * platform definitions that we'll use in this program. Also include |
| 40 | * standard C headers for functions we'll use here. */ |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 41 | #include "mbedtls/build_info.h" |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 42 | |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 43 | #include <stdlib.h> |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 44 | #include <stdio.h> |
| 45 | #include <string.h> |
| 46 | |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 47 | #include "mbedtls/platform.h" // for mbedtls_setbuf |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 48 | #include "mbedtls/platform_util.h" // for mbedtls_platform_zeroize |
| 49 | |
Gilles Peskine | 4e2cc53 | 2019-05-29 14:30:27 +0200 | [diff] [blame] | 50 | #include <psa/crypto.h> |
| 51 | |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 52 | /* If the build options we need are not enabled, compile a placeholder. */ |
Manuel Pégourié-Gonnard | 33783b4 | 2023-03-21 17:24:20 +0100 | [diff] [blame] | 53 | #if !defined(PSA_WANT_ALG_SHA_256) || !defined(MBEDTLS_MD_C) || \ |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 54 | !defined(MBEDTLS_AES_C) || !defined(MBEDTLS_CCM_C) || \ |
| 55 | !defined(MBEDTLS_PSA_CRYPTO_C) || !defined(MBEDTLS_FS_IO) || \ |
| 56 | defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER) |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 57 | int main(void) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 58 | { |
Manuel Pégourié-Gonnard | 33783b4 | 2023-03-21 17:24:20 +0100 | [diff] [blame] | 59 | printf("PSA_WANT_ALG_SHA_256 and/or MBEDTLS_MD_C and/or " |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 60 | "MBEDTLS_AES_C and/or MBEDTLS_CCM_C and/or " |
| 61 | "MBEDTLS_PSA_CRYPTO_C and/or MBEDTLS_FS_IO " |
| 62 | "not defined and/or MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER " |
| 63 | "defined.\n"); |
| 64 | return 0; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 65 | } |
| 66 | #else |
| 67 | |
| 68 | /* The real program starts here. */ |
| 69 | |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 70 | /* Run a system function and bail out if it fails. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 71 | #define SYS_CHECK(expr) \ |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 72 | do \ |
| 73 | { \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 74 | if (!(expr)) \ |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 75 | { \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 76 | perror( #expr); \ |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 77 | status = DEMO_ERROR; \ |
| 78 | goto exit; \ |
| 79 | } \ |
| 80 | } \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 81 | while (0) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 82 | |
| 83 | /* Run a PSA function and bail out if it fails. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 84 | #define PSA_CHECK(expr) \ |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 85 | do \ |
| 86 | { \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 87 | status = (expr); \ |
| 88 | if (status != PSA_SUCCESS) \ |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 89 | { \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 90 | printf("Error %d at line %d: %s\n", \ |
| 91 | (int) status, \ |
| 92 | __LINE__, \ |
| 93 | #expr); \ |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 94 | goto exit; \ |
| 95 | } \ |
| 96 | } \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 97 | while (0) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 98 | |
| 99 | /* To report operational errors in this program, use an error code that is |
| 100 | * different from every PSA error code. */ |
| 101 | #define DEMO_ERROR 120 |
| 102 | |
| 103 | /* The maximum supported key ladder depth. */ |
| 104 | #define MAX_LADDER_DEPTH 10 |
| 105 | |
| 106 | /* Salt to use when deriving an intermediate key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 107 | #define DERIVE_KEY_SALT ((uint8_t *) "key_ladder_demo.derive") |
| 108 | #define DERIVE_KEY_SALT_LENGTH (strlen((const char *) DERIVE_KEY_SALT)) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 109 | |
| 110 | /* Salt to use when deriving a wrapping key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 111 | #define WRAPPING_KEY_SALT ((uint8_t *) "key_ladder_demo.wrap") |
| 112 | #define WRAPPING_KEY_SALT_LENGTH (strlen((const char *) WRAPPING_KEY_SALT)) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 113 | |
| 114 | /* Size of the key derivation keys (applies both to the master key and |
| 115 | * to intermediate keys). */ |
| 116 | #define KEY_SIZE_BYTES 40 |
| 117 | |
| 118 | /* Algorithm for key derivation. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 119 | #define KDF_ALG PSA_ALG_HKDF(PSA_ALG_SHA_256) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 120 | |
| 121 | /* Type and size of the key used to wrap data. */ |
| 122 | #define WRAPPING_KEY_TYPE PSA_KEY_TYPE_AES |
| 123 | #define WRAPPING_KEY_BITS 128 |
| 124 | |
| 125 | /* Cipher mode used to wrap data. */ |
| 126 | #define WRAPPING_ALG PSA_ALG_CCM |
| 127 | |
| 128 | /* Nonce size used to wrap data. */ |
| 129 | #define WRAPPING_IV_SIZE 13 |
| 130 | |
| 131 | /* Header used in files containing wrapped data. We'll save this header |
| 132 | * directly without worrying about data representation issues such as |
| 133 | * integer sizes and endianness, because the data is meant to be read |
| 134 | * back by the same program on the same machine. */ |
| 135 | #define WRAPPED_DATA_MAGIC "key_ladder_demo" // including trailing null byte |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 136 | #define WRAPPED_DATA_MAGIC_LENGTH (sizeof(WRAPPED_DATA_MAGIC)) |
| 137 | typedef struct { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 138 | char magic[WRAPPED_DATA_MAGIC_LENGTH]; |
| 139 | size_t ad_size; /* Size of the additional data, which is this header. */ |
| 140 | size_t payload_size; /* Size of the encrypted data. */ |
| 141 | /* Store the IV inside the additional data. It's convenient. */ |
| 142 | uint8_t iv[WRAPPING_IV_SIZE]; |
| 143 | } wrapped_data_header_t; |
| 144 | |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 145 | /* The modes that this program can operate in (see usage). */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 146 | enum program_mode { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 147 | MODE_GENERATE, |
| 148 | MODE_SAVE, |
| 149 | MODE_UNWRAP, |
| 150 | MODE_WRAP |
| 151 | }; |
| 152 | |
| 153 | /* Save a key to a file. In the real world, you may want to export a derived |
| 154 | * key sometimes, to share it with another party. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 155 | static psa_status_t save_key(psa_key_id_t key, |
| 156 | const char *output_file_name) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 157 | { |
| 158 | psa_status_t status = PSA_SUCCESS; |
| 159 | uint8_t key_data[KEY_SIZE_BYTES]; |
| 160 | size_t key_size; |
| 161 | FILE *key_file = NULL; |
| 162 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 163 | PSA_CHECK(psa_export_key(key, |
| 164 | key_data, sizeof(key_data), |
| 165 | &key_size)); |
| 166 | SYS_CHECK((key_file = fopen(output_file_name, "wb")) != NULL); |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 167 | /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 168 | mbedtls_setbuf(key_file, NULL); |
| 169 | SYS_CHECK(fwrite(key_data, 1, key_size, key_file) == key_size); |
| 170 | SYS_CHECK(fclose(key_file) == 0); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 171 | key_file = NULL; |
| 172 | |
| 173 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 174 | if (key_file != NULL) { |
| 175 | fclose(key_file); |
| 176 | } |
| 177 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 178 | } |
| 179 | |
| 180 | /* Generate a master key for use in this demo. |
| 181 | * |
| 182 | * Normally a master key would be non-exportable. For the purpose of this |
| 183 | * demo, we want to save it to a file, to avoid relying on the keystore |
| 184 | * capability of the PSA crypto library. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 185 | static psa_status_t generate(const char *key_file_name) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 186 | { |
| 187 | psa_status_t status = PSA_SUCCESS; |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 188 | psa_key_id_t key = 0; |
Gilles Peskine | dfea0a25 | 2019-04-18 13:39:40 +0200 | [diff] [blame] | 189 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 190 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 191 | psa_set_key_usage_flags(&attributes, |
| 192 | PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT); |
| 193 | psa_set_key_algorithm(&attributes, KDF_ALG); |
| 194 | psa_set_key_type(&attributes, PSA_KEY_TYPE_DERIVE); |
| 195 | psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(KEY_SIZE_BYTES)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 196 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 197 | PSA_CHECK(psa_generate_key(&attributes, &key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 198 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 199 | PSA_CHECK(save_key(key, key_file_name)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 200 | |
| 201 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 202 | (void) psa_destroy_key(key); |
| 203 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 204 | } |
| 205 | |
| 206 | /* Load the master key from a file. |
| 207 | * |
| 208 | * In the real world, this master key would be stored in an internal memory |
| 209 | * and the storage would be managed by the keystore capability of the PSA |
| 210 | * crypto library. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 211 | static psa_status_t import_key_from_file(psa_key_usage_t usage, |
| 212 | psa_algorithm_t alg, |
| 213 | const char *key_file_name, |
| 214 | psa_key_id_t *master_key) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 215 | { |
| 216 | psa_status_t status = PSA_SUCCESS; |
Gilles Peskine | dfea0a25 | 2019-04-18 13:39:40 +0200 | [diff] [blame] | 217 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 218 | uint8_t key_data[KEY_SIZE_BYTES]; |
| 219 | size_t key_size; |
| 220 | FILE *key_file = NULL; |
| 221 | unsigned char extra_byte; |
| 222 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 223 | SYS_CHECK((key_file = fopen(key_file_name, "rb")) != NULL); |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 224 | /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 225 | mbedtls_setbuf(key_file, NULL); |
| 226 | SYS_CHECK((key_size = fread(key_data, 1, sizeof(key_data), |
| 227 | key_file)) != 0); |
| 228 | if (fread(&extra_byte, 1, 1, key_file) != 0) { |
| 229 | printf("Key file too large (max: %u).\n", |
| 230 | (unsigned) sizeof(key_data)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 231 | status = DEMO_ERROR; |
| 232 | goto exit; |
| 233 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 234 | SYS_CHECK(fclose(key_file) == 0); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 235 | key_file = NULL; |
| 236 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 237 | psa_set_key_usage_flags(&attributes, usage); |
| 238 | psa_set_key_algorithm(&attributes, alg); |
| 239 | psa_set_key_type(&attributes, PSA_KEY_TYPE_DERIVE); |
| 240 | PSA_CHECK(psa_import_key(&attributes, key_data, key_size, master_key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 241 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 242 | if (key_file != NULL) { |
| 243 | fclose(key_file); |
| 244 | } |
| 245 | mbedtls_platform_zeroize(key_data, sizeof(key_data)); |
| 246 | if (status != PSA_SUCCESS) { |
Gilles Peskine | 5163a92 | 2019-05-27 14:52:34 +0200 | [diff] [blame] | 247 | /* If the key creation hasn't happened yet or has failed, |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 248 | * *master_key is null. psa_destroy_key( 0 ) is |
| 249 | * guaranteed to do nothing and return PSA_SUCCESS. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 250 | (void) psa_destroy_key(*master_key); |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 251 | *master_key = 0; |
Gilles Peskine | b0edfb5 | 2018-12-03 16:24:51 +0100 | [diff] [blame] | 252 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 253 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 254 | } |
| 255 | |
| 256 | /* Derive the intermediate keys, using the list of labels provided on |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 257 | * the command line. On input, *key is the master key identifier. |
| 258 | * This function destroys the master key. On successful output, *key |
| 259 | * is the identifier of the final derived key. |
| 260 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 261 | static psa_status_t derive_key_ladder(const char *ladder[], |
| 262 | size_t ladder_depth, |
| 263 | psa_key_id_t *key) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 264 | { |
| 265 | psa_status_t status = PSA_SUCCESS; |
Gilles Peskine | dfea0a25 | 2019-04-18 13:39:40 +0200 | [diff] [blame] | 266 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
Gilles Peskine | 4e2cc53 | 2019-05-29 14:30:27 +0200 | [diff] [blame] | 267 | psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 268 | size_t i; |
Gilles Peskine | dfea0a25 | 2019-04-18 13:39:40 +0200 | [diff] [blame] | 269 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 270 | psa_set_key_usage_flags(&attributes, |
| 271 | PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT); |
| 272 | psa_set_key_algorithm(&attributes, KDF_ALG); |
| 273 | psa_set_key_type(&attributes, PSA_KEY_TYPE_DERIVE); |
| 274 | psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(KEY_SIZE_BYTES)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 275 | |
| 276 | /* For each label in turn, ... */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 277 | for (i = 0; i < ladder_depth; i++) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 278 | /* Start deriving material from the master key (if i=0) or from |
| 279 | * the current intermediate key (if i>0). */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 280 | PSA_CHECK(psa_key_derivation_setup(&operation, KDF_ALG)); |
| 281 | PSA_CHECK(psa_key_derivation_input_bytes( |
| 282 | &operation, PSA_KEY_DERIVATION_INPUT_SALT, |
| 283 | DERIVE_KEY_SALT, DERIVE_KEY_SALT_LENGTH)); |
| 284 | PSA_CHECK(psa_key_derivation_input_key( |
| 285 | &operation, PSA_KEY_DERIVATION_INPUT_SECRET, |
| 286 | *key)); |
| 287 | PSA_CHECK(psa_key_derivation_input_bytes( |
| 288 | &operation, PSA_KEY_DERIVATION_INPUT_INFO, |
| 289 | (uint8_t *) ladder[i], strlen(ladder[i]))); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 290 | /* When the parent key is not the master key, destroy it, |
| 291 | * since it is no longer needed. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 292 | PSA_CHECK(psa_destroy_key(*key)); |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 293 | *key = 0; |
Gilles Peskine | 4e2cc53 | 2019-05-29 14:30:27 +0200 | [diff] [blame] | 294 | /* Derive the next intermediate key from the parent key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 295 | PSA_CHECK(psa_key_derivation_output_key(&attributes, &operation, |
| 296 | key)); |
| 297 | PSA_CHECK(psa_key_derivation_abort(&operation)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 298 | } |
| 299 | |
| 300 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 301 | psa_key_derivation_abort(&operation); |
| 302 | if (status != PSA_SUCCESS) { |
| 303 | psa_destroy_key(*key); |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 304 | *key = 0; |
Gilles Peskine | b0edfb5 | 2018-12-03 16:24:51 +0100 | [diff] [blame] | 305 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 306 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 307 | } |
| 308 | |
| 309 | /* Derive a wrapping key from the last intermediate key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 310 | static psa_status_t derive_wrapping_key(psa_key_usage_t usage, |
| 311 | psa_key_id_t derived_key, |
| 312 | psa_key_id_t *wrapping_key) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 313 | { |
| 314 | psa_status_t status = PSA_SUCCESS; |
Gilles Peskine | dfea0a25 | 2019-04-18 13:39:40 +0200 | [diff] [blame] | 315 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
Gilles Peskine | 4e2cc53 | 2019-05-29 14:30:27 +0200 | [diff] [blame] | 316 | psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 317 | |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 318 | *wrapping_key = 0; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 319 | |
Gilles Peskine | 2a38e24 | 2019-05-29 14:33:00 +0200 | [diff] [blame] | 320 | /* Set up a key derivation operation from the key derived from |
| 321 | * the master key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 322 | PSA_CHECK(psa_key_derivation_setup(&operation, KDF_ALG)); |
| 323 | PSA_CHECK(psa_key_derivation_input_bytes( |
| 324 | &operation, PSA_KEY_DERIVATION_INPUT_SALT, |
| 325 | WRAPPING_KEY_SALT, WRAPPING_KEY_SALT_LENGTH)); |
| 326 | PSA_CHECK(psa_key_derivation_input_key( |
| 327 | &operation, PSA_KEY_DERIVATION_INPUT_SECRET, |
| 328 | derived_key)); |
| 329 | PSA_CHECK(psa_key_derivation_input_bytes( |
| 330 | &operation, PSA_KEY_DERIVATION_INPUT_INFO, |
| 331 | NULL, 0)); |
Gilles Peskine | 2a38e24 | 2019-05-29 14:33:00 +0200 | [diff] [blame] | 332 | |
| 333 | /* Create the wrapping key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 334 | psa_set_key_usage_flags(&attributes, usage); |
| 335 | psa_set_key_algorithm(&attributes, WRAPPING_ALG); |
| 336 | psa_set_key_type(&attributes, PSA_KEY_TYPE_AES); |
| 337 | psa_set_key_bits(&attributes, WRAPPING_KEY_BITS); |
| 338 | PSA_CHECK(psa_key_derivation_output_key(&attributes, &operation, |
| 339 | wrapping_key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 340 | |
| 341 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 342 | psa_key_derivation_abort(&operation); |
| 343 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 344 | } |
| 345 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 346 | static psa_status_t wrap_data(const char *input_file_name, |
| 347 | const char *output_file_name, |
| 348 | psa_key_id_t wrapping_key) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 349 | { |
| 350 | psa_status_t status; |
| 351 | FILE *input_file = NULL; |
| 352 | FILE *output_file = NULL; |
Bence Szépkúti | ec174e2 | 2021-03-19 18:46:15 +0100 | [diff] [blame] | 353 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
| 354 | psa_key_type_t key_type; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 355 | long input_position; |
| 356 | size_t input_size; |
Gilles Peskine | 5e09bc7 | 2018-12-21 12:06:15 +0100 | [diff] [blame] | 357 | size_t buffer_size = 0; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 358 | unsigned char *buffer = NULL; |
| 359 | size_t ciphertext_size; |
| 360 | wrapped_data_header_t header; |
| 361 | |
| 362 | /* Find the size of the data to wrap. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 363 | SYS_CHECK((input_file = fopen(input_file_name, "rb")) != NULL); |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 364 | /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 365 | mbedtls_setbuf(input_file, NULL); |
| 366 | SYS_CHECK(fseek(input_file, 0, SEEK_END) == 0); |
| 367 | SYS_CHECK((input_position = ftell(input_file)) != -1); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 368 | #if LONG_MAX > SIZE_MAX |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 369 | if (input_position > SIZE_MAX) { |
| 370 | printf("Input file too large.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 371 | status = DEMO_ERROR; |
| 372 | goto exit; |
| 373 | } |
| 374 | #endif |
| 375 | input_size = input_position; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 376 | PSA_CHECK(psa_get_key_attributes(wrapping_key, &attributes)); |
| 377 | key_type = psa_get_key_type(&attributes); |
Bence Szépkúti | ec174e2 | 2021-03-19 18:46:15 +0100 | [diff] [blame] | 378 | buffer_size = |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 379 | PSA_AEAD_ENCRYPT_OUTPUT_SIZE(key_type, WRAPPING_ALG, input_size); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 380 | /* Check for integer overflow. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 381 | if (buffer_size < input_size) { |
| 382 | printf("Input file too large.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 383 | status = DEMO_ERROR; |
| 384 | goto exit; |
| 385 | } |
| 386 | |
| 387 | /* Load the data to wrap. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 388 | SYS_CHECK(fseek(input_file, 0, SEEK_SET) == 0); |
| 389 | SYS_CHECK((buffer = calloc(1, buffer_size)) != NULL); |
| 390 | SYS_CHECK(fread(buffer, 1, input_size, input_file) == input_size); |
| 391 | SYS_CHECK(fclose(input_file) == 0); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 392 | input_file = NULL; |
| 393 | |
| 394 | /* Construct a header. */ |
Ronald Cron | 3e9cc2c | 2024-10-22 15:39:33 +0200 | [diff] [blame^] | 395 | memset(&header, 0, sizeof(header)); |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 396 | memcpy(&header.magic, WRAPPED_DATA_MAGIC, WRAPPED_DATA_MAGIC_LENGTH); |
| 397 | header.ad_size = sizeof(header); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 398 | header.payload_size = input_size; |
| 399 | |
| 400 | /* Wrap the data. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 401 | PSA_CHECK(psa_generate_random(header.iv, WRAPPING_IV_SIZE)); |
| 402 | PSA_CHECK(psa_aead_encrypt(wrapping_key, WRAPPING_ALG, |
| 403 | header.iv, WRAPPING_IV_SIZE, |
| 404 | (uint8_t *) &header, sizeof(header), |
| 405 | buffer, input_size, |
| 406 | buffer, buffer_size, |
| 407 | &ciphertext_size)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 408 | |
| 409 | /* Write the output. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 410 | SYS_CHECK((output_file = fopen(output_file_name, "wb")) != NULL); |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 411 | /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 412 | mbedtls_setbuf(output_file, NULL); |
| 413 | SYS_CHECK(fwrite(&header, 1, sizeof(header), |
| 414 | output_file) == sizeof(header)); |
| 415 | SYS_CHECK(fwrite(buffer, 1, ciphertext_size, |
| 416 | output_file) == ciphertext_size); |
| 417 | SYS_CHECK(fclose(output_file) == 0); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 418 | output_file = NULL; |
| 419 | |
| 420 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 421 | if (input_file != NULL) { |
| 422 | fclose(input_file); |
| 423 | } |
| 424 | if (output_file != NULL) { |
| 425 | fclose(output_file); |
| 426 | } |
| 427 | if (buffer != NULL) { |
| 428 | mbedtls_platform_zeroize(buffer, buffer_size); |
| 429 | } |
| 430 | free(buffer); |
| 431 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 432 | } |
| 433 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 434 | static psa_status_t unwrap_data(const char *input_file_name, |
| 435 | const char *output_file_name, |
| 436 | psa_key_id_t wrapping_key) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 437 | { |
| 438 | psa_status_t status; |
| 439 | FILE *input_file = NULL; |
| 440 | FILE *output_file = NULL; |
Bence Szépkúti | ec174e2 | 2021-03-19 18:46:15 +0100 | [diff] [blame] | 441 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
| 442 | psa_key_type_t key_type; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 443 | unsigned char *buffer = NULL; |
Gilles Peskine | 5e09bc7 | 2018-12-21 12:06:15 +0100 | [diff] [blame] | 444 | size_t ciphertext_size = 0; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 445 | size_t plaintext_size; |
| 446 | wrapped_data_header_t header; |
| 447 | unsigned char extra_byte; |
| 448 | |
| 449 | /* Load and validate the header. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 450 | SYS_CHECK((input_file = fopen(input_file_name, "rb")) != NULL); |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 451 | /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 452 | mbedtls_setbuf(input_file, NULL); |
| 453 | SYS_CHECK(fread(&header, 1, sizeof(header), |
| 454 | input_file) == sizeof(header)); |
| 455 | if (memcmp(&header.magic, WRAPPED_DATA_MAGIC, |
| 456 | WRAPPED_DATA_MAGIC_LENGTH) != 0) { |
| 457 | printf("The input does not start with a valid magic header.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 458 | status = DEMO_ERROR; |
| 459 | goto exit; |
| 460 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 461 | if (header.ad_size != sizeof(header)) { |
| 462 | printf("The header size is not correct.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 463 | status = DEMO_ERROR; |
| 464 | goto exit; |
| 465 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 466 | PSA_CHECK(psa_get_key_attributes(wrapping_key, &attributes)); |
| 467 | key_type = psa_get_key_type(&attributes); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 468 | ciphertext_size = |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 469 | PSA_AEAD_ENCRYPT_OUTPUT_SIZE(key_type, WRAPPING_ALG, header.payload_size); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 470 | /* Check for integer overflow. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 471 | if (ciphertext_size < header.payload_size) { |
| 472 | printf("Input file too large.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 473 | status = DEMO_ERROR; |
| 474 | goto exit; |
| 475 | } |
| 476 | |
| 477 | /* Load the payload data. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 478 | SYS_CHECK((buffer = calloc(1, ciphertext_size)) != NULL); |
| 479 | SYS_CHECK(fread(buffer, 1, ciphertext_size, |
| 480 | input_file) == ciphertext_size); |
| 481 | if (fread(&extra_byte, 1, 1, input_file) != 0) { |
| 482 | printf("Extra garbage after ciphertext\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 483 | status = DEMO_ERROR; |
| 484 | goto exit; |
| 485 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 486 | SYS_CHECK(fclose(input_file) == 0); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 487 | input_file = NULL; |
| 488 | |
| 489 | /* Unwrap the data. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 490 | PSA_CHECK(psa_aead_decrypt(wrapping_key, WRAPPING_ALG, |
| 491 | header.iv, WRAPPING_IV_SIZE, |
| 492 | (uint8_t *) &header, sizeof(header), |
| 493 | buffer, ciphertext_size, |
| 494 | buffer, ciphertext_size, |
| 495 | &plaintext_size)); |
| 496 | if (plaintext_size != header.payload_size) { |
| 497 | printf("Incorrect payload size in the header.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 498 | status = DEMO_ERROR; |
| 499 | goto exit; |
| 500 | } |
| 501 | |
| 502 | /* Write the output. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 503 | SYS_CHECK((output_file = fopen(output_file_name, "wb")) != NULL); |
Gilles Peskine | 6d576c9 | 2022-06-30 17:06:11 +0200 | [diff] [blame] | 504 | /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 505 | mbedtls_setbuf(output_file, NULL); |
| 506 | SYS_CHECK(fwrite(buffer, 1, plaintext_size, |
| 507 | output_file) == plaintext_size); |
| 508 | SYS_CHECK(fclose(output_file) == 0); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 509 | output_file = NULL; |
| 510 | |
| 511 | exit: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 512 | if (input_file != NULL) { |
| 513 | fclose(input_file); |
| 514 | } |
| 515 | if (output_file != NULL) { |
| 516 | fclose(output_file); |
| 517 | } |
| 518 | if (buffer != NULL) { |
| 519 | mbedtls_platform_zeroize(buffer, ciphertext_size); |
| 520 | } |
| 521 | free(buffer); |
| 522 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 523 | } |
| 524 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 525 | static psa_status_t run(enum program_mode mode, |
| 526 | const char *key_file_name, |
| 527 | const char *ladder[], size_t ladder_depth, |
| 528 | const char *input_file_name, |
| 529 | const char *output_file_name) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 530 | { |
| 531 | psa_status_t status = PSA_SUCCESS; |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 532 | psa_key_id_t derivation_key = 0; |
| 533 | psa_key_id_t wrapping_key = 0; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 534 | |
| 535 | /* Initialize the PSA crypto library. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 536 | PSA_CHECK(psa_crypto_init()); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 537 | |
| 538 | /* Generate mode is unlike the others. Generate the master key and exit. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 539 | if (mode == MODE_GENERATE) { |
| 540 | return generate(key_file_name); |
| 541 | } |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 542 | |
| 543 | /* Read the master key. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 544 | PSA_CHECK(import_key_from_file(PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT, |
| 545 | KDF_ALG, |
| 546 | key_file_name, |
| 547 | &derivation_key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 548 | |
| 549 | /* Calculate the derived key for this session. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 550 | PSA_CHECK(derive_key_ladder(ladder, ladder_depth, |
| 551 | &derivation_key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 552 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 553 | switch (mode) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 554 | case MODE_SAVE: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 555 | PSA_CHECK(save_key(derivation_key, output_file_name)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 556 | break; |
| 557 | case MODE_UNWRAP: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 558 | PSA_CHECK(derive_wrapping_key(PSA_KEY_USAGE_DECRYPT, |
| 559 | derivation_key, |
| 560 | &wrapping_key)); |
| 561 | PSA_CHECK(unwrap_data(input_file_name, output_file_name, |
| 562 | wrapping_key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 563 | break; |
| 564 | case MODE_WRAP: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 565 | PSA_CHECK(derive_wrapping_key(PSA_KEY_USAGE_ENCRYPT, |
| 566 | derivation_key, |
| 567 | &wrapping_key)); |
| 568 | PSA_CHECK(wrap_data(input_file_name, output_file_name, |
| 569 | wrapping_key)); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 570 | break; |
| 571 | default: |
| 572 | /* Unreachable but some compilers don't realize it. */ |
| 573 | break; |
| 574 | } |
| 575 | |
| 576 | exit: |
Ronald Cron | adc2ff2 | 2020-09-16 16:49:27 +0200 | [diff] [blame] | 577 | /* Destroy any remaining key. Deinitializing the crypto library would do |
| 578 | * this anyway since they are volatile keys, but explicitly destroying |
Ronald Cron | 77c89f5 | 2020-11-10 17:45:56 +0100 | [diff] [blame] | 579 | * keys makes the code easier to reuse. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 580 | (void) psa_destroy_key(derivation_key); |
| 581 | (void) psa_destroy_key(wrapping_key); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 582 | /* Deinitialize the PSA crypto library. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 583 | mbedtls_psa_crypto_free(); |
| 584 | return status; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 585 | } |
| 586 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 587 | static void usage(void) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 588 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 589 | printf("Usage: key_ladder_demo MODE [OPTION=VALUE]...\n"); |
| 590 | printf("Demonstrate the usage of a key derivation ladder.\n"); |
| 591 | printf("\n"); |
| 592 | printf("Modes:\n"); |
| 593 | printf(" generate Generate the master key\n"); |
| 594 | printf(" save Save the derived key\n"); |
| 595 | printf(" unwrap Unwrap (decrypt) input with the derived key\n"); |
| 596 | printf(" wrap Wrap (encrypt) input with the derived key\n"); |
| 597 | printf("\n"); |
| 598 | printf("Options:\n"); |
| 599 | printf(" input=FILENAME Input file (required for wrap/unwrap)\n"); |
| 600 | printf(" master=FILENAME File containing the master key (default: master.key)\n"); |
| 601 | printf(" output=FILENAME Output file (required for save/wrap/unwrap)\n"); |
| 602 | printf(" label=TEXT Label for the key derivation.\n"); |
| 603 | printf(" This may be repeated multiple times.\n"); |
| 604 | printf(" To get the same key, you must use the same master key\n"); |
| 605 | printf(" and the same sequence of labels.\n"); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 606 | } |
| 607 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 608 | int main(int argc, char *argv[]) |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 609 | { |
Gilles Peskine | 738f017 | 2019-01-02 17:25:16 +0100 | [diff] [blame] | 610 | const char *key_file_name = "master.key"; |
| 611 | const char *input_file_name = NULL; |
| 612 | const char *output_file_name = NULL; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 613 | const char *ladder[MAX_LADDER_DEPTH]; |
| 614 | size_t ladder_depth = 0; |
| 615 | int i; |
| 616 | enum program_mode mode; |
| 617 | psa_status_t status; |
| 618 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 619 | if (argc <= 1 || |
| 620 | strcmp(argv[1], "help") == 0 || |
| 621 | strcmp(argv[1], "-help") == 0 || |
| 622 | strcmp(argv[1], "--help") == 0) { |
| 623 | usage(); |
| 624 | return EXIT_SUCCESS; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 625 | } |
| 626 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 627 | for (i = 2; i < argc; i++) { |
| 628 | char *q = strchr(argv[i], '='); |
| 629 | if (q == NULL) { |
| 630 | printf("Missing argument to option %s\n", argv[i]); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 631 | goto usage_failure; |
| 632 | } |
| 633 | *q = 0; |
| 634 | ++q; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 635 | if (strcmp(argv[i], "input") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 636 | input_file_name = q; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 637 | } else if (strcmp(argv[i], "label") == 0) { |
| 638 | if (ladder_depth == MAX_LADDER_DEPTH) { |
| 639 | printf("Maximum ladder depth %u exceeded.\n", |
| 640 | (unsigned) MAX_LADDER_DEPTH); |
| 641 | return EXIT_FAILURE; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 642 | } |
| 643 | ladder[ladder_depth] = q; |
| 644 | ++ladder_depth; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 645 | } else if (strcmp(argv[i], "master") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 646 | key_file_name = q; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 647 | } else if (strcmp(argv[i], "output") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 648 | output_file_name = q; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 649 | } else { |
| 650 | printf("Unknown option: %s\n", argv[i]); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 651 | goto usage_failure; |
| 652 | } |
| 653 | } |
| 654 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 655 | if (strcmp(argv[1], "generate") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 656 | mode = MODE_GENERATE; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 657 | } else if (strcmp(argv[1], "save") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 658 | mode = MODE_SAVE; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 659 | } else if (strcmp(argv[1], "unwrap") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 660 | mode = MODE_UNWRAP; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 661 | } else if (strcmp(argv[1], "wrap") == 0) { |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 662 | mode = MODE_WRAP; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 663 | } else { |
| 664 | printf("Unknown action: %s\n", argv[1]); |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 665 | goto usage_failure; |
| 666 | } |
| 667 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 668 | if (input_file_name == NULL && |
| 669 | (mode == MODE_WRAP || mode == MODE_UNWRAP)) { |
| 670 | printf("Required argument missing: input\n"); |
| 671 | return DEMO_ERROR; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 672 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 673 | if (output_file_name == NULL && |
| 674 | (mode == MODE_SAVE || mode == MODE_WRAP || mode == MODE_UNWRAP)) { |
| 675 | printf("Required argument missing: output\n"); |
| 676 | return DEMO_ERROR; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 677 | } |
| 678 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 679 | status = run(mode, key_file_name, |
| 680 | ladder, ladder_depth, |
| 681 | input_file_name, output_file_name); |
| 682 | return status == PSA_SUCCESS ? |
| 683 | EXIT_SUCCESS : |
| 684 | EXIT_FAILURE; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 685 | |
| 686 | usage_failure: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 687 | usage(); |
| 688 | return EXIT_FAILURE; |
Gilles Peskine | f0fa436 | 2018-07-16 17:08:43 +0200 | [diff] [blame] | 689 | } |
Manuel Pégourié-Gonnard | 33783b4 | 2023-03-21 17:24:20 +0100 | [diff] [blame] | 690 | #endif /* PSA_WANT_ALG_SHA_256 && MBEDTLS_MD_C && |
David Horstmann | 5b98d73 | 2022-11-10 18:55:00 +0000 | [diff] [blame] | 691 | MBEDTLS_AES_C && MBEDTLS_CCM_C && |
| 692 | MBEDTLS_PSA_CRYPTO_C && MBEDTLS_FS_IO */ |