summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorbeck <>2020-01-23 03:40:18 +0000
committerbeck <>2020-01-23 03:40:18 +0000
commit61fedc0310a1ba6f15f2242f24fbba7b3b8d3d8f (patch)
treea073915c9aac4a8847bb3476bf48e1344f037b32 /src/lib
parentad05f547c71854756a76beb175202b0f9a417234 (diff)
downloadopenbsd-61fedc0310a1ba6f15f2242f24fbba7b3b8d3d8f.tar.gz
openbsd-61fedc0310a1ba6f15f2242f24fbba7b3b8d3d8f.tar.bz2
openbsd-61fedc0310a1ba6f15f2242f24fbba7b3b8d3d8f.zip
Remove lies from the SSL_pending man page, Our implementation never
advances the record layer, it only reports internal state. ok jsing@ tb@
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libssl/man/SSL_pending.325
1 files changed, 3 insertions, 22 deletions
diff --git a/src/lib/libssl/man/SSL_pending.3 b/src/lib/libssl/man/SSL_pending.3
index b3efa4260d..bbc2e9bdd2 100644
--- a/src/lib/libssl/man/SSL_pending.3
+++ b/src/lib/libssl/man/SSL_pending.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: SSL_pending.3,v 1.4 2018/03/27 17:35:50 schwarze Exp $ 1.\" $OpenBSD: SSL_pending.3,v 1.5 2020/01/23 03:40:18 beck Exp $
2.\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 2.\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400
3.\" 3.\"
4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>, 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>,
@@ -50,7 +50,7 @@
50.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51.\" OF THE POSSIBILITY OF SUCH DAMAGE. 51.\" OF THE POSSIBILITY OF SUCH DAMAGE.
52.\" 52.\"
53.Dd $Mdocdate: March 27 2018 $ 53.Dd $Mdocdate: January 23 2020 $
54.Dt SSL_PENDING 3 54.Dt SSL_PENDING 3
55.Os 55.Os
56.Sh NAME 56.Sh NAME
@@ -67,37 +67,18 @@ is buffered until it is read by the application via a call to
67.Xr SSL_read 3 . 67.Xr SSL_read 3 .
68.Pp 68.Pp
69.Fn SSL_pending 69.Fn SSL_pending
70returns the number of bytes which are available inside 70returns the number of bytes of application data which are available
71.Fa ssl
72for immediate read. 71for immediate read.
73.Pp 72.Pp
74.Fn SSL_pending 73.Fn SSL_pending
75takes into account only bytes from the TLS/SSL record that is 74takes into account only bytes from the TLS/SSL record that is
76currently being processed (if any). 75currently being processed (if any).
77If the
78.Fa ssl->read_ahead
79flag is set (see
80.Xr SSL_CTX_set_read_ahead 3 ) ,
81additional protocol bytes beyond the current record may have been
82read containing more TLS/SSL records.
83This also applies to DTLS.
84These additional bytes will be buffered but will remain unprocessed
85until they are needed.
86As these bytes are still in an unprocessed state,
87.Fn SSL_pending
88will ignore them.
89Therefore it is possible for no more bytes to be readable from the
90underlying BIO (because the library has already read them) and for
91.Fn SSL_pending
92to return 0, even though readable application data bytes are available
93(because the data is in unprocessed buffered records).
94.Sh RETURN VALUES 76.Sh RETURN VALUES
95.Fn SSL_pending 77.Fn SSL_pending
96returns the number of buffered and processed application data 78returns the number of buffered and processed application data
97bytes that are pending and are available for immediate read. 79bytes that are pending and are available for immediate read.
98.Sh SEE ALSO 80.Sh SEE ALSO
99.Xr ssl 3 , 81.Xr ssl 3 ,
100.Xr SSL_CTX_set_read_ahead 3 ,
101.Xr SSL_read 3 82.Xr SSL_read 3
102.Sh HISTORY 83.Sh HISTORY
103.Fn SSL_pending 84.Fn SSL_pending