xref: /freebsd-src/crypto/openssl/doc/man3/EVP_PKEY_digestsign_supports_digest.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryEVP_PKEY_digestsign_supports_digest - indicate support for signature digest
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 SYNOPSIS
8*b077aed3SPierre Pronchery
9*b077aed3SPierre Pronchery #include <openssl/evp.h>
10*b077aed3SPierre Pronchery int EVP_PKEY_digestsign_supports_digest(EVP_PKEY *pkey, OSSL_LIB_CTX *libctx,
11*b077aed3SPierre Pronchery                                         const char *name, const char *propq);
12*b077aed3SPierre Pronchery
13*b077aed3SPierre Pronchery=head1 DESCRIPTION
14*b077aed3SPierre Pronchery
15*b077aed3SPierre ProncheryThe EVP_PKEY_digestsign_supports_digest() function queries whether the message
16*b077aed3SPierre Proncherydigest I<name> is supported for public key signature operations associated with
17*b077aed3SPierre Proncherykey I<pkey>. The query is done within an optional library context I<libctx> and
18*b077aed3SPierre Proncherywith an optional property query I<propq>.
19*b077aed3SPierre Pronchery
20*b077aed3SPierre Pronchery=head1 RETURN VALUES
21*b077aed3SPierre Pronchery
22*b077aed3SPierre ProncheryThe EVP_PKEY_digestsign_supports_digest() function returns 1 if the message
23*b077aed3SPierre Proncherydigest algorithm identified by I<name> can be used for public key signature
24*b077aed3SPierre Proncheryoperations associated with key I<pkey> and 0 if it cannot be used. It returns
25*b077aed3SPierre Proncherya negative value for failure.
26*b077aed3SPierre Pronchery
27*b077aed3SPierre Pronchery=head1 SEE ALSO
28*b077aed3SPierre Pronchery
29*b077aed3SPierre ProncheryL<EVP_DigestSignInit_ex(3)>,
30*b077aed3SPierre Pronchery
31*b077aed3SPierre Pronchery=head1 HISTORY
32*b077aed3SPierre Pronchery
33*b077aed3SPierre ProncheryThe EVP_PKEY_digestsign_supports_digest() function was added in OpenSSL 3.0.
34*b077aed3SPierre Pronchery
35*b077aed3SPierre Pronchery=head1 COPYRIGHT
36*b077aed3SPierre Pronchery
37*b077aed3SPierre ProncheryCopyright 2021 The OpenSSL Project Authors. All Rights Reserved.
38*b077aed3SPierre Pronchery
39*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
40*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
41*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
42*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
43*b077aed3SPierre Pronchery
44*b077aed3SPierre Pronchery=cut
45