1 /*
2 * Key writing application
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
6 *
7 * This file is provided under the Apache License 2.0, or the
8 * GNU General Public License v2.0 or later.
9 *
10 * **********
11 * Apache License 2.0:
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License"); you may
14 * not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 * **********
26 *
27 * **********
28 * GNU General Public License v2.0 or later:
29 *
30 * This program is free software; you can redistribute it and/or modify
31 * it under the terms of the GNU General Public License as published by
32 * the Free Software Foundation; either version 2 of the License, or
33 * (at your option) any later version.
34 *
35 * This program is distributed in the hope that it will be useful,
36 * but WITHOUT ANY WARRANTY; without even the implied warranty of
37 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 * GNU General Public License for more details.
39 *
40 * You should have received a copy of the GNU General Public License along
41 * with this program; if not, write to the Free Software Foundation, Inc.,
42 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
43 *
44 * **********
45 */
46
47 #if !defined(MBEDTLS_CONFIG_FILE)
48 #include "mbedtls/config.h"
49 #else
50 #include MBEDTLS_CONFIG_FILE
51 #endif
52
53 #if defined(MBEDTLS_PLATFORM_C)
54 #include "mbedtls/platform.h"
55 #else
56 #include <stdio.h>
57 #include <stdlib.h>
58 #define mbedtls_printf printf
59 #define mbedtls_exit exit
60 #define MBEDTLS_EXIT_SUCCESS EXIT_SUCCESS
61 #define MBEDTLS_EXIT_FAILURE EXIT_FAILURE
62 #endif /* MBEDTLS_PLATFORM_C */
63
64 #if defined(MBEDTLS_PK_WRITE_C) && defined(MBEDTLS_FS_IO)
65 #include "mbedtls/error.h"
66 #include "mbedtls/pk.h"
67 #include "mbedtls/error.h"
68
69 #include <stdio.h>
70 #include <string.h>
71 #endif
72
73 #if defined(MBEDTLS_PEM_WRITE_C)
74 #define USAGE_OUT \
75 " output_file=%%s default: keyfile.pem\n" \
76 " output_format=pem|der default: pem\n"
77 #else
78 #define USAGE_OUT \
79 " output_file=%%s default: keyfile.der\n" \
80 " output_format=der default: der\n"
81 #endif
82
83 #if defined(MBEDTLS_PEM_WRITE_C)
84 #define DFL_OUTPUT_FILENAME "keyfile.pem"
85 #define DFL_OUTPUT_FORMAT OUTPUT_FORMAT_PEM
86 #else
87 #define DFL_OUTPUT_FILENAME "keyfile.der"
88 #define DFL_OUTPUT_FORMAT OUTPUT_FORMAT_DER
89 #endif
90
91 #define DFL_MODE MODE_NONE
92 #define DFL_FILENAME "keyfile.key"
93 #define DFL_DEBUG_LEVEL 0
94 #define DFL_OUTPUT_MODE OUTPUT_MODE_NONE
95
96 #define MODE_NONE 0
97 #define MODE_PRIVATE 1
98 #define MODE_PUBLIC 2
99
100 #define OUTPUT_MODE_NONE 0
101 #define OUTPUT_MODE_PRIVATE 1
102 #define OUTPUT_MODE_PUBLIC 2
103
104 #define OUTPUT_FORMAT_PEM 0
105 #define OUTPUT_FORMAT_DER 1
106
107 #define USAGE \
108 "\n usage: key_app_writer param=<>...\n" \
109 "\n acceptable parameters:\n" \
110 " mode=private|public default: none\n" \
111 " filename=%%s default: keyfile.key\n" \
112 " output_mode=private|public default: none\n" \
113 USAGE_OUT \
114 "\n"
115
116 #if !defined(MBEDTLS_PK_PARSE_C) || \
117 !defined(MBEDTLS_PK_WRITE_C) || \
118 !defined(MBEDTLS_FS_IO)
main(void)119 int main( void )
120 {
121 mbedtls_printf( "MBEDTLS_PK_PARSE_C and/or MBEDTLS_PK_WRITE_C and/or MBEDTLS_FS_IO not defined.\n" );
122 mbedtls_exit( 0 );
123 }
124 #else
125
126
127 /*
128 * global options
129 */
130 struct options
131 {
132 int mode; /* the mode to run the application in */
133 const char *filename; /* filename of the key file */
134 int output_mode; /* the output mode to use */
135 const char *output_file; /* where to store the constructed key file */
136 int output_format; /* the output format to use */
137 } opt;
138
write_public_key(mbedtls_pk_context * key,const char * output_file)139 static int write_public_key( mbedtls_pk_context *key, const char *output_file )
140 {
141 int ret;
142 FILE *f;
143 unsigned char output_buf[16000];
144 unsigned char *c = output_buf;
145 size_t len = 0;
146
147 memset(output_buf, 0, 16000);
148
149 #if defined(MBEDTLS_PEM_WRITE_C)
150 if( opt.output_format == OUTPUT_FORMAT_PEM )
151 {
152 if( ( ret = mbedtls_pk_write_pubkey_pem( key, output_buf, 16000 ) ) != 0 )
153 return( ret );
154
155 len = strlen( (char *) output_buf );
156 }
157 else
158 #endif
159 {
160 if( ( ret = mbedtls_pk_write_pubkey_der( key, output_buf, 16000 ) ) < 0 )
161 return( ret );
162
163 len = ret;
164 c = output_buf + sizeof(output_buf) - len;
165 }
166
167 if( ( f = fopen( output_file, "w" ) ) == NULL )
168 return( -1 );
169
170 if( fwrite( c, 1, len, f ) != len )
171 {
172 fclose( f );
173 return( -1 );
174 }
175
176 fclose( f );
177
178 return( 0 );
179 }
180
write_private_key(mbedtls_pk_context * key,const char * output_file)181 static int write_private_key( mbedtls_pk_context *key, const char *output_file )
182 {
183 int ret;
184 FILE *f;
185 unsigned char output_buf[16000];
186 unsigned char *c = output_buf;
187 size_t len = 0;
188
189 memset(output_buf, 0, 16000);
190
191 #if defined(MBEDTLS_PEM_WRITE_C)
192 if( opt.output_format == OUTPUT_FORMAT_PEM )
193 {
194 if( ( ret = mbedtls_pk_write_key_pem( key, output_buf, 16000 ) ) != 0 )
195 return( ret );
196
197 len = strlen( (char *) output_buf );
198 }
199 else
200 #endif
201 {
202 if( ( ret = mbedtls_pk_write_key_der( key, output_buf, 16000 ) ) < 0 )
203 return( ret );
204
205 len = ret;
206 c = output_buf + sizeof(output_buf) - len;
207 }
208
209 if( ( f = fopen( output_file, "w" ) ) == NULL )
210 return( -1 );
211
212 if( fwrite( c, 1, len, f ) != len )
213 {
214 fclose( f );
215 return( -1 );
216 }
217
218 fclose( f );
219
220 return( 0 );
221 }
222
main(int argc,char * argv[])223 int main( int argc, char *argv[] )
224 {
225 int ret = 1;
226 int exit_code = MBEDTLS_EXIT_FAILURE;
227 char buf[1024];
228 int i;
229 char *p, *q;
230
231 mbedtls_pk_context key;
232 mbedtls_mpi N, P, Q, D, E, DP, DQ, QP;
233
234 /*
235 * Set to sane values
236 */
237 mbedtls_pk_init( &key );
238 memset( buf, 0, sizeof( buf ) );
239
240 mbedtls_mpi_init( &N ); mbedtls_mpi_init( &P ); mbedtls_mpi_init( &Q );
241 mbedtls_mpi_init( &D ); mbedtls_mpi_init( &E ); mbedtls_mpi_init( &DP );
242 mbedtls_mpi_init( &DQ ); mbedtls_mpi_init( &QP );
243
244 if( argc == 0 )
245 {
246 usage:
247 mbedtls_printf( USAGE );
248 goto exit;
249 }
250
251 opt.mode = DFL_MODE;
252 opt.filename = DFL_FILENAME;
253 opt.output_mode = DFL_OUTPUT_MODE;
254 opt.output_file = DFL_OUTPUT_FILENAME;
255 opt.output_format = DFL_OUTPUT_FORMAT;
256
257 for( i = 1; i < argc; i++ )
258 {
259 p = argv[i];
260 if( ( q = strchr( p, '=' ) ) == NULL )
261 goto usage;
262 *q++ = '\0';
263
264 if( strcmp( p, "mode" ) == 0 )
265 {
266 if( strcmp( q, "private" ) == 0 )
267 opt.mode = MODE_PRIVATE;
268 else if( strcmp( q, "public" ) == 0 )
269 opt.mode = MODE_PUBLIC;
270 else
271 goto usage;
272 }
273 else if( strcmp( p, "output_mode" ) == 0 )
274 {
275 if( strcmp( q, "private" ) == 0 )
276 opt.output_mode = OUTPUT_MODE_PRIVATE;
277 else if( strcmp( q, "public" ) == 0 )
278 opt.output_mode = OUTPUT_MODE_PUBLIC;
279 else
280 goto usage;
281 }
282 else if( strcmp( p, "output_format" ) == 0 )
283 {
284 #if defined(MBEDTLS_PEM_WRITE_C)
285 if( strcmp( q, "pem" ) == 0 )
286 opt.output_format = OUTPUT_FORMAT_PEM;
287 else
288 #endif
289 if( strcmp( q, "der" ) == 0 )
290 opt.output_format = OUTPUT_FORMAT_DER;
291 else
292 goto usage;
293 }
294 else if( strcmp( p, "filename" ) == 0 )
295 opt.filename = q;
296 else if( strcmp( p, "output_file" ) == 0 )
297 opt.output_file = q;
298 else
299 goto usage;
300 }
301
302 if( opt.mode == MODE_NONE && opt.output_mode != OUTPUT_MODE_NONE )
303 {
304 mbedtls_printf( "\nCannot output a key without reading one.\n");
305 goto exit;
306 }
307
308 if( opt.mode == MODE_PUBLIC && opt.output_mode == OUTPUT_MODE_PRIVATE )
309 {
310 mbedtls_printf( "\nCannot output a private key from a public key.\n");
311 goto exit;
312 }
313
314 if( opt.mode == MODE_PRIVATE )
315 {
316 /*
317 * 1.1. Load the key
318 */
319 mbedtls_printf( "\n . Loading the private key ..." );
320 fflush( stdout );
321
322 ret = mbedtls_pk_parse_keyfile( &key, opt.filename, NULL );
323
324 if( ret != 0 )
325 {
326 mbedtls_strerror( ret, (char *) buf, sizeof(buf) );
327 mbedtls_printf( " failed\n ! mbedtls_pk_parse_keyfile returned -0x%04x - %s\n\n", -ret, buf );
328 goto exit;
329 }
330
331 mbedtls_printf( " ok\n" );
332
333 /*
334 * 1.2 Print the key
335 */
336 mbedtls_printf( " . Key information ...\n" );
337
338 #if defined(MBEDTLS_RSA_C)
339 if( mbedtls_pk_get_type( &key ) == MBEDTLS_PK_RSA )
340 {
341 mbedtls_rsa_context *rsa = mbedtls_pk_rsa( key );
342
343 if( ( ret = mbedtls_rsa_export ( rsa, &N, &P, &Q, &D, &E ) ) != 0 ||
344 ( ret = mbedtls_rsa_export_crt( rsa, &DP, &DQ, &QP ) ) != 0 )
345 {
346 mbedtls_printf( " failed\n ! could not export RSA parameters\n\n" );
347 goto exit;
348 }
349
350 mbedtls_mpi_write_file( "N: ", &N, 16, NULL );
351 mbedtls_mpi_write_file( "E: ", &E, 16, NULL );
352 mbedtls_mpi_write_file( "D: ", &D, 16, NULL );
353 mbedtls_mpi_write_file( "P: ", &P, 16, NULL );
354 mbedtls_mpi_write_file( "Q: ", &Q, 16, NULL );
355 mbedtls_mpi_write_file( "DP: ", &DP, 16, NULL );
356 mbedtls_mpi_write_file( "DQ: ", &DQ, 16, NULL );
357 mbedtls_mpi_write_file( "QP: ", &QP, 16, NULL );
358 }
359 else
360 #endif
361 #if defined(MBEDTLS_ECP_C)
362 if( mbedtls_pk_get_type( &key ) == MBEDTLS_PK_ECKEY )
363 {
364 mbedtls_ecp_keypair *ecp = mbedtls_pk_ec( key );
365 mbedtls_mpi_write_file( "Q(X): ", &ecp->Q.X, 16, NULL );
366 mbedtls_mpi_write_file( "Q(Y): ", &ecp->Q.Y, 16, NULL );
367 mbedtls_mpi_write_file( "Q(Z): ", &ecp->Q.Z, 16, NULL );
368 mbedtls_mpi_write_file( "D : ", &ecp->d , 16, NULL );
369 }
370 else
371 #endif
372 mbedtls_printf("key type not supported yet\n");
373
374 }
375 else if( opt.mode == MODE_PUBLIC )
376 {
377 /*
378 * 1.1. Load the key
379 */
380 mbedtls_printf( "\n . Loading the public key ..." );
381 fflush( stdout );
382
383 ret = mbedtls_pk_parse_public_keyfile( &key, opt.filename );
384
385 if( ret != 0 )
386 {
387 mbedtls_strerror( ret, (char *) buf, sizeof(buf) );
388 mbedtls_printf( " failed\n ! mbedtls_pk_parse_public_key returned -0x%04x - %s\n\n", -ret, buf );
389 goto exit;
390 }
391
392 mbedtls_printf( " ok\n" );
393
394 /*
395 * 1.2 Print the key
396 */
397 mbedtls_printf( " . Key information ...\n" );
398
399 #if defined(MBEDTLS_RSA_C)
400 if( mbedtls_pk_get_type( &key ) == MBEDTLS_PK_RSA )
401 {
402 mbedtls_rsa_context *rsa = mbedtls_pk_rsa( key );
403
404 if( ( ret = mbedtls_rsa_export( rsa, &N, NULL, NULL,
405 NULL, &E ) ) != 0 )
406 {
407 mbedtls_printf( " failed\n ! could not export RSA parameters\n\n" );
408 goto exit;
409 }
410 mbedtls_mpi_write_file( "N: ", &N, 16, NULL );
411 mbedtls_mpi_write_file( "E: ", &E, 16, NULL );
412 }
413 else
414 #endif
415 #if defined(MBEDTLS_ECP_C)
416 if( mbedtls_pk_get_type( &key ) == MBEDTLS_PK_ECKEY )
417 {
418 mbedtls_ecp_keypair *ecp = mbedtls_pk_ec( key );
419 mbedtls_mpi_write_file( "Q(X): ", &ecp->Q.X, 16, NULL );
420 mbedtls_mpi_write_file( "Q(Y): ", &ecp->Q.Y, 16, NULL );
421 mbedtls_mpi_write_file( "Q(Z): ", &ecp->Q.Z, 16, NULL );
422 }
423 else
424 #endif
425 mbedtls_printf("key type not supported yet\n");
426 }
427 else
428 goto usage;
429
430 if( opt.output_mode == OUTPUT_MODE_PUBLIC )
431 {
432 write_public_key( &key, opt.output_file );
433 }
434 if( opt.output_mode == OUTPUT_MODE_PRIVATE )
435 {
436 write_private_key( &key, opt.output_file );
437 }
438
439 exit_code = MBEDTLS_EXIT_SUCCESS;
440
441 exit:
442
443 if( exit_code != MBEDTLS_EXIT_SUCCESS )
444 {
445 #ifdef MBEDTLS_ERROR_C
446 mbedtls_strerror( ret, buf, sizeof( buf ) );
447 mbedtls_printf( " - %s\n", buf );
448 #else
449 mbedtls_printf("\n");
450 #endif
451 }
452
453 mbedtls_mpi_free( &N ); mbedtls_mpi_free( &P ); mbedtls_mpi_free( &Q );
454 mbedtls_mpi_free( &D ); mbedtls_mpi_free( &E ); mbedtls_mpi_free( &DP );
455 mbedtls_mpi_free( &DQ ); mbedtls_mpi_free( &QP );
456
457 mbedtls_pk_free( &key );
458
459 #if defined(_WIN32)
460 mbedtls_printf( " + Press Enter to exit this program.\n" );
461 fflush( stdout ); getchar();
462 #endif
463
464 mbedtls_exit( exit_code );
465 }
466 #endif /* MBEDTLS_PK_PARSE_C && MBEDTLS_PK_WRITE_C && MBEDTLS_FS_IO */
467