c309d60dcf46ba9eec61549d94e00d6dbbe8a769
[dragonfly.git] / secure / lib / libcrypto / man / pem.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "pem 3"
136 .TH pem 3 "2015-03-19" "1.0.1m" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 PEM, PEM_read_bio_PrivateKey, PEM_read_PrivateKey, PEM_write_bio_PrivateKey, PEM_write_PrivateKey, PEM_write_bio_PKCS8PrivateKey, PEM_write_PKCS8PrivateKey, PEM_write_bio_PKCS8PrivateKey_nid, PEM_write_PKCS8PrivateKey_nid, PEM_read_bio_PUBKEY, PEM_read_PUBKEY, PEM_write_bio_PUBKEY, PEM_write_PUBKEY, PEM_read_bio_RSAPrivateKey, PEM_read_RSAPrivateKey, PEM_write_bio_RSAPrivateKey, PEM_write_RSAPrivateKey, PEM_read_bio_RSAPublicKey, PEM_read_RSAPublicKey, PEM_write_bio_RSAPublicKey, PEM_write_RSAPublicKey, PEM_read_bio_RSA_PUBKEY, PEM_read_RSA_PUBKEY, PEM_write_bio_RSA_PUBKEY, PEM_write_RSA_PUBKEY, PEM_read_bio_DSAPrivateKey, PEM_read_DSAPrivateKey, PEM_write_bio_DSAPrivateKey, PEM_write_DSAPrivateKey, PEM_read_bio_DSA_PUBKEY, PEM_read_DSA_PUBKEY, PEM_write_bio_DSA_PUBKEY, PEM_write_DSA_PUBKEY, PEM_read_bio_DSAparams, PEM_read_DSAparams, PEM_write_bio_DSAparams, PEM_write_DSAparams, PEM_read_bio_DHparams, PEM_read_DHparams, PEM_write_bio_DHparams, PEM_write_DHparams, PEM_read_bio_X509, PEM_read_X509, PEM_write_bio_X509, PEM_write_X509, PEM_read_bio_X509_AUX, PEM_read_X509_AUX, PEM_write_bio_X509_AUX, PEM_write_X509_AUX, PEM_read_bio_X509_REQ, PEM_read_X509_REQ, PEM_write_bio_X509_REQ, PEM_write_X509_REQ, PEM_write_bio_X509_REQ_NEW, PEM_write_X509_REQ_NEW, PEM_read_bio_X509_CRL, PEM_read_X509_CRL, PEM_write_bio_X509_CRL, PEM_write_X509_CRL, PEM_read_bio_PKCS7, PEM_read_PKCS7, PEM_write_bio_PKCS7, PEM_write_PKCS7, PEM_read_bio_NETSCAPE_CERT_SEQUENCE, PEM_read_NETSCAPE_CERT_SEQUENCE, PEM_write_bio_NETSCAPE_CERT_SEQUENCE, PEM_write_NETSCAPE_CERT_SEQUENCE \- PEM routines
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/pem.h>
147 \&
148 \& EVP_PKEY *PEM_read_bio_PrivateKey(BIO *bp, EVP_PKEY **x,
149 \&                                        pem_password_cb *cb, void *u);
150 \&
151 \& EVP_PKEY *PEM_read_PrivateKey(FILE *fp, EVP_PKEY **x,
152 \&                                        pem_password_cb *cb, void *u);
153 \&
154 \& int PEM_write_bio_PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
155 \&                                        unsigned char *kstr, int klen,
156 \&                                        pem_password_cb *cb, void *u);
157 \&
158 \& int PEM_write_PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
159 \&                                        unsigned char *kstr, int klen,
160 \&                                        pem_password_cb *cb, void *u);
161 \&
162 \& int PEM_write_bio_PKCS8PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
163 \&                                        char *kstr, int klen,
164 \&                                        pem_password_cb *cb, void *u);
165 \&
166 \& int PEM_write_PKCS8PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
167 \&                                        char *kstr, int klen,
168 \&                                        pem_password_cb *cb, void *u);
169 \&
170 \& int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, EVP_PKEY *x, int nid,
171 \&                                        char *kstr, int klen,
172 \&                                        pem_password_cb *cb, void *u);
173 \&
174 \& int PEM_write_PKCS8PrivateKey_nid(FILE *fp, EVP_PKEY *x, int nid,
175 \&                                        char *kstr, int klen,
176 \&                                        pem_password_cb *cb, void *u);
177 \&
178 \& EVP_PKEY *PEM_read_bio_PUBKEY(BIO *bp, EVP_PKEY **x,
179 \&                                        pem_password_cb *cb, void *u);
180 \&
181 \& EVP_PKEY *PEM_read_PUBKEY(FILE *fp, EVP_PKEY **x,
182 \&                                        pem_password_cb *cb, void *u);
183 \&
184 \& int PEM_write_bio_PUBKEY(BIO *bp, EVP_PKEY *x);
185 \& int PEM_write_PUBKEY(FILE *fp, EVP_PKEY *x);
186 \&
187 \& RSA *PEM_read_bio_RSAPrivateKey(BIO *bp, RSA **x,
188 \&                                        pem_password_cb *cb, void *u);
189 \&
190 \& RSA *PEM_read_RSAPrivateKey(FILE *fp, RSA **x,
191 \&                                        pem_password_cb *cb, void *u);
192 \&
193 \& int PEM_write_bio_RSAPrivateKey(BIO *bp, RSA *x, const EVP_CIPHER *enc,
194 \&                                        unsigned char *kstr, int klen,
195 \&                                        pem_password_cb *cb, void *u);
196 \&
197 \& int PEM_write_RSAPrivateKey(FILE *fp, RSA *x, const EVP_CIPHER *enc,
198 \&                                        unsigned char *kstr, int klen,
199 \&                                        pem_password_cb *cb, void *u);
200 \&
201 \& RSA *PEM_read_bio_RSAPublicKey(BIO *bp, RSA **x,
202 \&                                        pem_password_cb *cb, void *u);
203 \&
204 \& RSA *PEM_read_RSAPublicKey(FILE *fp, RSA **x,
205 \&                                        pem_password_cb *cb, void *u);
206 \&
207 \& int PEM_write_bio_RSAPublicKey(BIO *bp, RSA *x);
208 \&
209 \& int PEM_write_RSAPublicKey(FILE *fp, RSA *x);
210 \&
211 \& RSA *PEM_read_bio_RSA_PUBKEY(BIO *bp, RSA **x,
212 \&                                        pem_password_cb *cb, void *u);
213 \&
214 \& RSA *PEM_read_RSA_PUBKEY(FILE *fp, RSA **x,
215 \&                                        pem_password_cb *cb, void *u);
216 \&
217 \& int PEM_write_bio_RSA_PUBKEY(BIO *bp, RSA *x);
218 \&
219 \& int PEM_write_RSA_PUBKEY(FILE *fp, RSA *x);
220 \&
221 \& DSA *PEM_read_bio_DSAPrivateKey(BIO *bp, DSA **x,
222 \&                                        pem_password_cb *cb, void *u);
223 \&
224 \& DSA *PEM_read_DSAPrivateKey(FILE *fp, DSA **x,
225 \&                                        pem_password_cb *cb, void *u);
226 \&
227 \& int PEM_write_bio_DSAPrivateKey(BIO *bp, DSA *x, const EVP_CIPHER *enc,
228 \&                                        unsigned char *kstr, int klen,
229 \&                                        pem_password_cb *cb, void *u);
230 \&
231 \& int PEM_write_DSAPrivateKey(FILE *fp, DSA *x, const EVP_CIPHER *enc,
232 \&                                        unsigned char *kstr, int klen,
233 \&                                        pem_password_cb *cb, void *u);
234 \&
235 \& DSA *PEM_read_bio_DSA_PUBKEY(BIO *bp, DSA **x,
236 \&                                        pem_password_cb *cb, void *u);
237 \&
238 \& DSA *PEM_read_DSA_PUBKEY(FILE *fp, DSA **x,
239 \&                                        pem_password_cb *cb, void *u);
240 \&
241 \& int PEM_write_bio_DSA_PUBKEY(BIO *bp, DSA *x);
242 \&
243 \& int PEM_write_DSA_PUBKEY(FILE *fp, DSA *x);
244 \&
245 \& DSA *PEM_read_bio_DSAparams(BIO *bp, DSA **x, pem_password_cb *cb, void *u);
246 \&
247 \& DSA *PEM_read_DSAparams(FILE *fp, DSA **x, pem_password_cb *cb, void *u);
248 \&
249 \& int PEM_write_bio_DSAparams(BIO *bp, DSA *x);
250 \&
251 \& int PEM_write_DSAparams(FILE *fp, DSA *x);
252 \&
253 \& DH *PEM_read_bio_DHparams(BIO *bp, DH **x, pem_password_cb *cb, void *u);
254 \&
255 \& DH *PEM_read_DHparams(FILE *fp, DH **x, pem_password_cb *cb, void *u);
256 \&
257 \& int PEM_write_bio_DHparams(BIO *bp, DH *x);
258 \&
259 \& int PEM_write_DHparams(FILE *fp, DH *x);
260 \&
261 \& X509 *PEM_read_bio_X509(BIO *bp, X509 **x, pem_password_cb *cb, void *u);
262 \&
263 \& X509 *PEM_read_X509(FILE *fp, X509 **x, pem_password_cb *cb, void *u);
264 \&
265 \& int PEM_write_bio_X509(BIO *bp, X509 *x);
266 \&
267 \& int PEM_write_X509(FILE *fp, X509 *x);
268 \&
269 \& X509 *PEM_read_bio_X509_AUX(BIO *bp, X509 **x, pem_password_cb *cb, void *u);
270 \&
271 \& X509 *PEM_read_X509_AUX(FILE *fp, X509 **x, pem_password_cb *cb, void *u);
272 \&
273 \& int PEM_write_bio_X509_AUX(BIO *bp, X509 *x);
274 \&
275 \& int PEM_write_X509_AUX(FILE *fp, X509 *x);
276 \&
277 \& X509_REQ *PEM_read_bio_X509_REQ(BIO *bp, X509_REQ **x,
278 \&                                        pem_password_cb *cb, void *u);
279 \&
280 \& X509_REQ *PEM_read_X509_REQ(FILE *fp, X509_REQ **x,
281 \&                                        pem_password_cb *cb, void *u);
282 \&
283 \& int PEM_write_bio_X509_REQ(BIO *bp, X509_REQ *x);
284 \&
285 \& int PEM_write_X509_REQ(FILE *fp, X509_REQ *x);
286 \&
287 \& int PEM_write_bio_X509_REQ_NEW(BIO *bp, X509_REQ *x);
288 \&
289 \& int PEM_write_X509_REQ_NEW(FILE *fp, X509_REQ *x);
290 \&
291 \& X509_CRL *PEM_read_bio_X509_CRL(BIO *bp, X509_CRL **x,
292 \&                                        pem_password_cb *cb, void *u);
293 \& X509_CRL *PEM_read_X509_CRL(FILE *fp, X509_CRL **x,
294 \&                                        pem_password_cb *cb, void *u);
295 \& int PEM_write_bio_X509_CRL(BIO *bp, X509_CRL *x);
296 \& int PEM_write_X509_CRL(FILE *fp, X509_CRL *x);
297 \&
298 \& PKCS7 *PEM_read_bio_PKCS7(BIO *bp, PKCS7 **x, pem_password_cb *cb, void *u);
299 \&
300 \& PKCS7 *PEM_read_PKCS7(FILE *fp, PKCS7 **x, pem_password_cb *cb, void *u);
301 \&
302 \& int PEM_write_bio_PKCS7(BIO *bp, PKCS7 *x);
303 \&
304 \& int PEM_write_PKCS7(FILE *fp, PKCS7 *x);
305 \&
306 \& NETSCAPE_CERT_SEQUENCE *PEM_read_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp,
307 \&                                                NETSCAPE_CERT_SEQUENCE **x,
308 \&                                                pem_password_cb *cb, void *u);
309 \&
310 \& NETSCAPE_CERT_SEQUENCE *PEM_read_NETSCAPE_CERT_SEQUENCE(FILE *fp,
311 \&                                                NETSCAPE_CERT_SEQUENCE **x,
312 \&                                                pem_password_cb *cb, void *u);
313 \&
314 \& int PEM_write_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp, NETSCAPE_CERT_SEQUENCE *x);
315 \&
316 \& int PEM_write_NETSCAPE_CERT_SEQUENCE(FILE *fp, NETSCAPE_CERT_SEQUENCE *x);
317 .Ve
318 .SH "DESCRIPTION"
319 .IX Header "DESCRIPTION"
320 The \s-1PEM\s0 functions read or write structures in \s-1PEM\s0 format. In
321 this sense \s-1PEM\s0 format is simply base64 encoded data surrounded
322 by header lines.
323 .PP
324 For more details about the meaning of arguments see the
325 \&\fB\s-1PEM FUNCTION ARGUMENTS\s0\fR section.
326 .PP
327 Each operation has four functions associated with it. For
328 clarity the term "\fBfoobar\fR functions" will be used to collectively
329 refer to the \fIPEM_read_bio_foobar()\fR, \fIPEM_read_foobar()\fR,
330 \&\fIPEM_write_bio_foobar()\fR and \fIPEM_write_foobar()\fR functions.
331 .PP
332 The \fBPrivateKey\fR functions read or write a private key in
333 \&\s-1PEM\s0 format using an \s-1EVP_PKEY\s0 structure. The write routines use
334 \&\*(L"traditional\*(R" private key format and can handle both \s-1RSA\s0 and \s-1DSA\s0
335 private keys. The read functions can additionally transparently
336 handle PKCS#8 format encrypted and unencrypted keys too.
337 .PP
338 \&\fIPEM_write_bio_PKCS8PrivateKey()\fR and \fIPEM_write_PKCS8PrivateKey()\fR
339 write a private key in an \s-1EVP_PKEY\s0 structure in PKCS#8
340 EncryptedPrivateKeyInfo format using PKCS#5 v2.0 password based encryption
341 algorithms. The \fBcipher\fR argument specifies the encryption algorithm to
342 use: unlike all other \s-1PEM\s0 routines the encryption is applied at the
343 PKCS#8 level and not in the \s-1PEM\s0 headers. If \fBcipher\fR is \s-1NULL\s0 then no
344 encryption is used and a PKCS#8 PrivateKeyInfo structure is used instead.
345 .PP
346 \&\fIPEM_write_bio_PKCS8PrivateKey_nid()\fR and \fIPEM_write_PKCS8PrivateKey_nid()\fR
347 also write out a private key as a PKCS#8 EncryptedPrivateKeyInfo however
348 it uses PKCS#5 v1.5 or PKCS#12 encryption algorithms instead. The algorithm
349 to use is specified in the \fBnid\fR parameter and should be the \s-1NID\s0 of the
350 corresponding \s-1OBJECT IDENTIFIER \s0(see \s-1NOTES\s0 section).
351 .PP
352 The \fB\s-1PUBKEY\s0\fR functions process a public key using an \s-1EVP_PKEY\s0
353 structure. The public key is encoded as a SubjectPublicKeyInfo
354 structure.
355 .PP
356 The \fBRSAPrivateKey\fR functions process an \s-1RSA\s0 private key using an
357 \&\s-1RSA\s0 structure. It handles the same formats as the \fBPrivateKey\fR
358 functions but an error occurs if the private key is not \s-1RSA.\s0
359 .PP
360 The \fBRSAPublicKey\fR functions process an \s-1RSA\s0 public key using an
361 \&\s-1RSA\s0 structure. The public key is encoded using a PKCS#1 RSAPublicKey
362 structure.
363 .PP
364 The \fB\s-1RSA_PUBKEY\s0\fR functions also process an \s-1RSA\s0 public key using
365 an \s-1RSA\s0 structure. However the public key is encoded using a
366 SubjectPublicKeyInfo structure and an error occurs if the public
367 key is not \s-1RSA.\s0
368 .PP
369 The \fBDSAPrivateKey\fR functions process a \s-1DSA\s0 private key using a
370 \&\s-1DSA\s0 structure. It handles the same formats as the \fBPrivateKey\fR
371 functions but an error occurs if the private key is not \s-1DSA.\s0
372 .PP
373 The \fB\s-1DSA_PUBKEY\s0\fR functions process a \s-1DSA\s0 public key using
374 a \s-1DSA\s0 structure. The public key is encoded using a
375 SubjectPublicKeyInfo structure and an error occurs if the public
376 key is not \s-1DSA.\s0
377 .PP
378 The \fBDSAparams\fR functions process \s-1DSA\s0 parameters using a \s-1DSA\s0
379 structure. The parameters are encoded using a foobar structure.
380 .PP
381 The \fBDHparams\fR functions process \s-1DH\s0 parameters using a \s-1DH\s0
382 structure. The parameters are encoded using a PKCS#3 DHparameter
383 structure.
384 .PP
385 The \fBX509\fR functions process an X509 certificate using an X509
386 structure. They will also process a trusted X509 certificate but
387 any trust settings are discarded.
388 .PP
389 The \fBX509_AUX\fR functions process a trusted X509 certificate using
390 an X509 structure.
391 .PP
392 The \fBX509_REQ\fR and \fBX509_REQ_NEW\fR functions process a PKCS#10
393 certificate request using an X509_REQ structure. The \fBX509_REQ\fR
394 write functions use \fB\s-1CERTIFICATE REQUEST\s0\fR in the header whereas
395 the \fBX509_REQ_NEW\fR functions use \fB\s-1NEW CERTIFICATE REQUEST\s0\fR
396 (as required by some CAs). The \fBX509_REQ\fR read functions will
397 handle either form so there are no \fBX509_REQ_NEW\fR read functions.
398 .PP
399 The \fBX509_CRL\fR functions process an X509 \s-1CRL\s0 using an X509_CRL
400 structure.
401 .PP
402 The \fB\s-1PKCS7\s0\fR functions process a PKCS#7 ContentInfo using a \s-1PKCS7\s0
403 structure.
404 .PP
405 The \fB\s-1NETSCAPE_CERT_SEQUENCE\s0\fR functions process a Netscape Certificate
406 Sequence using a \s-1NETSCAPE_CERT_SEQUENCE\s0 structure.
407 .SH "PEM FUNCTION ARGUMENTS"
408 .IX Header "PEM FUNCTION ARGUMENTS"
409 The \s-1PEM\s0 functions have many common arguments.
410 .PP
411 The \fBbp\fR \s-1BIO\s0 parameter (if present) specifies the \s-1BIO\s0 to read from
412 or write to.
413 .PP
414 The \fBfp\fR \s-1FILE\s0 parameter (if present) specifies the \s-1FILE\s0 pointer to
415 read from or write to.
416 .PP
417 The \s-1PEM\s0 read functions all take an argument \fB\s-1TYPE\s0 **x\fR and return
418 a \fB\s-1TYPE\s0 *\fR pointer. Where \fB\s-1TYPE\s0\fR is whatever structure the function
419 uses. If \fBx\fR is \s-1NULL\s0 then the parameter is ignored. If \fBx\fR is not
420 \&\s-1NULL\s0 but \fB*x\fR is \s-1NULL\s0 then the structure returned will be written
421 to \fB*x\fR. If neither \fBx\fR nor \fB*x\fR is \s-1NULL\s0 then an attempt is made
422 to reuse the structure at \fB*x\fR (but see \s-1BUGS\s0 and \s-1EXAMPLES\s0 sections).
423 Irrespective of the value of \fBx\fR a pointer to the structure is always
424 returned (or \s-1NULL\s0 if an error occurred).
425 .PP
426 The \s-1PEM\s0 functions which write private keys take an \fBenc\fR parameter
427 which specifies the encryption algorithm to use, encryption is done
428 at the \s-1PEM\s0 level. If this parameter is set to \s-1NULL\s0 then the private
429 key is written in unencrypted form.
430 .PP
431 The \fBcb\fR argument is the callback to use when querying for the pass
432 phrase used for encrypted \s-1PEM\s0 structures (normally only private keys).
433 .PP
434 For the \s-1PEM\s0 write routines if the \fBkstr\fR parameter is not \s-1NULL\s0 then
435 \&\fBklen\fR bytes at \fBkstr\fR are used as the passphrase and \fBcb\fR is
436 ignored.
437 .PP
438 If the \fBcb\fR parameters is set to \s-1NULL\s0 and the \fBu\fR parameter is not
439 \&\s-1NULL\s0 then the \fBu\fR parameter is interpreted as a null terminated string
440 to use as the passphrase. If both \fBcb\fR and \fBu\fR are \s-1NULL\s0 then the
441 default callback routine is used which will typically prompt for the
442 passphrase on the current terminal with echoing turned off.
443 .PP
444 The default passphrase callback is sometimes inappropriate (for example
445 in a \s-1GUI\s0 application) so an alternative can be supplied. The callback
446 routine has the following form:
447 .PP
448 .Vb 1
449 \& int cb(char *buf, int size, int rwflag, void *u);
450 .Ve
451 .PP
452 \&\fBbuf\fR is the buffer to write the passphrase to. \fBsize\fR is the maximum
453 length of the passphrase (i.e. the size of buf). \fBrwflag\fR is a flag
454 which is set to 0 when reading and 1 when writing. A typical routine
455 will ask the user to verify the passphrase (for example by prompting
456 for it twice) if \fBrwflag\fR is 1. The \fBu\fR parameter has the same
457 value as the \fBu\fR parameter passed to the \s-1PEM\s0 routine. It allows
458 arbitrary data to be passed to the callback by the application
459 (for example a window handle in a \s-1GUI\s0 application). The callback
460 \&\fBmust\fR return the number of characters in the passphrase or 0 if
461 an error occurred.
462 .SH "EXAMPLES"
463 .IX Header "EXAMPLES"
464 Although the \s-1PEM\s0 routines take several arguments in almost all applications
465 most of them are set to 0 or \s-1NULL.\s0
466 .PP
467 Read a certificate in \s-1PEM\s0 format from a \s-1BIO:\s0
468 .PP
469 .Vb 6
470 \& X509 *x;
471 \& x = PEM_read_bio_X509(bp, NULL, 0, NULL);
472 \& if (x == NULL)
473 \&        {
474 \&        /* Error */
475 \&        }
476 .Ve
477 .PP
478 Alternative method:
479 .PP
480 .Vb 5
481 \& X509 *x = NULL;
482 \& if (!PEM_read_bio_X509(bp, &x, 0, NULL))
483 \&        {
484 \&        /* Error */
485 \&        }
486 .Ve
487 .PP
488 Write a certificate to a \s-1BIO:\s0
489 .PP
490 .Vb 4
491 \& if (!PEM_write_bio_X509(bp, x))
492 \&        {
493 \&        /* Error */
494 \&        }
495 .Ve
496 .PP
497 Write an unencrypted private key to a \s-1FILE\s0 pointer:
498 .PP
499 .Vb 4
500 \& if (!PEM_write_PrivateKey(fp, key, NULL, NULL, 0, 0, NULL))
501 \&        {
502 \&        /* Error */
503 \&        }
504 .Ve
505 .PP
506 Write a private key (using traditional format) to a \s-1BIO\s0 using
507 triple \s-1DES\s0 encryption, the pass phrase is prompted for:
508 .PP
509 .Vb 4
510 \& if (!PEM_write_bio_PrivateKey(bp, key, EVP_des_ede3_cbc(), NULL, 0, 0, NULL))
511 \&        {
512 \&        /* Error */
513 \&        }
514 .Ve
515 .PP
516 Write a private key (using PKCS#8 format) to a \s-1BIO\s0 using triple
517 \&\s-1DES\s0 encryption, using the pass phrase \*(L"hello\*(R":
518 .PP
519 .Vb 4
520 \& if (!PEM_write_bio_PKCS8PrivateKey(bp, key, EVP_des_ede3_cbc(), NULL, 0, 0, "hello"))
521 \&        {
522 \&        /* Error */
523 \&        }
524 .Ve
525 .PP
526 Read a private key from a \s-1BIO\s0 using the pass phrase \*(L"hello\*(R":
527 .PP
528 .Vb 5
529 \& key = PEM_read_bio_PrivateKey(bp, NULL, 0, "hello");
530 \& if (key == NULL)
531 \&        {
532 \&        /* Error */
533 \&        }
534 .Ve
535 .PP
536 Read a private key from a \s-1BIO\s0 using a pass phrase callback:
537 .PP
538 .Vb 5
539 \& key = PEM_read_bio_PrivateKey(bp, NULL, pass_cb, "My Private Key");
540 \& if (key == NULL)
541 \&        {
542 \&        /* Error */
543 \&        }
544 .Ve
545 .PP
546 Skeleton pass phrase callback:
547 .PP
548 .Vb 6
549 \& int pass_cb(char *buf, int size, int rwflag, void *u);
550 \&        {
551 \&        int len;
552 \&        char *tmp;
553 \&        /* We\*(Aqd probably do something else if \*(Aqrwflag\*(Aq is 1 */
554 \&        printf("Enter pass phrase for \e"%s\e"\en", u);
555 \&
556 \&        /* get pass phrase, length \*(Aqlen\*(Aq into \*(Aqtmp\*(Aq */
557 \&        tmp = "hello";
558 \&        len = strlen(tmp);
559 \&
560 \&        if (len <= 0) return 0;
561 \&        /* if too long, truncate */
562 \&        if (len > size) len = size;
563 \&        memcpy(buf, tmp, len);
564 \&        return len;
565 \&        }
566 .Ve
567 .SH "NOTES"
568 .IX Header "NOTES"
569 The old \fBPrivateKey\fR write routines are retained for compatibility.
570 New applications should write private keys using the
571 \&\fIPEM_write_bio_PKCS8PrivateKey()\fR or \fIPEM_write_PKCS8PrivateKey()\fR routines
572 because they are more secure (they use an iteration count of 2048 whereas
573 the traditional routines use a count of 1) unless compatibility with older
574 versions of OpenSSL is important.
575 .PP
576 The \fBPrivateKey\fR read routines can be used in all applications because
577 they handle all formats transparently.
578 .PP
579 A frequent cause of problems is attempting to use the \s-1PEM\s0 routines like
580 this:
581 .PP
582 .Vb 2
583 \& X509 *x;
584 \& PEM_read_bio_X509(bp, &x, 0, NULL);
585 .Ve
586 .PP
587 this is a bug because an attempt will be made to reuse the data at \fBx\fR
588 which is an uninitialised pointer.
589 .SH "PEM ENCRYPTION FORMAT"
590 .IX Header "PEM ENCRYPTION FORMAT"
591 This old \fBPrivateKey\fR routines use a non standard technique for encryption.
592 .PP
593 The private key (or other data) takes the following form:
594 .PP
595 .Vb 3
596 \& \-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-
597 \& Proc\-Type: 4,ENCRYPTED
598 \& DEK\-Info: DES\-EDE3\-CBC,3F17F5316E2BAC89
599 \&
600 \& ...base64 encoded data...
601 \& \-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-
602 .Ve
603 .PP
604 The line beginning DEK-Info contains two comma separated pieces of information:
605 the encryption algorithm name as used by \fIEVP_get_cipherbyname()\fR and an 8
606 byte \fBsalt\fR encoded as a set of hexadecimal digits.
607 .PP
608 After this is the base64 encoded encrypted data.
609 .PP
610 The encryption key is determined using \fIEVP_BytesToKey()\fR, using \fBsalt\fR and an
611 iteration count of 1. The \s-1IV\s0 used is the value of \fBsalt\fR and *not* the \s-1IV\s0
612 returned by \fIEVP_BytesToKey()\fR.
613 .SH "BUGS"
614 .IX Header "BUGS"
615 The \s-1PEM\s0 read routines in some versions of OpenSSL will not correctly reuse
616 an existing structure. Therefore the following:
617 .PP
618 .Vb 1
619 \& PEM_read_bio_X509(bp, &x, 0, NULL);
620 .Ve
621 .PP
622 where \fBx\fR already contains a valid certificate, may not work, whereas:
623 .PP
624 .Vb 2
625 \& X509_free(x);
626 \& x = PEM_read_bio_X509(bp, NULL, 0, NULL);
627 .Ve
628 .PP
629 is guaranteed to work.
630 .SH "RETURN CODES"
631 .IX Header "RETURN CODES"
632 The read routines return either a pointer to the structure read or \s-1NULL\s0
633 if an error occurred.
634 .PP
635 The write routines return 1 for success or 0 for failure.
636 .SH "SEE ALSO"
637 .IX Header "SEE ALSO"
638 \&\fIEVP_get_cipherbyname\fR\|(3), \fIEVP_BytesToKey\fR\|(3)