blob: c7d7f2caa7793b131d203c9fc3907d17d800c887 [file] [log] [blame]
Stephan Muellerbb5530e2015-05-25 15:10:20 +02001/*
Stephan Muellerdfc9fa92015-06-23 16:18:54 +02002 * Non-physical true random number generator based on timing jitter --
3 * Jitter RNG standalone code.
Stephan Muellerbb5530e2015-05-25 15:10:20 +02004 *
Stephan Müllerbb897c52023-04-21 08:08:04 +02005 * Copyright Stephan Mueller <smueller@chronox.de>, 2015 - 2023
Stephan Muellerbb5530e2015-05-25 15:10:20 +02006 *
7 * Design
8 * ======
9 *
Alexander A. Klimov9332a9e2020-07-19 18:49:59 +020010 * See https://www.chronox.de/jent.html
Stephan Muellerbb5530e2015-05-25 15:10:20 +020011 *
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
Stephan Müllerbb897c52023-04-21 08:08:04 +020050 * version 3.4.0 provided at https://www.chronox.de/jent.html
Stephan Muellerbb5530e2015-05-25 15:10:20 +020051 */
52
Stephan Muellerdfc9fa92015-06-23 16:18:54 +020053#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
57typedef unsigned long long __u64;
58typedef long long __s64;
59typedef unsigned int __u32;
Stephan Müllerbb897c52023-04-21 08:08:04 +020060typedef unsigned char u8;
Stephan Muellerdfc9fa92015-06-23 16:18:54 +020061#define NULL ((void *) 0)
Stephan Muellerbb5530e2015-05-25 15:10:20 +020062
Stephan Muellerbb5530e2015-05-25 15:10:20 +020063/* The entropy pool */
64struct rand_data {
Stephan Müllerbb897c52023-04-21 08:08:04 +020065 /* SHA3-256 is used as conditioner */
66#define DATA_SIZE_BITS 256
Stephan Muellerbb5530e2015-05-25 15:10:20 +020067 /* all data values that are vital to maintain the security
68 * of the RNG are marked as SENSITIVE. A user must not
69 * access that information while the RNG executes its loops to
70 * calculate the next random value. */
Stephan Müllerbb897c52023-04-21 08:08:04 +020071 void *hash_state; /* SENSITIVE hash state entropy pool */
72 __u64 prev_time; /* SENSITIVE Previous time stamp */
73 __u64 last_delta; /* SENSITIVE stuck test */
74 __s64 last_delta2; /* SENSITIVE stuck test */
75 unsigned int osr; /* Oversample rate */
Stephan Muellerbb5530e2015-05-25 15:10:20 +020076#define JENT_MEMORY_BLOCKS 64
77#define JENT_MEMORY_BLOCKSIZE 32
78#define JENT_MEMORY_ACCESSLOOPS 128
79#define JENT_MEMORY_SIZE (JENT_MEMORY_BLOCKS*JENT_MEMORY_BLOCKSIZE)
80 unsigned char *mem; /* Memory access location with size of
81 * memblocks * memblocksize */
82 unsigned int memlocation; /* Pointer to byte in *mem */
83 unsigned int memblocks; /* Number of memory blocks in *mem */
84 unsigned int memblocksize; /* Size of one memory block in bytes */
85 unsigned int memaccessloops; /* Number of memory accesses per random
86 * bit generation */
Stephan Müller764428f2020-04-17 21:33:33 +020087
88 /* Repetition Count Test */
Stephan Müller3fde2fe2023-03-27 09:03:52 +020089 unsigned int rct_count; /* Number of stuck values */
Stephan Müller764428f2020-04-17 21:33:33 +020090
Stephan Müller3fde2fe2023-03-27 09:03:52 +020091 /* Intermittent health test failure threshold of 2^-30 */
92#define JENT_RCT_CUTOFF 30 /* Taken from SP800-90B sec 4.4.1 */
Stephan Müller764428f2020-04-17 21:33:33 +020093#define JENT_APT_CUTOFF 325 /* Taken from SP800-90B sec 4.4.2 */
Stephan Müller3fde2fe2023-03-27 09:03:52 +020094 /* Permanent health test failure threshold of 2^-60 */
95#define JENT_RCT_CUTOFF_PERMANENT 60
96#define JENT_APT_CUTOFF_PERMANENT 355
Stephan Müller764428f2020-04-17 21:33:33 +020097#define JENT_APT_WINDOW_SIZE 512 /* Data window size */
98 /* LSB of time stamp to process */
99#define JENT_APT_LSB 16
100#define JENT_APT_WORD_MASK (JENT_APT_LSB - 1)
101 unsigned int apt_observations; /* Number of collected observations */
102 unsigned int apt_count; /* APT counter */
103 unsigned int apt_base; /* APT base reference */
104 unsigned int apt_base_set:1; /* APT base reference set? */
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200105};
106
107/* Flags that can be used to initialize the RNG */
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200108#define JENT_DISABLE_MEMORY_ACCESS (1<<2) /* Disable memory access for more
109 * entropy, saves MEMORY_SIZE RAM for
110 * entropy collector */
111
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200112/* -- error codes for init function -- */
113#define JENT_ENOTIME 1 /* Timer service not available */
114#define JENT_ECOARSETIME 2 /* Timer too coarse for RNG */
115#define JENT_ENOMONOTONIC 3 /* Timer is not monotonic increasing */
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200116#define JENT_EVARVAR 5 /* Timer does not produce variations of
117 * variations (2nd derivation of time is
118 * zero). */
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200119#define JENT_ESTUCK 8 /* Too many stuck results during init. */
Stephan Müller764428f2020-04-17 21:33:33 +0200120#define JENT_EHEALTH 9 /* Health test failed during initialization */
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200121
Stephan Müller908dffa2021-12-20 07:21:53 +0100122/*
123 * The output n bits can receive more than n bits of min entropy, of course,
124 * but the fixed output of the conditioning function can only asymptotically
125 * approach the output size bits of min entropy, not attain that bound. Random
126 * maps will tend to have output collisions, which reduces the creditable
127 * output entropy (that is what SP 800-90B Section 3.1.5.1.2 attempts to bound).
128 *
129 * The value "64" is justified in Appendix A.4 of the current 90C draft,
130 * and aligns with NIST's in "epsilon" definition in this document, which is
131 * that a string can be considered "full entropy" if you can bound the min
132 * entropy in each bit of output to at least 1-epsilon, where epsilon is
133 * required to be <= 2^(-32).
134 */
135#define JENT_ENTROPY_SAFETY_FACTOR 64
136
137#include <linux/fips.h>
Ben Dooks965d7282019-10-09 10:12:56 +0100138#include "jitterentropy.h"
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200139
Stephan Müller764428f2020-04-17 21:33:33 +0200140/***************************************************************************
141 * Adaptive Proportion Test
142 *
143 * This test complies with SP800-90B section 4.4.2.
144 ***************************************************************************/
145
Randy Dunlap04cb7882021-08-24 14:05:13 -0700146/*
Stephan Müller764428f2020-04-17 21:33:33 +0200147 * Reset the APT counter
148 *
149 * @ec [in] Reference to entropy collector
150 */
151static void jent_apt_reset(struct rand_data *ec, unsigned int delta_masked)
152{
153 /* Reset APT counter */
154 ec->apt_count = 0;
155 ec->apt_base = delta_masked;
156 ec->apt_observations = 0;
157}
158
Randy Dunlap04cb7882021-08-24 14:05:13 -0700159/*
Stephan Müller764428f2020-04-17 21:33:33 +0200160 * Insert a new entropy event into APT
161 *
162 * @ec [in] Reference to entropy collector
163 * @delta_masked [in] Masked time delta to process
164 */
165static void jent_apt_insert(struct rand_data *ec, unsigned int delta_masked)
166{
167 /* Initialize the base reference */
168 if (!ec->apt_base_set) {
169 ec->apt_base = delta_masked;
170 ec->apt_base_set = 1;
171 return;
172 }
173
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200174 if (delta_masked == ec->apt_base)
Stephan Müller764428f2020-04-17 21:33:33 +0200175 ec->apt_count++;
176
Stephan Müller764428f2020-04-17 21:33:33 +0200177 ec->apt_observations++;
178
179 if (ec->apt_observations >= JENT_APT_WINDOW_SIZE)
180 jent_apt_reset(ec, delta_masked);
181}
182
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200183/* APT health test failure detection */
184static int jent_apt_permanent_failure(struct rand_data *ec)
185{
186 return (ec->apt_count >= JENT_APT_CUTOFF_PERMANENT) ? 1 : 0;
187}
188
189static int jent_apt_failure(struct rand_data *ec)
190{
191 return (ec->apt_count >= JENT_APT_CUTOFF) ? 1 : 0;
192}
193
Stephan Müller764428f2020-04-17 21:33:33 +0200194/***************************************************************************
195 * Stuck Test and its use as Repetition Count Test
196 *
197 * The Jitter RNG uses an enhanced version of the Repetition Count Test
198 * (RCT) specified in SP800-90B section 4.4.1. Instead of counting identical
199 * back-to-back values, the input to the RCT is the counting of the stuck
200 * values during the generation of one Jitter RNG output block.
201 *
202 * The RCT is applied with an alpha of 2^{-30} compliant to FIPS 140-2 IG 9.8.
203 *
204 * During the counting operation, the Jitter RNG always calculates the RCT
205 * cut-off value of C. If that value exceeds the allowed cut-off value,
206 * the Jitter RNG output block will be calculated completely but discarded at
207 * the end. The caller of the Jitter RNG is informed with an error code.
208 ***************************************************************************/
209
Randy Dunlap04cb7882021-08-24 14:05:13 -0700210/*
Stephan Müller764428f2020-04-17 21:33:33 +0200211 * Repetition Count Test as defined in SP800-90B section 4.4.1
212 *
213 * @ec [in] Reference to entropy collector
214 * @stuck [in] Indicator whether the value is stuck
215 */
216static void jent_rct_insert(struct rand_data *ec, int stuck)
217{
Stephan Müller764428f2020-04-17 21:33:33 +0200218 if (stuck) {
219 ec->rct_count++;
Stephan Müller764428f2020-04-17 21:33:33 +0200220 } else {
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200221 /* Reset RCT */
Stephan Müller764428f2020-04-17 21:33:33 +0200222 ec->rct_count = 0;
223 }
224}
225
Stephan Müller764428f2020-04-17 21:33:33 +0200226static inline __u64 jent_delta(__u64 prev, __u64 next)
227{
228#define JENT_UINT64_MAX (__u64)(~((__u64) 0))
229 return (prev < next) ? (next - prev) :
230 (JENT_UINT64_MAX - prev + 1 + next);
231}
232
Randy Dunlap04cb7882021-08-24 14:05:13 -0700233/*
Stephan Müller764428f2020-04-17 21:33:33 +0200234 * Stuck test by checking the:
235 * 1st derivative of the jitter measurement (time delta)
236 * 2nd derivative of the jitter measurement (delta of time deltas)
237 * 3rd derivative of the jitter measurement (delta of delta of time deltas)
238 *
239 * All values must always be non-zero.
240 *
241 * @ec [in] Reference to entropy collector
242 * @current_delta [in] Jitter time delta
243 *
244 * @return
245 * 0 jitter measurement not stuck (good bit)
246 * 1 jitter measurement stuck (reject bit)
247 */
248static int jent_stuck(struct rand_data *ec, __u64 current_delta)
249{
250 __u64 delta2 = jent_delta(ec->last_delta, current_delta);
251 __u64 delta3 = jent_delta(ec->last_delta2, delta2);
Stephan Müller764428f2020-04-17 21:33:33 +0200252
253 ec->last_delta = current_delta;
254 ec->last_delta2 = delta2;
255
256 /*
257 * Insert the result of the comparison of two back-to-back time
258 * deltas.
259 */
Stephan Müller552d03a2021-11-21 15:14:20 +0100260 jent_apt_insert(ec, current_delta);
Stephan Müller764428f2020-04-17 21:33:33 +0200261
262 if (!current_delta || !delta2 || !delta3) {
263 /* RCT with a stuck bit */
264 jent_rct_insert(ec, 1);
265 return 1;
266 }
267
268 /* RCT with a non-stuck bit */
269 jent_rct_insert(ec, 0);
270
271 return 0;
272}
273
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200274/* RCT health test failure detection */
275static int jent_rct_permanent_failure(struct rand_data *ec)
276{
277 return (ec->rct_count >= JENT_RCT_CUTOFF_PERMANENT) ? 1 : 0;
278}
279
280static int jent_rct_failure(struct rand_data *ec)
281{
282 return (ec->rct_count >= JENT_RCT_CUTOFF) ? 1 : 0;
283}
284
285/* Report of health test failures */
Stephan Müller764428f2020-04-17 21:33:33 +0200286static int jent_health_failure(struct rand_data *ec)
287{
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200288 return jent_rct_failure(ec) | jent_apt_failure(ec);
289}
290
291static int jent_permanent_health_failure(struct rand_data *ec)
292{
293 return jent_rct_permanent_failure(ec) | jent_apt_permanent_failure(ec);
Stephan Müller764428f2020-04-17 21:33:33 +0200294}
295
296/***************************************************************************
297 * Noise sources
298 ***************************************************************************/
299
Randy Dunlap04cb7882021-08-24 14:05:13 -0700300/*
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200301 * Update of the loop count used for the next round of
302 * an entropy collection.
303 *
304 * Input:
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200305 * @bits is the number of low bits of the timer to consider
306 * @min is the number of bits we shift the timer value to the right at
307 * the end to make sure we have a guaranteed minimum value
308 *
309 * @return Newly calculated loop counter
310 */
Stephan Müllerbb897c52023-04-21 08:08:04 +0200311static __u64 jent_loop_shuffle(unsigned int bits, unsigned int min)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200312{
313 __u64 time = 0;
314 __u64 shuffle = 0;
315 unsigned int i = 0;
316 unsigned int mask = (1<<bits) - 1;
317
318 jent_get_nstime(&time);
Stephan Müllerbb897c52023-04-21 08:08:04 +0200319
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200320 /*
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200321 * We fold the time value as much as possible to ensure that as many
322 * bits of the time stamp are included as possible.
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200323 */
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200324 for (i = 0; ((DATA_SIZE_BITS + bits - 1) / bits) > i; i++) {
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200325 shuffle ^= time & mask;
326 time = time >> bits;
327 }
328
329 /*
330 * We add a lower boundary value to ensure we have a minimum
331 * RNG loop count.
332 */
333 return (shuffle + (1<<min));
334}
335
Randy Dunlap04cb7882021-08-24 14:05:13 -0700336/*
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200337 * CPU Jitter noise source -- this is the noise source based on the CPU
338 * execution time jitter
339 *
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200340 * This function injects the individual bits of the time value into the
Stephan Müllerbb897c52023-04-21 08:08:04 +0200341 * entropy pool using a hash.
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200342 *
Stephan Müllerbb897c52023-04-21 08:08:04 +0200343 * ec [in] entropy collector
344 * time [in] time stamp to be injected
345 * stuck [in] Is the time stamp identified as stuck?
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200346 *
347 * Output:
Stephan Müllerbb897c52023-04-21 08:08:04 +0200348 * updated hash context in the entropy collector or error code
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200349 */
Stephan Müllerbb897c52023-04-21 08:08:04 +0200350static int jent_condition_data(struct rand_data *ec, __u64 time, int stuck)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200351{
Stephan Müllerbb897c52023-04-21 08:08:04 +0200352#define SHA3_HASH_LOOP (1<<3)
353 struct {
354 int rct_count;
355 unsigned int apt_observations;
356 unsigned int apt_count;
357 unsigned int apt_base;
358 } addtl = {
359 ec->rct_count,
360 ec->apt_observations,
361 ec->apt_count,
362 ec->apt_base
363 };
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200364
Stephan Müllerbb897c52023-04-21 08:08:04 +0200365 return jent_hash_time(ec->hash_state, time, (u8 *)&addtl, sizeof(addtl),
366 SHA3_HASH_LOOP, stuck);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200367}
368
Randy Dunlap04cb7882021-08-24 14:05:13 -0700369/*
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200370 * Memory Access noise source -- this is a noise source based on variations in
371 * memory access times
372 *
373 * This function performs memory accesses which will add to the timing
374 * variations due to an unknown amount of CPU wait states that need to be
375 * added when accessing memory. The memory size should be larger than the L1
376 * caches as outlined in the documentation and the associated testing.
377 *
378 * The L1 cache has a very high bandwidth, albeit its access rate is usually
379 * slower than accessing CPU registers. Therefore, L1 accesses only add minimal
380 * variations as the CPU has hardly to wait. Starting with L2, significant
381 * variations are added because L2 typically does not belong to the CPU any more
382 * and therefore a wider range of CPU wait states is necessary for accesses.
383 * L3 and real memory accesses have even a wider range of wait states. However,
384 * to reliably access either L3 or memory, the ec->mem memory must be quite
385 * large which is usually not desirable.
386 *
Stephan Müller764428f2020-04-17 21:33:33 +0200387 * @ec [in] Reference to the entropy collector with the memory access data -- if
388 * the reference to the memory block to be accessed is NULL, this noise
389 * source is disabled
390 * @loop_cnt [in] if a value not equal to 0 is set, use the given value
391 * number of loops to perform the LFSR
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200392 */
Stephan Müller764428f2020-04-17 21:33:33 +0200393static void jent_memaccess(struct rand_data *ec, __u64 loop_cnt)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200394{
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200395 unsigned int wrap = 0;
396 __u64 i = 0;
397#define MAX_ACC_LOOP_BIT 7
398#define MIN_ACC_LOOP_BIT 0
399 __u64 acc_loop_cnt =
Stephan Müllerbb897c52023-04-21 08:08:04 +0200400 jent_loop_shuffle(MAX_ACC_LOOP_BIT, MIN_ACC_LOOP_BIT);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200401
402 if (NULL == ec || NULL == ec->mem)
Stephan Müller764428f2020-04-17 21:33:33 +0200403 return;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200404 wrap = ec->memblocksize * ec->memblocks;
405
406 /*
407 * testing purposes -- allow test app to set the counter, not
408 * needed during runtime
409 */
410 if (loop_cnt)
411 acc_loop_cnt = loop_cnt;
412
413 for (i = 0; i < (ec->memaccessloops + acc_loop_cnt); i++) {
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200414 unsigned char *tmpval = ec->mem + ec->memlocation;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200415 /*
416 * memory access: just add 1 to one byte,
417 * wrap at 255 -- memory access implies read
418 * from and write to memory location
419 */
420 *tmpval = (*tmpval + 1) & 0xff;
421 /*
422 * Addition of memblocksize - 1 to pointer
423 * with wrap around logic to ensure that every
424 * memory location is hit evenly
425 */
426 ec->memlocation = ec->memlocation + ec->memblocksize - 1;
427 ec->memlocation = ec->memlocation % wrap;
428 }
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200429}
430
431/***************************************************************************
432 * Start of entropy processing logic
433 ***************************************************************************/
Randy Dunlap04cb7882021-08-24 14:05:13 -0700434/*
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200435 * This is the heart of the entropy generation: calculate time deltas and
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200436 * use the CPU jitter in the time deltas. The jitter is injected into the
437 * entropy pool.
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200438 *
439 * WARNING: ensure that ->prev_time is primed before using the output
440 * of this function! This can be done by calling this function
441 * and not using its result.
442 *
Stephan Müller764428f2020-04-17 21:33:33 +0200443 * @ec [in] Reference to entropy collector
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200444 *
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200445 * @return result of stuck test
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200446 */
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200447static int jent_measure_jitter(struct rand_data *ec)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200448{
449 __u64 time = 0;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200450 __u64 current_delta = 0;
Stephan Müller764428f2020-04-17 21:33:33 +0200451 int stuck;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200452
453 /* Invoke one noise source before time measurement to add variations */
454 jent_memaccess(ec, 0);
455
456 /*
457 * Get time stamp and calculate time delta to previous
458 * invocation to measure the timing variations
459 */
460 jent_get_nstime(&time);
Stephan Müller764428f2020-04-17 21:33:33 +0200461 current_delta = jent_delta(ec->prev_time, time);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200462 ec->prev_time = time;
463
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200464 /* Check whether we have a stuck measurement. */
Stephan Müller764428f2020-04-17 21:33:33 +0200465 stuck = jent_stuck(ec, current_delta);
466
467 /* Now call the next noise sources which also injects the data */
Stephan Müllerbb897c52023-04-21 08:08:04 +0200468 if (jent_condition_data(ec, current_delta, stuck))
469 stuck = 1;
Stephan Müller764428f2020-04-17 21:33:33 +0200470
471 return stuck;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200472}
473
Randy Dunlap04cb7882021-08-24 14:05:13 -0700474/*
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200475 * Generator of one 64 bit random number
Stephan Müllerbb897c52023-04-21 08:08:04 +0200476 * Function fills rand_data->hash_state
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200477 *
Stephan Müller764428f2020-04-17 21:33:33 +0200478 * @ec [in] Reference to entropy collector
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200479 */
480static void jent_gen_entropy(struct rand_data *ec)
481{
Stephan Müller908dffa2021-12-20 07:21:53 +0100482 unsigned int k = 0, safety_factor = 0;
483
484 if (fips_enabled)
485 safety_factor = JENT_ENTROPY_SAFETY_FACTOR;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200486
487 /* priming of the ->prev_time value */
488 jent_measure_jitter(ec);
489
Nicolai Stange710ce4b2021-11-30 15:10:09 +0100490 while (!jent_health_failure(ec)) {
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200491 /* If a stuck measurement is received, repeat measurement */
492 if (jent_measure_jitter(ec))
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200493 continue;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200494
495 /*
496 * We multiply the loop value with ->osr to obtain the
497 * oversampling rate requested by the caller
498 */
Stephan Müller908dffa2021-12-20 07:21:53 +0100499 if (++k >= ((DATA_SIZE_BITS + safety_factor) * ec->osr))
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200500 break;
501 }
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200502}
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200503
Randy Dunlap04cb7882021-08-24 14:05:13 -0700504/*
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200505 * Entry function: Obtain entropy for the caller.
506 *
507 * This function invokes the entropy gathering logic as often to generate
508 * as many bytes as requested by the caller. The entropy gathering logic
509 * creates 64 bit per invocation.
510 *
511 * This function truncates the last 64 bit entropy value output to the exact
512 * size specified by the caller.
513 *
Stephan Müller764428f2020-04-17 21:33:33 +0200514 * @ec [in] Reference to entropy collector
515 * @data [in] pointer to buffer for storing random data -- buffer must already
516 * exist
517 * @len [in] size of the buffer, specifying also the requested number of random
518 * in bytes
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200519 *
520 * @return 0 when request is fulfilled or an error
521 *
522 * The following error codes can occur:
Stephan Müllerbb897c52023-04-21 08:08:04 +0200523 * -1 entropy_collector is NULL or the generation failed
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200524 * -2 Intermittent health failure
525 * -3 Permanent health failure
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200526 */
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200527int jent_read_entropy(struct rand_data *ec, unsigned char *data,
528 unsigned int len)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200529{
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200530 unsigned char *p = data;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200531
532 if (!ec)
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200533 return -1;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200534
Milan Djurovic36c25012021-03-16 18:44:03 -0700535 while (len > 0) {
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200536 unsigned int tocopy;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200537
538 jent_gen_entropy(ec);
Stephan Müller764428f2020-04-17 21:33:33 +0200539
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200540 if (jent_permanent_health_failure(ec)) {
Stephan Müller764428f2020-04-17 21:33:33 +0200541 /*
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200542 * At this point, the Jitter RNG instance is considered
543 * as a failed instance. There is no rerun of the
544 * startup test any more, because the caller
545 * is assumed to not further use this instance.
546 */
547 return -3;
548 } else if (jent_health_failure(ec)) {
549 /*
550 * Perform startup health tests and return permanent
551 * error if it fails.
Stephan Müller764428f2020-04-17 21:33:33 +0200552 */
Stephan Müllerbb897c52023-04-21 08:08:04 +0200553 if (jent_entropy_init(ec->hash_state))
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200554 return -3;
Stephan Müller764428f2020-04-17 21:33:33 +0200555
Stephan Müller3fde2fe2023-03-27 09:03:52 +0200556 return -2;
Stephan Müller764428f2020-04-17 21:33:33 +0200557 }
558
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200559 if ((DATA_SIZE_BITS / 8) < len)
560 tocopy = (DATA_SIZE_BITS / 8);
561 else
562 tocopy = len;
Stephan Müllerbb897c52023-04-21 08:08:04 +0200563 if (jent_read_random_block(ec->hash_state, p, tocopy))
564 return -1;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200565
566 len -= tocopy;
567 p += tocopy;
568 }
569
570 return 0;
571}
572
573/***************************************************************************
574 * Initialization logic
575 ***************************************************************************/
576
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200577struct rand_data *jent_entropy_collector_alloc(unsigned int osr,
Stephan Müllerbb897c52023-04-21 08:08:04 +0200578 unsigned int flags,
579 void *hash_state)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200580{
581 struct rand_data *entropy_collector;
582
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200583 entropy_collector = jent_zalloc(sizeof(struct rand_data));
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200584 if (!entropy_collector)
585 return NULL;
586
587 if (!(flags & JENT_DISABLE_MEMORY_ACCESS)) {
588 /* Allocate memory for adding variations based on memory
589 * access
590 */
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200591 entropy_collector->mem = jent_zalloc(JENT_MEMORY_SIZE);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200592 if (!entropy_collector->mem) {
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200593 jent_zfree(entropy_collector);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200594 return NULL;
595 }
596 entropy_collector->memblocksize = JENT_MEMORY_BLOCKSIZE;
597 entropy_collector->memblocks = JENT_MEMORY_BLOCKS;
598 entropy_collector->memaccessloops = JENT_MEMORY_ACCESSLOOPS;
599 }
600
601 /* verify and set the oversampling rate */
Milan Djurovic36c25012021-03-16 18:44:03 -0700602 if (osr == 0)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200603 osr = 1; /* minimum sampling rate is 1 */
604 entropy_collector->osr = osr;
605
Stephan Müllerbb897c52023-04-21 08:08:04 +0200606 entropy_collector->hash_state = hash_state;
607
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200608 /* fill the data pad with non-zero values */
609 jent_gen_entropy(entropy_collector);
610
611 return entropy_collector;
612}
613
Stephan Muellerdfc9fa92015-06-23 16:18:54 +0200614void jent_entropy_collector_free(struct rand_data *entropy_collector)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200615{
Markus Elfringcea0a3c2015-06-23 22:30:21 +0200616 jent_zfree(entropy_collector->mem);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200617 entropy_collector->mem = NULL;
Markus Elfringcea0a3c2015-06-23 22:30:21 +0200618 jent_zfree(entropy_collector);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200619}
620
Stephan Müllerbb897c52023-04-21 08:08:04 +0200621int jent_entropy_init(void *hash_state)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200622{
623 int i;
624 __u64 delta_sum = 0;
625 __u64 old_delta = 0;
Stephan Müller764428f2020-04-17 21:33:33 +0200626 unsigned int nonstuck = 0;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200627 int time_backwards = 0;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200628 int count_mod = 0;
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200629 int count_stuck = 0;
630 struct rand_data ec = { 0 };
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200631
Stephan Müller764428f2020-04-17 21:33:33 +0200632 /* Required for RCT */
633 ec.osr = 1;
Stephan Müllerbb897c52023-04-21 08:08:04 +0200634 ec.hash_state = hash_state;
Stephan Müller764428f2020-04-17 21:33:33 +0200635
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200636 /* We could perform statistical tests here, but the problem is
637 * that we only have a few loop counts to do testing. These
638 * loop counts may show some slight skew and we produce
639 * false positives.
640 *
641 * Moreover, only old systems show potentially problematic
642 * jitter entropy that could potentially be caught here. But
643 * the RNG is intended for hardware that is available or widely
644 * used, but not old systems that are long out of favor. Thus,
645 * no statistical tests.
646 */
647
648 /*
649 * We could add a check for system capabilities such as clock_getres or
650 * check for CONFIG_X86_TSC, but it does not make much sense as the
651 * following sanity checks verify that we have a high-resolution
652 * timer.
653 */
654 /*
655 * TESTLOOPCOUNT needs some loops to identify edge systems. 100 is
656 * definitely too little.
Stephan Müller764428f2020-04-17 21:33:33 +0200657 *
658 * SP800-90B requires at least 1024 initial test cycles.
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200659 */
Stephan Müller764428f2020-04-17 21:33:33 +0200660#define TESTLOOPCOUNT 1024
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200661#define CLEARCACHE 100
662 for (i = 0; (TESTLOOPCOUNT + CLEARCACHE) > i; i++) {
663 __u64 time = 0;
664 __u64 time2 = 0;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200665 __u64 delta = 0;
666 unsigned int lowdelta = 0;
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200667 int stuck;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200668
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200669 /* Invoke core entropy collection logic */
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200670 jent_get_nstime(&time);
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200671 ec.prev_time = time;
Stephan Müllerbb897c52023-04-21 08:08:04 +0200672 jent_condition_data(&ec, time, 0);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200673 jent_get_nstime(&time2);
674
675 /* test whether timer works */
676 if (!time || !time2)
677 return JENT_ENOTIME;
Stephan Müller764428f2020-04-17 21:33:33 +0200678 delta = jent_delta(time, time2);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200679 /*
680 * test whether timer is fine grained enough to provide
681 * delta even when called shortly after each other -- this
682 * implies that we also have a high resolution timer
683 */
684 if (!delta)
685 return JENT_ECOARSETIME;
686
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200687 stuck = jent_stuck(&ec, delta);
688
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200689 /*
690 * up to here we did not modify any variable that will be
691 * evaluated later, but we already performed some work. Thus we
692 * already have had an impact on the caches, branch prediction,
693 * etc. with the goal to clear it to get the worst case
694 * measurements.
695 */
Milan Djurovic36c25012021-03-16 18:44:03 -0700696 if (i < CLEARCACHE)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200697 continue;
698
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200699 if (stuck)
700 count_stuck++;
Stephan Müller764428f2020-04-17 21:33:33 +0200701 else {
702 nonstuck++;
703
704 /*
705 * Ensure that the APT succeeded.
706 *
707 * With the check below that count_stuck must be less
708 * than 10% of the overall generated raw entropy values
709 * it is guaranteed that the APT is invoked at
710 * floor((TESTLOOPCOUNT * 0.9) / 64) == 14 times.
711 */
712 if ((nonstuck % JENT_APT_WINDOW_SIZE) == 0) {
713 jent_apt_reset(&ec,
714 delta & JENT_APT_WORD_MASK);
Stephan Müller764428f2020-04-17 21:33:33 +0200715 }
716 }
717
Stephan Müllerd2365972023-05-25 19:00:05 +0200718 /* Validate health test result */
719 if (jent_health_failure(&ec))
720 return JENT_EHEALTH;
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200721
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200722 /* test whether we have an increasing timer */
723 if (!(time2 > time))
724 time_backwards++;
725
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200726 /* use 32 bit value to ensure compilation on 32 bit arches */
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200727 lowdelta = time2 - time;
728 if (!(lowdelta % 100))
729 count_mod++;
730
731 /*
732 * ensure that we have a varying delta timer which is necessary
733 * for the calculation of entropy -- perform this check
734 * only after the first loop is executed as we need to prime
735 * the old_data value
736 */
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200737 if (delta > old_delta)
738 delta_sum += (delta - old_delta);
739 else
740 delta_sum += (old_delta - delta);
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200741 old_delta = delta;
742 }
743
744 /*
745 * we allow up to three times the time running backwards.
746 * CLOCK_REALTIME is affected by adjtime and NTP operations. Thus,
747 * if such an operation just happens to interfere with our test, it
748 * should not fail. The value of 3 should cover the NTP case being
749 * performed during our test run.
750 */
Milan Djurovic36c25012021-03-16 18:44:03 -0700751 if (time_backwards > 3)
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200752 return JENT_ENOMONOTONIC;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200753
754 /*
755 * Variations of deltas of time must on average be larger
756 * than 1 to ensure the entropy estimation
757 * implied with 1 is preserved
758 */
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200759 if ((delta_sum) <= 1)
760 return JENT_EVARVAR;
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200761
762 /*
763 * Ensure that we have variations in the time stamp below 10 for at
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200764 * least 10% of all checks -- on some platforms, the counter increments
765 * in multiples of 100, but not always
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200766 */
767 if ((TESTLOOPCOUNT/10 * 9) < count_mod)
768 return JENT_ECOARSETIME;
769
Stephan Müllerd9d67c82019-05-29 21:24:25 +0200770 /*
771 * If we have more than 90% stuck results, then this Jitter RNG is
772 * likely to not work well.
773 */
774 if ((TESTLOOPCOUNT/10 * 9) < count_stuck)
775 return JENT_ESTUCK;
776
Stephan Muellerbb5530e2015-05-25 15:10:20 +0200777 return 0;
778}