4 * Copyright (C) 1997 Richard Günther
6 * binfmt_misc detects binaries via a magic or filename extension and invokes
7 * a specified wrapper. See Documentation/admin-guide/binfmt-misc.rst for more details.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/sched/mm.h>
16 #include <linux/magic.h>
17 #include <linux/binfmts.h>
18 #include <linux/slab.h>
19 #include <linux/ctype.h>
20 #include <linux/string_helpers.h>
21 #include <linux/file.h>
22 #include <linux/pagemap.h>
23 #include <linux/namei.h>
24 #include <linux/mount.h>
25 #include <linux/syscalls.h>
27 #include <linux/uaccess.h>
38 VERBOSE_STATUS
= 1 /* make it zero to save 400 bytes kernel memory */
41 static LIST_HEAD(entries
);
42 static int enabled
= 1;
44 enum {Enabled
, Magic
};
45 #define MISC_FMT_PRESERVE_ARGV0 (1 << 31)
46 #define MISC_FMT_OPEN_BINARY (1 << 30)
47 #define MISC_FMT_CREDENTIALS (1 << 29)
48 #define MISC_FMT_OPEN_FILE (1 << 28)
51 struct list_head list
;
52 unsigned long flags
; /* type, status, etc. */
53 int offset
; /* offset of magic */
54 int size
; /* size of magic/mask */
55 char *magic
; /* magic or filename extension */
56 char *mask
; /* mask, NULL for exact match */
57 const char *interpreter
; /* filename of interpreter */
59 struct dentry
*dentry
;
60 struct file
*interp_file
;
63 static DEFINE_RWLOCK(entries_lock
);
64 static struct file_system_type bm_fs_type
;
65 static struct vfsmount
*bm_mnt
;
66 static int entry_count
;
69 * Max length of the register string. Determined by:
73 * - offset: 3 bytes (has to be smaller than BINPRM_BUF_SIZE)
74 * - magic: 128 bytes (512 in escaped form)
75 * - mask: 128 bytes (512 in escaped form)
78 * Round that up a bit, and then back off to hold the internal data
81 #define MAX_REGISTER_LENGTH 1920
84 * Check if we support the binfmt
85 * if we do, return the node, else NULL
86 * locking is done in load_misc_binary
88 static Node
*check_file(struct linux_binprm
*bprm
)
90 char *p
= strrchr(bprm
->interp
, '.');
93 /* Walk all the registered handlers. */
94 list_for_each(l
, &entries
) {
95 Node
*e
= list_entry(l
, Node
, list
);
99 /* Make sure this one is currently enabled. */
100 if (!test_bit(Enabled
, &e
->flags
))
103 /* Do matching based on extension if applicable. */
104 if (!test_bit(Magic
, &e
->flags
)) {
105 if (p
&& !strcmp(e
->magic
, p
+ 1))
110 /* Do matching based on magic & mask. */
111 s
= bprm
->buf
+ e
->offset
;
113 for (j
= 0; j
< e
->size
; j
++)
114 if ((*s
++ ^ e
->magic
[j
]) & e
->mask
[j
])
117 for (j
= 0; j
< e
->size
; j
++)
118 if ((*s
++ ^ e
->magic
[j
]))
130 static int load_misc_binary(struct linux_binprm
*bprm
)
133 struct file
*interp_file
= NULL
;
141 /* to keep locking time low, we copy the interpreter string */
142 read_lock(&entries_lock
);
143 fmt
= check_file(bprm
);
146 read_unlock(&entries_lock
);
150 /* Need to be able to load the file after exec */
152 if (bprm
->interp_flags
& BINPRM_FLAGS_PATH_INACCESSIBLE
)
155 if (!(fmt
->flags
& MISC_FMT_PRESERVE_ARGV0
)) {
156 retval
= remove_arg_zero(bprm
);
161 if (fmt
->flags
& MISC_FMT_OPEN_BINARY
) {
163 /* if the binary should be opened on behalf of the
164 * interpreter than keep it open and assign descriptor
167 fd_binary
= get_unused_fd_flags(0);
172 fd_install(fd_binary
, bprm
->file
);
174 /* if the binary is not readable than enforce mm->dumpable=0
175 regardless of the interpreter's permissions */
176 would_dump(bprm
, bprm
->file
);
178 allow_write_access(bprm
->file
);
181 /* mark the bprm that fd should be passed to interp */
182 bprm
->interp_flags
|= BINPRM_FLAGS_EXECFD
;
183 bprm
->interp_data
= fd_binary
;
186 allow_write_access(bprm
->file
);
190 /* make argv[1] be the path to the binary */
191 retval
= copy_strings_kernel(1, &bprm
->interp
, bprm
);
196 /* add the interp as argv[0] */
197 retval
= copy_strings_kernel(1, &fmt
->interpreter
, bprm
);
202 /* Update interp in case binfmt_script needs it. */
203 retval
= bprm_change_interp(fmt
->interpreter
, bprm
);
207 if (fmt
->flags
& MISC_FMT_OPEN_FILE
) {
208 interp_file
= filp_clone_open(fmt
->interp_file
);
209 if (!IS_ERR(interp_file
))
210 deny_write_access(interp_file
);
212 interp_file
= open_exec(fmt
->interpreter
);
214 retval
= PTR_ERR(interp_file
);
215 if (IS_ERR(interp_file
))
218 bprm
->file
= interp_file
;
219 if (fmt
->flags
& MISC_FMT_CREDENTIALS
) {
223 * No need to call prepare_binprm(), it's already been
224 * done. bprm->buf is stale, update from interp_file.
226 memset(bprm
->buf
, 0, BINPRM_BUF_SIZE
);
227 retval
= kernel_read(bprm
->file
, bprm
->buf
, BINPRM_BUF_SIZE
,
230 retval
= prepare_binprm(bprm
);
235 retval
= search_binary_handler(bprm
);
244 ksys_close(fd_binary
);
245 bprm
->interp_flags
= 0;
246 bprm
->interp_data
= 0;
250 /* Command parsers */
253 * parses and copies one argument enclosed in del from *sp to *dp,
254 * recognising the \x special.
255 * returns pointer to the copied argument or NULL in case of an
256 * error (and sets err) or null argument length.
258 static char *scanarg(char *s
, char del
)
262 while ((c
= *s
++) != del
) {
263 if (c
== '\\' && *s
== 'x') {
275 static char *check_special_flags(char *sfs
, Node
*e
)
284 pr_debug("register: flag: P (preserve argv0)\n");
286 e
->flags
|= MISC_FMT_PRESERVE_ARGV0
;
289 pr_debug("register: flag: O (open binary)\n");
291 e
->flags
|= MISC_FMT_OPEN_BINARY
;
294 pr_debug("register: flag: C (preserve creds)\n");
296 /* this flags also implies the
298 e
->flags
|= (MISC_FMT_CREDENTIALS
|
299 MISC_FMT_OPEN_BINARY
);
302 pr_debug("register: flag: F: open interpreter file now\n");
304 e
->flags
|= MISC_FMT_OPEN_FILE
;
315 * This registers a new binary format, it recognises the syntax
316 * ':name:type:offset:magic:mask:interpreter:flags'
317 * where the ':' is the IFS, that can be chosen with the first char
319 static Node
*create_entry(const char __user
*buffer
, size_t count
)
326 pr_debug("register: received %zu bytes\n", count
);
328 /* some sanity checks */
330 if ((count
< 11) || (count
> MAX_REGISTER_LENGTH
))
334 memsize
= sizeof(Node
) + count
+ 8;
335 e
= kmalloc(memsize
, GFP_KERNEL
);
339 p
= buf
= (char *)e
+ sizeof(Node
);
341 memset(e
, 0, sizeof(Node
));
342 if (copy_from_user(buf
, buffer
, count
))
345 del
= *p
++; /* delimeter */
347 pr_debug("register: delim: %#x {%c}\n", del
, del
);
349 /* Pad the buffer with the delim to simplify parsing below. */
350 memset(buf
+ count
, del
, 8);
352 /* Parse the 'name' field. */
359 !strcmp(e
->name
, ".") ||
360 !strcmp(e
->name
, "..") ||
361 strchr(e
->name
, '/'))
364 pr_debug("register: name: {%s}\n", e
->name
);
366 /* Parse the 'type' field. */
369 pr_debug("register: type: E (extension)\n");
370 e
->flags
= 1 << Enabled
;
373 pr_debug("register: type: M (magic)\n");
374 e
->flags
= (1 << Enabled
) | (1 << Magic
);
382 if (test_bit(Magic
, &e
->flags
)) {
383 /* Handle the 'M' (magic) format. */
386 /* Parse the 'offset' field. */
392 int r
= kstrtoint(p
, 10, &e
->offset
);
393 if (r
!= 0 || e
->offset
< 0)
399 pr_debug("register: offset: %#x\n", e
->offset
);
401 /* Parse the 'magic' field. */
409 print_hex_dump_bytes(
410 KBUILD_MODNAME
": register: magic[raw]: ",
411 DUMP_PREFIX_NONE
, e
->magic
, p
- e
->magic
);
413 /* Parse the 'mask' field. */
420 pr_debug("register: mask[raw]: none\n");
421 } else if (USE_DEBUG
)
422 print_hex_dump_bytes(
423 KBUILD_MODNAME
": register: mask[raw]: ",
424 DUMP_PREFIX_NONE
, e
->mask
, p
- e
->mask
);
427 * Decode the magic & mask fields.
428 * Note: while we might have accepted embedded NUL bytes from
429 * above, the unescape helpers here will stop at the first one
432 e
->size
= string_unescape_inplace(e
->magic
, UNESCAPE_HEX
);
434 string_unescape_inplace(e
->mask
, UNESCAPE_HEX
) != e
->size
)
436 if (e
->size
> BINPRM_BUF_SIZE
||
437 BINPRM_BUF_SIZE
- e
->size
< e
->offset
)
439 pr_debug("register: magic/mask length: %i\n", e
->size
);
441 print_hex_dump_bytes(
442 KBUILD_MODNAME
": register: magic[decoded]: ",
443 DUMP_PREFIX_NONE
, e
->magic
, e
->size
);
447 char *masked
= kmalloc(e
->size
, GFP_KERNEL
);
449 print_hex_dump_bytes(
450 KBUILD_MODNAME
": register: mask[decoded]: ",
451 DUMP_PREFIX_NONE
, e
->mask
, e
->size
);
454 for (i
= 0; i
< e
->size
; ++i
)
455 masked
[i
] = e
->magic
[i
] & e
->mask
[i
];
456 print_hex_dump_bytes(
457 KBUILD_MODNAME
": register: magic[masked]: ",
458 DUMP_PREFIX_NONE
, masked
, e
->size
);
465 /* Handle the 'E' (extension) format. */
467 /* Skip the 'offset' field. */
473 /* Parse the 'magic' field. */
479 if (!e
->magic
[0] || strchr(e
->magic
, '/'))
481 pr_debug("register: extension: {%s}\n", e
->magic
);
483 /* Skip the 'mask' field. */
490 /* Parse the 'interpreter' field. */
496 if (!e
->interpreter
[0])
498 pr_debug("register: interpreter: {%s}\n", e
->interpreter
);
500 /* Parse the 'flags' field. */
501 p
= check_special_flags(p
, e
);
504 if (p
!= buf
+ count
)
514 return ERR_PTR(-EFAULT
);
517 return ERR_PTR(-EINVAL
);
521 * Set status of entry/binfmt_misc:
522 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
524 static int parse_command(const char __user
*buffer
, size_t count
)
530 if (copy_from_user(s
, buffer
, count
))
534 if (s
[count
- 1] == '\n')
536 if (count
== 1 && s
[0] == '0')
538 if (count
== 1 && s
[0] == '1')
540 if (count
== 2 && s
[0] == '-' && s
[1] == '1')
547 static void entry_status(Node
*e
, char *page
)
550 const char *status
= "disabled";
552 if (test_bit(Enabled
, &e
->flags
))
555 if (!VERBOSE_STATUS
) {
556 sprintf(page
, "%s\n", status
);
560 dp
+= sprintf(dp
, "%s\ninterpreter %s\n", status
, e
->interpreter
);
562 /* print the special flags */
563 dp
+= sprintf(dp
, "flags: ");
564 if (e
->flags
& MISC_FMT_PRESERVE_ARGV0
)
566 if (e
->flags
& MISC_FMT_OPEN_BINARY
)
568 if (e
->flags
& MISC_FMT_CREDENTIALS
)
570 if (e
->flags
& MISC_FMT_OPEN_FILE
)
574 if (!test_bit(Magic
, &e
->flags
)) {
575 sprintf(dp
, "extension .%s\n", e
->magic
);
577 dp
+= sprintf(dp
, "offset %i\nmagic ", e
->offset
);
578 dp
= bin2hex(dp
, e
->magic
, e
->size
);
580 dp
+= sprintf(dp
, "\nmask ");
581 dp
= bin2hex(dp
, e
->mask
, e
->size
);
588 static struct inode
*bm_get_inode(struct super_block
*sb
, int mode
)
590 struct inode
*inode
= new_inode(sb
);
593 inode
->i_ino
= get_next_ino();
594 inode
->i_mode
= mode
;
595 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
=
601 static void bm_evict_inode(struct inode
*inode
)
603 Node
*e
= inode
->i_private
;
605 if (e
&& e
->flags
& MISC_FMT_OPEN_FILE
)
606 filp_close(e
->interp_file
, NULL
);
612 static void kill_node(Node
*e
)
614 struct dentry
*dentry
;
616 write_lock(&entries_lock
);
617 list_del_init(&e
->list
);
618 write_unlock(&entries_lock
);
621 drop_nlink(d_inode(dentry
));
624 simple_release_fs(&bm_mnt
, &entry_count
);
630 bm_entry_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
632 Node
*e
= file_inode(file
)->i_private
;
636 page
= (char *) __get_free_page(GFP_KERNEL
);
640 entry_status(e
, page
);
642 res
= simple_read_from_buffer(buf
, nbytes
, ppos
, page
, strlen(page
));
644 free_page((unsigned long) page
);
648 static ssize_t
bm_entry_write(struct file
*file
, const char __user
*buffer
,
649 size_t count
, loff_t
*ppos
)
652 Node
*e
= file_inode(file
)->i_private
;
653 int res
= parse_command(buffer
, count
);
657 /* Disable this handler. */
658 clear_bit(Enabled
, &e
->flags
);
661 /* Enable this handler. */
662 set_bit(Enabled
, &e
->flags
);
665 /* Delete this handler. */
666 root
= file_inode(file
)->i_sb
->s_root
;
667 inode_lock(d_inode(root
));
669 if (!list_empty(&e
->list
))
672 inode_unlock(d_inode(root
));
681 static const struct file_operations bm_entry_operations
= {
682 .read
= bm_entry_read
,
683 .write
= bm_entry_write
,
684 .llseek
= default_llseek
,
689 static ssize_t
bm_register_write(struct file
*file
, const char __user
*buffer
,
690 size_t count
, loff_t
*ppos
)
694 struct super_block
*sb
= file_inode(file
)->i_sb
;
695 struct dentry
*root
= sb
->s_root
, *dentry
;
698 e
= create_entry(buffer
, count
);
703 inode_lock(d_inode(root
));
704 dentry
= lookup_one_len(e
->name
, root
, strlen(e
->name
));
705 err
= PTR_ERR(dentry
);
710 if (d_really_is_positive(dentry
))
713 inode
= bm_get_inode(sb
, S_IFREG
| 0644);
719 err
= simple_pin_fs(&bm_fs_type
, &bm_mnt
, &entry_count
);
726 if (e
->flags
& MISC_FMT_OPEN_FILE
) {
729 f
= open_exec(e
->interpreter
);
732 pr_notice("register: failed to install interpreter file %s\n", e
->interpreter
);
733 simple_release_fs(&bm_mnt
, &entry_count
);
741 e
->dentry
= dget(dentry
);
742 inode
->i_private
= e
;
743 inode
->i_fop
= &bm_entry_operations
;
745 d_instantiate(dentry
, inode
);
746 write_lock(&entries_lock
);
747 list_add(&e
->list
, &entries
);
748 write_unlock(&entries_lock
);
754 inode_unlock(d_inode(root
));
763 static const struct file_operations bm_register_operations
= {
764 .write
= bm_register_write
,
765 .llseek
= noop_llseek
,
771 bm_status_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
773 char *s
= enabled
? "enabled\n" : "disabled\n";
775 return simple_read_from_buffer(buf
, nbytes
, ppos
, s
, strlen(s
));
778 static ssize_t
bm_status_write(struct file
*file
, const char __user
*buffer
,
779 size_t count
, loff_t
*ppos
)
781 int res
= parse_command(buffer
, count
);
786 /* Disable all handlers. */
790 /* Enable all handlers. */
794 /* Delete all handlers. */
795 root
= file_inode(file
)->i_sb
->s_root
;
796 inode_lock(d_inode(root
));
798 while (!list_empty(&entries
))
799 kill_node(list_first_entry(&entries
, Node
, list
));
801 inode_unlock(d_inode(root
));
810 static const struct file_operations bm_status_operations
= {
811 .read
= bm_status_read
,
812 .write
= bm_status_write
,
813 .llseek
= default_llseek
,
816 /* Superblock handling */
818 static const struct super_operations s_ops
= {
819 .statfs
= simple_statfs
,
820 .evict_inode
= bm_evict_inode
,
823 static int bm_fill_super(struct super_block
*sb
, void *data
, int silent
)
826 static const struct tree_descr bm_files
[] = {
827 [2] = {"status", &bm_status_operations
, S_IWUSR
|S_IRUGO
},
828 [3] = {"register", &bm_register_operations
, S_IWUSR
},
832 err
= simple_fill_super(sb
, BINFMTFS_MAGIC
, bm_files
);
838 static struct dentry
*bm_mount(struct file_system_type
*fs_type
,
839 int flags
, const char *dev_name
, void *data
)
841 return mount_single(fs_type
, flags
, data
, bm_fill_super
);
844 static struct linux_binfmt misc_format
= {
845 .module
= THIS_MODULE
,
846 .load_binary
= load_misc_binary
,
849 static struct file_system_type bm_fs_type
= {
850 .owner
= THIS_MODULE
,
851 .name
= "binfmt_misc",
853 .kill_sb
= kill_litter_super
,
855 MODULE_ALIAS_FS("binfmt_misc");
857 static int __init
init_misc_binfmt(void)
859 int err
= register_filesystem(&bm_fs_type
);
861 insert_binfmt(&misc_format
);
865 static void __exit
exit_misc_binfmt(void)
867 unregister_binfmt(&misc_format
);
868 unregister_filesystem(&bm_fs_type
);
871 core_initcall(init_misc_binfmt
);
872 module_exit(exit_misc_binfmt
);
873 MODULE_LICENSE("GPL");