X509_dup.pod 6.7 KB

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