fix reset handling
[gnuk/neug.git] / README
1 NeuG - a true random number generator implementation (for STM32F103)
2
3                                                           Version 1.0.3
4                                                              2015-08-03
5                                                            Niibe Yutaka
6                                       Free Software Initiative of Japan
7
8 What's NeuG?
9 ============
10
11 NeuG is a set of routines of random number generator (RNG) which is
12 based on physical noise.  It supports STM32F103.  It can be stand
13 alone USB RNG device (with main routine), too.
14
15 The name comes from Japanized English word "noidgy" (from English word
16 "noisy"), where many Japanese (including me) don't distinguish
17 pronunciations of "gee" and "zee".  NeuG includes my important letters
18 of "g", "n", and "u", and the word "neu" (German spelling of "new").
19
20 My primary intention was to incorporate NeuG routines into Gnuk for
21 random number generation, but the stand alone version could be useful
22 too.
23
24 Gnuk was named after my son who loved the pacifier when he was baby.
25 NeuG was named after my daughter, but I don't say she is noisy.
26
27
28 Release notes
29 =============
30
31 This is the third minor release of NeuG, after 1.0.
32
33 Basic features (generating random numbers) are stable, but newly added
34 things like Fraucheky (USB Mass Storage Class) support and reGNUal
35 (firmware upgrad) support should be considered experimental.
36
37 Note that you need Chopstx (the thread library) as external source
38 code (instead of ChibiOS/RT).  If you get the source code by Git,
39 Chopstx is submodule of neug.
40
41
42 FAQ
43 ===
44
45 Q0: How NeuG device is good?
46 A0: I believe it's good enough if we compare to other hardware RNGs.
47     I evaluated it with rngtest of RNG-tools, NIST STS test suite and
48     Dieharder.  See the directory neug/test-results/.
49 A0-dash: For better entropy device with embedded test, you could get
50          EntropyKey.  See http://www.entropykey.co.uk/
51 A0-double-dash: STM32F2xx and STM32F4xx have built-in TRNG, it would
52                 be better for you (although the quality of randomness
53                 looks not that good).
54
55 Q1: How fast is NeuG device?
56 A1: It's more than 80 kB/sec for conditioned output (by SHA-256), and
57     more than 280 kB/sec for CRC-32 filtered output (kB = 1000 byte).
58
59 Q2: Should we check condition of noise sources?
60 A2: Yes, we should.  Three continuous tests are implemented, following
61     (Draft of) NIST SP 800-90B.  Those are Repetition Count Test,
62     Adaptive Proportion Test (for 64 samples), and another Adaptive
63     Proportion Test (for 4096 samples).  When it detects an error (it
64     is really rare, but it could occur even for normal condition), the
65     generation of random bits restart again.
66
67 Q3: Conditioning with SHA-256 sounds over-kill.  Why not simpler?
68 A3: It is because NIST SP 800-90B mandates something like that for
69     "full entropy source".  If your usage is as an entropy source for
70     RNG-tools to feed entropy to your kernel, or use for computer
71     simulations, I think that CRC-32 filtered output would be good
72     enough.
73
74
75 Targets
76 =======
77
78 FST-01, Olimex STM32-H103, and STM32 part of STM8S Discovery Kit,
79 STBee Mini, STBee, STM32 Primer 2, ST Dongle and STM32 Nucleo F103 are
80 supported.
81
82
83 Build system and Host system
84 ============================
85
86 Makefile is written for GNU make.  You need Bash 4.x for configure.
87
88 If your bash is not installed as /bin/bash, you need to run configure
89 script prepending 'bash' before './configure'.
90
91 Some tools are written in Python.  If your Python is not installed as
92 /usr/bin/python, please prepend 'python' for your command invocation.
93 Python 2.7 and PyUSB 0.4.3 is assumed.
94
95
96 Souce code
97 ==========
98
99 NeuG source code is under src/ directory.
100
101 Note that SHA-256 hash function implementation, src/sha256.c, is based
102 on the original implementation by Dr. Brian Gladman.  See:
103
104   http://gladman.plushost.co.uk/oldsite/cryptography_technology/sha/index.php
105
106
107 License
108 =======
109
110 It is distributed under GNU General Public Licence version 3 or later
111 (GPLv3+).  Please see src/COPYING.
112
113
114 External source code
115 ====================
116
117 NeuG is distributed with external source code.
118
119 * chopstx/ -- Chopstx, the RT Thread Library
120
121 * [optional] fraucheky/ -- Fraucheky, the GPL container
122
123 Those are available at:
124
125   https://anonscm.debian.org/cgit/gnuk/chopstx/
126
127
128 USB vendor ID and product ID (USB device ID)
129 ============================================
130
131 When you have a vender ID and assign a product ID for NeuG, edit the
132 file NEUG_USB_DEVICE_ID and add an entry for yours.  In this case,
133 please contact Niibe, so that it is listed to the file in the official
134 release of the source code.
135
136 When you are modifing NeuG and installing the binary to device, you
137 should replace the vendor string to yours, so that users can see it's
138 not by original vendor, and it is modified version.
139
140 FSIJ allows you to use USB device ID of FSIJ (234b:0001) for devices
141 with standalone NeuG under one of following conditions:
142
143   * For everyone for experimental purpose:
144
145     - You must not distribute a binary with FSIJ's USB device ID, but
146       must use the binary by yourself only for your experiment.  Note
147       that "Distributing binary" includes distributing a device which
148       holds the binary.
149
150   * For individuals:
151
152     - No additional conditions.
153
154 FSIJ could give companies or business entities "second source
155 manufacturer" license to use USB device ID of FSIJ for devices with
156 unmodified version of NeuG, provided they support Free Software and
157 respect users' freedom for computing.  Please ask FSIJ for the
158 license.
159
160 Otherwise, companies which want to distribute NeuG devices, please use
161 your own USB vendor ID and product ID.  Please replace vendor string
162 and possibly product string to yours, when you modify NeuG.
163
164
165 How to compile
166 ==============
167
168 You need GNU toolchain and newlib for 'arm-none-eabi' target.
169
170 See https://launchpad.net/gcc-arm-embedded for preparation
171 of GNU Toolchain for 'arm-none-eabi' target.
172
173 Change directory to `src':
174
175   $ cd neug-VERSION/src
176
177 Then, run `configure':
178
179   $ ./configure --vidpid=<VID:PID>
180
181 Here, you need to specify USB vendor ID and product ID.  For FSIJ's,
182 it's: --vidpid=234b:0001 .  Please read section 'USB vendor ID and
183 product ID' above.
184
185
186 Type:
187
188   $ make
189
190 Then, we will have "neug.elf" under the "build" directory.
191
192
193 How to install
194 ==============
195
196 Olimex STM32-H103 board
197 -----------------------
198
199 If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
200
201   $ openocd -f interface/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
202
203 Then, with another terminal, type following to write "neug.elf" to Flash ROM:
204
205   $ telnet localhost 4444
206   > reset halt
207   > flash write_image erase neug.elf
208   > reset
209   > exit
210   $ 
211
212
213 Flying Stone Tiny 01 and STM8S Discovery Kit
214 --------------------------------------------
215
216 If you are using Flying Stone Tiny 01, you need a SWD writer.
217
218 OpenOCD 0.6.1 or newer supports ST-Link/V2.  With that we can do:
219
220   $ openocd -f interface/stlink-v2.cfg -f target/stm32f1x_stlink.cfg
221
222 Then, with another terminal, type following to write "neug.elf" to Flash ROM:
223
224   $ telnet localhost 4444
225   > reset halt
226   > flash write_image erase neug.elf
227   > reset
228   > exit
229   $ 
230
231 Note that OpenOCD (as of 0.7.0) doesn't support option bytes handling yet.
232
233 You can also use tool/stlinkv2.py in Gnuk.
234
235
236 Use of NeuG device
237 ==================
238
239 It is USB CDC ACM device.  On GNU/Linux, it can be /dev/ttyACM0 or like.
240 Before using /dev/ttyACM0, you need to configure its TTY discipline.
241
242   $ stty -F /dev/ttyACM0 -echo raw
243
244 Then, you can use output of /dev/ttyACM0.
245
246 When you want to get CRC-32 filtered output, you can configure:
247
248   $ stty -F /dev/ttyACM0 parenb parodd
249
250 for raw data after filter.  For direct raw data of ADC samples,
251 configure:
252
253   $ stty -F /dev/ttyACM0 parenb -parodd
254
255 And you can get SHA-256 conditioned output by configuring:
256
257   $ stty -F /dev/ttyACM0 -parenb
258
259
260 If your device is configured with Fraucheky, you can invoke Fraucheky
261 from NeuG by setting the unusual sequence of configurations:
262
263   $ stty -F /dev/ttyACM0 ispeed 110 ospeed 110
264   $ stty -F /dev/ttyACM0 speed 115200 ospeed 115200
265
266
267 Structure of NeuG
268 =================
269
270 Here is a figure of the circuit.
271
272                                          Noise sources
273
274                               /|<---+--- [ Analog input Vref ]
275                 16           | |<-+-|--- [ Analog input Temperature Sensor ]
276              +---/-[ADC1] <==| |  | |
277              |               | |<-+ |
278       +-+    |                \|<---+
279       | |<---+                |
280  +----| |          MUX CTL >--+
281  |    | |<---+
282  |    +-+    |                /|
283  |           |  16           | |<------- [ Analog input 0 ] (pull up to Vdd)
284  |           +---/-[ADC2] <==| |
285  |                           | |<------- [ Analog input 1 ] (pull up to Vdd)
286  |                            \|
287  |                            |
288  |                 MUX CTL >--+
289  |
290  +------------------+         <============ (*1)
291                     |
292                     / 32
293                     |
294                     | Put 4 times to output 32-bit
295                     V
296             [ CRC-32 filter ]
297                     |
298                     |           Put 35 times to output 1120-bit
299                     +---------------------------------+         <====== (*2)
300                                                       |
301                                                       / 32
302                                                       |
303                                                       V
304                                               [ Entropy Buffer ]
305                                                       |          
306             +--------------+                          |
307             |              |                          |
308             | Conditioning |            1120          |
309             | Component    |<------------/------------+
310             |              |
311       +-----|  Hash_df     |
312       |     |    by        |
313       |     |  SHA-256     |
314       |     |              |  128
315       |     |              |<--/--+
316       |     +--------------+      |
317       |                           |
318       +---------------------------+
319       |
320       / 256
321       |
322       v
323  Random Number Output <========== (*3)
324
325
326
327 Specifying by "stty", you can get (*3) with -parenb, (*2) with parenb
328 parodd, and (*1) with parenb -parodd.
329
330 STM32F103 has two built-in A/D converters.  NeuG uses A/D converters'
331 outputs as entropy sources.  It is considered noise of quantization
332 error, plus noise from power supply, etc.
333
334 We chose four analog input sources of: built-in voltage reference,
335 temperature sensor and two analog inputs which are pull-up to Vdd.
336
337 By a single sampling of two channels, we get 32-bit (not all 32-bit is
338 valid, as a A/D converter resolution is 12-bit only).  We take four
339 sampling of combinations: (Vref, IN0), (Temp, IN1), (Vref, IN1), and
340 (Temp, IN0).  Those 32-bit * 4 is fed into CRC32 filter.
341
342 We use STM32F103's CRC32 calculation unit as a kind of filter.  We put
343 output of A/D converters into CRC32 calculation unit, four times, to
344 get 4-byte output.
345
346 Output of CRC32 filter is collected 35 times, and it becomes 1120-bit
347 (32 * 35).  This is the noise source bits.
348
349 We put this 1120-bit and half of previous output (128-bit) to
350 conditioning component.
351
352 Conditioning Component is implemented by Hash_df function which is
353 composed by SHA-256.  Since the noise source is not "white", signal is
354 whiten by this Conditioning Component.
355
356 My experience with STM32F103 and NeuG shows that noise source is
357 stable at least for a year.
358
359
360 Test results
361 ============
362
363 See files under the directory test-results, for test result of
364 PractRand 0.92.
365
366 I collect 133 files of 125MB (>= 16GiB), and run the test suite of
367 PractRand 0.92.  Collecting 133 files, it took more than two days.
368
369
370 Git Repository
371 ==============
372
373 NeuG is available in the Gnuk repository at:
374
375     https://anonscm.debian.org/cgit/gnuk/gnuk/
376
377 You can get it by:
378
379     $ git clone git://anonscm.debian.org/gnuk/gnuk/neug.git
380
381
382 I put Chopstx and Fraucheky as a submodules of Git.  Please do this:
383
384   $ git submodule init
385   $ git submodule update
386
387
388
389 Information on the Web
390 ======================
391
392 Please see the FST-01 support pages:
393
394     http://www.gniibe.org/category/fst-01.html
395
396 Please consider to join Gnuk-users mailing list:
397
398     https://lists.alioth.debian.org/mailman/listinfo/gnuk-users
399
400
401
402 Your Contributions
403 ==================
404
405 FSIJ welcomes your contributions.  Please assign your copyright
406 to FSIJ (if possible).
407
408
409 Foot note
410 ==========
411
412 If NeuG had a family name, it must be Kunisada.
413 --