2 * Copyright (c) 2015-2018 Mark R V Murray
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * This is a skeleton for folks who wish to build a loadable module
30 * containing an alternative entropy-processing algorithm for random(4).
32 * The functions below should be completed with the appropriate code,
33 * and the nearby fortuna.c may be consulted for examples of working code.
35 * The author is willing to provide reasonable help to those wishing to
36 * write such a module for themselves. Please use the markm@ FreeBSD
37 * email address, and ensure that you are developing this on a suitably
38 * supported branch (This is currently 12-CURRENT, and may be no
39 * older than 12-STABLE in the future).
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
45 #include <sys/limits.h>
48 #include <sys/param.h>
49 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/mutex.h>
53 #include <sys/random.h>
54 #include <sys/sysctl.h>
55 #include <sys/systm.h>
57 #include <machine/cpu.h>
59 #include <crypto/rijndael/rijndael-api-fst.h>
60 #include <crypto/sha2/sha256.h>
62 #include <dev/random/hash.h>
63 #include <dev/random/randomdev.h>
64 #include <dev/random/random_harvestq.h>
65 #include <dev/random/uint128.h>
66 #include <dev/random/other_algorithm.h>
75 #include "unit_test.h"
77 #include <crypto/rijndael/rijndael-api-fst.h>
78 #include <crypto/sha2/sha256.h>
80 #include <dev/random/hash.h>
81 #include <dev/random/randomdev.h>
82 #include <dev/random/uint128.h>
83 #include <dev/random/other_algorithm.h>
86 static void random_other_pre_read(void);
87 static void random_other_read(uint8_t *, size_t);
88 static bool random_other_seeded(void);
89 static void random_other_process_event(struct harvest_event *);
92 * RANDOM_OTHER_NPOOLS is used when reading hardware random
93 * number sources to ensure that each pool gets one read sample
94 * per loop iteration. Fortuna has 32 (0-31).
96 #define RANDOM_OTHER_NPOOLS 1
98 #ifdef RANDOM_LOADABLE
101 const struct random_algorithm random_alg_context = {
103 .ra_pre_read = random_other_pre_read,
104 .ra_read = random_other_read,
105 .ra_seeded = random_other_seeded,
106 .ra_event_processor = random_other_process_event,
107 .ra_poolcount = RANDOM_OTHER_NPOOLS,
110 /* Use a mutex to protect your reseed variables? */
111 static mtx_t other_mtx;
114 * Do algorithm-specific initialisation here.
117 random_other_init_alg(void *unused __unused)
120 #ifdef RANDOM_LOADABLE
121 p_random_alg_context = &random_alg_context;
124 RANDOM_RESEED_INIT_LOCK();
126 SYSINIT(random_alg, SI_SUB_RANDOM, SI_ORDER_SECOND, random_other_init_alg,
130 * void random_other_pre_read(void)
132 * Do any pre-read preparation you need to. This will be called
133 * before >=1 calls to random_other_read() corresponding to one
136 * This routine will be called periodically while the generator is
137 * still blocked and a read is being attempted, giving you an
138 * opportunity to unblock.
141 random_other_pre_read(void)
144 RANDOM_RESEED_LOCK();
146 * Do pre-read housekeeping work here!
147 * You may use this as a chance to unblock the generator.
149 RANDOM_RESEED_UNLOCK();
153 * void random_other_read(uint8_t *buf, size_t count)
155 * Generate <count> bytes of output into <*buf>.
156 * You may NOT use the fact that <count> will be a multiple of
157 * RANDOM_BLOCKSIZE for optimization purposes.
159 * This function will always be called with your generator
160 * unblocked and ready. If you are not ready to generate
161 * output here, then feel free to KASSERT() or panic().
164 random_other_read(uint8_t *buf, size_t count)
167 RANDOM_RESEED_LOCK();
169 * Do random-number generation work here!
171 RANDOM_RESEED_UNLOCK();
175 * bool random_other_seeded(void)
177 * Return true if your generator is ready to generate
178 * output, and false otherwise.
181 random_other_seeded(void)
186 * Find out if your generator is seeded here!
192 * void random_other_process_event(struct harvest_event *event)
194 * Process one stochastic event <*event> into your entropy
197 * The structure of the event may change, so it is easier to
198 * just grab the whole thing into your accumulation system.
199 * You may pick-and-choose bits, but please don't complain
200 * when/if these change.
203 random_other_process_event(struct harvest_event *event)
206 RANDOM_RESEED_LOCK();
208 * Do entropy accumulation work here!
209 * You may use this as a chance to unblock the generator.
211 RANDOM_RESEED_UNLOCK();