secure/lib/libcrypto/man/d2i_X509.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "d2i_X509 3"
 132 .TH d2i_X509 3 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio,
 139 i2d_X509_fp \- X509 encode and decode functions
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 .Vb 1
 143 \& #include <openssl/x509.h>
 144 \&
 145 \& X509 *d2i_X509(X509 **px, const unsigned char **in, long len);
 146 \& X509 *d2i_X509_AUX(X509 **px, const unsigned char **in, long len);
 147 \& int i2d_X509(X509 *x, unsigned char **out);
 148 \& int i2d_X509_AUX(X509 *x, unsigned char **out);
 149 \&
 150 \& X509 *d2i_X509_bio(BIO *bp, X509 **x);
 151 \& X509 *d2i_X509_fp(FILE *fp, X509 **x);
 152 \&
 153 \& int i2d_X509_bio(BIO *bp, X509 *x);
 154 \& int i2d_X509_fp(FILE *fp, X509 *x);
 155 \&
 156 \& int i2d_re_X509_tbs(X509 *x, unsigned char **out);
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 The X509 encode and decode routines encode and parse an
 161 \&\fBX509\fR structure, which represents an X509 certificate.
 162 .PP
 163 \&\fId2i_X509()\fR attempts to decode \fBlen\fR bytes at \fB*in\fR. If
 164 successful a pointer to the \fBX509\fR structure is returned. If an error
 165 occurred then \fB\s-1NULL\s0\fR is returned. If \fBpx\fR is not \fB\s-1NULL\s0\fR then the
 166 returned structure is written to \fB*px\fR. If \fB*px\fR is not \fB\s-1NULL\s0\fR
 167 then it is assumed that \fB*px\fR contains a valid \fBX509\fR
 168 structure and an attempt is made to reuse it. This \*(L"reuse\*(R" capability is present
 169 for historical compatibility but its use is \fBstrongly discouraged\fR (see \s-1BUGS\s0
 170 below, and the discussion in the \s-1RETURN VALUES\s0 section).
 171 .PP
 172 If the call is successful \fB*in\fR is incremented to the byte following the
 173 parsed data.
 174 .PP
 175 \&\fId2i_X509_AUX()\fR is similar to \fId2i_X509()\fR but the input is expected to consist of
 176 an X509 certificate followed by auxiliary trust information.
 177 This is used by the \s-1PEM\s0 routines to read \*(L"\s-1TRUSTED CERTIFICATE\*(R"\s0 objects.
 178 This function should not be called on untrusted input.
 179 .PP
 180 \&\fIi2d_X509()\fR encodes the structure pointed to by \fBx\fR into \s-1DER\s0 format.
 181 If \fBout\fR is not \fB\s-1NULL\s0\fR is writes the \s-1DER\s0 encoded data to the buffer
 182 at \fB*out\fR, and increments it to point after the data just written.
 183 If the return value is negative an error occurred, otherwise it
 184 returns the length of the encoded data.
 185 .PP
 186 For OpenSSL 0.9.7 and later if \fB*out\fR is \fB\s-1NULL\s0\fR memory will be
 187 allocated for a buffer and the encoded data written to it. In this
 188 case \fB*out\fR is not incremented and it points to the start of the
 189 data just written.
 190 .PP
 191 \&\fIi2d_X509_AUX()\fR is similar to \fIi2d_X509()\fR, but the encoded output contains both
 192 the certificate and any auxiliary trust information.
 193 This is used by the \s-1PEM\s0 routines to write \*(L"\s-1TRUSTED CERTIFICATE\*(R"\s0 objects.
 194 Note, this is a non-standard OpenSSL-specific data format.
 195 .PP
 196 \&\fId2i_X509_bio()\fR is similar to \fId2i_X509()\fR except it attempts
 197 to parse data from \s-1BIO \s0\fBbp\fR.
 198 .PP
 199 \&\fId2i_X509_fp()\fR is similar to \fId2i_X509()\fR except it attempts
 200 to parse data from \s-1FILE\s0 pointer \fBfp\fR.
 201 .PP
 202 \&\fIi2d_X509_bio()\fR is similar to \fIi2d_X509()\fR except it writes
 203 the encoding of the structure \fBx\fR to \s-1BIO \s0\fBbp\fR and it
 204 returns 1 for success and 0 for failure.
 205 .PP
 206 \&\fIi2d_X509_fp()\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_re_X509_tbs()\fR is similar to \fIi2d_X509()\fR except it encodes
 211 only the TBSCertificate portion of the certificate.
 212 .SH "NOTES"
 213 .IX Header "NOTES"
 214 The letters \fBi\fR and \fBd\fR in for example \fBi2d_X509\fR stand for
 215 \&\*(L"internal\*(R" (that is an internal C structure) and \*(L"\s-1DER\*(R".\s0 So
 216 \&\fBi2d_X509\fR converts from internal to \s-1DER.\s0 The \*(L"re\*(R" in
 217 \&\fBi2d_re_X509_tbs\fR stands for \*(L"re-encode\*(R", and ensures that a fresh
 218 encoding is generated in case the object has been modified after
 219 creation (see the \s-1BUGS\s0 section).
 220 .PP
 221 The functions can also understand \fB\s-1BER\s0\fR forms.
 222 .PP
 223 The actual X509 structure passed to \fIi2d_X509()\fR must be a valid
 224 populated \fBX509\fR structure it can \fBnot\fR simply be fed with an
 225 empty structure such as that returned by \fIX509_new()\fR.
 226 .PP
 227 The encoded data is in binary form and may contain embedded zeroes.
 228 Therefore any \s-1FILE\s0 pointers or BIOs should be opened in binary mode.
 229 Functions such as \fB\f(BIstrlen()\fB\fR will \fBnot\fR return the correct length
 230 of the encoded structure.
 231 .PP
 232 The ways that \fB*in\fR and \fB*out\fR are incremented after the operation
 233 can trap the unwary. See the \fB\s-1WARNINGS\s0\fR section for some common
 234 errors.
 235 .PP
 236 The reason for the auto increment behaviour is to reflect a typical
 237 usage of \s-1ASN1\s0 functions: after one structure is encoded or decoded
 238 another will processed after it.
 239 .SH "EXAMPLES"
 240 .IX Header "EXAMPLES"
 241 Allocate and encode the \s-1DER\s0 encoding of an X509 structure:
 242 .PP
 243 .Vb 2
 244 \& int len;
 245 \& unsigned char *buf, *p;
 246 \&
 247 \& len = i2d_X509(x, NULL);
 248 \&
 249 \& buf = OPENSSL_malloc(len);
 250 \&
 251 \& if (buf == NULL)
 252 \&        /* error */
 253 \&
 254 \& p = buf;
 255 \&
 256 \& i2d_X509(x, &p);
 257 .Ve
 258 .PP
 259 If you are using OpenSSL 0.9.7 or later then this can be
 260 simplified to:
 261 .PP
 262 .Vb 2
 263 \& int len;
 264 \& unsigned char *buf;
 265 \&
 266 \& buf = NULL;
 267 \&
 268 \& len = i2d_X509(x, &buf);
 269 \&
 270 \& if (len < 0)
 271 \&        /* error */
 272 .Ve
 273 .PP
 274 Attempt to decode a buffer:
 275 .PP
 276 .Vb 1
 277 \& X509 *x;
 278 \&
 279 \& unsigned char *buf, *p;
 280 \&
 281 \& int len;
 282 \&
 283 \& /* Something to setup buf and len */
 284 \&
 285 \& p = buf;
 286 \&
 287 \& x = d2i_X509(NULL, &p, len);
 288 \&
 289 \& if (x == NULL)
 290 \&    /* Some error */
 291 .Ve
 292 .PP
 293 Alternative technique:
 294 .PP
 295 .Vb 1
 296 \& X509 *x;
 297 \&
 298 \& unsigned char *buf, *p;
 299 \&
 300 \& int len;
 301 \&
 302 \& /* Something to setup buf and len */
 303 \&
 304 \& p = buf;
 305 \&
 306 \& x = NULL;
 307 \&
 308 \& if(!d2i_X509(&x, &p, len))
 309 \&    /* Some error */
 310 .Ve
 311 .SH "WARNINGS"
 312 .IX Header "WARNINGS"
 313 The use of temporary variable is mandatory. A common
 314 mistake is to attempt to use a buffer directly as follows:
 315 .PP
 316 .Vb 2
 317 \& int len;
 318 \& unsigned char *buf;
 319 \&
 320 \& len = i2d_X509(x, NULL);
 321 \&
 322 \& buf = OPENSSL_malloc(len);
 323 \&
 324 \& if (buf == NULL)
 325 \&        /* error */
 326 \&
 327 \& i2d_X509(x, &buf);
 328 \&
 329 \& /* Other stuff ... */
 330 \&
 331 \& OPENSSL_free(buf);
 332 .Ve
 333 .PP
 334 This code will result in \fBbuf\fR apparently containing garbage because
 335 it was incremented after the call to point after the data just written.
 336 Also \fBbuf\fR will no longer contain the pointer allocated by \fB\f(BIOPENSSL_malloc()\fB\fR
 337 and the subsequent call to \fB\f(BIOPENSSL_free()\fB\fR may well crash.
 338 .PP
 339 The auto allocation feature (setting buf to \s-1NULL\s0) only works on OpenSSL
 340 0.9.7 and later. Attempts to use it on earlier versions will typically
 341 cause a segmentation violation.
 342 .PP
 343 Another trap to avoid is misuse of the \fBxp\fR argument to \fB\f(BId2i_X509()\fB\fR:
 344 .PP
 345 .Vb 1
 346 \& X509 *x;
 347 \&
 348 \& if (!d2i_X509(&x, &p, len))
 349 \&        /* Some error */
 350 .Ve
 351 .PP
 352 This will probably crash somewhere in \fB\f(BId2i_X509()\fB\fR. The reason for this
 353 is that the variable \fBx\fR is uninitialized and an attempt will be made to
 354 interpret its (invalid) value as an \fBX509\fR structure, typically causing
 355 a segmentation violation. If \fBx\fR is set to \s-1NULL\s0 first then this will not
 356 happen.
 357 .SH "BUGS"
 358 .IX Header "BUGS"
 359 In some versions of OpenSSL the \*(L"reuse\*(R" behaviour of \fId2i_X509()\fR when
 360 \&\fB*px\fR is valid is broken and some parts of the reused structure may
 361 persist if they are not present in the new one. As a result the use
 362 of this \*(L"reuse\*(R" behaviour is strongly discouraged.
 363 .PP
 364 \&\fIi2d_X509()\fR will not return an error in many versions of OpenSSL,
 365 if mandatory fields are not initialized due to a programming error
 366 then the encoded structure may contain invalid data or omit the
 367 fields entirely and will not be parsed by \fId2i_X509()\fR. This may be
 368 fixed in future so code should not assume that \fIi2d_X509()\fR will
 369 always succeed.
 370 .PP
 371 The encoding of the TBSCertificate portion of a certificate is cached
 372 in the \fBX509\fR structure internally to improve encoding performance
 373 and to ensure certificate signatures are verified correctly in some
 374 certificates with broken (non-DER) encodings.
 375 .PP
 376 Any function which encodes an X509 structure such as \fIi2d_X509()\fR,
 377 \&\fIi2d_X509_fp()\fR or \fIi2d_X509_bio()\fR may return a stale encoding if the
 378 \&\fBX509\fR structure has been modified after deserialization or previous
 379 serialization.
 380 .PP
 381 If, after modification, the \fBX509\fR object is re-signed with \fIX509_sign()\fR,
 382 the encoding is automatically renewed. Otherwise, the encoding of the
 383 TBSCertificate portion of the \fBX509\fR can be manually renewed by calling
 384 \&\fIi2d_re_X509_tbs()\fR.
 385 .SH "RETURN VALUES"
 386 .IX Header "RETURN VALUES"
 387 \&\fId2i_X509()\fR, \fId2i_X509_bio()\fR and \fId2i_X509_fp()\fR return a valid \fBX509\fR structure
 388 or \fB\s-1NULL\s0\fR if an error occurs. The error code that can be obtained by
 389 \&\fIERR_get_error\fR\|(3). If the \*(L"reuse\*(R" capability has been used
 390 with a valid X509 structure being passed in via \fBpx\fR then the object is not
 391 freed in the event of error but may be in a potentially invalid or inconsistent
 392 state.
 393 .PP
 394 \&\fIi2d_X509()\fR returns the number of bytes successfully encoded or a negative
 395 value if an error occurs. The error code can be obtained by
 396 \&\fIERR_get_error\fR\|(3).
 397 .PP
 398 \&\fIi2d_X509_bio()\fR and \fIi2d_X509_fp()\fR return 1 for success and 0 if an error
 399 occurs The error code can be obtained by \fIERR_get_error\fR\|(3).
 400 .SH "SEE ALSO"
 401 .IX Header "SEE ALSO"
 402 \&\fIERR_get_error\fR\|(3)
 403 .SH "HISTORY"
 404 .IX Header "HISTORY"
 405 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio and i2d_X509_fp
 406 are available in all versions of SSLeay and OpenSSL.