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/binfmt_misc.txt 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.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>
36 VERBOSE_STATUS
= 1 /* make it zero to save 400 bytes kernel memory */
39 static LIST_HEAD(entries
);
40 static int enabled
= 1;
42 enum {Enabled
, Magic
};
43 #define MISC_FMT_PRESERVE_ARGV0 (1 << 31)
44 #define MISC_FMT_OPEN_BINARY (1 << 30)
45 #define MISC_FMT_CREDENTIALS (1 << 29)
48 struct list_head list
;
49 unsigned long flags
; /* type, status, etc. */
50 int offset
; /* offset of magic */
51 int size
; /* size of magic/mask */
52 char *magic
; /* magic or filename extension */
53 char *mask
; /* mask, NULL for exact match */
54 char *interpreter
; /* filename of interpreter */
56 struct dentry
*dentry
;
59 static DEFINE_RWLOCK(entries_lock
);
60 static struct file_system_type bm_fs_type
;
61 static struct vfsmount
*bm_mnt
;
62 static int entry_count
;
65 * Max length of the register string. Determined by:
69 * - offset: 3 bytes (has to be smaller than BINPRM_BUF_SIZE)
70 * - magic: 128 bytes (512 in escaped form)
71 * - mask: 128 bytes (512 in escaped form)
74 * Round that up a bit, and then back off to hold the internal data
77 #define MAX_REGISTER_LENGTH 1920
80 * Check if we support the binfmt
81 * if we do, return the node, else NULL
82 * locking is done in load_misc_binary
84 static Node
*check_file(struct linux_binprm
*bprm
)
86 char *p
= strrchr(bprm
->interp
, '.');
89 /* Walk all the registered handlers. */
90 list_for_each(l
, &entries
) {
91 Node
*e
= list_entry(l
, Node
, list
);
95 /* Make sure this one is currently enabled. */
96 if (!test_bit(Enabled
, &e
->flags
))
99 /* Do matching based on extension if applicable. */
100 if (!test_bit(Magic
, &e
->flags
)) {
101 if (p
&& !strcmp(e
->magic
, p
+ 1))
106 /* Do matching based on magic & mask. */
107 s
= bprm
->buf
+ e
->offset
;
109 for (j
= 0; j
< e
->size
; j
++)
110 if ((*s
++ ^ e
->magic
[j
]) & e
->mask
[j
])
113 for (j
= 0; j
< e
->size
; j
++)
114 if ((*s
++ ^ e
->magic
[j
]))
126 static int load_misc_binary(struct linux_binprm
*bprm
)
129 struct file
*interp_file
= NULL
;
130 char iname
[BINPRM_BUF_SIZE
];
131 const char *iname_addr
= iname
;
139 /* to keep locking time low, we copy the interpreter string */
140 read_lock(&entries_lock
);
141 fmt
= check_file(bprm
);
143 strlcpy(iname
, fmt
->interpreter
, BINPRM_BUF_SIZE
);
144 read_unlock(&entries_lock
);
148 /* Need to be able to load the file after exec */
149 if (bprm
->interp_flags
& BINPRM_FLAGS_PATH_INACCESSIBLE
)
152 if (!(fmt
->flags
& MISC_FMT_PRESERVE_ARGV0
)) {
153 retval
= remove_arg_zero(bprm
);
158 if (fmt
->flags
& MISC_FMT_OPEN_BINARY
) {
160 /* if the binary should be opened on behalf of the
161 * interpreter than keep it open and assign descriptor
164 fd_binary
= get_unused_fd_flags(0);
169 fd_install(fd_binary
, bprm
->file
);
171 /* if the binary is not readable than enforce mm->dumpable=0
172 regardless of the interpreter's permissions */
173 would_dump(bprm
, bprm
->file
);
175 allow_write_access(bprm
->file
);
178 /* mark the bprm that fd should be passed to interp */
179 bprm
->interp_flags
|= BINPRM_FLAGS_EXECFD
;
180 bprm
->interp_data
= fd_binary
;
183 allow_write_access(bprm
->file
);
187 /* make argv[1] be the path to the binary */
188 retval
= copy_strings_kernel(1, &bprm
->interp
, bprm
);
193 /* add the interp as argv[0] */
194 retval
= copy_strings_kernel(1, &iname_addr
, bprm
);
199 /* Update interp in case binfmt_script needs it. */
200 retval
= bprm_change_interp(iname
, bprm
);
204 interp_file
= open_exec(iname
);
205 retval
= PTR_ERR(interp_file
);
206 if (IS_ERR(interp_file
))
209 bprm
->file
= interp_file
;
210 if (fmt
->flags
& MISC_FMT_CREDENTIALS
) {
212 * No need to call prepare_binprm(), it's already been
213 * done. bprm->buf is stale, update from interp_file.
215 memset(bprm
->buf
, 0, BINPRM_BUF_SIZE
);
216 retval
= kernel_read(bprm
->file
, 0, bprm
->buf
, BINPRM_BUF_SIZE
);
218 retval
= prepare_binprm(bprm
);
223 retval
= search_binary_handler(bprm
);
231 sys_close(fd_binary
);
232 bprm
->interp_flags
= 0;
233 bprm
->interp_data
= 0;
237 /* Command parsers */
240 * parses and copies one argument enclosed in del from *sp to *dp,
241 * recognising the \x special.
242 * returns pointer to the copied argument or NULL in case of an
243 * error (and sets err) or null argument length.
245 static char *scanarg(char *s
, char del
)
249 while ((c
= *s
++) != del
) {
250 if (c
== '\\' && *s
== 'x') {
262 static char *check_special_flags(char *sfs
, Node
*e
)
271 pr_debug("register: flag: P (preserve argv0)\n");
273 e
->flags
|= MISC_FMT_PRESERVE_ARGV0
;
276 pr_debug("register: flag: O (open binary)\n");
278 e
->flags
|= MISC_FMT_OPEN_BINARY
;
281 pr_debug("register: flag: C (preserve creds)\n");
283 /* this flags also implies the
285 e
->flags
|= (MISC_FMT_CREDENTIALS
|
286 MISC_FMT_OPEN_BINARY
);
297 * This registers a new binary format, it recognises the syntax
298 * ':name:type:offset:magic:mask:interpreter:flags'
299 * where the ':' is the IFS, that can be chosen with the first char
301 static Node
*create_entry(const char __user
*buffer
, size_t count
)
308 pr_debug("register: received %zu bytes\n", count
);
310 /* some sanity checks */
312 if ((count
< 11) || (count
> MAX_REGISTER_LENGTH
))
316 memsize
= sizeof(Node
) + count
+ 8;
317 e
= kmalloc(memsize
, GFP_KERNEL
);
321 p
= buf
= (char *)e
+ sizeof(Node
);
323 memset(e
, 0, sizeof(Node
));
324 if (copy_from_user(buf
, buffer
, count
))
327 del
= *p
++; /* delimeter */
329 pr_debug("register: delim: %#x {%c}\n", del
, del
);
331 /* Pad the buffer with the delim to simplify parsing below. */
332 memset(buf
+ count
, del
, 8);
334 /* Parse the 'name' field. */
341 !strcmp(e
->name
, ".") ||
342 !strcmp(e
->name
, "..") ||
343 strchr(e
->name
, '/'))
346 pr_debug("register: name: {%s}\n", e
->name
);
348 /* Parse the 'type' field. */
351 pr_debug("register: type: E (extension)\n");
352 e
->flags
= 1 << Enabled
;
355 pr_debug("register: type: M (magic)\n");
356 e
->flags
= (1 << Enabled
) | (1 << Magic
);
364 if (test_bit(Magic
, &e
->flags
)) {
365 /* Handle the 'M' (magic) format. */
368 /* Parse the 'offset' field. */
373 e
->offset
= simple_strtoul(p
, &p
, 10);
376 pr_debug("register: offset: %#x\n", e
->offset
);
378 /* Parse the 'magic' field. */
386 print_hex_dump_bytes(
387 KBUILD_MODNAME
": register: magic[raw]: ",
388 DUMP_PREFIX_NONE
, e
->magic
, p
- e
->magic
);
390 /* Parse the 'mask' field. */
397 pr_debug("register: mask[raw]: none\n");
398 } else if (USE_DEBUG
)
399 print_hex_dump_bytes(
400 KBUILD_MODNAME
": register: mask[raw]: ",
401 DUMP_PREFIX_NONE
, e
->mask
, p
- e
->mask
);
404 * Decode the magic & mask fields.
405 * Note: while we might have accepted embedded NUL bytes from
406 * above, the unescape helpers here will stop at the first one
409 e
->size
= string_unescape_inplace(e
->magic
, UNESCAPE_HEX
);
411 string_unescape_inplace(e
->mask
, UNESCAPE_HEX
) != e
->size
)
413 if (e
->size
+ e
->offset
> BINPRM_BUF_SIZE
)
415 pr_debug("register: magic/mask length: %i\n", e
->size
);
417 print_hex_dump_bytes(
418 KBUILD_MODNAME
": register: magic[decoded]: ",
419 DUMP_PREFIX_NONE
, e
->magic
, e
->size
);
423 char *masked
= kmalloc(e
->size
, GFP_KERNEL
);
425 print_hex_dump_bytes(
426 KBUILD_MODNAME
": register: mask[decoded]: ",
427 DUMP_PREFIX_NONE
, e
->mask
, e
->size
);
430 for (i
= 0; i
< e
->size
; ++i
)
431 masked
[i
] = e
->magic
[i
] & e
->mask
[i
];
432 print_hex_dump_bytes(
433 KBUILD_MODNAME
": register: magic[masked]: ",
434 DUMP_PREFIX_NONE
, masked
, e
->size
);
441 /* Handle the 'E' (extension) format. */
443 /* Skip the 'offset' field. */
449 /* Parse the 'magic' field. */
455 if (!e
->magic
[0] || strchr(e
->magic
, '/'))
457 pr_debug("register: extension: {%s}\n", e
->magic
);
459 /* Skip the 'mask' field. */
466 /* Parse the 'interpreter' field. */
472 if (!e
->interpreter
[0])
474 pr_debug("register: interpreter: {%s}\n", e
->interpreter
);
476 /* Parse the 'flags' field. */
477 p
= check_special_flags(p
, e
);
480 if (p
!= buf
+ count
)
490 return ERR_PTR(-EFAULT
);
493 return ERR_PTR(-EINVAL
);
497 * Set status of entry/binfmt_misc:
498 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
500 static int parse_command(const char __user
*buffer
, size_t count
)
506 if (copy_from_user(s
, buffer
, count
))
510 if (s
[count
- 1] == '\n')
512 if (count
== 1 && s
[0] == '0')
514 if (count
== 1 && s
[0] == '1')
516 if (count
== 2 && s
[0] == '-' && s
[1] == '1')
523 static void entry_status(Node
*e
, char *page
)
526 const char *status
= "disabled";
528 if (test_bit(Enabled
, &e
->flags
))
531 if (!VERBOSE_STATUS
) {
532 sprintf(page
, "%s\n", status
);
536 dp
+= sprintf(dp
, "%s\ninterpreter %s\n", status
, e
->interpreter
);
538 /* print the special flags */
539 dp
+= sprintf(dp
, "flags: ");
540 if (e
->flags
& MISC_FMT_PRESERVE_ARGV0
)
542 if (e
->flags
& MISC_FMT_OPEN_BINARY
)
544 if (e
->flags
& MISC_FMT_CREDENTIALS
)
548 if (!test_bit(Magic
, &e
->flags
)) {
549 sprintf(dp
, "extension .%s\n", e
->magic
);
551 dp
+= sprintf(dp
, "offset %i\nmagic ", e
->offset
);
552 dp
= bin2hex(dp
, e
->magic
, e
->size
);
554 dp
+= sprintf(dp
, "\nmask ");
555 dp
= bin2hex(dp
, e
->mask
, e
->size
);
562 static struct inode
*bm_get_inode(struct super_block
*sb
, int mode
)
564 struct inode
*inode
= new_inode(sb
);
567 inode
->i_ino
= get_next_ino();
568 inode
->i_mode
= mode
;
569 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
=
570 current_fs_time(inode
->i_sb
);
575 static void bm_evict_inode(struct inode
*inode
)
578 kfree(inode
->i_private
);
581 static void kill_node(Node
*e
)
583 struct dentry
*dentry
;
585 write_lock(&entries_lock
);
588 list_del_init(&e
->list
);
591 write_unlock(&entries_lock
);
594 drop_nlink(d_inode(dentry
));
597 simple_release_fs(&bm_mnt
, &entry_count
);
604 bm_entry_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
606 Node
*e
= file_inode(file
)->i_private
;
610 page
= (char *) __get_free_page(GFP_KERNEL
);
614 entry_status(e
, page
);
616 res
= simple_read_from_buffer(buf
, nbytes
, ppos
, page
, strlen(page
));
618 free_page((unsigned long) page
);
622 static ssize_t
bm_entry_write(struct file
*file
, const char __user
*buffer
,
623 size_t count
, loff_t
*ppos
)
626 Node
*e
= file_inode(file
)->i_private
;
627 int res
= parse_command(buffer
, count
);
631 /* Disable this handler. */
632 clear_bit(Enabled
, &e
->flags
);
635 /* Enable this handler. */
636 set_bit(Enabled
, &e
->flags
);
639 /* Delete this handler. */
640 root
= file_inode(file
)->i_sb
->s_root
;
641 inode_lock(d_inode(root
));
645 inode_unlock(d_inode(root
));
654 static const struct file_operations bm_entry_operations
= {
655 .read
= bm_entry_read
,
656 .write
= bm_entry_write
,
657 .llseek
= default_llseek
,
662 static ssize_t
bm_register_write(struct file
*file
, const char __user
*buffer
,
663 size_t count
, loff_t
*ppos
)
667 struct super_block
*sb
= file_inode(file
)->i_sb
;
668 struct dentry
*root
= sb
->s_root
, *dentry
;
671 e
= create_entry(buffer
, count
);
676 inode_lock(d_inode(root
));
677 dentry
= lookup_one_len(e
->name
, root
, strlen(e
->name
));
678 err
= PTR_ERR(dentry
);
683 if (d_really_is_positive(dentry
))
686 inode
= bm_get_inode(sb
, S_IFREG
| 0644);
692 err
= simple_pin_fs(&bm_fs_type
, &bm_mnt
, &entry_count
);
699 e
->dentry
= dget(dentry
);
700 inode
->i_private
= e
;
701 inode
->i_fop
= &bm_entry_operations
;
703 d_instantiate(dentry
, inode
);
704 write_lock(&entries_lock
);
705 list_add(&e
->list
, &entries
);
706 write_unlock(&entries_lock
);
712 inode_unlock(d_inode(root
));
721 static const struct file_operations bm_register_operations
= {
722 .write
= bm_register_write
,
723 .llseek
= noop_llseek
,
729 bm_status_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
731 char *s
= enabled
? "enabled\n" : "disabled\n";
733 return simple_read_from_buffer(buf
, nbytes
, ppos
, s
, strlen(s
));
736 static ssize_t
bm_status_write(struct file
*file
, const char __user
*buffer
,
737 size_t count
, loff_t
*ppos
)
739 int res
= parse_command(buffer
, count
);
744 /* Disable all handlers. */
748 /* Enable all handlers. */
752 /* Delete all handlers. */
753 root
= file_inode(file
)->i_sb
->s_root
;
754 inode_lock(d_inode(root
));
756 while (!list_empty(&entries
))
757 kill_node(list_entry(entries
.next
, Node
, list
));
759 inode_unlock(d_inode(root
));
768 static const struct file_operations bm_status_operations
= {
769 .read
= bm_status_read
,
770 .write
= bm_status_write
,
771 .llseek
= default_llseek
,
774 /* Superblock handling */
776 static const struct super_operations s_ops
= {
777 .statfs
= simple_statfs
,
778 .evict_inode
= bm_evict_inode
,
781 static int bm_fill_super(struct super_block
*sb
, void *data
, int silent
)
784 static struct tree_descr bm_files
[] = {
785 [2] = {"status", &bm_status_operations
, S_IWUSR
|S_IRUGO
},
786 [3] = {"register", &bm_register_operations
, S_IWUSR
},
790 err
= simple_fill_super(sb
, BINFMTFS_MAGIC
, bm_files
);
796 static struct dentry
*bm_mount(struct file_system_type
*fs_type
,
797 int flags
, const char *dev_name
, void *data
)
799 return mount_single(fs_type
, flags
, data
, bm_fill_super
);
802 static struct linux_binfmt misc_format
= {
803 .module
= THIS_MODULE
,
804 .load_binary
= load_misc_binary
,
807 static struct file_system_type bm_fs_type
= {
808 .owner
= THIS_MODULE
,
809 .name
= "binfmt_misc",
811 .kill_sb
= kill_litter_super
,
813 MODULE_ALIAS_FS("binfmt_misc");
815 static int __init
init_misc_binfmt(void)
817 int err
= register_filesystem(&bm_fs_type
);
819 insert_binfmt(&misc_format
);
823 static void __exit
exit_misc_binfmt(void)
825 unregister_binfmt(&misc_format
);
826 unregister_filesystem(&bm_fs_type
);
829 core_initcall(init_misc_binfmt
);
830 module_exit(exit_misc_binfmt
);
831 MODULE_LICENSE("GPL");