X509_dup.pod 6.5 KB

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