blob: c1ce0e3f02f283c7bef5c2fb68b18f188bec43e7 [file] [log] [blame]
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02001/*
2 * Public Key layer for writing key files and structures
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
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 */
19
Gilles Peskinedb09ef62020-06-03 01:43:33 +020020#include "common.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020023
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000024#include "mbedtls/pk.h"
25#include "mbedtls/asn1write.h"
26#include "mbedtls/oid.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050027#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000028#include "mbedtls/error.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020029
Rich Evans00ab4702015-02-06 13:43:58 +000030#include <string.h>
31
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000033#include "mbedtls/rsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020034#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#if defined(MBEDTLS_ECP_C)
Gilles Peskine2700cfb2018-08-11 00:48:44 +020036#include "mbedtls/bignum.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ecp.h"
Gilles Peskine2700cfb2018-08-11 00:48:44 +020038#include "mbedtls/platform_util.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020039#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040#if defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/ecdsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020042#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_PEM_WRITE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000044#include "mbedtls/pem.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020045#endif
46
Andrzej Kurek5fec0862018-11-19 10:07:36 -050047#if defined(MBEDTLS_USE_PSA_CRYPTO)
48#include "psa/crypto.h"
Hanno Becker65935d92019-02-01 11:55:03 +000049#include "mbedtls/psa_util.h"
Andrzej Kurek5fec0862018-11-19 10:07:36 -050050#endif
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000051#include "mbedtls/platform.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020052
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050053/* Parameter validation macros based on platform_util.h */
54#define PK_VALIDATE_RET( cond ) \
55 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_PK_BAD_INPUT_DATA )
56#define PK_VALIDATE( cond ) \
57 MBEDTLS_INTERNAL_VALIDATE( cond )
58
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#if defined(MBEDTLS_RSA_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020060/*
61 * RSAPublicKey ::= SEQUENCE {
62 * modulus INTEGER, -- n
63 * publicExponent INTEGER -- e
64 * }
65 */
66static int pk_write_rsa_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +010067 mbedtls_rsa_context *rsa )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020068{
Janos Follath24eed8d2019-11-22 13:21:35 +000069 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020070 size_t len = 0;
Hanno Becker15f81fa2017-08-23 12:38:27 +010071 mbedtls_mpi T;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020072
Hanno Becker15f81fa2017-08-23 12:38:27 +010073 mbedtls_mpi_init( &T );
74
75 /* Export E */
76 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &T ) ) != 0 ||
77 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
78 goto end_of_export;
79 len += ret;
80
81 /* Export N */
82 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL, NULL, NULL, NULL ) ) != 0 ||
83 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
84 goto end_of_export;
85 len += ret;
86
87end_of_export:
88
89 mbedtls_mpi_free( &T );
90 if( ret < 0 )
91 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020092
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
94 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start, MBEDTLS_ASN1_CONSTRUCTED |
95 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020096
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020097 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020098}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099#endif /* MBEDTLS_RSA_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101#if defined(MBEDTLS_ECP_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200102/*
103 * EC public key is an EC point
104 */
105static int pk_write_ec_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100106 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200107{
Janos Follath24eed8d2019-11-22 13:21:35 +0000108 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200109 size_t len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200110 unsigned char buf[MBEDTLS_ECP_MAX_PT_LEN];
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 if( ( ret = mbedtls_ecp_point_write_binary( &ec->grp, &ec->Q,
113 MBEDTLS_ECP_PF_UNCOMPRESSED,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200114 &len, buf, sizeof( buf ) ) ) != 0 )
115 {
116 return( ret );
117 }
118
Manuel Pégourié-Gonnard4dc9b392015-10-21 12:23:09 +0200119 if( *p < start || (size_t)( *p - start ) < len )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200121
122 *p -= len;
123 memcpy( *p, buf, len );
124
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200125 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200126}
127
128/*
129 * ECParameters ::= CHOICE {
130 * namedCurve OBJECT IDENTIFIER
131 * }
132 */
133static int pk_write_ec_param( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100134 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200135{
Janos Follath24eed8d2019-11-22 13:21:35 +0000136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200137 size_t len = 0;
138 const char *oid;
139 size_t oid_len;
140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141 if( ( ret = mbedtls_oid_get_oid_by_ec_grp( ec->grp.id, &oid, &oid_len ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200142 return( ret );
143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200144 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_oid( p, start, oid, oid_len ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200145
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200146 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200147}
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200148
149/*
150 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
151 */
152static int pk_write_ec_private( unsigned char **p, unsigned char *start,
153 mbedtls_ecp_keypair *ec )
154{
Janos Follath24eed8d2019-11-22 13:21:35 +0000155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200156 size_t byte_length = ( ec->grp.pbits + 7 ) / 8;
157 unsigned char tmp[MBEDTLS_ECP_MAX_BYTES];
158
Steven Cooreman0024df62020-07-13 10:59:40 +0200159 ret = mbedtls_ecp_write_key( ec, tmp, byte_length );
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200160 if( ret != 0 )
161 goto exit;
162 ret = mbedtls_asn1_write_octet_string( p, start, tmp, byte_length );
163
164exit:
165 mbedtls_platform_zeroize( tmp, byte_length );
166 return( ret );
167}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168#endif /* MBEDTLS_ECP_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100171 const mbedtls_pk_context *key )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200172{
Janos Follath24eed8d2019-11-22 13:21:35 +0000173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200174 size_t len = 0;
175
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500176 PK_VALIDATE_RET( p != NULL );
177 PK_VALIDATE_RET( *p != NULL );
178 PK_VALIDATE_RET( start != NULL );
179 PK_VALIDATE_RET( key != NULL );
180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#if defined(MBEDTLS_RSA_C)
182 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
183 MBEDTLS_ASN1_CHK_ADD( len, pk_write_rsa_pubkey( p, start, mbedtls_pk_rsa( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200184 else
185#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_ECP_C)
187 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
188 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_pubkey( p, start, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200189 else
190#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500191#if defined(MBEDTLS_USE_PSA_CRYPTO)
192 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_OPAQUE )
193 {
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500194 size_t buffer_size;
Ronald Croncf56a0a2020-08-04 09:51:30 +0200195 psa_key_id_t* key_id = (psa_key_id_t*) key->pk_ctx;
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500196
197 if ( *p < start )
198 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
199
Andrzej Kurekb7f3ac62018-11-20 03:03:28 -0500200 buffer_size = (size_t)( *p - start );
Ronald Croncf56a0a2020-08-04 09:51:30 +0200201 if ( psa_export_public_key( *key_id, start, buffer_size, &len )
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500202 != PSA_SUCCESS )
203 {
Andrzej Kurek4b114072018-11-19 18:04:01 -0500204 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500205 }
206 else
207 {
Hanno Becker4fb8db22019-02-01 09:57:20 +0000208 *p -= len;
209 memmove( *p, start, len );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500210 }
211 }
212 else
213#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200215
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200216 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200217}
218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200220{
Janos Follath24eed8d2019-11-22 13:21:35 +0000221 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200222 unsigned char *c;
223 size_t len = 0, par_len = 0, oid_len;
Hanno Becker493c1712019-02-01 10:07:07 +0000224 mbedtls_pk_type_t pk_type;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200225 const char *oid;
226
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500227 PK_VALIDATE_RET( key != NULL );
228 if( size == 0 )
229 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
230 PK_VALIDATE_RET( buf != NULL );
231
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200232 c = buf + size;
233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200235
236 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200238
239 /*
240 * SubjectPublicKeyInfo ::= SEQUENCE {
241 * algorithm AlgorithmIdentifier,
242 * subjectPublicKey BIT STRING }
243 */
244 *--c = 0;
245 len += 1;
246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
248 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200249
Hanno Becker493c1712019-02-01 10:07:07 +0000250 pk_type = mbedtls_pk_get_type( key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251#if defined(MBEDTLS_ECP_C)
Hanno Becker493c1712019-02-01 10:07:07 +0000252 if( pk_type == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200253 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200255 }
256#endif
Hanno Becker493c1712019-02-01 10:07:07 +0000257#if defined(MBEDTLS_USE_PSA_CRYPTO)
258 if( pk_type == MBEDTLS_PK_OPAQUE )
259 {
Gilles Peskined2d45c12019-05-27 14:53:13 +0200260 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Hanno Becker493c1712019-02-01 10:07:07 +0000261 psa_key_type_t key_type;
Ronald Croncf56a0a2020-08-04 09:51:30 +0200262 psa_key_id_t key_id;
Paul Elliott8ff510a2020-06-02 17:19:28 +0100263 psa_ecc_family_t curve;
Gilles Peskine89177e82019-12-03 21:19:09 +0100264 size_t bits;
Hanno Becker493c1712019-02-01 10:07:07 +0000265
Ronald Croncf56a0a2020-08-04 09:51:30 +0200266 key_id = *((psa_key_id_t*) key->pk_ctx );
267 if( PSA_SUCCESS != psa_get_key_attributes( key_id, &attributes ) )
Hanno Becker493c1712019-02-01 10:07:07 +0000268 return( MBEDTLS_ERR_PK_HW_ACCEL_FAILED );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200269 key_type = psa_get_key_type( &attributes );
Gilles Peskine89177e82019-12-03 21:19:09 +0100270 bits = psa_get_key_bits( &attributes );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200271 psa_reset_key_attributes( &attributes );
Hanno Becker493c1712019-02-01 10:07:07 +0000272
Paul Elliott8ff510a2020-06-02 17:19:28 +0100273 curve = PSA_KEY_TYPE_ECC_GET_FAMILY( key_type );
Hanno Becker493c1712019-02-01 10:07:07 +0000274 if( curve == 0 )
275 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
276
Gilles Peskine89177e82019-12-03 21:19:09 +0100277 ret = mbedtls_psa_get_ecc_oid_from_id( curve, bits, &oid, &oid_len );
Hanno Becker493c1712019-02-01 10:07:07 +0000278 if( ret != 0 )
279 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
280
281 /* Write EC algorithm parameters; that's akin
282 * to pk_write_ec_param() above. */
283 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_oid( &c, buf,
284 oid, oid_len ) );
285
286 /* The rest of the function works as for legacy EC contexts. */
287 pk_type = MBEDTLS_PK_ECKEY;
288 }
289#endif /* MBEDTLS_USE_PSA_CRYPTO */
290
291 if( ( ret = mbedtls_oid_get_oid_by_pk_alg( pk_type, &oid,
292 &oid_len ) ) != 0 )
293 {
294 return( ret );
295 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200296
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_algorithm_identifier( &c, buf, oid, oid_len,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200298 par_len ) );
299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
301 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
302 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200303
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200304 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200305}
306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307int mbedtls_pk_write_key_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200308{
Janos Follath24eed8d2019-11-22 13:21:35 +0000309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500310 unsigned char *c;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200311 size_t len = 0;
312
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500313 PK_VALIDATE_RET( key != NULL );
314 if( size == 0 )
315 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
316 PK_VALIDATE_RET( buf != NULL );
317
318 c = buf + size;
319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320#if defined(MBEDTLS_RSA_C)
321 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200322 {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100323 mbedtls_mpi T; /* Temporary holding the exported parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324 mbedtls_rsa_context *rsa = mbedtls_pk_rsa( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200325
Hanno Becker15f81fa2017-08-23 12:38:27 +0100326 /*
327 * Export the parameters one after another to avoid simultaneous copies.
328 */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200329
Hanno Becker15f81fa2017-08-23 12:38:27 +0100330 mbedtls_mpi_init( &T );
331
332 /* Export QP */
333 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, NULL, &T ) ) != 0 ||
334 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
335 goto end_of_export;
336 len += ret;
337
338 /* Export DQ */
339 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, &T, NULL ) ) != 0 ||
340 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
341 goto end_of_export;
342 len += ret;
343
344 /* Export DP */
345 if( ( ret = mbedtls_rsa_export_crt( rsa, &T, NULL, NULL ) ) != 0 ||
346 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
347 goto end_of_export;
348 len += ret;
349
350 /* Export Q */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100351 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
352 &T, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100353 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
354 goto end_of_export;
355 len += ret;
356
357 /* Export P */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100358 if ( ( ret = mbedtls_rsa_export( rsa, NULL, &T,
359 NULL, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100360 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
361 goto end_of_export;
362 len += ret;
363
364 /* Export D */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100365 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
366 NULL, &T, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100367 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
368 goto end_of_export;
369 len += ret;
370
371 /* Export E */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100372 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
373 NULL, NULL, &T ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100374 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
375 goto end_of_export;
376 len += ret;
377
378 /* Export N */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100379 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL,
380 NULL, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100381 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
382 goto end_of_export;
383 len += ret;
384
385 end_of_export:
386
387 mbedtls_mpi_free( &T );
388 if( ret < 0 )
389 return( ret );
390
391 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 0 ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
Hanno Beckerd71dc152017-08-23 06:32:42 +0100393 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c,
394 buf, MBEDTLS_ASN1_CONSTRUCTED |
395 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200396 }
397 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200398#endif /* MBEDTLS_RSA_C */
399#if defined(MBEDTLS_ECP_C)
400 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200401 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402 mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200403 size_t pub_len = 0, par_len = 0;
404
405 /*
406 * RFC 5915, or SEC1 Appendix C.4
407 *
408 * ECPrivateKey ::= SEQUENCE {
409 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
410 * privateKey OCTET STRING,
411 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
412 * publicKey [1] BIT STRING OPTIONAL
413 * }
414 */
415
416 /* publicKey */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417 MBEDTLS_ASN1_CHK_ADD( pub_len, pk_write_ec_pubkey( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200418
419 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200421 *--c = 0;
422 pub_len += 1;
423
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200424 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
425 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200426
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
428 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf,
429 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200430 len += pub_len;
431
432 /* parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200435 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_len( &c, buf, par_len ) );
436 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_tag( &c, buf,
437 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 0 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200438 len += par_len;
439
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200440 /* privateKey */
441 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_private( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200442
443 /* version */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200444 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200445
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
447 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
448 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200449 }
450 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451#endif /* MBEDTLS_ECP_C */
452 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200453
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200454 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200455}
456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200458
459#define PEM_BEGIN_PUBLIC_KEY "-----BEGIN PUBLIC KEY-----\n"
460#define PEM_END_PUBLIC_KEY "-----END PUBLIC KEY-----\n"
461
462#define PEM_BEGIN_PRIVATE_KEY_RSA "-----BEGIN RSA PRIVATE KEY-----\n"
463#define PEM_END_PRIVATE_KEY_RSA "-----END RSA PRIVATE KEY-----\n"
464#define PEM_BEGIN_PRIVATE_KEY_EC "-----BEGIN EC PRIVATE KEY-----\n"
465#define PEM_END_PRIVATE_KEY_EC "-----END EC PRIVATE KEY-----\n"
466
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200467/*
468 * Max sizes of key per types. Shown as tag + len (+ content).
469 */
470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200472/*
473 * RSA public keys:
474 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 3
475 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
476 * + 1 + 1 + 9 (rsa oid)
477 * + 1 + 1 (params null)
478 * subjectPublicKey BIT STRING } 1 + 3 + (1 + below)
479 * RSAPublicKey ::= SEQUENCE { 1 + 3
480 * modulus INTEGER, -- n 1 + 3 + MPI_MAX + 1
481 * publicExponent INTEGER -- e 1 + 3 + MPI_MAX + 1
482 * }
483 */
Daniel Otte79fb5da2021-02-01 14:26:08 +0100484#define RSA_PUB_DER_MAX_BYTES ( 38 + 2 * MBEDTLS_MPI_MAX_SIZE )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200485
486/*
487 * RSA private keys:
488 * RSAPrivateKey ::= SEQUENCE { 1 + 3
489 * version Version, 1 + 1 + 1
490 * modulus INTEGER, 1 + 3 + MPI_MAX + 1
491 * publicExponent INTEGER, 1 + 3 + MPI_MAX + 1
492 * privateExponent INTEGER, 1 + 3 + MPI_MAX + 1
493 * prime1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
494 * prime2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
495 * exponent1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
496 * exponent2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
497 * coefficient INTEGER, 1 + 3 + MPI_MAX / 2 + 1
498 * otherPrimeInfos OtherPrimeInfos OPTIONAL 0 (not supported)
499 * }
500 */
Daniel Otte39f36142021-02-01 14:23:30 +0100501#define MPI_MAX_SIZE_2 ( MBEDTLS_MPI_MAX_SIZE / 2 + \
502 MBEDTLS_MPI_MAX_SIZE % 2 )
Daniel Otte79fb5da2021-02-01 14:26:08 +0100503#define RSA_PRV_DER_MAX_BYTES ( 47 + 3 * MBEDTLS_MPI_MAX_SIZE \
504 + 5 * MPI_MAX_SIZE_2 )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506#else /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200507
508#define RSA_PUB_DER_MAX_BYTES 0
509#define RSA_PRV_DER_MAX_BYTES 0
510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200511#endif /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200512
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200514/*
515 * EC public keys:
516 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 2
517 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
518 * + 1 + 1 + 7 (ec oid)
519 * + 1 + 1 + 9 (namedCurve oid)
520 * subjectPublicKey BIT STRING 1 + 2 + 1 [1]
521 * + 1 (point format) [1]
522 * + 2 * ECP_MAX (coords) [1]
523 * }
524 */
Daniel Otte79fb5da2021-02-01 14:26:08 +0100525#define ECP_PUB_DER_MAX_BYTES ( 30 + 2 * MBEDTLS_ECP_MAX_BYTES )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200526
527/*
528 * EC private keys:
529 * ECPrivateKey ::= SEQUENCE { 1 + 2
530 * version INTEGER , 1 + 1 + 1
531 * privateKey OCTET STRING, 1 + 1 + ECP_MAX
532 * parameters [0] ECParameters OPTIONAL, 1 + 1 + (1 + 1 + 9)
533 * publicKey [1] BIT STRING OPTIONAL 1 + 2 + [1] above
534 * }
535 */
Daniel Otte79fb5da2021-02-01 14:26:08 +0100536#define ECP_PRV_DER_MAX_BYTES ( 29 + 3 * MBEDTLS_ECP_MAX_BYTES )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538#else /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200539
540#define ECP_PUB_DER_MAX_BYTES 0
541#define ECP_PRV_DER_MAX_BYTES 0
542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200544
Daniel Otte79fb5da2021-02-01 14:26:08 +0100545#define PUB_DER_MAX_BYTES ( RSA_PUB_DER_MAX_BYTES > ECP_PUB_DER_MAX_BYTES ? \
546 RSA_PUB_DER_MAX_BYTES : ECP_PUB_DER_MAX_BYTES )
547#define PRV_DER_MAX_BYTES ( RSA_PRV_DER_MAX_BYTES > ECP_PRV_DER_MAX_BYTES ? \
548 RSA_PRV_DER_MAX_BYTES : ECP_PRV_DER_MAX_BYTES )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200551{
Janos Follath24eed8d2019-11-22 13:21:35 +0000552 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200553 unsigned char output_buf[PUB_DER_MAX_BYTES];
Paul Bakker77e23fb2013-09-15 20:03:26 +0200554 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200555
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500556 PK_VALIDATE_RET( key != NULL );
557 PK_VALIDATE_RET( buf != NULL || size == 0 );
558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 if( ( ret = mbedtls_pk_write_pubkey_der( key, output_buf,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200560 sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200561 {
562 return( ret );
563 }
564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 if( ( ret = mbedtls_pem_write_buffer( PEM_BEGIN_PUBLIC_KEY, PEM_END_PUBLIC_KEY,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200566 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200567 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200568 {
569 return( ret );
570 }
571
572 return( 0 );
573}
574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575int mbedtls_pk_write_key_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200576{
Janos Follath24eed8d2019-11-22 13:21:35 +0000577 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200578 unsigned char output_buf[PRV_DER_MAX_BYTES];
Paul Bakkerfcc17212013-10-11 09:36:52 +0200579 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200580 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200581
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500582 PK_VALIDATE_RET( key != NULL );
583 PK_VALIDATE_RET( buf != NULL || size == 0 );
584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585 if( ( ret = mbedtls_pk_write_key_der( key, output_buf, sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200586 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588#if defined(MBEDTLS_RSA_C)
589 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200590 {
591 begin = PEM_BEGIN_PRIVATE_KEY_RSA;
592 end = PEM_END_PRIVATE_KEY_RSA;
593 }
594 else
595#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596#if defined(MBEDTLS_ECP_C)
597 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200598 {
599 begin = PEM_BEGIN_PRIVATE_KEY_EC;
600 end = PEM_END_PRIVATE_KEY_EC;
601 }
602 else
603#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606 if( ( ret = mbedtls_pem_write_buffer( begin, end,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200607 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200608 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200609 {
610 return( ret );
611 }
612
613 return( 0 );
614}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617#endif /* MBEDTLS_PK_WRITE_C */