diff options
author | Tomas Mraz <tomas@openssl.org> | 2021-05-07 17:44:26 +0200 |
---|---|---|
committer | Tomas Mraz <tomas@openssl.org> | 2021-05-13 13:19:39 +0200 |
commit | e9fe0f7e9df7e0909ca52a024b889e48616a29d9 (patch) | |
tree | 0063dedfae3fa67b80e46e5572743298a3eb2037 /doc | |
parent | 3c39bd9b89198c6b3834c369c7da6f582788f645 (diff) |
Replace EVP_PKEY_supports_digest_nid
The EVP_PKEY_supports_digest_nid() is renamed to
EVP_PKEY_digestsign_supports_digest() and implemented
via EVP_DigestSignInit_ex().
Fixes #14343
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15198)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build.info | 12 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_ASN1_METHOD.pod | 1 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_digestsign_supports_digest.pod | 44 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_get_default_digest_nid.pod | 2 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_supports_digest_nid.pod | 53 |
5 files changed, 51 insertions, 61 deletions
diff --git a/doc/build.info b/doc/build.info index af0e0e0539..02882af91e 100644 --- a/doc/build.info +++ b/doc/build.info @@ -1198,6 +1198,10 @@ DEPEND[html/man3/EVP_PKEY_derive.html]=man3/EVP_PKEY_derive.pod GENERATE[html/man3/EVP_PKEY_derive.html]=man3/EVP_PKEY_derive.pod DEPEND[man/man3/EVP_PKEY_derive.3]=man3/EVP_PKEY_derive.pod GENERATE[man/man3/EVP_PKEY_derive.3]=man3/EVP_PKEY_derive.pod +DEPEND[html/man3/EVP_PKEY_digestsign_supports_digest.html]=man3/EVP_PKEY_digestsign_supports_digest.pod +GENERATE[html/man3/EVP_PKEY_digestsign_supports_digest.html]=man3/EVP_PKEY_digestsign_supports_digest.pod +DEPEND[man/man3/EVP_PKEY_digestsign_supports_digest.3]=man3/EVP_PKEY_digestsign_supports_digest.pod +GENERATE[man/man3/EVP_PKEY_digestsign_supports_digest.3]=man3/EVP_PKEY_digestsign_supports_digest.pod DEPEND[html/man3/EVP_PKEY_encapsulate.html]=man3/EVP_PKEY_encapsulate.pod GENERATE[html/man3/EVP_PKEY_encapsulate.html]=man3/EVP_PKEY_encapsulate.pod DEPEND[man/man3/EVP_PKEY_encapsulate.3]=man3/EVP_PKEY_encapsulate.pod @@ -1274,10 +1278,6 @@ DEPEND[html/man3/EVP_PKEY_size.html]=man3/EVP_PKEY_size.pod GENERATE[html/man3/EVP_PKEY_size.html]=man3/EVP_PKEY_size.pod DEPEND[man/man3/EVP_PKEY_size.3]=man3/EVP_PKEY_size.pod GENERATE[man/man3/EVP_PKEY_size.3]=man3/EVP_PKEY_size.pod -DEPEND[html/man3/EVP_PKEY_supports_digest_nid.html]=man3/EVP_PKEY_supports_digest_nid.pod -GENERATE[html/man3/EVP_PKEY_supports_digest_nid.html]=man3/EVP_PKEY_supports_digest_nid.pod -DEPEND[man/man3/EVP_PKEY_supports_digest_nid.3]=man3/EVP_PKEY_supports_digest_nid.pod -GENERATE[man/man3/EVP_PKEY_supports_digest_nid.3]=man3/EVP_PKEY_supports_digest_nid.pod DEPEND[html/man3/EVP_PKEY_todata.html]=man3/EVP_PKEY_todata.pod GENERATE[html/man3/EVP_PKEY_todata.html]=man3/EVP_PKEY_todata.pod DEPEND[man/man3/EVP_PKEY_todata.3]=man3/EVP_PKEY_todata.pod @@ -3001,6 +3001,7 @@ html/man3/EVP_PKEY_copy_parameters.html \ html/man3/EVP_PKEY_decapsulate.html \ html/man3/EVP_PKEY_decrypt.html \ html/man3/EVP_PKEY_derive.html \ +html/man3/EVP_PKEY_digestsign_supports_digest.html \ html/man3/EVP_PKEY_encapsulate.html \ html/man3/EVP_PKEY_encrypt.html \ html/man3/EVP_PKEY_fromdata.html \ @@ -3020,7 +3021,6 @@ html/man3/EVP_PKEY_set_type.html \ html/man3/EVP_PKEY_settable_params.html \ html/man3/EVP_PKEY_sign.html \ html/man3/EVP_PKEY_size.html \ -html/man3/EVP_PKEY_supports_digest_nid.html \ html/man3/EVP_PKEY_todata.html \ html/man3/EVP_PKEY_verify.html \ html/man3/EVP_PKEY_verify_recover.html \ @@ -3589,6 +3589,7 @@ man/man3/EVP_PKEY_copy_parameters.3 \ man/man3/EVP_PKEY_decapsulate.3 \ man/man3/EVP_PKEY_decrypt.3 \ man/man3/EVP_PKEY_derive.3 \ +man/man3/EVP_PKEY_digestsign_supports_digest.3 \ man/man3/EVP_PKEY_encapsulate.3 \ man/man3/EVP_PKEY_encrypt.3 \ man/man3/EVP_PKEY_fromdata.3 \ @@ -3608,7 +3609,6 @@ man/man3/EVP_PKEY_set_type.3 \ man/man3/EVP_PKEY_settable_params.3 \ man/man3/EVP_PKEY_sign.3 \ man/man3/EVP_PKEY_size.3 \ -man/man3/EVP_PKEY_supports_digest_nid.3 \ man/man3/EVP_PKEY_todata.3 \ man/man3/EVP_PKEY_verify.3 \ man/man3/EVP_PKEY_verify_recover.3 \ diff --git a/doc/man3/EVP_PKEY_ASN1_METHOD.pod b/doc/man3/EVP_PKEY_ASN1_METHOD.pod index cbf735d333..4a515590cc 100644 --- a/doc/man3/EVP_PKEY_ASN1_METHOD.pod +++ b/doc/man3/EVP_PKEY_ASN1_METHOD.pod @@ -257,7 +257,6 @@ L<EVP_PKEY_set_type_str(3)>, and L<EVP_PKEY_assign(3)>. The pkey_ctrl() method adds extra algorithm specific control. It's called by L<EVP_PKEY_get_default_digest_nid(3)>, -L<EVP_PKEY_supports_digest_nid(3)>, L<EVP_PKEY_set1_encoded_public_key(3)>, L<EVP_PKEY_get1_encoded_public_key(3)>, L<PKCS7_SIGNER_INFO_set(3)>, L<PKCS7_RECIP_INFO_set(3)>, ... diff --git a/doc/man3/EVP_PKEY_digestsign_supports_digest.pod b/doc/man3/EVP_PKEY_digestsign_supports_digest.pod new file mode 100644 index 0000000000..c043ce4e95 --- /dev/null +++ b/doc/man3/EVP_PKEY_digestsign_supports_digest.pod @@ -0,0 +1,44 @@ +=pod + +=head1 NAME + +EVP_PKEY_digestsign_supports_digest - indicate support for signature digest + +=head1 SYNOPSIS + + #include <openssl/evp.h> + int EVP_PKEY_digestsign_supports_digest(EVP_PKEY *pkey, OSSL_LIB_CTX *libctx, + const char *name, const char *propq); + +=head1 DESCRIPTION + +The EVP_PKEY_digestsign_supports_digest() function queries whether the message +digest I<name> is supported for public key signature operations associated with +key I<pkey>. The query is done within an optional library context I<libctx> and +with an optional property query I<propq>. + +=head1 RETURN VALUES + +The EVP_PKEY_digestsign_supports_digest() function returns 1 if the message +digest algorithm identified by I<name> can be used for public key signature +operations associated with key I<pkey> and 0 if it cannot be used. It returns +a negative value for failure. + +=head1 SEE ALSO + +L<EVP_DigestSignInit_ex(3)>, + +=head1 HISTORY + +The EVP_PKEY_digestsign_supports_digest() function was added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2021 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). 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 +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/doc/man3/EVP_PKEY_get_default_digest_nid.pod b/doc/man3/EVP_PKEY_get_default_digest_nid.pod index 2213a024c7..d680ffef1a 100644 --- a/doc/man3/EVP_PKEY_get_default_digest_nid.pod +++ b/doc/man3/EVP_PKEY_get_default_digest_nid.pod @@ -47,7 +47,7 @@ algorithm. L<EVP_PKEY_CTX_new(3)>, L<EVP_PKEY_sign(3)>, -L<EVP_PKEY_supports_digest_nid(3)>, +L<EVP_PKEY_digestsign_supports_digest(3)>, L<EVP_PKEY_verify(3)>, L<EVP_PKEY_verify_recover(3)>, diff --git a/doc/man3/EVP_PKEY_supports_digest_nid.pod b/doc/man3/EVP_PKEY_supports_digest_nid.pod deleted file mode 100644 index b3f51346ca..0000000000 --- a/doc/man3/EVP_PKEY_supports_digest_nid.pod +++ /dev/null @@ -1,53 +0,0 @@ -=pod - -=head1 NAME - -EVP_PKEY_supports_digest_nid - indicate support for signature digest - -=head1 SYNOPSIS - - #include <openssl/evp.h> - int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid); - -=head1 DESCRIPTION - -The EVP_PKEY_supports_digest_nid() function queries whether the message digest -NID B<nid> is supported for public key signature operations associated with key -B<pkey>. - -=head1 NOTES - -If the EVP_PKEY implementation does not explicitly support this method, but -L<EVP_PKEY_get_default_digest_nid(3)> returns a mandatory digest result, then -only that mandatory digest will be supported. - -=head1 RETURN VALUES - -The EVP_PKEY_supports_digest_nid() function returns 1 if the message digest -algorithm identified by B<nid> can be used for public key signature operations -associated with key B<pkey> and 0 if it cannot be used. It returns a negative -value for failure. In particular a return value of -2 indicates the query -operation is not supported by the public key algorithm. - -=head1 SEE ALSO - -L<EVP_PKEY_CTX_new(3)>, -L<EVP_PKEY_get_default_digest_nid(3)>, -L<EVP_PKEY_sign(3)>, -L<EVP_PKEY_verify(3)>, -L<EVP_PKEY_verify_recover(3)>, - -=head1 HISTORY - -The EVP_PKEY_supports_digest_nid() function was added in OpenSSL 3.0. - -=head1 COPYRIGHT - -Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). 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 -L<https://www.openssl.org/source/license.html>. - -=cut |