2 * Copyright (C) 2005,2006,2007,2008 IBM Corporation
5 * Mimi Zohar <zohar@us.ibm.com>
6 * Kylene Hall <kjhall@us.ibm.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, version 2 of the License.
13 * Calculates md5/sha1 file hash, template hash, boot-aggreate hash
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 #include <linux/kernel.h>
19 #include <linux/moduleparam.h>
20 #include <linux/ratelimit.h>
21 #include <linux/file.h>
22 #include <linux/crypto.h>
23 #include <linux/scatterlist.h>
24 #include <linux/err.h>
25 #include <linux/slab.h>
26 #include <crypto/hash.h>
30 struct ahash_completion
{
31 struct completion completion
;
35 /* minimum file size for ahash use */
36 static unsigned long ima_ahash_minsize
;
37 module_param_named(ahash_minsize
, ima_ahash_minsize
, ulong
, 0644);
38 MODULE_PARM_DESC(ahash_minsize
, "Minimum file size for ahash use");
40 /* default is 0 - 1 page. */
41 static int ima_maxorder
;
42 static unsigned int ima_bufsize
= PAGE_SIZE
;
44 static int param_set_bufsize(const char *val
, const struct kernel_param
*kp
)
46 unsigned long long size
;
49 size
= memparse(val
, NULL
);
50 order
= get_order(size
);
51 if (order
>= MAX_ORDER
)
54 ima_bufsize
= PAGE_SIZE
<< order
;
58 static const struct kernel_param_ops param_ops_bufsize
= {
59 .set
= param_set_bufsize
,
60 .get
= param_get_uint
,
62 #define param_check_bufsize(name, p) __param_check(name, p, unsigned int)
64 module_param_named(ahash_bufsize
, ima_bufsize
, bufsize
, 0644);
65 MODULE_PARM_DESC(ahash_bufsize
, "Maximum ahash buffer size");
67 static struct crypto_shash
*ima_shash_tfm
;
68 static struct crypto_ahash
*ima_ahash_tfm
;
70 int __init
ima_init_crypto(void)
74 ima_shash_tfm
= crypto_alloc_shash(hash_algo_name
[ima_hash_algo
], 0, 0);
75 if (IS_ERR(ima_shash_tfm
)) {
76 rc
= PTR_ERR(ima_shash_tfm
);
77 pr_err("Can not allocate %s (reason: %ld)\n",
78 hash_algo_name
[ima_hash_algo
], rc
);
81 pr_info("Allocated hash algorithm: %s\n",
82 hash_algo_name
[ima_hash_algo
]);
86 static struct crypto_shash
*ima_alloc_tfm(enum hash_algo algo
)
88 struct crypto_shash
*tfm
= ima_shash_tfm
;
91 if (algo
< 0 || algo
>= HASH_ALGO__LAST
)
94 if (algo
!= ima_hash_algo
) {
95 tfm
= crypto_alloc_shash(hash_algo_name
[algo
], 0, 0);
98 pr_err("Can not allocate %s (reason: %d)\n",
99 hash_algo_name
[algo
], rc
);
105 static void ima_free_tfm(struct crypto_shash
*tfm
)
107 if (tfm
!= ima_shash_tfm
)
108 crypto_free_shash(tfm
);
112 * ima_alloc_pages() - Allocate contiguous pages.
113 * @max_size: Maximum amount of memory to allocate.
114 * @allocated_size: Returned size of actual allocation.
115 * @last_warn: Should the min_size allocation warn or not.
117 * Tries to do opportunistic allocation for memory first trying to allocate
118 * max_size amount of memory and then splitting that until zero order is
119 * reached. Allocation is tried without generating allocation warnings unless
120 * last_warn is set. Last_warn set affects only last allocation of zero order.
122 * By default, ima_maxorder is 0 and it is equivalent to kmalloc(GFP_KERNEL)
124 * Return pointer to allocated memory, or NULL on failure.
126 static void *ima_alloc_pages(loff_t max_size
, size_t *allocated_size
,
130 int order
= ima_maxorder
;
131 gfp_t gfp_mask
= __GFP_RECLAIM
| __GFP_NOWARN
| __GFP_NORETRY
;
134 order
= min(get_order(max_size
), order
);
136 for (; order
; order
--) {
137 ptr
= (void *)__get_free_pages(gfp_mask
, order
);
139 *allocated_size
= PAGE_SIZE
<< order
;
144 /* order is zero - one page */
146 gfp_mask
= GFP_KERNEL
;
149 gfp_mask
|= __GFP_NOWARN
;
151 ptr
= (void *)__get_free_pages(gfp_mask
, 0);
153 *allocated_size
= PAGE_SIZE
;
162 * ima_free_pages() - Free pages allocated by ima_alloc_pages().
163 * @ptr: Pointer to allocated pages.
164 * @size: Size of allocated buffer.
166 static void ima_free_pages(void *ptr
, size_t size
)
170 free_pages((unsigned long)ptr
, get_order(size
));
173 static struct crypto_ahash
*ima_alloc_atfm(enum hash_algo algo
)
175 struct crypto_ahash
*tfm
= ima_ahash_tfm
;
178 if (algo
< 0 || algo
>= HASH_ALGO__LAST
)
179 algo
= ima_hash_algo
;
181 if (algo
!= ima_hash_algo
|| !tfm
) {
182 tfm
= crypto_alloc_ahash(hash_algo_name
[algo
], 0, 0);
184 if (algo
== ima_hash_algo
)
188 pr_err("Can not allocate %s (reason: %d)\n",
189 hash_algo_name
[algo
], rc
);
195 static void ima_free_atfm(struct crypto_ahash
*tfm
)
197 if (tfm
!= ima_ahash_tfm
)
198 crypto_free_ahash(tfm
);
201 static void ahash_complete(struct crypto_async_request
*req
, int err
)
203 struct ahash_completion
*res
= req
->data
;
205 if (err
== -EINPROGRESS
)
208 complete(&res
->completion
);
211 static int ahash_wait(int err
, struct ahash_completion
*res
)
218 wait_for_completion(&res
->completion
);
219 reinit_completion(&res
->completion
);
223 pr_crit_ratelimited("ahash calculation failed: err: %d\n", err
);
229 static int ima_calc_file_hash_atfm(struct file
*file
,
230 struct ima_digest_data
*hash
,
231 struct crypto_ahash
*tfm
)
233 loff_t i_size
, offset
;
234 char *rbuf
[2] = { NULL
, };
235 int rc
, read
= 0, rbuf_len
, active
= 0, ahash_rc
= 0;
236 struct ahash_request
*req
;
237 struct scatterlist sg
[1];
238 struct ahash_completion res
;
241 hash
->length
= crypto_ahash_digestsize(tfm
);
243 req
= ahash_request_alloc(tfm
, GFP_KERNEL
);
247 init_completion(&res
.completion
);
248 ahash_request_set_callback(req
, CRYPTO_TFM_REQ_MAY_BACKLOG
|
249 CRYPTO_TFM_REQ_MAY_SLEEP
,
250 ahash_complete
, &res
);
252 rc
= ahash_wait(crypto_ahash_init(req
), &res
);
256 i_size
= i_size_read(file_inode(file
));
262 * Try to allocate maximum size of memory.
263 * Fail if even a single page cannot be allocated.
265 rbuf
[0] = ima_alloc_pages(i_size
, &rbuf_size
[0], 1);
271 /* Only allocate one buffer if that is enough. */
272 if (i_size
> rbuf_size
[0]) {
274 * Try to allocate secondary buffer. If that fails fallback to
275 * using single buffering. Use previous memory allocation size
276 * as baseline for possible allocation size.
278 rbuf
[1] = ima_alloc_pages(i_size
- rbuf_size
[0],
282 if (!(file
->f_mode
& FMODE_READ
)) {
283 file
->f_mode
|= FMODE_READ
;
287 for (offset
= 0; offset
< i_size
; offset
+= rbuf_len
) {
288 if (!rbuf
[1] && offset
) {
289 /* Not using two buffers, and it is not the first
290 * read/request, wait for the completion of the
291 * previous ahash_update() request.
293 rc
= ahash_wait(ahash_rc
, &res
);
298 rbuf_len
= min_t(loff_t
, i_size
- offset
, rbuf_size
[active
]);
299 rc
= integrity_kernel_read(file
, offset
, rbuf
[active
],
301 if (rc
!= rbuf_len
) {
307 if (rbuf
[1] && offset
) {
308 /* Using two buffers, and it is not the first
309 * read/request, wait for the completion of the
310 * previous ahash_update() request.
312 rc
= ahash_wait(ahash_rc
, &res
);
317 sg_init_one(&sg
[0], rbuf
[active
], rbuf_len
);
318 ahash_request_set_crypt(req
, sg
, NULL
, rbuf_len
);
320 ahash_rc
= crypto_ahash_update(req
);
323 active
= !active
; /* swap buffers, if we use two */
325 /* wait for the last update request to complete */
326 rc
= ahash_wait(ahash_rc
, &res
);
329 file
->f_mode
&= ~FMODE_READ
;
330 ima_free_pages(rbuf
[0], rbuf_size
[0]);
331 ima_free_pages(rbuf
[1], rbuf_size
[1]);
334 ahash_request_set_crypt(req
, NULL
, hash
->digest
, 0);
335 rc
= ahash_wait(crypto_ahash_final(req
), &res
);
338 ahash_request_free(req
);
342 static int ima_calc_file_ahash(struct file
*file
, struct ima_digest_data
*hash
)
344 struct crypto_ahash
*tfm
;
347 tfm
= ima_alloc_atfm(hash
->algo
);
351 rc
= ima_calc_file_hash_atfm(file
, hash
, tfm
);
358 static int ima_calc_file_hash_tfm(struct file
*file
,
359 struct ima_digest_data
*hash
,
360 struct crypto_shash
*tfm
)
362 loff_t i_size
, offset
= 0;
365 SHASH_DESC_ON_STACK(shash
, tfm
);
370 hash
->length
= crypto_shash_digestsize(tfm
);
372 rc
= crypto_shash_init(shash
);
376 i_size
= i_size_read(file_inode(file
));
381 rbuf
= kzalloc(PAGE_SIZE
, GFP_KERNEL
);
385 if (!(file
->f_mode
& FMODE_READ
)) {
386 file
->f_mode
|= FMODE_READ
;
390 while (offset
< i_size
) {
393 rbuf_len
= integrity_kernel_read(file
, offset
, rbuf
, PAGE_SIZE
);
402 rc
= crypto_shash_update(shash
, rbuf
, rbuf_len
);
407 file
->f_mode
&= ~FMODE_READ
;
411 rc
= crypto_shash_final(shash
, hash
->digest
);
415 static int ima_calc_file_shash(struct file
*file
, struct ima_digest_data
*hash
)
417 struct crypto_shash
*tfm
;
420 tfm
= ima_alloc_tfm(hash
->algo
);
424 rc
= ima_calc_file_hash_tfm(file
, hash
, tfm
);
432 * ima_calc_file_hash - calculate file hash
434 * Asynchronous hash (ahash) allows using HW acceleration for calculating
435 * a hash. ahash performance varies for different data sizes on different
436 * crypto accelerators. shash performance might be better for smaller files.
437 * The 'ima.ahash_minsize' module parameter allows specifying the best
438 * minimum file size for using ahash on the system.
440 * If the ima.ahash_minsize parameter is not specified, this function uses
441 * shash for the hash calculation. If ahash fails, it falls back to using
444 int ima_calc_file_hash(struct file
*file
, struct ima_digest_data
*hash
)
450 * For consistency, fail file's opened with the O_DIRECT flag on
451 * filesystems mounted with/without DAX option.
453 if (file
->f_flags
& O_DIRECT
) {
454 hash
->length
= hash_digest_size
[ima_hash_algo
];
455 hash
->algo
= ima_hash_algo
;
459 i_size
= i_size_read(file_inode(file
));
461 if (ima_ahash_minsize
&& i_size
>= ima_ahash_minsize
) {
462 rc
= ima_calc_file_ahash(file
, hash
);
467 return ima_calc_file_shash(file
, hash
);
471 * Calculate the hash of template data
473 static int ima_calc_field_array_hash_tfm(struct ima_field_data
*field_data
,
474 struct ima_template_desc
*td
,
476 struct ima_digest_data
*hash
,
477 struct crypto_shash
*tfm
)
479 SHASH_DESC_ON_STACK(shash
, tfm
);
485 hash
->length
= crypto_shash_digestsize(tfm
);
487 rc
= crypto_shash_init(shash
);
491 for (i
= 0; i
< num_fields
; i
++) {
492 u8 buffer
[IMA_EVENT_NAME_LEN_MAX
+ 1] = { 0 };
493 u8
*data_to_hash
= field_data
[i
].data
;
494 u32 datalen
= field_data
[i
].len
;
496 if (strcmp(td
->name
, IMA_TEMPLATE_IMA_NAME
) != 0) {
497 rc
= crypto_shash_update(shash
,
498 (const u8
*) &field_data
[i
].len
,
499 sizeof(field_data
[i
].len
));
502 } else if (strcmp(td
->fields
[i
]->field_id
, "n") == 0) {
503 memcpy(buffer
, data_to_hash
, datalen
);
504 data_to_hash
= buffer
;
505 datalen
= IMA_EVENT_NAME_LEN_MAX
+ 1;
507 rc
= crypto_shash_update(shash
, data_to_hash
, datalen
);
513 rc
= crypto_shash_final(shash
, hash
->digest
);
518 int ima_calc_field_array_hash(struct ima_field_data
*field_data
,
519 struct ima_template_desc
*desc
, int num_fields
,
520 struct ima_digest_data
*hash
)
522 struct crypto_shash
*tfm
;
525 tfm
= ima_alloc_tfm(hash
->algo
);
529 rc
= ima_calc_field_array_hash_tfm(field_data
, desc
, num_fields
,
537 static int calc_buffer_ahash_atfm(const void *buf
, loff_t len
,
538 struct ima_digest_data
*hash
,
539 struct crypto_ahash
*tfm
)
541 struct ahash_request
*req
;
542 struct scatterlist sg
;
543 struct ahash_completion res
;
544 int rc
, ahash_rc
= 0;
546 hash
->length
= crypto_ahash_digestsize(tfm
);
548 req
= ahash_request_alloc(tfm
, GFP_KERNEL
);
552 init_completion(&res
.completion
);
553 ahash_request_set_callback(req
, CRYPTO_TFM_REQ_MAY_BACKLOG
|
554 CRYPTO_TFM_REQ_MAY_SLEEP
,
555 ahash_complete
, &res
);
557 rc
= ahash_wait(crypto_ahash_init(req
), &res
);
561 sg_init_one(&sg
, buf
, len
);
562 ahash_request_set_crypt(req
, &sg
, NULL
, len
);
564 ahash_rc
= crypto_ahash_update(req
);
566 /* wait for the update request to complete */
567 rc
= ahash_wait(ahash_rc
, &res
);
569 ahash_request_set_crypt(req
, NULL
, hash
->digest
, 0);
570 rc
= ahash_wait(crypto_ahash_final(req
), &res
);
573 ahash_request_free(req
);
577 static int calc_buffer_ahash(const void *buf
, loff_t len
,
578 struct ima_digest_data
*hash
)
580 struct crypto_ahash
*tfm
;
583 tfm
= ima_alloc_atfm(hash
->algo
);
587 rc
= calc_buffer_ahash_atfm(buf
, len
, hash
, tfm
);
594 static int calc_buffer_shash_tfm(const void *buf
, loff_t size
,
595 struct ima_digest_data
*hash
,
596 struct crypto_shash
*tfm
)
598 SHASH_DESC_ON_STACK(shash
, tfm
);
605 hash
->length
= crypto_shash_digestsize(tfm
);
607 rc
= crypto_shash_init(shash
);
612 len
= size
< PAGE_SIZE
? size
: PAGE_SIZE
;
613 rc
= crypto_shash_update(shash
, buf
, len
);
621 rc
= crypto_shash_final(shash
, hash
->digest
);
625 static int calc_buffer_shash(const void *buf
, loff_t len
,
626 struct ima_digest_data
*hash
)
628 struct crypto_shash
*tfm
;
631 tfm
= ima_alloc_tfm(hash
->algo
);
635 rc
= calc_buffer_shash_tfm(buf
, len
, hash
, tfm
);
641 int ima_calc_buffer_hash(const void *buf
, loff_t len
,
642 struct ima_digest_data
*hash
)
646 if (ima_ahash_minsize
&& len
>= ima_ahash_minsize
) {
647 rc
= calc_buffer_ahash(buf
, len
, hash
);
652 return calc_buffer_shash(buf
, len
, hash
);
655 static void __init
ima_pcrread(int idx
, u8
*pcr
)
660 if (tpm_pcr_read(TPM_ANY_NUM
, idx
, pcr
) != 0)
661 pr_err("Error Communicating to TPM chip\n");
665 * Calculate the boot aggregate hash
667 static int __init
ima_calc_boot_aggregate_tfm(char *digest
,
668 struct crypto_shash
*tfm
)
670 u8 pcr_i
[TPM_DIGEST_SIZE
];
672 SHASH_DESC_ON_STACK(shash
, tfm
);
677 rc
= crypto_shash_init(shash
);
681 /* cumulative sha1 over tpm registers 0-7 */
682 for (i
= TPM_PCR0
; i
< TPM_PCR8
; i
++) {
683 ima_pcrread(i
, pcr_i
);
684 /* now accumulate with current aggregate */
685 rc
= crypto_shash_update(shash
, pcr_i
, TPM_DIGEST_SIZE
);
688 crypto_shash_final(shash
, digest
);
692 int __init
ima_calc_boot_aggregate(struct ima_digest_data
*hash
)
694 struct crypto_shash
*tfm
;
697 tfm
= ima_alloc_tfm(hash
->algo
);
701 hash
->length
= crypto_shash_digestsize(tfm
);
702 rc
= ima_calc_boot_aggregate_tfm(hash
->digest
, tfm
);