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/syscalls.h>
28 #include <linux/uaccess.h>
39 VERBOSE_STATUS
= 1 /* make it zero to save 400 bytes kernel memory */
42 static LIST_HEAD(entries
);
43 static int enabled
= 1;
45 enum {Enabled
, Magic
};
46 #define MISC_FMT_PRESERVE_ARGV0 (1 << 31)
47 #define MISC_FMT_OPEN_BINARY (1 << 30)
48 #define MISC_FMT_CREDENTIALS (1 << 29)
49 #define MISC_FMT_OPEN_FILE (1 << 28)
52 struct list_head list
;
53 unsigned long flags
; /* type, status, etc. */
54 int offset
; /* offset of magic */
55 int size
; /* size of magic/mask */
56 char *magic
; /* magic or filename extension */
57 char *mask
; /* mask, NULL for exact match */
58 const char *interpreter
; /* filename of interpreter */
60 struct dentry
*dentry
;
61 struct file
*interp_file
;
64 static DEFINE_RWLOCK(entries_lock
);
65 static struct file_system_type bm_fs_type
;
66 static struct vfsmount
*bm_mnt
;
67 static int entry_count
;
70 * Max length of the register string. Determined by:
74 * - offset: 3 bytes (has to be smaller than BINPRM_BUF_SIZE)
75 * - magic: 128 bytes (512 in escaped form)
76 * - mask: 128 bytes (512 in escaped form)
79 * Round that up a bit, and then back off to hold the internal data
82 #define MAX_REGISTER_LENGTH 1920
85 * Check if we support the binfmt
86 * if we do, return the node, else NULL
87 * locking is done in load_misc_binary
89 static Node
*check_file(struct linux_binprm
*bprm
)
91 char *p
= strrchr(bprm
->interp
, '.');
94 /* Walk all the registered handlers. */
95 list_for_each(l
, &entries
) {
96 Node
*e
= list_entry(l
, Node
, list
);
100 /* Make sure this one is currently enabled. */
101 if (!test_bit(Enabled
, &e
->flags
))
104 /* Do matching based on extension if applicable. */
105 if (!test_bit(Magic
, &e
->flags
)) {
106 if (p
&& !strcmp(e
->magic
, p
+ 1))
111 /* Do matching based on magic & mask. */
112 s
= bprm
->buf
+ e
->offset
;
114 for (j
= 0; j
< e
->size
; j
++)
115 if ((*s
++ ^ e
->magic
[j
]) & e
->mask
[j
])
118 for (j
= 0; j
< e
->size
; j
++)
119 if ((*s
++ ^ e
->magic
[j
]))
131 static int load_misc_binary(struct linux_binprm
*bprm
)
134 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
) {
164 /* if the binary should be opened on behalf of the
165 * interpreter than keep it open and assign descriptor
168 fd_binary
= get_unused_fd_flags(0);
173 fd_install(fd_binary
, bprm
->file
);
175 /* if the binary is not readable than enforce mm->dumpable=0
176 regardless of the interpreter's permissions */
177 would_dump(bprm
, bprm
->file
);
179 allow_write_access(bprm
->file
);
182 /* mark the bprm that fd should be passed to interp */
183 bprm
->interp_flags
|= BINPRM_FLAGS_EXECFD
;
184 bprm
->interp_data
= fd_binary
;
187 allow_write_access(bprm
->file
);
191 /* make argv[1] be the path to the binary */
192 retval
= copy_strings_kernel(1, &bprm
->interp
, bprm
);
197 /* add the interp as argv[0] */
198 retval
= copy_strings_kernel(1, &fmt
->interpreter
, bprm
);
203 /* Update interp in case binfmt_script needs it. */
204 retval
= bprm_change_interp(fmt
->interpreter
, bprm
);
208 if (fmt
->flags
& MISC_FMT_OPEN_FILE
) {
209 interp_file
= file_clone_open(fmt
->interp_file
);
210 if (!IS_ERR(interp_file
))
211 deny_write_access(interp_file
);
213 interp_file
= open_exec(fmt
->interpreter
);
215 retval
= PTR_ERR(interp_file
);
216 if (IS_ERR(interp_file
))
219 bprm
->file
= interp_file
;
220 if (fmt
->flags
& MISC_FMT_CREDENTIALS
) {
224 * No need to call prepare_binprm(), it's already been
225 * done. bprm->buf is stale, update from interp_file.
227 memset(bprm
->buf
, 0, BINPRM_BUF_SIZE
);
228 retval
= kernel_read(bprm
->file
, bprm
->buf
, BINPRM_BUF_SIZE
,
231 retval
= prepare_binprm(bprm
);
236 retval
= search_binary_handler(bprm
);
245 ksys_close(fd_binary
);
246 bprm
->interp_flags
= 0;
247 bprm
->interp_data
= 0;
251 /* Command parsers */
254 * parses and copies one argument enclosed in del from *sp to *dp,
255 * recognising the \x special.
256 * returns pointer to the copied argument or NULL in case of an
257 * error (and sets err) or null argument length.
259 static char *scanarg(char *s
, char del
)
263 while ((c
= *s
++) != del
) {
264 if (c
== '\\' && *s
== 'x') {
276 static char *check_special_flags(char *sfs
, Node
*e
)
285 pr_debug("register: flag: P (preserve argv0)\n");
287 e
->flags
|= MISC_FMT_PRESERVE_ARGV0
;
290 pr_debug("register: flag: O (open binary)\n");
292 e
->flags
|= MISC_FMT_OPEN_BINARY
;
295 pr_debug("register: flag: C (preserve creds)\n");
297 /* this flags also implies the
299 e
->flags
|= (MISC_FMT_CREDENTIALS
|
300 MISC_FMT_OPEN_BINARY
);
303 pr_debug("register: flag: F: open interpreter file now\n");
305 e
->flags
|= MISC_FMT_OPEN_FILE
;
316 * This registers a new binary format, it recognises the syntax
317 * ':name:type:offset:magic:mask:interpreter:flags'
318 * where the ':' is the IFS, that can be chosen with the first char
320 static Node
*create_entry(const char __user
*buffer
, size_t count
)
327 pr_debug("register: received %zu bytes\n", count
);
329 /* some sanity checks */
331 if ((count
< 11) || (count
> MAX_REGISTER_LENGTH
))
335 memsize
= sizeof(Node
) + count
+ 8;
336 e
= kmalloc(memsize
, GFP_KERNEL
);
340 p
= buf
= (char *)e
+ sizeof(Node
);
342 memset(e
, 0, sizeof(Node
));
343 if (copy_from_user(buf
, buffer
, count
))
346 del
= *p
++; /* delimeter */
348 pr_debug("register: delim: %#x {%c}\n", del
, del
);
350 /* Pad the buffer with the delim to simplify parsing below. */
351 memset(buf
+ count
, del
, 8);
353 /* Parse the 'name' field. */
360 !strcmp(e
->name
, ".") ||
361 !strcmp(e
->name
, "..") ||
362 strchr(e
->name
, '/'))
365 pr_debug("register: name: {%s}\n", e
->name
);
367 /* Parse the 'type' field. */
370 pr_debug("register: type: E (extension)\n");
371 e
->flags
= 1 << Enabled
;
374 pr_debug("register: type: M (magic)\n");
375 e
->flags
= (1 << Enabled
) | (1 << Magic
);
383 if (test_bit(Magic
, &e
->flags
)) {
384 /* Handle the 'M' (magic) format. */
387 /* Parse the 'offset' field. */
393 int r
= kstrtoint(p
, 10, &e
->offset
);
394 if (r
!= 0 || e
->offset
< 0)
400 pr_debug("register: offset: %#x\n", e
->offset
);
402 /* Parse the 'magic' field. */
410 print_hex_dump_bytes(
411 KBUILD_MODNAME
": register: magic[raw]: ",
412 DUMP_PREFIX_NONE
, e
->magic
, p
- e
->magic
);
414 /* Parse the 'mask' field. */
421 pr_debug("register: mask[raw]: none\n");
422 } else if (USE_DEBUG
)
423 print_hex_dump_bytes(
424 KBUILD_MODNAME
": register: mask[raw]: ",
425 DUMP_PREFIX_NONE
, e
->mask
, p
- e
->mask
);
428 * Decode the magic & mask fields.
429 * Note: while we might have accepted embedded NUL bytes from
430 * above, the unescape helpers here will stop at the first one
433 e
->size
= string_unescape_inplace(e
->magic
, UNESCAPE_HEX
);
435 string_unescape_inplace(e
->mask
, UNESCAPE_HEX
) != e
->size
)
437 if (e
->size
> BINPRM_BUF_SIZE
||
438 BINPRM_BUF_SIZE
- e
->size
< e
->offset
)
440 pr_debug("register: magic/mask length: %i\n", e
->size
);
442 print_hex_dump_bytes(
443 KBUILD_MODNAME
": register: magic[decoded]: ",
444 DUMP_PREFIX_NONE
, e
->magic
, e
->size
);
448 char *masked
= kmalloc(e
->size
, GFP_KERNEL
);
450 print_hex_dump_bytes(
451 KBUILD_MODNAME
": register: mask[decoded]: ",
452 DUMP_PREFIX_NONE
, e
->mask
, e
->size
);
455 for (i
= 0; i
< e
->size
; ++i
)
456 masked
[i
] = e
->magic
[i
] & e
->mask
[i
];
457 print_hex_dump_bytes(
458 KBUILD_MODNAME
": register: magic[masked]: ",
459 DUMP_PREFIX_NONE
, masked
, e
->size
);
466 /* Handle the 'E' (extension) format. */
468 /* Skip the 'offset' field. */
474 /* Parse the 'magic' field. */
480 if (!e
->magic
[0] || strchr(e
->magic
, '/'))
482 pr_debug("register: extension: {%s}\n", e
->magic
);
484 /* Skip the 'mask' field. */
491 /* Parse the 'interpreter' field. */
497 if (!e
->interpreter
[0])
499 pr_debug("register: interpreter: {%s}\n", e
->interpreter
);
501 /* Parse the 'flags' field. */
502 p
= check_special_flags(p
, e
);
505 if (p
!= buf
+ count
)
515 return ERR_PTR(-EFAULT
);
518 return ERR_PTR(-EINVAL
);
522 * Set status of entry/binfmt_misc:
523 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
525 static int parse_command(const char __user
*buffer
, size_t count
)
531 if (copy_from_user(s
, buffer
, count
))
535 if (s
[count
- 1] == '\n')
537 if (count
== 1 && s
[0] == '0')
539 if (count
== 1 && s
[0] == '1')
541 if (count
== 2 && s
[0] == '-' && s
[1] == '1')
548 static void entry_status(Node
*e
, char *page
)
551 const char *status
= "disabled";
553 if (test_bit(Enabled
, &e
->flags
))
556 if (!VERBOSE_STATUS
) {
557 sprintf(page
, "%s\n", status
);
561 dp
+= sprintf(dp
, "%s\ninterpreter %s\n", status
, e
->interpreter
);
563 /* print the special flags */
564 dp
+= sprintf(dp
, "flags: ");
565 if (e
->flags
& MISC_FMT_PRESERVE_ARGV0
)
567 if (e
->flags
& MISC_FMT_OPEN_BINARY
)
569 if (e
->flags
& MISC_FMT_CREDENTIALS
)
571 if (e
->flags
& MISC_FMT_OPEN_FILE
)
575 if (!test_bit(Magic
, &e
->flags
)) {
576 sprintf(dp
, "extension .%s\n", e
->magic
);
578 dp
+= sprintf(dp
, "offset %i\nmagic ", e
->offset
);
579 dp
= bin2hex(dp
, e
->magic
, e
->size
);
581 dp
+= sprintf(dp
, "\nmask ");
582 dp
= bin2hex(dp
, e
->mask
, e
->size
);
589 static struct inode
*bm_get_inode(struct super_block
*sb
, int mode
)
591 struct inode
*inode
= new_inode(sb
);
594 inode
->i_ino
= get_next_ino();
595 inode
->i_mode
= mode
;
596 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
=
602 static void bm_evict_inode(struct inode
*inode
)
604 Node
*e
= inode
->i_private
;
606 if (e
&& e
->flags
& MISC_FMT_OPEN_FILE
)
607 filp_close(e
->interp_file
, NULL
);
613 static void kill_node(Node
*e
)
615 struct dentry
*dentry
;
617 write_lock(&entries_lock
);
618 list_del_init(&e
->list
);
619 write_unlock(&entries_lock
);
622 drop_nlink(d_inode(dentry
));
625 simple_release_fs(&bm_mnt
, &entry_count
);
631 bm_entry_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
633 Node
*e
= file_inode(file
)->i_private
;
637 page
= (char *) __get_free_page(GFP_KERNEL
);
641 entry_status(e
, page
);
643 res
= simple_read_from_buffer(buf
, nbytes
, ppos
, page
, strlen(page
));
645 free_page((unsigned long) page
);
649 static ssize_t
bm_entry_write(struct file
*file
, const char __user
*buffer
,
650 size_t count
, loff_t
*ppos
)
653 Node
*e
= file_inode(file
)->i_private
;
654 int res
= parse_command(buffer
, count
);
658 /* Disable this handler. */
659 clear_bit(Enabled
, &e
->flags
);
662 /* Enable this handler. */
663 set_bit(Enabled
, &e
->flags
);
666 /* Delete this handler. */
667 root
= file_inode(file
)->i_sb
->s_root
;
668 inode_lock(d_inode(root
));
670 if (!list_empty(&e
->list
))
673 inode_unlock(d_inode(root
));
682 static const struct file_operations bm_entry_operations
= {
683 .read
= bm_entry_read
,
684 .write
= bm_entry_write
,
685 .llseek
= default_llseek
,
690 static ssize_t
bm_register_write(struct file
*file
, const char __user
*buffer
,
691 size_t count
, loff_t
*ppos
)
695 struct super_block
*sb
= file_inode(file
)->i_sb
;
696 struct dentry
*root
= sb
->s_root
, *dentry
;
699 e
= create_entry(buffer
, count
);
704 inode_lock(d_inode(root
));
705 dentry
= lookup_one_len(e
->name
, root
, strlen(e
->name
));
706 err
= PTR_ERR(dentry
);
711 if (d_really_is_positive(dentry
))
714 inode
= bm_get_inode(sb
, S_IFREG
| 0644);
720 err
= simple_pin_fs(&bm_fs_type
, &bm_mnt
, &entry_count
);
727 if (e
->flags
& MISC_FMT_OPEN_FILE
) {
730 f
= open_exec(e
->interpreter
);
733 pr_notice("register: failed to install interpreter file %s\n", e
->interpreter
);
734 simple_release_fs(&bm_mnt
, &entry_count
);
742 e
->dentry
= dget(dentry
);
743 inode
->i_private
= e
;
744 inode
->i_fop
= &bm_entry_operations
;
746 d_instantiate(dentry
, inode
);
747 write_lock(&entries_lock
);
748 list_add(&e
->list
, &entries
);
749 write_unlock(&entries_lock
);
755 inode_unlock(d_inode(root
));
764 static const struct file_operations bm_register_operations
= {
765 .write
= bm_register_write
,
766 .llseek
= noop_llseek
,
772 bm_status_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
774 char *s
= enabled
? "enabled\n" : "disabled\n";
776 return simple_read_from_buffer(buf
, nbytes
, ppos
, s
, strlen(s
));
779 static ssize_t
bm_status_write(struct file
*file
, const char __user
*buffer
,
780 size_t count
, loff_t
*ppos
)
782 int res
= parse_command(buffer
, count
);
787 /* Disable all handlers. */
791 /* Enable all handlers. */
795 /* Delete all handlers. */
796 root
= file_inode(file
)->i_sb
->s_root
;
797 inode_lock(d_inode(root
));
799 while (!list_empty(&entries
))
800 kill_node(list_first_entry(&entries
, Node
, list
));
802 inode_unlock(d_inode(root
));
811 static const struct file_operations bm_status_operations
= {
812 .read
= bm_status_read
,
813 .write
= bm_status_write
,
814 .llseek
= default_llseek
,
817 /* Superblock handling */
819 static const struct super_operations s_ops
= {
820 .statfs
= simple_statfs
,
821 .evict_inode
= bm_evict_inode
,
824 static int bm_fill_super(struct super_block
*sb
, void *data
, int silent
)
827 static const struct tree_descr bm_files
[] = {
828 [2] = {"status", &bm_status_operations
, S_IWUSR
|S_IRUGO
},
829 [3] = {"register", &bm_register_operations
, S_IWUSR
},
833 err
= simple_fill_super(sb
, BINFMTFS_MAGIC
, bm_files
);
839 static struct dentry
*bm_mount(struct file_system_type
*fs_type
,
840 int flags
, const char *dev_name
, void *data
)
842 return mount_single(fs_type
, flags
, data
, bm_fill_super
);
845 static struct linux_binfmt misc_format
= {
846 .module
= THIS_MODULE
,
847 .load_binary
= load_misc_binary
,
850 static struct file_system_type bm_fs_type
= {
851 .owner
= THIS_MODULE
,
852 .name
= "binfmt_misc",
854 .kill_sb
= kill_litter_super
,
856 MODULE_ALIAS_FS("binfmt_misc");
858 static int __init
init_misc_binfmt(void)
860 int err
= register_filesystem(&bm_fs_type
);
862 insert_binfmt(&misc_format
);
866 static void __exit
exit_misc_binfmt(void)
868 unregister_binfmt(&misc_format
);
869 unregister_filesystem(&bm_fs_type
);
872 core_initcall(init_misc_binfmt
);
873 module_exit(exit_misc_binfmt
);
874 MODULE_LICENSE("GPL");