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;
142 /* to keep locking time low, we copy the interpreter string */
143 read_lock(&entries_lock);
144 fmt = check_file(bprm);
147 read_unlock(&entries_lock);
151 /* Need to be able to load the file after exec */
153 if (bprm->interp_flags & BINPRM_FLAGS_PATH_INACCESSIBLE)
156 if (!(fmt->flags & MISC_FMT_PRESERVE_ARGV0)) {
157 retval = remove_arg_zero(bprm);
162 if (fmt->flags & MISC_FMT_OPEN_BINARY)
163 bprm->have_execfd = 1;
165 /* make argv[1] be the path to the binary */
166 retval = copy_string_kernel(bprm->interp, bprm);
171 /* add the interp as argv[0] */
172 retval = copy_string_kernel(fmt->interpreter, bprm);
177 /* Update interp in case binfmt_script needs it. */
178 retval = bprm_change_interp(fmt->interpreter, bprm);
182 if (fmt->flags & MISC_FMT_OPEN_FILE) {
183 interp_file = file_clone_open(fmt->interp_file);
184 if (!IS_ERR(interp_file))
185 deny_write_access(interp_file);
187 interp_file = open_exec(fmt->interpreter);
189 retval = PTR_ERR(interp_file);
190 if (IS_ERR(interp_file))
193 bprm->interpreter = interp_file;
194 if (fmt->flags & MISC_FMT_CREDENTIALS)
195 bprm->execfd_creds = 1;
203 /* Command parsers */
206 * parses and copies one argument enclosed in del from *sp to *dp,
207 * recognising the \x special.
208 * returns pointer to the copied argument or NULL in case of an
209 * error (and sets err) or null argument length.
211 static char *scanarg(char *s, char del)
215 while ((c = *s++) != del) {
216 if (c == '\\' && *s == 'x') {
228 static char *check_special_flags(char *sfs, Node *e)
237 pr_debug("register: flag: P (preserve argv0)\n");
239 e->flags |= MISC_FMT_PRESERVE_ARGV0;
242 pr_debug("register: flag: O (open binary)\n");
244 e->flags |= MISC_FMT_OPEN_BINARY;
247 pr_debug("register: flag: C (preserve creds)\n");
249 /* this flags also implies the
251 e->flags |= (MISC_FMT_CREDENTIALS |
252 MISC_FMT_OPEN_BINARY);
255 pr_debug("register: flag: F: open interpreter file now\n");
257 e->flags |= MISC_FMT_OPEN_FILE;
268 * This registers a new binary format, it recognises the syntax
269 * ':name:type:offset:magic:mask:interpreter:flags'
270 * where the ':' is the IFS, that can be chosen with the first char
272 static Node *create_entry(const char __user *buffer, size_t count)
279 pr_debug("register: received %zu bytes\n", count);
281 /* some sanity checks */
283 if ((count < 11) || (count > MAX_REGISTER_LENGTH))
287 memsize = sizeof(Node) + count + 8;
288 e = kmalloc(memsize, GFP_KERNEL);
292 p = buf = (char *)e + sizeof(Node);
294 memset(e, 0, sizeof(Node));
295 if (copy_from_user(buf, buffer, count))
298 del = *p++; /* delimeter */
300 pr_debug("register: delim: %#x {%c}\n", del, del);
302 /* Pad the buffer with the delim to simplify parsing below. */
303 memset(buf + count, del, 8);
305 /* Parse the 'name' field. */
312 !strcmp(e->name, ".") ||
313 !strcmp(e->name, "..") ||
314 strchr(e->name, '/'))
317 pr_debug("register: name: {%s}\n", e->name);
319 /* Parse the 'type' field. */
322 pr_debug("register: type: E (extension)\n");
323 e->flags = 1 << Enabled;
326 pr_debug("register: type: M (magic)\n");
327 e->flags = (1 << Enabled) | (1 << Magic);
335 if (test_bit(Magic, &e->flags)) {
336 /* Handle the 'M' (magic) format. */
339 /* Parse the 'offset' field. */
345 int r = kstrtoint(p, 10, &e->offset);
346 if (r != 0 || e->offset < 0)
352 pr_debug("register: offset: %#x\n", e->offset);
354 /* Parse the 'magic' field. */
362 print_hex_dump_bytes(
363 KBUILD_MODNAME ": register: magic[raw]: ",
364 DUMP_PREFIX_NONE, e->magic, p - e->magic);
366 /* Parse the 'mask' field. */
373 pr_debug("register: mask[raw]: none\n");
374 } else if (USE_DEBUG)
375 print_hex_dump_bytes(
376 KBUILD_MODNAME ": register: mask[raw]: ",
377 DUMP_PREFIX_NONE, e->mask, p - e->mask);
380 * Decode the magic & mask fields.
381 * Note: while we might have accepted embedded NUL bytes from
382 * above, the unescape helpers here will stop at the first one
385 e->size = string_unescape_inplace(e->magic, UNESCAPE_HEX);
387 string_unescape_inplace(e->mask, UNESCAPE_HEX) != e->size)
389 if (e->size > BINPRM_BUF_SIZE ||
390 BINPRM_BUF_SIZE - e->size < e->offset)
392 pr_debug("register: magic/mask length: %i\n", e->size);
394 print_hex_dump_bytes(
395 KBUILD_MODNAME ": register: magic[decoded]: ",
396 DUMP_PREFIX_NONE, e->magic, e->size);
400 char *masked = kmalloc(e->size, GFP_KERNEL);
402 print_hex_dump_bytes(
403 KBUILD_MODNAME ": register: mask[decoded]: ",
404 DUMP_PREFIX_NONE, e->mask, e->size);
407 for (i = 0; i < e->size; ++i)
408 masked[i] = e->magic[i] & e->mask[i];
409 print_hex_dump_bytes(
410 KBUILD_MODNAME ": register: magic[masked]: ",
411 DUMP_PREFIX_NONE, masked, e->size);
418 /* Handle the 'E' (extension) format. */
420 /* Skip the 'offset' field. */
426 /* Parse the 'magic' field. */
432 if (!e->magic[0] || strchr(e->magic, '/'))
434 pr_debug("register: extension: {%s}\n", e->magic);
436 /* Skip the 'mask' field. */
443 /* Parse the 'interpreter' field. */
449 if (!e->interpreter[0])
451 pr_debug("register: interpreter: {%s}\n", e->interpreter);
453 /* Parse the 'flags' field. */
454 p = check_special_flags(p, e);
457 if (p != buf + count)
467 return ERR_PTR(-EFAULT);
470 return ERR_PTR(-EINVAL);
474 * Set status of entry/binfmt_misc:
475 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
477 static int parse_command(const char __user *buffer, size_t count)
483 if (copy_from_user(s, buffer, count))
487 if (s[count - 1] == '\n')
489 if (count == 1 && s[0] == '0')
491 if (count == 1 && s[0] == '1')
493 if (count == 2 && s[0] == '-' && s[1] == '1')
500 static void entry_status(Node *e, char *page)
503 const char *status = "disabled";
505 if (test_bit(Enabled, &e->flags))
508 if (!VERBOSE_STATUS) {
509 sprintf(page, "%s\n", status);
513 dp += sprintf(dp, "%s\ninterpreter %s\n", status, e->interpreter);
515 /* print the special flags */
516 dp += sprintf(dp, "flags: ");
517 if (e->flags & MISC_FMT_PRESERVE_ARGV0)
519 if (e->flags & MISC_FMT_OPEN_BINARY)
521 if (e->flags & MISC_FMT_CREDENTIALS)
523 if (e->flags & MISC_FMT_OPEN_FILE)
527 if (!test_bit(Magic, &e->flags)) {
528 sprintf(dp, "extension .%s\n", e->magic);
530 dp += sprintf(dp, "offset %i\nmagic ", e->offset);
531 dp = bin2hex(dp, e->magic, e->size);
533 dp += sprintf(dp, "\nmask ");
534 dp = bin2hex(dp, e->mask, e->size);
541 static struct inode *bm_get_inode(struct super_block *sb, int mode)
543 struct inode *inode = new_inode(sb);
546 inode->i_ino = get_next_ino();
547 inode->i_mode = mode;
548 inode->i_atime = inode->i_mtime = inode->i_ctime =
554 static void bm_evict_inode(struct inode *inode)
556 Node *e = inode->i_private;
558 if (e && e->flags & MISC_FMT_OPEN_FILE)
559 filp_close(e->interp_file, NULL);
565 static void kill_node(Node *e)
567 struct dentry *dentry;
569 write_lock(&entries_lock);
570 list_del_init(&e->list);
571 write_unlock(&entries_lock);
574 drop_nlink(d_inode(dentry));
577 simple_release_fs(&bm_mnt, &entry_count);
583 bm_entry_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
585 Node *e = file_inode(file)->i_private;
589 page = (char *) __get_free_page(GFP_KERNEL);
593 entry_status(e, page);
595 res = simple_read_from_buffer(buf, nbytes, ppos, page, strlen(page));
597 free_page((unsigned long) page);
601 static ssize_t bm_entry_write(struct file *file, const char __user *buffer,
602 size_t count, loff_t *ppos)
605 Node *e = file_inode(file)->i_private;
606 int res = parse_command(buffer, count);
610 /* Disable this handler. */
611 clear_bit(Enabled, &e->flags);
614 /* Enable this handler. */
615 set_bit(Enabled, &e->flags);
618 /* Delete this handler. */
619 root = file_inode(file)->i_sb->s_root;
620 inode_lock(d_inode(root));
622 if (!list_empty(&e->list))
625 inode_unlock(d_inode(root));
634 static const struct file_operations bm_entry_operations = {
635 .read = bm_entry_read,
636 .write = bm_entry_write,
637 .llseek = default_llseek,
642 static ssize_t bm_register_write(struct file *file, const char __user *buffer,
643 size_t count, loff_t *ppos)
647 struct super_block *sb = file_inode(file)->i_sb;
648 struct dentry *root = sb->s_root, *dentry;
651 e = create_entry(buffer, count);
656 inode_lock(d_inode(root));
657 dentry = lookup_one_len(e->name, root, strlen(e->name));
658 err = PTR_ERR(dentry);
663 if (d_really_is_positive(dentry))
666 inode = bm_get_inode(sb, S_IFREG | 0644);
672 err = simple_pin_fs(&bm_fs_type, &bm_mnt, &entry_count);
679 if (e->flags & MISC_FMT_OPEN_FILE) {
682 f = open_exec(e->interpreter);
685 pr_notice("register: failed to install interpreter file %s\n", e->interpreter);
686 simple_release_fs(&bm_mnt, &entry_count);
694 e->dentry = dget(dentry);
695 inode->i_private = e;
696 inode->i_fop = &bm_entry_operations;
698 d_instantiate(dentry, inode);
699 write_lock(&entries_lock);
700 list_add(&e->list, &entries);
701 write_unlock(&entries_lock);
707 inode_unlock(d_inode(root));
716 static const struct file_operations bm_register_operations = {
717 .write = bm_register_write,
718 .llseek = noop_llseek,
724 bm_status_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
726 char *s = enabled ? "enabled\n" : "disabled\n";
728 return simple_read_from_buffer(buf, nbytes, ppos, s, strlen(s));
731 static ssize_t bm_status_write(struct file *file, const char __user *buffer,
732 size_t count, loff_t *ppos)
734 int res = parse_command(buffer, count);
739 /* Disable all handlers. */
743 /* Enable all handlers. */
747 /* Delete all handlers. */
748 root = file_inode(file)->i_sb->s_root;
749 inode_lock(d_inode(root));
751 while (!list_empty(&entries))
752 kill_node(list_first_entry(&entries, Node, list));
754 inode_unlock(d_inode(root));
763 static const struct file_operations bm_status_operations = {
764 .read = bm_status_read,
765 .write = bm_status_write,
766 .llseek = default_llseek,
769 /* Superblock handling */
771 static const struct super_operations s_ops = {
772 .statfs = simple_statfs,
773 .evict_inode = bm_evict_inode,
776 static int bm_fill_super(struct super_block *sb, struct fs_context *fc)
779 static const struct tree_descr bm_files[] = {
780 [2] = {"status", &bm_status_operations, S_IWUSR|S_IRUGO},
781 [3] = {"register", &bm_register_operations, S_IWUSR},
785 err = simple_fill_super(sb, BINFMTFS_MAGIC, bm_files);
791 static int bm_get_tree(struct fs_context *fc)
793 return get_tree_single(fc, bm_fill_super);
796 static const struct fs_context_operations bm_context_ops = {
797 .get_tree = bm_get_tree,
800 static int bm_init_fs_context(struct fs_context *fc)
802 fc->ops = &bm_context_ops;
806 static struct linux_binfmt misc_format = {
807 .module = THIS_MODULE,
808 .load_binary = load_misc_binary,
811 static struct file_system_type bm_fs_type = {
812 .owner = THIS_MODULE,
813 .name = "binfmt_misc",
814 .init_fs_context = bm_init_fs_context,
815 .kill_sb = kill_litter_super,
817 MODULE_ALIAS_FS("binfmt_misc");
819 static int __init init_misc_binfmt(void)
821 int err = register_filesystem(&bm_fs_type);
823 insert_binfmt(&misc_format);
827 static void __exit exit_misc_binfmt(void)
829 unregister_binfmt(&misc_format);
830 unregister_filesystem(&bm_fs_type);
833 core_initcall(init_misc_binfmt);
834 module_exit(exit_misc_binfmt);
835 MODULE_LICENSE("GPL");