blob: 7ec84f3e8d7e54bdaffa4fbc150ec81ea73a4f41 [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
Gilles Peskinedb09ef62020-06-03 01:43:33 +020022#include "common.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020025
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000026#include "mbedtls/pk.h"
27#include "mbedtls/asn1write.h"
28#include "mbedtls/oid.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050029#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000030#include "mbedtls/error.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020031
Rich Evans00ab4702015-02-06 13:43:58 +000032#include <string.h>
33
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020034#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000035#include "mbedtls/rsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020036#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#if defined(MBEDTLS_ECP_C)
Gilles Peskine2700cfb2018-08-11 00:48:44 +020038#include "mbedtls/bignum.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/ecp.h"
Gilles Peskine2700cfb2018-08-11 00:48:44 +020040#include "mbedtls/platform_util.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020041#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#if defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000043#include "mbedtls/ecdsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020044#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020045#if defined(MBEDTLS_PEM_WRITE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000046#include "mbedtls/pem.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020047#endif
48
Andrzej Kurek5fec0862018-11-19 10:07:36 -050049#if defined(MBEDTLS_USE_PSA_CRYPTO)
50#include "psa/crypto.h"
Hanno Becker65935d92019-02-01 11:55:03 +000051#include "mbedtls/psa_util.h"
Andrzej Kurek5fec0862018-11-19 10:07:36 -050052#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/platform.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020055#else
56#include <stdlib.h>
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +020057#define mbedtls_calloc calloc
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020058#define mbedtls_free free
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020059#endif
60
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050061/* Parameter validation macros based on platform_util.h */
62#define PK_VALIDATE_RET( cond ) \
63 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_PK_BAD_INPUT_DATA )
64#define PK_VALIDATE( cond ) \
65 MBEDTLS_INTERNAL_VALIDATE( cond )
66
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067#if defined(MBEDTLS_RSA_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020068/*
69 * RSAPublicKey ::= SEQUENCE {
70 * modulus INTEGER, -- n
71 * publicExponent INTEGER -- e
72 * }
73 */
74static int pk_write_rsa_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +010075 mbedtls_rsa_context *rsa )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020076{
Janos Follath24eed8d2019-11-22 13:21:35 +000077 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020078 size_t len = 0;
Hanno Becker15f81fa2017-08-23 12:38:27 +010079 mbedtls_mpi T;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020080
Hanno Becker15f81fa2017-08-23 12:38:27 +010081 mbedtls_mpi_init( &T );
82
83 /* Export E */
84 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &T ) ) != 0 ||
85 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
86 goto end_of_export;
87 len += ret;
88
89 /* Export N */
90 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL, NULL, NULL, NULL ) ) != 0 ||
91 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
92 goto end_of_export;
93 len += ret;
94
95end_of_export:
96
97 mbedtls_mpi_free( &T );
98 if( ret < 0 )
99 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
102 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start, MBEDTLS_ASN1_CONSTRUCTED |
103 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200104
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200105 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200106}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107#endif /* MBEDTLS_RSA_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109#if defined(MBEDTLS_ECP_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200110/*
111 * EC public key is an EC point
112 */
113static int pk_write_ec_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100114 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200115{
Janos Follath24eed8d2019-11-22 13:21:35 +0000116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200117 size_t len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118 unsigned char buf[MBEDTLS_ECP_MAX_PT_LEN];
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120 if( ( ret = mbedtls_ecp_point_write_binary( &ec->grp, &ec->Q,
121 MBEDTLS_ECP_PF_UNCOMPRESSED,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200122 &len, buf, sizeof( buf ) ) ) != 0 )
123 {
124 return( ret );
125 }
126
Manuel Pégourié-Gonnard4dc9b392015-10-21 12:23:09 +0200127 if( *p < start || (size_t)( *p - start ) < len )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200128 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200129
130 *p -= len;
131 memcpy( *p, buf, len );
132
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200133 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200134}
135
136/*
137 * ECParameters ::= CHOICE {
138 * namedCurve OBJECT IDENTIFIER
139 * }
140 */
141static int pk_write_ec_param( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100142 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200143{
Janos Follath24eed8d2019-11-22 13:21:35 +0000144 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200145 size_t len = 0;
146 const char *oid;
147 size_t oid_len;
148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200149 if( ( ret = mbedtls_oid_get_oid_by_ec_grp( ec->grp.id, &oid, &oid_len ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200150 return( ret );
151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200152 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_oid( p, start, oid, oid_len ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200153
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200154 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200155}
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200156
157/*
158 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
159 */
160static int pk_write_ec_private( unsigned char **p, unsigned char *start,
161 mbedtls_ecp_keypair *ec )
162{
Janos Follath24eed8d2019-11-22 13:21:35 +0000163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200164 size_t byte_length = ( ec->grp.pbits + 7 ) / 8;
165 unsigned char tmp[MBEDTLS_ECP_MAX_BYTES];
166
167 ret = mbedtls_mpi_write_binary( &ec->d, tmp, byte_length );
168 if( ret != 0 )
169 goto exit;
170 ret = mbedtls_asn1_write_octet_string( p, start, tmp, byte_length );
171
172exit:
173 mbedtls_platform_zeroize( tmp, byte_length );
174 return( ret );
175}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176#endif /* MBEDTLS_ECP_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100179 const mbedtls_pk_context *key )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200180{
Janos Follath24eed8d2019-11-22 13:21:35 +0000181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200182 size_t len = 0;
183
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500184 PK_VALIDATE_RET( p != NULL );
185 PK_VALIDATE_RET( *p != NULL );
186 PK_VALIDATE_RET( start != NULL );
187 PK_VALIDATE_RET( key != NULL );
188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#if defined(MBEDTLS_RSA_C)
190 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
191 MBEDTLS_ASN1_CHK_ADD( len, pk_write_rsa_pubkey( p, start, mbedtls_pk_rsa( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200192 else
193#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#if defined(MBEDTLS_ECP_C)
195 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
196 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_pubkey( p, start, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200197 else
198#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500199#if defined(MBEDTLS_USE_PSA_CRYPTO)
200 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_OPAQUE )
201 {
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500202 size_t buffer_size;
Andrzej Kurek2349c4d2019-01-08 09:36:01 -0500203 psa_key_handle_t* key_slot = (psa_key_handle_t*) key->pk_ctx;
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500204
205 if ( *p < start )
206 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
207
Andrzej Kurekb7f3ac62018-11-20 03:03:28 -0500208 buffer_size = (size_t)( *p - start );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500209 if ( psa_export_public_key( *key_slot, start, buffer_size, &len )
210 != PSA_SUCCESS )
211 {
Andrzej Kurek4b114072018-11-19 18:04:01 -0500212 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500213 }
214 else
215 {
Hanno Becker4fb8db22019-02-01 09:57:20 +0000216 *p -= len;
217 memmove( *p, start, len );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500218 }
219 }
220 else
221#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200223
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200224 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200225}
226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200228{
Janos Follath24eed8d2019-11-22 13:21:35 +0000229 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200230 unsigned char *c;
231 size_t len = 0, par_len = 0, oid_len;
Hanno Becker493c1712019-02-01 10:07:07 +0000232 mbedtls_pk_type_t pk_type;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200233 const char *oid;
234
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500235 PK_VALIDATE_RET( key != NULL );
236 if( size == 0 )
237 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
238 PK_VALIDATE_RET( buf != NULL );
239
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200240 c = buf + size;
241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200243
244 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200246
247 /*
248 * SubjectPublicKeyInfo ::= SEQUENCE {
249 * algorithm AlgorithmIdentifier,
250 * subjectPublicKey BIT STRING }
251 */
252 *--c = 0;
253 len += 1;
254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200255 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
256 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200257
Hanno Becker493c1712019-02-01 10:07:07 +0000258 pk_type = mbedtls_pk_get_type( key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259#if defined(MBEDTLS_ECP_C)
Hanno Becker493c1712019-02-01 10:07:07 +0000260 if( pk_type == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200261 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200263 }
264#endif
Hanno Becker493c1712019-02-01 10:07:07 +0000265#if defined(MBEDTLS_USE_PSA_CRYPTO)
266 if( pk_type == MBEDTLS_PK_OPAQUE )
267 {
Gilles Peskined2d45c12019-05-27 14:53:13 +0200268 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Hanno Becker493c1712019-02-01 10:07:07 +0000269 psa_key_type_t key_type;
270 psa_key_handle_t handle;
271 psa_ecc_curve_t curve;
Gilles Peskine89177e82019-12-03 21:19:09 +0100272 size_t bits;
Hanno Becker493c1712019-02-01 10:07:07 +0000273
274 handle = *((psa_key_handle_t*) key->pk_ctx );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200275 if( PSA_SUCCESS != psa_get_key_attributes( handle, &attributes ) )
Hanno Becker493c1712019-02-01 10:07:07 +0000276 return( MBEDTLS_ERR_PK_HW_ACCEL_FAILED );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200277 key_type = psa_get_key_type( &attributes );
Gilles Peskine89177e82019-12-03 21:19:09 +0100278 bits = psa_get_key_bits( &attributes );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200279 psa_reset_key_attributes( &attributes );
Hanno Becker493c1712019-02-01 10:07:07 +0000280
Gilles Peskinef65ed6f2019-12-04 17:18:41 +0100281 curve = PSA_KEY_TYPE_GET_CURVE( key_type );
Hanno Becker493c1712019-02-01 10:07:07 +0000282 if( curve == 0 )
283 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
284
Gilles Peskine89177e82019-12-03 21:19:09 +0100285 ret = mbedtls_psa_get_ecc_oid_from_id( curve, bits, &oid, &oid_len );
Hanno Becker493c1712019-02-01 10:07:07 +0000286 if( ret != 0 )
287 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
288
289 /* Write EC algorithm parameters; that's akin
290 * to pk_write_ec_param() above. */
291 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_oid( &c, buf,
292 oid, oid_len ) );
293
294 /* The rest of the function works as for legacy EC contexts. */
295 pk_type = MBEDTLS_PK_ECKEY;
296 }
297#endif /* MBEDTLS_USE_PSA_CRYPTO */
298
299 if( ( ret = mbedtls_oid_get_oid_by_pk_alg( pk_type, &oid,
300 &oid_len ) ) != 0 )
301 {
302 return( ret );
303 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_algorithm_identifier( &c, buf, oid, oid_len,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200306 par_len ) );
307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
309 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
310 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200311
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200312 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200313}
314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315int mbedtls_pk_write_key_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200316{
Janos Follath24eed8d2019-11-22 13:21:35 +0000317 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500318 unsigned char *c;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200319 size_t len = 0;
320
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500321 PK_VALIDATE_RET( key != NULL );
322 if( size == 0 )
323 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
324 PK_VALIDATE_RET( buf != NULL );
325
326 c = buf + size;
327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328#if defined(MBEDTLS_RSA_C)
329 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200330 {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100331 mbedtls_mpi T; /* Temporary holding the exported parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332 mbedtls_rsa_context *rsa = mbedtls_pk_rsa( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200333
Hanno Becker15f81fa2017-08-23 12:38:27 +0100334 /*
335 * Export the parameters one after another to avoid simultaneous copies.
336 */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200337
Hanno Becker15f81fa2017-08-23 12:38:27 +0100338 mbedtls_mpi_init( &T );
339
340 /* Export QP */
341 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, NULL, &T ) ) != 0 ||
342 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
343 goto end_of_export;
344 len += ret;
345
346 /* Export DQ */
347 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, &T, NULL ) ) != 0 ||
348 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
349 goto end_of_export;
350 len += ret;
351
352 /* Export DP */
353 if( ( ret = mbedtls_rsa_export_crt( rsa, &T, NULL, NULL ) ) != 0 ||
354 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
355 goto end_of_export;
356 len += ret;
357
358 /* Export Q */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100359 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
360 &T, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100361 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
362 goto end_of_export;
363 len += ret;
364
365 /* Export P */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100366 if ( ( ret = mbedtls_rsa_export( rsa, NULL, &T,
367 NULL, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100368 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
369 goto end_of_export;
370 len += ret;
371
372 /* Export D */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100373 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
374 NULL, &T, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100375 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
376 goto end_of_export;
377 len += ret;
378
379 /* Export E */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100380 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
381 NULL, NULL, &T ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100382 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
383 goto end_of_export;
384 len += ret;
385
386 /* Export N */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100387 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL,
388 NULL, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100389 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
390 goto end_of_export;
391 len += ret;
392
393 end_of_export:
394
395 mbedtls_mpi_free( &T );
396 if( ret < 0 )
397 return( ret );
398
399 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 0 ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
Hanno Beckerd71dc152017-08-23 06:32:42 +0100401 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c,
402 buf, MBEDTLS_ASN1_CONSTRUCTED |
403 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200404 }
405 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200406#endif /* MBEDTLS_RSA_C */
407#if defined(MBEDTLS_ECP_C)
408 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200410 mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200411 size_t pub_len = 0, par_len = 0;
412
413 /*
414 * RFC 5915, or SEC1 Appendix C.4
415 *
416 * ECPrivateKey ::= SEQUENCE {
417 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
418 * privateKey OCTET STRING,
419 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
420 * publicKey [1] BIT STRING OPTIONAL
421 * }
422 */
423
424 /* publicKey */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425 MBEDTLS_ASN1_CHK_ADD( pub_len, pk_write_ec_pubkey( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200426
427 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200429 *--c = 0;
430 pub_len += 1;
431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200432 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
433 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200435 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
436 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf,
437 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200438 len += pub_len;
439
440 /* parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_len( &c, buf, par_len ) );
444 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_tag( &c, buf,
445 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 0 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200446 len += par_len;
447
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200448 /* privateKey */
449 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_private( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200450
451 /* version */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
455 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
456 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200457 }
458 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200459#endif /* MBEDTLS_ECP_C */
460 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200461
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200462 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200463}
464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200466
467#define PEM_BEGIN_PUBLIC_KEY "-----BEGIN PUBLIC KEY-----\n"
468#define PEM_END_PUBLIC_KEY "-----END PUBLIC KEY-----\n"
469
470#define PEM_BEGIN_PRIVATE_KEY_RSA "-----BEGIN RSA PRIVATE KEY-----\n"
471#define PEM_END_PRIVATE_KEY_RSA "-----END RSA PRIVATE KEY-----\n"
472#define PEM_BEGIN_PRIVATE_KEY_EC "-----BEGIN EC PRIVATE KEY-----\n"
473#define PEM_END_PRIVATE_KEY_EC "-----END EC PRIVATE KEY-----\n"
474
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200475/*
476 * Max sizes of key per types. Shown as tag + len (+ content).
477 */
478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200480/*
481 * RSA public keys:
482 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 3
483 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
484 * + 1 + 1 + 9 (rsa oid)
485 * + 1 + 1 (params null)
486 * subjectPublicKey BIT STRING } 1 + 3 + (1 + below)
487 * RSAPublicKey ::= SEQUENCE { 1 + 3
488 * modulus INTEGER, -- n 1 + 3 + MPI_MAX + 1
489 * publicExponent INTEGER -- e 1 + 3 + MPI_MAX + 1
490 * }
491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200492#define RSA_PUB_DER_MAX_BYTES 38 + 2 * MBEDTLS_MPI_MAX_SIZE
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200493
494/*
495 * RSA private keys:
496 * RSAPrivateKey ::= SEQUENCE { 1 + 3
497 * version Version, 1 + 1 + 1
498 * modulus INTEGER, 1 + 3 + MPI_MAX + 1
499 * publicExponent INTEGER, 1 + 3 + MPI_MAX + 1
500 * privateExponent INTEGER, 1 + 3 + MPI_MAX + 1
501 * prime1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
502 * prime2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
503 * exponent1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
504 * exponent2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
505 * coefficient INTEGER, 1 + 3 + MPI_MAX / 2 + 1
506 * otherPrimeInfos OtherPrimeInfos OPTIONAL 0 (not supported)
507 * }
508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509#define MPI_MAX_SIZE_2 MBEDTLS_MPI_MAX_SIZE / 2 + \
510 MBEDTLS_MPI_MAX_SIZE % 2
511#define RSA_PRV_DER_MAX_BYTES 47 + 3 * MBEDTLS_MPI_MAX_SIZE \
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200512 + 5 * MPI_MAX_SIZE_2
513
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200514#else /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200515
516#define RSA_PUB_DER_MAX_BYTES 0
517#define RSA_PRV_DER_MAX_BYTES 0
518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519#endif /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200522/*
523 * EC public keys:
524 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 2
525 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
526 * + 1 + 1 + 7 (ec oid)
527 * + 1 + 1 + 9 (namedCurve oid)
528 * subjectPublicKey BIT STRING 1 + 2 + 1 [1]
529 * + 1 (point format) [1]
530 * + 2 * ECP_MAX (coords) [1]
531 * }
532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#define ECP_PUB_DER_MAX_BYTES 30 + 2 * MBEDTLS_ECP_MAX_BYTES
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200534
535/*
536 * EC private keys:
537 * ECPrivateKey ::= SEQUENCE { 1 + 2
538 * version INTEGER , 1 + 1 + 1
539 * privateKey OCTET STRING, 1 + 1 + ECP_MAX
540 * parameters [0] ECParameters OPTIONAL, 1 + 1 + (1 + 1 + 9)
541 * publicKey [1] BIT STRING OPTIONAL 1 + 2 + [1] above
542 * }
543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544#define ECP_PRV_DER_MAX_BYTES 29 + 3 * MBEDTLS_ECP_MAX_BYTES
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546#else /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200547
548#define ECP_PUB_DER_MAX_BYTES 0
549#define ECP_PRV_DER_MAX_BYTES 0
550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200552
553#define PUB_DER_MAX_BYTES RSA_PUB_DER_MAX_BYTES > ECP_PUB_DER_MAX_BYTES ? \
554 RSA_PUB_DER_MAX_BYTES : ECP_PUB_DER_MAX_BYTES
555#define PRV_DER_MAX_BYTES RSA_PRV_DER_MAX_BYTES > ECP_PRV_DER_MAX_BYTES ? \
556 RSA_PRV_DER_MAX_BYTES : ECP_PRV_DER_MAX_BYTES
557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200559{
Janos Follath24eed8d2019-11-22 13:21:35 +0000560 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200561 unsigned char output_buf[PUB_DER_MAX_BYTES];
Paul Bakker77e23fb2013-09-15 20:03:26 +0200562 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200563
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500564 PK_VALIDATE_RET( key != NULL );
565 PK_VALIDATE_RET( buf != NULL || size == 0 );
566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 if( ( ret = mbedtls_pk_write_pubkey_der( key, output_buf,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200568 sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200569 {
570 return( ret );
571 }
572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573 if( ( ret = mbedtls_pem_write_buffer( PEM_BEGIN_PUBLIC_KEY, PEM_END_PUBLIC_KEY,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200574 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200575 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200576 {
577 return( ret );
578 }
579
580 return( 0 );
581}
582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583int mbedtls_pk_write_key_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200584{
Janos Follath24eed8d2019-11-22 13:21:35 +0000585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200586 unsigned char output_buf[PRV_DER_MAX_BYTES];
Paul Bakkerfcc17212013-10-11 09:36:52 +0200587 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200588 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200589
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500590 PK_VALIDATE_RET( key != NULL );
591 PK_VALIDATE_RET( buf != NULL || size == 0 );
592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593 if( ( ret = mbedtls_pk_write_key_der( key, output_buf, sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200594 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596#if defined(MBEDTLS_RSA_C)
597 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200598 {
599 begin = PEM_BEGIN_PRIVATE_KEY_RSA;
600 end = PEM_END_PRIVATE_KEY_RSA;
601 }
602 else
603#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604#if defined(MBEDTLS_ECP_C)
605 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200606 {
607 begin = PEM_BEGIN_PRIVATE_KEY_EC;
608 end = PEM_END_PRIVATE_KEY_EC;
609 }
610 else
611#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 if( ( ret = mbedtls_pem_write_buffer( begin, end,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200615 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200616 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200617 {
618 return( ret );
619 }
620
621 return( 0 );
622}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200625#endif /* MBEDTLS_PK_WRITE_C */