secure/lib/libssl/man/SSL_CTX_set_client_CA_list.3

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