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, struct pt_regs *regs)
110 struct file * interp_file = NULL;
111 char iname[BINPRM_BUF_SIZE];
112 const char *iname_addr = iname;
121 if (bprm->recursion_depth > BINPRM_MAX_RECURSION)
124 /* to keep locking time low, we copy the interpreter string */
125 read_lock(&entries_lock);
126 fmt = check_file(bprm);
128 strlcpy(iname, fmt->interpreter, BINPRM_BUF_SIZE);
129 read_unlock(&entries_lock);
133 if (!(fmt->flags & MISC_FMT_PRESERVE_ARGV0)) {
134 retval = remove_arg_zero(bprm);
139 if (fmt->flags & MISC_FMT_OPEN_BINARY) {
141 /* if the binary should be opened on behalf of the
142 * interpreter than keep it open and assign descriptor
144 fd_binary = get_unused_fd();
149 fd_install(fd_binary, bprm->file);
151 /* if the binary is not readable than enforce mm->dumpable=0
152 regardless of the interpreter's permissions */
153 would_dump(bprm, bprm->file);
155 allow_write_access(bprm->file);
158 /* mark the bprm that fd should be passed to interp */
159 bprm->interp_flags |= BINPRM_FLAGS_EXECFD;
160 bprm->interp_data = fd_binary;
163 allow_write_access(bprm->file);
167 /* make argv[1] be the path to the binary */
168 retval = copy_strings_kernel (1, &bprm->interp, bprm);
173 /* add the interp as argv[0] */
174 retval = copy_strings_kernel (1, &iname_addr, bprm);
179 bprm->interp = iname; /* for binfmt_script */
181 interp_file = open_exec (iname);
182 retval = PTR_ERR (interp_file);
183 if (IS_ERR (interp_file))
186 bprm->file = interp_file;
187 if (fmt->flags & MISC_FMT_CREDENTIALS) {
189 * No need to call prepare_binprm(), it's already been
190 * done. bprm->buf is stale, update from interp_file.
192 memset(bprm->buf, 0, BINPRM_BUF_SIZE);
193 retval = kernel_read(bprm->file, 0, bprm->buf, BINPRM_BUF_SIZE);
195 retval = prepare_binprm (bprm);
200 bprm->recursion_depth++;
202 retval = search_binary_handler (bprm, regs);
210 sys_close(fd_binary);
211 bprm->interp_flags = 0;
212 bprm->interp_data = 0;
216 /* Command parsers */
219 * parses and copies one argument enclosed in del from *sp to *dp,
220 * recognising the \x special.
221 * returns pointer to the copied argument or NULL in case of an
222 * error (and sets err) or null argument length.
224 static char *scanarg(char *s, char del)
228 while ((c = *s++) != del) {
229 if (c == '\\' && *s == 'x') {
240 static int unquote(char *from)
242 char c = 0, *s = from, *p = from;
244 while ((c = *s++) != '\0') {
245 if (c == '\\' && *s == 'x') {
248 *p = (c - (isdigit(c) ? '0' : 'A' - 10)) << 4;
250 *p++ |= c - (isdigit(c) ? '0' : 'A' - 10);
258 static char * check_special_flags (char * sfs, Node * e)
268 e->flags |= MISC_FMT_PRESERVE_ARGV0;
272 e->flags |= MISC_FMT_OPEN_BINARY;
276 /* this flags also implies the
278 e->flags |= (MISC_FMT_CREDENTIALS |
279 MISC_FMT_OPEN_BINARY);
289 * This registers a new binary format, it recognises the syntax
290 * ':name:type:offset:magic:mask:interpreter:flags'
291 * where the ':' is the IFS, that can be chosen with the first char
293 static Node *create_entry(const char __user *buffer, size_t count)
300 /* some sanity checks */
302 if ((count < 11) || (count > 256))
306 memsize = sizeof(Node) + count + 8;
307 e = kmalloc(memsize, GFP_USER);
311 p = buf = (char *)e + sizeof(Node);
313 memset(e, 0, sizeof(Node));
314 if (copy_from_user(buf, buffer, count))
317 del = *p++; /* delimeter */
319 memset(buf+count, del, 8);
327 !strcmp(e->name, ".") ||
328 !strcmp(e->name, "..") ||
329 strchr(e->name, '/'))
332 case 'E': e->flags = 1<<Enabled; break;
333 case 'M': e->flags = (1<<Enabled) | (1<<Magic); break;
334 default: goto Einval;
338 if (test_bit(Magic, &e->flags)) {
339 char *s = strchr(p, del);
343 e->offset = simple_strtoul(p, &p, 10);
360 e->size = unquote(e->magic);
361 if (e->mask && unquote(e->mask) != e->size)
363 if (e->size + e->offset > BINPRM_BUF_SIZE)
375 if (!e->magic[0] || strchr(e->magic, '/'))
387 if (!e->interpreter[0])
391 p = check_special_flags (p, e);
395 if (p != buf + count)
404 return ERR_PTR(-EFAULT);
407 return ERR_PTR(-EINVAL);
411 * Set status of entry/binfmt_misc:
412 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
414 static int parse_command(const char __user *buffer, size_t count)
422 if (copy_from_user(s, buffer, count))
424 if (s[count-1] == '\n')
426 if (count == 1 && s[0] == '0')
428 if (count == 1 && s[0] == '1')
430 if (count == 2 && s[0] == '-' && s[1] == '1')
437 static void entry_status(Node *e, char *page)
440 char *status = "disabled";
441 const char * flags = "flags: ";
443 if (test_bit(Enabled, &e->flags))
446 if (!VERBOSE_STATUS) {
447 sprintf(page, "%s\n", status);
451 sprintf(page, "%s\ninterpreter %s\n", status, e->interpreter);
452 dp = page + strlen(page);
454 /* print the special flags */
455 sprintf (dp, "%s", flags);
456 dp += strlen (flags);
457 if (e->flags & MISC_FMT_PRESERVE_ARGV0) {
460 if (e->flags & MISC_FMT_OPEN_BINARY) {
463 if (e->flags & MISC_FMT_CREDENTIALS) {
469 if (!test_bit(Magic, &e->flags)) {
470 sprintf(dp, "extension .%s\n", e->magic);
474 sprintf(dp, "offset %i\nmagic ", e->offset);
475 dp = page + strlen(page);
476 for (i = 0; i < e->size; i++) {
477 sprintf(dp, "%02x", 0xff & (int) (e->magic[i]));
481 sprintf(dp, "\nmask ");
483 for (i = 0; i < e->size; i++) {
484 sprintf(dp, "%02x", 0xff & (int) (e->mask[i]));
493 static struct inode *bm_get_inode(struct super_block *sb, int mode)
495 struct inode * inode = new_inode(sb);
498 inode->i_ino = get_next_ino();
499 inode->i_mode = mode;
500 inode->i_atime = inode->i_mtime = inode->i_ctime =
501 current_fs_time(inode->i_sb);
506 static void bm_evict_inode(struct inode *inode)
508 end_writeback(inode);
509 kfree(inode->i_private);
512 static void kill_node(Node *e)
514 struct dentry *dentry;
516 write_lock(&entries_lock);
519 list_del_init(&e->list);
522 write_unlock(&entries_lock);
525 drop_nlink(dentry->d_inode);
528 simple_release_fs(&bm_mnt, &entry_count);
535 bm_entry_read(struct file * file, char __user * buf, size_t nbytes, loff_t *ppos)
537 Node *e = file->f_path.dentry->d_inode->i_private;
541 if (!(page = (char*) __get_free_page(GFP_KERNEL)))
544 entry_status(e, page);
546 res = simple_read_from_buffer(buf, nbytes, ppos, page, strlen(page));
548 free_page((unsigned long) page);
552 static ssize_t bm_entry_write(struct file *file, const char __user *buffer,
553 size_t count, loff_t *ppos)
556 Node *e = file->f_path.dentry->d_inode->i_private;
557 int res = parse_command(buffer, count);
560 case 1: clear_bit(Enabled, &e->flags);
562 case 2: set_bit(Enabled, &e->flags);
564 case 3: root = dget(file->f_path.dentry->d_sb->s_root);
565 mutex_lock(&root->d_inode->i_mutex);
569 mutex_unlock(&root->d_inode->i_mutex);
577 static const struct file_operations bm_entry_operations = {
578 .read = bm_entry_read,
579 .write = bm_entry_write,
580 .llseek = default_llseek,
585 static ssize_t bm_register_write(struct file *file, const char __user *buffer,
586 size_t count, loff_t *ppos)
590 struct dentry *root, *dentry;
591 struct super_block *sb = file->f_path.dentry->d_sb;
594 e = create_entry(buffer, count);
599 root = dget(sb->s_root);
600 mutex_lock(&root->d_inode->i_mutex);
601 dentry = lookup_one_len(e->name, root, strlen(e->name));
602 err = PTR_ERR(dentry);
610 inode = bm_get_inode(sb, S_IFREG | 0644);
616 err = simple_pin_fs(&bm_fs_type, &bm_mnt, &entry_count);
623 e->dentry = dget(dentry);
624 inode->i_private = e;
625 inode->i_fop = &bm_entry_operations;
627 d_instantiate(dentry, inode);
628 write_lock(&entries_lock);
629 list_add(&e->list, &entries);
630 write_unlock(&entries_lock);
636 mutex_unlock(&root->d_inode->i_mutex);
646 static const struct file_operations bm_register_operations = {
647 .write = bm_register_write,
648 .llseek = noop_llseek,
654 bm_status_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
656 char *s = enabled ? "enabled\n" : "disabled\n";
658 return simple_read_from_buffer(buf, nbytes, ppos, s, strlen(s));
661 static ssize_t bm_status_write(struct file * file, const char __user * buffer,
662 size_t count, loff_t *ppos)
664 int res = parse_command(buffer, count);
668 case 1: enabled = 0; break;
669 case 2: enabled = 1; break;
670 case 3: root = dget(file->f_path.dentry->d_sb->s_root);
671 mutex_lock(&root->d_inode->i_mutex);
673 while (!list_empty(&entries))
674 kill_node(list_entry(entries.next, Node, list));
676 mutex_unlock(&root->d_inode->i_mutex);
683 static const struct file_operations bm_status_operations = {
684 .read = bm_status_read,
685 .write = bm_status_write,
686 .llseek = default_llseek,
689 /* Superblock handling */
691 static const struct super_operations s_ops = {
692 .statfs = simple_statfs,
693 .evict_inode = bm_evict_inode,
696 static int bm_fill_super(struct super_block * sb, void * data, int silent)
698 static struct tree_descr bm_files[] = {
699 [2] = {"status", &bm_status_operations, S_IWUSR|S_IRUGO},
700 [3] = {"register", &bm_register_operations, S_IWUSR},
703 int err = simple_fill_super(sb, BINFMTFS_MAGIC, bm_files);
709 static struct dentry *bm_mount(struct file_system_type *fs_type,
710 int flags, const char *dev_name, void *data)
712 return mount_single(fs_type, flags, data, bm_fill_super);
715 static struct linux_binfmt misc_format = {
716 .module = THIS_MODULE,
717 .load_binary = load_misc_binary,
720 static struct file_system_type bm_fs_type = {
721 .owner = THIS_MODULE,
722 .name = "binfmt_misc",
724 .kill_sb = kill_litter_super,
727 static int __init init_misc_binfmt(void)
729 int err = register_filesystem(&bm_fs_type);
731 insert_binfmt(&misc_format);
735 static void __exit exit_misc_binfmt(void)
737 unregister_binfmt(&misc_format);
738 unregister_filesystem(&bm_fs_type);
741 core_initcall(init_misc_binfmt);
742 module_exit(exit_misc_binfmt);
743 MODULE_LICENSE("GPL");