blob: 67a0c897d55b18382a601061b282cfcfa22fed3a [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
Neil Armstronge0326a62022-02-25 08:57:19 +010040#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECP_C)
41#include "pkwrite.h"
42#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000044#include "mbedtls/ecdsa.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020045#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020046#if defined(MBEDTLS_PEM_WRITE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000047#include "mbedtls/pem.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020048#endif
49
Andrzej Kurek5fec0862018-11-19 10:07:36 -050050#if defined(MBEDTLS_USE_PSA_CRYPTO)
51#include "psa/crypto.h"
Hanno Becker65935d92019-02-01 11:55:03 +000052#include "mbedtls/psa_util.h"
Andrzej Kurek5fec0862018-11-19 10:07:36 -050053#endif
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/platform.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020056#if defined(MBEDTLS_RSA_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020057/*
58 * RSAPublicKey ::= SEQUENCE {
59 * modulus INTEGER, -- n
60 * publicExponent INTEGER -- e
61 * }
62 */
Gilles Peskine449bd832023-01-11 14:50:10 +010063static int pk_write_rsa_pubkey(unsigned char **p, unsigned char *start,
64 mbedtls_rsa_context *rsa)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020065{
Janos Follath24eed8d2019-11-22 13:21:35 +000066 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020067 size_t len = 0;
Hanno Becker15f81fa2017-08-23 12:38:27 +010068 mbedtls_mpi T;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020069
Gilles Peskine449bd832023-01-11 14:50:10 +010070 mbedtls_mpi_init(&T);
Hanno Becker15f81fa2017-08-23 12:38:27 +010071
72 /* Export E */
Gilles Peskine449bd832023-01-11 14:50:10 +010073 if ((ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &T)) != 0 ||
74 (ret = mbedtls_asn1_write_mpi(p, start, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +010075 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +010076 }
Hanno Becker15f81fa2017-08-23 12:38:27 +010077 len += ret;
78
79 /* Export N */
Gilles Peskine449bd832023-01-11 14:50:10 +010080 if ((ret = mbedtls_rsa_export(rsa, &T, NULL, NULL, NULL, NULL)) != 0 ||
81 (ret = mbedtls_asn1_write_mpi(p, start, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +010082 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +010083 }
Hanno Becker15f81fa2017-08-23 12:38:27 +010084 len += ret;
85
86end_of_export:
87
Gilles Peskine449bd832023-01-11 14:50:10 +010088 mbedtls_mpi_free(&T);
89 if (ret < 0) {
90 return ret;
91 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020092
Gilles Peskine449bd832023-01-11 14:50:10 +010093 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
Gilles Peskine449bd832023-01-11 14:50:10 +010097 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
Valerio Setti0d2980f2023-04-05 18:17:13 +0200101#if defined(MBEDTLS_ECP_LIGHT)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200102/*
103 * EC public key is an EC point
104 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100105static int pk_write_ec_pubkey(unsigned char **p, unsigned char *start,
106 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
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 if ((ret = mbedtls_ecp_point_write_binary(&ec->grp, &ec->Q,
113 MBEDTLS_ECP_PF_UNCOMPRESSED,
114 &len, buf, sizeof(buf))) != 0) {
115 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200116 }
117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (*p < start || (size_t) (*p - start) < len) {
119 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
120 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200121
122 *p -= len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 memcpy(*p, buf, len);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200126}
127
128/*
129 * ECParameters ::= CHOICE {
130 * namedCurve OBJECT IDENTIFIER
131 * }
132 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100133static int pk_write_ec_param(unsigned char **p, unsigned char *start,
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200134 mbedtls_ecp_group_id grp_id)
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
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200141 if ((ret = mbedtls_oid_get_oid_by_ec_grp(grp_id, &oid, &oid_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 return ret;
143 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_oid(p, start, oid, oid_len));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200148}
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200149
150/*
151 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
152 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100153static int pk_write_ec_private(unsigned char **p, unsigned char *start,
154 mbedtls_ecp_keypair *ec)
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200155{
Janos Follath24eed8d2019-11-22 13:21:35 +0000156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100157 size_t byte_length = (ec->grp.pbits + 7) / 8;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200158 unsigned char tmp[MBEDTLS_ECP_MAX_BYTES];
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 ret = mbedtls_ecp_write_key(ec, tmp, byte_length);
161 if (ret != 0) {
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100163 }
164 ret = mbedtls_asn1_write_octet_string(p, start, tmp, byte_length);
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200165
166exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100167 mbedtls_platform_zeroize(tmp, byte_length);
168 return ret;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200169}
Valerio Setti0d2980f2023-04-05 18:17:13 +0200170#endif /* MBEDTLS_ECP_LIGHT */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200171
Gilles Peskine449bd832023-01-11 14:50:10 +0100172int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
173 const mbedtls_pk_context *key)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200174{
Janos Follath24eed8d2019-11-22 13:21:35 +0000175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200176 size_t len = 0;
177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_RSA) {
180 MBEDTLS_ASN1_CHK_ADD(len, pk_write_rsa_pubkey(p, start, mbedtls_pk_rsa(*key)));
181 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200182#endif
Valerio Setti0d2980f2023-04-05 18:17:13 +0200183#if defined(MBEDTLS_ECP_LIGHT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_ECKEY) {
185 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_pubkey(p, start, mbedtls_pk_ec(*key)));
186 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200187#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500188#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_OPAQUE) {
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500190 size_t buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 mbedtls_svc_key_id_t *key_id = (mbedtls_svc_key_id_t *) key->pk_ctx;
Andrzej Kurek158c3d12018-11-19 18:09:59 -0500192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 if (*p < start) {
194 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500195 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100196
197 buffer_size = (size_t) (*p - start);
198 if (psa_export_public_key(*key_id, start, buffer_size, &len)
199 != PSA_SUCCESS) {
200 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
201 } else {
Hanno Becker4fb8db22019-02-01 09:57:20 +0000202 *p -= len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 memmove(*p, start, len);
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500204 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 } else
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500206#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200208
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200210}
211
Gilles Peskine449bd832023-01-11 14:50:10 +0100212int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200213{
Janos Follath24eed8d2019-11-22 13:21:35 +0000214 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200215 unsigned char *c;
Jethro Beekman01672442023-04-19 14:08:14 +0200216 int has_par = 1;
217 size_t len = 0, par_len = 0, oid_len = 0;
Hanno Becker493c1712019-02-01 10:07:07 +0000218 mbedtls_pk_type_t pk_type;
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200219 mbedtls_ecp_group_id ec_grp_id;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200220 const char *oid;
221
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 if (size == 0) {
223 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
224 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500225
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200226 c = buf + size;
227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_pk_write_pubkey(&c, buf, key));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200229
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 if (c - buf < 1) {
231 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
232 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200233
234 /*
235 * SubjectPublicKeyInfo ::= SEQUENCE {
236 * algorithm AlgorithmIdentifier,
237 * subjectPublicKey BIT STRING }
238 */
239 *--c = 0;
240 len += 1;
241
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
243 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_BIT_STRING));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200244
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 pk_type = mbedtls_pk_get_type(key);
Valerio Setti0d2980f2023-04-05 18:17:13 +0200246#if defined(MBEDTLS_ECP_LIGHT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 if (pk_type == MBEDTLS_PK_ECKEY) {
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200248 ec_grp_id = mbedtls_pk_ec(*key)->grp.id;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200249 }
Valerio Setti0d2980f2023-04-05 18:17:13 +0200250#endif /* MBEDTLS_ECP_LIGHT */
Hanno Becker493c1712019-02-01 10:07:07 +0000251#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 if (pk_type == MBEDTLS_PK_OPAQUE) {
Gilles Peskined2d45c12019-05-27 14:53:13 +0200253 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Hanno Becker493c1712019-02-01 10:07:07 +0000254 psa_key_type_t key_type;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100255 mbedtls_svc_key_id_t key_id;
Paul Elliott8ff510a2020-06-02 17:19:28 +0100256 psa_ecc_family_t curve;
Gilles Peskine89177e82019-12-03 21:19:09 +0100257 size_t bits;
Hanno Becker493c1712019-02-01 10:07:07 +0000258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 key_id = *((mbedtls_svc_key_id_t *) key->pk_ctx);
260 if (PSA_SUCCESS != psa_get_key_attributes(key_id, &attributes)) {
261 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
262 }
263 key_type = psa_get_key_type(&attributes);
264 bits = psa_get_key_bits(&attributes);
265 psa_reset_key_attributes(&attributes);
Hanno Becker493c1712019-02-01 10:07:07 +0000266
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (PSA_KEY_TYPE_IS_ECC_KEY_PAIR(key_type)) {
268 curve = PSA_KEY_TYPE_ECC_GET_FAMILY(key_type);
269 if (curve == 0) {
270 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
271 }
Neil Armstrong295aeb12022-03-15 16:25:41 +0100272
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200273 ec_grp_id = mbedtls_ecc_group_of_psa(curve, bits, 0);
274 if (ec_grp_id == MBEDTLS_ECP_DP_NONE) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
276 }
Neil Armstrong295aeb12022-03-15 16:25:41 +0100277
Neil Armstrong295aeb12022-03-15 16:25:41 +0100278 /* The rest of the function works as for legacy EC contexts. */
279 pk_type = MBEDTLS_PK_ECKEY;
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 } else if (PSA_KEY_TYPE_IS_RSA(key_type)) {
Neil Armstrong295aeb12022-03-15 16:25:41 +0100281 /* The rest of the function works as for legacy RSA contexts. */
282 pk_type = MBEDTLS_PK_RSA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 } else {
284 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Neil Armstrong295aeb12022-03-15 16:25:41 +0100285 }
Hanno Becker493c1712019-02-01 10:07:07 +0000286 }
287#endif /* MBEDTLS_USE_PSA_CRYPTO */
288
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200289#if defined(MBEDTLS_ECP_LIGHT)
290 if (pk_type == MBEDTLS_PK_ECKEY) {
291 /* Some groups have their own AlgorithmIdentifier OID, others are handled by mbedtls_oid_get_oid_by_pk_alg() below */
292 ret = mbedtls_oid_get_oid_by_ec_grp_algid(ec_grp_id, &oid, &oid_len);
293
294 if (ret == 0) {
295 /* Currently, none of the supported algorithms that have their own AlgorithmIdentifier OID have any parameters */
296 has_par = 0;
297 } else if (ret == MBEDTLS_ERR_OID_NOT_FOUND) {
298 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(&c, buf, ec_grp_id));
299 } else {
300 return ret;
301 }
302 }
303#endif /* MBEDTLS_ECP_LIGHT */
304
Jethro Beekman01672442023-04-19 14:08:14 +0200305 if (oid_len == 0) {
306 if ((ret = mbedtls_oid_get_oid_by_pk_alg(pk_type, &oid,
307 &oid_len)) != 0) {
308 return ret;
309 }
Hanno Becker493c1712019-02-01 10:07:07 +0000310 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200311
Jethro Beekman01672442023-04-19 14:08:14 +0200312 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_algorithm_identifier_ext(&c, buf, oid, oid_len,
313 par_len, has_par));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200314
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
316 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_CONSTRUCTED |
317 MBEDTLS_ASN1_SEQUENCE));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200318
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200320}
321
Jethro Beekman01672442023-04-19 14:08:14 +0200322#if defined(MBEDTLS_ECP_LIGHT)
323#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
324/*
325 * RFC8410
326 *
327 * OneAsymmetricKey ::= SEQUENCE {
328 * version Version,
329 * privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
330 * privateKey PrivateKey,
331 * attributes [0] IMPLICIT Attributes OPTIONAL,
332 * ...,
333 * [[2: publicKey [1] IMPLICIT PublicKey OPTIONAL ]],
334 * ...
335 * }
336 *
337 * CurvePrivateKey ::= OCTET STRING
338 */
339static int pk_write_ec_rfc8410_der(unsigned char **p, unsigned char *buf,
340 mbedtls_ecp_keypair *ec)
341{
342 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
343 size_t len = 0;
344 size_t oid_len = 0;
345 const char *oid;
346
347 /* privateKey */
348 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_private(p, buf, ec));
349 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
350 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_OCTET_STRING));
351
352 /* privateKeyAlgorithm */
353 if ((ret = mbedtls_oid_get_oid_by_ec_grp_algid(ec->grp.id, &oid, &oid_len)) != 0) {
354 return ret;
355 }
356 MBEDTLS_ASN1_CHK_ADD(len,
357 mbedtls_asn1_write_algorithm_identifier_ext(p, buf, oid, oid_len, 0, 0));
358
359 /* version */
360 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(p, buf, 0));
361
362 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
363 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_CONSTRUCTED |
364 MBEDTLS_ASN1_SEQUENCE));
365
366 return (int) len;
367}
368#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
369#endif /* MBEDTLS_ECP_LIGHT */
370
Gilles Peskine449bd832023-01-11 14:50:10 +0100371int mbedtls_pk_write_key_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200372{
Janos Follath24eed8d2019-11-22 13:21:35 +0000373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500374 unsigned char *c;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200375 size_t len = 0;
376
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 if (size == 0) {
378 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
379 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500380
381 c = buf + size;
382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_RSA) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100385 mbedtls_mpi T; /* Temporary holding the exported parameters */
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 mbedtls_rsa_context *rsa = mbedtls_pk_rsa(*key);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200387
Hanno Becker15f81fa2017-08-23 12:38:27 +0100388 /*
389 * Export the parameters one after another to avoid simultaneous copies.
390 */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200391
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 mbedtls_mpi_init(&T);
Hanno Becker15f81fa2017-08-23 12:38:27 +0100393
394 /* Export QP */
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 if ((ret = mbedtls_rsa_export_crt(rsa, NULL, NULL, &T)) != 0 ||
396 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100397 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100399 len += ret;
400
401 /* Export DQ */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 if ((ret = mbedtls_rsa_export_crt(rsa, NULL, &T, NULL)) != 0 ||
403 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100404 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100406 len += ret;
407
408 /* Export DP */
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 if ((ret = mbedtls_rsa_export_crt(rsa, &T, NULL, NULL)) != 0 ||
410 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100411 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100413 len += ret;
414
415 /* Export Q */
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 if ((ret = mbedtls_rsa_export(rsa, NULL, NULL,
417 &T, NULL, NULL)) != 0 ||
418 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100419 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100421 len += ret;
422
423 /* Export P */
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 if ((ret = mbedtls_rsa_export(rsa, NULL, &T,
425 NULL, NULL, NULL)) != 0 ||
426 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100427 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100429 len += ret;
430
431 /* Export D */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 if ((ret = mbedtls_rsa_export(rsa, NULL, NULL,
433 NULL, &T, NULL)) != 0 ||
434 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100435 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100437 len += ret;
438
439 /* Export E */
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 if ((ret = mbedtls_rsa_export(rsa, NULL, NULL,
441 NULL, NULL, &T)) != 0 ||
442 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100443 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100445 len += ret;
446
447 /* Export N */
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 if ((ret = mbedtls_rsa_export(rsa, &T, NULL,
449 NULL, NULL, NULL)) != 0 ||
450 (ret = mbedtls_asn1_write_mpi(&c, buf, &T)) < 0) {
Hanno Becker15f81fa2017-08-23 12:38:27 +0100451 goto end_of_export;
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100453 len += ret;
454
Gilles Peskine449bd832023-01-11 14:50:10 +0100455end_of_export:
Hanno Becker15f81fa2017-08-23 12:38:27 +0100456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 mbedtls_mpi_free(&T);
458 if (ret < 0) {
459 return ret;
460 }
Hanno Becker15f81fa2017-08-23 12:38:27 +0100461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(&c, buf, 0));
463 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
464 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c,
465 buf, MBEDTLS_ASN1_CONSTRUCTED |
466 MBEDTLS_ASN1_SEQUENCE));
467 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200468#endif /* MBEDTLS_RSA_C */
Valerio Setti0d2980f2023-04-05 18:17:13 +0200469#if defined(MBEDTLS_ECP_LIGHT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_ECKEY) {
471 mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*key);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200472 size_t pub_len = 0, par_len = 0;
473
Jethro Beekman01672442023-04-19 14:08:14 +0200474#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
475 if (mbedtls_pk_is_rfc8410_curve(ec->grp.id)) {
476 return pk_write_ec_rfc8410_der(&c, buf, ec);
477 }
478#endif
479
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200480 /*
481 * RFC 5915, or SEC1 Appendix C.4
482 *
483 * ECPrivateKey ::= SEQUENCE {
484 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
485 * privateKey OCTET STRING,
486 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
487 * publicKey [1] BIT STRING OPTIONAL
488 * }
489 */
490
491 /* publicKey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 MBEDTLS_ASN1_CHK_ADD(pub_len, pk_write_ec_pubkey(&c, buf, ec));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200493
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 if (c - buf < 1) {
495 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
496 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200497 *--c = 0;
498 pub_len += 1;
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_len(&c, buf, pub_len));
501 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_BIT_STRING));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_len(&c, buf, pub_len));
504 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_tag(&c, buf,
505 MBEDTLS_ASN1_CONTEXT_SPECIFIC |
506 MBEDTLS_ASN1_CONSTRUCTED | 1));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200507 len += pub_len;
508
509 /* parameters */
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200510 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(&c, buf, ec->grp.id));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 MBEDTLS_ASN1_CHK_ADD(par_len, mbedtls_asn1_write_len(&c, buf, par_len));
513 MBEDTLS_ASN1_CHK_ADD(par_len, mbedtls_asn1_write_tag(&c, buf,
514 MBEDTLS_ASN1_CONTEXT_SPECIFIC |
515 MBEDTLS_ASN1_CONSTRUCTED | 0));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200516 len += par_len;
517
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200518 /* privateKey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_private(&c, buf, ec));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200520
521 /* version */
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(&c, buf, 1));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
525 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_CONSTRUCTED |
526 MBEDTLS_ASN1_SEQUENCE));
527 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528#endif /* MBEDTLS_ECP_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200530
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200532}
533
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200535
536#define PEM_BEGIN_PUBLIC_KEY "-----BEGIN PUBLIC KEY-----\n"
537#define PEM_END_PUBLIC_KEY "-----END PUBLIC KEY-----\n"
538
539#define PEM_BEGIN_PRIVATE_KEY_RSA "-----BEGIN RSA PRIVATE KEY-----\n"
540#define PEM_END_PRIVATE_KEY_RSA "-----END RSA PRIVATE KEY-----\n"
541#define PEM_BEGIN_PRIVATE_KEY_EC "-----BEGIN EC PRIVATE KEY-----\n"
542#define PEM_END_PRIVATE_KEY_EC "-----END EC PRIVATE KEY-----\n"
Jethro Beekman01672442023-04-19 14:08:14 +0200543#define PEM_BEGIN_PRIVATE_KEY_PKCS8 "-----BEGIN PRIVATE KEY-----\n"
544#define PEM_END_PRIVATE_KEY_PKCS8 "-----END PRIVATE KEY-----\n"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200545
Neil Armstronge9ecd272022-03-01 10:03:21 +0100546#define PUB_DER_MAX_BYTES \
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 (MBEDTLS_PK_RSA_PUB_DER_MAX_BYTES > MBEDTLS_PK_ECP_PUB_DER_MAX_BYTES ? \
548 MBEDTLS_PK_RSA_PUB_DER_MAX_BYTES : MBEDTLS_PK_ECP_PUB_DER_MAX_BYTES)
Neil Armstronge9ecd272022-03-01 10:03:21 +0100549#define PRV_DER_MAX_BYTES \
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 (MBEDTLS_PK_RSA_PRV_DER_MAX_BYTES > MBEDTLS_PK_ECP_PRV_DER_MAX_BYTES ? \
551 MBEDTLS_PK_RSA_PRV_DER_MAX_BYTES : MBEDTLS_PK_ECP_PRV_DER_MAX_BYTES)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200552
Gilles Peskine449bd832023-01-11 14:50:10 +0100553int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200554{
Janos Follath24eed8d2019-11-22 13:21:35 +0000555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200556 unsigned char output_buf[PUB_DER_MAX_BYTES];
Paul Bakker77e23fb2013-09-15 20:03:26 +0200557 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200558
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 if ((ret = mbedtls_pk_write_pubkey_der(key, output_buf,
560 sizeof(output_buf))) < 0) {
561 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200562 }
563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 if ((ret = mbedtls_pem_write_buffer(PEM_BEGIN_PUBLIC_KEY, PEM_END_PUBLIC_KEY,
565 output_buf + sizeof(output_buf) - ret,
566 ret, buf, size, &olen)) != 0) {
567 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200568 }
569
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200571}
572
Gilles Peskine449bd832023-01-11 14:50:10 +0100573int mbedtls_pk_write_key_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200574{
Janos Follath24eed8d2019-11-22 13:21:35 +0000575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200576 unsigned char output_buf[PRV_DER_MAX_BYTES];
Paul Bakkerfcc17212013-10-11 09:36:52 +0200577 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200578 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 if ((ret = mbedtls_pk_write_key_der(key, output_buf, sizeof(output_buf))) < 0) {
581 return ret;
582 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_RSA) {
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200586 begin = PEM_BEGIN_PRIVATE_KEY_RSA;
587 end = PEM_END_PRIVATE_KEY_RSA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200589#endif
Valerio Setti6c496a12023-04-07 15:53:51 +0200590#if defined(MBEDTLS_ECP_LIGHT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_ECKEY) {
Jethro Beekman01672442023-04-19 14:08:14 +0200592#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
593 if (mbedtls_pk_is_rfc8410_curve(mbedtls_pk_ec(*key)->grp.id)) {
594 begin = PEM_BEGIN_PRIVATE_KEY_PKCS8;
595 end = PEM_END_PRIVATE_KEY_PKCS8;
596 } else
597#endif
598 {
599 begin = PEM_BEGIN_PRIVATE_KEY_EC;
600 end = PEM_END_PRIVATE_KEY_EC;
601 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200603#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200605
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 if ((ret = mbedtls_pem_write_buffer(begin, end,
607 output_buf + sizeof(output_buf) - ret,
608 ret, buf, size, &olen)) != 0) {
609 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200610 }
611
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 return 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200613}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200615
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616#endif /* MBEDTLS_PK_WRITE_C */