1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2021 Microsoft Corporation
5 * Author: Tushar Sugandhi <tusharsu@linux.microsoft.com>
7 * Enables IMA measurements for DM targets
13 #include <linux/ima.h>
14 #include <linux/sched/mm.h>
15 #include <crypto/hash.h>
16 #include <linux/crypto.h>
17 #include <crypto/hash_info.h>
19 #define DM_MSG_PREFIX "ima"
22 * Internal function to prefix separator characters in input buffer with escape
23 * character, so that they don't interfere with the construction of key-value pairs,
24 * and clients can split the key1=val1,key2=val2,key3=val3; pairs properly.
26 static void fix_separator_chars(char **buf)
31 for (i = 0; i < l; i++)
32 if ((*buf)[i] == '\\' || (*buf)[i] == ';' || (*buf)[i] == '=' || (*buf)[i] == ',')
38 for (i = l-1, j = i+sp; i >= 0; i--) {
39 (*buf)[j--] = (*buf)[i];
40 if ((*buf)[i] == '\\' || (*buf)[i] == ';' || (*buf)[i] == '=' || (*buf)[i] == ',')
46 * Internal function to allocate memory for IMA measurements.
48 static void *dm_ima_alloc(size_t len, gfp_t flags, bool noio)
50 unsigned int noio_flag;
54 noio_flag = memalloc_noio_save();
56 ptr = kzalloc(len, flags);
59 memalloc_noio_restore(noio_flag);
65 * Internal function to allocate and copy name and uuid for IMA measurements.
67 static int dm_ima_alloc_and_copy_name_uuid(struct mapped_device *md, char **dev_name,
68 char **dev_uuid, bool noio)
71 *dev_name = dm_ima_alloc(DM_NAME_LEN*2, GFP_KERNEL, noio);
77 *dev_uuid = dm_ima_alloc(DM_UUID_LEN*2, GFP_KERNEL, noio);
83 r = dm_copy_name_and_uuid(md, *dev_name, *dev_uuid);
87 fix_separator_chars(dev_name);
88 fix_separator_chars(dev_uuid);
100 * Internal function to allocate and copy device data for IMA measurements.
102 static int dm_ima_alloc_and_copy_device_data(struct mapped_device *md, char **device_data,
103 unsigned int num_targets, bool noio)
105 char *dev_name = NULL, *dev_uuid = NULL;
108 r = dm_ima_alloc_and_copy_name_uuid(md, &dev_name, &dev_uuid, noio);
112 *device_data = dm_ima_alloc(DM_IMA_DEVICE_BUF_LEN, GFP_KERNEL, noio);
113 if (!(*device_data)) {
118 scnprintf(*device_data, DM_IMA_DEVICE_BUF_LEN,
119 "name=%s,uuid=%s,major=%d,minor=%d,minor_count=%d,num_targets=%u;",
120 dev_name, dev_uuid, md->disk->major, md->disk->first_minor,
121 md->disk->minors, num_targets);
129 * Internal wrapper function to call IMA to measure DM data.
131 static void dm_ima_measure_data(const char *event_name, const void *buf, size_t buf_len,
134 unsigned int noio_flag;
137 noio_flag = memalloc_noio_save();
139 ima_measure_critical_data(DM_NAME, event_name, buf, buf_len,
143 memalloc_noio_restore(noio_flag);
147 * Internal function to allocate and copy current device capacity for IMA measurements.
149 static int dm_ima_alloc_and_copy_capacity_str(struct mapped_device *md, char **capacity_str,
154 capacity = get_capacity(md->disk);
156 *capacity_str = dm_ima_alloc(DM_IMA_DEVICE_CAPACITY_BUF_LEN, GFP_KERNEL, noio);
157 if (!(*capacity_str))
160 scnprintf(*capacity_str, DM_IMA_DEVICE_BUF_LEN, "current_device_capacity=%llu;",
167 * Initialize/reset the dm ima related data structure variables.
169 void dm_ima_reset_data(struct mapped_device *md)
171 memset(&(md->ima), 0, sizeof(md->ima));
172 md->ima.dm_version_str_len = strlen(DM_IMA_VERSION_STR);
176 * Build up the IMA data for each target, and finally measure.
178 void dm_ima_measure_on_table_load(struct dm_table *table, unsigned int status_flags)
180 size_t device_data_buf_len, target_metadata_buf_len, target_data_buf_len, l = 0;
181 char *target_metadata_buf = NULL, *target_data_buf = NULL, *digest_buf = NULL;
182 char *ima_buf = NULL, *device_data_buf = NULL;
183 int digest_size, last_target_measured = -1, r;
184 status_type_t type = STATUSTYPE_IMA;
185 size_t cur_total_buf_len = 0;
186 unsigned int num_targets, i;
187 SHASH_DESC_ON_STACK(shash, NULL);
188 struct crypto_shash *tfm = NULL;
192 * In below hash_alg_prefix_len assignment +1 is for the additional char (':'),
193 * when prefixing the hash value with the hash algorithm name. e.g. sha256:<hash_value>.
195 const size_t hash_alg_prefix_len = strlen(DM_IMA_TABLE_HASH_ALG) + 1;
196 char table_load_event_name[] = "dm_table_load";
198 ima_buf = dm_ima_alloc(DM_IMA_MEASUREMENT_BUF_LEN, GFP_KERNEL, noio);
202 target_metadata_buf = dm_ima_alloc(DM_IMA_TARGET_METADATA_BUF_LEN, GFP_KERNEL, noio);
203 if (!target_metadata_buf)
206 target_data_buf = dm_ima_alloc(DM_IMA_TARGET_DATA_BUF_LEN, GFP_KERNEL, noio);
207 if (!target_data_buf)
210 num_targets = table->num_targets;
212 if (dm_ima_alloc_and_copy_device_data(table->md, &device_data_buf, num_targets, noio))
215 tfm = crypto_alloc_shash(DM_IMA_TABLE_HASH_ALG, 0, 0);
220 digest_size = crypto_shash_digestsize(tfm);
221 digest = dm_ima_alloc(digest_size, GFP_KERNEL, noio);
225 r = crypto_shash_init(shash);
229 memcpy(ima_buf + l, DM_IMA_VERSION_STR, table->md->ima.dm_version_str_len);
230 l += table->md->ima.dm_version_str_len;
232 device_data_buf_len = strlen(device_data_buf);
233 memcpy(ima_buf + l, device_data_buf, device_data_buf_len);
234 l += device_data_buf_len;
236 for (i = 0; i < num_targets; i++) {
237 struct dm_target *ti = dm_table_get_target(table, i);
239 last_target_measured = 0;
242 * First retrieve the target metadata.
244 scnprintf(target_metadata_buf, DM_IMA_TARGET_METADATA_BUF_LEN,
245 "target_index=%d,target_begin=%llu,target_len=%llu,",
246 i, ti->begin, ti->len);
247 target_metadata_buf_len = strlen(target_metadata_buf);
250 * Then retrieve the actual target data.
252 if (ti->type->status)
253 ti->type->status(ti, type, status_flags, target_data_buf,
254 DM_IMA_TARGET_DATA_BUF_LEN);
256 target_data_buf[0] = '\0';
258 target_data_buf_len = strlen(target_data_buf);
261 * Check if the total data can fit into the IMA buffer.
263 cur_total_buf_len = l + target_metadata_buf_len + target_data_buf_len;
266 * IMA measurements for DM targets are best-effort.
267 * If the total data buffered so far, including the current target,
268 * is too large to fit into DM_IMA_MEASUREMENT_BUF_LEN, measure what
269 * we have in the current buffer, and continue measuring the remaining
270 * targets by prefixing the device metadata again.
272 if (unlikely(cur_total_buf_len >= DM_IMA_MEASUREMENT_BUF_LEN)) {
273 dm_ima_measure_data(table_load_event_name, ima_buf, l, noio);
274 r = crypto_shash_update(shash, (const u8 *)ima_buf, l);
278 memset(ima_buf, 0, DM_IMA_MEASUREMENT_BUF_LEN);
282 * Each new "dm_table_load" entry in IMA log should have device data
283 * prefix, so that multiple records from the same "dm_table_load" for
284 * a given device can be linked together.
286 memcpy(ima_buf + l, DM_IMA_VERSION_STR, table->md->ima.dm_version_str_len);
287 l += table->md->ima.dm_version_str_len;
289 memcpy(ima_buf + l, device_data_buf, device_data_buf_len);
290 l += device_data_buf_len;
293 * If this iteration of the for loop turns out to be the last target
294 * in the table, dm_ima_measure_data("dm_table_load", ...) doesn't need
295 * to be called again, just the hash needs to be finalized.
296 * "last_target_measured" tracks this state.
298 last_target_measured = 1;
302 * Fill-in all the target metadata, so that multiple targets for the same
303 * device can be linked together.
305 memcpy(ima_buf + l, target_metadata_buf, target_metadata_buf_len);
306 l += target_metadata_buf_len;
308 memcpy(ima_buf + l, target_data_buf, target_data_buf_len);
309 l += target_data_buf_len;
312 if (!last_target_measured) {
313 dm_ima_measure_data(table_load_event_name, ima_buf, l, noio);
315 r = crypto_shash_update(shash, (const u8 *)ima_buf, l);
321 * Finalize the table hash, and store it in table->md->ima.inactive_table.hash,
322 * so that the table data can be verified against the future device state change
323 * events, e.g. resume, rename, remove, table-clear etc.
325 r = crypto_shash_final(shash, digest);
329 digest_buf = dm_ima_alloc((digest_size*2) + hash_alg_prefix_len + 1, GFP_KERNEL, noio);
334 snprintf(digest_buf, hash_alg_prefix_len + 1, "%s:", DM_IMA_TABLE_HASH_ALG);
336 for (i = 0; i < digest_size; i++)
337 snprintf((digest_buf + hash_alg_prefix_len + (i*2)), 3, "%02x", digest[i]);
339 if (table->md->ima.active_table.hash != table->md->ima.inactive_table.hash)
340 kfree(table->md->ima.inactive_table.hash);
342 table->md->ima.inactive_table.hash = digest_buf;
343 table->md->ima.inactive_table.hash_len = strlen(digest_buf);
344 table->md->ima.inactive_table.num_targets = num_targets;
346 if (table->md->ima.active_table.device_metadata !=
347 table->md->ima.inactive_table.device_metadata)
348 kfree(table->md->ima.inactive_table.device_metadata);
350 table->md->ima.inactive_table.device_metadata = device_data_buf;
351 table->md->ima.inactive_table.device_metadata_len = device_data_buf_len;
356 kfree(device_data_buf);
360 crypto_free_shash(tfm);
362 kfree(target_metadata_buf);
363 kfree(target_data_buf);
367 * Measure IMA data on device resume.
369 void dm_ima_measure_on_device_resume(struct mapped_device *md, bool swap)
371 char *device_table_data, *dev_name = NULL, *dev_uuid = NULL, *capacity_str = NULL;
372 char active[] = "active_table_hash=";
373 unsigned int active_len = strlen(active), capacity_len = 0;
379 device_table_data = dm_ima_alloc(DM_IMA_DEVICE_BUF_LEN, GFP_KERNEL, noio);
380 if (!device_table_data)
383 r = dm_ima_alloc_and_copy_capacity_str(md, &capacity_str, noio);
387 memcpy(device_table_data + l, DM_IMA_VERSION_STR, md->ima.dm_version_str_len);
388 l += md->ima.dm_version_str_len;
391 if (md->ima.active_table.hash != md->ima.inactive_table.hash)
392 kfree(md->ima.active_table.hash);
394 md->ima.active_table.hash = NULL;
395 md->ima.active_table.hash_len = 0;
397 if (md->ima.active_table.device_metadata !=
398 md->ima.inactive_table.device_metadata)
399 kfree(md->ima.active_table.device_metadata);
401 md->ima.active_table.device_metadata = NULL;
402 md->ima.active_table.device_metadata_len = 0;
403 md->ima.active_table.num_targets = 0;
405 if (md->ima.inactive_table.hash) {
406 md->ima.active_table.hash = md->ima.inactive_table.hash;
407 md->ima.active_table.hash_len = md->ima.inactive_table.hash_len;
408 md->ima.inactive_table.hash = NULL;
409 md->ima.inactive_table.hash_len = 0;
412 if (md->ima.inactive_table.device_metadata) {
413 md->ima.active_table.device_metadata =
414 md->ima.inactive_table.device_metadata;
415 md->ima.active_table.device_metadata_len =
416 md->ima.inactive_table.device_metadata_len;
417 md->ima.active_table.num_targets = md->ima.inactive_table.num_targets;
418 md->ima.inactive_table.device_metadata = NULL;
419 md->ima.inactive_table.device_metadata_len = 0;
420 md->ima.inactive_table.num_targets = 0;
424 if (md->ima.active_table.device_metadata) {
425 memcpy(device_table_data + l, md->ima.active_table.device_metadata,
426 md->ima.active_table.device_metadata_len);
427 l += md->ima.active_table.device_metadata_len;
432 if (md->ima.active_table.hash) {
433 memcpy(device_table_data + l, active, active_len);
436 memcpy(device_table_data + l, md->ima.active_table.hash,
437 md->ima.active_table.hash_len);
438 l += md->ima.active_table.hash_len;
440 memcpy(device_table_data + l, ";", 1);
447 r = dm_ima_alloc_and_copy_name_uuid(md, &dev_name, &dev_uuid, noio);
451 scnprintf(device_table_data, DM_IMA_DEVICE_BUF_LEN,
452 "%sname=%s,uuid=%s;device_resume=no_data;",
453 DM_IMA_VERSION_STR, dev_name, dev_uuid);
454 l = strlen(device_table_data);
458 capacity_len = strlen(capacity_str);
459 memcpy(device_table_data + l, capacity_str, capacity_len);
462 dm_ima_measure_data("dm_device_resume", device_table_data, l, noio);
468 kfree(device_table_data);
472 * Measure IMA data on remove.
474 void dm_ima_measure_on_device_remove(struct mapped_device *md, bool remove_all)
476 char *device_table_data, *dev_name = NULL, *dev_uuid = NULL, *capacity_str = NULL;
477 char active_table_str[] = "active_table_hash=";
478 char inactive_table_str[] = "inactive_table_hash=";
479 char device_active_str[] = "device_active_metadata=";
480 char device_inactive_str[] = "device_inactive_metadata=";
481 char remove_all_str[] = "remove_all=";
482 unsigned int active_table_len = strlen(active_table_str);
483 unsigned int inactive_table_len = strlen(inactive_table_str);
484 unsigned int device_active_len = strlen(device_active_str);
485 unsigned int device_inactive_len = strlen(device_inactive_str);
486 unsigned int remove_all_len = strlen(remove_all_str);
487 unsigned int capacity_len = 0;
493 device_table_data = dm_ima_alloc(DM_IMA_DEVICE_BUF_LEN*2, GFP_KERNEL, noio);
494 if (!device_table_data)
497 r = dm_ima_alloc_and_copy_capacity_str(md, &capacity_str, noio);
499 kfree(device_table_data);
503 memcpy(device_table_data + l, DM_IMA_VERSION_STR, md->ima.dm_version_str_len);
504 l += md->ima.dm_version_str_len;
506 if (md->ima.active_table.device_metadata) {
507 memcpy(device_table_data + l, device_active_str, device_active_len);
508 l += device_active_len;
510 memcpy(device_table_data + l, md->ima.active_table.device_metadata,
511 md->ima.active_table.device_metadata_len);
512 l += md->ima.active_table.device_metadata_len;
517 if (md->ima.inactive_table.device_metadata) {
518 memcpy(device_table_data + l, device_inactive_str, device_inactive_len);
519 l += device_inactive_len;
521 memcpy(device_table_data + l, md->ima.inactive_table.device_metadata,
522 md->ima.inactive_table.device_metadata_len);
523 l += md->ima.inactive_table.device_metadata_len;
528 if (md->ima.active_table.hash) {
529 memcpy(device_table_data + l, active_table_str, active_table_len);
530 l += active_table_len;
532 memcpy(device_table_data + l, md->ima.active_table.hash,
533 md->ima.active_table.hash_len);
534 l += md->ima.active_table.hash_len;
536 memcpy(device_table_data + l, ",", 1);
542 if (md->ima.inactive_table.hash) {
543 memcpy(device_table_data + l, inactive_table_str, inactive_table_len);
544 l += inactive_table_len;
546 memcpy(device_table_data + l, md->ima.inactive_table.hash,
547 md->ima.inactive_table.hash_len);
548 l += md->ima.inactive_table.hash_len;
550 memcpy(device_table_data + l, ",", 1);
556 * In case both active and inactive tables, and corresponding
557 * device metadata is cleared/missing - record the name and uuid
558 * in IMA measurements.
561 if (dm_ima_alloc_and_copy_name_uuid(md, &dev_name, &dev_uuid, noio))
564 scnprintf(device_table_data, DM_IMA_DEVICE_BUF_LEN,
565 "%sname=%s,uuid=%s;device_remove=no_data;",
566 DM_IMA_VERSION_STR, dev_name, dev_uuid);
567 l = strlen(device_table_data);
570 memcpy(device_table_data + l, remove_all_str, remove_all_len);
572 memcpy(device_table_data + l, remove_all ? "y;" : "n;", 2);
575 capacity_len = strlen(capacity_str);
576 memcpy(device_table_data + l, capacity_str, capacity_len);
579 dm_ima_measure_data("dm_device_remove", device_table_data, l, noio);
582 kfree(device_table_data);
585 kfree(md->ima.active_table.device_metadata);
587 if (md->ima.active_table.device_metadata !=
588 md->ima.inactive_table.device_metadata)
589 kfree(md->ima.inactive_table.device_metadata);
591 kfree(md->ima.active_table.hash);
593 if (md->ima.active_table.hash != md->ima.inactive_table.hash)
594 kfree(md->ima.inactive_table.hash);
596 dm_ima_reset_data(md);
603 * Measure ima data on table clear.
605 void dm_ima_measure_on_table_clear(struct mapped_device *md, bool new_map)
607 unsigned int l = 0, capacity_len = 0;
608 char *device_table_data = NULL, *dev_name = NULL, *dev_uuid = NULL, *capacity_str = NULL;
609 char inactive_str[] = "inactive_table_hash=";
610 unsigned int inactive_len = strlen(inactive_str);
615 device_table_data = dm_ima_alloc(DM_IMA_DEVICE_BUF_LEN, GFP_KERNEL, noio);
616 if (!device_table_data)
619 r = dm_ima_alloc_and_copy_capacity_str(md, &capacity_str, noio);
623 memcpy(device_table_data + l, DM_IMA_VERSION_STR, md->ima.dm_version_str_len);
624 l += md->ima.dm_version_str_len;
626 if (md->ima.inactive_table.device_metadata_len &&
627 md->ima.inactive_table.hash_len) {
628 memcpy(device_table_data + l, md->ima.inactive_table.device_metadata,
629 md->ima.inactive_table.device_metadata_len);
630 l += md->ima.inactive_table.device_metadata_len;
632 memcpy(device_table_data + l, inactive_str, inactive_len);
635 memcpy(device_table_data + l, md->ima.inactive_table.hash,
636 md->ima.inactive_table.hash_len);
638 l += md->ima.inactive_table.hash_len;
640 memcpy(device_table_data + l, ";", 1);
647 if (dm_ima_alloc_and_copy_name_uuid(md, &dev_name, &dev_uuid, noio))
650 scnprintf(device_table_data, DM_IMA_DEVICE_BUF_LEN,
651 "%sname=%s,uuid=%s;table_clear=no_data;",
652 DM_IMA_VERSION_STR, dev_name, dev_uuid);
653 l = strlen(device_table_data);
656 capacity_len = strlen(capacity_str);
657 memcpy(device_table_data + l, capacity_str, capacity_len);
660 dm_ima_measure_data("dm_table_clear", device_table_data, l, noio);
663 if (md->ima.inactive_table.hash &&
664 md->ima.inactive_table.hash != md->ima.active_table.hash)
665 kfree(md->ima.inactive_table.hash);
667 md->ima.inactive_table.hash = NULL;
668 md->ima.inactive_table.hash_len = 0;
670 if (md->ima.inactive_table.device_metadata &&
671 md->ima.inactive_table.device_metadata != md->ima.active_table.device_metadata)
672 kfree(md->ima.inactive_table.device_metadata);
674 md->ima.inactive_table.device_metadata = NULL;
675 md->ima.inactive_table.device_metadata_len = 0;
676 md->ima.inactive_table.num_targets = 0;
678 if (md->ima.active_table.hash) {
679 md->ima.inactive_table.hash = md->ima.active_table.hash;
680 md->ima.inactive_table.hash_len = md->ima.active_table.hash_len;
683 if (md->ima.active_table.device_metadata) {
684 md->ima.inactive_table.device_metadata =
685 md->ima.active_table.device_metadata;
686 md->ima.inactive_table.device_metadata_len =
687 md->ima.active_table.device_metadata_len;
688 md->ima.inactive_table.num_targets =
689 md->ima.active_table.num_targets;
698 kfree(device_table_data);
702 * Measure IMA data on device rename.
704 void dm_ima_measure_on_device_rename(struct mapped_device *md)
706 char *old_device_data = NULL, *new_device_data = NULL, *combined_device_data = NULL;
707 char *new_dev_name = NULL, *new_dev_uuid = NULL, *capacity_str = NULL;
711 if (dm_ima_alloc_and_copy_device_data(md, &new_device_data,
712 md->ima.active_table.num_targets, noio))
715 if (dm_ima_alloc_and_copy_name_uuid(md, &new_dev_name, &new_dev_uuid, noio))
718 combined_device_data = dm_ima_alloc(DM_IMA_DEVICE_BUF_LEN * 2, GFP_KERNEL, noio);
719 if (!combined_device_data)
722 r = dm_ima_alloc_and_copy_capacity_str(md, &capacity_str, noio);
726 old_device_data = md->ima.active_table.device_metadata;
728 md->ima.active_table.device_metadata = new_device_data;
729 md->ima.active_table.device_metadata_len = strlen(new_device_data);
731 scnprintf(combined_device_data, DM_IMA_DEVICE_BUF_LEN * 2,
732 "%s%snew_name=%s,new_uuid=%s;%s", DM_IMA_VERSION_STR, old_device_data,
733 new_dev_name, new_dev_uuid, capacity_str);
735 dm_ima_measure_data("dm_device_rename", combined_device_data, strlen(combined_device_data),
741 kfree(new_device_data);
744 kfree(combined_device_data);
745 kfree(old_device_data);