secure/lib/libcrypto/man/d2i_X509.3

   1 .\" Automatically generated by Pod::Man 2.27 (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 "2015-03-19" "1.0.1m" "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, int len);
 150 \& int i2d_X509(X509 *x, unsigned char **out);
 151 \&
 152 \& X509 *d2i_X509_bio(BIO *bp, X509 **x);
 153 \& X509 *d2i_X509_fp(FILE *fp, X509 **x);
 154 \&
 155 \& int i2d_X509_bio(BIO *bp, X509 *x);
 156 \& int i2d_X509_fp(FILE *fp, X509 *x);
 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 \&\fIi2d_X509()\fR encodes the structure pointed to by \fBx\fR into \s-1DER\s0 format.
 176 If \fBout\fR is not \fB\s-1NULL\s0\fR is writes the \s-1DER\s0 encoded data to the buffer
 177 at \fB*out\fR, and increments it to point after the data just written.
 178 If the return value is negative an error occurred, otherwise it
 179 returns the length of the encoded data.
 180 .PP
 181 For OpenSSL 0.9.7 and later if \fB*out\fR is \fB\s-1NULL\s0\fR memory will be
 182 allocated for a buffer and the encoded data written to it. In this
 183 case \fB*out\fR is not incremented and it points to the start of the
 184 data just written.
 185 .PP
 186 \&\fId2i_X509_bio()\fR is similar to \fId2i_X509()\fR except it attempts
 187 to parse data from \s-1BIO \s0\fBbp\fR.
 188 .PP
 189 \&\fId2i_X509_fp()\fR is similar to \fId2i_X509()\fR except it attempts
 190 to parse data from \s-1FILE\s0 pointer \fBfp\fR.
 191 .PP
 192 \&\fIi2d_X509_bio()\fR is similar to \fIi2d_X509()\fR except it writes
 193 the encoding of the structure \fBx\fR to \s-1BIO \s0\fBbp\fR and it
 194 returns 1 for success and 0 for failure.
 195 .PP
 196 \&\fIi2d_X509_fp()\fR is similar to \fIi2d_X509()\fR except it writes
 197 the encoding of the structure \fBx\fR to \s-1BIO \s0\fBbp\fR and it
 198 returns 1 for success and 0 for failure.
 199 .SH "NOTES"
 200 .IX Header "NOTES"
 201 The letters \fBi\fR and \fBd\fR in for example \fBi2d_X509\fR stand for
 202 \&\*(L"internal\*(R" (that is an internal C structure) and \*(L"\s-1DER\*(R".\s0 So that
 203 \&\fBi2d_X509\fR converts from internal to \s-1DER.\s0
 204 .PP
 205 The functions can also understand \fB\s-1BER\s0\fR forms.
 206 .PP
 207 The actual X509 structure passed to \fIi2d_X509()\fR must be a valid
 208 populated \fBX509\fR structure it can \fBnot\fR simply be fed with an
 209 empty structure such as that returned by \fIX509_new()\fR.
 210 .PP
 211 The encoded data is in binary form and may contain embedded zeroes.
 212 Therefore any \s-1FILE\s0 pointers or BIOs should be opened in binary mode.
 213 Functions such as \fB\f(BIstrlen()\fB\fR will \fBnot\fR return the correct length
 214 of the encoded structure.
 215 .PP
 216 The ways that \fB*in\fR and \fB*out\fR are incremented after the operation
 217 can trap the unwary. See the \fB\s-1WARNINGS\s0\fR section for some common
 218 errors.
 219 .PP
 220 The reason for the auto increment behaviour is to reflect a typical
 221 usage of \s-1ASN1\s0 functions: after one structure is encoded or decoded
 222 another will processed after it.
 223 .SH "EXAMPLES"
 224 .IX Header "EXAMPLES"
 225 Allocate and encode the \s-1DER\s0 encoding of an X509 structure:
 226 .PP
 227 .Vb 2
 228 \& int len;
 229 \& unsigned char *buf, *p;
 230 \&
 231 \& len = i2d_X509(x, NULL);
 232 \&
 233 \& buf = OPENSSL_malloc(len);
 234 \&
 235 \& if (buf == NULL)
 236 \&        /* error */
 237 \&
 238 \& p = buf;
 239 \&
 240 \& i2d_X509(x, &p);
 241 .Ve
 242 .PP
 243 If you are using OpenSSL 0.9.7 or later then this can be
 244 simplified to:
 245 .PP
 246 .Vb 2
 247 \& int len;
 248 \& unsigned char *buf;
 249 \&
 250 \& buf = NULL;
 251 \&
 252 \& len = i2d_X509(x, &buf);
 253 \&
 254 \& if (len < 0)
 255 \&        /* error */
 256 .Ve
 257 .PP
 258 Attempt to decode a buffer:
 259 .PP
 260 .Vb 1
 261 \& X509 *x;
 262 \&
 263 \& unsigned char *buf, *p;
 264 \&
 265 \& int len;
 266 \&
 267 \& /* Something to setup buf and len */
 268 \&
 269 \& p = buf;
 270 \&
 271 \& x = d2i_X509(NULL, &p, len);
 272 \&
 273 \& if (x == NULL)
 274 \&    /* Some error */
 275 .Ve
 276 .PP
 277 Alternative technique:
 278 .PP
 279 .Vb 1
 280 \& X509 *x;
 281 \&
 282 \& unsigned char *buf, *p;
 283 \&
 284 \& int len;
 285 \&
 286 \& /* Something to setup buf and len */
 287 \&
 288 \& p = buf;
 289 \&
 290 \& x = NULL;
 291 \&
 292 \& if(!d2i_X509(&x, &p, len))
 293 \&    /* Some error */
 294 .Ve
 295 .SH "WARNINGS"
 296 .IX Header "WARNINGS"
 297 The use of temporary variable is mandatory. A common
 298 mistake is to attempt to use a buffer directly as follows:
 299 .PP
 300 .Vb 2
 301 \& int len;
 302 \& unsigned char *buf;
 303 \&
 304 \& len = i2d_X509(x, NULL);
 305 \&
 306 \& buf = OPENSSL_malloc(len);
 307 \&
 308 \& if (buf == NULL)
 309 \&        /* error */
 310 \&
 311 \& i2d_X509(x, &buf);
 312 \&
 313 \& /* Other stuff ... */
 314 \&
 315 \& OPENSSL_free(buf);
 316 .Ve
 317 .PP
 318 This code will result in \fBbuf\fR apparently containing garbage because
 319 it was incremented after the call to point after the data just written.
 320 Also \fBbuf\fR will no longer contain the pointer allocated by \fB\f(BIOPENSSL_malloc()\fB\fR
 321 and the subsequent call to \fB\f(BIOPENSSL_free()\fB\fR may well crash.
 322 .PP
 323 The auto allocation feature (setting buf to \s-1NULL\s0) only works on OpenSSL
 324 0.9.7 and later. Attempts to use it on earlier versions will typically
 325 cause a segmentation violation.
 326 .PP
 327 Another trap to avoid is misuse of the \fBxp\fR argument to \fB\f(BId2i_X509()\fB\fR:
 328 .PP
 329 .Vb 1
 330 \& X509 *x;
 331 \&
 332 \& if (!d2i_X509(&x, &p, len))
 333 \&        /* Some error */
 334 .Ve
 335 .PP
 336 This will probably crash somewhere in \fB\f(BId2i_X509()\fB\fR. The reason for this
 337 is that the variable \fBx\fR is uninitialized and an attempt will be made to
 338 interpret its (invalid) value as an \fBX509\fR structure, typically causing
 339 a segmentation violation. If \fBx\fR is set to \s-1NULL\s0 first then this will not
 340 happen.
 341 .SH "BUGS"
 342 .IX Header "BUGS"
 343 In some versions of OpenSSL the \*(L"reuse\*(R" behaviour of \fId2i_X509()\fR when
 344 \&\fB*px\fR is valid is broken and some parts of the reused structure may
 345 persist if they are not present in the new one. As a result the use
 346 of this \*(L"reuse\*(R" behaviour is strongly discouraged.
 347 .PP
 348 \&\fIi2d_X509()\fR will not return an error in many versions of OpenSSL,
 349 if mandatory fields are not initialized due to a programming error
 350 then the encoded structure may contain invalid data or omit the
 351 fields entirely and will not be parsed by \fId2i_X509()\fR. This may be
 352 fixed in future so code should not assume that \fIi2d_X509()\fR will
 353 always succeed.
 354 .SH "RETURN VALUES"
 355 .IX Header "RETURN VALUES"
 356 \&\fId2i_X509()\fR, \fId2i_X509_bio()\fR and \fId2i_X509_fp()\fR return a valid \fBX509\fR structure
 357 or \fB\s-1NULL\s0\fR if an error occurs. The error code that can be obtained by
 358 \&\fIERR_get_error\fR\|(3). If the \*(L"reuse\*(R" capability has been used
 359 with a valid X509 structure being passed in via \fBpx\fR then the object is not
 360 freed in the event of error but may be in a potentially invalid or inconsistent
 361 state.
 362 .PP
 363 \&\fIi2d_X509()\fR returns the number of bytes successfully encoded or a negative
 364 value if an error occurs. The error code can be obtained by
 365 \&\fIERR_get_error\fR\|(3).
 366 .PP
 367 \&\fIi2d_X509_bio()\fR and \fIi2d_X509_fp()\fR return 1 for success and 0 if an error
 368 occurs The error code can be obtained by \fIERR_get_error\fR\|(3).
 369 .SH "SEE ALSO"
 370 .IX Header "SEE ALSO"
 371 \&\fIERR_get_error\fR\|(3)
 372 .SH "HISTORY"
 373 .IX Header "HISTORY"
 374 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio and i2d_X509_fp
 375 are available in all versions of SSLeay and OpenSSL.