Blame view

Documentation/hw_random.txt 3.49 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
  Introduction:
537878d2c   David Brownell   hw_random doc upd...
2
  	The hw_random framework is software that makes use of a
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
3
  	special hardware feature on your CPU or motherboard,
537878d2c   David Brownell   hw_random doc upd...
4
5
6
7
  	a Random Number Generator (RNG).  The software has two parts:
  	a core providing the /dev/hw_random character device and its
  	sysfs support, plus a hardware-specific driver that plugs
  	into that core.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
8

537878d2c   David Brownell   hw_random doc upd...
9
  	To make the most effective use of these mechanisms, you
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
10
11
12
13
14
  	should download the support software as well.  Download the
  	latest version of the "rng-tools" package from the
  	hw_random driver's official Web site:
  
  		http://sourceforge.net/projects/gkernel/
537878d2c   David Brownell   hw_random doc upd...
15
16
17
  	Those tools use /dev/hw_random to fill the kernel entropy pool,
  	which is used internally and exported by the /dev/urandom and
  	/dev/random special files.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
18
19
  
  Theory of operation:
537878d2c   David Brownell   hw_random doc upd...
20
  	CHARACTER DEVICE.  Using the standard open()
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
21
22
23
24
25
26
27
  	and read() system calls, you can read random data from
  	the hardware RNG device.  This data is NOT CHECKED by any
  	fitness tests, and could potentially be bogus (if the
  	hardware is faulty or has been tampered with).  Data is only
  	output if the hardware "has-data" flag is set, but nevertheless
  	a security-conscious person would run fitness tests on the
  	data before assuming it is truly random.
537878d2c   David Brownell   hw_random doc upd...
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
  	The rng-tools package uses such tests in "rngd", and lets you
  	run them by hand with a "rngtest" utility.
  
  	/dev/hw_random is char device major 10, minor 183.
  
  	CLASS DEVICE.  There is a /sys/class/misc/hw_random node with
  	two unique attributes, "rng_available" and "rng_current".  The
  	"rng_available" attribute lists the hardware-specific drivers
  	available, while "rng_current" lists the one which is currently
  	connected to /dev/hw_random.  If your system has more than one
  	RNG available, you may change the one used by writing a name from
  	the list in "rng_available" into "rng_current".
  
  ==========================================================================
  
  	Hardware driver for Intel/AMD/VIA Random Number Generators (RNG)
  	Copyright 2000,2001 Jeff Garzik <jgarzik@pobox.com>
  	Copyright 2000,2001 Philipp Rumpf <prumpf@mandrakesoft.com>
  
  
  About the Intel RNG hardware, from the firmware hub datasheet:
  
  	The Firmware Hub integrates a Random Number Generator (RNG)
  	using thermal noise generated from inherently random quantum
  	mechanical properties of silicon. When not generating new random
  	bits the RNG circuitry will enter a low power state. Intel will
  	provide a binary software driver to give third party software
  	access to our RNG for use as a security feature. At this time,
  	the RNG is only to be used with a system in an OS-present state.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
57

537878d2c   David Brownell   hw_random doc upd...
58
  Intel RNG Driver notes:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
  
  	* FIXME: support poll(2)
  
  	NOTE: request_mem_region was removed, for two reasons:
  	1) Only one RNG is supported by this driver, 2) The location
  	used by the RNG is a fixed location in MMIO-addressable memory,
  	3) users with properly working BIOS e820 handling will always
  	have the region in which the RNG is located reserved, so
  	request_mem_region calls always fail for proper setups.
  	However, for people who use mem=XX, BIOS e820 information is
  	-not- in /proc/iomem, and request_mem_region(RNG_ADDR) can
  	succeed.
  
  Driver details:
  
  	Based on:
  	Intel 82802AB/82802AC Firmware Hub (FWH) Datasheet
  		May 1999 Order Number: 290658-002 R
  
  	Intel 82802 Firmware Hub: Random Number Generator
  	Programmer's Reference Manual
  		December 1999 Order Number: 298029-001 R
  
  	Intel 82802 Firmware HUB Random Number Generator Driver
  	Copyright (c) 2000 Matt Sottek <msottek@quiknet.com>
  
  	Special thanks to Matt Sottek.  I did the "guts", he
  	did the "brains" and all the testing.