1 /* $OpenBSD: pem_lib.c,v 1.45 2017/05/02 03:59:44 deraadt 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
239 /* Permit older strings */
241 if (!strcmp(nm
, PEM_STRING_X509_OLD
) &&
242 !strcmp(name
, PEM_STRING_X509
))
245 if (!strcmp(nm
, PEM_STRING_X509_REQ_OLD
) &&
246 !strcmp(name
, PEM_STRING_X509_REQ
))
249 /* Allow normal certs to be read as trusted certs */
250 if (!strcmp(nm
, PEM_STRING_X509
) &&
251 !strcmp(name
, PEM_STRING_X509_TRUSTED
))
254 if (!strcmp(nm
, PEM_STRING_X509_OLD
) &&
255 !strcmp(name
, PEM_STRING_X509_TRUSTED
))
258 /* Some CAs use PKCS#7 with CERTIFICATE headers */
259 if (!strcmp(nm
, PEM_STRING_X509
) &&
260 !strcmp(name
, PEM_STRING_PKCS7
))
263 if (!strcmp(nm
, PEM_STRING_PKCS7_SIGNED
) &&
264 !strcmp(name
, PEM_STRING_PKCS7
))
272 PEM_bytes_read_bio(unsigned char **pdata
, long *plen
, char **pnm
,
273 const char *name
, BIO
*bp
, pem_password_cb
*cb
, void *u
)
275 EVP_CIPHER_INFO cipher
;
276 char *nm
= NULL
, *header
= NULL
;
277 unsigned char *data
= NULL
;
282 if (!PEM_read_bio(bp
, &nm
, &header
, &data
, &len
)) {
283 if (ERR_GET_REASON(ERR_peek_error()) ==
285 ERR_asprintf_error_data("Expecting: %s", name
);
288 if (check_pem(nm
, name
))
294 if (!PEM_get_EVP_CIPHER_INFO(header
, &cipher
))
296 if (!PEM_do_header(&cipher
, data
, &len
, cb
, u
))
317 PEM_ASN1_write(i2d_of_void
*i2d
, const char *name
, FILE *fp
, void *x
,
318 const EVP_CIPHER
*enc
, unsigned char *kstr
, int klen
,
319 pem_password_cb
*callback
, void *u
)
324 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
325 PEMerror(ERR_R_BUF_LIB
);
328 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
329 ret
= PEM_ASN1_write_bio(i2d
, name
, b
, x
, enc
, kstr
, klen
, callback
, u
);
335 PEM_ASN1_write_bio(i2d_of_void
*i2d
, const char *name
, BIO
*bp
, void *x
,
336 const EVP_CIPHER
*enc
, unsigned char *kstr
, int klen
,
337 pem_password_cb
*callback
, void *u
)
340 int dsize
= 0, i
, j
, ret
= 0;
341 unsigned char *p
, *data
= NULL
;
342 const char *objstr
= NULL
;
343 char buf
[PEM_BUFSIZE
];
344 unsigned char key
[EVP_MAX_KEY_LENGTH
];
345 unsigned char iv
[EVP_MAX_IV_LENGTH
];
348 objstr
= OBJ_nid2sn(EVP_CIPHER_nid(enc
));
349 if (objstr
== NULL
) {
350 PEMerror(PEM_R_UNSUPPORTED_CIPHER
);
355 if ((dsize
= i2d(x
, NULL
)) < 0) {
356 PEMerror(ERR_R_ASN1_LIB
);
360 /* dzise + 8 bytes are needed */
361 /* actually it needs the cipher block size extra... */
362 data
= malloc(dsize
+ 20);
364 PEMerror(ERR_R_MALLOC_FAILURE
);
372 if (callback
== NULL
)
373 klen
= PEM_def_callback(buf
, PEM_BUFSIZE
, 1, u
);
375 klen
= (*callback
)(buf
, PEM_BUFSIZE
, 1, u
);
377 PEMerror(PEM_R_READ_KEY
);
380 kstr
= (unsigned char *)buf
;
382 if ((size_t)enc
->iv_len
> sizeof(iv
)) {
383 PEMerror(EVP_R_IV_TOO_LARGE
);
386 arc4random_buf(iv
, enc
->iv_len
); /* Generate a salt */
387 /* The 'iv' is used as the iv and as a salt. It is
388 * NOT taken from the BytesToKey function */
389 if (!EVP_BytesToKey(enc
, EVP_md5(), iv
, kstr
, klen
, 1,
393 if (kstr
== (unsigned char *)buf
)
394 explicit_bzero(buf
, PEM_BUFSIZE
);
396 if (strlen(objstr
) + 23 + 2 * enc
->iv_len
+ 13 > sizeof buf
) {
397 PEMerror(ASN1_R_BUFFER_TOO_SMALL
);
402 PEM_proc_type(buf
, PEM_TYPE_ENCRYPTED
);
403 PEM_dek_info(buf
, objstr
, enc
->iv_len
, (char *)iv
);
406 EVP_CIPHER_CTX_init(&ctx
);
408 if (!EVP_EncryptInit_ex(&ctx
, enc
, NULL
, key
, iv
) ||
409 !EVP_EncryptUpdate(&ctx
, data
, &j
, data
, i
) ||
410 !EVP_EncryptFinal_ex(&ctx
, &(data
[j
]), &i
))
412 EVP_CIPHER_CTX_cleanup(&ctx
);
420 i
= PEM_write_bio(bp
, name
, buf
, data
, i
);
424 explicit_bzero(key
, sizeof(key
));
425 explicit_bzero(iv
, sizeof(iv
));
426 explicit_bzero((char *)&ctx
, sizeof(ctx
));
427 explicit_bzero(buf
, PEM_BUFSIZE
);
428 freezero(data
, (unsigned int)dsize
);
433 PEM_do_header(EVP_CIPHER_INFO
*cipher
, unsigned char *data
, long *plen
,
434 pem_password_cb
*callback
, void *u
)
439 unsigned char key
[EVP_MAX_KEY_LENGTH
];
440 char buf
[PEM_BUFSIZE
];
444 if (cipher
->cipher
== NULL
)
446 if (callback
== NULL
)
447 klen
= PEM_def_callback(buf
, PEM_BUFSIZE
, 0, u
);
449 klen
= callback(buf
, PEM_BUFSIZE
, 0, u
);
451 PEMerror(PEM_R_BAD_PASSWORD_READ
);
454 if (!EVP_BytesToKey(cipher
->cipher
, EVP_md5(), &(cipher
->iv
[0]),
455 (unsigned char *)buf
, klen
, 1, key
, NULL
))
459 EVP_CIPHER_CTX_init(&ctx
);
460 o
= EVP_DecryptInit_ex(&ctx
, cipher
->cipher
, NULL
, key
,
463 o
= EVP_DecryptUpdate(&ctx
, data
, &i
, data
, j
);
465 o
= EVP_DecryptFinal_ex(&ctx
, &(data
[i
]), &j
);
466 EVP_CIPHER_CTX_cleanup(&ctx
);
467 explicit_bzero((char *)buf
, sizeof(buf
));
468 explicit_bzero((char *)key
, sizeof(key
));
470 PEMerror(PEM_R_BAD_DECRYPT
);
478 PEM_get_EVP_CIPHER_INFO(char *header
, EVP_CIPHER_INFO
*cipher
)
480 const EVP_CIPHER
*enc
= NULL
;
482 char **header_pp
= &header
;
484 cipher
->cipher
= NULL
;
485 if ((header
== NULL
) || (*header
== '\0') || (*header
== '\n'))
487 if (strncmp(header
, "Proc-Type: ", 11) != 0) {
488 PEMerror(PEM_R_NOT_PROC_TYPE
);
498 if (strncmp(header
, "ENCRYPTED", 9) != 0) {
499 PEMerror(PEM_R_NOT_ENCRYPTED
);
502 for (; (*header
!= '\n') && (*header
!= '\0'); header
++)
504 if (*header
== '\0') {
505 PEMerror(PEM_R_SHORT_HEADER
);
509 if (strncmp(header
, "DEK-Info: ", 10) != 0) {
510 PEMerror(PEM_R_NOT_DEK_INFO
);
518 if (!( ((c
>= 'A') && (c
<= 'Z')) || (c
== '-') ||
519 ((c
>= '0') && (c
<= '9'))))
524 cipher
->cipher
= enc
= EVP_get_cipherbyname(p
);
529 PEMerror(PEM_R_UNSUPPORTED_ENCRYPTION
);
532 if (!load_iv(header_pp
, &(cipher
->iv
[0]), enc
->iv_len
))
539 load_iv(char **fromp
, unsigned char *to
, int num
)
545 for (i
= 0; i
< num
; i
++)
548 for (i
= 0; i
< num
; i
++) {
549 if ((*from
>= '0') && (*from
<= '9'))
551 else if ((*from
>= 'A') && (*from
<= 'F'))
552 v
= *from
- 'A' + 10;
553 else if ((*from
>= 'a') && (*from
<= 'f'))
554 v
= *from
- 'a' + 10;
556 PEMerror(PEM_R_BAD_IV_CHARS
);
560 to
[i
/ 2] |= v
<< (long)((!(i
& 1)) * 4);
568 PEM_write(FILE *fp
, char *name
, char *header
, unsigned char *data
, long len
)
573 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
574 PEMerror(ERR_R_BUF_LIB
);
577 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
578 ret
= PEM_write_bio(b
, name
, header
, data
, len
);
584 PEM_write_bio(BIO
*bp
, const char *name
, char *header
, unsigned char *data
,
587 int nlen
, n
, i
, j
, outl
;
588 unsigned char *buf
= NULL
;
590 int reason
= ERR_R_BUF_LIB
;
592 EVP_EncodeInit(&ctx
);
595 if ((BIO_write(bp
, "-----BEGIN ", 11) != 11) ||
596 (BIO_write(bp
, name
, nlen
) != nlen
) ||
597 (BIO_write(bp
, "-----\n", 6) != 6))
602 if ((BIO_write(bp
, header
, i
) != i
) ||
603 (BIO_write(bp
, "\n", 1) != 1))
607 buf
= reallocarray(NULL
, PEM_BUFSIZE
, 8);
609 reason
= ERR_R_MALLOC_FAILURE
;
615 n
= (int)((len
> (PEM_BUFSIZE
* 5)) ? (PEM_BUFSIZE
* 5) : len
);
616 EVP_EncodeUpdate(&ctx
, buf
, &outl
, &(data
[j
]), n
);
617 if ((outl
) && (BIO_write(bp
, (char *)buf
, outl
) != outl
))
623 EVP_EncodeFinal(&ctx
, buf
, &outl
);
624 if ((outl
> 0) && (BIO_write(bp
, (char *)buf
, outl
) != outl
))
626 freezero(buf
, PEM_BUFSIZE
* 8);
628 if ((BIO_write(bp
, "-----END ", 9) != 9) ||
629 (BIO_write(bp
, name
, nlen
) != nlen
) ||
630 (BIO_write(bp
, "-----\n", 6) != 6))
635 freezero(buf
, PEM_BUFSIZE
* 8);
641 PEM_read(FILE *fp
, char **name
, char **header
, unsigned char **data
, long *len
)
646 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
647 PEMerror(ERR_R_BUF_LIB
);
650 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
651 ret
= PEM_read_bio(b
, name
, header
, data
, len
);
657 PEM_read_bio(BIO
*bp
, char **name
, char **header
, unsigned char **data
,
661 int end
= 0, i
, k
, bl
= 0, hl
= 0, nohead
= 0;
665 BUF_MEM
*dataB
, *tmpB
;
667 nameB
= BUF_MEM_new();
668 headerB
= BUF_MEM_new();
669 dataB
= BUF_MEM_new();
670 if ((nameB
== NULL
) || (headerB
== NULL
) || (dataB
== NULL
)) {
672 BUF_MEM_free(headerB
);
674 PEMerror(ERR_R_MALLOC_FAILURE
);
680 i
= BIO_gets(bp
, buf
, 254);
683 PEMerror(PEM_R_NO_START_LINE
);
687 while ((i
>= 0) && (buf
[i
] <= ' '))
692 if (strncmp(buf
, "-----BEGIN ", 11) == 0) {
693 i
= strlen(&(buf
[11]));
695 if (strncmp(&(buf
[11 + i
- 6]), "-----\n", 6) != 0)
697 if (!BUF_MEM_grow(nameB
, i
+ 9)) {
698 PEMerror(ERR_R_MALLOC_FAILURE
);
701 memcpy(nameB
->data
, &(buf
[11]), i
- 6);
702 nameB
->data
[i
- 6] = '\0';
707 if (!BUF_MEM_grow(headerB
, 256)) {
708 PEMerror(ERR_R_MALLOC_FAILURE
);
711 headerB
->data
[0] = '\0';
713 i
= BIO_gets(bp
, buf
, 254);
717 while ((i
>= 0) && (buf
[i
] <= ' '))
724 if (!BUF_MEM_grow(headerB
, hl
+ i
+ 9)) {
725 PEMerror(ERR_R_MALLOC_FAILURE
);
728 if (strncmp(buf
, "-----END ", 9) == 0) {
732 memcpy(&(headerB
->data
[hl
]), buf
, i
);
733 headerB
->data
[hl
+ i
] = '\0';
738 if (!BUF_MEM_grow(dataB
, 1024)) {
739 PEMerror(ERR_R_MALLOC_FAILURE
);
742 dataB
->data
[0] = '\0';
745 i
= BIO_gets(bp
, buf
, 254);
749 while ((i
>= 0) && (buf
[i
] <= ' '))
756 if (strncmp(buf
, "-----END ", 9) == 0)
760 if (!BUF_MEM_grow_clean(dataB
, i
+ bl
+ 9)) {
761 PEMerror(ERR_R_MALLOC_FAILURE
);
764 memcpy(&(dataB
->data
[bl
]), buf
, i
);
765 dataB
->data
[bl
+ i
] = '\0';
769 i
= BIO_gets(bp
, buf
, 254);
773 while ((i
>= 0) && (buf
[i
] <= ' '))
787 i
= strlen(nameB
->data
);
788 if ((strncmp(buf
, "-----END ", 9) != 0) ||
789 (strncmp(nameB
->data
, &(buf
[9]), i
) != 0) ||
790 (strncmp(&(buf
[9 + i
]), "-----\n", 6) != 0)) {
791 PEMerror(PEM_R_BAD_END_LINE
);
795 EVP_DecodeInit(&ctx
);
796 i
= EVP_DecodeUpdate(&ctx
,
797 (unsigned char *)dataB
->data
, &bl
,
798 (unsigned char *)dataB
->data
, bl
);
800 PEMerror(PEM_R_BAD_BASE64_DECODE
);
803 i
= EVP_DecodeFinal(&ctx
, (unsigned char *)&(dataB
->data
[bl
]), &k
);
805 PEMerror(PEM_R_BAD_BASE64_DECODE
);
813 *header
= headerB
->data
;
814 *data
= (unsigned char *)dataB
->data
;
823 BUF_MEM_free(headerB
);
828 /* Check pem string and return prefix length.
829 * If for example the pem_str == "RSA PRIVATE KEY" and suffix = "PRIVATE KEY"
830 * the return value is 3 for the string "RSA".
834 pem_check_suffix(const char *pem_str
, const char *suffix
)
836 int pem_len
= strlen(pem_str
);
837 int suffix_len
= strlen(suffix
);
840 if (suffix_len
+ 1 >= pem_len
)
842 p
= pem_str
+ pem_len
- suffix_len
;
843 if (strcmp(p
, suffix
))