SSL_get_client_CA_list.pod 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. =pod
  2. =head1 NAME
  3. SSL_get_client_CA_list, SSL_CTX_get_client_CA_list - get list of client CAs
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
  7. STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(const SSL_CTX *ctx);
  8. =head1 DESCRIPTION
  9. SSL_CTX_get_client_CA_list() returns the list of client CAs explicitly set for
  10. B<ctx> using L<SSL_CTX_set_client_CA_list(3)>.
  11. SSL_get_client_CA_list() returns the list of client CAs explicitly
  12. set for B<ssl> using SSL_set_client_CA_list() or B<ssl>'s SSL_CTX object with
  13. L<SSL_CTX_set_client_CA_list(3)>, when in
  14. server mode. In client mode, SSL_get_client_CA_list returns the list of
  15. client CAs sent from the server, if any.
  16. =head1 RETURN VALUES
  17. SSL_CTX_set_client_CA_list() and SSL_set_client_CA_list() do not return
  18. diagnostic information.
  19. SSL_CTX_add_client_CA() and SSL_add_client_CA() have the following return
  20. values:
  21. =over 4
  22. =item STACK_OF(X509_NAMES)
  23. List of CA names explicitly set (for B<ctx> or in server mode) or send
  24. by the server (client mode).
  25. =item NULL
  26. No client CA list was explicitly set (for B<ctx> or in server mode) or
  27. the server did not send a list of CAs (client mode).
  28. =back
  29. =head1 SEE ALSO
  30. L<ssl(7)>,
  31. L<SSL_CTX_set_client_CA_list(3)>,
  32. L<SSL_CTX_set_client_cert_cb(3)>
  33. =head1 COPYRIGHT
  34. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  35. Licensed under the OpenSSL license (the "License"). You may not use
  36. this file except in compliance with the License. You can obtain a copy
  37. in the file LICENSE in the source distribution or at
  38. L<https://www.openssl.org/source/license.html>.
  39. =cut