doc/man3/EVP_PKEY_digestsign_supports_digest.pod

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