random.c 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692
  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 <asm/processor.h>
  242. #include <asm/uaccess.h>
  243. #include <asm/irq.h>
  244. #include <asm/io.h>
  245. /*
  246. * Configuration information
  247. */
  248. #define INPUT_POOL_WORDS 128
  249. #define OUTPUT_POOL_WORDS 32
  250. #define SEC_XFER_SIZE 512
  251. /*
  252. * The minimum number of bits of entropy before we wake up a read on
  253. * /dev/random. Should be enough to do a significant reseed.
  254. */
  255. static int random_read_wakeup_thresh = 64;
  256. /*
  257. * If the entropy count falls under this number of bits, then we
  258. * should wake up processes which are selecting or polling on write
  259. * access to /dev/random.
  260. */
  261. static int random_write_wakeup_thresh = 128;
  262. /*
  263. * When the input pool goes over trickle_thresh, start dropping most
  264. * samples to avoid wasting CPU time and reduce lock contention.
  265. */
  266. static int trickle_thresh __read_mostly = INPUT_POOL_WORDS * 28;
  267. static DEFINE_PER_CPU(int, trickle_count);
  268. /*
  269. * A pool of size .poolwords is stirred with a primitive polynomial
  270. * of degree .poolwords over GF(2). The taps for various sizes are
  271. * defined below. They are chosen to be evenly spaced (minimum RMS
  272. * distance from evenly spaced; the numbers in the comments are a
  273. * scaled squared error sum) except for the last tap, which is 1 to
  274. * get the twisting happening as fast as possible.
  275. */
  276. static struct poolinfo {
  277. int poolwords;
  278. int tap1, tap2, tap3, tap4, tap5;
  279. } poolinfo_table[] = {
  280. /* x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 -- 105 */
  281. { 128, 103, 76, 51, 25, 1 },
  282. /* x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 -- 15 */
  283. { 32, 26, 20, 14, 7, 1 },
  284. #if 0
  285. /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
  286. { 2048, 1638, 1231, 819, 411, 1 },
  287. /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
  288. { 1024, 817, 615, 412, 204, 1 },
  289. /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
  290. { 1024, 819, 616, 410, 207, 2 },
  291. /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
  292. { 512, 411, 308, 208, 104, 1 },
  293. /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
  294. { 512, 409, 307, 206, 102, 2 },
  295. /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
  296. { 512, 409, 309, 205, 103, 2 },
  297. /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
  298. { 256, 205, 155, 101, 52, 1 },
  299. /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
  300. { 128, 103, 78, 51, 27, 2 },
  301. /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
  302. { 64, 52, 39, 26, 14, 1 },
  303. #endif
  304. };
  305. #define POOLBITS poolwords*32
  306. #define POOLBYTES poolwords*4
  307. /*
  308. * For the purposes of better mixing, we use the CRC-32 polynomial as
  309. * well to make a twisted Generalized Feedback Shift Reigster
  310. *
  311. * (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR generators. ACM
  312. * Transactions on Modeling and Computer Simulation 2(3):179-194.
  313. * Also see M. Matsumoto & Y. Kurita, 1994. Twisted GFSR generators
  314. * II. ACM Transactions on Mdeling and Computer Simulation 4:254-266)
  315. *
  316. * Thanks to Colin Plumb for suggesting this.
  317. *
  318. * We have not analyzed the resultant polynomial to prove it primitive;
  319. * in fact it almost certainly isn't. Nonetheless, the irreducible factors
  320. * of a random large-degree polynomial over GF(2) are more than large enough
  321. * that periodicity is not a concern.
  322. *
  323. * The input hash is much less sensitive than the output hash. All
  324. * that we want of it is that it be a good non-cryptographic hash;
  325. * i.e. it not produce collisions when fed "random" data of the sort
  326. * we expect to see. As long as the pool state differs for different
  327. * inputs, we have preserved the input entropy and done a good job.
  328. * The fact that an intelligent attacker can construct inputs that
  329. * will produce controlled alterations to the pool's state is not
  330. * important because we don't consider such inputs to contribute any
  331. * randomness. The only property we need with respect to them is that
  332. * the attacker can't increase his/her knowledge of the pool's state.
  333. * Since all additions are reversible (knowing the final state and the
  334. * input, you can reconstruct the initial state), if an attacker has
  335. * any uncertainty about the initial state, he/she can only shuffle
  336. * that uncertainty about, but never cause any collisions (which would
  337. * decrease the uncertainty).
  338. *
  339. * The chosen system lets the state of the pool be (essentially) the input
  340. * modulo the generator polymnomial. Now, for random primitive polynomials,
  341. * this is a universal class of hash functions, meaning that the chance
  342. * of a collision is limited by the attacker's knowledge of the generator
  343. * polynomail, so if it is chosen at random, an attacker can never force
  344. * a collision. Here, we use a fixed polynomial, but we *can* assume that
  345. * ###--> it is unknown to the processes generating the input entropy. <-###
  346. * Because of this important property, this is a good, collision-resistant
  347. * hash; hash collisions will occur no more often than chance.
  348. */
  349. /*
  350. * Static global variables
  351. */
  352. static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
  353. static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
  354. static struct fasync_struct *fasync;
  355. #if 0
  356. static int debug;
  357. module_param(debug, bool, 0644);
  358. #define DEBUG_ENT(fmt, arg...) do { \
  359. if (debug) \
  360. printk(KERN_DEBUG "random %04d %04d %04d: " \
  361. fmt,\
  362. input_pool.entropy_count,\
  363. blocking_pool.entropy_count,\
  364. nonblocking_pool.entropy_count,\
  365. ## arg); } while (0)
  366. #else
  367. #define DEBUG_ENT(fmt, arg...) do {} while (0)
  368. #endif
  369. /**********************************************************************
  370. *
  371. * OS independent entropy store. Here are the functions which handle
  372. * storing entropy in an entropy pool.
  373. *
  374. **********************************************************************/
  375. struct entropy_store;
  376. struct entropy_store {
  377. /* read-only data: */
  378. struct poolinfo *poolinfo;
  379. __u32 *pool;
  380. const char *name;
  381. int limit;
  382. struct entropy_store *pull;
  383. /* read-write data: */
  384. spinlock_t lock;
  385. unsigned add_ptr;
  386. int entropy_count; /* Must at no time exceed ->POOLBITS! */
  387. int input_rotate;
  388. };
  389. static __u32 input_pool_data[INPUT_POOL_WORDS];
  390. static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
  391. static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
  392. static struct entropy_store input_pool = {
  393. .poolinfo = &poolinfo_table[0],
  394. .name = "input",
  395. .limit = 1,
  396. .lock = __SPIN_LOCK_UNLOCKED(&input_pool.lock),
  397. .pool = input_pool_data
  398. };
  399. static struct entropy_store blocking_pool = {
  400. .poolinfo = &poolinfo_table[1],
  401. .name = "blocking",
  402. .limit = 1,
  403. .pull = &input_pool,
  404. .lock = __SPIN_LOCK_UNLOCKED(&blocking_pool.lock),
  405. .pool = blocking_pool_data
  406. };
  407. static struct entropy_store nonblocking_pool = {
  408. .poolinfo = &poolinfo_table[1],
  409. .name = "nonblocking",
  410. .pull = &input_pool,
  411. .lock = __SPIN_LOCK_UNLOCKED(&nonblocking_pool.lock),
  412. .pool = nonblocking_pool_data
  413. };
  414. /*
  415. * This function adds bytes into the entropy "pool". It does not
  416. * update the entropy estimate. The caller should call
  417. * credit_entropy_bits if this is appropriate.
  418. *
  419. * The pool is stirred with a primitive polynomial of the appropriate
  420. * degree, and then twisted. We twist by three bits at a time because
  421. * it's cheap to do so and helps slightly in the expected case where
  422. * the entropy is concentrated in the low-order bits.
  423. */
  424. static void mix_pool_bytes_extract(struct entropy_store *r, const void *in,
  425. int nbytes, __u8 out[64])
  426. {
  427. static __u32 const twist_table[8] = {
  428. 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
  429. 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
  430. unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
  431. int input_rotate;
  432. int wordmask = r->poolinfo->poolwords - 1;
  433. const char *bytes = in;
  434. __u32 w;
  435. unsigned long flags;
  436. /* Taps are constant, so we can load them without holding r->lock. */
  437. tap1 = r->poolinfo->tap1;
  438. tap2 = r->poolinfo->tap2;
  439. tap3 = r->poolinfo->tap3;
  440. tap4 = r->poolinfo->tap4;
  441. tap5 = r->poolinfo->tap5;
  442. spin_lock_irqsave(&r->lock, flags);
  443. input_rotate = r->input_rotate;
  444. i = r->add_ptr;
  445. /* mix one byte at a time to simplify size handling and churn faster */
  446. while (nbytes--) {
  447. w = rol32(*bytes++, input_rotate & 31);
  448. i = (i - 1) & wordmask;
  449. /* XOR in the various taps */
  450. w ^= r->pool[i];
  451. w ^= r->pool[(i + tap1) & wordmask];
  452. w ^= r->pool[(i + tap2) & wordmask];
  453. w ^= r->pool[(i + tap3) & wordmask];
  454. w ^= r->pool[(i + tap4) & wordmask];
  455. w ^= r->pool[(i + tap5) & wordmask];
  456. /* Mix the result back in with a twist */
  457. r->pool[i] = (w >> 3) ^ twist_table[w & 7];
  458. /*
  459. * Normally, we add 7 bits of rotation to the pool.
  460. * At the beginning of the pool, add an extra 7 bits
  461. * rotation, so that successive passes spread the
  462. * input bits across the pool evenly.
  463. */
  464. input_rotate += i ? 7 : 14;
  465. }
  466. r->input_rotate = input_rotate;
  467. r->add_ptr = i;
  468. if (out)
  469. for (j = 0; j < 16; j++)
  470. ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
  471. spin_unlock_irqrestore(&r->lock, flags);
  472. }
  473. static void mix_pool_bytes(struct entropy_store *r, const void *in, int bytes)
  474. {
  475. mix_pool_bytes_extract(r, in, bytes, NULL);
  476. }
  477. /*
  478. * Credit (or debit) the entropy store with n bits of entropy
  479. */
  480. static void credit_entropy_bits(struct entropy_store *r, int nbits)
  481. {
  482. unsigned long flags;
  483. int entropy_count;
  484. if (!nbits)
  485. return;
  486. spin_lock_irqsave(&r->lock, flags);
  487. DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
  488. entropy_count = r->entropy_count;
  489. entropy_count += nbits;
  490. if (entropy_count < 0) {
  491. DEBUG_ENT("negative entropy/overflow\n");
  492. entropy_count = 0;
  493. } else if (entropy_count > r->poolinfo->POOLBITS)
  494. entropy_count = r->poolinfo->POOLBITS;
  495. r->entropy_count = entropy_count;
  496. /* should we wake readers? */
  497. if (r == &input_pool && entropy_count >= random_read_wakeup_thresh) {
  498. wake_up_interruptible(&random_read_wait);
  499. kill_fasync(&fasync, SIGIO, POLL_IN);
  500. }
  501. spin_unlock_irqrestore(&r->lock, flags);
  502. }
  503. /*********************************************************************
  504. *
  505. * Entropy input management
  506. *
  507. *********************************************************************/
  508. /* There is one of these per entropy source */
  509. struct timer_rand_state {
  510. cycles_t last_time;
  511. long last_delta, last_delta2;
  512. unsigned dont_count_entropy:1;
  513. };
  514. #ifndef CONFIG_SPARSE_IRQ
  515. static struct timer_rand_state *irq_timer_state[NR_IRQS];
  516. static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
  517. {
  518. return irq_timer_state[irq];
  519. }
  520. static void set_timer_rand_state(unsigned int irq,
  521. struct timer_rand_state *state)
  522. {
  523. irq_timer_state[irq] = state;
  524. }
  525. #else
  526. static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
  527. {
  528. struct irq_desc *desc;
  529. desc = irq_to_desc(irq);
  530. return desc->timer_rand_state;
  531. }
  532. static void set_timer_rand_state(unsigned int irq,
  533. struct timer_rand_state *state)
  534. {
  535. struct irq_desc *desc;
  536. desc = irq_to_desc(irq);
  537. desc->timer_rand_state = state;
  538. }
  539. #endif
  540. static struct timer_rand_state input_timer_state;
  541. /*
  542. * This function adds entropy to the entropy "pool" by using timing
  543. * delays. It uses the timer_rand_state structure to make an estimate
  544. * of how many bits of entropy this call has added to the pool.
  545. *
  546. * The number "num" is also added to the pool - it should somehow describe
  547. * the type of event which just happened. This is currently 0-255 for
  548. * keyboard scan codes, and 256 upwards for interrupts.
  549. *
  550. */
  551. static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
  552. {
  553. struct {
  554. cycles_t cycles;
  555. long jiffies;
  556. unsigned num;
  557. } sample;
  558. long delta, delta2, delta3;
  559. preempt_disable();
  560. /* if over the trickle threshold, use only 1 in 4096 samples */
  561. if (input_pool.entropy_count > trickle_thresh &&
  562. (__get_cpu_var(trickle_count)++ & 0xfff))
  563. goto out;
  564. sample.jiffies = jiffies;
  565. sample.cycles = get_cycles();
  566. sample.num = num;
  567. mix_pool_bytes(&input_pool, &sample, sizeof(sample));
  568. /*
  569. * Calculate number of bits of randomness we probably added.
  570. * We take into account the first, second and third-order deltas
  571. * in order to make our estimate.
  572. */
  573. if (!state->dont_count_entropy) {
  574. delta = sample.jiffies - state->last_time;
  575. state->last_time = sample.jiffies;
  576. delta2 = delta - state->last_delta;
  577. state->last_delta = delta;
  578. delta3 = delta2 - state->last_delta2;
  579. state->last_delta2 = delta2;
  580. if (delta < 0)
  581. delta = -delta;
  582. if (delta2 < 0)
  583. delta2 = -delta2;
  584. if (delta3 < 0)
  585. delta3 = -delta3;
  586. if (delta > delta2)
  587. delta = delta2;
  588. if (delta > delta3)
  589. delta = delta3;
  590. /*
  591. * delta is now minimum absolute delta.
  592. * Round down by 1 bit on general principles,
  593. * and limit entropy entimate to 12 bits.
  594. */
  595. credit_entropy_bits(&input_pool,
  596. min_t(int, fls(delta>>1), 11));
  597. }
  598. out:
  599. preempt_enable();
  600. }
  601. void add_input_randomness(unsigned int type, unsigned int code,
  602. unsigned int value)
  603. {
  604. static unsigned char last_value;
  605. /* ignore autorepeat and the like */
  606. if (value == last_value)
  607. return;
  608. DEBUG_ENT("input event\n");
  609. last_value = value;
  610. add_timer_randomness(&input_timer_state,
  611. (type << 4) ^ code ^ (code >> 4) ^ value);
  612. }
  613. EXPORT_SYMBOL_GPL(add_input_randomness);
  614. void add_interrupt_randomness(int irq)
  615. {
  616. struct timer_rand_state *state;
  617. state = get_timer_rand_state(irq);
  618. if (state == NULL)
  619. return;
  620. DEBUG_ENT("irq event %d\n", irq);
  621. add_timer_randomness(state, 0x100 + irq);
  622. }
  623. #ifdef CONFIG_BLOCK
  624. void add_disk_randomness(struct gendisk *disk)
  625. {
  626. if (!disk || !disk->random)
  627. return;
  628. /* first major is 1, so we get >= 0x200 here */
  629. DEBUG_ENT("disk event %d:%d\n",
  630. MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
  631. add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
  632. }
  633. #endif
  634. #define EXTRACT_SIZE 10
  635. /*********************************************************************
  636. *
  637. * Entropy extraction routines
  638. *
  639. *********************************************************************/
  640. static ssize_t extract_entropy(struct entropy_store *r, void *buf,
  641. size_t nbytes, int min, int rsvd);
  642. /*
  643. * This utility inline function is responsible for transfering entropy
  644. * from the primary pool to the secondary extraction pool. We make
  645. * sure we pull enough for a 'catastrophic reseed'.
  646. */
  647. static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
  648. {
  649. __u32 tmp[OUTPUT_POOL_WORDS];
  650. if (r->pull && r->entropy_count < nbytes * 8 &&
  651. r->entropy_count < r->poolinfo->POOLBITS) {
  652. /* If we're limited, always leave two wakeup worth's BITS */
  653. int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
  654. int bytes = nbytes;
  655. /* pull at least as many as BYTES as wakeup BITS */
  656. bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
  657. /* but never more than the buffer size */
  658. bytes = min_t(int, bytes, sizeof(tmp));
  659. DEBUG_ENT("going to reseed %s with %d bits "
  660. "(%d of %d requested)\n",
  661. r->name, bytes * 8, nbytes * 8, r->entropy_count);
  662. bytes = extract_entropy(r->pull, tmp, bytes,
  663. random_read_wakeup_thresh / 8, rsvd);
  664. mix_pool_bytes(r, tmp, bytes);
  665. credit_entropy_bits(r, bytes*8);
  666. }
  667. }
  668. /*
  669. * These functions extracts randomness from the "entropy pool", and
  670. * returns it in a buffer.
  671. *
  672. * The min parameter specifies the minimum amount we can pull before
  673. * failing to avoid races that defeat catastrophic reseeding while the
  674. * reserved parameter indicates how much entropy we must leave in the
  675. * pool after each pull to avoid starving other readers.
  676. *
  677. * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
  678. */
  679. static size_t account(struct entropy_store *r, size_t nbytes, int min,
  680. int reserved)
  681. {
  682. unsigned long flags;
  683. BUG_ON(r->entropy_count > r->poolinfo->POOLBITS);
  684. /* Hold lock while accounting */
  685. spin_lock_irqsave(&r->lock, flags);
  686. DEBUG_ENT("trying to extract %d bits from %s\n",
  687. nbytes * 8, r->name);
  688. /* Can we pull enough? */
  689. if (r->entropy_count / 8 < min + reserved) {
  690. nbytes = 0;
  691. } else {
  692. /* If limited, never pull more than available */
  693. if (r->limit && nbytes + reserved >= r->entropy_count / 8)
  694. nbytes = r->entropy_count/8 - reserved;
  695. if (r->entropy_count / 8 >= nbytes + reserved)
  696. r->entropy_count -= nbytes*8;
  697. else
  698. r->entropy_count = reserved;
  699. if (r->entropy_count < random_write_wakeup_thresh) {
  700. wake_up_interruptible(&random_write_wait);
  701. kill_fasync(&fasync, SIGIO, POLL_OUT);
  702. }
  703. }
  704. DEBUG_ENT("debiting %d entropy credits from %s%s\n",
  705. nbytes * 8, r->name, r->limit ? "" : " (unlimited)");
  706. spin_unlock_irqrestore(&r->lock, flags);
  707. return nbytes;
  708. }
  709. static void extract_buf(struct entropy_store *r, __u8 *out)
  710. {
  711. int i;
  712. __u32 hash[5], workspace[SHA_WORKSPACE_WORDS];
  713. __u8 extract[64];
  714. /* Generate a hash across the pool, 16 words (512 bits) at a time */
  715. sha_init(hash);
  716. for (i = 0; i < r->poolinfo->poolwords; i += 16)
  717. sha_transform(hash, (__u8 *)(r->pool + i), workspace);
  718. /*
  719. * We mix the hash back into the pool to prevent backtracking
  720. * attacks (where the attacker knows the state of the pool
  721. * plus the current outputs, and attempts to find previous
  722. * ouputs), unless the hash function can be inverted. By
  723. * mixing at least a SHA1 worth of hash data back, we make
  724. * brute-forcing the feedback as hard as brute-forcing the
  725. * hash.
  726. */
  727. mix_pool_bytes_extract(r, hash, sizeof(hash), extract);
  728. /*
  729. * To avoid duplicates, we atomically extract a portion of the
  730. * pool while mixing, and hash one final time.
  731. */
  732. sha_transform(hash, extract, workspace);
  733. memset(extract, 0, sizeof(extract));
  734. memset(workspace, 0, sizeof(workspace));
  735. /*
  736. * In case the hash function has some recognizable output
  737. * pattern, we fold it in half. Thus, we always feed back
  738. * twice as much data as we output.
  739. */
  740. hash[0] ^= hash[3];
  741. hash[1] ^= hash[4];
  742. hash[2] ^= rol32(hash[2], 16);
  743. memcpy(out, hash, EXTRACT_SIZE);
  744. memset(hash, 0, sizeof(hash));
  745. }
  746. static ssize_t extract_entropy(struct entropy_store *r, void *buf,
  747. size_t nbytes, int min, int reserved)
  748. {
  749. ssize_t ret = 0, i;
  750. __u8 tmp[EXTRACT_SIZE];
  751. xfer_secondary_pool(r, nbytes);
  752. nbytes = account(r, nbytes, min, reserved);
  753. while (nbytes) {
  754. extract_buf(r, tmp);
  755. i = min_t(int, nbytes, EXTRACT_SIZE);
  756. memcpy(buf, tmp, i);
  757. nbytes -= i;
  758. buf += i;
  759. ret += i;
  760. }
  761. /* Wipe data just returned from memory */
  762. memset(tmp, 0, sizeof(tmp));
  763. return ret;
  764. }
  765. static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
  766. size_t nbytes)
  767. {
  768. ssize_t ret = 0, i;
  769. __u8 tmp[EXTRACT_SIZE];
  770. xfer_secondary_pool(r, nbytes);
  771. nbytes = account(r, nbytes, 0, 0);
  772. while (nbytes) {
  773. if (need_resched()) {
  774. if (signal_pending(current)) {
  775. if (ret == 0)
  776. ret = -ERESTARTSYS;
  777. break;
  778. }
  779. schedule();
  780. }
  781. extract_buf(r, tmp);
  782. i = min_t(int, nbytes, EXTRACT_SIZE);
  783. if (copy_to_user(buf, tmp, i)) {
  784. ret = -EFAULT;
  785. break;
  786. }
  787. nbytes -= i;
  788. buf += i;
  789. ret += i;
  790. }
  791. /* Wipe data just returned from memory */
  792. memset(tmp, 0, sizeof(tmp));
  793. return ret;
  794. }
  795. /*
  796. * This function is the exported kernel interface. It returns some
  797. * number of good random numbers, suitable for seeding TCP sequence
  798. * numbers, etc.
  799. */
  800. void get_random_bytes(void *buf, int nbytes)
  801. {
  802. extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
  803. }
  804. EXPORT_SYMBOL(get_random_bytes);
  805. /*
  806. * init_std_data - initialize pool with system data
  807. *
  808. * @r: pool to initialize
  809. *
  810. * This function clears the pool's entropy count and mixes some system
  811. * data into the pool to prepare it for use. The pool is not cleared
  812. * as that can only decrease the entropy in the pool.
  813. */
  814. static void init_std_data(struct entropy_store *r)
  815. {
  816. ktime_t now;
  817. unsigned long flags;
  818. spin_lock_irqsave(&r->lock, flags);
  819. r->entropy_count = 0;
  820. spin_unlock_irqrestore(&r->lock, flags);
  821. now = ktime_get_real();
  822. mix_pool_bytes(r, &now, sizeof(now));
  823. mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
  824. }
  825. static int rand_initialize(void)
  826. {
  827. init_std_data(&input_pool);
  828. init_std_data(&blocking_pool);
  829. init_std_data(&nonblocking_pool);
  830. return 0;
  831. }
  832. module_init(rand_initialize);
  833. void rand_initialize_irq(int irq)
  834. {
  835. struct timer_rand_state *state;
  836. state = get_timer_rand_state(irq);
  837. if (state)
  838. return;
  839. /*
  840. * If kzalloc returns null, we just won't use that entropy
  841. * source.
  842. */
  843. state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
  844. if (state)
  845. set_timer_rand_state(irq, state);
  846. }
  847. #ifdef CONFIG_BLOCK
  848. void rand_initialize_disk(struct gendisk *disk)
  849. {
  850. struct timer_rand_state *state;
  851. /*
  852. * If kzalloc returns null, we just won't use that entropy
  853. * source.
  854. */
  855. state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
  856. if (state)
  857. disk->random = state;
  858. }
  859. #endif
  860. static ssize_t
  861. random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
  862. {
  863. ssize_t n, retval = 0, count = 0;
  864. if (nbytes == 0)
  865. return 0;
  866. while (nbytes > 0) {
  867. n = nbytes;
  868. if (n > SEC_XFER_SIZE)
  869. n = SEC_XFER_SIZE;
  870. DEBUG_ENT("reading %d bits\n", n*8);
  871. n = extract_entropy_user(&blocking_pool, buf, n);
  872. DEBUG_ENT("read got %d bits (%d still needed)\n",
  873. n*8, (nbytes-n)*8);
  874. if (n == 0) {
  875. if (file->f_flags & O_NONBLOCK) {
  876. retval = -EAGAIN;
  877. break;
  878. }
  879. DEBUG_ENT("sleeping?\n");
  880. wait_event_interruptible(random_read_wait,
  881. input_pool.entropy_count >=
  882. random_read_wakeup_thresh);
  883. DEBUG_ENT("awake\n");
  884. if (signal_pending(current)) {
  885. retval = -ERESTARTSYS;
  886. break;
  887. }
  888. continue;
  889. }
  890. if (n < 0) {
  891. retval = n;
  892. break;
  893. }
  894. count += n;
  895. buf += n;
  896. nbytes -= n;
  897. break; /* This break makes the device work */
  898. /* like a named pipe */
  899. }
  900. /*
  901. * If we gave the user some bytes, update the access time.
  902. */
  903. if (count)
  904. file_accessed(file);
  905. return (count ? count : retval);
  906. }
  907. static ssize_t
  908. urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
  909. {
  910. return extract_entropy_user(&nonblocking_pool, buf, nbytes);
  911. }
  912. static unsigned int
  913. random_poll(struct file *file, poll_table * wait)
  914. {
  915. unsigned int mask;
  916. poll_wait(file, &random_read_wait, wait);
  917. poll_wait(file, &random_write_wait, wait);
  918. mask = 0;
  919. if (input_pool.entropy_count >= random_read_wakeup_thresh)
  920. mask |= POLLIN | POLLRDNORM;
  921. if (input_pool.entropy_count < random_write_wakeup_thresh)
  922. mask |= POLLOUT | POLLWRNORM;
  923. return mask;
  924. }
  925. static int
  926. write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
  927. {
  928. size_t bytes;
  929. __u32 buf[16];
  930. const char __user *p = buffer;
  931. while (count > 0) {
  932. bytes = min(count, sizeof(buf));
  933. if (copy_from_user(&buf, p, bytes))
  934. return -EFAULT;
  935. count -= bytes;
  936. p += bytes;
  937. mix_pool_bytes(r, buf, bytes);
  938. cond_resched();
  939. }
  940. return 0;
  941. }
  942. static ssize_t random_write(struct file *file, const char __user *buffer,
  943. size_t count, loff_t *ppos)
  944. {
  945. size_t ret;
  946. struct inode *inode = file->f_path.dentry->d_inode;
  947. ret = write_pool(&blocking_pool, buffer, count);
  948. if (ret)
  949. return ret;
  950. ret = write_pool(&nonblocking_pool, buffer, count);
  951. if (ret)
  952. return ret;
  953. inode->i_mtime = current_fs_time(inode->i_sb);
  954. mark_inode_dirty(inode);
  955. return (ssize_t)count;
  956. }
  957. static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
  958. {
  959. int size, ent_count;
  960. int __user *p = (int __user *)arg;
  961. int retval;
  962. switch (cmd) {
  963. case RNDGETENTCNT:
  964. /* inherently racy, no point locking */
  965. if (put_user(input_pool.entropy_count, p))
  966. return -EFAULT;
  967. return 0;
  968. case RNDADDTOENTCNT:
  969. if (!capable(CAP_SYS_ADMIN))
  970. return -EPERM;
  971. if (get_user(ent_count, p))
  972. return -EFAULT;
  973. credit_entropy_bits(&input_pool, ent_count);
  974. return 0;
  975. case RNDADDENTROPY:
  976. if (!capable(CAP_SYS_ADMIN))
  977. return -EPERM;
  978. if (get_user(ent_count, p++))
  979. return -EFAULT;
  980. if (ent_count < 0)
  981. return -EINVAL;
  982. if (get_user(size, p++))
  983. return -EFAULT;
  984. retval = write_pool(&input_pool, (const char __user *)p,
  985. size);
  986. if (retval < 0)
  987. return retval;
  988. credit_entropy_bits(&input_pool, ent_count);
  989. return 0;
  990. case RNDZAPENTCNT:
  991. case RNDCLEARPOOL:
  992. /* Clear the entropy pool counters. */
  993. if (!capable(CAP_SYS_ADMIN))
  994. return -EPERM;
  995. rand_initialize();
  996. return 0;
  997. default:
  998. return -EINVAL;
  999. }
  1000. }
  1001. static int random_fasync(int fd, struct file *filp, int on)
  1002. {
  1003. return fasync_helper(fd, filp, on, &fasync);
  1004. }
  1005. const struct file_operations random_fops = {
  1006. .read = random_read,
  1007. .write = random_write,
  1008. .poll = random_poll,
  1009. .unlocked_ioctl = random_ioctl,
  1010. .fasync = random_fasync,
  1011. };
  1012. const struct file_operations urandom_fops = {
  1013. .read = urandom_read,
  1014. .write = random_write,
  1015. .unlocked_ioctl = random_ioctl,
  1016. .fasync = random_fasync,
  1017. };
  1018. /***************************************************************
  1019. * Random UUID interface
  1020. *
  1021. * Used here for a Boot ID, but can be useful for other kernel
  1022. * drivers.
  1023. ***************************************************************/
  1024. /*
  1025. * Generate random UUID
  1026. */
  1027. void generate_random_uuid(unsigned char uuid_out[16])
  1028. {
  1029. get_random_bytes(uuid_out, 16);
  1030. /* Set UUID version to 4 --- truely random generation */
  1031. uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
  1032. /* Set the UUID variant to DCE */
  1033. uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
  1034. }
  1035. EXPORT_SYMBOL(generate_random_uuid);
  1036. /********************************************************************
  1037. *
  1038. * Sysctl interface
  1039. *
  1040. ********************************************************************/
  1041. #ifdef CONFIG_SYSCTL
  1042. #include <linux/sysctl.h>
  1043. static int min_read_thresh = 8, min_write_thresh;
  1044. static int max_read_thresh = INPUT_POOL_WORDS * 32;
  1045. static int max_write_thresh = INPUT_POOL_WORDS * 32;
  1046. static char sysctl_bootid[16];
  1047. /*
  1048. * These functions is used to return both the bootid UUID, and random
  1049. * UUID. The difference is in whether table->data is NULL; if it is,
  1050. * then a new UUID is generated and returned to the user.
  1051. *
  1052. * If the user accesses this via the proc interface, it will be returned
  1053. * as an ASCII string in the standard UUID format. If accesses via the
  1054. * sysctl system call, it is returned as 16 bytes of binary data.
  1055. */
  1056. static int proc_do_uuid(ctl_table *table, int write, struct file *filp,
  1057. void __user *buffer, size_t *lenp, loff_t *ppos)
  1058. {
  1059. ctl_table fake_table;
  1060. unsigned char buf[64], tmp_uuid[16], *uuid;
  1061. uuid = table->data;
  1062. if (!uuid) {
  1063. uuid = tmp_uuid;
  1064. uuid[8] = 0;
  1065. }
  1066. if (uuid[8] == 0)
  1067. generate_random_uuid(uuid);
  1068. sprintf(buf, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
  1069. "%02x%02x%02x%02x%02x%02x",
  1070. uuid[0], uuid[1], uuid[2], uuid[3],
  1071. uuid[4], uuid[5], uuid[6], uuid[7],
  1072. uuid[8], uuid[9], uuid[10], uuid[11],
  1073. uuid[12], uuid[13], uuid[14], uuid[15]);
  1074. fake_table.data = buf;
  1075. fake_table.maxlen = sizeof(buf);
  1076. return proc_dostring(&fake_table, write, filp, buffer, lenp, ppos);
  1077. }
  1078. static int uuid_strategy(ctl_table *table,
  1079. void __user *oldval, size_t __user *oldlenp,
  1080. void __user *newval, size_t newlen)
  1081. {
  1082. unsigned char tmp_uuid[16], *uuid;
  1083. unsigned int len;
  1084. if (!oldval || !oldlenp)
  1085. return 1;
  1086. uuid = table->data;
  1087. if (!uuid) {
  1088. uuid = tmp_uuid;
  1089. uuid[8] = 0;
  1090. }
  1091. if (uuid[8] == 0)
  1092. generate_random_uuid(uuid);
  1093. if (get_user(len, oldlenp))
  1094. return -EFAULT;
  1095. if (len) {
  1096. if (len > 16)
  1097. len = 16;
  1098. if (copy_to_user(oldval, uuid, len) ||
  1099. put_user(len, oldlenp))
  1100. return -EFAULT;
  1101. }
  1102. return 1;
  1103. }
  1104. static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
  1105. ctl_table random_table[] = {
  1106. {
  1107. .ctl_name = RANDOM_POOLSIZE,
  1108. .procname = "poolsize",
  1109. .data = &sysctl_poolsize,
  1110. .maxlen = sizeof(int),
  1111. .mode = 0444,
  1112. .proc_handler = &proc_dointvec,
  1113. },
  1114. {
  1115. .ctl_name = RANDOM_ENTROPY_COUNT,
  1116. .procname = "entropy_avail",
  1117. .maxlen = sizeof(int),
  1118. .mode = 0444,
  1119. .proc_handler = &proc_dointvec,
  1120. .data = &input_pool.entropy_count,
  1121. },
  1122. {
  1123. .ctl_name = RANDOM_READ_THRESH,
  1124. .procname = "read_wakeup_threshold",
  1125. .data = &random_read_wakeup_thresh,
  1126. .maxlen = sizeof(int),
  1127. .mode = 0644,
  1128. .proc_handler = &proc_dointvec_minmax,
  1129. .strategy = &sysctl_intvec,
  1130. .extra1 = &min_read_thresh,
  1131. .extra2 = &max_read_thresh,
  1132. },
  1133. {
  1134. .ctl_name = RANDOM_WRITE_THRESH,
  1135. .procname = "write_wakeup_threshold",
  1136. .data = &random_write_wakeup_thresh,
  1137. .maxlen = sizeof(int),
  1138. .mode = 0644,
  1139. .proc_handler = &proc_dointvec_minmax,
  1140. .strategy = &sysctl_intvec,
  1141. .extra1 = &min_write_thresh,
  1142. .extra2 = &max_write_thresh,
  1143. },
  1144. {
  1145. .ctl_name = RANDOM_BOOT_ID,
  1146. .procname = "boot_id",
  1147. .data = &sysctl_bootid,
  1148. .maxlen = 16,
  1149. .mode = 0444,
  1150. .proc_handler = &proc_do_uuid,
  1151. .strategy = &uuid_strategy,
  1152. },
  1153. {
  1154. .ctl_name = RANDOM_UUID,
  1155. .procname = "uuid",
  1156. .maxlen = 16,
  1157. .mode = 0444,
  1158. .proc_handler = &proc_do_uuid,
  1159. .strategy = &uuid_strategy,
  1160. },
  1161. { .ctl_name = 0 }
  1162. };
  1163. #endif /* CONFIG_SYSCTL */
  1164. /********************************************************************
  1165. *
  1166. * Random funtions for networking
  1167. *
  1168. ********************************************************************/
  1169. /*
  1170. * TCP initial sequence number picking. This uses the random number
  1171. * generator to pick an initial secret value. This value is hashed
  1172. * along with the TCP endpoint information to provide a unique
  1173. * starting point for each pair of TCP endpoints. This defeats
  1174. * attacks which rely on guessing the initial TCP sequence number.
  1175. * This algorithm was suggested by Steve Bellovin.
  1176. *
  1177. * Using a very strong hash was taking an appreciable amount of the total
  1178. * TCP connection establishment time, so this is a weaker hash,
  1179. * compensated for by changing the secret periodically.
  1180. */
  1181. /* F, G and H are basic MD4 functions: selection, majority, parity */
  1182. #define F(x, y, z) ((z) ^ ((x) & ((y) ^ (z))))
  1183. #define G(x, y, z) (((x) & (y)) + (((x) ^ (y)) & (z)))
  1184. #define H(x, y, z) ((x) ^ (y) ^ (z))
  1185. /*
  1186. * The generic round function. The application is so specific that
  1187. * we don't bother protecting all the arguments with parens, as is generally
  1188. * good macro practice, in favor of extra legibility.
  1189. * Rotation is separate from addition to prevent recomputation
  1190. */
  1191. #define ROUND(f, a, b, c, d, x, s) \
  1192. (a += f(b, c, d) + x, a = (a << s) | (a >> (32 - s)))
  1193. #define K1 0
  1194. #define K2 013240474631UL
  1195. #define K3 015666365641UL
  1196. #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  1197. static __u32 twothirdsMD4Transform(__u32 const buf[4], __u32 const in[12])
  1198. {
  1199. __u32 a = buf[0], b = buf[1], c = buf[2], d = buf[3];
  1200. /* Round 1 */
  1201. ROUND(F, a, b, c, d, in[ 0] + K1, 3);
  1202. ROUND(F, d, a, b, c, in[ 1] + K1, 7);
  1203. ROUND(F, c, d, a, b, in[ 2] + K1, 11);
  1204. ROUND(F, b, c, d, a, in[ 3] + K1, 19);
  1205. ROUND(F, a, b, c, d, in[ 4] + K1, 3);
  1206. ROUND(F, d, a, b, c, in[ 5] + K1, 7);
  1207. ROUND(F, c, d, a, b, in[ 6] + K1, 11);
  1208. ROUND(F, b, c, d, a, in[ 7] + K1, 19);
  1209. ROUND(F, a, b, c, d, in[ 8] + K1, 3);
  1210. ROUND(F, d, a, b, c, in[ 9] + K1, 7);
  1211. ROUND(F, c, d, a, b, in[10] + K1, 11);
  1212. ROUND(F, b, c, d, a, in[11] + K1, 19);
  1213. /* Round 2 */
  1214. ROUND(G, a, b, c, d, in[ 1] + K2, 3);
  1215. ROUND(G, d, a, b, c, in[ 3] + K2, 5);
  1216. ROUND(G, c, d, a, b, in[ 5] + K2, 9);
  1217. ROUND(G, b, c, d, a, in[ 7] + K2, 13);
  1218. ROUND(G, a, b, c, d, in[ 9] + K2, 3);
  1219. ROUND(G, d, a, b, c, in[11] + K2, 5);
  1220. ROUND(G, c, d, a, b, in[ 0] + K2, 9);
  1221. ROUND(G, b, c, d, a, in[ 2] + K2, 13);
  1222. ROUND(G, a, b, c, d, in[ 4] + K2, 3);
  1223. ROUND(G, d, a, b, c, in[ 6] + K2, 5);
  1224. ROUND(G, c, d, a, b, in[ 8] + K2, 9);
  1225. ROUND(G, b, c, d, a, in[10] + K2, 13);
  1226. /* Round 3 */
  1227. ROUND(H, a, b, c, d, in[ 3] + K3, 3);
  1228. ROUND(H, d, a, b, c, in[ 7] + K3, 9);
  1229. ROUND(H, c, d, a, b, in[11] + K3, 11);
  1230. ROUND(H, b, c, d, a, in[ 2] + K3, 15);
  1231. ROUND(H, a, b, c, d, in[ 6] + K3, 3);
  1232. ROUND(H, d, a, b, c, in[10] + K3, 9);
  1233. ROUND(H, c, d, a, b, in[ 1] + K3, 11);
  1234. ROUND(H, b, c, d, a, in[ 5] + K3, 15);
  1235. ROUND(H, a, b, c, d, in[ 9] + K3, 3);
  1236. ROUND(H, d, a, b, c, in[ 0] + K3, 9);
  1237. ROUND(H, c, d, a, b, in[ 4] + K3, 11);
  1238. ROUND(H, b, c, d, a, in[ 8] + K3, 15);
  1239. return buf[1] + b; /* "most hashed" word */
  1240. /* Alternative: return sum of all words? */
  1241. }
  1242. #endif
  1243. #undef ROUND
  1244. #undef F
  1245. #undef G
  1246. #undef H
  1247. #undef K1
  1248. #undef K2
  1249. #undef K3
  1250. /* This should not be decreased so low that ISNs wrap too fast. */
  1251. #define REKEY_INTERVAL (300 * HZ)
  1252. /*
  1253. * Bit layout of the tcp sequence numbers (before adding current time):
  1254. * bit 24-31: increased after every key exchange
  1255. * bit 0-23: hash(source,dest)
  1256. *
  1257. * The implementation is similar to the algorithm described
  1258. * in the Appendix of RFC 1185, except that
  1259. * - it uses a 1 MHz clock instead of a 250 kHz clock
  1260. * - it performs a rekey every 5 minutes, which is equivalent
  1261. * to a (source,dest) tulple dependent forward jump of the
  1262. * clock by 0..2^(HASH_BITS+1)
  1263. *
  1264. * Thus the average ISN wraparound time is 68 minutes instead of
  1265. * 4.55 hours.
  1266. *
  1267. * SMP cleanup and lock avoidance with poor man's RCU.
  1268. * Manfred Spraul <manfred@colorfullife.com>
  1269. *
  1270. */
  1271. #define COUNT_BITS 8
  1272. #define COUNT_MASK ((1 << COUNT_BITS) - 1)
  1273. #define HASH_BITS 24
  1274. #define HASH_MASK ((1 << HASH_BITS) - 1)
  1275. static struct keydata {
  1276. __u32 count; /* already shifted to the final position */
  1277. __u32 secret[12];
  1278. } ____cacheline_aligned ip_keydata[2];
  1279. static unsigned int ip_cnt;
  1280. static void rekey_seq_generator(struct work_struct *work);
  1281. static DECLARE_DELAYED_WORK(rekey_work, rekey_seq_generator);
  1282. /*
  1283. * Lock avoidance:
  1284. * The ISN generation runs lockless - it's just a hash over random data.
  1285. * State changes happen every 5 minutes when the random key is replaced.
  1286. * Synchronization is performed by having two copies of the hash function
  1287. * state and rekey_seq_generator always updates the inactive copy.
  1288. * The copy is then activated by updating ip_cnt.
  1289. * The implementation breaks down if someone blocks the thread
  1290. * that processes SYN requests for more than 5 minutes. Should never
  1291. * happen, and even if that happens only a not perfectly compliant
  1292. * ISN is generated, nothing fatal.
  1293. */
  1294. static void rekey_seq_generator(struct work_struct *work)
  1295. {
  1296. struct keydata *keyptr = &ip_keydata[1 ^ (ip_cnt & 1)];
  1297. get_random_bytes(keyptr->secret, sizeof(keyptr->secret));
  1298. keyptr->count = (ip_cnt & COUNT_MASK) << HASH_BITS;
  1299. smp_wmb();
  1300. ip_cnt++;
  1301. schedule_delayed_work(&rekey_work, REKEY_INTERVAL);
  1302. }
  1303. static inline struct keydata *get_keyptr(void)
  1304. {
  1305. struct keydata *keyptr = &ip_keydata[ip_cnt & 1];
  1306. smp_rmb();
  1307. return keyptr;
  1308. }
  1309. static __init int seqgen_init(void)
  1310. {
  1311. rekey_seq_generator(NULL);
  1312. return 0;
  1313. }
  1314. late_initcall(seqgen_init);
  1315. #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  1316. __u32 secure_tcpv6_sequence_number(__be32 *saddr, __be32 *daddr,
  1317. __be16 sport, __be16 dport)
  1318. {
  1319. __u32 seq;
  1320. __u32 hash[12];
  1321. struct keydata *keyptr = get_keyptr();
  1322. /* The procedure is the same as for IPv4, but addresses are longer.
  1323. * Thus we must use twothirdsMD4Transform.
  1324. */
  1325. memcpy(hash, saddr, 16);
  1326. hash[4] = ((__force u16)sport << 16) + (__force u16)dport;
  1327. memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
  1328. seq = twothirdsMD4Transform((const __u32 *)daddr, hash) & HASH_MASK;
  1329. seq += keyptr->count;
  1330. seq += ktime_to_ns(ktime_get_real());
  1331. return seq;
  1332. }
  1333. EXPORT_SYMBOL(secure_tcpv6_sequence_number);
  1334. #endif
  1335. /* The code below is shamelessly stolen from secure_tcp_sequence_number().
  1336. * All blames to Andrey V. Savochkin <saw@msu.ru>.
  1337. */
  1338. __u32 secure_ip_id(__be32 daddr)
  1339. {
  1340. struct keydata *keyptr;
  1341. __u32 hash[4];
  1342. keyptr = get_keyptr();
  1343. /*
  1344. * Pick a unique starting offset for each IP destination.
  1345. * The dest ip address is placed in the starting vector,
  1346. * which is then hashed with random data.
  1347. */
  1348. hash[0] = (__force __u32)daddr;
  1349. hash[1] = keyptr->secret[9];
  1350. hash[2] = keyptr->secret[10];
  1351. hash[3] = keyptr->secret[11];
  1352. return half_md4_transform(hash, keyptr->secret);
  1353. }
  1354. #ifdef CONFIG_INET
  1355. __u32 secure_tcp_sequence_number(__be32 saddr, __be32 daddr,
  1356. __be16 sport, __be16 dport)
  1357. {
  1358. __u32 seq;
  1359. __u32 hash[4];
  1360. struct keydata *keyptr = get_keyptr();
  1361. /*
  1362. * Pick a unique starting offset for each TCP connection endpoints
  1363. * (saddr, daddr, sport, dport).
  1364. * Note that the words are placed into the starting vector, which is
  1365. * then mixed with a partial MD4 over random data.
  1366. */
  1367. hash[0] = (__force u32)saddr;
  1368. hash[1] = (__force u32)daddr;
  1369. hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
  1370. hash[3] = keyptr->secret[11];
  1371. seq = half_md4_transform(hash, keyptr->secret) & HASH_MASK;
  1372. seq += keyptr->count;
  1373. /*
  1374. * As close as possible to RFC 793, which
  1375. * suggests using a 250 kHz clock.
  1376. * Further reading shows this assumes 2 Mb/s networks.
  1377. * For 10 Mb/s Ethernet, a 1 MHz clock is appropriate.
  1378. * For 10 Gb/s Ethernet, a 1 GHz clock should be ok, but
  1379. * we also need to limit the resolution so that the u32 seq
  1380. * overlaps less than one time per MSL (2 minutes).
  1381. * Choosing a clock of 64 ns period is OK. (period of 274 s)
  1382. */
  1383. seq += ktime_to_ns(ktime_get_real()) >> 6;
  1384. return seq;
  1385. }
  1386. /* Generate secure starting point for ephemeral IPV4 transport port search */
  1387. u32 secure_ipv4_port_ephemeral(__be32 saddr, __be32 daddr, __be16 dport)
  1388. {
  1389. struct keydata *keyptr = get_keyptr();
  1390. u32 hash[4];
  1391. /*
  1392. * Pick a unique starting offset for each ephemeral port search
  1393. * (saddr, daddr, dport) and 48bits of random data.
  1394. */
  1395. hash[0] = (__force u32)saddr;
  1396. hash[1] = (__force u32)daddr;
  1397. hash[2] = (__force u32)dport ^ keyptr->secret[10];
  1398. hash[3] = keyptr->secret[11];
  1399. return half_md4_transform(hash, keyptr->secret);
  1400. }
  1401. EXPORT_SYMBOL_GPL(secure_ipv4_port_ephemeral);
  1402. #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  1403. u32 secure_ipv6_port_ephemeral(const __be32 *saddr, const __be32 *daddr,
  1404. __be16 dport)
  1405. {
  1406. struct keydata *keyptr = get_keyptr();
  1407. u32 hash[12];
  1408. memcpy(hash, saddr, 16);
  1409. hash[4] = (__force u32)dport;
  1410. memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
  1411. return twothirdsMD4Transform((const __u32 *)daddr, hash);
  1412. }
  1413. #endif
  1414. #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
  1415. /* Similar to secure_tcp_sequence_number but generate a 48 bit value
  1416. * bit's 32-47 increase every key exchange
  1417. * 0-31 hash(source, dest)
  1418. */
  1419. u64 secure_dccp_sequence_number(__be32 saddr, __be32 daddr,
  1420. __be16 sport, __be16 dport)
  1421. {
  1422. u64 seq;
  1423. __u32 hash[4];
  1424. struct keydata *keyptr = get_keyptr();
  1425. hash[0] = (__force u32)saddr;
  1426. hash[1] = (__force u32)daddr;
  1427. hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
  1428. hash[3] = keyptr->secret[11];
  1429. seq = half_md4_transform(hash, keyptr->secret);
  1430. seq |= ((u64)keyptr->count) << (32 - HASH_BITS);
  1431. seq += ktime_to_ns(ktime_get_real());
  1432. seq &= (1ull << 48) - 1;
  1433. return seq;
  1434. }
  1435. EXPORT_SYMBOL(secure_dccp_sequence_number);
  1436. #endif
  1437. #endif /* CONFIG_INET */
  1438. /*
  1439. * Get a random word for internal kernel use only. Similar to urandom but
  1440. * with the goal of minimal entropy pool depletion. As a result, the random
  1441. * value is not cryptographically secure but for several uses the cost of
  1442. * depleting entropy is too high
  1443. */
  1444. unsigned int get_random_int(void)
  1445. {
  1446. /*
  1447. * Use IP's RNG. It suits our purpose perfectly: it re-keys itself
  1448. * every second, from the entropy pool (and thus creates a limited
  1449. * drain on it), and uses halfMD4Transform within the second. We
  1450. * also mix it with jiffies and the PID:
  1451. */
  1452. return secure_ip_id((__force __be32)(current->pid + jiffies));
  1453. }
  1454. /*
  1455. * randomize_range() returns a start address such that
  1456. *
  1457. * [...... <range> .....]
  1458. * start end
  1459. *
  1460. * a <range> with size "len" starting at the return value is inside in the
  1461. * area defined by [start, end], but is otherwise randomized.
  1462. */
  1463. unsigned long
  1464. randomize_range(unsigned long start, unsigned long end, unsigned long len)
  1465. {
  1466. unsigned long range = end - len - start;
  1467. if (end <= start + len)
  1468. return 0;
  1469. return PAGE_ALIGN(get_random_int() % range + start);
  1470. }