2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
13 #include "internal/cryptlib.h"
14 #include <openssl/buffer.h>
15 #include <openssl/objects.h>
16 #include <openssl/evp.h>
17 #include <openssl/rand.h>
18 #include <openssl/x509.h>
19 #include <openssl/pem.h>
20 #include <openssl/pkcs12.h>
21 #include "internal/asn1_int.h"
22 #include <openssl/des.h>
23 #include <openssl/engine.h>
27 static int load_iv(char **fromp, unsigned char *to, int num);
28 static int check_pem(const char *nm, const char *name);
29 int pem_check_suffix(const char *pem_str, const char *suffix);
31 int PEM_def_callback(char *buf, int num, int rwflag, void *userdata)
39 /* We assume that the user passes a default password as userdata */
42 i = (i > num) ? num : i;
43 memcpy(buf, userdata, i);
48 PEMerr(PEM_F_PEM_DEF_CALLBACK, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
51 prompt = EVP_get_pw_prompt();
53 prompt = "Enter PEM pass phrase:";
56 * rwflag == 0 means decryption
57 * rwflag == 1 means encryption
59 * We assume that for encryption, we want a minimum length, while for
60 * decryption, we cannot know any minimum length, so we assume zero.
62 min_len = rwflag ? MIN_LENGTH : 0;
64 i = EVP_read_pw_string_min(buf, min_len, num, prompt, rwflag);
66 PEMerr(PEM_F_PEM_DEF_CALLBACK, PEM_R_PROBLEMS_GETTING_PASSWORD);
67 memset(buf, 0, (unsigned int)num);
74 void PEM_proc_type(char *buf, int type)
78 if (type == PEM_TYPE_ENCRYPTED)
80 else if (type == PEM_TYPE_MIC_CLEAR)
82 else if (type == PEM_TYPE_MIC_ONLY)
87 OPENSSL_strlcat(buf, "Proc-Type: 4,", PEM_BUFSIZE);
88 OPENSSL_strlcat(buf, str, PEM_BUFSIZE);
89 OPENSSL_strlcat(buf, "\n", PEM_BUFSIZE);
92 void PEM_dek_info(char *buf, const char *type, int len, char *str)
94 static const unsigned char map[17] = "0123456789ABCDEF";
98 OPENSSL_strlcat(buf, "DEK-Info: ", PEM_BUFSIZE);
99 OPENSSL_strlcat(buf, type, PEM_BUFSIZE);
100 OPENSSL_strlcat(buf, ",", PEM_BUFSIZE);
102 if (j + (len * 2) + 1 > PEM_BUFSIZE)
104 for (i = 0; i < len; i++) {
105 buf[j + i * 2] = map[(str[i] >> 4) & 0x0f];
106 buf[j + i * 2 + 1] = map[(str[i]) & 0x0f];
108 buf[j + i * 2] = '\n';
109 buf[j + i * 2 + 1] = '\0';
112 #ifndef OPENSSL_NO_STDIO
113 void *PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
114 pem_password_cb *cb, void *u)
119 if ((b = BIO_new(BIO_s_file())) == NULL) {
120 PEMerr(PEM_F_PEM_ASN1_READ, ERR_R_BUF_LIB);
123 BIO_set_fp(b, fp, BIO_NOCLOSE);
124 ret = PEM_ASN1_read_bio(d2i, name, b, x, cb, u);
130 static int check_pem(const char *nm, const char *name)
132 /* Normal matching nm and name */
133 if (strcmp(nm, name) == 0)
136 /* Make PEM_STRING_EVP_PKEY match any private key */
138 if (strcmp(name, PEM_STRING_EVP_PKEY) == 0) {
140 const EVP_PKEY_ASN1_METHOD *ameth;
141 if (strcmp(nm, PEM_STRING_PKCS8) == 0)
143 if (strcmp(nm, PEM_STRING_PKCS8INF) == 0)
145 slen = pem_check_suffix(nm, "PRIVATE KEY");
148 * NB: ENGINE implementations won't contain a deprecated old
149 * private key decode function so don't look for them.
151 ameth = EVP_PKEY_asn1_find_str(NULL, nm, slen);
152 if (ameth && ameth->old_priv_decode)
158 if (strcmp(name, PEM_STRING_PARAMETERS) == 0) {
160 const EVP_PKEY_ASN1_METHOD *ameth;
161 slen = pem_check_suffix(nm, "PARAMETERS");
164 ameth = EVP_PKEY_asn1_find_str(&e, nm, slen);
167 if (ameth->param_decode)
171 #ifndef OPENSSL_NO_ENGINE
179 /* If reading DH parameters handle X9.42 DH format too */
180 if (strcmp(nm, PEM_STRING_DHXPARAMS) == 0
181 && strcmp(name, PEM_STRING_DHPARAMS) == 0)
184 /* Permit older strings */
186 if (strcmp(nm, PEM_STRING_X509_OLD) == 0
187 && strcmp(name, PEM_STRING_X509) == 0)
190 if (strcmp(nm, PEM_STRING_X509_REQ_OLD) == 0
191 && strcmp(name, PEM_STRING_X509_REQ) == 0)
194 /* Allow normal certs to be read as trusted certs */
195 if (strcmp(nm, PEM_STRING_X509) == 0
196 && strcmp(name, PEM_STRING_X509_TRUSTED) == 0)
199 if (strcmp(nm, PEM_STRING_X509_OLD) == 0
200 && strcmp(name, PEM_STRING_X509_TRUSTED) == 0)
203 /* Some CAs use PKCS#7 with CERTIFICATE headers */
204 if (strcmp(nm, PEM_STRING_X509) == 0
205 && strcmp(name, PEM_STRING_PKCS7) == 0)
208 if (strcmp(nm, PEM_STRING_PKCS7_SIGNED) == 0
209 && strcmp(name, PEM_STRING_PKCS7) == 0)
212 #ifndef OPENSSL_NO_CMS
213 if (strcmp(nm, PEM_STRING_X509) == 0
214 && strcmp(name, PEM_STRING_CMS) == 0)
216 /* Allow CMS to be read from PKCS#7 headers */
217 if (strcmp(nm, PEM_STRING_PKCS7) == 0
218 && strcmp(name, PEM_STRING_CMS) == 0)
225 int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm,
226 const char *name, BIO *bp, pem_password_cb *cb,
229 EVP_CIPHER_INFO cipher;
230 char *nm = NULL, *header = NULL;
231 unsigned char *data = NULL;
236 if (!PEM_read_bio(bp, &nm, &header, &data, &len)) {
237 if (ERR_GET_REASON(ERR_peek_error()) == PEM_R_NO_START_LINE)
238 ERR_add_error_data(2, "Expecting: ", name);
241 if (check_pem(nm, name))
244 OPENSSL_free(header);
247 if (!PEM_get_EVP_CIPHER_INFO(header, &cipher))
249 if (!PEM_do_header(&cipher, data, &len, cb, u))
263 OPENSSL_free(header);
269 #ifndef OPENSSL_NO_STDIO
270 int PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp,
271 void *x, const EVP_CIPHER *enc, unsigned char *kstr,
272 int klen, pem_password_cb *callback, void *u)
277 if ((b = BIO_new(BIO_s_file())) == NULL) {
278 PEMerr(PEM_F_PEM_ASN1_WRITE, ERR_R_BUF_LIB);
281 BIO_set_fp(b, fp, BIO_NOCLOSE);
282 ret = PEM_ASN1_write_bio(i2d, name, b, x, enc, kstr, klen, callback, u);
288 int PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp,
289 void *x, const EVP_CIPHER *enc, unsigned char *kstr,
290 int klen, pem_password_cb *callback, void *u)
292 EVP_CIPHER_CTX *ctx = NULL;
293 int dsize = 0, i = 0, j = 0, ret = 0;
294 unsigned char *p, *data = NULL;
295 const char *objstr = NULL;
296 char buf[PEM_BUFSIZE];
297 unsigned char key[EVP_MAX_KEY_LENGTH];
298 unsigned char iv[EVP_MAX_IV_LENGTH];
301 objstr = OBJ_nid2sn(EVP_CIPHER_nid(enc));
302 if (objstr == NULL || EVP_CIPHER_iv_length(enc) == 0) {
303 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, PEM_R_UNSUPPORTED_CIPHER);
308 if ((dsize = i2d(x, NULL)) < 0) {
309 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, ERR_R_ASN1_LIB);
313 /* dsize + 8 bytes are needed */
314 /* actually it needs the cipher block size extra... */
315 data = OPENSSL_malloc((unsigned int)dsize + 20);
317 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, ERR_R_MALLOC_FAILURE);
325 if (callback == NULL)
326 klen = PEM_def_callback(buf, PEM_BUFSIZE, 1, u);
328 klen = (*callback) (buf, PEM_BUFSIZE, 1, u);
330 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, PEM_R_READ_KEY);
333 #ifdef CHARSET_EBCDIC
334 /* Convert the pass phrase from EBCDIC */
335 ebcdic2ascii(buf, buf, klen);
337 kstr = (unsigned char *)buf;
339 RAND_add(data, i, 0); /* put in the RSA key. */
340 OPENSSL_assert(EVP_CIPHER_iv_length(enc) <= (int)sizeof(iv));
341 if (RAND_bytes(iv, EVP_CIPHER_iv_length(enc)) <= 0) /* Generate a salt */
344 * The 'iv' is used as the iv and as a salt. It is NOT taken from
345 * the BytesToKey function
347 if (!EVP_BytesToKey(enc, EVP_md5(), iv, kstr, klen, 1, key, NULL))
350 if (kstr == (unsigned char *)buf)
351 OPENSSL_cleanse(buf, PEM_BUFSIZE);
353 OPENSSL_assert(strlen(objstr) + 23 + 2 * EVP_CIPHER_iv_length(enc) + 13
357 PEM_proc_type(buf, PEM_TYPE_ENCRYPTED);
358 PEM_dek_info(buf, objstr, EVP_CIPHER_iv_length(enc), (char *)iv);
362 if ((ctx = EVP_CIPHER_CTX_new()) == NULL
363 || !EVP_EncryptInit_ex(ctx, enc, NULL, key, iv)
364 || !EVP_EncryptUpdate(ctx, data, &j, data, i)
365 || !EVP_EncryptFinal_ex(ctx, &(data[j]), &i))
374 i = PEM_write_bio(bp, name, buf, data, i);
378 OPENSSL_cleanse(key, sizeof(key));
379 OPENSSL_cleanse(iv, sizeof(iv));
380 EVP_CIPHER_CTX_free(ctx);
381 OPENSSL_cleanse(buf, PEM_BUFSIZE);
382 OPENSSL_clear_free(data, (unsigned int)dsize);
386 int PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *plen,
387 pem_password_cb *callback, void *u)
392 int ilen = (int) len; /* EVP_DecryptUpdate etc. take int lengths */
394 unsigned char key[EVP_MAX_KEY_LENGTH];
395 char buf[PEM_BUFSIZE];
397 #if LONG_MAX > INT_MAX
398 /* Check that we did not truncate the length */
400 PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_HEADER_TOO_LONG);
405 if (cipher->cipher == NULL)
407 if (callback == NULL)
408 keylen = PEM_def_callback(buf, PEM_BUFSIZE, 0, u);
410 keylen = callback(buf, PEM_BUFSIZE, 0, u);
412 PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_BAD_PASSWORD_READ);
415 #ifdef CHARSET_EBCDIC
416 /* Convert the pass phrase from EBCDIC */
417 ebcdic2ascii(buf, buf, keylen);
420 if (!EVP_BytesToKey(cipher->cipher, EVP_md5(), &(cipher->iv[0]),
421 (unsigned char *)buf, keylen, 1, key, NULL))
424 ctx = EVP_CIPHER_CTX_new();
428 ok = EVP_DecryptInit_ex(ctx, cipher->cipher, NULL, key, &(cipher->iv[0]));
430 ok = EVP_DecryptUpdate(ctx, data, &ilen, data, ilen);
432 /* Squirrel away the length of data decrypted so far. */
434 ok = EVP_DecryptFinal_ex(ctx, &(data[ilen]), &ilen);
439 PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_BAD_DECRYPT);
441 EVP_CIPHER_CTX_free(ctx);
442 OPENSSL_cleanse((char *)buf, sizeof(buf));
443 OPENSSL_cleanse((char *)key, sizeof(key));
448 * This implements a very limited PEM header parser that does not support the
449 * full grammar of rfc1421. In particular, folded headers are not supported,
450 * nor is additional whitespace.
452 * A robust implementation would make use of a library that turns the headers
453 * into a BIO from which one folded line is read at a time, and is then split
454 * into a header label and content. We would then parse the content of the
455 * headers we care about. This is overkill for just this limited use-case, but
456 * presumably we also parse rfc822-style headers for S/MIME, so a common
457 * abstraction might well be more generally useful.
459 int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher)
461 static const char ProcType[] = "Proc-Type:";
462 static const char ENCRYPTED[] = "ENCRYPTED";
463 static const char DEKInfo[] = "DEK-Info:";
464 const EVP_CIPHER *enc = NULL;
466 char *dekinfostart, c;
468 cipher->cipher = NULL;
469 memset(cipher->iv, 0, sizeof(cipher->iv));
470 if ((header == NULL) || (*header == '\0') || (*header == '\n'))
473 if (strncmp(header, ProcType, sizeof(ProcType)-1) != 0) {
474 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_PROC_TYPE);
477 header += sizeof(ProcType)-1;
478 header += strspn(header, " \t");
480 if (*header++ != '4' || *header++ != ',')
482 header += strspn(header, " \t");
484 /* We expect "ENCRYPTED" followed by optional white-space + line break */
485 if (strncmp(header, ENCRYPTED, sizeof(ENCRYPTED)-1) != 0 ||
486 strspn(header+sizeof(ENCRYPTED)-1, " \t\r\n") == 0) {
487 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_ENCRYPTED);
490 header += sizeof(ENCRYPTED)-1;
491 header += strspn(header, " \t\r");
492 if (*header++ != '\n') {
493 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_SHORT_HEADER);
498 * https://tools.ietf.org/html/rfc1421#section-4.6.1.3
499 * We expect "DEK-Info: algo[,hex-parameters]"
501 if (strncmp(header, DEKInfo, sizeof(DEKInfo)-1) != 0) {
502 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_DEK_INFO);
505 header += sizeof(DEKInfo)-1;
506 header += strspn(header, " \t");
509 * DEK-INFO is a comma-separated combination of algorithm name and optional
512 dekinfostart = header;
513 header += strcspn(header, " \t,");
516 cipher->cipher = enc = EVP_get_cipherbyname(dekinfostart);
518 header += strspn(header, " \t");
521 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_UNSUPPORTED_ENCRYPTION);
524 ivlen = EVP_CIPHER_iv_length(enc);
525 if (ivlen > 0 && *header++ != ',') {
526 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_MISSING_DEK_IV);
528 } else if (ivlen == 0 && *header == ',') {
529 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_UNEXPECTED_DEK_IV);
533 if (!load_iv(&header, cipher->iv, EVP_CIPHER_iv_length(enc)))
539 static int load_iv(char **fromp, unsigned char *to, int num)
545 for (i = 0; i < num; i++)
548 for (i = 0; i < num; i++) {
549 v = OPENSSL_hexchar2int(*from);
551 PEMerr(PEM_F_LOAD_IV, PEM_R_BAD_IV_CHARS);
555 to[i / 2] |= v << (long)((!(i & 1)) * 4);
562 #ifndef OPENSSL_NO_STDIO
563 int PEM_write(FILE *fp, const char *name, const char *header,
564 const unsigned char *data, long len)
569 if ((b = BIO_new(BIO_s_file())) == NULL) {
570 PEMerr(PEM_F_PEM_WRITE, ERR_R_BUF_LIB);
573 BIO_set_fp(b, fp, BIO_NOCLOSE);
574 ret = PEM_write_bio(b, name, header, data, len);
580 int PEM_write_bio(BIO *bp, const char *name, const char *header,
581 const unsigned char *data, long len)
583 int nlen, n, i, j, outl;
584 unsigned char *buf = NULL;
585 EVP_ENCODE_CTX *ctx = EVP_ENCODE_CTX_new();
586 int reason = ERR_R_BUF_LIB;
589 reason = ERR_R_MALLOC_FAILURE;
596 if ((BIO_write(bp, "-----BEGIN ", 11) != 11) ||
597 (BIO_write(bp, name, nlen) != nlen) ||
598 (BIO_write(bp, "-----\n", 6) != 6))
603 if ((BIO_write(bp, header, i) != i) || (BIO_write(bp, "\n", 1) != 1))
607 buf = OPENSSL_malloc(PEM_BUFSIZE * 8);
609 reason = ERR_R_MALLOC_FAILURE;
615 n = (int)((len > (PEM_BUFSIZE * 5)) ? (PEM_BUFSIZE * 5) : len);
616 if (!EVP_EncodeUpdate(ctx, buf, &outl, &(data[j]), n))
618 if ((outl) && (BIO_write(bp, (char *)buf, outl) != outl))
624 EVP_EncodeFinal(ctx, buf, &outl);
625 if ((outl > 0) && (BIO_write(bp, (char *)buf, outl) != outl))
627 if ((BIO_write(bp, "-----END ", 9) != 9) ||
628 (BIO_write(bp, name, nlen) != nlen) ||
629 (BIO_write(bp, "-----\n", 6) != 6))
631 OPENSSL_clear_free(buf, PEM_BUFSIZE * 8);
632 EVP_ENCODE_CTX_free(ctx);
635 OPENSSL_clear_free(buf, PEM_BUFSIZE * 8);
636 EVP_ENCODE_CTX_free(ctx);
637 PEMerr(PEM_F_PEM_WRITE_BIO, reason);
641 #ifndef OPENSSL_NO_STDIO
642 int PEM_read(FILE *fp, char **name, char **header, unsigned char **data,
648 if ((b = BIO_new(BIO_s_file())) == NULL) {
649 PEMerr(PEM_F_PEM_READ, ERR_R_BUF_LIB);
652 BIO_set_fp(b, fp, BIO_NOCLOSE);
653 ret = PEM_read_bio(b, name, header, data, len);
659 int PEM_read_bio(BIO *bp, char **name, char **header, unsigned char **data,
662 EVP_ENCODE_CTX *ctx = EVP_ENCODE_CTX_new();
663 int end = 0, i, k, bl = 0, hl = 0, nohead = 0;
667 BUF_MEM *dataB, *tmpB;
670 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
674 nameB = BUF_MEM_new();
675 headerB = BUF_MEM_new();
676 dataB = BUF_MEM_new();
677 if ((nameB == NULL) || (headerB == NULL) || (dataB == NULL)) {
683 i = BIO_gets(bp, buf, 254);
686 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_NO_START_LINE);
690 while ((i >= 0) && (buf[i] <= ' '))
695 if (strncmp(buf, "-----BEGIN ", 11) == 0) {
696 i = strlen(&(buf[11]));
698 if (strncmp(&(buf[11 + i - 6]), "-----\n", 6) != 0)
700 if (!BUF_MEM_grow(nameB, i + 9)) {
701 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
704 memcpy(nameB->data, &(buf[11]), i - 6);
705 nameB->data[i - 6] = '\0';
710 if (!BUF_MEM_grow(headerB, 256)) {
711 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
714 headerB->data[0] = '\0';
716 i = BIO_gets(bp, buf, 254);
720 while ((i >= 0) && (buf[i] <= ' '))
727 if (!BUF_MEM_grow(headerB, hl + i + 9)) {
728 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
731 if (strncmp(buf, "-----END ", 9) == 0) {
735 memcpy(&(headerB->data[hl]), buf, i);
736 headerB->data[hl + i] = '\0';
741 if (!BUF_MEM_grow(dataB, 1024)) {
742 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
745 dataB->data[0] = '\0';
748 i = BIO_gets(bp, buf, 254);
752 while ((i >= 0) && (buf[i] <= ' '))
759 if (strncmp(buf, "-----END ", 9) == 0)
763 if (!BUF_MEM_grow_clean(dataB, i + bl + 9)) {
764 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
767 memcpy(&(dataB->data[bl]), buf, i);
768 dataB->data[bl + i] = '\0';
772 i = BIO_gets(bp, buf, 254);
776 while ((i >= 0) && (buf[i] <= ' '))
790 i = strlen(nameB->data);
791 if ((strncmp(buf, "-----END ", 9) != 0) ||
792 (strncmp(nameB->data, &(buf[9]), i) != 0) ||
793 (strncmp(&(buf[9 + i]), "-----\n", 6) != 0)) {
794 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_BAD_END_LINE);
799 i = EVP_DecodeUpdate(ctx,
800 (unsigned char *)dataB->data, &bl,
801 (unsigned char *)dataB->data, bl);
803 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_BAD_BASE64_DECODE);
806 i = EVP_DecodeFinal(ctx, (unsigned char *)&(dataB->data[bl]), &k);
808 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_BAD_BASE64_DECODE);
816 *header = headerB->data;
817 *data = (unsigned char *)dataB->data;
820 OPENSSL_free(headerB);
822 EVP_ENCODE_CTX_free(ctx);
826 BUF_MEM_free(headerB);
828 EVP_ENCODE_CTX_free(ctx);
833 * Check pem string and return prefix length. If for example the pem_str ==
834 * "RSA PRIVATE KEY" and suffix = "PRIVATE KEY" the return value is 3 for the
838 int pem_check_suffix(const char *pem_str, const char *suffix)
840 int pem_len = strlen(pem_str);
841 int suffix_len = strlen(suffix);
843 if (suffix_len + 1 >= pem_len)
845 p = pem_str + pem_len - suffix_len;
846 if (strcmp(p, suffix))