blob: 2a698448bee647add928d6e7b85d738c3f48fcaf [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 Setti5f1c8a72024-10-11 14:55:24 +020068 size_t 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 }
Valerio Setti5f1c8a72024-10-11 14:55:24 +020073 /* 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 }
Valerio Setti605f03c2023-11-28 12:46:39 +010078 *p -= tmp_len;
79 memcpy(*p, tmp, tmp_len);
Valerio Setti605f03c2023-11-28 12:46:39 +010080 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Valerio Setti605f03c2023-11-28 12:46:39 +010081
Valerio Setti5f1c8a72024-10-11 14:55:24 +020082 return (int) tmp_len;
Valerio Setti605f03c2023-11-28 12:46:39 +010083 }
Valerio Setti429cd502024-01-23 09:10:22 +010084#endif /* MBEDTLS_USE_PSA_CRYPTO */
Valerio Setti135ebde2024-02-01 17:00:29 +010085 return mbedtls_rsa_write_key(mbedtls_pk_rsa(*pk), buf, p);
Valerio Setti605f03c2023-11-28 12:46:39 +010086}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087#endif /* MBEDTLS_RSA_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020088
Valerio Setti605f03c2023-11-28 12:46:39 +010089/******************************************************************************
90 * Internal functions for EC keys.
91 ******************************************************************************/
Valerio Setti81d75122023-06-14 14:49:33 +020092#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
valerio9ea26172023-05-31 12:10:23 +020093#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +010094static int pk_write_ec_pubkey(unsigned char **p, unsigned char *start,
Valerio Setti4064dbb2023-05-17 15:33:07 +020095 const mbedtls_pk_context *pk)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020096{
Paul Bakkerc7bb02b2013-09-15 14:54:56 +020097 size_t len = 0;
Valerio Settid5604ba2023-11-28 14:10:43 +010098 uint8_t buf[PK_MAX_EC_PUBLIC_KEY_SIZE];
Valerio Setti4064dbb2023-05-17 15:33:07 +020099
valerio9ea26172023-05-31 12:10:23 +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;
valeriof9139e52023-05-31 18:01:33 +0200106 memcpy(buf, pk->pub_raw, len);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200107 }
108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 if (*p < start || (size_t) (*p - start) < len) {
110 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
111 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200112
113 *p -= len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 memcpy(*p, buf, len);
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200115
Gilles Peskine449bd832023-01-11 14:50:10 +0100116 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200117}
valerio9ea26172023-05-31 12:10:23 +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;
Valerio Settid5604ba2023-11-28 14:10:43 +0100123 unsigned char buf[PK_MAX_EC_PUBLIC_KEY_SIZE];
valerio9ea26172023-05-31 12:10:23 +0200124 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 }
Valerio Setti5f1c8a72024-10-11 14:55:24 +0200132 /* 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 }
valerio9ea26172023-05-31 12:10:23 +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 */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200159
160/*
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200161 * privateKey OCTET STRING -- always of length ceil(log2(n)/8)
162 */
valerio52b675f2023-05-31 12:14:37 +0200163#if defined(MBEDTLS_PK_USE_PSA_EC_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100164static int pk_write_ec_private(unsigned char **p, unsigned char *start,
Valerio Setti00e8dd12023-05-18 18:56:59 +0200165 const mbedtls_pk_context *pk)
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200166{
Valerio Setti00e8dd12023-05-18 18:56:59 +0200167 size_t byte_length;
Janos Follath24eed8d2019-11-22 13:21:35 +0000168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Valerio Settid5604ba2023-11-28 14:10:43 +0100169 unsigned char tmp[PK_MAX_EC_KEY_PAIR_SIZE];
Valerio Setti00e8dd12023-05-18 18:56:59 +0200170 psa_status_t status;
171
valerio52b675f2023-05-31 12:14:37 +0200172 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 }
Valerio Setti00e8dd12023-05-18 18:56:59 +0200184 }
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200185
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 ret = mbedtls_asn1_write_octet_string(p, start, tmp, byte_length);
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200187exit:
Valerio Setti00e8dd12023-05-18 18:56:59 +0200188 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return ret;
Gilles Peskine2700cfb2018-08-11 00:48:44 +0200190}
valerio52b675f2023-05-31 12:14:37 +0200191#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;
Valerio Settid5604ba2023-11-28 14:10:43 +0100197 unsigned char tmp[PK_MAX_EC_KEY_PAIR_SIZE];
valerio52b675f2023-05-31 12:14:37 +0200198
199#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Settid5604ba2023-11-28 14:10:43 +0100200 psa_status_t status;
valerio52b675f2023-05-31 12:14:37 +0200201 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
Gilles Peskine84b9f1b2024-02-19 16:44:29 +0100213 ret = mbedtls_ecp_write_key_ext(ec, &byte_length, tmp, sizeof(tmp));
valerio52b675f2023-05-31 12:14:37 +0200214 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 */
Valerio Setti605f03c2023-11-28 12:46:39 +0100224
225/*
226 * ECParameters ::= CHOICE {
227 * namedCurve OBJECT IDENTIFIER
228 * }
229 */
230static int pk_write_ec_param(unsigned char **p, unsigned char *start,
231 mbedtls_ecp_group_id grp_id)
232{
233 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
234 size_t len = 0;
235 const char *oid;
236 size_t oid_len;
237
238 if ((ret = mbedtls_oid_get_oid_by_ec_grp(grp_id, &oid, &oid_len)) != 0) {
239 return ret;
240 }
241
242 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_oid(p, start, oid, oid_len));
243
244 return (int) len;
245}
246
247#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
Valerio Setti605f03c2023-11-28 12:46:39 +0100248/*
249 * 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
262 */
263static int pk_write_ec_rfc8410_der(unsigned char **p, unsigned char *buf,
264 const mbedtls_pk_context *pk)
265{
266 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
267 size_t len = 0;
268 size_t oid_len = 0;
269 const char *oid;
270 mbedtls_ecp_group_id grp_id;
271
272 /* 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
Valerio Settif9362b72023-11-29 08:42:27 +0100277 grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Setti605f03c2023-11-28 12:46:39 +0100278 /* privateKeyAlgorithm */
279 if ((ret = mbedtls_oid_get_oid_by_ec_grp_algid(grp_id, &oid, &oid_len)) != 0) {
280 return ret;
281 }
282 MBEDTLS_ASN1_CHK_ADD(len,
283 mbedtls_asn1_write_algorithm_identifier_ext(p, buf, oid, oid_len, 0, 0));
284
285 /* 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;
293}
294#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
295
296/*
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 */
Valerio Settif9362b72023-11-29 08:42:27 +0100334 grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Setti605f03c2023-11-28 12:46:39 +0100335 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}
Valerio Setti81d75122023-06-14 14:49:33 +0200354#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200355
Valerio Setti605f03c2023-11-28 12:46:39 +0100356/******************************************************************************
357 * Internal functions for Opaque keys.
358 ******************************************************************************/
valerio9ea26172023-05-31 12:10:23 +0200359#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
Valerio Setti605f03c2023-11-28 12:46:39 +0100383/******************************************************************************
Valerio Settia4f70fe2023-11-29 15:05:47 +0100384 * 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 {
Valerio Settiad6d0162023-11-30 08:10:36 +0100409 return MBEDTLS_PK_NONE;
Valerio Settia4f70fe2023-11-29 15:05:47 +0100410 }
411 } else
412#endif
413 return pk_type;
414}
415
416/******************************************************************************
Valerio Setti605f03c2023-11-28 12:46:39 +0100417 * Public functions for writing private/public DER keys.
418 ******************************************************************************/
Gilles Peskine449bd832023-01-11 14:50:10 +0100419int mbedtls_pk_write_pubkey(unsigned char **p, unsigned char *start,
420 const mbedtls_pk_context *key)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200421{
Janos Follath24eed8d2019-11-22 13:21:35 +0000422 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200423 size_t len = 0;
424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_RSA) {
Valerio Setti135ebde2024-02-01 17:00:29 +0100427 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_rsa_write_pubkey(mbedtls_pk_rsa(*key), start, p));
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200429#endif
Valerio Setti81d75122023-06-14 14:49:33 +0200430#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_ECKEY) {
Valerio Setti4064dbb2023-05-17 15:33:07 +0200432 MBEDTLS_ASN1_CHK_ADD(len, pk_write_ec_pubkey(p, start, key));
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200434#endif
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500435#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 if (mbedtls_pk_get_type(key) == MBEDTLS_PK_OPAQUE) {
valerio9ea26172023-05-31 12:10:23 +0200437 MBEDTLS_ASN1_CHK_ADD(len, pk_write_opaque_pubkey(p, start, key));
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 } else
Andrzej Kurek5fec0862018-11-19 10:07:36 -0500439#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200441
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200443}
444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445int mbedtls_pk_write_pubkey_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200446{
Janos Follath24eed8d2019-11-22 13:21:35 +0000447 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200448 unsigned char *c;
Jethro Beekman01672442023-04-19 14:08:14 +0200449 int has_par = 1;
450 size_t len = 0, par_len = 0, oid_len = 0;
Hanno Becker493c1712019-02-01 10:07:07 +0000451 mbedtls_pk_type_t pk_type;
correya15b4852023-09-21 16:19:11 +0800452 const char *oid = NULL;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200453
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 if (size == 0) {
455 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
456 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500457
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200458 c = buf + size;
459
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_pk_write_pubkey(&c, buf, key));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 if (c - buf < 1) {
463 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
464 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200465
466 /*
467 * SubjectPublicKeyInfo ::= SEQUENCE {
468 * algorithm AlgorithmIdentifier,
469 * subjectPublicKey BIT STRING }
470 */
471 *--c = 0;
472 len += 1;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 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));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200476
Valerio Settia4f70fe2023-11-29 15:05:47 +0100477 pk_type = pk_get_type_ext(key);
Hanno Becker493c1712019-02-01 10:07:07 +0000478
Valerio Setti81d75122023-06-14 14:49:33 +0200479#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Settibcc004b2023-11-29 17:16:55 +0100480 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
Valerio Settia4f70fe2023-11-29 15:05:47 +0100481 mbedtls_ecp_group_id ec_grp_id = mbedtls_pk_get_ec_group_id(key);
Valerio Settibcc004b2023-11-29 17:16:55 +0100482 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);
484 if (ret != 0) {
485 return ret;
486 }
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200487 has_par = 0;
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200488 } else {
Valerio Settibcc004b2023-11-29 17:16:55 +0100489 MBEDTLS_ASN1_CHK_ADD(par_len, pk_write_ec_param(&c, buf, ec_grp_id));
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200490 }
491 }
Valerio Setti81d75122023-06-14 14:49:33 +0200492#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jethro Beekman8e59ebb2023-05-03 13:05:33 +0200493
Valerio Settibcc004b2023-11-29 17:16:55 +0100494 /* At this point oid_len is not null only for EC Montgomery keys. */
Jethro Beekman01672442023-04-19 14:08:14 +0200495 if (oid_len == 0) {
Valerio Settibcc004b2023-11-29 17:16:55 +0100496 ret = mbedtls_oid_get_oid_by_pk_alg(pk_type, &oid, &oid_len);
497 if (ret != 0) {
Jethro Beekman01672442023-04-19 14:08:14 +0200498 return ret;
499 }
Hanno Becker493c1712019-02-01 10:07:07 +0000500 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200501
Jethro Beekman01672442023-04-19 14:08:14 +0200502 MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_algorithm_identifier_ext(&c, buf, oid, oid_len,
503 par_len, has_par));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200504
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 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));
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200508
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 return (int) len;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200510}
511
valerioc0bac572023-05-31 12:15:41 +0200512int mbedtls_pk_write_key_der(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
513{
514 unsigned char *c;
valerioc0bac572023-05-31 12:15:41 +0200515
516 if (size == 0) {
517 return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
518 }
519
520 c = buf + size;
521
valerioc0bac572023-05-31 12:15:41 +0200522#if defined(MBEDTLS_RSA_C)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100523 if (pk_get_type_ext(key) == MBEDTLS_PK_RSA) {
valerioc0bac572023-05-31 12:15:41 +0200524 return pk_write_rsa_der(&c, buf, key);
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526#endif /* MBEDTLS_RSA_C */
Valerio Setti81d75122023-06-14 14:49:33 +0200527#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100528 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
Jethro Beekman01672442023-04-19 14:08:14 +0200529#if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
Valerio Setti00e8dd12023-05-18 18:56:59 +0200530 if (mbedtls_pk_is_rfc8410(key)) {
531 return pk_write_ec_rfc8410_der(&c, buf, key);
Jethro Beekman01672442023-04-19 14:08:14 +0200532 }
valerioc0bac572023-05-31 12:15:41 +0200533#endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
534 return pk_write_ec_der(&c, buf, key);
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 } else
Valerio Setti81d75122023-06-14 14:49:33 +0200536#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200538}
539
Valerio Setti605f03c2023-11-28 12:46:39 +0100540/******************************************************************************
541 * Public functions for wrinting private/public PEM keys.
542 ******************************************************************************/
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200544
Neil Armstronge9ecd272022-03-01 10:03:21 +0100545#define PUB_DER_MAX_BYTES \
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 (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)
Neil Armstronge9ecd272022-03-01 10:03:21 +0100548#define PRV_DER_MAX_BYTES \
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 (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)
Manuel Pégourié-Gonnard192253a2014-07-21 16:37:15 +0200551
Gilles Peskine449bd832023-01-11 14:50:10 +0100552int mbedtls_pk_write_pubkey_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200553{
Janos Follath24eed8d2019-11-22 13:21:35 +0000554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Yanray Wang45ad3062023-08-11 15:03:51 +0800555 unsigned char *output_buf = NULL;
Yanray Wang08d5f462023-08-21 15:15:19 +0800556 output_buf = mbedtls_calloc(1, PUB_DER_MAX_BYTES);
Yanray Wang45ad3062023-08-11 15:03:51 +0800557 if (output_buf == NULL) {
558 return MBEDTLS_ERR_PK_ALLOC_FAILED;
559 }
Paul Bakker77e23fb2013-09-15 20:03:26 +0200560 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200561
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 if ((ret = mbedtls_pk_write_pubkey_der(key, output_buf,
Yanray Wang45ad3062023-08-11 15:03:51 +0800563 PUB_DER_MAX_BYTES)) < 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800564 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200565 }
566
Valerio Setti7f062a52023-12-04 16:29:56 +0100567 if ((ret = mbedtls_pem_write_buffer(PEM_BEGIN_PUBLIC_KEY "\n", PEM_END_PUBLIC_KEY "\n",
Yanray Wang45ad3062023-08-11 15:03:51 +0800568 output_buf + PUB_DER_MAX_BYTES - ret,
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 ret, buf, size, &olen)) != 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800570 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200571 }
572
Yanray Wang7226df02023-08-11 15:52:09 +0800573 ret = 0;
574cleanup:
Yanray Wang08d5f462023-08-21 15:15:19 +0800575 mbedtls_free(output_buf);
Yanray Wang7226df02023-08-11 15:52:09 +0800576 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200577}
578
Gilles Peskine449bd832023-01-11 14:50:10 +0100579int mbedtls_pk_write_key_pem(const mbedtls_pk_context *key, unsigned char *buf, size_t size)
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200580{
Janos Follath24eed8d2019-11-22 13:21:35 +0000581 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Yanray Wangc84086e2023-08-11 15:33:07 +0800582 unsigned char *output_buf = NULL;
Yanray Wang08d5f462023-08-21 15:15:19 +0800583 output_buf = mbedtls_calloc(1, PRV_DER_MAX_BYTES);
Yanray Wangc84086e2023-08-11 15:33:07 +0800584 if (output_buf == NULL) {
585 return MBEDTLS_ERR_PK_ALLOC_FAILED;
586 }
Paul Bakkerfcc17212013-10-11 09:36:52 +0200587 const char *begin, *end;
Paul Bakker77e23fb2013-09-15 20:03:26 +0200588 size_t olen = 0;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200589
Yanray Wangc84086e2023-08-11 15:33:07 +0800590 if ((ret = mbedtls_pk_write_key_der(key, output_buf, PRV_DER_MAX_BYTES)) < 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800591 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 }
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#if defined(MBEDTLS_RSA_C)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100595 if (pk_get_type_ext(key) == MBEDTLS_PK_RSA) {
Valerio Setti7f062a52023-12-04 16:29:56 +0100596 begin = PEM_BEGIN_PRIVATE_KEY_RSA "\n";
597 end = PEM_END_PRIVATE_KEY_RSA "\n";
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 } else
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200599#endif
Valerio Setti81d75122023-06-14 14:49:33 +0200600#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Valerio Settia4f70fe2023-11-29 15:05:47 +0100601 if (pk_get_type_ext(key) == MBEDTLS_PK_ECKEY) {
602 if (mbedtls_pk_is_rfc8410(key)) {
Valerio Setti7f062a52023-12-04 16:29:56 +0100603 begin = PEM_BEGIN_PRIVATE_KEY_PKCS8 "\n";
604 end = PEM_END_PRIVATE_KEY_PKCS8 "\n";
Valerio Settia4f70fe2023-11-29 15:05:47 +0100605 } else {
Valerio Setti7f062a52023-12-04 16:29:56 +0100606 begin = PEM_BEGIN_PRIVATE_KEY_EC "\n";
607 end = PEM_END_PRIVATE_KEY_EC "\n";
Jethro Beekman01672442023-04-19 14:08:14 +0200608 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 } else
Valerio Setti81d75122023-06-14 14:49:33 +0200610#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Yanray Wangc84086e2023-08-11 15:33:07 +0800611 {
Yanray Wang7226df02023-08-11 15:52:09 +0800612 ret = MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
613 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200614 }
615
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200616 if ((ret = mbedtls_pem_write_buffer(begin, end,
Yanray Wangc84086e2023-08-11 15:33:07 +0800617 output_buf + PRV_DER_MAX_BYTES - ret,
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200618 ret, buf, size, &olen)) != 0) {
Yanray Wang7226df02023-08-11 15:52:09 +0800619 goto cleanup;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200620 }
621
Yanray Wang7226df02023-08-11 15:52:09 +0800622 ret = 0;
623cleanup:
Yanray Wang044eb162023-08-28 10:35:39 +0800624 mbedtls_zeroize_and_free(output_buf, PRV_DER_MAX_BYTES);
Yanray Wang7226df02023-08-11 15:52:09 +0800625 return ret;
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200626}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#endif /* MBEDTLS_PEM_WRITE_C */
Paul Bakkerc7bb02b2013-09-15 14:54:56 +0200628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629#endif /* MBEDTLS_PK_WRITE_C */