X509_STORE_get0_param.pod 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. =pod
  2. =head1 NAME
  3. X509_STORE_get0_param, X509_STORE_set1_param,
  4. X509_STORE_get0_objects, X509_STORE_get1_all_certs
  5. - X509_STORE setter and getter functions
  6. =head1 SYNOPSIS
  7. #include <openssl/x509_vfy.h>
  8. X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *xs);
  9. int X509_STORE_set1_param(X509_STORE *xs, const X509_VERIFY_PARAM *pm);
  10. STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *xs);
  11. STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *xs);
  12. =head1 DESCRIPTION
  13. X509_STORE_set1_param() sets the verification parameters to I<pm> for I<xs>.
  14. X509_STORE_get0_param() retrieves an internal pointer to the verification
  15. parameters for I<xs>. The returned pointer must not be freed by the
  16. calling application
  17. X509_STORE_get0_objects() retrieves an internal pointer to the store's
  18. X509 object cache. The cache contains B<X509> and B<X509_CRL> objects. The
  19. returned pointer must not be freed by the calling application.
  20. X509_STORE_get1_all_certs() returns a list of all certificates in the store.
  21. The caller is responsible for freeing the returned list.
  22. =head1 RETURN VALUES
  23. X509_STORE_get0_param() returns a pointer to an
  24. B<X509_VERIFY_PARAM> structure.
  25. X509_STORE_set1_param() returns 1 for success and 0 for failure.
  26. X509_STORE_get0_objects() returns a pointer to a stack of B<X509_OBJECT>.
  27. X509_STORE_get1_all_certs() returns a pointer to a stack of the retrieved
  28. certificates on success, else NULL.
  29. =head1 SEE ALSO
  30. L<X509_STORE_new(3)>
  31. =head1 HISTORY
  32. B<X509_STORE_get0_param> and B<X509_STORE_get0_objects> were added in
  33. OpenSSL 1.1.0.
  34. B<X509_STORE_get1_certs> was added in OpenSSL 3.0.
  35. =head1 COPYRIGHT
  36. Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
  37. Licensed under the Apache License 2.0 (the "License"). You may not use
  38. this file except in compliance with the License. You can obtain a copy
  39. in the file LICENSE in the source distribution or at
  40. L<https://www.openssl.org/source/license.html>.
  41. =cut