Add usage messages.
[openssl.git] / fips / fips_test_suite.c
index c14ecb3058d0b64cb028fda86f00c5c93c5ef786..0046b9b0d50c035170dfed6e3fccbd872028b0f9 100644 (file)
@@ -43,6 +43,7 @@ int main(int argc, char *argv[])
 #include <openssl/dh.h>
 
 #include <openssl/fips.h>
+#include <openssl/fips_rand.h>
 #include "fips_utl.h"
 
 /* AES: encrypt and decrypt known plaintext, verify result matches original plaintext
@@ -653,6 +654,103 @@ static int Zeroize()
     return 1;
     }
 
+/* Dummy Entropy for DRBG tests. WARNING: THIS IS TOTALLY BOGUS
+ * HAS ZERO SECURITY AND MUST NOT BE USED IN REAL APPLICATIONS.
+ */
+
+static unsigned char dummy_drbg_entropy[1024];
+
+static size_t drbg_test_cb(DRBG_CTX *ctx, unsigned char **pout,
+                                int entropy, size_t min_len, size_t max_len)
+       {
+       *pout = dummy_drbg_entropy;
+       /* Round up to multiple of block size */
+       return (min_len + 0xf) & ~0xf;
+       }
+
+/* DRBG test: just generate lots of data and trigger health checks */
+
+static int do_drbg_test(int type, int flags)
+    {
+    DRBG_CTX *dctx;
+    int rv = 0;
+    size_t i;
+    unsigned char randout[1024];
+    dctx = FIPS_drbg_new(type, flags);
+    if (!dctx)
+       return 0;
+    FIPS_drbg_set_callbacks(dctx, drbg_test_cb, 0, 0x10, drbg_test_cb, 0);
+    for (i = 0; i < sizeof(dummy_drbg_entropy); i++)
+       {
+       dummy_drbg_entropy[i] = i & 0xff;
+       }
+    if (!FIPS_drbg_instantiate(dctx, dummy_drbg_entropy, 10))
+       goto err;
+    FIPS_drbg_set_check_interval(dctx, 10);
+    for (i = 0; i < 32; i++)
+       {
+       if (!FIPS_drbg_generate(dctx, randout, sizeof(randout), 0, NULL, 0))
+               goto err;
+       if (!FIPS_drbg_generate(dctx, randout, sizeof(randout), 0, dummy_drbg_entropy, 1))
+               goto err;
+       }
+    rv = 1;
+    err:
+    FIPS_drbg_uninstantiate(dctx);
+    return rv;
+    }
+
+typedef struct 
+    {
+    int type, flags;
+    } DRBG_LIST;
+
+static int do_drbg_all(void)
+    {
+    static DRBG_LIST drbg_types[] =
+       {
+               {NID_sha1, 0},
+               {NID_sha224, 0},
+               {NID_sha256, 0},
+               {NID_sha384, 0},
+               {NID_sha512, 0},
+               {NID_hmacWithSHA1, 0},
+               {NID_hmacWithSHA224, 0},
+               {NID_hmacWithSHA256, 0},
+               {NID_hmacWithSHA384, 0},
+               {NID_hmacWithSHA512, 0},
+               {NID_aes_128_ctr, 0},
+               {NID_aes_192_ctr, 0},
+               {NID_aes_256_ctr, 0},
+               {NID_aes_128_ctr, DRBG_FLAG_CTR_USE_DF},
+               {NID_aes_192_ctr, DRBG_FLAG_CTR_USE_DF},
+               {NID_aes_256_ctr, DRBG_FLAG_CTR_USE_DF},
+               {(NID_X9_62_prime256v1 << 16)|NID_sha1, 0},
+               {(NID_X9_62_prime256v1 << 16)|NID_sha224, 0},
+               {(NID_X9_62_prime256v1 << 16)|NID_sha256, 0},
+               {(NID_X9_62_prime256v1 << 16)|NID_sha384, 0},
+               {(NID_X9_62_prime256v1 << 16)|NID_sha512, 0},
+               {(NID_secp384r1 << 16)|NID_sha224, 0},
+               {(NID_secp384r1 << 16)|NID_sha256, 0},
+               {(NID_secp384r1 << 16)|NID_sha384, 0},
+               {(NID_secp384r1 << 16)|NID_sha512, 0},
+               {(NID_secp521r1 << 16)|NID_sha256, 0},
+               {(NID_secp521r1 << 16)|NID_sha384, 0},
+               {(NID_secp521r1 << 16)|NID_sha512, 0},
+               {0, 0}
+       };
+    DRBG_LIST *lst;
+    int rv = 1;
+    for (lst = drbg_types;; lst++)
+       {
+       if (lst->type == 0)
+               break;
+       if (!do_drbg_test(lst->type, lst->flags))
+               rv = 0;
+       }
+    return rv;
+    }
+
 static int Error;
 static const char * Fail(const char *msg)
     {
@@ -679,11 +777,31 @@ POST_ID id_list[] = {
        {NID_sha256, "SHA256"},
        {NID_sha384, "SHA384"},
        {NID_sha512, "SHA512"},
+       {NID_hmacWithSHA1, "HMAC-SHA1"},
+       {NID_hmacWithSHA224, "HMAC-SHA224"},
+       {NID_hmacWithSHA256, "HMAC-SHA256"},
+       {NID_hmacWithSHA384, "HMAC-SHA384"},
+       {NID_hmacWithSHA512, "HMAC-SHA512"},
        {EVP_PKEY_RSA, "RSA"},
        {EVP_PKEY_DSA, "DSA"},
        {EVP_PKEY_EC, "ECDSA"},
+       {NID_aes_128_cbc, "AES-128-CBC"},
+       {NID_aes_192_cbc, "AES-192-CBC"},
+       {NID_aes_256_cbc, "AES-256-CBC"},
+       {NID_aes_128_ctr, "AES-128-CTR"},
+       {NID_aes_192_ctr, "AES-192-CTR"},
+       {NID_aes_256_ctr, "AES-256-CTR"},
        {NID_aes_128_ecb, "AES-128-ECB"},
+       {NID_aes_128_xts, "AES-128-XTS"},
+       {NID_aes_256_xts, "AES-256-XTS"},
+       {NID_des_ede3_cbc, "DES-EDE3-CBC"},
        {NID_des_ede3_ecb, "DES-EDE3-ECB"},
+       {NID_secp224r1, "P-224"},
+       {NID_sect233r1, "B-233"},
+       {NID_sect233k1, "K-233"},
+       {NID_X9_62_prime256v1, "P-256"},
+       {NID_secp384r1, "P-384"},
+       {NID_secp521r1, "P-521"},
        {0, NULL}
 };
 
@@ -696,7 +814,7 @@ static const char *lookup_id(int id)
                if (n->id == id)
                        return n->name;
                }
-       sprintf(out, "ID=%d\n", id);
+       sprintf(out, "ID=%d", id);
        return out;
        }
 
@@ -707,7 +825,11 @@ static int fail_key = -1;
 static int post_cb(int op, int id, int subid, void *ex)
        {
        const char *idstr, *exstr = "";
+       char asctmp[20];
        int keytype = -1;
+#ifdef FIPS_POST_TIME
+       static struct timespec start, end, tstart, tend;
+#endif
        switch(id)
                {
                case FIPS_TEST_INTEGRITY:
@@ -729,7 +851,17 @@ static int post_cb(int op, int id, int subid, void *ex)
                        {
                        EVP_PKEY *pkey = ex;
                        keytype = pkey->type;
-                       exstr = lookup_id(keytype);
+                       if (keytype == EVP_PKEY_EC)
+                               {
+                               const EC_GROUP *grp;
+                               int cnid;
+                               grp = EC_KEY_get0_group(pkey->pkey.ec);
+                               cnid = EC_GROUP_get_curve_name(grp);
+                               sprintf(asctmp, "ECDSA %s", lookup_id(cnid));
+                               exstr = asctmp;
+                               }
+                       else
+                               exstr = lookup_id(keytype);
                        }
                idstr = "Signature";
                break;
@@ -741,26 +873,44 @@ static int post_cb(int op, int id, int subid, void *ex)
 
                case FIPS_TEST_CMAC:
                idstr = "CMAC";
+               exstr = lookup_id(subid);
                break;
 
                case FIPS_TEST_GCM:
                idstr = "GCM";
                break;
 
-               case FIPS_TEST_CCM:
-               idstr = "CCM";
+               case FIPS_TEST_XTS:
+               idstr = "XTS";
+               exstr = lookup_id(subid);
                break;
 
-               case FIPS_TEST_XTS:
-               idstr = "HMAC";
+               case FIPS_TEST_CCM:
+               idstr = "CCM";
                break;
 
                case FIPS_TEST_X931:
                idstr = "X9.31 PRNG";
+               sprintf(asctmp, "keylen=%d", subid);
+               exstr = asctmp;
                break;
 
                case FIPS_TEST_DRBG:
                idstr = "DRBG";
+               if (*(int *)ex & DRBG_FLAG_CTR_USE_DF)
+                       {
+                       sprintf(asctmp, "%s DF", lookup_id(subid));
+                       exstr = asctmp;
+                       }
+               else if (subid >> 16)
+                       {
+                       sprintf(asctmp, "%s %s",
+                                       lookup_id(subid >> 16),
+                                       lookup_id(subid & 0xFFFF));
+                       exstr = asctmp;
+                       }
+               else
+                       exstr = lookup_id(subid);
                break;
 
                case FIPS_TEST_PAIRWISE:
@@ -777,6 +927,11 @@ static int post_cb(int op, int id, int subid, void *ex)
                idstr = "Continuous PRNG";
                break;
 
+               case FIPS_TEST_ECDH:
+               idstr = "ECDH";
+               exstr = lookup_id(subid);
+               break;
+
                default:
                idstr = "Unknown";
                break;
@@ -786,19 +941,40 @@ static int post_cb(int op, int id, int subid, void *ex)
        switch(op)
                {
                case FIPS_POST_BEGIN:
+#ifdef FIPS_POST_TIME
+               clock_getres(CLOCK_REALTIME, &tstart);
+               printf("\tTimer resolution %ld s, %ld ns\n",
+                               (long)tstart.tv_sec, (long)tstart.tv_nsec);
+               clock_gettime(CLOCK_REALTIME, &tstart);
+#endif
                printf("\tPOST started\n");
                break;
 
                case FIPS_POST_END:
                printf("\tPOST %s\n", id ? "Success" : "Failed");
+#ifdef FIPS_POST_TIME
+               clock_gettime(CLOCK_REALTIME, &tend);
+               printf("\t\tTook %f seconds\n",
+                       (double)((tend.tv_sec+tend.tv_nsec*1e-9)
+                        - (tstart.tv_sec+tstart.tv_nsec*1e-9)));
+#endif
                break;
 
                case FIPS_POST_STARTED:
                printf("\t\t%s %s test started\n", idstr, exstr);
+#ifdef FIPS_POST_TIME
+               clock_gettime(CLOCK_REALTIME, &start);
+#endif
                break;
 
                case FIPS_POST_SUCCESS:
                printf("\t\t%s %s test OK\n", idstr, exstr);
+#ifdef FIPS_POST_TIME
+               clock_gettime(CLOCK_REALTIME, &end);
+               printf("\t\t\tTook %f seconds\n",
+                       (double)((end.tv_sec+end.tv_nsec*1e-9)
+                        - (start.tv_sec+start.tv_nsec*1e-9)));
+#endif
                break;
 
                case FIPS_POST_FAIL:
@@ -825,12 +1001,13 @@ int main(int argc,char **argv)
     int do_rng_stick = 0;
     int do_drbg_stick = 0;
     int no_exit = 0;
-
-    fips_algtest_init_nofips();
+    int no_dh = 0;
 
     FIPS_post_set_callback(post_cb);
 
-    printf("\tFIPS-mode test application\n\n");
+    printf("\tFIPS-mode test application\n");
+
+    printf("\t%s\n\n", FIPS_module_version_text());
 
     if (argv[1]) {
         /* Corrupted KAT tests */
@@ -839,14 +1016,20 @@ int main(int argc,char **argv)
         } else if (!strcmp(argv[1], "aes")) {
            fail_id = FIPS_TEST_CIPHER;
            fail_sub = NID_aes_128_ecb; 
+        } else if (!strcmp(argv[1], "aes-ccm")) {
+           fail_id = FIPS_TEST_CCM;
         } else if (!strcmp(argv[1], "aes-gcm")) {
            fail_id = FIPS_TEST_GCM;
+        } else if (!strcmp(argv[1], "aes-xts")) {
+           fail_id = FIPS_TEST_XTS;
         } else if (!strcmp(argv[1], "des")) {
            fail_id = FIPS_TEST_CIPHER;
            fail_sub = NID_des_ede3_ecb;        
         } else if (!strcmp(argv[1], "dsa")) {
            fail_id = FIPS_TEST_SIGNATURE;
            fail_key = EVP_PKEY_DSA;    
+        } else if (!strcmp(argv[1], "ecdh")) {
+           fail_id = FIPS_TEST_ECDH;
         } else if (!strcmp(argv[1], "ecdsa")) {
            fail_id = FIPS_TEST_SIGNATURE;
            fail_key = EVP_PKEY_EC;     
@@ -873,14 +1056,23 @@ int main(int argc,char **argv)
            fail_id = FIPS_TEST_DIGEST;
         } else if (!strcmp(argv[1], "hmac")) {
            fail_id = FIPS_TEST_HMAC;
+        } else if (!strcmp(argv[1], "cmac")) {
+           fail_id = FIPS_TEST_CMAC;
        } else if (!strcmp(argv[1], "drbg")) {
-           FIPS_corrupt_drbg();
+           fail_id = FIPS_TEST_DRBG;
        } else if (!strcmp(argv[1], "rng")) {
-           FIPS_corrupt_x931();
+           fail_id = FIPS_TEST_X931;
+       } else if (!strcmp(argv[1], "nodh")) {
+           no_dh = 1;
+           no_exit = 1;
+       } else if (!strcmp(argv[1], "post")) {
+           fail_id = -1;
        } else if (!strcmp(argv[1], "rngstick")) {
            do_rng_stick = 1;
            no_exit = 1;
            printf("RNG test with stuck continuous test...\n");
+       } else if (!strcmp(argv[1], "drbgentstick")) {
+               do_entropy_stick();
        } else if (!strcmp(argv[1], "drbgstick")) {
            do_drbg_stick = 1;
            no_exit = 1;
@@ -890,7 +1082,8 @@ int main(int argc,char **argv)
             exit(1);
         }
        if (!no_exit) {
-               if (!FIPS_mode_set(1)) {
+               fips_algtest_init_nofips();
+               if (!FIPS_module_mode_set(1)) {
                    printf("Power-up self test failed\n");
                    exit(1);
                }
@@ -899,16 +1092,21 @@ int main(int argc,char **argv)
        }
     }
 
+    fips_algtest_init_nofips();
+
     /* Non-Approved cryptographic operation
     */
     printf("1. Non-Approved cryptographic operation test...\n");
-    test_msg("\ta. Included algorithm (D-H)...", dh_test());
+    if (no_dh)
+       printf("\t D-H test skipped\n");
+    else
+       test_msg("\ta. Included algorithm (D-H)...", dh_test());
 
     /* Power-up self test
     */
     ERR_clear_error();
-    test_msg("2. Automatic power-up self test", FIPS_mode_set(1));
-    if (!FIPS_mode())
+    test_msg("2. Automatic power-up self test", FIPS_module_mode_set(1));
+    if (!FIPS_module_mode())
        exit(1);
     if (do_drbg_stick)
             FIPS_drbg_stick();
@@ -994,6 +1192,7 @@ int main(int argc,char **argv)
     */
     printf("9. Non-Approved cryptographic operation test...\n");
     printf("\ta. Included algorithm (D-H)...%s\n",
+               no_dh ? "skipped" :
                dh_test() ? "successful as expected"
                                                : Fail("failed INCORRECTLY!") );
 
@@ -1003,6 +1202,14 @@ int main(int argc,char **argv)
                Zeroize() ? "successful as expected"
                                        : Fail("failed INCORRECTLY!") );
 
+    printf("11. Complete DRBG health check...\n");
+    printf("\t%s\n", FIPS_selftest_drbg_all() ? "successful as expected"
+                                       : Fail("failed INCORRECTLY!") );
+
+    printf("12. DRBG generation check...\n");
+    printf("\t%s\n", do_drbg_all() ? "successful as expected"
+                                       : Fail("failed INCORRECTLY!") );
+
     printf("\nAll tests completed with %d errors\n", Error);
     return Error ? 1 : 0;
     }