xref: /freebsd/crypto/openssl/doc/man3/PEM_read_bio_ex.pod (revision 52c2bb75163559a6e2866ad374a7de67a4ea1273)
1=pod
2
3=head1 NAME
4
5PEM_read_bio_ex, PEM_FLAG_SECURE, PEM_FLAG_EAY_COMPATIBLE,
6PEM_FLAG_ONLY_B64 - read PEM format files with custom processing
7
8=head1 SYNOPSIS
9
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
18=head1 DESCRIPTION
19
20PEM_read_bio_ex() reads in PEM formatted data from an input BIO, outputting
21the name of the type of contained data, the header information regarding
22the possibly encrypted data, and the binary data payload (after base64 decoding).
23It should generally only be used to implement PEM_read_bio_-family functions
24for specific data types or other usage, but is exposed to allow greater flexibility
25over how processing is performed, if needed.
26
27If PEM_FLAG_SECURE is set, the intermediate buffers used to read in lines of
28input are allocated from the secure heap.
29
30If PEM_FLAG_EAY_COMPATIBLE is set, a simple algorithm is used to remove whitespace
31and control characters from the end of each line, so as to be compatible with
32the historical behavior of PEM_read_bio().
33
34If PEM_FLAG_ONLY_B64 is set, all characters are required to be valid base64
35characters (or newlines); non-base64 characters are treated as end of input.
36
37If neither PEM_FLAG_EAY_COMPATIBLE or PEM_FLAG_ONLY_B64 is set, control characters
38are ignored.
39
40If both PEM_FLAG_EAY_COMPATIBLE and PEM_FLAG_ONLY_B64 are set, an error is returned;
41these options are not compatible with each other.
42
43=head1 NOTES
44
45The caller must release the storage allocated for *name, *header, and *data.
46If PEM_FLAG_SECURE was set, use OPENSSL_secure_free(); otherwise,
47OPENSSL_free() is used.
48
49=head1 RETURN VALUES
50
51PEM_read_bio_ex() returns 1 for success or 0 for failure.
52
53=head1 SEE ALSO
54
55L<PEM(3)>
56
57=head1 HISTORY
58
59The PEM_read_bio_ex() function was added in OpenSSL 1.1.1.
60
61=head1 COPYRIGHT
62
63Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
64
65Licensed under the OpenSSL license (the "License").  You may not use
66this file except in compliance with the License.  You can obtain a copy
67in the file LICENSE in the source distribution or at
68L<https://www.openssl.org/source/license.html>.
69
70=cut
71