1 /* $OpenBSD: pem_lib.c,v 1.49 2019/09/06 17:41:05 jsing Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
64 #include <openssl/opensslconf.h>
66 #include <openssl/buffer.h>
67 #include <openssl/err.h>
68 #include <openssl/evp.h>
69 #include <openssl/objects.h>
70 #include <openssl/pem.h>
71 #include <openssl/pkcs12.h>
72 #include <openssl/x509.h>
74 #ifndef OPENSSL_NO_DES
75 #include <openssl/des.h>
77 #ifndef OPENSSL_NO_ENGINE
78 #include <openssl/engine.h>
81 #include "asn1_locl.h"
85 static int load_iv(char **fromp, unsigned char *to, int num);
86 static int check_pem(const char *nm, const char *name);
87 int pem_check_suffix(const char *pem_str, const char *suffix);
89 /* XXX LSSL ABI XXX return value and `num' ought to be size_t */
91 PEM_def_callback(char *buf, int num, int w, void *key)
108 prompt = EVP_get_pw_prompt();
110 prompt = "Enter PEM pass phrase:";
113 i = EVP_read_pw_string_min(buf, MIN_LENGTH, num, prompt, w);
115 PEMerror(PEM_R_PROBLEMS_GETTING_PASSWORD);
120 if (l < MIN_LENGTH) {
121 fprintf(stderr, "phrase is too short, "
122 "needs to be at least %zu chars\n",
131 PEM_proc_type(char *buf, int type)
135 if (type == PEM_TYPE_ENCRYPTED)
137 else if (type == PEM_TYPE_MIC_CLEAR)
139 else if (type == PEM_TYPE_MIC_ONLY)
144 strlcat(buf, "Proc-Type: 4,", PEM_BUFSIZE);
145 strlcat(buf, str, PEM_BUFSIZE);
146 strlcat(buf, "\n", PEM_BUFSIZE);
150 PEM_dek_info(char *buf, const char *type, int len, char *str)
152 static const unsigned char map[17] = "0123456789ABCDEF";
156 strlcat(buf, "DEK-Info: ", PEM_BUFSIZE);
157 strlcat(buf, type, PEM_BUFSIZE);
158 strlcat(buf, ",", PEM_BUFSIZE);
160 if (j + (len * 2) + 1 > PEM_BUFSIZE)
162 for (i = 0; i < len; i++) {
163 buf[j + i * 2] = map[(str[i] >> 4) & 0x0f];
164 buf[j + i * 2 + 1] = map[(str[i]) & 0x0f];
166 buf[j + i * 2] = '\n';
167 buf[j + i * 2 + 1] = '\0';
171 PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
172 pem_password_cb *cb, void *u)
177 if ((b = BIO_new(BIO_s_file())) == NULL) {
178 PEMerror(ERR_R_BUF_LIB);
181 BIO_set_fp(b, fp, BIO_NOCLOSE);
182 ret = PEM_ASN1_read_bio(d2i, name, b, x, cb, u);
188 check_pem(const char *nm, const char *name)
190 /* Normal matching nm and name */
191 if (!strcmp(nm, name))
194 /* Make PEM_STRING_EVP_PKEY match any private key */
196 if (!strcmp(name, PEM_STRING_EVP_PKEY)) {
198 const EVP_PKEY_ASN1_METHOD *ameth;
199 if (!strcmp(nm, PEM_STRING_PKCS8))
201 if (!strcmp(nm, PEM_STRING_PKCS8INF))
203 slen = pem_check_suffix(nm, "PRIVATE KEY");
205 /* NB: ENGINE implementations wont contain
206 * a deprecated old private key decode function
207 * so don't look for them.
209 ameth = EVP_PKEY_asn1_find_str(NULL, nm, slen);
210 if (ameth && ameth->old_priv_decode)
216 if (!strcmp(name, PEM_STRING_PARAMETERS)) {
218 const EVP_PKEY_ASN1_METHOD *ameth;
219 slen = pem_check_suffix(nm, "PARAMETERS");
222 ameth = EVP_PKEY_asn1_find_str(&e, nm, slen);
225 if (ameth->param_decode)
229 #ifndef OPENSSL_NO_ENGINE
238 /* Permit older strings */
240 if (!strcmp(nm, PEM_STRING_X509_OLD) &&
241 !strcmp(name, PEM_STRING_X509))
244 if (!strcmp(nm, PEM_STRING_X509_REQ_OLD) &&
245 !strcmp(name, PEM_STRING_X509_REQ))
248 /* Allow normal certs to be read as trusted certs */
249 if (!strcmp(nm, PEM_STRING_X509) &&
250 !strcmp(name, PEM_STRING_X509_TRUSTED))
253 if (!strcmp(nm, PEM_STRING_X509_OLD) &&
254 !strcmp(name, PEM_STRING_X509_TRUSTED))
257 /* Some CAs use PKCS#7 with CERTIFICATE headers */
258 if (!strcmp(nm, PEM_STRING_X509) &&
259 !strcmp(name, PEM_STRING_PKCS7))
262 if (!strcmp(nm, PEM_STRING_PKCS7_SIGNED) &&
263 !strcmp(name, PEM_STRING_PKCS7))
266 #ifndef OPENSSL_NO_CMS
267 if (strcmp(nm, PEM_STRING_X509) == 0 &&
268 strcmp(name, PEM_STRING_CMS) == 0)
271 /* Allow CMS to be read from PKCS#7 headers */
272 if (strcmp(nm, PEM_STRING_PKCS7) == 0 &&
273 strcmp(name, PEM_STRING_CMS) == 0)
281 PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm,
282 const char *name, BIO *bp, pem_password_cb *cb, void *u)
284 EVP_CIPHER_INFO cipher;
285 char *nm = NULL, *header = NULL;
286 unsigned char *data = NULL;
291 if (!PEM_read_bio(bp, &nm, &header, &data, &len)) {
292 if (ERR_GET_REASON(ERR_peek_error()) ==
294 ERR_asprintf_error_data("Expecting: %s", name);
297 if (check_pem(nm, name))
303 if (!PEM_get_EVP_CIPHER_INFO(header, &cipher))
305 if (!PEM_do_header(&cipher, data, &len, cb, u))
326 PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp, void *x,
327 const EVP_CIPHER *enc, unsigned char *kstr, int klen,
328 pem_password_cb *callback, void *u)
333 if ((b = BIO_new(BIO_s_file())) == NULL) {
334 PEMerror(ERR_R_BUF_LIB);
337 BIO_set_fp(b, fp, BIO_NOCLOSE);
338 ret = PEM_ASN1_write_bio(i2d, name, b, x, enc, kstr, klen, callback, u);
344 PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp, void *x,
345 const EVP_CIPHER *enc, unsigned char *kstr, int klen,
346 pem_password_cb *callback, void *u)
349 int dsize = 0, i, j, ret = 0;
350 unsigned char *p, *data = NULL;
351 const char *objstr = NULL;
352 char buf[PEM_BUFSIZE];
353 unsigned char key[EVP_MAX_KEY_LENGTH];
354 unsigned char iv[EVP_MAX_IV_LENGTH];
357 objstr = OBJ_nid2sn(EVP_CIPHER_nid(enc));
358 if (objstr == NULL) {
359 PEMerror(PEM_R_UNSUPPORTED_CIPHER);
364 if ((dsize = i2d(x, NULL)) < 0) {
365 PEMerror(ERR_R_ASN1_LIB);
369 /* dzise + 8 bytes are needed */
370 /* actually it needs the cipher block size extra... */
371 data = malloc(dsize + 20);
373 PEMerror(ERR_R_MALLOC_FAILURE);
381 if (callback == NULL)
382 klen = PEM_def_callback(buf, PEM_BUFSIZE, 1, u);
384 klen = (*callback)(buf, PEM_BUFSIZE, 1, u);
386 PEMerror(PEM_R_READ_KEY);
389 kstr = (unsigned char *)buf;
391 if ((size_t)enc->iv_len > sizeof(iv)) {
392 PEMerror(EVP_R_IV_TOO_LARGE);
395 arc4random_buf(iv, enc->iv_len); /* Generate a salt */
396 /* The 'iv' is used as the iv and as a salt. It is
397 * NOT taken from the BytesToKey function */
398 if (!EVP_BytesToKey(enc, EVP_md5(), iv, kstr, klen, 1,
402 if (kstr == (unsigned char *)buf)
403 explicit_bzero(buf, PEM_BUFSIZE);
405 if (strlen(objstr) + 23 + 2 * enc->iv_len + 13 > sizeof buf) {
406 PEMerror(ASN1_R_BUFFER_TOO_SMALL);
411 PEM_proc_type(buf, PEM_TYPE_ENCRYPTED);
412 PEM_dek_info(buf, objstr, enc->iv_len, (char *)iv);
415 EVP_CIPHER_CTX_init(&ctx);
417 if (!EVP_EncryptInit_ex(&ctx, enc, NULL, key, iv) ||
418 !EVP_EncryptUpdate(&ctx, data, &j, data, i) ||
419 !EVP_EncryptFinal_ex(&ctx, &(data[j]), &i))
421 EVP_CIPHER_CTX_cleanup(&ctx);
429 i = PEM_write_bio(bp, name, buf, data, i);
433 explicit_bzero(key, sizeof(key));
434 explicit_bzero(iv, sizeof(iv));
435 explicit_bzero((char *)&ctx, sizeof(ctx));
436 explicit_bzero(buf, PEM_BUFSIZE);
437 freezero(data, (unsigned int)dsize);
442 PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *plen,
443 pem_password_cb *callback, void *u)
448 unsigned char key[EVP_MAX_KEY_LENGTH];
449 char buf[PEM_BUFSIZE];
453 if (cipher->cipher == NULL)
455 if (callback == NULL)
456 klen = PEM_def_callback(buf, PEM_BUFSIZE, 0, u);
458 klen = callback(buf, PEM_BUFSIZE, 0, u);
460 PEMerror(PEM_R_BAD_PASSWORD_READ);
463 if (!EVP_BytesToKey(cipher->cipher, EVP_md5(), &(cipher->iv[0]),
464 (unsigned char *)buf, klen, 1, key, NULL))
468 EVP_CIPHER_CTX_init(&ctx);
469 o = EVP_DecryptInit_ex(&ctx, cipher->cipher, NULL, key,
472 o = EVP_DecryptUpdate(&ctx, data, &i, data, j);
474 o = EVP_DecryptFinal_ex(&ctx, &(data[i]), &j);
475 EVP_CIPHER_CTX_cleanup(&ctx);
476 explicit_bzero((char *)buf, sizeof(buf));
477 explicit_bzero((char *)key, sizeof(key));
479 PEMerror(PEM_R_BAD_DECRYPT);
487 PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher)
489 const EVP_CIPHER *enc = NULL;
491 char **header_pp = &header;
493 cipher->cipher = NULL;
494 if ((header == NULL) || (*header == '\0') || (*header == '\n'))
496 if (strncmp(header, "Proc-Type: ", 11) != 0) {
497 PEMerror(PEM_R_NOT_PROC_TYPE);
507 if (strncmp(header, "ENCRYPTED", 9) != 0) {
508 PEMerror(PEM_R_NOT_ENCRYPTED);
511 for (; (*header != '\n') && (*header != '\0'); header++)
513 if (*header == '\0') {
514 PEMerror(PEM_R_SHORT_HEADER);
518 if (strncmp(header, "DEK-Info: ", 10) != 0) {
519 PEMerror(PEM_R_NOT_DEK_INFO);
527 if (!( ((c >= 'A') && (c <= 'Z')) || (c == '-') ||
528 ((c >= '0') && (c <= '9'))))
533 cipher->cipher = enc = EVP_get_cipherbyname(p);
538 PEMerror(PEM_R_UNSUPPORTED_ENCRYPTION);
541 if (!load_iv(header_pp, &(cipher->iv[0]), enc->iv_len))
548 load_iv(char **fromp, unsigned char *to, int num)
554 for (i = 0; i < num; i++)
557 for (i = 0; i < num; i++) {
558 if ((*from >= '0') && (*from <= '9'))
560 else if ((*from >= 'A') && (*from <= 'F'))
561 v = *from - 'A' + 10;
562 else if ((*from >= 'a') && (*from <= 'f'))
563 v = *from - 'a' + 10;
565 PEMerror(PEM_R_BAD_IV_CHARS);
569 to[i / 2] |= v << (long)((!(i & 1)) * 4);
577 PEM_write(FILE *fp, const char *name, const char *header,
578 const unsigned char *data, long len)
583 if ((b = BIO_new(BIO_s_file())) == NULL) {
584 PEMerror(ERR_R_BUF_LIB);
587 BIO_set_fp(b, fp, BIO_NOCLOSE);
588 ret = PEM_write_bio(b, name, header, data, len);
594 PEM_write_bio(BIO *bp, const char *name, const char *header,
595 const unsigned char *data, long len)
597 int nlen, n, i, j, outl;
598 unsigned char *buf = NULL;
600 int reason = ERR_R_BUF_LIB;
602 EVP_EncodeInit(&ctx);
605 if ((BIO_write(bp, "-----BEGIN ", 11) != 11) ||
606 (BIO_write(bp, name, nlen) != nlen) ||
607 (BIO_write(bp, "-----\n", 6) != 6))
612 if ((BIO_write(bp, header, i) != i) ||
613 (BIO_write(bp, "\n", 1) != 1))
617 buf = reallocarray(NULL, PEM_BUFSIZE, 8);
619 reason = ERR_R_MALLOC_FAILURE;
625 n = (int)((len > (PEM_BUFSIZE * 5)) ? (PEM_BUFSIZE * 5) : len);
626 if (!EVP_EncodeUpdate(&ctx, buf, &outl, &(data[j]), n))
628 if ((outl) && (BIO_write(bp, (char *)buf, outl) != outl))
634 EVP_EncodeFinal(&ctx, buf, &outl);
635 if ((outl > 0) && (BIO_write(bp, (char *)buf, outl) != outl))
637 freezero(buf, PEM_BUFSIZE * 8);
639 if ((BIO_write(bp, "-----END ", 9) != 9) ||
640 (BIO_write(bp, name, nlen) != nlen) ||
641 (BIO_write(bp, "-----\n", 6) != 6))
646 freezero(buf, PEM_BUFSIZE * 8);
652 PEM_read(FILE *fp, char **name, char **header, unsigned char **data, long *len)
657 if ((b = BIO_new(BIO_s_file())) == NULL) {
658 PEMerror(ERR_R_BUF_LIB);
661 BIO_set_fp(b, fp, BIO_NOCLOSE);
662 ret = PEM_read_bio(b, name, header, data, len);
668 PEM_read_bio(BIO *bp, char **name, char **header, unsigned char **data,
672 int end = 0, i, k, bl = 0, hl = 0, nohead = 0;
676 BUF_MEM *dataB, *tmpB;
678 nameB = BUF_MEM_new();
679 headerB = BUF_MEM_new();
680 dataB = BUF_MEM_new();
681 if ((nameB == NULL) || (headerB == NULL) || (dataB == NULL)) {
683 BUF_MEM_free(headerB);
685 PEMerror(ERR_R_MALLOC_FAILURE);
691 i = BIO_gets(bp, buf, 254);
694 PEMerror(PEM_R_NO_START_LINE);
698 while ((i >= 0) && (buf[i] <= ' '))
703 if (strncmp(buf, "-----BEGIN ", 11) == 0) {
704 i = strlen(&(buf[11]));
706 if (strncmp(&(buf[11 + i - 6]), "-----\n", 6) != 0)
708 if (!BUF_MEM_grow(nameB, i + 9)) {
709 PEMerror(ERR_R_MALLOC_FAILURE);
712 memcpy(nameB->data, &(buf[11]), i - 6);
713 nameB->data[i - 6] = '\0';
718 if (!BUF_MEM_grow(headerB, 256)) {
719 PEMerror(ERR_R_MALLOC_FAILURE);
722 headerB->data[0] = '\0';
724 i = BIO_gets(bp, buf, 254);
728 while ((i >= 0) && (buf[i] <= ' '))
735 if (!BUF_MEM_grow(headerB, hl + i + 9)) {
736 PEMerror(ERR_R_MALLOC_FAILURE);
739 if (strncmp(buf, "-----END ", 9) == 0) {
743 memcpy(&(headerB->data[hl]), buf, i);
744 headerB->data[hl + i] = '\0';
749 if (!BUF_MEM_grow(dataB, 1024)) {
750 PEMerror(ERR_R_MALLOC_FAILURE);
753 dataB->data[0] = '\0';
756 i = BIO_gets(bp, buf, 254);
760 while ((i >= 0) && (buf[i] <= ' '))
767 if (strncmp(buf, "-----END ", 9) == 0)
771 if (!BUF_MEM_grow_clean(dataB, i + bl + 9)) {
772 PEMerror(ERR_R_MALLOC_FAILURE);
775 memcpy(&(dataB->data[bl]), buf, i);
776 dataB->data[bl + i] = '\0';
780 i = BIO_gets(bp, buf, 254);
784 while ((i >= 0) && (buf[i] <= ' '))
798 i = strlen(nameB->data);
799 if ((strncmp(buf, "-----END ", 9) != 0) ||
800 (strncmp(nameB->data, &(buf[9]), i) != 0) ||
801 (strncmp(&(buf[9 + i]), "-----\n", 6) != 0)) {
802 PEMerror(PEM_R_BAD_END_LINE);
806 EVP_DecodeInit(&ctx);
807 i = EVP_DecodeUpdate(&ctx,
808 (unsigned char *)dataB->data, &bl,
809 (unsigned char *)dataB->data, bl);
811 PEMerror(PEM_R_BAD_BASE64_DECODE);
814 i = EVP_DecodeFinal(&ctx, (unsigned char *)&(dataB->data[bl]), &k);
816 PEMerror(PEM_R_BAD_BASE64_DECODE);
824 *header = headerB->data;
825 *data = (unsigned char *)dataB->data;
834 BUF_MEM_free(headerB);
839 /* Check pem string and return prefix length.
840 * If for example the pem_str == "RSA PRIVATE KEY" and suffix = "PRIVATE KEY"
841 * the return value is 3 for the string "RSA".
845 pem_check_suffix(const char *pem_str, const char *suffix)
847 int pem_len = strlen(pem_str);
848 int suffix_len = strlen(suffix);
851 if (suffix_len + 1 >= pem_len)
853 p = pem_str + pem_len - suffix_len;
854 if (strcmp(p, suffix))