blob: 800896f120fa993345bb291fd279c23e5cd80528 [file] [log] [blame]
Gilles Peskinef0fa4362018-07-16 17:08:43 +02001/**
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
33/* Copyright (C) 2018, ARM Limited, All Rights Reserved
34 * SPDX-License-Identifier: Apache-2.0
35 *
36 * Licensed under the Apache License, Version 2.0 (the "License"); you may
37 * not use this file except in compliance with the License.
38 * You may obtain a copy of the License at
39 *
40 * http://www.apache.org/licenses/LICENSE-2.0
41 *
42 * Unless required by applicable law or agreed to in writing, software
43 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
44 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
45 * See the License for the specific language governing permissions and
46 * limitations under the License.
47 *
48 * This file is part of mbed TLS (https://tls.mbed.org)
49 */
50
51/* First include Mbed TLS headers to get the Mbed TLS configuration and
52 * platform definitions that we'll use in this program. Also include
53 * standard C headers for functions we'll use here. */
54#if !defined(MBEDTLS_CONFIG_FILE)
55#include "mbedtls/config.h"
56#else
57#include MBEDTLS_CONFIG_FILE
58#endif
59
Gilles Peskinef0fa4362018-07-16 17:08:43 +020060#include <stdlib.h>
Gilles Peskinef0fa4362018-07-16 17:08:43 +020061#include <stdio.h>
62#include <string.h>
63
64#include "mbedtls/platform_util.h" // for mbedtls_platform_zeroize
65
Gilles Peskine4e2cc532019-05-29 14:30:27 +020066#include <psa/crypto.h>
67
Gilles Peskinef0fa4362018-07-16 17:08:43 +020068/* If the build options we need are not enabled, compile a placeholder. */
69#if !defined(MBEDTLS_SHA256_C) || !defined(MBEDTLS_MD_C) || \
70 !defined(MBEDTLS_AES_C) || !defined(MBEDTLS_CCM_C) || \
Janos Follath71a4c912019-06-11 09:14:47 +010071 !defined(MBEDTLS_PSA_CRYPTO_C) || !defined(MBEDTLS_FS_IO) ||\
Gilles Peskine4e2cc532019-05-29 14:30:27 +020072 defined(PSA_PRE_1_0_KEY_DERIVATION)
Gilles Peskinef0fa4362018-07-16 17:08:43 +020073int main( void )
74{
Jaeden Amerofa30c332018-12-21 18:42:18 +000075 printf("MBEDTLS_SHA256_C and/or MBEDTLS_MD_C and/or "
76 "MBEDTLS_AES_C and/or MBEDTLS_CCM_C and/or "
Janos Follath71a4c912019-06-11 09:14:47 +010077 "MBEDTLS_PSA_CRYPTO_C and/or MBEDTLS_FS_IO and/or "
Gilles Peskine4e2cc532019-05-29 14:30:27 +020078 "not defined and/or PSA_PRE_1_0_KEY_DERIVATION defined.\n");
Gilles Peskinef0fa4362018-07-16 17:08:43 +020079 return( 0 );
80}
81#else
82
83/* The real program starts here. */
84
Gilles Peskinef0fa4362018-07-16 17:08:43 +020085/* Run a system function and bail out if it fails. */
86#define SYS_CHECK( expr ) \
87 do \
88 { \
89 if( ! ( expr ) ) \
90 { \
91 perror( #expr ); \
92 status = DEMO_ERROR; \
93 goto exit; \
94 } \
95 } \
96 while( 0 )
97
98/* Run a PSA function and bail out if it fails. */
99#define PSA_CHECK( expr ) \
100 do \
101 { \
102 status = ( expr ); \
103 if( status != PSA_SUCCESS ) \
104 { \
Jaeden Amerofa30c332018-12-21 18:42:18 +0000105 printf( "Error %d at line %u: %s\n", \
106 (int) status, \
107 __LINE__, \
108 #expr ); \
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200109 goto exit; \
110 } \
111 } \
112 while( 0 )
113
114/* To report operational errors in this program, use an error code that is
115 * different from every PSA error code. */
116#define DEMO_ERROR 120
117
118/* The maximum supported key ladder depth. */
119#define MAX_LADDER_DEPTH 10
120
121/* Salt to use when deriving an intermediate key. */
122#define DERIVE_KEY_SALT ( (uint8_t *) "key_ladder_demo.derive" )
123#define DERIVE_KEY_SALT_LENGTH ( strlen( (const char*) DERIVE_KEY_SALT ) )
124
125/* Salt to use when deriving a wrapping key. */
126#define WRAPPING_KEY_SALT ( (uint8_t *) "key_ladder_demo.wrap" )
127#define WRAPPING_KEY_SALT_LENGTH ( strlen( (const char*) WRAPPING_KEY_SALT ) )
128
129/* Size of the key derivation keys (applies both to the master key and
130 * to intermediate keys). */
131#define KEY_SIZE_BYTES 40
132
133/* Algorithm for key derivation. */
134#define KDF_ALG PSA_ALG_HKDF( PSA_ALG_SHA_256 )
135
136/* Type and size of the key used to wrap data. */
137#define WRAPPING_KEY_TYPE PSA_KEY_TYPE_AES
138#define WRAPPING_KEY_BITS 128
139
140/* Cipher mode used to wrap data. */
141#define WRAPPING_ALG PSA_ALG_CCM
142
143/* Nonce size used to wrap data. */
144#define WRAPPING_IV_SIZE 13
145
146/* Header used in files containing wrapped data. We'll save this header
147 * directly without worrying about data representation issues such as
148 * integer sizes and endianness, because the data is meant to be read
149 * back by the same program on the same machine. */
150#define WRAPPED_DATA_MAGIC "key_ladder_demo" // including trailing null byte
151#define WRAPPED_DATA_MAGIC_LENGTH ( sizeof( WRAPPED_DATA_MAGIC ) )
152typedef struct
153{
154 char magic[WRAPPED_DATA_MAGIC_LENGTH];
155 size_t ad_size; /* Size of the additional data, which is this header. */
156 size_t payload_size; /* Size of the encrypted data. */
157 /* Store the IV inside the additional data. It's convenient. */
158 uint8_t iv[WRAPPING_IV_SIZE];
159} wrapped_data_header_t;
160
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200161/* The modes that this program can operate in (see usage). */
162enum program_mode
163{
164 MODE_GENERATE,
165 MODE_SAVE,
166 MODE_UNWRAP,
167 MODE_WRAP
168};
169
170/* Save a key to a file. In the real world, you may want to export a derived
171 * key sometimes, to share it with another party. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100172static psa_status_t save_key( psa_key_handle_t key_handle,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200173 const char *output_file_name )
174{
175 psa_status_t status = PSA_SUCCESS;
176 uint8_t key_data[KEY_SIZE_BYTES];
177 size_t key_size;
178 FILE *key_file = NULL;
179
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100180 PSA_CHECK( psa_export_key( key_handle,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200181 key_data, sizeof( key_data ),
182 &key_size ) );
183 SYS_CHECK( ( key_file = fopen( output_file_name, "wb" ) ) != NULL );
184 SYS_CHECK( fwrite( key_data, 1, key_size, key_file ) == key_size );
185 SYS_CHECK( fclose( key_file ) == 0 );
186 key_file = NULL;
187
188exit:
189 if( key_file != NULL)
190 fclose( key_file );
191 return( status );
192}
193
194/* Generate a master key for use in this demo.
195 *
196 * Normally a master key would be non-exportable. For the purpose of this
197 * demo, we want to save it to a file, to avoid relying on the keystore
198 * capability of the PSA crypto library. */
199static psa_status_t generate( const char *key_file_name )
200{
201 psa_status_t status = PSA_SUCCESS;
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100202 psa_key_handle_t key_handle = 0;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200203 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200204
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200205 psa_set_key_usage_flags( &attributes,
206 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
207 psa_set_key_algorithm( &attributes, KDF_ALG );
208 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200209 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( KEY_SIZE_BYTES ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200210
Gilles Peskine35ef36b2019-05-16 19:42:05 +0200211 PSA_CHECK( psa_generate_key( &attributes, &key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200212
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100213 PSA_CHECK( save_key( key_handle, key_file_name ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200214
215exit:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100216 (void) psa_destroy_key( key_handle );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200217 return( status );
218}
219
220/* Load the master key from a file.
221 *
222 * In the real world, this master key would be stored in an internal memory
223 * and the storage would be managed by the keystore capability of the PSA
224 * crypto library. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100225static psa_status_t import_key_from_file( psa_key_usage_t usage,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200226 psa_algorithm_t alg,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100227 const char *key_file_name,
228 psa_key_handle_t *master_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200229{
230 psa_status_t status = PSA_SUCCESS;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200231 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200232 uint8_t key_data[KEY_SIZE_BYTES];
233 size_t key_size;
234 FILE *key_file = NULL;
235 unsigned char extra_byte;
236
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100237 *master_key_handle = 0;
238
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200239 SYS_CHECK( ( key_file = fopen( key_file_name, "rb" ) ) != NULL );
240 SYS_CHECK( ( key_size = fread( key_data, 1, sizeof( key_data ),
241 key_file ) ) != 0 );
242 if( fread( &extra_byte, 1, 1, key_file ) != 0 )
243 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000244 printf( "Key file too large (max: %u).\n",
245 (unsigned) sizeof( key_data ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200246 status = DEMO_ERROR;
247 goto exit;
248 }
249 SYS_CHECK( fclose( key_file ) == 0 );
250 key_file = NULL;
251
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200252 psa_set_key_usage_flags( &attributes, usage );
253 psa_set_key_algorithm( &attributes, alg );
254 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine73676cb2019-05-15 20:15:10 +0200255 PSA_CHECK( psa_import_key( &attributes, key_data, key_size,
256 master_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200257exit:
258 if( key_file != NULL )
259 fclose( key_file );
260 mbedtls_platform_zeroize( key_data, sizeof( key_data ) );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100261 if( status != PSA_SUCCESS )
262 {
Gilles Peskine5163a922019-05-27 14:52:34 +0200263 /* If the key creation hasn't happened yet or has failed,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100264 * *master_key_handle is 0. psa_destroy_key(0) is guaranteed to do
265 * nothing and return PSA_ERROR_INVALID_HANDLE. */
266 (void) psa_destroy_key( *master_key_handle );
267 *master_key_handle = 0;
268 }
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200269 return( status );
270}
271
272/* Derive the intermediate keys, using the list of labels provided on
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100273 * the command line. On input, *key_handle is a handle to the master key.
274 * This function closes the master key. On successful output, *key_handle
275 * is a handle to the final derived key. */
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200276static psa_status_t derive_key_ladder( const char *ladder[],
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100277 size_t ladder_depth,
278 psa_key_handle_t *key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200279{
280 psa_status_t status = PSA_SUCCESS;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200281 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200282 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200283 size_t i;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200284
285 psa_set_key_usage_flags( &attributes,
286 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
287 psa_set_key_algorithm( &attributes, KDF_ALG );
288 psa_set_key_type( &attributes, PSA_KEY_TYPE_DERIVE );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200289 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( KEY_SIZE_BYTES ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200290
291 /* For each label in turn, ... */
292 for( i = 0; i < ladder_depth; i++ )
293 {
294 /* Start deriving material from the master key (if i=0) or from
295 * the current intermediate key (if i>0). */
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200296 PSA_CHECK( psa_key_derivation_setup( &operation, KDF_ALG ) );
297 PSA_CHECK( psa_key_derivation_input_bytes(
298 &operation, PSA_KEY_DERIVATION_INPUT_SALT,
299 DERIVE_KEY_SALT, DERIVE_KEY_SALT_LENGTH ) );
300 PSA_CHECK( psa_key_derivation_input_key(
301 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
302 *key_handle ) );
303 PSA_CHECK( psa_key_derivation_input_bytes(
304 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
305 (uint8_t*) ladder[i], strlen( ladder[i] ) ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200306 /* When the parent key is not the master key, destroy it,
307 * since it is no longer needed. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100308 PSA_CHECK( psa_close_key( *key_handle ) );
309 *key_handle = 0;
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200310 /* Derive the next intermediate key from the parent key. */
311 PSA_CHECK( psa_key_derivation_output_key( &attributes, &operation,
312 key_handle ) );
313 PSA_CHECK( psa_key_derivation_abort( &operation ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200314 }
315
316exit:
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200317 psa_key_derivation_abort( &operation );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100318 if( status != PSA_SUCCESS )
319 {
320 psa_close_key( *key_handle );
321 *key_handle = 0;
322 }
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200323 return( status );
324}
325
326/* Derive a wrapping key from the last intermediate key. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100327static psa_status_t derive_wrapping_key( psa_key_usage_t usage,
328 psa_key_handle_t derived_key_handle,
329 psa_key_handle_t *wrapping_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200330{
331 psa_status_t status = PSA_SUCCESS;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200332 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200333 psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200334
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100335 *wrapping_key_handle = 0;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200336 psa_set_key_usage_flags( &attributes, usage );
337 psa_set_key_algorithm( &attributes, WRAPPING_ALG );
338 psa_set_key_type( &attributes, PSA_KEY_TYPE_AES );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200339 psa_set_key_bits( &attributes, WRAPPING_KEY_BITS );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200340
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200341 PSA_CHECK( psa_key_derivation_setup( &operation, KDF_ALG ) );
342 PSA_CHECK( psa_key_derivation_input_bytes(
343 &operation, PSA_KEY_DERIVATION_INPUT_SALT,
344 WRAPPING_KEY_SALT, WRAPPING_KEY_SALT_LENGTH ) );
345 PSA_CHECK( psa_key_derivation_input_key(
346 &operation, PSA_KEY_DERIVATION_INPUT_SECRET,
347 derived_key_handle ) );
348 PSA_CHECK( psa_key_derivation_input_bytes(
349 &operation, PSA_KEY_DERIVATION_INPUT_INFO,
350 NULL, 0 ) );
351 PSA_CHECK( psa_key_derivation_output_key( &attributes, &operation,
352 wrapping_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200353
354exit:
Gilles Peskine4e2cc532019-05-29 14:30:27 +0200355 psa_key_derivation_abort( &operation );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100356 if( status != PSA_SUCCESS )
357 {
358 psa_close_key( *wrapping_key_handle );
359 *wrapping_key_handle = 0;
360 }
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200361 return( status );
362}
363
364static psa_status_t wrap_data( const char *input_file_name,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100365 const char *output_file_name,
366 psa_key_handle_t wrapping_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200367{
368 psa_status_t status;
369 FILE *input_file = NULL;
370 FILE *output_file = NULL;
371 long input_position;
372 size_t input_size;
Gilles Peskine5e09bc72018-12-21 12:06:15 +0100373 size_t buffer_size = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200374 unsigned char *buffer = NULL;
375 size_t ciphertext_size;
376 wrapped_data_header_t header;
377
378 /* Find the size of the data to wrap. */
379 SYS_CHECK( ( input_file = fopen( input_file_name, "rb" ) ) != NULL );
380 SYS_CHECK( fseek( input_file, 0, SEEK_END ) == 0 );
381 SYS_CHECK( ( input_position = ftell( input_file ) ) != -1 );
382#if LONG_MAX > SIZE_MAX
383 if( input_position > SIZE_MAX )
384 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000385 printf( "Input file too large.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200386 status = DEMO_ERROR;
387 goto exit;
388 }
389#endif
390 input_size = input_position;
391 buffer_size = PSA_AEAD_ENCRYPT_OUTPUT_SIZE( WRAPPING_ALG, input_size );
392 /* Check for integer overflow. */
393 if( buffer_size < input_size )
394 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000395 printf( "Input file too large.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200396 status = DEMO_ERROR;
397 goto exit;
398 }
399
400 /* Load the data to wrap. */
401 SYS_CHECK( fseek( input_file, 0, SEEK_SET ) == 0 );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000402 SYS_CHECK( ( buffer = calloc( 1, buffer_size ) ) != NULL );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200403 SYS_CHECK( fread( buffer, 1, input_size, input_file ) == input_size );
404 SYS_CHECK( fclose( input_file ) == 0 );
405 input_file = NULL;
406
407 /* Construct a header. */
408 memcpy( &header.magic, WRAPPED_DATA_MAGIC, WRAPPED_DATA_MAGIC_LENGTH );
409 header.ad_size = sizeof( header );
410 header.payload_size = input_size;
411
412 /* Wrap the data. */
413 PSA_CHECK( psa_generate_random( header.iv, WRAPPING_IV_SIZE ) );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100414 PSA_CHECK( psa_aead_encrypt( wrapping_key_handle, WRAPPING_ALG,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200415 header.iv, WRAPPING_IV_SIZE,
416 (uint8_t *) &header, sizeof( header ),
417 buffer, input_size,
418 buffer, buffer_size,
419 &ciphertext_size ) );
420
421 /* Write the output. */
422 SYS_CHECK( ( output_file = fopen( output_file_name, "wb" ) ) != NULL );
423 SYS_CHECK( fwrite( &header, 1, sizeof( header ),
424 output_file ) == sizeof( header ) );
425 SYS_CHECK( fwrite( buffer, 1, ciphertext_size,
426 output_file ) == ciphertext_size );
427 SYS_CHECK( fclose( output_file ) == 0 );
428 output_file = NULL;
429
430exit:
431 if( input_file != NULL )
432 fclose( input_file );
433 if( output_file != NULL )
434 fclose( output_file );
435 if( buffer != NULL )
436 mbedtls_platform_zeroize( buffer, buffer_size );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000437 free( buffer );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200438 return( status );
439}
440
441static psa_status_t unwrap_data( const char *input_file_name,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100442 const char *output_file_name,
443 psa_key_handle_t wrapping_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200444{
445 psa_status_t status;
446 FILE *input_file = NULL;
447 FILE *output_file = NULL;
448 unsigned char *buffer = NULL;
Gilles Peskine5e09bc72018-12-21 12:06:15 +0100449 size_t ciphertext_size = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200450 size_t plaintext_size;
451 wrapped_data_header_t header;
452 unsigned char extra_byte;
453
454 /* Load and validate the header. */
455 SYS_CHECK( ( input_file = fopen( input_file_name, "rb" ) ) != NULL );
456 SYS_CHECK( fread( &header, 1, sizeof( header ),
457 input_file ) == sizeof( header ) );
458 if( memcmp( &header.magic, WRAPPED_DATA_MAGIC,
459 WRAPPED_DATA_MAGIC_LENGTH ) != 0 )
460 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000461 printf( "The input does not start with a valid magic header.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200462 status = DEMO_ERROR;
463 goto exit;
464 }
465 if( header.ad_size != sizeof( header ) )
466 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000467 printf( "The header size is not correct.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200468 status = DEMO_ERROR;
469 goto exit;
470 }
471 ciphertext_size =
472 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( WRAPPING_ALG, header.payload_size );
473 /* Check for integer overflow. */
474 if( ciphertext_size < header.payload_size )
475 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000476 printf( "Input file too large.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200477 status = DEMO_ERROR;
478 goto exit;
479 }
480
481 /* Load the payload data. */
Jaeden Amerofa30c332018-12-21 18:42:18 +0000482 SYS_CHECK( ( buffer = calloc( 1, ciphertext_size ) ) != NULL );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200483 SYS_CHECK( fread( buffer, 1, ciphertext_size,
484 input_file ) == ciphertext_size );
485 if( fread( &extra_byte, 1, 1, input_file ) != 0 )
486 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000487 printf( "Extra garbage after ciphertext\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200488 status = DEMO_ERROR;
489 goto exit;
490 }
491 SYS_CHECK( fclose( input_file ) == 0 );
492 input_file = NULL;
493
494 /* Unwrap the data. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100495 PSA_CHECK( psa_aead_decrypt( wrapping_key_handle, WRAPPING_ALG,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200496 header.iv, WRAPPING_IV_SIZE,
497 (uint8_t *) &header, sizeof( header ),
498 buffer, ciphertext_size,
499 buffer, ciphertext_size,
500 &plaintext_size ) );
501 if( plaintext_size != header.payload_size )
502 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000503 printf( "Incorrect payload size in the header.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200504 status = DEMO_ERROR;
505 goto exit;
506 }
507
508 /* Write the output. */
509 SYS_CHECK( ( output_file = fopen( output_file_name, "wb" ) ) != NULL );
510 SYS_CHECK( fwrite( buffer, 1, plaintext_size,
511 output_file ) == plaintext_size );
512 SYS_CHECK( fclose( output_file ) == 0 );
513 output_file = NULL;
514
515exit:
516 if( input_file != NULL )
517 fclose( input_file );
518 if( output_file != NULL )
519 fclose( output_file );
520 if( buffer != NULL )
521 mbedtls_platform_zeroize( buffer, ciphertext_size );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000522 free( buffer );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200523 return( status );
524}
525
526static psa_status_t run( enum program_mode mode,
527 const char *key_file_name,
528 const char *ladder[], size_t ladder_depth,
529 const char *input_file_name,
530 const char *output_file_name )
531{
532 psa_status_t status = PSA_SUCCESS;
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100533 psa_key_handle_t derivation_key_handle = 0;
534 psa_key_handle_t wrapping_key_handle = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200535
536 /* Initialize the PSA crypto library. */
537 PSA_CHECK( psa_crypto_init( ) );
538
539 /* Generate mode is unlike the others. Generate the master key and exit. */
540 if( mode == MODE_GENERATE )
541 return( generate( key_file_name ) );
542
543 /* Read the master key. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100544 PSA_CHECK( import_key_from_file( PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200545 KDF_ALG,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100546 key_file_name,
547 &derivation_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200548
549 /* Calculate the derived key for this session. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100550 PSA_CHECK( derive_key_ladder( ladder, ladder_depth,
551 &derivation_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200552
553 switch( mode )
554 {
555 case MODE_SAVE:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100556 PSA_CHECK( save_key( derivation_key_handle, output_file_name ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200557 break;
558 case MODE_UNWRAP:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100559 PSA_CHECK( derive_wrapping_key( PSA_KEY_USAGE_DECRYPT,
560 derivation_key_handle,
561 &wrapping_key_handle ) );
562 PSA_CHECK( unwrap_data( input_file_name, output_file_name,
563 wrapping_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200564 break;
565 case MODE_WRAP:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100566 PSA_CHECK( derive_wrapping_key( PSA_KEY_USAGE_ENCRYPT,
567 derivation_key_handle,
568 &wrapping_key_handle ) );
569 PSA_CHECK( wrap_data( input_file_name, output_file_name,
570 wrapping_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200571 break;
572 default:
573 /* Unreachable but some compilers don't realize it. */
574 break;
575 }
576
577exit:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100578 /* Close any remaining key. Deinitializing the crypto library would do
579 * this anyway, but explicitly closing handles makes the code easier
580 * to reuse. */
581 (void) psa_close_key( derivation_key_handle );
582 (void) psa_close_key( wrapping_key_handle );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200583 /* Deinitialize the PSA crypto library. */
584 mbedtls_psa_crypto_free( );
585 return( status );
586}
587
588static void usage( void )
589{
Jaeden Amerofa30c332018-12-21 18:42:18 +0000590 printf( "Usage: key_ladder_demo MODE [OPTION=VALUE]...\n" );
591 printf( "Demonstrate the usage of a key derivation ladder.\n" );
592 printf( "\n" );
593 printf( "Modes:\n" );
594 printf( " generate Generate the master key\n" );
595 printf( " save Save the derived key\n" );
596 printf( " unwrap Unwrap (decrypt) input with the derived key\n" );
597 printf( " wrap Wrap (encrypt) input with the derived key\n" );
598 printf( "\n" );
599 printf( "Options:\n" );
600 printf( " input=FILENAME Input file (required for wrap/unwrap)\n" );
601 printf( " master=FILENAME File containing the master key (default: master.key)\n" );
602 printf( " output=FILENAME Output file (required for save/wrap/unwrap)\n" );
603 printf( " label=TEXT Label for the key derivation.\n" );
604 printf( " This may be repeated multiple times.\n" );
605 printf( " To get the same key, you must use the same master key\n" );
606 printf( " and the same sequence of labels.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200607}
608
Jaeden Amero44a59ab2019-02-11 13:24:47 +0000609#if defined(MBEDTLS_CHECK_PARAMS)
610#include "mbedtls/platform_util.h"
611void mbedtls_param_failed( const char *failure_condition,
612 const char *file,
613 int line )
614{
Jaeden Amerofa30c332018-12-21 18:42:18 +0000615 printf( "%s:%i: Input param failed - %s\n",
Jaeden Amero44a59ab2019-02-11 13:24:47 +0000616 file, line, failure_condition );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000617 exit( EXIT_FAILURE );
Jaeden Amero44a59ab2019-02-11 13:24:47 +0000618}
619#endif
620
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200621int main( int argc, char *argv[] )
622{
Gilles Peskine738f0172019-01-02 17:25:16 +0100623 const char *key_file_name = "master.key";
624 const char *input_file_name = NULL;
625 const char *output_file_name = NULL;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200626 const char *ladder[MAX_LADDER_DEPTH];
627 size_t ladder_depth = 0;
628 int i;
629 enum program_mode mode;
630 psa_status_t status;
631
632 if( argc <= 1 ||
633 strcmp( argv[1], "help" ) == 0 ||
634 strcmp( argv[1], "-help" ) == 0 ||
635 strcmp( argv[1], "--help" ) == 0 )
636 {
637 usage( );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000638 return( EXIT_SUCCESS );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200639 }
640
641 for( i = 2; i < argc; i++ )
642 {
643 char *q = strchr( argv[i], '=' );
644 if( q == NULL )
645 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000646 printf( "Missing argument to option %s\n", argv[i] );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200647 goto usage_failure;
648 }
649 *q = 0;
650 ++q;
651 if( strcmp( argv[i], "input" ) == 0 )
652 input_file_name = q;
653 else if( strcmp( argv[i], "label" ) == 0 )
654 {
655 if( ladder_depth == MAX_LADDER_DEPTH )
656 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000657 printf( "Maximum ladder depth %u exceeded.\n",
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200658 (unsigned) MAX_LADDER_DEPTH );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000659 return( EXIT_FAILURE );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200660 }
661 ladder[ladder_depth] = q;
662 ++ladder_depth;
663 }
664 else if( strcmp( argv[i], "master" ) == 0 )
665 key_file_name = q;
666 else if( strcmp( argv[i], "output" ) == 0 )
667 output_file_name = q;
668 else
669 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000670 printf( "Unknown option: %s\n", argv[i] );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200671 goto usage_failure;
672 }
673 }
674
675 if( strcmp( argv[1], "generate" ) == 0 )
676 mode = MODE_GENERATE;
677 else if( strcmp( argv[1], "save" ) == 0 )
678 mode = MODE_SAVE;
679 else if( strcmp( argv[1], "unwrap" ) == 0 )
680 mode = MODE_UNWRAP;
681 else if( strcmp( argv[1], "wrap" ) == 0 )
682 mode = MODE_WRAP;
683 else
684 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000685 printf( "Unknown action: %s\n", argv[1] );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200686 goto usage_failure;
687 }
688
689 if( input_file_name == NULL &&
690 ( mode == MODE_WRAP || mode == MODE_UNWRAP ) )
691 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000692 printf( "Required argument missing: input\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200693 return( DEMO_ERROR );
694 }
695 if( output_file_name == NULL &&
696 ( mode == MODE_SAVE || mode == MODE_WRAP || mode == MODE_UNWRAP ) )
697 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000698 printf( "Required argument missing: output\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200699 return( DEMO_ERROR );
700 }
701
702 status = run( mode, key_file_name,
703 ladder, ladder_depth,
704 input_file_name, output_file_name );
705 return( status == PSA_SUCCESS ?
Jaeden Amerofa30c332018-12-21 18:42:18 +0000706 EXIT_SUCCESS :
707 EXIT_FAILURE );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200708
709usage_failure:
710 usage( );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000711 return( EXIT_FAILURE );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200712}
713#endif /* MBEDTLS_SHA256_C && MBEDTLS_MD_C && MBEDTLS_AES_C && MBEDTLS_CCM_C && MBEDTLS_PSA_CRYPTO_C && MBEDTLS_FS_IO */