blob: 2a698448bee647add928d6e7b85d738c3f48fcaf [file] [log] [blame]
Jens Wiklander817466c2018-05-22 13:49:31 +02001/*
2 * Public Key layer for writing key files and structures
3 *
Jerome Forissier79013242021-07-28 10:24:04 +02004 * Copyright The Mbed TLS Contributors
Tom Van Eyckb0563632024-06-13 16:20:14 +02005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jens Wiklander817466c2018-05-22 13:49:31 +02006 */
7
Jerome Forissier79013242021-07-28 10:24:04 +02008#include "common.h"
Jens Wiklander817466c2018-05-22 13:49:31 +02009
10#if defined(MBEDTLS_PK_WRITE_C)
11
12#include "mbedtls/pk.h"
13#include "mbedtls/asn1write.h"
14#include "mbedtls/oid.h"
Jens Wiklander3d3b0592019-03-20 15:30:29 +010015#include "mbedtls/platform_util.h"
Jerome Forissier11fa71b2020-04-20 17:17:56 +020016#include "mbedtls/error.h"
Tom Van Eyckb0563632024-06-13 16:20:14 +020017#include "pk_internal.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020018
19#include <string.h>
20
Jens Wiklander817466c2018-05-22 13:49:31 +020021#if defined(MBEDTLS_ECP_C)
Jerome Forissier5b25c762020-04-07 11:18:49 +020022#include "mbedtls/bignum.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020023#include "mbedtls/ecp.h"
Jerome Forissier5b25c762020-04-07 11:18:49 +020024#include "mbedtls/platform_util.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020025#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +020026#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
27#include "pk_internal.h"
Jens Wiklander32b31802023-10-06 16:59:46 +020028#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +020029#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_HAVE_ECC_KEYS)
30#include "pkwrite.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020031#endif
32#if defined(MBEDTLS_PEM_WRITE_C)
33#include "mbedtls/pem.h"
34#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +020035#if defined(MBEDTLS_RSA_C)
36#include "rsa_internal.h"
37#endif
Jens Wiklander817466c2018-05-22 13:49:31 +020038
Jerome Forissier11fa71b2020-04-20 17:17:56 +020039#if defined(MBEDTLS_USE_PSA_CRYPTO)
40#include "psa/crypto.h"
Tom Van Eyckb0563632024-06-13 16:20:14 +020041#include "psa_util_internal.h"
Jerome Forissier11fa71b2020-04-20 17:17:56 +020042#endif
Jens Wiklander817466c2018-05-22 13:49:31 +020043#include "mbedtls/platform.h"
Jens Wiklander3d3b0592019-03-20 15:30:29 +010044
Tom Van Eyckb0563632024-06-13 16:20:14 +020045/* Helpers for properly sizing buffers aimed at holding public keys or
46 * key-pairs based on build symbols. */
47#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
48#define PK_MAX_EC_PUBLIC_KEY_SIZE PSA_EXPORT_PUBLIC_KEY_MAX_SIZE
49#define PK_MAX_EC_KEY_PAIR_SIZE MBEDTLS_PSA_MAX_EC_KEY_PAIR_LENGTH
50#elif defined(MBEDTLS_USE_PSA_CRYPTO)
51#define PK_MAX_EC_PUBLIC_KEY_SIZE PSA_EXPORT_PUBLIC_KEY_MAX_SIZE
52#define PK_MAX_EC_KEY_PAIR_SIZE MBEDTLS_PSA_MAX_EC_KEY_PAIR_LENGTH
53#else
54#define PK_MAX_EC_PUBLIC_KEY_SIZE MBEDTLS_ECP_MAX_PT_LEN
55#define PK_MAX_EC_KEY_PAIR_SIZE MBEDTLS_ECP_MAX_BYTES
56#endif
57
58/******************************************************************************
59 * Internal functions for RSA keys.
60 ******************************************************************************/
Jens Wiklander817466c2018-05-22 13:49:31 +020061#if defined(MBEDTLS_RSA_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +020062static int pk_write_rsa_der(unsigned char **p, unsigned char *buf,
63 const mbedtls_pk_context *pk)
Jens Wiklander817466c2018-05-22 13:49:31 +020064{
Tom Van Eyckb0563632024-06-13 16:20:14 +020065#if defined(MBEDTLS_USE_PSA_CRYPTO)
66 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
67 uint8_t tmp[PSA_EXPORT_KEY_PAIR_MAX_SIZE];
Sungbae Yoo4d211f32024-11-19 02:47:55 +000068 size_t tmp_len = 0;
Jens Wiklander817466c2018-05-22 13:49:31 +020069
Tom Van Eyckb0563632024-06-13 16:20:14 +020070 if (psa_export_key(pk->priv_id, tmp, sizeof(tmp), &tmp_len) != PSA_SUCCESS) {
71 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
72 }
Sungbae Yoo4d211f32024-11-19 02:47:55 +000073 /* Ensure there's enough space in the provided buffer before copying data into it. */
74 if (tmp_len > (size_t) (*p - buf)) {
75 mbedtls_platform_zeroize(tmp, sizeof(tmp));
76 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
77 }
Tom Van Eyckb0563632024-06-13 16:20:14 +020078 *p -= tmp_len;
79 memcpy(*p, tmp, tmp_len);
Tom Van Eyckb0563632024-06-13 16:20:14 +020080 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jens Wiklander3d3b0592019-03-20 15:30:29 +010081
Sungbae Yoo4d211f32024-11-19 02:47:55 +000082 return (int) tmp_len;
Jens Wiklander32b31802023-10-06 16:59:46 +020083 }
Tom Van Eyckb0563632024-06-13 16:20:14 +020084#endif /* MBEDTLS_USE_PSA_CRYPTO */
85 return mbedtls_rsa_write_key(mbedtls_pk_rsa(*pk), buf, p);
Jens Wiklander817466c2018-05-22 13:49:31 +020086}
87#endif /* MBEDTLS_RSA_C */
88
Tom Van Eyckb0563632024-06-13 16:20:14 +020089/******************************************************************************
90 * Internal functions for EC keys.
91 ******************************************************************************/
92#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
93#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
Jens Wiklander32b31802023-10-06 16:59:46 +020094static int pk_write_ec_pubkey(unsigned char **p, unsigned char *start,
Tom Van Eyckb0563632024-06-13 16:20:14 +020095 const mbedtls_pk_context *pk)
Jens Wiklander817466c2018-05-22 13:49:31 +020096{
Jens Wiklander817466c2018-05-22 13:49:31 +020097 size_t len = 0;
Tom Van Eyckb0563632024-06-13 16:20:14 +020098 uint8_t buf[PK_MAX_EC_PUBLIC_KEY_SIZE];
Jens Wiklander817466c2018-05-22 13:49:31 +020099
Tom Van Eyckb0563632024-06-13 16:20:14 +0200100 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
101 if (psa_export_public_key(pk->priv_id, buf, sizeof(buf), &len) != PSA_SUCCESS) {
102 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
103 }
104 } else {
105 len = pk->pub_raw_len;
106 memcpy(buf, pk->pub_raw, len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200107 }
108
Jens Wiklander32b31802023-10-06 16:59:46 +0200109 if (*p < start || (size_t) (*p - start) < len) {
110 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
111 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200112
113 *p -= len;
Jens Wiklander32b31802023-10-06 16:59:46 +0200114 memcpy(*p, buf, len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200115
Jens Wiklander32b31802023-10-06 16:59:46 +0200116 return (int) len;
Jens Wiklander817466c2018-05-22 13:49:31 +0200117}
Tom Van Eyckb0563632024-06-13 16:20:14 +0200118#else /* MBEDTLS_PK_USE_PSA_EC_DATA */
119static int pk_write_ec_pubkey(unsigned char **p, unsigned char *start,
120 const mbedtls_pk_context *pk)
121{
122 size_t len = 0;
123 unsigned char buf[PK_MAX_EC_PUBLIC_KEY_SIZE];
124 mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*pk);
125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
126
127#if defined(MBEDTLS_USE_PSA_CRYPTO)
128 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
129 if (psa_export_public_key(pk->priv_id, buf, sizeof(buf), &len) != PSA_SUCCESS) {
130 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
131 }
Sungbae Yoo4d211f32024-11-19 02:47:55 +0000132 /* Ensure there's enough space in the provided buffer before copying data into it. */
133 if (len > (size_t) (*p - start)) {
134 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
135 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200136 *p -= len;
137 memcpy(*p, buf, len);
138 return (int) len;
139 } else
140#endif /* MBEDTLS_USE_PSA_CRYPTO */
141 {
142 if ((ret = mbedtls_ecp_point_write_binary(&ec->grp, &ec->Q,
143 MBEDTLS_ECP_PF_UNCOMPRESSED,
144 &len, buf, sizeof(buf))) != 0) {
145 return ret;
146 }
147 }
148
149 if (*p < start || (size_t) (*p - start) < len) {
150 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
151 }
152
153 *p -= len;
154 memcpy(*p, buf, len);
155
156 return (int) len;
157}
158#endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
159
160/*
161 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
162 */
163#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
164static int pk_write_ec_private(unsigned char **p, unsigned char *start,
165 const mbedtls_pk_context *pk)
166{
167 size_t byte_length;
168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
169 unsigned char tmp[PK_MAX_EC_KEY_PAIR_SIZE];
170 psa_status_t status;
171
172 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
173 status = psa_export_key(pk->priv_id, tmp, sizeof(tmp), &byte_length);
174 if (status != PSA_SUCCESS) {
175 ret = PSA_PK_ECDSA_TO_MBEDTLS_ERR(status);
176 return ret;
177 }
178 } else {
179 status = psa_export_key(pk->priv_id, tmp, sizeof(tmp), &byte_length);
180 if (status != PSA_SUCCESS) {
181 ret = PSA_PK_ECDSA_TO_MBEDTLS_ERR(status);
182 goto exit;
183 }
184 }
185
186 ret = mbedtls_asn1_write_octet_string(p, start, tmp, byte_length);
187exit:
188 mbedtls_platform_zeroize(tmp, sizeof(tmp));
189 return ret;
190}
191#else /* MBEDTLS_PK_USE_PSA_EC_DATA */
192static int pk_write_ec_private(unsigned char **p, unsigned char *start,
193 const mbedtls_pk_context *pk)
194{
195 size_t byte_length;
196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
197 unsigned char tmp[PK_MAX_EC_KEY_PAIR_SIZE];
198
199#if defined(MBEDTLS_USE_PSA_CRYPTO)
200 psa_status_t status;
201 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
202 status = psa_export_key(pk->priv_id, tmp, sizeof(tmp), &byte_length);
203 if (status != PSA_SUCCESS) {
204 ret = PSA_PK_ECDSA_TO_MBEDTLS_ERR(status);
205 return ret;
206 }
207 } else
208#endif /* MBEDTLS_USE_PSA_CRYPTO */
209 {
210 mbedtls_ecp_keypair *ec = mbedtls_pk_ec_rw(*pk);
211 byte_length = (ec->grp.pbits + 7) / 8;
212
213 ret = mbedtls_ecp_write_key_ext(ec, &byte_length, tmp, sizeof(tmp));
214 if (ret != 0) {
215 goto exit;
216 }
217 }
218 ret = mbedtls_asn1_write_octet_string(p, start, tmp, byte_length);
219exit:
220 mbedtls_platform_zeroize(tmp, sizeof(tmp));
221 return ret;
222}
223#endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
Jens Wiklander817466c2018-05-22 13:49:31 +0200224
225/*
226 * ECParameters ::= CHOICE {
227 * namedCurve OBJECT IDENTIFIER
228 * }
229 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200230static int pk_write_ec_param(unsigned char **p, unsigned char *start,
Tom Van Eyckb0563632024-06-13 16:20:14 +0200231 mbedtls_ecp_group_id grp_id)
Jens Wiklander817466c2018-05-22 13:49:31 +0200232{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200233 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +0200234 size_t len = 0;
235 const char *oid;
236 size_t oid_len;
237
Tom Van Eyckb0563632024-06-13 16:20:14 +0200238 if ((ret = mbedtls_oid_get_oid_by_ec_grp(grp_id, &oid, &oid_len)) != 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200239 return ret;
240 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200241
Jens Wiklander32b31802023-10-06 16:59:46 +0200242 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_oid(p, start, oid, oid_len));
Jens Wiklander817466c2018-05-22 13:49:31 +0200243
Jens Wiklander32b31802023-10-06 16:59:46 +0200244 return (int) len;
Jens Wiklander817466c2018-05-22 13:49:31 +0200245}
Jerome Forissier5b25c762020-04-07 11:18:49 +0200246
Tom Van Eyckb0563632024-06-13 16:20:14 +0200247#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
Jerome Forissier5b25c762020-04-07 11:18:49 +0200248/*
Tom Van Eyckb0563632024-06-13 16:20:14 +0200249 * RFC8410 section 7
250 *
251 * OneAsymmetricKey ::= SEQUENCE {
252 * version Version,
253 * privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
254 * privateKey PrivateKey,
255 * attributes [0] IMPLICIT Attributes OPTIONAL,
256 * ...,
257 * [[2: publicKey [1] IMPLICIT PublicKey OPTIONAL ]],
258 * ...
259 * }
260 * ...
261 * CurvePrivateKey ::= OCTET STRING
Jerome Forissier5b25c762020-04-07 11:18:49 +0200262 */
Tom Van Eyckb0563632024-06-13 16:20:14 +0200263static int pk_write_ec_rfc8410_der(unsigned char **p, unsigned char *buf,
264 const mbedtls_pk_context *pk)
Jerome Forissier5b25c762020-04-07 11:18:49 +0200265{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200266 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200267 size_t len = 0;
268 size_t oid_len = 0;
269 const char *oid;
270 mbedtls_ecp_group_id grp_id;
Jerome Forissier5b25c762020-04-07 11:18:49 +0200271
Tom Van Eyckb0563632024-06-13 16:20:14 +0200272 /* privateKey */
273 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_private(p, buf, pk));
274 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
275 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_OCTET_STRING));
276
277 grp_id = mbedtls_pk_get_ec_group_id(pk);
278 /* privateKeyAlgorithm */
279 if ((ret = mbedtls_oid_get_oid_by_ec_grp_algid(grp_id, &oid, &oid_len)) != 0) {
280 return ret;
Jens Wiklander32b31802023-10-06 16:59:46 +0200281 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200282 MBEDTLS_ASN1_CHK_ADD(len,
283 mbedtls_asn1_write_algorithm_identifier_ext(p, buf, oid, oid_len, 0, 0));
Jerome Forissier5b25c762020-04-07 11:18:49 +0200284
Tom Van Eyckb0563632024-06-13 16:20:14 +0200285 /* version */
286 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(p, buf, 0));
287
288 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
289 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_CONSTRUCTED |
290 MBEDTLS_ASN1_SEQUENCE));
291
292 return (int) len;
Jerome Forissier5b25c762020-04-07 11:18:49 +0200293}
Tom Van Eyckb0563632024-06-13 16:20:14 +0200294#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
Jens Wiklander817466c2018-05-22 13:49:31 +0200295
Tom Van Eyckb0563632024-06-13 16:20:14 +0200296/*
297 * RFC 5915, or SEC1 Appendix C.4
298 *
299 * ECPrivateKey ::= SEQUENCE {
300 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
301 * privateKey OCTET STRING,
302 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
303 * publicKey [1] BIT STRING OPTIONAL
304 * }
305 */
306static int pk_write_ec_der(unsigned char **p, unsigned char *buf,
307 const mbedtls_pk_context *pk)
308{
309 size_t len = 0;
310 int ret;
311 size_t pub_len = 0, par_len = 0;
312 mbedtls_ecp_group_id grp_id;
313
314 /* publicKey */
315 MBEDTLS_ASN1_CHK_ADD(pub_len, pk_write_ec_pubkey(p, buf, pk));
316
317 if (*p - buf < 1) {
318 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
319 }
320 (*p)--;
321 **p = 0;
322 pub_len += 1;
323
324 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_len(p, buf, pub_len));
325 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_BIT_STRING));
326
327 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_len(p, buf, pub_len));
328 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_tag(p, buf,
329 MBEDTLS_ASN1_CONTEXT_SPECIFIC |
330 MBEDTLS_ASN1_CONSTRUCTED | 1));
331 len += pub_len;
332
333 /* parameters */
334 grp_id = mbedtls_pk_get_ec_group_id(pk);
335 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(p, buf, grp_id));
336 MBEDTLS_ASN1_CHK_ADD(par_len, mbedtls_asn1_write_len(p, buf, par_len));
337 MBEDTLS_ASN1_CHK_ADD(par_len, mbedtls_asn1_write_tag(p, buf,
338 MBEDTLS_ASN1_CONTEXT_SPECIFIC |
339 MBEDTLS_ASN1_CONSTRUCTED | 0));
340 len += par_len;
341
342 /* privateKey */
343 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_private(p, buf, pk));
344
345 /* version */
346 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(p, buf, 1));
347
348 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
349 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_CONSTRUCTED |
350 MBEDTLS_ASN1_SEQUENCE));
351
352 return (int) len;
353}
354#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
355
356/******************************************************************************
357 * Internal functions for Opaque keys.
358 ******************************************************************************/
359#if defined(MBEDTLS_USE_PSA_CRYPTO)
360static int pk_write_opaque_pubkey(unsigned char **p, unsigned char *start,
361 const mbedtls_pk_context *pk)
362{
363 size_t buffer_size;
364 size_t len = 0;
365
366 if (*p < start) {
367 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
368 }
369
370 buffer_size = (size_t) (*p - start);
371 if (psa_export_public_key(pk->priv_id, start, buffer_size,
372 &len) != PSA_SUCCESS) {
373 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
374 }
375
376 *p -= len;
377 memmove(*p, start, len);
378
379 return (int) len;
380}
381#endif /* MBEDTLS_USE_PSA_CRYPTO */
382
383/******************************************************************************
384 * Generic helpers
385 ******************************************************************************/
386
387/* Extend the public mbedtls_pk_get_type() by getting key type also in case of
388 * opaque keys. */
389static mbedtls_pk_type_t pk_get_type_ext(const mbedtls_pk_context *pk)
390{
391 mbedtls_pk_type_t pk_type = mbedtls_pk_get_type(pk);
392
393#if defined(MBEDTLS_USE_PSA_CRYPTO)
394 if (pk_type == MBEDTLS_PK_OPAQUE) {
395 psa_key_attributes_t opaque_attrs = PSA_KEY_ATTRIBUTES_INIT;
396 psa_key_type_t opaque_key_type;
397
398 if (psa_get_key_attributes(pk->priv_id, &opaque_attrs) != PSA_SUCCESS) {
399 return MBEDTLS_PK_NONE;
400 }
401 opaque_key_type = psa_get_key_type(&opaque_attrs);
402 psa_reset_key_attributes(&opaque_attrs);
403
404 if (PSA_KEY_TYPE_IS_ECC(opaque_key_type)) {
405 return MBEDTLS_PK_ECKEY;
406 } else if (PSA_KEY_TYPE_IS_RSA(opaque_key_type)) {
407 return MBEDTLS_PK_RSA;
408 } else {
409 return MBEDTLS_PK_NONE;
410 }
411 } else
412#endif
413 return pk_type;
414}
415
416/******************************************************************************
417 * Public functions for writing private/public DER keys.
418 ******************************************************************************/
Jens Wiklander32b31802023-10-06 16:59:46 +0200419int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
420 const mbedtls_pk_context *key)
Jens Wiklander817466c2018-05-22 13:49:31 +0200421{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200422 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +0200423 size_t len = 0;
424
425#if defined(MBEDTLS_RSA_C)
Jens Wiklander32b31802023-10-06 16:59:46 +0200426 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_RSA) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200427 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_rsa_write_pubkey(mbedtls_pk_rsa(*key), start, p));
Jens Wiklander32b31802023-10-06 16:59:46 +0200428 } else
Jens Wiklander817466c2018-05-22 13:49:31 +0200429#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +0200430#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jens Wiklander32b31802023-10-06 16:59:46 +0200431 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_ECKEY) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200432 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_pubkey(p, start, key));
Jens Wiklander32b31802023-10-06 16:59:46 +0200433 } else
Jens Wiklander817466c2018-05-22 13:49:31 +0200434#endif
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200435#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jens Wiklander32b31802023-10-06 16:59:46 +0200436 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_OPAQUE) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200437 MBEDTLS_ASN1_CHK_ADD(len, pk_write_opaque_pubkey(p, start, key));
Jens Wiklander32b31802023-10-06 16:59:46 +0200438 } else
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200439#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jens Wiklander32b31802023-10-06 16:59:46 +0200440 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200441
Jens Wiklander32b31802023-10-06 16:59:46 +0200442 return (int) len;
Jens Wiklander817466c2018-05-22 13:49:31 +0200443}
444
Jens Wiklander32b31802023-10-06 16:59:46 +0200445int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Jens Wiklander817466c2018-05-22 13:49:31 +0200446{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200447 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +0200448 unsigned char *c;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200449 int has_par = 1;
450 size_t len = 0, par_len = 0, oid_len = 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200451 mbedtls_pk_type_t pk_type;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200452 const char *oid = NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200453
Jens Wiklander32b31802023-10-06 16:59:46 +0200454 if (size == 0) {
455 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
456 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100457
Jens Wiklander817466c2018-05-22 13:49:31 +0200458 c = buf + size;
459
Jens Wiklander32b31802023-10-06 16:59:46 +0200460 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_pk_write_pubkey(&c, buf, key));
Jens Wiklander817466c2018-05-22 13:49:31 +0200461
Jens Wiklander32b31802023-10-06 16:59:46 +0200462 if (c - buf < 1) {
463 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
464 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200465
466 /*
467 * SubjectPublicKeyInfo ::= SEQUENCE {
468 * algorithm AlgorithmIdentifier,
469 * subjectPublicKey BIT STRING }
470 */
471 *--c = 0;
472 len += 1;
473
Jens Wiklander32b31802023-10-06 16:59:46 +0200474 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
475 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_BIT_STRING));
Jens Wiklander817466c2018-05-22 13:49:31 +0200476
Tom Van Eyckb0563632024-06-13 16:20:14 +0200477 pk_type = pk_get_type_ext(key);
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200478
Tom Van Eyckb0563632024-06-13 16:20:14 +0200479#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
480 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
481 mbedtls_ecp_group_id ec_grp_id = mbedtls_pk_get_ec_group_id(key);
482 if (MBEDTLS_PK_IS_RFC8410_GROUP_ID(ec_grp_id)) {
483 ret = mbedtls_oid_get_oid_by_ec_grp_algid(ec_grp_id, &oid, &oid_len);
Jens Wiklander32b31802023-10-06 16:59:46 +0200484 if (ret != 0) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200485 return ret;
Jens Wiklander32b31802023-10-06 16:59:46 +0200486 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200487 has_par = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +0200488 } else {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200489 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(&c, buf, ec_grp_id));
Jens Wiklander32b31802023-10-06 16:59:46 +0200490 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200491 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200492#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200493
Tom Van Eyckb0563632024-06-13 16:20:14 +0200494 /* At this point oid_len is not null only for EC Montgomery keys. */
495 if (oid_len == 0) {
496 ret = mbedtls_oid_get_oid_by_pk_alg(pk_type, &oid, &oid_len);
497 if (ret != 0) {
498 return ret;
499 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200500 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200501
Tom Van Eyckb0563632024-06-13 16:20:14 +0200502 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_algorithm_identifier_ext(&c, buf, oid, oid_len,
503 par_len, has_par));
Jens Wiklander817466c2018-05-22 13:49:31 +0200504
Jens Wiklander32b31802023-10-06 16:59:46 +0200505 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
506 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_CONSTRUCTED |
507 MBEDTLS_ASN1_SEQUENCE));
Jens Wiklander817466c2018-05-22 13:49:31 +0200508
Jens Wiklander32b31802023-10-06 16:59:46 +0200509 return (int) len;
Jens Wiklander817466c2018-05-22 13:49:31 +0200510}
511
Jens Wiklander32b31802023-10-06 16:59:46 +0200512int mbedtls_pk_write_key_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Jens Wiklander817466c2018-05-22 13:49:31 +0200513{
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100514 unsigned char *c;
Jens Wiklander817466c2018-05-22 13:49:31 +0200515
Jens Wiklander32b31802023-10-06 16:59:46 +0200516 if (size == 0) {
517 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
518 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100519
520 c = buf + size;
521
Jens Wiklander817466c2018-05-22 13:49:31 +0200522#if defined(MBEDTLS_RSA_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200523 if (pk_get_type_ext(key) == MBEDTLS_PK_RSA) {
524 return pk_write_rsa_der(&c, buf, key);
Jens Wiklander32b31802023-10-06 16:59:46 +0200525 } else
Jens Wiklander817466c2018-05-22 13:49:31 +0200526#endif /* MBEDTLS_RSA_C */
Tom Van Eyckb0563632024-06-13 16:20:14 +0200527#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
528 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
529#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
530 if (mbedtls_pk_is_rfc8410(key)) {
531 return pk_write_ec_rfc8410_der(&c, buf, key);
Jens Wiklander32b31802023-10-06 16:59:46 +0200532 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200533#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
534 return pk_write_ec_der(&c, buf, key);
Jens Wiklander32b31802023-10-06 16:59:46 +0200535 } else
Tom Van Eyckb0563632024-06-13 16:20:14 +0200536#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jens Wiklander32b31802023-10-06 16:59:46 +0200537 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200538}
539
Tom Van Eyckb0563632024-06-13 16:20:14 +0200540/******************************************************************************
541 * Public functions for wrinting private/public PEM keys.
542 ******************************************************************************/
Jens Wiklander817466c2018-05-22 13:49:31 +0200543#if defined(MBEDTLS_PEM_WRITE_C)
544
Jens Wiklander32b31802023-10-06 16:59:46 +0200545#define PUB_DER_MAX_BYTES \
546 (MBEDTLS_PK_RSA_PUB_DER_MAX_BYTES > MBEDTLS_PK_ECP_PUB_DER_MAX_BYTES ? \
547 MBEDTLS_PK_RSA_PUB_DER_MAX_BYTES : MBEDTLS_PK_ECP_PUB_DER_MAX_BYTES)
548#define PRV_DER_MAX_BYTES \
549 (MBEDTLS_PK_RSA_PRV_DER_MAX_BYTES > MBEDTLS_PK_ECP_PRV_DER_MAX_BYTES ? \
550 MBEDTLS_PK_RSA_PRV_DER_MAX_BYTES : MBEDTLS_PK_ECP_PRV_DER_MAX_BYTES)
Jens Wiklander817466c2018-05-22 13:49:31 +0200551
Jens Wiklander32b31802023-10-06 16:59:46 +0200552int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Jens Wiklander817466c2018-05-22 13:49:31 +0200553{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200555 unsigned char *output_buf = NULL;
556 output_buf = mbedtls_calloc(1, PUB_DER_MAX_BYTES);
557 if (output_buf == NULL) {
558 return MBEDTLS_ERR_PK_ALLOC_FAILED;
559 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200560 size_t olen = 0;
561
Jens Wiklander32b31802023-10-06 16:59:46 +0200562 if ((ret = mbedtls_pk_write_pubkey_der(key, output_buf,
Tom Van Eyckb0563632024-06-13 16:20:14 +0200563 PUB_DER_MAX_BYTES)) < 0) {
564 goto cleanup;
Jens Wiklander817466c2018-05-22 13:49:31 +0200565 }
566
Tom Van Eyckb0563632024-06-13 16:20:14 +0200567 if ((ret = mbedtls_pem_write_buffer(PEM_BEGIN_PUBLIC_KEY "\n", PEM_END_PUBLIC_KEY "\n",
568 output_buf + PUB_DER_MAX_BYTES - ret,
Jens Wiklander32b31802023-10-06 16:59:46 +0200569 ret, buf, size, &olen)) != 0) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200570 goto cleanup;
Jens Wiklander817466c2018-05-22 13:49:31 +0200571 }
572
Tom Van Eyckb0563632024-06-13 16:20:14 +0200573 ret = 0;
574cleanup:
575 mbedtls_free(output_buf);
576 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200577}
578
Jens Wiklander32b31802023-10-06 16:59:46 +0200579int mbedtls_pk_write_key_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Jens Wiklander817466c2018-05-22 13:49:31 +0200580{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200581 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200582 unsigned char *output_buf = NULL;
583 output_buf = mbedtls_calloc(1, PRV_DER_MAX_BYTES);
584 if (output_buf == NULL) {
585 return MBEDTLS_ERR_PK_ALLOC_FAILED;
586 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200587 const char *begin, *end;
588 size_t olen = 0;
589
Tom Van Eyckb0563632024-06-13 16:20:14 +0200590 if ((ret = mbedtls_pk_write_key_der(key, output_buf, PRV_DER_MAX_BYTES)) < 0) {
591 goto cleanup;
Jens Wiklander32b31802023-10-06 16:59:46 +0200592 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200593
594#if defined(MBEDTLS_RSA_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200595 if (pk_get_type_ext(key) == MBEDTLS_PK_RSA) {
596 begin = PEM_BEGIN_PRIVATE_KEY_RSA "\n";
597 end = PEM_END_PRIVATE_KEY_RSA "\n";
Jens Wiklander32b31802023-10-06 16:59:46 +0200598 } else
Jens Wiklander817466c2018-05-22 13:49:31 +0200599#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +0200600#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
601 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
602 if (mbedtls_pk_is_rfc8410(key)) {
603 begin = PEM_BEGIN_PRIVATE_KEY_PKCS8 "\n";
604 end = PEM_END_PRIVATE_KEY_PKCS8 "\n";
605 } else {
606 begin = PEM_BEGIN_PRIVATE_KEY_EC "\n";
607 end = PEM_END_PRIVATE_KEY_EC "\n";
608 }
Jens Wiklander32b31802023-10-06 16:59:46 +0200609 } else
Tom Van Eyckb0563632024-06-13 16:20:14 +0200610#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
611 {
612 ret = MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
613 goto cleanup;
Jens Wiklander817466c2018-05-22 13:49:31 +0200614 }
615
Tom Van Eyckb0563632024-06-13 16:20:14 +0200616 if ((ret = mbedtls_pem_write_buffer(begin, end,
617 output_buf + PRV_DER_MAX_BYTES - ret,
618 ret, buf, size, &olen)) != 0) {
619 goto cleanup;
620 }
621
622 ret = 0;
623cleanup:
624 mbedtls_zeroize_and_free(output_buf, PRV_DER_MAX_BYTES);
625 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200626}
627#endif /* MBEDTLS_PEM_WRITE_C */
628
629#endif /* MBEDTLS_PK_WRITE_C */