crypto/jitterentropy.c

   1 /*
   2  * Non-physical true random number generator based on timing jitter --
   3  * Jitter RNG standalone code.
   4  *
   5  * Copyright Stephan Mueller <smueller@chronox.de>, 2015 - 2020
   6  *
   7  * Design
   8  * ======
   9  *
  10  * See https://www.chronox.de/jent.html
  11  *
  12  * License
  13  * =======
  14  *
  15  * Redistribution and use in source and binary forms, with or without
  16  * modification, are permitted provided that the following conditions
  17  * are met:
  18  * 1. Redistributions of source code must retain the above copyright
  19  *    notice, and the entire permission notice in its entirety,
  20  *    including the disclaimer of warranties.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  * 3. The name of the author may not be used to endorse or promote
  25  *    products derived from this software without specific prior
  26  *    written permission.
  27  *
  28  * ALTERNATIVELY, this product may be distributed under the terms of
  29  * the GNU General Public License, in which case the provisions of the GPL2 are
  30  * required INSTEAD OF the above restrictions.  (This clause is
  31  * necessary due to a potential bad interaction between the GPL and
  32  * the restrictions contained in a BSD-style copyright.)
  33  *
  34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  35  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  36  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
  37  * WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
  38  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  39  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  40  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  41  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  42  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  44  * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
  45  * DAMAGE.
  46  */
  47
  48 /*
  49  * This Jitterentropy RNG is based on the jitterentropy library
  50  * version 2.2.0 provided at https://www.chronox.de/jent.html
  51  */
  52
  53 #ifdef __OPTIMIZE__
  54  #error "The CPU Jitter random number generator must not be compiled with optimizations. See documentation. Use the compiler switch -O0 for compiling jitterentropy.c."
  55 #endif
  56
  57 typedef unsigned long long      __u64;
  58 typedef long long               __s64;
  59 typedef unsigned int            __u32;
  60 #define NULL    ((void *) 0)
  61
  62 /* The entropy pool */
  63 struct rand_data {
  64         /* all data values that are vital to maintain the security
  65          * of the RNG are marked as SENSITIVE. A user must not
  66          * access that information while the RNG executes its loops to
  67          * calculate the next random value. */
  68         __u64 data;             /* SENSITIVE Actual random number */
  69         __u64 old_data;         /* SENSITIVE Previous random number */
  70         __u64 prev_time;        /* SENSITIVE Previous time stamp */
  71 #define DATA_SIZE_BITS ((sizeof(__u64)) * 8)
  72         __u64 last_delta;       /* SENSITIVE stuck test */
  73         __s64 last_delta2;      /* SENSITIVE stuck test */
  74         unsigned int osr;       /* Oversample rate */
  75 #define JENT_MEMORY_BLOCKS 64
  76 #define JENT_MEMORY_BLOCKSIZE 32
  77 #define JENT_MEMORY_ACCESSLOOPS 128
  78 #define JENT_MEMORY_SIZE (JENT_MEMORY_BLOCKS*JENT_MEMORY_BLOCKSIZE)
  79         unsigned char *mem;     /* Memory access location with size of
  80                                  * memblocks * memblocksize */
  81         unsigned int memlocation; /* Pointer to byte in *mem */
  82         unsigned int memblocks; /* Number of memory blocks in *mem */
  83         unsigned int memblocksize; /* Size of one memory block in bytes */
  84         unsigned int memaccessloops; /* Number of memory accesses per random
  85                                       * bit generation */
  86
  87         /* Repetition Count Test */
  88         int rct_count;                  /* Number of stuck values */
  89
  90         /* Adaptive Proportion Test for a significance level of 2^-30 */
  91 #define JENT_APT_CUTOFF         325     /* Taken from SP800-90B sec 4.4.2 */
  92 #define JENT_APT_WINDOW_SIZE    512     /* Data window size */
  93         /* LSB of time stamp to process */
  94 #define JENT_APT_LSB            16
  95 #define JENT_APT_WORD_MASK      (JENT_APT_LSB - 1)
  96         unsigned int apt_observations;  /* Number of collected observations */
  97         unsigned int apt_count;         /* APT counter */
  98         unsigned int apt_base;          /* APT base reference */
  99         unsigned int apt_base_set:1;    /* APT base reference set? */
 100
 101         unsigned int health_failure:1;  /* Permanent health failure */
 102 };
 103
 104 /* Flags that can be used to initialize the RNG */
 105 #define JENT_DISABLE_MEMORY_ACCESS (1<<2) /* Disable memory access for more
 106                                            * entropy, saves MEMORY_SIZE RAM for
 107                                            * entropy collector */
 108
 109 /* -- error codes for init function -- */
 110 #define JENT_ENOTIME            1 /* Timer service not available */
 111 #define JENT_ECOARSETIME        2 /* Timer too coarse for RNG */
 112 #define JENT_ENOMONOTONIC       3 /* Timer is not monotonic increasing */
 113 #define JENT_EVARVAR            5 /* Timer does not produce variations of
 114                                    * variations (2nd derivation of time is
 115                                    * zero). */
 116 #define JENT_ESTUCK             8 /* Too many stuck results during init. */
 117 #define JENT_EHEALTH            9 /* Health test failed during initialization */
 118 #define JENT_ERCT               10 /* RCT failed during initialization */
 119
 120 #include "jitterentropy.h"
 121
 122 /***************************************************************************
 123  * Adaptive Proportion Test
 124  *
 125  * This test complies with SP800-90B section 4.4.2.
 126  ***************************************************************************/
 127
 128 /*
 129  * Reset the APT counter
 130  *
 131  * @ec [in] Reference to entropy collector
 132  */
 133 static void jent_apt_reset(struct rand_data *ec, unsigned int delta_masked)
 134 {
 135         /* Reset APT counter */
 136         ec->apt_count = 0;
 137         ec->apt_base = delta_masked;
 138         ec->apt_observations = 0;
 139 }
 140
 141 /*
 142  * Insert a new entropy event into APT
 143  *
 144  * @ec [in] Reference to entropy collector
 145  * @delta_masked [in] Masked time delta to process
 146  */
 147 static void jent_apt_insert(struct rand_data *ec, unsigned int delta_masked)
 148 {
 149         /* Initialize the base reference */
 150         if (!ec->apt_base_set) {
 151                 ec->apt_base = delta_masked;
 152                 ec->apt_base_set = 1;
 153                 return;
 154         }
 155
 156         if (delta_masked == ec->apt_base) {
 157                 ec->apt_count++;
 158
 159                 if (ec->apt_count >= JENT_APT_CUTOFF)
 160                         ec->health_failure = 1;
 161         }
 162
 163         ec->apt_observations++;
 164
 165         if (ec->apt_observations >= JENT_APT_WINDOW_SIZE)
 166                 jent_apt_reset(ec, delta_masked);
 167 }
 168
 169 /***************************************************************************
 170  * Stuck Test and its use as Repetition Count Test
 171  *
 172  * The Jitter RNG uses an enhanced version of the Repetition Count Test
 173  * (RCT) specified in SP800-90B section 4.4.1. Instead of counting identical
 174  * back-to-back values, the input to the RCT is the counting of the stuck
 175  * values during the generation of one Jitter RNG output block.
 176  *
 177  * The RCT is applied with an alpha of 2^{-30} compliant to FIPS 140-2 IG 9.8.
 178  *
 179  * During the counting operation, the Jitter RNG always calculates the RCT
 180  * cut-off value of C. If that value exceeds the allowed cut-off value,
 181  * the Jitter RNG output block will be calculated completely but discarded at
 182  * the end. The caller of the Jitter RNG is informed with an error code.
 183  ***************************************************************************/
 184
 185 /*
 186  * Repetition Count Test as defined in SP800-90B section 4.4.1
 187  *
 188  * @ec [in] Reference to entropy collector
 189  * @stuck [in] Indicator whether the value is stuck
 190  */
 191 static void jent_rct_insert(struct rand_data *ec, int stuck)
 192 {
 193         /*
 194          * If we have a count less than zero, a previous RCT round identified
 195          * a failure. We will not overwrite it.
 196          */
 197         if (ec->rct_count < 0)
 198                 return;
 199
 200         if (stuck) {
 201                 ec->rct_count++;
 202
 203                 /*
 204                  * The cutoff value is based on the following consideration:
 205                  * alpha = 2^-30 as recommended in FIPS 140-2 IG 9.8.
 206                  * In addition, we require an entropy value H of 1/OSR as this
 207                  * is the minimum entropy required to provide full entropy.
 208                  * Note, we collect 64 * OSR deltas for inserting them into
 209                  * the entropy pool which should then have (close to) 64 bits
 210                  * of entropy.
 211                  *
 212                  * Note, ec->rct_count (which equals to value B in the pseudo
 213                  * code of SP800-90B section 4.4.1) starts with zero. Hence
 214                  * we need to subtract one from the cutoff value as calculated
 215                  * following SP800-90B.
 216                  */
 217                 if ((unsigned int)ec->rct_count >= (31 * ec->osr)) {
 218                         ec->rct_count = -1;
 219                         ec->health_failure = 1;
 220                 }
 221         } else {
 222                 ec->rct_count = 0;
 223         }
 224 }
 225
 226 /*
 227  * Is there an RCT health test failure?
 228  *
 229  * @ec [in] Reference to entropy collector
 230  *
 231  * @return
 232  *      0 No health test failure
 233  *      1 Permanent health test failure
 234  */
 235 static int jent_rct_failure(struct rand_data *ec)
 236 {
 237         if (ec->rct_count < 0)
 238                 return 1;
 239         return 0;
 240 }
 241
 242 static inline __u64 jent_delta(__u64 prev, __u64 next)
 243 {
 244 #define JENT_UINT64_MAX         (__u64)(~((__u64) 0))
 245         return (prev < next) ? (next - prev) :
 246                                (JENT_UINT64_MAX - prev + 1 + next);
 247 }
 248
 249 /*
 250  * Stuck test by checking the:
 251  *      1st derivative of the jitter measurement (time delta)
 252  *      2nd derivative of the jitter measurement (delta of time deltas)
 253  *      3rd derivative of the jitter measurement (delta of delta of time deltas)
 254  *
 255  * All values must always be non-zero.
 256  *
 257  * @ec [in] Reference to entropy collector
 258  * @current_delta [in] Jitter time delta
 259  *
 260  * @return
 261  *      0 jitter measurement not stuck (good bit)
 262  *      1 jitter measurement stuck (reject bit)
 263  */
 264 static int jent_stuck(struct rand_data *ec, __u64 current_delta)
 265 {
 266         __u64 delta2 = jent_delta(ec->last_delta, current_delta);
 267         __u64 delta3 = jent_delta(ec->last_delta2, delta2);
 268
 269         ec->last_delta = current_delta;
 270         ec->last_delta2 = delta2;
 271
 272         /*
 273          * Insert the result of the comparison of two back-to-back time
 274          * deltas.
 275          */
 276         jent_apt_insert(ec, current_delta);
 277
 278         if (!current_delta || !delta2 || !delta3) {
 279                 /* RCT with a stuck bit */
 280                 jent_rct_insert(ec, 1);
 281                 return 1;
 282         }
 283
 284         /* RCT with a non-stuck bit */
 285         jent_rct_insert(ec, 0);
 286
 287         return 0;
 288 }
 289
 290 /*
 291  * Report any health test failures
 292  *
 293  * @ec [in] Reference to entropy collector
 294  *
 295  * @return
 296  *      0 No health test failure
 297  *      1 Permanent health test failure
 298  */
 299 static int jent_health_failure(struct rand_data *ec)
 300 {
 301         return ec->health_failure;
 302 }
 303
 304 /***************************************************************************
 305  * Noise sources
 306  ***************************************************************************/
 307
 308 /*
 309  * Update of the loop count used for the next round of
 310  * an entropy collection.
 311  *
 312  * Input:
 313  * @ec entropy collector struct -- may be NULL
 314  * @bits is the number of low bits of the timer to consider
 315  * @min is the number of bits we shift the timer value to the right at
 316  *      the end to make sure we have a guaranteed minimum value
 317  *
 318  * @return Newly calculated loop counter
 319  */
 320 static __u64 jent_loop_shuffle(struct rand_data *ec,
 321                                unsigned int bits, unsigned int min)
 322 {
 323         __u64 time = 0;
 324         __u64 shuffle = 0;
 325         unsigned int i = 0;
 326         unsigned int mask = (1<<bits) - 1;
 327
 328         jent_get_nstime(&time);
 329         /*
 330          * Mix the current state of the random number into the shuffle
 331          * calculation to balance that shuffle a bit more.
 332          */
 333         if (ec)
 334                 time ^= ec->data;
 335         /*
 336          * We fold the time value as much as possible to ensure that as many
 337          * bits of the time stamp are included as possible.
 338          */
 339         for (i = 0; ((DATA_SIZE_BITS + bits - 1) / bits) > i; i++) {
 340                 shuffle ^= time & mask;
 341                 time = time >> bits;
 342         }
 343
 344         /*
 345          * We add a lower boundary value to ensure we have a minimum
 346          * RNG loop count.
 347          */
 348         return (shuffle + (1<<min));
 349 }
 350
 351 /*
 352  * CPU Jitter noise source -- this is the noise source based on the CPU
 353  *                            execution time jitter
 354  *
 355  * This function injects the individual bits of the time value into the
 356  * entropy pool using an LFSR.
 357  *
 358  * The code is deliberately inefficient with respect to the bit shifting
 359  * and shall stay that way. This function is the root cause why the code
 360  * shall be compiled without optimization. This function not only acts as
 361  * folding operation, but this function's execution is used to measure
 362  * the CPU execution time jitter. Any change to the loop in this function
 363  * implies that careful retesting must be done.
 364  *
 365  * @ec [in] entropy collector struct
 366  * @time [in] time stamp to be injected
 367  * @loop_cnt [in] if a value not equal to 0 is set, use the given value as
 368  *                number of loops to perform the folding
 369  * @stuck [in] Is the time stamp identified as stuck?
 370  *
 371  * Output:
 372  * updated ec->data
 373  *
 374  * @return Number of loops the folding operation is performed
 375  */
 376 static void jent_lfsr_time(struct rand_data *ec, __u64 time, __u64 loop_cnt,
 377                            int stuck)
 378 {
 379         unsigned int i;
 380         __u64 j = 0;
 381         __u64 new = 0;
 382 #define MAX_FOLD_LOOP_BIT 4
 383 #define MIN_FOLD_LOOP_BIT 0
 384         __u64 fold_loop_cnt =
 385                 jent_loop_shuffle(ec, MAX_FOLD_LOOP_BIT, MIN_FOLD_LOOP_BIT);
 386
 387         /*
 388          * testing purposes -- allow test app to set the counter, not
 389          * needed during runtime
 390          */
 391         if (loop_cnt)
 392                 fold_loop_cnt = loop_cnt;
 393         for (j = 0; j < fold_loop_cnt; j++) {
 394                 new = ec->data;
 395                 for (i = 1; (DATA_SIZE_BITS) >= i; i++) {
 396                         __u64 tmp = time << (DATA_SIZE_BITS - i);
 397
 398                         tmp = tmp >> (DATA_SIZE_BITS - 1);
 399
 400                         /*
 401                         * Fibonacci LSFR with polynomial of
 402                         *  x^64 + x^61 + x^56 + x^31 + x^28 + x^23 + 1 which is
 403                         *  primitive according to
 404                         *   http://poincare.matf.bg.ac.rs/~ezivkovm/publications/primpol1.pdf
 405                         * (the shift values are the polynomial values minus one
 406                         * due to counting bits from 0 to 63). As the current
 407                         * position is always the LSB, the polynomial only needs
 408                         * to shift data in from the left without wrap.
 409                         */
 410                         tmp ^= ((new >> 63) & 1);
 411                         tmp ^= ((new >> 60) & 1);
 412                         tmp ^= ((new >> 55) & 1);
 413                         tmp ^= ((new >> 30) & 1);
 414                         tmp ^= ((new >> 27) & 1);
 415                         tmp ^= ((new >> 22) & 1);
 416                         new <<= 1;
 417                         new ^= tmp;
 418                 }
 419         }
 420
 421         /*
 422          * If the time stamp is stuck, do not finally insert the value into
 423          * the entropy pool. Although this operation should not do any harm
 424          * even when the time stamp has no entropy, SP800-90B requires that
 425          * any conditioning operation (SP800-90B considers the LFSR to be a
 426          * conditioning operation) to have an identical amount of input
 427          * data according to section 3.1.5.
 428          */
 429         if (!stuck)
 430                 ec->data = new;
 431 }
 432
 433 /*
 434  * Memory Access noise source -- this is a noise source based on variations in
 435  *                               memory access times
 436  *
 437  * This function performs memory accesses which will add to the timing
 438  * variations due to an unknown amount of CPU wait states that need to be
 439  * added when accessing memory. The memory size should be larger than the L1
 440  * caches as outlined in the documentation and the associated testing.
 441  *
 442  * The L1 cache has a very high bandwidth, albeit its access rate is  usually
 443  * slower than accessing CPU registers. Therefore, L1 accesses only add minimal
 444  * variations as the CPU has hardly to wait. Starting with L2, significant
 445  * variations are added because L2 typically does not belong to the CPU any more
 446  * and therefore a wider range of CPU wait states is necessary for accesses.
 447  * L3 and real memory accesses have even a wider range of wait states. However,
 448  * to reliably access either L3 or memory, the ec->mem memory must be quite
 449  * large which is usually not desirable.
 450  *
 451  * @ec [in] Reference to the entropy collector with the memory access data -- if
 452  *          the reference to the memory block to be accessed is NULL, this noise
 453  *          source is disabled
 454  * @loop_cnt [in] if a value not equal to 0 is set, use the given value
 455  *                number of loops to perform the LFSR
 456  */
 457 static void jent_memaccess(struct rand_data *ec, __u64 loop_cnt)
 458 {
 459         unsigned int wrap = 0;
 460         __u64 i = 0;
 461 #define MAX_ACC_LOOP_BIT 7
 462 #define MIN_ACC_LOOP_BIT 0
 463         __u64 acc_loop_cnt =
 464                 jent_loop_shuffle(ec, MAX_ACC_LOOP_BIT, MIN_ACC_LOOP_BIT);
 465
 466         if (NULL == ec || NULL == ec->mem)
 467                 return;
 468         wrap = ec->memblocksize * ec->memblocks;
 469
 470         /*
 471          * testing purposes -- allow test app to set the counter, not
 472          * needed during runtime
 473          */
 474         if (loop_cnt)
 475                 acc_loop_cnt = loop_cnt;
 476
 477         for (i = 0; i < (ec->memaccessloops + acc_loop_cnt); i++) {
 478                 unsigned char *tmpval = ec->mem + ec->memlocation;
 479                 /*
 480                  * memory access: just add 1 to one byte,
 481                  * wrap at 255 -- memory access implies read
 482                  * from and write to memory location
 483                  */
 484                 *tmpval = (*tmpval + 1) & 0xff;
 485                 /*
 486                  * Addition of memblocksize - 1 to pointer
 487                  * with wrap around logic to ensure that every
 488                  * memory location is hit evenly
 489                  */
 490                 ec->memlocation = ec->memlocation + ec->memblocksize - 1;
 491                 ec->memlocation = ec->memlocation % wrap;
 492         }
 493 }
 494
 495 /***************************************************************************
 496  * Start of entropy processing logic
 497  ***************************************************************************/
 498 /*
 499  * This is the heart of the entropy generation: calculate time deltas and
 500  * use the CPU jitter in the time deltas. The jitter is injected into the
 501  * entropy pool.
 502  *
 503  * WARNING: ensure that ->prev_time is primed before using the output
 504  *          of this function! This can be done by calling this function
 505  *          and not using its result.
 506  *
 507  * @ec [in] Reference to entropy collector
 508  *
 509  * @return result of stuck test
 510  */
 511 static int jent_measure_jitter(struct rand_data *ec)
 512 {
 513         __u64 time = 0;
 514         __u64 current_delta = 0;
 515         int stuck;
 516
 517         /* Invoke one noise source before time measurement to add variations */
 518         jent_memaccess(ec, 0);
 519
 520         /*
 521          * Get time stamp and calculate time delta to previous
 522          * invocation to measure the timing variations
 523          */
 524         jent_get_nstime(&time);
 525         current_delta = jent_delta(ec->prev_time, time);
 526         ec->prev_time = time;
 527
 528         /* Check whether we have a stuck measurement. */
 529         stuck = jent_stuck(ec, current_delta);
 530
 531         /* Now call the next noise sources which also injects the data */
 532         jent_lfsr_time(ec, current_delta, 0, stuck);
 533
 534         return stuck;
 535 }
 536
 537 /*
 538  * Generator of one 64 bit random number
 539  * Function fills rand_data->data
 540  *
 541  * @ec [in] Reference to entropy collector
 542  */
 543 static void jent_gen_entropy(struct rand_data *ec)
 544 {
 545         unsigned int k = 0;
 546
 547         /* priming of the ->prev_time value */
 548         jent_measure_jitter(ec);
 549
 550         while (!jent_health_failure(ec)) {
 551                 /* If a stuck measurement is received, repeat measurement */
 552                 if (jent_measure_jitter(ec))
 553                         continue;
 554
 555                 /*
 556                  * We multiply the loop value with ->osr to obtain the
 557                  * oversampling rate requested by the caller
 558                  */
 559                 if (++k >= (DATA_SIZE_BITS * ec->osr))
 560                         break;
 561         }
 562 }
 563
 564 /*
 565  * Entry function: Obtain entropy for the caller.
 566  *
 567  * This function invokes the entropy gathering logic as often to generate
 568  * as many bytes as requested by the caller. The entropy gathering logic
 569  * creates 64 bit per invocation.
 570  *
 571  * This function truncates the last 64 bit entropy value output to the exact
 572  * size specified by the caller.
 573  *
 574  * @ec [in] Reference to entropy collector
 575  * @data [in] pointer to buffer for storing random data -- buffer must already
 576  *            exist
 577  * @len [in] size of the buffer, specifying also the requested number of random
 578  *           in bytes
 579  *
 580  * @return 0 when request is fulfilled or an error
 581  *
 582  * The following error codes can occur:
 583  *      -1      entropy_collector is NULL
 584  *      -2      RCT failed
 585  *      -3      APT test failed
 586  */
 587 int jent_read_entropy(struct rand_data *ec, unsigned char *data,
 588                       unsigned int len)
 589 {
 590         unsigned char *p = data;
 591
 592         if (!ec)
 593                 return -1;
 594
 595         while (len > 0) {
 596                 unsigned int tocopy;
 597
 598                 jent_gen_entropy(ec);
 599
 600                 if (jent_health_failure(ec)) {
 601                         int ret;
 602
 603                         if (jent_rct_failure(ec))
 604                                 ret = -2;
 605                         else
 606                                 ret = -3;
 607
 608                         /*
 609                          * Re-initialize the noise source
 610                          *
 611                          * If the health test fails, the Jitter RNG remains
 612                          * in failure state and will return a health failure
 613                          * during next invocation.
 614                          */
 615                         if (jent_entropy_init())
 616                                 return ret;
 617
 618                         /* Set APT to initial state */
 619                         jent_apt_reset(ec, 0);
 620                         ec->apt_base_set = 0;
 621
 622                         /* Set RCT to initial state */
 623                         ec->rct_count = 0;
 624
 625                         /* Re-enable Jitter RNG */
 626                         ec->health_failure = 0;
 627
 628                         /*
 629                          * Return the health test failure status to the
 630                          * caller as the generated value is not appropriate.
 631                          */
 632                         return ret;
 633                 }
 634
 635                 if ((DATA_SIZE_BITS / 8) < len)
 636                         tocopy = (DATA_SIZE_BITS / 8);
 637                 else
 638                         tocopy = len;
 639                 jent_memcpy(p, &ec->data, tocopy);
 640
 641                 len -= tocopy;
 642                 p += tocopy;
 643         }
 644
 645         return 0;
 646 }
 647
 648 /***************************************************************************
 649  * Initialization logic
 650  ***************************************************************************/
 651
 652 struct rand_data *jent_entropy_collector_alloc(unsigned int osr,
 653                                                unsigned int flags)
 654 {
 655         struct rand_data *entropy_collector;
 656
 657         entropy_collector = jent_zalloc(sizeof(struct rand_data));
 658         if (!entropy_collector)
 659                 return NULL;
 660
 661         if (!(flags & JENT_DISABLE_MEMORY_ACCESS)) {
 662                 /* Allocate memory for adding variations based on memory
 663                  * access
 664                  */
 665                 entropy_collector->mem = jent_zalloc(JENT_MEMORY_SIZE);
 666                 if (!entropy_collector->mem) {
 667                         jent_zfree(entropy_collector);
 668                         return NULL;
 669                 }
 670                 entropy_collector->memblocksize = JENT_MEMORY_BLOCKSIZE;
 671                 entropy_collector->memblocks = JENT_MEMORY_BLOCKS;
 672                 entropy_collector->memaccessloops = JENT_MEMORY_ACCESSLOOPS;
 673         }
 674
 675         /* verify and set the oversampling rate */
 676         if (osr == 0)
 677                 osr = 1; /* minimum sampling rate is 1 */
 678         entropy_collector->osr = osr;
 679
 680         /* fill the data pad with non-zero values */
 681         jent_gen_entropy(entropy_collector);
 682
 683         return entropy_collector;
 684 }
 685
 686 void jent_entropy_collector_free(struct rand_data *entropy_collector)
 687 {
 688         jent_zfree(entropy_collector->mem);
 689         entropy_collector->mem = NULL;
 690         jent_zfree(entropy_collector);
 691 }
 692
 693 int jent_entropy_init(void)
 694 {
 695         int i;
 696         __u64 delta_sum = 0;
 697         __u64 old_delta = 0;
 698         unsigned int nonstuck = 0;
 699         int time_backwards = 0;
 700         int count_mod = 0;
 701         int count_stuck = 0;
 702         struct rand_data ec = { 0 };
 703
 704         /* Required for RCT */
 705         ec.osr = 1;
 706
 707         /* We could perform statistical tests here, but the problem is
 708          * that we only have a few loop counts to do testing. These
 709          * loop counts may show some slight skew and we produce
 710          * false positives.
 711          *
 712          * Moreover, only old systems show potentially problematic
 713          * jitter entropy that could potentially be caught here. But
 714          * the RNG is intended for hardware that is available or widely
 715          * used, but not old systems that are long out of favor. Thus,
 716          * no statistical tests.
 717          */
 718
 719         /*
 720          * We could add a check for system capabilities such as clock_getres or
 721          * check for CONFIG_X86_TSC, but it does not make much sense as the
 722          * following sanity checks verify that we have a high-resolution
 723          * timer.
 724          */
 725         /*
 726          * TESTLOOPCOUNT needs some loops to identify edge systems. 100 is
 727          * definitely too little.
 728          *
 729          * SP800-90B requires at least 1024 initial test cycles.
 730          */
 731 #define TESTLOOPCOUNT 1024
 732 #define CLEARCACHE 100
 733         for (i = 0; (TESTLOOPCOUNT + CLEARCACHE) > i; i++) {
 734                 __u64 time = 0;
 735                 __u64 time2 = 0;
 736                 __u64 delta = 0;
 737                 unsigned int lowdelta = 0;
 738                 int stuck;
 739
 740                 /* Invoke core entropy collection logic */
 741                 jent_get_nstime(&time);
 742                 ec.prev_time = time;
 743                 jent_lfsr_time(&ec, time, 0, 0);
 744                 jent_get_nstime(&time2);
 745
 746                 /* test whether timer works */
 747                 if (!time || !time2)
 748                         return JENT_ENOTIME;
 749                 delta = jent_delta(time, time2);
 750                 /*
 751                  * test whether timer is fine grained enough to provide
 752                  * delta even when called shortly after each other -- this
 753                  * implies that we also have a high resolution timer
 754                  */
 755                 if (!delta)
 756                         return JENT_ECOARSETIME;
 757
 758                 stuck = jent_stuck(&ec, delta);
 759
 760                 /*
 761                  * up to here we did not modify any variable that will be
 762                  * evaluated later, but we already performed some work. Thus we
 763                  * already have had an impact on the caches, branch prediction,
 764                  * etc. with the goal to clear it to get the worst case
 765                  * measurements.
 766                  */
 767                 if (i < CLEARCACHE)
 768                         continue;
 769
 770                 if (stuck)
 771                         count_stuck++;
 772                 else {
 773                         nonstuck++;
 774
 775                         /*
 776                          * Ensure that the APT succeeded.
 777                          *
 778                          * With the check below that count_stuck must be less
 779                          * than 10% of the overall generated raw entropy values
 780                          * it is guaranteed that the APT is invoked at
 781                          * floor((TESTLOOPCOUNT * 0.9) / 64) == 14 times.
 782                          */
 783                         if ((nonstuck % JENT_APT_WINDOW_SIZE) == 0) {
 784                                 jent_apt_reset(&ec,
 785                                                delta & JENT_APT_WORD_MASK);
 786                                 if (jent_health_failure(&ec))
 787                                         return JENT_EHEALTH;
 788                         }
 789                 }
 790
 791                 /* Validate RCT */
 792                 if (jent_rct_failure(&ec))
 793                         return JENT_ERCT;
 794
 795                 /* test whether we have an increasing timer */
 796                 if (!(time2 > time))
 797                         time_backwards++;
 798
 799                 /* use 32 bit value to ensure compilation on 32 bit arches */
 800                 lowdelta = time2 - time;
 801                 if (!(lowdelta % 100))
 802                         count_mod++;
 803
 804                 /*
 805                  * ensure that we have a varying delta timer which is necessary
 806                  * for the calculation of entropy -- perform this check
 807                  * only after the first loop is executed as we need to prime
 808                  * the old_data value
 809                  */
 810                 if (delta > old_delta)
 811                         delta_sum += (delta - old_delta);
 812                 else
 813                         delta_sum += (old_delta - delta);
 814                 old_delta = delta;
 815         }
 816
 817         /*
 818          * we allow up to three times the time running backwards.
 819          * CLOCK_REALTIME is affected by adjtime and NTP operations. Thus,
 820          * if such an operation just happens to interfere with our test, it
 821          * should not fail. The value of 3 should cover the NTP case being
 822          * performed during our test run.
 823          */
 824         if (time_backwards > 3)
 825                 return JENT_ENOMONOTONIC;
 826
 827         /*
 828          * Variations of deltas of time must on average be larger
 829          * than 1 to ensure the entropy estimation
 830          * implied with 1 is preserved
 831          */
 832         if ((delta_sum) <= 1)
 833                 return JENT_EVARVAR;
 834
 835         /*
 836          * Ensure that we have variations in the time stamp below 10 for at
 837          * least 10% of all checks -- on some platforms, the counter increments
 838          * in multiples of 100, but not always
 839          */
 840         if ((TESTLOOPCOUNT/10 * 9) < count_mod)
 841                 return JENT_ECOARSETIME;
 842
 843         /*
 844          * If we have more than 90% stuck results, then this Jitter RNG is
 845          * likely to not work well.
 846          */
 847         if ((TESTLOOPCOUNT/10 * 9) < count_stuck)
 848                 return JENT_ESTUCK;
 849
 850         return 0;
 851 }