pkparse.c 46 KB

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