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