diff options
| author | Dániel Szoboszlay <[email protected]> | 2014-05-13 10:39:36 +0200 |
|---|---|---|
| committer | Magnus Henoch <[email protected]> | 2016-09-28 15:09:42 +0100 |
| commit | cbc937f1c16964669a6d4865aeda2fcdeef9df0f (patch) | |
| tree | 74a65eafb13b6a271fec4730fe6f09356fe40d73 /lib/crypto/doc/src/crypto.xml | |
| parent | b6c83354ac6c3d37dd5f9891932302e4104606eb (diff) | |
| download | otp-cbc937f1c16964669a6d4865aeda2fcdeef9df0f.tar.gz otp-cbc937f1c16964669a6d4865aeda2fcdeef9df0f.tar.bz2 otp-cbc937f1c16964669a6d4865aeda2fcdeef9df0f.zip | |
Document FIPS mode support
Diffstat (limited to 'lib/crypto/doc/src/crypto.xml')
| -rw-r--r-- | lib/crypto/doc/src/crypto.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index ce8bf2216a..cbf141b3b0 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -475,6 +475,28 @@ </func> <func> + <name>info_fips() -> Status</name> + <fsummary>Provides information about the FIPS operating status.</fsummary> + <type> + <v>Status = enabled | not_enabled | not_supported</v> + </type> + <desc> + <p>Provides information about the FIPS operating status of + crypto and the underlying OpenSSL library. If crypto was built + with FIPS support this can be either <c>enabled</c> (when + running in FIPS mode) or <c>not_enabled</c>. For other builds + this value is always <c>not_supported</c>.</p> + <warning> + <p>In FIPS mode all non-FIPS compliant algorithms are + disabled and throw exception <c>not_supported</c>. Check + <seealso marker="#supports-0">supports</seealso> that in + FIPS mode returns the restricted list of available + algorithms.</p> + </warning> + </desc> + </func> + + <func> <name>info_lib() -> [{Name,VerNum,VerStr}]</name> <fsummary>Provides information about the libraries used by crypto.</fsummary> <type> |