Commit 23e3b3c0c5 for openssl.org
commit 23e3b3c0c5d8f29d95f518a1f0e40f3e1c63ead9
Author: Dr. David von Oheimb <dev@ddvo.net>
Date: Sun Apr 13 21:58:35 2025 +0200
provider-signature.pod: fix doc of OSSL_SIGNATURE_PARAM_ALGORITHM_ID, describing its relevance
This provides a fix for the documentation part of #22932.
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
(Merged from https://github.com/openssl/openssl/pull/27372)
diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod
index 203223cd6b..0abb08a037 100644
--- a/doc/man7/provider-signature.pod
+++ b/doc/man7/provider-signature.pod
@@ -470,8 +470,13 @@ The length of the "digest-size" parameter should not exceed that of a B<size_t>.
=item "algorithm-id" (B<OSSL_SIGNATURE_PARAM_ALGORITHM_ID>) <octet string>
-Gets the DER encoded AlgorithmIdentifier that corresponds to the combination of
-signature algorithm and digest algorithm for the signature operation.
+Gets the DER-encoded AlgorithmIdentifier for the signature operation.
+This typically corresponds to the combination of a digest algorithm
+with a purely asymmetric signature algorithm, such as SHA256WithECDSA.
+
+The L<ASN1_item_sign_ctx(3)> relies on this operation and is used by
+many other functions signing ASN.1 structures such as X.509 certificates,
+certificate requests, and CRLs, as well as OCSP, CMP, and CMS messages.
=item "nonce-type" (B<OSSL_SIGNATURE_PARAM_NONCE_TYPE>) <unsigned integer>
@@ -603,7 +608,8 @@ All other functions should return 1 for success or 0 on error.
=head1 SEE ALSO
-L<provider(7)>
+L<provider(7)>,
+L<ASN1_item_sign_ctx(3)>
=head1 HISTORY