blob: 914b33ff46c9c3ae64829a9b2cfdbf1be22d84ec [file] [log] [blame]
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001/*
2 * Public Key layer for writing key files and structures
3 *
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02004 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020018 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000019 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020020 */
21
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000023#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020024#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020026#endif
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020028#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/pk.h"
31#include "mbedtls/asn1write.h"
32#include "mbedtls/oid.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050033#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000034#include "mbedtls/error.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020035
Rich Evans00ab4702015-02-06 13:43:58 +000036#include <string.h>
37
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/rsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020040#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if defined(MBEDTLS_ECP_C)
Gilles Peskine2700cfb2018-08-11 00:48:44 +020042#include "mbedtls/bignum.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000043#include "mbedtls/ecp.h"
Gilles Peskine2700cfb2018-08-11 00:48:44 +020044#include "mbedtls/platform_util.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020045#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020046#if defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000047#include "mbedtls/ecdsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020048#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#if defined(MBEDTLS_PEM_WRITE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/pem.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020051#endif
52
Andrzej Kurek5fec0862018-11-19 10:07:36 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
54#include "psa/crypto.h"
Hanno Becker65935d92019-02-01 11:55:03 +000055#include "mbedtls/psa_util.h"
Andrzej Kurek5fec0862018-11-19 10:07:36 -050056#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020057#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/platform.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020059#else
60#include <stdlib.h>
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +020061#define mbedtls_calloc calloc
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#define mbedtls_free free
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020063#endif
64
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050065/* Parameter validation macros based on platform_util.h */
66#define PK_VALIDATE_RET( cond ) \
67 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_PK_BAD_INPUT_DATA )
68#define PK_VALIDATE( cond ) \
69 MBEDTLS_INTERNAL_VALIDATE( cond )
70
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071#if defined(MBEDTLS_RSA_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020072/*
73 * RSAPublicKey ::= SEQUENCE {
74 * modulus INTEGER, -- n
75 * publicExponent INTEGER -- e
76 * }
77 */
78static int pk_write_rsa_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +010079 mbedtls_rsa_context *rsa )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020080{
Janos Follath24eed8d2019-11-22 13:21:35 +000081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020082 size_t len = 0;
Hanno Becker15f81fa2017-08-23 12:38:27 +010083 mbedtls_mpi T;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020084
Hanno Becker15f81fa2017-08-23 12:38:27 +010085 mbedtls_mpi_init( &T );
86
87 /* Export E */
88 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &T ) ) != 0 ||
89 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
90 goto end_of_export;
91 len += ret;
92
93 /* Export N */
94 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL, NULL, NULL, NULL ) ) != 0 ||
95 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
96 goto end_of_export;
97 len += ret;
98
99end_of_export:
100
101 mbedtls_mpi_free( &T );
102 if( ret < 0 )
103 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200104
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
106 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start, MBEDTLS_ASN1_CONSTRUCTED |
107 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200108
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200109 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200110}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111#endif /* MBEDTLS_RSA_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113#if defined(MBEDTLS_ECP_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200114/*
115 * EC public key is an EC point
116 */
117static int pk_write_ec_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100118 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200119{
Janos Follath24eed8d2019-11-22 13:21:35 +0000120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200121 size_t len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122 unsigned char buf[MBEDTLS_ECP_MAX_PT_LEN];
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124 if( ( ret = mbedtls_ecp_point_write_binary( &ec->grp, &ec->Q,
125 MBEDTLS_ECP_PF_UNCOMPRESSED,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200126 &len, buf, sizeof( buf ) ) ) != 0 )
127 {
128 return( ret );
129 }
130
Manuel Pégourié-Gonnard4dc9b392015-10-21 12:23:09 +0200131 if( *p < start || (size_t)( *p - start ) < len )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200133
134 *p -= len;
135 memcpy( *p, buf, len );
136
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200137 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200138}
139
140/*
141 * ECParameters ::= CHOICE {
142 * namedCurve OBJECT IDENTIFIER
143 * }
144 */
145static int pk_write_ec_param( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100146 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200147{
Janos Follath24eed8d2019-11-22 13:21:35 +0000148 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200149 size_t len = 0;
150 const char *oid;
151 size_t oid_len;
152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 if( ( ret = mbedtls_oid_get_oid_by_ec_grp( ec->grp.id, &oid, &oid_len ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200154 return( ret );
155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_oid( p, start, oid, oid_len ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200157
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200158 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200159}
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200160
161/*
162 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
163 */
164static int pk_write_ec_private( unsigned char **p, unsigned char *start,
165 mbedtls_ecp_keypair *ec )
166{
Janos Follath24eed8d2019-11-22 13:21:35 +0000167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200168 size_t byte_length = ( ec->grp.pbits + 7 ) / 8;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200169 size_t output_length;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200170 unsigned char tmp[MBEDTLS_ECP_MAX_BYTES];
171
Steven Cooremane3fd3922020-06-11 16:50:36 +0200172 ret = mbedtls_ecp_write_key( ec->grp.id, ec, &output_length, tmp, byte_length );
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200173 if( ret != 0 )
174 goto exit;
175 ret = mbedtls_asn1_write_octet_string( p, start, tmp, byte_length );
176
177exit:
178 mbedtls_platform_zeroize( tmp, byte_length );
179 return( ret );
180}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#endif /* MBEDTLS_ECP_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100184 const mbedtls_pk_context *key )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200185{
Janos Follath24eed8d2019-11-22 13:21:35 +0000186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200187 size_t len = 0;
188
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500189 PK_VALIDATE_RET( p != NULL );
190 PK_VALIDATE_RET( *p != NULL );
191 PK_VALIDATE_RET( start != NULL );
192 PK_VALIDATE_RET( key != NULL );
193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#if defined(MBEDTLS_RSA_C)
195 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
196 MBEDTLS_ASN1_CHK_ADD( len, pk_write_rsa_pubkey( p, start, mbedtls_pk_rsa( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200197 else
198#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_ECP_C)
200 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
201 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_pubkey( p, start, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200202 else
203#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500204#if defined(MBEDTLS_USE_PSA_CRYPTO)
205 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_OPAQUE )
206 {
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500207 size_t buffer_size;
Andrzej Kurek2349c4d2019-01-08 09:36:01 -0500208 psa_key_handle_t* key_slot = (psa_key_handle_t*) key->pk_ctx;
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500209
210 if ( *p < start )
211 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
212
Andrzej Kurekb7f3ac62018-11-20 03:03:28 -0500213 buffer_size = (size_t)( *p - start );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500214 if ( psa_export_public_key( *key_slot, start, buffer_size, &len )
215 != PSA_SUCCESS )
216 {
Andrzej Kurek4b114072018-11-19 18:04:01 -0500217 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500218 }
219 else
220 {
Hanno Becker4fb8db22019-02-01 09:57:20 +0000221 *p -= len;
222 memmove( *p, start, len );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500223 }
224 }
225 else
226#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200228
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200229 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200230}
231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200233{
Janos Follath24eed8d2019-11-22 13:21:35 +0000234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200235 unsigned char *c;
236 size_t len = 0, par_len = 0, oid_len;
Hanno Becker493c1712019-02-01 10:07:07 +0000237 mbedtls_pk_type_t pk_type;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200238 const char *oid;
239
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500240 PK_VALIDATE_RET( key != NULL );
241 if( size == 0 )
242 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
243 PK_VALIDATE_RET( buf != NULL );
244
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200245 c = buf + size;
246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200248
249 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200251
252 /*
253 * SubjectPublicKeyInfo ::= SEQUENCE {
254 * algorithm AlgorithmIdentifier,
255 * subjectPublicKey BIT STRING }
256 */
257 *--c = 0;
258 len += 1;
259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
261 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200262
Hanno Becker493c1712019-02-01 10:07:07 +0000263 pk_type = mbedtls_pk_get_type( key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#if defined(MBEDTLS_ECP_C)
Hanno Becker493c1712019-02-01 10:07:07 +0000265 if( pk_type == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200268 }
269#endif
Hanno Becker493c1712019-02-01 10:07:07 +0000270#if defined(MBEDTLS_USE_PSA_CRYPTO)
271 if( pk_type == MBEDTLS_PK_OPAQUE )
272 {
Gilles Peskined2d45c12019-05-27 14:53:13 +0200273 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Hanno Becker493c1712019-02-01 10:07:07 +0000274 psa_key_type_t key_type;
275 psa_key_handle_t handle;
276 psa_ecc_curve_t curve;
Gilles Peskine89177e82019-12-03 21:19:09 +0100277 size_t bits;
Hanno Becker493c1712019-02-01 10:07:07 +0000278
279 handle = *((psa_key_handle_t*) key->pk_ctx );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200280 if( PSA_SUCCESS != psa_get_key_attributes( handle, &attributes ) )
Hanno Becker493c1712019-02-01 10:07:07 +0000281 return( MBEDTLS_ERR_PK_HW_ACCEL_FAILED );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200282 key_type = psa_get_key_type( &attributes );
Gilles Peskine89177e82019-12-03 21:19:09 +0100283 bits = psa_get_key_bits( &attributes );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200284 psa_reset_key_attributes( &attributes );
Hanno Becker493c1712019-02-01 10:07:07 +0000285
Gilles Peskinef65ed6f2019-12-04 17:18:41 +0100286 curve = PSA_KEY_TYPE_GET_CURVE( key_type );
Hanno Becker493c1712019-02-01 10:07:07 +0000287 if( curve == 0 )
288 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
289
Gilles Peskine89177e82019-12-03 21:19:09 +0100290 ret = mbedtls_psa_get_ecc_oid_from_id( curve, bits, &oid, &oid_len );
Hanno Becker493c1712019-02-01 10:07:07 +0000291 if( ret != 0 )
292 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
293
294 /* Write EC algorithm parameters; that's akin
295 * to pk_write_ec_param() above. */
296 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_oid( &c, buf,
297 oid, oid_len ) );
298
299 /* The rest of the function works as for legacy EC contexts. */
300 pk_type = MBEDTLS_PK_ECKEY;
301 }
302#endif /* MBEDTLS_USE_PSA_CRYPTO */
303
304 if( ( ret = mbedtls_oid_get_oid_by_pk_alg( pk_type, &oid,
305 &oid_len ) ) != 0 )
306 {
307 return( ret );
308 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_algorithm_identifier( &c, buf, oid, oid_len,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200311 par_len ) );
312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
314 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
315 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200316
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200317 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200318}
319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320int mbedtls_pk_write_key_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200321{
Janos Follath24eed8d2019-11-22 13:21:35 +0000322 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500323 unsigned char *c;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200324 size_t len = 0;
325
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500326 PK_VALIDATE_RET( key != NULL );
327 if( size == 0 )
328 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
329 PK_VALIDATE_RET( buf != NULL );
330
331 c = buf + size;
332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333#if defined(MBEDTLS_RSA_C)
334 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200335 {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100336 mbedtls_mpi T; /* Temporary holding the exported parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337 mbedtls_rsa_context *rsa = mbedtls_pk_rsa( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200338
Hanno Becker15f81fa2017-08-23 12:38:27 +0100339 /*
340 * Export the parameters one after another to avoid simultaneous copies.
341 */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200342
Hanno Becker15f81fa2017-08-23 12:38:27 +0100343 mbedtls_mpi_init( &T );
344
345 /* Export QP */
346 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, NULL, &T ) ) != 0 ||
347 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
348 goto end_of_export;
349 len += ret;
350
351 /* Export DQ */
352 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, &T, NULL ) ) != 0 ||
353 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
354 goto end_of_export;
355 len += ret;
356
357 /* Export DP */
358 if( ( ret = mbedtls_rsa_export_crt( rsa, &T, NULL, NULL ) ) != 0 ||
359 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
360 goto end_of_export;
361 len += ret;
362
363 /* Export Q */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100364 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
365 &T, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100366 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
367 goto end_of_export;
368 len += ret;
369
370 /* Export P */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100371 if ( ( ret = mbedtls_rsa_export( rsa, NULL, &T,
372 NULL, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100373 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
374 goto end_of_export;
375 len += ret;
376
377 /* Export D */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100378 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
379 NULL, &T, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100380 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
381 goto end_of_export;
382 len += ret;
383
384 /* Export E */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100385 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
386 NULL, NULL, &T ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100387 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
388 goto end_of_export;
389 len += ret;
390
391 /* Export N */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100392 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL,
393 NULL, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100394 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
395 goto end_of_export;
396 len += ret;
397
398 end_of_export:
399
400 mbedtls_mpi_free( &T );
401 if( ret < 0 )
402 return( ret );
403
404 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 0 ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200405 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
Hanno Beckerd71dc152017-08-23 06:32:42 +0100406 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c,
407 buf, MBEDTLS_ASN1_CONSTRUCTED |
408 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200409 }
410 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200411#endif /* MBEDTLS_RSA_C */
412#if defined(MBEDTLS_ECP_C)
413 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200414 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415 mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200416 size_t pub_len = 0, par_len = 0;
417
418 /*
419 * RFC 5915, or SEC1 Appendix C.4
420 *
421 * ECPrivateKey ::= SEQUENCE {
422 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
423 * privateKey OCTET STRING,
424 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
425 * publicKey [1] BIT STRING OPTIONAL
426 * }
427 */
428
429 /* publicKey */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 MBEDTLS_ASN1_CHK_ADD( pub_len, pk_write_ec_pubkey( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200431
432 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200434 *--c = 0;
435 pub_len += 1;
436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200437 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
438 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200440 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
441 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf,
442 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200443 len += pub_len;
444
445 /* parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_len( &c, buf, par_len ) );
449 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_tag( &c, buf,
450 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 0 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200451 len += par_len;
452
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200453 /* privateKey */
454 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_private( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200455
456 /* version */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200459 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
460 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
461 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200462 }
463 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200464#endif /* MBEDTLS_ECP_C */
465 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200466
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200467 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200468}
469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200471
472#define PEM_BEGIN_PUBLIC_KEY "-----BEGIN PUBLIC KEY-----\n"
473#define PEM_END_PUBLIC_KEY "-----END PUBLIC KEY-----\n"
474
475#define PEM_BEGIN_PRIVATE_KEY_RSA "-----BEGIN RSA PRIVATE KEY-----\n"
476#define PEM_END_PRIVATE_KEY_RSA "-----END RSA PRIVATE KEY-----\n"
477#define PEM_BEGIN_PRIVATE_KEY_EC "-----BEGIN EC PRIVATE KEY-----\n"
478#define PEM_END_PRIVATE_KEY_EC "-----END EC PRIVATE KEY-----\n"
479
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200480/*
481 * Max sizes of key per types. Shown as tag + len (+ content).
482 */
483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200485/*
486 * RSA public keys:
487 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 3
488 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
489 * + 1 + 1 + 9 (rsa oid)
490 * + 1 + 1 (params null)
491 * subjectPublicKey BIT STRING } 1 + 3 + (1 + below)
492 * RSAPublicKey ::= SEQUENCE { 1 + 3
493 * modulus INTEGER, -- n 1 + 3 + MPI_MAX + 1
494 * publicExponent INTEGER -- e 1 + 3 + MPI_MAX + 1
495 * }
496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497#define RSA_PUB_DER_MAX_BYTES 38 + 2 * MBEDTLS_MPI_MAX_SIZE
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200498
499/*
500 * RSA private keys:
501 * RSAPrivateKey ::= SEQUENCE { 1 + 3
502 * version Version, 1 + 1 + 1
503 * modulus INTEGER, 1 + 3 + MPI_MAX + 1
504 * publicExponent INTEGER, 1 + 3 + MPI_MAX + 1
505 * privateExponent INTEGER, 1 + 3 + MPI_MAX + 1
506 * prime1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
507 * prime2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
508 * exponent1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
509 * exponent2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
510 * coefficient INTEGER, 1 + 3 + MPI_MAX / 2 + 1
511 * otherPrimeInfos OtherPrimeInfos OPTIONAL 0 (not supported)
512 * }
513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200514#define MPI_MAX_SIZE_2 MBEDTLS_MPI_MAX_SIZE / 2 + \
515 MBEDTLS_MPI_MAX_SIZE % 2
516#define RSA_PRV_DER_MAX_BYTES 47 + 3 * MBEDTLS_MPI_MAX_SIZE \
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200517 + 5 * MPI_MAX_SIZE_2
518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519#else /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200520
521#define RSA_PUB_DER_MAX_BYTES 0
522#define RSA_PRV_DER_MAX_BYTES 0
523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524#endif /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200527/*
528 * EC public keys:
529 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 2
530 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
531 * + 1 + 1 + 7 (ec oid)
532 * + 1 + 1 + 9 (namedCurve oid)
533 * subjectPublicKey BIT STRING 1 + 2 + 1 [1]
534 * + 1 (point format) [1]
535 * + 2 * ECP_MAX (coords) [1]
536 * }
537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538#define ECP_PUB_DER_MAX_BYTES 30 + 2 * MBEDTLS_ECP_MAX_BYTES
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200539
540/*
541 * EC private keys:
542 * ECPrivateKey ::= SEQUENCE { 1 + 2
543 * version INTEGER , 1 + 1 + 1
544 * privateKey OCTET STRING, 1 + 1 + ECP_MAX
545 * parameters [0] ECParameters OPTIONAL, 1 + 1 + (1 + 1 + 9)
546 * publicKey [1] BIT STRING OPTIONAL 1 + 2 + [1] above
547 * }
548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549#define ECP_PRV_DER_MAX_BYTES 29 + 3 * MBEDTLS_ECP_MAX_BYTES
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#else /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200552
553#define ECP_PUB_DER_MAX_BYTES 0
554#define ECP_PRV_DER_MAX_BYTES 0
555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200557
558#define PUB_DER_MAX_BYTES RSA_PUB_DER_MAX_BYTES > ECP_PUB_DER_MAX_BYTES ? \
559 RSA_PUB_DER_MAX_BYTES : ECP_PUB_DER_MAX_BYTES
560#define PRV_DER_MAX_BYTES RSA_PRV_DER_MAX_BYTES > ECP_PRV_DER_MAX_BYTES ? \
561 RSA_PRV_DER_MAX_BYTES : ECP_PRV_DER_MAX_BYTES
562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200564{
Janos Follath24eed8d2019-11-22 13:21:35 +0000565 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200566 unsigned char output_buf[PUB_DER_MAX_BYTES];
Paul Bakker77e23fb2013-09-15 20:03:26 +0200567 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200568
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500569 PK_VALIDATE_RET( key != NULL );
570 PK_VALIDATE_RET( buf != NULL || size == 0 );
571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572 if( ( ret = mbedtls_pk_write_pubkey_der( key, output_buf,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200573 sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200574 {
575 return( ret );
576 }
577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578 if( ( ret = mbedtls_pem_write_buffer( PEM_BEGIN_PUBLIC_KEY, PEM_END_PUBLIC_KEY,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200579 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200580 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200581 {
582 return( ret );
583 }
584
585 return( 0 );
586}
587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588int mbedtls_pk_write_key_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200589{
Janos Follath24eed8d2019-11-22 13:21:35 +0000590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200591 unsigned char output_buf[PRV_DER_MAX_BYTES];
Paul Bakkerfcc17212013-10-11 09:36:52 +0200592 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200593 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200594
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500595 PK_VALIDATE_RET( key != NULL );
596 PK_VALIDATE_RET( buf != NULL || size == 0 );
597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 if( ( ret = mbedtls_pk_write_key_der( key, output_buf, sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200599 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601#if defined(MBEDTLS_RSA_C)
602 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200603 {
604 begin = PEM_BEGIN_PRIVATE_KEY_RSA;
605 end = PEM_END_PRIVATE_KEY_RSA;
606 }
607 else
608#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609#if defined(MBEDTLS_ECP_C)
610 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200611 {
612 begin = PEM_BEGIN_PRIVATE_KEY_EC;
613 end = PEM_END_PRIVATE_KEY_EC;
614 }
615 else
616#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619 if( ( ret = mbedtls_pem_write_buffer( begin, end,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200620 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200621 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200622 {
623 return( ret );
624 }
625
626 return( 0 );
627}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630#endif /* MBEDTLS_PK_WRITE_C */