pkparse.c 46 KB

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