1 /* $FreeBSD: src/sys/dev/rndtest/rndtest.c,v 1.1.4.1 2003/06/04 17:10:30 sam Exp $ */
2 /* $DragonFly: src/sys/dev/crypto/rndtest/rndtest.c,v 1.9 2006/12/18 20:41:01 dillon Exp $ */
6 * Copyright (c) 2002 Jason L. Wright (jason@thought.net)
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by Jason L. Wright
20 * 4. The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
36 #include <sys/param.h>
37 #include <sys/systm.h>
39 #include <sys/callout.h>
40 #include <sys/kernel.h>
41 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/random.h>
44 #include <sys/sysctl.h>
45 #include <machine/stdarg.h>
49 static void rndtest_test(struct rndtest_state
*);
50 static void rndtest_timeout(void *);
52 /* The tests themselves */
53 static int rndtest_monobit(struct rndtest_state
*);
54 static int rndtest_runs(struct rndtest_state
*);
55 static int rndtest_longruns(struct rndtest_state
*);
56 static int rndtest_chi_4(struct rndtest_state
*);
58 static int rndtest_runs_check(struct rndtest_state
*, int, int *);
59 static void rndtest_runs_record(struct rndtest_state
*, int, int *);
61 static const struct rndtest_testfunc
{
62 int (*test
)(struct rndtest_state
*);
70 #define RNDTEST_NTESTS (sizeof(rndtest_funcs)/sizeof(rndtest_funcs[0]))
72 SYSCTL_NODE(_kern
, OID_AUTO
, rndtest
, CTLFLAG_RD
, 0, "RNG test parameters");
74 static int rndtest_retest
= 120; /* interval in seconds */
75 SYSCTL_INT(_kern_rndtest
, OID_AUTO
, retest
, CTLFLAG_RW
, &rndtest_retest
,
76 0, "retest interval (seconds)");
77 static struct rndtest_stats rndstats
;
78 SYSCTL_STRUCT(_kern_rndtest
, OID_AUTO
, stats
, CTLFLAG_RD
, &rndstats
,
79 rndtest_stats
, "RNG test statistics");
80 static int rndtest_verbose
= 1; /* report only failures */
81 SYSCTL_INT(_kern_rndtest
, OID_AUTO
, verbose
, CTLFLAG_RW
, &rndtest_verbose
,
82 0, "display results on console");
84 struct rndtest_state
*
85 rndtest_attach(device_t dev
)
87 struct rndtest_state
*rsp
;
89 rsp
= kmalloc(sizeof (*rsp
), M_DEVBUF
, M_INTWAIT
);
90 rsp
->rs_begin
= rsp
->rs_buf
;
91 rsp
->rs_end
= rsp
->rs_buf
+ sizeof(rsp
->rs_buf
);
92 rsp
->rs_current
= rsp
->rs_begin
;
96 /* NB: 1 means the callout runs w/o Giant locked */
97 callout_init_mp(&rsp
->rs_to
);
102 rndtest_detach(struct rndtest_state
*rsp
)
104 callout_stop(&rsp
->rs_to
);
105 kfree(rsp
, M_DEVBUF
);
109 rndtest_harvest(struct rndtest_state
*rsp
, void *buf
, u_int len
)
113 * If enabled, collect data and run tests when we have enough.
115 if (rsp
->rs_collect
) {
116 for (i
= 0; i
< len
; i
++) {
117 *rsp
->rs_current
= ((u_char
*) buf
)[i
];
118 if (++rsp
->rs_current
== rsp
->rs_end
) {
120 rsp
->rs_current
= rsp
->rs_begin
;
122 * If tests passed, turn off collection and
123 * schedule another test. Otherwise we keep
124 * testing until the data looks ok.
126 if (!rsp
->rs_discard
&& rndtest_retest
!= 0) {
128 callout_reset(&rsp
->rs_to
,
130 rndtest_timeout
, rsp
);
137 * Only stir entropy that passes muster into the pool.
140 rndstats
.rst_discard
+= len
;
142 #if defined(__DragonFly__) || __FreeBSD_version < 500000
143 /* XXX verify buffer is word aligned */
145 for (len
/= sizeof (u_int32_t
); len
; len
--)
146 add_true_randomness(*p
++);
148 random_harvest(buf
, len
, len
*NBBY
, 0, RANDOM_PURE
);
154 rndtest_test(struct rndtest_state
*rsp
)
158 rndstats
.rst_tests
++;
159 for (i
= 0; i
< RNDTEST_NTESTS
; i
++)
160 rv
|= (*rndtest_funcs
[i
].test
)(rsp
);
161 rsp
->rs_discard
= (rv
!= 0);
165 rndtest_report(struct rndtest_state
*rsp
, int failure
, const char *fmt
, ...)
170 if (rndtest_verbose
== 0)
172 if (!failure
&& rndtest_verbose
== 1) /* don't report successes */
175 kvsnprintf(buf
, sizeof (buf
), fmt
, ap
);
177 device_printf(rsp
->rs_parent
, "rndtest: %s\n", buf
);
180 #define RNDTEST_MONOBIT_MINONES 9725
181 #define RNDTEST_MONOBIT_MAXONES 10275
184 rndtest_monobit(struct rndtest_state
*rsp
)
189 for (i
= 0; i
< RNDTEST_NBYTES
; i
++) {
191 for (j
= 0; j
< 8; j
++, r
<<= 1)
195 if (ones
> RNDTEST_MONOBIT_MINONES
&&
196 ones
< RNDTEST_MONOBIT_MAXONES
) {
197 if (rndtest_verbose
> 1)
198 rndtest_report(rsp
, 0, "monobit pass (%d < %d < %d)",
199 RNDTEST_MONOBIT_MINONES
, ones
,
200 RNDTEST_MONOBIT_MAXONES
);
204 rndtest_report(rsp
, 1,
205 "monobit failed (%d ones)", ones
);
206 rndstats
.rst_monobit
++;
211 #define RNDTEST_RUNS_NINTERVAL 6
213 static const struct rndtest_runs_tabs
{
215 } rndtest_runs_tab
[] = {
225 rndtest_runs(struct rndtest_state
*rsp
)
227 int i
, j
, ones
, zeros
, rv
= 0;
228 int onei
[RNDTEST_RUNS_NINTERVAL
], zeroi
[RNDTEST_RUNS_NINTERVAL
];
231 bzero(onei
, sizeof(onei
));
232 bzero(zeroi
, sizeof(zeroi
));
234 for (i
= 0; i
< RNDTEST_NBYTES
; i
++) {
236 for (j
= 0; j
< 8; j
++, c
<<= 1) {
239 rndtest_runs_record(rsp
, zeros
, zeroi
);
243 rndtest_runs_record(rsp
, ones
, onei
);
248 rndtest_runs_record(rsp
, ones
, onei
);
249 rndtest_runs_record(rsp
, zeros
, zeroi
);
251 rv
|= rndtest_runs_check(rsp
, 0, zeroi
);
252 rv
|= rndtest_runs_check(rsp
, 1, onei
);
261 rndtest_runs_record(struct rndtest_state
*rsp
, int len
, int *intrv
)
265 if (len
> RNDTEST_RUNS_NINTERVAL
)
266 len
= RNDTEST_RUNS_NINTERVAL
;
272 rndtest_runs_check(struct rndtest_state
*rsp
, int val
, int *src
)
276 for (i
= 0; i
< RNDTEST_RUNS_NINTERVAL
; i
++) {
277 if (src
[i
] < rndtest_runs_tab
[i
].min
||
278 src
[i
] > rndtest_runs_tab
[i
].max
) {
279 rndtest_report(rsp
, 1,
280 "%s interval %d failed (%d, %d-%d)",
281 val
? "ones" : "zeros",
282 i
+ 1, src
[i
], rndtest_runs_tab
[i
].min
,
283 rndtest_runs_tab
[i
].max
);
286 rndtest_report(rsp
, 0,
287 "runs pass %s interval %d (%d < %d < %d)",
288 val
? "ones" : "zeros",
289 i
+ 1, rndtest_runs_tab
[i
].min
, src
[i
],
290 rndtest_runs_tab
[i
].max
);
297 rndtest_longruns(struct rndtest_state
*rsp
)
299 int i
, j
, ones
= 0, zeros
= 0, maxones
= 0, maxzeros
= 0;
302 for (i
= 0; i
< RNDTEST_NBYTES
; i
++) {
304 for (j
= 0; j
< 8; j
++, c
<<= 1) {
313 if (zeros
> maxzeros
)
319 if (maxones
< 26 && maxzeros
< 26) {
320 rndtest_report(rsp
, 0, "longruns pass (%d ones, %d zeros)",
324 rndtest_report(rsp
, 1, "longruns fail (%d ones, %d zeros)",
326 rndstats
.rst_longruns
++;
332 * chi^2 test over 4 bits: (this is called the poker test in FIPS 140-2,
333 * but it is really the chi^2 test over 4 bits (the poker test as described
334 * by Knuth vol 2 is something different, and I take him as authoritative
335 * on nomenclature over NIST).
337 #define RNDTEST_CHI4_K 16
338 #define RNDTEST_CHI4_K_MASK (RNDTEST_CHI4_K - 1)
341 * The unnormalized values are used so that we don't have to worry about
342 * fractional precision. The "real" value is found by:
343 * (V - 1562500) * (16 / 5000) = Vn (where V is the unnormalized value)
345 #define RNDTEST_CHI4_VMIN 1563181 /* 2.1792 */
346 #define RNDTEST_CHI4_VMAX 1576929 /* 46.1728 */
349 rndtest_chi_4(struct rndtest_state
*rsp
)
351 unsigned int freq
[RNDTEST_CHI4_K
], i
, sum
;
353 for (i
= 0; i
< RNDTEST_CHI4_K
; i
++)
356 /* Get number of occurances of each 4 bit pattern */
357 for (i
= 0; i
< RNDTEST_NBYTES
; i
++) {
358 freq
[(rsp
->rs_buf
[i
] >> 4) & RNDTEST_CHI4_K_MASK
]++;
359 freq
[(rsp
->rs_buf
[i
] >> 0) & RNDTEST_CHI4_K_MASK
]++;
362 for (i
= 0, sum
= 0; i
< RNDTEST_CHI4_K
; i
++)
363 sum
+= freq
[i
] * freq
[i
];
365 if (sum
>= 1563181 && sum
<= 1576929) {
366 rndtest_report(rsp
, 0, "chi^2(4): pass (sum %u)", sum
);
369 rndtest_report(rsp
, 1, "chi^2(4): failed (sum %u)", sum
);
376 rndtest_timeout(void *xrsp
)
378 struct rndtest_state
*rsp
= xrsp
;
384 rndtest_modevent(module_t mod
, int type
, void *unused
)
395 static moduledata_t rndtest_mod
= {
400 DECLARE_MODULE(rndtest
, rndtest_mod
, SI_SUB_DRIVERS
, SI_ORDER_ANY
);
401 MODULE_VERSION(rndtest
, 1);