diff --git a/crypto/openssl/doc/man3/SSL_write.pod b/crypto/openssl/doc/man3/SSL_write.pod index 20c7953deb06..9b271d8e65a2 100644 --- a/crypto/openssl/doc/man3/SSL_write.pod +++ b/crypto/openssl/doc/man3/SSL_write.pod @@ -1,155 +1,156 @@ =pod =head1 NAME SSL_write_ex, SSL_write, SSL_sendfile - write bytes to a TLS/SSL connection =head1 SYNOPSIS #include ossl_ssize_t SSL_sendfile(SSL *s, int fd, off_t offset, size_t size, int flags); int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written); int SSL_write(SSL *ssl, const void *buf, int num); =head1 DESCRIPTION SSL_write_ex() and SSL_write() write B bytes from the buffer B into the specified B connection. On success SSL_write_ex() will store the number of bytes written in B<*written>. SSL_sendfile() writes B bytes from offset B in the file descriptor B to the specified SSL connection B. This function provides efficient zero-copy semantics. SSL_sendfile() is available only when Kernel TLS is enabled, which can be checked by calling BIO_get_ktls_send(). It is provided here to allow users to maintain the same interface. The meaning of B is platform dependent. Currently, under Linux it is ignored. =head1 NOTES In the paragraphs below a "write function" is defined as one of either SSL_write_ex(), or SSL_write(). If necessary, a write function will negotiate a TLS/SSL session, if not already explicitly performed by L or L. If the peer requests a re-negotiation, it will be performed transparently during the write function operation. The behaviour of the write functions depends on the underlying BIO. For the transparent negotiation to succeed, the B must have been initialized to client or server mode. This is being done by calling L or SSL_set_accept_state() before the first call to a write function. If the underlying BIO is B, the write functions will only return, once the write operation has been finished or an error occurred. If the underlying BIO is B the write functions will also return when the underlying BIO could not satisfy the needs of the function to continue the operation. In this case a call to L with the return value of the write function will yield B or B. As at any time a re-negotiation is possible, a call to a write function can also cause read operations! The calling process then must repeat the call after taking appropriate action to satisfy the needs of the write function. The action depends on the underlying BIO. When using a nonblocking socket, nothing is to be done, but select() can be used to check for the required condition. When using a buffering BIO, like a BIO pair, data must be written into or retrieved out of the BIO before being able to continue. The write functions will only return with success when the complete contents of B of length B has been written. This default behaviour can be changed with the SSL_MODE_ENABLE_PARTIAL_WRITE option of L. When this flag is set the write functions will also return with success when a partial write has been successfully completed. In this case the write function operation is considered completed. The bytes are sent and a new write call with a new buffer (with the already sent bytes removed) must be started. A partial write is performed with the size of a message block, which is 16kB. =head1 WARNINGS When a write function call has to be repeated because L returned B or B, it must be repeated with the same arguments. The data that was passed might have been partially processed. When B was set using L the pointer can be different, but the data and length should still be the same. You should not call SSL_write() with num=0, it will return an error. SSL_write_ex() can be called with num=0, but will not send application data to the peer. =head1 RETURN VALUES SSL_write_ex() will return 1 for success or 0 for failure. Success means that all requested application data bytes have been written to the SSL connection or, if SSL_MODE_ENABLE_PARTIAL_WRITE is in use, at least 1 application data byte has been written to the SSL connection. Failure means that not all the requested bytes have been written yet (if SSL_MODE_ENABLE_PARTIAL_WRITE is not in use) or no bytes could be written to the SSL connection (if SSL_MODE_ENABLE_PARTIAL_WRITE is in use). Failures can be retryable (e.g. the network write buffer has temporarily filled up) or non-retryable (e.g. a fatal network error). In the event of a failure call L to find out the reason which indicates whether the call is retryable or not. For SSL_write() the following return values can occur: =over 4 =item E 0 The write operation was successful, the return value is the number of bytes actually written to the TLS/SSL connection. =item Z<><= 0 The write operation was not successful, because either the connection was closed, an error occurred or action must be taken by the calling process. Call SSL_get_error() with the return value B to find out the reason. Old documentation indicated a difference between 0 and -1, and that -1 was retryable. You should instead call SSL_get_error() to find out if it's retryable. =back For SSL_sendfile(), the following return values can occur: =over 4 =item Z<>>= 0 The write operation was successful, the return value is the number -of bytes of the file written to the TLS/SSL connection. +of bytes of the file written to the TLS/SSL connection. The return +value can be less than B for a partial write. =item E 0 The write operation was not successful, because either the connection was closed, an error occured or action must be taken by the calling process. Call SSL_get_error() with the return value to find out the reason. =back =head1 SEE ALSO L, L, L L, L, L, L L, L, L, L =head1 HISTORY The SSL_write_ex() function was added in OpenSSL 1.1.1. The SSL_sendfile() function was added in OpenSSL 3.0.0. =head1 COPYRIGHT Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (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 L. =cut diff --git a/crypto/openssl/include/internal/ktls.h b/crypto/openssl/include/internal/ktls.h index 9032c0ed6174..622d7be76d1e 100644 --- a/crypto/openssl/include/internal/ktls.h +++ b/crypto/openssl/include/internal/ktls.h @@ -1,403 +1,400 @@ /* * Copyright 2018 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 */ #if defined(OPENSSL_SYS_LINUX) # ifndef OPENSSL_NO_KTLS # include # if LINUX_VERSION_CODE < KERNEL_VERSION(4, 13, 0) # define OPENSSL_NO_KTLS # ifndef PEDANTIC # warning "KTLS requires Kernel Headers >= 4.13.0" # warning "Skipping Compilation of KTLS" # endif # endif # endif #endif #ifndef HEADER_INTERNAL_KTLS # define HEADER_INTERNAL_KTLS # ifndef OPENSSL_NO_KTLS # if defined(__FreeBSD__) # include # include # include # include # include # include "openssl/ssl3.h" # ifndef TCP_RXTLS_ENABLE # define OPENSSL_NO_KTLS_RX # endif # define OPENSSL_KTLS_AES_GCM_128 # define OPENSSL_KTLS_AES_GCM_256 # define OPENSSL_KTLS_TLS13 /* * Only used by the tests in sslapitest.c. */ # define TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE 8 # define TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE 8 typedef struct tls_enable ktls_crypto_info_t; /* * FreeBSD does not require any additional steps to enable KTLS before * setting keys. */ static ossl_inline int ktls_enable(int fd) { return 1; } /* * The TCP_TXTLS_ENABLE socket option marks the outgoing socket buffer * as using TLS. If successful, then data sent using this socket will * be encrypted and encapsulated in TLS records using the tls_en * provided here. * * The TCP_RXTLS_ENABLE socket option marks the incoming socket buffer * as using TLS. If successful, then data received for this socket will * be authenticated and decrypted using the tls_en provided here. */ static ossl_inline int ktls_start(int fd, ktls_crypto_info_t *tls_en, int is_tx) { if (is_tx) return setsockopt(fd, IPPROTO_TCP, TCP_TXTLS_ENABLE, tls_en, sizeof(*tls_en)) ? 0 : 1; # ifndef OPENSSL_NO_KTLS_RX return setsockopt(fd, IPPROTO_TCP, TCP_RXTLS_ENABLE, tls_en, sizeof(*tls_en)) ? 0 : 1; # else return 0; # endif } /* * Send a TLS record using the tls_en provided in ktls_start and use * record_type instead of the default SSL3_RT_APPLICATION_DATA. * When the socket is non-blocking, then this call either returns EAGAIN or * the entire record is pushed to TCP. It is impossible to send a partial * record using this control message. */ static ossl_inline int ktls_send_ctrl_message(int fd, unsigned char record_type, const void *data, size_t length) { struct msghdr msg = { 0 }; int cmsg_len = sizeof(record_type); struct cmsghdr *cmsg; char buf[CMSG_SPACE(cmsg_len)]; struct iovec msg_iov; /* Vector of data to send/receive into */ msg.msg_control = buf; msg.msg_controllen = sizeof(buf); cmsg = CMSG_FIRSTHDR(&msg); cmsg->cmsg_level = IPPROTO_TCP; cmsg->cmsg_type = TLS_SET_RECORD_TYPE; cmsg->cmsg_len = CMSG_LEN(cmsg_len); *((unsigned char *)CMSG_DATA(cmsg)) = record_type; msg.msg_controllen = cmsg->cmsg_len; msg_iov.iov_base = (void *)data; msg_iov.iov_len = length; msg.msg_iov = &msg_iov; msg.msg_iovlen = 1; return sendmsg(fd, &msg, 0); } # ifdef OPENSSL_NO_KTLS_RX static ossl_inline int ktls_read_record(int fd, void *data, size_t length) { return -1; } # else /* !defined(OPENSSL_NO_KTLS_RX) */ /* * Receive a TLS record using the tls_en provided in ktls_start. The * kernel strips any explicit IV and authentication tag, but provides * the TLS record header via a control message. If there is an error * with the TLS record such as an invalid header, invalid padding, or * authentication failure recvmsg() will fail with an error. */ static ossl_inline int ktls_read_record(int fd, void *data, size_t length) { struct msghdr msg = { 0 }; int cmsg_len = sizeof(struct tls_get_record); struct tls_get_record *tgr; struct cmsghdr *cmsg; char buf[CMSG_SPACE(cmsg_len)]; struct iovec msg_iov; /* Vector of data to send/receive into */ int ret; unsigned char *p = data; const size_t prepend_length = SSL3_RT_HEADER_LENGTH; if (length <= prepend_length) { errno = EINVAL; return -1; } msg.msg_control = buf; msg.msg_controllen = sizeof(buf); msg_iov.iov_base = p + prepend_length; msg_iov.iov_len = length - prepend_length; msg.msg_iov = &msg_iov; msg.msg_iovlen = 1; ret = recvmsg(fd, &msg, 0); if (ret <= 0) return ret; if ((msg.msg_flags & (MSG_EOR | MSG_CTRUNC)) != MSG_EOR) { errno = EMSGSIZE; return -1; } if (msg.msg_controllen == 0) { errno = EBADMSG; return -1; } cmsg = CMSG_FIRSTHDR(&msg); if (cmsg->cmsg_level != IPPROTO_TCP || cmsg->cmsg_type != TLS_GET_RECORD || cmsg->cmsg_len != CMSG_LEN(cmsg_len)) { errno = EBADMSG; return -1; } tgr = (struct tls_get_record *)CMSG_DATA(cmsg); p[0] = tgr->tls_type; p[1] = tgr->tls_vmajor; p[2] = tgr->tls_vminor; *(uint16_t *)(p + 3) = htons(ret); return ret + prepend_length; } # endif /* OPENSSL_NO_KTLS_RX */ /* * KTLS enables the sendfile system call to send data from a file over * TLS. */ static ossl_inline ossl_ssize_t ktls_sendfile(int s, int fd, off_t off, size_t size, int flags) { - off_t sbytes; + off_t sbytes = 0; int ret; ret = sendfile(fd, s, off, size, NULL, &sbytes, flags); - if (ret == -1) { - if (errno == EAGAIN && sbytes != 0) - return sbytes; - return -1; - } + if (ret == -1 && sbytes == 0) + return -1; return sbytes; } # endif /* __FreeBSD__ */ # if defined(OPENSSL_SYS_LINUX) # include # if LINUX_VERSION_CODE < KERNEL_VERSION(4, 17, 0) # define OPENSSL_NO_KTLS_RX # ifndef PEDANTIC # warning "KTLS requires Kernel Headers >= 4.17.0 for receiving" # warning "Skipping Compilation of KTLS receive data path" # endif # endif # define OPENSSL_KTLS_AES_GCM_128 # if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 1, 0) # define OPENSSL_KTLS_AES_GCM_256 # define OPENSSL_KTLS_TLS13 # if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 2, 0) # define OPENSSL_KTLS_AES_CCM_128 # endif # endif # include # include # include # include "openssl/ssl3.h" # include "openssl/tls1.h" # include "openssl/evp.h" # ifndef SOL_TLS # define SOL_TLS 282 # endif # ifndef TCP_ULP # define TCP_ULP 31 # endif # ifndef TLS_RX # define TLS_RX 2 # endif struct tls_crypto_info_all { union { # ifdef OPENSSL_KTLS_AES_GCM_128 struct tls12_crypto_info_aes_gcm_128 gcm128; # endif # ifdef OPENSSL_KTLS_AES_GCM_256 struct tls12_crypto_info_aes_gcm_256 gcm256; # endif # ifdef OPENSSL_KTLS_AES_CCM_128 struct tls12_crypto_info_aes_ccm_128 ccm128; # endif }; size_t tls_crypto_info_len; }; typedef struct tls_crypto_info_all ktls_crypto_info_t; /* * When successful, this socket option doesn't change the behaviour of the * TCP socket, except changing the TCP setsockopt handler to enable the * processing of SOL_TLS socket options. All other functionality remains the * same. */ static ossl_inline int ktls_enable(int fd) { return setsockopt(fd, SOL_TCP, TCP_ULP, "tls", sizeof("tls")) ? 0 : 1; } /* * The TLS_TX socket option changes the send/sendmsg handlers of the TCP socket. * If successful, then data sent using this socket will be encrypted and * encapsulated in TLS records using the crypto_info provided here. * The TLS_RX socket option changes the recv/recvmsg handlers of the TCP socket. * If successful, then data received using this socket will be decrypted, * authenticated and decapsulated using the crypto_info provided here. */ static ossl_inline int ktls_start(int fd, ktls_crypto_info_t *crypto_info, int is_tx) { return setsockopt(fd, SOL_TLS, is_tx ? TLS_TX : TLS_RX, crypto_info, crypto_info->tls_crypto_info_len) ? 0 : 1; } /* * Send a TLS record using the crypto_info provided in ktls_start and use * record_type instead of the default SSL3_RT_APPLICATION_DATA. * When the socket is non-blocking, then this call either returns EAGAIN or * the entire record is pushed to TCP. It is impossible to send a partial * record using this control message. */ static ossl_inline int ktls_send_ctrl_message(int fd, unsigned char record_type, const void *data, size_t length) { struct msghdr msg; int cmsg_len = sizeof(record_type); struct cmsghdr *cmsg; union { struct cmsghdr hdr; char buf[CMSG_SPACE(sizeof(unsigned char))]; } cmsgbuf; struct iovec msg_iov; /* Vector of data to send/receive into */ memset(&msg, 0, sizeof(msg)); msg.msg_control = cmsgbuf.buf; msg.msg_controllen = sizeof(cmsgbuf.buf); cmsg = CMSG_FIRSTHDR(&msg); cmsg->cmsg_level = SOL_TLS; cmsg->cmsg_type = TLS_SET_RECORD_TYPE; cmsg->cmsg_len = CMSG_LEN(cmsg_len); *((unsigned char *)CMSG_DATA(cmsg)) = record_type; msg.msg_controllen = cmsg->cmsg_len; msg_iov.iov_base = (void *)data; msg_iov.iov_len = length; msg.msg_iov = &msg_iov; msg.msg_iovlen = 1; return sendmsg(fd, &msg, 0); } /* * KTLS enables the sendfile system call to send data from a file over TLS. * @flags are ignored on Linux. (placeholder for FreeBSD sendfile) * */ static ossl_inline ossl_ssize_t ktls_sendfile(int s, int fd, off_t off, size_t size, int flags) { return sendfile(s, fd, &off, size); } # ifdef OPENSSL_NO_KTLS_RX static ossl_inline int ktls_read_record(int fd, void *data, size_t length) { return -1; } # else /* !defined(OPENSSL_NO_KTLS_RX) */ /* * Receive a TLS record using the crypto_info provided in ktls_start. * The kernel strips the TLS record header, IV and authentication tag, * returning only the plaintext data or an error on failure. * We add the TLS record header here to satisfy routines in rec_layer_s3.c */ static ossl_inline int ktls_read_record(int fd, void *data, size_t length) { struct msghdr msg; struct cmsghdr *cmsg; union { struct cmsghdr hdr; char buf[CMSG_SPACE(sizeof(unsigned char))]; } cmsgbuf; struct iovec msg_iov; int ret; unsigned char *p = data; const size_t prepend_length = SSL3_RT_HEADER_LENGTH; if (length < prepend_length + EVP_GCM_TLS_TAG_LEN) { errno = EINVAL; return -1; } memset(&msg, 0, sizeof(msg)); msg.msg_control = cmsgbuf.buf; msg.msg_controllen = sizeof(cmsgbuf.buf); msg_iov.iov_base = p + prepend_length; msg_iov.iov_len = length - prepend_length - EVP_GCM_TLS_TAG_LEN; msg.msg_iov = &msg_iov; msg.msg_iovlen = 1; ret = recvmsg(fd, &msg, 0); if (ret < 0) return ret; if (msg.msg_controllen > 0) { cmsg = CMSG_FIRSTHDR(&msg); if (cmsg->cmsg_type == TLS_GET_RECORD_TYPE) { p[0] = *((unsigned char *)CMSG_DATA(cmsg)); p[1] = TLS1_2_VERSION_MAJOR; p[2] = TLS1_2_VERSION_MINOR; /* returned length is limited to msg_iov.iov_len above */ p[3] = (ret >> 8) & 0xff; p[4] = ret & 0xff; ret += prepend_length; } } return ret; } # endif /* OPENSSL_NO_KTLS_RX */ # endif /* OPENSSL_SYS_LINUX */ # endif /* OPENSSL_NO_KTLS */ #endif /* HEADER_INTERNAL_KTLS */