blob: 990b55452227b33ca4b6bcf171dfdc9cdd5e7056 [file] [log] [blame]
Paul Bakker1a7550a2013-09-15 13:01:22 +02001/*
2 * Public Key layer for parsing 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 Bakker1a7550a2013-09-15 13:01:22 +020018 */
19
Gilles Peskinedb09ef62020-06-03 01:43:33 +020020#include "common.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if defined(MBEDTLS_PK_PARSE_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +020023
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000024#include "mbedtls/pk.h"
25#include "mbedtls/asn1.h"
26#include "mbedtls/oid.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050027#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000028#include "mbedtls/error.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +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 Bakker1a7550a2013-09-15 13:01:22 +020034#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/ecp.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020037#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/ecdsa.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020040#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if defined(MBEDTLS_PEM_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000042#include "mbedtls/pem.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020043#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#if defined(MBEDTLS_PKCS5_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000045#include "mbedtls/pkcs5.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020046#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#if defined(MBEDTLS_PKCS12_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/pkcs12.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020049#endif
50
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000051#include "mbedtls/platform.h"
Paul Bakker1a7550a2013-09-15 13:01:22 +020052
Gilles Peskine832f3492017-11-30 11:42:12 +010053#if defined(MBEDTLS_FS_IO)
Paul Bakker1a7550a2013-09-15 13:01:22 +020054/*
55 * Load all data from a file into a given buffer.
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +020056 *
57 * The file is expected to contain either PEM or DER encoded data.
58 * A terminating null byte is always appended. It is included in the announced
59 * length only if the data looks like it is PEM encoded.
Paul Bakker1a7550a2013-09-15 13:01:22 +020060 */
David Horstmann8b6068b2023-01-05 15:42:32 +000061int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n)
Paul Bakker1a7550a2013-09-15 13:01:22 +020062{
63 FILE *f;
64 long size;
65
David Horstmann8b6068b2023-01-05 15:42:32 +000066 if ((f = fopen(path, "rb")) == NULL) {
67 return MBEDTLS_ERR_PK_FILE_IO_ERROR;
68 }
Paul Bakker1a7550a2013-09-15 13:01:22 +020069
Gilles Peskineda0913b2022-06-30 17:03:40 +020070 /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */
David Horstmann8b6068b2023-01-05 15:42:32 +000071 mbedtls_setbuf(f, NULL);
Gilles Peskineda0913b2022-06-30 17:03:40 +020072
David Horstmann8b6068b2023-01-05 15:42:32 +000073 fseek(f, 0, SEEK_END);
74 if ((size = ftell(f)) == -1) {
75 fclose(f);
76 return MBEDTLS_ERR_PK_FILE_IO_ERROR;
Paul Bakker1a7550a2013-09-15 13:01:22 +020077 }
David Horstmann8b6068b2023-01-05 15:42:32 +000078 fseek(f, 0, SEEK_SET);
Paul Bakker1a7550a2013-09-15 13:01:22 +020079
80 *n = (size_t) size;
81
David Horstmann8b6068b2023-01-05 15:42:32 +000082 if (*n + 1 == 0 ||
83 (*buf = mbedtls_calloc(1, *n + 1)) == NULL) {
84 fclose(f);
85 return MBEDTLS_ERR_PK_ALLOC_FAILED;
Paul Bakker1a7550a2013-09-15 13:01:22 +020086 }
87
David Horstmann8b6068b2023-01-05 15:42:32 +000088 if (fread(*buf, 1, *n, f) != *n) {
89 fclose(f);
Andres Amaya Garcia1f2666f2017-06-26 10:36:20 +010090
David Horstmann8b6068b2023-01-05 15:42:32 +000091 mbedtls_platform_zeroize(*buf, *n);
92 mbedtls_free(*buf);
Andres Amaya Garcia1f2666f2017-06-26 10:36:20 +010093
David Horstmann8b6068b2023-01-05 15:42:32 +000094 return MBEDTLS_ERR_PK_FILE_IO_ERROR;
Paul Bakker1a7550a2013-09-15 13:01:22 +020095 }
96
David Horstmann8b6068b2023-01-05 15:42:32 +000097 fclose(f);
Paul Bakker1a7550a2013-09-15 13:01:22 +020098
99 (*buf)[*n] = '\0';
100
David Horstmann8b6068b2023-01-05 15:42:32 +0000101 if (strstr((const char *) *buf, "-----BEGIN ") != NULL) {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200102 ++*n;
David Horstmann8b6068b2023-01-05 15:42:32 +0000103 }
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200104
David Horstmann8b6068b2023-01-05 15:42:32 +0000105 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200106}
107
108/*
109 * Load and parse a private key
110 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000111int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx,
112 const char *path, const char *pwd,
113 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200114{
Janos Follath24eed8d2019-11-22 13:21:35 +0000115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200116 size_t n;
117 unsigned char *buf;
118
David Horstmann8b6068b2023-01-05 15:42:32 +0000119 if ((ret = mbedtls_pk_load_file(path, &buf, &n)) != 0) {
120 return ret;
121 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200122
David Horstmann8b6068b2023-01-05 15:42:32 +0000123 if (pwd == NULL) {
124 ret = mbedtls_pk_parse_key(ctx, buf, n, NULL, 0, f_rng, p_rng);
125 } else {
126 ret = mbedtls_pk_parse_key(ctx, buf, n,
127 (const unsigned char *) pwd, strlen(pwd), f_rng, p_rng);
128 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200129
David Horstmann8b6068b2023-01-05 15:42:32 +0000130 mbedtls_platform_zeroize(buf, n);
131 mbedtls_free(buf);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200132
David Horstmann8b6068b2023-01-05 15:42:32 +0000133 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200134}
135
136/*
137 * Load and parse a public key
138 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000139int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200140{
Janos Follath24eed8d2019-11-22 13:21:35 +0000141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200142 size_t n;
143 unsigned char *buf;
144
David Horstmann8b6068b2023-01-05 15:42:32 +0000145 if ((ret = mbedtls_pk_load_file(path, &buf, &n)) != 0) {
146 return ret;
147 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200148
David Horstmann8b6068b2023-01-05 15:42:32 +0000149 ret = mbedtls_pk_parse_public_key(ctx, buf, n);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200150
David Horstmann8b6068b2023-01-05 15:42:32 +0000151 mbedtls_platform_zeroize(buf, n);
152 mbedtls_free(buf);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200153
David Horstmann8b6068b2023-01-05 15:42:32 +0000154 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200155}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156#endif /* MBEDTLS_FS_IO */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158#if defined(MBEDTLS_ECP_C)
159/* Minimally parse an ECParameters buffer to and mbedtls_asn1_buf
Paul Bakker1a7550a2013-09-15 13:01:22 +0200160 *
161 * ECParameters ::= CHOICE {
162 * namedCurve OBJECT IDENTIFIER
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100163 * specifiedCurve SpecifiedECDomain -- = SEQUENCE { ... }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200164 * -- implicitCurve NULL
Paul Bakker1a7550a2013-09-15 13:01:22 +0200165 * }
166 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000167static int pk_get_ecparams(unsigned char **p, const unsigned char *end,
168 mbedtls_asn1_buf *params)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200169{
Janos Follath24eed8d2019-11-22 13:21:35 +0000170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200171
David Horstmann8b6068b2023-01-05 15:42:32 +0000172 if (end - *p < 1) {
173 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
174 MBEDTLS_ERR_ASN1_OUT_OF_DATA);
175 }
Sanne Woudab2b29d52017-08-21 15:58:12 +0100176
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100177 /* Tag may be either OID or SEQUENCE */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200178 params->tag = **p;
David Horstmann8b6068b2023-01-05 15:42:32 +0000179 if (params->tag != MBEDTLS_ASN1_OID
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#if defined(MBEDTLS_PK_PARSE_EC_EXTENDED)
David Horstmann8b6068b2023-01-05 15:42:32 +0000181 && params->tag != (MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100182#endif
David Horstmann8b6068b2023-01-05 15:42:32 +0000183 ) {
184 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
185 MBEDTLS_ERR_ASN1_UNEXPECTED_TAG);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100186 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200187
David Horstmann8b6068b2023-01-05 15:42:32 +0000188 if ((ret = mbedtls_asn1_get_tag(p, end, &params->len, params->tag)) != 0) {
189 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100190 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200191
192 params->p = *p;
193 *p += params->len;
194
David Horstmann8b6068b2023-01-05 15:42:32 +0000195 if (*p != end) {
196 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
197 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
198 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200199
David Horstmann8b6068b2023-01-05 15:42:32 +0000200 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200201}
202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203#if defined(MBEDTLS_PK_PARSE_EC_EXTENDED)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200204/*
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100205 * Parse a SpecifiedECDomain (SEC 1 C.2) and (mostly) fill the group with it.
206 * WARNING: the resulting group should only be used with
207 * pk_group_id_from_specified(), since its base point may not be set correctly
208 * if it was encoded compressed.
209 *
210 * SpecifiedECDomain ::= SEQUENCE {
211 * version SpecifiedECDomainVersion(ecdpVer1 | ecdpVer2 | ecdpVer3, ...),
212 * fieldID FieldID {{FieldTypes}},
213 * curve Curve,
214 * base ECPoint,
215 * order INTEGER,
216 * cofactor INTEGER OPTIONAL,
217 * hash HashAlgorithm OPTIONAL,
218 * ...
219 * }
220 *
221 * We only support prime-field as field type, and ignore hash and cofactor.
222 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000223static int pk_group_from_specified(const mbedtls_asn1_buf *params, mbedtls_ecp_group *grp)
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100224{
Janos Follath24eed8d2019-11-22 13:21:35 +0000225 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100226 unsigned char *p = params->p;
227 const unsigned char * const end = params->p + params->len;
228 const unsigned char *end_field, *end_curve;
229 size_t len;
230 int ver;
231
232 /* SpecifiedECDomainVersion ::= INTEGER { 1, 2, 3 } */
David Horstmann8b6068b2023-01-05 15:42:32 +0000233 if ((ret = mbedtls_asn1_get_int(&p, end, &ver)) != 0) {
234 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
235 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100236
David Horstmann8b6068b2023-01-05 15:42:32 +0000237 if (ver < 1 || ver > 3) {
238 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
239 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100240
241 /*
242 * FieldID { FIELD-ID:IOSet } ::= SEQUENCE { -- Finite field
243 * fieldType FIELD-ID.&id({IOSet}),
244 * parameters FIELD-ID.&Type({IOSet}{@fieldType})
245 * }
246 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000247 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
248 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
249 return ret;
250 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100251
252 end_field = p + len;
253
254 /*
255 * FIELD-ID ::= TYPE-IDENTIFIER
256 * FieldTypes FIELD-ID ::= {
257 * { Prime-p IDENTIFIED BY prime-field } |
258 * { Characteristic-two IDENTIFIED BY characteristic-two-field }
259 * }
260 * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
261 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000262 if ((ret = mbedtls_asn1_get_tag(&p, end_field, &len, MBEDTLS_ASN1_OID)) != 0) {
263 return ret;
264 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100265
David Horstmann8b6068b2023-01-05 15:42:32 +0000266 if (len != MBEDTLS_OID_SIZE(MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD) ||
267 memcmp(p, MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD, len) != 0) {
268 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100269 }
270
271 p += len;
272
273 /* Prime-p ::= INTEGER -- Field of size p. */
David Horstmann8b6068b2023-01-05 15:42:32 +0000274 if ((ret = mbedtls_asn1_get_mpi(&p, end_field, &grp->P)) != 0) {
275 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
276 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100277
David Horstmann8b6068b2023-01-05 15:42:32 +0000278 grp->pbits = mbedtls_mpi_bitlen(&grp->P);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100279
David Horstmann8b6068b2023-01-05 15:42:32 +0000280 if (p != end_field) {
281 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
282 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
283 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100284
285 /*
286 * Curve ::= SEQUENCE {
287 * a FieldElement,
288 * b FieldElement,
289 * seed BIT STRING OPTIONAL
290 * -- Shall be present if used in SpecifiedECDomain
291 * -- with version equal to ecdpVer2 or ecdpVer3
292 * }
293 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000294 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
295 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
296 return ret;
297 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100298
299 end_curve = p + len;
300
301 /*
302 * FieldElement ::= OCTET STRING
303 * containing an integer in the case of a prime field
304 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000305 if ((ret = mbedtls_asn1_get_tag(&p, end_curve, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0 ||
306 (ret = mbedtls_mpi_read_binary(&grp->A, p, len)) != 0) {
307 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100308 }
309
310 p += len;
311
David Horstmann8b6068b2023-01-05 15:42:32 +0000312 if ((ret = mbedtls_asn1_get_tag(&p, end_curve, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0 ||
313 (ret = mbedtls_mpi_read_binary(&grp->B, p, len)) != 0) {
314 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100315 }
316
317 p += len;
318
319 /* Ignore seed BIT STRING OPTIONAL */
David Horstmann8b6068b2023-01-05 15:42:32 +0000320 if ((ret = mbedtls_asn1_get_tag(&p, end_curve, &len, MBEDTLS_ASN1_BIT_STRING)) == 0) {
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100321 p += len;
David Horstmann8b6068b2023-01-05 15:42:32 +0000322 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100323
David Horstmann8b6068b2023-01-05 15:42:32 +0000324 if (p != end_curve) {
325 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
326 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
327 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100328
329 /*
330 * ECPoint ::= OCTET STRING
331 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000332 if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
333 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
334 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100335
David Horstmann8b6068b2023-01-05 15:42:32 +0000336 if ((ret = mbedtls_ecp_point_read_binary(grp, &grp->G,
337 (const unsigned char *) p, len)) != 0) {
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100338 /*
339 * If we can't read the point because it's compressed, cheat by
340 * reading only the X coordinate and the parity bit of Y.
341 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000342 if (ret != MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE ||
343 (p[0] != 0x02 && p[0] != 0x03) ||
344 len != mbedtls_mpi_size(&grp->P) + 1 ||
345 mbedtls_mpi_read_binary(&grp->G.X, p + 1, len - 1) != 0 ||
346 mbedtls_mpi_lset(&grp->G.Y, p[0] - 2) != 0 ||
347 mbedtls_mpi_lset(&grp->G.Z, 1) != 0) {
348 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100349 }
350 }
351
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100352 p += len;
353
354 /*
355 * order INTEGER
356 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000357 if ((ret = mbedtls_asn1_get_mpi(&p, end, &grp->N)) != 0) {
358 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
359 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100360
David Horstmann8b6068b2023-01-05 15:42:32 +0000361 grp->nbits = mbedtls_mpi_bitlen(&grp->N);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100362
363 /*
364 * Allow optional elements by purposefully not enforcing p == end here.
365 */
366
David Horstmann8b6068b2023-01-05 15:42:32 +0000367 return 0;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100368}
369
370/*
371 * Find the group id associated with an (almost filled) group as generated by
372 * pk_group_from_specified(), or return an error if unknown.
373 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000374static int pk_group_id_from_group(const mbedtls_ecp_group *grp, mbedtls_ecp_group_id *grp_id)
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100375{
Manuel Pégourié-Gonnard5b8c4092014-03-27 14:59:42 +0100376 int ret = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377 mbedtls_ecp_group ref;
378 const mbedtls_ecp_group_id *id;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100379
David Horstmann8b6068b2023-01-05 15:42:32 +0000380 mbedtls_ecp_group_init(&ref);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100381
David Horstmann8b6068b2023-01-05 15:42:32 +0000382 for (id = mbedtls_ecp_grp_id_list(); *id != MBEDTLS_ECP_DP_NONE; id++) {
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100383 /* Load the group associated to that id */
David Horstmann8b6068b2023-01-05 15:42:32 +0000384 mbedtls_ecp_group_free(&ref);
385 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ref, *id));
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100386
387 /* Compare to the group we were given, starting with easy tests */
David Horstmann8b6068b2023-01-05 15:42:32 +0000388 if (grp->pbits == ref.pbits && grp->nbits == ref.nbits &&
389 mbedtls_mpi_cmp_mpi(&grp->P, &ref.P) == 0 &&
390 mbedtls_mpi_cmp_mpi(&grp->A, &ref.A) == 0 &&
391 mbedtls_mpi_cmp_mpi(&grp->B, &ref.B) == 0 &&
392 mbedtls_mpi_cmp_mpi(&grp->N, &ref.N) == 0 &&
393 mbedtls_mpi_cmp_mpi(&grp->G.X, &ref.G.X) == 0 &&
394 mbedtls_mpi_cmp_mpi(&grp->G.Z, &ref.G.Z) == 0 &&
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100395 /* For Y we may only know the parity bit, so compare only that */
David Horstmann8b6068b2023-01-05 15:42:32 +0000396 mbedtls_mpi_get_bit(&grp->G.Y, 0) == mbedtls_mpi_get_bit(&ref.G.Y, 0)) {
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100397 break;
398 }
399
400 }
401
402cleanup:
David Horstmann8b6068b2023-01-05 15:42:32 +0000403 mbedtls_ecp_group_free(&ref);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100404
405 *grp_id = *id;
406
David Horstmann8b6068b2023-01-05 15:42:32 +0000407 if (ret == 0 && *id == MBEDTLS_ECP_DP_NONE) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408 ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
David Horstmann8b6068b2023-01-05 15:42:32 +0000409 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100410
David Horstmann8b6068b2023-01-05 15:42:32 +0000411 return ret;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100412}
413
414/*
415 * Parse a SpecifiedECDomain (SEC 1 C.2) and find the associated group ID
416 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000417static int pk_group_id_from_specified(const mbedtls_asn1_buf *params,
418 mbedtls_ecp_group_id *grp_id)
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100419{
Janos Follath24eed8d2019-11-22 13:21:35 +0000420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200421 mbedtls_ecp_group grp;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100422
David Horstmann8b6068b2023-01-05 15:42:32 +0000423 mbedtls_ecp_group_init(&grp);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100424
David Horstmann8b6068b2023-01-05 15:42:32 +0000425 if ((ret = pk_group_from_specified(params, &grp)) != 0) {
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100426 goto cleanup;
David Horstmann8b6068b2023-01-05 15:42:32 +0000427 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100428
David Horstmann8b6068b2023-01-05 15:42:32 +0000429 ret = pk_group_id_from_group(&grp, grp_id);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100430
431cleanup:
David Horstmann8b6068b2023-01-05 15:42:32 +0000432 mbedtls_ecp_group_free(&grp);
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100433
David Horstmann8b6068b2023-01-05 15:42:32 +0000434 return ret;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100435}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200436#endif /* MBEDTLS_PK_PARSE_EC_EXTENDED */
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100437
438/*
Paul Bakker1a7550a2013-09-15 13:01:22 +0200439 * Use EC parameters to initialise an EC group
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100440 *
441 * ECParameters ::= CHOICE {
442 * namedCurve OBJECT IDENTIFIER
443 * specifiedCurve SpecifiedECDomain -- = SEQUENCE { ... }
444 * -- implicitCurve NULL
Paul Bakker1a7550a2013-09-15 13:01:22 +0200445 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000446static int pk_use_ecparams(const mbedtls_asn1_buf *params, mbedtls_ecp_group *grp)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200447{
Janos Follath24eed8d2019-11-22 13:21:35 +0000448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200449 mbedtls_ecp_group_id grp_id;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200450
David Horstmann8b6068b2023-01-05 15:42:32 +0000451 if (params->tag == MBEDTLS_ASN1_OID) {
452 if (mbedtls_oid_get_ec_grp(params, &grp_id) != 0) {
453 return MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE;
454 }
455 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456#if defined(MBEDTLS_PK_PARSE_EC_EXTENDED)
David Horstmann8b6068b2023-01-05 15:42:32 +0000457 if ((ret = pk_group_id_from_specified(params, &grp_id)) != 0) {
458 return ret;
459 }
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100460#else
David Horstmann8b6068b2023-01-05 15:42:32 +0000461 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100462#endif
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100463 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200464
465 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800466 * grp may already be initialized; if so, make sure IDs match
Paul Bakker1a7550a2013-09-15 13:01:22 +0200467 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000468 if (grp->id != MBEDTLS_ECP_DP_NONE && grp->id != grp_id) {
469 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
470 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200471
David Horstmann8b6068b2023-01-05 15:42:32 +0000472 if ((ret = mbedtls_ecp_group_load(grp, grp_id)) != 0) {
473 return ret;
474 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200475
David Horstmann8b6068b2023-01-05 15:42:32 +0000476 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200477}
478
479/*
480 * EC public key is an EC point
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100481 *
482 * The caller is responsible for clearing the structure upon failure if
483 * desired. Take care to pass along the possible ECP_FEATURE_UNAVAILABLE
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484 * return code of mbedtls_ecp_point_read_binary() and leave p in a usable state.
Paul Bakker1a7550a2013-09-15 13:01:22 +0200485 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000486static int pk_get_ecpubkey(unsigned char **p, const unsigned char *end,
487 mbedtls_ecp_keypair *key)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200488{
Janos Follath24eed8d2019-11-22 13:21:35 +0000489 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200490
David Horstmann8b6068b2023-01-05 15:42:32 +0000491 if ((ret = mbedtls_ecp_point_read_binary(&key->grp, &key->Q,
492 (const unsigned char *) *p, end - *p)) == 0) {
493 ret = mbedtls_ecp_check_pubkey(&key->grp, &key->Q);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200494 }
495
496 /*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497 * We know mbedtls_ecp_point_read_binary consumed all bytes or failed
Paul Bakker1a7550a2013-09-15 13:01:22 +0200498 */
499 *p = (unsigned char *) end;
500
David Horstmann8b6068b2023-01-05 15:42:32 +0000501 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200502}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503#endif /* MBEDTLS_ECP_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200504
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505#if defined(MBEDTLS_RSA_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200506/*
507 * RSAPublicKey ::= SEQUENCE {
508 * modulus INTEGER, -- n
509 * publicExponent INTEGER -- e
510 * }
511 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000512static int pk_get_rsapubkey(unsigned char **p,
513 const unsigned char *end,
514 mbedtls_rsa_context *rsa)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200515{
Janos Follath24eed8d2019-11-22 13:21:35 +0000516 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200517 size_t len;
518
David Horstmann8b6068b2023-01-05 15:42:32 +0000519 if ((ret = mbedtls_asn1_get_tag(p, end, &len,
520 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
521 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY, ret);
522 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200523
David Horstmann8b6068b2023-01-05 15:42:32 +0000524 if (*p + len != end) {
525 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
526 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
527 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200528
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100529 /* Import N */
David Horstmann8b6068b2023-01-05 15:42:32 +0000530 if ((ret = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_INTEGER)) != 0) {
531 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY, ret);
532 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200533
David Horstmann8b6068b2023-01-05 15:42:32 +0000534 if ((ret = mbedtls_rsa_import_raw(rsa, *p, len, NULL, 0, NULL, 0,
535 NULL, 0, NULL, 0)) != 0) {
536 return MBEDTLS_ERR_PK_INVALID_PUBKEY;
537 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100538
539 *p += len;
540
541 /* Import E */
David Horstmann8b6068b2023-01-05 15:42:32 +0000542 if ((ret = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_INTEGER)) != 0) {
543 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY, ret);
544 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100545
David Horstmann8b6068b2023-01-05 15:42:32 +0000546 if ((ret = mbedtls_rsa_import_raw(rsa, NULL, 0, NULL, 0, NULL, 0,
547 NULL, 0, *p, len)) != 0) {
548 return MBEDTLS_ERR_PK_INVALID_PUBKEY;
549 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100550
551 *p += len;
552
David Horstmann8b6068b2023-01-05 15:42:32 +0000553 if (mbedtls_rsa_complete(rsa) != 0 ||
554 mbedtls_rsa_check_pubkey(rsa) != 0) {
555 return MBEDTLS_ERR_PK_INVALID_PUBKEY;
Hanno Becker895c5ab2018-01-05 08:08:09 +0000556 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100557
David Horstmann8b6068b2023-01-05 15:42:32 +0000558 if (*p != end) {
559 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
560 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
561 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200562
David Horstmann8b6068b2023-01-05 15:42:32 +0000563 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200564}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565#endif /* MBEDTLS_RSA_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200566
567/* Get a PK algorithm identifier
568 *
569 * AlgorithmIdentifier ::= SEQUENCE {
570 * algorithm OBJECT IDENTIFIER,
571 * parameters ANY DEFINED BY algorithm OPTIONAL }
572 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000573static int pk_get_pk_alg(unsigned char **p,
574 const unsigned char *end,
575 mbedtls_pk_type_t *pk_alg, mbedtls_asn1_buf *params)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200576{
Janos Follath24eed8d2019-11-22 13:21:35 +0000577 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578 mbedtls_asn1_buf alg_oid;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200579
David Horstmann8b6068b2023-01-05 15:42:32 +0000580 memset(params, 0, sizeof(mbedtls_asn1_buf));
Paul Bakker1a7550a2013-09-15 13:01:22 +0200581
David Horstmann8b6068b2023-01-05 15:42:32 +0000582 if ((ret = mbedtls_asn1_get_alg(p, end, &alg_oid, params)) != 0) {
583 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_ALG, ret);
584 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200585
David Horstmann8b6068b2023-01-05 15:42:32 +0000586 if (mbedtls_oid_get_pk_alg(&alg_oid, pk_alg) != 0) {
587 return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
588 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200589
590 /*
591 * No parameters with RSA (only for EC)
592 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000593 if (*pk_alg == MBEDTLS_PK_RSA &&
594 ((params->tag != MBEDTLS_ASN1_NULL && params->tag != 0) ||
595 params->len != 0)) {
596 return MBEDTLS_ERR_PK_INVALID_ALG;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200597 }
598
David Horstmann8b6068b2023-01-05 15:42:32 +0000599 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200600}
601
602/*
603 * SubjectPublicKeyInfo ::= SEQUENCE {
604 * algorithm AlgorithmIdentifier,
605 * subjectPublicKey BIT STRING }
606 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000607int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end,
608 mbedtls_pk_context *pk)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200609{
Janos Follath24eed8d2019-11-22 13:21:35 +0000610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200611 size_t len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 mbedtls_asn1_buf alg_params;
613 mbedtls_pk_type_t pk_alg = MBEDTLS_PK_NONE;
614 const mbedtls_pk_info_t *pk_info;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200615
David Horstmann8b6068b2023-01-05 15:42:32 +0000616 if ((ret = mbedtls_asn1_get_tag(p, end, &len,
617 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
618 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200619 }
620
621 end = *p + len;
622
David Horstmann8b6068b2023-01-05 15:42:32 +0000623 if ((ret = pk_get_pk_alg(p, end, &pk_alg, &alg_params)) != 0) {
624 return ret;
625 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200626
David Horstmann8b6068b2023-01-05 15:42:32 +0000627 if ((ret = mbedtls_asn1_get_bitstring_null(p, end, &len)) != 0) {
628 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY, ret);
629 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200630
David Horstmann8b6068b2023-01-05 15:42:32 +0000631 if (*p + len != end) {
632 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
633 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
634 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200635
David Horstmann8b6068b2023-01-05 15:42:32 +0000636 if ((pk_info = mbedtls_pk_info_from_type(pk_alg)) == NULL) {
637 return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
638 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200639
David Horstmann8b6068b2023-01-05 15:42:32 +0000640 if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0) {
641 return ret;
642 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644#if defined(MBEDTLS_RSA_C)
David Horstmann8b6068b2023-01-05 15:42:32 +0000645 if (pk_alg == MBEDTLS_PK_RSA) {
646 ret = pk_get_rsapubkey(p, end, mbedtls_pk_rsa(*pk));
Paul Bakker1a7550a2013-09-15 13:01:22 +0200647 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#endif /* MBEDTLS_RSA_C */
649#if defined(MBEDTLS_ECP_C)
David Horstmann8b6068b2023-01-05 15:42:32 +0000650 if (pk_alg == MBEDTLS_PK_ECKEY_DH || pk_alg == MBEDTLS_PK_ECKEY) {
651 ret = pk_use_ecparams(&alg_params, &mbedtls_pk_ec(*pk)->grp);
652 if (ret == 0) {
653 ret = pk_get_ecpubkey(p, end, mbedtls_pk_ec(*pk));
654 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200655 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656#endif /* MBEDTLS_ECP_C */
David Horstmann8b6068b2023-01-05 15:42:32 +0000657 ret = MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200658
David Horstmann8b6068b2023-01-05 15:42:32 +0000659 if (ret == 0 && *p != end) {
660 ret = MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
661 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
662 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200663
David Horstmann8b6068b2023-01-05 15:42:32 +0000664 if (ret != 0) {
665 mbedtls_pk_free(pk);
666 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200667
David Horstmann8b6068b2023-01-05 15:42:32 +0000668 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200669}
670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671#if defined(MBEDTLS_RSA_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200672/*
Manuel Pégourié-Gonnarda04a2c32020-02-18 10:12:14 +0100673 * Wrapper around mbedtls_asn1_get_mpi() that rejects zero.
674 *
675 * The value zero is:
676 * - never a valid value for an RSA parameter
677 * - interpreted as "omitted, please reconstruct" by mbedtls_rsa_complete().
678 *
679 * Since values can't be omitted in PKCS#1, passing a zero value to
680 * rsa_complete() would be incorrect, so reject zero values early.
681 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000682static int asn1_get_nonzero_mpi(unsigned char **p,
683 const unsigned char *end,
684 mbedtls_mpi *X)
Manuel Pégourié-Gonnarda04a2c32020-02-18 10:12:14 +0100685{
686 int ret;
687
David Horstmann8b6068b2023-01-05 15:42:32 +0000688 ret = mbedtls_asn1_get_mpi(p, end, X);
689 if (ret != 0) {
690 return ret;
691 }
Manuel Pégourié-Gonnarda04a2c32020-02-18 10:12:14 +0100692
David Horstmann8b6068b2023-01-05 15:42:32 +0000693 if (mbedtls_mpi_cmp_int(X, 0) == 0) {
694 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
695 }
Manuel Pégourié-Gonnarda04a2c32020-02-18 10:12:14 +0100696
David Horstmann8b6068b2023-01-05 15:42:32 +0000697 return 0;
Manuel Pégourié-Gonnarda04a2c32020-02-18 10:12:14 +0100698}
699
700/*
Paul Bakker1a7550a2013-09-15 13:01:22 +0200701 * Parse a PKCS#1 encoded private RSA key
702 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000703static int pk_parse_key_pkcs1_der(mbedtls_rsa_context *rsa,
704 const unsigned char *key,
705 size_t keylen)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200706{
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100707 int ret, version;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200708 size_t len;
709 unsigned char *p, *end;
710
Hanno Beckerefa14e82017-10-11 19:45:19 +0100711 mbedtls_mpi T;
David Horstmann8b6068b2023-01-05 15:42:32 +0000712 mbedtls_mpi_init(&T);
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100713
Paul Bakker1a7550a2013-09-15 13:01:22 +0200714 p = (unsigned char *) key;
715 end = p + keylen;
716
717 /*
718 * This function parses the RSAPrivateKey (PKCS#1)
719 *
720 * RSAPrivateKey ::= SEQUENCE {
721 * version Version,
722 * modulus INTEGER, -- n
723 * publicExponent INTEGER, -- e
724 * privateExponent INTEGER, -- d
725 * prime1 INTEGER, -- p
726 * prime2 INTEGER, -- q
727 * exponent1 INTEGER, -- d mod (p-1)
728 * exponent2 INTEGER, -- d mod (q-1)
729 * coefficient INTEGER, -- (inverse of q) mod p
730 * otherPrimeInfos OtherPrimeInfos OPTIONAL
731 * }
732 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000733 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
734 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
735 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200736 }
737
738 end = p + len;
739
David Horstmann8b6068b2023-01-05 15:42:32 +0000740 if ((ret = mbedtls_asn1_get_int(&p, end, &version)) != 0) {
741 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200742 }
743
David Horstmann8b6068b2023-01-05 15:42:32 +0000744 if (version != 0) {
745 return MBEDTLS_ERR_PK_KEY_INVALID_VERSION;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200746 }
747
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100748 /* Import N */
David Horstmann8b6068b2023-01-05 15:42:32 +0000749 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
750 (ret = mbedtls_rsa_import(rsa, &T, NULL, NULL,
751 NULL, NULL)) != 0) {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100752 goto cleanup;
David Horstmann8b6068b2023-01-05 15:42:32 +0000753 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200754
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100755 /* Import E */
David Horstmann8b6068b2023-01-05 15:42:32 +0000756 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
757 (ret = mbedtls_rsa_import(rsa, NULL, NULL, NULL,
758 NULL, &T)) != 0) {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100759 goto cleanup;
David Horstmann8b6068b2023-01-05 15:42:32 +0000760 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100761
762 /* Import D */
David Horstmann8b6068b2023-01-05 15:42:32 +0000763 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
764 (ret = mbedtls_rsa_import(rsa, NULL, NULL, NULL,
765 &T, NULL)) != 0) {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100766 goto cleanup;
David Horstmann8b6068b2023-01-05 15:42:32 +0000767 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100768
769 /* Import P */
David Horstmann8b6068b2023-01-05 15:42:32 +0000770 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
771 (ret = mbedtls_rsa_import(rsa, NULL, &T, NULL,
772 NULL, NULL)) != 0) {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100773 goto cleanup;
David Horstmann8b6068b2023-01-05 15:42:32 +0000774 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100775
776 /* Import Q */
David Horstmann8b6068b2023-01-05 15:42:32 +0000777 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
778 (ret = mbedtls_rsa_import(rsa, NULL, NULL, &T,
779 NULL, NULL)) != 0) {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100780 goto cleanup;
David Horstmann8b6068b2023-01-05 15:42:32 +0000781 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100782
Manuel Pégourié-Gonnardbbb5a0a2020-02-18 10:22:54 +0100783#if !defined(MBEDTLS_RSA_NO_CRT) && !defined(MBEDTLS_RSA_ALT)
Jack Lloyd8c2631b2020-01-23 17:23:52 -0500784 /*
David Horstmann8b6068b2023-01-05 15:42:32 +0000785 * The RSA CRT parameters DP, DQ and QP are nominally redundant, in
786 * that they can be easily recomputed from D, P and Q. However by
787 * parsing them from the PKCS1 structure it is possible to avoid
788 * recalculating them which both reduces the overhead of loading
789 * RSA private keys into memory and also avoids side channels which
790 * can arise when computing those values, since all of D, P, and Q
791 * are secret. See https://eprint.iacr.org/2020/055 for a
792 * description of one such attack.
793 */
Jack Lloyd8c2631b2020-01-23 17:23:52 -0500794
Jack Lloyd80cc8112020-01-22 17:34:29 -0500795 /* Import DP */
David Horstmann8b6068b2023-01-05 15:42:32 +0000796 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
797 (ret = mbedtls_mpi_copy(&rsa->DP, &T)) != 0) {
798 goto cleanup;
799 }
Jack Lloyd80cc8112020-01-22 17:34:29 -0500800
801 /* Import DQ */
David Horstmann8b6068b2023-01-05 15:42:32 +0000802 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
803 (ret = mbedtls_mpi_copy(&rsa->DQ, &T)) != 0) {
804 goto cleanup;
805 }
Jack Lloyd80cc8112020-01-22 17:34:29 -0500806
807 /* Import QP */
David Horstmann8b6068b2023-01-05 15:42:32 +0000808 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
809 (ret = mbedtls_mpi_copy(&rsa->QP, &T)) != 0) {
810 goto cleanup;
811 }
Jack Lloyd2e9eef42020-01-28 14:43:52 -0500812
Jack Lloyd60239752020-01-27 17:53:36 -0500813#else
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800814 /* Verify existence of the CRT params */
David Horstmann8b6068b2023-01-05 15:42:32 +0000815 if ((ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
816 (ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0 ||
817 (ret = asn1_get_nonzero_mpi(&p, end, &T)) != 0) {
818 goto cleanup;
819 }
Jack Lloyd60239752020-01-27 17:53:36 -0500820#endif
Jack Lloyd80cc8112020-01-22 17:34:29 -0500821
Manuel Pégourié-Gonnardc4226792020-02-14 11:28:47 +0100822 /* rsa_complete() doesn't complete anything with the default
823 * implementation but is still called:
824 * - for the benefit of alternative implementation that may want to
825 * pre-compute stuff beyond what's provided (eg Montgomery factors)
826 * - as is also sanity-checks the key
827 *
828 * Furthermore, we also check the public part for consistency with
829 * mbedtls_pk_parse_pubkey(), as it includes size minima for example.
830 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000831 if ((ret = mbedtls_rsa_complete(rsa)) != 0 ||
832 (ret = mbedtls_rsa_check_pubkey(rsa)) != 0) {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100833 goto cleanup;
Manuel Pégourié-Gonnardc4226792020-02-14 11:28:47 +0100834 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100835
David Horstmann8b6068b2023-01-05 15:42:32 +0000836 if (p != end) {
837 ret = MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
838 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200839 }
840
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100841cleanup:
842
David Horstmann8b6068b2023-01-05 15:42:32 +0000843 mbedtls_mpi_free(&T);
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100844
David Horstmann8b6068b2023-01-05 15:42:32 +0000845 if (ret != 0) {
Hanno Beckerefa14e82017-10-11 19:45:19 +0100846 /* Wrap error code if it's coming from a lower level */
David Horstmann8b6068b2023-01-05 15:42:32 +0000847 if ((ret & 0xff80) == 0) {
848 ret = MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
849 } else {
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100850 ret = MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
David Horstmann8b6068b2023-01-05 15:42:32 +0000851 }
Hanno Beckerd58c5b22017-08-22 14:33:21 +0100852
David Horstmann8b6068b2023-01-05 15:42:32 +0000853 mbedtls_rsa_free(rsa);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200854 }
855
David Horstmann8b6068b2023-01-05 15:42:32 +0000856 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200857}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858#endif /* MBEDTLS_RSA_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860#if defined(MBEDTLS_ECP_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200861/*
862 * Parse a SEC1 encoded private EC key
863 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000864static int pk_parse_key_sec1_der(mbedtls_ecp_keypair *eck,
865 const unsigned char *key, size_t keylen,
866 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Paul Bakker1a7550a2013-09-15 13:01:22 +0200867{
Janos Follath24eed8d2019-11-22 13:21:35 +0000868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100869 int version, pubkey_done;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200870 size_t len;
Leonid Rozenboima3008e72022-04-21 17:28:18 -0700871 mbedtls_asn1_buf params = { 0, 0, NULL };
Paul Bakker1a7550a2013-09-15 13:01:22 +0200872 unsigned char *p = (unsigned char *) key;
873 unsigned char *end = p + keylen;
874 unsigned char *end2;
875
876 /*
877 * RFC 5915, or SEC1 Appendix C.4
878 *
879 * ECPrivateKey ::= SEQUENCE {
880 * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
881 * privateKey OCTET STRING,
882 * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
883 * publicKey [1] BIT STRING OPTIONAL
884 * }
885 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000886 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
887 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
888 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200889 }
890
891 end = p + len;
892
David Horstmann8b6068b2023-01-05 15:42:32 +0000893 if ((ret = mbedtls_asn1_get_int(&p, end, &version)) != 0) {
894 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
895 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200896
David Horstmann8b6068b2023-01-05 15:42:32 +0000897 if (version != 1) {
898 return MBEDTLS_ERR_PK_KEY_INVALID_VERSION;
899 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200900
David Horstmann8b6068b2023-01-05 15:42:32 +0000901 if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
902 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
903 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200904
David Horstmann8b6068b2023-01-05 15:42:32 +0000905 if ((ret = mbedtls_mpi_read_binary(&eck->d, p, len)) != 0) {
906 mbedtls_ecp_keypair_free(eck);
907 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +0200908 }
909
910 p += len;
911
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200912 pubkey_done = 0;
David Horstmann8b6068b2023-01-05 15:42:32 +0000913 if (p != end) {
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200914 /*
915 * Is 'parameters' present?
916 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000917 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
918 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED |
919 0)) == 0) {
920 if ((ret = pk_get_ecparams(&p, p + len, &params)) != 0 ||
921 (ret = pk_use_ecparams(&params, &eck->grp)) != 0) {
922 mbedtls_ecp_keypair_free(eck);
923 return ret;
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200924 }
David Horstmann8b6068b2023-01-05 15:42:32 +0000925 } else if (ret != MBEDTLS_ERR_ASN1_UNEXPECTED_TAG) {
926 mbedtls_ecp_keypair_free(eck);
927 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Manuel Pégourié-Gonnard5246ee52014-03-19 16:18:38 +0100928 }
Jethro Beekmand2df9362018-02-16 13:11:04 -0800929 }
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200930
David Horstmann8b6068b2023-01-05 15:42:32 +0000931 if (p != end) {
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200932 /*
933 * Is 'publickey' present? If not, or if we can't read it (eg because it
934 * is compressed), create it from the private key.
935 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000936 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
937 MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED |
938 1)) == 0) {
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200939 end2 = p + len;
940
David Horstmann8b6068b2023-01-05 15:42:32 +0000941 if ((ret = mbedtls_asn1_get_bitstring_null(&p, end2, &len)) != 0) {
942 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
943 }
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200944
David Horstmann8b6068b2023-01-05 15:42:32 +0000945 if (p + len != end2) {
946 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
947 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
948 }
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200949
David Horstmann8b6068b2023-01-05 15:42:32 +0000950 if ((ret = pk_get_ecpubkey(&p, end2, eck)) == 0) {
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200951 pubkey_done = 1;
David Horstmann8b6068b2023-01-05 15:42:32 +0000952 } else {
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200953 /*
954 * The only acceptable failure mode of pk_get_ecpubkey() above
955 * is if the point format is not recognized.
956 */
David Horstmann8b6068b2023-01-05 15:42:32 +0000957 if (ret != MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE) {
958 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
959 }
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200960 }
David Horstmann8b6068b2023-01-05 15:42:32 +0000961 } else if (ret != MBEDTLS_ERR_ASN1_UNEXPECTED_TAG) {
962 mbedtls_ecp_keypair_free(eck);
963 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Manuel Pégourié-Gonnard924cd102015-04-14 11:18:04 +0200964 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200965 }
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100966
David Horstmann8b6068b2023-01-05 15:42:32 +0000967 if (!pubkey_done &&
968 (ret = mbedtls_ecp_mul(&eck->grp, &eck->Q, &eck->d, &eck->grp.G,
969 f_rng, p_rng)) != 0) {
970 mbedtls_ecp_keypair_free(eck);
971 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Manuel Pégourié-Gonnardff29f9c2013-09-18 16:13:02 +0200972 }
Paul Bakker1a7550a2013-09-15 13:01:22 +0200973
David Horstmann8b6068b2023-01-05 15:42:32 +0000974 if ((ret = mbedtls_ecp_check_privkey(&eck->grp, &eck->d)) != 0) {
975 mbedtls_ecp_keypair_free(eck);
976 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200977 }
978
David Horstmann8b6068b2023-01-05 15:42:32 +0000979 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +0200980}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#endif /* MBEDTLS_ECP_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +0200982
983/*
984 * Parse an unencrypted PKCS#8 encoded private key
Hanno Beckerb4274212017-09-29 19:18:51 +0100985 *
986 * Notes:
987 *
988 * - This function does not own the key buffer. It is the
989 * responsibility of the caller to take care of zeroizing
990 * and freeing it after use.
991 *
992 * - The function is responsible for freeing the provided
993 * PK context on failure.
994 *
Paul Bakker1a7550a2013-09-15 13:01:22 +0200995 */
996static int pk_parse_key_pkcs8_unencrypted_der(
David Horstmann8b6068b2023-01-05 15:42:32 +0000997 mbedtls_pk_context *pk,
998 const unsigned char *key, size_t keylen,
999 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001000{
1001 int ret, version;
1002 size_t len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 mbedtls_asn1_buf params;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001004 unsigned char *p = (unsigned char *) key;
1005 unsigned char *end = p + keylen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 mbedtls_pk_type_t pk_alg = MBEDTLS_PK_NONE;
1007 const mbedtls_pk_info_t *pk_info;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001008
Manuel Pégourié-Gonnard609ab642021-06-16 14:29:11 +02001009#if !defined(MBEDTLS_ECP_C)
1010 (void) f_rng;
1011 (void) p_rng;
1012#endif
1013
Paul Bakker1a7550a2013-09-15 13:01:22 +02001014 /*
Hanno Becker9c6cb382017-09-05 10:08:01 +01001015 * This function parses the PrivateKeyInfo object (PKCS#8 v1.2 = RFC 5208)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001016 *
1017 * PrivateKeyInfo ::= SEQUENCE {
1018 * version Version,
1019 * privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
1020 * privateKey PrivateKey,
1021 * attributes [0] IMPLICIT Attributes OPTIONAL }
1022 *
1023 * Version ::= INTEGER
1024 * PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
1025 * PrivateKey ::= OCTET STRING
1026 *
1027 * The PrivateKey OCTET STRING is a SEC1 ECPrivateKey
1028 */
1029
David Horstmann8b6068b2023-01-05 15:42:32 +00001030 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
1031 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
1032 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001033 }
1034
1035 end = p + len;
1036
David Horstmann8b6068b2023-01-05 15:42:32 +00001037 if ((ret = mbedtls_asn1_get_int(&p, end, &version)) != 0) {
1038 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Chris Jonesfdb588b2021-04-14 18:15:24 +01001039 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001040
David Horstmann8b6068b2023-01-05 15:42:32 +00001041 if (version != 0) {
1042 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_VERSION, ret);
1043 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001044
David Horstmann8b6068b2023-01-05 15:42:32 +00001045 if ((ret = pk_get_pk_alg(&p, end, &pk_alg, &params)) != 0) {
1046 return ret;
1047 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001048
David Horstmann8b6068b2023-01-05 15:42:32 +00001049 if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
1050 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
1051 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001052
David Horstmann8b6068b2023-01-05 15:42:32 +00001053 if (len < 1) {
1054 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
1055 MBEDTLS_ERR_ASN1_OUT_OF_DATA);
1056 }
1057
1058 if ((pk_info = mbedtls_pk_info_from_type(pk_alg)) == NULL) {
1059 return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
1060 }
1061
1062 if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0) {
1063 return ret;
1064 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#if defined(MBEDTLS_RSA_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001067 if (pk_alg == MBEDTLS_PK_RSA) {
1068 if ((ret = pk_parse_key_pkcs1_der(mbedtls_pk_rsa(*pk), p, len)) != 0) {
1069 mbedtls_pk_free(pk);
1070 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001071 }
1072 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073#endif /* MBEDTLS_RSA_C */
1074#if defined(MBEDTLS_ECP_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001075 if (pk_alg == MBEDTLS_PK_ECKEY || pk_alg == MBEDTLS_PK_ECKEY_DH) {
1076 if ((ret = pk_use_ecparams(&params, &mbedtls_pk_ec(*pk)->grp)) != 0 ||
1077 (ret = pk_parse_key_sec1_der(mbedtls_pk_ec(*pk), p, len, f_rng, p_rng)) != 0) {
1078 mbedtls_pk_free(pk);
1079 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001080 }
1081 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082#endif /* MBEDTLS_ECP_C */
David Horstmann8b6068b2023-01-05 15:42:32 +00001083 return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001084
David Horstmann8b6068b2023-01-05 15:42:32 +00001085 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001086}
1087
1088/*
1089 * Parse an encrypted PKCS#8 encoded private key
Hanno Beckerb4274212017-09-29 19:18:51 +01001090 *
1091 * To save space, the decryption happens in-place on the given key buffer.
1092 * Also, while this function may modify the keybuffer, it doesn't own it,
1093 * and instead it is the responsibility of the caller to zeroize and properly
1094 * free it after use.
1095 *
Paul Bakker1a7550a2013-09-15 13:01:22 +02001096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097#if defined(MBEDTLS_PKCS12_C) || defined(MBEDTLS_PKCS5_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001098static int pk_parse_key_pkcs8_encrypted_der(
David Horstmann8b6068b2023-01-05 15:42:32 +00001099 mbedtls_pk_context *pk,
1100 unsigned char *key, size_t keylen,
1101 const unsigned char *pwd, size_t pwdlen,
1102 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001103{
Paul Bakkerf4cf80b2014-04-17 17:19:56 +02001104 int ret, decrypted = 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001105 size_t len;
Hanno Beckerfab35692017-08-25 13:38:26 +01001106 unsigned char *buf;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001107 unsigned char *p, *end;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 mbedtls_asn1_buf pbe_alg_oid, pbe_params;
1109#if defined(MBEDTLS_PKCS12_C)
1110 mbedtls_cipher_type_t cipher_alg;
1111 mbedtls_md_type_t md_alg;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001112#endif
1113
Hanno Becker2aa80a72017-09-07 15:28:45 +01001114 p = key;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001115 end = p + keylen;
1116
David Horstmann8b6068b2023-01-05 15:42:32 +00001117 if (pwdlen == 0) {
1118 return MBEDTLS_ERR_PK_PASSWORD_REQUIRED;
1119 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001120
1121 /*
Hanno Beckerf04111f2017-09-29 19:18:42 +01001122 * This function parses the EncryptedPrivateKeyInfo object (PKCS#8)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001123 *
1124 * EncryptedPrivateKeyInfo ::= SEQUENCE {
1125 * encryptionAlgorithm EncryptionAlgorithmIdentifier,
1126 * encryptedData EncryptedData
1127 * }
1128 *
1129 * EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier
1130 *
1131 * EncryptedData ::= OCTET STRING
1132 *
1133 * The EncryptedData OCTET STRING is a PKCS#8 PrivateKeyInfo
Hanno Beckerb8d16572017-09-07 15:29:01 +01001134 *
Paul Bakker1a7550a2013-09-15 13:01:22 +02001135 */
David Horstmann8b6068b2023-01-05 15:42:32 +00001136 if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
1137 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
1138 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001139 }
1140
1141 end = p + len;
1142
David Horstmann8b6068b2023-01-05 15:42:32 +00001143 if ((ret = mbedtls_asn1_get_alg(&p, end, &pbe_alg_oid, &pbe_params)) != 0) {
1144 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
1145 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001146
David Horstmann8b6068b2023-01-05 15:42:32 +00001147 if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
1148 return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
1149 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001150
Hanno Beckerfab35692017-08-25 13:38:26 +01001151 buf = p;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001152
1153 /*
Hanno Beckerb8d16572017-09-07 15:29:01 +01001154 * Decrypt EncryptedData with appropriate PBE
Paul Bakker1a7550a2013-09-15 13:01:22 +02001155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156#if defined(MBEDTLS_PKCS12_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001157 if (mbedtls_oid_get_pkcs12_pbe_alg(&pbe_alg_oid, &md_alg, &cipher_alg) == 0) {
1158 if ((ret = mbedtls_pkcs12_pbe(&pbe_params, MBEDTLS_PKCS12_PBE_DECRYPT,
1159 cipher_alg, md_alg,
1160 pwd, pwdlen, p, len, buf)) != 0) {
1161 if (ret == MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH) {
1162 return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
1163 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001164
David Horstmann8b6068b2023-01-05 15:42:32 +00001165 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001166 }
Paul Bakkerf4cf80b2014-04-17 17:19:56 +02001167
1168 decrypted = 1;
David Horstmann8b6068b2023-01-05 15:42:32 +00001169 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170#endif /* MBEDTLS_PKCS12_C */
1171#if defined(MBEDTLS_PKCS5_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001172 if (MBEDTLS_OID_CMP(MBEDTLS_OID_PKCS5_PBES2, &pbe_alg_oid) == 0) {
1173 if ((ret = mbedtls_pkcs5_pbes2(&pbe_params, MBEDTLS_PKCS5_DECRYPT, pwd, pwdlen,
1174 p, len, buf)) != 0) {
1175 if (ret == MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH) {
1176 return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
1177 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001178
David Horstmann8b6068b2023-01-05 15:42:32 +00001179 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001180 }
Paul Bakkerf4cf80b2014-04-17 17:19:56 +02001181
1182 decrypted = 1;
David Horstmann8b6068b2023-01-05 15:42:32 +00001183 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#endif /* MBEDTLS_PKCS5_C */
Manuel Pégourié-Gonnard1032c1d2013-09-18 17:18:34 +02001185 {
1186 ((void) pwd);
Manuel Pégourié-Gonnard1032c1d2013-09-18 17:18:34 +02001187 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001188
David Horstmann8b6068b2023-01-05 15:42:32 +00001189 if (decrypted == 0) {
1190 return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
1191 }
Paul Bakkerf4cf80b2014-04-17 17:19:56 +02001192
David Horstmann8b6068b2023-01-05 15:42:32 +00001193 return pk_parse_key_pkcs8_unencrypted_der(pk, buf, len, f_rng, p_rng);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001194}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195#endif /* MBEDTLS_PKCS12_C || MBEDTLS_PKCS5_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001196
1197/*
1198 * Parse a private key
1199 */
David Horstmann8b6068b2023-01-05 15:42:32 +00001200int mbedtls_pk_parse_key(mbedtls_pk_context *pk,
1201 const unsigned char *key, size_t keylen,
1202 const unsigned char *pwd, size_t pwdlen,
1203 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001204{
Janos Follath24eed8d2019-11-22 13:21:35 +00001205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 const mbedtls_pk_info_t *pk_info;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207#if defined(MBEDTLS_PEM_PARSE_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001208 size_t len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 mbedtls_pem_context pem;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001210#endif
Paul Bakker1a7550a2013-09-15 13:01:22 +02001211
David Horstmann8b6068b2023-01-05 15:42:32 +00001212 if (keylen == 0) {
1213 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
1214 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001215
1216#if defined(MBEDTLS_PEM_PARSE_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001217 mbedtls_pem_init(&pem);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001220 /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
David Horstmann8b6068b2023-01-05 15:42:32 +00001221 if (key[keylen - 1] != '\0') {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001222 ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
David Horstmann8b6068b2023-01-05 15:42:32 +00001223 } else {
1224 ret = mbedtls_pem_read_buffer(&pem,
1225 "-----BEGIN RSA PRIVATE KEY-----",
1226 "-----END RSA PRIVATE KEY-----",
1227 key, pwd, pwdlen, &len);
1228 }
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001229
David Horstmann8b6068b2023-01-05 15:42:32 +00001230 if (ret == 0) {
1231 pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA);
1232 if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0 ||
1233 (ret = pk_parse_key_pkcs1_der(mbedtls_pk_rsa(*pk),
1234 pem.buf, pem.buflen)) != 0) {
1235 mbedtls_pk_free(pk);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001236 }
1237
David Horstmann8b6068b2023-01-05 15:42:32 +00001238 mbedtls_pem_free(&pem);
1239 return ret;
1240 } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_MISMATCH) {
1241 return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
1242 } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_REQUIRED) {
1243 return MBEDTLS_ERR_PK_PASSWORD_REQUIRED;
1244 } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
1245 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001246 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247#endif /* MBEDTLS_RSA_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001249#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001250 /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
David Horstmann8b6068b2023-01-05 15:42:32 +00001251 if (key[keylen - 1] != '\0') {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001252 ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
David Horstmann8b6068b2023-01-05 15:42:32 +00001253 } else {
1254 ret = mbedtls_pem_read_buffer(&pem,
1255 "-----BEGIN EC PRIVATE KEY-----",
1256 "-----END EC PRIVATE KEY-----",
1257 key, pwd, pwdlen, &len);
1258 }
1259 if (ret == 0) {
1260 pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_ECKEY);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001261
David Horstmann8b6068b2023-01-05 15:42:32 +00001262 if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0 ||
1263 (ret = pk_parse_key_sec1_der(mbedtls_pk_ec(*pk),
1264 pem.buf, pem.buflen,
1265 f_rng, p_rng)) != 0) {
1266 mbedtls_pk_free(pk);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001267 }
1268
David Horstmann8b6068b2023-01-05 15:42:32 +00001269 mbedtls_pem_free(&pem);
1270 return ret;
1271 } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_MISMATCH) {
1272 return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
1273 } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_REQUIRED) {
1274 return MBEDTLS_ERR_PK_PASSWORD_REQUIRED;
1275 } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
1276 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001277 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278#endif /* MBEDTLS_ECP_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001279
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001280 /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
David Horstmann8b6068b2023-01-05 15:42:32 +00001281 if (key[keylen - 1] != '\0') {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001282 ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
David Horstmann8b6068b2023-01-05 15:42:32 +00001283 } else {
1284 ret = mbedtls_pem_read_buffer(&pem,
1285 "-----BEGIN PRIVATE KEY-----",
1286 "-----END PRIVATE KEY-----",
1287 key, NULL, 0, &len);
1288 }
1289 if (ret == 0) {
1290 if ((ret = pk_parse_key_pkcs8_unencrypted_der(pk,
1291 pem.buf, pem.buflen, f_rng, p_rng)) != 0) {
1292 mbedtls_pk_free(pk);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001293 }
1294
David Horstmann8b6068b2023-01-05 15:42:32 +00001295 mbedtls_pem_free(&pem);
1296 return ret;
1297 } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
1298 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001299 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301#if defined(MBEDTLS_PKCS12_C) || defined(MBEDTLS_PKCS5_C)
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001302 /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
David Horstmann8b6068b2023-01-05 15:42:32 +00001303 if (key[keylen - 1] != '\0') {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001304 ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
David Horstmann8b6068b2023-01-05 15:42:32 +00001305 } else {
1306 ret = mbedtls_pem_read_buffer(&pem,
1307 "-----BEGIN ENCRYPTED PRIVATE KEY-----",
1308 "-----END ENCRYPTED PRIVATE KEY-----",
1309 key, NULL, 0, &len);
1310 }
1311 if (ret == 0) {
1312 if ((ret = pk_parse_key_pkcs8_encrypted_der(pk, pem.buf, pem.buflen,
1313 pwd, pwdlen, f_rng, p_rng)) != 0) {
1314 mbedtls_pk_free(pk);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001315 }
1316
David Horstmann8b6068b2023-01-05 15:42:32 +00001317 mbedtls_pem_free(&pem);
1318 return ret;
1319 } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
1320 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001321 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322#endif /* MBEDTLS_PKCS12_C || MBEDTLS_PKCS5_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001323#else
1324 ((void) pwd);
1325 ((void) pwdlen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326#endif /* MBEDTLS_PEM_PARSE_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001327
1328 /*
Brian J Murray2adecba2016-11-06 04:45:15 -08001329 * At this point we only know it's not a PEM formatted key. Could be any
1330 * of the known DER encoded private key formats
1331 *
1332 * We try the different DER format parsers to see if one passes without
1333 * error
1334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#if defined(MBEDTLS_PKCS12_C) || defined(MBEDTLS_PKCS5_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001336 if (pwdlen != 0) {
Hanno Beckerfab35692017-08-25 13:38:26 +01001337 unsigned char *key_copy;
1338
David Horstmann8b6068b2023-01-05 15:42:32 +00001339 if ((key_copy = mbedtls_calloc(1, keylen)) == NULL) {
1340 return MBEDTLS_ERR_PK_ALLOC_FAILED;
1341 }
Hanno Beckerfab35692017-08-25 13:38:26 +01001342
David Horstmann8b6068b2023-01-05 15:42:32 +00001343 memcpy(key_copy, key, keylen);
Hanno Beckerfab35692017-08-25 13:38:26 +01001344
David Horstmann8b6068b2023-01-05 15:42:32 +00001345 ret = pk_parse_key_pkcs8_encrypted_der(pk, key_copy, keylen,
1346 pwd, pwdlen, f_rng, p_rng);
Hanno Beckerfab35692017-08-25 13:38:26 +01001347
David Horstmann8b6068b2023-01-05 15:42:32 +00001348 mbedtls_platform_zeroize(key_copy, keylen);
1349 mbedtls_free(key_copy);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001350 }
1351
David Horstmann8b6068b2023-01-05 15:42:32 +00001352 if (ret == 0) {
1353 return 0;
1354 }
Hanno Beckerfab35692017-08-25 13:38:26 +01001355
David Horstmann8b6068b2023-01-05 15:42:32 +00001356 mbedtls_pk_free(pk);
1357 mbedtls_pk_init(pk);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001358
David Horstmann8b6068b2023-01-05 15:42:32 +00001359 if (ret == MBEDTLS_ERR_PK_PASSWORD_MISMATCH) {
1360 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001361 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001362#endif /* MBEDTLS_PKCS12_C || MBEDTLS_PKCS5_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001363
David Horstmann8b6068b2023-01-05 15:42:32 +00001364 ret = pk_parse_key_pkcs8_unencrypted_der(pk, key, keylen, f_rng, p_rng);
1365 if (ret == 0) {
1366 return 0;
Manuel Pégourié-Gonnard84dea012021-06-15 11:29:26 +02001367 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001368
David Horstmann8b6068b2023-01-05 15:42:32 +00001369 mbedtls_pk_free(pk);
1370 mbedtls_pk_init(pk);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001371
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001372#if defined(MBEDTLS_RSA_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001373
David Horstmann8b6068b2023-01-05 15:42:32 +00001374 pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA);
1375 if (mbedtls_pk_setup(pk, pk_info) == 0 &&
1376 pk_parse_key_pkcs1_der(mbedtls_pk_rsa(*pk), key, keylen) == 0) {
1377 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001378 }
1379
David Horstmann8b6068b2023-01-05 15:42:32 +00001380 mbedtls_pk_free(pk);
1381 mbedtls_pk_init(pk);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001382#endif /* MBEDTLS_RSA_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384#if defined(MBEDTLS_ECP_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001385 pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_ECKEY);
1386 if (mbedtls_pk_setup(pk, pk_info) == 0 &&
1387 pk_parse_key_sec1_der(mbedtls_pk_ec(*pk),
1388 key, keylen, f_rng, p_rng) == 0) {
1389 return 0;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001390 }
David Horstmann8b6068b2023-01-05 15:42:32 +00001391 mbedtls_pk_free(pk);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#endif /* MBEDTLS_ECP_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001393
Hanno Becker780f0a42018-10-10 11:23:33 +01001394 /* If MBEDTLS_RSA_C is defined but MBEDTLS_ECP_C isn't,
1395 * it is ok to leave the PK context initialized but not
1396 * freed: It is the caller's responsibility to call pk_init()
1397 * before calling this function, and to call pk_free()
1398 * when it fails. If MBEDTLS_ECP_C is defined but MBEDTLS_RSA_C
1399 * isn't, this leads to mbedtls_pk_free() being called
1400 * twice, once here and once by the caller, but this is
1401 * also ok and in line with the mbedtls_pk_free() calls
1402 * on failed PEM parsing attempts. */
1403
David Horstmann8b6068b2023-01-05 15:42:32 +00001404 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001405}
1406
1407/*
1408 * Parse a public key
1409 */
David Horstmann8b6068b2023-01-05 15:42:32 +00001410int mbedtls_pk_parse_public_key(mbedtls_pk_context *ctx,
1411 const unsigned char *key, size_t keylen)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001412{
Janos Follath24eed8d2019-11-22 13:21:35 +00001413 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001414 unsigned char *p;
Ron Eldor5472d432017-10-17 09:49:00 +03001415#if defined(MBEDTLS_RSA_C)
1416 const mbedtls_pk_info_t *pk_info;
1417#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418#if defined(MBEDTLS_PEM_PARSE_C)
Paul Bakker1a7550a2013-09-15 13:01:22 +02001419 size_t len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420 mbedtls_pem_context pem;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001421#endif
Paul Bakker1a7550a2013-09-15 13:01:22 +02001422
David Horstmann8b6068b2023-01-05 15:42:32 +00001423 if (keylen == 0) {
1424 return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
1425 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001426
1427#if defined(MBEDTLS_PEM_PARSE_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001428 mbedtls_pem_init(&pem);
Ron Eldord0c56de2017-10-10 17:03:08 +03001429#if defined(MBEDTLS_RSA_C)
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001430 /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
David Horstmann8b6068b2023-01-05 15:42:32 +00001431 if (key[keylen - 1] != '\0') {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001432 ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
David Horstmann8b6068b2023-01-05 15:42:32 +00001433 } else {
1434 ret = mbedtls_pem_read_buffer(&pem,
1435 "-----BEGIN RSA PUBLIC KEY-----",
1436 "-----END RSA PUBLIC KEY-----",
1437 key, NULL, 0, &len);
Ron Eldord0c56de2017-10-10 17:03:08 +03001438 }
David Horstmann8b6068b2023-01-05 15:42:32 +00001439
1440 if (ret == 0) {
1441 p = pem.buf;
1442 if ((pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA)) == NULL) {
1443 mbedtls_pem_free(&pem);
1444 return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
1445 }
1446
1447 if ((ret = mbedtls_pk_setup(ctx, pk_info)) != 0) {
1448 mbedtls_pem_free(&pem);
1449 return ret;
1450 }
1451
1452 if ((ret = pk_get_rsapubkey(&p, p + pem.buflen, mbedtls_pk_rsa(*ctx))) != 0) {
1453 mbedtls_pk_free(ctx);
1454 }
1455
1456 mbedtls_pem_free(&pem);
1457 return ret;
1458 } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
1459 mbedtls_pem_free(&pem);
1460 return ret;
Ron Eldord0c56de2017-10-10 17:03:08 +03001461 }
1462#endif /* MBEDTLS_RSA_C */
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001463
1464 /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
David Horstmann8b6068b2023-01-05 15:42:32 +00001465 if (key[keylen - 1] != '\0') {
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +02001466 ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
David Horstmann8b6068b2023-01-05 15:42:32 +00001467 } else {
1468 ret = mbedtls_pem_read_buffer(&pem,
1469 "-----BEGIN PUBLIC KEY-----",
1470 "-----END PUBLIC KEY-----",
1471 key, NULL, 0, &len);
1472 }
Paul Bakker1a7550a2013-09-15 13:01:22 +02001473
David Horstmann8b6068b2023-01-05 15:42:32 +00001474 if (ret == 0) {
Paul Bakker1a7550a2013-09-15 13:01:22 +02001475 /*
1476 * Was PEM encoded
1477 */
Ron Eldor40b14a82017-10-16 19:30:00 +03001478 p = pem.buf;
1479
David Horstmann8b6068b2023-01-05 15:42:32 +00001480 ret = mbedtls_pk_parse_subpubkey(&p, p + pem.buflen, ctx);
1481 mbedtls_pem_free(&pem);
1482 return ret;
1483 } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
1484 mbedtls_pem_free(&pem);
1485 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001486 }
David Horstmann8b6068b2023-01-05 15:42:32 +00001487 mbedtls_pem_free(&pem);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488#endif /* MBEDTLS_PEM_PARSE_C */
Ron Eldor40b14a82017-10-16 19:30:00 +03001489
1490#if defined(MBEDTLS_RSA_C)
David Horstmann8b6068b2023-01-05 15:42:32 +00001491 if ((pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA)) == NULL) {
1492 return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
Ron Eldor40b14a82017-10-16 19:30:00 +03001493 }
David Horstmann8b6068b2023-01-05 15:42:32 +00001494
1495 if ((ret = mbedtls_pk_setup(ctx, pk_info)) != 0) {
1496 return ret;
1497 }
1498
1499 p = (unsigned char *) key;
1500 ret = pk_get_rsapubkey(&p, p + keylen, mbedtls_pk_rsa(*ctx));
1501 if (ret == 0) {
1502 return ret;
1503 }
1504 mbedtls_pk_free(ctx);
1505 if (ret != (MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
1506 MBEDTLS_ERR_ASN1_UNEXPECTED_TAG))) {
1507 return ret;
Ron Eldor40b14a82017-10-16 19:30:00 +03001508 }
1509#endif /* MBEDTLS_RSA_C */
Paul Bakker1a7550a2013-09-15 13:01:22 +02001510 p = (unsigned char *) key;
1511
David Horstmann8b6068b2023-01-05 15:42:32 +00001512 ret = mbedtls_pk_parse_subpubkey(&p, p + keylen, ctx);
Paul Bakker1a7550a2013-09-15 13:01:22 +02001513
David Horstmann8b6068b2023-01-05 15:42:32 +00001514 return ret;
Paul Bakker1a7550a2013-09-15 13:01:22 +02001515}
1516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517#endif /* MBEDTLS_PK_PARSE_C */