doc/ssl/SSL_CTX_set_tlsext_status_cb.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_tlsext_status_cb,
   6 SSL_CTX_set_tlsext_status_arg,
   7 SSL_CTX_set_tlsext_status_type,
   8 SSL_CTX_get_tlsext_status_type,
   9 SSL_set_tlsext_status_type,
  10 SSL_get_tlsext_status_type,
  11 SSL_get_tlsext_status_ocsp_resp,
  12 SSL_set_tlsext_status_ocsp_resp
  13 - OCSP Certificate Status Request functions
  14
  15 =head1 SYNOPSIS
  16
  17  #include <openssl/tls1.h>
  18
  19  long SSL_CTX_set_tlsext_status_cb(SSL_CTX *ctx,
  20                                    int (*callback)(SSL *, void *));
  21  long SSL_CTX_set_tlsext_status_arg(SSL_CTX *ctx, void *arg);
  22
  23  long SSL_CTX_set_tlsext_status_type(SSL_CTX *ctx, int type);
  24  long SSL_CTX_get_tlsext_status_type(SSL_CTX *ctx);
  25
  26  long SSL_set_tlsext_status_type(SSL *s, int type);
  27  long SSL_get_tlsext_status_type(SSL *s);
  28
  29  long SSL_get_tlsext_status_ocsp_resp(ssl, unsigned char **resp);
  30  long SSL_set_tlsext_status_ocsp_resp(ssl, unsigned char *resp, int len);
  31
  32 =head1 DESCRIPTION
  33
  34 A client application may request that a server send back an OCSP status response
  35 (also known as OCSP stapling). To do so the client should call the
  36 SSL_CTX_set_tlsext_status_type() function prior to the creation of any SSL
  37 objects. Alternatively an application can call the SSL_set_tlsext_status_type()
  38 function on an individual SSL object prior to the start of the handshake.
  39 Currently the only supported type is B<TLSEXT_STATUSTYPE_ocsp>. This value
  40 should be passed in the B<type> argument. Calling
  41 SSL_CTX_get_tlsext_status_type() will return the type B<TLSEXT_STATUSTYPE_ocsp>
  42 previously set via SSL_CTX_set_tlsext_status_type() or -1 if not set.
  43
  44 The client should additionally provide a callback function to decide what to do
  45 with the returned OCSP response by calling SSL_CTX_set_tlsext_status_cb(). The
  46 callback function should determine whether the returned OCSP response is
  47 acceptable or not. The callback will be passed as an argument the value
  48 previously set via a call to SSL_CTX_set_tlsext_status_arg(). Note that the
  49 callback will not be called in the event of a handshake where session resumption
  50 occurs (because there are no Certificates exchanged in such a handshake).
  51
  52 On the client side SSL_get_tlsext_status_type() can be used to determine whether
  53 the client has previously called SSL_set_tlsext_status_type(). It will return
  54 B<TLSEXT_STATUSTYPE_ocsp> if it has been called or -1 otherwise. On the server
  55 side SSL_get_tlsext_status_type() can be used to determine whether the client
  56 requested OCSP stapling. If the client requested it then this function will
  57 return B<TLSEXT_STATUSTYPE_ocsp>, or -1 otherwise.
  58
  59 The response returned by the server can be obtained via a call to
  60 SSL_get_tlsext_status_ocsp_resp(). The value B<*resp> will be updated to point
  61 to the OCSP response data and the return value will be the length of that data.
  62 Typically a callback would obtain an OCSP_RESPONSE object from this data via a
  63 call to the d2i_OCSP_RESPONSE() function. If the server has not provided any
  64 response data then B<*resp> will be NULL and the return value from
  65 SSL_get_tlsext_status_ocsp_resp() will be -1.
  66
  67 A server application must also call the SSL_CTX_set_tlsext_status_cb() function
  68 if it wants to be able to provide clients with OCSP Certificate Status
  69 responses. Typically the server callback would obtain the server certificate
  70 that is being sent back to the client via a call to SSL_get_certificate();
  71 obtain the OCSP response to be sent back; and then set that response data by
  72 calling SSL_set_tlsext_status_ocsp_resp(). A pointer to the response data should
  73 be provided in the B<resp> argument, and the length of that data should be in
  74 the B<len> argument.
  75
  76 =head1 RETURN VALUES
  77
  78 The callback when used on the client side should return a negative value on
  79 error; 0 if the response is not acceptable (in which case the handshake will
  80 fail) or a positive value if it is acceptable.
  81
  82 The callback when used on the server side should return with either
  83 SSL_TLSEXT_ERR_OK (meaning that the OCSP response that has been set should be
  84 returned), SSL_TLSEXT_ERR_NOACK (meaning that an OCSP response should not be
  85 returned) or SSL_TLSEXT_ERR_ALERT_FATAL (meaning that a fatal error has
  86 occurred).
  87
  88 SSL_CTX_set_tlsext_status_cb(), SSL_CTX_set_tlsext_status_arg(),
  89 SSL_CTX_set_tlsext_status_type(), SSL_set_tlsext_status_type() and
  90 SSL_set_tlsext_status_ocsp_resp() return 0 on error or 1 on success.
  91
  92 SSL_CTX_get_tlsext_status_type() returns the value previously set by
  93 SSL_CTX_set_tlsext_status_type(), or -1 if not set.
  94
  95 SSL_get_tlsext_status_ocsp_resp() returns the length of the OCSP response data
  96 or -1 if there is no OCSP response data.
  97
  98 SSL_get_tlsext_status_type() returns B<TLSEXT_STATUSTYPE_ocsp> on the client
  99 side if SSL_set_tlsext_status_type() was previously called, or on the server
 100 side if the client requested OCSP stapling. Otherwise -1 is returned.
 101
 102 =head1 HISTORY
 103
 104 SSL_get_tlsext_status_type(), SSL_CTX_get_tlsext_status_type() and
 105 SSL_CTX_set_tlsext_status_type() were added in OpenSSL 1.1.0.
 106
 107 =head1 COPYRIGHT
 108
 109 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
 110
 111 Licensed under the OpenSSL license (the "License").  You may not use
 112 this file except in compliance with the License.  You can obtain a copy
 113 in the file LICENSE in the source distribution or at
 114 L<https://www.openssl.org/source/license.html>.
 115
 116 =cut