blob: 523668e13d4533e05eced8fc6b5ad5eb3ff0d564 [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
66/* If the build options we need are not enabled, compile a placeholder. */
67#if !defined(MBEDTLS_SHA256_C) || !defined(MBEDTLS_MD_C) || \
68 !defined(MBEDTLS_AES_C) || !defined(MBEDTLS_CCM_C) || \
69 !defined(MBEDTLS_PSA_CRYPTO_C) || !defined(MBEDTLS_FS_IO)
70int main( void )
71{
Jaeden Amerofa30c332018-12-21 18:42:18 +000072 printf("MBEDTLS_SHA256_C and/or MBEDTLS_MD_C and/or "
73 "MBEDTLS_AES_C and/or MBEDTLS_CCM_C and/or "
74 "MBEDTLS_PSA_CRYPTO_C and/or MBEDTLS_FS_IO not defined.\n");
Gilles Peskinef0fa4362018-07-16 17:08:43 +020075 return( 0 );
76}
77#else
78
79/* The real program starts here. */
80
81
82
83#include <psa/crypto.h>
84
85/* 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
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +0100211 PSA_CHECK( psa_generate_random_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 );
255 PSA_CHECK( psa_import_key( &attributes, master_key_handle,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200256 key_data, key_size ) );
257exit:
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 {
263 /* If psa_allocate_key hasn't been called yet or has failed,
264 * *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 Peskinef0fa4362018-07-16 17:08:43 +0200282 psa_crypto_generator_t generator = PSA_CRYPTO_GENERATOR_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). */
296 PSA_CHECK( psa_key_derivation(
297 &generator,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100298 *key_handle,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200299 KDF_ALG,
300 DERIVE_KEY_SALT, DERIVE_KEY_SALT_LENGTH,
301 (uint8_t*) ladder[i], strlen( ladder[i] ),
302 KEY_SIZE_BYTES ) );
303 /* When the parent key is not the master key, destroy it,
304 * since it is no longer needed. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100305 PSA_CHECK( psa_close_key( *key_handle ) );
306 *key_handle = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200307 /* Use the generator obtained from the parent key to create
308 * the next intermediate key. */
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +0100309 PSA_CHECK( psa_generate_derived_key( &attributes, key_handle,
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200310 &generator ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200311 PSA_CHECK( psa_generator_abort( &generator ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200312 }
313
314exit:
315 psa_generator_abort( &generator );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100316 if( status != PSA_SUCCESS )
317 {
318 psa_close_key( *key_handle );
319 *key_handle = 0;
320 }
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200321 return( status );
322}
323
324/* Derive a wrapping key from the last intermediate key. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100325static psa_status_t derive_wrapping_key( psa_key_usage_t usage,
326 psa_key_handle_t derived_key_handle,
327 psa_key_handle_t *wrapping_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200328{
329 psa_status_t status = PSA_SUCCESS;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200330 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200331 psa_crypto_generator_t generator = PSA_CRYPTO_GENERATOR_INIT;
332
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100333 *wrapping_key_handle = 0;
Gilles Peskinedfea0a252019-04-18 13:39:40 +0200334 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 );
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200337 psa_set_key_bits( &attributes, WRAPPING_KEY_BITS );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200338
339 PSA_CHECK( psa_key_derivation(
340 &generator,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100341 derived_key_handle,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200342 KDF_ALG,
343 WRAPPING_KEY_SALT, WRAPPING_KEY_SALT_LENGTH,
344 NULL, 0,
345 PSA_BITS_TO_BYTES( WRAPPING_KEY_BITS ) ) );
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +0100346 PSA_CHECK( psa_generate_derived_key( &attributes, wrapping_key_handle,
Gilles Peskine3a4f1f82019-04-26 13:49:28 +0200347 &generator ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200348
349exit:
350 psa_generator_abort( &generator );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100351 if( status != PSA_SUCCESS )
352 {
353 psa_close_key( *wrapping_key_handle );
354 *wrapping_key_handle = 0;
355 }
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200356 return( status );
357}
358
359static psa_status_t wrap_data( const char *input_file_name,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100360 const char *output_file_name,
361 psa_key_handle_t wrapping_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200362{
363 psa_status_t status;
364 FILE *input_file = NULL;
365 FILE *output_file = NULL;
366 long input_position;
367 size_t input_size;
Gilles Peskine5e09bc72018-12-21 12:06:15 +0100368 size_t buffer_size = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200369 unsigned char *buffer = NULL;
370 size_t ciphertext_size;
371 wrapped_data_header_t header;
372
373 /* Find the size of the data to wrap. */
374 SYS_CHECK( ( input_file = fopen( input_file_name, "rb" ) ) != NULL );
375 SYS_CHECK( fseek( input_file, 0, SEEK_END ) == 0 );
376 SYS_CHECK( ( input_position = ftell( input_file ) ) != -1 );
377#if LONG_MAX > SIZE_MAX
378 if( input_position > SIZE_MAX )
379 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000380 printf( "Input file too large.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200381 status = DEMO_ERROR;
382 goto exit;
383 }
384#endif
385 input_size = input_position;
386 buffer_size = PSA_AEAD_ENCRYPT_OUTPUT_SIZE( WRAPPING_ALG, input_size );
387 /* Check for integer overflow. */
388 if( buffer_size < input_size )
389 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000390 printf( "Input file too large.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200391 status = DEMO_ERROR;
392 goto exit;
393 }
394
395 /* Load the data to wrap. */
396 SYS_CHECK( fseek( input_file, 0, SEEK_SET ) == 0 );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000397 SYS_CHECK( ( buffer = calloc( 1, buffer_size ) ) != NULL );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200398 SYS_CHECK( fread( buffer, 1, input_size, input_file ) == input_size );
399 SYS_CHECK( fclose( input_file ) == 0 );
400 input_file = NULL;
401
402 /* Construct a header. */
403 memcpy( &header.magic, WRAPPED_DATA_MAGIC, WRAPPED_DATA_MAGIC_LENGTH );
404 header.ad_size = sizeof( header );
405 header.payload_size = input_size;
406
407 /* Wrap the data. */
408 PSA_CHECK( psa_generate_random( header.iv, WRAPPING_IV_SIZE ) );
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100409 PSA_CHECK( psa_aead_encrypt( wrapping_key_handle, WRAPPING_ALG,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200410 header.iv, WRAPPING_IV_SIZE,
411 (uint8_t *) &header, sizeof( header ),
412 buffer, input_size,
413 buffer, buffer_size,
414 &ciphertext_size ) );
415
416 /* Write the output. */
417 SYS_CHECK( ( output_file = fopen( output_file_name, "wb" ) ) != NULL );
418 SYS_CHECK( fwrite( &header, 1, sizeof( header ),
419 output_file ) == sizeof( header ) );
420 SYS_CHECK( fwrite( buffer, 1, ciphertext_size,
421 output_file ) == ciphertext_size );
422 SYS_CHECK( fclose( output_file ) == 0 );
423 output_file = NULL;
424
425exit:
426 if( input_file != NULL )
427 fclose( input_file );
428 if( output_file != NULL )
429 fclose( output_file );
430 if( buffer != NULL )
431 mbedtls_platform_zeroize( buffer, buffer_size );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000432 free( buffer );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200433 return( status );
434}
435
436static psa_status_t unwrap_data( const char *input_file_name,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100437 const char *output_file_name,
438 psa_key_handle_t wrapping_key_handle )
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200439{
440 psa_status_t status;
441 FILE *input_file = NULL;
442 FILE *output_file = NULL;
443 unsigned char *buffer = NULL;
Gilles Peskine5e09bc72018-12-21 12:06:15 +0100444 size_t ciphertext_size = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200445 size_t plaintext_size;
446 wrapped_data_header_t header;
447 unsigned char extra_byte;
448
449 /* Load and validate the header. */
450 SYS_CHECK( ( input_file = fopen( input_file_name, "rb" ) ) != NULL );
451 SYS_CHECK( fread( &header, 1, sizeof( header ),
452 input_file ) == sizeof( header ) );
453 if( memcmp( &header.magic, WRAPPED_DATA_MAGIC,
454 WRAPPED_DATA_MAGIC_LENGTH ) != 0 )
455 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000456 printf( "The input does not start with a valid magic header.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200457 status = DEMO_ERROR;
458 goto exit;
459 }
460 if( header.ad_size != sizeof( header ) )
461 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000462 printf( "The header size is not correct.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200463 status = DEMO_ERROR;
464 goto exit;
465 }
466 ciphertext_size =
467 PSA_AEAD_ENCRYPT_OUTPUT_SIZE( WRAPPING_ALG, header.payload_size );
468 /* Check for integer overflow. */
469 if( ciphertext_size < header.payload_size )
470 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000471 printf( "Input file too large.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200472 status = DEMO_ERROR;
473 goto exit;
474 }
475
476 /* Load the payload data. */
Jaeden Amerofa30c332018-12-21 18:42:18 +0000477 SYS_CHECK( ( buffer = calloc( 1, ciphertext_size ) ) != NULL );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200478 SYS_CHECK( fread( buffer, 1, ciphertext_size,
479 input_file ) == ciphertext_size );
480 if( fread( &extra_byte, 1, 1, input_file ) != 0 )
481 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000482 printf( "Extra garbage after ciphertext\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200483 status = DEMO_ERROR;
484 goto exit;
485 }
486 SYS_CHECK( fclose( input_file ) == 0 );
487 input_file = NULL;
488
489 /* Unwrap the data. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100490 PSA_CHECK( psa_aead_decrypt( wrapping_key_handle, WRAPPING_ALG,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200491 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 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000498 printf( "Incorrect payload size in the header.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200499 status = DEMO_ERROR;
500 goto exit;
501 }
502
503 /* Write the output. */
504 SYS_CHECK( ( output_file = fopen( output_file_name, "wb" ) ) != NULL );
505 SYS_CHECK( fwrite( buffer, 1, plaintext_size,
506 output_file ) == plaintext_size );
507 SYS_CHECK( fclose( output_file ) == 0 );
508 output_file = NULL;
509
510exit:
511 if( input_file != NULL )
512 fclose( input_file );
513 if( output_file != NULL )
514 fclose( output_file );
515 if( buffer != NULL )
516 mbedtls_platform_zeroize( buffer, ciphertext_size );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000517 free( buffer );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200518 return( status );
519}
520
521static psa_status_t run( enum program_mode mode,
522 const char *key_file_name,
523 const char *ladder[], size_t ladder_depth,
524 const char *input_file_name,
525 const char *output_file_name )
526{
527 psa_status_t status = PSA_SUCCESS;
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100528 psa_key_handle_t derivation_key_handle = 0;
529 psa_key_handle_t wrapping_key_handle = 0;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200530
531 /* Initialize the PSA crypto library. */
532 PSA_CHECK( psa_crypto_init( ) );
533
534 /* Generate mode is unlike the others. Generate the master key and exit. */
535 if( mode == MODE_GENERATE )
536 return( generate( key_file_name ) );
537
538 /* Read the master key. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100539 PSA_CHECK( import_key_from_file( PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT,
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200540 KDF_ALG,
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100541 key_file_name,
542 &derivation_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200543
544 /* Calculate the derived key for this session. */
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100545 PSA_CHECK( derive_key_ladder( ladder, ladder_depth,
546 &derivation_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200547
548 switch( mode )
549 {
550 case MODE_SAVE:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100551 PSA_CHECK( save_key( derivation_key_handle, output_file_name ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200552 break;
553 case MODE_UNWRAP:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100554 PSA_CHECK( derive_wrapping_key( PSA_KEY_USAGE_DECRYPT,
555 derivation_key_handle,
556 &wrapping_key_handle ) );
557 PSA_CHECK( unwrap_data( input_file_name, output_file_name,
558 wrapping_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200559 break;
560 case MODE_WRAP:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100561 PSA_CHECK( derive_wrapping_key( PSA_KEY_USAGE_ENCRYPT,
562 derivation_key_handle,
563 &wrapping_key_handle ) );
564 PSA_CHECK( wrap_data( input_file_name, output_file_name,
565 wrapping_key_handle ) );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200566 break;
567 default:
568 /* Unreachable but some compilers don't realize it. */
569 break;
570 }
571
572exit:
Gilles Peskineb0edfb52018-12-03 16:24:51 +0100573 /* Close any remaining key. Deinitializing the crypto library would do
574 * this anyway, but explicitly closing handles makes the code easier
575 * to reuse. */
576 (void) psa_close_key( derivation_key_handle );
577 (void) psa_close_key( wrapping_key_handle );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200578 /* Deinitialize the PSA crypto library. */
579 mbedtls_psa_crypto_free( );
580 return( status );
581}
582
583static void usage( void )
584{
Jaeden Amerofa30c332018-12-21 18:42:18 +0000585 printf( "Usage: key_ladder_demo MODE [OPTION=VALUE]...\n" );
586 printf( "Demonstrate the usage of a key derivation ladder.\n" );
587 printf( "\n" );
588 printf( "Modes:\n" );
589 printf( " generate Generate the master key\n" );
590 printf( " save Save the derived key\n" );
591 printf( " unwrap Unwrap (decrypt) input with the derived key\n" );
592 printf( " wrap Wrap (encrypt) input with the derived key\n" );
593 printf( "\n" );
594 printf( "Options:\n" );
595 printf( " input=FILENAME Input file (required for wrap/unwrap)\n" );
596 printf( " master=FILENAME File containing the master key (default: master.key)\n" );
597 printf( " output=FILENAME Output file (required for save/wrap/unwrap)\n" );
598 printf( " label=TEXT Label for the key derivation.\n" );
599 printf( " This may be repeated multiple times.\n" );
600 printf( " To get the same key, you must use the same master key\n" );
601 printf( " and the same sequence of labels.\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200602}
603
Jaeden Amero44a59ab2019-02-11 13:24:47 +0000604#if defined(MBEDTLS_CHECK_PARAMS)
605#include "mbedtls/platform_util.h"
606void mbedtls_param_failed( const char *failure_condition,
607 const char *file,
608 int line )
609{
Jaeden Amerofa30c332018-12-21 18:42:18 +0000610 printf( "%s:%i: Input param failed - %s\n",
Jaeden Amero44a59ab2019-02-11 13:24:47 +0000611 file, line, failure_condition );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000612 exit( EXIT_FAILURE );
Jaeden Amero44a59ab2019-02-11 13:24:47 +0000613}
614#endif
615
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200616int main( int argc, char *argv[] )
617{
Gilles Peskine738f0172019-01-02 17:25:16 +0100618 const char *key_file_name = "master.key";
619 const char *input_file_name = NULL;
620 const char *output_file_name = NULL;
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200621 const char *ladder[MAX_LADDER_DEPTH];
622 size_t ladder_depth = 0;
623 int i;
624 enum program_mode mode;
625 psa_status_t status;
626
627 if( argc <= 1 ||
628 strcmp( argv[1], "help" ) == 0 ||
629 strcmp( argv[1], "-help" ) == 0 ||
630 strcmp( argv[1], "--help" ) == 0 )
631 {
632 usage( );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000633 return( EXIT_SUCCESS );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200634 }
635
636 for( i = 2; i < argc; i++ )
637 {
638 char *q = strchr( argv[i], '=' );
639 if( q == NULL )
640 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000641 printf( "Missing argument to option %s\n", argv[i] );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200642 goto usage_failure;
643 }
644 *q = 0;
645 ++q;
646 if( strcmp( argv[i], "input" ) == 0 )
647 input_file_name = q;
648 else if( strcmp( argv[i], "label" ) == 0 )
649 {
650 if( ladder_depth == MAX_LADDER_DEPTH )
651 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000652 printf( "Maximum ladder depth %u exceeded.\n",
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200653 (unsigned) MAX_LADDER_DEPTH );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000654 return( EXIT_FAILURE );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200655 }
656 ladder[ladder_depth] = q;
657 ++ladder_depth;
658 }
659 else if( strcmp( argv[i], "master" ) == 0 )
660 key_file_name = q;
661 else if( strcmp( argv[i], "output" ) == 0 )
662 output_file_name = q;
663 else
664 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000665 printf( "Unknown option: %s\n", argv[i] );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200666 goto usage_failure;
667 }
668 }
669
670 if( strcmp( argv[1], "generate" ) == 0 )
671 mode = MODE_GENERATE;
672 else if( strcmp( argv[1], "save" ) == 0 )
673 mode = MODE_SAVE;
674 else if( strcmp( argv[1], "unwrap" ) == 0 )
675 mode = MODE_UNWRAP;
676 else if( strcmp( argv[1], "wrap" ) == 0 )
677 mode = MODE_WRAP;
678 else
679 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000680 printf( "Unknown action: %s\n", argv[1] );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200681 goto usage_failure;
682 }
683
684 if( input_file_name == NULL &&
685 ( mode == MODE_WRAP || mode == MODE_UNWRAP ) )
686 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000687 printf( "Required argument missing: input\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200688 return( DEMO_ERROR );
689 }
690 if( output_file_name == NULL &&
691 ( mode == MODE_SAVE || mode == MODE_WRAP || mode == MODE_UNWRAP ) )
692 {
Jaeden Amerofa30c332018-12-21 18:42:18 +0000693 printf( "Required argument missing: output\n" );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200694 return( DEMO_ERROR );
695 }
696
697 status = run( mode, key_file_name,
698 ladder, ladder_depth,
699 input_file_name, output_file_name );
700 return( status == PSA_SUCCESS ?
Jaeden Amerofa30c332018-12-21 18:42:18 +0000701 EXIT_SUCCESS :
702 EXIT_FAILURE );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200703
704usage_failure:
705 usage( );
Jaeden Amerofa30c332018-12-21 18:42:18 +0000706 return( EXIT_FAILURE );
Gilles Peskinef0fa4362018-07-16 17:08:43 +0200707}
708#endif /* MBEDTLS_SHA256_C && MBEDTLS_MD_C && MBEDTLS_AES_C && MBEDTLS_CCM_C && MBEDTLS_PSA_CRYPTO_C && MBEDTLS_FS_IO */