pkparse.c 46 KB

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