2 * DRBG: Deterministic Random Bits Generator
3 * Based on NIST Recommended DRBG from NIST SP800-90A with the following
5 * * CTR DRBG with DF with AES-128, AES-192, AES-256 cores
6 * * Hash DRBG with DF with SHA-1, SHA-256, SHA-384, SHA-512 cores
7 * * HMAC DRBG with DF with SHA-1, SHA-256, SHA-384, SHA-512 cores
8 * * with and without prediction resistance
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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
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.)
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
46 * The SP 800-90A DRBG allows the user to specify a personalization string
47 * for initialization as well as an additional information string for each
48 * random number request. The following code fragments show how a caller
49 * uses the kernel crypto API to use the full functionality of the DRBG.
51 * Usage without any additional data
52 * ---------------------------------
53 * struct crypto_rng *drng;
57 * drng = crypto_alloc_rng(drng_name, 0, 0);
58 * err = crypto_rng_get_bytes(drng, &data, DATALEN);
59 * crypto_free_rng(drng);
62 * Usage with personalization string during initialization
63 * -------------------------------------------------------
64 * struct crypto_rng *drng;
67 * struct drbg_string pers;
68 * char personalization[11] = "some-string";
70 * drbg_string_fill(&pers, personalization, strlen(personalization));
71 * drng = crypto_alloc_rng(drng_name, 0, 0);
72 * // The reset completely re-initializes the DRBG with the provided
73 * // personalization string
74 * err = crypto_rng_reset(drng, &personalization, strlen(personalization));
75 * err = crypto_rng_get_bytes(drng, &data, DATALEN);
76 * crypto_free_rng(drng);
79 * Usage with additional information string during random number request
80 * ---------------------------------------------------------------------
81 * struct crypto_rng *drng;
84 * char addtl_string[11] = "some-string";
85 * string drbg_string addtl;
87 * drbg_string_fill(&addtl, addtl_string, strlen(addtl_string));
88 * drng = crypto_alloc_rng(drng_name, 0, 0);
89 * // The following call is a wrapper to crypto_rng_get_bytes() and returns
90 * // the same error codes.
91 * err = crypto_drbg_get_bytes_addtl(drng, &data, DATALEN, &addtl);
92 * crypto_free_rng(drng);
95 * Usage with personalization and additional information strings
96 * -------------------------------------------------------------
97 * Just mix both scenarios above.
100 #include <crypto/drbg.h>
101 #include <linux/kernel.h>
103 /***************************************************************
104 * Backend cipher definitions available to DRBG
105 ***************************************************************/
108 * The order of the DRBG definitions here matter: every DRBG is registered
109 * as stdrng. Each DRBG receives an increasing cra_priority values the later
110 * they are defined in this array (see drbg_fill_array).
112 * HMAC DRBGs are favored over Hash DRBGs over CTR DRBGs, and
113 * the SHA256 / AES 256 over other ciphers. Thus, the favored
114 * DRBGs are the latest entries in this array.
116 static const struct drbg_core drbg_cores[] = {
117 #ifdef CONFIG_CRYPTO_DRBG_CTR
119 .flags = DRBG_CTR | DRBG_STRENGTH128,
120 .statelen = 32, /* 256 bits as defined in 10.2.1 */
121 .blocklen_bytes = 16,
122 .cra_name = "ctr_aes128",
123 .backend_cra_name = "aes",
125 .flags = DRBG_CTR | DRBG_STRENGTH192,
126 .statelen = 40, /* 320 bits as defined in 10.2.1 */
127 .blocklen_bytes = 16,
128 .cra_name = "ctr_aes192",
129 .backend_cra_name = "aes",
131 .flags = DRBG_CTR | DRBG_STRENGTH256,
132 .statelen = 48, /* 384 bits as defined in 10.2.1 */
133 .blocklen_bytes = 16,
134 .cra_name = "ctr_aes256",
135 .backend_cra_name = "aes",
137 #endif /* CONFIG_CRYPTO_DRBG_CTR */
138 #ifdef CONFIG_CRYPTO_DRBG_HASH
140 .flags = DRBG_HASH | DRBG_STRENGTH128,
141 .statelen = 55, /* 440 bits */
142 .blocklen_bytes = 20,
144 .backend_cra_name = "sha1",
146 .flags = DRBG_HASH | DRBG_STRENGTH256,
147 .statelen = 111, /* 888 bits */
148 .blocklen_bytes = 48,
149 .cra_name = "sha384",
150 .backend_cra_name = "sha384",
152 .flags = DRBG_HASH | DRBG_STRENGTH256,
153 .statelen = 111, /* 888 bits */
154 .blocklen_bytes = 64,
155 .cra_name = "sha512",
156 .backend_cra_name = "sha512",
158 .flags = DRBG_HASH | DRBG_STRENGTH256,
159 .statelen = 55, /* 440 bits */
160 .blocklen_bytes = 32,
161 .cra_name = "sha256",
162 .backend_cra_name = "sha256",
164 #endif /* CONFIG_CRYPTO_DRBG_HASH */
165 #ifdef CONFIG_CRYPTO_DRBG_HMAC
167 .flags = DRBG_HMAC | DRBG_STRENGTH128,
168 .statelen = 20, /* block length of cipher */
169 .blocklen_bytes = 20,
170 .cra_name = "hmac_sha1",
171 .backend_cra_name = "hmac(sha1)",
173 .flags = DRBG_HMAC | DRBG_STRENGTH256,
174 .statelen = 48, /* block length of cipher */
175 .blocklen_bytes = 48,
176 .cra_name = "hmac_sha384",
177 .backend_cra_name = "hmac(sha384)",
179 .flags = DRBG_HMAC | DRBG_STRENGTH256,
180 .statelen = 64, /* block length of cipher */
181 .blocklen_bytes = 64,
182 .cra_name = "hmac_sha512",
183 .backend_cra_name = "hmac(sha512)",
185 .flags = DRBG_HMAC | DRBG_STRENGTH256,
186 .statelen = 32, /* block length of cipher */
187 .blocklen_bytes = 32,
188 .cra_name = "hmac_sha256",
189 .backend_cra_name = "hmac(sha256)",
191 #endif /* CONFIG_CRYPTO_DRBG_HMAC */
194 static int drbg_uninstantiate(struct drbg_state *drbg);
196 /******************************************************************
197 * Generic helper functions
198 ******************************************************************/
201 * Return strength of DRBG according to SP800-90A section 8.4
203 * @flags DRBG flags reference
205 * Return: normalized strength in *bytes* value or 32 as default
206 * to counter programming errors
208 static inline unsigned short drbg_sec_strength(drbg_flag_t flags)
210 switch (flags & DRBG_STRENGTH_MASK) {
211 case DRBG_STRENGTH128:
213 case DRBG_STRENGTH192:
215 case DRBG_STRENGTH256:
223 * Convert an integer into a byte representation of this integer.
224 * The byte representation is big-endian
226 * @val value to be converted
227 * @buf buffer holding the converted integer -- caller must ensure that
228 * buffer size is at least 32 bit
230 #if (defined(CONFIG_CRYPTO_DRBG_HASH) || defined(CONFIG_CRYPTO_DRBG_CTR))
231 static inline void drbg_cpu_to_be32(__u32 val, unsigned char *buf)
236 struct s *conversion = (struct s *) buf;
238 conversion->conv = cpu_to_be32(val);
240 #endif /* defined(CONFIG_CRYPTO_DRBG_HASH) || defined(CONFIG_CRYPTO_DRBG_CTR) */
242 /******************************************************************
243 * CTR DRBG callback functions
244 ******************************************************************/
246 #ifdef CONFIG_CRYPTO_DRBG_CTR
247 #define CRYPTO_DRBG_CTR_STRING "CTR "
248 MODULE_ALIAS_CRYPTO("drbg_pr_ctr_aes256");
249 MODULE_ALIAS_CRYPTO("drbg_nopr_ctr_aes256");
250 MODULE_ALIAS_CRYPTO("drbg_pr_ctr_aes192");
251 MODULE_ALIAS_CRYPTO("drbg_nopr_ctr_aes192");
252 MODULE_ALIAS_CRYPTO("drbg_pr_ctr_aes128");
253 MODULE_ALIAS_CRYPTO("drbg_nopr_ctr_aes128");
255 static int drbg_kcapi_sym(struct drbg_state *drbg, const unsigned char *key,
256 unsigned char *outval, const struct drbg_string *in);
257 static int drbg_init_sym_kernel(struct drbg_state *drbg);
258 static int drbg_fini_sym_kernel(struct drbg_state *drbg);
260 /* BCC function for CTR DRBG as defined in 10.4.3 */
261 static int drbg_ctr_bcc(struct drbg_state *drbg,
262 unsigned char *out, const unsigned char *key,
263 struct list_head *in)
266 struct drbg_string *curr = NULL;
267 struct drbg_string data;
270 drbg_string_fill(&data, out, drbg_blocklen(drbg));
272 /* 10.4.3 step 2 / 4 */
273 list_for_each_entry(curr, in, list) {
274 const unsigned char *pos = curr->buf;
275 size_t len = curr->len;
276 /* 10.4.3 step 4.1 */
278 /* 10.4.3 step 4.2 */
279 if (drbg_blocklen(drbg) == cnt) {
281 ret = drbg_kcapi_sym(drbg, key, out, &data);
291 /* 10.4.3 step 4.2 for last block */
293 ret = drbg_kcapi_sym(drbg, key, out, &data);
299 * scratchpad usage: drbg_ctr_update is interlinked with drbg_ctr_df
300 * (and drbg_ctr_bcc, but this function does not need any temporary buffers),
301 * the scratchpad is used as follows:
304 * start: drbg->scratchpad
305 * length: drbg_statelen(drbg) + drbg_blocklen(drbg)
306 * note: the cipher writing into this variable works
307 * blocklen-wise. Now, when the statelen is not a multiple
308 * of blocklen, the generateion loop below "spills over"
309 * by at most blocklen. Thus, we need to give sufficient
312 * start: drbg->scratchpad +
313 * drbg_statelen(drbg) + drbg_blocklen(drbg)
314 * length: drbg_statelen(drbg)
318 * start: df_data + drbg_statelen(drbg)
319 * length: drbg_blocklen(drbg)
321 * start: pad + drbg_blocklen(drbg)
322 * length: drbg_blocklen(drbg)
324 * start: iv + drbg_blocklen(drbg)
325 * length: drbg_satelen(drbg) + drbg_blocklen(drbg)
326 * note: temp is the buffer that the BCC function operates
327 * on. BCC operates blockwise. drbg_statelen(drbg)
328 * is sufficient when the DRBG state length is a multiple
329 * of the block size. For AES192 (and maybe other ciphers)
330 * this is not correct and the length for temp is
331 * insufficient (yes, that also means for such ciphers,
332 * the final output of all BCC rounds are truncated).
333 * Therefore, add drbg_blocklen(drbg) to cover all
337 /* Derivation Function for CTR DRBG as defined in 10.4.2 */
338 static int drbg_ctr_df(struct drbg_state *drbg,
339 unsigned char *df_data, size_t bytes_to_return,
340 struct list_head *seedlist)
343 unsigned char L_N[8];
345 struct drbg_string S1, S2, S4, cipherin;
347 unsigned char *pad = df_data + drbg_statelen(drbg);
348 unsigned char *iv = pad + drbg_blocklen(drbg);
349 unsigned char *temp = iv + drbg_blocklen(drbg);
351 unsigned int templen = 0;
355 const unsigned char *K = (unsigned char *)
356 "\x00\x01\x02\x03\x04\x05\x06\x07"
357 "\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
358 "\x10\x11\x12\x13\x14\x15\x16\x17"
359 "\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f";
361 size_t generated_len = 0;
363 struct drbg_string *seed = NULL;
365 memset(pad, 0, drbg_blocklen(drbg));
366 memset(iv, 0, drbg_blocklen(drbg));
368 /* 10.4.2 step 1 is implicit as we work byte-wise */
371 if ((512/8) < bytes_to_return)
374 /* 10.4.2 step 2 -- calculate the entire length of all input data */
375 list_for_each_entry(seed, seedlist, list)
376 inputlen += seed->len;
377 drbg_cpu_to_be32(inputlen, &L_N[0]);
380 drbg_cpu_to_be32(bytes_to_return, &L_N[4]);
382 /* 10.4.2 step 5: length is L_N, input_string, one byte, padding */
383 padlen = (inputlen + sizeof(L_N) + 1) % (drbg_blocklen(drbg));
384 /* wrap the padlen appropriately */
386 padlen = drbg_blocklen(drbg) - padlen;
388 * pad / padlen contains the 0x80 byte and the following zero bytes.
389 * As the calculated padlen value only covers the number of zero
390 * bytes, this value has to be incremented by one for the 0x80 byte.
395 /* 10.4.2 step 4 -- first fill the linked list and then order it */
396 drbg_string_fill(&S1, iv, drbg_blocklen(drbg));
397 list_add_tail(&S1.list, &bcc_list);
398 drbg_string_fill(&S2, L_N, sizeof(L_N));
399 list_add_tail(&S2.list, &bcc_list);
400 list_splice_tail(seedlist, &bcc_list);
401 drbg_string_fill(&S4, pad, padlen);
402 list_add_tail(&S4.list, &bcc_list);
405 while (templen < (drbg_keylen(drbg) + (drbg_blocklen(drbg)))) {
407 * 10.4.2 step 9.1 - the padding is implicit as the buffer
408 * holds zeros after allocation -- even the increment of i
409 * is irrelevant as the increment remains within length of i
411 drbg_cpu_to_be32(i, iv);
412 /* 10.4.2 step 9.2 -- BCC and concatenation with temp */
413 ret = drbg_ctr_bcc(drbg, temp + templen, K, &bcc_list);
416 /* 10.4.2 step 9.3 */
418 templen += drbg_blocklen(drbg);
422 X = temp + (drbg_keylen(drbg));
423 drbg_string_fill(&cipherin, X, drbg_blocklen(drbg));
425 /* 10.4.2 step 12: overwriting of outval is implemented in next step */
428 while (generated_len < bytes_to_return) {
431 * 10.4.2 step 13.1: the truncation of the key length is
432 * implicit as the key is only drbg_blocklen in size based on
433 * the implementation of the cipher function callback
435 ret = drbg_kcapi_sym(drbg, temp, X, &cipherin);
438 blocklen = (drbg_blocklen(drbg) <
439 (bytes_to_return - generated_len)) ?
440 drbg_blocklen(drbg) :
441 (bytes_to_return - generated_len);
442 /* 10.4.2 step 13.2 and 14 */
443 memcpy(df_data + generated_len, X, blocklen);
444 generated_len += blocklen;
450 memset(iv, 0, drbg_blocklen(drbg));
451 memset(temp, 0, drbg_statelen(drbg) + drbg_blocklen(drbg));
452 memset(pad, 0, drbg_blocklen(drbg));
457 * update function of CTR DRBG as defined in 10.2.1.2
459 * The reseed variable has an enhanced meaning compared to the update
460 * functions of the other DRBGs as follows:
461 * 0 => initial seed from initialization
462 * 1 => reseed via drbg_seed
463 * 2 => first invocation from drbg_ctr_update when addtl is present. In
464 * this case, the df_data scratchpad is not deleted so that it is
465 * available for another calls to prevent calling the DF function
467 * 3 => second invocation from drbg_ctr_update. When the update function
468 * was called with addtl, the df_data memory already contains the
469 * DFed addtl information and we do not need to call DF again.
471 static int drbg_ctr_update(struct drbg_state *drbg, struct list_head *seed,
475 /* 10.2.1.2 step 1 */
476 unsigned char *temp = drbg->scratchpad;
477 unsigned char *df_data = drbg->scratchpad + drbg_statelen(drbg) +
479 unsigned char *temp_p, *df_data_p; /* pointer to iterate over buffers */
480 unsigned int len = 0;
481 struct drbg_string cipherin;
484 memset(df_data, 0, drbg_statelen(drbg));
486 /* 10.2.1.3.2 step 2 and 10.2.1.4.2 step 2 */
488 ret = drbg_ctr_df(drbg, df_data, drbg_statelen(drbg), seed);
493 drbg_string_fill(&cipherin, drbg->V, drbg_blocklen(drbg));
495 * 10.2.1.3.2 steps 2 and 3 are already covered as the allocation
496 * zeroizes all memory during initialization
498 while (len < (drbg_statelen(drbg))) {
499 /* 10.2.1.2 step 2.1 */
500 crypto_inc(drbg->V, drbg_blocklen(drbg));
502 * 10.2.1.2 step 2.2 */
503 ret = drbg_kcapi_sym(drbg, drbg->C, temp + len, &cipherin);
506 /* 10.2.1.2 step 2.3 and 3 */
507 len += drbg_blocklen(drbg);
510 /* 10.2.1.2 step 4 */
513 for (len = 0; len < drbg_statelen(drbg); len++) {
514 *temp_p ^= *df_data_p;
515 df_data_p++; temp_p++;
518 /* 10.2.1.2 step 5 */
519 memcpy(drbg->C, temp, drbg_keylen(drbg));
520 /* 10.2.1.2 step 6 */
521 memcpy(drbg->V, temp + drbg_keylen(drbg), drbg_blocklen(drbg));
525 memset(temp, 0, drbg_statelen(drbg) + drbg_blocklen(drbg));
527 memset(df_data, 0, drbg_statelen(drbg));
532 * scratchpad use: drbg_ctr_update is called independently from
533 * drbg_ctr_extract_bytes. Therefore, the scratchpad is reused
535 /* Generate function of CTR DRBG as defined in 10.2.1.5.2 */
536 static int drbg_ctr_generate(struct drbg_state *drbg,
537 unsigned char *buf, unsigned int buflen,
538 struct list_head *addtl)
542 struct drbg_string data;
544 /* 10.2.1.5.2 step 2 */
545 if (addtl && !list_empty(addtl)) {
546 ret = drbg_ctr_update(drbg, addtl, 2);
551 /* 10.2.1.5.2 step 4.1 */
552 crypto_inc(drbg->V, drbg_blocklen(drbg));
553 drbg_string_fill(&data, drbg->V, drbg_blocklen(drbg));
554 while (len < buflen) {
556 /* 10.2.1.5.2 step 4.2 */
557 ret = drbg_kcapi_sym(drbg, drbg->C, drbg->scratchpad, &data);
562 outlen = (drbg_blocklen(drbg) < (buflen - len)) ?
563 drbg_blocklen(drbg) : (buflen - len);
564 /* 10.2.1.5.2 step 4.3 */
565 memcpy(buf + len, drbg->scratchpad, outlen);
567 /* 10.2.1.5.2 step 6 */
569 crypto_inc(drbg->V, drbg_blocklen(drbg));
572 /* 10.2.1.5.2 step 6 */
573 ret = drbg_ctr_update(drbg, NULL, 3);
578 memset(drbg->scratchpad, 0, drbg_blocklen(drbg));
582 static const struct drbg_state_ops drbg_ctr_ops = {
583 .update = drbg_ctr_update,
584 .generate = drbg_ctr_generate,
585 .crypto_init = drbg_init_sym_kernel,
586 .crypto_fini = drbg_fini_sym_kernel,
588 #endif /* CONFIG_CRYPTO_DRBG_CTR */
590 /******************************************************************
591 * HMAC DRBG callback functions
592 ******************************************************************/
594 #if defined(CONFIG_CRYPTO_DRBG_HASH) || defined(CONFIG_CRYPTO_DRBG_HMAC)
595 static int drbg_kcapi_hash(struct drbg_state *drbg, unsigned char *outval,
596 const struct list_head *in);
597 static void drbg_kcapi_hmacsetkey(struct drbg_state *drbg,
598 const unsigned char *key);
599 static int drbg_init_hash_kernel(struct drbg_state *drbg);
600 static int drbg_fini_hash_kernel(struct drbg_state *drbg);
601 #endif /* (CONFIG_CRYPTO_DRBG_HASH || CONFIG_CRYPTO_DRBG_HMAC) */
603 #ifdef CONFIG_CRYPTO_DRBG_HMAC
604 #define CRYPTO_DRBG_HMAC_STRING "HMAC "
605 MODULE_ALIAS_CRYPTO("drbg_pr_hmac_sha512");
606 MODULE_ALIAS_CRYPTO("drbg_nopr_hmac_sha512");
607 MODULE_ALIAS_CRYPTO("drbg_pr_hmac_sha384");
608 MODULE_ALIAS_CRYPTO("drbg_nopr_hmac_sha384");
609 MODULE_ALIAS_CRYPTO("drbg_pr_hmac_sha256");
610 MODULE_ALIAS_CRYPTO("drbg_nopr_hmac_sha256");
611 MODULE_ALIAS_CRYPTO("drbg_pr_hmac_sha1");
612 MODULE_ALIAS_CRYPTO("drbg_nopr_hmac_sha1");
614 /* update function of HMAC DRBG as defined in 10.1.2.2 */
615 static int drbg_hmac_update(struct drbg_state *drbg, struct list_head *seed,
620 struct drbg_string seed1, seed2, vdata;
622 LIST_HEAD(vdatalist);
625 /* 10.1.2.3 step 2 -- memset(0) of C is implicit with kzalloc */
626 memset(drbg->V, 1, drbg_statelen(drbg));
627 drbg_kcapi_hmacsetkey(drbg, drbg->C);
630 drbg_string_fill(&seed1, drbg->V, drbg_statelen(drbg));
631 list_add_tail(&seed1.list, &seedlist);
632 /* buffer of seed2 will be filled in for loop below with one byte */
633 drbg_string_fill(&seed2, NULL, 1);
634 list_add_tail(&seed2.list, &seedlist);
635 /* input data of seed is allowed to be NULL at this point */
637 list_splice_tail(seed, &seedlist);
639 drbg_string_fill(&vdata, drbg->V, drbg_statelen(drbg));
640 list_add_tail(&vdata.list, &vdatalist);
641 for (i = 2; 0 < i; i--) {
642 /* first round uses 0x0, second 0x1 */
643 unsigned char prefix = DRBG_PREFIX0;
645 prefix = DRBG_PREFIX1;
646 /* 10.1.2.2 step 1 and 4 -- concatenation and HMAC for key */
648 ret = drbg_kcapi_hash(drbg, drbg->C, &seedlist);
651 drbg_kcapi_hmacsetkey(drbg, drbg->C);
653 /* 10.1.2.2 step 2 and 5 -- HMAC for V */
654 ret = drbg_kcapi_hash(drbg, drbg->V, &vdatalist);
658 /* 10.1.2.2 step 3 */
666 /* generate function of HMAC DRBG as defined in 10.1.2.5 */
667 static int drbg_hmac_generate(struct drbg_state *drbg,
670 struct list_head *addtl)
674 struct drbg_string data;
677 /* 10.1.2.5 step 2 */
678 if (addtl && !list_empty(addtl)) {
679 ret = drbg_hmac_update(drbg, addtl, 1);
684 drbg_string_fill(&data, drbg->V, drbg_statelen(drbg));
685 list_add_tail(&data.list, &datalist);
686 while (len < buflen) {
687 unsigned int outlen = 0;
688 /* 10.1.2.5 step 4.1 */
689 ret = drbg_kcapi_hash(drbg, drbg->V, &datalist);
692 outlen = (drbg_blocklen(drbg) < (buflen - len)) ?
693 drbg_blocklen(drbg) : (buflen - len);
695 /* 10.1.2.5 step 4.2 */
696 memcpy(buf + len, drbg->V, outlen);
700 /* 10.1.2.5 step 6 */
701 if (addtl && !list_empty(addtl))
702 ret = drbg_hmac_update(drbg, addtl, 1);
704 ret = drbg_hmac_update(drbg, NULL, 1);
711 static const struct drbg_state_ops drbg_hmac_ops = {
712 .update = drbg_hmac_update,
713 .generate = drbg_hmac_generate,
714 .crypto_init = drbg_init_hash_kernel,
715 .crypto_fini = drbg_fini_hash_kernel,
717 #endif /* CONFIG_CRYPTO_DRBG_HMAC */
719 /******************************************************************
720 * Hash DRBG callback functions
721 ******************************************************************/
723 #ifdef CONFIG_CRYPTO_DRBG_HASH
724 #define CRYPTO_DRBG_HASH_STRING "HASH "
725 MODULE_ALIAS_CRYPTO("drbg_pr_sha512");
726 MODULE_ALIAS_CRYPTO("drbg_nopr_sha512");
727 MODULE_ALIAS_CRYPTO("drbg_pr_sha384");
728 MODULE_ALIAS_CRYPTO("drbg_nopr_sha384");
729 MODULE_ALIAS_CRYPTO("drbg_pr_sha256");
730 MODULE_ALIAS_CRYPTO("drbg_nopr_sha256");
731 MODULE_ALIAS_CRYPTO("drbg_pr_sha1");
732 MODULE_ALIAS_CRYPTO("drbg_nopr_sha1");
737 * @dst buffer to increment
740 static inline void drbg_add_buf(unsigned char *dst, size_t dstlen,
741 const unsigned char *add, size_t addlen)
743 /* implied: dstlen > addlen */
744 unsigned char *dstptr;
745 const unsigned char *addptr;
746 unsigned int remainder = 0;
749 dstptr = dst + (dstlen-1);
750 addptr = add + (addlen-1);
752 remainder += *dstptr + *addptr;
753 *dstptr = remainder & 0xff;
755 len--; dstptr--; addptr--;
757 len = dstlen - addlen;
758 while (len && remainder > 0) {
759 remainder = *dstptr + 1;
760 *dstptr = remainder & 0xff;
767 * scratchpad usage: as drbg_hash_update and drbg_hash_df are used
768 * interlinked, the scratchpad is used as follows:
770 * start: drbg->scratchpad
771 * length: drbg_statelen(drbg)
773 * start: drbg->scratchpad + drbg_statelen(drbg)
774 * length: drbg_blocklen(drbg)
776 * drbg_hash_process_addtl uses the scratchpad, but fully completes
777 * before either of the functions mentioned before are invoked. Therefore,
778 * drbg_hash_process_addtl does not need to be specifically considered.
781 /* Derivation Function for Hash DRBG as defined in 10.4.1 */
782 static int drbg_hash_df(struct drbg_state *drbg,
783 unsigned char *outval, size_t outlen,
784 struct list_head *entropylist)
788 unsigned char input[5];
789 unsigned char *tmp = drbg->scratchpad + drbg_statelen(drbg);
790 struct drbg_string data;
794 drbg_cpu_to_be32((outlen * 8), &input[1]);
796 /* 10.4.1 step 4.1 -- concatenation of data for input into hash */
797 drbg_string_fill(&data, input, 5);
798 list_add(&data.list, entropylist);
801 while (len < outlen) {
803 /* 10.4.1 step 4.1 */
804 ret = drbg_kcapi_hash(drbg, tmp, entropylist);
807 /* 10.4.1 step 4.2 */
809 blocklen = (drbg_blocklen(drbg) < (outlen - len)) ?
810 drbg_blocklen(drbg) : (outlen - len);
811 memcpy(outval + len, tmp, blocklen);
816 memset(tmp, 0, drbg_blocklen(drbg));
820 /* update function for Hash DRBG as defined in 10.1.1.2 / 10.1.1.3 */
821 static int drbg_hash_update(struct drbg_state *drbg, struct list_head *seed,
825 struct drbg_string data1, data2;
827 LIST_HEAD(datalist2);
828 unsigned char *V = drbg->scratchpad;
829 unsigned char prefix = DRBG_PREFIX1;
835 /* 10.1.1.3 step 1 */
836 memcpy(V, drbg->V, drbg_statelen(drbg));
837 drbg_string_fill(&data1, &prefix, 1);
838 list_add_tail(&data1.list, &datalist);
839 drbg_string_fill(&data2, V, drbg_statelen(drbg));
840 list_add_tail(&data2.list, &datalist);
842 list_splice_tail(seed, &datalist);
844 /* 10.1.1.2 / 10.1.1.3 step 2 and 3 */
845 ret = drbg_hash_df(drbg, drbg->V, drbg_statelen(drbg), &datalist);
849 /* 10.1.1.2 / 10.1.1.3 step 4 */
850 prefix = DRBG_PREFIX0;
851 drbg_string_fill(&data1, &prefix, 1);
852 list_add_tail(&data1.list, &datalist2);
853 drbg_string_fill(&data2, drbg->V, drbg_statelen(drbg));
854 list_add_tail(&data2.list, &datalist2);
855 /* 10.1.1.2 / 10.1.1.3 step 4 */
856 ret = drbg_hash_df(drbg, drbg->C, drbg_statelen(drbg), &datalist2);
859 memset(drbg->scratchpad, 0, drbg_statelen(drbg));
863 /* processing of additional information string for Hash DRBG */
864 static int drbg_hash_process_addtl(struct drbg_state *drbg,
865 struct list_head *addtl)
868 struct drbg_string data1, data2;
870 unsigned char prefix = DRBG_PREFIX2;
872 /* 10.1.1.4 step 2 */
873 if (!addtl || list_empty(addtl))
876 /* 10.1.1.4 step 2a */
877 drbg_string_fill(&data1, &prefix, 1);
878 drbg_string_fill(&data2, drbg->V, drbg_statelen(drbg));
879 list_add_tail(&data1.list, &datalist);
880 list_add_tail(&data2.list, &datalist);
881 list_splice_tail(addtl, &datalist);
882 ret = drbg_kcapi_hash(drbg, drbg->scratchpad, &datalist);
886 /* 10.1.1.4 step 2b */
887 drbg_add_buf(drbg->V, drbg_statelen(drbg),
888 drbg->scratchpad, drbg_blocklen(drbg));
891 memset(drbg->scratchpad, 0, drbg_blocklen(drbg));
895 /* Hashgen defined in 10.1.1.4 */
896 static int drbg_hash_hashgen(struct drbg_state *drbg,
902 unsigned char *src = drbg->scratchpad;
903 unsigned char *dst = drbg->scratchpad + drbg_statelen(drbg);
904 struct drbg_string data;
907 /* 10.1.1.4 step hashgen 2 */
908 memcpy(src, drbg->V, drbg_statelen(drbg));
910 drbg_string_fill(&data, src, drbg_statelen(drbg));
911 list_add_tail(&data.list, &datalist);
912 while (len < buflen) {
913 unsigned int outlen = 0;
914 /* 10.1.1.4 step hashgen 4.1 */
915 ret = drbg_kcapi_hash(drbg, dst, &datalist);
920 outlen = (drbg_blocklen(drbg) < (buflen - len)) ?
921 drbg_blocklen(drbg) : (buflen - len);
922 /* 10.1.1.4 step hashgen 4.2 */
923 memcpy(buf + len, dst, outlen);
925 /* 10.1.1.4 hashgen step 4.3 */
927 crypto_inc(src, drbg_statelen(drbg));
931 memset(drbg->scratchpad, 0,
932 (drbg_statelen(drbg) + drbg_blocklen(drbg)));
936 /* generate function for Hash DRBG as defined in 10.1.1.4 */
937 static int drbg_hash_generate(struct drbg_state *drbg,
938 unsigned char *buf, unsigned int buflen,
939 struct list_head *addtl)
944 unsigned char req[8];
947 unsigned char prefix = DRBG_PREFIX3;
948 struct drbg_string data1, data2;
951 /* 10.1.1.4 step 2 */
952 ret = drbg_hash_process_addtl(drbg, addtl);
955 /* 10.1.1.4 step 3 */
956 len = drbg_hash_hashgen(drbg, buf, buflen);
958 /* this is the value H as documented in 10.1.1.4 */
959 /* 10.1.1.4 step 4 */
960 drbg_string_fill(&data1, &prefix, 1);
961 list_add_tail(&data1.list, &datalist);
962 drbg_string_fill(&data2, drbg->V, drbg_statelen(drbg));
963 list_add_tail(&data2.list, &datalist);
964 ret = drbg_kcapi_hash(drbg, drbg->scratchpad, &datalist);
970 /* 10.1.1.4 step 5 */
971 drbg_add_buf(drbg->V, drbg_statelen(drbg),
972 drbg->scratchpad, drbg_blocklen(drbg));
973 drbg_add_buf(drbg->V, drbg_statelen(drbg),
974 drbg->C, drbg_statelen(drbg));
975 u.req_int = cpu_to_be64(drbg->reseed_ctr);
976 drbg_add_buf(drbg->V, drbg_statelen(drbg), u.req, 8);
979 memset(drbg->scratchpad, 0, drbg_blocklen(drbg));
984 * scratchpad usage: as update and generate are used isolated, both
985 * can use the scratchpad
987 static const struct drbg_state_ops drbg_hash_ops = {
988 .update = drbg_hash_update,
989 .generate = drbg_hash_generate,
990 .crypto_init = drbg_init_hash_kernel,
991 .crypto_fini = drbg_fini_hash_kernel,
993 #endif /* CONFIG_CRYPTO_DRBG_HASH */
995 /******************************************************************
996 * Functions common for DRBG implementations
997 ******************************************************************/
999 static inline int __drbg_seed(struct drbg_state *drbg, struct list_head *seed,
1002 int ret = drbg->d_ops->update(drbg, seed, reseed);
1007 drbg->seeded = true;
1008 /* 10.1.1.2 / 10.1.1.3 step 5 */
1009 drbg->reseed_ctr = 1;
1014 static void drbg_async_seed(struct work_struct *work)
1016 struct drbg_string data;
1017 LIST_HEAD(seedlist);
1018 struct drbg_state *drbg = container_of(work, struct drbg_state,
1020 unsigned int entropylen = drbg_sec_strength(drbg->core->flags);
1021 unsigned char entropy[32];
1023 BUG_ON(!entropylen);
1024 BUG_ON(entropylen > sizeof(entropy));
1025 get_random_bytes(entropy, entropylen);
1027 drbg_string_fill(&data, entropy, entropylen);
1028 list_add_tail(&data.list, &seedlist);
1030 mutex_lock(&drbg->drbg_mutex);
1032 /* If nonblocking pool is initialized, deactivate Jitter RNG */
1033 crypto_free_rng(drbg->jent);
1036 /* Set seeded to false so that if __drbg_seed fails the
1037 * next generate call will trigger a reseed.
1039 drbg->seeded = false;
1041 __drbg_seed(drbg, &seedlist, true);
1044 drbg->reseed_threshold = drbg_max_requests(drbg);
1046 mutex_unlock(&drbg->drbg_mutex);
1048 memzero_explicit(entropy, entropylen);
1052 * Seeding or reseeding of the DRBG
1054 * @drbg: DRBG state struct
1055 * @pers: personalization / additional information buffer
1056 * @reseed: 0 for initial seed process, 1 for reseeding
1060 * error value otherwise
1062 static int drbg_seed(struct drbg_state *drbg, struct drbg_string *pers,
1066 unsigned char entropy[((32 + 16) * 2)];
1067 unsigned int entropylen = drbg_sec_strength(drbg->core->flags);
1068 struct drbg_string data1;
1069 LIST_HEAD(seedlist);
1071 /* 9.1 / 9.2 / 9.3.1 step 3 */
1072 if (pers && pers->len > (drbg_max_addtl(drbg))) {
1073 pr_devel("DRBG: personalization string too long %zu\n",
1078 if (list_empty(&drbg->test_data.list)) {
1079 drbg_string_fill(&data1, drbg->test_data.buf,
1080 drbg->test_data.len);
1081 pr_devel("DRBG: using test entropy\n");
1084 * Gather entropy equal to the security strength of the DRBG.
1085 * With a derivation function, a nonce is required in addition
1086 * to the entropy. A nonce must be at least 1/2 of the security
1087 * strength of the DRBG in size. Thus, entropy + nonce is 3/2
1088 * of the strength. The consideration of a nonce is only
1089 * applicable during initial seeding.
1091 BUG_ON(!entropylen);
1093 entropylen = ((entropylen + 1) / 2) * 3;
1094 BUG_ON((entropylen * 2) > sizeof(entropy));
1096 /* Get seed from in-kernel /dev/urandom */
1097 get_random_bytes(entropy, entropylen);
1100 drbg_string_fill(&data1, entropy, entropylen);
1101 pr_devel("DRBG: (re)seeding with %u bytes of entropy\n",
1104 /* Get seed from Jitter RNG */
1105 ret = crypto_rng_get_bytes(drbg->jent,
1106 entropy + entropylen,
1109 pr_devel("DRBG: jent failed with %d\n", ret);
1113 drbg_string_fill(&data1, entropy, entropylen * 2);
1114 pr_devel("DRBG: (re)seeding with %u bytes of entropy\n",
1118 list_add_tail(&data1.list, &seedlist);
1121 * concatenation of entropy with personalization str / addtl input)
1122 * the variable pers is directly handed in by the caller, so check its
1123 * contents whether it is appropriate
1125 if (pers && pers->buf && 0 < pers->len) {
1126 list_add_tail(&pers->list, &seedlist);
1127 pr_devel("DRBG: using personalization string\n");
1131 memset(drbg->V, 0, drbg_statelen(drbg));
1132 memset(drbg->C, 0, drbg_statelen(drbg));
1135 ret = __drbg_seed(drbg, &seedlist, reseed);
1137 memzero_explicit(entropy, entropylen * 2);
1142 /* Free all substructures in a DRBG state without the DRBG state structure */
1143 static inline void drbg_dealloc_state(struct drbg_state *drbg)
1151 kzfree(drbg->scratchpad);
1152 drbg->scratchpad = NULL;
1153 drbg->reseed_ctr = 0;
1159 * Allocate all sub-structures for a DRBG state.
1160 * The DRBG state structure must already be allocated.
1162 static inline int drbg_alloc_state(struct drbg_state *drbg)
1165 unsigned int sb_size = 0;
1167 switch (drbg->core->flags & DRBG_TYPE_MASK) {
1168 #ifdef CONFIG_CRYPTO_DRBG_HMAC
1170 drbg->d_ops = &drbg_hmac_ops;
1172 #endif /* CONFIG_CRYPTO_DRBG_HMAC */
1173 #ifdef CONFIG_CRYPTO_DRBG_HASH
1175 drbg->d_ops = &drbg_hash_ops;
1177 #endif /* CONFIG_CRYPTO_DRBG_HASH */
1178 #ifdef CONFIG_CRYPTO_DRBG_CTR
1180 drbg->d_ops = &drbg_ctr_ops;
1182 #endif /* CONFIG_CRYPTO_DRBG_CTR */
1188 drbg->V = kmalloc(drbg_statelen(drbg), GFP_KERNEL);
1191 drbg->C = kmalloc(drbg_statelen(drbg), GFP_KERNEL);
1194 /* scratchpad is only generated for CTR and Hash */
1195 if (drbg->core->flags & DRBG_HMAC)
1197 else if (drbg->core->flags & DRBG_CTR)
1198 sb_size = drbg_statelen(drbg) + drbg_blocklen(drbg) + /* temp */
1199 drbg_statelen(drbg) + /* df_data */
1200 drbg_blocklen(drbg) + /* pad */
1201 drbg_blocklen(drbg) + /* iv */
1202 drbg_statelen(drbg) + drbg_blocklen(drbg); /* temp */
1204 sb_size = drbg_statelen(drbg) + drbg_blocklen(drbg);
1207 drbg->scratchpad = kzalloc(sb_size, GFP_KERNEL);
1208 if (!drbg->scratchpad)
1215 drbg_dealloc_state(drbg);
1219 /*************************************************************************
1220 * DRBG interface functions
1221 *************************************************************************/
1224 * DRBG generate function as required by SP800-90A - this function
1225 * generates random numbers
1227 * @drbg DRBG state handle
1228 * @buf Buffer where to store the random numbers -- the buffer must already
1229 * be pre-allocated by caller
1230 * @buflen Length of output buffer - this value defines the number of random
1231 * bytes pulled from DRBG
1232 * @addtl Additional input that is mixed into state, may be NULL -- note
1233 * the entropy is pulled by the DRBG internally unconditionally
1234 * as defined in SP800-90A. The additional input is mixed into
1235 * the state in addition to the pulled entropy.
1237 * return: 0 when all bytes are generated; < 0 in case of an error
1239 static int drbg_generate(struct drbg_state *drbg,
1240 unsigned char *buf, unsigned int buflen,
1241 struct drbg_string *addtl)
1244 LIST_HEAD(addtllist);
1247 pr_devel("DRBG: not yet seeded\n");
1250 if (0 == buflen || !buf) {
1251 pr_devel("DRBG: no output buffer provided\n");
1254 if (addtl && NULL == addtl->buf && 0 < addtl->len) {
1255 pr_devel("DRBG: wrong format of additional information\n");
1261 if (buflen > (drbg_max_request_bytes(drbg))) {
1262 pr_devel("DRBG: requested random numbers too large %u\n",
1267 /* 9.3.1 step 3 is implicit with the chosen DRBG */
1270 if (addtl && addtl->len > (drbg_max_addtl(drbg))) {
1271 pr_devel("DRBG: additional information string too long %zu\n",
1275 /* 9.3.1 step 5 is implicit with the chosen DRBG */
1278 * 9.3.1 step 6 and 9 supplemented by 9.3.2 step c is implemented
1279 * here. The spec is a bit convoluted here, we make it simpler.
1281 if (drbg->reseed_threshold < drbg->reseed_ctr)
1282 drbg->seeded = false;
1284 if (drbg->pr || !drbg->seeded) {
1285 pr_devel("DRBG: reseeding before generation (prediction "
1286 "resistance: %s, state %s)\n",
1287 drbg->pr ? "true" : "false",
1288 drbg->seeded ? "seeded" : "unseeded");
1289 /* 9.3.1 steps 7.1 through 7.3 */
1290 len = drbg_seed(drbg, addtl, true);
1293 /* 9.3.1 step 7.4 */
1297 if (addtl && 0 < addtl->len)
1298 list_add_tail(&addtl->list, &addtllist);
1299 /* 9.3.1 step 8 and 10 */
1300 len = drbg->d_ops->generate(drbg, buf, buflen, &addtllist);
1302 /* 10.1.1.4 step 6, 10.1.2.5 step 7, 10.2.1.5.2 step 7 */
1308 * Section 11.3.3 requires to re-perform self tests after some
1309 * generated random numbers. The chosen value after which self
1310 * test is performed is arbitrary, but it should be reasonable.
1311 * However, we do not perform the self tests because of the following
1312 * reasons: it is mathematically impossible that the initial self tests
1313 * were successfully and the following are not. If the initial would
1314 * pass and the following would not, the kernel integrity is violated.
1315 * In this case, the entire kernel operation is questionable and it
1316 * is unlikely that the integrity violation only affects the
1317 * correct operation of the DRBG.
1319 * Albeit the following code is commented out, it is provided in
1320 * case somebody has a need to implement the test of 11.3.3.
1323 if (drbg->reseed_ctr && !(drbg->reseed_ctr % 4096)) {
1325 pr_devel("DRBG: start to perform self test\n");
1326 if (drbg->core->flags & DRBG_HMAC)
1327 err = alg_test("drbg_pr_hmac_sha256",
1328 "drbg_pr_hmac_sha256", 0, 0);
1329 else if (drbg->core->flags & DRBG_CTR)
1330 err = alg_test("drbg_pr_ctr_aes128",
1331 "drbg_pr_ctr_aes128", 0, 0);
1333 err = alg_test("drbg_pr_sha256",
1334 "drbg_pr_sha256", 0, 0);
1336 pr_err("DRBG: periodical self test failed\n");
1338 * uninstantiate implies that from now on, only errors
1339 * are returned when reusing this DRBG cipher handle
1341 drbg_uninstantiate(drbg);
1344 pr_devel("DRBG: self test successful\n");
1350 * All operations were successful, return 0 as mandated by
1351 * the kernel crypto API interface.
1359 * Wrapper around drbg_generate which can pull arbitrary long strings
1360 * from the DRBG without hitting the maximum request limitation.
1362 * Parameters: see drbg_generate
1363 * Return codes: see drbg_generate -- if one drbg_generate request fails,
1364 * the entire drbg_generate_long request fails
1366 static int drbg_generate_long(struct drbg_state *drbg,
1367 unsigned char *buf, unsigned int buflen,
1368 struct drbg_string *addtl)
1370 unsigned int len = 0;
1371 unsigned int slice = 0;
1374 unsigned int chunk = 0;
1375 slice = ((buflen - len) / drbg_max_request_bytes(drbg));
1376 chunk = slice ? drbg_max_request_bytes(drbg) : (buflen - len);
1377 mutex_lock(&drbg->drbg_mutex);
1378 err = drbg_generate(drbg, buf + len, chunk, addtl);
1379 mutex_unlock(&drbg->drbg_mutex);
1383 } while (slice > 0 && (len < buflen));
1387 static void drbg_schedule_async_seed(struct random_ready_callback *rdy)
1389 struct drbg_state *drbg = container_of(rdy, struct drbg_state,
1392 schedule_work(&drbg->seed_work);
1395 static int drbg_prepare_hrng(struct drbg_state *drbg)
1399 /* We do not need an HRNG in test mode. */
1400 if (list_empty(&drbg->test_data.list))
1403 INIT_WORK(&drbg->seed_work, drbg_async_seed);
1405 drbg->random_ready.owner = THIS_MODULE;
1406 drbg->random_ready.func = drbg_schedule_async_seed;
1408 err = add_random_ready_callback(&drbg->random_ready);
1419 drbg->random_ready.func = NULL;
1423 drbg->jent = crypto_alloc_rng("jitterentropy_rng", 0, 0);
1426 * Require frequent reseeds until the seed source is fully
1429 drbg->reseed_threshold = 50;
1435 * DRBG instantiation function as required by SP800-90A - this function
1436 * sets up the DRBG handle, performs the initial seeding and all sanity
1437 * checks required by SP800-90A
1439 * @drbg memory of state -- if NULL, new memory is allocated
1440 * @pers Personalization string that is mixed into state, may be NULL -- note
1441 * the entropy is pulled by the DRBG internally unconditionally
1442 * as defined in SP800-90A. The additional input is mixed into
1443 * the state in addition to the pulled entropy.
1444 * @coreref reference to core
1445 * @pr prediction resistance enabled
1449 * error value otherwise
1451 static int drbg_instantiate(struct drbg_state *drbg, struct drbg_string *pers,
1452 int coreref, bool pr)
1457 pr_devel("DRBG: Initializing DRBG core %d with prediction resistance "
1458 "%s\n", coreref, pr ? "enabled" : "disabled");
1459 mutex_lock(&drbg->drbg_mutex);
1461 /* 9.1 step 1 is implicit with the selected DRBG type */
1464 * 9.1 step 2 is implicit as caller can select prediction resistance
1465 * and the flag is copied into drbg->flags --
1466 * all DRBG types support prediction resistance
1469 /* 9.1 step 4 is implicit in drbg_sec_strength */
1472 drbg->core = &drbg_cores[coreref];
1474 drbg->seeded = false;
1475 drbg->reseed_threshold = drbg_max_requests(drbg);
1477 ret = drbg_alloc_state(drbg);
1482 if (drbg->d_ops->crypto_init(drbg))
1485 ret = drbg_prepare_hrng(drbg);
1487 goto free_everything;
1489 if (IS_ERR(drbg->jent)) {
1490 ret = PTR_ERR(drbg->jent);
1492 if (fips_enabled || ret != -ENOENT)
1493 goto free_everything;
1494 pr_info("DRBG: Continuing without Jitter RNG\n");
1500 ret = drbg_seed(drbg, pers, reseed);
1503 goto free_everything;
1505 mutex_unlock(&drbg->drbg_mutex);
1509 drbg_dealloc_state(drbg);
1511 mutex_unlock(&drbg->drbg_mutex);
1515 mutex_unlock(&drbg->drbg_mutex);
1516 drbg_uninstantiate(drbg);
1521 * DRBG uninstantiate function as required by SP800-90A - this function
1522 * frees all buffers and the DRBG handle
1524 * @drbg DRBG state handle
1529 static int drbg_uninstantiate(struct drbg_state *drbg)
1531 if (drbg->random_ready.func) {
1532 del_random_ready_callback(&drbg->random_ready);
1533 cancel_work_sync(&drbg->seed_work);
1534 crypto_free_rng(drbg->jent);
1539 drbg->d_ops->crypto_fini(drbg);
1540 drbg_dealloc_state(drbg);
1541 /* no scrubbing of test_data -- this shall survive an uninstantiate */
1546 * Helper function for setting the test data in the DRBG
1548 * @drbg DRBG state handle
1550 * @len test data length
1552 static void drbg_kcapi_set_entropy(struct crypto_rng *tfm,
1553 const u8 *data, unsigned int len)
1555 struct drbg_state *drbg = crypto_rng_ctx(tfm);
1557 mutex_lock(&drbg->drbg_mutex);
1558 drbg_string_fill(&drbg->test_data, data, len);
1559 mutex_unlock(&drbg->drbg_mutex);
1562 /***************************************************************
1563 * Kernel crypto API cipher invocations requested by DRBG
1564 ***************************************************************/
1566 #if defined(CONFIG_CRYPTO_DRBG_HASH) || defined(CONFIG_CRYPTO_DRBG_HMAC)
1568 struct shash_desc shash;
1572 static int drbg_init_hash_kernel(struct drbg_state *drbg)
1574 struct sdesc *sdesc;
1575 struct crypto_shash *tfm;
1577 tfm = crypto_alloc_shash(drbg->core->backend_cra_name, 0, 0);
1579 pr_info("DRBG: could not allocate digest TFM handle: %s\n",
1580 drbg->core->backend_cra_name);
1581 return PTR_ERR(tfm);
1583 BUG_ON(drbg_blocklen(drbg) != crypto_shash_digestsize(tfm));
1584 sdesc = kzalloc(sizeof(struct shash_desc) + crypto_shash_descsize(tfm),
1587 crypto_free_shash(tfm);
1591 sdesc->shash.tfm = tfm;
1592 sdesc->shash.flags = 0;
1593 drbg->priv_data = sdesc;
1597 static int drbg_fini_hash_kernel(struct drbg_state *drbg)
1599 struct sdesc *sdesc = (struct sdesc *)drbg->priv_data;
1601 crypto_free_shash(sdesc->shash.tfm);
1604 drbg->priv_data = NULL;
1608 static void drbg_kcapi_hmacsetkey(struct drbg_state *drbg,
1609 const unsigned char *key)
1611 struct sdesc *sdesc = (struct sdesc *)drbg->priv_data;
1613 crypto_shash_setkey(sdesc->shash.tfm, key, drbg_statelen(drbg));
1616 static int drbg_kcapi_hash(struct drbg_state *drbg, unsigned char *outval,
1617 const struct list_head *in)
1619 struct sdesc *sdesc = (struct sdesc *)drbg->priv_data;
1620 struct drbg_string *input = NULL;
1622 crypto_shash_init(&sdesc->shash);
1623 list_for_each_entry(input, in, list)
1624 crypto_shash_update(&sdesc->shash, input->buf, input->len);
1625 return crypto_shash_final(&sdesc->shash, outval);
1627 #endif /* (CONFIG_CRYPTO_DRBG_HASH || CONFIG_CRYPTO_DRBG_HMAC) */
1629 #ifdef CONFIG_CRYPTO_DRBG_CTR
1630 static int drbg_init_sym_kernel(struct drbg_state *drbg)
1633 struct crypto_cipher *tfm;
1635 tfm = crypto_alloc_cipher(drbg->core->backend_cra_name, 0, 0);
1637 pr_info("DRBG: could not allocate cipher TFM handle: %s\n",
1638 drbg->core->backend_cra_name);
1639 return PTR_ERR(tfm);
1641 BUG_ON(drbg_blocklen(drbg) != crypto_cipher_blocksize(tfm));
1642 drbg->priv_data = tfm;
1646 static int drbg_fini_sym_kernel(struct drbg_state *drbg)
1648 struct crypto_cipher *tfm =
1649 (struct crypto_cipher *)drbg->priv_data;
1651 crypto_free_cipher(tfm);
1652 drbg->priv_data = NULL;
1656 static int drbg_kcapi_sym(struct drbg_state *drbg, const unsigned char *key,
1657 unsigned char *outval, const struct drbg_string *in)
1659 struct crypto_cipher *tfm =
1660 (struct crypto_cipher *)drbg->priv_data;
1662 crypto_cipher_setkey(tfm, key, (drbg_keylen(drbg)));
1663 /* there is only component in *in */
1664 BUG_ON(in->len < drbg_blocklen(drbg));
1665 crypto_cipher_encrypt_one(tfm, outval, in->buf);
1668 #endif /* CONFIG_CRYPTO_DRBG_CTR */
1670 /***************************************************************
1671 * Kernel crypto API interface to register DRBG
1672 ***************************************************************/
1675 * Look up the DRBG flags by given kernel crypto API cra_name
1676 * The code uses the drbg_cores definition to do this
1678 * @cra_name kernel crypto API cra_name
1679 * @coreref reference to integer which is filled with the pointer to
1680 * the applicable core
1681 * @pr reference for setting prediction resistance
1685 static inline void drbg_convert_tfm_core(const char *cra_driver_name,
1686 int *coreref, bool *pr)
1693 /* disassemble the names */
1694 if (!memcmp(cra_driver_name, "drbg_nopr_", 10)) {
1697 } else if (!memcmp(cra_driver_name, "drbg_pr_", 8)) {
1703 /* remove the first part */
1704 len = strlen(cra_driver_name) - start;
1705 for (i = 0; ARRAY_SIZE(drbg_cores) > i; i++) {
1706 if (!memcmp(cra_driver_name + start, drbg_cores[i].cra_name,
1714 static int drbg_kcapi_init(struct crypto_tfm *tfm)
1716 struct drbg_state *drbg = crypto_tfm_ctx(tfm);
1718 mutex_init(&drbg->drbg_mutex);
1723 static void drbg_kcapi_cleanup(struct crypto_tfm *tfm)
1725 drbg_uninstantiate(crypto_tfm_ctx(tfm));
1729 * Generate random numbers invoked by the kernel crypto API:
1730 * The API of the kernel crypto API is extended as follows:
1732 * src is additional input supplied to the RNG.
1733 * slen is the length of src.
1734 * dst is the output buffer where random data is to be stored.
1735 * dlen is the length of dst.
1737 static int drbg_kcapi_random(struct crypto_rng *tfm,
1738 const u8 *src, unsigned int slen,
1739 u8 *dst, unsigned int dlen)
1741 struct drbg_state *drbg = crypto_rng_ctx(tfm);
1742 struct drbg_string *addtl = NULL;
1743 struct drbg_string string;
1746 /* linked list variable is now local to allow modification */
1747 drbg_string_fill(&string, src, slen);
1751 return drbg_generate_long(drbg, dst, dlen, addtl);
1755 * Seed the DRBG invoked by the kernel crypto API
1757 static int drbg_kcapi_seed(struct crypto_rng *tfm,
1758 const u8 *seed, unsigned int slen)
1760 struct drbg_state *drbg = crypto_rng_ctx(tfm);
1761 struct crypto_tfm *tfm_base = crypto_rng_tfm(tfm);
1763 struct drbg_string string;
1764 struct drbg_string *seed_string = NULL;
1767 drbg_convert_tfm_core(crypto_tfm_alg_driver_name(tfm_base), &coreref,
1770 drbg_string_fill(&string, seed, slen);
1771 seed_string = &string;
1774 return drbg_instantiate(drbg, seed_string, coreref, pr);
1777 /***************************************************************
1778 * Kernel module: code to load the module
1779 ***************************************************************/
1782 * Tests as defined in 11.3.2 in addition to the cipher tests: testing
1783 * of the error handling.
1785 * Note: testing of failing seed source as defined in 11.3.2 is not applicable
1786 * as seed source of get_random_bytes does not fail.
1788 * Note 2: There is no sensible way of testing the reseed counter
1789 * enforcement, so skip it.
1791 static inline int __init drbg_healthcheck_sanity(void)
1794 #define OUTBUFLEN 16
1795 unsigned char buf[OUTBUFLEN];
1796 struct drbg_state *drbg = NULL;
1801 struct drbg_string addtl;
1802 size_t max_addtllen, max_request_bytes;
1804 /* only perform test in FIPS mode */
1808 #ifdef CONFIG_CRYPTO_DRBG_CTR
1809 drbg_convert_tfm_core("drbg_nopr_ctr_aes128", &coreref, &pr);
1810 #elif defined CONFIG_CRYPTO_DRBG_HASH
1811 drbg_convert_tfm_core("drbg_nopr_sha256", &coreref, &pr);
1813 drbg_convert_tfm_core("drbg_nopr_hmac_sha256", &coreref, &pr);
1816 drbg = kzalloc(sizeof(struct drbg_state), GFP_KERNEL);
1820 mutex_init(&drbg->drbg_mutex);
1823 * if the following tests fail, it is likely that there is a buffer
1824 * overflow as buf is much smaller than the requested or provided
1825 * string lengths -- in case the error handling does not succeed
1826 * we may get an OOPS. And we want to get an OOPS as this is a
1830 /* get a valid instance of DRBG for following tests */
1831 ret = drbg_instantiate(drbg, NULL, coreref, pr);
1836 max_addtllen = drbg_max_addtl(drbg);
1837 max_request_bytes = drbg_max_request_bytes(drbg);
1838 drbg_string_fill(&addtl, buf, max_addtllen + 1);
1839 /* overflow addtllen with additonal info string */
1840 len = drbg_generate(drbg, buf, OUTBUFLEN, &addtl);
1842 /* overflow max_bits */
1843 len = drbg_generate(drbg, buf, (max_request_bytes + 1), NULL);
1845 drbg_uninstantiate(drbg);
1847 /* overflow max addtllen with personalization string */
1848 ret = drbg_instantiate(drbg, &addtl, coreref, pr);
1850 /* all tests passed */
1853 pr_devel("DRBG: Sanity tests for failure code paths successfully "
1856 drbg_uninstantiate(drbg);
1862 static struct rng_alg drbg_algs[22];
1865 * Fill the array drbg_algs used to register the different DRBGs
1866 * with the kernel crypto API. To fill the array, the information
1867 * from drbg_cores[] is used.
1869 static inline void __init drbg_fill_array(struct rng_alg *alg,
1870 const struct drbg_core *core, int pr)
1873 static int priority = 200;
1875 memcpy(alg->base.cra_name, "stdrng", 6);
1877 memcpy(alg->base.cra_driver_name, "drbg_pr_", 8);
1880 memcpy(alg->base.cra_driver_name, "drbg_nopr_", 10);
1883 memcpy(alg->base.cra_driver_name + pos, core->cra_name,
1884 strlen(core->cra_name));
1886 alg->base.cra_priority = priority;
1889 * If FIPS mode enabled, the selected DRBG shall have the
1890 * highest cra_priority over other stdrng instances to ensure
1894 alg->base.cra_priority += 200;
1896 alg->base.cra_ctxsize = sizeof(struct drbg_state);
1897 alg->base.cra_module = THIS_MODULE;
1898 alg->base.cra_init = drbg_kcapi_init;
1899 alg->base.cra_exit = drbg_kcapi_cleanup;
1900 alg->generate = drbg_kcapi_random;
1901 alg->seed = drbg_kcapi_seed;
1902 alg->set_ent = drbg_kcapi_set_entropy;
1906 static int __init drbg_init(void)
1908 unsigned int i = 0; /* pointer to drbg_algs */
1909 unsigned int j = 0; /* pointer to drbg_cores */
1912 ret = drbg_healthcheck_sanity();
1916 if (ARRAY_SIZE(drbg_cores) * 2 > ARRAY_SIZE(drbg_algs)) {
1917 pr_info("DRBG: Cannot register all DRBG types"
1918 "(slots needed: %zu, slots available: %zu)\n",
1919 ARRAY_SIZE(drbg_cores) * 2, ARRAY_SIZE(drbg_algs));
1924 * each DRBG definition can be used with PR and without PR, thus
1925 * we instantiate each DRBG in drbg_cores[] twice.
1927 * As the order of placing them into the drbg_algs array matters
1928 * (the later DRBGs receive a higher cra_priority) we register the
1929 * prediction resistance DRBGs first as the should not be too
1932 for (j = 0; ARRAY_SIZE(drbg_cores) > j; j++, i++)
1933 drbg_fill_array(&drbg_algs[i], &drbg_cores[j], 1);
1934 for (j = 0; ARRAY_SIZE(drbg_cores) > j; j++, i++)
1935 drbg_fill_array(&drbg_algs[i], &drbg_cores[j], 0);
1936 return crypto_register_rngs(drbg_algs, (ARRAY_SIZE(drbg_cores) * 2));
1939 static void __exit drbg_exit(void)
1941 crypto_unregister_rngs(drbg_algs, (ARRAY_SIZE(drbg_cores) * 2));
1944 module_init(drbg_init);
1945 module_exit(drbg_exit);
1946 #ifndef CRYPTO_DRBG_HASH_STRING
1947 #define CRYPTO_DRBG_HASH_STRING ""
1949 #ifndef CRYPTO_DRBG_HMAC_STRING
1950 #define CRYPTO_DRBG_HMAC_STRING ""
1952 #ifndef CRYPTO_DRBG_CTR_STRING
1953 #define CRYPTO_DRBG_CTR_STRING ""
1955 MODULE_LICENSE("GPL");
1957 MODULE_DESCRIPTION("NIST SP800-90A Deterministic Random Bit Generator (DRBG) "
1958 "using following cores: "
1959 CRYPTO_DRBG_HASH_STRING
1960 CRYPTO_DRBG_HMAC_STRING
1961 CRYPTO_DRBG_CTR_STRING);
1962 MODULE_ALIAS_CRYPTO("stdrng");