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