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
81 lines
2.2 KiB
Text
81 lines
2.2 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
OSSL_DISPATCH - OpenSSL Core type to define a dispatchable function table
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/core.h>
|
|
|
|
typedef struct ossl_dispatch_st OSSL_DISPATCH;
|
|
struct ossl_dispatch_st {
|
|
int function_id;
|
|
void (*function)(void);
|
|
};
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This type is a tuple of function identity and function pointer.
|
|
Arrays of this type are passed between the OpenSSL libraries and the
|
|
providers to describe what functionality one side provides to the other.
|
|
|
|
Arrays of this type must be terminated with a tuple having function identity
|
|
zero and function pointer NULL.
|
|
|
|
=head2 B<OSSL_DISPATCH> fields
|
|
|
|
=over 4
|
|
|
|
=item I<function_id>
|
|
|
|
OpenSSL defined function identity of the implemented function.
|
|
|
|
=item I<function>
|
|
|
|
Pointer to the implemented function itself. Despite the generic definition
|
|
of this field, the implemented function it points to must have a function
|
|
signature that corresponds to the I<function_id>
|
|
|
|
=back
|
|
|
|
Available function identities and corresponding function signatures are
|
|
defined in L<openssl-core_dispatch.h(7)>.
|
|
Furthermore, the chosen function identities and associated function
|
|
signature must be chosen specifically for the operation that it's intended
|
|
for, as determined by the intended L<OSSL_ALGORITHM(3)> array.
|
|
|
|
Any function identity not recognised by the recipient of this type
|
|
will be ignored.
|
|
This ensures that providers built with one OpenSSL version in mind
|
|
will work together with any other OpenSSL version that supports this
|
|
mechanism.
|
|
|
|
=begin comment RETURN VALUES doesn't make sense for a manual that only
|
|
describes a type, but document checkers still want that section, and
|
|
to have more than just the section title.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
txt
|
|
|
|
=end comment
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<crypto(7)>, L<openssl-core_dispatch.h(7)>, L<OSSL_ALGORITHM(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
B<OSSL_DISPATCH> was added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2022 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
|