doc/man3/SSL_CTX_set_client_cert_cb.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_client_cert_cb, SSL_CTX_get_client_cert_cb - handle client certificate callback function
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
  12                                  int (*client_cert_cb)(SSL *ssl, X509 **x509,
  13                                                        EVP_PKEY **pkey));
  14  int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl, X509 **x509,
  15                                                  EVP_PKEY **pkey);
  16
  17 =head1 DESCRIPTION
  18
  19 SSL_CTX_set_client_cert_cb() sets the I<client_cert_cb> callback, that is
  20 called when a client certificate is requested by a server and no certificate
  21 was yet set for the SSL object.
  22
  23 When I<client_cert_cb> is NULL, no callback function is used.
  24
  25 SSL_CTX_get_client_cert_cb() returns a pointer to the currently set callback
  26 function.
  27
  28 I<client_cert_cb> is the application defined callback. If it wants to
  29 set a certificate, a certificate/private key combination must be set
  30 using the I<x509> and I<pkey> arguments and "1" must be returned. The
  31 certificate will be installed into I<ssl>, see the NOTES and BUGS sections.
  32 If no certificate should be set, "0" has to be returned and no certificate
  33 will be sent. A negative return value will suspend the handshake and the
  34 handshake function will return immediately. L<SSL_get_error(3)>
  35 will return SSL_ERROR_WANT_X509_LOOKUP to indicate, that the handshake was
  36 suspended. The next call to the handshake function will again lead to the call
  37 of I<client_cert_cb>. It is the job of the I<client_cert_cb> to store information
  38 about the state of the last call, if required to continue.
  39
  40 =head1 NOTES
  41
  42 During a handshake (or renegotiation) a server may request a certificate
  43 from the client. A client certificate must only be sent, when the server
  44 did send the request.
  45
  46 When a certificate was set using the
  47 L<SSL_CTX_use_certificate(3)> family of functions,
  48 it will be sent to the server. The TLS standard requires that only a
  49 certificate is sent, if it matches the list of acceptable CAs sent by the
  50 server. This constraint is violated by the default behavior of the OpenSSL
  51 library. Using the callback function it is possible to implement a proper
  52 selection routine or to allow a user interaction to choose the certificate to
  53 be sent.
  54
  55 If a callback function is defined and no certificate was yet defined for the
  56 SSL object, the callback function will be called.
  57 If the callback function returns a certificate, the OpenSSL library
  58 will try to load the private key and certificate data into the SSL
  59 object using the SSL_use_certificate() and SSL_use_private_key() functions.
  60 Thus it will permanently install the certificate and key for this SSL
  61 object. It will not be reset by calling L<SSL_clear(3)>.
  62 If the callback returns no certificate, the OpenSSL library will not send
  63 a certificate.
  64
  65 =head1 RETURN VALUES
  66
  67 SSL_CTX_get_client_cert_cb() returns function pointer of I<client_cert_cb> or
  68 NULL if the callback is not set.
  69
  70 =head1 BUGS
  71
  72 The I<client_cert_cb> cannot return a complete certificate chain, it can
  73 only return one client certificate. If the chain only has a length of 2,
  74 the root CA certificate may be omitted according to the TLS standard and
  75 thus a standard conforming answer can be sent to the server. For a
  76 longer chain, the client must send the complete chain (with the option
  77 to leave out the root CA certificate). This can only be accomplished by
  78 either adding the intermediate CA certificates into the trusted
  79 certificate store for the SSL_CTX object (resulting in having to add
  80 CA certificates that otherwise maybe would not be trusted), or by adding
  81 the chain certificates using the
  82 L<SSL_CTX_add_extra_chain_cert(3)>
  83 function, which is only available for the SSL_CTX object as a whole and that
  84 therefore probably can only apply for one client certificate, making
  85 the concept of the callback function (to allow the choice from several
  86 certificates) questionable.
  87
  88 Once the SSL object has been used in conjunction with the callback function,
  89 the certificate will be set for the SSL object and will not be cleared
  90 even when L<SSL_clear(3)> is being called. It is therefore
  91 mandatory to destroy the SSL object using L<SSL_free(3)>
  92 and create a new one to return to the previous state.
  93
  94 =head1 SEE ALSO
  95
  96 L<ssl(7)>, L<SSL_CTX_use_certificate(3)>,
  97 L<SSL_CTX_add_extra_chain_cert(3)>,
  98 L<SSL_get_client_CA_list(3)>,
  99 L<SSL_clear(3)>, L<SSL_free(3)>
 100
 101 =head1 COPYRIGHT
 102
 103 Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
 104
 105 Licensed under the Apache License 2.0 (the "License").  You may not use
 106 this file except in compliance with the License.  You can obtain a copy
 107 in the file LICENSE in the source distribution or at
 108 L<https://www.openssl.org/source/license.html>.
 109
 110 =cut