deploy openssl/openssl@b85e6f5 to master

master/man3/X509_dup/index.html

@@ -24,4 +24,4 @@
 </code></pre></div><p>The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining <strong>OPENSSL_API_COMPAT</strong> with a suitable version value, see <a href=../../man7/openssl_user_macros/ >openssl_user_macros(7)</a>:</p><div class=highlight><pre><span></span><code>DSA *DSAparams_dup(const DSA *dsa);
 RSA *RSAPrivateKey_dup(const RSA *rsa);
 RSA *RSAPublicKey_dup(const RSA *rsa);
-</code></pre></div><h2 id=description>DESCRIPTION<a class=headerlink href=#description title="Permanent link">&para;</a></h2><p>In the description below, <strong><em>TYPE</em></strong> is used as a placeholder for any of the OpenSSL datatypes, such as <strong>X509</strong>.</p><p>The OpenSSL ASN1 parsing library templates are like a data-driven bytecode interpreter. Every ASN1 object as a global variable, TYPE_it, that describes the item such as its fields. (On systems which cannot export variables from shared libraries, the global is instead a function which returns a pointer to a static variable.</p><p>The macro DECLARE_ASN1_FUNCTIONS() is typically used in header files to generate the function declarations.</p><p>The macro IMPLEMENT_ASN1_FUNCTIONS() is used once in a source file to generate the function bodies.</p><p><strong><em>TYPE</em>_new</strong>() allocates an empty object of the indicated type. The object returned must be released by calling <strong><em>TYPE</em>_free</strong>().</p><p><strong><em>TYPE</em>_new_ex</strong>() is similar to <strong><em>TYPE</em>_new</strong>() but also passes the library context <em>libctx</em> and the property query <em>propq</em> to use when retrieving algorithms from providers. This created object can then be used when loading binary data using <strong>d2i_<em>TYPE</em></strong>().</p><p><strong><em>TYPE</em>_dup</strong>() copies an existing object, leaving it untouched. Note, however, that the internal representation of the object may contain (besides the ASN.1 structure) further data, which is not copied. For instance, an <strong>X509</strong> object usually is augmented by cached information on X.509v3 extensions, etc., and losing it can lead to wrong validation results. To avoid such situations, better use <strong><em>TYPE</em>_up_ref</strong>() if available. For the case of <strong>X509</strong> objects, an alternative to using <a href=../X509_new/ >X509_up_ref(3)</a> may be to still call <strong><em>TYPE</em>_dup</strong>(), e.g., <em>copied_cert = X509_dup(cert)</em>, followed by <em>X509_check_purpose(copied_cert, -1, 0)</em>, which re-builds the cached data.</p><p><strong><em>TYPE</em>_free</strong>() releases the object and all pointers and sub-objects within it. If the argument is NULL, nothing is done.</p><p><strong><em>TYPE</em>_print_ctx</strong>() prints the object <em>a</em> on the specified BIO <em>out</em>. Each line will be prefixed with <em>indent</em> spaces. The <em>pctx</em> specifies the printing context and is for internal use; use NULL to get the default behavior. If a print function is user-defined, then pass in any <em>pctx</em> down to any nested calls.</p><h2 id=return-values>RETURN VALUES<a class=headerlink href=#return-values title="Permanent link">&para;</a></h2><p><strong><em>TYPE</em>_new</strong>(), <strong><em>TYPE</em>_new_ex</strong>() and <strong><em>TYPE</em>_dup</strong>() return a pointer to the object or NULL on failure.</p><p><strong><em>TYPE</em>_print_ctx</strong>() returns 1 on success or zero on failure.</p><h2 id=see-also>SEE ALSO<a class=headerlink href=#see-also title="Permanent link">&para;</a></h2><p><a href=../X509_new/ >X509_up_ref(3)</a></p><h2 id=history>HISTORY<a class=headerlink href=#history title="Permanent link">&para;</a></h2><p>The functions X509_REQ_new_ex(), X509_CRL_new_ex(), PKCS7_new_ex() and CMS_ContentInfo_new_ex() were added in OpenSSL 3.0.</p><p>The functions DSAparams_dup(), RSAPrivateKey_dup() and RSAPublicKey_dup() were deprecated in 3.0.</p><p>CMS_EnvelopedData_it(), CMS_SignedData_free(), CMS_SignedData_new() were added in OpenSSL 3.2.</p><p>DIST_POINT_NAME_dup(), OSSL_IETF_ATTR_SYNTAX_free(), OSSL_IETF_ATTR_SYNTAX_it(), OSSL_IETF_ATTR_SYNTAX_new(), OSSL_ATTRIBUTES_SYNTAX_free(), OSSL_ATTRIBUTES_SYNTAX_it(), OSSL_ATTRIBUTES_SYNTAX_new(), OSSL_BASIC_ATTR_CONSTRAINTS_free(), OSSL_BASIC_ATTR_CONSTRAINTS_it(), OSSL_BASIC_ATTR_CONSTRAINTS_new(), OSSL_CMP_ATAVS_new(), OSSL_CMP_ATAVS_free(), OSSL_CMP_ATAVS_it(), OSSL_CMP_CRLSTATUS_free(), OSSL_CRMF_CERTTEMPLATE_dup(), OSSL_CRMF_ATTRIBUTETYPEANDVALUE_dup(), OSSL_CRMF_ATTRIBUTETYPEANDVALUE_free(), OSSL_TARGET_free(), OSSL_TARGET_it(), OSSL_TARGET_new(), OSSL_TARGETING_INFORMATION_free(), OSSL_TARGETING_INFORMATION_it(), OSSL_TARGETING_INFORMATION_new(), OSSL_TARGETS_free(), OSSL_TARGETS_it(), OSSL_TARGETS_new(), OSSL_IETF_ATTR_SYNTAX_VALUE_free(), OSSL_IETF_ATTR_SYNTAX_VALUE_it(), OSSL_IETF_ATTR_SYNTAX_VALUE_new(), OSSL_ISSUER_SERIAL_free(), OSSL_ISSUER_SERIAL_new(), OSSL_OBJECT_DIGEST_INFO_free(), OSSL_OBJECT_DIGEST_INFO_new(), OSSL_USER_NOTICE_SYNTAX_free(), OSSL_USER_NOTICE_SYNTAX_new(), OSSL_USER_NOTICE_SYNTAX_it(), PBMAC1PARAM_free(), PBMAC1PARAM_it(), PBMAC1PARAM_new(), X509_ACERT_dup(), X509_ACERT_free(), X509_ACERT_it(), X509_ACERT_new(), X509_ACERT_INFO_free(), X509_ACERT_INFO_it(), X509_ACERT_INFO_new(), X509_ACERT_ISSUER_V2FORM_free(), X509_ACERT_ISSUER_V2FORM_new() were added in OpenSSL 3.4.</p><p>OSSL_ATTRIBUTE_DESCRIPTOR_free(), OSSL_ATTRIBUTE_DESCRIPTOR_new(), OSSL_ATTRIBUTE_DESCRIPTOR_it(), OSSL_AUTHORITY_ATTRIBUTE_ID_SYNTAX_free(), OSSL_AUTHORITY_ATTRIBUTE_ID_SYNTAX_it(), OSSL_AUTHORITY_ATTRIBUTE_ID_SYNTAX_new(), OSSL_HASH_free(), OSSL_HASH_it(), OSSL_HASH_new(), OSSL_INFO_SYNTAX_free(), OSSL_INFO_SYNTAX_it(), OSSL_INFO_SYNTAX_new(), OSSL_INFO_SYNTAX_POINTER_free(), OSSL_INFO_SYNTAX_POINTER_it(), OSSL_INFO_SYNTAX_POINTER_new(), OSSL_PRIVILEGE_POLICY_ID_free(), OSSL_PRIVILEGE_POLICY_ID_it(), OSSL_PRIVILEGE_POLICY_ID_new(), OSSL_ROLE_SPEC_CERT_ID_free(), OSSL_ROLE_SPEC_CERT_ID_new(), OSSL_ROLE_SPEC_CERT_ID_it(), OSSL_ROLE_SPEC_CERT_ID_SYNTAX_free(), OSSL_ROLE_SPEC_CERT_ID_SYNTAX_new(), OSSL_ROLE_SPEC_CERT_ID_SYNTAX_it(), OSSL_DAY_TIME_BAND_free(), OSSL_DAY_TIME_BAND_it(), OSSL_DAY_TIME_BAND_new(), OSSL_DAY_TIME_free(), OSSL_DAY_TIME_it(), OSSL_DAY_TIME_new(), OSSL_NAMED_DAY_free(), OSSL_NAMED_DAY_it(), OSSL_NAMED_DAY_new(), OSSL_TIME_PERIOD_free(), OSSL_TIME_PERIOD_it(), OSSL_TIME_PERIOD_new(), OSSL_TIME_SPEC_ABSOLUTE_free(), OSSL_TIME_SPEC_ABSOLUTE_it(), OSSL_TIME_SPEC_ABSOLUTE_new(), OSSL_TIME_SPEC_DAY_free(), OSSL_TIME_SPEC_DAY_it(), OSSL_TIME_SPEC_DAY_new(), OSSL_TIME_SPEC_MONTH_free(), OSSL_TIME_SPEC_MONTH_it(), OSSL_TIME_SPEC_MONTH_new(), OSSL_TIME_SPEC_TIME_free(), OSSL_TIME_SPEC_TIME_it(), OSSL_TIME_SPEC_TIME_new(), OSSL_TIME_SPEC_WEEKS_free(), OSSL_TIME_SPEC_WEEKS_it(), OSSL_TIME_SPEC_WEEKS_new(), OSSL_TIME_SPEC_X_DAY_OF_free(), OSSL_TIME_SPEC_X_DAY_OF_it(), OSSL_TIME_SPEC_X_DAY_OF_new(), OSSL_TIME_SPEC_free(), OSSL_TIME_SPEC_it(), OSSL_TIME_SPEC_new() were added in OpenSSL 3.5.</p><h2 id=copyright>COPYRIGHT<a class=headerlink href=#copyright title="Permanent link">&para;</a></h2><p>Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.</p><p>Licensed under the Apache License 2.0 (the &quot;License&quot;). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href=https://www.openssl.org/source/license.html>https://www.openssl.org/source/license.html</a>.</p></article></div><script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script></div></main><footer class=md-footer><div class="md-footer-meta md-typeset"><div class="md-footer-meta__inner md-grid"><div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a></div></div></div></footer></div><div class=md-dialog data-md-component=dialog><div class="md-dialog__inner md-typeset"></div></div><script id=__config type=application/json>{"base": "../..", "features": ["navigation.indexes", "navigation.instant", "navigation.path", "navigation.prune", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "master", "provider": "mike"}}</script><script src=../../assets/javascripts/bundle.ad660dcc.min.js></script></body></html>
+</code></pre></div><h2 id=description>DESCRIPTION<a class=headerlink href=#description title="Permanent link">&para;</a></h2><p>In the description below, <strong><em>TYPE</em></strong> is used as a placeholder for any of the OpenSSL datatypes, such as <strong>X509</strong>.</p><p>The OpenSSL ASN1 parsing library templates are like a data-driven bytecode interpreter. Every ASN1 object as a global variable, TYPE_it, that describes the item such as its fields. (On systems which cannot export variables from shared libraries, the global is instead a function which returns a pointer to a static variable.</p><p>The macro DECLARE_ASN1_FUNCTIONS() is typically used in header files to generate the function declarations.</p><p>The macro IMPLEMENT_ASN1_FUNCTIONS() is used once in a source file to generate the function bodies.</p><p><strong><em>TYPE</em>_new</strong>() allocates an empty object of the indicated type. The object returned must be released by calling <strong><em>TYPE</em>_free</strong>().</p><p><strong><em>TYPE</em>_new_ex</strong>() is similar to <strong><em>TYPE</em>_new</strong>() but also passes the library context <em>libctx</em> and the property query <em>propq</em> to use when retrieving algorithms from providers. This created object can then be used when loading binary data using <strong>d2i_<em>TYPE</em></strong>().</p><p><strong><em>TYPE</em>_dup</strong>() copies an existing object, leaving it untouched. Note, however, that the internal representation of the object may contain (besides the ASN.1 structure) further data, which is not copied. For instance, an <strong>X509</strong> object usually is augmented by cached information on X.509v3 extensions, etc., and losing it can lead to wrong validation results. To avoid such situations, better use <strong><em>TYPE</em>_up_ref</strong>() if available. For the case of <strong>X509</strong> objects, an alternative to using <a href=../X509_new/ >X509_up_ref(3)</a> may be to still call <strong><em>TYPE</em>_dup</strong>(), e.g., <em>copied_cert = X509_dup(cert)</em>, followed by <em>X509_check_purpose(copied_cert, -1, 0)</em>, which re-builds the cached data.</p><p><strong><em>TYPE</em>_free</strong>() releases the object and all pointers and sub-objects within it. If the argument is NULL, nothing is done.</p><p><strong><em>TYPE</em>_print_ctx</strong>() prints the object <em>a</em> on the specified BIO <em>out</em>. Each line will be prefixed with <em>indent</em> spaces. The <em>pctx</em> specifies the printing context and is for internal use; use NULL to get the default behavior. If a print function is user-defined, then pass in any <em>pctx</em> down to any nested calls.</p><h2 id=return-values>RETURN VALUES<a class=headerlink href=#return-values title="Permanent link">&para;</a></h2><p><strong><em>TYPE</em>_new</strong>(), <strong><em>TYPE</em>_new_ex</strong>() and <strong><em>TYPE</em>_dup</strong>() return a pointer to the object or NULL on failure.</p><p><strong><em>TYPE</em>_print_ctx</strong>() returns 1 on success or zero on failure.</p><h2 id=see-also>SEE ALSO<a class=headerlink href=#see-also title="Permanent link">&para;</a></h2><p><a href=../X509_new/ >X509_up_ref(3)</a></p><h2 id=history>HISTORY<a class=headerlink href=#history title="Permanent link">&para;</a></h2><p>The functions X509_REQ_new_ex(), X509_CRL_new_ex(), PKCS7_new_ex() and CMS_ContentInfo_new_ex() were added in OpenSSL 3.0.</p><p>The functions DSAparams_dup(), RSAPrivateKey_dup() and RSAPublicKey_dup() were deprecated in 3.0.</p><p>CMS_EnvelopedData_it(), CMS_SignedData_free(), CMS_SignedData_new() were added in OpenSSL 3.2.</p><p>DIST_POINT_NAME_dup(), OSSL_IETF_ATTR_SYNTAX_free(), OSSL_IETF_ATTR_SYNTAX_it(), OSSL_IETF_ATTR_SYNTAX_new(), OSSL_ATTRIBUTES_SYNTAX_free(), OSSL_ATTRIBUTES_SYNTAX_it(), OSSL_ATTRIBUTES_SYNTAX_new(), OSSL_BASIC_ATTR_CONSTRAINTS_free(), OSSL_BASIC_ATTR_CONSTRAINTS_it(), OSSL_BASIC_ATTR_CONSTRAINTS_new(), OSSL_CMP_ATAVS_new(), OSSL_CMP_ATAVS_free(), OSSL_CMP_ATAVS_it(), OSSL_CMP_CRLSTATUS_free(), OSSL_CRMF_CERTTEMPLATE_dup(), OSSL_CRMF_ATTRIBUTETYPEANDVALUE_dup(), OSSL_CRMF_ATTRIBUTETYPEANDVALUE_free(), OSSL_TARGET_free(), OSSL_TARGET_it(), OSSL_TARGET_new(), OSSL_TARGETING_INFORMATION_free(), OSSL_TARGETING_INFORMATION_it(), OSSL_TARGETING_INFORMATION_new(), OSSL_TARGETS_free(), OSSL_TARGETS_it(), OSSL_TARGETS_new(), OSSL_IETF_ATTR_SYNTAX_VALUE_free(), OSSL_IETF_ATTR_SYNTAX_VALUE_it(), OSSL_IETF_ATTR_SYNTAX_VALUE_new(), OSSL_ISSUER_SERIAL_free(), OSSL_ISSUER_SERIAL_new(), OSSL_OBJECT_DIGEST_INFO_free(), OSSL_OBJECT_DIGEST_INFO_new(), OSSL_USER_NOTICE_SYNTAX_free(), OSSL_USER_NOTICE_SYNTAX_new(), OSSL_USER_NOTICE_SYNTAX_it(), PBMAC1PARAM_free(), PBMAC1PARAM_it(), PBMAC1PARAM_new(), X509_ACERT_dup(), X509_ACERT_free(), X509_ACERT_it(), X509_ACERT_new(), X509_ACERT_INFO_free(), X509_ACERT_INFO_it(), X509_ACERT_INFO_new(), X509_ACERT_ISSUER_V2FORM_free(), X509_ACERT_ISSUER_V2FORM_new() were added in OpenSSL 3.4.</p><p>OSSL_ATAV_free(), OSSL_ATAV_it(), OSSL_ATAV_new(), OSSL_ATTRIBUTE_DESCRIPTOR_free(), OSSL_ATTRIBUTE_DESCRIPTOR_new(), OSSL_ATTRIBUTE_DESCRIPTOR_it(), OSSL_ATTRIBUTE_MAPPINGS_free(), OSSL_ATTRIBUTE_MAPPINGS_it(), OSSL_ATTRIBUTE_MAPPINGS_new(), OSSL_ATTRIBUTE_MAPPING_free(), OSSL_ATTRIBUTE_MAPPING_it(), OSSL_ATTRIBUTE_MAPPING_new(), OSSL_ATTRIBUTE_TYPE_MAPPING_free(), OSSL_ATTRIBUTE_TYPE_MAPPING_it(), OSSL_ATTRIBUTE_TYPE_MAPPING_new(), OSSL_ATTRIBUTE_VALUE_MAPPING_free(), OSSL_ATTRIBUTE_VALUE_MAPPING_it(), OSSL_ATTRIBUTE_VALUE_MAPPING_new(), OSSL_AUTHORITY_ATTRIBUTE_ID_SYNTAX_free(), OSSL_AUTHORITY_ATTRIBUTE_ID_SYNTAX_it(), OSSL_AUTHORITY_ATTRIBUTE_ID_SYNTAX_new(), OSSL_HASH_free(), OSSL_HASH_it(), OSSL_HASH_new(), OSSL_INFO_SYNTAX_free(), OSSL_INFO_SYNTAX_it(), OSSL_INFO_SYNTAX_new(), OSSL_INFO_SYNTAX_POINTER_free(), OSSL_INFO_SYNTAX_POINTER_it(), OSSL_INFO_SYNTAX_POINTER_new(), OSSL_PRIVILEGE_POLICY_ID_free(), OSSL_PRIVILEGE_POLICY_ID_it(), OSSL_PRIVILEGE_POLICY_ID_new(), OSSL_ROLE_SPEC_CERT_ID_free(), OSSL_ROLE_SPEC_CERT_ID_new(), OSSL_ROLE_SPEC_CERT_ID_it(), OSSL_ROLE_SPEC_CERT_ID_SYNTAX_free(), OSSL_ROLE_SPEC_CERT_ID_SYNTAX_new(), OSSL_ROLE_SPEC_CERT_ID_SYNTAX_it(), OSSL_DAY_TIME_BAND_free(), OSSL_DAY_TIME_BAND_it(), OSSL_DAY_TIME_BAND_new(), OSSL_DAY_TIME_free(), OSSL_DAY_TIME_it(), OSSL_DAY_TIME_new(), OSSL_NAMED_DAY_free(), OSSL_NAMED_DAY_it(), OSSL_NAMED_DAY_new(), OSSL_TIME_PERIOD_free(), OSSL_TIME_PERIOD_it(), OSSL_TIME_PERIOD_new(), OSSL_TIME_SPEC_ABSOLUTE_free(), OSSL_TIME_SPEC_ABSOLUTE_it(), OSSL_TIME_SPEC_ABSOLUTE_new(), OSSL_TIME_SPEC_DAY_free(), OSSL_TIME_SPEC_DAY_it(), OSSL_TIME_SPEC_DAY_new(), OSSL_TIME_SPEC_MONTH_free(), OSSL_TIME_SPEC_MONTH_it(), OSSL_TIME_SPEC_MONTH_new(), OSSL_TIME_SPEC_TIME_free(), OSSL_TIME_SPEC_TIME_it(), OSSL_TIME_SPEC_TIME_new(), OSSL_TIME_SPEC_WEEKS_free(), OSSL_TIME_SPEC_WEEKS_it(), OSSL_TIME_SPEC_WEEKS_new(), OSSL_TIME_SPEC_X_DAY_OF_free(), OSSL_TIME_SPEC_X_DAY_OF_it(), OSSL_TIME_SPEC_X_DAY_OF_new(), OSSL_TIME_SPEC_free(), OSSL_TIME_SPEC_it(), OSSL_TIME_SPEC_new() were added in OpenSSL 3.5.</p><h2 id=copyright>COPYRIGHT<a class=headerlink href=#copyright title="Permanent link">&para;</a></h2><p>Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.</p><p>Licensed under the Apache License 2.0 (the &quot;License&quot;). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href=https://www.openssl.org/source/license.html>https://www.openssl.org/source/license.html</a>.</p></article></div><script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script></div></main><footer class=md-footer><div class="md-footer-meta md-typeset"><div class="md-footer-meta__inner md-grid"><div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a></div></div></div></footer></div><div class=md-dialog data-md-component=dialog><div class="md-dialog__inner md-typeset"></div></div><script id=__config type=application/json>{"base": "../..", "features": ["navigation.indexes", "navigation.instant", "navigation.path", "navigation.prune", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "master", "provider": "mike"}}</script><script src=../../assets/javascripts/bundle.ad660dcc.min.js></script></body></html>