pkparse.c 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392
  1. /*
  2. * Public Key layer for parsing key files and structures
  3. *
  4. * Copyright The Mbed TLS Contributors
  5. * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
  6. */
  7. #include "common.h"
  8. #if defined(MBEDTLS_PK_PARSE_C)
  9. #include "mbedtls/pk.h"
  10. #include "mbedtls/asn1.h"
  11. #include "mbedtls/oid.h"
  12. #include "mbedtls/platform_util.h"
  13. #include "mbedtls/platform.h"
  14. #include "mbedtls/error.h"
  15. #include "mbedtls/ecp.h"
  16. #include "pk_internal.h"
  17. #include <string.h>
  18. #if defined(MBEDTLS_USE_PSA_CRYPTO)
  19. #include "mbedtls/psa_util.h"
  20. #include "psa/crypto.h"
  21. #endif
  22. /* Key types */
  23. #if defined(MBEDTLS_RSA_C)
  24. #include "mbedtls/rsa.h"
  25. #include "rsa_internal.h"
  26. #endif
  27. /* Extended formats */
  28. #if defined(MBEDTLS_PEM_PARSE_C)
  29. #include "mbedtls/pem.h"
  30. #endif
  31. #if defined(MBEDTLS_PKCS5_C)
  32. #include "mbedtls/pkcs5.h"
  33. #endif
  34. #if defined(MBEDTLS_PKCS12_C)
  35. #include "mbedtls/pkcs12.h"
  36. #endif
  37. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  38. /***********************************************************************
  39. *
  40. * Low-level ECC parsing: optional support for SpecifiedECDomain
  41. *
  42. * There are two functions here that are used by the rest of the code:
  43. * - pk_ecc_tag_is_speficied_ec_domain()
  44. * - pk_ecc_group_id_from_specified()
  45. *
  46. * All the other functions are internal to this section.
  47. *
  48. * The two "public" functions have a dummy variant provided
  49. * in configs without MBEDTLS_PK_PARSE_EC_EXTENDED. This acts as an
  50. * abstraction layer for this macro, which should not appear outside
  51. * this section.
  52. *
  53. **********************************************************************/
  54. #if !defined(MBEDTLS_PK_PARSE_EC_EXTENDED)
  55. /* See the "real" version for documentation */
  56. static int pk_ecc_tag_is_specified_ec_domain(int tag)
  57. {
  58. (void) tag;
  59. return 0;
  60. }
  61. /* See the "real" version for documentation */
  62. static int pk_ecc_group_id_from_specified(const mbedtls_asn1_buf *params,
  63. mbedtls_ecp_group_id *grp_id)
  64. {
  65. (void) params;
  66. (void) grp_id;
  67. return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
  68. }
  69. #else /* MBEDTLS_PK_PARSE_EC_EXTENDED */
  70. /*
  71. * Tell if the passed tag might be the start of SpecifiedECDomain
  72. * (that is, a sequence).
  73. */
  74. static int pk_ecc_tag_is_specified_ec_domain(int tag)
  75. {
  76. return tag == (MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE);
  77. }
  78. /*
  79. * Parse a SpecifiedECDomain (SEC 1 C.2) and (mostly) fill the group with it.
  80. * WARNING: the resulting group should only be used with
  81. * pk_ecc_group_id_from_specified(), since its base point may not be set correctly
  82. * if it was encoded compressed.
  83. *
  84. * SpecifiedECDomain ::= SEQUENCE {
  85. * version SpecifiedECDomainVersion(ecdpVer1 | ecdpVer2 | ecdpVer3, ...),
  86. * fieldID FieldID {{FieldTypes}},
  87. * curve Curve,
  88. * base ECPoint,
  89. * order INTEGER,
  90. * cofactor INTEGER OPTIONAL,
  91. * hash HashAlgorithm OPTIONAL,
  92. * ...
  93. * }
  94. *
  95. * We only support prime-field as field type, and ignore hash and cofactor.
  96. */
  97. static int pk_group_from_specified(const mbedtls_asn1_buf *params, mbedtls_ecp_group *grp)
  98. {
  99. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  100. unsigned char *p = params->p;
  101. const unsigned char *const end = params->p + params->len;
  102. const unsigned char *end_field, *end_curve;
  103. size_t len;
  104. int ver;
  105. /* SpecifiedECDomainVersion ::= INTEGER { 1, 2, 3 } */
  106. if ((ret = mbedtls_asn1_get_int(&p, end, &ver)) != 0) {
  107. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  108. }
  109. if (ver < 1 || ver > 3) {
  110. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  111. }
  112. /*
  113. * FieldID { FIELD-ID:IOSet } ::= SEQUENCE { -- Finite field
  114. * fieldType FIELD-ID.&id({IOSet}),
  115. * parameters FIELD-ID.&Type({IOSet}{@fieldType})
  116. * }
  117. */
  118. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  119. MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
  120. return ret;
  121. }
  122. end_field = p + len;
  123. /*
  124. * FIELD-ID ::= TYPE-IDENTIFIER
  125. * FieldTypes FIELD-ID ::= {
  126. * { Prime-p IDENTIFIED BY prime-field } |
  127. * { Characteristic-two IDENTIFIED BY characteristic-two-field }
  128. * }
  129. * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
  130. */
  131. if ((ret = mbedtls_asn1_get_tag(&p, end_field, &len, MBEDTLS_ASN1_OID)) != 0) {
  132. return ret;
  133. }
  134. if (len != MBEDTLS_OID_SIZE(MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD) ||
  135. memcmp(p, MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD, len) != 0) {
  136. return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
  137. }
  138. p += len;
  139. /* Prime-p ::= INTEGER -- Field of size p. */
  140. if ((ret = mbedtls_asn1_get_mpi(&p, end_field, &grp->P)) != 0) {
  141. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  142. }
  143. grp->pbits = mbedtls_mpi_bitlen(&grp->P);
  144. if (p != end_field) {
  145. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  146. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  147. }
  148. /*
  149. * Curve ::= SEQUENCE {
  150. * a FieldElement,
  151. * b FieldElement,
  152. * seed BIT STRING OPTIONAL
  153. * -- Shall be present if used in SpecifiedECDomain
  154. * -- with version equal to ecdpVer2 or ecdpVer3
  155. * }
  156. */
  157. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  158. MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
  159. return ret;
  160. }
  161. end_curve = p + len;
  162. /*
  163. * FieldElement ::= OCTET STRING
  164. * containing an integer in the case of a prime field
  165. */
  166. if ((ret = mbedtls_asn1_get_tag(&p, end_curve, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0 ||
  167. (ret = mbedtls_mpi_read_binary(&grp->A, p, len)) != 0) {
  168. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  169. }
  170. p += len;
  171. if ((ret = mbedtls_asn1_get_tag(&p, end_curve, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0 ||
  172. (ret = mbedtls_mpi_read_binary(&grp->B, p, len)) != 0) {
  173. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  174. }
  175. p += len;
  176. /* Ignore seed BIT STRING OPTIONAL */
  177. if ((ret = mbedtls_asn1_get_tag(&p, end_curve, &len, MBEDTLS_ASN1_BIT_STRING)) == 0) {
  178. p += len;
  179. }
  180. if (p != end_curve) {
  181. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  182. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  183. }
  184. /*
  185. * ECPoint ::= OCTET STRING
  186. */
  187. if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
  188. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  189. }
  190. if ((ret = mbedtls_ecp_point_read_binary(grp, &grp->G,
  191. (const unsigned char *) p, len)) != 0) {
  192. /*
  193. * If we can't read the point because it's compressed, cheat by
  194. * reading only the X coordinate and the parity bit of Y.
  195. */
  196. if (ret != MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE ||
  197. (p[0] != 0x02 && p[0] != 0x03) ||
  198. len != mbedtls_mpi_size(&grp->P) + 1 ||
  199. mbedtls_mpi_read_binary(&grp->G.X, p + 1, len - 1) != 0 ||
  200. mbedtls_mpi_lset(&grp->G.Y, p[0] - 2) != 0 ||
  201. mbedtls_mpi_lset(&grp->G.Z, 1) != 0) {
  202. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  203. }
  204. }
  205. p += len;
  206. /*
  207. * order INTEGER
  208. */
  209. if ((ret = mbedtls_asn1_get_mpi(&p, end, &grp->N)) != 0) {
  210. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  211. }
  212. grp->nbits = mbedtls_mpi_bitlen(&grp->N);
  213. /*
  214. * Allow optional elements by purposefully not enforcing p == end here.
  215. */
  216. return 0;
  217. }
  218. /*
  219. * Find the group id associated with an (almost filled) group as generated by
  220. * pk_group_from_specified(), or return an error if unknown.
  221. */
  222. static int pk_group_id_from_group(const mbedtls_ecp_group *grp, mbedtls_ecp_group_id *grp_id)
  223. {
  224. int ret = 0;
  225. mbedtls_ecp_group ref;
  226. const mbedtls_ecp_group_id *id;
  227. mbedtls_ecp_group_init(&ref);
  228. for (id = mbedtls_ecp_grp_id_list(); *id != MBEDTLS_ECP_DP_NONE; id++) {
  229. /* Load the group associated to that id */
  230. mbedtls_ecp_group_free(&ref);
  231. MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ref, *id));
  232. /* Compare to the group we were given, starting with easy tests */
  233. if (grp->pbits == ref.pbits && grp->nbits == ref.nbits &&
  234. mbedtls_mpi_cmp_mpi(&grp->P, &ref.P) == 0 &&
  235. mbedtls_mpi_cmp_mpi(&grp->A, &ref.A) == 0 &&
  236. mbedtls_mpi_cmp_mpi(&grp->B, &ref.B) == 0 &&
  237. mbedtls_mpi_cmp_mpi(&grp->N, &ref.N) == 0 &&
  238. mbedtls_mpi_cmp_mpi(&grp->G.X, &ref.G.X) == 0 &&
  239. mbedtls_mpi_cmp_mpi(&grp->G.Z, &ref.G.Z) == 0 &&
  240. /* For Y we may only know the parity bit, so compare only that */
  241. mbedtls_mpi_get_bit(&grp->G.Y, 0) == mbedtls_mpi_get_bit(&ref.G.Y, 0)) {
  242. break;
  243. }
  244. }
  245. cleanup:
  246. mbedtls_ecp_group_free(&ref);
  247. *grp_id = *id;
  248. if (ret == 0 && *id == MBEDTLS_ECP_DP_NONE) {
  249. ret = MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE;
  250. }
  251. return ret;
  252. }
  253. /*
  254. * Parse a SpecifiedECDomain (SEC 1 C.2) and find the associated group ID
  255. */
  256. static int pk_ecc_group_id_from_specified(const mbedtls_asn1_buf *params,
  257. mbedtls_ecp_group_id *grp_id)
  258. {
  259. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  260. mbedtls_ecp_group grp;
  261. mbedtls_ecp_group_init(&grp);
  262. if ((ret = pk_group_from_specified(params, &grp)) != 0) {
  263. goto cleanup;
  264. }
  265. ret = pk_group_id_from_group(&grp, grp_id);
  266. cleanup:
  267. /* The API respecting lifecycle for mbedtls_ecp_group struct is
  268. * _init(), _load() and _free(). In pk_ecc_group_id_from_specified() the
  269. * temporary grp breaks that flow and it's members are populated
  270. * by pk_group_id_from_group(). As such mbedtls_ecp_group_free()
  271. * which is assuming a group populated by _setup() may not clean-up
  272. * properly -> Manually free it's members.
  273. */
  274. mbedtls_mpi_free(&grp.N);
  275. mbedtls_mpi_free(&grp.P);
  276. mbedtls_mpi_free(&grp.A);
  277. mbedtls_mpi_free(&grp.B);
  278. mbedtls_ecp_point_free(&grp.G);
  279. return ret;
  280. }
  281. #endif /* MBEDTLS_PK_PARSE_EC_EXTENDED */
  282. /***********************************************************************
  283. *
  284. * Unsorted (yet!) from this point on until the next section header
  285. *
  286. **********************************************************************/
  287. /* Minimally parse an ECParameters buffer to and mbedtls_asn1_buf
  288. *
  289. * ECParameters ::= CHOICE {
  290. * namedCurve OBJECT IDENTIFIER
  291. * specifiedCurve SpecifiedECDomain -- = SEQUENCE { ... }
  292. * -- implicitCurve NULL
  293. * }
  294. */
  295. static int pk_get_ecparams(unsigned char **p, const unsigned char *end,
  296. mbedtls_asn1_buf *params)
  297. {
  298. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  299. if (end - *p < 1) {
  300. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  301. MBEDTLS_ERR_ASN1_OUT_OF_DATA);
  302. }
  303. /* Acceptable tags: OID for namedCurve, or specifiedECDomain */
  304. params->tag = **p;
  305. if (params->tag != MBEDTLS_ASN1_OID &&
  306. !pk_ecc_tag_is_specified_ec_domain(params->tag)) {
  307. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  308. MBEDTLS_ERR_ASN1_UNEXPECTED_TAG);
  309. }
  310. if ((ret = mbedtls_asn1_get_tag(p, end, &params->len, params->tag)) != 0) {
  311. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  312. }
  313. params->p = *p;
  314. *p += params->len;
  315. if (*p != end) {
  316. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  317. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  318. }
  319. return 0;
  320. }
  321. /*
  322. * Use EC parameters to initialise an EC group
  323. *
  324. * ECParameters ::= CHOICE {
  325. * namedCurve OBJECT IDENTIFIER
  326. * specifiedCurve SpecifiedECDomain -- = SEQUENCE { ... }
  327. * -- implicitCurve NULL
  328. */
  329. static int pk_use_ecparams(const mbedtls_asn1_buf *params, mbedtls_pk_context *pk)
  330. {
  331. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  332. mbedtls_ecp_group_id grp_id;
  333. if (params->tag == MBEDTLS_ASN1_OID) {
  334. if (mbedtls_oid_get_ec_grp(params, &grp_id) != 0) {
  335. return MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE;
  336. }
  337. } else {
  338. ret = pk_ecc_group_id_from_specified(params, &grp_id);
  339. if (ret != 0) {
  340. return ret;
  341. }
  342. }
  343. return mbedtls_pk_ecc_set_group(pk, grp_id);
  344. }
  345. #if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
  346. /*
  347. * Load an RFC8410 EC key, which doesn't have any parameters
  348. */
  349. static int pk_use_ecparams_rfc8410(const mbedtls_asn1_buf *params,
  350. mbedtls_ecp_group_id grp_id,
  351. mbedtls_pk_context *pk)
  352. {
  353. if (params->tag != 0 || params->len != 0) {
  354. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  355. }
  356. return mbedtls_pk_ecc_set_group(pk, grp_id);
  357. }
  358. /*
  359. * Parse an RFC 8410 encoded private EC key
  360. *
  361. * CurvePrivateKey ::= OCTET STRING
  362. */
  363. static int pk_parse_key_rfc8410_der(mbedtls_pk_context *pk,
  364. unsigned char *key, size_t keylen, const unsigned char *end,
  365. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
  366. {
  367. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  368. size_t len;
  369. if ((ret = mbedtls_asn1_get_tag(&key, (key + keylen), &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
  370. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  371. }
  372. if (key + len != end) {
  373. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  374. }
  375. /*
  376. * Load the private key
  377. */
  378. ret = mbedtls_pk_ecc_set_key(pk, key, len);
  379. if (ret != 0) {
  380. return ret;
  381. }
  382. /* pk_parse_key_pkcs8_unencrypted_der() only supports version 1 PKCS8 keys,
  383. * which never contain a public key. As such, derive the public key
  384. * unconditionally. */
  385. if ((ret = mbedtls_pk_ecc_set_pubkey_from_prv(pk, key, len, f_rng, p_rng)) != 0) {
  386. return ret;
  387. }
  388. return 0;
  389. }
  390. #endif /* MBEDTLS_PK_HAVE_RFC8410_CURVES */
  391. #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
  392. /* Get a PK algorithm identifier
  393. *
  394. * AlgorithmIdentifier ::= SEQUENCE {
  395. * algorithm OBJECT IDENTIFIER,
  396. * parameters ANY DEFINED BY algorithm OPTIONAL }
  397. */
  398. static int pk_get_pk_alg(unsigned char **p,
  399. const unsigned char *end,
  400. mbedtls_pk_type_t *pk_alg, mbedtls_asn1_buf *params,
  401. mbedtls_ecp_group_id *ec_grp_id)
  402. {
  403. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  404. mbedtls_asn1_buf alg_oid;
  405. memset(params, 0, sizeof(mbedtls_asn1_buf));
  406. if ((ret = mbedtls_asn1_get_alg(p, end, &alg_oid, params)) != 0) {
  407. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_ALG, ret);
  408. }
  409. ret = mbedtls_oid_get_pk_alg(&alg_oid, pk_alg);
  410. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  411. if (ret == MBEDTLS_ERR_OID_NOT_FOUND) {
  412. ret = mbedtls_oid_get_ec_grp_algid(&alg_oid, ec_grp_id);
  413. if (ret == 0) {
  414. *pk_alg = MBEDTLS_PK_ECKEY;
  415. }
  416. }
  417. #else
  418. (void) ec_grp_id;
  419. #endif
  420. if (ret != 0) {
  421. return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  422. }
  423. /*
  424. * No parameters with RSA (only for EC)
  425. */
  426. if (*pk_alg == MBEDTLS_PK_RSA &&
  427. ((params->tag != MBEDTLS_ASN1_NULL && params->tag != 0) ||
  428. params->len != 0)) {
  429. return MBEDTLS_ERR_PK_INVALID_ALG;
  430. }
  431. return 0;
  432. }
  433. /*
  434. * SubjectPublicKeyInfo ::= SEQUENCE {
  435. * algorithm AlgorithmIdentifier,
  436. * subjectPublicKey BIT STRING }
  437. */
  438. int mbedtls_pk_parse_subpubkey(unsigned char **p, const unsigned char *end,
  439. mbedtls_pk_context *pk)
  440. {
  441. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  442. size_t len;
  443. mbedtls_asn1_buf alg_params;
  444. mbedtls_pk_type_t pk_alg = MBEDTLS_PK_NONE;
  445. mbedtls_ecp_group_id ec_grp_id = MBEDTLS_ECP_DP_NONE;
  446. const mbedtls_pk_info_t *pk_info;
  447. if ((ret = mbedtls_asn1_get_tag(p, end, &len,
  448. MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
  449. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  450. }
  451. end = *p + len;
  452. if ((ret = pk_get_pk_alg(p, end, &pk_alg, &alg_params, &ec_grp_id)) != 0) {
  453. return ret;
  454. }
  455. if ((ret = mbedtls_asn1_get_bitstring_null(p, end, &len)) != 0) {
  456. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY, ret);
  457. }
  458. if (*p + len != end) {
  459. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
  460. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  461. }
  462. if ((pk_info = mbedtls_pk_info_from_type(pk_alg)) == NULL) {
  463. return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  464. }
  465. if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0) {
  466. return ret;
  467. }
  468. #if defined(MBEDTLS_RSA_C)
  469. if (pk_alg == MBEDTLS_PK_RSA) {
  470. ret = mbedtls_rsa_parse_pubkey(mbedtls_pk_rsa(*pk), *p, (size_t) (end - *p));
  471. if (ret == 0) {
  472. /* On success all the input has been consumed by the parsing function. */
  473. *p += end - *p;
  474. } else if ((ret <= MBEDTLS_ERR_ASN1_OUT_OF_DATA) &&
  475. (ret >= MBEDTLS_ERR_ASN1_BUF_TOO_SMALL)) {
  476. /* In case of ASN1 error codes add MBEDTLS_ERR_PK_INVALID_PUBKEY. */
  477. ret = MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY, ret);
  478. } else {
  479. ret = MBEDTLS_ERR_PK_INVALID_PUBKEY;
  480. }
  481. } else
  482. #endif /* MBEDTLS_RSA_C */
  483. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  484. if (pk_alg == MBEDTLS_PK_ECKEY_DH || pk_alg == MBEDTLS_PK_ECKEY) {
  485. #if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
  486. if (MBEDTLS_PK_IS_RFC8410_GROUP_ID(ec_grp_id)) {
  487. ret = pk_use_ecparams_rfc8410(&alg_params, ec_grp_id, pk);
  488. } else
  489. #endif
  490. {
  491. ret = pk_use_ecparams(&alg_params, pk);
  492. }
  493. if (ret == 0) {
  494. ret = mbedtls_pk_ecc_set_pubkey(pk, *p, (size_t) (end - *p));
  495. *p += end - *p;
  496. }
  497. } else
  498. #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
  499. ret = MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  500. if (ret == 0 && *p != end) {
  501. ret = MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_INVALID_PUBKEY,
  502. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  503. }
  504. if (ret != 0) {
  505. mbedtls_pk_free(pk);
  506. }
  507. return ret;
  508. }
  509. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  510. /*
  511. * Parse a SEC1 encoded private EC key
  512. */
  513. static int pk_parse_key_sec1_der(mbedtls_pk_context *pk,
  514. const unsigned char *key, size_t keylen,
  515. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
  516. {
  517. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  518. int version, pubkey_done;
  519. size_t len, d_len;
  520. mbedtls_asn1_buf params = { 0, 0, NULL };
  521. unsigned char *p = (unsigned char *) key;
  522. unsigned char *d;
  523. unsigned char *end = p + keylen;
  524. unsigned char *end2;
  525. /*
  526. * RFC 5915, or SEC1 Appendix C.4
  527. *
  528. * ECPrivateKey ::= SEQUENCE {
  529. * version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
  530. * privateKey OCTET STRING,
  531. * parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
  532. * publicKey [1] BIT STRING OPTIONAL
  533. * }
  534. */
  535. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  536. MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
  537. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  538. }
  539. end = p + len;
  540. if ((ret = mbedtls_asn1_get_int(&p, end, &version)) != 0) {
  541. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  542. }
  543. if (version != 1) {
  544. return MBEDTLS_ERR_PK_KEY_INVALID_VERSION;
  545. }
  546. if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
  547. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  548. }
  549. /* Keep a reference to the position fo the private key. It will be used
  550. * later in this function. */
  551. d = p;
  552. d_len = len;
  553. p += len;
  554. pubkey_done = 0;
  555. if (p != end) {
  556. /*
  557. * Is 'parameters' present?
  558. */
  559. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  560. MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED |
  561. 0)) == 0) {
  562. if ((ret = pk_get_ecparams(&p, p + len, &params)) != 0 ||
  563. (ret = pk_use_ecparams(&params, pk)) != 0) {
  564. return ret;
  565. }
  566. } else if (ret != MBEDTLS_ERR_ASN1_UNEXPECTED_TAG) {
  567. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  568. }
  569. }
  570. /*
  571. * Load the private key
  572. */
  573. ret = mbedtls_pk_ecc_set_key(pk, d, d_len);
  574. if (ret != 0) {
  575. return ret;
  576. }
  577. if (p != end) {
  578. /*
  579. * Is 'publickey' present? If not, or if we can't read it (eg because it
  580. * is compressed), create it from the private key.
  581. */
  582. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  583. MBEDTLS_ASN1_CONTEXT_SPECIFIC | MBEDTLS_ASN1_CONSTRUCTED |
  584. 1)) == 0) {
  585. end2 = p + len;
  586. if ((ret = mbedtls_asn1_get_bitstring_null(&p, end2, &len)) != 0) {
  587. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  588. }
  589. if (p + len != end2) {
  590. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  591. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  592. }
  593. if ((ret = mbedtls_pk_ecc_set_pubkey(pk, p, (size_t) (end2 - p))) == 0) {
  594. pubkey_done = 1;
  595. } else {
  596. /*
  597. * The only acceptable failure mode of mbedtls_pk_ecc_set_pubkey() above
  598. * is if the point format is not recognized.
  599. */
  600. if (ret != MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE) {
  601. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  602. }
  603. }
  604. } else if (ret != MBEDTLS_ERR_ASN1_UNEXPECTED_TAG) {
  605. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  606. }
  607. }
  608. if (!pubkey_done) {
  609. if ((ret = mbedtls_pk_ecc_set_pubkey_from_prv(pk, d, d_len, f_rng, p_rng)) != 0) {
  610. return ret;
  611. }
  612. }
  613. return 0;
  614. }
  615. #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
  616. /***********************************************************************
  617. *
  618. * PKCS#8 parsing functions
  619. *
  620. **********************************************************************/
  621. /*
  622. * Parse an unencrypted PKCS#8 encoded private key
  623. *
  624. * Notes:
  625. *
  626. * - This function does not own the key buffer. It is the
  627. * responsibility of the caller to take care of zeroizing
  628. * and freeing it after use.
  629. *
  630. * - The function is responsible for freeing the provided
  631. * PK context on failure.
  632. *
  633. */
  634. static int pk_parse_key_pkcs8_unencrypted_der(
  635. mbedtls_pk_context *pk,
  636. const unsigned char *key, size_t keylen,
  637. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
  638. {
  639. int ret, version;
  640. size_t len;
  641. mbedtls_asn1_buf params;
  642. unsigned char *p = (unsigned char *) key;
  643. unsigned char *end = p + keylen;
  644. mbedtls_pk_type_t pk_alg = MBEDTLS_PK_NONE;
  645. mbedtls_ecp_group_id ec_grp_id = MBEDTLS_ECP_DP_NONE;
  646. const mbedtls_pk_info_t *pk_info;
  647. #if !defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  648. (void) f_rng;
  649. (void) p_rng;
  650. #endif
  651. /*
  652. * This function parses the PrivateKeyInfo object (PKCS#8 v1.2 = RFC 5208)
  653. *
  654. * PrivateKeyInfo ::= SEQUENCE {
  655. * version Version,
  656. * privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
  657. * privateKey PrivateKey,
  658. * attributes [0] IMPLICIT Attributes OPTIONAL }
  659. *
  660. * Version ::= INTEGER
  661. * PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
  662. * PrivateKey ::= OCTET STRING
  663. *
  664. * The PrivateKey OCTET STRING is a SEC1 ECPrivateKey
  665. */
  666. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  667. MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
  668. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  669. }
  670. end = p + len;
  671. if ((ret = mbedtls_asn1_get_int(&p, end, &version)) != 0) {
  672. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  673. }
  674. if (version != 0) {
  675. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_VERSION, ret);
  676. }
  677. if ((ret = pk_get_pk_alg(&p, end, &pk_alg, &params, &ec_grp_id)) != 0) {
  678. return ret;
  679. }
  680. if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
  681. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  682. }
  683. if (len < 1) {
  684. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  685. MBEDTLS_ERR_ASN1_OUT_OF_DATA);
  686. }
  687. if ((pk_info = mbedtls_pk_info_from_type(pk_alg)) == NULL) {
  688. return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  689. }
  690. if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0) {
  691. return ret;
  692. }
  693. #if defined(MBEDTLS_RSA_C)
  694. if (pk_alg == MBEDTLS_PK_RSA) {
  695. if ((ret = mbedtls_rsa_parse_key(mbedtls_pk_rsa(*pk), p, len)) != 0) {
  696. mbedtls_pk_free(pk);
  697. return ret;
  698. }
  699. } else
  700. #endif /* MBEDTLS_RSA_C */
  701. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  702. if (pk_alg == MBEDTLS_PK_ECKEY || pk_alg == MBEDTLS_PK_ECKEY_DH) {
  703. #if defined(MBEDTLS_PK_HAVE_RFC8410_CURVES)
  704. if (MBEDTLS_PK_IS_RFC8410_GROUP_ID(ec_grp_id)) {
  705. if ((ret =
  706. pk_use_ecparams_rfc8410(&params, ec_grp_id, pk)) != 0 ||
  707. (ret =
  708. pk_parse_key_rfc8410_der(pk, p, len, end, f_rng,
  709. p_rng)) != 0) {
  710. mbedtls_pk_free(pk);
  711. return ret;
  712. }
  713. } else
  714. #endif
  715. {
  716. if ((ret = pk_use_ecparams(&params, pk)) != 0 ||
  717. (ret = pk_parse_key_sec1_der(pk, p, len, f_rng, p_rng)) != 0) {
  718. mbedtls_pk_free(pk);
  719. return ret;
  720. }
  721. }
  722. } else
  723. #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
  724. return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  725. end = p + len;
  726. if (end != (key + keylen)) {
  727. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT,
  728. MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  729. }
  730. return 0;
  731. }
  732. /*
  733. * Parse an encrypted PKCS#8 encoded private key
  734. *
  735. * To save space, the decryption happens in-place on the given key buffer.
  736. * Also, while this function may modify the keybuffer, it doesn't own it,
  737. * and instead it is the responsibility of the caller to zeroize and properly
  738. * free it after use.
  739. *
  740. */
  741. #if defined(MBEDTLS_PKCS12_C) || defined(MBEDTLS_PKCS5_C)
  742. MBEDTLS_STATIC_TESTABLE int mbedtls_pk_parse_key_pkcs8_encrypted_der(
  743. mbedtls_pk_context *pk,
  744. unsigned char *key, size_t keylen,
  745. const unsigned char *pwd, size_t pwdlen,
  746. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
  747. {
  748. int ret, decrypted = 0;
  749. size_t len;
  750. unsigned char *buf;
  751. unsigned char *p, *end;
  752. mbedtls_asn1_buf pbe_alg_oid, pbe_params;
  753. #if defined(MBEDTLS_PKCS12_C) && defined(MBEDTLS_CIPHER_PADDING_PKCS7) && defined(MBEDTLS_CIPHER_C)
  754. mbedtls_cipher_type_t cipher_alg;
  755. mbedtls_md_type_t md_alg;
  756. #endif
  757. size_t outlen = 0;
  758. p = key;
  759. end = p + keylen;
  760. if (pwdlen == 0) {
  761. return MBEDTLS_ERR_PK_PASSWORD_REQUIRED;
  762. }
  763. /*
  764. * This function parses the EncryptedPrivateKeyInfo object (PKCS#8)
  765. *
  766. * EncryptedPrivateKeyInfo ::= SEQUENCE {
  767. * encryptionAlgorithm EncryptionAlgorithmIdentifier,
  768. * encryptedData EncryptedData
  769. * }
  770. *
  771. * EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier
  772. *
  773. * EncryptedData ::= OCTET STRING
  774. *
  775. * The EncryptedData OCTET STRING is a PKCS#8 PrivateKeyInfo
  776. *
  777. */
  778. if ((ret = mbedtls_asn1_get_tag(&p, end, &len,
  779. MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
  780. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  781. }
  782. end = p + len;
  783. if ((ret = mbedtls_asn1_get_alg(&p, end, &pbe_alg_oid, &pbe_params)) != 0) {
  784. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  785. }
  786. if ((ret = mbedtls_asn1_get_tag(&p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
  787. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PK_KEY_INVALID_FORMAT, ret);
  788. }
  789. buf = p;
  790. /*
  791. * Decrypt EncryptedData with appropriate PBE
  792. */
  793. #if defined(MBEDTLS_PKCS12_C) && defined(MBEDTLS_CIPHER_PADDING_PKCS7) && defined(MBEDTLS_CIPHER_C)
  794. if (mbedtls_oid_get_pkcs12_pbe_alg(&pbe_alg_oid, &md_alg, &cipher_alg) == 0) {
  795. if ((ret = mbedtls_pkcs12_pbe_ext(&pbe_params, MBEDTLS_PKCS12_PBE_DECRYPT,
  796. cipher_alg, md_alg,
  797. pwd, pwdlen, p, len, buf, len, &outlen)) != 0) {
  798. if (ret == MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH) {
  799. return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
  800. }
  801. return ret;
  802. }
  803. decrypted = 1;
  804. } else
  805. #endif /* MBEDTLS_PKCS12_C && MBEDTLS_CIPHER_PADDING_PKCS7 && MBEDTLS_CIPHER_C */
  806. #if defined(MBEDTLS_PKCS5_C) && defined(MBEDTLS_CIPHER_PADDING_PKCS7) && defined(MBEDTLS_CIPHER_C)
  807. if (MBEDTLS_OID_CMP(MBEDTLS_OID_PKCS5_PBES2, &pbe_alg_oid) == 0) {
  808. if ((ret = mbedtls_pkcs5_pbes2_ext(&pbe_params, MBEDTLS_PKCS5_DECRYPT, pwd, pwdlen,
  809. p, len, buf, len, &outlen)) != 0) {
  810. if (ret == MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH) {
  811. return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
  812. }
  813. return ret;
  814. }
  815. decrypted = 1;
  816. } else
  817. #endif /* MBEDTLS_PKCS5_C && MBEDTLS_CIPHER_PADDING_PKCS7 && MBEDTLS_CIPHER_C */
  818. {
  819. ((void) pwd);
  820. }
  821. if (decrypted == 0) {
  822. return MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE;
  823. }
  824. return pk_parse_key_pkcs8_unencrypted_der(pk, buf, outlen, f_rng, p_rng);
  825. }
  826. #endif /* MBEDTLS_PKCS12_C || MBEDTLS_PKCS5_C */
  827. /***********************************************************************
  828. *
  829. * Top-level functions, with format auto-discovery
  830. *
  831. **********************************************************************/
  832. /*
  833. * Parse a private key
  834. */
  835. int mbedtls_pk_parse_key(mbedtls_pk_context *pk,
  836. const unsigned char *key, size_t keylen,
  837. const unsigned char *pwd, size_t pwdlen,
  838. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
  839. {
  840. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  841. const mbedtls_pk_info_t *pk_info;
  842. #if defined(MBEDTLS_PEM_PARSE_C)
  843. size_t len;
  844. mbedtls_pem_context pem;
  845. #endif
  846. if (keylen == 0) {
  847. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  848. }
  849. #if defined(MBEDTLS_PEM_PARSE_C)
  850. mbedtls_pem_init(&pem);
  851. #if defined(MBEDTLS_RSA_C)
  852. /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
  853. if (key[keylen - 1] != '\0') {
  854. ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  855. } else {
  856. ret = mbedtls_pem_read_buffer(&pem,
  857. PEM_BEGIN_PRIVATE_KEY_RSA, PEM_END_PRIVATE_KEY_RSA,
  858. key, pwd, pwdlen, &len);
  859. }
  860. if (ret == 0) {
  861. pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA);
  862. if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0 ||
  863. (ret = mbedtls_rsa_parse_key(mbedtls_pk_rsa(*pk),
  864. pem.buf, pem.buflen)) != 0) {
  865. mbedtls_pk_free(pk);
  866. }
  867. mbedtls_pem_free(&pem);
  868. return ret;
  869. } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_MISMATCH) {
  870. return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
  871. } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_REQUIRED) {
  872. return MBEDTLS_ERR_PK_PASSWORD_REQUIRED;
  873. } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
  874. return ret;
  875. }
  876. #endif /* MBEDTLS_RSA_C */
  877. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  878. /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
  879. if (key[keylen - 1] != '\0') {
  880. ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  881. } else {
  882. ret = mbedtls_pem_read_buffer(&pem,
  883. PEM_BEGIN_PRIVATE_KEY_EC,
  884. PEM_END_PRIVATE_KEY_EC,
  885. key, pwd, pwdlen, &len);
  886. }
  887. if (ret == 0) {
  888. pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_ECKEY);
  889. if ((ret = mbedtls_pk_setup(pk, pk_info)) != 0 ||
  890. (ret = pk_parse_key_sec1_der(pk,
  891. pem.buf, pem.buflen,
  892. f_rng, p_rng)) != 0) {
  893. mbedtls_pk_free(pk);
  894. }
  895. mbedtls_pem_free(&pem);
  896. return ret;
  897. } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_MISMATCH) {
  898. return MBEDTLS_ERR_PK_PASSWORD_MISMATCH;
  899. } else if (ret == MBEDTLS_ERR_PEM_PASSWORD_REQUIRED) {
  900. return MBEDTLS_ERR_PK_PASSWORD_REQUIRED;
  901. } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
  902. return ret;
  903. }
  904. #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
  905. /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
  906. if (key[keylen - 1] != '\0') {
  907. ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  908. } else {
  909. ret = mbedtls_pem_read_buffer(&pem,
  910. PEM_BEGIN_PRIVATE_KEY_PKCS8, PEM_END_PRIVATE_KEY_PKCS8,
  911. key, NULL, 0, &len);
  912. }
  913. if (ret == 0) {
  914. if ((ret = pk_parse_key_pkcs8_unencrypted_der(pk,
  915. pem.buf, pem.buflen, f_rng, p_rng)) != 0) {
  916. mbedtls_pk_free(pk);
  917. }
  918. mbedtls_pem_free(&pem);
  919. return ret;
  920. } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
  921. return ret;
  922. }
  923. #if defined(MBEDTLS_PKCS12_C) || defined(MBEDTLS_PKCS5_C)
  924. /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
  925. if (key[keylen - 1] != '\0') {
  926. ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  927. } else {
  928. ret = mbedtls_pem_read_buffer(&pem,
  929. PEM_BEGIN_ENCRYPTED_PRIVATE_KEY_PKCS8,
  930. PEM_END_ENCRYPTED_PRIVATE_KEY_PKCS8,
  931. key, NULL, 0, &len);
  932. }
  933. if (ret == 0) {
  934. if ((ret = mbedtls_pk_parse_key_pkcs8_encrypted_der(pk, pem.buf, pem.buflen,
  935. pwd, pwdlen, f_rng, p_rng)) != 0) {
  936. mbedtls_pk_free(pk);
  937. }
  938. mbedtls_pem_free(&pem);
  939. return ret;
  940. } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
  941. return ret;
  942. }
  943. #endif /* MBEDTLS_PKCS12_C || MBEDTLS_PKCS5_C */
  944. #else
  945. ((void) pwd);
  946. ((void) pwdlen);
  947. #endif /* MBEDTLS_PEM_PARSE_C */
  948. /*
  949. * At this point we only know it's not a PEM formatted key. Could be any
  950. * of the known DER encoded private key formats
  951. *
  952. * We try the different DER format parsers to see if one passes without
  953. * error
  954. */
  955. #if defined(MBEDTLS_PKCS12_C) || defined(MBEDTLS_PKCS5_C)
  956. if (pwdlen != 0) {
  957. unsigned char *key_copy;
  958. if ((key_copy = mbedtls_calloc(1, keylen)) == NULL) {
  959. return MBEDTLS_ERR_PK_ALLOC_FAILED;
  960. }
  961. memcpy(key_copy, key, keylen);
  962. ret = mbedtls_pk_parse_key_pkcs8_encrypted_der(pk, key_copy, keylen,
  963. pwd, pwdlen, f_rng, p_rng);
  964. mbedtls_zeroize_and_free(key_copy, keylen);
  965. }
  966. if (ret == 0) {
  967. return 0;
  968. }
  969. mbedtls_pk_free(pk);
  970. mbedtls_pk_init(pk);
  971. if (ret == MBEDTLS_ERR_PK_PASSWORD_MISMATCH) {
  972. return ret;
  973. }
  974. #endif /* MBEDTLS_PKCS12_C || MBEDTLS_PKCS5_C */
  975. ret = pk_parse_key_pkcs8_unencrypted_der(pk, key, keylen, f_rng, p_rng);
  976. if (ret == 0) {
  977. return 0;
  978. }
  979. mbedtls_pk_free(pk);
  980. mbedtls_pk_init(pk);
  981. #if defined(MBEDTLS_RSA_C)
  982. pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA);
  983. if (mbedtls_pk_setup(pk, pk_info) == 0 &&
  984. mbedtls_rsa_parse_key(mbedtls_pk_rsa(*pk), key, keylen) == 0) {
  985. return 0;
  986. }
  987. mbedtls_pk_free(pk);
  988. mbedtls_pk_init(pk);
  989. #endif /* MBEDTLS_RSA_C */
  990. #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
  991. pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_ECKEY);
  992. if (mbedtls_pk_setup(pk, pk_info) == 0 &&
  993. pk_parse_key_sec1_der(pk,
  994. key, keylen, f_rng, p_rng) == 0) {
  995. return 0;
  996. }
  997. mbedtls_pk_free(pk);
  998. #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
  999. /* If MBEDTLS_RSA_C is defined but MBEDTLS_PK_HAVE_ECC_KEYS isn't,
  1000. * it is ok to leave the PK context initialized but not
  1001. * freed: It is the caller's responsibility to call pk_init()
  1002. * before calling this function, and to call pk_free()
  1003. * when it fails. If MBEDTLS_PK_HAVE_ECC_KEYS is defined but MBEDTLS_RSA_C
  1004. * isn't, this leads to mbedtls_pk_free() being called
  1005. * twice, once here and once by the caller, but this is
  1006. * also ok and in line with the mbedtls_pk_free() calls
  1007. * on failed PEM parsing attempts. */
  1008. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  1009. }
  1010. /*
  1011. * Parse a public key
  1012. */
  1013. int mbedtls_pk_parse_public_key(mbedtls_pk_context *ctx,
  1014. const unsigned char *key, size_t keylen)
  1015. {
  1016. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  1017. unsigned char *p;
  1018. #if defined(MBEDTLS_RSA_C)
  1019. const mbedtls_pk_info_t *pk_info;
  1020. #endif
  1021. #if defined(MBEDTLS_PEM_PARSE_C)
  1022. size_t len;
  1023. mbedtls_pem_context pem;
  1024. #endif
  1025. if (keylen == 0) {
  1026. return MBEDTLS_ERR_PK_KEY_INVALID_FORMAT;
  1027. }
  1028. #if defined(MBEDTLS_PEM_PARSE_C)
  1029. mbedtls_pem_init(&pem);
  1030. #if defined(MBEDTLS_RSA_C)
  1031. /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
  1032. if (key[keylen - 1] != '\0') {
  1033. ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  1034. } else {
  1035. ret = mbedtls_pem_read_buffer(&pem,
  1036. PEM_BEGIN_PUBLIC_KEY_RSA, PEM_END_PUBLIC_KEY_RSA,
  1037. key, NULL, 0, &len);
  1038. }
  1039. if (ret == 0) {
  1040. p = pem.buf;
  1041. if ((pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA)) == NULL) {
  1042. mbedtls_pem_free(&pem);
  1043. return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  1044. }
  1045. if ((ret = mbedtls_pk_setup(ctx, pk_info)) != 0) {
  1046. mbedtls_pem_free(&pem);
  1047. return ret;
  1048. }
  1049. if ((ret = mbedtls_rsa_parse_pubkey(mbedtls_pk_rsa(*ctx), p, pem.buflen)) != 0) {
  1050. mbedtls_pk_free(ctx);
  1051. }
  1052. mbedtls_pem_free(&pem);
  1053. return ret;
  1054. } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
  1055. mbedtls_pem_free(&pem);
  1056. return ret;
  1057. }
  1058. #endif /* MBEDTLS_RSA_C */
  1059. /* Avoid calling mbedtls_pem_read_buffer() on non-null-terminated string */
  1060. if (key[keylen - 1] != '\0') {
  1061. ret = MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  1062. } else {
  1063. ret = mbedtls_pem_read_buffer(&pem,
  1064. PEM_BEGIN_PUBLIC_KEY, PEM_END_PUBLIC_KEY,
  1065. key, NULL, 0, &len);
  1066. }
  1067. if (ret == 0) {
  1068. /*
  1069. * Was PEM encoded
  1070. */
  1071. p = pem.buf;
  1072. ret = mbedtls_pk_parse_subpubkey(&p, p + pem.buflen, ctx);
  1073. mbedtls_pem_free(&pem);
  1074. return ret;
  1075. } else if (ret != MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT) {
  1076. mbedtls_pem_free(&pem);
  1077. return ret;
  1078. }
  1079. mbedtls_pem_free(&pem);
  1080. #endif /* MBEDTLS_PEM_PARSE_C */
  1081. #if defined(MBEDTLS_RSA_C)
  1082. if ((pk_info = mbedtls_pk_info_from_type(MBEDTLS_PK_RSA)) == NULL) {
  1083. return MBEDTLS_ERR_PK_UNKNOWN_PK_ALG;
  1084. }
  1085. if ((ret = mbedtls_pk_setup(ctx, pk_info)) != 0) {
  1086. return ret;
  1087. }
  1088. p = (unsigned char *) key;
  1089. ret = mbedtls_rsa_parse_pubkey(mbedtls_pk_rsa(*ctx), p, keylen);
  1090. if (ret == 0) {
  1091. return ret;
  1092. }
  1093. mbedtls_pk_free(ctx);
  1094. if (ret != MBEDTLS_ERR_ASN1_UNEXPECTED_TAG) {
  1095. return ret;
  1096. }
  1097. #endif /* MBEDTLS_RSA_C */
  1098. p = (unsigned char *) key;
  1099. ret = mbedtls_pk_parse_subpubkey(&p, p + keylen, ctx);
  1100. return ret;
  1101. }
  1102. /***********************************************************************
  1103. *
  1104. * Top-level functions, with filesystem support
  1105. *
  1106. **********************************************************************/
  1107. #if defined(MBEDTLS_FS_IO)
  1108. /*
  1109. * Load all data from a file into a given buffer.
  1110. *
  1111. * The file is expected to contain either PEM or DER encoded data.
  1112. * A terminating null byte is always appended. It is included in the announced
  1113. * length only if the data looks like it is PEM encoded.
  1114. */
  1115. int mbedtls_pk_load_file(const char *path, unsigned char **buf, size_t *n)
  1116. {
  1117. FILE *f;
  1118. long size;
  1119. if ((f = fopen(path, "rb")) == NULL) {
  1120. return MBEDTLS_ERR_PK_FILE_IO_ERROR;
  1121. }
  1122. /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */
  1123. mbedtls_setbuf(f, NULL);
  1124. fseek(f, 0, SEEK_END);
  1125. if ((size = ftell(f)) == -1) {
  1126. fclose(f);
  1127. return MBEDTLS_ERR_PK_FILE_IO_ERROR;
  1128. }
  1129. fseek(f, 0, SEEK_SET);
  1130. *n = (size_t) size;
  1131. if (*n + 1 == 0 ||
  1132. (*buf = mbedtls_calloc(1, *n + 1)) == NULL) {
  1133. fclose(f);
  1134. return MBEDTLS_ERR_PK_ALLOC_FAILED;
  1135. }
  1136. if (fread(*buf, 1, *n, f) != *n) {
  1137. fclose(f);
  1138. mbedtls_zeroize_and_free(*buf, *n);
  1139. return MBEDTLS_ERR_PK_FILE_IO_ERROR;
  1140. }
  1141. fclose(f);
  1142. (*buf)[*n] = '\0';
  1143. if (strstr((const char *) *buf, "-----BEGIN ") != NULL) {
  1144. ++*n;
  1145. }
  1146. return 0;
  1147. }
  1148. /*
  1149. * Load and parse a private key
  1150. */
  1151. int mbedtls_pk_parse_keyfile(mbedtls_pk_context *ctx,
  1152. const char *path, const char *pwd,
  1153. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng)
  1154. {
  1155. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  1156. size_t n;
  1157. unsigned char *buf;
  1158. if ((ret = mbedtls_pk_load_file(path, &buf, &n)) != 0) {
  1159. return ret;
  1160. }
  1161. if (pwd == NULL) {
  1162. ret = mbedtls_pk_parse_key(ctx, buf, n, NULL, 0, f_rng, p_rng);
  1163. } else {
  1164. ret = mbedtls_pk_parse_key(ctx, buf, n,
  1165. (const unsigned char *) pwd, strlen(pwd), f_rng, p_rng);
  1166. }
  1167. mbedtls_zeroize_and_free(buf, n);
  1168. return ret;
  1169. }
  1170. /*
  1171. * Load and parse a public key
  1172. */
  1173. int mbedtls_pk_parse_public_keyfile(mbedtls_pk_context *ctx, const char *path)
  1174. {
  1175. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  1176. size_t n;
  1177. unsigned char *buf;
  1178. if ((ret = mbedtls_pk_load_file(path, &buf, &n)) != 0) {
  1179. return ret;
  1180. }
  1181. ret = mbedtls_pk_parse_public_key(ctx, buf, n);
  1182. mbedtls_zeroize_and_free(buf, n);
  1183. return ret;
  1184. }
  1185. #endif /* MBEDTLS_FS_IO */
  1186. #endif /* MBEDTLS_PK_PARSE_C */