EVP_set_default_properties.pod 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. =pod
  2. =head1 NAME
  3. EVP_set_default_properties
  4. - Set default properties for future algorithm fetches
  5. =head1 SYNOPSIS
  6. #include <openssl/evp.h>
  7. int EVP_set_default_properties(OPENSSL_CTX *libctx, const char *propq);
  8. =head1 DESCRIPTION
  9. EVP_set_default_properties() sets the default properties for all
  10. future EVP algorithm fetches, implicit as well as explicit.
  11. =for comment TODO(3.0) We should consider having an EVP document in
  12. section 7 that details everything about implicit vs explicit fetches
  13. and how they relate to properties.
  14. EVP_set_default_properties stores the properties given with the string
  15. I<propq> among the EVP data that's been stored in the library context
  16. given with I<libctx> (NULL signifies the default library context).
  17. Any previous default property for the specified library context will
  18. be dropped.
  19. =head1 RETURN VALUES
  20. EVP_set_default_properties() returns 1 on success, or 0 on failure.
  21. The latter adds an error on the error stack.
  22. =head1 SEE ALSO
  23. L<EVP_MD_fetch(3)>
  24. =head1 HISTORY
  25. The functions described here were added in OpenSSL 3.0.
  26. =head1 COPYRIGHT
  27. Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  28. Licensed under the Apache License 2.0 (the "License"). You may not use
  29. this file except in compliance with the License. You can obtain a copy
  30. in the file LICENSE in the source distribution or at
  31. L<https://www.openssl.org/source/license.html>.
  32. =cut