secure/lib/libssl/man/SSL_CTX_set_client_cert_cb.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_cert_cb 3"
 135 .TH SSL_CTX_set_client_cert_cb 3 "2010-02-27" "0.9.8m" "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_cert_cb, SSL_CTX_get_client_cert_cb \- handle client certificate callback function
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 1
 145 \& #include <openssl/ssl.h>
 146 \&
 147 \& void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx, int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
 148 \& int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl, X509 **x509, 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 \fB\f(BIclient_cert_cb()\fB\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 \fB\f(BIclient_cert_cb()\fB\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 immediatly. \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 "BUGS"
 198 .IX Header "BUGS"
 199 The \fIclient_cert_cb()\fR cannot return a complete certificate chain, it can
 200 only return one client certificate. If the chain only has a length of 2,
 201 the root \s-1CA\s0 certificate may be omitted according to the \s-1TLS\s0 standard and
 202 thus a standard conforming answer can be sent to the server. For a
 203 longer chain, the client must send the complete chain (with the option
 204 to leave out the root \s-1CA\s0 certificate). This can only be accomplished by
 205 either adding the intermediate \s-1CA\s0 certificates into the trusted
 206 certificate store for the \s-1SSL_CTX\s0 object (resulting in having to add
 207 \&\s-1CA\s0 certificates that otherwise maybe would not be trusted), or by adding
 208 the chain certificates using the
 209 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3)
 210 function, which is only available for the \s-1SSL_CTX\s0 object as a whole and that
 211 therefore probably can only apply for one client certificate, making
 212 the concept of the callback function (to allow the choice from several
 213 certificates) questionable.
 214 .PP
 215 Once the \s-1SSL\s0 object has been used in conjunction with the callback function,
 216 the certificate will be set for the \s-1SSL\s0 object and will not be cleared
 217 even when \fISSL_clear\fR\|(3) is being called. It is therefore
 218 mandatory to destroy the \s-1SSL\s0 object using \fISSL_free\fR\|(3)
 219 and create a new one to return to the previous state.
 220 .SH "SEE ALSO"
 221 .IX Header "SEE ALSO"
 222 \&\fIssl\fR\|(3), \fISSL_CTX_use_certificate\fR\|(3),
 223 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3),
 224 \&\fISSL_get_client_CA_list\fR\|(3),
 225 \&\fISSL_clear\fR\|(3), \fISSL_free\fR\|(3)