mirror of
https://github.com/openssl/openssl.git
synced 2024-12-15 06:01:37 +08:00
cd715b7e7f
TLS device offload allows to perform zerocopy sendfile transmissions. FreeBSD provides this feature by default, and Linux 5.19 introduced it as an opt-in. Zerocopy improves the TX rate significantly, but has a side effect: if the underlying file is changed while being transmitted, and a TCP retransmission happens, the receiver may get a TLS record containing both new and old data, which leads to an authentication failure and termination of connection. This effect is the reason Linux makes a copy on sendfile by default. This commit adds support for TLS zerocopy sendfile on Linux disabled by default to avoid any unlikely backward compatibility issues on Linux, although sacrificing consistency in OpenSSL's behavior on Linux and FreeBSD. A new option called KTLSTxZerocopySendfile is added to enable the new zerocopy behavior on Linux. This option should be used when the the application guarantees that the file is not modified during transmission, or it doesn't care about breaking the connection. The related documentation is also added in this commit. The unit test added doesn't test the actual functionality (it would require specific hardware and a non-local peer), but solely checks that it's possible to set the new option flag. Signed-off-by: Maxim Mikityanskiy <maximmi@nvidia.com> Reviewed-by: Tariq Toukan <tariqt@nvidia.com> Reviewed-by: Boris Pismenny <borisp@nvidia.com> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Todd Short <todd.short@me.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/18650)
102 lines
4.2 KiB
C
102 lines
4.2 KiB
C
/*
|
|
* Copyright 2016-2022 The OpenSSL Project Authors. All Rights Reserved.
|
|
*
|
|
* Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
* this file except in compliance with the License. You can obtain a copy
|
|
* in the file LICENSE in the source distribution or at
|
|
* https://www.openssl.org/source/license.html
|
|
*/
|
|
|
|
#ifndef OSSL_INTERNAL_BIO_H
|
|
# define OSSL_INTERNAL_BIO_H
|
|
# pragma once
|
|
|
|
# include <openssl/core.h>
|
|
# include <openssl/bio.h>
|
|
|
|
struct bio_method_st {
|
|
int type;
|
|
char *name;
|
|
int (*bwrite) (BIO *, const char *, size_t, size_t *);
|
|
int (*bwrite_old) (BIO *, const char *, int);
|
|
int (*bread) (BIO *, char *, size_t, size_t *);
|
|
int (*bread_old) (BIO *, char *, int);
|
|
int (*bputs) (BIO *, const char *);
|
|
int (*bgets) (BIO *, char *, int);
|
|
long (*ctrl) (BIO *, int, long, void *);
|
|
int (*create) (BIO *);
|
|
int (*destroy) (BIO *);
|
|
long (*callback_ctrl) (BIO *, int, BIO_info_cb *);
|
|
int (*bsendmmsg) (BIO *, BIO_MSG *, size_t, size_t, uint64_t, size_t *);
|
|
int (*brecvmmsg) (BIO *, BIO_MSG *, size_t, size_t, uint64_t, size_t *);
|
|
};
|
|
|
|
void bio_free_ex_data(BIO *bio);
|
|
void bio_cleanup(void);
|
|
|
|
|
|
/* Old style to new style BIO_METHOD conversion functions */
|
|
int bwrite_conv(BIO *bio, const char *data, size_t datal, size_t *written);
|
|
int bread_conv(BIO *bio, char *data, size_t datal, size_t *read);
|
|
|
|
/* Changes to these internal BIOs must also update include/openssl/bio.h */
|
|
# define BIO_CTRL_SET_KTLS 72
|
|
# define BIO_CTRL_SET_KTLS_TX_SEND_CTRL_MSG 74
|
|
# define BIO_CTRL_CLEAR_KTLS_TX_CTRL_MSG 75
|
|
# define BIO_CTRL_SET_KTLS_TX_ZEROCOPY_SENDFILE 90
|
|
|
|
/*
|
|
* This is used with socket BIOs:
|
|
* BIO_FLAGS_KTLS_TX means we are using ktls with this BIO for sending.
|
|
* BIO_FLAGS_KTLS_TX_CTRL_MSG means we are about to send a ctrl message next.
|
|
* BIO_FLAGS_KTLS_RX means we are using ktls with this BIO for receiving.
|
|
* BIO_FLAGS_KTLS_TX_ZEROCOPY_SENDFILE means we are using the zerocopy mode with
|
|
* this BIO for sending using sendfile.
|
|
*/
|
|
# define BIO_FLAGS_KTLS_TX_CTRL_MSG 0x1000
|
|
# define BIO_FLAGS_KTLS_RX 0x2000
|
|
# define BIO_FLAGS_KTLS_TX 0x4000
|
|
# define BIO_FLAGS_KTLS_TX_ZEROCOPY_SENDFILE 0x8000
|
|
|
|
/* KTLS related controls and flags */
|
|
# define BIO_set_ktls_flag(b, is_tx) \
|
|
BIO_set_flags(b, (is_tx) ? BIO_FLAGS_KTLS_TX : BIO_FLAGS_KTLS_RX)
|
|
# define BIO_should_ktls_flag(b, is_tx) \
|
|
BIO_test_flags(b, (is_tx) ? BIO_FLAGS_KTLS_TX : BIO_FLAGS_KTLS_RX)
|
|
# define BIO_set_ktls_ctrl_msg_flag(b) \
|
|
BIO_set_flags(b, BIO_FLAGS_KTLS_TX_CTRL_MSG)
|
|
# define BIO_should_ktls_ctrl_msg_flag(b) \
|
|
BIO_test_flags(b, BIO_FLAGS_KTLS_TX_CTRL_MSG)
|
|
# define BIO_clear_ktls_ctrl_msg_flag(b) \
|
|
BIO_clear_flags(b, BIO_FLAGS_KTLS_TX_CTRL_MSG)
|
|
# define BIO_set_ktls_zerocopy_sendfile_flag(b) \
|
|
BIO_set_flags(b, BIO_FLAGS_KTLS_TX_ZEROCOPY_SENDFILE)
|
|
|
|
# define BIO_set_ktls(b, keyblob, is_tx) \
|
|
BIO_ctrl(b, BIO_CTRL_SET_KTLS, is_tx, keyblob)
|
|
# define BIO_set_ktls_ctrl_msg(b, record_type) \
|
|
BIO_ctrl(b, BIO_CTRL_SET_KTLS_TX_SEND_CTRL_MSG, record_type, NULL)
|
|
# define BIO_clear_ktls_ctrl_msg(b) \
|
|
BIO_ctrl(b, BIO_CTRL_CLEAR_KTLS_TX_CTRL_MSG, 0, NULL)
|
|
# define BIO_set_ktls_tx_zerocopy_sendfile(b) \
|
|
BIO_ctrl(b, BIO_CTRL_SET_KTLS_TX_ZEROCOPY_SENDFILE, 0, NULL)
|
|
|
|
/* Functions to allow the core to offer the CORE_BIO type to providers */
|
|
OSSL_CORE_BIO *ossl_core_bio_new_from_bio(BIO *bio);
|
|
OSSL_CORE_BIO *ossl_core_bio_new_file(const char *filename, const char *mode);
|
|
OSSL_CORE_BIO *ossl_core_bio_new_mem_buf(const void *buf, int len);
|
|
int ossl_core_bio_read_ex(OSSL_CORE_BIO *cb, void *data, size_t dlen,
|
|
size_t *readbytes);
|
|
int ossl_core_bio_write_ex(OSSL_CORE_BIO *cb, const void *data, size_t dlen,
|
|
size_t *written);
|
|
int ossl_core_bio_gets(OSSL_CORE_BIO *cb, char *buf, int size);
|
|
int ossl_core_bio_puts(OSSL_CORE_BIO *cb, const char *buf);
|
|
long ossl_core_bio_ctrl(OSSL_CORE_BIO *cb, int cmd, long larg, void *parg);
|
|
int ossl_core_bio_up_ref(OSSL_CORE_BIO *cb);
|
|
int ossl_core_bio_free(OSSL_CORE_BIO *cb);
|
|
int ossl_core_bio_vprintf(OSSL_CORE_BIO *cb, const char *format, va_list args);
|
|
|
|
int ossl_bio_init_core(OSSL_LIB_CTX *libctx, const OSSL_DISPATCH *fns);
|
|
|
|
#endif
|