random.c 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334
  1. /*
  2. * random.c -- A strong random number generator
  3. *
  4. * Copyright (C) 2017 Jason A. Donenfeld <Jason@zx2c4.com>. All
  5. * Rights Reserved.
  6. *
  7. * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
  8. *
  9. * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
  10. * rights reserved.
  11. *
  12. * Redistribution and use in source and binary forms, with or without
  13. * modification, are permitted provided that the following conditions
  14. * are met:
  15. * 1. Redistributions of source code must retain the above copyright
  16. * notice, and the entire permission notice in its entirety,
  17. * including the disclaimer of warranties.
  18. * 2. Redistributions in binary form must reproduce the above copyright
  19. * notice, this list of conditions and the following disclaimer in the
  20. * documentation and/or other materials provided with the distribution.
  21. * 3. The name of the author may not be used to endorse or promote
  22. * products derived from this software without specific prior
  23. * written permission.
  24. *
  25. * ALTERNATIVELY, this product may be distributed under the terms of
  26. * the GNU General Public License, in which case the provisions of the GPL are
  27. * required INSTEAD OF the above restrictions. (This clause is
  28. * necessary due to a potential bad interaction between the GPL and
  29. * the restrictions contained in a BSD-style copyright.)
  30. *
  31. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  32. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  33. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
  34. * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
  35. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  36. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  37. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  38. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  39. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  41. * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
  42. * DAMAGE.
  43. */
  44. /*
  45. * (now, with legal B.S. out of the way.....)
  46. *
  47. * This routine gathers environmental noise from device drivers, etc.,
  48. * and returns good random numbers, suitable for cryptographic use.
  49. * Besides the obvious cryptographic uses, these numbers are also good
  50. * for seeding TCP sequence numbers, and other places where it is
  51. * desirable to have numbers which are not only random, but hard to
  52. * predict by an attacker.
  53. *
  54. * Theory of operation
  55. * ===================
  56. *
  57. * Computers are very predictable devices. Hence it is extremely hard
  58. * to produce truly random numbers on a computer --- as opposed to
  59. * pseudo-random numbers, which can easily generated by using a
  60. * algorithm. Unfortunately, it is very easy for attackers to guess
  61. * the sequence of pseudo-random number generators, and for some
  62. * applications this is not acceptable. So instead, we must try to
  63. * gather "environmental noise" from the computer's environment, which
  64. * must be hard for outside attackers to observe, and use that to
  65. * generate random numbers. In a Unix environment, this is best done
  66. * from inside the kernel.
  67. *
  68. * Sources of randomness from the environment include inter-keyboard
  69. * timings, inter-interrupt timings from some interrupts, and other
  70. * events which are both (a) non-deterministic and (b) hard for an
  71. * outside observer to measure. Randomness from these sources are
  72. * added to an "entropy pool", which is mixed using a CRC-like function.
  73. * This is not cryptographically strong, but it is adequate assuming
  74. * the randomness is not chosen maliciously, and it is fast enough that
  75. * the overhead of doing it on every interrupt is very reasonable.
  76. * As random bytes are mixed into the entropy pool, the routines keep
  77. * an *estimate* of how many bits of randomness have been stored into
  78. * the random number generator's internal state.
  79. *
  80. * When random bytes are desired, they are obtained by taking the SHA
  81. * hash of the contents of the "entropy pool". The SHA hash avoids
  82. * exposing the internal state of the entropy pool. It is believed to
  83. * be computationally infeasible to derive any useful information
  84. * about the input of SHA from its output. Even if it is possible to
  85. * analyze SHA in some clever way, as long as the amount of data
  86. * returned from the generator is less than the inherent entropy in
  87. * the pool, the output data is totally unpredictable. For this
  88. * reason, the routine decreases its internal estimate of how many
  89. * bits of "true randomness" are contained in the entropy pool as it
  90. * outputs random numbers.
  91. *
  92. * If this estimate goes to zero, the routine can still generate
  93. * random numbers; however, an attacker may (at least in theory) be
  94. * able to infer the future output of the generator from prior
  95. * outputs. This requires successful cryptanalysis of SHA, which is
  96. * not believed to be feasible, but there is a remote possibility.
  97. * Nonetheless, these numbers should be useful for the vast majority
  98. * of purposes.
  99. *
  100. * Exported interfaces ---- output
  101. * ===============================
  102. *
  103. * There are three exported interfaces; the first is one designed to
  104. * be used from within the kernel:
  105. *
  106. * void get_random_bytes(void *buf, int nbytes);
  107. *
  108. * This interface will return the requested number of random bytes,
  109. * and place it in the requested buffer.
  110. *
  111. * The two other interfaces are two character devices /dev/random and
  112. * /dev/urandom. /dev/random is suitable for use when very high
  113. * quality randomness is desired (for example, for key generation or
  114. * one-time pads), as it will only return a maximum of the number of
  115. * bits of randomness (as estimated by the random number generator)
  116. * contained in the entropy pool.
  117. *
  118. * The /dev/urandom device does not have this limit, and will return
  119. * as many bytes as are requested. As more and more random bytes are
  120. * requested without giving time for the entropy pool to recharge,
  121. * this will result in random numbers that are merely cryptographically
  122. * strong. For many applications, however, this is acceptable.
  123. *
  124. * Exported interfaces ---- input
  125. * ==============================
  126. *
  127. * The current exported interfaces for gathering environmental noise
  128. * from the devices are:
  129. *
  130. * void add_device_randomness(const void *buf, unsigned int size);
  131. * void add_input_randomness(unsigned int type, unsigned int code,
  132. * unsigned int value);
  133. * void add_interrupt_randomness(int irq, int irq_flags);
  134. * void add_disk_randomness(struct gendisk *disk);
  135. *
  136. * add_device_randomness() is for adding data to the random pool that
  137. * is likely to differ between two devices (or possibly even per boot).
  138. * This would be things like MAC addresses or serial numbers, or the
  139. * read-out of the RTC. This does *not* add any actual entropy to the
  140. * pool, but it initializes the pool to different values for devices
  141. * that might otherwise be identical and have very little entropy
  142. * available to them (particularly common in the embedded world).
  143. *
  144. * add_input_randomness() uses the input layer interrupt timing, as well as
  145. * the event type information from the hardware.
  146. *
  147. * add_interrupt_randomness() uses the interrupt timing as random
  148. * inputs to the entropy pool. Using the cycle counters and the irq source
  149. * as inputs, it feeds the randomness roughly once a second.
  150. *
  151. * add_disk_randomness() uses what amounts to the seek time of block
  152. * layer request events, on a per-disk_devt basis, as input to the
  153. * entropy pool. Note that high-speed solid state drives with very low
  154. * seek times do not make for good sources of entropy, as their seek
  155. * times are usually fairly consistent.
  156. *
  157. * All of these routines try to estimate how many bits of randomness a
  158. * particular randomness source. They do this by keeping track of the
  159. * first and second order deltas of the event timings.
  160. *
  161. * Ensuring unpredictability at system startup
  162. * ============================================
  163. *
  164. * When any operating system starts up, it will go through a sequence
  165. * of actions that are fairly predictable by an adversary, especially
  166. * if the start-up does not involve interaction with a human operator.
  167. * This reduces the actual number of bits of unpredictability in the
  168. * entropy pool below the value in entropy_count. In order to
  169. * counteract this effect, it helps to carry information in the
  170. * entropy pool across shut-downs and start-ups. To do this, put the
  171. * following lines an appropriate script which is run during the boot
  172. * sequence:
  173. *
  174. * echo "Initializing random number generator..."
  175. * random_seed=/var/run/random-seed
  176. * # Carry a random seed from start-up to start-up
  177. * # Load and then save the whole entropy pool
  178. * if [ -f $random_seed ]; then
  179. * cat $random_seed >/dev/urandom
  180. * else
  181. * touch $random_seed
  182. * fi
  183. * chmod 600 $random_seed
  184. * dd if=/dev/urandom of=$random_seed count=1 bs=512
  185. *
  186. * and the following lines in an appropriate script which is run as
  187. * the system is shutdown:
  188. *
  189. * # Carry a random seed from shut-down to start-up
  190. * # Save the whole entropy pool
  191. * echo "Saving random seed..."
  192. * random_seed=/var/run/random-seed
  193. * touch $random_seed
  194. * chmod 600 $random_seed
  195. * dd if=/dev/urandom of=$random_seed count=1 bs=512
  196. *
  197. * For example, on most modern systems using the System V init
  198. * scripts, such code fragments would be found in
  199. * /etc/rc.d/init.d/random. On older Linux systems, the correct script
  200. * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
  201. *
  202. * Effectively, these commands cause the contents of the entropy pool
  203. * to be saved at shut-down time and reloaded into the entropy pool at
  204. * start-up. (The 'dd' in the addition to the bootup script is to
  205. * make sure that /etc/random-seed is different for every start-up,
  206. * even if the system crashes without executing rc.0.) Even with
  207. * complete knowledge of the start-up activities, predicting the state
  208. * of the entropy pool requires knowledge of the previous history of
  209. * the system.
  210. *
  211. * Configuring the /dev/random driver under Linux
  212. * ==============================================
  213. *
  214. * The /dev/random driver under Linux uses minor numbers 8 and 9 of
  215. * the /dev/mem major number (#1). So if your system does not have
  216. * /dev/random and /dev/urandom created already, they can be created
  217. * by using the commands:
  218. *
  219. * mknod /dev/random c 1 8
  220. * mknod /dev/urandom c 1 9
  221. *
  222. * Acknowledgements:
  223. * =================
  224. *
  225. * Ideas for constructing this random number generator were derived
  226. * from Pretty Good Privacy's random number generator, and from private
  227. * discussions with Phil Karn. Colin Plumb provided a faster random
  228. * number generator, which speed up the mixing function of the entropy
  229. * pool, taken from PGPfone. Dale Worley has also contributed many
  230. * useful ideas and suggestions to improve this driver.
  231. *
  232. * Any flaws in the design are solely my responsibility, and should
  233. * not be attributed to the Phil, Colin, or any of authors of PGP.
  234. *
  235. * Further background information on this topic may be obtained from
  236. * RFC 1750, "Randomness Recommendations for Security", by Donald
  237. * Eastlake, Steve Crocker, and Jeff Schiller.
  238. */
  239. #include <linux/utsname.h>
  240. #include <linux/module.h>
  241. #include <linux/kernel.h>
  242. #include <linux/major.h>
  243. #include <linux/string.h>
  244. #include <linux/fcntl.h>
  245. #include <linux/slab.h>
  246. #include <linux/random.h>
  247. #include <linux/poll.h>
  248. #include <linux/init.h>
  249. #include <linux/fs.h>
  250. #include <linux/genhd.h>
  251. #include <linux/interrupt.h>
  252. #include <linux/mm.h>
  253. #include <linux/nodemask.h>
  254. #include <linux/spinlock.h>
  255. #include <linux/kthread.h>
  256. #include <linux/percpu.h>
  257. #include <linux/cryptohash.h>
  258. #include <linux/fips.h>
  259. #include <linux/ptrace.h>
  260. #include <linux/workqueue.h>
  261. #include <linux/irq.h>
  262. #include <linux/ratelimit.h>
  263. #include <linux/syscalls.h>
  264. #include <linux/completion.h>
  265. #include <linux/uuid.h>
  266. #include <crypto/chacha20.h>
  267. #include <asm/processor.h>
  268. #include <linux/uaccess.h>
  269. #include <asm/irq.h>
  270. #include <asm/irq_regs.h>
  271. #include <asm/io.h>
  272. #define CREATE_TRACE_POINTS
  273. #include <trace/events/random.h>
  274. /* #define ADD_INTERRUPT_BENCH */
  275. /*
  276. * Configuration information
  277. */
  278. #define INPUT_POOL_SHIFT 12
  279. #define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
  280. #define OUTPUT_POOL_SHIFT 10
  281. #define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
  282. #define SEC_XFER_SIZE 512
  283. #define EXTRACT_SIZE 10
  284. #define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
  285. /*
  286. * To allow fractional bits to be tracked, the entropy_count field is
  287. * denominated in units of 1/8th bits.
  288. *
  289. * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
  290. * credit_entropy_bits() needs to be 64 bits wide.
  291. */
  292. #define ENTROPY_SHIFT 3
  293. #define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
  294. /*
  295. * The minimum number of bits of entropy before we wake up a read on
  296. * /dev/random. Should be enough to do a significant reseed.
  297. */
  298. static int random_read_wakeup_bits = 64;
  299. /*
  300. * If the entropy count falls under this number of bits, then we
  301. * should wake up processes which are selecting or polling on write
  302. * access to /dev/random.
  303. */
  304. static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
  305. /*
  306. * Originally, we used a primitive polynomial of degree .poolwords
  307. * over GF(2). The taps for various sizes are defined below. They
  308. * were chosen to be evenly spaced except for the last tap, which is 1
  309. * to get the twisting happening as fast as possible.
  310. *
  311. * For the purposes of better mixing, we use the CRC-32 polynomial as
  312. * well to make a (modified) twisted Generalized Feedback Shift
  313. * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
  314. * generators. ACM Transactions on Modeling and Computer Simulation
  315. * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
  316. * GFSR generators II. ACM Transactions on Modeling and Computer
  317. * Simulation 4:254-266)
  318. *
  319. * Thanks to Colin Plumb for suggesting this.
  320. *
  321. * The mixing operation is much less sensitive than the output hash,
  322. * where we use SHA-1. All that we want of mixing operation is that
  323. * it be a good non-cryptographic hash; i.e. it not produce collisions
  324. * when fed "random" data of the sort we expect to see. As long as
  325. * the pool state differs for different inputs, we have preserved the
  326. * input entropy and done a good job. The fact that an intelligent
  327. * attacker can construct inputs that will produce controlled
  328. * alterations to the pool's state is not important because we don't
  329. * consider such inputs to contribute any randomness. The only
  330. * property we need with respect to them is that the attacker can't
  331. * increase his/her knowledge of the pool's state. Since all
  332. * additions are reversible (knowing the final state and the input,
  333. * you can reconstruct the initial state), if an attacker has any
  334. * uncertainty about the initial state, he/she can only shuffle that
  335. * uncertainty about, but never cause any collisions (which would
  336. * decrease the uncertainty).
  337. *
  338. * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
  339. * Videau in their paper, "The Linux Pseudorandom Number Generator
  340. * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
  341. * paper, they point out that we are not using a true Twisted GFSR,
  342. * since Matsumoto & Kurita used a trinomial feedback polynomial (that
  343. * is, with only three taps, instead of the six that we are using).
  344. * As a result, the resulting polynomial is neither primitive nor
  345. * irreducible, and hence does not have a maximal period over
  346. * GF(2**32). They suggest a slight change to the generator
  347. * polynomial which improves the resulting TGFSR polynomial to be
  348. * irreducible, which we have made here.
  349. */
  350. static struct poolinfo {
  351. int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
  352. #define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
  353. int tap1, tap2, tap3, tap4, tap5;
  354. } poolinfo_table[] = {
  355. /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
  356. /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
  357. { S(128), 104, 76, 51, 25, 1 },
  358. /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
  359. /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
  360. { S(32), 26, 19, 14, 7, 1 },
  361. #if 0
  362. /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
  363. { S(2048), 1638, 1231, 819, 411, 1 },
  364. /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
  365. { S(1024), 817, 615, 412, 204, 1 },
  366. /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
  367. { S(1024), 819, 616, 410, 207, 2 },
  368. /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
  369. { S(512), 411, 308, 208, 104, 1 },
  370. /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
  371. { S(512), 409, 307, 206, 102, 2 },
  372. /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
  373. { S(512), 409, 309, 205, 103, 2 },
  374. /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
  375. { S(256), 205, 155, 101, 52, 1 },
  376. /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
  377. { S(128), 103, 78, 51, 27, 2 },
  378. /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
  379. { S(64), 52, 39, 26, 14, 1 },
  380. #endif
  381. };
  382. /*
  383. * Static global variables
  384. */
  385. static DECLARE_WAIT_QUEUE_HEAD(random_wait);
  386. static struct fasync_struct *fasync;
  387. static DEFINE_SPINLOCK(random_ready_list_lock);
  388. static LIST_HEAD(random_ready_list);
  389. struct crng_state {
  390. __u32 state[16];
  391. unsigned long init_time;
  392. spinlock_t lock;
  393. };
  394. struct crng_state primary_crng = {
  395. .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
  396. };
  397. /*
  398. * crng_init = 0 --> Uninitialized
  399. * 1 --> Initialized
  400. * 2 --> Initialized from input_pool
  401. *
  402. * crng_init is protected by primary_crng->lock, and only increases
  403. * its value (from 0->1->2).
  404. */
  405. static int crng_init = 0;
  406. #define crng_ready() (likely(crng_init > 1))
  407. static int crng_init_cnt = 0;
  408. static unsigned long crng_global_init_time = 0;
  409. #define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
  410. static void _extract_crng(struct crng_state *crng,
  411. __u32 out[CHACHA20_BLOCK_WORDS]);
  412. static void _crng_backtrack_protect(struct crng_state *crng,
  413. __u32 tmp[CHACHA20_BLOCK_WORDS], int used);
  414. static void process_random_ready_list(void);
  415. static void _get_random_bytes(void *buf, int nbytes);
  416. static struct ratelimit_state unseeded_warning =
  417. RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
  418. static struct ratelimit_state urandom_warning =
  419. RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
  420. static int ratelimit_disable __read_mostly;
  421. module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
  422. MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
  423. /**********************************************************************
  424. *
  425. * OS independent entropy store. Here are the functions which handle
  426. * storing entropy in an entropy pool.
  427. *
  428. **********************************************************************/
  429. struct entropy_store;
  430. struct entropy_store {
  431. /* read-only data: */
  432. const struct poolinfo *poolinfo;
  433. __u32 *pool;
  434. const char *name;
  435. struct entropy_store *pull;
  436. struct work_struct push_work;
  437. /* read-write data: */
  438. unsigned long last_pulled;
  439. spinlock_t lock;
  440. unsigned short add_ptr;
  441. unsigned short input_rotate;
  442. int entropy_count;
  443. int entropy_total;
  444. unsigned int initialized:1;
  445. unsigned int last_data_init:1;
  446. __u8 last_data[EXTRACT_SIZE];
  447. };
  448. static ssize_t extract_entropy(struct entropy_store *r, void *buf,
  449. size_t nbytes, int min, int rsvd);
  450. static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
  451. size_t nbytes, int fips);
  452. static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
  453. static void push_to_pool(struct work_struct *work);
  454. static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
  455. static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
  456. static struct entropy_store input_pool = {
  457. .poolinfo = &poolinfo_table[0],
  458. .name = "input",
  459. .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
  460. .pool = input_pool_data
  461. };
  462. static struct entropy_store blocking_pool = {
  463. .poolinfo = &poolinfo_table[1],
  464. .name = "blocking",
  465. .pull = &input_pool,
  466. .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
  467. .pool = blocking_pool_data,
  468. .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
  469. push_to_pool),
  470. };
  471. static __u32 const twist_table[8] = {
  472. 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
  473. 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
  474. /*
  475. * This function adds bytes into the entropy "pool". It does not
  476. * update the entropy estimate. The caller should call
  477. * credit_entropy_bits if this is appropriate.
  478. *
  479. * The pool is stirred with a primitive polynomial of the appropriate
  480. * degree, and then twisted. We twist by three bits at a time because
  481. * it's cheap to do so and helps slightly in the expected case where
  482. * the entropy is concentrated in the low-order bits.
  483. */
  484. static void _mix_pool_bytes(struct entropy_store *r, const void *in,
  485. int nbytes)
  486. {
  487. unsigned long i, tap1, tap2, tap3, tap4, tap5;
  488. int input_rotate;
  489. int wordmask = r->poolinfo->poolwords - 1;
  490. const char *bytes = in;
  491. __u32 w;
  492. tap1 = r->poolinfo->tap1;
  493. tap2 = r->poolinfo->tap2;
  494. tap3 = r->poolinfo->tap3;
  495. tap4 = r->poolinfo->tap4;
  496. tap5 = r->poolinfo->tap5;
  497. input_rotate = r->input_rotate;
  498. i = r->add_ptr;
  499. /* mix one byte at a time to simplify size handling and churn faster */
  500. while (nbytes--) {
  501. w = rol32(*bytes++, input_rotate);
  502. i = (i - 1) & wordmask;
  503. /* XOR in the various taps */
  504. w ^= r->pool[i];
  505. w ^= r->pool[(i + tap1) & wordmask];
  506. w ^= r->pool[(i + tap2) & wordmask];
  507. w ^= r->pool[(i + tap3) & wordmask];
  508. w ^= r->pool[(i + tap4) & wordmask];
  509. w ^= r->pool[(i + tap5) & wordmask];
  510. /* Mix the result back in with a twist */
  511. r->pool[i] = (w >> 3) ^ twist_table[w & 7];
  512. /*
  513. * Normally, we add 7 bits of rotation to the pool.
  514. * At the beginning of the pool, add an extra 7 bits
  515. * rotation, so that successive passes spread the
  516. * input bits across the pool evenly.
  517. */
  518. input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
  519. }
  520. r->input_rotate = input_rotate;
  521. r->add_ptr = i;
  522. }
  523. static void __mix_pool_bytes(struct entropy_store *r, const void *in,
  524. int nbytes)
  525. {
  526. trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
  527. _mix_pool_bytes(r, in, nbytes);
  528. }
  529. static void mix_pool_bytes(struct entropy_store *r, const void *in,
  530. int nbytes)
  531. {
  532. unsigned long flags;
  533. trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
  534. spin_lock_irqsave(&r->lock, flags);
  535. _mix_pool_bytes(r, in, nbytes);
  536. spin_unlock_irqrestore(&r->lock, flags);
  537. }
  538. struct fast_pool {
  539. __u32 pool[4];
  540. unsigned long last;
  541. unsigned short reg_idx;
  542. unsigned char count;
  543. };
  544. /*
  545. * This is a fast mixing routine used by the interrupt randomness
  546. * collector. It's hardcoded for an 128 bit pool and assumes that any
  547. * locks that might be needed are taken by the caller.
  548. */
  549. static void fast_mix(struct fast_pool *f)
  550. {
  551. __u32 a = f->pool[0], b = f->pool[1];
  552. __u32 c = f->pool[2], d = f->pool[3];
  553. a += b; c += d;
  554. b = rol32(b, 6); d = rol32(d, 27);
  555. d ^= a; b ^= c;
  556. a += b; c += d;
  557. b = rol32(b, 16); d = rol32(d, 14);
  558. d ^= a; b ^= c;
  559. a += b; c += d;
  560. b = rol32(b, 6); d = rol32(d, 27);
  561. d ^= a; b ^= c;
  562. a += b; c += d;
  563. b = rol32(b, 16); d = rol32(d, 14);
  564. d ^= a; b ^= c;
  565. f->pool[0] = a; f->pool[1] = b;
  566. f->pool[2] = c; f->pool[3] = d;
  567. f->count++;
  568. }
  569. static void process_random_ready_list(void)
  570. {
  571. unsigned long flags;
  572. struct random_ready_callback *rdy, *tmp;
  573. spin_lock_irqsave(&random_ready_list_lock, flags);
  574. list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
  575. struct module *owner = rdy->owner;
  576. list_del_init(&rdy->list);
  577. rdy->func(rdy);
  578. module_put(owner);
  579. }
  580. spin_unlock_irqrestore(&random_ready_list_lock, flags);
  581. }
  582. /*
  583. * Credit (or debit) the entropy store with n bits of entropy.
  584. * Use credit_entropy_bits_safe() if the value comes from userspace
  585. * or otherwise should be checked for extreme values.
  586. */
  587. static void credit_entropy_bits(struct entropy_store *r, int nbits)
  588. {
  589. int entropy_count, orig;
  590. const int pool_size = r->poolinfo->poolfracbits;
  591. int nfrac = nbits << ENTROPY_SHIFT;
  592. if (!nbits)
  593. return;
  594. retry:
  595. entropy_count = orig = READ_ONCE(r->entropy_count);
  596. if (nfrac < 0) {
  597. /* Debit */
  598. entropy_count += nfrac;
  599. } else {
  600. /*
  601. * Credit: we have to account for the possibility of
  602. * overwriting already present entropy. Even in the
  603. * ideal case of pure Shannon entropy, new contributions
  604. * approach the full value asymptotically:
  605. *
  606. * entropy <- entropy + (pool_size - entropy) *
  607. * (1 - exp(-add_entropy/pool_size))
  608. *
  609. * For add_entropy <= pool_size/2 then
  610. * (1 - exp(-add_entropy/pool_size)) >=
  611. * (add_entropy/pool_size)*0.7869...
  612. * so we can approximate the exponential with
  613. * 3/4*add_entropy/pool_size and still be on the
  614. * safe side by adding at most pool_size/2 at a time.
  615. *
  616. * The use of pool_size-2 in the while statement is to
  617. * prevent rounding artifacts from making the loop
  618. * arbitrarily long; this limits the loop to log2(pool_size)*2
  619. * turns no matter how large nbits is.
  620. */
  621. int pnfrac = nfrac;
  622. const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
  623. /* The +2 corresponds to the /4 in the denominator */
  624. do {
  625. unsigned int anfrac = min(pnfrac, pool_size/2);
  626. unsigned int add =
  627. ((pool_size - entropy_count)*anfrac*3) >> s;
  628. entropy_count += add;
  629. pnfrac -= anfrac;
  630. } while (unlikely(entropy_count < pool_size-2 && pnfrac));
  631. }
  632. if (unlikely(entropy_count < 0)) {
  633. pr_warn("random: negative entropy/overflow: pool %s count %d\n",
  634. r->name, entropy_count);
  635. WARN_ON(1);
  636. entropy_count = 0;
  637. } else if (entropy_count > pool_size)
  638. entropy_count = pool_size;
  639. if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
  640. goto retry;
  641. r->entropy_total += nbits;
  642. if (!r->initialized && r->entropy_total > 128) {
  643. r->initialized = 1;
  644. r->entropy_total = 0;
  645. }
  646. trace_credit_entropy_bits(r->name, nbits,
  647. entropy_count >> ENTROPY_SHIFT,
  648. r->entropy_total, _RET_IP_);
  649. if (r == &input_pool) {
  650. int entropy_bits = entropy_count >> ENTROPY_SHIFT;
  651. if (crng_init < 2 && entropy_bits >= 128) {
  652. crng_reseed(&primary_crng, r);
  653. entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
  654. }
  655. /* should we wake readers? */
  656. if (entropy_bits >= random_read_wakeup_bits &&
  657. wq_has_sleeper(&random_wait)) {
  658. wake_up_interruptible_poll(&random_wait, POLLIN);
  659. kill_fasync(&fasync, SIGIO, POLL_IN);
  660. }
  661. /* If the input pool is getting full, send some
  662. * entropy to the blocking pool until it is 75% full.
  663. */
  664. if (entropy_bits > random_write_wakeup_bits &&
  665. r->initialized &&
  666. r->entropy_total >= 2*random_read_wakeup_bits) {
  667. struct entropy_store *other = &blocking_pool;
  668. if (other->entropy_count <=
  669. 3 * other->poolinfo->poolfracbits / 4) {
  670. schedule_work(&other->push_work);
  671. r->entropy_total = 0;
  672. }
  673. }
  674. }
  675. }
  676. static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
  677. {
  678. const int nbits_max = r->poolinfo->poolwords * 32;
  679. if (nbits < 0)
  680. return -EINVAL;
  681. /* Cap the value to avoid overflows */
  682. nbits = min(nbits, nbits_max);
  683. credit_entropy_bits(r, nbits);
  684. return 0;
  685. }
  686. /*********************************************************************
  687. *
  688. * CRNG using CHACHA20
  689. *
  690. *********************************************************************/
  691. #define CRNG_RESEED_INTERVAL (300*HZ)
  692. static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
  693. #ifdef CONFIG_NUMA
  694. /*
  695. * Hack to deal with crazy userspace progams when they are all trying
  696. * to access /dev/urandom in parallel. The programs are almost
  697. * certainly doing something terribly wrong, but we'll work around
  698. * their brain damage.
  699. */
  700. static struct crng_state **crng_node_pool __read_mostly;
  701. #endif
  702. static void invalidate_batched_entropy(void);
  703. static void crng_initialize(struct crng_state *crng)
  704. {
  705. int i;
  706. unsigned long rv;
  707. memcpy(&crng->state[0], "expand 32-byte k", 16);
  708. if (crng == &primary_crng)
  709. _extract_entropy(&input_pool, &crng->state[4],
  710. sizeof(__u32) * 12, 0);
  711. else
  712. _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
  713. for (i = 4; i < 16; i++) {
  714. if (!arch_get_random_seed_long(&rv) &&
  715. !arch_get_random_long(&rv))
  716. rv = random_get_entropy();
  717. crng->state[i] ^= rv;
  718. }
  719. crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
  720. }
  721. #ifdef CONFIG_NUMA
  722. static void do_numa_crng_init(struct work_struct *work)
  723. {
  724. int i;
  725. struct crng_state *crng;
  726. struct crng_state **pool;
  727. pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
  728. for_each_online_node(i) {
  729. crng = kmalloc_node(sizeof(struct crng_state),
  730. GFP_KERNEL | __GFP_NOFAIL, i);
  731. spin_lock_init(&crng->lock);
  732. crng_initialize(crng);
  733. pool[i] = crng;
  734. }
  735. mb();
  736. if (cmpxchg(&crng_node_pool, NULL, pool)) {
  737. for_each_node(i)
  738. kfree(pool[i]);
  739. kfree(pool);
  740. }
  741. }
  742. static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
  743. static void numa_crng_init(void)
  744. {
  745. schedule_work(&numa_crng_init_work);
  746. }
  747. #else
  748. static void numa_crng_init(void) {}
  749. #endif
  750. /*
  751. * crng_fast_load() can be called by code in the interrupt service
  752. * path. So we can't afford to dilly-dally.
  753. */
  754. static int crng_fast_load(const char *cp, size_t len)
  755. {
  756. unsigned long flags;
  757. char *p;
  758. if (!spin_trylock_irqsave(&primary_crng.lock, flags))
  759. return 0;
  760. if (crng_init != 0) {
  761. spin_unlock_irqrestore(&primary_crng.lock, flags);
  762. return 0;
  763. }
  764. p = (unsigned char *) &primary_crng.state[4];
  765. while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
  766. p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
  767. cp++; crng_init_cnt++; len--;
  768. }
  769. spin_unlock_irqrestore(&primary_crng.lock, flags);
  770. if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
  771. invalidate_batched_entropy();
  772. crng_init = 1;
  773. wake_up_interruptible(&crng_init_wait);
  774. pr_notice("random: fast init done\n");
  775. }
  776. return 1;
  777. }
  778. /*
  779. * crng_slow_load() is called by add_device_randomness, which has two
  780. * attributes. (1) We can't trust the buffer passed to it is
  781. * guaranteed to be unpredictable (so it might not have any entropy at
  782. * all), and (2) it doesn't have the performance constraints of
  783. * crng_fast_load().
  784. *
  785. * So we do something more comprehensive which is guaranteed to touch
  786. * all of the primary_crng's state, and which uses a LFSR with a
  787. * period of 255 as part of the mixing algorithm. Finally, we do
  788. * *not* advance crng_init_cnt since buffer we may get may be something
  789. * like a fixed DMI table (for example), which might very well be
  790. * unique to the machine, but is otherwise unvarying.
  791. */
  792. static int crng_slow_load(const char *cp, size_t len)
  793. {
  794. unsigned long flags;
  795. static unsigned char lfsr = 1;
  796. unsigned char tmp;
  797. unsigned i, max = CHACHA20_KEY_SIZE;
  798. const char * src_buf = cp;
  799. char * dest_buf = (char *) &primary_crng.state[4];
  800. if (!spin_trylock_irqsave(&primary_crng.lock, flags))
  801. return 0;
  802. if (crng_init != 0) {
  803. spin_unlock_irqrestore(&primary_crng.lock, flags);
  804. return 0;
  805. }
  806. if (len > max)
  807. max = len;
  808. for (i = 0; i < max ; i++) {
  809. tmp = lfsr;
  810. lfsr >>= 1;
  811. if (tmp & 1)
  812. lfsr ^= 0xE1;
  813. tmp = dest_buf[i % CHACHA20_KEY_SIZE];
  814. dest_buf[i % CHACHA20_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
  815. lfsr += (tmp << 3) | (tmp >> 5);
  816. }
  817. spin_unlock_irqrestore(&primary_crng.lock, flags);
  818. return 1;
  819. }
  820. static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
  821. {
  822. unsigned long flags;
  823. int i, num;
  824. union {
  825. __u32 block[CHACHA20_BLOCK_WORDS];
  826. __u32 key[8];
  827. } buf;
  828. if (r) {
  829. num = extract_entropy(r, &buf, 32, 16, 0);
  830. if (num == 0)
  831. return;
  832. } else {
  833. _extract_crng(&primary_crng, buf.block);
  834. _crng_backtrack_protect(&primary_crng, buf.block,
  835. CHACHA20_KEY_SIZE);
  836. }
  837. spin_lock_irqsave(&crng->lock, flags);
  838. for (i = 0; i < 8; i++) {
  839. unsigned long rv;
  840. if (!arch_get_random_seed_long(&rv) &&
  841. !arch_get_random_long(&rv))
  842. rv = random_get_entropy();
  843. crng->state[i+4] ^= buf.key[i] ^ rv;
  844. }
  845. memzero_explicit(&buf, sizeof(buf));
  846. crng->init_time = jiffies;
  847. spin_unlock_irqrestore(&crng->lock, flags);
  848. if (crng == &primary_crng && crng_init < 2) {
  849. invalidate_batched_entropy();
  850. numa_crng_init();
  851. crng_init = 2;
  852. process_random_ready_list();
  853. wake_up_interruptible(&crng_init_wait);
  854. pr_notice("random: crng init done\n");
  855. if (unseeded_warning.missed) {
  856. pr_notice("random: %d get_random_xx warning(s) missed "
  857. "due to ratelimiting\n",
  858. unseeded_warning.missed);
  859. unseeded_warning.missed = 0;
  860. }
  861. if (urandom_warning.missed) {
  862. pr_notice("random: %d urandom warning(s) missed "
  863. "due to ratelimiting\n",
  864. urandom_warning.missed);
  865. urandom_warning.missed = 0;
  866. }
  867. }
  868. }
  869. static void _extract_crng(struct crng_state *crng,
  870. __u32 out[CHACHA20_BLOCK_WORDS])
  871. {
  872. unsigned long v, flags;
  873. if (crng_ready() &&
  874. (time_after(crng_global_init_time, crng->init_time) ||
  875. time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
  876. crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
  877. spin_lock_irqsave(&crng->lock, flags);
  878. if (arch_get_random_long(&v))
  879. crng->state[14] ^= v;
  880. chacha20_block(&crng->state[0], out);
  881. if (crng->state[12] == 0)
  882. crng->state[13]++;
  883. spin_unlock_irqrestore(&crng->lock, flags);
  884. }
  885. static void extract_crng(__u32 out[CHACHA20_BLOCK_WORDS])
  886. {
  887. struct crng_state *crng = NULL;
  888. #ifdef CONFIG_NUMA
  889. if (crng_node_pool)
  890. crng = crng_node_pool[numa_node_id()];
  891. if (crng == NULL)
  892. #endif
  893. crng = &primary_crng;
  894. _extract_crng(crng, out);
  895. }
  896. /*
  897. * Use the leftover bytes from the CRNG block output (if there is
  898. * enough) to mutate the CRNG key to provide backtracking protection.
  899. */
  900. static void _crng_backtrack_protect(struct crng_state *crng,
  901. __u32 tmp[CHACHA20_BLOCK_WORDS], int used)
  902. {
  903. unsigned long flags;
  904. __u32 *s, *d;
  905. int i;
  906. used = round_up(used, sizeof(__u32));
  907. if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
  908. extract_crng(tmp);
  909. used = 0;
  910. }
  911. spin_lock_irqsave(&crng->lock, flags);
  912. s = &tmp[used / sizeof(__u32)];
  913. d = &crng->state[4];
  914. for (i=0; i < 8; i++)
  915. *d++ ^= *s++;
  916. spin_unlock_irqrestore(&crng->lock, flags);
  917. }
  918. static void crng_backtrack_protect(__u32 tmp[CHACHA20_BLOCK_WORDS], int used)
  919. {
  920. struct crng_state *crng = NULL;
  921. #ifdef CONFIG_NUMA
  922. if (crng_node_pool)
  923. crng = crng_node_pool[numa_node_id()];
  924. if (crng == NULL)
  925. #endif
  926. crng = &primary_crng;
  927. _crng_backtrack_protect(crng, tmp, used);
  928. }
  929. static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
  930. {
  931. ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
  932. __u32 tmp[CHACHA20_BLOCK_WORDS];
  933. int large_request = (nbytes > 256);
  934. while (nbytes) {
  935. if (large_request && need_resched()) {
  936. if (signal_pending(current)) {
  937. if (ret == 0)
  938. ret = -ERESTARTSYS;
  939. break;
  940. }
  941. schedule();
  942. }
  943. extract_crng(tmp);
  944. i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
  945. if (copy_to_user(buf, tmp, i)) {
  946. ret = -EFAULT;
  947. break;
  948. }
  949. nbytes -= i;
  950. buf += i;
  951. ret += i;
  952. }
  953. crng_backtrack_protect(tmp, i);
  954. /* Wipe data just written to memory */
  955. memzero_explicit(tmp, sizeof(tmp));
  956. return ret;
  957. }
  958. /*********************************************************************
  959. *
  960. * Entropy input management
  961. *
  962. *********************************************************************/
  963. /* There is one of these per entropy source */
  964. struct timer_rand_state {
  965. cycles_t last_time;
  966. long last_delta, last_delta2;
  967. };
  968. #define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
  969. /*
  970. * Add device- or boot-specific data to the input pool to help
  971. * initialize it.
  972. *
  973. * None of this adds any entropy; it is meant to avoid the problem of
  974. * the entropy pool having similar initial state across largely
  975. * identical devices.
  976. */
  977. void add_device_randomness(const void *buf, unsigned int size)
  978. {
  979. unsigned long time = random_get_entropy() ^ jiffies;
  980. unsigned long flags;
  981. if (!crng_ready() && size)
  982. crng_slow_load(buf, size);
  983. trace_add_device_randomness(size, _RET_IP_);
  984. spin_lock_irqsave(&input_pool.lock, flags);
  985. _mix_pool_bytes(&input_pool, buf, size);
  986. _mix_pool_bytes(&input_pool, &time, sizeof(time));
  987. spin_unlock_irqrestore(&input_pool.lock, flags);
  988. }
  989. EXPORT_SYMBOL(add_device_randomness);
  990. static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
  991. /*
  992. * This function adds entropy to the entropy "pool" by using timing
  993. * delays. It uses the timer_rand_state structure to make an estimate
  994. * of how many bits of entropy this call has added to the pool.
  995. *
  996. * The number "num" is also added to the pool - it should somehow describe
  997. * the type of event which just happened. This is currently 0-255 for
  998. * keyboard scan codes, and 256 upwards for interrupts.
  999. *
  1000. */
  1001. static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
  1002. {
  1003. struct entropy_store *r;
  1004. struct {
  1005. long jiffies;
  1006. unsigned cycles;
  1007. unsigned num;
  1008. } sample;
  1009. long delta, delta2, delta3;
  1010. preempt_disable();
  1011. sample.jiffies = jiffies;
  1012. sample.cycles = random_get_entropy();
  1013. sample.num = num;
  1014. r = &input_pool;
  1015. mix_pool_bytes(r, &sample, sizeof(sample));
  1016. /*
  1017. * Calculate number of bits of randomness we probably added.
  1018. * We take into account the first, second and third-order deltas
  1019. * in order to make our estimate.
  1020. */
  1021. delta = sample.jiffies - state->last_time;
  1022. state->last_time = sample.jiffies;
  1023. delta2 = delta - state->last_delta;
  1024. state->last_delta = delta;
  1025. delta3 = delta2 - state->last_delta2;
  1026. state->last_delta2 = delta2;
  1027. if (delta < 0)
  1028. delta = -delta;
  1029. if (delta2 < 0)
  1030. delta2 = -delta2;
  1031. if (delta3 < 0)
  1032. delta3 = -delta3;
  1033. if (delta > delta2)
  1034. delta = delta2;
  1035. if (delta > delta3)
  1036. delta = delta3;
  1037. /*
  1038. * delta is now minimum absolute delta.
  1039. * Round down by 1 bit on general principles,
  1040. * and limit entropy entimate to 12 bits.
  1041. */
  1042. credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
  1043. preempt_enable();
  1044. }
  1045. void add_input_randomness(unsigned int type, unsigned int code,
  1046. unsigned int value)
  1047. {
  1048. static unsigned char last_value;
  1049. /* ignore autorepeat and the like */
  1050. if (value == last_value)
  1051. return;
  1052. last_value = value;
  1053. add_timer_randomness(&input_timer_state,
  1054. (type << 4) ^ code ^ (code >> 4) ^ value);
  1055. trace_add_input_randomness(ENTROPY_BITS(&input_pool));
  1056. }
  1057. EXPORT_SYMBOL_GPL(add_input_randomness);
  1058. static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
  1059. #ifdef ADD_INTERRUPT_BENCH
  1060. static unsigned long avg_cycles, avg_deviation;
  1061. #define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
  1062. #define FIXED_1_2 (1 << (AVG_SHIFT-1))
  1063. static void add_interrupt_bench(cycles_t start)
  1064. {
  1065. long delta = random_get_entropy() - start;
  1066. /* Use a weighted moving average */
  1067. delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
  1068. avg_cycles += delta;
  1069. /* And average deviation */
  1070. delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
  1071. avg_deviation += delta;
  1072. }
  1073. #else
  1074. #define add_interrupt_bench(x)
  1075. #endif
  1076. static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
  1077. {
  1078. __u32 *ptr = (__u32 *) regs;
  1079. unsigned int idx;
  1080. if (regs == NULL)
  1081. return 0;
  1082. idx = READ_ONCE(f->reg_idx);
  1083. if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
  1084. idx = 0;
  1085. ptr += idx++;
  1086. WRITE_ONCE(f->reg_idx, idx);
  1087. return *ptr;
  1088. }
  1089. void add_interrupt_randomness(int irq, int irq_flags)
  1090. {
  1091. struct entropy_store *r;
  1092. struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
  1093. struct pt_regs *regs = get_irq_regs();
  1094. unsigned long now = jiffies;
  1095. cycles_t cycles = random_get_entropy();
  1096. __u32 c_high, j_high;
  1097. __u64 ip;
  1098. unsigned long seed;
  1099. int credit = 0;
  1100. if (cycles == 0)
  1101. cycles = get_reg(fast_pool, regs);
  1102. c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
  1103. j_high = (sizeof(now) > 4) ? now >> 32 : 0;
  1104. fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
  1105. fast_pool->pool[1] ^= now ^ c_high;
  1106. ip = regs ? instruction_pointer(regs) : _RET_IP_;
  1107. fast_pool->pool[2] ^= ip;
  1108. fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
  1109. get_reg(fast_pool, regs);
  1110. fast_mix(fast_pool);
  1111. add_interrupt_bench(cycles);
  1112. if (unlikely(crng_init == 0)) {
  1113. if ((fast_pool->count >= 64) &&
  1114. crng_fast_load((char *) fast_pool->pool,
  1115. sizeof(fast_pool->pool))) {
  1116. fast_pool->count = 0;
  1117. fast_pool->last = now;
  1118. }
  1119. return;
  1120. }
  1121. if ((fast_pool->count < 64) &&
  1122. !time_after(now, fast_pool->last + HZ))
  1123. return;
  1124. r = &input_pool;
  1125. if (!spin_trylock(&r->lock))
  1126. return;
  1127. fast_pool->last = now;
  1128. __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
  1129. /*
  1130. * If we have architectural seed generator, produce a seed and
  1131. * add it to the pool. For the sake of paranoia don't let the
  1132. * architectural seed generator dominate the input from the
  1133. * interrupt noise.
  1134. */
  1135. if (arch_get_random_seed_long(&seed)) {
  1136. __mix_pool_bytes(r, &seed, sizeof(seed));
  1137. credit = 1;
  1138. }
  1139. spin_unlock(&r->lock);
  1140. fast_pool->count = 0;
  1141. /* award one bit for the contents of the fast pool */
  1142. credit_entropy_bits(r, credit + 1);
  1143. }
  1144. EXPORT_SYMBOL_GPL(add_interrupt_randomness);
  1145. #ifdef CONFIG_BLOCK
  1146. void add_disk_randomness(struct gendisk *disk)
  1147. {
  1148. if (!disk || !disk->random)
  1149. return;
  1150. /* first major is 1, so we get >= 0x200 here */
  1151. add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
  1152. trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
  1153. }
  1154. EXPORT_SYMBOL_GPL(add_disk_randomness);
  1155. #endif
  1156. /*********************************************************************
  1157. *
  1158. * Entropy extraction routines
  1159. *
  1160. *********************************************************************/
  1161. /*
  1162. * This utility inline function is responsible for transferring entropy
  1163. * from the primary pool to the secondary extraction pool. We make
  1164. * sure we pull enough for a 'catastrophic reseed'.
  1165. */
  1166. static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
  1167. static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
  1168. {
  1169. if (!r->pull ||
  1170. r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
  1171. r->entropy_count > r->poolinfo->poolfracbits)
  1172. return;
  1173. _xfer_secondary_pool(r, nbytes);
  1174. }
  1175. static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
  1176. {
  1177. __u32 tmp[OUTPUT_POOL_WORDS];
  1178. int bytes = nbytes;
  1179. /* pull at least as much as a wakeup */
  1180. bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
  1181. /* but never more than the buffer size */
  1182. bytes = min_t(int, bytes, sizeof(tmp));
  1183. trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
  1184. ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
  1185. bytes = extract_entropy(r->pull, tmp, bytes,
  1186. random_read_wakeup_bits / 8, 0);
  1187. mix_pool_bytes(r, tmp, bytes);
  1188. credit_entropy_bits(r, bytes*8);
  1189. }
  1190. /*
  1191. * Used as a workqueue function so that when the input pool is getting
  1192. * full, we can "spill over" some entropy to the output pools. That
  1193. * way the output pools can store some of the excess entropy instead
  1194. * of letting it go to waste.
  1195. */
  1196. static void push_to_pool(struct work_struct *work)
  1197. {
  1198. struct entropy_store *r = container_of(work, struct entropy_store,
  1199. push_work);
  1200. BUG_ON(!r);
  1201. _xfer_secondary_pool(r, random_read_wakeup_bits/8);
  1202. trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
  1203. r->pull->entropy_count >> ENTROPY_SHIFT);
  1204. }
  1205. /*
  1206. * This function decides how many bytes to actually take from the
  1207. * given pool, and also debits the entropy count accordingly.
  1208. */
  1209. static size_t account(struct entropy_store *r, size_t nbytes, int min,
  1210. int reserved)
  1211. {
  1212. int entropy_count, orig, have_bytes;
  1213. size_t ibytes, nfrac;
  1214. BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
  1215. /* Can we pull enough? */
  1216. retry:
  1217. entropy_count = orig = READ_ONCE(r->entropy_count);
  1218. ibytes = nbytes;
  1219. /* never pull more than available */
  1220. have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
  1221. if ((have_bytes -= reserved) < 0)
  1222. have_bytes = 0;
  1223. ibytes = min_t(size_t, ibytes, have_bytes);
  1224. if (ibytes < min)
  1225. ibytes = 0;
  1226. if (unlikely(entropy_count < 0)) {
  1227. pr_warn("random: negative entropy count: pool %s count %d\n",
  1228. r->name, entropy_count);
  1229. WARN_ON(1);
  1230. entropy_count = 0;
  1231. }
  1232. nfrac = ibytes << (ENTROPY_SHIFT + 3);
  1233. if ((size_t) entropy_count > nfrac)
  1234. entropy_count -= nfrac;
  1235. else
  1236. entropy_count = 0;
  1237. if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
  1238. goto retry;
  1239. trace_debit_entropy(r->name, 8 * ibytes);
  1240. if (ibytes &&
  1241. (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
  1242. wake_up_interruptible_poll(&random_wait, POLLOUT);
  1243. kill_fasync(&fasync, SIGIO, POLL_OUT);
  1244. }
  1245. return ibytes;
  1246. }
  1247. /*
  1248. * This function does the actual extraction for extract_entropy and
  1249. * extract_entropy_user.
  1250. *
  1251. * Note: we assume that .poolwords is a multiple of 16 words.
  1252. */
  1253. static void extract_buf(struct entropy_store *r, __u8 *out)
  1254. {
  1255. int i;
  1256. union {
  1257. __u32 w[5];
  1258. unsigned long l[LONGS(20)];
  1259. } hash;
  1260. __u32 workspace[SHA_WORKSPACE_WORDS];
  1261. unsigned long flags;
  1262. /*
  1263. * If we have an architectural hardware random number
  1264. * generator, use it for SHA's initial vector
  1265. */
  1266. sha_init(hash.w);
  1267. for (i = 0; i < LONGS(20); i++) {
  1268. unsigned long v;
  1269. if (!arch_get_random_long(&v))
  1270. break;
  1271. hash.l[i] = v;
  1272. }
  1273. /* Generate a hash across the pool, 16 words (512 bits) at a time */
  1274. spin_lock_irqsave(&r->lock, flags);
  1275. for (i = 0; i < r->poolinfo->poolwords; i += 16)
  1276. sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
  1277. /*
  1278. * We mix the hash back into the pool to prevent backtracking
  1279. * attacks (where the attacker knows the state of the pool
  1280. * plus the current outputs, and attempts to find previous
  1281. * ouputs), unless the hash function can be inverted. By
  1282. * mixing at least a SHA1 worth of hash data back, we make
  1283. * brute-forcing the feedback as hard as brute-forcing the
  1284. * hash.
  1285. */
  1286. __mix_pool_bytes(r, hash.w, sizeof(hash.w));
  1287. spin_unlock_irqrestore(&r->lock, flags);
  1288. memzero_explicit(workspace, sizeof(workspace));
  1289. /*
  1290. * In case the hash function has some recognizable output
  1291. * pattern, we fold it in half. Thus, we always feed back
  1292. * twice as much data as we output.
  1293. */
  1294. hash.w[0] ^= hash.w[3];
  1295. hash.w[1] ^= hash.w[4];
  1296. hash.w[2] ^= rol32(hash.w[2], 16);
  1297. memcpy(out, &hash, EXTRACT_SIZE);
  1298. memzero_explicit(&hash, sizeof(hash));
  1299. }
  1300. static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
  1301. size_t nbytes, int fips)
  1302. {
  1303. ssize_t ret = 0, i;
  1304. __u8 tmp[EXTRACT_SIZE];
  1305. unsigned long flags;
  1306. while (nbytes) {
  1307. extract_buf(r, tmp);
  1308. if (fips) {
  1309. spin_lock_irqsave(&r->lock, flags);
  1310. if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
  1311. panic("Hardware RNG duplicated output!\n");
  1312. memcpy(r->last_data, tmp, EXTRACT_SIZE);
  1313. spin_unlock_irqrestore(&r->lock, flags);
  1314. }
  1315. i = min_t(int, nbytes, EXTRACT_SIZE);
  1316. memcpy(buf, tmp, i);
  1317. nbytes -= i;
  1318. buf += i;
  1319. ret += i;
  1320. }
  1321. /* Wipe data just returned from memory */
  1322. memzero_explicit(tmp, sizeof(tmp));
  1323. return ret;
  1324. }
  1325. /*
  1326. * This function extracts randomness from the "entropy pool", and
  1327. * returns it in a buffer.
  1328. *
  1329. * The min parameter specifies the minimum amount we can pull before
  1330. * failing to avoid races that defeat catastrophic reseeding while the
  1331. * reserved parameter indicates how much entropy we must leave in the
  1332. * pool after each pull to avoid starving other readers.
  1333. */
  1334. static ssize_t extract_entropy(struct entropy_store *r, void *buf,
  1335. size_t nbytes, int min, int reserved)
  1336. {
  1337. __u8 tmp[EXTRACT_SIZE];
  1338. unsigned long flags;
  1339. /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
  1340. if (fips_enabled) {
  1341. spin_lock_irqsave(&r->lock, flags);
  1342. if (!r->last_data_init) {
  1343. r->last_data_init = 1;
  1344. spin_unlock_irqrestore(&r->lock, flags);
  1345. trace_extract_entropy(r->name, EXTRACT_SIZE,
  1346. ENTROPY_BITS(r), _RET_IP_);
  1347. xfer_secondary_pool(r, EXTRACT_SIZE);
  1348. extract_buf(r, tmp);
  1349. spin_lock_irqsave(&r->lock, flags);
  1350. memcpy(r->last_data, tmp, EXTRACT_SIZE);
  1351. }
  1352. spin_unlock_irqrestore(&r->lock, flags);
  1353. }
  1354. trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
  1355. xfer_secondary_pool(r, nbytes);
  1356. nbytes = account(r, nbytes, min, reserved);
  1357. return _extract_entropy(r, buf, nbytes, fips_enabled);
  1358. }
  1359. /*
  1360. * This function extracts randomness from the "entropy pool", and
  1361. * returns it in a userspace buffer.
  1362. */
  1363. static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
  1364. size_t nbytes)
  1365. {
  1366. ssize_t ret = 0, i;
  1367. __u8 tmp[EXTRACT_SIZE];
  1368. int large_request = (nbytes > 256);
  1369. trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
  1370. xfer_secondary_pool(r, nbytes);
  1371. nbytes = account(r, nbytes, 0, 0);
  1372. while (nbytes) {
  1373. if (large_request && need_resched()) {
  1374. if (signal_pending(current)) {
  1375. if (ret == 0)
  1376. ret = -ERESTARTSYS;
  1377. break;
  1378. }
  1379. schedule();
  1380. }
  1381. extract_buf(r, tmp);
  1382. i = min_t(int, nbytes, EXTRACT_SIZE);
  1383. if (copy_to_user(buf, tmp, i)) {
  1384. ret = -EFAULT;
  1385. break;
  1386. }
  1387. nbytes -= i;
  1388. buf += i;
  1389. ret += i;
  1390. }
  1391. /* Wipe data just returned from memory */
  1392. memzero_explicit(tmp, sizeof(tmp));
  1393. return ret;
  1394. }
  1395. #define warn_unseeded_randomness(previous) \
  1396. _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
  1397. static void _warn_unseeded_randomness(const char *func_name, void *caller,
  1398. void **previous)
  1399. {
  1400. #ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
  1401. const bool print_once = false;
  1402. #else
  1403. static bool print_once __read_mostly;
  1404. #endif
  1405. if (print_once ||
  1406. crng_ready() ||
  1407. (previous && (caller == READ_ONCE(*previous))))
  1408. return;
  1409. WRITE_ONCE(*previous, caller);
  1410. #ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
  1411. print_once = true;
  1412. #endif
  1413. if (__ratelimit(&unseeded_warning))
  1414. pr_notice("random: %s called from %pS with crng_init=%d\n",
  1415. func_name, caller, crng_init);
  1416. }
  1417. /*
  1418. * This function is the exported kernel interface. It returns some
  1419. * number of good random numbers, suitable for key generation, seeding
  1420. * TCP sequence numbers, etc. It does not rely on the hardware random
  1421. * number generator. For random bytes direct from the hardware RNG
  1422. * (when available), use get_random_bytes_arch(). In order to ensure
  1423. * that the randomness provided by this function is okay, the function
  1424. * wait_for_random_bytes() should be called and return 0 at least once
  1425. * at any point prior.
  1426. */
  1427. static void _get_random_bytes(void *buf, int nbytes)
  1428. {
  1429. __u32 tmp[CHACHA20_BLOCK_WORDS];
  1430. trace_get_random_bytes(nbytes, _RET_IP_);
  1431. while (nbytes >= CHACHA20_BLOCK_SIZE) {
  1432. extract_crng(buf);
  1433. buf += CHACHA20_BLOCK_SIZE;
  1434. nbytes -= CHACHA20_BLOCK_SIZE;
  1435. }
  1436. if (nbytes > 0) {
  1437. extract_crng(tmp);
  1438. memcpy(buf, tmp, nbytes);
  1439. crng_backtrack_protect(tmp, nbytes);
  1440. } else
  1441. crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
  1442. memzero_explicit(tmp, sizeof(tmp));
  1443. }
  1444. void get_random_bytes(void *buf, int nbytes)
  1445. {
  1446. static void *previous;
  1447. warn_unseeded_randomness(&previous);
  1448. _get_random_bytes(buf, nbytes);
  1449. }
  1450. EXPORT_SYMBOL(get_random_bytes);
  1451. /*
  1452. * Wait for the urandom pool to be seeded and thus guaranteed to supply
  1453. * cryptographically secure random numbers. This applies to: the /dev/urandom
  1454. * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
  1455. * family of functions. Using any of these functions without first calling
  1456. * this function forfeits the guarantee of security.
  1457. *
  1458. * Returns: 0 if the urandom pool has been seeded.
  1459. * -ERESTARTSYS if the function was interrupted by a signal.
  1460. */
  1461. int wait_for_random_bytes(void)
  1462. {
  1463. if (likely(crng_ready()))
  1464. return 0;
  1465. return wait_event_interruptible(crng_init_wait, crng_ready());
  1466. }
  1467. EXPORT_SYMBOL(wait_for_random_bytes);
  1468. /*
  1469. * Add a callback function that will be invoked when the nonblocking
  1470. * pool is initialised.
  1471. *
  1472. * returns: 0 if callback is successfully added
  1473. * -EALREADY if pool is already initialised (callback not called)
  1474. * -ENOENT if module for callback is not alive
  1475. */
  1476. int add_random_ready_callback(struct random_ready_callback *rdy)
  1477. {
  1478. struct module *owner;
  1479. unsigned long flags;
  1480. int err = -EALREADY;
  1481. if (crng_ready())
  1482. return err;
  1483. owner = rdy->owner;
  1484. if (!try_module_get(owner))
  1485. return -ENOENT;
  1486. spin_lock_irqsave(&random_ready_list_lock, flags);
  1487. if (crng_ready())
  1488. goto out;
  1489. owner = NULL;
  1490. list_add(&rdy->list, &random_ready_list);
  1491. err = 0;
  1492. out:
  1493. spin_unlock_irqrestore(&random_ready_list_lock, flags);
  1494. module_put(owner);
  1495. return err;
  1496. }
  1497. EXPORT_SYMBOL(add_random_ready_callback);
  1498. /*
  1499. * Delete a previously registered readiness callback function.
  1500. */
  1501. void del_random_ready_callback(struct random_ready_callback *rdy)
  1502. {
  1503. unsigned long flags;
  1504. struct module *owner = NULL;
  1505. spin_lock_irqsave(&random_ready_list_lock, flags);
  1506. if (!list_empty(&rdy->list)) {
  1507. list_del_init(&rdy->list);
  1508. owner = rdy->owner;
  1509. }
  1510. spin_unlock_irqrestore(&random_ready_list_lock, flags);
  1511. module_put(owner);
  1512. }
  1513. EXPORT_SYMBOL(del_random_ready_callback);
  1514. /*
  1515. * This function will use the architecture-specific hardware random
  1516. * number generator if it is available. The arch-specific hw RNG will
  1517. * almost certainly be faster than what we can do in software, but it
  1518. * is impossible to verify that it is implemented securely (as
  1519. * opposed, to, say, the AES encryption of a sequence number using a
  1520. * key known by the NSA). So it's useful if we need the speed, but
  1521. * only if we're willing to trust the hardware manufacturer not to
  1522. * have put in a back door.
  1523. */
  1524. void get_random_bytes_arch(void *buf, int nbytes)
  1525. {
  1526. char *p = buf;
  1527. trace_get_random_bytes_arch(nbytes, _RET_IP_);
  1528. while (nbytes) {
  1529. unsigned long v;
  1530. int chunk = min(nbytes, (int)sizeof(unsigned long));
  1531. if (!arch_get_random_long(&v))
  1532. break;
  1533. memcpy(p, &v, chunk);
  1534. p += chunk;
  1535. nbytes -= chunk;
  1536. }
  1537. if (nbytes)
  1538. get_random_bytes(p, nbytes);
  1539. }
  1540. EXPORT_SYMBOL(get_random_bytes_arch);
  1541. /*
  1542. * init_std_data - initialize pool with system data
  1543. *
  1544. * @r: pool to initialize
  1545. *
  1546. * This function clears the pool's entropy count and mixes some system
  1547. * data into the pool to prepare it for use. The pool is not cleared
  1548. * as that can only decrease the entropy in the pool.
  1549. */
  1550. static void init_std_data(struct entropy_store *r)
  1551. {
  1552. int i;
  1553. ktime_t now = ktime_get_real();
  1554. unsigned long rv;
  1555. r->last_pulled = jiffies;
  1556. mix_pool_bytes(r, &now, sizeof(now));
  1557. for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
  1558. if (!arch_get_random_seed_long(&rv) &&
  1559. !arch_get_random_long(&rv))
  1560. rv = random_get_entropy();
  1561. mix_pool_bytes(r, &rv, sizeof(rv));
  1562. }
  1563. mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
  1564. }
  1565. /*
  1566. * Note that setup_arch() may call add_device_randomness()
  1567. * long before we get here. This allows seeding of the pools
  1568. * with some platform dependent data very early in the boot
  1569. * process. But it limits our options here. We must use
  1570. * statically allocated structures that already have all
  1571. * initializations complete at compile time. We should also
  1572. * take care not to overwrite the precious per platform data
  1573. * we were given.
  1574. */
  1575. static int rand_initialize(void)
  1576. {
  1577. init_std_data(&input_pool);
  1578. init_std_data(&blocking_pool);
  1579. crng_initialize(&primary_crng);
  1580. crng_global_init_time = jiffies;
  1581. if (ratelimit_disable) {
  1582. urandom_warning.interval = 0;
  1583. unseeded_warning.interval = 0;
  1584. }
  1585. return 0;
  1586. }
  1587. early_initcall(rand_initialize);
  1588. #ifdef CONFIG_BLOCK
  1589. void rand_initialize_disk(struct gendisk *disk)
  1590. {
  1591. struct timer_rand_state *state;
  1592. /*
  1593. * If kzalloc returns null, we just won't use that entropy
  1594. * source.
  1595. */
  1596. state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
  1597. if (state) {
  1598. state->last_time = INITIAL_JIFFIES;
  1599. disk->random = state;
  1600. }
  1601. }
  1602. #endif
  1603. static ssize_t
  1604. _random_read(int nonblock, char __user *buf, size_t nbytes)
  1605. {
  1606. ssize_t n;
  1607. if (nbytes == 0)
  1608. return 0;
  1609. nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
  1610. while (1) {
  1611. n = extract_entropy_user(&blocking_pool, buf, nbytes);
  1612. if (n < 0)
  1613. return n;
  1614. trace_random_read(n*8, (nbytes-n)*8,
  1615. ENTROPY_BITS(&blocking_pool),
  1616. ENTROPY_BITS(&input_pool));
  1617. if (n > 0)
  1618. return n;
  1619. /* Pool is (near) empty. Maybe wait and retry. */
  1620. if (nonblock)
  1621. return -EAGAIN;
  1622. wait_event_interruptible(random_wait,
  1623. ENTROPY_BITS(&input_pool) >=
  1624. random_read_wakeup_bits);
  1625. if (signal_pending(current))
  1626. return -ERESTARTSYS;
  1627. }
  1628. }
  1629. static ssize_t
  1630. random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
  1631. {
  1632. return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
  1633. }
  1634. static ssize_t
  1635. urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
  1636. {
  1637. unsigned long flags;
  1638. static int maxwarn = 10;
  1639. int ret;
  1640. if (!crng_ready() && maxwarn > 0) {
  1641. maxwarn--;
  1642. if (__ratelimit(&urandom_warning))
  1643. printk(KERN_NOTICE "random: %s: uninitialized "
  1644. "urandom read (%zd bytes read)\n",
  1645. current->comm, nbytes);
  1646. spin_lock_irqsave(&primary_crng.lock, flags);
  1647. crng_init_cnt = 0;
  1648. spin_unlock_irqrestore(&primary_crng.lock, flags);
  1649. }
  1650. nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
  1651. ret = extract_crng_user(buf, nbytes);
  1652. trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
  1653. return ret;
  1654. }
  1655. static struct wait_queue_head *
  1656. random_get_poll_head(struct file *file, __poll_t events)
  1657. {
  1658. return &random_wait;
  1659. }
  1660. static __poll_t
  1661. random_poll_mask(struct file *file, __poll_t events)
  1662. {
  1663. __poll_t mask = 0;
  1664. if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
  1665. mask |= EPOLLIN | EPOLLRDNORM;
  1666. if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
  1667. mask |= EPOLLOUT | EPOLLWRNORM;
  1668. return mask;
  1669. }
  1670. static int
  1671. write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
  1672. {
  1673. size_t bytes;
  1674. __u32 buf[16];
  1675. const char __user *p = buffer;
  1676. while (count > 0) {
  1677. bytes = min(count, sizeof(buf));
  1678. if (copy_from_user(&buf, p, bytes))
  1679. return -EFAULT;
  1680. count -= bytes;
  1681. p += bytes;
  1682. mix_pool_bytes(r, buf, bytes);
  1683. cond_resched();
  1684. }
  1685. return 0;
  1686. }
  1687. static ssize_t random_write(struct file *file, const char __user *buffer,
  1688. size_t count, loff_t *ppos)
  1689. {
  1690. size_t ret;
  1691. ret = write_pool(&input_pool, buffer, count);
  1692. if (ret)
  1693. return ret;
  1694. return (ssize_t)count;
  1695. }
  1696. static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
  1697. {
  1698. int size, ent_count;
  1699. int __user *p = (int __user *)arg;
  1700. int retval;
  1701. switch (cmd) {
  1702. case RNDGETENTCNT:
  1703. /* inherently racy, no point locking */
  1704. ent_count = ENTROPY_BITS(&input_pool);
  1705. if (put_user(ent_count, p))
  1706. return -EFAULT;
  1707. return 0;
  1708. case RNDADDTOENTCNT:
  1709. if (!capable(CAP_SYS_ADMIN))
  1710. return -EPERM;
  1711. if (get_user(ent_count, p))
  1712. return -EFAULT;
  1713. return credit_entropy_bits_safe(&input_pool, ent_count);
  1714. case RNDADDENTROPY:
  1715. if (!capable(CAP_SYS_ADMIN))
  1716. return -EPERM;
  1717. if (get_user(ent_count, p++))
  1718. return -EFAULT;
  1719. if (ent_count < 0)
  1720. return -EINVAL;
  1721. if (get_user(size, p++))
  1722. return -EFAULT;
  1723. retval = write_pool(&input_pool, (const char __user *)p,
  1724. size);
  1725. if (retval < 0)
  1726. return retval;
  1727. return credit_entropy_bits_safe(&input_pool, ent_count);
  1728. case RNDZAPENTCNT:
  1729. case RNDCLEARPOOL:
  1730. /*
  1731. * Clear the entropy pool counters. We no longer clear
  1732. * the entropy pool, as that's silly.
  1733. */
  1734. if (!capable(CAP_SYS_ADMIN))
  1735. return -EPERM;
  1736. input_pool.entropy_count = 0;
  1737. blocking_pool.entropy_count = 0;
  1738. return 0;
  1739. case RNDRESEEDCRNG:
  1740. if (!capable(CAP_SYS_ADMIN))
  1741. return -EPERM;
  1742. if (crng_init < 2)
  1743. return -ENODATA;
  1744. crng_reseed(&primary_crng, NULL);
  1745. crng_global_init_time = jiffies - 1;
  1746. return 0;
  1747. default:
  1748. return -EINVAL;
  1749. }
  1750. }
  1751. static int random_fasync(int fd, struct file *filp, int on)
  1752. {
  1753. return fasync_helper(fd, filp, on, &fasync);
  1754. }
  1755. const struct file_operations random_fops = {
  1756. .read = random_read,
  1757. .write = random_write,
  1758. .get_poll_head = random_get_poll_head,
  1759. .poll_mask = random_poll_mask,
  1760. .unlocked_ioctl = random_ioctl,
  1761. .fasync = random_fasync,
  1762. .llseek = noop_llseek,
  1763. };
  1764. const struct file_operations urandom_fops = {
  1765. .read = urandom_read,
  1766. .write = random_write,
  1767. .unlocked_ioctl = random_ioctl,
  1768. .fasync = random_fasync,
  1769. .llseek = noop_llseek,
  1770. };
  1771. SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
  1772. unsigned int, flags)
  1773. {
  1774. int ret;
  1775. if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
  1776. return -EINVAL;
  1777. if (count > INT_MAX)
  1778. count = INT_MAX;
  1779. if (flags & GRND_RANDOM)
  1780. return _random_read(flags & GRND_NONBLOCK, buf, count);
  1781. if (!crng_ready()) {
  1782. if (flags & GRND_NONBLOCK)
  1783. return -EAGAIN;
  1784. ret = wait_for_random_bytes();
  1785. if (unlikely(ret))
  1786. return ret;
  1787. }
  1788. return urandom_read(NULL, buf, count, NULL);
  1789. }
  1790. /********************************************************************
  1791. *
  1792. * Sysctl interface
  1793. *
  1794. ********************************************************************/
  1795. #ifdef CONFIG_SYSCTL
  1796. #include <linux/sysctl.h>
  1797. static int min_read_thresh = 8, min_write_thresh;
  1798. static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
  1799. static int max_write_thresh = INPUT_POOL_WORDS * 32;
  1800. static int random_min_urandom_seed = 60;
  1801. static char sysctl_bootid[16];
  1802. /*
  1803. * This function is used to return both the bootid UUID, and random
  1804. * UUID. The difference is in whether table->data is NULL; if it is,
  1805. * then a new UUID is generated and returned to the user.
  1806. *
  1807. * If the user accesses this via the proc interface, the UUID will be
  1808. * returned as an ASCII string in the standard UUID format; if via the
  1809. * sysctl system call, as 16 bytes of binary data.
  1810. */
  1811. static int proc_do_uuid(struct ctl_table *table, int write,
  1812. void __user *buffer, size_t *lenp, loff_t *ppos)
  1813. {
  1814. struct ctl_table fake_table;
  1815. unsigned char buf[64], tmp_uuid[16], *uuid;
  1816. uuid = table->data;
  1817. if (!uuid) {
  1818. uuid = tmp_uuid;
  1819. generate_random_uuid(uuid);
  1820. } else {
  1821. static DEFINE_SPINLOCK(bootid_spinlock);
  1822. spin_lock(&bootid_spinlock);
  1823. if (!uuid[8])
  1824. generate_random_uuid(uuid);
  1825. spin_unlock(&bootid_spinlock);
  1826. }
  1827. sprintf(buf, "%pU", uuid);
  1828. fake_table.data = buf;
  1829. fake_table.maxlen = sizeof(buf);
  1830. return proc_dostring(&fake_table, write, buffer, lenp, ppos);
  1831. }
  1832. /*
  1833. * Return entropy available scaled to integral bits
  1834. */
  1835. static int proc_do_entropy(struct ctl_table *table, int write,
  1836. void __user *buffer, size_t *lenp, loff_t *ppos)
  1837. {
  1838. struct ctl_table fake_table;
  1839. int entropy_count;
  1840. entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
  1841. fake_table.data = &entropy_count;
  1842. fake_table.maxlen = sizeof(entropy_count);
  1843. return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
  1844. }
  1845. static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
  1846. extern struct ctl_table random_table[];
  1847. struct ctl_table random_table[] = {
  1848. {
  1849. .procname = "poolsize",
  1850. .data = &sysctl_poolsize,
  1851. .maxlen = sizeof(int),
  1852. .mode = 0444,
  1853. .proc_handler = proc_dointvec,
  1854. },
  1855. {
  1856. .procname = "entropy_avail",
  1857. .maxlen = sizeof(int),
  1858. .mode = 0444,
  1859. .proc_handler = proc_do_entropy,
  1860. .data = &input_pool.entropy_count,
  1861. },
  1862. {
  1863. .procname = "read_wakeup_threshold",
  1864. .data = &random_read_wakeup_bits,
  1865. .maxlen = sizeof(int),
  1866. .mode = 0644,
  1867. .proc_handler = proc_dointvec_minmax,
  1868. .extra1 = &min_read_thresh,
  1869. .extra2 = &max_read_thresh,
  1870. },
  1871. {
  1872. .procname = "write_wakeup_threshold",
  1873. .data = &random_write_wakeup_bits,
  1874. .maxlen = sizeof(int),
  1875. .mode = 0644,
  1876. .proc_handler = proc_dointvec_minmax,
  1877. .extra1 = &min_write_thresh,
  1878. .extra2 = &max_write_thresh,
  1879. },
  1880. {
  1881. .procname = "urandom_min_reseed_secs",
  1882. .data = &random_min_urandom_seed,
  1883. .maxlen = sizeof(int),
  1884. .mode = 0644,
  1885. .proc_handler = proc_dointvec,
  1886. },
  1887. {
  1888. .procname = "boot_id",
  1889. .data = &sysctl_bootid,
  1890. .maxlen = 16,
  1891. .mode = 0444,
  1892. .proc_handler = proc_do_uuid,
  1893. },
  1894. {
  1895. .procname = "uuid",
  1896. .maxlen = 16,
  1897. .mode = 0444,
  1898. .proc_handler = proc_do_uuid,
  1899. },
  1900. #ifdef ADD_INTERRUPT_BENCH
  1901. {
  1902. .procname = "add_interrupt_avg_cycles",
  1903. .data = &avg_cycles,
  1904. .maxlen = sizeof(avg_cycles),
  1905. .mode = 0444,
  1906. .proc_handler = proc_doulongvec_minmax,
  1907. },
  1908. {
  1909. .procname = "add_interrupt_avg_deviation",
  1910. .data = &avg_deviation,
  1911. .maxlen = sizeof(avg_deviation),
  1912. .mode = 0444,
  1913. .proc_handler = proc_doulongvec_minmax,
  1914. },
  1915. #endif
  1916. { }
  1917. };
  1918. #endif /* CONFIG_SYSCTL */
  1919. struct batched_entropy {
  1920. union {
  1921. u64 entropy_u64[CHACHA20_BLOCK_SIZE / sizeof(u64)];
  1922. u32 entropy_u32[CHACHA20_BLOCK_SIZE / sizeof(u32)];
  1923. };
  1924. unsigned int position;
  1925. };
  1926. static rwlock_t batched_entropy_reset_lock = __RW_LOCK_UNLOCKED(batched_entropy_reset_lock);
  1927. /*
  1928. * Get a random word for internal kernel use only. The quality of the random
  1929. * number is either as good as RDRAND or as good as /dev/urandom, with the
  1930. * goal of being quite fast and not depleting entropy. In order to ensure
  1931. * that the randomness provided by this function is okay, the function
  1932. * wait_for_random_bytes() should be called and return 0 at least once
  1933. * at any point prior.
  1934. */
  1935. static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64);
  1936. u64 get_random_u64(void)
  1937. {
  1938. u64 ret;
  1939. bool use_lock;
  1940. unsigned long flags = 0;
  1941. struct batched_entropy *batch;
  1942. static void *previous;
  1943. #if BITS_PER_LONG == 64
  1944. if (arch_get_random_long((unsigned long *)&ret))
  1945. return ret;
  1946. #else
  1947. if (arch_get_random_long((unsigned long *)&ret) &&
  1948. arch_get_random_long((unsigned long *)&ret + 1))
  1949. return ret;
  1950. #endif
  1951. warn_unseeded_randomness(&previous);
  1952. use_lock = READ_ONCE(crng_init) < 2;
  1953. batch = &get_cpu_var(batched_entropy_u64);
  1954. if (use_lock)
  1955. read_lock_irqsave(&batched_entropy_reset_lock, flags);
  1956. if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
  1957. extract_crng((__u32 *)batch->entropy_u64);
  1958. batch->position = 0;
  1959. }
  1960. ret = batch->entropy_u64[batch->position++];
  1961. if (use_lock)
  1962. read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
  1963. put_cpu_var(batched_entropy_u64);
  1964. return ret;
  1965. }
  1966. EXPORT_SYMBOL(get_random_u64);
  1967. static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32);
  1968. u32 get_random_u32(void)
  1969. {
  1970. u32 ret;
  1971. bool use_lock;
  1972. unsigned long flags = 0;
  1973. struct batched_entropy *batch;
  1974. static void *previous;
  1975. if (arch_get_random_int(&ret))
  1976. return ret;
  1977. warn_unseeded_randomness(&previous);
  1978. use_lock = READ_ONCE(crng_init) < 2;
  1979. batch = &get_cpu_var(batched_entropy_u32);
  1980. if (use_lock)
  1981. read_lock_irqsave(&batched_entropy_reset_lock, flags);
  1982. if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
  1983. extract_crng(batch->entropy_u32);
  1984. batch->position = 0;
  1985. }
  1986. ret = batch->entropy_u32[batch->position++];
  1987. if (use_lock)
  1988. read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
  1989. put_cpu_var(batched_entropy_u32);
  1990. return ret;
  1991. }
  1992. EXPORT_SYMBOL(get_random_u32);
  1993. /* It's important to invalidate all potential batched entropy that might
  1994. * be stored before the crng is initialized, which we can do lazily by
  1995. * simply resetting the counter to zero so that it's re-extracted on the
  1996. * next usage. */
  1997. static void invalidate_batched_entropy(void)
  1998. {
  1999. int cpu;
  2000. unsigned long flags;
  2001. write_lock_irqsave(&batched_entropy_reset_lock, flags);
  2002. for_each_possible_cpu (cpu) {
  2003. per_cpu_ptr(&batched_entropy_u32, cpu)->position = 0;
  2004. per_cpu_ptr(&batched_entropy_u64, cpu)->position = 0;
  2005. }
  2006. write_unlock_irqrestore(&batched_entropy_reset_lock, flags);
  2007. }
  2008. /**
  2009. * randomize_page - Generate a random, page aligned address
  2010. * @start: The smallest acceptable address the caller will take.
  2011. * @range: The size of the area, starting at @start, within which the
  2012. * random address must fall.
  2013. *
  2014. * If @start + @range would overflow, @range is capped.
  2015. *
  2016. * NOTE: Historical use of randomize_range, which this replaces, presumed that
  2017. * @start was already page aligned. We now align it regardless.
  2018. *
  2019. * Return: A page aligned address within [start, start + range). On error,
  2020. * @start is returned.
  2021. */
  2022. unsigned long
  2023. randomize_page(unsigned long start, unsigned long range)
  2024. {
  2025. if (!PAGE_ALIGNED(start)) {
  2026. range -= PAGE_ALIGN(start) - start;
  2027. start = PAGE_ALIGN(start);
  2028. }
  2029. if (start > ULONG_MAX - range)
  2030. range = ULONG_MAX - start;
  2031. range >>= PAGE_SHIFT;
  2032. if (range == 0)
  2033. return start;
  2034. return start + (get_random_long() % range << PAGE_SHIFT);
  2035. }
  2036. /* Interface for in-kernel drivers of true hardware RNGs.
  2037. * Those devices may produce endless random bits and will be throttled
  2038. * when our pool is full.
  2039. */
  2040. void add_hwgenerator_randomness(const char *buffer, size_t count,
  2041. size_t entropy)
  2042. {
  2043. struct entropy_store *poolp = &input_pool;
  2044. if (unlikely(crng_init == 0)) {
  2045. crng_fast_load(buffer, count);
  2046. return;
  2047. }
  2048. /* Suspend writing if we're above the trickle threshold.
  2049. * We'll be woken up again once below random_write_wakeup_thresh,
  2050. * or when the calling thread is about to terminate.
  2051. */
  2052. wait_event_interruptible(random_wait, kthread_should_stop() ||
  2053. ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
  2054. mix_pool_bytes(poolp, buffer, count);
  2055. credit_entropy_bits(poolp, entropy);
  2056. }
  2057. EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);