mirror of
https://github.com/opnsense/src.git
synced 2026-06-09 08:43:19 -04: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
68 lines
1.5 KiB
Text
68 lines
1.5 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
const char *SSL_rstate_string(SSL *ssl);
|
|
const char *SSL_rstate_string_long(SSL *ssl);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
SSL_rstate_string() returns a 2 letter string indicating the current read state
|
|
of the SSL object B<ssl>.
|
|
|
|
SSL_rstate_string_long() returns a string indicating the current read state of
|
|
the SSL object B<ssl>.
|
|
|
|
=head1 NOTES
|
|
|
|
When performing a read operation, the SSL/TLS engine must parse the record,
|
|
consisting of header and body. When working in a blocking environment,
|
|
SSL_rstate_string[_long]() should always return "RD"/"read done".
|
|
|
|
This function should only seldom be needed in applications.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
SSL_rstate_string() and SSL_rstate_string_long() can return the following
|
|
values:
|
|
|
|
=over 4
|
|
|
|
=item "RH"/"read header"
|
|
|
|
The header of the record is being evaluated.
|
|
|
|
=item "RB"/"read body"
|
|
|
|
The body of the record is being evaluated.
|
|
|
|
=item "RD"/"read done"
|
|
|
|
The record has been completely processed.
|
|
|
|
=item "unknown"/"unknown"
|
|
|
|
The read state is unknown. This should never happen.
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ssl(7)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2001-2016 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
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|