1 /*
2 * Certificate request generation
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_X509_CSR_WRITE_C) || !defined(MBEDTLS_FS_IO) || \
65 !defined(MBEDTLS_PK_PARSE_C) || !defined(MBEDTLS_SHA256_C) || \
66 !defined(MBEDTLS_ENTROPY_C) || !defined(MBEDTLS_CTR_DRBG_C) || \
67 !defined(MBEDTLS_PEM_WRITE_C)
main(void)68 int main( void )
69 {
70 mbedtls_printf( "MBEDTLS_X509_CSR_WRITE_C and/or MBEDTLS_FS_IO and/or "
71 "MBEDTLS_PK_PARSE_C and/or MBEDTLS_SHA256_C and/or "
72 "MBEDTLS_ENTROPY_C and/or MBEDTLS_CTR_DRBG_C "
73 "not defined.\n");
74 mbedtls_exit( 0 );
75 }
76 #else
77
78 #include "mbedtls/x509_csr.h"
79 #include "mbedtls/entropy.h"
80 #include "mbedtls/ctr_drbg.h"
81 #include "mbedtls/error.h"
82
83 #include <stdio.h>
84 #include <stdlib.h>
85 #include <string.h>
86
87 #define DFL_FILENAME "keyfile.key"
88 #define DFL_PASSWORD NULL
89 #define DFL_DEBUG_LEVEL 0
90 #define DFL_OUTPUT_FILENAME "cert.req"
91 #define DFL_SUBJECT_NAME "CN=Cert,O=mbed TLS,C=UK"
92 #define DFL_KEY_USAGE 0
93 #define DFL_FORCE_KEY_USAGE 0
94 #define DFL_NS_CERT_TYPE 0
95 #define DFL_FORCE_NS_CERT_TYPE 0
96 #define DFL_MD_ALG MBEDTLS_MD_SHA256
97
98 #define USAGE \
99 "\n usage: cert_req param=<>...\n" \
100 "\n acceptable parameters:\n" \
101 " filename=%%s default: keyfile.key\n" \
102 " password=%%s default: NULL\n" \
103 " debug_level=%%d default: 0 (disabled)\n" \
104 " output_file=%%s default: cert.req\n" \
105 " subject_name=%%s default: CN=Cert,O=mbed TLS,C=UK\n" \
106 " key_usage=%%s default: (empty)\n" \
107 " Comma-separated-list of values:\n" \
108 " digital_signature\n" \
109 " non_repudiation\n" \
110 " key_encipherment\n" \
111 " data_encipherment\n" \
112 " key_agreement\n" \
113 " key_cert_sign\n" \
114 " crl_sign\n" \
115 " force_key_usage=0/1 default: off\n" \
116 " Add KeyUsage even if it is empty\n" \
117 " ns_cert_type=%%s default: (empty)\n" \
118 " Comma-separated-list of values:\n" \
119 " ssl_client\n" \
120 " ssl_server\n" \
121 " email\n" \
122 " object_signing\n" \
123 " ssl_ca\n" \
124 " email_ca\n" \
125 " object_signing_ca\n" \
126 " force_ns_cert_type=0/1 default: off\n" \
127 " Add NsCertType even if it is empty\n" \
128 " md=%%s default: SHA256\n" \
129 " possible values:\n" \
130 " MD2, MD4, MD5, RIPEMD160, SHA1,\n" \
131 " SHA224, SHA256, SHA384, SHA512\n" \
132 "\n"
133
134
135 /*
136 * global options
137 */
138 struct options
139 {
140 const char *filename; /* filename of the key file */
141 const char *password; /* password for the key file */
142 int debug_level; /* level of debugging */
143 const char *output_file; /* where to store the constructed key file */
144 const char *subject_name; /* subject name for certificate request */
145 unsigned char key_usage; /* key usage flags */
146 int force_key_usage; /* Force adding the KeyUsage extension */
147 unsigned char ns_cert_type; /* NS cert type */
148 int force_ns_cert_type; /* Force adding NsCertType extension */
149 mbedtls_md_type_t md_alg; /* Hash algorithm used for signature. */
150 } opt;
151
write_certificate_request(mbedtls_x509write_csr * req,const char * output_file,int (* f_rng)(void *,unsigned char *,size_t),void * p_rng)152 int write_certificate_request( mbedtls_x509write_csr *req, const char *output_file,
153 int (*f_rng)(void *, unsigned char *, size_t),
154 void *p_rng )
155 {
156 int ret;
157 FILE *f;
158 unsigned char output_buf[4096];
159 size_t len = 0;
160
161 memset( output_buf, 0, 4096 );
162 if( ( ret = mbedtls_x509write_csr_pem( req, output_buf, 4096, f_rng, p_rng ) ) < 0 )
163 return( ret );
164
165 len = strlen( (char *) output_buf );
166
167 if( ( f = fopen( output_file, "w" ) ) == NULL )
168 return( -1 );
169
170 if( fwrite( output_buf, 1, len, f ) != len )
171 {
172 fclose( f );
173 return( -1 );
174 }
175
176 fclose( f );
177
178 return( 0 );
179 }
180
main(int argc,char * argv[])181 int main( int argc, char *argv[] )
182 {
183 int ret = 1;
184 int exit_code = MBEDTLS_EXIT_FAILURE;
185 mbedtls_pk_context key;
186 char buf[1024];
187 int i;
188 char *p, *q, *r;
189 mbedtls_x509write_csr req;
190 mbedtls_entropy_context entropy;
191 mbedtls_ctr_drbg_context ctr_drbg;
192 const char *pers = "csr example app";
193
194 /*
195 * Set to sane values
196 */
197 mbedtls_x509write_csr_init( &req );
198 mbedtls_pk_init( &key );
199 mbedtls_ctr_drbg_init( &ctr_drbg );
200 memset( buf, 0, sizeof( buf ) );
201
202 if( argc == 0 )
203 {
204 usage:
205 mbedtls_printf( USAGE );
206 goto exit;
207 }
208
209 opt.filename = DFL_FILENAME;
210 opt.password = DFL_PASSWORD;
211 opt.debug_level = DFL_DEBUG_LEVEL;
212 opt.output_file = DFL_OUTPUT_FILENAME;
213 opt.subject_name = DFL_SUBJECT_NAME;
214 opt.key_usage = DFL_KEY_USAGE;
215 opt.force_key_usage = DFL_FORCE_KEY_USAGE;
216 opt.ns_cert_type = DFL_NS_CERT_TYPE;
217 opt.force_ns_cert_type = DFL_FORCE_NS_CERT_TYPE;
218 opt.md_alg = DFL_MD_ALG;
219
220 for( i = 1; i < argc; i++ )
221 {
222
223 p = argv[i];
224 if( ( q = strchr( p, '=' ) ) == NULL )
225 goto usage;
226 *q++ = '\0';
227
228 if( strcmp( p, "filename" ) == 0 )
229 opt.filename = q;
230 else if( strcmp( p, "password" ) == 0 )
231 opt.password = q;
232 else if( strcmp( p, "output_file" ) == 0 )
233 opt.output_file = q;
234 else if( strcmp( p, "debug_level" ) == 0 )
235 {
236 opt.debug_level = atoi( q );
237 if( opt.debug_level < 0 || opt.debug_level > 65535 )
238 goto usage;
239 }
240 else if( strcmp( p, "subject_name" ) == 0 )
241 {
242 opt.subject_name = q;
243 }
244 else if( strcmp( p, "md" ) == 0 )
245 {
246 const mbedtls_md_info_t *md_info =
247 mbedtls_md_info_from_string( q );
248 if( md_info == NULL )
249 {
250 mbedtls_printf( "Invalid argument for option %s\n", p );
251 goto usage;
252 }
253 opt.md_alg = mbedtls_md_get_type( md_info );
254 }
255 else if( strcmp( p, "key_usage" ) == 0 )
256 {
257 while( q != NULL )
258 {
259 if( ( r = strchr( q, ',' ) ) != NULL )
260 *r++ = '\0';
261
262 if( strcmp( q, "digital_signature" ) == 0 )
263 opt.key_usage |= MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
264 else if( strcmp( q, "non_repudiation" ) == 0 )
265 opt.key_usage |= MBEDTLS_X509_KU_NON_REPUDIATION;
266 else if( strcmp( q, "key_encipherment" ) == 0 )
267 opt.key_usage |= MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
268 else if( strcmp( q, "data_encipherment" ) == 0 )
269 opt.key_usage |= MBEDTLS_X509_KU_DATA_ENCIPHERMENT;
270 else if( strcmp( q, "key_agreement" ) == 0 )
271 opt.key_usage |= MBEDTLS_X509_KU_KEY_AGREEMENT;
272 else if( strcmp( q, "key_cert_sign" ) == 0 )
273 opt.key_usage |= MBEDTLS_X509_KU_KEY_CERT_SIGN;
274 else if( strcmp( q, "crl_sign" ) == 0 )
275 opt.key_usage |= MBEDTLS_X509_KU_CRL_SIGN;
276 else
277 goto usage;
278
279 q = r;
280 }
281 }
282 else if( strcmp( p, "force_key_usage" ) == 0 )
283 {
284 switch( atoi( q ) )
285 {
286 case 0: opt.force_key_usage = 0; break;
287 case 1: opt.force_key_usage = 1; break;
288 default: goto usage;
289 }
290 }
291 else if( strcmp( p, "ns_cert_type" ) == 0 )
292 {
293 while( q != NULL )
294 {
295 if( ( r = strchr( q, ',' ) ) != NULL )
296 *r++ = '\0';
297
298 if( strcmp( q, "ssl_client" ) == 0 )
299 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT;
300 else if( strcmp( q, "ssl_server" ) == 0 )
301 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER;
302 else if( strcmp( q, "email" ) == 0 )
303 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_EMAIL;
304 else if( strcmp( q, "object_signing" ) == 0 )
305 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING;
306 else if( strcmp( q, "ssl_ca" ) == 0 )
307 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_SSL_CA;
308 else if( strcmp( q, "email_ca" ) == 0 )
309 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA;
310 else if( strcmp( q, "object_signing_ca" ) == 0 )
311 opt.ns_cert_type |= MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA;
312 else
313 goto usage;
314
315 q = r;
316 }
317 }
318 else if( strcmp( p, "force_ns_cert_type" ) == 0 )
319 {
320 switch( atoi( q ) )
321 {
322 case 0: opt.force_ns_cert_type = 0; break;
323 case 1: opt.force_ns_cert_type = 1; break;
324 default: goto usage;
325 }
326 }
327 else
328 goto usage;
329 }
330
331 mbedtls_x509write_csr_set_md_alg( &req, opt.md_alg );
332
333 if( opt.key_usage || opt.force_key_usage == 1 )
334 mbedtls_x509write_csr_set_key_usage( &req, opt.key_usage );
335
336 if( opt.ns_cert_type || opt.force_ns_cert_type == 1 )
337 mbedtls_x509write_csr_set_ns_cert_type( &req, opt.ns_cert_type );
338
339 /*
340 * 0. Seed the PRNG
341 */
342 mbedtls_printf( " . Seeding the random number generator..." );
343 fflush( stdout );
344
345 mbedtls_entropy_init( &entropy );
346 if( ( ret = mbedtls_ctr_drbg_seed( &ctr_drbg, mbedtls_entropy_func, &entropy,
347 (const unsigned char *) pers,
348 strlen( pers ) ) ) != 0 )
349 {
350 mbedtls_printf( " failed\n ! mbedtls_ctr_drbg_seed returned %d", ret );
351 goto exit;
352 }
353
354 mbedtls_printf( " ok\n" );
355
356 /*
357 * 1.0. Check the subject name for validity
358 */
359 mbedtls_printf( " . Checking subject name..." );
360 fflush( stdout );
361
362 if( ( ret = mbedtls_x509write_csr_set_subject_name( &req, opt.subject_name ) ) != 0 )
363 {
364 mbedtls_printf( " failed\n ! mbedtls_x509write_csr_set_subject_name returned %d", ret );
365 goto exit;
366 }
367
368 mbedtls_printf( " ok\n" );
369
370 /*
371 * 1.1. Load the key
372 */
373 mbedtls_printf( " . Loading the private key ..." );
374 fflush( stdout );
375
376 ret = mbedtls_pk_parse_keyfile( &key, opt.filename, opt.password );
377
378 if( ret != 0 )
379 {
380 mbedtls_printf( " failed\n ! mbedtls_pk_parse_keyfile returned %d", ret );
381 goto exit;
382 }
383
384 mbedtls_x509write_csr_set_key( &req, &key );
385
386 mbedtls_printf( " ok\n" );
387
388 /*
389 * 1.2. Writing the request
390 */
391 mbedtls_printf( " . Writing the certificate request ..." );
392 fflush( stdout );
393
394 if( ( ret = write_certificate_request( &req, opt.output_file,
395 mbedtls_ctr_drbg_random, &ctr_drbg ) ) != 0 )
396 {
397 mbedtls_printf( " failed\n ! write_certifcate_request %d", ret );
398 goto exit;
399 }
400
401 mbedtls_printf( " ok\n" );
402
403 exit_code = MBEDTLS_EXIT_SUCCESS;
404
405 exit:
406
407 if( exit_code != MBEDTLS_EXIT_SUCCESS )
408 {
409 #ifdef MBEDTLS_ERROR_C
410 mbedtls_strerror( ret, buf, sizeof( buf ) );
411 mbedtls_printf( " - %s\n", buf );
412 #else
413 mbedtls_printf("\n");
414 #endif
415 }
416
417 mbedtls_x509write_csr_free( &req );
418 mbedtls_pk_free( &key );
419 mbedtls_ctr_drbg_free( &ctr_drbg );
420 mbedtls_entropy_free( &entropy );
421
422 #if defined(_WIN32)
423 mbedtls_printf( " + Press Enter to exit this program.\n" );
424 fflush( stdout ); getchar();
425 #endif
426
427 mbedtls_exit( exit_code );
428 }
429 #endif /* MBEDTLS_X509_CSR_WRITE_C && MBEDTLS_PK_PARSE_C && MBEDTLS_FS_IO &&
430 MBEDTLS_ENTROPY_C && MBEDTLS_CTR_DRBG_C && MBEDTLS_PEM_WRITE_C */
431