EVP_PKEY_CTX_get0_libctx.pod 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. =pod
  2. =head1 NAME
  3. EVP_PKEY_CTX_get0_libctx,
  4. EVP_PKEY_CTX_get0_propq,
  5. EVP_PKEY_CTX_get0_provider
  6. - functions for getting diverse information from an EVP_PKEY_CTX
  7. =head1 SYNOPSIS
  8. #include <openssl/evp.h>
  9. OSSL_LIB_CTX *EVP_PKEY_CTX_get0_libctx(EVP_PKEY_CTX *ctx);
  10. const char *EVP_PKEY_CTX_get0_propq(const EVP_PKEY_CTX *ctx);
  11. const OSSL_PROVIDER *EVP_PKEY_CTX_get0_provider(const EVP_PKEY_CTX *ctx);
  12. =head1 DESCRIPTION
  13. EVP_PKEY_CTX_get0_libctx() and EVP_PKEY_CTX_get0_propq() obtain the
  14. OSSL_LIB_CTX and property query string values respectively that were
  15. associated with the EVP_PKEY_CTX when it was constructed.
  16. EVP_PKEY_CTX_get0_provider() returns the provider associated with the
  17. ongoing B<EVP_PKEY_CTX> operation. If the operation is performed by
  18. en B<ENGINE>, this function returns NULL.
  19. =head1 RETURN VALUES
  20. EVP_PKEY_CTX_get0_libctx() and EVP_PKEY_CTX_get0_propq() functions return the
  21. OSSL_LIB_CTX and property query string associated with the EVP_PKEY_CTX or NULL
  22. if they are not set. The returned values should not be freed by the caller.
  23. EVP_PKEY_CTX_get0_provider() returns a provider if an operation performed by
  24. a provider is ongoing, otherwise NULL.
  25. =head1 SEE ALSO
  26. L<EVP_PKEY_CTX_new(3)>
  27. =head1 HISTORY
  28. All functions were added in OpenSSL 3.0.
  29. =head1 COPYRIGHT
  30. Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
  31. Licensed under the Apache License 2.0 (the "License"). You may not use
  32. this file except in compliance with the License. You can obtain a copy
  33. in the file LICENSE in the source distribution or at
  34. L<https://www.openssl.org/source/license.html>.
  35. =cut