Check requested security strength in DRBG. Add function to retrieve the
[openssl.git] / fips / rand / fips_drbg_lib.c
index da9fb37dd9dd8a0902fc3df15b7b26b9f5a94df0..1c8712e7a5255d3d36f94b4a4ad8dc0d670d4ee6 100644 (file)
 #include <openssl/crypto.h>
 #include <openssl/evp.h>
 #include <openssl/aes.h>
+#include <openssl/err.h>
 #include <openssl/fips_rand.h>
 #include "fips_rand_lcl.h"
 
 /* Support framework for SP800-90 DRBGs */
 
-DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags)
+static int fips_drbg_init(DRBG_CTX *dctx, int type, unsigned int flags)
        {
        int rv;
-       DRBG_CTX *dctx;
-       dctx = OPENSSL_malloc(sizeof(DRBG_CTX));
        memset(dctx, 0, sizeof(DRBG_CTX));
        dctx->status = DRBG_STATUS_UNINITIALISED;
        dctx->flags = flags;
        dctx->type = type;
+
        rv = fips_drbg_hash_init(dctx);
+
        if (rv == -2)
                rv = fips_drbg_ctr_init(dctx);
-       if (rv <= 0)
+
+       return rv;
+       }
+
+DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags)
+       {
+       int rv;
+       DRBG_CTX *dctx;
+       dctx = OPENSSL_malloc(sizeof(DRBG_CTX));
+       if (!dctx)
                {
-               /* Fatal: cannot initialiase DRBG */
-               goto err;
+               FIPSerr(FIPS_F_FIPS_DRBG_NEW, ERR_R_MALLOC_FAILURE);
+               return NULL;
                }
+       rv = fips_drbg_init(dctx, type, flags);
 
-       return dctx;
+       if (rv <= 0)
+               {
+               if (rv == -2)
+                       FIPSerr(FIPS_F_FIPS_DRBG_NEW, FIPS_R_UNSUPPORTED_DRBG_TYPE);
+               else
+                       FIPSerr(FIPS_F_FIPS_DRBG_NEW, FIPS_R_ERROR_INITIALISING_DRBG);
 
-       err:
-       if (dctx)
                OPENSSL_free(dctx);
-       return NULL;
+               return NULL;
+               }
+       return dctx;
+       }
+
+void FIPS_drbg_free(DRBG_CTX *dctx)
+       {
+       dctx->uninstantiate(dctx);
+       OPENSSL_cleanse(dctx, sizeof(DRBG_CTX));
+       OPENSSL_free(dctx);
        }
 
 int FIPS_drbg_instantiate(DRBG_CTX *dctx,
@@ -94,13 +117,38 @@ int FIPS_drbg_instantiate(DRBG_CTX *dctx,
        {
        size_t entlen, noncelen;
 
+#if 0
+       /* Put here so error script picks them up */
+       FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE,
+                               FIPS_R_PERSONALISATION_STRING_TOO_LONG);
+       FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_IN_ERROR_STATE);
+       FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ALREADY_INSTANTIATED);
+       FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_ENTROPY);
+       FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_NONCE);
+       FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_INSTANTIATE_ERROR);
+#endif
+
+       int r = 0;
+
        if (perslen > dctx->max_pers)
-               return 0;
+               {
+               r = FIPS_R_PERSONALISATION_STRING_TOO_LONG;
+               goto end;
+               }
 
        if (dctx->status != DRBG_STATUS_UNINITIALISED)
                {
-               /* error */
-               return 0;
+               if (dctx->status == DRBG_STATUS_ERROR)
+                       r = FIPS_R_IN_ERROR_STATE;
+               else
+                       r = FIPS_R_ALREADY_INSTANTIATED;
+               goto end;
+               }
+
+       if (strength > dctx->strength)
+               {
+               r = FIPS_R_INSUFFICIENT_SECURITY_STRENGTH;
+               goto end;
                }
 
        dctx->status = DRBG_STATUS_ERROR;
@@ -109,7 +157,10 @@ int FIPS_drbg_instantiate(DRBG_CTX *dctx,
                                dctx->min_entropy, dctx->max_entropy);
 
        if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
+               {
+               r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
                goto end;
+               }
 
        if (dctx->max_nonce > 0)
                {
@@ -119,7 +170,10 @@ int FIPS_drbg_instantiate(DRBG_CTX *dctx,
                                        dctx->min_nonce, dctx->max_nonce);
 
                if (noncelen < dctx->min_nonce || noncelen > dctx->max_nonce)
+                       {
+                       r = FIPS_R_ERROR_RETRIEVING_NONCE;
                        goto end;
+                       }
 
                }
        else
@@ -129,11 +183,16 @@ int FIPS_drbg_instantiate(DRBG_CTX *dctx,
                                dctx->entropy, entlen,
                                dctx->nonce, noncelen,
                                pers, perslen))
+               {
+               r = FIPS_R_ERROR_INSTANTIATING_DRBG;
                goto end;
+               }
 
 
        dctx->status = DRBG_STATUS_READY;
        dctx->reseed_counter = 1;
+       /* Initial test value for reseed interval */
+       dctx->reseed_interval = 1<<24;
 
        end:
 
@@ -143,6 +202,9 @@ int FIPS_drbg_instantiate(DRBG_CTX *dctx,
        if (dctx->status == DRBG_STATUS_READY)
                return 1;
 
+       if (r && !(dctx->flags & DRBG_FLAG_TEST))
+               FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, r);
+
        return 0;
 
        }
@@ -151,19 +213,28 @@ int FIPS_drbg_reseed(DRBG_CTX *dctx,
                        const unsigned char *adin, size_t adinlen)
        {
        size_t entlen;
+       int r = 0;
+
+#if 0
+       FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_NOT_INSTANTIATED);
+       FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_ADDITIONAL_INPUT_TOO_LONG);
+#endif
        if (dctx->status != DRBG_STATUS_READY
                && dctx->status != DRBG_STATUS_RESEED)
                {
-               /* error */
-               return 0;
+               if (dctx->status == DRBG_STATUS_ERROR)
+                       r = FIPS_R_IN_ERROR_STATE;
+               else if(dctx->status == DRBG_STATUS_UNINITIALISED)
+                       r = FIPS_R_NOT_INSTANTIATED;
+               goto end;
                }
 
        if (!adin)
                adinlen = 0;
-       else if (adinlen > dctx->max_adin);
+       else if (adinlen > dctx->max_adin)
                {
-               /* error */
-               return 0;
+               r = FIPS_R_ADDITIONAL_INPUT_TOO_LONG;
+               goto end;
                }
 
        dctx->status = DRBG_STATUS_ERROR;
@@ -172,7 +243,10 @@ int FIPS_drbg_reseed(DRBG_CTX *dctx,
                                dctx->min_entropy, dctx->max_entropy);
 
        if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
+               {
+               r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
                goto end;
+               }
 
        if (!dctx->reseed(dctx, dctx->entropy, entlen, adin, adinlen))
                goto end;
@@ -181,46 +255,117 @@ int FIPS_drbg_reseed(DRBG_CTX *dctx,
        dctx->reseed_counter = 1;
        end:
        OPENSSL_cleanse(dctx->entropy, sizeof(dctx->entropy));
+
        if (dctx->status == DRBG_STATUS_READY)
                return 1;
+
+       if (r && !(dctx->flags & DRBG_FLAG_TEST))
+               FIPSerr(FIPS_F_FIPS_DRBG_RESEED, r);
+
        return 0;
        }
-       
+
 
 int FIPS_drbg_generate(DRBG_CTX *dctx, unsigned char *out, size_t outlen,
-                       int prediction_resistance,
+                       int strength, int prediction_resistance,
                        const unsigned char *adin, size_t adinlen)
        {
+       int r = 0;
        if (outlen > dctx->max_request)
                {
-               /* Too large */
+               r = FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG;
                return 0;
                }
+
+       if (strength > dctx->strength)
+               {
+               r = FIPS_R_INSUFFICIENT_SECURITY_STRENGTH;
+               goto end;
+               }
+
        if (dctx->status == DRBG_STATUS_RESEED || prediction_resistance)
                {
                if (!FIPS_drbg_reseed(dctx, adin, adinlen))
-                       return 0;
+                       {
+                       r = FIPS_R_RESEED_ERROR;
+                       goto end;
+                       }
                adin = NULL;
                adinlen = 0;
                }
        if (dctx->status != DRBG_STATUS_READY)
                {
-               /* Bad error */
-               return 0;
+               if (dctx->status == DRBG_STATUS_ERROR)
+                       r = FIPS_R_IN_ERROR_STATE;
+               else if(dctx->status == DRBG_STATUS_UNINITIALISED)
+                       r = FIPS_R_NOT_INSTANTIATED;
+               goto end;
                }
        if (!dctx->generate(dctx, out, outlen, adin, adinlen))
                {
-               /* Bad error */
+               r = FIPS_R_GENERATE_ERROR;
                dctx->status = DRBG_STATUS_ERROR;
-               return 0;
+               goto end;
                }
        if (dctx->reseed_counter > dctx->reseed_interval)
                dctx->status = DRBG_STATUS_RESEED;
        else
                dctx->reseed_counter++;
 
+       end:
+       if (r)
+               {
+               if (!(dctx->flags & DRBG_FLAG_TEST))
+                       FIPSerr(FIPS_F_FIPS_DRBG_GENERATE, r);
+               return 0;
+               }
+
        return 1;
        }
 
+int FIPS_drbg_uninstantiate(DRBG_CTX *dctx)
+       {
+       int save_type, save_flags, rv;
+       save_type = dctx->type;
+       save_flags = dctx->flags;
+       rv = dctx->uninstantiate(dctx);
+       OPENSSL_cleanse(dctx, sizeof(DRBG_CTX));
+       /* If method has problems uninstantiating, return error */
+       if (rv <= 0)
+               return rv;
+       return fips_drbg_init(dctx, save_type, save_flags);
+       }
 
+int FIPS_drbg_set_test_mode(DRBG_CTX *dctx,
+       size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char *out,
+                               int entropy, size_t min_len, size_t max_len),
+       size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char *out,
+                               int entropy, size_t min_len, size_t max_len))
+       {
+       if (dctx->status != DRBG_STATUS_UNINITIALISED)
+               return 0;
+       dctx->flags |= DRBG_FLAG_TEST;
+       dctx->get_entropy = get_entropy;
+       dctx->get_nonce = get_nonce;
+       return 1;
+       }
 
+void *FIPS_drbg_get_app_data(DRBG_CTX *dctx)
+       {
+       return dctx->app_data;
+       }
+
+void FIPS_drbg_set_app_data(DRBG_CTX *dctx, void *app_data)
+       {
+       dctx->app_data = app_data;
+       }
+
+size_t FIPS_drbg_get_blocklength(DRBG_CTX *dctx)
+       {
+       return dctx->blocklength;
+       }
+
+int FIPS_drbg_get_strength(DRBG_CTX *dctx)
+       {
+       return dctx->strength;
+       }