mirror of
https://github.com/freebsd/freebsd-src
synced 2024-07-08 20:26:31 +00: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
124 lines
3.7 KiB
Plaintext
124 lines
3.7 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
fips_config - OpenSSL FIPS configuration
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
A separate configuration file, using the OpenSSL L<config(5)> syntax,
|
|
is used to hold information about the FIPS module. This includes a digest
|
|
of the shared library file, and status about the self-testing.
|
|
This data is used automatically by the module itself for two
|
|
purposes:
|
|
|
|
=over 4
|
|
|
|
=item - Run the startup FIPS self-test known answer tests (KATS).
|
|
|
|
This is normally done once, at installation time, but may also be set up to
|
|
run each time the module is used.
|
|
|
|
=item - Verify the module's checksum.
|
|
|
|
This is done each time the module is used.
|
|
|
|
=back
|
|
|
|
This file is generated by the L<openssl-fipsinstall(1)> program, and
|
|
used internally by the FIPS module during its initialization.
|
|
|
|
The following options are supported. They should all appear in a section
|
|
whose name is identified by the B<fips> option in the B<providers>
|
|
section, as described in L<config(5)/Provider Configuration Module>.
|
|
|
|
=over 4
|
|
|
|
=item B<activate>
|
|
|
|
If present, the module is activated. The value assigned to this name is not
|
|
significant.
|
|
|
|
=item B<install-version>
|
|
|
|
A version number for the fips install process. Should be 1.
|
|
|
|
=item B<conditional-errors>
|
|
|
|
The FIPS module normally enters an internal error mode if any self test fails.
|
|
Once this error mode is active, no services or cryptographic algorithms are
|
|
accessible from this point on.
|
|
Continuous tests are a subset of the self tests (e.g., a key pair test during key
|
|
generation, or the CRNG output test).
|
|
Setting this value to C<0> allows the error mode to not be triggered if any
|
|
continuous test fails. The default value of C<1> will trigger the error mode.
|
|
Regardless of the value, the operation (e.g., key generation) that called the
|
|
continuous test will return an error code if its continuous test fails. The
|
|
operation may then be retried if the error mode has not been triggered.
|
|
|
|
=item B<security-checks>
|
|
|
|
This indicates if run-time checks related to enforcement of security parameters
|
|
such as minimum security strength of keys and approved curve names are used.
|
|
A value of '1' will perform the checks, otherwise if the value is '0' the checks
|
|
are not performed and FIPS compliance must be done by procedures documented in
|
|
the relevant Security Policy.
|
|
|
|
=item B<module-mac>
|
|
|
|
The calculated MAC of the FIPS provider file.
|
|
|
|
=item B<install-status>
|
|
|
|
An indicator that the self-tests were successfully run.
|
|
This should only be written after the module has
|
|
successfully passed its self tests during installation.
|
|
If this field is not present, then the self tests will run when the module
|
|
loads.
|
|
|
|
=item B<install-mac>
|
|
|
|
A MAC of the value of the B<install-status> option, to prevent accidental
|
|
changes to that value.
|
|
It is written-to at the same time as B<install-status> is updated.
|
|
|
|
=back
|
|
|
|
For example:
|
|
|
|
[fips_sect]
|
|
activate = 1
|
|
install-version = 1
|
|
conditional-errors = 1
|
|
security-checks = 1
|
|
module-mac = 41:D0:FA:C2:5D:41:75:CD:7D:C3:90:55:6F:A4:DC
|
|
install-mac = FE:10:13:5A:D3:B4:C7:82:1B:1E:17:4C:AC:84:0C
|
|
install-status = INSTALL_SELF_TEST_KATS_RUN
|
|
|
|
=head1 NOTES
|
|
|
|
When using the FIPS provider, it is recommended that the
|
|
B<config_diagnostics> option is enabled to prevent accidental use of
|
|
non-FIPS validated algorithms via broken or mistaken configuration.
|
|
See L<config(5)>.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<config(5)>
|
|
L<openssl-fipsinstall(1)>
|
|
|
|
=head1 HISTORY
|
|
|
|
This functionality was added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2019-2021 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
|