mirror of
https://github.com/opnsense/src.git
synced 2026-02-27 11:50:47 -05:00
b077aed33b
Migrate to OpenSSL 3.0 in advance of FreeBSD 14.0. OpenSSL 1.1.1 (the version we were previously using) will be EOL as of 2023-09-11. Most of the base system has already been updated for a seamless switch to OpenSSL 3.0. For many components we've added `-DOPENSSL_API_COMPAT=0x10100000L` to CFLAGS to specify the API version, which avoids deprecation warnings from OpenSSL 3.0. Changes have also been made to avoid OpenSSL APIs that were already deprecated in OpenSSL 1.1.1. The process of updating to contemporary APIs can continue after this merge. Additional changes are still required for libarchive and Kerberos- related libraries or tools; workarounds will immediately follow this commit. Fixes are in progress in the upstream projects and will be incorporated when those are next updated. There are some performance regressions in benchmarks (certain tests in `openssl speed`) and in some OpenSSL consumers in ports (e.g. haproxy). Investigation will continue for these. Netflix's testing showed no functional regression and a rather small, albeit statistically significant, increase in CPU consumption with OpenSSL 3.0. Thanks to ngie@ and des@ for updating base system components, to antoine@ and bofh@ for ports exp-runs and port fixes/workarounds, and to Netflix and everyone who tested prior to commit or contributed to this update in other ways. PR: 271615 PR: 271656 [exp-run] Relnotes: Yes Sponsored by: The FreeBSD Foundation
273 lines
11 KiB
Groff
273 lines
11 KiB
Groff
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
. ds C`
|
|
. ds C'
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is >0, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==0)) \{\
|
|
. if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
. \}
|
|
.\}
|
|
.rr rF
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "SSL_WRITE 3"
|
|
.TH SSL_WRITE 3 "2023-05-30" "3.0.9" "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
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& 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);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fBSSL_write_ex()\fR and \fBSSL_write()\fR write \fBnum\fR bytes from the buffer \fBbuf\fR into
|
|
the specified \fBssl\fR connection. On success \fBSSL_write_ex()\fR will store the number
|
|
of bytes written in \fB*written\fR.
|
|
.PP
|
|
\&\fBSSL_sendfile()\fR writes \fBsize\fR bytes from offset \fBoffset\fR in the file
|
|
descriptor \fBfd\fR to the specified \s-1SSL\s0 connection \fBs\fR. This function provides
|
|
efficient zero-copy semantics. \fBSSL_sendfile()\fR is available only when
|
|
Kernel \s-1TLS\s0 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.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
In the paragraphs below a \*(L"write function\*(R" is defined as one of either
|
|
\&\fBSSL_write_ex()\fR, or \fBSSL_write()\fR.
|
|
.PP
|
|
If necessary, a write function will negotiate a \s-1TLS/SSL\s0 session, if not already
|
|
explicitly performed by \fBSSL_connect\fR\|(3) or \fBSSL_accept\fR\|(3). 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 \s-1BIO.\s0
|
|
.PP
|
|
For the transparent negotiation to succeed, the \fBssl\fR must have been
|
|
initialized to client or server mode. This is being done by calling
|
|
\&\fBSSL_set_connect_state\fR\|(3) or \fBSSL_set_accept_state()\fR
|
|
before the first call to a write function.
|
|
.PP
|
|
If the underlying \s-1BIO\s0 is \fBblocking\fR, the write functions will only return, once
|
|
the write operation has been finished or an error occurred.
|
|
.PP
|
|
If the underlying \s-1BIO\s0 is \fBnonblocking\fR the write functions will also return
|
|
when the underlying \s-1BIO\s0 could not satisfy the needs of the function to continue
|
|
the operation. In this case a call to \fBSSL_get_error\fR\|(3) with the
|
|
return value of the write function will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR
|
|
or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. 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 \s-1BIO.\s0 When using a
|
|
nonblocking socket, nothing is to be done, but \fBselect()\fR can be used to check
|
|
for the required condition. When using a buffering \s-1BIO,\s0 like a \s-1BIO\s0 pair, data
|
|
must be written into or retrieved out of the \s-1BIO\s0 before being able to continue.
|
|
.PP
|
|
The write functions will only return with success when the complete contents of
|
|
\&\fBbuf\fR of length \fBnum\fR has been written. This default behaviour can be changed
|
|
with the \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 option of \fBSSL_CTX_set_mode\fR\|(3). 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.
|
|
.SH "WARNINGS"
|
|
.IX Header "WARNINGS"
|
|
When a write function call has to be repeated because \fBSSL_get_error\fR\|(3)
|
|
returned \fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR, it must be repeated
|
|
with the same arguments.
|
|
The data that was passed might have been partially processed.
|
|
When \fB\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0\fR was set using \fBSSL_CTX_set_mode\fR\|(3)
|
|
the pointer can be different, but the data and length should still be the same.
|
|
.PP
|
|
You should not call \fBSSL_write()\fR with num=0, it will return an error.
|
|
\&\fBSSL_write_ex()\fR can be called with num=0, but will not send application data to
|
|
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 \s-1SSL\s0 connection or,
|
|
if \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is in use, at least 1 application data byte has
|
|
been written to the \s-1SSL\s0 connection. Failure means that not all the requested
|
|
bytes have been written yet (if \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is not in use) or
|
|
no bytes could be written to the \s-1SSL\s0 connection (if
|
|
\&\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 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
|
|
.IX Item "> 0"
|
|
The write operation was successful, the return value is the number of
|
|
bytes actually written to the \s-1TLS/SSL\s0 connection.
|
|
.IP "<= 0" 4
|
|
.IX Item "<= 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 \fBSSL_get_error()\fR with the return value \fBret\fR to find out the reason.
|
|
.Sp
|
|
Old documentation indicated a difference between 0 and \-1, and that \-1 was
|
|
retryable.
|
|
You should instead call \fBSSL_get_error()\fR to find out if it's retryable.
|
|
.PP
|
|
For \fBSSL_sendfile()\fR, the following return values can occur:
|
|
.IP ">= 0" 4
|
|
.IX Item ">= 0"
|
|
The write operation was successful, the return value is the number
|
|
of bytes of the file written to the \s-1TLS/SSL\s0 connection. The return
|
|
value can be less than \fBsize\fR for a partial write.
|
|
.IP "< 0" 4
|
|
.IX Item "< 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 \fBSSL_get_error()\fR with the return value to find out the reason.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fBSSL_get_error\fR\|(3), \fBSSL_read_ex\fR\|(3), \fBSSL_read\fR\|(3)
|
|
\&\fBSSL_CTX_set_mode\fR\|(3), \fBSSL_CTX_new\fR\|(3),
|
|
\&\fBSSL_connect\fR\|(3), \fBSSL_accept\fR\|(3)
|
|
\&\fBSSL_set_connect_state\fR\|(3), \fBBIO_ctrl\fR\|(3),
|
|
\&\fBssl\fR\|(7), \fBbio\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
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\-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|