diff options
author | schwarze <> | 2020-05-26 19:45:58 +0000 |
---|---|---|
committer | schwarze <> | 2020-05-26 19:45:58 +0000 |
commit | 2c2dac9c21ee14c128f2b41805aec8152fcd1546 (patch) | |
tree | 142c751673c1de80791eabb909ed47ead1be3fbe | |
parent | dc1caebca4d325d1d05fc082722782a2d2374cd6 (diff) | |
download | openbsd-2c2dac9c21ee14c128f2b41805aec8152fcd1546.tar.gz openbsd-2c2dac9c21ee14c128f2b41805aec8152fcd1546.tar.bz2 openbsd-2c2dac9c21ee14c128f2b41805aec8152fcd1546.zip |
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
-rw-r--r-- | src/lib/libssl/man/SSL_read.3 | 26 |
1 files changed, 14 insertions, 12 deletions
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 @@ | |||
1 | .\" $OpenBSD: SSL_read.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $ | 1 | .\" $OpenBSD: SSL_read.3,v 1.7 2020/05/26 19:45:58 schwarze Exp $ |
2 | .\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 | 2 | .\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 |
3 | .\" partial merge up to: OpenSSL 18bad535 Apr 9 15:13:55 2019 +0100 | ||
3 | .\" | 4 | .\" |
4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org> and | 5 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org> and |
5 | .\" Matt Caswell <matt@openssl.org>. | 6 | .\" Matt Caswell <matt@openssl.org>. |
6 | .\" Copyright (c) 2000, 2001, 2008, 2016 The OpenSSL Project. All rights reserved. | 7 | .\" Copyright (c) 2000, 2001, 2008, 2016 The OpenSSL Project. |
8 | .\" All rights reserved. | ||
7 | .\" | 9 | .\" |
8 | .\" Redistribution and use in source and binary forms, with or without | 10 | .\" Redistribution and use in source and binary forms, with or without |
9 | .\" modification, are permitted provided that the following conditions | 11 | .\" modification, are permitted provided that the following conditions |
@@ -49,13 +51,13 @@ | |||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 51 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 52 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
51 | .\" | 53 | .\" |
52 | .Dd $Mdocdate: March 27 2018 $ | 54 | .Dd $Mdocdate: May 26 2020 $ |
53 | .Dt SSL_READ 3 | 55 | .Dt SSL_READ 3 |
54 | .Os | 56 | .Os |
55 | .Sh NAME | 57 | .Sh NAME |
56 | .Nm SSL_read , | 58 | .Nm SSL_read , |
57 | .Nm SSL_peek | 59 | .Nm SSL_peek |
58 | .Nd read bytes from a TLS/SSL connection | 60 | .Nd read bytes from a TLS connection |
59 | .Sh SYNOPSIS | 61 | .Sh SYNOPSIS |
60 | .In openssl/ssl.h | 62 | .In openssl/ssl.h |
61 | .Ft int | 63 | .Ft int |
@@ -86,7 +88,7 @@ and | |||
86 | are called | 88 | are called |
87 | .Dq read functions . | 89 | .Dq read functions . |
88 | .Pp | 90 | .Pp |
89 | If necessary, a read function will negotiate a TLS/SSL session, if | 91 | If necessary, a read function will negotiate a TLS session, if |
90 | not already explicitly performed by | 92 | not already explicitly performed by |
91 | .Xr SSL_connect 3 | 93 | .Xr SSL_connect 3 |
92 | or | 94 | or |
@@ -105,12 +107,12 @@ or | |||
105 | .Xr SSL_set_accept_state 3 | 107 | .Xr SSL_set_accept_state 3 |
106 | before the first call to a read function. | 108 | before the first call to a read function. |
107 | .Pp | 109 | .Pp |
108 | The read functions works based on the SSL/TLS records. | 110 | The read functions works based on the TLS records. |
109 | The data are received in records (with a maximum record size of 16kB). | 111 | The data are received in records (with a maximum record size of 16kB). |
110 | Only when a record has been completely received, it can be processed | 112 | Only when a record has been completely received, it can be processed |
111 | (decrypted and checked for integrity). | 113 | (decrypted and checked for integrity). |
112 | Therefore data that was not retrieved at the last read call can | 114 | Therefore data that was not retrieved at the last read call can |
113 | still be buffered inside the SSL layer and will be retrieved on the | 115 | still be buffered inside the TLS layer and will be retrieved on the |
114 | next read call. | 116 | next read call. |
115 | If | 117 | If |
116 | .Fa num | 118 | .Fa num |
@@ -121,7 +123,7 @@ the processing of the next record. | |||
121 | Only when the record has been received and processed completely | 123 | Only when the record has been received and processed completely |
122 | will the read functions return reporting success. | 124 | will the read functions return reporting success. |
123 | At most the contents of the record will be returned. | 125 | At most the contents of the record will be returned. |
124 | As the size of an SSL/TLS record may exceed the maximum packet size | 126 | As the size of a TLS record may exceed the maximum packet size |
125 | of the underlying transport (e.g., TCP), it may be necessary to | 127 | of the underlying transport (e.g., TCP), it may be necessary to |
126 | read several packets from the transport layer before the record is | 128 | read several packets from the transport layer before the record is |
127 | complete and the read call can succeed. | 129 | complete and the read call can succeed. |
@@ -185,7 +187,7 @@ The following return values can occur: | |||
185 | .It >0 | 187 | .It >0 |
186 | The read operation was successful. | 188 | The read operation was successful. |
187 | The return value is the number of bytes actually read from the | 189 | The return value is the number of bytes actually read from the |
188 | TLS/SSL connection. | 190 | TLS connection. |
189 | .It 0 | 191 | .It 0 |
190 | The read operation was not successful. | 192 | The read operation was not successful. |
191 | The reason may either be a clean shutdown due to a | 193 | The reason may either be a clean shutdown due to a |
@@ -199,7 +201,7 @@ and | |||
199 | It is also possible that the peer simply shut down the underlying transport and | 201 | It is also possible that the peer simply shut down the underlying transport and |
200 | the shutdown is incomplete. | 202 | the shutdown is incomplete. |
201 | Call | 203 | Call |
202 | .Fn SSL_get_error | 204 | .Xr SSL_get_error 3 |
203 | with the return value to find out whether an error occurred or the connection | 205 | with the return value to find out whether an error occurred or the connection |
204 | was shut down cleanly | 206 | was shut down cleanly |
205 | .Pq Dv SSL_ERROR_ZERO_RETURN . | 207 | .Pq Dv SSL_ERROR_ZERO_RETURN . |
@@ -207,7 +209,7 @@ was shut down cleanly | |||
207 | The read operation was not successful, because either an error occurred or | 209 | The read operation was not successful, because either an error occurred or |
208 | action must be taken by the calling process. | 210 | action must be taken by the calling process. |
209 | Call | 211 | Call |
210 | .Fn SSL_get_error | 212 | .Xr SSL_get_error 3 |
211 | with the return value to find out the reason. | 213 | with the return value to find out the reason. |
212 | .El | 214 | .El |
213 | .Sh SEE ALSO | 215 | .Sh SEE ALSO |