Add whitelist feature

libkmod/libkmod-config.c

@@ -56,6 +56,11 @@ const char *kmod_blacklist_get_modname(const struct kmod_list *l)
 	return l->data;
 }
 
+const char *kmod_whitelist_get_modname(const struct kmod_list *l)
+{
+	return l->data;
+}
+
 const char *kmod_alias_get_name(const struct kmod_list *l)
 {
 	const struct kmod_alias *alias = l->data;
@@ -232,6 +237,27 @@ static int kmod_config_add_blacklist(struct kmod_config *config, const char *mod
 	return 0;
 }
 
+static int kmod_config_add_whitelist(struct kmod_config *config, const char *modname)
+{
+	_cleanup_free_ char *p;
+	struct kmod_list *list;
+
+	DBG(config->ctx, "modname=%s\n", modname);
+
+	_clang_suppress_alloc_ p = strdup(modname);
+	if (!p)
+		return -ENOMEM;
+
+	list = kmod_list_append(config->whitelists, p);
+	if (!list)
+		return -ENOMEM;
+
+	TAKE_PTR(p);
+	config->whitelists = list;
+
+	return 0;
+}
+
 static int kmod_config_add_softdep(struct kmod_config *config, const char *modname,
 				   const char *line)
 {
@@ -810,6 +836,17 @@ static int kmod_config_parse(struct kmod_config *config, int fd, const char *fil
 				goto syntax_error;
 
 			kmod_config_add_blacklist(config, modname);
+		} else if (streq(cmd, "whitelist")) {
+			char *modname = strtok_r(NULL, "\t ", &saveptr);
+
+			if (underscores(modname) < 0)
+				goto syntax_error;
+
+			kmod_config_add_whitelist(config, modname);
+		} else if (streq(cmd, "whitelist-enable")) {
+			config->whitelist_active = true;
+		} else if (streq(cmd, "whitelist-test-mode")) {
+			config->whitelist_test_mode = true;
 		} else if (streq(cmd, "options")) {
 			char *modname = strtok_r(NULL, "\t ", &saveptr);
 			char *options = strtok_r(NULL, "\0", &saveptr);
@@ -879,6 +916,7 @@ void kmod_config_free(struct kmod_config *config)
 	kmod_list_release(config->remove_commands, free);
 	kmod_list_release(config->softdeps, free);
 	kmod_list_release(config->weakdeps, free);
+	kmod_list_release(config->whitelists, free);
 	kmod_list_release(config->paths, free);
 	free(config);
 }

libkmod/libkmod-internal.h

@@ -103,13 +103,17 @@ struct kmod_config {
 	struct kmod_list *install_commands;
 	struct kmod_list *softdeps;
 	struct kmod_list *weakdeps;
+	struct kmod_list *whitelists;
+	bool whitelist_active;
+	bool whitelist_test_mode;
 
 	struct kmod_list *paths;
 };
 
 _nonnull_all_ int kmod_config_new(struct kmod_ctx *ctx, struct kmod_config **config, const char *const *config_paths);
 _nonnull_all_ void kmod_config_free(struct kmod_config *config);
 _nonnull_all_ const char *kmod_blacklist_get_modname(const struct kmod_list *l);
+_nonnull_all_ const char *kmod_whitelist_get_modname(const struct kmod_list *l);
 _nonnull_all_ const char *kmod_alias_get_name(const struct kmod_list *l);
 _nonnull_all_ const char *kmod_alias_get_modname(const struct kmod_list *l);
 _nonnull_all_ const char *kmod_option_get_options(const struct kmod_list *l);

libkmod/libkmod-module.c

@@ -737,6 +737,23 @@ static bool module_is_blacklisted(const struct kmod_module *mod)
 	return false;
 }
 
+static bool module_is_whitelisted(const struct kmod_module *mod)
+{
+	const struct kmod_ctx *ctx = mod->ctx;
+	const struct kmod_config *config = kmod_get_config(ctx);
+	const struct kmod_list *wl = config->whitelists;
+	const struct kmod_list *l;
+
+	kmod_list_foreach(l, wl) {
+		const char *modname = kmod_whitelist_get_modname(l);
+
+		if (streq(modname, mod->name))
+			return true;
+	}
+
+	return false;
+}
+
 KMOD_EXPORT int kmod_module_apply_filter(const struct kmod_ctx *ctx,
 					 enum kmod_filter filter_type,
 					 const struct kmod_list *input,
@@ -1002,6 +1019,30 @@ static int kmod_module_get_probe_list(struct kmod_module *mod, bool ignorecmd,
 	return err;
 }
 
+static bool module_whitelist_check(struct kmod_module *mod)
+{
+	const struct kmod_config *config = kmod_get_config(mod->ctx);
+
+	if (!config->whitelist_active || module_is_whitelisted(mod))
+		return true;
+
+	/*
+	 * Bypass the usual NOTICE() verbosity gate: the kernel always invokes
+	 * the modprobe autoload helper with -q, which would otherwise
+	 * silence this message entirely, defeating whitelist auditing.
+	 */
+	if (config->whitelist_test_mode) {
+		kmod_log(mod->ctx, LOG_NOTICE, __FILE__, __LINE__, __func__,
+			 "whitelist: module '%s' would be denied (test mode active, load permitted)\n",
+			 mod->name);
+		return true;
+	}
+
+	kmod_log(mod->ctx, LOG_NOTICE, __FILE__, __LINE__, __func__,
+		 "whitelist: module '%s' not in whitelist, denied\n", mod->name);
+	return false;
+}
+
 KMOD_EXPORT int kmod_module_probe_insert_module(
 	struct kmod_module *mod, unsigned int flags, const char *extra_options,
 	int (*run_install)(struct kmod_module *m, const char *cmd, void *data),
@@ -1033,6 +1074,9 @@ KMOD_EXPORT int kmod_module_probe_insert_module(
 			return KMOD_PROBE_APPLY_BLACKLIST;
 	}
 
+	if (!module_whitelist_check(mod))
+		return -EPERM;
+
 	err = kmod_module_get_probe_list(mod, !!(flags & KMOD_PROBE_IGNORE_COMMAND),
 					 &list);
 	if (err < 0)

libkmod/libkmod.h

@@ -780,7 +780,7 @@ enum kmod_probe {
  * output or in dry-run mode.
  *
  * Insert a module in the kernel resolving dependencies, soft dependencies,
- * install commands and applying blacklist.
+ * install commands and applying blacklist and whitelist.
  *
  * If @run_install is NULL, this function will fork and exec by calling
  * system(3). Don't pass a NULL argument in @run_install if your binary is

man/modprobe.d.5.scd

@@ -156,6 +156,23 @@ weakdep _modulename_ _modules_
 	required/desired at runtime. When c is loaded and is being probed, it
 	may issue calls to request_module() causing a or b to also be loaded.
 
+whitelist _modulename_
+	Adds _modulename_ to the whitelist of modules that are permitted to
+	load. This command only has an effect once *whitelist-enable* is
+	also given (in this or any other configuration file); by itself, a
+	*whitelist* entry is parsed but has no effect.
+
+whitelist-enable
+	Enables whitelist enforcement, where only modules listed via
+	*whitelist* commands are permitted to load, and all other modules
+	are denied.
+
+whitelist-test-mode
+	Used together with *whitelist-enable*. Modules that the whitelist
+	would otherwise deny are still permitted to load; a notice is logged
+	instead, reporting which module would have been denied. This allows
+	auditing the effect of a whitelist before enforcing it.
+
 # COMPATIBILITY
 
 A future version of kmod will come with a strong warning to avoid use of the

scripts/setup-rootfs.sh

@@ -111,6 +111,9 @@ map=(
     ["test-modprobe/blacklist-loaded$MODULE_DIRECTORY/4.4.4/kernel/"]="mod-simple.ko"
     ["test-modprobe/blacklist-softdep$MODULE_DIRECTORY/4.4.4/kernel/mod-foo-a.ko"]="mod-foo-a.ko"
     ["test-modprobe/blacklist-softdep$MODULE_DIRECTORY/4.4.4/kernel/mod-simple.ko"]="mod-simple.ko"
+    ["test-modprobe/whitelist-inactive$MODULE_DIRECTORY/3.3.3/kernel/"]="mod-simple.ko"
+    ["test-modprobe/whitelist-allowed$MODULE_DIRECTORY/3.3.3/kernel/"]="mod-simple.ko"
+    ["test-modprobe/whitelist-test-mode$MODULE_DIRECTORY/3.3.3/kernel/"]="mod-simple.ko"
     ["test-depmod/modules-order-compressed$MODULE_DIRECTORY/4.4.4/kernel/drivers/block/cciss.ko"]="mod-fake-cciss.ko"
     ["test-depmod/modules-order-compressed$MODULE_DIRECTORY/4.4.4/kernel/drivers/scsi/hpsa.ko"]="mod-fake-hpsa.ko"
     ["test-depmod/modules-order-compressed$MODULE_DIRECTORY/4.4.4/kernel/drivers/scsi/scsi_mod.ko"]="mod-fake-scsi-mod.ko"

testsuite/rootfs-pristine/test-modprobe/whitelist-allowed/etc/modprobe.d/modprobe.conf

@@ -0,0 +1,2 @@
+whitelist-enable
+whitelist mod-simple

testsuite/rootfs-pristine/test-modprobe/whitelist-allowed/lib/modules/3.3.3/modules.alias

@@ -0,0 +1 @@
+# Aliases extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-allowed/lib/modules/3.3.3/modules.dep

@@ -0,0 +1 @@
+kernel/mod-simple.ko:

testsuite/rootfs-pristine/test-modprobe/whitelist-allowed/lib/modules/3.3.3/modules.devname

@@ -0,0 +1 @@
+# Device nodes to trigger on-demand module loading.

testsuite/rootfs-pristine/test-modprobe/whitelist-allowed/lib/modules/3.3.3/modules.softdep

@@ -0,0 +1 @@
+# Soft dependencies extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-allowed/lib/modules/3.3.3/modules.symbols

@@ -0,0 +1 @@
+# Aliases for symbols, used by symbol_request().

testsuite/rootfs-pristine/test-modprobe/whitelist-deny-all/etc/modprobe.d/modprobe.conf

@@ -0,0 +1 @@
+whitelist-enable

testsuite/rootfs-pristine/test-modprobe/whitelist-deny-all/lib/modules/3.3.3/modules.alias

@@ -0,0 +1 @@
+# Aliases extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-deny-all/lib/modules/3.3.3/modules.dep

@@ -0,0 +1 @@
+kernel/mod-simple.ko:

testsuite/rootfs-pristine/test-modprobe/whitelist-deny-all/lib/modules/3.3.3/modules.devname

@@ -0,0 +1 @@
+# Device nodes to trigger on-demand module loading.

testsuite/rootfs-pristine/test-modprobe/whitelist-deny-all/lib/modules/3.3.3/modules.softdep

@@ -0,0 +1 @@
+# Soft dependencies extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-deny-all/lib/modules/3.3.3/modules.symbols

@@ -0,0 +1 @@
+# Aliases for symbols, used by symbol_request().

testsuite/rootfs-pristine/test-modprobe/whitelist-inactive/lib/modules/3.3.3/modules.alias

@@ -0,0 +1 @@
+# Aliases extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-inactive/lib/modules/3.3.3/modules.dep

@@ -0,0 +1 @@
+kernel/mod-simple.ko:

testsuite/rootfs-pristine/test-modprobe/whitelist-inactive/lib/modules/3.3.3/modules.devname

@@ -0,0 +1 @@
+# Device nodes to trigger on-demand module loading.

testsuite/rootfs-pristine/test-modprobe/whitelist-inactive/lib/modules/3.3.3/modules.softdep

@@ -0,0 +1 @@
+# Soft dependencies extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-inactive/lib/modules/3.3.3/modules.symbols

@@ -0,0 +1 @@
+# Aliases for symbols, used by symbol_request().

testsuite/rootfs-pristine/test-modprobe/whitelist-test-mode/etc/modprobe.d/modprobe.conf

@@ -0,0 +1,2 @@
+whitelist-enable
+whitelist-test-mode

testsuite/rootfs-pristine/test-modprobe/whitelist-test-mode/lib/modules/3.3.3/modules.alias

@@ -0,0 +1 @@
+# Aliases extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-test-mode/lib/modules/3.3.3/modules.dep

@@ -0,0 +1 @@
+kernel/mod-simple.ko:

testsuite/rootfs-pristine/test-modprobe/whitelist-test-mode/lib/modules/3.3.3/modules.devname

@@ -0,0 +1 @@
+# Device nodes to trigger on-demand module loading.

testsuite/rootfs-pristine/test-modprobe/whitelist-test-mode/lib/modules/3.3.3/modules.softdep

@@ -0,0 +1 @@
+# Soft dependencies extracted from modules themselves.

testsuite/rootfs-pristine/test-modprobe/whitelist-test-mode/lib/modules/3.3.3/modules.symbols

@@ -0,0 +1 @@
+# Aliases for symbols, used by symbol_request().

testsuite/test-modprobe.c

@@ -493,4 +493,60 @@ DEFINE_TEST(modprobe_blacklisted_softdep,
 	.modules_loaded = "mod-simple,mod-foo-a",
 	);
 
+static int modprobe_whitelist_inactive(void)
+{
+	return EXEC_TOOL(modprobe, "mod-simple");
+}
+DEFINE_TEST(modprobe_whitelist_inactive,
+	.description = "check that modules load normally when no whitelist directive is configured",
+	.config = {
+		[TC_UNAME_R] = "3.3.3",
+		[TC_ROOTFS] = TESTSUITE_ROOTFS "test-modprobe/whitelist-inactive",
+		[TC_INIT_MODULE_RETCODES] = "",
+	},
+	.modules_loaded = "mod-simple",
+	);
+
+static int modprobe_whitelist_deny_all(void)
+{
+	return EXEC_TOOL(modprobe, "mod-simple");
+}
+DEFINE_TEST(modprobe_whitelist_deny_all,
+	.description = "check that modules are denied when whitelist-enable is set with no entries",
+	.config = {
+		[TC_UNAME_R] = "3.3.3",
+		[TC_ROOTFS] = TESTSUITE_ROOTFS "test-modprobe/whitelist-deny-all",
+		[TC_INIT_MODULE_RETCODES] = "",
+	},
+	.expected_fail = true,
+	);
+
+static int modprobe_whitelist_allowed(void)
+{
+	return EXEC_TOOL(modprobe, "mod-simple");
+}
+DEFINE_TEST(modprobe_whitelist_allowed,
+	.description = "check that a listed module loads, also verifying hyphen/underscore normalisation",
+	.config = {
+		[TC_UNAME_R] = "3.3.3",
+		[TC_ROOTFS] = TESTSUITE_ROOTFS "test-modprobe/whitelist-allowed",
+		[TC_INIT_MODULE_RETCODES] = "",
+	},
+	.modules_loaded = "mod-simple",
+	);
+
+static int modprobe_whitelist_test_mode(void)
+{
+	return EXEC_TOOL(modprobe, "mod-simple");
+}
+DEFINE_TEST(modprobe_whitelist_test_mode,
+	.description = "check that whitelist-test-mode permits loading a module that would otherwise be denied",
+	.config = {
+		[TC_UNAME_R] = "3.3.3",
+		[TC_ROOTFS] = TESTSUITE_ROOTFS "test-modprobe/whitelist-test-mode",
+		[TC_INIT_MODULE_RETCODES] = "",
+	},
+	.modules_loaded = "mod-simple",
+	);
+
 TESTSUITE_MAIN();