xnu-7195.60.75.tar.gz

[apple/xnu.git] / EXTERNAL_HEADERS / corecrypto / ccdrbg.h

diff --git a/EXTERNAL_HEADERS/corecrypto/ccdrbg.h b/EXTERNAL_HEADERS/corecrypto/ccdrbg.h
index 152e0801f806f44d8bc5d949aa341ab779776d84..1cbcca0a1e0aec66d2f2e607c29b68915d2d0470 100644 (file)
--- a/EXTERNAL_HEADERS/corecrypto/ccdrbg.h
+++ b/EXTERNAL_HEADERS/corecrypto/ccdrbg.h
@@ -1,24 +1,12 @@
-/*
- * Copyright (c) 2007-2010 Apple Inc. All Rights Reserved.
- *
- * @APPLE_LICENSE_HEADER_START@
- *
- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+/* Copyright (c) (2010,2011,2012,2014,2015,2016,2017,2018,2019) Apple Inc. All rights reserved.

  *
  *

- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
- * limitations under the License.
- *
- * @APPLE_LICENSE_HEADER_END@
+ * corecrypto is licensed under Apple Inc.’s Internal Use License Agreement (which
+ * is contained in the License.txt file distributed with corecrypto) and only to 
+ * people who accept that license. IMPORTANT:  Any license rights granted to you by 
+ * Apple Inc. (if any) are limited to internal use within your organization only on 
+ * devices and computers you own or control, for the sole purpose of verifying the 
+ * security characteristics and correct functioning of the Apple Software.  You may 
+ * not, directly or indirectly, redistribute the Apple Software or any portions thereof.

  */
 
 /*!
  */
 
 /*!


@@ -34,72 +22,90 @@
 #include <corecrypto/cc.h>
 #include <corecrypto/ccdrbg_impl.h>
 
 #include <corecrypto/cc.h>
 #include <corecrypto/ccdrbg_impl.h>
 

-/* TODO: Error codes ? */
-#define CCDRBG_STATUS_OK 0
-#define CCDRBG_STATUS_ERROR (-1)
-#define CCDRBG_STATUS_NEED_RESEED (-2)
-#define CCDRBG_STATUS_PARAM_ERROR (-3)
+/*
+ * The maximum length of the entropy_input,  additional_input (max_additional_input_length) , personalization string
+ * (max_personalization_string_length) and max_number_of_bits_per_request  are implementation dependent
+ * but shall fit in a 32 bit register and be be less than or equal to the specified maximum length for the
+ * selected DRBG mechanism (NIST 800-90A Section 10).
+ */

 
 

-CC_INLINE size_t ccdrbg_context_size(const struct ccdrbg_info *drbg)
-{
-    return drbg->size;
-}
+#define CCDRBG_MAX_ENTROPY_SIZE         ((uint32_t)1<<16)
+#define CCDRBG_MAX_ADDITIONALINPUT_SIZE ((uint32_t)1<<16)
+#define CCDRBG_MAX_PSINPUT_SIZE         ((uint32_t)1<<16)
+#define CCDRBG_MAX_REQUEST_SIZE         ((uint32_t)1<<16) //this is the absolute maximum in NIST 800-90A
+#define CCDRBG_RESEED_INTERVAL          ((uint64_t)1<<48) // must be able to fit the NIST maximum of 2^48
+
+
+/*
+ * The entropyLength is forced to be greater or equal than the security strength.
+ * Nonce is not forced. It either needs to have 0.5*security strength entropy. Or, a vale that is repeated
+ * less than a 0.5*security strength bit random string.
+ * see below or NIST  800-90A for the definition of security strength
+ */

 
 CC_INLINE int ccdrbg_init(const struct ccdrbg_info *info,
                        struct ccdrbg_state *drbg,
 
 CC_INLINE int ccdrbg_init(const struct ccdrbg_info *info,
                        struct ccdrbg_state *drbg,

-            unsigned long entropyLength, const void* entropy,
-            unsigned long nonceLength, const void* nonce,
-            unsigned long psLength, const void* ps)
+            size_t entropyLength, const void* entropy,
+            size_t nonceLength, const void* nonce,
+            size_t psLength, const void* ps)

 {
        return info->init(info, drbg, entropyLength, entropy, nonceLength, nonce, psLength, ps);
 }
 
 {
        return info->init(info, drbg, entropyLength, entropy, nonceLength, nonce, psLength, ps);
 }
 

+/*
+ *  The entropyLength is forced to be greater or equal than the security strength.
+ */

 CC_INLINE int ccdrbg_reseed(const struct ccdrbg_info *info,
 CC_INLINE int ccdrbg_reseed(const struct ccdrbg_info *info,

-               struct ccdrbg_state *prng,
-               unsigned long entropylen, const void *entropy,
-               unsigned long inlen, const void *in)
+       struct ccdrbg_state *drbg,
+       size_t entropyLength, const void *entropy,
+       size_t additionalLength, const void *additional)

 {
 {

-       return info->reseed(prng, entropylen, entropy, inlen, in);
+    return info->reseed(drbg, entropyLength, entropy, additionalLength, additional);

 }
 
 
 CC_INLINE int ccdrbg_generate(const struct ccdrbg_info *info,
 }
 
 
 CC_INLINE int ccdrbg_generate(const struct ccdrbg_info *info,

-               struct ccdrbg_state *prng,
-               unsigned long outlen, void *out,
-               unsigned long inlen, const void *in)
+         struct ccdrbg_state *drbg,
+         size_t dataOutLength, void *dataOut,
+         size_t additionalLength, const void *additional)

 {
 {

-       return info->generate(prng, outlen, out, inlen, in);
+    return info->generate(drbg, dataOutLength, dataOut, additionalLength, additional);

 }
 
 CC_INLINE void ccdrbg_done(const struct ccdrbg_info *info,
 }
 
 CC_INLINE void ccdrbg_done(const struct ccdrbg_info *info,

-               struct ccdrbg_state *prng)
+               struct ccdrbg_state *drbg)

 {
 {

-       info->done(prng);
+       info->done(drbg);

 }
 
 }
 

+CC_INLINE size_t ccdrbg_context_size(const struct ccdrbg_info *info)
+{
+    return info->size;
+}

 
 

-extern struct ccdrbg_info ccdrbg_dummy_info;
-extern struct ccdrbg_info ccdrbg_fipssha1_info;

 
 

+/*
+ * NIST SP 800-90 CTR_DRBG
+ * the maximum security strengh of drbg equals to the block size of the corresponding ECB.
+ */

 struct ccdrbg_nistctr_custom {
 struct ccdrbg_nistctr_custom {

-    const struct ccmode_ecb *ecb;
-    unsigned long keylen;
+    const struct ccmode_ctr *ctr_info;
+    size_t keylen;

     int strictFIPS;
     int use_df;
 };
 
 void ccdrbg_factory_nistctr(struct ccdrbg_info *info, const struct ccdrbg_nistctr_custom *custom);
 
     int strictFIPS;
     int use_df;
 };
 
 void ccdrbg_factory_nistctr(struct ccdrbg_info *info, const struct ccdrbg_nistctr_custom *custom);
 

-extern struct ccdrbg_info ccdrbg_nistdigest_info;
-
+/*
+ * NIST SP 800-90 HMAC_DRBG
+ * the maximum security strengh of drbg is half of output size of the input hash function and it internally is limited to 256 bits
+ */

 struct ccdrbg_nisthmac_custom {
     const struct ccdigest_info *di;
     int strictFIPS;
 };
 
 struct ccdrbg_nisthmac_custom {
     const struct ccdigest_info *di;
     int strictFIPS;
 };
 

-// "class" method on nisthmac dbrg's to ask about their security_strength for a given di
-int ccdbrg_nisthmac_security_strength(const struct ccdrbg_nisthmac_custom *custom);
-

 void ccdrbg_factory_nisthmac(struct ccdrbg_info *info, const struct ccdrbg_nisthmac_custom *custom);
 
 #endif /* _CORECRYPTO_CCDRBG_H_ */
 void ccdrbg_factory_nisthmac(struct ccdrbg_info *info, const struct ccdrbg_nisthmac_custom *custom);
 
 #endif /* _CORECRYPTO_CCDRBG_H_ */