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