X509_dup.pod 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  1. =pod
  2. =head1 NAME
  3. DECLARE_ASN1_FUNCTIONS,
  4. IMPLEMENT_ASN1_FUNCTIONS,
  5. ASN1_ITEM,
  6. ACCESS_DESCRIPTION_free,
  7. ACCESS_DESCRIPTION_new,
  8. ADMISSIONS_free,
  9. ADMISSIONS_new,
  10. ADMISSION_SYNTAX_free,
  11. ADMISSION_SYNTAX_new,
  12. ASIdOrRange_free,
  13. ASIdOrRange_new,
  14. ASIdentifierChoice_free,
  15. ASIdentifierChoice_new,
  16. ASIdentifiers_free,
  17. ASIdentifiers_new,
  18. ASRange_free,
  19. ASRange_new,
  20. AUTHORITY_INFO_ACCESS_free,
  21. AUTHORITY_INFO_ACCESS_new,
  22. AUTHORITY_KEYID_free,
  23. AUTHORITY_KEYID_new,
  24. BASIC_CONSTRAINTS_free,
  25. BASIC_CONSTRAINTS_new,
  26. CERTIFICATEPOLICIES_free,
  27. CERTIFICATEPOLICIES_new,
  28. CMS_ContentInfo_free,
  29. CMS_ContentInfo_new,
  30. CMS_ContentInfo_print_ctx,
  31. CMS_ReceiptRequest_free,
  32. CMS_ReceiptRequest_new,
  33. CRL_DIST_POINTS_free,
  34. CRL_DIST_POINTS_new,
  35. DIRECTORYSTRING_free,
  36. DIRECTORYSTRING_new,
  37. DISPLAYTEXT_free,
  38. DISPLAYTEXT_new,
  39. DIST_POINT_NAME_free,
  40. DIST_POINT_NAME_new,
  41. DIST_POINT_free,
  42. DIST_POINT_new,
  43. DSAparams_dup,
  44. ECPARAMETERS_free,
  45. ECPARAMETERS_new,
  46. ECPKPARAMETERS_free,
  47. ECPKPARAMETERS_new,
  48. EDIPARTYNAME_free,
  49. EDIPARTYNAME_new,
  50. ESS_CERT_ID_dup,
  51. ESS_CERT_ID_free,
  52. ESS_CERT_ID_new,
  53. ESS_CERT_ID_V2_dup,
  54. ESS_CERT_ID_V2_free,
  55. ESS_CERT_ID_V2_new,
  56. ESS_ISSUER_SERIAL_dup,
  57. ESS_ISSUER_SERIAL_free,
  58. ESS_ISSUER_SERIAL_new,
  59. ESS_SIGNING_CERT_dup,
  60. ESS_SIGNING_CERT_free,
  61. ESS_SIGNING_CERT_new,
  62. ESS_SIGNING_CERT_V2_dup,
  63. ESS_SIGNING_CERT_V2_free,
  64. ESS_SIGNING_CERT_V2_new,
  65. EXTENDED_KEY_USAGE_free,
  66. EXTENDED_KEY_USAGE_new,
  67. GENERAL_NAMES_free,
  68. GENERAL_NAMES_new,
  69. GENERAL_NAME_dup,
  70. GENERAL_NAME_free,
  71. GENERAL_NAME_new,
  72. GENERAL_SUBTREE_free,
  73. GENERAL_SUBTREE_new,
  74. IPAddressChoice_free,
  75. IPAddressChoice_new,
  76. IPAddressFamily_free,
  77. IPAddressFamily_new,
  78. IPAddressOrRange_free,
  79. IPAddressOrRange_new,
  80. IPAddressRange_free,
  81. IPAddressRange_new,
  82. ISSUER_SIGN_TOOL_free,
  83. ISSUER_SIGN_TOOL_it,
  84. ISSUER_SIGN_TOOL_new,
  85. ISSUING_DIST_POINT_free,
  86. ISSUING_DIST_POINT_it,
  87. ISSUING_DIST_POINT_new,
  88. NAME_CONSTRAINTS_free,
  89. NAME_CONSTRAINTS_new,
  90. NAMING_AUTHORITY_free,
  91. NAMING_AUTHORITY_new,
  92. NETSCAPE_CERT_SEQUENCE_free,
  93. NETSCAPE_CERT_SEQUENCE_new,
  94. NETSCAPE_SPKAC_free,
  95. NETSCAPE_SPKAC_new,
  96. NETSCAPE_SPKI_free,
  97. NETSCAPE_SPKI_new,
  98. NOTICEREF_free,
  99. NOTICEREF_new,
  100. OCSP_BASICRESP_free,
  101. OCSP_BASICRESP_new,
  102. OCSP_CERTID_dup,
  103. OCSP_CERTID_new,
  104. OCSP_CERTSTATUS_free,
  105. OCSP_CERTSTATUS_new,
  106. OCSP_CRLID_free,
  107. OCSP_CRLID_new,
  108. OCSP_ONEREQ_free,
  109. OCSP_ONEREQ_new,
  110. OCSP_REQINFO_free,
  111. OCSP_REQINFO_new,
  112. OCSP_RESPBYTES_free,
  113. OCSP_RESPBYTES_new,
  114. OCSP_RESPDATA_free,
  115. OCSP_RESPDATA_new,
  116. OCSP_RESPID_free,
  117. OCSP_RESPID_new,
  118. OCSP_RESPONSE_new,
  119. OCSP_REVOKEDINFO_free,
  120. OCSP_REVOKEDINFO_new,
  121. OCSP_SERVICELOC_free,
  122. OCSP_SERVICELOC_new,
  123. OCSP_SIGNATURE_free,
  124. OCSP_SIGNATURE_new,
  125. OCSP_SINGLERESP_free,
  126. OCSP_SINGLERESP_new,
  127. OSSL_CMP_ITAV_dup,
  128. OSSL_CMP_ITAV_free,
  129. OSSL_CMP_MSG_dup,
  130. OSSL_CMP_MSG_it,
  131. OSSL_CMP_MSG_free,
  132. OSSL_CMP_PKIHEADER_free,
  133. OSSL_CMP_PKIHEADER_it,
  134. OSSL_CMP_PKIHEADER_new,
  135. OSSL_CMP_PKISI_dup,
  136. OSSL_CMP_PKISI_free,
  137. OSSL_CMP_PKISI_it,
  138. OSSL_CMP_PKISI_new,
  139. OSSL_CMP_PKISTATUS_it,
  140. OSSL_CRMF_CERTID_dup,
  141. OSSL_CRMF_CERTID_free,
  142. OSSL_CRMF_CERTID_it,
  143. OSSL_CRMF_CERTID_new,
  144. OSSL_CRMF_CERTTEMPLATE_free,
  145. OSSL_CRMF_CERTTEMPLATE_it,
  146. OSSL_CRMF_CERTTEMPLATE_new,
  147. OSSL_CRMF_ENCRYPTEDVALUE_free,
  148. OSSL_CRMF_ENCRYPTEDVALUE_it,
  149. OSSL_CRMF_ENCRYPTEDVALUE_new,
  150. OSSL_CRMF_MSGS_free,
  151. OSSL_CRMF_MSGS_it,
  152. OSSL_CRMF_MSGS_new,
  153. OSSL_CRMF_MSG_free,
  154. OSSL_CRMF_MSG_it,
  155. OSSL_CRMF_MSG_new,
  156. OSSL_CRMF_PBMPARAMETER_free,
  157. OSSL_CRMF_PBMPARAMETER_it,
  158. OSSL_CRMF_PBMPARAMETER_new,
  159. OSSL_CRMF_PKIPUBLICATIONINFO_free,
  160. OSSL_CRMF_PKIPUBLICATIONINFO_it,
  161. OSSL_CRMF_PKIPUBLICATIONINFO_new,
  162. OSSL_CRMF_SINGLEPUBINFO_free,
  163. OSSL_CRMF_SINGLEPUBINFO_it,
  164. OSSL_CRMF_SINGLEPUBINFO_new,
  165. OTHERNAME_free,
  166. OTHERNAME_new,
  167. PBE2PARAM_free,
  168. PBE2PARAM_new,
  169. PBEPARAM_free,
  170. PBEPARAM_new,
  171. PBKDF2PARAM_free,
  172. PBKDF2PARAM_new,
  173. PKCS12_BAGS_free,
  174. PKCS12_BAGS_new,
  175. PKCS12_MAC_DATA_free,
  176. PKCS12_MAC_DATA_new,
  177. PKCS12_SAFEBAG_free,
  178. PKCS12_SAFEBAG_new,
  179. PKCS12_free,
  180. PKCS12_new,
  181. PKCS7_DIGEST_free,
  182. PKCS7_DIGEST_new,
  183. PKCS7_ENCRYPT_free,
  184. PKCS7_ENCRYPT_new,
  185. PKCS7_ENC_CONTENT_free,
  186. PKCS7_ENC_CONTENT_new,
  187. PKCS7_ENVELOPE_free,
  188. PKCS7_ENVELOPE_new,
  189. PKCS7_ISSUER_AND_SERIAL_free,
  190. PKCS7_ISSUER_AND_SERIAL_new,
  191. PKCS7_RECIP_INFO_free,
  192. PKCS7_RECIP_INFO_new,
  193. PKCS7_SIGNED_free,
  194. PKCS7_SIGNED_new,
  195. PKCS7_SIGNER_INFO_free,
  196. PKCS7_SIGNER_INFO_new,
  197. PKCS7_SIGN_ENVELOPE_free,
  198. PKCS7_SIGN_ENVELOPE_new,
  199. PKCS7_dup,
  200. PKCS7_free,
  201. PKCS7_new,
  202. PKCS7_print_ctx,
  203. PKCS8_PRIV_KEY_INFO_free,
  204. PKCS8_PRIV_KEY_INFO_new,
  205. PKEY_USAGE_PERIOD_free,
  206. PKEY_USAGE_PERIOD_new,
  207. POLICYINFO_free,
  208. POLICYINFO_new,
  209. POLICYQUALINFO_free,
  210. POLICYQUALINFO_new,
  211. POLICY_CONSTRAINTS_free,
  212. POLICY_CONSTRAINTS_new,
  213. POLICY_MAPPING_free,
  214. POLICY_MAPPING_new,
  215. PROFESSION_INFOS_free,
  216. PROFESSION_INFOS_new,
  217. PROFESSION_INFO_free,
  218. PROFESSION_INFO_new,
  219. PROXY_CERT_INFO_EXTENSION_free,
  220. PROXY_CERT_INFO_EXTENSION_new,
  221. PROXY_POLICY_free,
  222. PROXY_POLICY_new,
  223. RSAPrivateKey_dup,
  224. RSAPublicKey_dup,
  225. RSA_OAEP_PARAMS_free,
  226. RSA_OAEP_PARAMS_new,
  227. RSA_PSS_PARAMS_free,
  228. RSA_PSS_PARAMS_new,
  229. SCRYPT_PARAMS_free,
  230. SCRYPT_PARAMS_new,
  231. SXNETID_free,
  232. SXNETID_new,
  233. SXNET_free,
  234. SXNET_new,
  235. TLS_FEATURE_free,
  236. TLS_FEATURE_new,
  237. TS_ACCURACY_dup,
  238. TS_ACCURACY_free,
  239. TS_ACCURACY_new,
  240. TS_MSG_IMPRINT_dup,
  241. TS_MSG_IMPRINT_free,
  242. TS_MSG_IMPRINT_new,
  243. TS_REQ_dup,
  244. TS_REQ_free,
  245. TS_REQ_new,
  246. TS_RESP_dup,
  247. TS_RESP_free,
  248. TS_RESP_new,
  249. TS_STATUS_INFO_dup,
  250. TS_STATUS_INFO_free,
  251. TS_STATUS_INFO_new,
  252. TS_TST_INFO_dup,
  253. TS_TST_INFO_free,
  254. TS_TST_INFO_new,
  255. USERNOTICE_free,
  256. USERNOTICE_new,
  257. X509_ALGOR_free,
  258. X509_ALGOR_it,
  259. X509_ALGOR_new,
  260. X509_ATTRIBUTE_dup,
  261. X509_ATTRIBUTE_free,
  262. X509_ATTRIBUTE_new,
  263. X509_CERT_AUX_free,
  264. X509_CERT_AUX_new,
  265. X509_CINF_free,
  266. X509_CINF_new,
  267. X509_CRL_INFO_free,
  268. X509_CRL_INFO_new,
  269. X509_CRL_dup,
  270. X509_CRL_free,
  271. X509_CRL_new,
  272. X509_EXTENSION_dup,
  273. X509_EXTENSION_free,
  274. X509_EXTENSION_new,
  275. X509_NAME_ENTRY_dup,
  276. X509_NAME_ENTRY_free,
  277. X509_NAME_ENTRY_new,
  278. X509_NAME_dup,
  279. X509_NAME_free,
  280. X509_NAME_new,
  281. X509_REQ_INFO_free,
  282. X509_REQ_INFO_new,
  283. X509_REQ_dup,
  284. X509_REQ_free,
  285. X509_REQ_new,
  286. X509_REVOKED_dup,
  287. X509_REVOKED_free,
  288. X509_REVOKED_new,
  289. X509_SIG_free,
  290. X509_SIG_new,
  291. X509_VAL_free,
  292. X509_VAL_new,
  293. X509_dup,
  294. - ASN1 object utilities
  295. =head1 SYNOPSIS
  296. =for openssl generic
  297. #include <openssl/asn1t.h>
  298. DECLARE_ASN1_FUNCTIONS(type)
  299. IMPLEMENT_ASN1_FUNCTIONS(stname)
  300. typedef struct ASN1_ITEM_st ASN1_ITEM;
  301. extern const ASN1_ITEM TYPE_it;
  302. TYPE *TYPE_new(void);
  303. TYPE *TYPE_dup(const TYPE *a);
  304. void TYPE_free(TYPE *a);
  305. int TYPE_print_ctx(BIO *out, TYPE *a, int indent, const ASN1_PCTX *pctx);
  306. =head1 DESCRIPTION
  307. In the description below, B<I<TYPE>> is used
  308. as a placeholder for any of the OpenSSL datatypes, such as B<X509>.
  309. The OpenSSL ASN1 parsing library templates are like a data-driven bytecode
  310. interpreter.
  311. Every ASN1 object as a global variable, TYPE_it, that describes the item
  312. such as its fields. (On systems which cannot export variables from shared
  313. libraries, the global is instead a function which returns a pointer to a
  314. static variable.
  315. The macro DECLARE_ASN1_FUNCTIONS() is typically used in header files
  316. to generate the function declarations.
  317. The macro IMPLEMENT_ASN1_FUNCTIONS() is used once in a source file
  318. to generate the function bodies.
  319. B<I<TYPE>_new>() allocates an empty object of the indicated type.
  320. The object returned must be released by calling B<I<TYPE>_free>().
  321. B<I<TYPE>_dup>() copies an existing object, leaving it untouched.
  322. B<I<TYPE>_free>() releases the object and all pointers and sub-objects
  323. within it.
  324. B<I<TYPE>_print_ctx>() prints the object I<a> on the specified BIO I<out>.
  325. Each line will be prefixed with I<indent> spaces.
  326. The I<pctx> specifies the printing context and is for internal
  327. use; use NULL to get the default behavior. If a print function is
  328. user-defined, then pass in any I<pctx> down to any nested calls.
  329. =head1 RETURN VALUES
  330. B<I<TYPE>_new>() and B<I<TYPE>_dup>() return a pointer to the object or NULL on
  331. failure.
  332. B<I<TYPE>_print_ctx>() returns 1 on success or zero on failure.
  333. =head1 COPYRIGHT
  334. Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
  335. Licensed under the Apache License 2.0 (the "License"). You may not use
  336. this file except in compliance with the License. You can obtain a copy
  337. in the file LICENSE in the source distribution or at
  338. L<https://www.openssl.org/source/license.html>.
  339. =cut