Skip to content

Commit

Permalink
doc: update FIPS provider version information
Browse files Browse the repository at this point in the history
With 3.0.8 validated, we need to note this in the documentation.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com>
(Merged from #21049)

(cherry picked from commit 73f59aa)
  • Loading branch information
paulidale committed Jun 1, 2023
1 parent a1798d1 commit 4e258b5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
18 changes: 13 additions & 5 deletions doc/man7/OSSL_PROVIDER-FIPS.pod
Expand Up @@ -428,6 +428,17 @@ A simple self test callback is shown below for illustrative purposes.

=head1 NOTES

Some released versions of OpenSSL do not include a validated
FIPS provider. To determine which versions have undergone
the validation process, please refer to the
L<OpenSSL Downloads page|https://www.openssl.org/source/>. If you
require FIPS-approved functionality, it is essential to build your FIPS
provider using one of the validated versions listed there. Normally,
it is possible to utilize a FIPS provider constructed from one of the
validated versions alongside F<libcrypto> and F<libssl> compiled from any
release within the same major release series. This flexibility enables
you to address bug fixes and CVEs that fall outside the FIPS boundary.

The FIPS provider in OpenSSL 3.1 includes some non-FIPS validated algorithms,
consequently the property query C<fips=yes> is mandatory for applications that
want to operate in a FIPS approved manner. The algorithms are:
Expand All @@ -451,16 +462,13 @@ L<OSSL_SELF_TEST_new(3)>,
L<OSSL_PARAM(3)>,
L<openssl-core.h(7)>,
L<openssl-core_dispatch.h(7)>,
L<provider(7)>
L<provider(7)>,
L<https://www.openssl.org/source/>

=head1 HISTORY

This functionality was added in OpenSSL 3.0.

OpenSSL 3.0 includes a FIPS 140-2 approved FIPS provider.

OpenSSL 3.1 includes a FIPS 140-3 approved FIPS provider.

=head1 COPYRIGHT

Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
Expand Down
18 changes: 13 additions & 5 deletions doc/man7/fips_module.pod
Expand Up @@ -470,6 +470,17 @@ L<OSSL_PROVIDER_get0_name(3)>.

=head1 NOTES

Some released versions of OpenSSL do not include a validated
FIPS provider. To determine which versions have undergone
the validation process, please refer to the
L<OpenSSL Downloads page|https://www.openssl.org/source/>. If you
require FIPS-approved functionality, it is essential to build your FIPS
provider using one of the validated versions listed there. Normally,
it is possible to utilize a FIPS provider constructed from one of the
validated versions alongside F<libcrypto> and F<libssl> compiled from any
release within the same major release series. This flexibility enables
you to address bug fixes and CVEs that fall outside the FIPS boundary.

The FIPS provider in OpenSSL 3.1 includes some non-FIPS validated algorithms,
consequently the property query C<fips=yes> is mandatory for applications that
want to operate in a FIPS approved manner. The algorithms are:
Expand All @@ -486,17 +497,14 @@ want to operate in a FIPS approved manner. The algorithms are:

=head1 SEE ALSO

L<migration_guide(7)>, L<crypto(7)>, L<fips_config(5)>
L<migration_guide(7)>, L<crypto(7)>, L<fips_config(5)>,
L<https://www.openssl.org/source/>

=head1 HISTORY

The FIPS module guide was created for use with the new FIPS provider
in OpenSSL 3.0.

OpenSSL 3.0 includes a FIPS 140-2 approved FIPS provider.

OpenSSL 3.1 includes a FIPS 140-3 approved FIPS provider.

=head1 COPYRIGHT

Copyright 2021-2023 The OpenSSL Project Authors. All Rights Reserved.
Expand Down

0 comments on commit 4e258b5

Please sign in to comment.