d2i_X509.pod 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657
  1. =pod
  2. =head1 NAME
  3. d2i_ACCESS_DESCRIPTION,
  4. d2i_ADMISSIONS,
  5. d2i_ADMISSION_SYNTAX,
  6. d2i_ASIdOrRange,
  7. d2i_ASIdentifierChoice,
  8. d2i_ASIdentifiers,
  9. d2i_ASN1_BIT_STRING,
  10. d2i_ASN1_BMPSTRING,
  11. d2i_ASN1_ENUMERATED,
  12. d2i_ASN1_GENERALIZEDTIME,
  13. d2i_ASN1_GENERALSTRING,
  14. d2i_ASN1_IA5STRING,
  15. d2i_ASN1_INTEGER,
  16. d2i_ASN1_NULL,
  17. d2i_ASN1_OBJECT,
  18. d2i_ASN1_OCTET_STRING,
  19. d2i_ASN1_PRINTABLE,
  20. d2i_ASN1_PRINTABLESTRING,
  21. d2i_ASN1_SEQUENCE_ANY,
  22. d2i_ASN1_SET_ANY,
  23. d2i_ASN1_T61STRING,
  24. d2i_ASN1_TIME,
  25. d2i_ASN1_TYPE,
  26. d2i_ASN1_UINTEGER,
  27. d2i_ASN1_UNIVERSALSTRING,
  28. d2i_ASN1_UTCTIME,
  29. d2i_ASN1_UTF8STRING,
  30. d2i_ASN1_VISIBLESTRING,
  31. d2i_ASRange,
  32. d2i_AUTHORITY_INFO_ACCESS,
  33. d2i_AUTHORITY_KEYID,
  34. d2i_BASIC_CONSTRAINTS,
  35. d2i_CERTIFICATEPOLICIES,
  36. d2i_CMS_ContentInfo,
  37. d2i_CMS_ReceiptRequest,
  38. d2i_CMS_bio,
  39. d2i_CRL_DIST_POINTS,
  40. d2i_DHxparams,
  41. d2i_DIRECTORYSTRING,
  42. d2i_DISPLAYTEXT,
  43. d2i_DIST_POINT,
  44. d2i_DIST_POINT_NAME,
  45. d2i_DSAPrivateKey,
  46. d2i_DSAPrivateKey_bio,
  47. d2i_DSAPrivateKey_fp,
  48. d2i_DSAPublicKey,
  49. d2i_DSA_PUBKEY,
  50. d2i_DSA_PUBKEY_bio,
  51. d2i_DSA_PUBKEY_fp,
  52. d2i_DSA_SIG,
  53. d2i_DSAparams,
  54. d2i_ECDSA_SIG,
  55. d2i_ECPKParameters,
  56. d2i_ECParameters,
  57. d2i_ECPrivateKey,
  58. d2i_ECPrivateKey_bio,
  59. d2i_ECPrivateKey_fp,
  60. d2i_EC_PUBKEY,
  61. d2i_EC_PUBKEY_bio,
  62. d2i_EC_PUBKEY_fp,
  63. d2i_EDIPARTYNAME,
  64. d2i_ESS_CERT_ID,
  65. d2i_ESS_CERT_ID_V2,
  66. d2i_ESS_ISSUER_SERIAL,
  67. d2i_ESS_SIGNING_CERT,
  68. d2i_ESS_SIGNING_CERT_V2,
  69. d2i_EXTENDED_KEY_USAGE,
  70. d2i_GENERAL_NAME,
  71. d2i_GENERAL_NAMES,
  72. d2i_IPAddressChoice,
  73. d2i_IPAddressFamily,
  74. d2i_IPAddressOrRange,
  75. d2i_IPAddressRange,
  76. d2i_ISSUER_SIGN_TOOL,
  77. d2i_ISSUING_DIST_POINT,
  78. d2i_NAMING_AUTHORITY,
  79. d2i_NETSCAPE_CERT_SEQUENCE,
  80. d2i_NETSCAPE_SPKAC,
  81. d2i_NETSCAPE_SPKI,
  82. d2i_NOTICEREF,
  83. d2i_OCSP_BASICRESP,
  84. d2i_OCSP_CERTID,
  85. d2i_OCSP_CERTSTATUS,
  86. d2i_OCSP_CRLID,
  87. d2i_OCSP_ONEREQ,
  88. d2i_OCSP_REQINFO,
  89. d2i_OCSP_REQUEST,
  90. d2i_OCSP_RESPBYTES,
  91. d2i_OCSP_RESPDATA,
  92. d2i_OCSP_RESPID,
  93. d2i_OCSP_RESPONSE,
  94. d2i_OCSP_REVOKEDINFO,
  95. d2i_OCSP_SERVICELOC,
  96. d2i_OCSP_SIGNATURE,
  97. d2i_OCSP_SINGLERESP,
  98. d2i_OSSL_CMP_MSG,
  99. d2i_OSSL_CMP_PKIHEADER,
  100. d2i_OSSL_CMP_PKISI,
  101. d2i_OSSL_CRMF_CERTID,
  102. d2i_OSSL_CRMF_CERTTEMPLATE,
  103. d2i_OSSL_CRMF_ENCRYPTEDVALUE,
  104. d2i_OSSL_CRMF_MSG,
  105. d2i_OSSL_CRMF_MSGS,
  106. d2i_OSSL_CRMF_PBMPARAMETER,
  107. d2i_OSSL_CRMF_PKIPUBLICATIONINFO,
  108. d2i_OSSL_CRMF_SINGLEPUBINFO,
  109. d2i_OTHERNAME,
  110. d2i_PBE2PARAM,
  111. d2i_PBEPARAM,
  112. d2i_PBKDF2PARAM,
  113. d2i_PKCS12,
  114. d2i_PKCS12_BAGS,
  115. d2i_PKCS12_MAC_DATA,
  116. d2i_PKCS12_SAFEBAG,
  117. d2i_PKCS12_bio,
  118. d2i_PKCS12_fp,
  119. d2i_PKCS7,
  120. d2i_PKCS7_DIGEST,
  121. d2i_PKCS7_ENCRYPT,
  122. d2i_PKCS7_ENC_CONTENT,
  123. d2i_PKCS7_ENVELOPE,
  124. d2i_PKCS7_ISSUER_AND_SERIAL,
  125. d2i_PKCS7_RECIP_INFO,
  126. d2i_PKCS7_SIGNED,
  127. d2i_PKCS7_SIGNER_INFO,
  128. d2i_PKCS7_SIGN_ENVELOPE,
  129. d2i_PKCS7_bio,
  130. d2i_PKCS7_fp,
  131. d2i_PKCS8_PRIV_KEY_INFO,
  132. d2i_PKCS8_PRIV_KEY_INFO_bio,
  133. d2i_PKCS8_PRIV_KEY_INFO_fp,
  134. d2i_PKCS8_bio,
  135. d2i_PKCS8_fp,
  136. d2i_PKEY_USAGE_PERIOD,
  137. d2i_POLICYINFO,
  138. d2i_POLICYQUALINFO,
  139. d2i_PROFESSION_INFO,
  140. d2i_PROXY_CERT_INFO_EXTENSION,
  141. d2i_PROXY_POLICY,
  142. d2i_RSAPrivateKey,
  143. d2i_RSAPrivateKey_bio,
  144. d2i_RSAPrivateKey_fp,
  145. d2i_RSAPublicKey,
  146. d2i_RSAPublicKey_bio,
  147. d2i_RSAPublicKey_fp,
  148. d2i_RSA_OAEP_PARAMS,
  149. d2i_RSA_PSS_PARAMS,
  150. d2i_RSA_PUBKEY,
  151. d2i_RSA_PUBKEY_bio,
  152. d2i_RSA_PUBKEY_fp,
  153. d2i_SCRYPT_PARAMS,
  154. d2i_SCT_LIST,
  155. d2i_SXNET,
  156. d2i_SXNETID,
  157. d2i_TS_ACCURACY,
  158. d2i_TS_MSG_IMPRINT,
  159. d2i_TS_MSG_IMPRINT_bio,
  160. d2i_TS_MSG_IMPRINT_fp,
  161. d2i_TS_REQ,
  162. d2i_TS_REQ_bio,
  163. d2i_TS_REQ_fp,
  164. d2i_TS_RESP,
  165. d2i_TS_RESP_bio,
  166. d2i_TS_RESP_fp,
  167. d2i_TS_STATUS_INFO,
  168. d2i_TS_TST_INFO,
  169. d2i_TS_TST_INFO_bio,
  170. d2i_TS_TST_INFO_fp,
  171. d2i_USERNOTICE,
  172. d2i_X509,
  173. d2i_X509_ALGOR,
  174. d2i_X509_ALGORS,
  175. d2i_X509_ATTRIBUTE,
  176. d2i_X509_CERT_AUX,
  177. d2i_X509_CINF,
  178. d2i_X509_CRL,
  179. d2i_X509_CRL_INFO,
  180. d2i_X509_CRL_bio,
  181. d2i_X509_CRL_fp,
  182. d2i_X509_EXTENSION,
  183. d2i_X509_EXTENSIONS,
  184. d2i_X509_NAME,
  185. d2i_X509_NAME_ENTRY,
  186. d2i_X509_PUBKEY,
  187. d2i_X509_PUBKEY_bio,
  188. d2i_X509_PUBKEY_fp,
  189. d2i_X509_REQ,
  190. d2i_X509_REQ_INFO,
  191. d2i_X509_REQ_bio,
  192. d2i_X509_REQ_fp,
  193. d2i_X509_REVOKED,
  194. d2i_X509_SIG,
  195. d2i_X509_VAL,
  196. i2d_ACCESS_DESCRIPTION,
  197. i2d_ADMISSIONS,
  198. i2d_ADMISSION_SYNTAX,
  199. i2d_ASIdOrRange,
  200. i2d_ASIdentifierChoice,
  201. i2d_ASIdentifiers,
  202. i2d_ASN1_BIT_STRING,
  203. i2d_ASN1_BMPSTRING,
  204. i2d_ASN1_ENUMERATED,
  205. i2d_ASN1_GENERALIZEDTIME,
  206. i2d_ASN1_GENERALSTRING,
  207. i2d_ASN1_IA5STRING,
  208. i2d_ASN1_INTEGER,
  209. i2d_ASN1_NULL,
  210. i2d_ASN1_OBJECT,
  211. i2d_ASN1_OCTET_STRING,
  212. i2d_ASN1_PRINTABLE,
  213. i2d_ASN1_PRINTABLESTRING,
  214. i2d_ASN1_SEQUENCE_ANY,
  215. i2d_ASN1_SET_ANY,
  216. i2d_ASN1_T61STRING,
  217. i2d_ASN1_TIME,
  218. i2d_ASN1_TYPE,
  219. i2d_ASN1_UNIVERSALSTRING,
  220. i2d_ASN1_UTCTIME,
  221. i2d_ASN1_UTF8STRING,
  222. i2d_ASN1_VISIBLESTRING,
  223. i2d_ASN1_bio_stream,
  224. i2d_ASRange,
  225. i2d_AUTHORITY_INFO_ACCESS,
  226. i2d_AUTHORITY_KEYID,
  227. i2d_BASIC_CONSTRAINTS,
  228. i2d_CERTIFICATEPOLICIES,
  229. i2d_CMS_ContentInfo,
  230. i2d_CMS_ReceiptRequest,
  231. i2d_CMS_bio,
  232. i2d_CRL_DIST_POINTS,
  233. i2d_DHxparams,
  234. i2d_DIRECTORYSTRING,
  235. i2d_DISPLAYTEXT,
  236. i2d_DIST_POINT,
  237. i2d_DIST_POINT_NAME,
  238. i2d_DSAPrivateKey,
  239. i2d_DSAPrivateKey_bio,
  240. i2d_DSAPrivateKey_fp,
  241. i2d_DSAPublicKey,
  242. i2d_DSA_PUBKEY,
  243. i2d_DSA_PUBKEY_bio,
  244. i2d_DSA_PUBKEY_fp,
  245. i2d_DSA_SIG,
  246. i2d_DSAparams,
  247. i2d_ECDSA_SIG,
  248. i2d_ECPKParameters,
  249. i2d_ECParameters,
  250. i2d_ECPrivateKey,
  251. i2d_ECPrivateKey_bio,
  252. i2d_ECPrivateKey_fp,
  253. i2d_EC_PUBKEY,
  254. i2d_EC_PUBKEY_bio,
  255. i2d_EC_PUBKEY_fp,
  256. i2d_EDIPARTYNAME,
  257. i2d_ESS_CERT_ID,
  258. i2d_ESS_CERT_ID_V2,
  259. i2d_ESS_ISSUER_SERIAL,
  260. i2d_ESS_SIGNING_CERT,
  261. i2d_ESS_SIGNING_CERT_V2,
  262. i2d_EXTENDED_KEY_USAGE,
  263. i2d_GENERAL_NAME,
  264. i2d_GENERAL_NAMES,
  265. i2d_IPAddressChoice,
  266. i2d_IPAddressFamily,
  267. i2d_IPAddressOrRange,
  268. i2d_IPAddressRange,
  269. i2d_ISSUER_SIGN_TOOL,
  270. i2d_ISSUING_DIST_POINT,
  271. i2d_NAMING_AUTHORITY,
  272. i2d_NETSCAPE_CERT_SEQUENCE,
  273. i2d_NETSCAPE_SPKAC,
  274. i2d_NETSCAPE_SPKI,
  275. i2d_NOTICEREF,
  276. i2d_OCSP_BASICRESP,
  277. i2d_OCSP_CERTID,
  278. i2d_OCSP_CERTSTATUS,
  279. i2d_OCSP_CRLID,
  280. i2d_OCSP_ONEREQ,
  281. i2d_OCSP_REQINFO,
  282. i2d_OCSP_REQUEST,
  283. i2d_OCSP_RESPBYTES,
  284. i2d_OCSP_RESPDATA,
  285. i2d_OCSP_RESPID,
  286. i2d_OCSP_RESPONSE,
  287. i2d_OCSP_REVOKEDINFO,
  288. i2d_OCSP_SERVICELOC,
  289. i2d_OCSP_SIGNATURE,
  290. i2d_OCSP_SINGLERESP,
  291. i2d_OSSL_CMP_MSG,
  292. i2d_OSSL_CMP_PKIHEADER,
  293. i2d_OSSL_CMP_PKISI,
  294. i2d_OSSL_CRMF_CERTID,
  295. i2d_OSSL_CRMF_CERTTEMPLATE,
  296. i2d_OSSL_CRMF_ENCRYPTEDVALUE,
  297. i2d_OSSL_CRMF_MSG,
  298. i2d_OSSL_CRMF_MSGS,
  299. i2d_OSSL_CRMF_PBMPARAMETER,
  300. i2d_OSSL_CRMF_PKIPUBLICATIONINFO,
  301. i2d_OSSL_CRMF_SINGLEPUBINFO,
  302. i2d_OTHERNAME,
  303. i2d_PBE2PARAM,
  304. i2d_PBEPARAM,
  305. i2d_PBKDF2PARAM,
  306. i2d_PKCS12,
  307. i2d_PKCS12_BAGS,
  308. i2d_PKCS12_MAC_DATA,
  309. i2d_PKCS12_SAFEBAG,
  310. i2d_PKCS12_bio,
  311. i2d_PKCS12_fp,
  312. i2d_PKCS7,
  313. i2d_PKCS7_DIGEST,
  314. i2d_PKCS7_ENCRYPT,
  315. i2d_PKCS7_ENC_CONTENT,
  316. i2d_PKCS7_ENVELOPE,
  317. i2d_PKCS7_ISSUER_AND_SERIAL,
  318. i2d_PKCS7_NDEF,
  319. i2d_PKCS7_RECIP_INFO,
  320. i2d_PKCS7_SIGNED,
  321. i2d_PKCS7_SIGNER_INFO,
  322. i2d_PKCS7_SIGN_ENVELOPE,
  323. i2d_PKCS7_bio,
  324. i2d_PKCS7_fp,
  325. i2d_PKCS8PrivateKeyInfo_bio,
  326. i2d_PKCS8PrivateKeyInfo_fp,
  327. i2d_PKCS8_PRIV_KEY_INFO,
  328. i2d_PKCS8_PRIV_KEY_INFO_bio,
  329. i2d_PKCS8_PRIV_KEY_INFO_fp,
  330. i2d_PKCS8_bio,
  331. i2d_PKCS8_fp,
  332. i2d_PKEY_USAGE_PERIOD,
  333. i2d_POLICYINFO,
  334. i2d_POLICYQUALINFO,
  335. i2d_PROFESSION_INFO,
  336. i2d_PROXY_CERT_INFO_EXTENSION,
  337. i2d_PROXY_POLICY,
  338. i2d_RSAPrivateKey,
  339. i2d_RSAPrivateKey_bio,
  340. i2d_RSAPrivateKey_fp,
  341. i2d_RSAPublicKey,
  342. i2d_RSAPublicKey_bio,
  343. i2d_RSAPublicKey_fp,
  344. i2d_RSA_OAEP_PARAMS,
  345. i2d_RSA_PSS_PARAMS,
  346. i2d_RSA_PUBKEY,
  347. i2d_RSA_PUBKEY_bio,
  348. i2d_RSA_PUBKEY_fp,
  349. i2d_SCRYPT_PARAMS,
  350. i2d_SCT_LIST,
  351. i2d_SXNET,
  352. i2d_SXNETID,
  353. i2d_TS_ACCURACY,
  354. i2d_TS_MSG_IMPRINT,
  355. i2d_TS_MSG_IMPRINT_bio,
  356. i2d_TS_MSG_IMPRINT_fp,
  357. i2d_TS_REQ,
  358. i2d_TS_REQ_bio,
  359. i2d_TS_REQ_fp,
  360. i2d_TS_RESP,
  361. i2d_TS_RESP_bio,
  362. i2d_TS_RESP_fp,
  363. i2d_TS_STATUS_INFO,
  364. i2d_TS_TST_INFO,
  365. i2d_TS_TST_INFO_bio,
  366. i2d_TS_TST_INFO_fp,
  367. i2d_USERNOTICE,
  368. i2d_X509,
  369. i2d_X509_ALGOR,
  370. i2d_X509_ALGORS,
  371. i2d_X509_ATTRIBUTE,
  372. i2d_X509_CERT_AUX,
  373. i2d_X509_CINF,
  374. i2d_X509_CRL,
  375. i2d_X509_CRL_INFO,
  376. i2d_X509_CRL_bio,
  377. i2d_X509_CRL_fp,
  378. i2d_X509_EXTENSION,
  379. i2d_X509_EXTENSIONS,
  380. i2d_X509_NAME,
  381. i2d_X509_NAME_ENTRY,
  382. i2d_X509_PUBKEY,
  383. i2d_X509_PUBKEY_bio,
  384. i2d_X509_PUBKEY_fp,
  385. i2d_X509_REQ,
  386. i2d_X509_REQ_INFO,
  387. i2d_X509_REQ_bio,
  388. i2d_X509_REQ_fp,
  389. i2d_X509_REVOKED,
  390. i2d_X509_SIG,
  391. i2d_X509_VAL,
  392. - convert objects from/to ASN.1/DER representation
  393. =head1 SYNOPSIS
  394. =for openssl generic
  395. TYPE *d2i_TYPE(TYPE **a, const unsigned char **ppin, long length);
  396. TYPE *d2i_TYPE_bio(BIO *bp, TYPE **a);
  397. TYPE *d2i_TYPE_fp(FILE *fp, TYPE **a);
  398. int i2d_TYPE(const TYPE *a, unsigned char **ppout);
  399. int i2d_TYPE(TYPE *a, unsigned char **ppout);
  400. int i2d_TYPE_fp(FILE *fp, const TYPE *a);
  401. int i2d_TYPE_fp(FILE *fp, TYPE *a);
  402. int i2d_TYPE_bio(BIO *bp, const TYPE *a);
  403. int i2d_TYPE_bio(BIO *bp, TYPE *a);
  404. =head1 DESCRIPTION
  405. In the description here, B<I<TYPE>> is used a placeholder
  406. for any of the OpenSSL datatypes, such as I<X509_CRL>.
  407. The function parameters I<ppin> and I<ppout> are generally
  408. either both named I<pp> in the headers, or I<in> and I<out>.
  409. These functions convert OpenSSL objects to and from their ASN.1/DER
  410. encoding. Unlike the C structures which can have pointers to sub-objects
  411. within, the DER is a serialized encoding, suitable for sending over the
  412. network, writing to a file, and so on.
  413. B<d2i_I<TYPE>>() attempts to decode I<len> bytes at I<*ppin>. If successful a
  414. pointer to the B<I<TYPE>> structure is returned and I<*ppin> is incremented to
  415. the byte following the parsed data. If I<a> is not NULL then a pointer
  416. to the returned structure is also written to I<*a>. If an error occurred
  417. then NULL is returned.
  418. On a successful return, if I<*a> is not NULL then it is assumed that I<*a>
  419. contains a valid B<I<TYPE>> structure and an attempt is made to reuse it. This
  420. "reuse" capability is present for historical compatibility but its use is
  421. B<strongly discouraged> (see BUGS below, and the discussion in the RETURN
  422. VALUES section).
  423. B<d2i_I<TYPE>_bio>() is similar to B<d2i_I<TYPE>>() except it attempts
  424. to parse data from BIO I<bp>.
  425. B<d2i_I<TYPE>_fp>() is similar to B<d2i_I<TYPE>>() except it attempts
  426. to parse data from FILE pointer I<fp>.
  427. B<i2d_I<TYPE>>() encodes the structure pointed to by I<a> into DER format.
  428. If I<ppout> is not NULL, it writes the DER encoded data to the buffer
  429. at I<*ppout>, and increments it to point after the data just written.
  430. If the return value is negative an error occurred, otherwise it
  431. returns the length of the encoded data.
  432. If I<*ppout> is NULL memory will be allocated for a buffer and the encoded
  433. data written to it. In this case I<*ppout> is not incremented and it points
  434. to the start of the data just written.
  435. B<i2d_I<TYPE>_bio>() is similar to B<i2d_I<TYPE>>() except it writes
  436. the encoding of the structure I<a> to BIO I<bp> and it
  437. returns 1 for success and 0 for failure.
  438. B<i2d_I<TYPE>_fp>() is similar to B<i2d_I<TYPE>>() except it writes
  439. the encoding of the structure I<a> to FILE pointer I<fp> and it
  440. returns 1 for success and 0 for failure.
  441. These routines do not encrypt private keys and therefore offer no
  442. security; use L<PEM_write_PrivateKey(3)> or similar for writing to files.
  443. =head1 NOTES
  444. The letters B<i> and B<d> in B<i2d_I<TYPE>>() stand for
  445. "internal" (that is, an internal C structure) and "DER" respectively.
  446. So B<i2d_I<TYPE>>() converts from internal to DER.
  447. The functions can also understand B<BER> forms.
  448. The actual TYPE structure passed to B<i2d_I<TYPE>>() must be a valid
  449. populated B<I<TYPE>> structure -- it B<cannot> simply be fed with an
  450. empty structure such as that returned by TYPE_new().
  451. The encoded data is in binary form and may contain embedded zeros.
  452. Therefore, any FILE pointers or BIOs should be opened in binary mode.
  453. Functions such as strlen() will B<not> return the correct length
  454. of the encoded structure.
  455. The ways that I<*ppin> and I<*ppout> are incremented after the operation
  456. can trap the unwary. See the B<WARNINGS> section for some common
  457. errors.
  458. The reason for this-auto increment behaviour is to reflect a typical
  459. usage of ASN1 functions: after one structure is encoded or decoded
  460. another will be processed after it.
  461. The following points about the data types might be useful:
  462. =over 4
  463. =item B<ASN1_OBJECT>
  464. Represents an ASN1 OBJECT IDENTIFIER.
  465. =item B<DHparams>
  466. Represents a PKCS#3 DH parameters structure.
  467. =item B<DHxparams>
  468. Represents an ANSI X9.42 DH parameters structure.
  469. =item B<DSA_PUBKEY>
  470. Represents a DSA public key using a B<SubjectPublicKeyInfo> structure.
  471. =item B<DSAPublicKey>, B<DSAPrivateKey>
  472. Use a non-standard OpenSSL format and should be avoided; use B<DSA_PUBKEY>,
  473. L<PEM_write_PrivateKey(3)>, or similar instead.
  474. =item B<ECDSA_SIG>
  475. Represents an ECDSA signature.
  476. =item B<RSAPublicKey>
  477. Represents a PKCS#1 RSA public key structure.
  478. =item B<X509_ALGOR>
  479. Represents an B<AlgorithmIdentifier> structure as used in IETF RFC 6960 and
  480. elsewhere.
  481. =item B<X509_Name>
  482. Represents a B<Name> type as used for subject and issuer names in
  483. IETF RFC 6960 and elsewhere.
  484. =item B<X509_REQ>
  485. Represents a PKCS#10 certificate request.
  486. =item B<X509_SIG>
  487. Represents the B<DigestInfo> structure defined in PKCS#1 and PKCS#7.
  488. =back
  489. =head1 RETURN VALUES
  490. B<d2i_I<TYPE>>(), B<d2i_I<TYPE>_bio>() and B<d2i_I<TYPE>_fp>() return a valid
  491. B<I<TYPE>> structure or NULL if an error occurs. If the "reuse" capability has
  492. been used with a valid structure being passed in via I<a>, then the object is
  493. freed in the event of error and I<*a> is set to NULL.
  494. B<i2d_I<TYPE>>() returns the number of bytes successfully encoded or a negative
  495. value if an error occurs.
  496. B<i2d_I<TYPE>_bio>() and B<i2d_I<TYPE>_fp>() return 1 for success and 0 if an
  497. error occurs.
  498. =head1 EXAMPLES
  499. Allocate and encode the DER encoding of an X509 structure:
  500. int len;
  501. unsigned char *buf;
  502. buf = NULL;
  503. len = i2d_X509(x, &buf);
  504. if (len < 0)
  505. /* error */
  506. Attempt to decode a buffer:
  507. X509 *x;
  508. unsigned char *buf;
  509. const unsigned char *p;
  510. int len;
  511. /* Set up buf and len to point to the input buffer. */
  512. p = buf;
  513. x = d2i_X509(NULL, &p, len);
  514. if (x == NULL)
  515. /* error */
  516. Alternative technique:
  517. X509 *x;
  518. unsigned char *buf;
  519. const unsigned char *p;
  520. int len;
  521. /* Set up buf and len to point to the input buffer. */
  522. p = buf;
  523. x = NULL;
  524. if (d2i_X509(&x, &p, len) == NULL)
  525. /* error */
  526. =head1 WARNINGS
  527. Using a temporary variable is mandatory. A common
  528. mistake is to attempt to use a buffer directly as follows:
  529. int len;
  530. unsigned char *buf;
  531. len = i2d_X509(x, NULL);
  532. buf = OPENSSL_malloc(len);
  533. ...
  534. i2d_X509(x, &buf);
  535. ...
  536. OPENSSL_free(buf);
  537. This code will result in I<buf> apparently containing garbage because
  538. it was incremented after the call to point after the data just written.
  539. Also I<buf> will no longer contain the pointer allocated by OPENSSL_malloc()
  540. and the subsequent call to OPENSSL_free() is likely to crash.
  541. Another trap to avoid is misuse of the I<a> argument to B<d2i_I<TYPE>>():
  542. X509 *x;
  543. if (d2i_X509(&x, &p, len) == NULL)
  544. /* error */
  545. This will probably crash somewhere in d2i_X509(). The reason for this
  546. is that the variable I<x> is uninitialized and an attempt will be made to
  547. interpret its (invalid) value as an B<X509> structure, typically causing
  548. a segmentation violation. If I<x> is set to NULL first then this will not
  549. happen.
  550. =head1 BUGS
  551. In some versions of OpenSSL the "reuse" behaviour of B<d2i_I<TYPE>>() when
  552. I<*a> is valid is broken and some parts of the reused structure may
  553. persist if they are not present in the new one. Additionally, in versions of
  554. OpenSSL prior to 1.1.0, when the "reuse" behaviour is used and an error occurs
  555. the behaviour is inconsistent. Some functions behaved as described here, while
  556. some did not free I<*a> on error and did not set I<*a> to NULL.
  557. As a result of the above issues the "reuse" behaviour is strongly discouraged.
  558. B<i2d_I<TYPE>>() will not return an error in many versions of OpenSSL,
  559. if mandatory fields are not initialized due to a programming error
  560. then the encoded structure may contain invalid data or omit the
  561. fields entirely and will not be parsed by B<d2i_I<TYPE>>(). This may be
  562. fixed in future so code should not assume that B<i2d_I<TYPE>>() will
  563. always succeed.
  564. Any function which encodes a structure (B<i2d_I<TYPE>>(),
  565. B<i2d_I<TYPE>>() or B<i2d_I<TYPE>>()) may return a stale encoding if the
  566. structure has been modified after deserialization or previous
  567. serialization. This is because some objects cache the encoding for
  568. efficiency reasons.
  569. =head1 COPYRIGHT
  570. Copyright 1998-2020 The OpenSSL Project Authors. All Rights Reserved.
  571. Licensed under the Apache License 2.0 (the "License"). You may not use
  572. this file except in compliance with the License. You can obtain a copy
  573. in the file LICENSE in the source distribution or at
  574. L<https://www.openssl.org/source/license.html>.
  575. =cut