random.c 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662
  1. /*
  2. * random.c -- A strong random number generator
  3. *
  4. * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
  5. *
  6. * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
  7. * rights reserved.
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, and the entire permission notice in its entirety,
  14. * including the disclaimer of warranties.
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in the
  17. * documentation and/or other materials provided with the distribution.
  18. * 3. The name of the author may not be used to endorse or promote
  19. * products derived from this software without specific prior
  20. * written permission.
  21. *
  22. * ALTERNATIVELY, this product may be distributed under the terms of
  23. * the GNU General Public License, in which case the provisions of the GPL are
  24. * required INSTEAD OF the above restrictions. (This clause is
  25. * necessary due to a potential bad interaction between the GPL and
  26. * the restrictions contained in a BSD-style copyright.)
  27. *
  28. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  29. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
  31. * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  34. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  35. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  36. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  38. * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
  39. * DAMAGE.
  40. */
  41. /*
  42. * (now, with legal B.S. out of the way.....)
  43. *
  44. * This routine gathers environmental noise from device drivers, etc.,
  45. * and returns good random numbers, suitable for cryptographic use.
  46. * Besides the obvious cryptographic uses, these numbers are also good
  47. * for seeding TCP sequence numbers, and other places where it is
  48. * desirable to have numbers which are not only random, but hard to
  49. * predict by an attacker.
  50. *
  51. * Theory of operation
  52. * ===================
  53. *
  54. * Computers are very predictable devices. Hence it is extremely hard
  55. * to produce truly random numbers on a computer --- as opposed to
  56. * pseudo-random numbers, which can easily generated by using a
  57. * algorithm. Unfortunately, it is very easy for attackers to guess
  58. * the sequence of pseudo-random number generators, and for some
  59. * applications this is not acceptable. So instead, we must try to
  60. * gather "environmental noise" from the computer's environment, which
  61. * must be hard for outside attackers to observe, and use that to
  62. * generate random numbers. In a Unix environment, this is best done
  63. * from inside the kernel.
  64. *
  65. * Sources of randomness from the environment include inter-keyboard
  66. * timings, inter-interrupt timings from some interrupts, and other
  67. * events which are both (a) non-deterministic and (b) hard for an
  68. * outside observer to measure. Randomness from these sources are
  69. * added to an "entropy pool", which is mixed using a CRC-like function.
  70. * This is not cryptographically strong, but it is adequate assuming
  71. * the randomness is not chosen maliciously, and it is fast enough that
  72. * the overhead of doing it on every interrupt is very reasonable.
  73. * As random bytes are mixed into the entropy pool, the routines keep
  74. * an *estimate* of how many bits of randomness have been stored into
  75. * the random number generator's internal state.
  76. *
  77. * When random bytes are desired, they are obtained by taking the SHA
  78. * hash of the contents of the "entropy pool". The SHA hash avoids
  79. * exposing the internal state of the entropy pool. It is believed to
  80. * be computationally infeasible to derive any useful information
  81. * about the input of SHA from its output. Even if it is possible to
  82. * analyze SHA in some clever way, as long as the amount of data
  83. * returned from the generator is less than the inherent entropy in
  84. * the pool, the output data is totally unpredictable. For this
  85. * reason, the routine decreases its internal estimate of how many
  86. * bits of "true randomness" are contained in the entropy pool as it
  87. * outputs random numbers.
  88. *
  89. * If this estimate goes to zero, the routine can still generate
  90. * random numbers; however, an attacker may (at least in theory) be
  91. * able to infer the future output of the generator from prior
  92. * outputs. This requires successful cryptanalysis of SHA, which is
  93. * not believed to be feasible, but there is a remote possibility.
  94. * Nonetheless, these numbers should be useful for the vast majority
  95. * of purposes.
  96. *
  97. * Exported interfaces ---- output
  98. * ===============================
  99. *
  100. * There are three exported interfaces; the first is one designed to
  101. * be used from within the kernel:
  102. *
  103. * void get_random_bytes(void *buf, int nbytes);
  104. *
  105. * This interface will return the requested number of random bytes,
  106. * and place it in the requested buffer.
  107. *
  108. * The two other interfaces are two character devices /dev/random and
  109. * /dev/urandom. /dev/random is suitable for use when very high
  110. * quality randomness is desired (for example, for key generation or
  111. * one-time pads), as it will only return a maximum of the number of
  112. * bits of randomness (as estimated by the random number generator)
  113. * contained in the entropy pool.
  114. *
  115. * The /dev/urandom device does not have this limit, and will return
  116. * as many bytes as are requested. As more and more random bytes are
  117. * requested without giving time for the entropy pool to recharge,
  118. * this will result in random numbers that are merely cryptographically
  119. * strong. For many applications, however, this is acceptable.
  120. *
  121. * Exported interfaces ---- input
  122. * ==============================
  123. *
  124. * The current exported interfaces for gathering environmental noise
  125. * from the devices are:
  126. *
  127. * void add_input_randomness(unsigned int type, unsigned int code,
  128. * unsigned int value);
  129. * void add_interrupt_randomness(int irq);
  130. *
  131. * add_input_randomness() uses the input layer interrupt timing, as well as
  132. * the event type information from the hardware.
  133. *
  134. * add_interrupt_randomness() uses the inter-interrupt timing as random
  135. * inputs to the entropy pool. Note that not all interrupts are good
  136. * sources of randomness! For example, the timer interrupts is not a
  137. * good choice, because the periodicity of the interrupts is too
  138. * regular, and hence predictable to an attacker. Disk interrupts are
  139. * a better measure, since the timing of the disk interrupts are more
  140. * unpredictable.
  141. *
  142. * All of these routines try to estimate how many bits of randomness a
  143. * particular randomness source. They do this by keeping track of the
  144. * first and second order deltas of the event timings.
  145. *
  146. * Ensuring unpredictability at system startup
  147. * ============================================
  148. *
  149. * When any operating system starts up, it will go through a sequence
  150. * of actions that are fairly predictable by an adversary, especially
  151. * if the start-up does not involve interaction with a human operator.
  152. * This reduces the actual number of bits of unpredictability in the
  153. * entropy pool below the value in entropy_count. In order to
  154. * counteract this effect, it helps to carry information in the
  155. * entropy pool across shut-downs and start-ups. To do this, put the
  156. * following lines an appropriate script which is run during the boot
  157. * sequence:
  158. *
  159. * echo "Initializing random number generator..."
  160. * random_seed=/var/run/random-seed
  161. * # Carry a random seed from start-up to start-up
  162. * # Load and then save the whole entropy pool
  163. * if [ -f $random_seed ]; then
  164. * cat $random_seed >/dev/urandom
  165. * else
  166. * touch $random_seed
  167. * fi
  168. * chmod 600 $random_seed
  169. * dd if=/dev/urandom of=$random_seed count=1 bs=512
  170. *
  171. * and the following lines in an appropriate script which is run as
  172. * the system is shutdown:
  173. *
  174. * # Carry a random seed from shut-down to start-up
  175. * # Save the whole entropy pool
  176. * echo "Saving random seed..."
  177. * random_seed=/var/run/random-seed
  178. * touch $random_seed
  179. * chmod 600 $random_seed
  180. * dd if=/dev/urandom of=$random_seed count=1 bs=512
  181. *
  182. * For example, on most modern systems using the System V init
  183. * scripts, such code fragments would be found in
  184. * /etc/rc.d/init.d/random. On older Linux systems, the correct script
  185. * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
  186. *
  187. * Effectively, these commands cause the contents of the entropy pool
  188. * to be saved at shut-down time and reloaded into the entropy pool at
  189. * start-up. (The 'dd' in the addition to the bootup script is to
  190. * make sure that /etc/random-seed is different for every start-up,
  191. * even if the system crashes without executing rc.0.) Even with
  192. * complete knowledge of the start-up activities, predicting the state
  193. * of the entropy pool requires knowledge of the previous history of
  194. * the system.
  195. *
  196. * Configuring the /dev/random driver under Linux
  197. * ==============================================
  198. *
  199. * The /dev/random driver under Linux uses minor numbers 8 and 9 of
  200. * the /dev/mem major number (#1). So if your system does not have
  201. * /dev/random and /dev/urandom created already, they can be created
  202. * by using the commands:
  203. *
  204. * mknod /dev/random c 1 8
  205. * mknod /dev/urandom c 1 9
  206. *
  207. * Acknowledgements:
  208. * =================
  209. *
  210. * Ideas for constructing this random number generator were derived
  211. * from Pretty Good Privacy's random number generator, and from private
  212. * discussions with Phil Karn. Colin Plumb provided a faster random
  213. * number generator, which speed up the mixing function of the entropy
  214. * pool, taken from PGPfone. Dale Worley has also contributed many
  215. * useful ideas and suggestions to improve this driver.
  216. *
  217. * Any flaws in the design are solely my responsibility, and should
  218. * not be attributed to the Phil, Colin, or any of authors of PGP.
  219. *
  220. * Further background information on this topic may be obtained from
  221. * RFC 1750, "Randomness Recommendations for Security", by Donald
  222. * Eastlake, Steve Crocker, and Jeff Schiller.
  223. */
  224. #include <linux/utsname.h>
  225. #include <linux/module.h>
  226. #include <linux/kernel.h>
  227. #include <linux/major.h>
  228. #include <linux/string.h>
  229. #include <linux/fcntl.h>
  230. #include <linux/slab.h>
  231. #include <linux/random.h>
  232. #include <linux/poll.h>
  233. #include <linux/init.h>
  234. #include <linux/fs.h>
  235. #include <linux/genhd.h>
  236. #include <linux/interrupt.h>
  237. #include <linux/mm.h>
  238. #include <linux/spinlock.h>
  239. #include <linux/percpu.h>
  240. #include <linux/cryptohash.h>
  241. #include <linux/fips.h>
  242. #ifdef CONFIG_GENERIC_HARDIRQS
  243. # include <linux/irq.h>
  244. #endif
  245. #include <asm/processor.h>
  246. #include <asm/uaccess.h>
  247. #include <asm/irq.h>
  248. #include <asm/io.h>
  249. /*
  250. * Configuration information
  251. */
  252. #define INPUT_POOL_WORDS 128
  253. #define OUTPUT_POOL_WORDS 32
  254. #define SEC_XFER_SIZE 512
  255. /*
  256. * The minimum number of bits of entropy before we wake up a read on
  257. * /dev/random. Should be enough to do a significant reseed.
  258. */
  259. static int random_read_wakeup_thresh = 64;
  260. /*
  261. * If the entropy count falls under this number of bits, then we
  262. * should wake up processes which are selecting or polling on write
  263. * access to /dev/random.
  264. */
  265. static int random_write_wakeup_thresh = 128;
  266. /*
  267. * When the input pool goes over trickle_thresh, start dropping most
  268. * samples to avoid wasting CPU time and reduce lock contention.
  269. */
  270. static int trickle_thresh __read_mostly = INPUT_POOL_WORDS * 28;
  271. static DEFINE_PER_CPU(int, trickle_count);
  272. /*
  273. * A pool of size .poolwords is stirred with a primitive polynomial
  274. * of degree .poolwords over GF(2). The taps for various sizes are
  275. * defined below. They are chosen to be evenly spaced (minimum RMS
  276. * distance from evenly spaced; the numbers in the comments are a
  277. * scaled squared error sum) except for the last tap, which is 1 to
  278. * get the twisting happening as fast as possible.
  279. */
  280. static struct poolinfo {
  281. int poolwords;
  282. int tap1, tap2, tap3, tap4, tap5;
  283. } poolinfo_table[] = {
  284. /* x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 -- 105 */
  285. { 128, 103, 76, 51, 25, 1 },
  286. /* x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 -- 15 */
  287. { 32, 26, 20, 14, 7, 1 },
  288. #if 0
  289. /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
  290. { 2048, 1638, 1231, 819, 411, 1 },
  291. /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
  292. { 1024, 817, 615, 412, 204, 1 },
  293. /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
  294. { 1024, 819, 616, 410, 207, 2 },
  295. /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
  296. { 512, 411, 308, 208, 104, 1 },
  297. /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
  298. { 512, 409, 307, 206, 102, 2 },
  299. /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
  300. { 512, 409, 309, 205, 103, 2 },
  301. /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
  302. { 256, 205, 155, 101, 52, 1 },
  303. /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
  304. { 128, 103, 78, 51, 27, 2 },
  305. /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
  306. { 64, 52, 39, 26, 14, 1 },
  307. #endif
  308. };
  309. #define POOLBITS poolwords*32
  310. #define POOLBYTES poolwords*4
  311. /*
  312. * For the purposes of better mixing, we use the CRC-32 polynomial as
  313. * well to make a twisted Generalized Feedback Shift Reigster
  314. *
  315. * (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR generators. ACM
  316. * Transactions on Modeling and Computer Simulation 2(3):179-194.
  317. * Also see M. Matsumoto & Y. Kurita, 1994. Twisted GFSR generators
  318. * II. ACM Transactions on Mdeling and Computer Simulation 4:254-266)
  319. *
  320. * Thanks to Colin Plumb for suggesting this.
  321. *
  322. * We have not analyzed the resultant polynomial to prove it primitive;
  323. * in fact it almost certainly isn't. Nonetheless, the irreducible factors
  324. * of a random large-degree polynomial over GF(2) are more than large enough
  325. * that periodicity is not a concern.
  326. *
  327. * The input hash is much less sensitive than the output hash. All
  328. * that we want of it is that it be a good non-cryptographic hash;
  329. * i.e. it not produce collisions when fed "random" data of the sort
  330. * we expect to see. As long as the pool state differs for different
  331. * inputs, we have preserved the input entropy and done a good job.
  332. * The fact that an intelligent attacker can construct inputs that
  333. * will produce controlled alterations to the pool's state is not
  334. * important because we don't consider such inputs to contribute any
  335. * randomness. The only property we need with respect to them is that
  336. * the attacker can't increase his/her knowledge of the pool's state.
  337. * Since all additions are reversible (knowing the final state and the
  338. * input, you can reconstruct the initial state), if an attacker has
  339. * any uncertainty about the initial state, he/she can only shuffle
  340. * that uncertainty about, but never cause any collisions (which would
  341. * decrease the uncertainty).
  342. *
  343. * The chosen system lets the state of the pool be (essentially) the input
  344. * modulo the generator polymnomial. Now, for random primitive polynomials,
  345. * this is a universal class of hash functions, meaning that the chance
  346. * of a collision is limited by the attacker's knowledge of the generator
  347. * polynomail, so if it is chosen at random, an attacker can never force
  348. * a collision. Here, we use a fixed polynomial, but we *can* assume that
  349. * ###--> it is unknown to the processes generating the input entropy. <-###
  350. * Because of this important property, this is a good, collision-resistant
  351. * hash; hash collisions will occur no more often than chance.
  352. */
  353. /*
  354. * Static global variables
  355. */
  356. static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
  357. static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
  358. static struct fasync_struct *fasync;
  359. #if 0
  360. static int debug;
  361. module_param(debug, bool, 0644);
  362. #define DEBUG_ENT(fmt, arg...) do { \
  363. if (debug) \
  364. printk(KERN_DEBUG "random %04d %04d %04d: " \
  365. fmt,\
  366. input_pool.entropy_count,\
  367. blocking_pool.entropy_count,\
  368. nonblocking_pool.entropy_count,\
  369. ## arg); } while (0)
  370. #else
  371. #define DEBUG_ENT(fmt, arg...) do {} while (0)
  372. #endif
  373. /**********************************************************************
  374. *
  375. * OS independent entropy store. Here are the functions which handle
  376. * storing entropy in an entropy pool.
  377. *
  378. **********************************************************************/
  379. struct entropy_store;
  380. struct entropy_store {
  381. /* read-only data: */
  382. struct poolinfo *poolinfo;
  383. __u32 *pool;
  384. const char *name;
  385. int limit;
  386. struct entropy_store *pull;
  387. /* read-write data: */
  388. spinlock_t lock;
  389. unsigned add_ptr;
  390. int entropy_count;
  391. int input_rotate;
  392. __u8 *last_data;
  393. };
  394. static __u32 input_pool_data[INPUT_POOL_WORDS];
  395. static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
  396. static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
  397. static struct entropy_store input_pool = {
  398. .poolinfo = &poolinfo_table[0],
  399. .name = "input",
  400. .limit = 1,
  401. .lock = __SPIN_LOCK_UNLOCKED(&input_pool.lock),
  402. .pool = input_pool_data
  403. };
  404. static struct entropy_store blocking_pool = {
  405. .poolinfo = &poolinfo_table[1],
  406. .name = "blocking",
  407. .limit = 1,
  408. .pull = &input_pool,
  409. .lock = __SPIN_LOCK_UNLOCKED(&blocking_pool.lock),
  410. .pool = blocking_pool_data
  411. };
  412. static struct entropy_store nonblocking_pool = {
  413. .poolinfo = &poolinfo_table[1],
  414. .name = "nonblocking",
  415. .pull = &input_pool,
  416. .lock = __SPIN_LOCK_UNLOCKED(&nonblocking_pool.lock),
  417. .pool = nonblocking_pool_data
  418. };
  419. /*
  420. * This function adds bytes into the entropy "pool". It does not
  421. * update the entropy estimate. The caller should call
  422. * credit_entropy_bits if this is appropriate.
  423. *
  424. * The pool is stirred with a primitive polynomial of the appropriate
  425. * degree, and then twisted. We twist by three bits at a time because
  426. * it's cheap to do so and helps slightly in the expected case where
  427. * the entropy is concentrated in the low-order bits.
  428. */
  429. static void mix_pool_bytes_extract(struct entropy_store *r, const void *in,
  430. int nbytes, __u8 out[64])
  431. {
  432. static __u32 const twist_table[8] = {
  433. 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
  434. 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
  435. unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
  436. int input_rotate;
  437. int wordmask = r->poolinfo->poolwords - 1;
  438. const char *bytes = in;
  439. __u32 w;
  440. unsigned long flags;
  441. /* Taps are constant, so we can load them without holding r->lock. */
  442. tap1 = r->poolinfo->tap1;
  443. tap2 = r->poolinfo->tap2;
  444. tap3 = r->poolinfo->tap3;
  445. tap4 = r->poolinfo->tap4;
  446. tap5 = r->poolinfo->tap5;
  447. spin_lock_irqsave(&r->lock, flags);
  448. input_rotate = r->input_rotate;
  449. i = r->add_ptr;
  450. /* mix one byte at a time to simplify size handling and churn faster */
  451. while (nbytes--) {
  452. w = rol32(*bytes++, input_rotate & 31);
  453. i = (i - 1) & wordmask;
  454. /* XOR in the various taps */
  455. w ^= r->pool[i];
  456. w ^= r->pool[(i + tap1) & wordmask];
  457. w ^= r->pool[(i + tap2) & wordmask];
  458. w ^= r->pool[(i + tap3) & wordmask];
  459. w ^= r->pool[(i + tap4) & wordmask];
  460. w ^= r->pool[(i + tap5) & wordmask];
  461. /* Mix the result back in with a twist */
  462. r->pool[i] = (w >> 3) ^ twist_table[w & 7];
  463. /*
  464. * Normally, we add 7 bits of rotation to the pool.
  465. * At the beginning of the pool, add an extra 7 bits
  466. * rotation, so that successive passes spread the
  467. * input bits across the pool evenly.
  468. */
  469. input_rotate += i ? 7 : 14;
  470. }
  471. r->input_rotate = input_rotate;
  472. r->add_ptr = i;
  473. if (out)
  474. for (j = 0; j < 16; j++)
  475. ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
  476. spin_unlock_irqrestore(&r->lock, flags);
  477. }
  478. static void mix_pool_bytes(struct entropy_store *r, const void *in, int bytes)
  479. {
  480. mix_pool_bytes_extract(r, in, bytes, NULL);
  481. }
  482. /*
  483. * Credit (or debit) the entropy store with n bits of entropy
  484. */
  485. static void credit_entropy_bits(struct entropy_store *r, int nbits)
  486. {
  487. unsigned long flags;
  488. int entropy_count;
  489. if (!nbits)
  490. return;
  491. spin_lock_irqsave(&r->lock, flags);
  492. DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
  493. entropy_count = r->entropy_count;
  494. entropy_count += nbits;
  495. if (entropy_count < 0) {
  496. DEBUG_ENT("negative entropy/overflow\n");
  497. entropy_count = 0;
  498. } else if (entropy_count > r->poolinfo->POOLBITS)
  499. entropy_count = r->poolinfo->POOLBITS;
  500. r->entropy_count = entropy_count;
  501. /* should we wake readers? */
  502. if (r == &input_pool && entropy_count >= random_read_wakeup_thresh) {
  503. wake_up_interruptible(&random_read_wait);
  504. kill_fasync(&fasync, SIGIO, POLL_IN);
  505. }
  506. spin_unlock_irqrestore(&r->lock, flags);
  507. }
  508. /*********************************************************************
  509. *
  510. * Entropy input management
  511. *
  512. *********************************************************************/
  513. /* There is one of these per entropy source */
  514. struct timer_rand_state {
  515. cycles_t last_time;
  516. long last_delta, last_delta2;
  517. unsigned dont_count_entropy:1;
  518. };
  519. #ifndef CONFIG_GENERIC_HARDIRQS
  520. static struct timer_rand_state *irq_timer_state[NR_IRQS];
  521. static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
  522. {
  523. return irq_timer_state[irq];
  524. }
  525. static void set_timer_rand_state(unsigned int irq,
  526. struct timer_rand_state *state)
  527. {
  528. irq_timer_state[irq] = state;
  529. }
  530. #else
  531. static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
  532. {
  533. struct irq_desc *desc;
  534. desc = irq_to_desc(irq);
  535. return desc->timer_rand_state;
  536. }
  537. static void set_timer_rand_state(unsigned int irq,
  538. struct timer_rand_state *state)
  539. {
  540. struct irq_desc *desc;
  541. desc = irq_to_desc(irq);
  542. desc->timer_rand_state = state;
  543. }
  544. #endif
  545. static struct timer_rand_state input_timer_state;
  546. /*
  547. * This function adds entropy to the entropy "pool" by using timing
  548. * delays. It uses the timer_rand_state structure to make an estimate
  549. * of how many bits of entropy this call has added to the pool.
  550. *
  551. * The number "num" is also added to the pool - it should somehow describe
  552. * the type of event which just happened. This is currently 0-255 for
  553. * keyboard scan codes, and 256 upwards for interrupts.
  554. *
  555. */
  556. static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
  557. {
  558. struct {
  559. cycles_t cycles;
  560. long jiffies;
  561. unsigned num;
  562. } sample;
  563. long delta, delta2, delta3;
  564. preempt_disable();
  565. /* if over the trickle threshold, use only 1 in 4096 samples */
  566. if (input_pool.entropy_count > trickle_thresh &&
  567. (__get_cpu_var(trickle_count)++ & 0xfff))
  568. goto out;
  569. sample.jiffies = jiffies;
  570. sample.cycles = get_cycles();
  571. sample.num = num;
  572. mix_pool_bytes(&input_pool, &sample, sizeof(sample));
  573. /*
  574. * Calculate number of bits of randomness we probably added.
  575. * We take into account the first, second and third-order deltas
  576. * in order to make our estimate.
  577. */
  578. if (!state->dont_count_entropy) {
  579. delta = sample.jiffies - state->last_time;
  580. state->last_time = sample.jiffies;
  581. delta2 = delta - state->last_delta;
  582. state->last_delta = delta;
  583. delta3 = delta2 - state->last_delta2;
  584. state->last_delta2 = delta2;
  585. if (delta < 0)
  586. delta = -delta;
  587. if (delta2 < 0)
  588. delta2 = -delta2;
  589. if (delta3 < 0)
  590. delta3 = -delta3;
  591. if (delta > delta2)
  592. delta = delta2;
  593. if (delta > delta3)
  594. delta = delta3;
  595. /*
  596. * delta is now minimum absolute delta.
  597. * Round down by 1 bit on general principles,
  598. * and limit entropy entimate to 12 bits.
  599. */
  600. credit_entropy_bits(&input_pool,
  601. min_t(int, fls(delta>>1), 11));
  602. }
  603. out:
  604. preempt_enable();
  605. }
  606. void add_input_randomness(unsigned int type, unsigned int code,
  607. unsigned int value)
  608. {
  609. static unsigned char last_value;
  610. /* ignore autorepeat and the like */
  611. if (value == last_value)
  612. return;
  613. DEBUG_ENT("input event\n");
  614. last_value = value;
  615. add_timer_randomness(&input_timer_state,
  616. (type << 4) ^ code ^ (code >> 4) ^ value);
  617. }
  618. EXPORT_SYMBOL_GPL(add_input_randomness);
  619. void add_interrupt_randomness(int irq)
  620. {
  621. struct timer_rand_state *state;
  622. state = get_timer_rand_state(irq);
  623. if (state == NULL)
  624. return;
  625. DEBUG_ENT("irq event %d\n", irq);
  626. add_timer_randomness(state, 0x100 + irq);
  627. }
  628. #ifdef CONFIG_BLOCK
  629. void add_disk_randomness(struct gendisk *disk)
  630. {
  631. if (!disk || !disk->random)
  632. return;
  633. /* first major is 1, so we get >= 0x200 here */
  634. DEBUG_ENT("disk event %d:%d\n",
  635. MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
  636. add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
  637. }
  638. #endif
  639. #define EXTRACT_SIZE 10
  640. /*********************************************************************
  641. *
  642. * Entropy extraction routines
  643. *
  644. *********************************************************************/
  645. static ssize_t extract_entropy(struct entropy_store *r, void *buf,
  646. size_t nbytes, int min, int rsvd);
  647. /*
  648. * This utility inline function is responsible for transfering entropy
  649. * from the primary pool to the secondary extraction pool. We make
  650. * sure we pull enough for a 'catastrophic reseed'.
  651. */
  652. static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
  653. {
  654. __u32 tmp[OUTPUT_POOL_WORDS];
  655. if (r->pull && r->entropy_count < nbytes * 8 &&
  656. r->entropy_count < r->poolinfo->POOLBITS) {
  657. /* If we're limited, always leave two wakeup worth's BITS */
  658. int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
  659. int bytes = nbytes;
  660. /* pull at least as many as BYTES as wakeup BITS */
  661. bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
  662. /* but never more than the buffer size */
  663. bytes = min_t(int, bytes, sizeof(tmp));
  664. DEBUG_ENT("going to reseed %s with %d bits "
  665. "(%d of %d requested)\n",
  666. r->name, bytes * 8, nbytes * 8, r->entropy_count);
  667. bytes = extract_entropy(r->pull, tmp, bytes,
  668. random_read_wakeup_thresh / 8, rsvd);
  669. mix_pool_bytes(r, tmp, bytes);
  670. credit_entropy_bits(r, bytes*8);
  671. }
  672. }
  673. /*
  674. * These functions extracts randomness from the "entropy pool", and
  675. * returns it in a buffer.
  676. *
  677. * The min parameter specifies the minimum amount we can pull before
  678. * failing to avoid races that defeat catastrophic reseeding while the
  679. * reserved parameter indicates how much entropy we must leave in the
  680. * pool after each pull to avoid starving other readers.
  681. *
  682. * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
  683. */
  684. static size_t account(struct entropy_store *r, size_t nbytes, int min,
  685. int reserved)
  686. {
  687. unsigned long flags;
  688. /* Hold lock while accounting */
  689. spin_lock_irqsave(&r->lock, flags);
  690. BUG_ON(r->entropy_count > r->poolinfo->POOLBITS);
  691. DEBUG_ENT("trying to extract %d bits from %s\n",
  692. nbytes * 8, r->name);
  693. /* Can we pull enough? */
  694. if (r->entropy_count / 8 < min + reserved) {
  695. nbytes = 0;
  696. } else {
  697. /* If limited, never pull more than available */
  698. if (r->limit && nbytes + reserved >= r->entropy_count / 8)
  699. nbytes = r->entropy_count/8 - reserved;
  700. if (r->entropy_count / 8 >= nbytes + reserved)
  701. r->entropy_count -= nbytes*8;
  702. else
  703. r->entropy_count = reserved;
  704. if (r->entropy_count < random_write_wakeup_thresh) {
  705. wake_up_interruptible(&random_write_wait);
  706. kill_fasync(&fasync, SIGIO, POLL_OUT);
  707. }
  708. }
  709. DEBUG_ENT("debiting %d entropy credits from %s%s\n",
  710. nbytes * 8, r->name, r->limit ? "" : " (unlimited)");
  711. spin_unlock_irqrestore(&r->lock, flags);
  712. return nbytes;
  713. }
  714. static void extract_buf(struct entropy_store *r, __u8 *out)
  715. {
  716. int i;
  717. __u32 hash[5], workspace[SHA_WORKSPACE_WORDS];
  718. __u8 extract[64];
  719. /* Generate a hash across the pool, 16 words (512 bits) at a time */
  720. sha_init(hash);
  721. for (i = 0; i < r->poolinfo->poolwords; i += 16)
  722. sha_transform(hash, (__u8 *)(r->pool + i), workspace);
  723. /*
  724. * We mix the hash back into the pool to prevent backtracking
  725. * attacks (where the attacker knows the state of the pool
  726. * plus the current outputs, and attempts to find previous
  727. * ouputs), unless the hash function can be inverted. By
  728. * mixing at least a SHA1 worth of hash data back, we make
  729. * brute-forcing the feedback as hard as brute-forcing the
  730. * hash.
  731. */
  732. mix_pool_bytes_extract(r, hash, sizeof(hash), extract);
  733. /*
  734. * To avoid duplicates, we atomically extract a portion of the
  735. * pool while mixing, and hash one final time.
  736. */
  737. sha_transform(hash, extract, workspace);
  738. memset(extract, 0, sizeof(extract));
  739. memset(workspace, 0, sizeof(workspace));
  740. /*
  741. * In case the hash function has some recognizable output
  742. * pattern, we fold it in half. Thus, we always feed back
  743. * twice as much data as we output.
  744. */
  745. hash[0] ^= hash[3];
  746. hash[1] ^= hash[4];
  747. hash[2] ^= rol32(hash[2], 16);
  748. memcpy(out, hash, EXTRACT_SIZE);
  749. memset(hash, 0, sizeof(hash));
  750. }
  751. static ssize_t extract_entropy(struct entropy_store *r, void *buf,
  752. size_t nbytes, int min, int reserved)
  753. {
  754. ssize_t ret = 0, i;
  755. __u8 tmp[EXTRACT_SIZE];
  756. unsigned long flags;
  757. xfer_secondary_pool(r, nbytes);
  758. nbytes = account(r, nbytes, min, reserved);
  759. while (nbytes) {
  760. extract_buf(r, tmp);
  761. if (r->last_data) {
  762. spin_lock_irqsave(&r->lock, flags);
  763. if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
  764. panic("Hardware RNG duplicated output!\n");
  765. memcpy(r->last_data, tmp, EXTRACT_SIZE);
  766. spin_unlock_irqrestore(&r->lock, flags);
  767. }
  768. i = min_t(int, nbytes, EXTRACT_SIZE);
  769. memcpy(buf, tmp, i);
  770. nbytes -= i;
  771. buf += i;
  772. ret += i;
  773. }
  774. /* Wipe data just returned from memory */
  775. memset(tmp, 0, sizeof(tmp));
  776. return ret;
  777. }
  778. static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
  779. size_t nbytes)
  780. {
  781. ssize_t ret = 0, i;
  782. __u8 tmp[EXTRACT_SIZE];
  783. xfer_secondary_pool(r, nbytes);
  784. nbytes = account(r, nbytes, 0, 0);
  785. while (nbytes) {
  786. if (need_resched()) {
  787. if (signal_pending(current)) {
  788. if (ret == 0)
  789. ret = -ERESTARTSYS;
  790. break;
  791. }
  792. schedule();
  793. }
  794. extract_buf(r, tmp);
  795. i = min_t(int, nbytes, EXTRACT_SIZE);
  796. if (copy_to_user(buf, tmp, i)) {
  797. ret = -EFAULT;
  798. break;
  799. }
  800. nbytes -= i;
  801. buf += i;
  802. ret += i;
  803. }
  804. /* Wipe data just returned from memory */
  805. memset(tmp, 0, sizeof(tmp));
  806. return ret;
  807. }
  808. /*
  809. * This function is the exported kernel interface. It returns some
  810. * number of good random numbers, suitable for seeding TCP sequence
  811. * numbers, etc.
  812. */
  813. void get_random_bytes(void *buf, int nbytes)
  814. {
  815. extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
  816. }
  817. EXPORT_SYMBOL(get_random_bytes);
  818. /*
  819. * init_std_data - initialize pool with system data
  820. *
  821. * @r: pool to initialize
  822. *
  823. * This function clears the pool's entropy count and mixes some system
  824. * data into the pool to prepare it for use. The pool is not cleared
  825. * as that can only decrease the entropy in the pool.
  826. */
  827. static void init_std_data(struct entropy_store *r)
  828. {
  829. ktime_t now;
  830. unsigned long flags;
  831. spin_lock_irqsave(&r->lock, flags);
  832. r->entropy_count = 0;
  833. spin_unlock_irqrestore(&r->lock, flags);
  834. now = ktime_get_real();
  835. mix_pool_bytes(r, &now, sizeof(now));
  836. mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
  837. /* Enable continuous test in fips mode */
  838. if (fips_enabled)
  839. r->last_data = kmalloc(EXTRACT_SIZE, GFP_KERNEL);
  840. }
  841. static int rand_initialize(void)
  842. {
  843. init_std_data(&input_pool);
  844. init_std_data(&blocking_pool);
  845. init_std_data(&nonblocking_pool);
  846. return 0;
  847. }
  848. module_init(rand_initialize);
  849. void rand_initialize_irq(int irq)
  850. {
  851. struct timer_rand_state *state;
  852. state = get_timer_rand_state(irq);
  853. if (state)
  854. return;
  855. /*
  856. * If kzalloc returns null, we just won't use that entropy
  857. * source.
  858. */
  859. state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
  860. if (state)
  861. set_timer_rand_state(irq, state);
  862. }
  863. #ifdef CONFIG_BLOCK
  864. void rand_initialize_disk(struct gendisk *disk)
  865. {
  866. struct timer_rand_state *state;
  867. /*
  868. * If kzalloc returns null, we just won't use that entropy
  869. * source.
  870. */
  871. state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
  872. if (state)
  873. disk->random = state;
  874. }
  875. #endif
  876. static ssize_t
  877. random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
  878. {
  879. ssize_t n, retval = 0, count = 0;
  880. if (nbytes == 0)
  881. return 0;
  882. while (nbytes > 0) {
  883. n = nbytes;
  884. if (n > SEC_XFER_SIZE)
  885. n = SEC_XFER_SIZE;
  886. DEBUG_ENT("reading %d bits\n", n*8);
  887. n = extract_entropy_user(&blocking_pool, buf, n);
  888. DEBUG_ENT("read got %d bits (%d still needed)\n",
  889. n*8, (nbytes-n)*8);
  890. if (n == 0) {
  891. if (file->f_flags & O_NONBLOCK) {
  892. retval = -EAGAIN;
  893. break;
  894. }
  895. DEBUG_ENT("sleeping?\n");
  896. wait_event_interruptible(random_read_wait,
  897. input_pool.entropy_count >=
  898. random_read_wakeup_thresh);
  899. DEBUG_ENT("awake\n");
  900. if (signal_pending(current)) {
  901. retval = -ERESTARTSYS;
  902. break;
  903. }
  904. continue;
  905. }
  906. if (n < 0) {
  907. retval = n;
  908. break;
  909. }
  910. count += n;
  911. buf += n;
  912. nbytes -= n;
  913. break; /* This break makes the device work */
  914. /* like a named pipe */
  915. }
  916. return (count ? count : retval);
  917. }
  918. static ssize_t
  919. urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
  920. {
  921. return extract_entropy_user(&nonblocking_pool, buf, nbytes);
  922. }
  923. static unsigned int
  924. random_poll(struct file *file, poll_table * wait)
  925. {
  926. unsigned int mask;
  927. poll_wait(file, &random_read_wait, wait);
  928. poll_wait(file, &random_write_wait, wait);
  929. mask = 0;
  930. if (input_pool.entropy_count >= random_read_wakeup_thresh)
  931. mask |= POLLIN | POLLRDNORM;
  932. if (input_pool.entropy_count < random_write_wakeup_thresh)
  933. mask |= POLLOUT | POLLWRNORM;
  934. return mask;
  935. }
  936. static int
  937. write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
  938. {
  939. size_t bytes;
  940. __u32 buf[16];
  941. const char __user *p = buffer;
  942. while (count > 0) {
  943. bytes = min(count, sizeof(buf));
  944. if (copy_from_user(&buf, p, bytes))
  945. return -EFAULT;
  946. count -= bytes;
  947. p += bytes;
  948. mix_pool_bytes(r, buf, bytes);
  949. cond_resched();
  950. }
  951. return 0;
  952. }
  953. static ssize_t random_write(struct file *file, const char __user *buffer,
  954. size_t count, loff_t *ppos)
  955. {
  956. size_t ret;
  957. ret = write_pool(&blocking_pool, buffer, count);
  958. if (ret)
  959. return ret;
  960. ret = write_pool(&nonblocking_pool, buffer, count);
  961. if (ret)
  962. return ret;
  963. return (ssize_t)count;
  964. }
  965. static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
  966. {
  967. int size, ent_count;
  968. int __user *p = (int __user *)arg;
  969. int retval;
  970. switch (cmd) {
  971. case RNDGETENTCNT:
  972. /* inherently racy, no point locking */
  973. if (put_user(input_pool.entropy_count, p))
  974. return -EFAULT;
  975. return 0;
  976. case RNDADDTOENTCNT:
  977. if (!capable(CAP_SYS_ADMIN))
  978. return -EPERM;
  979. if (get_user(ent_count, p))
  980. return -EFAULT;
  981. credit_entropy_bits(&input_pool, ent_count);
  982. return 0;
  983. case RNDADDENTROPY:
  984. if (!capable(CAP_SYS_ADMIN))
  985. return -EPERM;
  986. if (get_user(ent_count, p++))
  987. return -EFAULT;
  988. if (ent_count < 0)
  989. return -EINVAL;
  990. if (get_user(size, p++))
  991. return -EFAULT;
  992. retval = write_pool(&input_pool, (const char __user *)p,
  993. size);
  994. if (retval < 0)
  995. return retval;
  996. credit_entropy_bits(&input_pool, ent_count);
  997. return 0;
  998. case RNDZAPENTCNT:
  999. case RNDCLEARPOOL:
  1000. /* Clear the entropy pool counters. */
  1001. if (!capable(CAP_SYS_ADMIN))
  1002. return -EPERM;
  1003. rand_initialize();
  1004. return 0;
  1005. default:
  1006. return -EINVAL;
  1007. }
  1008. }
  1009. static int random_fasync(int fd, struct file *filp, int on)
  1010. {
  1011. return fasync_helper(fd, filp, on, &fasync);
  1012. }
  1013. const struct file_operations random_fops = {
  1014. .read = random_read,
  1015. .write = random_write,
  1016. .poll = random_poll,
  1017. .unlocked_ioctl = random_ioctl,
  1018. .fasync = random_fasync,
  1019. };
  1020. const struct file_operations urandom_fops = {
  1021. .read = urandom_read,
  1022. .write = random_write,
  1023. .unlocked_ioctl = random_ioctl,
  1024. .fasync = random_fasync,
  1025. };
  1026. /***************************************************************
  1027. * Random UUID interface
  1028. *
  1029. * Used here for a Boot ID, but can be useful for other kernel
  1030. * drivers.
  1031. ***************************************************************/
  1032. /*
  1033. * Generate random UUID
  1034. */
  1035. void generate_random_uuid(unsigned char uuid_out[16])
  1036. {
  1037. get_random_bytes(uuid_out, 16);
  1038. /* Set UUID version to 4 --- truely random generation */
  1039. uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
  1040. /* Set the UUID variant to DCE */
  1041. uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
  1042. }
  1043. EXPORT_SYMBOL(generate_random_uuid);
  1044. /********************************************************************
  1045. *
  1046. * Sysctl interface
  1047. *
  1048. ********************************************************************/
  1049. #ifdef CONFIG_SYSCTL
  1050. #include <linux/sysctl.h>
  1051. static int min_read_thresh = 8, min_write_thresh;
  1052. static int max_read_thresh = INPUT_POOL_WORDS * 32;
  1053. static int max_write_thresh = INPUT_POOL_WORDS * 32;
  1054. static char sysctl_bootid[16];
  1055. /*
  1056. * These functions is used to return both the bootid UUID, and random
  1057. * UUID. The difference is in whether table->data is NULL; if it is,
  1058. * then a new UUID is generated and returned to the user.
  1059. *
  1060. * If the user accesses this via the proc interface, it will be returned
  1061. * as an ASCII string in the standard UUID format. If accesses via the
  1062. * sysctl system call, it is returned as 16 bytes of binary data.
  1063. */
  1064. static int proc_do_uuid(ctl_table *table, int write,
  1065. void __user *buffer, size_t *lenp, loff_t *ppos)
  1066. {
  1067. ctl_table fake_table;
  1068. unsigned char buf[64], tmp_uuid[16], *uuid;
  1069. uuid = table->data;
  1070. if (!uuid) {
  1071. uuid = tmp_uuid;
  1072. uuid[8] = 0;
  1073. }
  1074. if (uuid[8] == 0)
  1075. generate_random_uuid(uuid);
  1076. sprintf(buf, "%pU", uuid);
  1077. fake_table.data = buf;
  1078. fake_table.maxlen = sizeof(buf);
  1079. return proc_dostring(&fake_table, write, buffer, lenp, ppos);
  1080. }
  1081. static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
  1082. ctl_table random_table[] = {
  1083. {
  1084. .procname = "poolsize",
  1085. .data = &sysctl_poolsize,
  1086. .maxlen = sizeof(int),
  1087. .mode = 0444,
  1088. .proc_handler = proc_dointvec,
  1089. },
  1090. {
  1091. .procname = "entropy_avail",
  1092. .maxlen = sizeof(int),
  1093. .mode = 0444,
  1094. .proc_handler = proc_dointvec,
  1095. .data = &input_pool.entropy_count,
  1096. },
  1097. {
  1098. .procname = "read_wakeup_threshold",
  1099. .data = &random_read_wakeup_thresh,
  1100. .maxlen = sizeof(int),
  1101. .mode = 0644,
  1102. .proc_handler = proc_dointvec_minmax,
  1103. .extra1 = &min_read_thresh,
  1104. .extra2 = &max_read_thresh,
  1105. },
  1106. {
  1107. .procname = "write_wakeup_threshold",
  1108. .data = &random_write_wakeup_thresh,
  1109. .maxlen = sizeof(int),
  1110. .mode = 0644,
  1111. .proc_handler = proc_dointvec_minmax,
  1112. .extra1 = &min_write_thresh,
  1113. .extra2 = &max_write_thresh,
  1114. },
  1115. {
  1116. .procname = "boot_id",
  1117. .data = &sysctl_bootid,
  1118. .maxlen = 16,
  1119. .mode = 0444,
  1120. .proc_handler = proc_do_uuid,
  1121. },
  1122. {
  1123. .procname = "uuid",
  1124. .maxlen = 16,
  1125. .mode = 0444,
  1126. .proc_handler = proc_do_uuid,
  1127. },
  1128. { }
  1129. };
  1130. #endif /* CONFIG_SYSCTL */
  1131. /********************************************************************
  1132. *
  1133. * Random functions for networking
  1134. *
  1135. ********************************************************************/
  1136. /*
  1137. * TCP initial sequence number picking. This uses the random number
  1138. * generator to pick an initial secret value. This value is hashed
  1139. * along with the TCP endpoint information to provide a unique
  1140. * starting point for each pair of TCP endpoints. This defeats
  1141. * attacks which rely on guessing the initial TCP sequence number.
  1142. * This algorithm was suggested by Steve Bellovin.
  1143. *
  1144. * Using a very strong hash was taking an appreciable amount of the total
  1145. * TCP connection establishment time, so this is a weaker hash,
  1146. * compensated for by changing the secret periodically.
  1147. */
  1148. /* F, G and H are basic MD4 functions: selection, majority, parity */
  1149. #define F(x, y, z) ((z) ^ ((x) & ((y) ^ (z))))
  1150. #define G(x, y, z) (((x) & (y)) + (((x) ^ (y)) & (z)))
  1151. #define H(x, y, z) ((x) ^ (y) ^ (z))
  1152. /*
  1153. * The generic round function. The application is so specific that
  1154. * we don't bother protecting all the arguments with parens, as is generally
  1155. * good macro practice, in favor of extra legibility.
  1156. * Rotation is separate from addition to prevent recomputation
  1157. */
  1158. #define ROUND(f, a, b, c, d, x, s) \
  1159. (a += f(b, c, d) + x, a = (a << s) | (a >> (32 - s)))
  1160. #define K1 0
  1161. #define K2 013240474631UL
  1162. #define K3 015666365641UL
  1163. #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  1164. static __u32 twothirdsMD4Transform(__u32 const buf[4], __u32 const in[12])
  1165. {
  1166. __u32 a = buf[0], b = buf[1], c = buf[2], d = buf[3];
  1167. /* Round 1 */
  1168. ROUND(F, a, b, c, d, in[ 0] + K1, 3);
  1169. ROUND(F, d, a, b, c, in[ 1] + K1, 7);
  1170. ROUND(F, c, d, a, b, in[ 2] + K1, 11);
  1171. ROUND(F, b, c, d, a, in[ 3] + K1, 19);
  1172. ROUND(F, a, b, c, d, in[ 4] + K1, 3);
  1173. ROUND(F, d, a, b, c, in[ 5] + K1, 7);
  1174. ROUND(F, c, d, a, b, in[ 6] + K1, 11);
  1175. ROUND(F, b, c, d, a, in[ 7] + K1, 19);
  1176. ROUND(F, a, b, c, d, in[ 8] + K1, 3);
  1177. ROUND(F, d, a, b, c, in[ 9] + K1, 7);
  1178. ROUND(F, c, d, a, b, in[10] + K1, 11);
  1179. ROUND(F, b, c, d, a, in[11] + K1, 19);
  1180. /* Round 2 */
  1181. ROUND(G, a, b, c, d, in[ 1] + K2, 3);
  1182. ROUND(G, d, a, b, c, in[ 3] + K2, 5);
  1183. ROUND(G, c, d, a, b, in[ 5] + K2, 9);
  1184. ROUND(G, b, c, d, a, in[ 7] + K2, 13);
  1185. ROUND(G, a, b, c, d, in[ 9] + K2, 3);
  1186. ROUND(G, d, a, b, c, in[11] + K2, 5);
  1187. ROUND(G, c, d, a, b, in[ 0] + K2, 9);
  1188. ROUND(G, b, c, d, a, in[ 2] + K2, 13);
  1189. ROUND(G, a, b, c, d, in[ 4] + K2, 3);
  1190. ROUND(G, d, a, b, c, in[ 6] + K2, 5);
  1191. ROUND(G, c, d, a, b, in[ 8] + K2, 9);
  1192. ROUND(G, b, c, d, a, in[10] + K2, 13);
  1193. /* Round 3 */
  1194. ROUND(H, a, b, c, d, in[ 3] + K3, 3);
  1195. ROUND(H, d, a, b, c, in[ 7] + K3, 9);
  1196. ROUND(H, c, d, a, b, in[11] + K3, 11);
  1197. ROUND(H, b, c, d, a, in[ 2] + K3, 15);
  1198. ROUND(H, a, b, c, d, in[ 6] + K3, 3);
  1199. ROUND(H, d, a, b, c, in[10] + K3, 9);
  1200. ROUND(H, c, d, a, b, in[ 1] + K3, 11);
  1201. ROUND(H, b, c, d, a, in[ 5] + K3, 15);
  1202. ROUND(H, a, b, c, d, in[ 9] + K3, 3);
  1203. ROUND(H, d, a, b, c, in[ 0] + K3, 9);
  1204. ROUND(H, c, d, a, b, in[ 4] + K3, 11);
  1205. ROUND(H, b, c, d, a, in[ 8] + K3, 15);
  1206. return buf[1] + b; /* "most hashed" word */
  1207. /* Alternative: return sum of all words? */
  1208. }
  1209. #endif
  1210. #undef ROUND
  1211. #undef F
  1212. #undef G
  1213. #undef H
  1214. #undef K1
  1215. #undef K2
  1216. #undef K3
  1217. /* This should not be decreased so low that ISNs wrap too fast. */
  1218. #define REKEY_INTERVAL (300 * HZ)
  1219. /*
  1220. * Bit layout of the tcp sequence numbers (before adding current time):
  1221. * bit 24-31: increased after every key exchange
  1222. * bit 0-23: hash(source,dest)
  1223. *
  1224. * The implementation is similar to the algorithm described
  1225. * in the Appendix of RFC 1185, except that
  1226. * - it uses a 1 MHz clock instead of a 250 kHz clock
  1227. * - it performs a rekey every 5 minutes, which is equivalent
  1228. * to a (source,dest) tulple dependent forward jump of the
  1229. * clock by 0..2^(HASH_BITS+1)
  1230. *
  1231. * Thus the average ISN wraparound time is 68 minutes instead of
  1232. * 4.55 hours.
  1233. *
  1234. * SMP cleanup and lock avoidance with poor man's RCU.
  1235. * Manfred Spraul <manfred@colorfullife.com>
  1236. *
  1237. */
  1238. #define COUNT_BITS 8
  1239. #define COUNT_MASK ((1 << COUNT_BITS) - 1)
  1240. #define HASH_BITS 24
  1241. #define HASH_MASK ((1 << HASH_BITS) - 1)
  1242. static struct keydata {
  1243. __u32 count; /* already shifted to the final position */
  1244. __u32 secret[12];
  1245. } ____cacheline_aligned ip_keydata[2];
  1246. static unsigned int ip_cnt;
  1247. static void rekey_seq_generator(struct work_struct *work);
  1248. static DECLARE_DELAYED_WORK(rekey_work, rekey_seq_generator);
  1249. /*
  1250. * Lock avoidance:
  1251. * The ISN generation runs lockless - it's just a hash over random data.
  1252. * State changes happen every 5 minutes when the random key is replaced.
  1253. * Synchronization is performed by having two copies of the hash function
  1254. * state and rekey_seq_generator always updates the inactive copy.
  1255. * The copy is then activated by updating ip_cnt.
  1256. * The implementation breaks down if someone blocks the thread
  1257. * that processes SYN requests for more than 5 minutes. Should never
  1258. * happen, and even if that happens only a not perfectly compliant
  1259. * ISN is generated, nothing fatal.
  1260. */
  1261. static void rekey_seq_generator(struct work_struct *work)
  1262. {
  1263. struct keydata *keyptr = &ip_keydata[1 ^ (ip_cnt & 1)];
  1264. get_random_bytes(keyptr->secret, sizeof(keyptr->secret));
  1265. keyptr->count = (ip_cnt & COUNT_MASK) << HASH_BITS;
  1266. smp_wmb();
  1267. ip_cnt++;
  1268. schedule_delayed_work(&rekey_work,
  1269. round_jiffies_relative(REKEY_INTERVAL));
  1270. }
  1271. static inline struct keydata *get_keyptr(void)
  1272. {
  1273. struct keydata *keyptr = &ip_keydata[ip_cnt & 1];
  1274. smp_rmb();
  1275. return keyptr;
  1276. }
  1277. static __init int seqgen_init(void)
  1278. {
  1279. rekey_seq_generator(NULL);
  1280. return 0;
  1281. }
  1282. late_initcall(seqgen_init);
  1283. #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  1284. __u32 secure_tcpv6_sequence_number(__be32 *saddr, __be32 *daddr,
  1285. __be16 sport, __be16 dport)
  1286. {
  1287. __u32 seq;
  1288. __u32 hash[12];
  1289. struct keydata *keyptr = get_keyptr();
  1290. /* The procedure is the same as for IPv4, but addresses are longer.
  1291. * Thus we must use twothirdsMD4Transform.
  1292. */
  1293. memcpy(hash, saddr, 16);
  1294. hash[4] = ((__force u16)sport << 16) + (__force u16)dport;
  1295. memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
  1296. seq = twothirdsMD4Transform((const __u32 *)daddr, hash) & HASH_MASK;
  1297. seq += keyptr->count;
  1298. seq += ktime_to_ns(ktime_get_real());
  1299. return seq;
  1300. }
  1301. EXPORT_SYMBOL(secure_tcpv6_sequence_number);
  1302. #endif
  1303. /* The code below is shamelessly stolen from secure_tcp_sequence_number().
  1304. * All blames to Andrey V. Savochkin <saw@msu.ru>.
  1305. */
  1306. __u32 secure_ip_id(__be32 daddr)
  1307. {
  1308. struct keydata *keyptr;
  1309. __u32 hash[4];
  1310. keyptr = get_keyptr();
  1311. /*
  1312. * Pick a unique starting offset for each IP destination.
  1313. * The dest ip address is placed in the starting vector,
  1314. * which is then hashed with random data.
  1315. */
  1316. hash[0] = (__force __u32)daddr;
  1317. hash[1] = keyptr->secret[9];
  1318. hash[2] = keyptr->secret[10];
  1319. hash[3] = keyptr->secret[11];
  1320. return half_md4_transform(hash, keyptr->secret);
  1321. }
  1322. #ifdef CONFIG_INET
  1323. __u32 secure_tcp_sequence_number(__be32 saddr, __be32 daddr,
  1324. __be16 sport, __be16 dport)
  1325. {
  1326. __u32 seq;
  1327. __u32 hash[4];
  1328. struct keydata *keyptr = get_keyptr();
  1329. /*
  1330. * Pick a unique starting offset for each TCP connection endpoints
  1331. * (saddr, daddr, sport, dport).
  1332. * Note that the words are placed into the starting vector, which is
  1333. * then mixed with a partial MD4 over random data.
  1334. */
  1335. hash[0] = (__force u32)saddr;
  1336. hash[1] = (__force u32)daddr;
  1337. hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
  1338. hash[3] = keyptr->secret[11];
  1339. seq = half_md4_transform(hash, keyptr->secret) & HASH_MASK;
  1340. seq += keyptr->count;
  1341. /*
  1342. * As close as possible to RFC 793, which
  1343. * suggests using a 250 kHz clock.
  1344. * Further reading shows this assumes 2 Mb/s networks.
  1345. * For 10 Mb/s Ethernet, a 1 MHz clock is appropriate.
  1346. * For 10 Gb/s Ethernet, a 1 GHz clock should be ok, but
  1347. * we also need to limit the resolution so that the u32 seq
  1348. * overlaps less than one time per MSL (2 minutes).
  1349. * Choosing a clock of 64 ns period is OK. (period of 274 s)
  1350. */
  1351. seq += ktime_to_ns(ktime_get_real()) >> 6;
  1352. return seq;
  1353. }
  1354. /* Generate secure starting point for ephemeral IPV4 transport port search */
  1355. u32 secure_ipv4_port_ephemeral(__be32 saddr, __be32 daddr, __be16 dport)
  1356. {
  1357. struct keydata *keyptr = get_keyptr();
  1358. u32 hash[4];
  1359. /*
  1360. * Pick a unique starting offset for each ephemeral port search
  1361. * (saddr, daddr, dport) and 48bits of random data.
  1362. */
  1363. hash[0] = (__force u32)saddr;
  1364. hash[1] = (__force u32)daddr;
  1365. hash[2] = (__force u32)dport ^ keyptr->secret[10];
  1366. hash[3] = keyptr->secret[11];
  1367. return half_md4_transform(hash, keyptr->secret);
  1368. }
  1369. EXPORT_SYMBOL_GPL(secure_ipv4_port_ephemeral);
  1370. #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  1371. u32 secure_ipv6_port_ephemeral(const __be32 *saddr, const __be32 *daddr,
  1372. __be16 dport)
  1373. {
  1374. struct keydata *keyptr = get_keyptr();
  1375. u32 hash[12];
  1376. memcpy(hash, saddr, 16);
  1377. hash[4] = (__force u32)dport;
  1378. memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
  1379. return twothirdsMD4Transform((const __u32 *)daddr, hash);
  1380. }
  1381. #endif
  1382. #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
  1383. /* Similar to secure_tcp_sequence_number but generate a 48 bit value
  1384. * bit's 32-47 increase every key exchange
  1385. * 0-31 hash(source, dest)
  1386. */
  1387. u64 secure_dccp_sequence_number(__be32 saddr, __be32 daddr,
  1388. __be16 sport, __be16 dport)
  1389. {
  1390. u64 seq;
  1391. __u32 hash[4];
  1392. struct keydata *keyptr = get_keyptr();
  1393. hash[0] = (__force u32)saddr;
  1394. hash[1] = (__force u32)daddr;
  1395. hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
  1396. hash[3] = keyptr->secret[11];
  1397. seq = half_md4_transform(hash, keyptr->secret);
  1398. seq |= ((u64)keyptr->count) << (32 - HASH_BITS);
  1399. seq += ktime_to_ns(ktime_get_real());
  1400. seq &= (1ull << 48) - 1;
  1401. return seq;
  1402. }
  1403. EXPORT_SYMBOL(secure_dccp_sequence_number);
  1404. #endif
  1405. #endif /* CONFIG_INET */
  1406. /*
  1407. * Get a random word for internal kernel use only. Similar to urandom but
  1408. * with the goal of minimal entropy pool depletion. As a result, the random
  1409. * value is not cryptographically secure but for several uses the cost of
  1410. * depleting entropy is too high
  1411. */
  1412. DEFINE_PER_CPU(__u32 [4], get_random_int_hash);
  1413. unsigned int get_random_int(void)
  1414. {
  1415. struct keydata *keyptr;
  1416. __u32 *hash = get_cpu_var(get_random_int_hash);
  1417. int ret;
  1418. keyptr = get_keyptr();
  1419. hash[0] += current->pid + jiffies + get_cycles();
  1420. ret = half_md4_transform(hash, keyptr->secret);
  1421. put_cpu_var(get_random_int_hash);
  1422. return ret;
  1423. }
  1424. /*
  1425. * randomize_range() returns a start address such that
  1426. *
  1427. * [...... <range> .....]
  1428. * start end
  1429. *
  1430. * a <range> with size "len" starting at the return value is inside in the
  1431. * area defined by [start, end], but is otherwise randomized.
  1432. */
  1433. unsigned long
  1434. randomize_range(unsigned long start, unsigned long end, unsigned long len)
  1435. {
  1436. unsigned long range = end - len - start;
  1437. if (end <= start + len)
  1438. return 0;
  1439. return PAGE_ALIGN(get_random_int() % range + start);
  1440. }