53899c2ef4a25827a13cc20a39f39c0a08a6e415
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_client_cert_cb.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "SSL_CTX_set_client_cert_cb 3"
136 .TH SSL_CTX_set_client_cert_cb 3 "2015-03-19" "1.0.1m" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 SSL_CTX_set_client_cert_cb, SSL_CTX_get_client_cert_cb \- handle client certificate callback function
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/ssl.h>
147 \&
148 \& void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx, int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
149 \& int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
150 \& int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
151 .Ve
152 .SH "DESCRIPTION"
153 .IX Header "DESCRIPTION"
154 \&\fISSL_CTX_set_client_cert_cb()\fR sets the \fB\f(BIclient_cert_cb()\fB\fR callback, that is
155 called when a client certificate is requested by a server and no certificate
156 was yet set for the \s-1SSL\s0 object.
157 .PP
158 When \fB\f(BIclient_cert_cb()\fB\fR is \s-1NULL,\s0 no callback function is used.
159 .PP
160 \&\fISSL_CTX_get_client_cert_cb()\fR returns a pointer to the currently set callback
161 function.
162 .PP
163 \&\fIclient_cert_cb()\fR is the application defined callback. If it wants to
164 set a certificate, a certificate/private key combination must be set
165 using the \fBx509\fR and \fBpkey\fR arguments and \*(L"1\*(R" must be returned. The
166 certificate will be installed into \fBssl\fR, see the \s-1NOTES\s0 and \s-1BUGS\s0 sections.
167 If no certificate should be set, \*(L"0\*(R" has to be returned and no certificate
168 will be sent. A negative return value will suspend the handshake and the
169 handshake function will return immediately. \fISSL_get_error\fR\|(3)
170 will return \s-1SSL_ERROR_WANT_X509_LOOKUP\s0 to indicate, that the handshake was
171 suspended. The next call to the handshake function will again lead to the call
172 of \fIclient_cert_cb()\fR. It is the job of the \fIclient_cert_cb()\fR to store information
173 about the state of the last call, if required to continue.
174 .SH "NOTES"
175 .IX Header "NOTES"
176 During a handshake (or renegotiation) a server may request a certificate
177 from the client. A client certificate must only be sent, when the server
178 did send the request.
179 .PP
180 When a certificate was set using the
181 \&\fISSL_CTX_use_certificate\fR\|(3) family of functions,
182 it will be sent to the server. The \s-1TLS\s0 standard requires that only a
183 certificate is sent, if it matches the list of acceptable CAs sent by the
184 server. This constraint is violated by the default behavior of the OpenSSL
185 library. Using the callback function it is possible to implement a proper
186 selection routine or to allow a user interaction to choose the certificate to
187 be sent.
188 .PP
189 If a callback function is defined and no certificate was yet defined for the
190 \&\s-1SSL\s0 object, the callback function will be called.
191 If the callback function returns a certificate, the OpenSSL library
192 will try to load the private key and certificate data into the \s-1SSL\s0
193 object using the \fISSL_use_certificate()\fR and \fISSL_use_private_key()\fR functions.
194 Thus it will permanently install the certificate and key for this \s-1SSL\s0
195 object. It will not be reset by calling \fISSL_clear\fR\|(3).
196 If the callback returns no certificate, the OpenSSL library will not send
197 a certificate.
198 .SH "BUGS"
199 .IX Header "BUGS"
200 The \fIclient_cert_cb()\fR cannot return a complete certificate chain, it can
201 only return one client certificate. If the chain only has a length of 2,
202 the root \s-1CA\s0 certificate may be omitted according to the \s-1TLS\s0 standard and
203 thus a standard conforming answer can be sent to the server. For a
204 longer chain, the client must send the complete chain (with the option
205 to leave out the root \s-1CA\s0 certificate). This can only be accomplished by
206 either adding the intermediate \s-1CA\s0 certificates into the trusted
207 certificate store for the \s-1SSL_CTX\s0 object (resulting in having to add
208 \&\s-1CA\s0 certificates that otherwise maybe would not be trusted), or by adding
209 the chain certificates using the
210 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3)
211 function, which is only available for the \s-1SSL_CTX\s0 object as a whole and that
212 therefore probably can only apply for one client certificate, making
213 the concept of the callback function (to allow the choice from several
214 certificates) questionable.
215 .PP
216 Once the \s-1SSL\s0 object has been used in conjunction with the callback function,
217 the certificate will be set for the \s-1SSL\s0 object and will not be cleared
218 even when \fISSL_clear\fR\|(3) is being called. It is therefore
219 mandatory to destroy the \s-1SSL\s0 object using \fISSL_free\fR\|(3)
220 and create a new one to return to the previous state.
221 .SH "SEE ALSO"
222 .IX Header "SEE ALSO"
223 \&\fIssl\fR\|(3), \fISSL_CTX_use_certificate\fR\|(3),
224 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
225 \&\fISSL_get_client_CA_list\fR\|(3),
226 \&\fISSL_clear\fR\|(3), \fISSL_free\fR\|(3)