QuasarApp/openssl
4
0
Fork 0
mirror of https://github.com/QuasarApp/openssl.git synced 2025-05-14 18:39:40 +00:00
Code Issues Projects Releases Wiki Activity

Add some documentation of SSL_CTX_set_tlsext_status_type()

Browse Source 
The previous commit added SSL_CTX_set_tlsext_status_type(). This one adds
some documentation for it.

Reviewed-by: Rich Salz <rsalz@openssl.org>
This commit is contained in:
Matt Caswell 2016-05-06 10:19:35 +01:00
parent ba261f718b
commit c408b80c50
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/ssl/SSL_CTX_set_tlsext_status_cb.pod
View File

@ -3,8 +3,9 @@
=head1 NAME =head1 NAME
SSL_CTX_set_tlsext_status_cb, SSL_CTX_set_tlsext_status_arg, SSL_CTX_set_tlsext_status_cb, SSL_CTX_set_tlsext_status_arg,
SSL_set_tlsext_status_type, SSL_get_tlsext_status_ocsp_resp, SSL_CTX_set_tlsext_status_type, SSL_set_tlsext_status_type,
SSL_set_tlsext_status_ocsp_resp - OCSP Certificate Status Request functions SSL_get_tlsext_status_ocsp_resp, SSL_set_tlsext_status_ocsp_resp - OCSP
Certificate Status Request functions
=head1 SYNOPSIS =head1 SYNOPSIS
@ -14,6 +15,8 @@ SSL_set_tlsext_status_ocsp_resp - OCSP Certificate Status Request functions
int (*callback)(SSL *, void *)); int (*callback)(SSL *, void *));
long SSL_CTX_set_tlsext_status_arg(SSL_CTX *ctx, void *arg); long SSL_CTX_set_tlsext_status_arg(SSL_CTX *ctx, void *arg);
long SSL_CTX_set_tlsext_status_type(SSL_CTX *ctx, int type);
long SSL_set_tlsext_status_type(SSL *s, int type); long SSL_set_tlsext_status_type(SSL *s, int type);
long SSL_get_tlsext_status_ocsp_resp(ssl, unsigned char **resp); long SSL_get_tlsext_status_ocsp_resp(ssl, unsigned char **resp);
@ -23,16 +26,19 @@ SSL_set_tlsext_status_ocsp_resp - OCSP Certificate Status Request functions
A client application may request that a server send back an OCSP status response A client application may request that a server send back an OCSP status response
(also known as OCSP stapling). To do so the client should call the (also known as OCSP stapling). To do so the client should call the
SSL_set_tlsext_status_type() function prior to the start of the handshake. SSL_CTX_set_tlsext_status_type() function prior to the creation of any SSL
objects. Alternatively an application can call the SSL_set_tlsext_status_type()
function on an individual SSL object prior to the start of the handshake.
Currently the only supported type is B<TLSEXT_STATUSTYPE_ocsp>. This value Currently the only supported type is B<TLSEXT_STATUSTYPE_ocsp>. This value
should be passed in the B<type> argument. The client should additionally provide should be passed in the B<type> argument.
a callback function to decide what to do with the returned OCSP response by
calling SSL_CTX_set_tlsext_status_cb(). The callback function should determine The client should additionally provide a callback function to decide what to do
whether the returned OCSP response is acceptable or not. The callback will be with the returned OCSP response by calling SSL_CTX_set_tlsext_status_cb(). The
passed as an argument the value previously set via a call to callback function should determine whether the returned OCSP response is
SSL_CTX_set_tlsext_status_arg(). Note that the callback will not be called in acceptable or not. The callback will be passed as an argument the value
the event of a handshake where session resumption occurs (because there are no previously set via a call to SSL_CTX_set_tlsext_status_arg(). Note that the
Certificates exchanged in such a handshake). callback will not be called in the event of a handshake where session resumption
occurs (because there are no Certificates exchanged in such a handshake).
The response returned by the server can be obtained via a call to The response returned by the server can be obtained via a call to
SSL_get_tlsext_status_ocsp_resp(). The value B<*resp> will be updated to point SSL_get_tlsext_status_ocsp_resp(). The value B<*resp> will be updated to point
@ -64,10 +70,14 @@ returned) or SSL_TLSEXT_ERR_ALERT_FATAL (meaning that a fatal error has
occurred). occurred).
SSL_CTX_set_tlsext_status_cb(), SSL_CTX_set_tlsext_status_arg(), SSL_CTX_set_tlsext_status_cb(), SSL_CTX_set_tlsext_status_arg(),
SSL_set_tlsext_status_type() and SSL_set_tlsext_status_ocsp_resp() return 0 on SSL_CTX_set_tlsext_status_type(), SSL_set_tlsext_status_type() and
error or 1 on success. SSL_set_tlsext_status_ocsp_resp() return 0 on error or 1 on success.
SSL_get_tlsext_status_ocsp_resp() returns the length of the OCSP response data SSL_get_tlsext_status_ocsp_resp() returns the length of the OCSP response data
or -1 if there is no OCSP response data. or -1 if there is no OCSP response data.
=head1 HISTORY
SSL_CTX_set_tlsext_status_type() was added in OpenSSL 1.1.0.
=cut =cut