openssl/doc
Simo Sorce 7962a7ec98 Clarify and expand FIPS deferred tests design
Add a new "Examples" section to the design document to illustrate the intended
behavior of the self-test mechanism. These examples cover simple tests,
composite algorithms, and the specific semantics of the `also_satisfies` and
`depends_on` lists.

This change also clarifies several key points:
- The `also_satisfies` list is not processed recursively, while `depends_on`
is.
- The entire FIPS module will enter a failure state if any individual self-
test fails.

Finally, the document is updated with various grammatical fixes and improved
wording for better readability.

Signed-off-by: Simo Sorce <simo@redhat.com>

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/29004)
2025-11-26 08:50:25 +11:00
..
HOWTO Document update for keys.txt 2025-04-15 17:15:23 +01:00
designs Clarify and expand FIPS deferred tests design 2025-11-26 08:50:25 +11:00
images update logo 2024-10-21 11:49:25 +01:00
internal CMP doc: update RFC 4210 -> 9810, RFC 6712 -> 9811 2025-11-19 14:31:42 +01:00
life-cycles Add EVP_DigestSqueeze() API. 2023-11-10 13:27:00 +01:00
man1 Correct information about the default value of the -md parameter 2025-11-21 08:45:50 -05:00
man3 doc: Discuss calling X509_verify_cert in cert_verify_callback 2025-11-24 19:22:20 +01:00
man5 Expand and clarify SSL_CTX_config(3) docs. 2025-11-21 15:13:09 +01:00
man7 pbkdf2: enable setting minimum password length at build time 2025-11-26 08:48:02 +11:00
README.md Update doc README URLs 2025-03-03 09:40:30 +01:00
build.info Properly error out when AEAD Algorithms are used with Encrypted Data 2025-11-10 20:41:44 +01:00
build.info.in
dir-locals.example.el
fingerprints.txt Drop the old PGP key fingerprint 2024-06-06 16:03:38 +02:00
openssl-c-indent.el
perlvars.pm Copyright year updates 2025-03-12 13:35:59 +00:00
sbom.cdx.json Add a SBOM template in CycloneDX format 2025-04-03 09:11:29 +02:00

README.md

OpenSSL Documentation

README.md This file

fingerprints.txt PGP fingerprints of authorised release signers

HOWTO/ A few how-to documents; not necessarily up-to-date

man1/ The openssl command-line tools; start with openssl.pod

man3/ The SSL library and the crypto library

man5/ File formats

man7/ Overviews; start with crypto.pod and ssl.pod, for example Algorithm specific EVP_PKEY documentation.

Formatted versions of the manpages (apps,ssl,crypto) can be found at https://docs.openssl.org/master/