summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/SSL_write.3ssl
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man3/SSL_write.3ssl')
-rw-r--r--upstream/archlinux/man3/SSL_write.3ssl65
1 files changed, 52 insertions, 13 deletions
diff --git a/upstream/archlinux/man3/SSL_write.3ssl b/upstream/archlinux/man3/SSL_write.3ssl
index 3545df46..02c15c77 100644
--- a/upstream/archlinux/man3/SSL_write.3ssl
+++ b/upstream/archlinux/man3/SSL_write.3ssl
@@ -55,19 +55,25 @@
.\" ========================================================================
.\"
.IX Title "SSL_WRITE 3ssl"
-.TH SSL_WRITE 3ssl 2024-01-30 3.2.1 OpenSSL
+.TH SSL_WRITE 3ssl 2024-04-28 3.3.0 OpenSSL
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
-SSL_write_ex, SSL_write, SSL_sendfile \- write bytes to a TLS/SSL connection
+SSL_write_ex2, SSL_write_ex, SSL_write, SSL_sendfile, SSL_WRITE_FLAG_CONCLUDE \-
+write bytes to a TLS/SSL connection
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
+\& #define SSL_WRITE_FLAG_CONCLUDE
+\&
\& ossl_ssize_t SSL_sendfile(SSL *s, int fd, off_t offset, size_t size, int flags);
+\& int SSL_write_ex2(SSL *s, const void *buf, size_t num,
+\& uint64_t flags,
+\& size_t *written);
\& 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);
.Ve
@@ -77,6 +83,10 @@ SSL_write_ex, SSL_write, SSL_sendfile \- write bytes to a TLS/SSL connection
the specified \fBssl\fR connection. On success \fBSSL_write_ex()\fR will store the number
of bytes written in \fB*written\fR.
.PP
+\&\fBSSL_write_ex2()\fR functions similarly to \fBSSL_write_ex()\fR but can also accept
+optional flags which modify its behaviour. Calling \fBSSL_write_ex2()\fR with a
+\&\fIflags\fR argument of 0 is exactly equivalent to calling \fBSSL_write_ex()\fR.
+.PP
\&\fBSSL_sendfile()\fR writes \fBsize\fR bytes from offset \fBoffset\fR in the file
descriptor \fBfd\fR to the specified SSL connection \fBs\fR. This function provides
efficient zero-copy semantics. \fBSSL_sendfile()\fR is available only when
@@ -84,6 +94,34 @@ Kernel TLS is enabled, which can be checked by calling \fBBIO_get_ktls_send()\fR
It is provided here to allow users to maintain the same interface.
The meaning of \fBflags\fR is platform dependent.
Currently, under Linux it is ignored.
+.PP
+The \fIflags\fR argument to \fBSSL_write_ex2()\fR can accept zero or more of the
+following flags. Note that which flags are supported will depend on the kind of
+SSL object and underlying protocol being used:
+.IP \fBSSL_WRITE_FLAG_CONCLUDE\fR 4
+.IX Item "SSL_WRITE_FLAG_CONCLUDE"
+This flag is only supported on QUIC stream SSL objects (or QUIC connection SSL
+objects with a default stream attached).
+.Sp
+If this flag is set, and the call to \fBSSL_write_ex2()\fR succeeds, and all of the
+data passed to the call is written (meaning that \f(CW\*(C`*written == num\*(C'\fR), the
+relevant QUIC stream's send part is concluded automatically as though
+\&\fBSSL_stream_conclude\fR\|(3) was called (causing transmission of a FIN for the
+stream).
+.Sp
+While using this flag is semantically equivalent to calling
+\&\fBSSL_stream_conclude\fR\|(3) after a successful call to this function, using this
+flag enables greater efficiency than making these two API calls separately, as
+it enables the written stream data and the FIN flag indicating the end of the
+stream to be scheduled as part of the same QUIC STREAM frame and QUIC packet.
+.Sp
+Setting this flag does not cause a stream's send part to be concluded if not all
+of the data passed to the call was consumed.
+.PP
+A call to \fBSSL_write_ex2()\fR fails if a flag is passed which is not supported or
+understood by the given SSL object. An application should determine if a flag is
+supported (for example, for \fBSSL_WRITE_FLAG_CONCLUDE\fR, that a QUIC stream SSL
+object is being used) before attempting to use it.
.SH NOTES
.IX Header "NOTES"
In the paragraphs below a "write function" is defined as one of either
@@ -145,16 +183,17 @@ You should not call \fBSSL_write()\fR with num=0, it will return an error.
the peer.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
-\&\fBSSL_write_ex()\fR 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 \fBSSL_get_error\fR\|(3) to find out
-the reason which indicates whether the call is retryable or not.
+\&\fBSSL_write_ex()\fR and \fBSSL_write_ex2()\fR 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
+\&\fBSSL_get_error\fR\|(3) to find out the reason which indicates whether the call is
+retryable or not.
.PP
For \fBSSL_write()\fR the following return values can occur:
.IP "> 0" 4
@@ -195,7 +234,7 @@ The \fBSSL_write_ex()\fR function was added in OpenSSL 1.1.1.
The \fBSSL_sendfile()\fR function was added in OpenSSL 3.0.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
-Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
.PP
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