openssl: Adjust manual pages for 1.0.1h.
[dragonfly.git] / secure / lib / libcrypto / man / d2i_X509.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "d2i_X509 3"
127 .TH d2i_X509 3 "2014-06-05" "1.0.1h" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio,
134 i2d_X509_fp \- X509 encode and decode functions
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 1
138 \& #include <openssl/x509.h>
139 \&
140 \& X509 *d2i_X509(X509 **px, const unsigned char **in, int len);
141 \& int i2d_X509(X509 *x, unsigned char **out);
142 \&
143 \& X509 *d2i_X509_bio(BIO *bp, X509 **x);
144 \& X509 *d2i_X509_fp(FILE *fp, X509 **x);
145 \&
146 \& int i2d_X509_bio(BIO *bp, X509 *x);
147 \& int i2d_X509_fp(FILE *fp, X509 *x);
148 .Ve
149 .SH "DESCRIPTION"
150 .IX Header "DESCRIPTION"
151 The X509 encode and decode routines encode and parse an
152 \&\fBX509\fR structure, which represents an X509 certificate.
153 .PP
154 \&\fId2i_X509()\fR attempts to decode \fBlen\fR bytes at \fB*in\fR. If 
155 successful a pointer to the \fBX509\fR structure is returned. If an error
156 occurred then \fB\s-1NULL\s0\fR is returned. If \fBpx\fR is not \fB\s-1NULL\s0\fR then the
157 returned structure is written to \fB*px\fR. If \fB*px\fR is not \fB\s-1NULL\s0\fR
158 then it is assumed that \fB*px\fR contains a valid \fBX509\fR
159 structure and an attempt is made to reuse it. If the call is
160 successful \fB*in\fR is incremented to the byte following the
161 parsed data.
162 .PP
163 \&\fIi2d_X509()\fR encodes the structure pointed to by \fBx\fR into \s-1DER\s0 format.
164 If \fBout\fR is not \fB\s-1NULL\s0\fR is writes the \s-1DER\s0 encoded data to the buffer
165 at \fB*out\fR, and increments it to point after the data just written.
166 If the return value is negative an error occurred, otherwise it
167 returns the length of the encoded data.
168 .PP
169 For OpenSSL 0.9.7 and later if \fB*out\fR is \fB\s-1NULL\s0\fR memory will be
170 allocated for a buffer and the encoded data written to it. In this
171 case \fB*out\fR is not incremented and it points to the start of the
172 data just written.
173 .PP
174 \&\fId2i_X509_bio()\fR is similar to \fId2i_X509()\fR except it attempts
175 to parse data from \s-1BIO\s0 \fBbp\fR.
176 .PP
177 \&\fId2i_X509_fp()\fR is similar to \fId2i_X509()\fR except it attempts
178 to parse data from \s-1FILE\s0 pointer \fBfp\fR.
179 .PP
180 \&\fIi2d_X509_bio()\fR is similar to \fIi2d_X509()\fR except it writes
181 the encoding of the structure \fBx\fR to \s-1BIO\s0 \fBbp\fR and it
182 returns 1 for success and 0 for failure.
183 .PP
184 \&\fIi2d_X509_fp()\fR is similar to \fIi2d_X509()\fR except it writes
185 the encoding of the structure \fBx\fR to \s-1BIO\s0 \fBbp\fR and it
186 returns 1 for success and 0 for failure.
187 .SH "NOTES"
188 .IX Header "NOTES"
189 The letters \fBi\fR and \fBd\fR in for example \fBi2d_X509\fR stand for
190 \&\*(L"internal\*(R" (that is an internal C structure) and \*(L"\s-1DER\s0\*(R". So that
191 \&\fBi2d_X509\fR converts from internal to \s-1DER\s0.
192 .PP
193 The functions can also understand \fB\s-1BER\s0\fR forms.
194 .PP
195 The actual X509 structure passed to \fIi2d_X509()\fR must be a valid
196 populated \fBX509\fR structure it can \fBnot\fR simply be fed with an
197 empty structure such as that returned by \fIX509_new()\fR.
198 .PP
199 The encoded data is in binary form and may contain embedded zeroes.
200 Therefore any \s-1FILE\s0 pointers or BIOs should be opened in binary mode.
201 Functions such as \fB\f(BIstrlen()\fB\fR will \fBnot\fR return the correct length
202 of the encoded structure.
203 .PP
204 The ways that \fB*in\fR and \fB*out\fR are incremented after the operation
205 can trap the unwary. See the \fB\s-1WARNINGS\s0\fR section for some common
206 errors.
207 .PP
208 The reason for the auto increment behaviour is to reflect a typical
209 usage of \s-1ASN1\s0 functions: after one structure is encoded or decoded
210 another will processed after it.
211 .SH "EXAMPLES"
212 .IX Header "EXAMPLES"
213 Allocate and encode the \s-1DER\s0 encoding of an X509 structure:
214 .PP
215 .Vb 2
216 \& int len;
217 \& unsigned char *buf, *p;
218 \&
219 \& len = i2d_X509(x, NULL);
220 \&
221 \& buf = OPENSSL_malloc(len);
222 \&
223 \& if (buf == NULL)
224 \&        /* error */
225 \&
226 \& p = buf;
227 \&
228 \& i2d_X509(x, &p);
229 .Ve
230 .PP
231 If you are using OpenSSL 0.9.7 or later then this can be
232 simplified to:
233 .PP
234 .Vb 2
235 \& int len;
236 \& unsigned char *buf;
237 \&
238 \& buf = NULL;
239 \&
240 \& len = i2d_X509(x, &buf);
241 \&
242 \& if (len < 0)
243 \&        /* error */
244 .Ve
245 .PP
246 Attempt to decode a buffer:
247 .PP
248 .Vb 1
249 \& X509 *x;
250 \&
251 \& unsigned char *buf, *p;
252 \&
253 \& int len;
254 \&
255 \& /* Something to setup buf and len */
256 \&
257 \& p = buf;
258 \&
259 \& x = d2i_X509(NULL, &p, len);
260 \&
261 \& if (x == NULL)
262 \&    /* Some error */
263 .Ve
264 .PP
265 Alternative technique:
266 .PP
267 .Vb 1
268 \& X509 *x;
269 \&
270 \& unsigned char *buf, *p;
271 \&
272 \& int len;
273 \&
274 \& /* Something to setup buf and len */
275 \&
276 \& p = buf;
277 \&
278 \& x = NULL;
279 \&
280 \& if(!d2i_X509(&x, &p, len))
281 \&    /* Some error */
282 .Ve
283 .SH "WARNINGS"
284 .IX Header "WARNINGS"
285 The use of temporary variable is mandatory. A common
286 mistake is to attempt to use a buffer directly as follows:
287 .PP
288 .Vb 2
289 \& int len;
290 \& unsigned char *buf;
291 \&
292 \& len = i2d_X509(x, NULL);
293 \&
294 \& buf = OPENSSL_malloc(len);
295 \&
296 \& if (buf == NULL)
297 \&        /* error */
298 \&
299 \& i2d_X509(x, &buf);
300 \&
301 \& /* Other stuff ... */
302 \&
303 \& OPENSSL_free(buf);
304 .Ve
305 .PP
306 This code will result in \fBbuf\fR apparently containing garbage because
307 it was incremented after the call to point after the data just written.
308 Also \fBbuf\fR will no longer contain the pointer allocated by \fB\f(BIOPENSSL_malloc()\fB\fR
309 and the subsequent call to \fB\f(BIOPENSSL_free()\fB\fR may well crash.
310 .PP
311 The auto allocation feature (setting buf to \s-1NULL\s0) only works on OpenSSL
312 0.9.7 and later. Attempts to use it on earlier versions will typically
313 cause a segmentation violation.
314 .PP
315 Another trap to avoid is misuse of the \fBxp\fR argument to \fB\f(BId2i_X509()\fB\fR:
316 .PP
317 .Vb 1
318 \& X509 *x;
319 \&
320 \& if (!d2i_X509(&x, &p, len))
321 \&        /* Some error */
322 .Ve
323 .PP
324 This will probably crash somewhere in \fB\f(BId2i_X509()\fB\fR. The reason for this
325 is that the variable \fBx\fR is uninitialized and an attempt will be made to
326 interpret its (invalid) value as an \fBX509\fR structure, typically causing
327 a segmentation violation. If \fBx\fR is set to \s-1NULL\s0 first then this will not
328 happen.
329 .SH "BUGS"
330 .IX Header "BUGS"
331 In some versions of OpenSSL the \*(L"reuse\*(R" behaviour of \fId2i_X509()\fR when 
332 \&\fB*px\fR is valid is broken and some parts of the reused structure may
333 persist if they are not present in the new one. As a result the use
334 of this \*(L"reuse\*(R" behaviour is strongly discouraged.
335 .PP
336 \&\fIi2d_X509()\fR will not return an error in many versions of OpenSSL,
337 if mandatory fields are not initialized due to a programming error
338 then the encoded structure may contain invalid data or omit the
339 fields entirely and will not be parsed by \fId2i_X509()\fR. This may be
340 fixed in future so code should not assume that \fIi2d_X509()\fR will
341 always succeed.
342 .SH "RETURN VALUES"
343 .IX Header "RETURN VALUES"
344 \&\fId2i_X509()\fR, \fId2i_X509_bio()\fR and \fId2i_X509_fp()\fR return a valid \fBX509\fR structure
345 or \fB\s-1NULL\s0\fR if an error occurs. The error code that can be obtained by
346 \&\fIERR_get_error\fR\|(3).
347 .PP
348 \&\fIi2d_X509()\fR returns the number of bytes successfully encoded or a negative
349 value if an error occurs. The error code can be obtained by
350 \&\fIERR_get_error\fR\|(3).
351 .PP
352 \&\fIi2d_X509_bio()\fR and \fIi2d_X509_fp()\fR return 1 for success and 0 if an error 
353 occurs The error code can be obtained by \fIERR_get_error\fR\|(3).
354 .SH "SEE ALSO"
355 .IX Header "SEE ALSO"
356 \&\fIERR_get_error\fR\|(3)
357 .SH "HISTORY"
358 .IX Header "HISTORY"
359 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio and i2d_X509_fp
360 are available in all versions of SSLeay and OpenSSL.