Update files for OpenSSL-1.0.1b import.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_client_CA_list.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "SSL_CTX_set_client_CA_list 3"
127 .TH SSL_CTX_set_client_CA_list 3 "2012-04-26" "1.0.1b" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 SSL_CTX_set_client_CA_list, SSL_set_client_CA_list, SSL_CTX_add_client_CA,
134 SSL_add_client_CA \- set list of CAs sent to the client when requesting a
135 client certificate
136 .SH "SYNOPSIS"
137 .IX Header "SYNOPSIS"
138 .Vb 1
139 \& #include <openssl/ssl.h>
140 \& 
141 \& void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *list);
142 \& void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *list);
143 \& int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *cacert);
144 \& int SSL_add_client_CA(SSL *ssl, X509 *cacert);
145 .Ve
146 .SH "DESCRIPTION"
147 .IX Header "DESCRIPTION"
148 \&\fISSL_CTX_set_client_CA_list()\fR sets the \fBlist\fR of CAs sent to the client when
149 requesting a client certificate for \fBctx\fR.
150 .PP
151 \&\fISSL_set_client_CA_list()\fR sets the \fBlist\fR of CAs sent to the client when
152 requesting a client certificate for the chosen \fBssl\fR, overriding the
153 setting valid for \fBssl\fR's \s-1SSL_CTX\s0 object.
154 .PP
155 \&\fISSL_CTX_add_client_CA()\fR adds the \s-1CA\s0 name extracted from \fBcacert\fR to the
156 list of CAs sent to the client when requesting a client certificate for
157 \&\fBctx\fR.
158 .PP
159 \&\fISSL_add_client_CA()\fR adds the \s-1CA\s0 name extracted from \fBcacert\fR to the
160 list of CAs sent to the client when requesting a client certificate for
161 the chosen \fBssl\fR, overriding the setting valid for \fBssl\fR's \s-1SSL_CTX\s0 object.
162 .SH "NOTES"
163 .IX Header "NOTES"
164 When a \s-1TLS/SSL\s0 server requests a client certificate (see
165 \&\fB\f(BISSL_CTX_set_verify_options()\fB\fR), it sends a list of CAs, for which
166 it will accept certificates, to the client.
167 .PP
168 This list must explicitly be set using \fISSL_CTX_set_client_CA_list()\fR for
169 \&\fBctx\fR and \fISSL_set_client_CA_list()\fR for the specific \fBssl\fR. The list
170 specified overrides the previous setting. The CAs listed do not become
171 trusted (\fBlist\fR only contains the names, not the complete certificates); use
172 \&\fISSL_CTX_load_verify_locations\fR\|(3) 
173 to additionally load them for verification.
174 .PP
175 If the list of acceptable CAs is compiled in a file, the
176 \&\fISSL_load_client_CA_file\fR\|(3)
177 function can be used to help importing the necessary data.
178 .PP
179 \&\fISSL_CTX_add_client_CA()\fR and \fISSL_add_client_CA()\fR can be used to add additional
180 items the list of client CAs. If no list was specified before using
181 \&\fISSL_CTX_set_client_CA_list()\fR or \fISSL_set_client_CA_list()\fR, a new client
182 \&\s-1CA\s0 list for \fBctx\fR or \fBssl\fR (as appropriate) is opened.
183 .PP
184 These functions are only useful for \s-1TLS/SSL\s0 servers.
185 .SH "RETURN VALUES"
186 .IX Header "RETURN VALUES"
187 \&\fISSL_CTX_set_client_CA_list()\fR and \fISSL_set_client_CA_list()\fR do not return
188 diagnostic information.
189 .PP
190 \&\fISSL_CTX_add_client_CA()\fR and \fISSL_add_client_CA()\fR have the following return
191 values:
192 .IP "1." 4
193 The operation succeeded.
194 .IP "2." 4
195 A failure while manipulating the \s-1STACK_OF\s0(X509_NAME) object occurred or
196 the X509_NAME could not be extracted from \fBcacert\fR. Check the error stack
197 to find out the reason.
198 .SH "EXAMPLES"
199 .IX Header "EXAMPLES"
200 Scan all certificates in \fBCAfile\fR and list them as acceptable CAs:
201 .PP
202 .Vb 1
203 \&  SSL_CTX_set_client_CA_list(ctx,SSL_load_client_CA_file(CAfile));
204 .Ve
205 .SH "SEE ALSO"
206 .IX Header "SEE ALSO"
207 \&\fIssl\fR\|(3),
208 \&\fISSL_get_client_CA_list\fR\|(3),
209 \&\fISSL_load_client_CA_file\fR\|(3),
210 \&\fISSL_CTX_load_verify_locations\fR\|(3)
211 .SH "POD ERRORS"
212 .IX Header "POD ERRORS"
213 Hey! \fBThe above document had some coding errors, which are explained below:\fR
214 .IP "Around line 73:" 4
215 .IX Item "Around line 73:"
216 You have '=item 0' instead of the expected '=item 2'