5 SSL_CTX_set_client_CA_list, SSL_set_client_CA_list, SSL_CTX_add_client_CA,
6 SSL_add_client_CA - set list of CAs sent to the client when requesting a
11 #include <openssl/ssl.h>
13 void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *list);
14 void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *list);
15 int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *cacert);
16 int SSL_add_client_CA(SSL *ssl, X509 *cacert);
20 SSL_CTX_set_client_CA_list() sets the B<list> of CAs sent to the client when
21 requesting a client certificate for B<ctx>.
23 SSL_set_client_CA_list() sets the B<list> of CAs sent to the client when
24 requesting a client certificate for the chosen B<ssl>, overriding the
25 setting valid for B<ssl>'s SSL_CTX object.
27 SSL_CTX_add_client_CA() adds the CA name extracted from B<cacert> to the
28 list of CAs sent to the client when requesting a client certificate for
31 SSL_add_client_CA() adds the CA name extracted from B<cacert> to the
32 list of CAs sent to the client when requesting a client certificate for
33 the chosen B<ssl>, overriding the setting valid for B<ssl>'s SSL_CTX object.
37 When a TLS/SSL server requests a client certificate (see
38 B<SSL_CTX_set_verify_options()>), it sends a list of CAs, for which
39 it will accept certificates, to the client. If no special list is provided,
40 the CAs available using the B<CAfile> option in
41 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>
44 This list can be explicitely set using the SSL_CTX_set_client_CA_list() for
45 B<ctx> and SSL_set_client_CA_list() for the specific B<ssl>. The list
46 specified overrides the previous setting. The CAs listed do not become
47 trusted (B<list> only contains the names, not the complete certificates); use
48 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>
49 to additionally load them for verification.
51 SSL_CTX_add_client_CA() and SSL_add_client_CA() can be used to add additional
52 items the list of client CAs. If no list was specified before using
53 SSL_CTX_set_client_CA_list() or SSL_set_client_CA_list(), a new client
54 CA list for B<ctx> or B<ssl> (as appropriate) is opened. The CAs implicitly
56 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>
57 are no longer used automatically.
59 These functions are only useful for TLS/SSL servers.
63 SSL_CTX_set_client_CA_list() and SSL_set_client_CA_list() do not return
64 diagnostic information.
66 SSL_CTX_add_client_CA() and SSL_add_client_CA() have the following return
73 The operation succeeded.
77 A failure while manipulating the STACK_OF(X509_NAME) object occured or
78 the X509_NAME could not be extracted from B<cacert>. Check the error stack
79 to find out the reason.
86 L<SSL_get_client_CA_list(3)|SSL_get_client_CA_list(3)>,
87 L<SSL_load_client_CA_file(3)|SSL_load_client_CA_file(3)>
88 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>