blob: b9ddcf1d8d13aa6e9438bb775be1d9b6db67686c [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
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02006 */
7
Gilles Peskinedb09ef62020-06-03 01:43:33 +02008#include "common.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +02009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020010#if defined(MBEDTLS_PK_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020011
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000012#include "mbedtls/pk.h"
13#include "mbedtls/asn1write.h"
14#include "mbedtls/oid.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050015#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000016#include "mbedtls/error.h"
Valerio Setti77a75682023-05-15 11:18:46 +020017#include "pk_internal.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020018
Rich Evans00ab4702015-02-06 13:43:58 +000019#include <string.h>
20
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020021#if defined(MBEDTLS_ECP_C)
Gilles Peskine2700cfb2018-08-11 00:48:44 +020022#include "mbedtls/bignum.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000023#include "mbedtls/ecp.h"
Gilles Peskine2700cfb2018-08-11 00:48:44 +020024#include "mbedtls/platform_util.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020025#endif
Valerio Setti81d75122023-06-14 14:49:33 +020026#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Setti4064dbb2023-05-17 15:33:07 +020027#include "pk_internal.h"
28#endif
Valerio Setti81d75122023-06-14 14:49:33 +020029#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Neil Armstronge0326a62022-02-25 08:57:19 +010030#include "pkwrite.h"
31#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#if defined(MBEDTLS_PEM_WRITE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000033#include "mbedtls/pem.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020034#endif
Valerio Settib328c442024-01-23 10:48:45 +010035#if defined(MBEDTLS_RSA_C)
36#include "rsa_internal.h"
37#endif
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020038
Andrzej Kurek5fec0862018-11-19 10:07:36 -050039#if defined(MBEDTLS_USE_PSA_CRYPTO)
40#include "psa/crypto.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020041#include "psa_util_internal.h"
Andrzej Kurek5fec0862018-11-19 10:07:36 -050042#endif
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000043#include "mbedtls/platform.h"
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020044
Valerio Settid5604ba2023-11-28 14:10:43 +010045/* 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
Valerio Setti8aec84f2023-12-04 16:04:21 +010050#elif defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Settid5604ba2023-11-28 14:10:43 +010051#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
Valerio Settid5604ba2023-11-28 14:10:43 +010057
Valerio Setti605f03c2023-11-28 12:46:39 +010058/******************************************************************************
59 * Internal functions for RSA keys.
60 ******************************************************************************/
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061#if defined(MBEDTLS_RSA_C)
Valerio Setti429cd502024-01-23 09:10:22 +010062static int pk_write_rsa_der(unsigned char **p, unsigned char *buf,
63 const mbedtls_pk_context *pk)
64{
Valerio Setti605f03c2023-11-28 12:46:39 +010065#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];
Valerio Setti429cd502024-01-23 09:10:22 +010068 size_t len = 0, tmp_len = 0;
Valerio Setti605f03c2023-11-28 12:46:39 +010069
70 if (psa_export_key(pk->priv_id, tmp, sizeof(tmp), &tmp_len) != PSA_SUCCESS) {
71 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
72 }
73 *p -= tmp_len;
74 memcpy(*p, tmp, tmp_len);
75 len += tmp_len;
76 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Valerio Setti605f03c2023-11-28 12:46:39 +010077
Valerio Setti429cd502024-01-23 09:10:22 +010078 return (int) len;
Valerio Setti605f03c2023-11-28 12:46:39 +010079 }
Valerio Setti429cd502024-01-23 09:10:22 +010080#endif /* MBEDTLS_USE_PSA_CRYPTO */
Valerio Setti135ebde2024-02-01 17:00:29 +010081 return mbedtls_rsa_write_key(mbedtls_pk_rsa(*pk), buf, p);
Valerio Setti605f03c2023-11-28 12:46:39 +010082}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020083#endif /* MBEDTLS_RSA_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020084
Valerio Setti605f03c2023-11-28 12:46:39 +010085/******************************************************************************
86 * Internal functions for EC keys.
87 ******************************************************************************/
Valerio Setti81d75122023-06-14 14:49:33 +020088#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
valerio9ea26172023-05-31 12:10:23 +020089#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +010090static int pk_write_ec_pubkey(unsigned char **p, unsigned char *start,
Valerio Setti4064dbb2023-05-17 15:33:07 +020091 const mbedtls_pk_context *pk)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020092{
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020093 size_t len = 0;
Valerio Settid5604ba2023-11-28 14:10:43 +010094 uint8_t buf[PK_MAX_EC_PUBLIC_KEY_SIZE];
Valerio Setti4064dbb2023-05-17 15:33:07 +020095
valerio9ea26172023-05-31 12:10:23 +020096 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
97 if (psa_export_public_key(pk->priv_id, buf, sizeof(buf), &len) != PSA_SUCCESS) {
98 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
99 }
100 } else {
101 len = pk->pub_raw_len;
valeriof9139e52023-05-31 18:01:33 +0200102 memcpy(buf, pk->pub_raw, len);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200103 }
104
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (*p < start || (size_t) (*p - start) < len) {
106 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
107 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200108
109 *p -= len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 memcpy(*p, buf, len);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200111
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200113}
valerio9ea26172023-05-31 12:10:23 +0200114#else /* MBEDTLS_PK_USE_PSA_EC_DATA */
115static int pk_write_ec_pubkey(unsigned char **p, unsigned char *start,
116 const mbedtls_pk_context *pk)
117{
118 size_t len = 0;
Valerio Settid5604ba2023-11-28 14:10:43 +0100119 unsigned char buf[PK_MAX_EC_PUBLIC_KEY_SIZE];
valerio9ea26172023-05-31 12:10:23 +0200120 mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*pk);
121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
122
123#if defined(MBEDTLS_USE_PSA_CRYPTO)
124 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
125 if (psa_export_public_key(pk->priv_id, buf, sizeof(buf), &len) != PSA_SUCCESS) {
126 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
127 }
128 *p -= len;
129 memcpy(*p, buf, len);
130 return (int) len;
131 } else
132#endif /* MBEDTLS_USE_PSA_CRYPTO */
133 {
134 if ((ret = mbedtls_ecp_point_write_binary(&ec->grp, &ec->Q,
135 MBEDTLS_ECP_PF_UNCOMPRESSED,
136 &len, buf, sizeof(buf))) != 0) {
137 return ret;
138 }
139 }
140
141 if (*p < start || (size_t) (*p - start) < len) {
142 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
143 }
144
145 *p -= len;
146 memcpy(*p, buf, len);
147
148 return (int) len;
149}
150#endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200151
152/*
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200153 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
154 */
valerio52b675f2023-05-31 12:14:37 +0200155#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100156static int pk_write_ec_private(unsigned char **p, unsigned char *start,
Valerio Setti00e8dd12023-05-18 18:56:59 +0200157 const mbedtls_pk_context *pk)
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200158{
Valerio Setti00e8dd12023-05-18 18:56:59 +0200159 size_t byte_length;
Janos Follath24eed8d2019-11-22 13:21:35 +0000160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Valerio Settid5604ba2023-11-28 14:10:43 +0100161 unsigned char tmp[PK_MAX_EC_KEY_PAIR_SIZE];
Valerio Setti00e8dd12023-05-18 18:56:59 +0200162 psa_status_t status;
163
valerio52b675f2023-05-31 12:14:37 +0200164 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
165 status = psa_export_key(pk->priv_id, tmp, sizeof(tmp), &byte_length);
166 if (status != PSA_SUCCESS) {
167 ret = PSA_PK_ECDSA_TO_MBEDTLS_ERR(status);
168 return ret;
169 }
170 } else {
171 status = psa_export_key(pk->priv_id, tmp, sizeof(tmp), &byte_length);
172 if (status != PSA_SUCCESS) {
173 ret = PSA_PK_ECDSA_TO_MBEDTLS_ERR(status);
174 goto exit;
175 }
Valerio Setti00e8dd12023-05-18 18:56:59 +0200176 }
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200177
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 ret = mbedtls_asn1_write_octet_string(p, start, tmp, byte_length);
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200179exit:
Valerio Setti00e8dd12023-05-18 18:56:59 +0200180 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 return ret;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200182}
valerio52b675f2023-05-31 12:14:37 +0200183#else /* MBEDTLS_PK_USE_PSA_EC_DATA */
184static int pk_write_ec_private(unsigned char **p, unsigned char *start,
185 const mbedtls_pk_context *pk)
186{
187 size_t byte_length;
188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Valerio Settid5604ba2023-11-28 14:10:43 +0100189 unsigned char tmp[PK_MAX_EC_KEY_PAIR_SIZE];
valerio52b675f2023-05-31 12:14:37 +0200190
191#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Settid5604ba2023-11-28 14:10:43 +0100192 psa_status_t status;
valerio52b675f2023-05-31 12:14:37 +0200193 if (mbedtls_pk_get_type(pk) == MBEDTLS_PK_OPAQUE) {
194 status = psa_export_key(pk->priv_id, tmp, sizeof(tmp), &byte_length);
195 if (status != PSA_SUCCESS) {
196 ret = PSA_PK_ECDSA_TO_MBEDTLS_ERR(status);
197 return ret;
198 }
199 } else
200#endif /* MBEDTLS_USE_PSA_CRYPTO */
201 {
202 mbedtls_ecp_keypair *ec = mbedtls_pk_ec_rw(*pk);
203 byte_length = (ec->grp.pbits + 7) / 8;
204
205 ret = mbedtls_ecp_write_key(ec, tmp, byte_length);
206 if (ret != 0) {
207 goto exit;
208 }
209 }
210 ret = mbedtls_asn1_write_octet_string(p, start, tmp, byte_length);
211exit:
212 mbedtls_platform_zeroize(tmp, sizeof(tmp));
213 return ret;
214}
215#endif /* MBEDTLS_PK_USE_PSA_EC_DATA */
Valerio Setti605f03c2023-11-28 12:46:39 +0100216
217/*
218 * ECParameters ::= CHOICE {
219 * namedCurve OBJECT IDENTIFIER
220 * }
221 */
222static int pk_write_ec_param(unsigned char **p, unsigned char *start,
223 mbedtls_ecp_group_id grp_id)
224{
225 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
226 size_t len = 0;
227 const char *oid;
228 size_t oid_len;
229
230 if ((ret = mbedtls_oid_get_oid_by_ec_grp(grp_id, &oid, &oid_len)) != 0) {
231 return ret;
232 }
233
234 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_oid(p, start, oid, oid_len));
235
236 return (int) len;
237}
238
239#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
Valerio Setti605f03c2023-11-28 12:46:39 +0100240/*
241 * RFC8410 section 7
242 *
243 * OneAsymmetricKey ::= SEQUENCE {
244 * version Version,
245 * privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
246 * privateKey PrivateKey,
247 * attributes [0] IMPLICIT Attributes OPTIONAL,
248 * ...,
249 * [[2: publicKey [1] IMPLICIT PublicKey OPTIONAL ]],
250 * ...
251 * }
252 * ...
253 * CurvePrivateKey ::= OCTET STRING
254 */
255static int pk_write_ec_rfc8410_der(unsigned char **p, unsigned char *buf,
256 const mbedtls_pk_context *pk)
257{
258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
259 size_t len = 0;
260 size_t oid_len = 0;
261 const char *oid;
262 mbedtls_ecp_group_id grp_id;
263
264 /* privateKey */
265 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_private(p, buf, pk));
266 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
267 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_OCTET_STRING));
268
Valerio Settif9362b72023-11-29 08:42:27 +0100269 grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Setti605f03c2023-11-28 12:46:39 +0100270 /* privateKeyAlgorithm */
271 if ((ret = mbedtls_oid_get_oid_by_ec_grp_algid(grp_id, &oid, &oid_len)) != 0) {
272 return ret;
273 }
274 MBEDTLS_ASN1_CHK_ADD(len,
275 mbedtls_asn1_write_algorithm_identifier_ext(p, buf, oid, oid_len, 0, 0));
276
277 /* version */
278 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(p, buf, 0));
279
280 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
281 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_CONSTRUCTED |
282 MBEDTLS_ASN1_SEQUENCE));
283
284 return (int) len;
285}
286#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
287
288/*
289 * RFC 5915, or SEC1 Appendix C.4
290 *
291 * ECPrivateKey ::= SEQUENCE {
292 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
293 * privateKey OCTET STRING,
294 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
295 * publicKey [1] BIT STRING OPTIONAL
296 * }
297 */
298static int pk_write_ec_der(unsigned char **p, unsigned char *buf,
299 const mbedtls_pk_context *pk)
300{
301 size_t len = 0;
302 int ret;
303 size_t pub_len = 0, par_len = 0;
304 mbedtls_ecp_group_id grp_id;
305
306 /* publicKey */
307 MBEDTLS_ASN1_CHK_ADD(pub_len, pk_write_ec_pubkey(p, buf, pk));
308
309 if (*p - buf < 1) {
310 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
311 }
312 (*p)--;
313 **p = 0;
314 pub_len += 1;
315
316 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_len(p, buf, pub_len));
317 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_BIT_STRING));
318
319 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_len(p, buf, pub_len));
320 MBEDTLS_ASN1_CHK_ADD(pub_len, mbedtls_asn1_write_tag(p, buf,
321 MBEDTLS_ASN1_CONTEXT_SPECIFIC |
322 MBEDTLS_ASN1_CONSTRUCTED | 1));
323 len += pub_len;
324
325 /* parameters */
Valerio Settif9362b72023-11-29 08:42:27 +0100326 grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Setti605f03c2023-11-28 12:46:39 +0100327 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(p, buf, grp_id));
328 MBEDTLS_ASN1_CHK_ADD(par_len, mbedtls_asn1_write_len(p, buf, par_len));
329 MBEDTLS_ASN1_CHK_ADD(par_len, mbedtls_asn1_write_tag(p, buf,
330 MBEDTLS_ASN1_CONTEXT_SPECIFIC |
331 MBEDTLS_ASN1_CONSTRUCTED | 0));
332 len += par_len;
333
334 /* privateKey */
335 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_private(p, buf, pk));
336
337 /* version */
338 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_int(p, buf, 1));
339
340 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, buf, len));
341 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, buf, MBEDTLS_ASN1_CONSTRUCTED |
342 MBEDTLS_ASN1_SEQUENCE));
343
344 return (int) len;
345}
Valerio Setti81d75122023-06-14 14:49:33 +0200346#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200347
Valerio Setti605f03c2023-11-28 12:46:39 +0100348/******************************************************************************
349 * Internal functions for Opaque keys.
350 ******************************************************************************/
valerio9ea26172023-05-31 12:10:23 +0200351#if defined(MBEDTLS_USE_PSA_CRYPTO)
352static int pk_write_opaque_pubkey(unsigned char **p, unsigned char *start,
353 const mbedtls_pk_context *pk)
354{
355 size_t buffer_size;
356 size_t len = 0;
357
358 if (*p < start) {
359 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
360 }
361
362 buffer_size = (size_t) (*p - start);
363 if (psa_export_public_key(pk->priv_id, start, buffer_size,
364 &len) != PSA_SUCCESS) {
365 return MBEDTLS_ERR_PK_BAD_INPUT_DATA;
366 }
367
368 *p -= len;
369 memmove(*p, start, len);
370
371 return (int) len;
372}
373#endif /* MBEDTLS_USE_PSA_CRYPTO */
374
Valerio Setti605f03c2023-11-28 12:46:39 +0100375/******************************************************************************
Valerio Settia4f70fe2023-11-29 15:05:47 +0100376 * Generic helpers
377 ******************************************************************************/
378
379/* Extend the public mbedtls_pk_get_type() by getting key type also in case of
380 * opaque keys. */
381static mbedtls_pk_type_t pk_get_type_ext(const mbedtls_pk_context *pk)
382{
383 mbedtls_pk_type_t pk_type = mbedtls_pk_get_type(pk);
384
385#if defined(MBEDTLS_USE_PSA_CRYPTO)
386 if (pk_type == MBEDTLS_PK_OPAQUE) {
387 psa_key_attributes_t opaque_attrs = PSA_KEY_ATTRIBUTES_INIT;
388 psa_key_type_t opaque_key_type;
389
390 if (psa_get_key_attributes(pk->priv_id, &opaque_attrs) != PSA_SUCCESS) {
391 return MBEDTLS_PK_NONE;
392 }
393 opaque_key_type = psa_get_key_type(&opaque_attrs);
394 psa_reset_key_attributes(&opaque_attrs);
395
396 if (PSA_KEY_TYPE_IS_ECC(opaque_key_type)) {
397 return MBEDTLS_PK_ECKEY;
398 } else if (PSA_KEY_TYPE_IS_RSA(opaque_key_type)) {
399 return MBEDTLS_PK_RSA;
400 } else {
Valerio Settiad6d0162023-11-30 08:10:36 +0100401 return MBEDTLS_PK_NONE;
Valerio Settia4f70fe2023-11-29 15:05:47 +0100402 }
403 } else
404#endif
405 return pk_type;
406}
407
408/******************************************************************************
Valerio Setti605f03c2023-11-28 12:46:39 +0100409 * Public functions for writing private/public DER keys.
410 ******************************************************************************/
Gilles Peskine449bd832023-01-11 14:50:10 +0100411int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
412 const mbedtls_pk_context *key)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200413{
Janos Follath24eed8d2019-11-22 13:21:35 +0000414 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200415 size_t len = 0;
416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_RSA) {
Valerio Setti135ebde2024-02-01 17:00:29 +0100419 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_rsa_write_pubkey(mbedtls_pk_rsa(*key), start, p));
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200421#endif
Valerio Setti81d75122023-06-14 14:49:33 +0200422#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_ECKEY) {
Valerio Setti4064dbb2023-05-17 15:33:07 +0200424 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_pubkey(p, start, key));
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200426#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500427#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_OPAQUE) {
valerio9ea26172023-05-31 12:10:23 +0200429 MBEDTLS_ASN1_CHK_ADD(len, pk_write_opaque_pubkey(p, start, key));
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 } else
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500431#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200433
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200435}
436
Gilles Peskine449bd832023-01-11 14:50:10 +0100437int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200438{
Janos Follath24eed8d2019-11-22 13:21:35 +0000439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200440 unsigned char *c;
Jethro Beekman01672442023-04-19 14:08:14 +0200441 int has_par = 1;
442 size_t len = 0, par_len = 0, oid_len = 0;
Hanno Becker493c1712019-02-01 10:07:07 +0000443 mbedtls_pk_type_t pk_type;
correya15b4852023-09-21 16:19:11 +0800444 const char *oid = NULL;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200445
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 if (size == 0) {
447 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
448 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500449
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200450 c = buf + size;
451
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_pk_write_pubkey(&c, buf, key));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200453
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 if (c - buf < 1) {
455 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
456 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200457
458 /*
459 * SubjectPublicKeyInfo ::= SEQUENCE {
460 * algorithm AlgorithmIdentifier,
461 * subjectPublicKey BIT STRING }
462 */
463 *--c = 0;
464 len += 1;
465
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
467 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_BIT_STRING));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200468
Valerio Settia4f70fe2023-11-29 15:05:47 +0100469 pk_type = pk_get_type_ext(key);
Hanno Becker493c1712019-02-01 10:07:07 +0000470
Valerio Setti81d75122023-06-14 14:49:33 +0200471#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Settibcc004b2023-11-29 17:16:55 +0100472 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
Valerio Settia4f70fe2023-11-29 15:05:47 +0100473 mbedtls_ecp_group_id ec_grp_id = mbedtls_pk_get_ec_group_id(key);
Valerio Settibcc004b2023-11-29 17:16:55 +0100474 if (MBEDTLS_PK_IS_RFC8410_GROUP_ID(ec_grp_id)) {
475 ret = mbedtls_oid_get_oid_by_ec_grp_algid(ec_grp_id, &oid, &oid_len);
476 if (ret != 0) {
477 return ret;
478 }
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200479 has_par = 0;
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200480 } else {
Valerio Settibcc004b2023-11-29 17:16:55 +0100481 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(&c, buf, ec_grp_id));
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200482 }
483 }
Valerio Setti81d75122023-06-14 14:49:33 +0200484#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200485
Valerio Settibcc004b2023-11-29 17:16:55 +0100486 /* At this point oid_len is not null only for EC Montgomery keys. */
Jethro Beekman01672442023-04-19 14:08:14 +0200487 if (oid_len == 0) {
Valerio Settibcc004b2023-11-29 17:16:55 +0100488 ret = mbedtls_oid_get_oid_by_pk_alg(pk_type, &oid, &oid_len);
489 if (ret != 0) {
Jethro Beekman01672442023-04-19 14:08:14 +0200490 return ret;
491 }
Hanno Becker493c1712019-02-01 10:07:07 +0000492 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200493
Jethro Beekman01672442023-04-19 14:08:14 +0200494 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_algorithm_identifier_ext(&c, buf, oid, oid_len,
495 par_len, has_par));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200496
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(&c, buf, len));
498 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(&c, buf, MBEDTLS_ASN1_CONSTRUCTED |
499 MBEDTLS_ASN1_SEQUENCE));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200500
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200502}
503
valerioc0bac572023-05-31 12:15:41 +0200504int mbedtls_pk_write_key_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
505{
506 unsigned char *c;
valerioc0bac572023-05-31 12:15:41 +0200507
508 if (size == 0) {
509 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
510 }
511
512 c = buf + size;
513
valerioc0bac572023-05-31 12:15:41 +0200514#if defined(MBEDTLS_RSA_C)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100515 if (pk_get_type_ext(key) == MBEDTLS_PK_RSA) {
valerioc0bac572023-05-31 12:15:41 +0200516 return pk_write_rsa_der(&c, buf, key);
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200518#endif /* MBEDTLS_RSA_C */
Valerio Setti81d75122023-06-14 14:49:33 +0200519#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100520 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
Jethro Beekman01672442023-04-19 14:08:14 +0200521#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
Valerio Setti00e8dd12023-05-18 18:56:59 +0200522 if (mbedtls_pk_is_rfc8410(key)) {
523 return pk_write_ec_rfc8410_der(&c, buf, key);
Jethro Beekman01672442023-04-19 14:08:14 +0200524 }
valerioc0bac572023-05-31 12:15:41 +0200525#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
526 return pk_write_ec_der(&c, buf, key);
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 } else
Valerio Setti81d75122023-06-14 14:49:33 +0200528#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200530}
531
Valerio Setti605f03c2023-11-28 12:46:39 +0100532/******************************************************************************
533 * Public functions for wrinting private/public PEM keys.
534 ******************************************************************************/
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200536
Neil Armstronge9ecd272022-03-01 10:03:21 +0100537#define PUB_DER_MAX_BYTES \
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 (MBEDTLS_PK_RSA_PUB_DER_MAX_BYTES > MBEDTLS_PK_ECP_PUB_DER_MAX_BYTES ? \
539 MBEDTLS_PK_RSA_PUB_DER_MAX_BYTES : MBEDTLS_PK_ECP_PUB_DER_MAX_BYTES)
Neil Armstronge9ecd272022-03-01 10:03:21 +0100540#define PRV_DER_MAX_BYTES \
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 (MBEDTLS_PK_RSA_PRV_DER_MAX_BYTES > MBEDTLS_PK_ECP_PRV_DER_MAX_BYTES ? \
542 MBEDTLS_PK_RSA_PRV_DER_MAX_BYTES : MBEDTLS_PK_ECP_PRV_DER_MAX_BYTES)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200543
Gilles Peskine449bd832023-01-11 14:50:10 +0100544int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200545{
Janos Follath24eed8d2019-11-22 13:21:35 +0000546 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Yanray Wang45ad3062023-08-11 15:03:51 +0800547 unsigned char *output_buf = NULL;
Yanray Wang08d5f462023-08-21 15:15:19 +0800548 output_buf = mbedtls_calloc(1, PUB_DER_MAX_BYTES);
Yanray Wang45ad3062023-08-11 15:03:51 +0800549 if (output_buf == NULL) {
550 return MBEDTLS_ERR_PK_ALLOC_FAILED;
551 }
Paul Bakker77e23fb2013-09-15 20:03:26 +0200552 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 if ((ret = mbedtls_pk_write_pubkey_der(key, output_buf,
Yanray Wang45ad3062023-08-11 15:03:51 +0800555 PUB_DER_MAX_BYTES)) < 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800556 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200557 }
558
Valerio Setti7f062a52023-12-04 16:29:56 +0100559 if ((ret = mbedtls_pem_write_buffer(PEM_BEGIN_PUBLIC_KEY "\n", PEM_END_PUBLIC_KEY "\n",
Yanray Wang45ad3062023-08-11 15:03:51 +0800560 output_buf + PUB_DER_MAX_BYTES - ret,
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 ret, buf, size, &olen)) != 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800562 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200563 }
564
Yanray Wang7226df02023-08-11 15:52:09 +0800565 ret = 0;
566cleanup:
Yanray Wang08d5f462023-08-21 15:15:19 +0800567 mbedtls_free(output_buf);
Yanray Wang7226df02023-08-11 15:52:09 +0800568 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200569}
570
Gilles Peskine449bd832023-01-11 14:50:10 +0100571int mbedtls_pk_write_key_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200572{
Janos Follath24eed8d2019-11-22 13:21:35 +0000573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Yanray Wangc84086e2023-08-11 15:33:07 +0800574 unsigned char *output_buf = NULL;
Yanray Wang08d5f462023-08-21 15:15:19 +0800575 output_buf = mbedtls_calloc(1, PRV_DER_MAX_BYTES);
Yanray Wangc84086e2023-08-11 15:33:07 +0800576 if (output_buf == NULL) {
577 return MBEDTLS_ERR_PK_ALLOC_FAILED;
578 }
Paul Bakkerfcc17212013-10-11 09:36:52 +0200579 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200580 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200581
Yanray Wangc84086e2023-08-11 15:33:07 +0800582 if ((ret = mbedtls_pk_write_key_der(key, output_buf, PRV_DER_MAX_BYTES)) < 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800583 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586#if defined(MBEDTLS_RSA_C)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100587 if (pk_get_type_ext(key) == MBEDTLS_PK_RSA) {
Valerio Setti7f062a52023-12-04 16:29:56 +0100588 begin = PEM_BEGIN_PRIVATE_KEY_RSA "\n";
589 end = PEM_END_PRIVATE_KEY_RSA "\n";
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200591#endif
Valerio Setti81d75122023-06-14 14:49:33 +0200592#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100593 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
594 if (mbedtls_pk_is_rfc8410(key)) {
Valerio Setti7f062a52023-12-04 16:29:56 +0100595 begin = PEM_BEGIN_PRIVATE_KEY_PKCS8 "\n";
596 end = PEM_END_PRIVATE_KEY_PKCS8 "\n";
Valerio Settia4f70fe2023-11-29 15:05:47 +0100597 } else {
Valerio Setti7f062a52023-12-04 16:29:56 +0100598 begin = PEM_BEGIN_PRIVATE_KEY_EC "\n";
599 end = PEM_END_PRIVATE_KEY_EC "\n";
Jethro Beekman01672442023-04-19 14:08:14 +0200600 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 } else
Valerio Setti81d75122023-06-14 14:49:33 +0200602#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Yanray Wangc84086e2023-08-11 15:33:07 +0800603 {
Yanray Wang7226df02023-08-11 15:52:09 +0800604 ret = MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
605 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200606 }
607
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200608 if ((ret = mbedtls_pem_write_buffer(begin, end,
Yanray Wangc84086e2023-08-11 15:33:07 +0800609 output_buf + PRV_DER_MAX_BYTES - ret,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200610 ret, buf, size, &olen)) != 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800611 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200612 }
613
Yanray Wang7226df02023-08-11 15:52:09 +0800614 ret = 0;
615cleanup:
Yanray Wang044eb162023-08-28 10:35:39 +0800616 mbedtls_zeroize_and_free(output_buf, PRV_DER_MAX_BYTES);
Yanray Wang7226df02023-08-11 15:52:09 +0800617 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200618}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621#endif /* MBEDTLS_PK_WRITE_C */