pem.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515
  1. /*
  2. * Privacy Enhanced Mail (PEM) decoding
  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_PEM_PARSE_C) || defined(MBEDTLS_PEM_WRITE_C)
  9. #include "mbedtls/pem.h"
  10. #include "mbedtls/base64.h"
  11. #include "mbedtls/des.h"
  12. #include "mbedtls/aes.h"
  13. #include "mbedtls/md5.h"
  14. #include "mbedtls/cipher.h"
  15. #include "mbedtls/platform_util.h"
  16. #include "mbedtls/error.h"
  17. #include <string.h>
  18. #include "mbedtls/platform.h"
  19. #if defined(MBEDTLS_PEM_PARSE_C)
  20. void mbedtls_pem_init(mbedtls_pem_context *ctx)
  21. {
  22. memset(ctx, 0, sizeof(mbedtls_pem_context));
  23. }
  24. #if defined(MBEDTLS_MD5_C) && defined(MBEDTLS_CIPHER_MODE_CBC) && \
  25. (defined(MBEDTLS_DES_C) || defined(MBEDTLS_AES_C))
  26. /*
  27. * Read a 16-byte hex string and convert it to binary
  28. */
  29. static int pem_get_iv(const unsigned char *s, unsigned char *iv,
  30. size_t iv_len)
  31. {
  32. size_t i, j, k;
  33. memset(iv, 0, iv_len);
  34. for (i = 0; i < iv_len * 2; i++, s++) {
  35. if (*s >= '0' && *s <= '9') {
  36. j = *s - '0';
  37. } else
  38. if (*s >= 'A' && *s <= 'F') {
  39. j = *s - '7';
  40. } else
  41. if (*s >= 'a' && *s <= 'f') {
  42. j = *s - 'W';
  43. } else {
  44. return MBEDTLS_ERR_PEM_INVALID_ENC_IV;
  45. }
  46. k = ((i & 1) != 0) ? j : j << 4;
  47. iv[i >> 1] = (unsigned char) (iv[i >> 1] | k);
  48. }
  49. return 0;
  50. }
  51. static int pem_pbkdf1(unsigned char *key, size_t keylen,
  52. unsigned char *iv,
  53. const unsigned char *pwd, size_t pwdlen)
  54. {
  55. mbedtls_md5_context md5_ctx;
  56. unsigned char md5sum[16];
  57. size_t use_len;
  58. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  59. mbedtls_md5_init(&md5_ctx);
  60. /*
  61. * key[ 0..15] = MD5(pwd || IV)
  62. */
  63. if ((ret = mbedtls_md5_starts_ret(&md5_ctx)) != 0) {
  64. goto exit;
  65. }
  66. if ((ret = mbedtls_md5_update_ret(&md5_ctx, pwd, pwdlen)) != 0) {
  67. goto exit;
  68. }
  69. if ((ret = mbedtls_md5_update_ret(&md5_ctx, iv, 8)) != 0) {
  70. goto exit;
  71. }
  72. if ((ret = mbedtls_md5_finish_ret(&md5_ctx, md5sum)) != 0) {
  73. goto exit;
  74. }
  75. if (keylen <= 16) {
  76. memcpy(key, md5sum, keylen);
  77. goto exit;
  78. }
  79. memcpy(key, md5sum, 16);
  80. /*
  81. * key[16..23] = MD5(key[ 0..15] || pwd || IV])
  82. */
  83. if ((ret = mbedtls_md5_starts_ret(&md5_ctx)) != 0) {
  84. goto exit;
  85. }
  86. if ((ret = mbedtls_md5_update_ret(&md5_ctx, md5sum, 16)) != 0) {
  87. goto exit;
  88. }
  89. if ((ret = mbedtls_md5_update_ret(&md5_ctx, pwd, pwdlen)) != 0) {
  90. goto exit;
  91. }
  92. if ((ret = mbedtls_md5_update_ret(&md5_ctx, iv, 8)) != 0) {
  93. goto exit;
  94. }
  95. if ((ret = mbedtls_md5_finish_ret(&md5_ctx, md5sum)) != 0) {
  96. goto exit;
  97. }
  98. use_len = 16;
  99. if (keylen < 32) {
  100. use_len = keylen - 16;
  101. }
  102. memcpy(key + 16, md5sum, use_len);
  103. exit:
  104. mbedtls_md5_free(&md5_ctx);
  105. mbedtls_platform_zeroize(md5sum, 16);
  106. return ret;
  107. }
  108. #if defined(MBEDTLS_DES_C)
  109. /*
  110. * Decrypt with DES-CBC, using PBKDF1 for key derivation
  111. */
  112. static int pem_des_decrypt(unsigned char des_iv[8],
  113. unsigned char *buf, size_t buflen,
  114. const unsigned char *pwd, size_t pwdlen)
  115. {
  116. mbedtls_des_context des_ctx;
  117. unsigned char des_key[8];
  118. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  119. mbedtls_des_init(&des_ctx);
  120. if ((ret = pem_pbkdf1(des_key, 8, des_iv, pwd, pwdlen)) != 0) {
  121. goto exit;
  122. }
  123. if ((ret = mbedtls_des_setkey_dec(&des_ctx, des_key)) != 0) {
  124. goto exit;
  125. }
  126. ret = mbedtls_des_crypt_cbc(&des_ctx, MBEDTLS_DES_DECRYPT, buflen,
  127. des_iv, buf, buf);
  128. exit:
  129. mbedtls_des_free(&des_ctx);
  130. mbedtls_platform_zeroize(des_key, 8);
  131. return ret;
  132. }
  133. /*
  134. * Decrypt with 3DES-CBC, using PBKDF1 for key derivation
  135. */
  136. static int pem_des3_decrypt(unsigned char des3_iv[8],
  137. unsigned char *buf, size_t buflen,
  138. const unsigned char *pwd, size_t pwdlen)
  139. {
  140. mbedtls_des3_context des3_ctx;
  141. unsigned char des3_key[24];
  142. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  143. mbedtls_des3_init(&des3_ctx);
  144. if ((ret = pem_pbkdf1(des3_key, 24, des3_iv, pwd, pwdlen)) != 0) {
  145. goto exit;
  146. }
  147. if ((ret = mbedtls_des3_set3key_dec(&des3_ctx, des3_key)) != 0) {
  148. goto exit;
  149. }
  150. ret = mbedtls_des3_crypt_cbc(&des3_ctx, MBEDTLS_DES_DECRYPT, buflen,
  151. des3_iv, buf, buf);
  152. exit:
  153. mbedtls_des3_free(&des3_ctx);
  154. mbedtls_platform_zeroize(des3_key, 24);
  155. return ret;
  156. }
  157. #endif /* MBEDTLS_DES_C */
  158. #if defined(MBEDTLS_AES_C)
  159. /*
  160. * Decrypt with AES-XXX-CBC, using PBKDF1 for key derivation
  161. */
  162. static int pem_aes_decrypt(unsigned char aes_iv[16], unsigned int keylen,
  163. unsigned char *buf, size_t buflen,
  164. const unsigned char *pwd, size_t pwdlen)
  165. {
  166. mbedtls_aes_context aes_ctx;
  167. unsigned char aes_key[32];
  168. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  169. mbedtls_aes_init(&aes_ctx);
  170. if ((ret = pem_pbkdf1(aes_key, keylen, aes_iv, pwd, pwdlen)) != 0) {
  171. goto exit;
  172. }
  173. if ((ret = mbedtls_aes_setkey_dec(&aes_ctx, aes_key, keylen * 8)) != 0) {
  174. goto exit;
  175. }
  176. ret = mbedtls_aes_crypt_cbc(&aes_ctx, MBEDTLS_AES_DECRYPT, buflen,
  177. aes_iv, buf, buf);
  178. exit:
  179. mbedtls_aes_free(&aes_ctx);
  180. mbedtls_platform_zeroize(aes_key, keylen);
  181. return ret;
  182. }
  183. #endif /* MBEDTLS_AES_C */
  184. #endif /* MBEDTLS_MD5_C && MBEDTLS_CIPHER_MODE_CBC &&
  185. ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
  186. int mbedtls_pem_read_buffer(mbedtls_pem_context *ctx, const char *header, const char *footer,
  187. const unsigned char *data, const unsigned char *pwd,
  188. size_t pwdlen, size_t *use_len)
  189. {
  190. int ret, enc;
  191. size_t len;
  192. unsigned char *buf;
  193. const unsigned char *s1, *s2, *end;
  194. #if defined(MBEDTLS_MD5_C) && defined(MBEDTLS_CIPHER_MODE_CBC) && \
  195. (defined(MBEDTLS_DES_C) || defined(MBEDTLS_AES_C))
  196. unsigned char pem_iv[16];
  197. mbedtls_cipher_type_t enc_alg = MBEDTLS_CIPHER_NONE;
  198. #else
  199. ((void) pwd);
  200. ((void) pwdlen);
  201. #endif /* MBEDTLS_MD5_C && MBEDTLS_CIPHER_MODE_CBC &&
  202. ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
  203. if (ctx == NULL) {
  204. return MBEDTLS_ERR_PEM_BAD_INPUT_DATA;
  205. }
  206. s1 = (unsigned char *) strstr((const char *) data, header);
  207. if (s1 == NULL) {
  208. return MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  209. }
  210. s2 = (unsigned char *) strstr((const char *) data, footer);
  211. if (s2 == NULL || s2 <= s1) {
  212. return MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  213. }
  214. s1 += strlen(header);
  215. if (*s1 == ' ') {
  216. s1++;
  217. }
  218. if (*s1 == '\r') {
  219. s1++;
  220. }
  221. if (*s1 == '\n') {
  222. s1++;
  223. } else {
  224. return MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT;
  225. }
  226. end = s2;
  227. end += strlen(footer);
  228. if (*end == ' ') {
  229. end++;
  230. }
  231. if (*end == '\r') {
  232. end++;
  233. }
  234. if (*end == '\n') {
  235. end++;
  236. }
  237. *use_len = end - data;
  238. enc = 0;
  239. if (s2 - s1 >= 22 && memcmp(s1, "Proc-Type: 4,ENCRYPTED", 22) == 0) {
  240. #if defined(MBEDTLS_MD5_C) && defined(MBEDTLS_CIPHER_MODE_CBC) && \
  241. (defined(MBEDTLS_DES_C) || defined(MBEDTLS_AES_C))
  242. enc++;
  243. s1 += 22;
  244. if (*s1 == '\r') {
  245. s1++;
  246. }
  247. if (*s1 == '\n') {
  248. s1++;
  249. } else {
  250. return MBEDTLS_ERR_PEM_INVALID_DATA;
  251. }
  252. #if defined(MBEDTLS_DES_C)
  253. if (s2 - s1 >= 23 && memcmp(s1, "DEK-Info: DES-EDE3-CBC,", 23) == 0) {
  254. enc_alg = MBEDTLS_CIPHER_DES_EDE3_CBC;
  255. s1 += 23;
  256. if (s2 - s1 < 16 || pem_get_iv(s1, pem_iv, 8) != 0) {
  257. return MBEDTLS_ERR_PEM_INVALID_ENC_IV;
  258. }
  259. s1 += 16;
  260. } else if (s2 - s1 >= 18 && memcmp(s1, "DEK-Info: DES-CBC,", 18) == 0) {
  261. enc_alg = MBEDTLS_CIPHER_DES_CBC;
  262. s1 += 18;
  263. if (s2 - s1 < 16 || pem_get_iv(s1, pem_iv, 8) != 0) {
  264. return MBEDTLS_ERR_PEM_INVALID_ENC_IV;
  265. }
  266. s1 += 16;
  267. }
  268. #endif /* MBEDTLS_DES_C */
  269. #if defined(MBEDTLS_AES_C)
  270. if (s2 - s1 >= 14 && memcmp(s1, "DEK-Info: AES-", 14) == 0) {
  271. if (s2 - s1 < 22) {
  272. return MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG;
  273. } else if (memcmp(s1, "DEK-Info: AES-128-CBC,", 22) == 0) {
  274. enc_alg = MBEDTLS_CIPHER_AES_128_CBC;
  275. } else if (memcmp(s1, "DEK-Info: AES-192-CBC,", 22) == 0) {
  276. enc_alg = MBEDTLS_CIPHER_AES_192_CBC;
  277. } else if (memcmp(s1, "DEK-Info: AES-256-CBC,", 22) == 0) {
  278. enc_alg = MBEDTLS_CIPHER_AES_256_CBC;
  279. } else {
  280. return MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG;
  281. }
  282. s1 += 22;
  283. if (s2 - s1 < 32 || pem_get_iv(s1, pem_iv, 16) != 0) {
  284. return MBEDTLS_ERR_PEM_INVALID_ENC_IV;
  285. }
  286. s1 += 32;
  287. }
  288. #endif /* MBEDTLS_AES_C */
  289. if (enc_alg == MBEDTLS_CIPHER_NONE) {
  290. return MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG;
  291. }
  292. if (*s1 == '\r') {
  293. s1++;
  294. }
  295. if (*s1 == '\n') {
  296. s1++;
  297. } else {
  298. return MBEDTLS_ERR_PEM_INVALID_DATA;
  299. }
  300. #else
  301. return MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE;
  302. #endif /* MBEDTLS_MD5_C && MBEDTLS_CIPHER_MODE_CBC &&
  303. ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
  304. }
  305. if (s1 >= s2) {
  306. return MBEDTLS_ERR_PEM_INVALID_DATA;
  307. }
  308. ret = mbedtls_base64_decode(NULL, 0, &len, s1, s2 - s1);
  309. if (ret == MBEDTLS_ERR_BASE64_INVALID_CHARACTER) {
  310. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PEM_INVALID_DATA, ret);
  311. }
  312. if ((buf = mbedtls_calloc(1, len)) == NULL) {
  313. return MBEDTLS_ERR_PEM_ALLOC_FAILED;
  314. }
  315. if ((ret = mbedtls_base64_decode(buf, len, &len, s1, s2 - s1)) != 0) {
  316. mbedtls_platform_zeroize(buf, len);
  317. mbedtls_free(buf);
  318. return MBEDTLS_ERROR_ADD(MBEDTLS_ERR_PEM_INVALID_DATA, ret);
  319. }
  320. if (enc != 0) {
  321. #if defined(MBEDTLS_MD5_C) && defined(MBEDTLS_CIPHER_MODE_CBC) && \
  322. (defined(MBEDTLS_DES_C) || defined(MBEDTLS_AES_C))
  323. if (pwd == NULL) {
  324. mbedtls_platform_zeroize(buf, len);
  325. mbedtls_free(buf);
  326. return MBEDTLS_ERR_PEM_PASSWORD_REQUIRED;
  327. }
  328. ret = 0;
  329. #if defined(MBEDTLS_DES_C)
  330. if (enc_alg == MBEDTLS_CIPHER_DES_EDE3_CBC) {
  331. ret = pem_des3_decrypt(pem_iv, buf, len, pwd, pwdlen);
  332. } else if (enc_alg == MBEDTLS_CIPHER_DES_CBC) {
  333. ret = pem_des_decrypt(pem_iv, buf, len, pwd, pwdlen);
  334. }
  335. #endif /* MBEDTLS_DES_C */
  336. #if defined(MBEDTLS_AES_C)
  337. if (enc_alg == MBEDTLS_CIPHER_AES_128_CBC) {
  338. ret = pem_aes_decrypt(pem_iv, 16, buf, len, pwd, pwdlen);
  339. } else if (enc_alg == MBEDTLS_CIPHER_AES_192_CBC) {
  340. ret = pem_aes_decrypt(pem_iv, 24, buf, len, pwd, pwdlen);
  341. } else if (enc_alg == MBEDTLS_CIPHER_AES_256_CBC) {
  342. ret = pem_aes_decrypt(pem_iv, 32, buf, len, pwd, pwdlen);
  343. }
  344. #endif /* MBEDTLS_AES_C */
  345. if (ret != 0) {
  346. mbedtls_free(buf);
  347. return ret;
  348. }
  349. /*
  350. * The result will be ASN.1 starting with a SEQUENCE tag, with 1 to 3
  351. * length bytes (allow 4 to be sure) in all known use cases.
  352. *
  353. * Use that as a heuristic to try to detect password mismatches.
  354. */
  355. if (len <= 2 || buf[0] != 0x30 || buf[1] > 0x83) {
  356. mbedtls_platform_zeroize(buf, len);
  357. mbedtls_free(buf);
  358. return MBEDTLS_ERR_PEM_PASSWORD_MISMATCH;
  359. }
  360. #else
  361. mbedtls_platform_zeroize(buf, len);
  362. mbedtls_free(buf);
  363. return MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE;
  364. #endif /* MBEDTLS_MD5_C && MBEDTLS_CIPHER_MODE_CBC &&
  365. ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
  366. }
  367. ctx->buf = buf;
  368. ctx->buflen = len;
  369. return 0;
  370. }
  371. void mbedtls_pem_free(mbedtls_pem_context *ctx)
  372. {
  373. if (ctx->buf != NULL) {
  374. mbedtls_platform_zeroize(ctx->buf, ctx->buflen);
  375. mbedtls_free(ctx->buf);
  376. }
  377. mbedtls_free(ctx->info);
  378. mbedtls_platform_zeroize(ctx, sizeof(mbedtls_pem_context));
  379. }
  380. #endif /* MBEDTLS_PEM_PARSE_C */
  381. #if defined(MBEDTLS_PEM_WRITE_C)
  382. int mbedtls_pem_write_buffer(const char *header, const char *footer,
  383. const unsigned char *der_data, size_t der_len,
  384. unsigned char *buf, size_t buf_len, size_t *olen)
  385. {
  386. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  387. unsigned char *encode_buf = NULL, *c, *p = buf;
  388. size_t len = 0, use_len, add_len = 0;
  389. mbedtls_base64_encode(NULL, 0, &use_len, der_data, der_len);
  390. add_len = strlen(header) + strlen(footer) + (use_len / 64) + 1;
  391. if (use_len + add_len > buf_len) {
  392. *olen = use_len + add_len;
  393. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  394. }
  395. if (use_len != 0 &&
  396. ((encode_buf = mbedtls_calloc(1, use_len)) == NULL)) {
  397. return MBEDTLS_ERR_PEM_ALLOC_FAILED;
  398. }
  399. if ((ret = mbedtls_base64_encode(encode_buf, use_len, &use_len, der_data,
  400. der_len)) != 0) {
  401. mbedtls_free(encode_buf);
  402. return ret;
  403. }
  404. memcpy(p, header, strlen(header));
  405. p += strlen(header);
  406. c = encode_buf;
  407. while (use_len) {
  408. len = (use_len > 64) ? 64 : use_len;
  409. memcpy(p, c, len);
  410. use_len -= len;
  411. p += len;
  412. c += len;
  413. *p++ = '\n';
  414. }
  415. memcpy(p, footer, strlen(footer));
  416. p += strlen(footer);
  417. *p++ = '\0';
  418. *olen = p - buf;
  419. /* Clean any remaining data previously written to the buffer */
  420. memset(buf + *olen, 0, buf_len - *olen);
  421. mbedtls_free(encode_buf);
  422. return 0;
  423. }
  424. #endif /* MBEDTLS_PEM_WRITE_C */
  425. #endif /* MBEDTLS_PEM_PARSE_C || MBEDTLS_PEM_WRITE_C */