blob: 566153dd9334c82bf085685a4e5bcd34af26719e [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é-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000052#include "mbedtls/platform.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020053#else
54#include <stdlib.h>
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +020055#define mbedtls_calloc calloc
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020056#define mbedtls_free free
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020057#endif
58
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050059/* Parameter validation macros based on platform_util.h */
60#define PK_VALIDATE_RET( cond ) \
61 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_PK_BAD_INPUT_DATA )
62#define PK_VALIDATE( cond ) \
63 MBEDTLS_INTERNAL_VALIDATE( cond )
64
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#if defined(MBEDTLS_RSA_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020066/*
67 * RSAPublicKey ::= SEQUENCE {
68 * modulus INTEGER, -- n
69 * publicExponent INTEGER -- e
70 * }
71 */
72static int pk_write_rsa_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +010073 mbedtls_rsa_context *rsa )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020074{
Janos Follath24eed8d2019-11-22 13:21:35 +000075 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020076 size_t len = 0;
Hanno Becker15f81fa2017-08-23 12:38:27 +010077 mbedtls_mpi T;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020078
Hanno Becker15f81fa2017-08-23 12:38:27 +010079 mbedtls_mpi_init( &T );
80
81 /* Export E */
82 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &T ) ) != 0 ||
83 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
84 goto end_of_export;
85 len += ret;
86
87 /* Export N */
88 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL, NULL, NULL, NULL ) ) != 0 ||
89 ( ret = mbedtls_asn1_write_mpi( p, start, &T ) ) < 0 )
90 goto end_of_export;
91 len += ret;
92
93end_of_export:
94
95 mbedtls_mpi_free( &T );
96 if( ret < 0 )
97 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( p, start, len ) );
100 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( p, start, MBEDTLS_ASN1_CONSTRUCTED |
101 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200102
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200103 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200104}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105#endif /* MBEDTLS_RSA_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107#if defined(MBEDTLS_ECP_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200108/*
109 * EC public key is an EC point
110 */
111static int pk_write_ec_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100112 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200113{
Janos Follath24eed8d2019-11-22 13:21:35 +0000114 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200115 size_t len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116 unsigned char buf[MBEDTLS_ECP_MAX_PT_LEN];
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118 if( ( ret = mbedtls_ecp_point_write_binary( &ec->grp, &ec->Q,
119 MBEDTLS_ECP_PF_UNCOMPRESSED,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200120 &len, buf, sizeof( buf ) ) ) != 0 )
121 {
122 return( ret );
123 }
124
Manuel Pégourié-Gonnard4dc9b392015-10-21 12:23:09 +0200125 if( *p < start || (size_t)( *p - start ) < len )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200127
128 *p -= len;
129 memcpy( *p, buf, len );
130
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200131 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200132}
133
134/*
135 * ECParameters ::= CHOICE {
136 * namedCurve OBJECT IDENTIFIER
137 * }
138 */
139static int pk_write_ec_param( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100140 mbedtls_ecp_keypair *ec )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200141{
Janos Follath24eed8d2019-11-22 13:21:35 +0000142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200143 size_t len = 0;
144 const char *oid;
145 size_t oid_len;
146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147 if( ( ret = mbedtls_oid_get_oid_by_ec_grp( ec->grp.id, &oid, &oid_len ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200148 return( ret );
149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_oid( p, start, oid, oid_len ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200151
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200152 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200153}
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200154
155/*
156 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
157 */
158static int pk_write_ec_private( unsigned char **p, unsigned char *start,
159 mbedtls_ecp_keypair *ec )
160{
Janos Follath24eed8d2019-11-22 13:21:35 +0000161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200162 size_t byte_length = ( ec->grp.pbits + 7 ) / 8;
163 unsigned char tmp[MBEDTLS_ECP_MAX_BYTES];
164
Steven Cooreman0024df62020-07-13 10:59:40 +0200165 ret = mbedtls_ecp_write_key( ec, tmp, byte_length );
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200166 if( ret != 0 )
167 goto exit;
168 ret = mbedtls_asn1_write_octet_string( p, start, tmp, byte_length );
169
170exit:
171 mbedtls_platform_zeroize( tmp, byte_length );
172 return( ret );
173}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174#endif /* MBEDTLS_ECP_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176int mbedtls_pk_write_pubkey( unsigned char **p, unsigned char *start,
Hanno Becker8fd55482017-08-23 14:07:48 +0100177 const mbedtls_pk_context *key )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200178{
Janos Follath24eed8d2019-11-22 13:21:35 +0000179 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200180 size_t len = 0;
181
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500182 PK_VALIDATE_RET( p != NULL );
183 PK_VALIDATE_RET( *p != NULL );
184 PK_VALIDATE_RET( start != NULL );
185 PK_VALIDATE_RET( key != NULL );
186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187#if defined(MBEDTLS_RSA_C)
188 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
189 MBEDTLS_ASN1_CHK_ADD( len, pk_write_rsa_pubkey( p, start, mbedtls_pk_rsa( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200190 else
191#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192#if defined(MBEDTLS_ECP_C)
193 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
194 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_pubkey( p, start, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200195 else
196#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500197#if defined(MBEDTLS_USE_PSA_CRYPTO)
198 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_OPAQUE )
199 {
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500200 size_t buffer_size;
Ronald Croncf56a0a2020-08-04 09:51:30 +0200201 psa_key_id_t* key_id = (psa_key_id_t*) key->pk_ctx;
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500202
203 if ( *p < start )
204 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
205
Andrzej Kurekb7f3ac62018-11-20 03:03:28 -0500206 buffer_size = (size_t)( *p - start );
Ronald Croncf56a0a2020-08-04 09:51:30 +0200207 if ( psa_export_public_key( *key_id, start, buffer_size, &len )
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500208 != PSA_SUCCESS )
209 {
Andrzej Kurek4b114072018-11-19 18:04:01 -0500210 return( MBEDTLS_ERR_PK_BAD_INPUT_DATA );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500211 }
212 else
213 {
Hanno Becker4fb8db22019-02-01 09:57:20 +0000214 *p -= len;
215 memmove( *p, start, len );
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500216 }
217 }
218 else
219#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200221
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200222 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200223}
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225int mbedtls_pk_write_pubkey_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200226{
Janos Follath24eed8d2019-11-22 13:21:35 +0000227 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200228 unsigned char *c;
229 size_t len = 0, par_len = 0, oid_len;
Hanno Becker493c1712019-02-01 10:07:07 +0000230 mbedtls_pk_type_t pk_type;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200231 const char *oid;
232
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500233 PK_VALIDATE_RET( key != NULL );
234 if( size == 0 )
235 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
236 PK_VALIDATE_RET( buf != NULL );
237
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200238 c = buf + size;
239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_pk_write_pubkey( &c, buf, key ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200241
242 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200244
245 /*
246 * SubjectPublicKeyInfo ::= SEQUENCE {
247 * algorithm AlgorithmIdentifier,
248 * subjectPublicKey BIT STRING }
249 */
250 *--c = 0;
251 len += 1;
252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
254 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200255
Hanno Becker493c1712019-02-01 10:07:07 +0000256 pk_type = mbedtls_pk_get_type( key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257#if defined(MBEDTLS_ECP_C)
Hanno Becker493c1712019-02-01 10:07:07 +0000258 if( pk_type == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200259 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, mbedtls_pk_ec( *key ) ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200261 }
262#endif
Hanno Becker493c1712019-02-01 10:07:07 +0000263#if defined(MBEDTLS_USE_PSA_CRYPTO)
264 if( pk_type == MBEDTLS_PK_OPAQUE )
265 {
Gilles Peskined2d45c12019-05-27 14:53:13 +0200266 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Hanno Becker493c1712019-02-01 10:07:07 +0000267 psa_key_type_t key_type;
Ronald Croncf56a0a2020-08-04 09:51:30 +0200268 psa_key_id_t key_id;
Paul Elliott8ff510a2020-06-02 17:19:28 +0100269 psa_ecc_family_t curve;
Gilles Peskine89177e82019-12-03 21:19:09 +0100270 size_t bits;
Hanno Becker493c1712019-02-01 10:07:07 +0000271
Ronald Croncf56a0a2020-08-04 09:51:30 +0200272 key_id = *((psa_key_id_t*) key->pk_ctx );
273 if( PSA_SUCCESS != psa_get_key_attributes( key_id, &attributes ) )
Hanno Becker493c1712019-02-01 10:07:07 +0000274 return( MBEDTLS_ERR_PK_HW_ACCEL_FAILED );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200275 key_type = psa_get_key_type( &attributes );
Gilles Peskine89177e82019-12-03 21:19:09 +0100276 bits = psa_get_key_bits( &attributes );
Gilles Peskined2d45c12019-05-27 14:53:13 +0200277 psa_reset_key_attributes( &attributes );
Hanno Becker493c1712019-02-01 10:07:07 +0000278
Paul Elliott8ff510a2020-06-02 17:19:28 +0100279 curve = PSA_KEY_TYPE_ECC_GET_FAMILY( key_type );
Hanno Becker493c1712019-02-01 10:07:07 +0000280 if( curve == 0 )
281 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
282
Gilles Peskine89177e82019-12-03 21:19:09 +0100283 ret = mbedtls_psa_get_ecc_oid_from_id( curve, bits, &oid, &oid_len );
Hanno Becker493c1712019-02-01 10:07:07 +0000284 if( ret != 0 )
285 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
286
287 /* Write EC algorithm parameters; that's akin
288 * to pk_write_ec_param() above. */
289 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_oid( &c, buf,
290 oid, oid_len ) );
291
292 /* The rest of the function works as for legacy EC contexts. */
293 pk_type = MBEDTLS_PK_ECKEY;
294 }
295#endif /* MBEDTLS_USE_PSA_CRYPTO */
296
297 if( ( ret = mbedtls_oid_get_oid_by_pk_alg( pk_type, &oid,
298 &oid_len ) ) != 0 )
299 {
300 return( ret );
301 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_algorithm_identifier( &c, buf, oid, oid_len,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200304 par_len ) );
305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
307 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
308 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200309
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200310 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200311}
312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313int mbedtls_pk_write_key_der( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200314{
Janos Follath24eed8d2019-11-22 13:21:35 +0000315 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500316 unsigned char *c;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200317 size_t len = 0;
318
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500319 PK_VALIDATE_RET( key != NULL );
320 if( size == 0 )
321 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
322 PK_VALIDATE_RET( buf != NULL );
323
324 c = buf + size;
325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326#if defined(MBEDTLS_RSA_C)
327 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200328 {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100329 mbedtls_mpi T; /* Temporary holding the exported parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330 mbedtls_rsa_context *rsa = mbedtls_pk_rsa( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200331
Hanno Becker15f81fa2017-08-23 12:38:27 +0100332 /*
333 * Export the parameters one after another to avoid simultaneous copies.
334 */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200335
Hanno Becker15f81fa2017-08-23 12:38:27 +0100336 mbedtls_mpi_init( &T );
337
338 /* Export QP */
339 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, NULL, &T ) ) != 0 ||
340 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
341 goto end_of_export;
342 len += ret;
343
344 /* Export DQ */
345 if( ( ret = mbedtls_rsa_export_crt( rsa, NULL, &T, NULL ) ) != 0 ||
346 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
347 goto end_of_export;
348 len += ret;
349
350 /* Export DP */
351 if( ( ret = mbedtls_rsa_export_crt( rsa, &T, NULL, NULL ) ) != 0 ||
352 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
353 goto end_of_export;
354 len += ret;
355
356 /* Export Q */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100357 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
358 &T, NULL, NULL ) ) != 0 ||
Hanno Becker15f81fa2017-08-23 12:38:27 +0100359 ( ret = mbedtls_asn1_write_mpi( &c, buf, &T ) ) < 0 )
360 goto end_of_export;
361 len += ret;
362
363 /* Export P */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100364 if ( ( ret = mbedtls_rsa_export( rsa, NULL, &T,
365 NULL, 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 D */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100371 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
372 NULL, &T, 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 E */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100378 if ( ( ret = mbedtls_rsa_export( rsa, NULL, NULL,
379 NULL, NULL, &T ) ) != 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 N */
Hanno Beckerd71dc152017-08-23 06:32:42 +0100385 if ( ( ret = mbedtls_rsa_export( rsa, &T, NULL,
386 NULL, NULL, NULL ) ) != 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 end_of_export:
392
393 mbedtls_mpi_free( &T );
394 if( ret < 0 )
395 return( ret );
396
397 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 0 ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200398 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
Hanno Beckerd71dc152017-08-23 06:32:42 +0100399 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c,
400 buf, MBEDTLS_ASN1_CONSTRUCTED |
401 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200402 }
403 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#endif /* MBEDTLS_RSA_C */
405#if defined(MBEDTLS_ECP_C)
406 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200407 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408 mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *key );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200409 size_t pub_len = 0, par_len = 0;
410
411 /*
412 * RFC 5915, or SEC1 Appendix C.4
413 *
414 * ECPrivateKey ::= SEQUENCE {
415 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
416 * privateKey OCTET STRING,
417 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
418 * publicKey [1] BIT STRING OPTIONAL
419 * }
420 */
421
422 /* publicKey */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423 MBEDTLS_ASN1_CHK_ADD( pub_len, pk_write_ec_pubkey( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200424
425 if( c - buf < 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200426 return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200427 *--c = 0;
428 pub_len += 1;
429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
431 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_BIT_STRING ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_len( &c, buf, pub_len ) );
434 MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_asn1_write_tag( &c, buf,
435 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200436 len += pub_len;
437
438 /* parameters */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 MBEDTLS_ASN1_CHK_ADD( par_len, pk_write_ec_param( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_len( &c, buf, par_len ) );
442 MBEDTLS_ASN1_CHK_ADD( par_len, mbedtls_asn1_write_tag( &c, buf,
443 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED | 0 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200444 len += par_len;
445
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200446 /* privateKey */
447 MBEDTLS_ASN1_CHK_ADD( len, pk_write_ec_private( &c, buf, ec ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200448
449 /* version */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200450 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, buf, 1 ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, buf, len ) );
453 MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, buf, MBEDTLS_ASN1_CONSTRUCTED |
454 MBEDTLS_ASN1_SEQUENCE ) );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200455 }
456 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457#endif /* MBEDTLS_ECP_C */
458 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200459
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200460 return( (int) len );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200461}
462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200463#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200464
465#define PEM_BEGIN_PUBLIC_KEY "-----BEGIN PUBLIC KEY-----\n"
466#define PEM_END_PUBLIC_KEY "-----END PUBLIC KEY-----\n"
467
468#define PEM_BEGIN_PRIVATE_KEY_RSA "-----BEGIN RSA PRIVATE KEY-----\n"
469#define PEM_END_PRIVATE_KEY_RSA "-----END RSA PRIVATE KEY-----\n"
470#define PEM_BEGIN_PRIVATE_KEY_EC "-----BEGIN EC PRIVATE KEY-----\n"
471#define PEM_END_PRIVATE_KEY_EC "-----END EC PRIVATE KEY-----\n"
472
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200473/*
474 * Max sizes of key per types. Shown as tag + len (+ content).
475 */
476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200478/*
479 * RSA public keys:
480 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 3
481 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
482 * + 1 + 1 + 9 (rsa oid)
483 * + 1 + 1 (params null)
484 * subjectPublicKey BIT STRING } 1 + 3 + (1 + below)
485 * RSAPublicKey ::= SEQUENCE { 1 + 3
486 * modulus INTEGER, -- n 1 + 3 + MPI_MAX + 1
487 * publicExponent INTEGER -- e 1 + 3 + MPI_MAX + 1
488 * }
489 */
Daniel Otte79fb5da2021-02-01 14:26:08 +0100490#define RSA_PUB_DER_MAX_BYTES ( 38 + 2 * MBEDTLS_MPI_MAX_SIZE )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200491
492/*
493 * RSA private keys:
494 * RSAPrivateKey ::= SEQUENCE { 1 + 3
495 * version Version, 1 + 1 + 1
496 * modulus INTEGER, 1 + 3 + MPI_MAX + 1
497 * publicExponent INTEGER, 1 + 3 + MPI_MAX + 1
498 * privateExponent INTEGER, 1 + 3 + MPI_MAX + 1
499 * prime1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
500 * prime2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
501 * exponent1 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
502 * exponent2 INTEGER, 1 + 3 + MPI_MAX / 2 + 1
503 * coefficient INTEGER, 1 + 3 + MPI_MAX / 2 + 1
504 * otherPrimeInfos OtherPrimeInfos OPTIONAL 0 (not supported)
505 * }
506 */
Daniel Otte39f36142021-02-01 14:23:30 +0100507#define MPI_MAX_SIZE_2 ( MBEDTLS_MPI_MAX_SIZE / 2 + \
508 MBEDTLS_MPI_MAX_SIZE % 2 )
Daniel Otte79fb5da2021-02-01 14:26:08 +0100509#define RSA_PRV_DER_MAX_BYTES ( 47 + 3 * MBEDTLS_MPI_MAX_SIZE \
510 + 5 * MPI_MAX_SIZE_2 )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200512#else /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200513
514#define RSA_PUB_DER_MAX_BYTES 0
515#define RSA_PRV_DER_MAX_BYTES 0
516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200517#endif /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200520/*
521 * EC public keys:
522 * SubjectPublicKeyInfo ::= SEQUENCE { 1 + 2
523 * algorithm AlgorithmIdentifier, 1 + 1 (sequence)
524 * + 1 + 1 + 7 (ec oid)
525 * + 1 + 1 + 9 (namedCurve oid)
526 * subjectPublicKey BIT STRING 1 + 2 + 1 [1]
527 * + 1 (point format) [1]
528 * + 2 * ECP_MAX (coords) [1]
529 * }
530 */
Daniel Otte79fb5da2021-02-01 14:26:08 +0100531#define ECP_PUB_DER_MAX_BYTES ( 30 + 2 * MBEDTLS_ECP_MAX_BYTES )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200532
533/*
534 * EC private keys:
535 * ECPrivateKey ::= SEQUENCE { 1 + 2
536 * version INTEGER , 1 + 1 + 1
537 * privateKey OCTET STRING, 1 + 1 + ECP_MAX
538 * parameters [0] ECParameters OPTIONAL, 1 + 1 + (1 + 1 + 9)
539 * publicKey [1] BIT STRING OPTIONAL 1 + 2 + [1] above
540 * }
541 */
Daniel Otte79fb5da2021-02-01 14:26:08 +0100542#define ECP_PRV_DER_MAX_BYTES ( 29 + 3 * MBEDTLS_ECP_MAX_BYTES )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544#else /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200545
546#define ECP_PUB_DER_MAX_BYTES 0
547#define ECP_PRV_DER_MAX_BYTES 0
548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200550
Daniel Otte79fb5da2021-02-01 14:26:08 +0100551#define PUB_DER_MAX_BYTES ( RSA_PUB_DER_MAX_BYTES > ECP_PUB_DER_MAX_BYTES ? \
552 RSA_PUB_DER_MAX_BYTES : ECP_PUB_DER_MAX_BYTES )
553#define PRV_DER_MAX_BYTES ( RSA_PRV_DER_MAX_BYTES > ECP_PRV_DER_MAX_BYTES ? \
554 RSA_PRV_DER_MAX_BYTES : ECP_PRV_DER_MAX_BYTES )
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556int mbedtls_pk_write_pubkey_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200557{
Janos Follath24eed8d2019-11-22 13:21:35 +0000558 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200559 unsigned char output_buf[PUB_DER_MAX_BYTES];
Paul Bakker77e23fb2013-09-15 20:03:26 +0200560 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200561
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500562 PK_VALIDATE_RET( key != NULL );
563 PK_VALIDATE_RET( buf != NULL || size == 0 );
564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 if( ( ret = mbedtls_pk_write_pubkey_der( key, output_buf,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200566 sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200567 {
568 return( ret );
569 }
570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571 if( ( ret = mbedtls_pem_write_buffer( PEM_BEGIN_PUBLIC_KEY, PEM_END_PUBLIC_KEY,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200572 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200573 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200574 {
575 return( ret );
576 }
577
578 return( 0 );
579}
580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200581int mbedtls_pk_write_key_pem( mbedtls_pk_context *key, unsigned char *buf, size_t size )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200582{
Janos Follath24eed8d2019-11-22 13:21:35 +0000583 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200584 unsigned char output_buf[PRV_DER_MAX_BYTES];
Paul Bakkerfcc17212013-10-11 09:36:52 +0200585 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200586 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200587
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500588 PK_VALIDATE_RET( key != NULL );
589 PK_VALIDATE_RET( buf != NULL || size == 0 );
590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591 if( ( ret = mbedtls_pk_write_key_der( key, output_buf, sizeof(output_buf) ) ) < 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200592 return( ret );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#if defined(MBEDTLS_RSA_C)
595 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_RSA )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200596 {
597 begin = PEM_BEGIN_PRIVATE_KEY_RSA;
598 end = PEM_END_PRIVATE_KEY_RSA;
599 }
600 else
601#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602#if defined(MBEDTLS_ECP_C)
603 if( mbedtls_pk_get_type( key ) == MBEDTLS_PK_ECKEY )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200604 {
605 begin = PEM_BEGIN_PRIVATE_KEY_EC;
606 end = PEM_END_PRIVATE_KEY_EC;
607 }
608 else
609#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 return( MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE );
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 if( ( ret = mbedtls_pem_write_buffer( begin, end,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200613 output_buf + sizeof(output_buf) - ret,
Paul Bakker77e23fb2013-09-15 20:03:26 +0200614 ret, buf, size, &olen ) ) != 0 )
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200615 {
616 return( ret );
617 }
618
619 return( 0 );
620}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623#endif /* MBEDTLS_PK_WRITE_C */