diff options
| author | Todd Short <tshort@akamai.com> | 2021-09-08 16:23:04 -0400 |
|---|---|---|
| committer | Todd Short <todd.short@me.com> | 2022-03-10 10:42:43 -0500 |
| commit | a3e53d56831adb60d6875297b3339a4251f735d2 (patch) | |
| tree | c931c5b2cc9a63f80e4f3ae3a366b70064b897ae /doc/man3/BIO_ctrl.pod | |
| parent | 97896f744d9ee4f2e821e3383caac8e8c5f226cf (diff) | |
Add TFO support to socket BIO and s_client/s_server
Supports Linux, MacOS and FreeBSD
Disabled by default, enabled via `enabled-tfo`
Some tests
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/8692)
Diffstat (limited to 'doc/man3/BIO_ctrl.pod')
| -rw-r--r-- | doc/man3/BIO_ctrl.pod | 30 |
1 files changed, 29 insertions, 1 deletions
diff --git a/doc/man3/BIO_ctrl.pod b/doc/man3/BIO_ctrl.pod index cfb505e314..4ba8c54539 100644 --- a/doc/man3/BIO_ctrl.pod +++ b/doc/man3/BIO_ctrl.pod @@ -6,7 +6,7 @@ BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset, BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close, BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending, BIO_get_info_callback, BIO_set_info_callback, BIO_info_cb, BIO_get_ktls_send, -BIO_get_ktls_recv +BIO_get_ktls_recv, BIO_set_conn_mode, BIO_get_conn_mode, BIO_set_tfo - BIO control operations =head1 SYNOPSIS @@ -38,6 +38,11 @@ BIO_get_ktls_recv int BIO_get_ktls_send(BIO *b); int BIO_get_ktls_recv(BIO *b); + int BIO_set_conn_mode(BIO *b, int mode); + int BIO_get_conn_mode(BIO *b); + + int BIO_set_tfo(BIO *b, int onoff); + =head1 DESCRIPTION BIO_ctrl(), BIO_callback_ctrl(), BIO_ptr_ctrl() and BIO_int_ctrl() @@ -81,6 +86,13 @@ sending. Otherwise, it returns zero. It also returns negative values for failure BIO_get_ktls_recv() returns 1 if the BIO is using the Kernel TLS data-path for receiving. Otherwise, it returns zero. It also returns negative values for failure. +BIO_get_conn_mode() returns the BIO connection mode. BIO_set_conn_mode() sets +the BIO connection mode. + +BIO_set_tfo() disables TCP Fast Open when B<onoff> is 0, and enables TCP Fast +Open when B<onoff> is nonzero. Setting the value to 1 is equivalent to setting +B<BIO_SOCK_TFO> in BIO_set_conn_mode(). + =head1 RETURN VALUES BIO_reset() normally returns 1 for success and <=0 for failure. File @@ -107,6 +119,19 @@ sending. Otherwise, it returns zero. BIO_get_ktls_recv() returns 1 if the BIO is using the Kernel TLS data-path for receiving. Otherwise, it returns zero. +BIO_set_conn_mode() returns 1 for success and 0 for failure. BIO_get_conn_mode() +returns the current connection mode. Which may contain the bitwise-or of the +following flags: + + BIO_SOCK_REUSEADDR + BIO_SOCK_V6_ONLY + BIO_SOCK_KEEPALIVE + BIO_SOCK_NONBLOCK + BIO_SOCK_NODELAY + BIO_SOCK_TFO + +BIO_set_tfo() returns 1 for success, and 0 for failure. + =head1 NOTES BIO_flush(), because it can write data may return 0 or -1 indicating @@ -144,6 +169,9 @@ the case of BIO_seek() on a file BIO for a successful operation. The BIO_get_ktls_send() and BIO_get_ktls_recv() functions were added in OpenSSL 3.0. +The BIO_get_conn_mode(), BIO_set_conn_mode() and BIO_set_tfo() functions +were added in OpenSSL 3.1. + =head1 COPYRIGHT Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved. |