mirror of
https://github.com/openssl/openssl.git
synced 2025-01-12 13:36:28 +08:00
fc68cf21b5
Similar to other KDFs, the input key should be 112 bits long. Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Paul Dale <ppzgs1@gmail.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/25529)
244 lines
6.3 KiB
Plaintext
244 lines
6.3 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<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<module-mac>
|
|
|
|
The calculated MAC of the FIPS provider file.
|
|
|
|
=item B<install-version>
|
|
|
|
A version number for the fips install process. Should be 1.
|
|
|
|
=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
|
|
|
|
=head2 FIPS indicator options
|
|
|
|
The following FIPS configuration options indicate if run-time checks related to
|
|
enforcement of FIPS 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.
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> for further information related to these
|
|
options.
|
|
|
|
=over 4
|
|
|
|
=item B<security-checks>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-no_security_checks>
|
|
|
|
=item B<tls1-prf-ems-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-ems_check>
|
|
|
|
=item B<no-short-mac>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-no_short_mac>
|
|
|
|
=item B<drbg-no-trunc-md>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-no_drbg_truncated_digests>
|
|
|
|
=item B<signature-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-signature_digest_check>
|
|
|
|
=item B<hkdf-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-hkdf_digest_check>
|
|
|
|
=item B<tls13-kdf-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-tls13_kdf_digest_check>
|
|
|
|
=item B<tls1-prf-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-tls1_prf_digest_check>
|
|
|
|
=item B<sshkdf-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-sshkdf_digest_check>
|
|
|
|
=item B<sskdf-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-sskdf_digest_check>
|
|
|
|
=item B<x963kdf-digest-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-x963kdf_digest_check>
|
|
|
|
=item B<dsa-sign-disabled>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-dsa_sign_disabled>
|
|
|
|
=item B<tdes-encrypt-disabled>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-tdes_encrypt_disabled>
|
|
|
|
=item B<rsa-pkcs15-pad-disabled>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-rsa_pkcs15_pad_disabled>
|
|
|
|
=item B<rsa-pss-saltlen-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-rsa_pss_saltlen_check>
|
|
|
|
=item B<rsa-sign-x931-pad-disabled>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-rsa_sign_x931_disabled>
|
|
|
|
=item B<hkdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-hkdf_key_check>
|
|
|
|
=item B<kbkdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-kbkdf_key_check>
|
|
|
|
=item B<tls13-kdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-tls13_kdf_key_check>
|
|
|
|
=item B<tls1-prf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-tls1_prf_key_check>
|
|
|
|
=item B<sshkdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-sshkdf_key_check>
|
|
|
|
=item B<sskdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-sskdf_key_check>
|
|
|
|
=item B<x963kdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-x963kdf_key_check>
|
|
|
|
=item B<x942kdf-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-x942kdf_key_check>
|
|
|
|
=item B<pbkdf2-lower-bound-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-no_pbkdf2_lower_bound_check>
|
|
|
|
=item B<ecdh-cofactor-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-ecdh_cofactor_check>
|
|
|
|
=item B<hmac-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-hmac_key_check>
|
|
|
|
=item B<kmac-key-check>
|
|
|
|
See L<openssl-fipsinstall(1)/OPTIONS> B<-kmac_key_check>
|
|
|
|
=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-2024 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
|