Merging upstream version 4.23.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 38 insertions, 12 deletions

diff --git a/upstream/debian-unstable/man3/BIO_s_mem.3ssl b/upstream/debian-unstable/man3/BIO_s_mem.3ssl
index 1c11c319..556b1eae 100644
--- a/upstream/debian-unstable/man3/BIO_s_mem.3ssl
+++ b/upstream/debian-unstable/man3/BIO_s_mem.3ssl
@@ -55,13 +55,13 @@
 .\" ========================================================================
 .\"
 .IX Title "BIO_S_MEM 3SSL"
-.TH BIO_S_MEM 3SSL 2024-02-03 3.1.5 OpenSSL
+.TH BIO_S_MEM 3SSL 2024-04-04 3.2.2-dev 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
-BIO_s_secmem,
+BIO_s_secmem, BIO_s_dgram_mem,
 BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
 BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
 .SH SYNOPSIS
@@ -70,6 +70,7 @@ BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
 \& #include <openssl/bio.h>
 \&
 \& const BIO_METHOD *BIO_s_mem(void);
+\& const BIO_METHOD *BIO_s_dgram_mem(void);
 \& const BIO_METHOD *BIO_s_secmem(void);
 \&
 \& BIO_set_mem_eof_return(BIO *b, int v);
@@ -90,11 +91,31 @@ as appropriate to accommodate the stored data.
 \&\fBBIO_s_secmem()\fR is like \fBBIO_s_mem()\fR except that the secure heap is used
 for buffer storage.
 .PP
+\&\fBBIO_s_dgram_mem()\fR is a memory BIO that respects datagram semantics. A single
+call to \fBBIO_write\fR\|(3) will write a single datagram to the memory BIO. A
+subsequent call to \fBBIO_read\fR\|(3) will read the data in that datagram. The
+\&\fBBIO_read\fR\|(3) call will never return more data than was written in the original
+\&\fBBIO_write\fR\|(3) call even if there were subsequent \fBBIO_write\fR\|(3) calls that
+wrote more datagrams. Each successive call to \fBBIO_read\fR\|(3) will read the next
+datagram. If a \fBBIO_read\fR\|(3) call supplies a read buffer that is smaller than
+the size of the datagram, then the read buffer will be completely filled and the
+remaining data from the datagram will be discarded.
+.PP
+It is not possible to write a zero length datagram. Calling \fBBIO_write\fR\|(3) in
+this case will return 0 and no datagrams will be written. Calling \fBBIO_read\fR\|(3)
+when there are no datagrams in the BIO to read will return a negative result and
+the "retry" flags will be set (i.e. calling \fBBIO_should_retry\fR\|(3) will return
+true). A datagram mem BIO will never return true from \fBBIO_eof\fR\|(3).
+.PP
 Any data written to a memory BIO can be recalled by reading from it.
 Unless the memory BIO is read only any data read from it is deleted from
 the BIO.
 .PP
-Memory BIOs support \fBBIO_gets()\fR and \fBBIO_puts()\fR.
+Memory BIOs except \fBBIO_s_dgram_mem()\fR support \fBBIO_gets()\fR and \fBBIO_puts()\fR.
+.PP
+\&\fBBIO_s_dgram_mem()\fR supports \fBBIO_sendmmsg\fR\|(3) and \fBBIO_recvmmsg\fR\|(3) calls
+and calls related to \fBBIO_ADDR\fR and MTU handling similarly to the
+\&\fBBIO_s_dgram_pair\fR\|(3).
 .PP
 If the BIO_CLOSE flag is set when a memory BIO is freed then the underlying
 BUF_MEM structure is also freed.
@@ -115,6 +136,7 @@ it will return zero and BIO_should_retry(b) will be false. If \fBv\fR is non
 zero then it will return \fBv\fR when it is empty and it will set the read retry
 flag (that is BIO_read_retry(b) is true). To avoid ambiguity with a normal
 positive return value \fBv\fR should be set to a negative value, typically \-1.
+Calling this macro will fail for datagram mem BIOs.
 .PP
 \&\fBBIO_get_mem_data()\fR sets *\fBpp\fR to a pointer to the start of the memory BIOs data
 and returns the total amount of data available. It is implemented as a macro.
@@ -135,10 +157,16 @@ as a result cannot be written to. This is useful when some data needs to be
 made available from a static area of memory in the form of a BIO. The
 supplied data is read directly from the supplied buffer: it is \fBnot\fR copied
 first, so the supplied area of memory must be unchanged until the BIO is freed.
+.PP
+All of the five functions described above return an error with
+\&\fBBIO_s_dgram_mem()\fR.
 .SH NOTES
 .IX Header "NOTES"
 Writes to memory BIOs will always succeed if memory is available: that is
-their size can grow indefinitely.
+their size can grow indefinitely. An exception is \fBBIO_s_dgram_mem()\fR when
+\&\fBBIO_set_write_buf_size\fR\|(3) is called on it. In such case the write buffer
+size will be fixed and any writes that would overflow the buffer will return
+an error.
 .PP
 Every write after partial read (not all data in the memory buffer was read)
 to a read write memory BIO will have to move the unread data with an internal
@@ -146,15 +174,15 @@ copy operation, if a BIO contains a lot of data and it is read in small
 chunks intertwined with writes the operation can be very slow. Adding
 a buffering BIO to the chain can speed up the process.
 .PP
-Calling \fBBIO_set_mem_buf()\fR on a BIO created with \fBBIO_new_secmem()\fR will
-give undefined results, including perhaps a program crash.
+Calling \fBBIO_set_mem_buf()\fR on a secmem or dgram BIO will give undefined results,
+including perhaps a program crash.
 .PP
-Switching the memory BIO from read write to read only is not supported and
+Switching a memory BIO from read write to read only is not supported and
 can give undefined results including a program crash. There are two notable
 exceptions to the rule. The first one is to assign a static memory buffer
 immediately after BIO creation and set the BIO as read only.
 .PP
-The other supported sequence is to start with read write BIO then temporarily
+The other supported sequence is to start with a read write BIO then temporarily
 switch it to read only and call \fBBIO_reset()\fR on the read only BIO immediately
 before switching it back to read write. Before the BIO is freed it must be
 switched back to the read write mode.
@@ -177,12 +205,10 @@ BIO_FLAGS_NONCLEAR_RST set has the same effect as a write operation.
 Calling \fBBIO_set_close()\fR with BIO_NOCLOSE orphans the BUF_MEM internal to the
 BIO, _not_ its actual data buffer. See the examples section for the proper
 method for claiming ownership of the data pointer for a deferred free operation.
-.SH BUGS
-.IX Header "BUGS"
-There should be an option to set the maximum size of a memory BIO.
 .SH "RETURN VALUES"
 .IX Header "RETURN VALUES"
-\&\fBBIO_s_mem()\fR and \fBBIO_s_secmem()\fR return a valid memory \fBBIO_METHOD\fR structure.
+\&\fBBIO_s_mem()\fR, \fBBIO_s_dgram_mem()\fR and \fBBIO_s_secmem()\fR return a valid memory
+\&\fBBIO_METHOD\fR structure.
 .PP
 \&\fBBIO_set_mem_eof_return()\fR, \fBBIO_set_mem_buf()\fR and \fBBIO_get_mem_ptr()\fR
 return 1 on success or a value which is less than or equal to 0 if an error occurred.