secure/lib/libcrypto/man/d2i_X509.3

   1 .\" Automatically generated by Pod::Man 2.28 (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 "d2i_X509 3"
 136 .TH d2i_X509 3 "2016-09-22" "1.0.2i" "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 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio,
 143 i2d_X509_fp \- X509 encode and decode functions
 144 .SH "SYNOPSIS"
 145 .IX Header "SYNOPSIS"
 146 .Vb 1
 147 \& #include <openssl/x509.h>
 148 \&
 149 \& X509 *d2i_X509(X509 **px, const unsigned char **in, long len);
 150 \& X509 *d2i_X509_AUX(X509 **px, const unsigned char **in, long len);
 151 \& int i2d_X509(X509 *x, unsigned char **out);
 152 \& int i2d_X509_AUX(X509 *x, unsigned char **out);
 153 \&
 154 \& X509 *d2i_X509_bio(BIO *bp, X509 **x);
 155 \& X509 *d2i_X509_fp(FILE *fp, X509 **x);
 156 \&
 157 \& int i2d_X509_bio(BIO *bp, X509 *x);
 158 \& int i2d_X509_fp(FILE *fp, X509 *x);
 159 \&
 160 \& int i2d_re_X509_tbs(X509 *x, unsigned char **out);
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 The X509 encode and decode routines encode and parse an
 165 \&\fBX509\fR structure, which represents an X509 certificate.
 166 .PP
 167 \&\fId2i_X509()\fR attempts to decode \fBlen\fR bytes at \fB*in\fR. If
 168 successful a pointer to the \fBX509\fR structure is returned. If an error
 169 occurred then \fB\s-1NULL\s0\fR is returned. If \fBpx\fR is not \fB\s-1NULL\s0\fR then the
 170 returned structure is written to \fB*px\fR. If \fB*px\fR is not \fB\s-1NULL\s0\fR
 171 then it is assumed that \fB*px\fR contains a valid \fBX509\fR
 172 structure and an attempt is made to reuse it. This \*(L"reuse\*(R" capability is present
 173 for historical compatibility but its use is \fBstrongly discouraged\fR (see \s-1BUGS\s0
 174 below, and the discussion in the \s-1RETURN VALUES\s0 section).
 175 .PP
 176 If the call is successful \fB*in\fR is incremented to the byte following the
 177 parsed data.
 178 .PP
 179 \&\fId2i_X509_AUX()\fR is similar to \fId2i_X509()\fR but the input is expected to consist of
 180 an X509 certificate followed by auxiliary trust information.
 181 This is used by the \s-1PEM\s0 routines to read \*(L"\s-1TRUSTED CERTIFICATE\*(R"\s0 objects.
 182 This function should not be called on untrusted input.
 183 .PP
 184 \&\fIi2d_X509()\fR encodes the structure pointed to by \fBx\fR into \s-1DER\s0 format.
 185 If \fBout\fR is not \fB\s-1NULL\s0\fR is writes the \s-1DER\s0 encoded data to the buffer
 186 at \fB*out\fR, and increments it to point after the data just written.
 187 If the return value is negative an error occurred, otherwise it
 188 returns the length of the encoded data.
 189 .PP
 190 For OpenSSL 0.9.7 and later if \fB*out\fR is \fB\s-1NULL\s0\fR memory will be
 191 allocated for a buffer and the encoded data written to it. In this
 192 case \fB*out\fR is not incremented and it points to the start of the
 193 data just written.
 194 .PP
 195 \&\fIi2d_X509_AUX()\fR is similar to \fIi2d_X509()\fR, but the encoded output contains both
 196 the certificate and any auxiliary trust information.
 197 This is used by the \s-1PEM\s0 routines to write \*(L"\s-1TRUSTED CERTIFICATE\*(R"\s0 objects.
 198 Note, this is a non-standard OpenSSL-specific data format.
 199 .PP
 200 \&\fId2i_X509_bio()\fR is similar to \fId2i_X509()\fR except it attempts
 201 to parse data from \s-1BIO \s0\fBbp\fR.
 202 .PP
 203 \&\fId2i_X509_fp()\fR is similar to \fId2i_X509()\fR except it attempts
 204 to parse data from \s-1FILE\s0 pointer \fBfp\fR.
 205 .PP
 206 \&\fIi2d_X509_bio()\fR is similar to \fIi2d_X509()\fR except it writes
 207 the encoding of the structure \fBx\fR to \s-1BIO \s0\fBbp\fR and it
 208 returns 1 for success and 0 for failure.
 209 .PP
 210 \&\fIi2d_X509_fp()\fR is similar to \fIi2d_X509()\fR except it writes
 211 the encoding of the structure \fBx\fR to \s-1BIO \s0\fBbp\fR and it
 212 returns 1 for success and 0 for failure.
 213 .PP
 214 \&\fIi2d_re_X509_tbs()\fR is similar to \fIi2d_X509()\fR except it encodes
 215 only the TBSCertificate portion of the certificate.
 216 .SH "NOTES"
 217 .IX Header "NOTES"
 218 The letters \fBi\fR and \fBd\fR in for example \fBi2d_X509\fR stand for
 219 \&\*(L"internal\*(R" (that is an internal C structure) and \*(L"\s-1DER\*(R".\s0 So
 220 \&\fBi2d_X509\fR converts from internal to \s-1DER.\s0 The \*(L"re\*(R" in
 221 \&\fBi2d_re_X509_tbs\fR stands for \*(L"re-encode\*(R", and ensures that a fresh
 222 encoding is generated in case the object has been modified after
 223 creation (see the \s-1BUGS\s0 section).
 224 .PP
 225 The functions can also understand \fB\s-1BER\s0\fR forms.
 226 .PP
 227 The actual X509 structure passed to \fIi2d_X509()\fR must be a valid
 228 populated \fBX509\fR structure it can \fBnot\fR simply be fed with an
 229 empty structure such as that returned by \fIX509_new()\fR.
 230 .PP
 231 The encoded data is in binary form and may contain embedded zeroes.
 232 Therefore any \s-1FILE\s0 pointers or BIOs should be opened in binary mode.
 233 Functions such as \fB\f(BIstrlen()\fB\fR will \fBnot\fR return the correct length
 234 of the encoded structure.
 235 .PP
 236 The ways that \fB*in\fR and \fB*out\fR are incremented after the operation
 237 can trap the unwary. See the \fB\s-1WARNINGS\s0\fR section for some common
 238 errors.
 239 .PP
 240 The reason for the auto increment behaviour is to reflect a typical
 241 usage of \s-1ASN1\s0 functions: after one structure is encoded or decoded
 242 another will processed after it.
 243 .SH "EXAMPLES"
 244 .IX Header "EXAMPLES"
 245 Allocate and encode the \s-1DER\s0 encoding of an X509 structure:
 246 .PP
 247 .Vb 2
 248 \& int len;
 249 \& unsigned char *buf, *p;
 250 \&
 251 \& len = i2d_X509(x, NULL);
 252 \&
 253 \& buf = OPENSSL_malloc(len);
 254 \&
 255 \& if (buf == NULL)
 256 \&        /* error */
 257 \&
 258 \& p = buf;
 259 \&
 260 \& i2d_X509(x, &p);
 261 .Ve
 262 .PP
 263 If you are using OpenSSL 0.9.7 or later then this can be
 264 simplified to:
 265 .PP
 266 .Vb 2
 267 \& int len;
 268 \& unsigned char *buf;
 269 \&
 270 \& buf = NULL;
 271 \&
 272 \& len = i2d_X509(x, &buf);
 273 \&
 274 \& if (len < 0)
 275 \&        /* error */
 276 .Ve
 277 .PP
 278 Attempt to decode a buffer:
 279 .PP
 280 .Vb 1
 281 \& X509 *x;
 282 \&
 283 \& unsigned char *buf, *p;
 284 \&
 285 \& int len;
 286 \&
 287 \& /* Something to setup buf and len */
 288 \&
 289 \& p = buf;
 290 \&
 291 \& x = d2i_X509(NULL, &p, len);
 292 \&
 293 \& if (x == NULL)
 294 \&    /* Some error */
 295 .Ve
 296 .PP
 297 Alternative technique:
 298 .PP
 299 .Vb 1
 300 \& X509 *x;
 301 \&
 302 \& unsigned char *buf, *p;
 303 \&
 304 \& int len;
 305 \&
 306 \& /* Something to setup buf and len */
 307 \&
 308 \& p = buf;
 309 \&
 310 \& x = NULL;
 311 \&
 312 \& if(!d2i_X509(&x, &p, len))
 313 \&    /* Some error */
 314 .Ve
 315 .SH "WARNINGS"
 316 .IX Header "WARNINGS"
 317 The use of temporary variable is mandatory. A common
 318 mistake is to attempt to use a buffer directly as follows:
 319 .PP
 320 .Vb 2
 321 \& int len;
 322 \& unsigned char *buf;
 323 \&
 324 \& len = i2d_X509(x, NULL);
 325 \&
 326 \& buf = OPENSSL_malloc(len);
 327 \&
 328 \& if (buf == NULL)
 329 \&        /* error */
 330 \&
 331 \& i2d_X509(x, &buf);
 332 \&
 333 \& /* Other stuff ... */
 334 \&
 335 \& OPENSSL_free(buf);
 336 .Ve
 337 .PP
 338 This code will result in \fBbuf\fR apparently containing garbage because
 339 it was incremented after the call to point after the data just written.
 340 Also \fBbuf\fR will no longer contain the pointer allocated by \fB\f(BIOPENSSL_malloc()\fB\fR
 341 and the subsequent call to \fB\f(BIOPENSSL_free()\fB\fR may well crash.
 342 .PP
 343 The auto allocation feature (setting buf to \s-1NULL\s0) only works on OpenSSL
 344 0.9.7 and later. Attempts to use it on earlier versions will typically
 345 cause a segmentation violation.
 346 .PP
 347 Another trap to avoid is misuse of the \fBxp\fR argument to \fB\f(BId2i_X509()\fB\fR:
 348 .PP
 349 .Vb 1
 350 \& X509 *x;
 351 \&
 352 \& if (!d2i_X509(&x, &p, len))
 353 \&        /* Some error */
 354 .Ve
 355 .PP
 356 This will probably crash somewhere in \fB\f(BId2i_X509()\fB\fR. The reason for this
 357 is that the variable \fBx\fR is uninitialized and an attempt will be made to
 358 interpret its (invalid) value as an \fBX509\fR structure, typically causing
 359 a segmentation violation. If \fBx\fR is set to \s-1NULL\s0 first then this will not
 360 happen.
 361 .SH "BUGS"
 362 .IX Header "BUGS"
 363 In some versions of OpenSSL the \*(L"reuse\*(R" behaviour of \fId2i_X509()\fR when
 364 \&\fB*px\fR is valid is broken and some parts of the reused structure may
 365 persist if they are not present in the new one. As a result the use
 366 of this \*(L"reuse\*(R" behaviour is strongly discouraged.
 367 .PP
 368 \&\fIi2d_X509()\fR will not return an error in many versions of OpenSSL,
 369 if mandatory fields are not initialized due to a programming error
 370 then the encoded structure may contain invalid data or omit the
 371 fields entirely and will not be parsed by \fId2i_X509()\fR. This may be
 372 fixed in future so code should not assume that \fIi2d_X509()\fR will
 373 always succeed.
 374 .PP
 375 The encoding of the TBSCertificate portion of a certificate is cached
 376 in the \fBX509\fR structure internally to improve encoding performance
 377 and to ensure certificate signatures are verified correctly in some
 378 certificates with broken (non-DER) encodings.
 379 .PP
 380 Any function which encodes an X509 structure such as \fIi2d_X509()\fR,
 381 \&\fIi2d_X509_fp()\fR or \fIi2d_X509_bio()\fR may return a stale encoding if the
 382 \&\fBX509\fR structure has been modified after deserialization or previous
 383 serialization.
 384 .PP
 385 If, after modification, the \fBX509\fR object is re-signed with \fIX509_sign()\fR,
 386 the encoding is automatically renewed. Otherwise, the encoding of the
 387 TBSCertificate portion of the \fBX509\fR can be manually renewed by calling
 388 \&\fIi2d_re_X509_tbs()\fR.
 389 .SH "RETURN VALUES"
 390 .IX Header "RETURN VALUES"
 391 \&\fId2i_X509()\fR, \fId2i_X509_bio()\fR and \fId2i_X509_fp()\fR return a valid \fBX509\fR structure
 392 or \fB\s-1NULL\s0\fR if an error occurs. The error code that can be obtained by
 393 \&\fIERR_get_error\fR\|(3). If the \*(L"reuse\*(R" capability has been used
 394 with a valid X509 structure being passed in via \fBpx\fR then the object is not
 395 freed in the event of error but may be in a potentially invalid or inconsistent
 396 state.
 397 .PP
 398 \&\fIi2d_X509()\fR returns the number of bytes successfully encoded or a negative
 399 value if an error occurs. The error code can be obtained by
 400 \&\fIERR_get_error\fR\|(3).
 401 .PP
 402 \&\fIi2d_X509_bio()\fR and \fIi2d_X509_fp()\fR return 1 for success and 0 if an error
 403 occurs The error code can be obtained by \fIERR_get_error\fR\|(3).
 404 .SH "SEE ALSO"
 405 .IX Header "SEE ALSO"
 406 \&\fIERR_get_error\fR\|(3)
 407 .SH "HISTORY"
 408 .IX Header "HISTORY"
 409 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio and i2d_X509_fp
 410 are available in all versions of SSLeay and OpenSSL.