2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
10 /* We need to use some engine deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
14 #include "crypto/ctype.h"
16 #include "internal/cryptlib.h"
17 #include <openssl/buffer.h>
18 #include <openssl/objects.h>
19 #include <openssl/evp.h>
20 #include <openssl/rand.h>
21 #include <openssl/x509.h>
22 #include <openssl/pem.h>
23 #include <openssl/pkcs12.h>
24 #include "crypto/asn1.h"
25 #include <openssl/des.h>
26 #include <openssl/engine.h>
30 static int load_iv(char **fromp
, unsigned char *to
, int num
);
31 static int check_pem(const char *nm
, const char *name
);
32 int ossl_pem_check_suffix(const char *pem_str
, const char *suffix
);
34 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
);
47 prompt
= EVP_get_pw_prompt();
49 prompt
= "Enter PEM pass phrase:";
52 * rwflag == 0 means decryption
53 * rwflag == 1 means encryption
55 * We assume that for encryption, we want a minimum length, while for
56 * decryption, we cannot know any minimum length, so we assume zero.
58 min_len
= rwflag
? MIN_LENGTH
: 0;
60 i
= EVP_read_pw_string_min(buf
, min_len
, num
, prompt
, rwflag
);
62 ERR_raise(ERR_LIB_PEM
, PEM_R_PROBLEMS_GETTING_PASSWORD
);
63 memset(buf
, 0, (unsigned int)num
);
69 void PEM_proc_type(char *buf
, int type
)
72 char *p
= buf
+ strlen(buf
);
74 if (type
== PEM_TYPE_ENCRYPTED
)
76 else if (type
== PEM_TYPE_MIC_CLEAR
)
78 else if (type
== PEM_TYPE_MIC_ONLY
)
83 BIO_snprintf(p
, PEM_BUFSIZE
- (size_t)(p
- buf
), "Proc-Type: 4,%s\n", str
);
86 void PEM_dek_info(char *buf
, const char *type
, int len
, const char *str
)
89 char *p
= buf
+ strlen(buf
);
90 int j
= PEM_BUFSIZE
- (size_t)(p
- buf
), n
;
92 n
= BIO_snprintf(p
, j
, "DEK-Info: %s,", type
);
96 for (i
= 0; i
< len
; i
++) {
97 n
= BIO_snprintf(p
, j
, "%02X", 0xff & str
[i
]);
108 #ifndef OPENSSL_NO_STDIO
109 void *PEM_ASN1_read(d2i_of_void
*d2i
, const char *name
, FILE *fp
, void **x
,
110 pem_password_cb
*cb
, void *u
)
115 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
116 ERR_raise(ERR_LIB_PEM
, ERR_R_BUF_LIB
);
119 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
120 ret
= PEM_ASN1_read_bio(d2i
, name
, b
, x
, cb
, u
);
126 static int check_pem(const char *nm
, const char *name
)
128 /* Normal matching nm and name */
129 if (strcmp(nm
, name
) == 0)
132 /* Make PEM_STRING_EVP_PKEY match any private key */
134 if (strcmp(name
, PEM_STRING_EVP_PKEY
) == 0) {
136 const EVP_PKEY_ASN1_METHOD
*ameth
;
137 if (strcmp(nm
, PEM_STRING_PKCS8
) == 0)
139 if (strcmp(nm
, PEM_STRING_PKCS8INF
) == 0)
141 slen
= ossl_pem_check_suffix(nm
, "PRIVATE KEY");
144 * NB: ENGINE implementations won't contain a deprecated old
145 * private key decode function so don't look for them.
147 ameth
= EVP_PKEY_asn1_find_str(NULL
, nm
, slen
);
148 if (ameth
&& ameth
->old_priv_decode
)
154 if (strcmp(name
, PEM_STRING_PARAMETERS
) == 0) {
156 const EVP_PKEY_ASN1_METHOD
*ameth
;
157 slen
= ossl_pem_check_suffix(nm
, "PARAMETERS");
160 ameth
= EVP_PKEY_asn1_find_str(&e
, nm
, slen
);
163 if (ameth
->param_decode
)
167 #ifndef OPENSSL_NO_ENGINE
175 /* If reading DH parameters handle X9.42 DH format too */
176 if (strcmp(nm
, PEM_STRING_DHXPARAMS
) == 0
177 && strcmp(name
, PEM_STRING_DHPARAMS
) == 0)
180 /* Permit older strings */
182 if (strcmp(nm
, PEM_STRING_X509_OLD
) == 0
183 && strcmp(name
, PEM_STRING_X509
) == 0)
186 if (strcmp(nm
, PEM_STRING_X509_REQ_OLD
) == 0
187 && strcmp(name
, PEM_STRING_X509_REQ
) == 0)
190 /* Allow normal certs to be read as trusted certs */
191 if (strcmp(nm
, PEM_STRING_X509
) == 0
192 && strcmp(name
, PEM_STRING_X509_TRUSTED
) == 0)
195 if (strcmp(nm
, PEM_STRING_X509_OLD
) == 0
196 && strcmp(name
, PEM_STRING_X509_TRUSTED
) == 0)
199 /* Some CAs use PKCS#7 with CERTIFICATE headers */
200 if (strcmp(nm
, PEM_STRING_X509
) == 0
201 && strcmp(name
, PEM_STRING_PKCS7
) == 0)
204 if (strcmp(nm
, PEM_STRING_PKCS7_SIGNED
) == 0
205 && strcmp(name
, PEM_STRING_PKCS7
) == 0)
208 #ifndef OPENSSL_NO_CMS
209 if (strcmp(nm
, PEM_STRING_X509
) == 0
210 && strcmp(name
, PEM_STRING_CMS
) == 0)
212 /* Allow CMS to be read from PKCS#7 headers */
213 if (strcmp(nm
, PEM_STRING_PKCS7
) == 0
214 && strcmp(name
, PEM_STRING_CMS
) == 0)
221 #define PEM_FREE(p, flags, num) \
222 pem_free((p), (flags), (num), OPENSSL_FILE, OPENSSL_LINE)
223 static void pem_free(void *p
, unsigned int flags
, size_t num
,
224 const char *file
, int line
)
226 if (flags
& PEM_FLAG_SECURE
)
227 CRYPTO_secure_clear_free(p
, num
, file
, line
);
229 CRYPTO_free(p
, file
, line
);
232 #define PEM_MALLOC(num, flags) \
233 pem_malloc((num), (flags), OPENSSL_FILE, OPENSSL_LINE)
234 static void *pem_malloc(int num
, unsigned int flags
,
235 const char *file
, int line
)
237 return (flags
& PEM_FLAG_SECURE
) ? CRYPTO_secure_malloc(num
, file
, line
)
238 : CRYPTO_malloc(num
, file
, line
);
242 static int pem_bytes_read_bio_flags(unsigned char **pdata
, long *plen
,
243 char **pnm
, const char *name
, BIO
*bp
,
244 pem_password_cb
*cb
, void *u
,
247 EVP_CIPHER_INFO cipher
;
248 char *nm
= NULL
, *header
= NULL
;
249 unsigned char *data
= NULL
;
254 PEM_FREE(nm
, flags
, 0);
255 PEM_FREE(header
, flags
, 0);
256 PEM_FREE(data
, flags
, len
);
257 if (!PEM_read_bio_ex(bp
, &nm
, &header
, &data
, &len
, flags
)) {
258 if (ERR_GET_REASON(ERR_peek_error()) == PEM_R_NO_START_LINE
)
259 ERR_add_error_data(2, "Expecting: ", name
);
262 } while (!check_pem(nm
, name
));
263 if (!PEM_get_EVP_CIPHER_INFO(header
, &cipher
))
265 if (!PEM_do_header(&cipher
, data
, &len
, cb
, u
))
277 if (!ret
|| pnm
== NULL
)
278 PEM_FREE(nm
, flags
, 0);
279 PEM_FREE(header
, flags
, 0);
281 PEM_FREE(data
, flags
, len
);
285 int PEM_bytes_read_bio(unsigned char **pdata
, long *plen
, char **pnm
,
286 const char *name
, BIO
*bp
, pem_password_cb
*cb
,
288 return pem_bytes_read_bio_flags(pdata
, plen
, pnm
, name
, bp
, cb
, u
,
289 PEM_FLAG_EAY_COMPATIBLE
);
292 int PEM_bytes_read_bio_secmem(unsigned char **pdata
, long *plen
, char **pnm
,
293 const char *name
, BIO
*bp
, pem_password_cb
*cb
,
295 return pem_bytes_read_bio_flags(pdata
, plen
, pnm
, name
, bp
, cb
, u
,
296 PEM_FLAG_SECURE
| PEM_FLAG_EAY_COMPATIBLE
);
299 #ifndef OPENSSL_NO_STDIO
300 int PEM_ASN1_write(i2d_of_void
*i2d
, const char *name
, FILE *fp
,
301 const void *x
, const EVP_CIPHER
*enc
,
302 const unsigned char *kstr
, int klen
,
303 pem_password_cb
*callback
, void *u
)
308 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
309 ERR_raise(ERR_LIB_PEM
, ERR_R_BUF_LIB
);
312 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
313 ret
= PEM_ASN1_write_bio(i2d
, name
, b
, x
, enc
, kstr
, klen
, callback
, u
);
319 int PEM_ASN1_write_bio(i2d_of_void
*i2d
, const char *name
, BIO
*bp
,
320 const void *x
, const EVP_CIPHER
*enc
,
321 const unsigned char *kstr
, int klen
,
322 pem_password_cb
*callback
, void *u
)
324 EVP_CIPHER_CTX
*ctx
= NULL
;
325 int dsize
= 0, i
= 0, j
= 0, ret
= 0;
326 unsigned char *p
, *data
= NULL
;
327 const char *objstr
= NULL
;
328 char buf
[PEM_BUFSIZE
];
329 unsigned char key
[EVP_MAX_KEY_LENGTH
];
330 unsigned char iv
[EVP_MAX_IV_LENGTH
];
333 objstr
= EVP_CIPHER_get0_name(enc
);
334 if (objstr
== NULL
|| EVP_CIPHER_get_iv_length(enc
) == 0
335 || EVP_CIPHER_get_iv_length(enc
) > (int)sizeof(iv
)
337 * Check "Proc-Type: 4,Encrypted\nDEK-Info: objstr,hex-iv\n"
340 || strlen(objstr
) + 23 + 2 * EVP_CIPHER_get_iv_length(enc
) + 13
342 ERR_raise(ERR_LIB_PEM
, PEM_R_UNSUPPORTED_CIPHER
);
347 if ((dsize
= i2d(x
, NULL
)) <= 0) {
348 ERR_raise(ERR_LIB_PEM
, ERR_R_ASN1_LIB
);
352 /* dsize + 8 bytes are needed */
353 /* actually it needs the cipher block size extra... */
354 data
= OPENSSL_malloc((unsigned int)dsize
+ 20);
362 if (callback
== NULL
)
363 klen
= PEM_def_callback(buf
, PEM_BUFSIZE
, 1, u
);
365 klen
= (*callback
) (buf
, PEM_BUFSIZE
, 1, u
);
367 ERR_raise(ERR_LIB_PEM
, PEM_R_READ_KEY
);
370 #ifdef CHARSET_EBCDIC
371 /* Convert the pass phrase from EBCDIC */
372 ebcdic2ascii(buf
, buf
, klen
);
374 kstr
= (unsigned char *)buf
;
376 /* Generate a salt */
377 if (RAND_bytes(iv
, EVP_CIPHER_get_iv_length(enc
)) <= 0)
380 * The 'iv' is used as the iv and as a salt. It is NOT taken from
381 * the BytesToKey function
383 if (!EVP_BytesToKey(enc
, EVP_md5(), iv
, kstr
, klen
, 1, key
, NULL
))
386 if (kstr
== (unsigned char *)buf
)
387 OPENSSL_cleanse(buf
, PEM_BUFSIZE
);
390 PEM_proc_type(buf
, PEM_TYPE_ENCRYPTED
);
391 PEM_dek_info(buf
, objstr
, EVP_CIPHER_get_iv_length(enc
), (char *)iv
);
395 if ((ctx
= EVP_CIPHER_CTX_new()) == NULL
396 || !EVP_EncryptInit_ex(ctx
, enc
, NULL
, key
, iv
)
397 || !EVP_EncryptUpdate(ctx
, data
, &j
, data
, i
)
398 || !EVP_EncryptFinal_ex(ctx
, &(data
[j
]), &i
))
407 i
= PEM_write_bio(bp
, name
, buf
, data
, i
);
411 OPENSSL_cleanse(key
, sizeof(key
));
412 OPENSSL_cleanse(iv
, sizeof(iv
));
413 EVP_CIPHER_CTX_free(ctx
);
414 OPENSSL_cleanse(buf
, PEM_BUFSIZE
);
415 OPENSSL_clear_free(data
, (unsigned int)dsize
);
419 int PEM_do_header(EVP_CIPHER_INFO
*cipher
, unsigned char *data
, long *plen
,
420 pem_password_cb
*callback
, void *u
)
425 int ilen
= (int) len
; /* EVP_DecryptUpdate etc. take int lengths */
427 unsigned char key
[EVP_MAX_KEY_LENGTH
];
428 char buf
[PEM_BUFSIZE
];
430 #if LONG_MAX > INT_MAX
431 /* Check that we did not truncate the length */
433 ERR_raise(ERR_LIB_PEM
, PEM_R_HEADER_TOO_LONG
);
438 if (cipher
->cipher
== NULL
)
440 if (callback
== NULL
)
441 keylen
= PEM_def_callback(buf
, PEM_BUFSIZE
, 0, u
);
443 keylen
= callback(buf
, PEM_BUFSIZE
, 0, u
);
445 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_PASSWORD_READ
);
448 #ifdef CHARSET_EBCDIC
449 /* Convert the pass phrase from EBCDIC */
450 ebcdic2ascii(buf
, buf
, keylen
);
453 if (!EVP_BytesToKey(cipher
->cipher
, EVP_md5(), &(cipher
->iv
[0]),
454 (unsigned char *)buf
, keylen
, 1, key
, NULL
))
457 ctx
= EVP_CIPHER_CTX_new();
461 ok
= EVP_DecryptInit_ex(ctx
, cipher
->cipher
, NULL
, key
, &(cipher
->iv
[0]));
463 ok
= EVP_DecryptUpdate(ctx
, data
, &ilen
, data
, ilen
);
465 /* Squirrel away the length of data decrypted so far. */
467 ok
= EVP_DecryptFinal_ex(ctx
, &(data
[ilen
]), &ilen
);
472 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_DECRYPT
);
474 EVP_CIPHER_CTX_free(ctx
);
475 OPENSSL_cleanse((char *)buf
, sizeof(buf
));
476 OPENSSL_cleanse((char *)key
, sizeof(key
));
481 * This implements a very limited PEM header parser that does not support the
482 * full grammar of rfc1421. In particular, folded headers are not supported,
483 * nor is additional whitespace.
485 * A robust implementation would make use of a library that turns the headers
486 * into a BIO from which one folded line is read at a time, and is then split
487 * into a header label and content. We would then parse the content of the
488 * headers we care about. This is overkill for just this limited use-case, but
489 * presumably we also parse rfc822-style headers for S/MIME, so a common
490 * abstraction might well be more generally useful.
492 #define PROC_TYPE "Proc-Type:"
493 #define ENCRYPTED "ENCRYPTED"
494 #define DEK_INFO "DEK-Info:"
495 int PEM_get_EVP_CIPHER_INFO(char *header
, EVP_CIPHER_INFO
*cipher
)
497 const EVP_CIPHER
*enc
= NULL
;
499 char *dekinfostart
, c
;
501 cipher
->cipher
= NULL
;
502 memset(cipher
->iv
, 0, sizeof(cipher
->iv
));
503 if ((header
== NULL
) || (*header
== '\0') || (*header
== '\n'))
506 if (!CHECK_AND_SKIP_PREFIX(header
, PROC_TYPE
)) {
507 ERR_raise(ERR_LIB_PEM
, PEM_R_NOT_PROC_TYPE
);
510 header
+= strspn(header
, " \t");
512 if (*header
++ != '4' || *header
++ != ',')
514 header
+= strspn(header
, " \t");
516 /* We expect "ENCRYPTED" followed by optional white-space + line break */
517 if (!CHECK_AND_SKIP_PREFIX(header
, ENCRYPTED
) ||
518 strspn(header
, " \t\r\n") == 0) {
519 ERR_raise(ERR_LIB_PEM
, PEM_R_NOT_ENCRYPTED
);
522 header
+= strspn(header
, " \t\r");
523 if (*header
++ != '\n') {
524 ERR_raise(ERR_LIB_PEM
, PEM_R_SHORT_HEADER
);
529 * https://tools.ietf.org/html/rfc1421#section-4.6.1.3
530 * We expect "DEK-Info: algo[,hex-parameters]"
532 if (!CHECK_AND_SKIP_PREFIX(header
, DEK_INFO
)) {
533 ERR_raise(ERR_LIB_PEM
, PEM_R_NOT_DEK_INFO
);
536 header
+= strspn(header
, " \t");
539 * DEK-INFO is a comma-separated combination of algorithm name and optional
542 dekinfostart
= header
;
543 header
+= strcspn(header
, " \t,");
546 cipher
->cipher
= enc
= EVP_get_cipherbyname(dekinfostart
);
548 header
+= strspn(header
, " \t");
551 ERR_raise(ERR_LIB_PEM
, PEM_R_UNSUPPORTED_ENCRYPTION
);
554 ivlen
= EVP_CIPHER_get_iv_length(enc
);
555 if (ivlen
> 0 && *header
++ != ',') {
556 ERR_raise(ERR_LIB_PEM
, PEM_R_MISSING_DEK_IV
);
558 } else if (ivlen
== 0 && *header
== ',') {
559 ERR_raise(ERR_LIB_PEM
, PEM_R_UNEXPECTED_DEK_IV
);
563 if (!load_iv(&header
, cipher
->iv
, EVP_CIPHER_get_iv_length(enc
)))
569 static int load_iv(char **fromp
, unsigned char *to
, int num
)
575 for (i
= 0; i
< num
; i
++)
578 for (i
= 0; i
< num
; i
++) {
579 v
= OPENSSL_hexchar2int(*from
);
581 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_IV_CHARS
);
585 to
[i
/ 2] |= v
<< (long)((!(i
& 1)) * 4);
592 #ifndef OPENSSL_NO_STDIO
593 int PEM_write(FILE *fp
, const char *name
, const char *header
,
594 const unsigned char *data
, long len
)
599 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
600 ERR_raise(ERR_LIB_PEM
, ERR_R_BUF_LIB
);
603 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
604 ret
= PEM_write_bio(b
, name
, header
, data
, len
);
610 int PEM_write_bio(BIO
*bp
, const char *name
, const char *header
,
611 const unsigned char *data
, long len
)
613 int nlen
, n
, i
, j
, outl
;
614 unsigned char *buf
= NULL
;
615 EVP_ENCODE_CTX
*ctx
= EVP_ENCODE_CTX_new();
620 reason
= ERR_R_EVP_LIB
;
627 if ((BIO_write(bp
, "-----BEGIN ", 11) != 11) ||
628 (BIO_write(bp
, name
, nlen
) != nlen
) ||
629 (BIO_write(bp
, "-----\n", 6) != 6)) {
630 reason
= ERR_R_BIO_LIB
;
634 i
= header
!= NULL
? strlen(header
) : 0;
636 if ((BIO_write(bp
, header
, i
) != i
) || (BIO_write(bp
, "\n", 1) != 1)) {
637 reason
= ERR_R_BIO_LIB
;
642 buf
= OPENSSL_malloc(PEM_BUFSIZE
* 8);
648 n
= (int)((len
> (PEM_BUFSIZE
* 5)) ? (PEM_BUFSIZE
* 5) : len
);
649 if (!EVP_EncodeUpdate(ctx
, buf
, &outl
, &(data
[j
]), n
)) {
650 reason
= ERR_R_EVP_LIB
;
653 if ((outl
) && (BIO_write(bp
, (char *)buf
, outl
) != outl
)) {
654 reason
= ERR_R_BIO_LIB
;
661 EVP_EncodeFinal(ctx
, buf
, &outl
);
662 if ((outl
> 0) && (BIO_write(bp
, (char *)buf
, outl
) != outl
)) {
663 reason
= ERR_R_BIO_LIB
;
666 if ((BIO_write(bp
, "-----END ", 9) != 9) ||
667 (BIO_write(bp
, name
, nlen
) != nlen
) ||
668 (BIO_write(bp
, "-----\n", 6) != 6)) {
669 reason
= ERR_R_BIO_LIB
;
675 if (retval
== 0 && reason
!= 0)
676 ERR_raise(ERR_LIB_PEM
, reason
);
677 EVP_ENCODE_CTX_free(ctx
);
678 OPENSSL_clear_free(buf
, PEM_BUFSIZE
* 8);
682 #ifndef OPENSSL_NO_STDIO
683 int PEM_read(FILE *fp
, char **name
, char **header
, unsigned char **data
,
689 if ((b
= BIO_new(BIO_s_file())) == NULL
) {
690 ERR_raise(ERR_LIB_PEM
, ERR_R_BUF_LIB
);
693 BIO_set_fp(b
, fp
, BIO_NOCLOSE
);
694 ret
= PEM_read_bio(b
, name
, header
, data
, len
);
700 /* Some helpers for PEM_read_bio_ex(). */
701 static int sanitize_line(char *linebuf
, int len
, unsigned int flags
, int first_call
)
705 /* Other BOMs imply unsupported multibyte encoding,
706 * so don't strip them and let the error raise */
707 const unsigned char utf8_bom
[3] = {0xEF, 0xBB, 0xBF};
709 if (len
> 3 && memcmp(linebuf
, utf8_bom
, 3) == 0) {
710 memmove(linebuf
, linebuf
+ 3, len
- 3);
711 linebuf
[len
- 3] = 0;
716 if (flags
& PEM_FLAG_EAY_COMPATIBLE
) {
717 /* Strip trailing whitespace */
718 while ((len
>= 0) && (linebuf
[len
] <= ' '))
720 /* Go back to whitespace before applying uniform line ending. */
722 } else if (flags
& PEM_FLAG_ONLY_B64
) {
723 for (i
= 0; i
< len
; ++i
) {
724 if (!ossl_isbase64(linebuf
[i
]) || linebuf
[i
] == '\n'
725 || linebuf
[i
] == '\r')
730 /* EVP_DecodeBlock strips leading and trailing whitespace, so just strip
731 * control characters in-place and let everything through. */
732 for (i
= 0; i
< len
; ++i
) {
733 if (linebuf
[i
] == '\n' || linebuf
[i
] == '\r')
735 if (ossl_iscntrl(linebuf
[i
]))
740 /* The caller allocated LINESIZE+1, so this is safe. */
741 linebuf
[len
++] = '\n';
747 /* Note trailing spaces for begin and end. */
748 #define BEGINSTR "-----BEGIN "
749 #define ENDSTR "-----END "
750 #define TAILSTR "-----\n"
751 #define BEGINLEN ((int)(sizeof(BEGINSTR) - 1))
752 #define ENDLEN ((int)(sizeof(ENDSTR) - 1))
753 #define TAILLEN ((int)(sizeof(TAILSTR) - 1))
754 static int get_name(BIO
*bp
, char **name
, unsigned int flags
)
762 * Need to hold trailing NUL (accounted for by BIO_gets() and the newline
763 * that will be added by sanitize_line() (the extra '1').
765 linebuf
= PEM_MALLOC(LINESIZE
+ 1, flags
);
770 len
= BIO_gets(bp
, linebuf
, LINESIZE
);
773 ERR_raise(ERR_LIB_PEM
, PEM_R_NO_START_LINE
);
777 /* Strip trailing garbage and standardize ending. */
778 len
= sanitize_line(linebuf
, len
, flags
& ~PEM_FLAG_ONLY_B64
, first_call
);
781 /* Allow leading empty or non-matching lines. */
782 } while (!HAS_PREFIX(linebuf
, BEGINSTR
)
784 || !HAS_PREFIX(linebuf
+ len
- TAILLEN
, TAILSTR
));
785 linebuf
[len
- TAILLEN
] = '\0';
786 len
= len
- BEGINLEN
- TAILLEN
+ 1;
787 *name
= PEM_MALLOC(len
, flags
);
790 memcpy(*name
, linebuf
+ BEGINLEN
, len
);
794 PEM_FREE(linebuf
, flags
, LINESIZE
+ 1);
798 /* Keep track of how much of a header we've seen. */
806 * Extract the optional PEM header, with details on the type of content and
807 * any encryption used on the contents, and the bulk of the data from the bio.
808 * The end of the header is marked by a blank line; if the end-of-input marker
809 * is reached prior to a blank line, there is no header.
811 * The header and data arguments are BIO** since we may have to swap them
812 * if there is no header, for efficiency.
814 * We need the name of the PEM-encoded type to verify the end string.
816 static int get_header_and_data(BIO
*bp
, BIO
**header
, BIO
**data
, char *name
,
821 int len
, ret
= 0, end
= 0, prev_partial_line_read
= 0, partial_line_read
= 0;
822 /* 0 if not seen (yet), 1 if reading header, 2 if finished header */
823 enum header_status got_header
= MAYBE_HEADER
;
824 unsigned int flags_mask
;
827 /* Need to hold trailing NUL (accounted for by BIO_gets() and the newline
828 * that will be added by sanitize_line() (the extra '1'). */
829 linebuf
= PEM_MALLOC(LINESIZE
+ 1, flags
);
835 len
= BIO_gets(bp
, linebuf
, LINESIZE
);
837 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_END_LINE
);
842 * Check if line has been read completely or if only part of the line
843 * has been read. Keep the previous value to ignore newlines that
844 * appear due to reading a line up until the char before the newline.
846 prev_partial_line_read
= partial_line_read
;
847 partial_line_read
= len
== LINESIZE
-1 && linebuf
[LINESIZE
-2] != '\n';
849 if (got_header
== MAYBE_HEADER
) {
850 if (memchr(linebuf
, ':', len
) != NULL
)
851 got_header
= IN_HEADER
;
853 if (HAS_PREFIX(linebuf
, ENDSTR
) || got_header
== IN_HEADER
)
854 flags_mask
&= ~PEM_FLAG_ONLY_B64
;
855 len
= sanitize_line(linebuf
, len
, flags
& flags_mask
, 0);
857 /* Check for end of header. */
858 if (linebuf
[0] == '\n') {
860 * If previous line has been read only partially this newline is a
861 * regular newline at the end of a line and not an empty line.
863 if (!prev_partial_line_read
) {
864 if (got_header
== POST_HEADER
) {
865 /* Another blank line is an error. */
866 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_END_LINE
);
869 got_header
= POST_HEADER
;
875 /* Check for end of stream (which means there is no header). */
877 if (CHECK_AND_SKIP_PREFIX(p
, ENDSTR
)) {
878 namelen
= strlen(name
);
879 if (strncmp(p
, name
, namelen
) != 0 ||
880 !HAS_PREFIX(p
+ namelen
, TAILSTR
)) {
881 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_END_LINE
);
884 if (got_header
== MAYBE_HEADER
) {
890 /* Malformed input; short line not at end of data. */
891 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_END_LINE
);
895 * Else, a line of text -- could be header or data; we don't
896 * know yet. Just pass it through.
898 if (BIO_puts(tmp
, linebuf
) < 0)
901 * Only encrypted files need the line length check applied.
903 if (got_header
== POST_HEADER
) {
904 /* 65 includes the trailing newline */
914 PEM_FREE(linebuf
, flags
, LINESIZE
+ 1);
919 * Read in PEM-formatted data from the given BIO.
921 * By nature of the PEM format, all content must be printable ASCII (except
922 * for line endings). Other characters are malformed input and will be rejected.
924 int PEM_read_bio_ex(BIO
*bp
, char **name_out
, char **header
,
925 unsigned char **data
, long *len_out
, unsigned int flags
)
927 EVP_ENCODE_CTX
*ctx
= NULL
;
928 const BIO_METHOD
*bmeth
;
929 BIO
*headerB
= NULL
, *dataB
= NULL
;
931 int len
, taillen
, headerlen
, ret
= 0;
935 *name_out
= *header
= NULL
;
937 if ((flags
& PEM_FLAG_EAY_COMPATIBLE
) && (flags
& PEM_FLAG_ONLY_B64
)) {
938 /* These two are mutually incompatible; bail out. */
939 ERR_raise(ERR_LIB_PEM
, ERR_R_PASSED_INVALID_ARGUMENT
);
942 bmeth
= (flags
& PEM_FLAG_SECURE
) ? BIO_s_secmem() : BIO_s_mem();
944 headerB
= BIO_new(bmeth
);
945 dataB
= BIO_new(bmeth
);
946 if (headerB
== NULL
|| dataB
== NULL
) {
947 ERR_raise(ERR_LIB_PEM
, ERR_R_BIO_LIB
);
951 if (!get_name(bp
, &name
, flags
))
953 if (!get_header_and_data(bp
, &headerB
, &dataB
, name
, flags
))
956 BIO_get_mem_ptr(dataB
, &buf_mem
);
957 len
= buf_mem
->length
;
959 /* There was no data in the PEM file */
963 ctx
= EVP_ENCODE_CTX_new();
965 ERR_raise(ERR_LIB_PEM
, ERR_R_EVP_LIB
);
970 if (EVP_DecodeUpdate(ctx
, (unsigned char*)buf_mem
->data
, &len
,
971 (unsigned char*)buf_mem
->data
, len
) < 0
972 || EVP_DecodeFinal(ctx
, (unsigned char*)&(buf_mem
->data
[len
]),
974 ERR_raise(ERR_LIB_PEM
, PEM_R_BAD_BASE64_DECODE
);
978 buf_mem
->length
= len
;
980 headerlen
= BIO_get_mem_data(headerB
, NULL
);
981 *header
= PEM_MALLOC(headerlen
+ 1, flags
);
982 *data
= PEM_MALLOC(len
, flags
);
983 if (*header
== NULL
|| *data
== NULL
)
985 if (headerlen
!= 0 && BIO_read(headerB
, *header
, headerlen
) != headerlen
)
987 (*header
)[headerlen
] = '\0';
988 if (BIO_read(dataB
, *data
, len
) != len
)
997 PEM_FREE(*header
, flags
, 0);
999 PEM_FREE(*data
, flags
, 0);
1002 EVP_ENCODE_CTX_free(ctx
);
1003 PEM_FREE(name
, flags
, 0);
1009 int PEM_read_bio(BIO
*bp
, char **name
, char **header
, unsigned char **data
,
1012 return PEM_read_bio_ex(bp
, name
, header
, data
, len
, PEM_FLAG_EAY_COMPATIBLE
);
1016 * Check pem string and return prefix length. If for example the pem_str ==
1017 * "RSA PRIVATE KEY" and suffix = "PRIVATE KEY" the return value is 3 for the
1021 int ossl_pem_check_suffix(const char *pem_str
, const char *suffix
)
1023 int pem_len
= strlen(pem_str
);
1024 int suffix_len
= strlen(suffix
);
1026 if (suffix_len
+ 1 >= pem_len
)
1028 p
= pem_str
+ pem_len
- suffix_len
;
1029 if (strcmp(p
, suffix
))