mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-12-09 05:51:54 +08:00
Code Issues Packages Projects Releases Wiki Activity
454afd9866
openssl/doc/man3/SSL_get_error.pod

177 lines
6.8 KiB
Plaintext
Raw Normal View History

New manual page.
2000-01-26 06:35:20 +08:00
=pod
=head1 NAME
ispell and some other nit-picking
2000-09-16 23:39:28 +08:00
SSL_get_error - obtain result code for TLS/SSL I/O operation
New manual page.
2000-01-26 06:35:20 +08:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
update docs (recent constification)
2005-03-30 19:50:14 +08:00
int SSL_get_error(const SSL *ssl, int ret);
New manual page.
2000-01-26 06:35:20 +08:00
=head1 DESCRIPTION
SSL_get_error() returns a result code (suitable for the C "switch"
mention SSL_do_handshake()
2002-07-29 20:35:19 +08:00
statement) for a preceding call to SSL_connect(), SSL_accept(), SSL_do_handshake(),
Add SSL_shutdown to SSL_get_error's documentation SSL_shutdown can fail if called during initialization, and in such case, it'll add an error to the error queue. This adds SSL_shutdown to the list of functions that should preceed the call to SSL_get_error. CLA: trivial Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/7465)
2018-10-23 05:34:57 +08:00
SSL_read_ex(), SSL_read(), SSL_peek_ex(), SSL_peek(), SSL_shutdown(),
SSL_write_ex() or SSL_write() on B<ssl>. The value returned by that TLS/SSL I/O
function must be passed to SSL_get_error() in parameter B<ret>.
New manual page.
2000-01-26 06:35:20 +08:00
In addition to B<ssl> and B<ret>, SSL_get_error() inspects the
current thread's OpenSSL error queue. Thus, SSL_get_error() must be
ispell and some other nit-picking
2000-09-16 23:39:28 +08:00
used in the same thread that performed the TLS/SSL I/O operation, and no
spelling
2000-02-01 09:35:52 +08:00
other OpenSSL function calls should appear in between. The current
ispell and some other nit-picking
2000-09-16 23:39:28 +08:00
thread's error queue must be empty before the TLS/SSL I/O operation is
New manual page.
2000-01-26 06:35:20 +08:00
attempted, or SSL_get_error() will not work reliably.
=head1 RETURN VALUES
The following return values can currently occur:
=over 4
=item SSL_ERROR_NONE
ispell and some other nit-picking
2000-09-16 23:39:28 +08:00
The TLS/SSL I/O operation completed. This result code is returned
spelling
2000-02-01 09:35:52 +08:00
if and only if B<ret E<gt> 0>.
New manual page.
2000-01-26 06:35:20 +08:00
=item SSL_ERROR_ZERO_RETURN
Update documentation on how to close a connection Reviewed-by: Bernd Edlinger <bernd.edlinger@hotmail.de> GH: #5823
2018-03-31 20:43:01 +08:00
The TLS/SSL peer has closed the connection for writing by sending the
Improve SSL_shutdown() documentation Reviewed-by: Ben Kaduk <kaduk@mit.edu> GH: #7188
2018-09-12 05:39:25 +08:00
close_notify alert.
Update documentation on how to close a connection Reviewed-by: Bernd Edlinger <bernd.edlinger@hotmail.de> GH: #5823
2018-03-31 20:43:01 +08:00
No more data can be read.
Note that B<SSL_ERROR_ZERO_RETURN> does not necessarily
Make SSL_read and SSL_write return the old behaviour and document it. This reverts commit 4880672a9b41a09a0984b55e219f02a2de7ab75e. Fixes: #1903 Reviewed-by: Matt Caswell <matt@openssl.org> GH: #1931
2016-11-16 01:58:52 +08:00
indicate that the underlying transport has been closed.
New manual page.
2000-01-26 06:35:20 +08:00
=item SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE
Improve documentation about reading and writing Reviewed-by: Matt Caswell <matt@openssl.org> GH: #6240
2018-05-13 17:24:11 +08:00
The operation did not complete and can be retried later.
B<SSL_ERROR_WANT_READ> is returned when the last operation was a read
operation from a non-blocking B<BIO>.
It means that not enough data was available at this time to complete the
operation.
If at a later time the underlying B<BIO> has data available for reading the same
function can be called again.
SSL_read() and SSL_read_ex() can also set B<SSL_ERROR_WANT_READ> when there is
still unprocessed data available at either the B<SSL> or the B<BIO> layer, even
for a blocking B<BIO>.
See L<SSL_read(3)> for more information.
B<SSL_ERROR_WANT_WRITE> is returned when the last operation was a write
to a non-blocking B<BIO> and it was unable to sent all data to the B<BIO>.
When the B<BIO> is writeable again, the same function can be called again.
Note that the retry may again lead to an B<SSL_ERROR_WANT_READ> or
B<SSL_ERROR_WANT_WRITE> condition.
Additional explanations for SSL_ERROR_WANT_READ/WRITE.
2000-11-13 03:17:22 +08:00
There is no fixed upper limit for the number of iterations that
may be necessary until progress becomes visible at application
protocol level.
Improve documentation about reading and writing Reviewed-by: Matt Caswell <matt@openssl.org> GH: #6240
2018-05-13 17:24:11 +08:00
It is safe to call SSL_read() or SSL_read_ex() when more data is available
even when the call that set this error was an SSL_write() or SSL_write_ex().
However if the call was an SSL_write() or SSL_write_ex(), it should be called
again to continue sending the application data.
Additional explanations for SSL_ERROR_WANT_READ/WRITE.
2000-11-13 03:17:22 +08:00
For socket B<BIO>s (e.g. when SSL_set_fd() was used), select() or
poll() on the underlying socket can be used to find out when the
TLS/SSL I/O function should be retried.
New manual page.
2000-01-26 06:35:20 +08:00
SSL => TLS/SSL
2000-09-17 00:05:34 +08:00
Caveat: Any TLS/SSL I/O function can lead to either of
Improve documentation about reading and writing Reviewed-by: Matt Caswell <matt@openssl.org> GH: #6240
2018-05-13 17:24:11 +08:00
B<SSL_ERROR_WANT_READ> and B<SSL_ERROR_WANT_WRITE>.
In particular,
Updates various man pages based on review feedback received. Improvements to style, grammar etc. Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-10-21 23:16:20 +08:00
SSL_read_ex(), SSL_read(), SSL_peek_ex(), or SSL_peek() may want to write data
Improve documentation about reading and writing Reviewed-by: Matt Caswell <matt@openssl.org> GH: #6240
2018-05-13 17:24:11 +08:00
and SSL_write() or SSL_write_ex() may want to read data.
This is mainly because
Document the newly added SSL functions Also document SSL_peek() which was missing from the docs. Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-10-20 22:04:21 +08:00
TLS/SSL handshakes may occur at any time during the protocol (initiated by
either the client or the server); SSL_read_ex(), SSL_read(), SSL_peek_ex(),
Updates various man pages based on review feedback received. Improvements to style, grammar etc. Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-10-21 23:16:20 +08:00
SSL_peek(), SSL_write_ex(), and SSL_write() will handle any pending handshakes.
New manual page.
2000-01-26 06:35:20 +08:00
Add missing item(s) SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT.
2001-05-16 17:43:51 +08:00
=item SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT
The operation did not complete; the same TLS/SSL I/O function should be
called again later. The underlying BIO was not connected yet to the peer
and the call would block in connect()/accept(). The SSL function should be
called again when the connection is established. These messages can only
appear with a BIO_s_connect() or BIO_s_accept() BIO, respectively.
In order to find out, when the connection has been successfully established,
on many platforms select() or poll() for writing on the socket file descriptor
can be used.
New manual page.
2000-01-26 06:35:20 +08:00
=item SSL_ERROR_WANT_X509_LOOKUP
The operation did not complete because an application callback set by
SSL_CTX_set_client_cert_cb() has asked to be called again.
SSL => TLS/SSL
2000-09-17 00:05:34 +08:00
The TLS/SSL I/O function should be called again later.
New manual page.
2000-01-26 06:35:20 +08:00
Details depend on the application.
More async documentation Document the libssl and command line application aspects of async. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-10-06 20:48:43 +08:00
=item SSL_ERROR_WANT_ASYNC
The operation did not complete because an asynchronous engine is still
processing data. This will only occur if the mode has been set to SSL_MODE_ASYNC
using L<SSL_CTX_set_mode(3)> or L<SSL_set_mode(3)> and an asynchronous capable
engine is being used. An application can determine whether the engine has
completed its processing using select() or poll() on the asynchronous wait file
descriptor. This file descriptor is available by calling
Correct documentation error SSL_get_async_wait_fd() was replaced by SSL_get_all_async_fds() and SSL_get_changed_async_fds(). Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-17 05:50:12 +08:00
L<SSL_get_all_async_fds(3)> or L<SSL_get_changed_async_fds(3)>. The TLS/SSL I/O
function should be called again later. The function B<must> be called from the
same thread that the original call was made from.
More async documentation Document the libssl and command line application aspects of async. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-10-06 20:48:43 +08:00
Handle no async jobs in libssl If the application has limited the size of the async pool using ASYNC_init_thread() then we could run out of jobs while trying to start a libssl io operation. However libssl was failing to handle this and treating it like a fatal error. It should not be fatal...we just need to retry when there are jobs available again. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-04 00:55:00 +08:00
=item SSL_ERROR_WANT_ASYNC_JOB
The asynchronous job could not be started because there were no async jobs
available in the pool (see ASYNC_init_thread(3)). This will only occur if the
mode has been set to SSL_MODE_ASYNC using L<SSL_CTX_set_mode(3)> or
L<SSL_set_mode(3)> and a maximum limit has been set on the async job pool
through a call to L<ASYNC_init_thread(3)>. The application should retry the
operation after a currently executing asynchronous operation for the current
thread has completed.
Rename SSL_CTX_set_early_cb to SSL_CTX_set_client_hello_cb. "Early callback" is a little ambiguous now that early data exists. Perhaps "ClientHello callback"? Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Ben Kaduk <kaduk@mit.edu> (Merged from https://github.com/openssl/openssl/pull/4349)
2017-09-08 06:39:40 +08:00
=item SSL_ERROR_WANT_CLIENT_HELLO_CB
Add SSL_CTX early callback Provide a callback interface that gives the application the ability to adjust the nascent SSL object at the earliest stage of ClientHello processing, immediately after extensions have been collected but before they have been processed. This is akin to BoringSSL's "select_certificate_cb" (though it is not API compatible), and as the name indicates, one major use is to examine the supplied server name indication and select what certificate to present to the client. However, it can also be used to make more sweeping configuration changes to the SSL object according to the selected server identity and configuration. That may include adjusting the permitted TLS versions, swapping out the SSL_CTX object (as is traditionally done in a tlsext_servername_callback), changing the server's cipher list, and more. We also wish to allow an early callback to indicate that it needs to perform additional work asynchronously and resume processing later. To that effect, refactor the second half of tls_process_client_hello() into a subroutine to be called at the post-processing stage (including the early callback itself), to allow the callback to result in remaining in the same work stage for a later call to succeed. This requires allocating for and storing the CLIENTHELLO_MSG in the SSL object to be preserved across such calls, but the storage is reclaimed after ClientHello processing finishes. Information about the CliehtHello is available to the callback by means of accessor functions that can only be used from the early callback. This allows extensions to make use of the existing internal parsing machinery without exposing structure internals (e.g., of PACKET), so that applications do not have to write fragile parsing code. Applications are encouraged to utilize an early callback and not use a servername_callback, in order to avoid unexpected behavior that occurs due to the relative order of processing between things like session resumption and the historical servername callback. Also tidy up nearby style by removing unnecessary braces around one-line conditional bodies. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2279)
2017-01-24 07:03:16 +08:00
The operation did not complete because an application callback set by
Rename SSL_CTX_set_early_cb to SSL_CTX_set_client_hello_cb. "Early callback" is a little ambiguous now that early data exists. Perhaps "ClientHello callback"? Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Ben Kaduk <kaduk@mit.edu> (Merged from https://github.com/openssl/openssl/pull/4349)
2017-09-08 06:39:40 +08:00
SSL_CTX_set_client_hello_cb() has asked to be called again.
Add SSL_CTX early callback Provide a callback interface that gives the application the ability to adjust the nascent SSL object at the earliest stage of ClientHello processing, immediately after extensions have been collected but before they have been processed. This is akin to BoringSSL's "select_certificate_cb" (though it is not API compatible), and as the name indicates, one major use is to examine the supplied server name indication and select what certificate to present to the client. However, it can also be used to make more sweeping configuration changes to the SSL object according to the selected server identity and configuration. That may include adjusting the permitted TLS versions, swapping out the SSL_CTX object (as is traditionally done in a tlsext_servername_callback), changing the server's cipher list, and more. We also wish to allow an early callback to indicate that it needs to perform additional work asynchronously and resume processing later. To that effect, refactor the second half of tls_process_client_hello() into a subroutine to be called at the post-processing stage (including the early callback itself), to allow the callback to result in remaining in the same work stage for a later call to succeed. This requires allocating for and storing the CLIENTHELLO_MSG in the SSL object to be preserved across such calls, but the storage is reclaimed after ClientHello processing finishes. Information about the CliehtHello is available to the callback by means of accessor functions that can only be used from the early callback. This allows extensions to make use of the existing internal parsing machinery without exposing structure internals (e.g., of PACKET), so that applications do not have to write fragile parsing code. Applications are encouraged to utilize an early callback and not use a servername_callback, in order to avoid unexpected behavior that occurs due to the relative order of processing between things like session resumption and the historical servername callback. Also tidy up nearby style by removing unnecessary braces around one-line conditional bodies. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2279)
2017-01-24 07:03:16 +08:00
The TLS/SSL I/O function should be called again later.
Details depend on the application.
New manual page.
2000-01-26 06:35:20 +08:00
=item SSL_ERROR_SYSCALL
Clarify that SSL_shutdown() must not be called after a fatal error Follow on from CVE-2019-1559 Reviewed-by: Richard Levitte <levitte@openssl.org>
2019-02-20 22:21:36 +08:00
Some non-recoverable, fatal I/O error occurred. The OpenSSL error queue may
contain more information on the error. For socket I/O on Unix systems, consult
B<errno> for details. If this error occurs then no further I/O operations should
be performed on the connection and SSL_shutdown() must not be called.
New manual page.
2000-01-26 06:35:20 +08:00
Improve documentation about reading and writing Reviewed-by: Matt Caswell <matt@openssl.org> GH: #6240
2018-05-13 17:24:11 +08:00
This value can also be returned for other errors, check the error queue for
details.
New manual page.
2000-01-26 06:35:20 +08:00
=item SSL_ERROR_SSL
Clarify that SSL_shutdown() must not be called after a fatal error Follow on from CVE-2019-1559 Reviewed-by: Richard Levitte <levitte@openssl.org>
2019-02-20 22:21:36 +08:00
A non-recoverable, fatal error in the SSL library occurred, usually a protocol
error. The OpenSSL error queue contains more information on the error. If this
error occurs then no further I/O operations should be performed on the
connection and SSL_shutdown() must not be called.
New manual page.
2000-01-26 06:35:20 +08:00
=back
=head1 SEE ALSO
Remove ref to err(7), update copyright. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2825)
2017-03-02 23:07:21 +08:00
L<ssl(7)>
New manual page.
2000-01-26 06:35:20 +08:00
More async documentation Document the libssl and command line application aspects of async. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-10-06 20:48:43 +08:00
=head1 HISTORY
man: harmonize the various formulations in the HISTORY sections While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
2018-12-09 08:02:36 +08:00
The SSL_ERROR_WANT_ASYNC error code was added in OpenSSL 1.1.0.
The SSL_ERROR_WANT_CLIENT_HELLO_CB error code was added in OpenSSL 1.1.1.
More async documentation Document the libssl and command line application aspects of async. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-10-06 20:48:43 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Update copyright year Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/5851)
2018-04-03 20:57:12 +08:00
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut
Reference in New Issue Copy Permalink