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