1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1997 Richard Günther
7 * binfmt_misc detects binaries via a magic or filename extension and invokes
8 * a specified wrapper. See Documentation/admin-guide/binfmt-misc.rst for more details.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/sched/mm.h>
17 #include <linux/magic.h>
18 #include <linux/binfmts.h>
19 #include <linux/slab.h>
20 #include <linux/ctype.h>
21 #include <linux/string_helpers.h>
22 #include <linux/file.h>
23 #include <linux/pagemap.h>
24 #include <linux/namei.h>
25 #include <linux/mount.h>
26 #include <linux/fs_context.h>
27 #include <linux/syscalls.h>
29 #include <linux/uaccess.h>
40 VERBOSE_STATUS = 1 /* make it zero to save 400 bytes kernel memory */
43 static LIST_HEAD(entries);
44 static int enabled = 1;
46 enum {Enabled, Magic};
47 #define MISC_FMT_PRESERVE_ARGV0 (1 << 31)
48 #define MISC_FMT_OPEN_BINARY (1 << 30)
49 #define MISC_FMT_CREDENTIALS (1 << 29)
50 #define MISC_FMT_OPEN_FILE (1 << 28)
53 struct list_head list;
54 unsigned long flags; /* type, status, etc. */
55 int offset; /* offset of magic */
56 int size; /* size of magic/mask */
57 char *magic; /* magic or filename extension */
58 char *mask; /* mask, NULL for exact match */
59 const char *interpreter; /* filename of interpreter */
61 struct dentry *dentry;
62 struct file *interp_file;
65 static DEFINE_RWLOCK(entries_lock);
66 static struct file_system_type bm_fs_type;
67 static struct vfsmount *bm_mnt;
68 static int entry_count;
71 * Max length of the register string. Determined by:
75 * - offset: 3 bytes (has to be smaller than BINPRM_BUF_SIZE)
76 * - magic: 128 bytes (512 in escaped form)
77 * - mask: 128 bytes (512 in escaped form)
80 * Round that up a bit, and then back off to hold the internal data
83 #define MAX_REGISTER_LENGTH 1920
86 * Check if we support the binfmt
87 * if we do, return the node, else NULL
88 * locking is done in load_misc_binary
90 static Node *check_file(struct linux_binprm *bprm)
92 char *p = strrchr(bprm->interp, '.');
95 /* Walk all the registered handlers. */
96 list_for_each(l, &entries) {
97 Node *e = list_entry(l, Node, list);
101 /* Make sure this one is currently enabled. */
102 if (!test_bit(Enabled, &e->flags))
105 /* Do matching based on extension if applicable. */
106 if (!test_bit(Magic, &e->flags)) {
107 if (p && !strcmp(e->magic, p + 1))
112 /* Do matching based on magic & mask. */
113 s = bprm->buf + e->offset;
115 for (j = 0; j < e->size; j++)
116 if ((*s++ ^ e->magic[j]) & e->mask[j])
119 for (j = 0; j < e->size; j++)
120 if ((*s++ ^ e->magic[j]))
132 static int load_misc_binary(struct linux_binprm *bprm)
135 struct file *interp_file = NULL;
143 /* to keep locking time low, we copy the interpreter string */
144 read_lock(&entries_lock);
145 fmt = check_file(bprm);
148 read_unlock(&entries_lock);
152 /* Need to be able to load the file after exec */
154 if (bprm->interp_flags & BINPRM_FLAGS_PATH_INACCESSIBLE)
157 if (!(fmt->flags & MISC_FMT_PRESERVE_ARGV0)) {
158 retval = remove_arg_zero(bprm);
163 if (fmt->flags & MISC_FMT_OPEN_BINARY) {
165 /* if the binary should be opened on behalf of the
166 * interpreter than keep it open and assign descriptor
169 fd_binary = get_unused_fd_flags(0);
174 fd_install(fd_binary, bprm->file);
176 /* if the binary is not readable than enforce mm->dumpable=0
177 regardless of the interpreter's permissions */
178 would_dump(bprm, bprm->file);
180 allow_write_access(bprm->file);
183 /* mark the bprm that fd should be passed to interp */
184 bprm->interp_flags |= BINPRM_FLAGS_EXECFD;
185 bprm->interp_data = fd_binary;
188 allow_write_access(bprm->file);
192 /* make argv[1] be the path to the binary */
193 retval = copy_strings_kernel(1, &bprm->interp, bprm);
198 /* add the interp as argv[0] */
199 retval = copy_strings_kernel(1, &fmt->interpreter, bprm);
204 /* Update interp in case binfmt_script needs it. */
205 retval = bprm_change_interp(fmt->interpreter, bprm);
209 if (fmt->flags & MISC_FMT_OPEN_FILE) {
210 interp_file = file_clone_open(fmt->interp_file);
211 if (!IS_ERR(interp_file))
212 deny_write_access(interp_file);
214 interp_file = open_exec(fmt->interpreter);
216 retval = PTR_ERR(interp_file);
217 if (IS_ERR(interp_file))
220 bprm->file = interp_file;
221 if (fmt->flags & MISC_FMT_CREDENTIALS) {
225 * No need to call prepare_binprm(), it's already been
226 * done. bprm->buf is stale, update from interp_file.
228 memset(bprm->buf, 0, BINPRM_BUF_SIZE);
229 retval = kernel_read(bprm->file, bprm->buf, BINPRM_BUF_SIZE,
232 retval = prepare_binprm(bprm);
237 retval = search_binary_handler(bprm);
246 ksys_close(fd_binary);
247 bprm->interp_flags = 0;
248 bprm->interp_data = 0;
252 /* Command parsers */
255 * parses and copies one argument enclosed in del from *sp to *dp,
256 * recognising the \x special.
257 * returns pointer to the copied argument or NULL in case of an
258 * error (and sets err) or null argument length.
260 static char *scanarg(char *s, char del)
264 while ((c = *s++) != del) {
265 if (c == '\\' && *s == 'x') {
277 static char *check_special_flags(char *sfs, Node *e)
286 pr_debug("register: flag: P (preserve argv0)\n");
288 e->flags |= MISC_FMT_PRESERVE_ARGV0;
291 pr_debug("register: flag: O (open binary)\n");
293 e->flags |= MISC_FMT_OPEN_BINARY;
296 pr_debug("register: flag: C (preserve creds)\n");
298 /* this flags also implies the
300 e->flags |= (MISC_FMT_CREDENTIALS |
301 MISC_FMT_OPEN_BINARY);
304 pr_debug("register: flag: F: open interpreter file now\n");
306 e->flags |= MISC_FMT_OPEN_FILE;
317 * This registers a new binary format, it recognises the syntax
318 * ':name:type:offset:magic:mask:interpreter:flags'
319 * where the ':' is the IFS, that can be chosen with the first char
321 static Node *create_entry(const char __user *buffer, size_t count)
328 pr_debug("register: received %zu bytes\n", count);
330 /* some sanity checks */
332 if ((count < 11) || (count > MAX_REGISTER_LENGTH))
336 memsize = sizeof(Node) + count + 8;
337 e = kmalloc(memsize, GFP_KERNEL);
341 p = buf = (char *)e + sizeof(Node);
343 memset(e, 0, sizeof(Node));
344 if (copy_from_user(buf, buffer, count))
347 del = *p++; /* delimeter */
349 pr_debug("register: delim: %#x {%c}\n", del, del);
351 /* Pad the buffer with the delim to simplify parsing below. */
352 memset(buf + count, del, 8);
354 /* Parse the 'name' field. */
361 !strcmp(e->name, ".") ||
362 !strcmp(e->name, "..") ||
363 strchr(e->name, '/'))
366 pr_debug("register: name: {%s}\n", e->name);
368 /* Parse the 'type' field. */
371 pr_debug("register: type: E (extension)\n");
372 e->flags = 1 << Enabled;
375 pr_debug("register: type: M (magic)\n");
376 e->flags = (1 << Enabled) | (1 << Magic);
384 if (test_bit(Magic, &e->flags)) {
385 /* Handle the 'M' (magic) format. */
388 /* Parse the 'offset' field. */
394 int r = kstrtoint(p, 10, &e->offset);
395 if (r != 0 || e->offset < 0)
401 pr_debug("register: offset: %#x\n", e->offset);
403 /* Parse the 'magic' field. */
411 print_hex_dump_bytes(
412 KBUILD_MODNAME ": register: magic[raw]: ",
413 DUMP_PREFIX_NONE, e->magic, p - e->magic);
415 /* Parse the 'mask' field. */
422 pr_debug("register: mask[raw]: none\n");
423 } else if (USE_DEBUG)
424 print_hex_dump_bytes(
425 KBUILD_MODNAME ": register: mask[raw]: ",
426 DUMP_PREFIX_NONE, e->mask, p - e->mask);
429 * Decode the magic & mask fields.
430 * Note: while we might have accepted embedded NUL bytes from
431 * above, the unescape helpers here will stop at the first one
434 e->size = string_unescape_inplace(e->magic, UNESCAPE_HEX);
436 string_unescape_inplace(e->mask, UNESCAPE_HEX) != e->size)
438 if (e->size > BINPRM_BUF_SIZE ||
439 BINPRM_BUF_SIZE - e->size < e->offset)
441 pr_debug("register: magic/mask length: %i\n", e->size);
443 print_hex_dump_bytes(
444 KBUILD_MODNAME ": register: magic[decoded]: ",
445 DUMP_PREFIX_NONE, e->magic, e->size);
449 char *masked = kmalloc(e->size, GFP_KERNEL);
451 print_hex_dump_bytes(
452 KBUILD_MODNAME ": register: mask[decoded]: ",
453 DUMP_PREFIX_NONE, e->mask, e->size);
456 for (i = 0; i < e->size; ++i)
457 masked[i] = e->magic[i] & e->mask[i];
458 print_hex_dump_bytes(
459 KBUILD_MODNAME ": register: magic[masked]: ",
460 DUMP_PREFIX_NONE, masked, e->size);
467 /* Handle the 'E' (extension) format. */
469 /* Skip the 'offset' field. */
475 /* Parse the 'magic' field. */
481 if (!e->magic[0] || strchr(e->magic, '/'))
483 pr_debug("register: extension: {%s}\n", e->magic);
485 /* Skip the 'mask' field. */
492 /* Parse the 'interpreter' field. */
498 if (!e->interpreter[0])
500 pr_debug("register: interpreter: {%s}\n", e->interpreter);
502 /* Parse the 'flags' field. */
503 p = check_special_flags(p, e);
506 if (p != buf + count)
516 return ERR_PTR(-EFAULT);
519 return ERR_PTR(-EINVAL);
523 * Set status of entry/binfmt_misc:
524 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
526 static int parse_command(const char __user *buffer, size_t count)
532 if (copy_from_user(s, buffer, count))
536 if (s[count - 1] == '\n')
538 if (count == 1 && s[0] == '0')
540 if (count == 1 && s[0] == '1')
542 if (count == 2 && s[0] == '-' && s[1] == '1')
549 static void entry_status(Node *e, char *page)
552 const char *status = "disabled";
554 if (test_bit(Enabled, &e->flags))
557 if (!VERBOSE_STATUS) {
558 sprintf(page, "%s\n", status);
562 dp += sprintf(dp, "%s\ninterpreter %s\n", status, e->interpreter);
564 /* print the special flags */
565 dp += sprintf(dp, "flags: ");
566 if (e->flags & MISC_FMT_PRESERVE_ARGV0)
568 if (e->flags & MISC_FMT_OPEN_BINARY)
570 if (e->flags & MISC_FMT_CREDENTIALS)
572 if (e->flags & MISC_FMT_OPEN_FILE)
576 if (!test_bit(Magic, &e->flags)) {
577 sprintf(dp, "extension .%s\n", e->magic);
579 dp += sprintf(dp, "offset %i\nmagic ", e->offset);
580 dp = bin2hex(dp, e->magic, e->size);
582 dp += sprintf(dp, "\nmask ");
583 dp = bin2hex(dp, e->mask, e->size);
590 static struct inode *bm_get_inode(struct super_block *sb, int mode)
592 struct inode *inode = new_inode(sb);
595 inode->i_ino = get_next_ino();
596 inode->i_mode = mode;
597 inode->i_atime = inode->i_mtime = inode->i_ctime =
603 static void bm_evict_inode(struct inode *inode)
605 Node *e = inode->i_private;
607 if (e && e->flags & MISC_FMT_OPEN_FILE)
608 filp_close(e->interp_file, NULL);
614 static void kill_node(Node *e)
616 struct dentry *dentry;
618 write_lock(&entries_lock);
619 list_del_init(&e->list);
620 write_unlock(&entries_lock);
623 drop_nlink(d_inode(dentry));
626 simple_release_fs(&bm_mnt, &entry_count);
632 bm_entry_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
634 Node *e = file_inode(file)->i_private;
638 page = (char *) __get_free_page(GFP_KERNEL);
642 entry_status(e, page);
644 res = simple_read_from_buffer(buf, nbytes, ppos, page, strlen(page));
646 free_page((unsigned long) page);
650 static ssize_t bm_entry_write(struct file *file, const char __user *buffer,
651 size_t count, loff_t *ppos)
654 Node *e = file_inode(file)->i_private;
655 int res = parse_command(buffer, count);
659 /* Disable this handler. */
660 clear_bit(Enabled, &e->flags);
663 /* Enable this handler. */
664 set_bit(Enabled, &e->flags);
667 /* Delete this handler. */
668 root = file_inode(file)->i_sb->s_root;
669 inode_lock(d_inode(root));
671 if (!list_empty(&e->list))
674 inode_unlock(d_inode(root));
683 static const struct file_operations bm_entry_operations = {
684 .read = bm_entry_read,
685 .write = bm_entry_write,
686 .llseek = default_llseek,
691 static ssize_t bm_register_write(struct file *file, const char __user *buffer,
692 size_t count, loff_t *ppos)
696 struct super_block *sb = file_inode(file)->i_sb;
697 struct dentry *root = sb->s_root, *dentry;
700 e = create_entry(buffer, count);
705 inode_lock(d_inode(root));
706 dentry = lookup_one_len(e->name, root, strlen(e->name));
707 err = PTR_ERR(dentry);
712 if (d_really_is_positive(dentry))
715 inode = bm_get_inode(sb, S_IFREG | 0644);
721 err = simple_pin_fs(&bm_fs_type, &bm_mnt, &entry_count);
728 if (e->flags & MISC_FMT_OPEN_FILE) {
731 f = open_exec(e->interpreter);
734 pr_notice("register: failed to install interpreter file %s\n", e->interpreter);
735 simple_release_fs(&bm_mnt, &entry_count);
743 e->dentry = dget(dentry);
744 inode->i_private = e;
745 inode->i_fop = &bm_entry_operations;
747 d_instantiate(dentry, inode);
748 write_lock(&entries_lock);
749 list_add(&e->list, &entries);
750 write_unlock(&entries_lock);
756 inode_unlock(d_inode(root));
765 static const struct file_operations bm_register_operations = {
766 .write = bm_register_write,
767 .llseek = noop_llseek,
773 bm_status_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
775 char *s = enabled ? "enabled\n" : "disabled\n";
777 return simple_read_from_buffer(buf, nbytes, ppos, s, strlen(s));
780 static ssize_t bm_status_write(struct file *file, const char __user *buffer,
781 size_t count, loff_t *ppos)
783 int res = parse_command(buffer, count);
788 /* Disable all handlers. */
792 /* Enable all handlers. */
796 /* Delete all handlers. */
797 root = file_inode(file)->i_sb->s_root;
798 inode_lock(d_inode(root));
800 while (!list_empty(&entries))
801 kill_node(list_first_entry(&entries, Node, list));
803 inode_unlock(d_inode(root));
812 static const struct file_operations bm_status_operations = {
813 .read = bm_status_read,
814 .write = bm_status_write,
815 .llseek = default_llseek,
818 /* Superblock handling */
820 static const struct super_operations s_ops = {
821 .statfs = simple_statfs,
822 .evict_inode = bm_evict_inode,
825 static int bm_fill_super(struct super_block *sb, struct fs_context *fc)
828 static const struct tree_descr bm_files[] = {
829 [2] = {"status", &bm_status_operations, S_IWUSR|S_IRUGO},
830 [3] = {"register", &bm_register_operations, S_IWUSR},
834 err = simple_fill_super(sb, BINFMTFS_MAGIC, bm_files);
840 static int bm_get_tree(struct fs_context *fc)
842 return get_tree_single(fc, bm_fill_super);
845 static const struct fs_context_operations bm_context_ops = {
846 .get_tree = bm_get_tree,
849 static int bm_init_fs_context(struct fs_context *fc)
851 fc->ops = &bm_context_ops;
855 static struct linux_binfmt misc_format = {
856 .module = THIS_MODULE,
857 .load_binary = load_misc_binary,
860 static struct file_system_type bm_fs_type = {
861 .owner = THIS_MODULE,
862 .name = "binfmt_misc",
863 .init_fs_context = bm_init_fs_context,
864 .kill_sb = kill_litter_super,
866 MODULE_ALIAS_FS("binfmt_misc");
868 static int __init init_misc_binfmt(void)
870 int err = register_filesystem(&bm_fs_type);
872 insert_binfmt(&misc_format);
876 static void __exit exit_misc_binfmt(void)
878 unregister_binfmt(&misc_format);
879 unregister_filesystem(&bm_fs_type);
882 core_initcall(init_misc_binfmt);
883 module_exit(exit_misc_binfmt);
884 MODULE_LICENSE("GPL");