diff options
Diffstat (limited to 'lib')
18 files changed, 46 insertions, 40 deletions
diff --git a/lib/libssl/src/doc/crypto/X509_STORE_CTX_get_error.pod b/lib/libssl/src/doc/crypto/X509_STORE_CTX_get_error.pod index a883f6c0978..60e8332ae9d 100644 --- a/lib/libssl/src/doc/crypto/X509_STORE_CTX_get_error.pod +++ b/lib/libssl/src/doc/crypto/X509_STORE_CTX_get_error.pod @@ -278,6 +278,8 @@ happen if extended CRL checking is enabled. an application specific error. This will never be returned unless explicitly set by an application. +=back + =head1 NOTES The above functions should be used instead of directly referencing the fields diff --git a/lib/libssl/src/doc/ssl/SSL_COMP_add_compression_method.pod b/lib/libssl/src/doc/ssl/SSL_COMP_add_compression_method.pod index 42fa66b1975..80175a3c178 100644 --- a/lib/libssl/src/doc/ssl/SSL_COMP_add_compression_method.pod +++ b/lib/libssl/src/doc/ssl/SSL_COMP_add_compression_method.pod @@ -53,11 +53,11 @@ SSL_COMP_add_compression_method() may return the following values: =over 4 -=item 0 +=item C<0> The operation succeeded. -=item 1 +=item C<1> The operation failed. Check the error queue to find out the reason. diff --git a/lib/libssl/src/doc/ssl/SSL_CTX_add_session.pod b/lib/libssl/src/doc/ssl/SSL_CTX_add_session.pod index 82676b26b23..fd927f8d7d1 100644 --- a/lib/libssl/src/doc/ssl/SSL_CTX_add_session.pod +++ b/lib/libssl/src/doc/ssl/SSL_CTX_add_session.pod @@ -52,13 +52,13 @@ The following values are returned by all functions: =over 4 -=item 0 +=item C<0> The operation failed. In case of the add operation, it was tried to add the same (identical) session twice. In case of the remove operation, the session was not found in the cache. -=item 1 +=item C<1> The operation succeeded. diff --git a/lib/libssl/src/doc/ssl/SSL_CTX_load_verify_locations.pod b/lib/libssl/src/doc/ssl/SSL_CTX_load_verify_locations.pod index 84a799fc71d..de010652850 100644 --- a/lib/libssl/src/doc/ssl/SSL_CTX_load_verify_locations.pod +++ b/lib/libssl/src/doc/ssl/SSL_CTX_load_verify_locations.pod @@ -100,13 +100,13 @@ The following return values can occur: =over 4 -=item 0 +=item C<0> The operation failed because B<CAfile> and B<CApath> are NULL or the processing at one of the locations specified failed. Check the error stack to find out the reason. -=item 1 +=item C<1> The operation succeeded. diff --git a/lib/libssl/src/doc/ssl/SSL_CTX_set_client_CA_list.pod b/lib/libssl/src/doc/ssl/SSL_CTX_set_client_CA_list.pod index 632b556d126..04d0a3c9a87 100644 --- a/lib/libssl/src/doc/ssl/SSL_CTX_set_client_CA_list.pod +++ b/lib/libssl/src/doc/ssl/SSL_CTX_set_client_CA_list.pod @@ -66,11 +66,11 @@ values: =over 4 -=item 1 +=item C<1> The operation succeeded. -=item 0 +=item C<0> A failure while manipulating the STACK_OF(X509_NAME) object occurred or the X509_NAME could not be extracted from B<cacert>. Check the error stack diff --git a/lib/libssl/src/doc/ssl/SSL_CTX_set_session_id_context.pod b/lib/libssl/src/doc/ssl/SSL_CTX_set_session_id_context.pod index 58fc685506e..ed0a81cdb92 100644 --- a/lib/libssl/src/doc/ssl/SSL_CTX_set_session_id_context.pod +++ b/lib/libssl/src/doc/ssl/SSL_CTX_set_session_id_context.pod @@ -64,13 +64,13 @@ return the following values: =over 4 -=item 0 +=item C<0> The length B<sid_ctx_len> of the session id context B<sid_ctx> exceeded the maximum allowed length of B<SSL_MAX_SSL_SESSION_ID_LENGTH>. The error is logged to the error stack. -=item 1 +=item C<1> The operation succeeded. diff --git a/lib/libssl/src/doc/ssl/SSL_CTX_set_ssl_version.pod b/lib/libssl/src/doc/ssl/SSL_CTX_set_ssl_version.pod index 254f2b4397f..5ea8f0d4f60 100644 --- a/lib/libssl/src/doc/ssl/SSL_CTX_set_ssl_version.pod +++ b/lib/libssl/src/doc/ssl/SSL_CTX_set_ssl_version.pod @@ -42,11 +42,11 @@ and SSL_set_ssl_method(): =over 4 -=item 0 +=item C<0> The new choice failed, check the error stack to find out the reason. -=item 1 +=item C<1> The operation succeeded. diff --git a/lib/libssl/src/doc/ssl/SSL_CTX_use_psk_identity_hint.pod b/lib/libssl/src/doc/ssl/SSL_CTX_use_psk_identity_hint.pod index b80e25be7ea..9f88d284d20 100644 --- a/lib/libssl/src/doc/ssl/SSL_CTX_use_psk_identity_hint.pod +++ b/lib/libssl/src/doc/ssl/SSL_CTX_use_psk_identity_hint.pod @@ -81,7 +81,9 @@ SSL_CTX_use_psk_identity_hint() and SSL_use_psk_identity_hint() return Return values from the server callback are interpreted as follows: -=item > 0 +=over 4 + +=item C<E<gt> 0> PSK identity was found and the server callback has provided the PSK successfully in parameter B<psk>. Return value is the length of @@ -94,9 +96,11 @@ data to B<psk> and return the length of the random data, so the connection will fail with decryption_error before it will be finished completely. -=item 0 +=item C<0> PSK identity was not found. An "unknown_psk_identity" alert message will be sent and the connection setup fails. +=back + =cut diff --git a/lib/libssl/src/doc/ssl/SSL_accept.pod b/lib/libssl/src/doc/ssl/SSL_accept.pod index cc724c0d561..17f504b89b6 100644 --- a/lib/libssl/src/doc/ssl/SSL_accept.pod +++ b/lib/libssl/src/doc/ssl/SSL_accept.pod @@ -44,18 +44,18 @@ The following return values can occur: =over 4 -=item 1 +=item C<1> The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been established. -=item 0 +=item C<0> The TLS/SSL handshake was not successful but was shut down controlled and by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B<ret> to find out the reason. -=item E<lt>0 +=item C<E<lt>0> The TLS/SSL handshake was not successful because a fatal error occurred either at the protocol level or a connection failure occurred. The shutdown was diff --git a/lib/libssl/src/doc/ssl/SSL_clear.pod b/lib/libssl/src/doc/ssl/SSL_clear.pod index d4df1bfac31..2da0b023c63 100644 --- a/lib/libssl/src/doc/ssl/SSL_clear.pod +++ b/lib/libssl/src/doc/ssl/SSL_clear.pod @@ -56,12 +56,12 @@ The following return values can occur: =over 4 -=item 0 +=item C<0> The SSL_clear() operation could not be performed. Check the error stack to find out the reason. -=item 1 +=item C<1> The SSL_clear() operation was successful. diff --git a/lib/libssl/src/doc/ssl/SSL_connect.pod b/lib/libssl/src/doc/ssl/SSL_connect.pod index cc56ebb75f3..413af361e14 100644 --- a/lib/libssl/src/doc/ssl/SSL_connect.pod +++ b/lib/libssl/src/doc/ssl/SSL_connect.pod @@ -41,18 +41,18 @@ The following return values can occur: =over 4 -=item 1 +=item C<1> The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been established. -=item 0 +=item C<0> The TLS/SSL handshake was not successful but was shut down controlled and by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B<ret> to find out the reason. -=item E<lt>0 +=item C<E<lt>0> The TLS/SSL handshake was not successful, because a fatal error occurred either at the protocol level or a connection failure occurred. The shutdown was diff --git a/lib/libssl/src/doc/ssl/SSL_do_handshake.pod b/lib/libssl/src/doc/ssl/SSL_do_handshake.pod index 243576451b7..e9d4119c72b 100644 --- a/lib/libssl/src/doc/ssl/SSL_do_handshake.pod +++ b/lib/libssl/src/doc/ssl/SSL_do_handshake.pod @@ -45,18 +45,18 @@ The following return values can occur: =over 4 -=item 1 +=item C<1> The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been established. -=item 0 +=item C<0> The TLS/SSL handshake was not successful but was shut down controlled and by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B<ret> to find out the reason. -=item E<lt>0 +=item C<E<lt>0> The TLS/SSL handshake was not successful because a fatal error occurred either at the protocol level or a connection failure occurred. The shutdown was diff --git a/lib/libssl/src/doc/ssl/SSL_read.pod b/lib/libssl/src/doc/ssl/SSL_read.pod index 7038cd2d752..5f03ec35595 100644 --- a/lib/libssl/src/doc/ssl/SSL_read.pod +++ b/lib/libssl/src/doc/ssl/SSL_read.pod @@ -81,12 +81,12 @@ The following return values can occur: =over 4 -=item E<gt>0 +=item C<E<gt>0> The read operation was successful; the return value is the number of bytes actually read from the TLS/SSL connection. -=item 0 +=item C<0> The read operation was not successful. The reason may either be a clean shutdown due to a "close notify" alert sent by the peer (in which case @@ -103,7 +103,7 @@ only be detected, whether the underlying connection was closed. It cannot be checked, whether the closure was initiated by the peer or by something else. -=item E<lt>0 +=item C<E<lt>0> The read operation was not successful, because either an error occurred or action must be taken by the calling process. Call SSL_get_error() with the diff --git a/lib/libssl/src/doc/ssl/SSL_session_reused.pod b/lib/libssl/src/doc/ssl/SSL_session_reused.pod index da7d06264d0..033d54c05b5 100644 --- a/lib/libssl/src/doc/ssl/SSL_session_reused.pod +++ b/lib/libssl/src/doc/ssl/SSL_session_reused.pod @@ -27,11 +27,11 @@ The following return values can occur: =over 4 -=item 0 +=item C<0> A new session was negotiated. -=item 1 +=item C<1> A session was reused. diff --git a/lib/libssl/src/doc/ssl/SSL_set_fd.pod b/lib/libssl/src/doc/ssl/SSL_set_fd.pod index 70291128fce..59e1b2bb20f 100644 --- a/lib/libssl/src/doc/ssl/SSL_set_fd.pod +++ b/lib/libssl/src/doc/ssl/SSL_set_fd.pod @@ -35,11 +35,11 @@ The following return values can occur: =over 4 -=item 0 +=item C<0> The operation failed. Check the error stack to find out why. -=item 1 +=item C<1> The operation succeeded. diff --git a/lib/libssl/src/doc/ssl/SSL_set_session.pod b/lib/libssl/src/doc/ssl/SSL_set_session.pod index 5f54714ad86..d35e6d3b7b7 100644 --- a/lib/libssl/src/doc/ssl/SSL_set_session.pod +++ b/lib/libssl/src/doc/ssl/SSL_set_session.pod @@ -37,11 +37,11 @@ The following return values can occur: =over 4 -=item 0 +=item C<0> The operation failed; check the error stack to find out the reason. -=item 1 +=item C<1> The operation succeeded. diff --git a/lib/libssl/src/doc/ssl/SSL_shutdown.pod b/lib/libssl/src/doc/ssl/SSL_shutdown.pod index 89911acbcac..69ad31e80b0 100644 --- a/lib/libssl/src/doc/ssl/SSL_shutdown.pod +++ b/lib/libssl/src/doc/ssl/SSL_shutdown.pod @@ -92,19 +92,19 @@ The following return values can occur: =over 4 -=item 1 +=item C<1> The shutdown was successfully completed. The "close notify" alert was sent and the peer's "close notify" alert was received. -=item 0 +=item C<0> The shutdown is not yet finished. Call SSL_shutdown() for a second time, if a bidirectional shutdown shall be performed. The output of L<SSL_get_error(3)|SSL_get_error(3)> may be misleading, as an erroneous SSL_ERROR_SYSCALL may be flagged even though no error occurred. -=item -1 +=item C<-1> The shutdown was not successful because a fatal error occurred either at the protocol level or a connection failure occurred. It can also occur if diff --git a/lib/libssl/src/doc/ssl/SSL_write.pod b/lib/libssl/src/doc/ssl/SSL_write.pod index e013c12d525..b0f73ae5203 100644 --- a/lib/libssl/src/doc/ssl/SSL_write.pod +++ b/lib/libssl/src/doc/ssl/SSL_write.pod @@ -74,12 +74,12 @@ The following return values can occur: =over 4 -=item E<gt>0 +=item C<E<gt>0> The write operation was successful, the return value is the number of bytes actually written to the TLS/SSL connection. -=item 0 +=item C<0> The write operation was not successful. Probably the underlying connection was closed. Call SSL_get_error() with the return value B<ret> to find out, @@ -90,7 +90,7 @@ SSLv2 (deprecated) does not support a shutdown alert protocol, so it can only be detected, whether the underlying connection was closed. It cannot be checked, why the closure happened. -=item E<lt>0 +=item C<E<lt>0> The write operation was not successful, because either an error occurred or action must be taken by the calling process. Call SSL_get_error() with the |