312 lines
13 KiB
Groff
Executable File
312 lines
13 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "SSL_CTX_SET0_CA_LIST 3"
|
|
.TH SSL_CTX_SET0_CA_LIST 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
SSL_CTX_set_client_CA_list,
|
|
SSL_set_client_CA_list,
|
|
SSL_get_client_CA_list,
|
|
SSL_CTX_get_client_CA_list,
|
|
SSL_CTX_add_client_CA,
|
|
SSL_add_client_CA,
|
|
SSL_set0_CA_list,
|
|
SSL_CTX_set0_CA_list,
|
|
SSL_get0_CA_list,
|
|
SSL_CTX_get0_CA_list,
|
|
SSL_add1_to_CA_list,
|
|
SSL_CTX_add1_to_CA_list,
|
|
SSL_get0_peer_CA_list
|
|
\&\- get or set CA list
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *list);
|
|
\& void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *list);
|
|
\& STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
|
|
\& STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(const SSL_CTX *ctx);
|
|
\& int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *cacert);
|
|
\& int SSL_add_client_CA(SSL *ssl, X509 *cacert);
|
|
\&
|
|
\& void SSL_CTX_set0_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
|
|
\& void SSL_set0_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
|
|
\& const STACK_OF(X509_NAME) *SSL_CTX_get0_CA_list(const SSL_CTX *ctx);
|
|
\& const STACK_OF(X509_NAME) *SSL_get0_CA_list(const SSL *s);
|
|
\& int SSL_CTX_add1_to_CA_list(SSL_CTX *ctx, const X509 *x);
|
|
\& int SSL_add1_to_CA_list(SSL *ssl, const X509 *x);
|
|
\&
|
|
\& const STACK_OF(X509_NAME) *SSL_get0_peer_CA_list(const SSL *s);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The functions described here set and manage the list of \s-1CA\s0 names that are sent
|
|
between two communicating peers.
|
|
.PP
|
|
For \s-1TLS\s0 versions 1.2 and earlier the list of \s-1CA\s0 names is only sent from the
|
|
server to the client when requesting a client certificate. So any list of \s-1CA\s0
|
|
names set is never sent from client to server and the list of \s-1CA\s0 names retrieved
|
|
by \fISSL_get0_peer_CA_list()\fR is always \fB\s-1NULL\s0\fR.
|
|
.PP
|
|
For \s-1TLS\s0 1.3 the list of \s-1CA\s0 names is sent using the \fBcertificate_authorities\fR
|
|
extension and may be sent by a client (in the ClientHello message) or by
|
|
a server (when requesting a certificate).
|
|
.PP
|
|
In most cases it is not necessary to set \s-1CA\s0 names on the client side. The list
|
|
of \s-1CA\s0 names that are acceptable to the client will be sent in plaintext to the
|
|
server. This has privacy implications and may also have performance implications
|
|
if the list is large. This optional capability was introduced as part of TLSv1.3
|
|
and therefore setting \s-1CA\s0 names on the client side will have no impact if that
|
|
protocol version has been disabled. Most servers do not need this and so this
|
|
should be avoided unless required.
|
|
.PP
|
|
The \*(L"client \s-1CA\s0 list\*(R" functions below only have an effect when called on the
|
|
server side.
|
|
.PP
|
|
\&\fISSL_CTX_set_client_CA_list()\fR sets the \fBlist\fR of CAs sent to the client when
|
|
requesting a client certificate for \fBctx\fR. Ownership of \fBlist\fR is transferred
|
|
to \fBctx\fR and it should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_set_client_CA_list()\fR sets the \fBlist\fR of CAs sent to the client when
|
|
requesting a client certificate for the chosen \fBssl\fR, overriding the
|
|
setting valid for \fBssl\fR's \s-1SSL_CTX\s0 object. Ownership of \fBlist\fR is transferred
|
|
to \fBs\fR and it should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_CTX_get_client_CA_list()\fR returns the list of client CAs explicitly set for
|
|
\&\fBctx\fR using \fISSL_CTX_set_client_CA_list()\fR. The returned list should not be freed
|
|
by the caller.
|
|
.PP
|
|
\&\fISSL_get_client_CA_list()\fR returns the list of client CAs explicitly
|
|
set for \fBssl\fR using \fISSL_set_client_CA_list()\fR or \fBssl\fR's \s-1SSL_CTX\s0 object with
|
|
\&\fISSL_CTX_set_client_CA_list()\fR, when in server mode. In client mode,
|
|
SSL_get_client_CA_list returns the list of client CAs sent from the server, if
|
|
any. The returned list should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_CTX_add_client_CA()\fR adds the \s-1CA\s0 name extracted from \fBcacert\fR to the
|
|
list of CAs sent to the client when requesting a client certificate for
|
|
\&\fBctx\fR.
|
|
.PP
|
|
\&\fISSL_add_client_CA()\fR adds the \s-1CA\s0 name extracted from \fBcacert\fR to the
|
|
list of CAs sent to the client when requesting a client certificate for
|
|
the chosen \fBssl\fR, overriding the setting valid for \fBssl\fR's \s-1SSL_CTX\s0 object.
|
|
.PP
|
|
\&\fISSL_get0_peer_CA_list()\fR retrieves the list of \s-1CA\s0 names (if any) the peer
|
|
has sent. This can be called on either the server or the client side. The
|
|
returned list should not be freed by the caller.
|
|
.PP
|
|
The \*(L"generic \s-1CA\s0 list\*(R" functions below are very similar to the \*(L"client \s-1CA\s0
|
|
list\*(R" functions except that they have an effect on both the server and client
|
|
sides. The lists of \s-1CA\s0 names managed are separate \- so you cannot (for example)
|
|
set \s-1CA\s0 names using the \*(L"client \s-1CA\s0 list\*(R" functions and then get them using the
|
|
\&\*(L"generic \s-1CA\s0 list\*(R" functions. Where a mix of the two types of functions has been
|
|
used on the server side then the \*(L"client \s-1CA\s0 list\*(R" functions take precedence.
|
|
Typically, on the server side, the \*(L"client \s-1CA\s0 list \*(R" functions should be used in
|
|
preference. As noted above in most cases it is not necessary to set \s-1CA\s0 names on
|
|
the client side.
|
|
.PP
|
|
\&\fISSL_CTX_set0_CA_list()\fR sets the list of CAs to be sent to the peer to
|
|
\&\fBname_list\fR. Ownership of \fBname_list\fR is transferred to \fBctx\fR and
|
|
it should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_set0_CA_list()\fR sets the list of CAs to be sent to the peer to \fBname_list\fR
|
|
overriding any list set in the parent \fB\s-1SSL_CTX\s0\fR of \fBs\fR. Ownership of
|
|
\&\fBname_list\fR is transferred to \fBs\fR and it should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_CTX_get0_CA_list()\fR retrieves any previously set list of CAs set for
|
|
\&\fBctx\fR. The returned list should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_get0_CA_list()\fR retrieves any previously set list of CAs set for
|
|
\&\fBs\fR or if none are set the list from the parent \fB\s-1SSL_CTX\s0\fR is retrieved. The
|
|
returned list should not be freed by the caller.
|
|
.PP
|
|
\&\fISSL_CTX_add1_to_CA_list()\fR appends the \s-1CA\s0 subject name extracted from \fBx\fR to the
|
|
list of CAs sent to peer for \fBctx\fR.
|
|
.PP
|
|
\&\fISSL_add1_to_CA_list()\fR appends the \s-1CA\s0 subject name extracted from \fBx\fR to the
|
|
list of CAs sent to the peer for \fBs\fR, overriding the setting in the parent
|
|
\&\fB\s-1SSL_CTX\s0\fR.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
When a \s-1TLS/SSL\s0 server requests a client certificate (see
|
|
\&\fB\f(BISSL_CTX_set_verify\fB\|(3)\fR), it sends a list of CAs, for which it will accept
|
|
certificates, to the client.
|
|
.PP
|
|
This list must explicitly be set using \fISSL_CTX_set_client_CA_list()\fR or
|
|
\&\fISSL_CTX_set0_CA_list()\fR for \fBctx\fR and \fISSL_set_client_CA_list()\fR or
|
|
\&\fISSL_set0_CA_list()\fR for the specific \fBssl\fR. The list specified
|
|
overrides the previous setting. The CAs listed do not become trusted (\fBlist\fR
|
|
only contains the names, not the complete certificates); use
|
|
\&\fISSL_CTX_load_verify_locations\fR\|(3) to additionally load them for verification.
|
|
.PP
|
|
If the list of acceptable CAs is compiled in a file, the
|
|
\&\fISSL_load_client_CA_file\fR\|(3) function can be used to help to import the
|
|
necessary data.
|
|
.PP
|
|
\&\fISSL_CTX_add_client_CA()\fR, \fISSL_CTX_add1_to_CA_list()\fR, \fISSL_add_client_CA()\fR and
|
|
\&\fISSL_add1_to_CA_list()\fR can be used to add additional items the list of CAs. If no
|
|
list was specified before using \fISSL_CTX_set_client_CA_list()\fR,
|
|
\&\fISSL_CTX_set0_CA_list()\fR, \fISSL_set_client_CA_list()\fR or \fISSL_set0_CA_list()\fR, a
|
|
new \s-1CA\s0 list for \fBctx\fR or \fBssl\fR (as appropriate) is opened.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fISSL_CTX_set_client_CA_list()\fR, \fISSL_set_client_CA_list()\fR,
|
|
\&\fISSL_CTX_set_client_CA_list()\fR, \fISSL_set_client_CA_list()\fR, \fISSL_CTX_set0_CA_list()\fR
|
|
and \fISSL_set0_CA_list()\fR do not return a value.
|
|
.PP
|
|
\&\fISSL_CTX_get_client_CA_list()\fR, \fISSL_get_client_CA_list()\fR, \fISSL_CTX_get0_CA_list()\fR
|
|
and \fISSL_get0_CA_list()\fR return a stack of \s-1CA\s0 names or \fB\s-1NULL\s0\fR is no \s-1CA\s0 names are
|
|
set.
|
|
.PP
|
|
\&\fISSL_CTX_add_client_CA()\fR,\fISSL_add_client_CA()\fR, \fISSL_CTX_add1_to_CA_list()\fR and
|
|
\&\fISSL_add1_to_CA_list()\fR return 1 for success and 0 for failure.
|
|
.PP
|
|
\&\fISSL_get0_peer_CA_list()\fR returns a stack of \s-1CA\s0 names sent by the peer or
|
|
\&\fB\s-1NULL\s0\fR or an empty stack if no list was sent.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Scan all certificates in \fBCAfile\fR and list them as acceptable CAs:
|
|
.PP
|
|
.Vb 1
|
|
\& SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(CAfile));
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7),
|
|
\&\fISSL_load_client_CA_file\fR\|(3),
|
|
\&\fISSL_CTX_load_verify_locations\fR\|(3)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|