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  X509 *d2i_X509(X509 **px, unsigned char **in, int len);
  11  int i2d_X509(X509 *x, unsigned char **out);
  12
  13  X509 *d2i_X509_bio(BIO *bp, X509 **x);
  14  X509 *d2i_X509_fp(FILE *fp, X509 **x);
  15
  16  int i2d_X509_bio(X509 *x, BIO *bp);
  17  int i2d_X509_fp(X509 *x, FILE *fp);
  18
  19 =head1 DESCRIPTION
  20
  21 The X509 encode and decode routines encode and parse an
  22 B<X509> structure, which represents an X509 certificate.
  23
  24 d2i_X509() attempts to decode B<len> bytes at B<*out>. If
  25 successful a pointer to the B<X509> structure is returned. If an error
  26 occurred then B<NULL> is returned. If B<px> is not B<NULL> then the
  27 returned structure is written to B<*px>. If B<*px> is not B<NULL>
  28 then it is assumed that B<*px> contains a valid B<X509>
  29 structure and an attempt is made to reuse it. If the call is
  30 successful B<*out> is incremented to the byte following the
  31 parsed data.
  32
  33 i2d_X509() encodes the structure pointed to by B<x> into DER format.
  34 If B<out> is not B<NULL> is writes the DER encoded data to the buffer
  35 at B<*out>, and increments it to point after the data just written.
  36 If the return value is negative an error occurred, otherwise it
  37 returns the length of the encoded data.
  38
  39 For OpenSSL 0.9.7 and later if B<*out> is B<NULL> memory will be
  40 allocated for a buffer and the encoded data written to it. In this
  41 case B<*out> is not incremented and it points to the start of the
  42 data just written.
  43
  44 d2i_X509_bio() is similar to d2i_X509() except it attempts
  45 to parse data from BIO B<bp>.
  46
  47 d2i_X509_fp() is similar to d2i_X509() except it attempts
  48 to parse data from FILE pointer B<fp>.
  49
  50 i2d_X509_bio() is similar to i2d_X509() except it writes
  51 the encoding of the structure B<x> to BIO B<bp>.
  52
  53 i2d_X509_fp() is similar to i2d_X509() except it writes
  54 the encoding of the structure B<x> to BIO B<bp>.
  55
  56 =head1 NOTES
  57
  58 The letters B<i> and B<d> in for example B<i2d_X509> stand for
  59 "internal" (that is an internal C structure) and "DER". So that
  60 B<i2d_X509> converts from internal to DER.
  61
  62 The functions can also understand B<BER> forms.
  63
  64 The actual X509 structure passed to i2d_X509() must be a valid
  65 populated B<X509> structure it can B<not> simply be fed with an
  66 empty structure such as that returned by X509_new().
  67
  68 The encoded data is in binary form and may contain embedded zeroes.
  69 Therefore any FILE pointers or BIOs should be opened in binary mode.
  70 Functions such as B<strlen()> will B<not> return the correct length
  71 of the encoded structure.
  72
  73 The ways that B<*in> and B<*out> are incremented after the operation
  74 can trap the unwary. See the B<WARNINGS> section for some common
  75 errors.
  76
  77 The reason for the auto increment behaviour is to reflect a typical
  78 usage of ASN1 functions: after one structure is encoded or decoded
  79 another will processed after it.
  80
  81 =head1 EXAMPLES
  82
  83 Allocate and encode the DER encoding of an X509 structure:
  84
  85  int len;
  86  unsigned char *buf, *p;
  87
  88  len = i2d_X509(x, NULL);
  89
  90  buf = OPENSSL_malloc(len);
  91
  92  if (buf == NULL)
  93         /* error */
  94
  95  p = buf;
  96
  97  i2d_X509(x, &p);
  98
  99 If you are using OpenSSL 0.9.7 or later then this can be
 100 simplified to:
 101
 102
 103  int len;
 104  unsigned char *buf;
 105
 106  buf = NULL;
 107
 108  len = i2d_X509(x, &buf);
 109
 110  if (len < 0)
 111         /* error */
 112
 113 Attempt to decode a buffer:
 114
 115  X509 *x;
 116
 117  unsigned char *buf, *p;
 118
 119  int len;
 120
 121  /* Something to setup buf and len */
 122
 123  p = buf;
 124
 125  x = d2i_X509(NULL, &p, len);
 126
 127  if (x == NULL)
 128     /* Some error */
 129
 130 Alternative technique:
 131
 132  X509 *x;
 133
 134  unsigned char *buf, *p;
 135
 136  int len;
 137
 138  /* Something to setup buf and len */
 139
 140  p = buf;
 141
 142  x = NULL;
 143
 144  if(!d2i_X509(&x, &p, len))
 145     /* Some error */
 146
 147
 148 =head1 WARNINGS
 149
 150 The use of temporary variable is mandatory. A common
 151 mistake is to attempt to use a buffer directly as follows:
 152
 153  int len;
 154  unsigned char *buf;
 155
 156  len = i2d_X509(x, NULL);
 157
 158  buf = OPENSSL_malloc(len);
 159
 160  if (buf == NULL)
 161         /* error */
 162
 163  i2d_X509(x, &buf);
 164
 165  /* Other stuff ... */
 166
 167  OPENSSL_free(buf);
 168
 169 This code will result in B<buf> apparently containing garbage because
 170 it was incremented after the call to point after the data just written.
 171 Also B<buf> will no longer contain the pointer allocated by B<OPENSSL_malloc()>
 172 and the subsequent call to B<OPENSSL_free()> may well crash.
 173
 174 The auto allocation feature (setting buf to NULL) only works on OpenSSL
 175 0.9.7 and later. Attempts to use it on earlier versions will typically
 176 cause a segmentation violation.
 177
 178 Another trap to avoid is misuse of the B<xp> argument to B<d2i_X509()>:
 179
 180  X509 *x;
 181
 182  if (!d2i_X509(&x, &p, len))
 183         /* Some error */
 184
 185 This will probably crash somewhere in B<d2i_X509()>. The reason for this
 186 is that the variable B<x> is uninitialized and an attempt will be made to
 187 interpret its (invalid) value as an B<X509> structure, typically causing
 188 a segmentation violation. If B<x> is set to NULL first then this will not
 189 happen.
 190
 191 =head1 BUGS
 192
 193 In some versions of OpenSSL the "reuse" behaviour of d2i_X509() when
 194 B<*px> is valid is broken and some parts of the reused structure may
 195 persist if they are not present in the new one. As a result the use
 196 of this "reuse" behaviour is strongly discouraged.
 197
 198 i2d_X509() will not return an error in many versions of OpenSSL,
 199 if mandatory fields are not initialized due to a programming error
 200 then the encoded structure may contain invalid data or omit the
 201 fields entirely and will not be parsed by d2i_X509(). This may be
 202 fixed in future so code should not assume that i2d_X509() will
 203 always succeed.
 204
 205 =head1 RETURN VALUES
 206
 207 d2i_X509(), d2i_X509_bio() and d2i_X509_fp() return a valid B<X509> structure
 208 or B<NULL> if an error occurs. The error code that can be obtained by
 209 L<ERR_get_error(3)|ERR_get_error(3)>.
 210
 211 i2d_X509(), i2d_X509_bio() and i2d_X509_fp() return a the number of bytes
 212 successfully encoded or a negative value if an error occurs. The error code
 213 can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 214
 215 =head1 SEE ALSO
 216
 217 L<ERR_get_error(3)|ERR_get_error(3)>
 218
 219 =head1 HISTORY
 220
 221 d2i_X509, i2d_X509, d2i_X509_bio, d2i_X509_fp, i2d_X509_bio and i2d_X509_fp
 222 are available in all versions of SSLeay and OpenSSL.
 223
 224 =cut