PR: 2522
[openssl.git] / fips / rand / fips_drbg_selftest.c
index e94a5d8e79a43abe812dbfabd705ecf48412b0c1..881bce041d5002f82af79f66a88e11e248d21ec1 100644 (file)
@@ -60,6 +60,7 @@
 #include <openssl/err.h>
 #include <openssl/fips_rand.h>
 #include "fips_rand_lcl.h"
+#include "fips_locl.h"
 
 typedef struct {
        int nid;
@@ -82,7 +83,7 @@ typedef struct {
        size_t katlen;
        } DRBG_SELFTEST_DATA;
 
-#define make_drbg_test_data(nid, flag, pr) { nid, flag, \
+#define make_drbg_test_data(nid, flag, pr) { nid, flag | DRBG_FLAG_TEST, \
        pr##_entropyinput, sizeof(pr##_entropyinput), \
        pr##_nonce, sizeof(pr##_nonce), \
        pr##_personalizationstring, sizeof(pr##_personalizationstring), \
@@ -688,7 +689,7 @@ static const unsigned char sha512_additionalinput2[] =
        0x41,0xbe,0x14,0x87,0x81,0x08,0x0d,0xee
        };
 /* NB: not constant so we can corrupt it */
-static unsigned char sha512_entropyinputpr2[] =
+static const unsigned char sha512_entropyinputpr2[] =
        {
        0xed,0x22,0x42,0x61,0xa7,0x4c,0xed,0xc7,0x10,0x82,0x61,0x17,
        0xaa,0x7d,0xdb,0x4e,0x1c,0x96,0x61,0x23,0xcd,0x8f,0x84,0x77,
@@ -710,7 +711,7 @@ static const unsigned char sha512_returnedbits[] =
 static DRBG_SELFTEST_DATA drbg_test[] = {
        make_drbg_test_data_df(NID_aes_128_ctr, aes_128_use_df),
        make_drbg_test_data_df(NID_aes_192_ctr, aes_192_use_df),
-       make_drbg_test_data_df(NID_aes_192_ctr, aes_192_use_df),
+       make_drbg_test_data_df(NID_aes_256_ctr, aes_256_use_df),
        make_drbg_test_data(NID_aes_128_ctr, 0, aes_128_no_df),
        make_drbg_test_data(NID_aes_192_ctr, 0, aes_192_no_df),
        make_drbg_test_data(NID_aes_256_ctr, 0, aes_256_no_df),
@@ -726,39 +727,39 @@ typedef struct
        {
        const unsigned char *ent;
        size_t entlen;
+       int entcnt;
        const unsigned char *nonce;
        size_t noncelen;
+       int noncecnt;
        } TEST_ENT;
 
-static size_t test_entropy(DRBG_CTX *dctx, unsigned char *out,
+static size_t test_entropy(DRBG_CTX *dctx, unsigned char **pout,
                                 int entropy, size_t min_len, size_t max_len)
        {
        TEST_ENT *t = FIPS_drbg_get_app_data(dctx);
-       memcpy(out, t->ent, t->entlen);
+       *pout = (unsigned char *)t->ent;
+       t->entcnt++;
        return t->entlen;
        }
 
-static size_t test_nonce(DRBG_CTX *dctx, unsigned char *out,
+static size_t test_nonce(DRBG_CTX *dctx, unsigned char **pout,
                                 int entropy, size_t min_len, size_t max_len)
        {
        TEST_ENT *t = FIPS_drbg_get_app_data(dctx);
-       memcpy(out, t->nonce, t->noncelen);
+       *pout = (unsigned char *)t->nonce;
+       t->noncecnt++;
        return t->noncelen;
        }
 
-void FIPS_corrupt_drbg(void)
-       {
-       sha512_entropyinputpr2[0]++;
-       }
-
 static int fips_drbg_single_kat(DRBG_CTX *dctx, DRBG_SELFTEST_DATA *td)
        {
        TEST_ENT t;
        int rv = 0;
+       size_t adinlen;
        unsigned char randout[1024];
        if (!FIPS_drbg_init(dctx, td->nid, td->flags))
                return 0;
-       if (!FIPS_drbg_set_test_mode(dctx, test_entropy, test_nonce))
+       if (!FIPS_drbg_set_callbacks(dctx, test_entropy, 0, 0, test_nonce, 0))
                return 0;
 
        FIPS_drbg_set_app_data(dctx, &t);
@@ -767,15 +768,25 @@ static int fips_drbg_single_kat(DRBG_CTX *dctx, DRBG_SELFTEST_DATA *td)
        t.entlen = td->entlen;
        t.nonce = td->nonce;
        t.noncelen = td->noncelen;
+       t.entcnt = 0;
+       t.noncecnt = 0;
 
-       if (!FIPS_drbg_instantiate(dctx, 0, td->pers, td->perslen))
+       if (!FIPS_drbg_instantiate(dctx, td->pers, td->perslen))
                goto err;
 
        t.ent = td->entpr;
        t.entlen = td->entprlen;
 
+       /* Note for CTR without DF some additional input values
+        * ignore bytes after the keylength: so reduce adinlen
+        * to half to ensure invalid data is fed in.
+        */
+       if (!fips_post_corrupt(FIPS_TEST_DRBG, dctx->type, &dctx->flags))
+               adinlen = td->adinlen / 2;
+       else
+               adinlen = td->adinlen;
        if (!FIPS_drbg_generate(dctx, randout, td->katlen, 0, 1,
-                               td->adin, td->adinlen))
+                               td->adin, adinlen))
                goto err;
 
        t.ent = td->entg;
@@ -791,18 +802,219 @@ static int fips_drbg_single_kat(DRBG_CTX *dctx, DRBG_SELFTEST_DATA *td)
        rv = 1;
 
        err:
+       if (rv == 0)
+               FIPSerr(FIPS_F_FIPS_DRBG_SINGLE_KAT, FIPS_R_SELFTEST_FAILED);
        FIPS_drbg_uninstantiate(dctx);
        
        return rv;
        }
 
+/* This is the "health check" function required by SP800-90. Induce several
+ * failure modes and check an error condition is set.
+ */
+
+static int fips_drbg_health_check(DRBG_CTX *dctx, DRBG_SELFTEST_DATA *td)
+       {
+       unsigned char randout[1024];
+       TEST_ENT t;
+       size_t i;
+       unsigned char *p = (unsigned char *)dctx;
+
+       /* Initialise DRBG */
+
+       if (!FIPS_drbg_init(dctx, td->nid, td->flags))
+               goto err;
+
+       if (!FIPS_drbg_set_callbacks(dctx, test_entropy, 0, 0, test_nonce, 0))
+               goto err;
+
+       FIPS_drbg_set_app_data(dctx, &t);
+
+       t.ent = td->ent;
+       t.entlen = td->entlen;
+       t.nonce = td->nonce;
+       t.noncelen = td->noncelen;
+       t.entcnt = 0;
+       t.noncecnt = 0;
+
+       /* Don't report induced errors */
+       dctx->flags |= DRBG_FLAG_NOERR;
+
+       /* Try too large a personalisation length */
+       if (FIPS_drbg_instantiate(dctx, td->pers, dctx->max_pers + 1) > 0)
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_PERSONALISATION_ERROR_UNDETECTED);
+               goto err;
+               }
+
+       /* Test entropy source failure detection */
+
+       t.entlen = 0;
+       if (FIPS_drbg_instantiate(dctx, td->pers, td->perslen) > 0)
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_ENTROPY_ERROR_UNDETECTED);
+               goto err;
+               }
+
+       /* Try to generate output from uninstantiated DRBG */
+       if (FIPS_drbg_generate(dctx, randout, td->katlen, 0, 0,
+                               td->adin, td->adinlen))
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_GENERATE_ERROR_UNDETECTED);
+               goto err;
+               }
+
+       dctx->flags &= ~DRBG_FLAG_NOERR;
+       if (!FIPS_drbg_uninstantiate(dctx))
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_UNINSTANTIATE_ERROR);
+               goto err;
+               }
+
+       /* Instantiate with valid data. NB: errors now reported again */
+       if (!FIPS_drbg_init(dctx, td->nid, td->flags))
+               goto err;
+       if (!FIPS_drbg_set_callbacks(dctx, test_entropy, 0, 0, test_nonce, 0))
+               goto err;
+       FIPS_drbg_set_app_data(dctx, &t);
+
+       t.entlen = td->entlen;
+       if (!FIPS_drbg_instantiate(dctx, td->pers, td->perslen))
+               goto err;
+
+       /* Check generation is now OK */
+       if (!FIPS_drbg_generate(dctx, randout, td->katlen, 0, 0,
+                               td->adin, td->adinlen))
+               goto err;
+
+       /* Try to generate with too high a strength.
+        */
+
+       dctx->flags |= DRBG_FLAG_NOERR;
+       if (dctx->strength != 256)
+               {
+               if (FIPS_drbg_generate(dctx, randout, td->katlen, 256, 0,
+                                       td->adin, td->adinlen))
+                       {
+                       FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_STRENGTH_ERROR_UNDETECTED);
+
+                       goto err;
+                       }
+               }
+
+       /* Request too much data for one request */
+       if (FIPS_drbg_generate(dctx, randout, dctx->max_request + 1, 0, 0,
+                               td->adin, td->adinlen))
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_REQUEST_LENGTH_ERROR_UNDETECTED);
+               goto err;
+               }
+
+       /* Check prediction resistance request fails if entropy source
+        * failure.
+        */
+
+       t.entlen = 0;
+
+       if (FIPS_drbg_generate(dctx, randout, td->katlen, 0, 1,
+                               td->adin, td->adinlen))
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_ENTROPY_ERROR_UNDETECTED);
+               goto err;
+               }
+               
+       dctx->flags &= ~DRBG_FLAG_NOERR;
+
+       if (!FIPS_drbg_uninstantiate(dctx))
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_UNINSTANTIATE_ERROR);
+               goto err;
+               }
+
+
+       /* Instantiate again with valid data */
+
+       if (!FIPS_drbg_init(dctx, td->nid, td->flags))
+               goto err;
+       if (!FIPS_drbg_set_callbacks(dctx, test_entropy, 0, 0, test_nonce, 0))
+               goto err;
+       FIPS_drbg_set_app_data(dctx, &t);
+
+       t.entlen = td->entlen;
+       /* Test reseeding works */
+       dctx->reseed_interval = 2;
+       if (!FIPS_drbg_instantiate(dctx, td->pers, td->perslen))
+               goto err;
+
+       /* Check generation is now OK */
+       if (!FIPS_drbg_generate(dctx, randout, td->katlen, 0, 0,
+                               td->adin, td->adinlen))
+               goto err;
+       if (!FIPS_drbg_generate(dctx, randout, td->katlen, 0, 0,
+                               td->adin, td->adinlen))
+               goto err;
+
+       /* DRBG should now require a reseed */
+       if (dctx->status != DRBG_STATUS_RESEED)
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_RESEED_COUNTER_ERROR);
+               goto err;
+               }
+
+
+       /* Generate again and check entropy has been requested for reseed */
+       t.entcnt = 0;
+       if (!FIPS_drbg_generate(dctx, randout, td->katlen, 0, 0,
+                               td->adin, td->adinlen))
+               goto err;
+       if (t.entcnt != 1)
+               {
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_ENTROPY_NOT_REQUESTED_FOR_RESEED);
+               goto err;
+               }
+
+       FIPS_drbg_uninstantiate(dctx);
+       p = (unsigned char *)&dctx->d;
+       /* Standard says we have to check uninstantiate really zeroes
+        * the data...
+        */
+       for (i = 0; i < sizeof(dctx->d); i++)
+               {
+               if (*p != 0)
+                       {
+                       FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_UNINSTANTIATE_ZEROISE_ERROR);
+                       goto err;
+                       }
+               p++;
+               }
+
+       return 1;
+
+       err:
+       /* A real error as opposed to an induced one: underlying function will
+        * indicate the error.
+        */
+       if (!(dctx->flags & DRBG_FLAG_NOERR))
+               FIPSerr(FIPS_F_FIPS_DRBG_HEALTH_CHECK, FIPS_R_FUNCTION_ERROR);
+       FIPS_drbg_uninstantiate(dctx);
+       return 0;
+
+       }
+
+
 int fips_drbg_kat(DRBG_CTX *dctx, int nid, unsigned int flags)
        {
+       int rv;
        DRBG_SELFTEST_DATA *td;
        for (td = drbg_test; td->nid != 0; td++)
                {
                if (td->nid == nid && td->flags == flags)
-                       return fips_drbg_single_kat(dctx, td);
+                       {
+                       rv = fips_drbg_single_kat(dctx, td);
+                       if (rv <= 0)
+                               return rv;
+                       return fips_drbg_health_check(dctx, td);
+                       }
                }
        return 0;
        }
@@ -811,15 +1023,31 @@ int FIPS_selftest_drbg(void)
        {
        DRBG_CTX *dctx;
        DRBG_SELFTEST_DATA *td;
+       int rv = 1;
        dctx = FIPS_drbg_new(0, 0);
        if (!dctx)
                return 0;
        for (td = drbg_test; td->nid != 0; td++)
+               {
+               if (!fips_post_started(FIPS_TEST_DRBG, td->nid, &td->flags))
+                       return 1;
                if (!fips_drbg_single_kat(dctx, td))
-                       break;
-       if (td->nid == 0)
-               return 1;
-       return 0;
+                       {
+                       fips_post_failed(FIPS_TEST_DRBG, td->nid, &td->flags);
+                       rv = 0;
+                       continue;
+                       }
+               if (!fips_drbg_health_check(dctx, td))
+                       {
+                       fips_post_failed(FIPS_TEST_DRBG, td->nid, &td->flags);
+                       rv = 0;
+                       continue;
+                       }
+               if (!fips_post_success(FIPS_TEST_DRBG, td->nid, &td->flags))
+                       return 0;
+               }
+       FIPS_drbg_free(dctx);
+       return rv;
        }