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 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 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
  94 another will processed after it.
  95
  96 =head1 EXAMPLES
  97
  98 Allocate and encode the DER encoding of an X509 structure:
  99
 100  int len;
 101  unsigned char *buf;
 102
 103  buf = NULL;
 104  len = i2d_X509(x, &buf);
 105  if (len < 0)
 106         /* error */
 107
 108 Attempt to decode a buffer:
 109
 110  X509 *x;
 111  unsigned char *buf, *p;
 112  int len;
 113
 114  /* Something to setup buf and len */
 115  p = buf;
 116  x = d2i_X509(NULL, &p, len);
 117
 118  if (x == NULL)
 119     /* Some error */
 120
 121 Alternative technique:
 122
 123  X509 *x;
 124  unsigned char *buf, *p;
 125  int len;
 126
 127  /* Something to setup buf and len */
 128  p = buf;
 129  x = NULL;
 130
 131  if (!d2i_X509(&x, &p, len))
 132     /* Some error */
 133
 134
 135 =head1 WARNINGS
 136
 137 The use of temporary variable is mandatory. A common
 138 mistake is to attempt to use a buffer directly as follows:
 139
 140  int len;
 141  unsigned char *buf;
 142
 143  len = i2d_X509(x, NULL);
 144  buf = OPENSSL_malloc(len);
 145  if (buf == NULL)
 146         /* error */
 147
 148  i2d_X509(x, &buf);
 149  /* Other stuff ... */
 150  OPENSSL_free(buf);
 151
 152 This code will result in B<buf> apparently containing garbage because
 153 it was incremented after the call to point after the data just written.
 154 Also B<buf> will no longer contain the pointer allocated by OPENSSL_malloc()
 155 and the subsequent call to OPENSSL_free() may well crash.
 156
 157 Another trap to avoid is misuse of the B<xp> argument to d2i_X509():
 158
 159  X509 *x;
 160
 161  if (!d2i_X509(&x, &p, len))
 162         /* Some error */
 163
 164 This will probably crash somewhere in d2i_X509(). The reason for this
 165 is that the variable B<x> is uninitialized and an attempt will be made to
 166 interpret its (invalid) value as an B<X509> structure, typically causing
 167 a segmentation violation. If B<x> is set to NULL first then this will not
 168 happen.
 169
 170 =head1 BUGS
 171
 172 In some versions of OpenSSL the "reuse" behaviour of d2i_X509() when
 173 B<*px> is valid is broken and some parts of the reused structure may
 174 persist if they are not present in the new one. As a result the use
 175 of this "reuse" behaviour is strongly discouraged.
 176
 177 i2d_X509() will not return an error in many versions of OpenSSL,
 178 if mandatory fields are not initialized due to a programming error
 179 then the encoded structure may contain invalid data or omit the
 180 fields entirely and will not be parsed by d2i_X509(). This may be
 181 fixed in future so code should not assume that i2d_X509() will
 182 always succeed.
 183
 184 The encoding of the TBSCertificate portion of a certificate is cached
 185 in the B<X509> structure internally to improve encoding performance
 186 and to ensure certificate signatures are verified correctly in some
 187 certificates with broken (non-DER) encodings.
 188
 189 Any function which encodes an X509 structure such as i2d_X509(),
 190 i2d_X509_fp() or i2d_X509_bio() may return a stale encoding if the
 191 B<X509> structure has been modified after deserialization or previous
 192 serialization.
 193
 194 If, after modification, the B<X509> object is re-signed with X509_sign(),
 195 the encoding is automatically renewed. Otherwise, the encoding of the
 196 TBSCertificate portion of the B<X509> can be manually renewed by calling
 197 i2d_re_X509_tbs().
 198
 199 =head1 RETURN VALUES
 200
 201 d2i_X509(), d2i_X509_bio() and d2i_X509_fp() return a valid B<X509> structure
 202 or B<NULL> if an error occurs. The error code that can be obtained by
 203 L<ERR_get_error(3)>. If the "reuse" capability has been used
 204 with a valid X509 structure being passed in via B<px> then the object is not
 205 freed in the event of error but may be in a potentially invalid or inconsistent
 206 state.
 207
 208 i2d_X509() returns the number of bytes successfully encoded or a negative
 209 value if an error occurs. The error code can be obtained by
 210 L<ERR_get_error(3)>.
 211
 212 i2d_X509_bio() and i2d_X509_fp() return 1 for success and 0 if an error
 213 occurs The error code can be obtained by L<ERR_get_error(3)>.
 214
 215 =head1 SEE ALSO
 216
 217 L<ERR_get_error(3)>
 218 L<X509_CRL_get0_by_serial(3)>,
 219 L<X509_get0_signature(3)>,
 220 L<X509_get_ext_d2i(3)>,
 221 L<X509_get_extension_flags(3)>,
 222 L<X509_get_pubkey(3)>,
 223 L<X509_get_subject_name(3)>,
 224 L<X509_get_version(3)>,
 225 L<X509_NAME_add_entry_by_txt(3)>,
 226 L<X509_NAME_ENTRY_get_object(3)>,
 227 L<X509_NAME_get_index_by_NID(3)>,
 228 L<X509_NAME_print_ex(3)>,
 229 L<X509_new(3)>,
 230 L<X509_sign(3)>,
 231 L<X509V3_get_d2i(3)>,
 232 L<X509_verify_cert(3)>
 233
 234 =cut