03236769a0637e2ed339d5d7a83a6c961bdbea0d
[openssl.git] / doc / crypto / d2i_X509.pod
1 =pod
2
3 =head1 NAME
4
5 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio,
6 i2d_X509_fp - X509 encode and decode functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/x509.h>
11
12  X509 *d2i_X509(X509 **px, const unsigned char **in, int len);
13  int i2d_X509(X509 *x, unsigned char **out);
14
15  X509 *d2i_X509_bio(BIO *bp, X509 **x);
16  X509 *d2i_X509_fp(FILE *fp, X509 **x);
17
18  int i2d_X509_bio(BIO *bp, X509 *x);
19  int i2d_X509_fp(FILE *fp, X509 *x);
20
21  int i2d_re_X509_tbs(X509 *x, unsigned char **out);
22
23 =head1 DESCRIPTION
24
25 The X509 encode and decode routines encode and parse an
26 B<X509> structure, which represents an X509 certificate.
27
28 d2i_X509() attempts to decode B<len> bytes at B<*in>. If 
29 successful a pointer to the B<X509> structure is returned. If an error
30 occurred then B<NULL> is returned. If B<px> is not B<NULL> then the
31 returned structure is written to B<*px>. If B<*px> is not B<NULL>
32 then it is assumed that B<*px> contains a valid B<X509>
33 structure and an attempt is made to reuse it. This "reuse" capability is present
34 for historical compatibility but its use is B<strongly discouraged> (see BUGS
35 below, and the discussion in the RETURN VALUES section).
36
37 If the call is successful B<*in> is incremented to the byte following the
38 parsed data.
39
40 i2d_X509() encodes the structure pointed to by B<x> into DER format.
41 If B<out> is not B<NULL> is writes the DER encoded data to the buffer
42 at B<*out>, and increments it to point after the data just written.
43 If the return value is negative an error occurred, otherwise it
44 returns the length of the encoded data. 
45
46 For OpenSSL 0.9.7 and later if B<*out> is B<NULL> memory will be
47 allocated for a buffer and the encoded data written to it. In this
48 case B<*out> is not incremented and it points to the start of the
49 data just written.
50
51 d2i_X509_bio() is similar to d2i_X509() except it attempts
52 to parse data from BIO B<bp>.
53
54 d2i_X509_fp() is similar to d2i_X509() except it attempts
55 to parse data from FILE pointer B<fp>.
56
57 i2d_X509_bio() is similar to i2d_X509() except it writes
58 the encoding of the structure B<x> to BIO B<bp> and it
59 returns 1 for success and 0 for failure.
60
61 i2d_X509_fp() is similar to i2d_X509() except it writes
62 the encoding of the structure B<x> to BIO B<bp> and it
63 returns 1 for success and 0 for failure.
64
65 i2d_re_X509_tbs() is similar to i2d_X509() except it encodes
66 only the TBSCertificate portion of the certificate.
67
68 =head1 NOTES
69
70 The letters B<i> and B<d> in for example B<i2d_X509> stand for
71 "internal" (that is an internal C structure) and "DER". So
72 B<i2d_X509> converts from internal to DER. The "re" in
73 B<i2d_re_X509_tbs> stands for "re-encode", and ensures that a fresh
74 encoding is generated in case the object has been modified after
75 creation (see the BUGS section).
76
77 The functions can also understand B<BER> forms.
78
79 The actual X509 structure passed to i2d_X509() must be a valid
80 populated B<X509> structure it can B<not> simply be fed with an
81 empty structure such as that returned by X509_new().
82
83 The encoded data is in binary form and may contain embedded zeroes.
84 Therefore any FILE pointers or BIOs should be opened in binary mode.
85 Functions such as B<strlen()> will B<not> return the correct length
86 of the encoded structure.
87
88 The ways that B<*in> and B<*out> are incremented after the operation
89 can trap the unwary. See the B<WARNINGS> section for some common
90 errors.
91
92 The reason for the auto increment behaviour is to reflect a typical
93 usage of ASN1 functions: after one structure is encoded or decoded    if (a != NULL)
94         (*a) = ret;
95 another will processed after it.
96
97 =head1 EXAMPLES
98
99 Allocate and encode the DER encoding of an X509 structure:
100
101  int len;
102  unsigned char *buf, *p;
103
104  len = i2d_X509(x, NULL);
105
106  buf = OPENSSL_malloc(len);
107
108  if (buf == NULL)
109         /* error */
110
111  p = buf;
112
113  i2d_X509(x, &p);
114
115 If you are using OpenSSL 0.9.7 or later then this can be
116 simplified to:
117
118
119  int len;
120  unsigned char *buf;
121
122  buf = NULL;
123
124  len = i2d_X509(x, &buf);
125
126  if (len < 0)
127         /* error */
128
129 Attempt to decode a buffer:
130
131  X509 *x;
132
133  unsigned char *buf, *p;
134
135  int len;
136
137  /* Something to setup buf and len */
138
139  p = buf;
140
141  x = d2i_X509(NULL, &p, len);
142
143  if (x == NULL)
144     /* Some error */
145
146 Alternative technique:
147
148  X509 *x;
149
150  unsigned char *buf, *p;
151
152  int len;
153
154  /* Something to setup buf and len */
155
156  p = buf;
157
158  x = NULL;
159
160  if(!d2i_X509(&x, &p, len))
161     /* Some error */
162
163
164 =head1 WARNINGS
165
166 The use of temporary variable is mandatory. A common
167 mistake is to attempt to use a buffer directly as follows:
168
169  int len;
170  unsigned char *buf;
171
172  len = i2d_X509(x, NULL);
173
174  buf = OPENSSL_malloc(len);
175
176  if (buf == NULL)
177         /* error */
178
179  i2d_X509(x, &buf);
180
181  /* Other stuff ... */
182
183  OPENSSL_free(buf);
184
185 This code will result in B<buf> apparently containing garbage because
186 it was incremented after the call to point after the data just written.
187 Also B<buf> will no longer contain the pointer allocated by B<OPENSSL_malloc()>
188 and the subsequent call to B<OPENSSL_free()> may well crash.
189
190 The auto allocation feature (setting buf to NULL) only works on OpenSSL
191 0.9.7 and later. Attempts to use it on earlier versions will typically
192 cause a segmentation violation.
193
194 Another trap to avoid is misuse of the B<xp> argument to B<d2i_X509()>:
195
196  X509 *x;
197
198  if (!d2i_X509(&x, &p, len))
199         /* Some error */
200
201 This will probably crash somewhere in B<d2i_X509()>. The reason for this
202 is that the variable B<x> is uninitialized and an attempt will be made to
203 interpret its (invalid) value as an B<X509> structure, typically causing
204 a segmentation violation. If B<x> is set to NULL first then this will not
205 happen.
206
207 =head1 BUGS
208
209 In some versions of OpenSSL the "reuse" behaviour of d2i_X509() when 
210 B<*px> is valid is broken and some parts of the reused structure may
211 persist if they are not present in the new one. As a result the use
212 of this "reuse" behaviour is strongly discouraged.
213
214 i2d_X509() will not return an error in many versions of OpenSSL,
215 if mandatory fields are not initialized due to a programming error
216 then the encoded structure may contain invalid data or omit the    if (a != NULL)
217         (*a) = ret;
218 fields entirely and will not be parsed by d2i_X509(). This may be
219 fixed in future so code should not assume that i2d_X509() will
220 always succeed.
221
222 The encoding of the TBSCertificate portion of a certificate is cached
223 in the B<X509> structure internally to improve encoding performance
224 and to ensure certificate signatures are verified correctly in some
225 certificates with broken (non-DER) encodings.
226
227 Any function which encodes an X509 structure such as i2d_X509(),
228 i2d_X509_fp() or i2d_X509_bio() may return a stale encoding if the
229 B<X509> structure has been modified after deserialization or previous
230 serialization.
231
232 If, after modification, the B<X509> object is re-signed with X509_sign(),
233 the encoding is automatically renewed. Otherwise, the encoding of the
234 TBSCertificate portion of the B<X509> can be manually renewed by calling
235 i2d_re_X509_tbs().
236
237 =head1 RETURN VALUES
238
239 d2i_X509(), d2i_X509_bio() and d2i_X509_fp() return a valid B<X509> structure
240 or B<NULL> if an error occurs. The error code that can be obtained by
241 L<ERR_get_error(3)|ERR_get_error(3)>. If the "reuse" capability has been used
242 with a valid X509 structure being passed in via B<px> then the object is not
243 freed in the event of error but may be in a potentially invalid or inconsistent
244 state.
245
246 i2d_X509() returns the number of bytes successfully encoded or a negative
247 value if an error occurs. The error code can be obtained by
248 L<ERR_get_error(3)|ERR_get_error(3)>. 
249
250 i2d_X509_bio() and i2d_X509_fp() return 1 for success and 0 if an error 
251 occurs The error code can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. 
252
253 =head1 SEE ALSO
254
255 L<ERR_get_error(3)|ERR_get_error(3)>
256
257 =head1 HISTORY
258
259 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio and i2d_X509_fp
260 are available in all versions of SSLeay and OpenSSL.
261
262 =cut