secure/lib/libcrypto/man/d2i_X509.3

   1 .\" Automatically generated by Pod::Man 4.09 (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 "2018-11-20" "1.1.1a" "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_ACCESS_DESCRIPTION, d2i_ADMISSIONS, d2i_ADMISSION_SYNTAX, d2i_ASIdOrRange, d2i_ASIdentifierChoice, d2i_ASIdentifiers, d2i_ASN1_BIT_STRING, d2i_ASN1_BMPSTRING, d2i_ASN1_ENUMERATED, d2i_ASN1_GENERALIZEDTIME, d2i_ASN1_GENERALSTRING, d2i_ASN1_IA5STRING, d2i_ASN1_INTEGER, d2i_ASN1_NULL, d2i_ASN1_OBJECT, d2i_ASN1_OCTET_STRING, d2i_ASN1_PRINTABLE, d2i_ASN1_PRINTABLESTRING, d2i_ASN1_SEQUENCE_ANY, d2i_ASN1_SET_ANY, d2i_ASN1_T61STRING, d2i_ASN1_TIME, d2i_ASN1_TYPE, d2i_ASN1_UINTEGER, d2i_ASN1_UNIVERSALSTRING, d2i_ASN1_UTCTIME, d2i_ASN1_UTF8STRING, d2i_ASN1_VISIBLESTRING, d2i_ASRange, d2i_AUTHORITY_INFO_ACCESS, d2i_AUTHORITY_KEYID, d2i_BASIC_CONSTRAINTS, d2i_CERTIFICATEPOLICIES, d2i_CMS_ContentInfo, d2i_CMS_ReceiptRequest, d2i_CMS_bio, d2i_CRL_DIST_POINTS, d2i_DHxparams, d2i_DIRECTORYSTRING, d2i_DISPLAYTEXT, d2i_DIST_POINT, d2i_DIST_POINT_NAME, d2i_DSAPrivateKey, d2i_DSAPrivateKey_bio, d2i_DSAPrivateKey_fp, d2i_DSAPublicKey, d2i_DSA_PUBKEY, d2i_DSA_PUBKEY_bio, d2i_DSA_PUBKEY_fp, d2i_DSA_SIG, d2i_DSAparams, d2i_ECPKParameters, d2i_ECParameters, d2i_ECPrivateKey, d2i_ECPrivateKey_bio, d2i_ECPrivateKey_fp, d2i_EC_PUBKEY, d2i_EC_PUBKEY_bio, d2i_EC_PUBKEY_fp, d2i_EDIPARTYNAME, d2i_ESS_CERT_ID, d2i_ESS_ISSUER_SERIAL, d2i_ESS_SIGNING_CERT, d2i_EXTENDED_KEY_USAGE, d2i_GENERAL_NAME, d2i_GENERAL_NAMES, d2i_IPAddressChoice, d2i_IPAddressFamily, d2i_IPAddressOrRange, d2i_IPAddressRange, d2i_ISSUING_DIST_POINT, d2i_NAMING_AUTHORITY, d2i_NETSCAPE_CERT_SEQUENCE, d2i_NETSCAPE_SPKAC, d2i_NETSCAPE_SPKI, d2i_NOTICEREF, d2i_OCSP_BASICRESP, d2i_OCSP_CERTID, d2i_OCSP_CERTSTATUS, d2i_OCSP_CRLID, d2i_OCSP_ONEREQ, d2i_OCSP_REQINFO, d2i_OCSP_REQUEST, d2i_OCSP_RESPBYTES, d2i_OCSP_RESPDATA, d2i_OCSP_RESPID, d2i_OCSP_RESPONSE, d2i_OCSP_REVOKEDINFO, d2i_OCSP_SERVICELOC, d2i_OCSP_SIGNATURE, d2i_OCSP_SINGLERESP, d2i_OTHERNAME, d2i_PBE2PARAM, d2i_PBEPARAM, d2i_PBKDF2PARAM, d2i_PKCS12, d2i_PKCS12_BAGS, d2i_PKCS12_MAC_DATA, d2i_PKCS12_SAFEBAG, d2i_PKCS12_bio, d2i_PKCS12_fp, d2i_PKCS7, d2i_PKCS7_DIGEST, d2i_PKCS7_ENCRYPT, d2i_PKCS7_ENC_CONTENT, d2i_PKCS7_ENVELOPE, d2i_PKCS7_ISSUER_AND_SERIAL, d2i_PKCS7_RECIP_INFO, d2i_PKCS7_SIGNED, d2i_PKCS7_SIGNER_INFO, d2i_PKCS7_SIGN_ENVELOPE, d2i_PKCS7_bio, d2i_PKCS7_fp, d2i_PKCS8_PRIV_KEY_INFO, d2i_PKCS8_PRIV_KEY_INFO_bio, d2i_PKCS8_PRIV_KEY_INFO_fp, d2i_PKCS8_bio, d2i_PKCS8_fp, d2i_PKEY_USAGE_PERIOD, d2i_POLICYINFO, d2i_POLICYQUALINFO, d2i_PROFESSION_INFO, d2i_PROXY_CERT_INFO_EXTENSION, d2i_PROXY_POLICY, d2i_RSAPrivateKey, d2i_RSAPrivateKey_bio, d2i_RSAPrivateKey_fp, d2i_RSAPublicKey, d2i_RSAPublicKey_bio, d2i_RSAPublicKey_fp, d2i_RSA_OAEP_PARAMS, d2i_RSA_PSS_PARAMS, d2i_RSA_PUBKEY, d2i_RSA_PUBKEY_bio, d2i_RSA_PUBKEY_fp, d2i_SCRYPT_PARAMS, d2i_SCT_LIST, d2i_SXNET, d2i_SXNETID, d2i_TS_ACCURACY, d2i_TS_MSG_IMPRINT, d2i_TS_MSG_IMPRINT_bio, d2i_TS_MSG_IMPRINT_fp, d2i_TS_REQ, d2i_TS_REQ_bio, d2i_TS_REQ_fp, d2i_TS_RESP, d2i_TS_RESP_bio, d2i_TS_RESP_fp, d2i_TS_STATUS_INFO, d2i_TS_TST_INFO, d2i_TS_TST_INFO_bio, d2i_TS_TST_INFO_fp, d2i_USERNOTICE, d2i_X509, d2i_X509_ALGOR, d2i_X509_ALGORS, d2i_X509_ATTRIBUTE, d2i_X509_CERT_AUX, d2i_X509_CINF, d2i_X509_CRL, d2i_X509_CRL_INFO, d2i_X509_CRL_bio, d2i_X509_CRL_fp, d2i_X509_EXTENSION, d2i_X509_EXTENSIONS, d2i_X509_NAME, d2i_X509_NAME_ENTRY, d2i_X509_PUBKEY, d2i_X509_REQ, d2i_X509_REQ_INFO, d2i_X509_REQ_bio, d2i_X509_REQ_fp, d2i_X509_REVOKED, d2i_X509_SIG, d2i_X509_VAL, i2d_ACCESS_DESCRIPTION, i2d_ADMISSIONS, i2d_ADMISSION_SYNTAX, i2d_ASIdOrRange, i2d_ASIdentifierChoice, i2d_ASIdentifiers, i2d_ASN1_BIT_STRING, i2d_ASN1_BMPSTRING, i2d_ASN1_ENUMERATED, i2d_ASN1_GENERALIZEDTIME, i2d_ASN1_GENERALSTRING, i2d_ASN1_IA5STRING, i2d_ASN1_INTEGER, i2d_ASN1_NULL, i2d_ASN1_OBJECT, i2d_ASN1_OCTET_STRING, i2d_ASN1_PRINTABLE, i2d_ASN1_PRINTABLESTRING, i2d_ASN1_SEQUENCE_ANY, i2d_ASN1_SET_ANY, i2d_ASN1_T61STRING, i2d_ASN1_TIME, i2d_ASN1_TYPE, i2d_ASN1_UNIVERSALSTRING, i2d_ASN1_UTCTIME, i2d_ASN1_UTF8STRING, i2d_ASN1_VISIBLESTRING, i2d_ASN1_bio_stream, i2d_ASRange, i2d_AUTHORITY_INFO_ACCESS, i2d_AUTHORITY_KEYID, i2d_BASIC_CONSTRAINTS, i2d_CERTIFICATEPOLICIES, i2d_CMS_ContentInfo, i2d_CMS_ReceiptRequest, i2d_CMS_bio, i2d_CRL_DIST_POINTS, i2d_DHxparams, i2d_DIRECTORYSTRING, i2d_DISPLAYTEXT, i2d_DIST_POINT, i2d_DIST_POINT_NAME, i2d_DSAPrivateKey, i2d_DSAPrivateKey_bio, i2d_DSAPrivateKey_fp, i2d_DSAPublicKey, i2d_DSA_PUBKEY, i2d_DSA_PUBKEY_bio, i2d_DSA_PUBKEY_fp, i2d_DSA_SIG, i2d_DSAparams, i2d_ECPKParameters, i2d_ECParameters, i2d_ECPrivateKey, i2d_ECPrivateKey_bio, i2d_ECPrivateKey_fp, i2d_EC_PUBKEY, i2d_EC_PUBKEY_bio, i2d_EC_PUBKEY_fp, i2d_EDIPARTYNAME, i2d_ESS_CERT_ID, i2d_ESS_ISSUER_SERIAL, i2d_ESS_SIGNING_CERT, i2d_EXTENDED_KEY_USAGE, i2d_GENERAL_NAME, i2d_GENERAL_NAMES, i2d_IPAddressChoice, i2d_IPAddressFamily, i2d_IPAddressOrRange, i2d_IPAddressRange, i2d_ISSUING_DIST_POINT, i2d_NAMING_AUTHORITY, i2d_NETSCAPE_CERT_SEQUENCE, i2d_NETSCAPE_SPKAC, i2d_NETSCAPE_SPKI, i2d_NOTICEREF, i2d_OCSP_BASICRESP, i2d_OCSP_CERTID, i2d_OCSP_CERTSTATUS, i2d_OCSP_CRLID, i2d_OCSP_ONEREQ, i2d_OCSP_REQINFO, i2d_OCSP_REQUEST, i2d_OCSP_RESPBYTES, i2d_OCSP_RESPDATA, i2d_OCSP_RESPID, i2d_OCSP_RESPONSE, i2d_OCSP_REVOKEDINFO, i2d_OCSP_SERVICELOC, i2d_OCSP_SIGNATURE, i2d_OCSP_SINGLERESP, i2d_OTHERNAME, i2d_PBE2PARAM, i2d_PBEPARAM, i2d_PBKDF2PARAM, i2d_PKCS12, i2d_PKCS12_BAGS, i2d_PKCS12_MAC_DATA, i2d_PKCS12_SAFEBAG, i2d_PKCS12_bio, i2d_PKCS12_fp, i2d_PKCS7, i2d_PKCS7_DIGEST, i2d_PKCS7_ENCRYPT, i2d_PKCS7_ENC_CONTENT, i2d_PKCS7_ENVELOPE, i2d_PKCS7_ISSUER_AND_SERIAL, i2d_PKCS7_NDEF, i2d_PKCS7_RECIP_INFO, i2d_PKCS7_SIGNED, i2d_PKCS7_SIGNER_INFO, i2d_PKCS7_SIGN_ENVELOPE, i2d_PKCS7_bio, i2d_PKCS7_fp, i2d_PKCS8PrivateKeyInfo_bio, i2d_PKCS8PrivateKeyInfo_fp, i2d_PKCS8_PRIV_KEY_INFO, i2d_PKCS8_PRIV_KEY_INFO_bio, i2d_PKCS8_PRIV_KEY_INFO_fp, i2d_PKCS8_bio, i2d_PKCS8_fp, i2d_PKEY_USAGE_PERIOD, i2d_POLICYINFO, i2d_POLICYQUALINFO, i2d_PROFESSION_INFO, i2d_PROXY_CERT_INFO_EXTENSION, i2d_PROXY_POLICY, i2d_PublicKey, i2d_RSAPrivateKey, i2d_RSAPrivateKey_bio, i2d_RSAPrivateKey_fp, i2d_RSAPublicKey, i2d_RSAPublicKey_bio, i2d_RSAPublicKey_fp, i2d_RSA_OAEP_PARAMS, i2d_RSA_PSS_PARAMS, i2d_RSA_PUBKEY, i2d_RSA_PUBKEY_bio, i2d_RSA_PUBKEY_fp, i2d_SCRYPT_PARAMS, i2d_SCT_LIST, i2d_SXNET, i2d_SXNETID, i2d_TS_ACCURACY, i2d_TS_MSG_IMPRINT, i2d_TS_MSG_IMPRINT_bio, i2d_TS_MSG_IMPRINT_fp, i2d_TS_REQ, i2d_TS_REQ_bio, i2d_TS_REQ_fp, i2d_TS_RESP, i2d_TS_RESP_bio, i2d_TS_RESP_fp, i2d_TS_STATUS_INFO, i2d_TS_TST_INFO, i2d_TS_TST_INFO_bio, i2d_TS_TST_INFO_fp, i2d_USERNOTICE, i2d_X509, i2d_X509_ALGOR, i2d_X509_ALGORS, i2d_X509_ATTRIBUTE, i2d_X509_CERT_AUX, i2d_X509_CINF, i2d_X509_CRL, i2d_X509_CRL_INFO, i2d_X509_CRL_bio, i2d_X509_CRL_fp, i2d_X509_EXTENSION, i2d_X509_EXTENSIONS, i2d_X509_NAME, i2d_X509_NAME_ENTRY, i2d_X509_PUBKEY, i2d_X509_REQ, i2d_X509_REQ_INFO, i2d_X509_REQ_bio, i2d_X509_REQ_fp, i2d_X509_REVOKED, i2d_X509_SIG, i2d_X509_VAL, \&\- convert objects from/to ASN.1/DER representation
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 3
 142 \& TYPE *d2i_TYPE(TYPE **a, unsigned char **ppin, long length);
 143 \& TYPE *d2i_TYPE_bio(BIO *bp, TYPE **a);
 144 \& TYPE *d2i_TYPE_fp(FILE *fp, TYPE **a);
 145 \&
 146 \& int i2d_TYPE(TYPE *a, unsigned char **ppout);
 147 \& int i2d_TYPE_fp(FILE *fp, TYPE *a);
 148 \& int i2d_TYPE_bio(BIO *bp, TYPE *a);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 In the description here, \fI\s-1TYPE\s0\fR is used a placeholder
 153 for any of the OpenSSL datatypes, such as \fIX509_CRL\fR.
 154 The function parameters \fIppin\fR and \fIppout\fR are generally
 155 either both named \fIpp\fR in the headers, or \fIin\fR and \fIout\fR.
 156 .PP
 157 These functions convert OpenSSL objects to and from their \s-1ASN.1/DER\s0
 158 encoding.  Unlike the C structures which can have pointers to sub-objects
 159 within, the \s-1DER\s0 is a serialized encoding, suitable for sending over the
 160 network, writing to a file, and so on.
 161 .PP
 162 \&\fId2i_TYPE()\fR attempts to decode \fBlen\fR bytes at \fB*ppin\fR. If successful a
 163 pointer to the \fB\s-1TYPE\s0\fR structure is returned and \fB*ppin\fR is incremented to
 164 the byte following the parsed data.  If \fBa\fR is not \fB\s-1NULL\s0\fR then a pointer
 165 to the returned structure is also written to \fB*a\fR.  If an error occurred
 166 then \fB\s-1NULL\s0\fR is returned.
 167 .PP
 168 On a successful return, if \fB*a\fR is not \fB\s-1NULL\s0\fR then it is assumed that \fB*a\fR
 169 contains a valid \fB\s-1TYPE\s0\fR structure and an attempt is made to reuse it. This
 170 \&\*(L"reuse\*(R" capability is present for historical compatibility but its use is
 171 \&\fBstrongly discouraged\fR (see \s-1BUGS\s0 below, and the discussion in the \s-1RETURN
 172 VALUES\s0 section).
 173 .PP
 174 \&\fId2i_TYPE_bio()\fR is similar to \fId2i_TYPE()\fR except it attempts
 175 to parse data from \s-1BIO\s0 \fBbp\fR.
 176 .PP
 177 \&\fId2i_TYPE_fp()\fR is similar to \fId2i_TYPE()\fR except it attempts
 178 to parse data from \s-1FILE\s0 pointer \fBfp\fR.
 179 .PP
 180 \&\fIi2d_TYPE()\fR encodes the structure pointed to by \fBa\fR into \s-1DER\s0 format.
 181 If \fBppout\fR is not \fB\s-1NULL\s0\fR, it writes the \s-1DER\s0 encoded data to the buffer
 182 at \fB*ppout\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 If \fB*ppout\fR is \fB\s-1NULL\s0\fR memory will be allocated for a buffer and the encoded
 187 data written to it. In this case \fB*ppout\fR is not incremented and it points
 188 to the start of the data just written.
 189 .PP
 190 \&\fIi2d_TYPE_bio()\fR is similar to \fIi2d_TYPE()\fR except it writes
 191 the encoding of the structure \fBa\fR to \s-1BIO\s0 \fBbp\fR and it
 192 returns 1 for success and 0 for failure.
 193 .PP
 194 \&\fIi2d_TYPE_fp()\fR is similar to \fIi2d_TYPE()\fR except it writes
 195 the encoding of the structure \fBa\fR to \s-1BIO\s0 \fBbp\fR and it
 196 returns 1 for success and 0 for failure.
 197 .PP
 198 These routines do not encrypt private keys and therefore offer no
 199 security; use \fIPEM_write_PrivateKey\fR\|(3) or similar for writing to files.
 200 .SH "NOTES"
 201 .IX Header "NOTES"
 202 The letters \fBi\fR and \fBd\fR in \fBi2d_TYPE\fR stand for
 203 \&\*(L"internal\*(R" (that is, an internal C structure) and \*(L"\s-1DER\*(R"\s0 respectively.
 204 So \fBi2d_TYPE\fR converts from internal to \s-1DER.\s0
 205 .PP
 206 The functions can also understand \fB\s-1BER\s0\fR forms.
 207 .PP
 208 The actual \s-1TYPE\s0 structure passed to \fIi2d_TYPE()\fR must be a valid
 209 populated \fB\s-1TYPE\s0\fR structure \*(-- it \fBcannot\fR simply be fed with an
 210 empty structure such as that returned by \fITYPE_new()\fR.
 211 .PP
 212 The encoded data is in binary form and may contain embedded zeroes.
 213 Therefore any \s-1FILE\s0 pointers or BIOs should be opened in binary mode.
 214 Functions such as \fIstrlen()\fR will \fBnot\fR return the correct length
 215 of the encoded structure.
 216 .PP
 217 The ways that \fB*ppin\fR and \fB*ppout\fR are incremented after the operation
 218 can trap the unwary. See the \fB\s-1WARNINGS\s0\fR section for some common
 219 errors.
 220 The reason for this-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 be processed after it.
 223 .PP
 224 The following points about the data types might be useful:
 225 .IP "\fB\s-1ASN1_OBJECT\s0\fR" 4
 226 .IX Item "ASN1_OBJECT"
 227 Represents an \s-1ASN1 OBJECT IDENTIFIER.\s0
 228 .IP "\fBDHparams\fR" 4
 229 .IX Item "DHparams"
 230 Represents a PKCS#3 \s-1DH\s0 parameters structure.
 231 .IP "\fBDHparamx\fR" 4
 232 .IX Item "DHparamx"
 233 Represents an \s-1ANSI X9.42 DH\s0 parameters structure.
 234 .IP "\fB\s-1DSA_PUBKEY\s0\fR" 4
 235 .IX Item "DSA_PUBKEY"
 236 Represents a \s-1DSA\s0 public key using a \fBSubjectPublicKeyInfo\fR structure.
 237 .IP "\fBDSAPublicKey, DSAPrivateKey\fR" 4
 238 .IX Item "DSAPublicKey, DSAPrivateKey"
 239 Use a non-standard OpenSSL format and should be avoided; use \fB\s-1DSA_PUBKEY\s0\fR,
 240 \&\fB\f(BIPEM_write_PrivateKey\fB\|(3)\fR, or similar instead.
 241 .IP "\fBRSAPublicKey\fR" 4
 242 .IX Item "RSAPublicKey"
 243 Represents a PKCS#1 \s-1RSA\s0 public key structure.
 244 .IP "\fBX509_ALGOR\fR" 4
 245 .IX Item "X509_ALGOR"
 246 Represents an \fBAlgorithmIdentifier\fR structure as used in \s-1IETF RFC 6960\s0 and
 247 elsewhere.
 248 .IP "\fBX509_Name\fR" 4
 249 .IX Item "X509_Name"
 250 Represents a \fBName\fR type as used for subject and issuer names in
 251 \&\s-1IETF RFC 6960\s0 and elsewhere.
 252 .IP "\fBX509_REQ\fR" 4
 253 .IX Item "X509_REQ"
 254 Represents a PKCS#10 certificate request.
 255 .IP "\fBX509_SIG\fR" 4
 256 .IX Item "X509_SIG"
 257 Represents the \fBDigestInfo\fR structure defined in PKCS#1 and PKCS#7.
 258 .SH "EXAMPLES"
 259 .IX Header "EXAMPLES"
 260 Allocate and encode the \s-1DER\s0 encoding of an X509 structure:
 261 .PP
 262 .Vb 2
 263 \& int len;
 264 \& unsigned char *buf;
 265 \&
 266 \& buf = NULL;
 267 \& len = i2d_X509(x, &buf);
 268 \& if (len < 0)
 269 \&     /* error */
 270 .Ve
 271 .PP
 272 Attempt to decode a buffer:
 273 .PP
 274 .Vb 3
 275 \& X509 *x;
 276 \& unsigned char *buf, *p;
 277 \& int len;
 278 \&
 279 \& /* Set up buf and len to point to the input buffer. */
 280 \& p = buf;
 281 \& x = d2i_X509(NULL, &p, len);
 282 \& if (x == NULL)
 283 \&     /* error */
 284 .Ve
 285 .PP
 286 Alternative technique:
 287 .PP
 288 .Vb 3
 289 \& X509 *x;
 290 \& unsigned char *buf, *p;
 291 \& int len;
 292 \&
 293 \& /* Set up buf and len to point to the input buffer. */
 294 \& p = buf;
 295 \& x = NULL;
 296 \&
 297 \& if (d2i_X509(&x, &p, len) == NULL)
 298 \&     /* error */
 299 .Ve
 300 .SH "WARNINGS"
 301 .IX Header "WARNINGS"
 302 Using a temporary variable is mandatory. A common
 303 mistake is to attempt to use a buffer directly as follows:
 304 .PP
 305 .Vb 2
 306 \& int len;
 307 \& unsigned char *buf;
 308 \&
 309 \& len = i2d_X509(x, NULL);
 310 \& buf = OPENSSL_malloc(len);
 311 \& ...
 312 \& i2d_X509(x, &buf);
 313 \& ...
 314 \& OPENSSL_free(buf);
 315 .Ve
 316 .PP
 317 This code will result in \fBbuf\fR apparently containing garbage because
 318 it was incremented after the call to point after the data just written.
 319 Also \fBbuf\fR will no longer contain the pointer allocated by \fIOPENSSL_malloc()\fR
 320 and the subsequent call to \fIOPENSSL_free()\fR is likely to crash.
 321 .PP
 322 Another trap to avoid is misuse of the \fBa\fR argument to \fId2i_TYPE()\fR:
 323 .PP
 324 .Vb 1
 325 \& X509 *x;
 326 \&
 327 \& if (d2i_X509(&x, &p, len) == NULL)
 328 \&     /* error */
 329 .Ve
 330 .PP
 331 This will probably crash somewhere in \fId2i_X509()\fR. The reason for this
 332 is that the variable \fBx\fR is uninitialized and an attempt will be made to
 333 interpret its (invalid) value as an \fBX509\fR structure, typically causing
 334 a segmentation violation. If \fBx\fR is set to \s-1NULL\s0 first then this will not
 335 happen.
 336 .SH "BUGS"
 337 .IX Header "BUGS"
 338 In some versions of OpenSSL the \*(L"reuse\*(R" behaviour of \fId2i_TYPE()\fR when
 339 \&\fB*px\fR is valid is broken and some parts of the reused structure may
 340 persist if they are not present in the new one. As a result the use
 341 of this \*(L"reuse\*(R" behaviour is strongly discouraged.
 342 .PP
 343 \&\fIi2d_TYPE()\fR will not return an error in many versions of OpenSSL,
 344 if mandatory fields are not initialized due to a programming error
 345 then the encoded structure may contain invalid data or omit the
 346 fields entirely and will not be parsed by \fId2i_TYPE()\fR. This may be
 347 fixed in future so code should not assume that \fIi2d_TYPE()\fR will
 348 always succeed.
 349 .PP
 350 Any function which encodes a structure (\fIi2d_TYPE()\fR,
 351 \&\fIi2d_TYPE()\fR or \fIi2d_TYPE()\fR) may return a stale encoding if the
 352 structure has been modified after deserialization or previous
 353 serialization. This is because some objects cache the encoding for
 354 efficiency reasons.
 355 .SH "RETURN VALUES"
 356 .IX Header "RETURN VALUES"
 357 \&\fId2i_TYPE()\fR, \fId2i_TYPE_bio()\fR and \fId2i_TYPE_fp()\fR return a valid \fB\s-1TYPE\s0\fR structure
 358 or \fB\s-1NULL\s0\fR if an error occurs.  If the \*(L"reuse\*(R" capability has been used with
 359 a valid structure being passed in via \fBa\fR, then the object is not freed in
 360 the event of error but may be in a potentially invalid or inconsistent state.
 361 .PP
 362 \&\fIi2d_TYPE()\fR returns the number of bytes successfully encoded or a negative
 363 value if an error occurs.
 364 .PP
 365 \&\fIi2d_TYPE_bio()\fR and \fIi2d_TYPE_fp()\fR return 1 for success and 0 if an error
 366 occurs.
 367 .SH "COPYRIGHT"
 368 .IX Header "COPYRIGHT"
 369 Copyright 1998\-2018 The OpenSSL Project Authors. All Rights Reserved.
 370 .PP
 371 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 372 this file except in compliance with the License.  You can obtain a copy
 373 in the file \s-1LICENSE\s0 in the source distribution or at
 374 <https://www.openssl.org/source/license.html>.