4 * Copyright (C) 1997 Richard Günther
6 * binfmt_misc detects binaries via a magic or filename extension and invokes
7 * a specified wrapper. This should obsolete binfmt_java, binfmt_em86 and
10 * 1997-04-25 first version
13 * 1997-06-26 hpa: pass the real filename rather than argv[0]
14 * 1997-06-30 minor cleanup
15 * 1997-08-09 removed extension stripping, locking cleanup
16 * 2001-02-28 AV: rewritten into something that resembles C. Original didn't.
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/sched.h>
22 #include <linux/magic.h>
23 #include <linux/binfmts.h>
24 #include <linux/slab.h>
25 #include <linux/ctype.h>
26 #include <linux/file.h>
27 #include <linux/pagemap.h>
28 #include <linux/namei.h>
29 #include <linux/mount.h>
30 #include <linux/syscalls.h>
33 #include <asm/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 * Check if we support the binfmt
66 * if we do, return the node, else NULL
67 * locking is done in load_misc_binary
69 static Node *check_file(struct linux_binprm *bprm)
71 char *p = strrchr(bprm->interp, '.');
74 list_for_each(l, &entries) {
75 Node *e = list_entry(l, Node, list);
79 if (!test_bit(Enabled, &e->flags))
82 if (!test_bit(Magic, &e->flags)) {
83 if (p && !strcmp(e->magic, p + 1))
88 s = bprm->buf + e->offset;
90 for (j = 0; j < e->size; j++)
91 if ((*s++ ^ e->magic[j]) & e->mask[j])
94 for (j = 0; j < e->size; j++)
95 if ((*s++ ^ e->magic[j]))
107 static int load_misc_binary(struct linux_binprm *bprm)
110 struct file * interp_file = NULL;
111 char iname[BINPRM_BUF_SIZE];
112 const char *iname_addr = iname;
120 /* to keep locking time low, we copy the interpreter string */
121 read_lock(&entries_lock);
122 fmt = check_file(bprm);
124 strlcpy(iname, fmt->interpreter, BINPRM_BUF_SIZE);
125 read_unlock(&entries_lock);
129 if (!(fmt->flags & MISC_FMT_PRESERVE_ARGV0)) {
130 retval = remove_arg_zero(bprm);
135 if (fmt->flags & MISC_FMT_OPEN_BINARY) {
137 /* if the binary should be opened on behalf of the
138 * interpreter than keep it open and assign descriptor
140 fd_binary = get_unused_fd();
145 fd_install(fd_binary, bprm->file);
147 /* if the binary is not readable than enforce mm->dumpable=0
148 regardless of the interpreter's permissions */
149 would_dump(bprm, bprm->file);
151 allow_write_access(bprm->file);
154 /* mark the bprm that fd should be passed to interp */
155 bprm->interp_flags |= BINPRM_FLAGS_EXECFD;
156 bprm->interp_data = fd_binary;
159 allow_write_access(bprm->file);
163 /* make argv[1] be the path to the binary */
164 retval = copy_strings_kernel (1, &bprm->interp, bprm);
169 /* add the interp as argv[0] */
170 retval = copy_strings_kernel (1, &iname_addr, bprm);
175 /* Update interp in case binfmt_script needs it. */
176 retval = bprm_change_interp(iname, bprm);
180 interp_file = open_exec (iname);
181 retval = PTR_ERR (interp_file);
182 if (IS_ERR (interp_file))
185 bprm->file = interp_file;
186 if (fmt->flags & MISC_FMT_CREDENTIALS) {
188 * No need to call prepare_binprm(), it's already been
189 * done. bprm->buf is stale, update from interp_file.
191 memset(bprm->buf, 0, BINPRM_BUF_SIZE);
192 retval = kernel_read(bprm->file, 0, bprm->buf, BINPRM_BUF_SIZE);
194 retval = prepare_binprm (bprm);
199 retval = search_binary_handler(bprm);
207 sys_close(fd_binary);
208 bprm->interp_flags = 0;
209 bprm->interp_data = 0;
213 /* Command parsers */
216 * parses and copies one argument enclosed in del from *sp to *dp,
217 * recognising the \x special.
218 * returns pointer to the copied argument or NULL in case of an
219 * error (and sets err) or null argument length.
221 static char *scanarg(char *s, char del)
225 while ((c = *s++) != del) {
226 if (c == '\\' && *s == 'x') {
237 static int unquote(char *from)
239 char c = 0, *s = from, *p = from;
241 while ((c = *s++) != '\0') {
242 if (c == '\\' && *s == 'x') {
245 *p = (c - (isdigit(c) ? '0' : 'A' - 10)) << 4;
247 *p++ |= c - (isdigit(c) ? '0' : 'A' - 10);
255 static char * check_special_flags (char * sfs, Node * e)
265 e->flags |= MISC_FMT_PRESERVE_ARGV0;
269 e->flags |= MISC_FMT_OPEN_BINARY;
273 /* this flags also implies the
275 e->flags |= (MISC_FMT_CREDENTIALS |
276 MISC_FMT_OPEN_BINARY);
286 * This registers a new binary format, it recognises the syntax
287 * ':name:type:offset:magic:mask:interpreter:flags'
288 * where the ':' is the IFS, that can be chosen with the first char
290 static Node *create_entry(const char __user *buffer, size_t count)
297 /* some sanity checks */
299 if ((count < 11) || (count > 256))
303 memsize = sizeof(Node) + count + 8;
304 e = kmalloc(memsize, GFP_USER);
308 p = buf = (char *)e + sizeof(Node);
310 memset(e, 0, sizeof(Node));
311 if (copy_from_user(buf, buffer, count))
314 del = *p++; /* delimeter */
316 memset(buf+count, del, 8);
324 !strcmp(e->name, ".") ||
325 !strcmp(e->name, "..") ||
326 strchr(e->name, '/'))
329 case 'E': e->flags = 1<<Enabled; break;
330 case 'M': e->flags = (1<<Enabled) | (1<<Magic); break;
331 default: goto Einval;
335 if (test_bit(Magic, &e->flags)) {
336 char *s = strchr(p, del);
340 e->offset = simple_strtoul(p, &p, 10);
357 e->size = unquote(e->magic);
358 if (e->mask && unquote(e->mask) != e->size)
360 if (e->size + e->offset > BINPRM_BUF_SIZE)
372 if (!e->magic[0] || strchr(e->magic, '/'))
384 if (!e->interpreter[0])
388 p = check_special_flags (p, e);
392 if (p != buf + count)
401 return ERR_PTR(-EFAULT);
404 return ERR_PTR(-EINVAL);
408 * Set status of entry/binfmt_misc:
409 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
411 static int parse_command(const char __user *buffer, size_t count)
419 if (copy_from_user(s, buffer, count))
421 if (s[count-1] == '\n')
423 if (count == 1 && s[0] == '0')
425 if (count == 1 && s[0] == '1')
427 if (count == 2 && s[0] == '-' && s[1] == '1')
434 static void entry_status(Node *e, char *page)
437 char *status = "disabled";
438 const char * flags = "flags: ";
440 if (test_bit(Enabled, &e->flags))
443 if (!VERBOSE_STATUS) {
444 sprintf(page, "%s\n", status);
448 sprintf(page, "%s\ninterpreter %s\n", status, e->interpreter);
449 dp = page + strlen(page);
451 /* print the special flags */
452 sprintf (dp, "%s", flags);
453 dp += strlen (flags);
454 if (e->flags & MISC_FMT_PRESERVE_ARGV0) {
457 if (e->flags & MISC_FMT_OPEN_BINARY) {
460 if (e->flags & MISC_FMT_CREDENTIALS) {
466 if (!test_bit(Magic, &e->flags)) {
467 sprintf(dp, "extension .%s\n", e->magic);
471 sprintf(dp, "offset %i\nmagic ", e->offset);
472 dp = page + strlen(page);
473 for (i = 0; i < e->size; i++) {
474 sprintf(dp, "%02x", 0xff & (int) (e->magic[i]));
478 sprintf(dp, "\nmask ");
480 for (i = 0; i < e->size; i++) {
481 sprintf(dp, "%02x", 0xff & (int) (e->mask[i]));
490 static struct inode *bm_get_inode(struct super_block *sb, int mode)
492 struct inode * inode = new_inode(sb);
495 inode->i_ino = get_next_ino();
496 inode->i_mode = mode;
497 inode->i_atime = inode->i_mtime = inode->i_ctime =
498 current_fs_time(inode->i_sb);
503 static void bm_evict_inode(struct inode *inode)
506 kfree(inode->i_private);
509 static void kill_node(Node *e)
511 struct dentry *dentry;
513 write_lock(&entries_lock);
516 list_del_init(&e->list);
519 write_unlock(&entries_lock);
522 drop_nlink(dentry->d_inode);
525 simple_release_fs(&bm_mnt, &entry_count);
532 bm_entry_read(struct file * file, char __user * buf, size_t nbytes, loff_t *ppos)
534 Node *e = file->f_path.dentry->d_inode->i_private;
538 if (!(page = (char*) __get_free_page(GFP_KERNEL)))
541 entry_status(e, page);
543 res = simple_read_from_buffer(buf, nbytes, ppos, page, strlen(page));
545 free_page((unsigned long) page);
549 static ssize_t bm_entry_write(struct file *file, const char __user *buffer,
550 size_t count, loff_t *ppos)
553 Node *e = file->f_path.dentry->d_inode->i_private;
554 int res = parse_command(buffer, count);
557 case 1: clear_bit(Enabled, &e->flags);
559 case 2: set_bit(Enabled, &e->flags);
561 case 3: root = dget(file->f_path.dentry->d_sb->s_root);
562 mutex_lock(&root->d_inode->i_mutex);
566 mutex_unlock(&root->d_inode->i_mutex);
574 static const struct file_operations bm_entry_operations = {
575 .read = bm_entry_read,
576 .write = bm_entry_write,
577 .llseek = default_llseek,
582 static ssize_t bm_register_write(struct file *file, const char __user *buffer,
583 size_t count, loff_t *ppos)
587 struct dentry *root, *dentry;
588 struct super_block *sb = file->f_path.dentry->d_sb;
591 e = create_entry(buffer, count);
596 root = dget(sb->s_root);
597 mutex_lock(&root->d_inode->i_mutex);
598 dentry = lookup_one_len(e->name, root, strlen(e->name));
599 err = PTR_ERR(dentry);
607 inode = bm_get_inode(sb, S_IFREG | 0644);
613 err = simple_pin_fs(&bm_fs_type, &bm_mnt, &entry_count);
620 e->dentry = dget(dentry);
621 inode->i_private = e;
622 inode->i_fop = &bm_entry_operations;
624 d_instantiate(dentry, inode);
625 write_lock(&entries_lock);
626 list_add(&e->list, &entries);
627 write_unlock(&entries_lock);
633 mutex_unlock(&root->d_inode->i_mutex);
643 static const struct file_operations bm_register_operations = {
644 .write = bm_register_write,
645 .llseek = noop_llseek,
651 bm_status_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
653 char *s = enabled ? "enabled\n" : "disabled\n";
655 return simple_read_from_buffer(buf, nbytes, ppos, s, strlen(s));
658 static ssize_t bm_status_write(struct file * file, const char __user * buffer,
659 size_t count, loff_t *ppos)
661 int res = parse_command(buffer, count);
665 case 1: enabled = 0; break;
666 case 2: enabled = 1; break;
667 case 3: root = dget(file->f_path.dentry->d_sb->s_root);
668 mutex_lock(&root->d_inode->i_mutex);
670 while (!list_empty(&entries))
671 kill_node(list_entry(entries.next, Node, list));
673 mutex_unlock(&root->d_inode->i_mutex);
680 static const struct file_operations bm_status_operations = {
681 .read = bm_status_read,
682 .write = bm_status_write,
683 .llseek = default_llseek,
686 /* Superblock handling */
688 static const struct super_operations s_ops = {
689 .statfs = simple_statfs,
690 .evict_inode = bm_evict_inode,
693 static int bm_fill_super(struct super_block * sb, void * data, int silent)
695 static struct tree_descr bm_files[] = {
696 [2] = {"status", &bm_status_operations, S_IWUSR|S_IRUGO},
697 [3] = {"register", &bm_register_operations, S_IWUSR},
700 int err = simple_fill_super(sb, BINFMTFS_MAGIC, bm_files);
706 static struct dentry *bm_mount(struct file_system_type *fs_type,
707 int flags, const char *dev_name, void *data)
709 return mount_single(fs_type, flags, data, bm_fill_super);
712 static struct linux_binfmt misc_format = {
713 .module = THIS_MODULE,
714 .load_binary = load_misc_binary,
717 static struct file_system_type bm_fs_type = {
718 .owner = THIS_MODULE,
719 .name = "binfmt_misc",
721 .kill_sb = kill_litter_super,
724 static int __init init_misc_binfmt(void)
726 int err = register_filesystem(&bm_fs_type);
728 insert_binfmt(&misc_format);
732 static void __exit exit_misc_binfmt(void)
734 unregister_binfmt(&misc_format);
735 unregister_filesystem(&bm_fs_type);
738 core_initcall(init_misc_binfmt);
739 module_exit(exit_misc_binfmt);
740 MODULE_LICENSE("GPL");