4 * Copyright (c) 2002 Jason L. Wright (jason@thought.net)
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Jason L. Wright
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
40 #include <sys/callout.h>
41 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/random.h>
45 #include <sys/sysctl.h>
46 #include <machine/stdarg.h>
48 #include <dev/rndtest/rndtest.h>
50 static void rndtest_test(struct rndtest_state *);
51 static void rndtest_timeout(void *);
53 /* The tests themselves */
54 static int rndtest_monobit(struct rndtest_state *);
55 static int rndtest_runs(struct rndtest_state *);
56 static int rndtest_longruns(struct rndtest_state *);
57 static int rndtest_chi_4(struct rndtest_state *);
59 static int rndtest_runs_check(struct rndtest_state *, int, int *);
60 static void rndtest_runs_record(struct rndtest_state *, int, int *);
62 static const struct rndtest_testfunc {
63 int (*test)(struct rndtest_state *);
71 #define RNDTEST_NTESTS (sizeof(rndtest_funcs)/sizeof(rndtest_funcs[0]))
73 static SYSCTL_NODE(_kern, OID_AUTO, rndtest, CTLFLAG_RD, 0,
74 "RNG test parameters");
75 static int rndtest_retest = 120; /* interval in seconds */
76 SYSCTL_INT(_kern_rndtest, OID_AUTO, retest, CTLFLAG_RW, &rndtest_retest,
77 0, "retest interval (seconds)");
78 static struct rndtest_stats rndstats;
79 SYSCTL_STRUCT(_kern_rndtest, OID_AUTO, stats, CTLFLAG_RD, &rndstats,
80 rndtest_stats, "RNG test statistics");
81 static int rndtest_verbose = 1; /* report only failures */
82 SYSCTL_INT(_kern_rndtest, OID_AUTO, verbose, CTLFLAG_RW, &rndtest_verbose,
83 0, "display results on console");
85 struct rndtest_state *
86 rndtest_attach(device_t dev)
88 struct rndtest_state *rsp;
90 rsp = malloc(sizeof (*rsp), M_DEVBUF, M_NOWAIT);
92 rsp->rs_begin = rsp->rs_buf;
93 rsp->rs_end = rsp->rs_buf + sizeof(rsp->rs_buf);
94 rsp->rs_current = rsp->rs_begin;
98 #if __FreeBSD_version < 500000
99 callout_init(&rsp->rs_to);
101 callout_init(&rsp->rs_to, CALLOUT_MPSAFE);
104 device_printf(dev, "rndtest_init: no memory for state block\n");
109 rndtest_detach(struct rndtest_state *rsp)
111 callout_stop(&rsp->rs_to);
116 rndtest_harvest(struct rndtest_state *rsp, void *buf, u_int len)
120 * If enabled, collect data and run tests when we have enough.
122 if (rsp->rs_collect) {
123 for (i = 0; i < len; i++) {
124 *rsp->rs_current = ((u_char *) buf)[i];
125 if (++rsp->rs_current == rsp->rs_end) {
127 rsp->rs_current = rsp->rs_begin;
129 * If tests passed, turn off collection and
130 * schedule another test. Otherwise we keep
131 * testing until the data looks ok.
133 if (!rsp->rs_discard && rndtest_retest != 0) {
135 callout_reset(&rsp->rs_to,
137 rndtest_timeout, rsp);
144 * Only stir entropy that passes muster into the pool.
147 rndstats.rst_discard += len;
149 #if __FreeBSD_version < 500000
150 /* XXX verify buffer is word aligned */
152 for (len /= sizeof (u_int32_t); len; len--)
153 add_true_randomness(*p++);
155 random_harvest(buf, len, len*NBBY, 0, RANDOM_PURE);
161 rndtest_test(struct rndtest_state *rsp)
165 rndstats.rst_tests++;
166 for (i = 0; i < RNDTEST_NTESTS; i++)
167 rv |= (*rndtest_funcs[i].test)(rsp);
168 rsp->rs_discard = (rv != 0);
172 rndtest_report(struct rndtest_state *rsp, int failure, const char *fmt, ...)
177 if (rndtest_verbose == 0)
179 if (!failure && rndtest_verbose == 1) /* don't report successes */
182 vsnprintf(buf, sizeof (buf), fmt, ap);
184 device_printf(rsp->rs_parent, "rndtest: %s\n", buf);
187 #define RNDTEST_MONOBIT_MINONES 9725
188 #define RNDTEST_MONOBIT_MAXONES 10275
191 rndtest_monobit(struct rndtest_state *rsp)
196 for (i = 0; i < RNDTEST_NBYTES; i++) {
198 for (j = 0; j < 8; j++, r <<= 1)
202 if (ones > RNDTEST_MONOBIT_MINONES &&
203 ones < RNDTEST_MONOBIT_MAXONES) {
204 if (rndtest_verbose > 1)
205 rndtest_report(rsp, 0, "monobit pass (%d < %d < %d)",
206 RNDTEST_MONOBIT_MINONES, ones,
207 RNDTEST_MONOBIT_MAXONES);
211 rndtest_report(rsp, 1,
212 "monobit failed (%d ones)", ones);
213 rndstats.rst_monobit++;
218 #define RNDTEST_RUNS_NINTERVAL 6
220 static const struct rndtest_runs_tabs {
222 } rndtest_runs_tab[] = {
232 rndtest_runs(struct rndtest_state *rsp)
234 int i, j, ones, zeros, rv = 0;
235 int onei[RNDTEST_RUNS_NINTERVAL], zeroi[RNDTEST_RUNS_NINTERVAL];
238 bzero(onei, sizeof(onei));
239 bzero(zeroi, sizeof(zeroi));
241 for (i = 0; i < RNDTEST_NBYTES; i++) {
243 for (j = 0; j < 8; j++, c <<= 1) {
246 rndtest_runs_record(rsp, zeros, zeroi);
250 rndtest_runs_record(rsp, ones, onei);
255 rndtest_runs_record(rsp, ones, onei);
256 rndtest_runs_record(rsp, zeros, zeroi);
258 rv |= rndtest_runs_check(rsp, 0, zeroi);
259 rv |= rndtest_runs_check(rsp, 1, onei);
268 rndtest_runs_record(struct rndtest_state *rsp, int len, int *intrv)
272 if (len > RNDTEST_RUNS_NINTERVAL)
273 len = RNDTEST_RUNS_NINTERVAL;
279 rndtest_runs_check(struct rndtest_state *rsp, int val, int *src)
283 for (i = 0; i < RNDTEST_RUNS_NINTERVAL; i++) {
284 if (src[i] < rndtest_runs_tab[i].min ||
285 src[i] > rndtest_runs_tab[i].max) {
286 rndtest_report(rsp, 1,
287 "%s interval %d failed (%d, %d-%d)",
288 val ? "ones" : "zeros",
289 i + 1, src[i], rndtest_runs_tab[i].min,
290 rndtest_runs_tab[i].max);
293 rndtest_report(rsp, 0,
294 "runs pass %s interval %d (%d < %d < %d)",
295 val ? "ones" : "zeros",
296 i + 1, rndtest_runs_tab[i].min, src[i],
297 rndtest_runs_tab[i].max);
304 rndtest_longruns(struct rndtest_state *rsp)
306 int i, j, ones = 0, zeros = 0, maxones = 0, maxzeros = 0;
309 for (i = 0; i < RNDTEST_NBYTES; i++) {
311 for (j = 0; j < 8; j++, c <<= 1) {
320 if (zeros > maxzeros)
326 if (maxones < 26 && maxzeros < 26) {
327 rndtest_report(rsp, 0, "longruns pass (%d ones, %d zeros)",
331 rndtest_report(rsp, 1, "longruns fail (%d ones, %d zeros)",
333 rndstats.rst_longruns++;
339 * chi^2 test over 4 bits: (this is called the poker test in FIPS 140-2,
340 * but it is really the chi^2 test over 4 bits (the poker test as described
341 * by Knuth vol 2 is something different, and I take him as authoritative
342 * on nomenclature over NIST).
344 #define RNDTEST_CHI4_K 16
345 #define RNDTEST_CHI4_K_MASK (RNDTEST_CHI4_K - 1)
348 * The unnormalized values are used so that we don't have to worry about
349 * fractional precision. The "real" value is found by:
350 * (V - 1562500) * (16 / 5000) = Vn (where V is the unnormalized value)
352 #define RNDTEST_CHI4_VMIN 1563181 /* 2.1792 */
353 #define RNDTEST_CHI4_VMAX 1576929 /* 46.1728 */
356 rndtest_chi_4(struct rndtest_state *rsp)
358 unsigned int freq[RNDTEST_CHI4_K], i, sum;
360 for (i = 0; i < RNDTEST_CHI4_K; i++)
363 /* Get number of occurances of each 4 bit pattern */
364 for (i = 0; i < RNDTEST_NBYTES; i++) {
365 freq[(rsp->rs_buf[i] >> 4) & RNDTEST_CHI4_K_MASK]++;
366 freq[(rsp->rs_buf[i] >> 0) & RNDTEST_CHI4_K_MASK]++;
369 for (i = 0, sum = 0; i < RNDTEST_CHI4_K; i++)
370 sum += freq[i] * freq[i];
372 if (sum >= 1563181 && sum <= 1576929) {
373 rndtest_report(rsp, 0, "chi^2(4): pass (sum %u)", sum);
376 rndtest_report(rsp, 1, "chi^2(4): failed (sum %u)", sum);
383 rndtest_timeout(void *xrsp)
385 struct rndtest_state *rsp = xrsp;
391 rndtest_modevent(module_t mod, int type, void *unused)
402 static moduledata_t rndtest_mod = {
407 DECLARE_MODULE(rndtest, rndtest_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
408 MODULE_VERSION(rndtest, 1);