secure/lib/libcrypto/man/SSL_CTX_set_client_cert_cb.3

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