1=pod
2
3=head1 NAME
4
5DECLARE_PEM_rw,
6PEM_read_CMS,
7PEM_read_bio_CMS,
8PEM_write_CMS,
9PEM_write_bio_CMS,
10PEM_write_DHxparams,
11PEM_write_bio_DHxparams,
12PEM_read_ECPKParameters,
13PEM_read_bio_ECPKParameters,
14PEM_write_ECPKParameters,
15PEM_write_bio_ECPKParameters,
16PEM_read_ECPrivateKey,
17PEM_write_ECPrivateKey,
18PEM_write_bio_ECPrivateKey,
19PEM_read_EC_PUBKEY,
20PEM_read_bio_EC_PUBKEY,
21PEM_write_EC_PUBKEY,
22PEM_write_bio_EC_PUBKEY,
23PEM_read_NETSCAPE_CERT_SEQUENCE,
24PEM_read_bio_NETSCAPE_CERT_SEQUENCE,
25PEM_write_NETSCAPE_CERT_SEQUENCE,
26PEM_write_bio_NETSCAPE_CERT_SEQUENCE,
27PEM_read_PKCS8,
28PEM_read_bio_PKCS8,
29PEM_write_PKCS8,
30PEM_write_bio_PKCS8,
31PEM_write_PKCS8_PRIV_KEY_INFO,
32PEM_read_bio_PKCS8_PRIV_KEY_INFO,
33PEM_read_PKCS8_PRIV_KEY_INFO,
34PEM_write_bio_PKCS8_PRIV_KEY_INFO,
35PEM_read_SSL_SESSION,
36PEM_read_bio_SSL_SESSION,
37PEM_write_SSL_SESSION,
38PEM_write_bio_SSL_SESSION
39- PEM object encoding routines
40
41=head1 SYNOPSIS
42
43=for comment generic
44
45 #include <openssl/pem.h>
46
47 DECLARE_PEM_rw(name, TYPE)
48
49 TYPE *PEM_read_TYPE(FILE *fp, TYPE **a, pem_password_cb *cb, void *u);
50 TYPE *PEM_read_bio_TYPE(BIO *bp, TYPE **a, pem_password_cb *cb, void *u);
51 int PEM_write_TYPE(FILE *fp, const TYPE *a);
52 int PEM_write_bio_TYPE(BIO *bp, const TYPE *a);
53
54=head1 DESCRIPTION
55
56In the description below, I<TYPE> is used
57as a placeholder for any of the OpenSSL datatypes, such as I<X509>.
58The macro B<DECLARE_PEM_rw> expands to the set of declarations shown in
59the next four lines of the synopsis.
60
61These routines convert between local instances of ASN1 datatypes and
62the PEM encoding.  For more information on the templates, see
63L<ASN1_ITEM(3)>.  For more information on the lower-level routines used
64by the functions here, see L<PEM_read(3)>.
65
66PEM_read_TYPE() reads a PEM-encoded object of I<TYPE> from the file B<fp>
67and returns it.  The B<cb> and B<u> parameters are as described in
68L<pem_password_cb(3)>.
69
70PEM_read_bio_TYPE() is similar to PEM_read_TYPE() but reads from the BIO B<bp>.
71
72PEM_write_TYPE() writes the PEM encoding of the object B<a> to the file B<fp>.
73
74PEM_write_bio_TYPE() similarly writes to the BIO B<bp>.
75
76=head1 NOTES
77
78These functions make no assumption regarding the pass phrase received from the
79password callback.
80It will simply be treated as a byte sequence.
81
82=head1 RETURN VALUES
83
84PEM_read_TYPE() and PEM_read_bio_TYPE() return a pointer to an allocated
85object, which should be released by calling TYPE_free(), or NULL on error.
86
87PEM_write_TYPE() and PEM_write_bio_TYPE() return the number of bytes written
88or zero on error.
89
90=head1 SEE ALSO
91
92L<PEM_read(3)>,
93L<passphrase-encoding(7)>
94
95=head1 COPYRIGHT
96
97Copyright 1998-2018 The OpenSSL Project Authors. All Rights Reserved.
98
99Licensed under the OpenSSL license (the "License").  You may not use
100this file except in compliance with the License.  You can obtain a copy
101in the file LICENSE in the source distribution or at
102L<https://www.openssl.org/source/license.html>.
103
104=cut
105