226 lines
8.3 KiB
Plaintext
226 lines
8.3 KiB
Plaintext
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
|
.\"
|
|
.\" 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" ''
|
|
. ds C`
|
|
. ds C'
|
|
'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.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==0)) \{
|
|
. if \nF \{
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
. \}
|
|
.\}
|
|
.rr rF
|
|
.\"
|
|
.\" 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_HANDLE_EVENTS 3ossl"
|
|
.TH SSL_HANDLE_EVENTS 3ossl "2024-01-30" "3.2.1" "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_handle_events \- advance asynchronous state machine and perform network I/O
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& int SSL_handle_events(SSL *ssl);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fISSL_handle_events()\fR performs any internal processing which is due on a \s-1SSL\s0 object. The
|
|
exact operations performed by \fISSL_handle_events()\fR vary depending on what kind of protocol
|
|
is being used with the given \s-1SSL\s0 object. For example, \fISSL_handle_events()\fR may handle
|
|
timeout events which have become due, or may attempt, to the extent currently
|
|
possible, to perform network I/O operations on one of the BIOs underlying the
|
|
\&\s-1SSL\s0 object.
|
|
.PP
|
|
The primary use case for \fISSL_handle_events()\fR is to allow an application which uses
|
|
OpenSSL in nonblocking mode to give OpenSSL an opportunity to handle timer
|
|
events, or to respond to the availability of new data to be read from an
|
|
underlying \s-1BIO,\s0 or to respond to the opportunity to write pending data to an
|
|
underlying \s-1BIO.\s0
|
|
.PP
|
|
\&\fISSL_handle_events()\fR can be used only with the following types of \s-1SSL\s0 object:
|
|
.IP "\s-1DTLS SSL\s0 objects" 4
|
|
.IX Item "DTLS SSL objects"
|
|
Using \fISSL_handle_events()\fR on an \s-1SSL\s0 object being used with a \s-1DTLS\s0 method allows timeout
|
|
events to be handled properly. This is equivalent to a call to
|
|
\&\fIDTLSv1_handle_timeout\fR\|(3). Since \fISSL_handle_events()\fR handles a superset of the use
|
|
cases of \fIDTLSv1_handle_timeout\fR\|(3), it should be preferred for new
|
|
applications which do not require support for OpenSSL 3.1 or older.
|
|
.Sp
|
|
When using \s-1DTLS,\s0 an application must call \fISSL_handle_events()\fR as indicated by
|
|
calls to \fISSL_get_event_timeout\fR\|(3); event handling is not performed
|
|
automatically by calls to other \s-1SSL\s0 functions such as \fISSL_read\fR\|(3) or
|
|
\&\fISSL_write\fR\|(3). Note that this is different to \s-1QUIC\s0 which also performs event
|
|
handling implicitly; see below.
|
|
.IP "\s-1QUIC\s0 connection \s-1SSL\s0 objects" 4
|
|
.IX Item "QUIC connection SSL objects"
|
|
Using \fISSL_handle_events()\fR on an \s-1SSL\s0 object which represents a \s-1QUIC\s0 connection allows
|
|
timeout events to be handled properly, as well as incoming network data to be
|
|
processed, and queued outgoing network data to be written, if the underlying \s-1BIO\s0
|
|
has the capacity to accept it.
|
|
.Sp
|
|
Ordinarily, when an application uses an \s-1SSL\s0 object in blocking mode, it does not
|
|
need to call \fISSL_handle_events()\fR because OpenSSL performs ticking internally on an
|
|
automatic basis. However, if an application uses a \s-1QUIC\s0 connection in
|
|
nonblocking mode, it must at a minimum ensure that \fISSL_handle_events()\fR is called
|
|
periodically to allow timeout events to be handled. An application can find out
|
|
when it next needs to call \fISSL_handle_events()\fR for this purpose (if at all) by calling
|
|
\&\fISSL_get_event_timeout\fR\|(3).
|
|
.Sp
|
|
Calling \fISSL_handle_events()\fR on a \s-1QUIC\s0 connection \s-1SSL\s0 object being used in blocking mode
|
|
is not necessary unless no I/O calls (such as \fISSL_read\fR\|(3) or \fISSL_write\fR\|(3))
|
|
will be made to the object for a substantial period of time. So long as at least
|
|
one call to the \s-1SSL\s0 object is blocking, no such call is needed. However,
|
|
\&\fISSL_handle_events()\fR may optionally be used on a \s-1QUIC\s0 connection object if desired.
|
|
.Sp
|
|
With the thread-assisted mode of operation \fIOSSL_QUIC_client_thread_method\fR\|(3)
|
|
it is unnecessary to call \fISSL_handle_events()\fR as the assist thread handles the \s-1QUIC\s0
|
|
connection events.
|
|
.PP
|
|
Calling \fISSL_handle_events()\fR on any other kind of \s-1SSL\s0 object is a no-op. This is
|
|
considered a success case.
|
|
.PP
|
|
Note that \fISSL_handle_events()\fR supersedes the older \fIDTLSv1_handle_timeout\fR\|(3) function
|
|
for all use cases.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
Returns 1 on success and 0 on failure.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fISSL_get_event_timeout\fR\|(3), \fIDTLSv1_handle_timeout\fR\|(3), \fIssl\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fISSL_handle_events()\fR function was added in OpenSSL 3.2.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2023 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>.
|