EVP_PKEY_digestsign_supports_digest.pod 1.3 KB

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