250 lines
9.8 KiB
Groff
Executable File
250 lines
9.8 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "SSL_CTX_SET_TLSEXT_STATUS_CB 3"
|
|
.TH SSL_CTX_SET_TLSEXT_STATUS_CB 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
SSL_CTX_set_tlsext_status_cb,
|
|
SSL_CTX_get_tlsext_status_cb,
|
|
SSL_CTX_set_tlsext_status_arg,
|
|
SSL_CTX_get_tlsext_status_arg,
|
|
SSL_CTX_set_tlsext_status_type,
|
|
SSL_CTX_get_tlsext_status_type,
|
|
SSL_set_tlsext_status_type,
|
|
SSL_get_tlsext_status_type,
|
|
SSL_get_tlsext_status_ocsp_resp,
|
|
SSL_set_tlsext_status_ocsp_resp
|
|
\&\- OCSP Certificate Status Request functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/tls1.h>
|
|
\&
|
|
\& long SSL_CTX_set_tlsext_status_cb(SSL_CTX *ctx, int (*callback)(SSL *, void *));
|
|
\& long SSL_CTX_get_tlsext_status_cb(SSL_CTX *ctx, int (**callback)(SSL *, void *));
|
|
\&
|
|
\& long SSL_CTX_set_tlsext_status_arg(SSL_CTX *ctx, void *arg);
|
|
\& long SSL_CTX_get_tlsext_status_arg(SSL_CTX *ctx, void **arg);
|
|
\&
|
|
\& long SSL_CTX_set_tlsext_status_type(SSL_CTX *ctx, int type);
|
|
\& long SSL_CTX_get_tlsext_status_type(SSL_CTX *ctx);
|
|
\&
|
|
\& long SSL_set_tlsext_status_type(SSL *s, int type);
|
|
\& long SSL_get_tlsext_status_type(SSL *s);
|
|
\&
|
|
\& long SSL_get_tlsext_status_ocsp_resp(ssl, unsigned char **resp);
|
|
\& long SSL_set_tlsext_status_ocsp_resp(ssl, unsigned char *resp, int len);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
A client application may request that a server send back an \s-1OCSP\s0 status response
|
|
(also known as \s-1OCSP\s0 stapling). To do so the client should call the
|
|
\&\fISSL_CTX_set_tlsext_status_type()\fR function prior to the creation of any \s-1SSL\s0
|
|
objects. Alternatively an application can call the \fISSL_set_tlsext_status_type()\fR
|
|
function on an individual \s-1SSL\s0 object prior to the start of the handshake.
|
|
Currently the only supported type is \fBTLSEXT_STATUSTYPE_ocsp\fR. This value
|
|
should be passed in the \fBtype\fR argument. Calling
|
|
\&\fISSL_CTX_get_tlsext_status_type()\fR will return the type \fBTLSEXT_STATUSTYPE_ocsp\fR
|
|
previously set via \fISSL_CTX_set_tlsext_status_type()\fR or \-1 if not set.
|
|
.PP
|
|
The client should additionally provide a callback function to decide what to do
|
|
with the returned \s-1OCSP\s0 response by calling \fISSL_CTX_set_tlsext_status_cb()\fR. The
|
|
callback function should determine whether the returned \s-1OCSP\s0 response is
|
|
acceptable or not. The callback will be passed as an argument the value
|
|
previously set via a call to \fISSL_CTX_set_tlsext_status_arg()\fR. Note that the
|
|
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 callback previously set via \fISSL_CTX_set_tlsext_status_cb()\fR can be retrieved
|
|
by calling \fISSL_CTX_get_tlsext_status_cb()\fR, and the argument by calling
|
|
\&\fISSL_CTX_get_tlsext_status_arg()\fR.
|
|
.PP
|
|
On the client side \fISSL_get_tlsext_status_type()\fR can be used to determine whether
|
|
the client has previously called \fISSL_set_tlsext_status_type()\fR. It will return
|
|
\&\fBTLSEXT_STATUSTYPE_ocsp\fR if it has been called or \-1 otherwise. On the server
|
|
side \fISSL_get_tlsext_status_type()\fR can be used to determine whether the client
|
|
requested \s-1OCSP\s0 stapling. If the client requested it then this function will
|
|
return \fBTLSEXT_STATUSTYPE_ocsp\fR, or \-1 otherwise.
|
|
.PP
|
|
The response returned by the server can be obtained via a call to
|
|
\&\fISSL_get_tlsext_status_ocsp_resp()\fR. The value \fB*resp\fR will be updated to point
|
|
to the \s-1OCSP\s0 response data and the return value will be the length of that data.
|
|
Typically a callback would obtain an \s-1OCSP_RESPONSE\s0 object from this data via a
|
|
call to the \fId2i_OCSP_RESPONSE()\fR function. If the server has not provided any
|
|
response data then \fB*resp\fR will be \s-1NULL\s0 and the return value from
|
|
\&\fISSL_get_tlsext_status_ocsp_resp()\fR will be \-1.
|
|
.PP
|
|
A server application must also call the \fISSL_CTX_set_tlsext_status_cb()\fR function
|
|
if it wants to be able to provide clients with \s-1OCSP\s0 Certificate Status
|
|
responses. Typically the server callback would obtain the server certificate
|
|
that is being sent back to the client via a call to \fISSL_get_certificate()\fR;
|
|
obtain the \s-1OCSP\s0 response to be sent back; and then set that response data by
|
|
calling \fISSL_set_tlsext_status_ocsp_resp()\fR. A pointer to the response data should
|
|
be provided in the \fBresp\fR argument, and the length of that data should be in
|
|
the \fBlen\fR argument.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
The callback when used on the client side should return a negative value on
|
|
error; 0 if the response is not acceptable (in which case the handshake will
|
|
fail) or a positive value if it is acceptable.
|
|
.PP
|
|
The callback when used on the server side should return with either
|
|
\&\s-1SSL_TLSEXT_ERR_OK\s0 (meaning that the \s-1OCSP\s0 response that has been set should be
|
|
returned), \s-1SSL_TLSEXT_ERR_NOACK\s0 (meaning that an \s-1OCSP\s0 response should not be
|
|
returned) or \s-1SSL_TLSEXT_ERR_ALERT_FATAL\s0 (meaning that a fatal error has
|
|
occurred).
|
|
.PP
|
|
\&\fISSL_CTX_set_tlsext_status_cb()\fR, \fISSL_CTX_set_tlsext_status_arg()\fR,
|
|
\&\fISSL_CTX_set_tlsext_status_type()\fR, \fISSL_set_tlsext_status_type()\fR and
|
|
\&\fISSL_set_tlsext_status_ocsp_resp()\fR return 0 on error or 1 on success.
|
|
.PP
|
|
\&\fISSL_CTX_get_tlsext_status_type()\fR returns the value previously set by
|
|
\&\fISSL_CTX_set_tlsext_status_type()\fR, or \-1 if not set.
|
|
.PP
|
|
\&\fISSL_get_tlsext_status_ocsp_resp()\fR returns the length of the \s-1OCSP\s0 response data
|
|
or \-1 if there is no \s-1OCSP\s0 response data.
|
|
.PP
|
|
\&\fISSL_get_tlsext_status_type()\fR returns \fBTLSEXT_STATUSTYPE_ocsp\fR on the client
|
|
side if \fISSL_set_tlsext_status_type()\fR was previously called, or on the server
|
|
side if the client requested \s-1OCSP\s0 stapling. Otherwise \-1 is returned.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fISSL_get_tlsext_status_type()\fR, \fISSL_CTX_get_tlsext_status_type()\fR
|
|
and \fISSL_CTX_set_tlsext_status_type()\fR functions were added in OpenSSL 1.1.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|