1 /* crypto/pem/pem_lib.c */
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.]
62 #include <openssl/buffer.h>
63 #include <openssl/objects.h>
64 #include <openssl/evp.h>
65 #include <openssl/rand.h>
66 #include <openssl/x509.h>
67 #include <openssl/pem.h>
68 #include <openssl/pkcs12.h>
69 #include "asn1_locl.h"
70 #ifndef OPENSSL_NO_DES
71 # include <openssl/des.h>
73 #ifndef OPENSSL_NO_ENGINE
74 # include <openssl/engine.h>
77 const char PEM_version[] = "PEM" OPENSSL_VERSION_PTEXT;
81 static int load_iv(char **fromp, unsigned char *to, int num);
82 static int check_pem(const char *nm, const char *name);
83 int pem_check_suffix(const char *pem_str, const char *suffix);
85 int PEM_def_callback(char *buf, int num, int w, void *key)
87 #ifdef OPENSSL_NO_STDIO
89 * We should not ever call the default callback routine from windows.
91 PEMerr(PEM_F_PEM_DEF_CALLBACK, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
98 i = (i > num) ? num : i;
103 prompt = EVP_get_pw_prompt();
105 prompt = "Enter PEM pass phrase:";
108 i = EVP_read_pw_string_min(buf, MIN_LENGTH, num, prompt, w);
110 PEMerr(PEM_F_PEM_DEF_CALLBACK, PEM_R_PROBLEMS_GETTING_PASSWORD);
111 memset(buf, 0, (unsigned int)num);
115 if (j < MIN_LENGTH) {
117 "phrase is too short, needs to be at least %d chars\n",
126 void PEM_proc_type(char *buf, int type)
130 if (type == PEM_TYPE_ENCRYPTED)
132 else if (type == PEM_TYPE_MIC_CLEAR)
134 else if (type == PEM_TYPE_MIC_ONLY)
139 BUF_strlcat(buf, "Proc-Type: 4,", PEM_BUFSIZE);
140 BUF_strlcat(buf, str, PEM_BUFSIZE);
141 BUF_strlcat(buf, "\n", PEM_BUFSIZE);
144 void PEM_dek_info(char *buf, const char *type, int len, char *str)
146 static const unsigned char map[17] = "0123456789ABCDEF";
150 BUF_strlcat(buf, "DEK-Info: ", PEM_BUFSIZE);
151 BUF_strlcat(buf, type, PEM_BUFSIZE);
152 BUF_strlcat(buf, ",", PEM_BUFSIZE);
154 if (j + (len * 2) + 1 > PEM_BUFSIZE)
156 for (i = 0; i < len; i++) {
157 buf[j + i * 2] = map[(str[i] >> 4) & 0x0f];
158 buf[j + i * 2 + 1] = map[(str[i]) & 0x0f];
160 buf[j + i * 2] = '\n';
161 buf[j + i * 2 + 1] = '\0';
164 #ifndef OPENSSL_NO_STDIO
165 void *PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
166 pem_password_cb *cb, void *u)
171 if ((b = BIO_new(BIO_s_file())) == NULL) {
172 PEMerr(PEM_F_PEM_ASN1_READ, ERR_R_BUF_LIB);
175 BIO_set_fp(b, fp, BIO_NOCLOSE);
176 ret = PEM_ASN1_read_bio(d2i, name, b, x, cb, u);
182 static int check_pem(const char *nm, const char *name)
184 /* Normal matching nm and name */
185 if (!strcmp(nm, name))
188 /* Make PEM_STRING_EVP_PKEY match any private key */
190 if (!strcmp(name, PEM_STRING_EVP_PKEY)) {
192 const EVP_PKEY_ASN1_METHOD *ameth;
193 if (!strcmp(nm, PEM_STRING_PKCS8))
195 if (!strcmp(nm, PEM_STRING_PKCS8INF))
197 slen = pem_check_suffix(nm, "PRIVATE KEY");
200 * NB: ENGINE implementations wont contain a deprecated old
201 * private key decode function so don't look for them.
203 ameth = EVP_PKEY_asn1_find_str(NULL, nm, slen);
204 if (ameth && ameth->old_priv_decode)
210 if (!strcmp(name, PEM_STRING_PARAMETERS)) {
212 const EVP_PKEY_ASN1_METHOD *ameth;
213 slen = pem_check_suffix(nm, "PARAMETERS");
216 ameth = EVP_PKEY_asn1_find_str(&e, nm, slen);
219 if (ameth->param_decode)
223 #ifndef OPENSSL_NO_ENGINE
232 /* If reading DH parameters handle X9.42 DH format too */
233 if (!strcmp(nm, PEM_STRING_DHXPARAMS) &&
234 !strcmp(name, PEM_STRING_DHPARAMS))
237 /* Permit older strings */
239 if (!strcmp(nm, PEM_STRING_X509_OLD) && !strcmp(name, PEM_STRING_X509))
242 if (!strcmp(nm, PEM_STRING_X509_REQ_OLD) &&
243 !strcmp(name, PEM_STRING_X509_REQ))
246 /* Allow normal certs to be read as trusted certs */
247 if (!strcmp(nm, PEM_STRING_X509) &&
248 !strcmp(name, PEM_STRING_X509_TRUSTED))
251 if (!strcmp(nm, PEM_STRING_X509_OLD) &&
252 !strcmp(name, PEM_STRING_X509_TRUSTED))
255 /* Some CAs use PKCS#7 with CERTIFICATE headers */
256 if (!strcmp(nm, PEM_STRING_X509) && !strcmp(name, PEM_STRING_PKCS7))
259 if (!strcmp(nm, PEM_STRING_PKCS7_SIGNED) &&
260 !strcmp(name, PEM_STRING_PKCS7))
263 #ifndef OPENSSL_NO_CMS
264 if (!strcmp(nm, PEM_STRING_X509) && !strcmp(name, PEM_STRING_CMS))
266 /* Allow CMS to be read from PKCS#7 headers */
267 if (!strcmp(nm, PEM_STRING_PKCS7) && !strcmp(name, PEM_STRING_CMS))
274 int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm,
275 const char *name, BIO *bp, pem_password_cb *cb,
278 EVP_CIPHER_INFO cipher;
279 char *nm = NULL, *header = NULL;
280 unsigned char *data = NULL;
285 if (!PEM_read_bio(bp, &nm, &header, &data, &len)) {
286 if (ERR_GET_REASON(ERR_peek_error()) == PEM_R_NO_START_LINE)
287 ERR_add_error_data(2, "Expecting: ", name);
290 if (check_pem(nm, name))
293 OPENSSL_free(header);
296 if (!PEM_get_EVP_CIPHER_INFO(header, &cipher))
298 if (!PEM_do_header(&cipher, data, &len, cb, u))
312 OPENSSL_free(header);
318 #ifndef OPENSSL_NO_STDIO
319 int PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp,
320 void *x, const EVP_CIPHER *enc, unsigned char *kstr,
321 int klen, pem_password_cb *callback, void *u)
326 if ((b = BIO_new(BIO_s_file())) == NULL) {
327 PEMerr(PEM_F_PEM_ASN1_WRITE, ERR_R_BUF_LIB);
330 BIO_set_fp(b, fp, BIO_NOCLOSE);
331 ret = PEM_ASN1_write_bio(i2d, name, b, x, enc, kstr, klen, callback, u);
337 int PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp,
338 void *x, const EVP_CIPHER *enc, unsigned char *kstr,
339 int klen, pem_password_cb *callback, void *u)
342 int dsize = 0, i, j, ret = 0;
343 unsigned char *p, *data = NULL;
344 const char *objstr = NULL;
345 char buf[PEM_BUFSIZE];
346 unsigned char key[EVP_MAX_KEY_LENGTH];
347 unsigned char iv[EVP_MAX_IV_LENGTH];
350 objstr = OBJ_nid2sn(EVP_CIPHER_nid(enc));
351 if (objstr == NULL) {
352 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, PEM_R_UNSUPPORTED_CIPHER);
357 if ((dsize = i2d(x, NULL)) < 0) {
358 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, ERR_R_ASN1_LIB);
362 /* dzise + 8 bytes are needed */
363 /* actually it needs the cipher block size extra... */
364 data = (unsigned char *)OPENSSL_malloc((unsigned int)dsize + 20);
366 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, ERR_R_MALLOC_FAILURE);
374 if (callback == NULL)
375 klen = PEM_def_callback(buf, PEM_BUFSIZE, 1, u);
377 klen = (*callback) (buf, PEM_BUFSIZE, 1, u);
379 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, PEM_R_READ_KEY);
382 #ifdef CHARSET_EBCDIC
383 /* Convert the pass phrase from EBCDIC */
384 ebcdic2ascii(buf, buf, klen);
386 kstr = (unsigned char *)buf;
388 RAND_add(data, i, 0); /* put in the RSA key. */
389 OPENSSL_assert(enc->iv_len <= (int)sizeof(iv));
390 if (RAND_pseudo_bytes(iv, enc->iv_len) < 0) /* Generate a salt */
393 * The 'iv' is used as the iv and as a salt. It is NOT taken from
394 * the BytesToKey function
396 if (!EVP_BytesToKey(enc, EVP_md5(), iv, kstr, klen, 1, key, NULL))
399 if (kstr == (unsigned char *)buf)
400 OPENSSL_cleanse(buf, PEM_BUFSIZE);
402 OPENSSL_assert(strlen(objstr) + 23 + 2 * enc->iv_len + 13 <=
406 PEM_proc_type(buf, PEM_TYPE_ENCRYPTED);
407 PEM_dek_info(buf, objstr, enc->iv_len, (char *)iv);
410 EVP_CIPHER_CTX_init(&ctx);
412 if (!EVP_EncryptInit_ex(&ctx, enc, NULL, key, iv)
413 || !EVP_EncryptUpdate(&ctx, data, &j, data, i)
414 || !EVP_EncryptFinal_ex(&ctx, &(data[j]), &i))
416 EVP_CIPHER_CTX_cleanup(&ctx);
424 i = PEM_write_bio(bp, name, buf, data, i);
428 OPENSSL_cleanse(key, sizeof(key));
429 OPENSSL_cleanse(iv, sizeof(iv));
430 OPENSSL_cleanse((char *)&ctx, sizeof(ctx));
431 OPENSSL_cleanse(buf, PEM_BUFSIZE);
433 OPENSSL_cleanse(data, (unsigned int)dsize);
439 int PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *plen,
440 pem_password_cb *callback, void *u)
442 int i = 0, j, o, klen;
445 unsigned char key[EVP_MAX_KEY_LENGTH];
446 char buf[PEM_BUFSIZE];
450 if (cipher->cipher == NULL)
452 if (callback == NULL)
453 klen = PEM_def_callback(buf, PEM_BUFSIZE, 0, u);
455 klen = callback(buf, PEM_BUFSIZE, 0, u);
457 PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_BAD_PASSWORD_READ);
460 #ifdef CHARSET_EBCDIC
461 /* Convert the pass phrase from EBCDIC */
462 ebcdic2ascii(buf, buf, klen);
465 if (!EVP_BytesToKey(cipher->cipher, EVP_md5(), &(cipher->iv[0]),
466 (unsigned char *)buf, klen, 1, key, NULL))
470 EVP_CIPHER_CTX_init(&ctx);
471 o = EVP_DecryptInit_ex(&ctx, cipher->cipher, NULL, key, &(cipher->iv[0]));
473 o = EVP_DecryptUpdate(&ctx, data, &i, data, j);
475 o = EVP_DecryptFinal_ex(&ctx, &(data[i]), &j);
476 EVP_CIPHER_CTX_cleanup(&ctx);
477 OPENSSL_cleanse((char *)buf, sizeof(buf));
478 OPENSSL_cleanse((char *)key, sizeof(key));
482 PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_BAD_DECRYPT);
489 int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher)
491 const EVP_CIPHER *enc = NULL;
493 char **header_pp = &header;
495 cipher->cipher = NULL;
496 if ((header == NULL) || (*header == '\0') || (*header == '\n'))
498 if (strncmp(header, "Proc-Type: ", 11) != 0) {
499 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_PROC_TYPE);
509 if (strncmp(header, "ENCRYPTED", 9) != 0) {
510 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_ENCRYPTED);
513 for (; (*header != '\n') && (*header != '\0'); header++) ;
514 if (*header == '\0') {
515 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_SHORT_HEADER);
519 if (strncmp(header, "DEK-Info: ", 10) != 0) {
520 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_DEK_INFO);
528 #ifndef CHARSET_EBCDIC
529 if (!(((c >= 'A') && (c <= 'Z')) || (c == '-') ||
530 ((c >= '0') && (c <= '9'))))
533 if (!(isupper(c) || (c == '-') || isdigit(c)))
539 cipher->cipher = enc = EVP_get_cipherbyname(p);
544 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_UNSUPPORTED_ENCRYPTION);
547 if (!load_iv(header_pp, &(cipher->iv[0]), enc->iv_len))
553 static int load_iv(char **fromp, unsigned char *to, int num)
559 for (i = 0; i < num; i++)
562 for (i = 0; i < num; i++) {
563 if ((*from >= '0') && (*from <= '9'))
565 else if ((*from >= 'A') && (*from <= 'F'))
566 v = *from - 'A' + 10;
567 else if ((*from >= 'a') && (*from <= 'f'))
568 v = *from - 'a' + 10;
570 PEMerr(PEM_F_LOAD_IV, PEM_R_BAD_IV_CHARS);
574 to[i / 2] |= v << (long)((!(i & 1)) * 4);
581 #ifndef OPENSSL_NO_STDIO
582 int PEM_write(FILE *fp, const char *name, const char *header,
583 const unsigned char *data, long len)
588 if ((b = BIO_new(BIO_s_file())) == NULL) {
589 PEMerr(PEM_F_PEM_WRITE, ERR_R_BUF_LIB);
592 BIO_set_fp(b, fp, BIO_NOCLOSE);
593 ret = PEM_write_bio(b, name, header, data, len);
599 int PEM_write_bio(BIO *bp, const char *name, const char *header,
600 const unsigned char *data, long len)
602 int nlen, n, i, j, outl;
603 unsigned char *buf = NULL;
605 int reason = ERR_R_BUF_LIB;
607 EVP_EncodeInit(&ctx);
610 if ((BIO_write(bp, "-----BEGIN ", 11) != 11) ||
611 (BIO_write(bp, name, nlen) != nlen) ||
612 (BIO_write(bp, "-----\n", 6) != 6))
617 if ((BIO_write(bp, header, i) != i) || (BIO_write(bp, "\n", 1) != 1))
621 buf = OPENSSL_malloc(PEM_BUFSIZE * 8);
623 reason = ERR_R_MALLOC_FAILURE;
629 n = (int)((len > (PEM_BUFSIZE * 5)) ? (PEM_BUFSIZE * 5) : len);
630 EVP_EncodeUpdate(&ctx, buf, &outl, &(data[j]), n);
631 if ((outl) && (BIO_write(bp, (char *)buf, outl) != outl))
637 EVP_EncodeFinal(&ctx, buf, &outl);
638 if ((outl > 0) && (BIO_write(bp, (char *)buf, outl) != outl))
640 OPENSSL_cleanse(buf, PEM_BUFSIZE * 8);
643 if ((BIO_write(bp, "-----END ", 9) != 9) ||
644 (BIO_write(bp, name, nlen) != nlen) ||
645 (BIO_write(bp, "-----\n", 6) != 6))
650 OPENSSL_cleanse(buf, PEM_BUFSIZE * 8);
653 PEMerr(PEM_F_PEM_WRITE_BIO, reason);
657 #ifndef OPENSSL_NO_STDIO
658 int PEM_read(FILE *fp, char **name, char **header, unsigned char **data,
664 if ((b = BIO_new(BIO_s_file())) == NULL) {
665 PEMerr(PEM_F_PEM_READ, ERR_R_BUF_LIB);
668 BIO_set_fp(b, fp, BIO_NOCLOSE);
669 ret = PEM_read_bio(b, name, header, data, len);
675 int PEM_read_bio(BIO *bp, char **name, char **header, unsigned char **data,
679 int end = 0, i, k, bl = 0, hl = 0, nohead = 0;
683 BUF_MEM *dataB, *tmpB;
685 nameB = BUF_MEM_new();
686 headerB = BUF_MEM_new();
687 dataB = BUF_MEM_new();
688 if ((nameB == NULL) || (headerB == NULL) || (dataB == NULL)) {
690 BUF_MEM_free(headerB);
692 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
698 i = BIO_gets(bp, buf, 254);
701 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_NO_START_LINE);
705 while ((i >= 0) && (buf[i] <= ' '))
710 if (strncmp(buf, "-----BEGIN ", 11) == 0) {
711 i = strlen(&(buf[11]));
713 if (strncmp(&(buf[11 + i - 6]), "-----\n", 6) != 0)
715 if (!BUF_MEM_grow(nameB, i + 9)) {
716 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
719 memcpy(nameB->data, &(buf[11]), i - 6);
720 nameB->data[i - 6] = '\0';
725 if (!BUF_MEM_grow(headerB, 256)) {
726 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
729 headerB->data[0] = '\0';
731 i = BIO_gets(bp, buf, 254);
735 while ((i >= 0) && (buf[i] <= ' '))
742 if (!BUF_MEM_grow(headerB, hl + i + 9)) {
743 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
746 if (strncmp(buf, "-----END ", 9) == 0) {
750 memcpy(&(headerB->data[hl]), buf, i);
751 headerB->data[hl + i] = '\0';
756 if (!BUF_MEM_grow(dataB, 1024)) {
757 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
760 dataB->data[0] = '\0';
763 i = BIO_gets(bp, buf, 254);
767 while ((i >= 0) && (buf[i] <= ' '))
774 if (strncmp(buf, "-----END ", 9) == 0)
778 if (!BUF_MEM_grow_clean(dataB, i + bl + 9)) {
779 PEMerr(PEM_F_PEM_READ_BIO, ERR_R_MALLOC_FAILURE);
782 memcpy(&(dataB->data[bl]), buf, i);
783 dataB->data[bl + i] = '\0';
787 i = BIO_gets(bp, buf, 254);
791 while ((i >= 0) && (buf[i] <= ' '))
805 i = strlen(nameB->data);
806 if ((strncmp(buf, "-----END ", 9) != 0) ||
807 (strncmp(nameB->data, &(buf[9]), i) != 0) ||
808 (strncmp(&(buf[9 + i]), "-----\n", 6) != 0)) {
809 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_BAD_END_LINE);
813 EVP_DecodeInit(&ctx);
814 i = EVP_DecodeUpdate(&ctx,
815 (unsigned char *)dataB->data, &bl,
816 (unsigned char *)dataB->data, bl);
818 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_BAD_BASE64_DECODE);
821 i = EVP_DecodeFinal(&ctx, (unsigned char *)&(dataB->data[bl]), &k);
823 PEMerr(PEM_F_PEM_READ_BIO, PEM_R_BAD_BASE64_DECODE);
831 *header = headerB->data;
832 *data = (unsigned char *)dataB->data;
835 OPENSSL_free(headerB);
840 BUF_MEM_free(headerB);
846 * Check pem string and return prefix length. If for example the pem_str ==
847 * "RSA PRIVATE KEY" and suffix = "PRIVATE KEY" the return value is 3 for the
851 int pem_check_suffix(const char *pem_str, const char *suffix)
853 int pem_len = strlen(pem_str);
854 int suffix_len = strlen(suffix);
856 if (suffix_len + 1 >= pem_len)
858 p = pem_str + pem_len - suffix_len;
859 if (strcmp(p, suffix))