doc/man3/X509_dup.pod

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