X509_STORE_CTX_get_by_subject.pod 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. =pod
  2. =head1 NAME
  3. X509_STORE_CTX_get_by_subject,
  4. X509_STORE_CTX_get_obj_by_subject
  5. - X509 and X509_CRL lookup functions
  6. =head1 SYNOPSIS
  7. #include <openssl/x509_vfy.h>
  8. int X509_STORE_CTX_get_by_subject(const X509_STORE_CTX *vs,
  9. X509_LOOKUP_TYPE type,
  10. const X509_NAME *name, X509_OBJECT *ret);
  11. X509_OBJECT *X509_STORE_CTX_get_obj_by_subject(X509_STORE_CTX *vs,
  12. X509_LOOKUP_TYPE type,
  13. const X509_NAME *name);
  14. =head1 DESCRIPTION
  15. X509_STORE_CTX_get_by_subject() tries to find an object
  16. of given I<type>, which may be B<X509_LU_X509> or B<X509_LU_CRL>,
  17. and subject I<name> from the store in the provided store context I<vs>.
  18. If found and I<ret> is not NULL, it increments the reference count and
  19. stores the looked up object in I<ret>.
  20. X509_STORE_CTX_get_obj_by_subject() is like X509_STORE_CTX_get_by_subject()
  21. but returns the found object on success, else NULL.
  22. =head1 RETURN VALUES
  23. X509_STORE_CTX_get_by_subject() returns 1 if the lookup was successful, else 0.
  24. X509_STORE_CTX_get_obj_by_subject() returns an object on success, else NULL.
  25. =head1 SEE ALSO
  26. L<X509_LOOKUP_meth_set_get_by_subject(3)>,
  27. L<X509_LOOKUP_by_subject(3)>
  28. =head1 COPYRIGHT
  29. Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
  30. Licensed under the Apache License 2.0 (the "License"). You may not use
  31. this file except in compliance with the License. You can obtain a copy
  32. in the file LICENSE in the source distribution or at
  33. L<https://www.openssl.org/source/license.html>.
  34. =cut