From 2c2dac9c21ee14c128f2b41805aec8152fcd1546 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Tue, 26 May 2020 19:45:58 +0000 Subject: minor cleanup ahead of the following work: remove references to the SSL protocol which is no longer supported and use .Xr rather than .Fn for functions documented elsewhere --- src/lib/libssl/man/SSL_read.3 | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) (limited to 'src/lib') diff --git a/src/lib/libssl/man/SSL_read.3 b/src/lib/libssl/man/SSL_read.3 index d773065a81..ea181ce15c 100644 --- a/src/lib/libssl/man/SSL_read.3 +++ b/src/lib/libssl/man/SSL_read.3 @@ -1,9 +1,11 @@ -.\" $OpenBSD: SSL_read.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $ -.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 +.\" $OpenBSD: SSL_read.3,v 1.7 2020/05/26 19:45:58 schwarze Exp $ +.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 +.\" partial merge up to: OpenSSL 18bad535 Apr 9 15:13:55 2019 +0100 .\" .\" This file was written by Lutz Jaenicke and .\" Matt Caswell . -.\" Copyright (c) 2000, 2001, 2008, 2016 The OpenSSL Project. All rights reserved. +.\" Copyright (c) 2000, 2001, 2008, 2016 The OpenSSL Project. +.\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -49,13 +51,13 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: March 27 2018 $ +.Dd $Mdocdate: May 26 2020 $ .Dt SSL_READ 3 .Os .Sh NAME .Nm SSL_read , .Nm SSL_peek -.Nd read bytes from a TLS/SSL connection +.Nd read bytes from a TLS connection .Sh SYNOPSIS .In openssl/ssl.h .Ft int @@ -86,7 +88,7 @@ and are called .Dq read functions . .Pp -If necessary, a read function will negotiate a TLS/SSL session, if +If necessary, a read function will negotiate a TLS session, if not already explicitly performed by .Xr SSL_connect 3 or @@ -105,12 +107,12 @@ or .Xr SSL_set_accept_state 3 before the first call to a read function. .Pp -The read functions works based on the SSL/TLS records. +The read functions works based on the TLS records. The data are received in records (with a maximum record size of 16kB). Only when a record has been completely received, it can be processed (decrypted and checked for integrity). Therefore data that was not retrieved at the last read call can -still be buffered inside the SSL layer and will be retrieved on the +still be buffered inside the TLS layer and will be retrieved on the next read call. If .Fa num @@ -121,7 +123,7 @@ the processing of the next record. Only when the record has been received and processed completely will the read functions return reporting success. At most the contents of the record will be returned. -As the size of an SSL/TLS record may exceed the maximum packet size +As the size of a TLS record may exceed the maximum packet size of the underlying transport (e.g., TCP), it may be necessary to read several packets from the transport layer before the record is complete and the read call can succeed. @@ -185,7 +187,7 @@ The following return values can occur: .It >0 The read operation was successful. The return value is the number of bytes actually read from the -TLS/SSL connection. +TLS connection. .It 0 The read operation was not successful. The reason may either be a clean shutdown due to a @@ -199,7 +201,7 @@ and It is also possible that the peer simply shut down the underlying transport and the shutdown is incomplete. Call -.Fn SSL_get_error +.Xr SSL_get_error 3 with the return value to find out whether an error occurred or the connection was shut down cleanly .Pq Dv SSL_ERROR_ZERO_RETURN . @@ -207,7 +209,7 @@ was shut down cleanly The read operation was not successful, because either an error occurred or action must be taken by the calling process. Call -.Fn SSL_get_error +.Xr SSL_get_error 3 with the return value to find out the reason. .El .Sh SEE ALSO -- cgit v1.2.3-55-g6feb