1PEM_READ_BIO_EX(3)                  OpenSSL                 PEM_READ_BIO_EX(3)
2
3
4

NAME

6       PEM_read_bio_ex, PEM_FLAG_SECURE, PEM_FLAG_EAY_COMPATIBLE,
7       PEM_FLAG_ONLY_B64 - read PEM format files with custom processing
8

SYNOPSIS

10        #include <openssl/pem.h>
11
12        #define PEM_FLAG_SECURE             0x1
13        #define PEM_FLAG_EAY_COMPATIBLE     0x2
14        #define PEM_FLAG_ONLY_B64           0x4
15        int PEM_read_bio_ex(BIO *in, char **name, char **header,
16                            unsigned char **data, long *len, unsigned int flags);
17

DESCRIPTION

19       PEM_read_bio_ex() reads in PEM formatted data from an input BIO,
20       outputting the name of the type of contained data, the header
21       information regarding the possibly encrypted data, and the binary data
22       payload (after base64 decoding).  It should generally only be used to
23       implement PEM_read_bio_-family functions for specific data types or
24       other usage, but is exposed to allow greater flexibility over how
25       processing is performed, if needed.
26
27       If PEM_FLAG_SECURE is set, the intermediate buffers used to read in
28       lines of input are allocated from the secure heap.
29
30       If PEM_FLAG_EAY_COMPATIBLE is set, a simple algorithm is used to remove
31       whitespace and control characters from the end of each line, so as to
32       be compatible with the historical behavior of PEM_read_bio().
33
34       If PEM_FLAG_ONLY_B64 is set, all characters are required to be valid
35       base64 characters (or newlines); non-base64 characters are treated as
36       end of input.
37
38       If neither PEM_FLAG_EAY_COMPATIBLE or PEM_FLAG_ONLY_B64 is set, control
39       characters are ignored.
40
41       If both PEM_FLAG_EAY_COMPATIBLE and PEM_FLAG_ONLY_B64 are set, an error
42       is returned; these options are not compatible with each other.
43

NOTES

45       The caller must release the storage allocated for *name, *header, and
46       *data.  If PEM_FLAG_SECURE was set, use OPENSSL_secure_free();
47       otherwise, OPENSSL_free() is used.
48

RETURN VALUES

50       PEM_read_bio_ex() returns 1 for success or 0 for failure.
51

SEE ALSO

53       PEM_bytes_read_bio(3)
54

HISTORY

56       The PEM_read_bio_ex() function was added in OpenSSL 1.1.1.
57

59       Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
60
61       Licensed under the OpenSSL license (the "License").  You may not use
62       this file except in compliance with the License.  You can obtain a copy
63       in the file LICENSE in the source distribution or at
64       <https://www.openssl.org/source/license.html>.
65
66
67
681.1.1l                            2021-09-15                PEM_READ_BIO_EX(3)
Impressum