diff options
| author | Shane Lontis <shane.lontis@oracle.com> | 2020-09-02 09:08:09 +1000 |
|---|---|---|
| committer | Shane Lontis <shane.lontis@oracle.com> | 2020-09-18 06:20:33 +1000 |
| commit | 7f9e74403677a995ded00f070d84297401f6e3fd (patch) | |
| tree | a8eb5cc00e8ca3ae7e4c5e82263430ba12675d3a /doc | |
| parent | 4b51903d8681c7fd429c566548529d5753e24f47 (diff) | |
Add selftest callback to CRNG output test
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12795)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_SELF_TEST_new.pod | 5 | ||||
| -rw-r--r-- | doc/man7/OSSL_PROVIDER-FIPS.pod | 8 |
2 files changed, 12 insertions, 1 deletions
diff --git a/doc/man3/OSSL_SELF_TEST_new.pod b/doc/man3/OSSL_SELF_TEST_new.pod index b2c4f5ccce..744c82e204 100644 --- a/doc/man3/OSSL_SELF_TEST_new.pod +++ b/doc/man3/OSSL_SELF_TEST_new.pod @@ -17,7 +17,7 @@ OSSL_SELF_TEST_onend - functionality to trigger a callback during a self test void OSSL_SELF_TEST_onbegin(OSSL_SELF_TEST *st, const char *type, const char *desc); - void OSSL_SELF_TEST_oncorrupt_byte(OSSL_SELF_TEST *st, unsigned char *bytes); + int OSSL_SELF_TEST_oncorrupt_byte(OSSL_SELF_TEST *st, unsigned char *bytes); void OSSL_SELF_TEST_onend(OSSL_SELF_TEST *st, int ret); =head1 DESCRIPTION @@ -104,6 +104,9 @@ This allows the callback to identify the sub category of the test being run. OSSL_SELF_TEST_new() returns the allocated B<OSSL_SELF_TEST> object, or NULL if it fails. +OSSL_SELF_TEST_oncorrupt_byte() returns 1 if corruption occurs, otherwise it +returns 0. + =head1 EXAMPLES A single self test could be set up in the following way: diff --git a/doc/man7/OSSL_PROVIDER-FIPS.pod b/doc/man7/OSSL_PROVIDER-FIPS.pod index 2ae999e023..98c6079d72 100644 --- a/doc/man7/OSSL_PROVIDER-FIPS.pod +++ b/doc/man7/OSSL_PROVIDER-FIPS.pod @@ -212,6 +212,10 @@ Known answer test for a Deterministic Random Bit Generator. Conditional test that is run during the generation of key pairs. +=item "Continuous_RNG_Test" (B<OSSL_SELF_TEST_TYPE_CRNG>) + +Continuous random number generator test. + =back The "Module_Integrity" self test is always run at startup. @@ -289,6 +293,10 @@ Key Derivation Function tests used with the "KAT_KDF" type. DRBG tests used with the "DRBG" type. += item "RNG" (B<OSSL_SELF_TEST_DESC_RNG>) + +"Continuous_RNG_Test" uses this. + =back =head1 EXAMPLES |