The last character of inconsistency in my recent commits is hereby
[openssl.git] / doc / ssl / SSL_get_client_CA_list.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_client_CA_list, SSL_CTX_get_client_CA_list - get list of client CAs
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  STACK_OF(X509_NAME) *SSL_get_client_CA_list(SSL *s);
12  STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(SSL_CTX *ctx); 
13
14 =head1 DESCRIPTION
15
16 SSL_CTX_get_client_CA_list() returns the list of client CAs explicitly set for
17 B<ctx> using L<SSL_CTX_set_client_CA_list(3)|SSL_CTX_set_client_CA_list(3)>.
18
19 SSL_get_client_CA_list() returns the list of client CAs explicitly
20 set for B<ssl> using SSL_set_client_CA_list() or B<ssl>'s SSL_CTX object with
21 L<SSL_CTX_set_client_CA_list(3)|SSL_CTX_set_client_CA_list(3)>, when in
22 server mode. In client mode, SSL_get_client_CA_list returns the list of
23 client CAs sent from the server, if any.
24
25 =head1 RETURN VALUES
26
27 SSL_CTX_set_client_CA_list() and SSL_set_client_CA_list() do not return
28 diagnostic information.
29
30 SSL_CTX_add_client_CA() and SSL_add_client_CA() have the following return
31 values:
32
33 =over 4
34
35 =item STACK_OF(X509_NAMES)
36
37 List of CA names explicitly set (for B<ctx> or in server mode) or send
38 by the server (client mode).
39
40 =item NULL
41
42 No client CA list was explicitly set (for B<ctx> or in server mode) or
43 the server did not send a list of CAs (client mode).
44
45 =back
46
47 =head1 SEE ALSO
48
49 L<ssl(3)|ssl(3)>,
50 L<SSL_CTX_set_client_CA_list(3)|SSL_CTX_set_client_CA_list(3)>,
51 L<SSL_CTX_set_client_cert_cb(3)|SSL_CTX_set_client_cert_cb(3)>
52
53 =cut