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/binfmts.h>
23 #include <linux/slab.h>
24 #include <linux/ctype.h>
25 #include <linux/file.h>
26 #include <linux/pagemap.h>
27 #include <linux/namei.h>
28 #include <linux/mount.h>
29 #include <linux/syscalls.h>
32 #include <asm/uaccess.h>
35 VERBOSE_STATUS
= 1 /* make it zero to save 400 bytes kernel memory */
38 static LIST_HEAD(entries
);
39 static int enabled
= 1;
41 enum {Enabled
, Magic
};
42 #define MISC_FMT_PRESERVE_ARGV0 (1<<31)
43 #define MISC_FMT_OPEN_BINARY (1<<30)
44 #define MISC_FMT_CREDENTIALS (1<<29)
47 struct list_head list
;
48 unsigned long flags
; /* type, status, etc. */
49 int offset
; /* offset of magic */
50 int size
; /* size of magic/mask */
51 char *magic
; /* magic or filename extension */
52 char *mask
; /* mask, NULL for exact match */
53 char *interpreter
; /* filename of interpreter */
55 struct dentry
*dentry
;
58 static DEFINE_RWLOCK(entries_lock
);
59 static struct file_system_type bm_fs_type
;
60 static struct vfsmount
*bm_mnt
;
61 static int entry_count
;
64 * Check if we support the binfmt
65 * if we do, return the node, else NULL
66 * locking is done in load_misc_binary
68 static Node
*check_file(struct linux_binprm
*bprm
)
70 char *p
= strrchr(bprm
->interp
, '.');
73 list_for_each(l
, &entries
) {
74 Node
*e
= list_entry(l
, Node
, list
);
78 if (!test_bit(Enabled
, &e
->flags
))
81 if (!test_bit(Magic
, &e
->flags
)) {
82 if (p
&& !strcmp(e
->magic
, p
+ 1))
87 s
= bprm
->buf
+ e
->offset
;
89 for (j
= 0; j
< e
->size
; j
++)
90 if ((*s
++ ^ e
->magic
[j
]) & e
->mask
[j
])
93 for (j
= 0; j
< e
->size
; j
++)
94 if ((*s
++ ^ e
->magic
[j
]))
106 static int load_misc_binary(struct linux_binprm
*bprm
, struct pt_regs
*regs
)
109 struct file
* interp_file
= NULL
;
110 char iname
[BINPRM_BUF_SIZE
];
111 const char *iname_addr
= iname
;
119 /* to keep locking time low, we copy the interpreter string */
120 read_lock(&entries_lock
);
121 fmt
= check_file(bprm
);
123 strlcpy(iname
, fmt
->interpreter
, BINPRM_BUF_SIZE
);
124 read_unlock(&entries_lock
);
128 if (!(fmt
->flags
& MISC_FMT_PRESERVE_ARGV0
)) {
129 retval
= remove_arg_zero(bprm
);
134 if (fmt
->flags
& MISC_FMT_OPEN_BINARY
) {
136 /* if the binary should be opened on behalf of the
137 * interpreter than keep it open and assign descriptor
139 fd_binary
= get_unused_fd();
144 fd_install(fd_binary
, bprm
->file
);
146 /* if the binary is not readable than enforce mm->dumpable=0
147 regardless of the interpreter's permissions */
148 would_dump(bprm
, bprm
->file
);
150 allow_write_access(bprm
->file
);
153 /* mark the bprm that fd should be passed to interp */
154 bprm
->interp_flags
|= BINPRM_FLAGS_EXECFD
;
155 bprm
->interp_data
= fd_binary
;
158 allow_write_access(bprm
->file
);
162 /* make argv[1] be the path to the binary */
163 retval
= copy_strings_kernel (1, &bprm
->interp
, bprm
);
168 /* add the interp as argv[0] */
169 retval
= copy_strings_kernel (1, &iname_addr
, bprm
);
174 /* Update interp in case binfmt_script needs it. */
175 retval
= bprm_change_interp(iname
, bprm
);
179 interp_file
= open_exec (iname
);
180 retval
= PTR_ERR (interp_file
);
181 if (IS_ERR (interp_file
))
184 bprm
->file
= interp_file
;
185 if (fmt
->flags
& MISC_FMT_CREDENTIALS
) {
187 * No need to call prepare_binprm(), it's already been
188 * done. bprm->buf is stale, update from interp_file.
190 memset(bprm
->buf
, 0, BINPRM_BUF_SIZE
);
191 retval
= kernel_read(bprm
->file
, 0, bprm
->buf
, BINPRM_BUF_SIZE
);
193 retval
= prepare_binprm (bprm
);
198 retval
= search_binary_handler (bprm
, regs
);
206 sys_close(fd_binary
);
207 bprm
->interp_flags
= 0;
208 bprm
->interp_data
= 0;
212 /* Command parsers */
215 * parses and copies one argument enclosed in del from *sp to *dp,
216 * recognising the \x special.
217 * returns pointer to the copied argument or NULL in case of an
218 * error (and sets err) or null argument length.
220 static char *scanarg(char *s
, char del
)
224 while ((c
= *s
++) != del
) {
225 if (c
== '\\' && *s
== 'x') {
236 static int unquote(char *from
)
238 char c
= 0, *s
= from
, *p
= from
;
240 while ((c
= *s
++) != '\0') {
241 if (c
== '\\' && *s
== 'x') {
244 *p
= (c
- (isdigit(c
) ? '0' : 'A' - 10)) << 4;
246 *p
++ |= c
- (isdigit(c
) ? '0' : 'A' - 10);
254 static char * check_special_flags (char * sfs
, Node
* e
)
264 e
->flags
|= MISC_FMT_PRESERVE_ARGV0
;
268 e
->flags
|= MISC_FMT_OPEN_BINARY
;
272 /* this flags also implies the
274 e
->flags
|= (MISC_FMT_CREDENTIALS
|
275 MISC_FMT_OPEN_BINARY
);
285 * This registers a new binary format, it recognises the syntax
286 * ':name:type:offset:magic:mask:interpreter:flags'
287 * where the ':' is the IFS, that can be chosen with the first char
289 static Node
*create_entry(const char __user
*buffer
, size_t count
)
296 /* some sanity checks */
298 if ((count
< 11) || (count
> 256))
302 memsize
= sizeof(Node
) + count
+ 8;
303 e
= kmalloc(memsize
, GFP_USER
);
307 p
= buf
= (char *)e
+ sizeof(Node
);
309 memset(e
, 0, sizeof(Node
));
310 if (copy_from_user(buf
, buffer
, count
))
313 del
= *p
++; /* delimeter */
315 memset(buf
+count
, del
, 8);
323 !strcmp(e
->name
, ".") ||
324 !strcmp(e
->name
, "..") ||
325 strchr(e
->name
, '/'))
328 case 'E': e
->flags
= 1<<Enabled
; break;
329 case 'M': e
->flags
= (1<<Enabled
) | (1<<Magic
); break;
330 default: goto Einval
;
334 if (test_bit(Magic
, &e
->flags
)) {
335 char *s
= strchr(p
, del
);
339 e
->offset
= simple_strtoul(p
, &p
, 10);
356 e
->size
= unquote(e
->magic
);
357 if (e
->mask
&& unquote(e
->mask
) != e
->size
)
359 if (e
->size
+ e
->offset
> BINPRM_BUF_SIZE
)
371 if (!e
->magic
[0] || strchr(e
->magic
, '/'))
383 if (!e
->interpreter
[0])
387 p
= check_special_flags (p
, e
);
391 if (p
!= buf
+ count
)
400 return ERR_PTR(-EFAULT
);
403 return ERR_PTR(-EINVAL
);
407 * Set status of entry/binfmt_misc:
408 * '1' enables, '0' disables and '-1' clears entry/binfmt_misc
410 static int parse_command(const char __user
*buffer
, size_t count
)
418 if (copy_from_user(s
, buffer
, count
))
420 if (s
[count
-1] == '\n')
422 if (count
== 1 && s
[0] == '0')
424 if (count
== 1 && s
[0] == '1')
426 if (count
== 2 && s
[0] == '-' && s
[1] == '1')
433 static void entry_status(Node
*e
, char *page
)
436 char *status
= "disabled";
437 const char * flags
= "flags: ";
439 if (test_bit(Enabled
, &e
->flags
))
442 if (!VERBOSE_STATUS
) {
443 sprintf(page
, "%s\n", status
);
447 sprintf(page
, "%s\ninterpreter %s\n", status
, e
->interpreter
);
448 dp
= page
+ strlen(page
);
450 /* print the special flags */
451 sprintf (dp
, "%s", flags
);
452 dp
+= strlen (flags
);
453 if (e
->flags
& MISC_FMT_PRESERVE_ARGV0
) {
456 if (e
->flags
& MISC_FMT_OPEN_BINARY
) {
459 if (e
->flags
& MISC_FMT_CREDENTIALS
) {
465 if (!test_bit(Magic
, &e
->flags
)) {
466 sprintf(dp
, "extension .%s\n", e
->magic
);
470 sprintf(dp
, "offset %i\nmagic ", e
->offset
);
471 dp
= page
+ strlen(page
);
472 for (i
= 0; i
< e
->size
; i
++) {
473 sprintf(dp
, "%02x", 0xff & (int) (e
->magic
[i
]));
477 sprintf(dp
, "\nmask ");
479 for (i
= 0; i
< e
->size
; i
++) {
480 sprintf(dp
, "%02x", 0xff & (int) (e
->mask
[i
]));
489 static struct inode
*bm_get_inode(struct super_block
*sb
, int mode
)
491 struct inode
* inode
= new_inode(sb
);
494 inode
->i_ino
= get_next_ino();
495 inode
->i_mode
= mode
;
496 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
=
497 current_fs_time(inode
->i_sb
);
502 static void bm_evict_inode(struct inode
*inode
)
504 end_writeback(inode
);
505 kfree(inode
->i_private
);
508 static void kill_node(Node
*e
)
510 struct dentry
*dentry
;
512 write_lock(&entries_lock
);
515 list_del_init(&e
->list
);
518 write_unlock(&entries_lock
);
521 drop_nlink(dentry
->d_inode
);
524 simple_release_fs(&bm_mnt
, &entry_count
);
531 bm_entry_read(struct file
* file
, char __user
* buf
, size_t nbytes
, loff_t
*ppos
)
533 Node
*e
= file
->f_path
.dentry
->d_inode
->i_private
;
537 if (!(page
= (char*) __get_free_page(GFP_KERNEL
)))
540 entry_status(e
, page
);
542 res
= simple_read_from_buffer(buf
, nbytes
, ppos
, page
, strlen(page
));
544 free_page((unsigned long) page
);
548 static ssize_t
bm_entry_write(struct file
*file
, const char __user
*buffer
,
549 size_t count
, loff_t
*ppos
)
552 Node
*e
= file
->f_path
.dentry
->d_inode
->i_private
;
553 int res
= parse_command(buffer
, count
);
556 case 1: clear_bit(Enabled
, &e
->flags
);
558 case 2: set_bit(Enabled
, &e
->flags
);
560 case 3: root
= dget(file
->f_path
.mnt
->mnt_sb
->s_root
);
561 mutex_lock(&root
->d_inode
->i_mutex
);
565 mutex_unlock(&root
->d_inode
->i_mutex
);
573 static const struct file_operations bm_entry_operations
= {
574 .read
= bm_entry_read
,
575 .write
= bm_entry_write
,
576 .llseek
= default_llseek
,
581 static ssize_t
bm_register_write(struct file
*file
, const char __user
*buffer
,
582 size_t count
, loff_t
*ppos
)
586 struct dentry
*root
, *dentry
;
587 struct super_block
*sb
= file
->f_path
.mnt
->mnt_sb
;
590 e
= create_entry(buffer
, count
);
595 root
= dget(sb
->s_root
);
596 mutex_lock(&root
->d_inode
->i_mutex
);
597 dentry
= lookup_one_len(e
->name
, root
, strlen(e
->name
));
598 err
= PTR_ERR(dentry
);
606 inode
= bm_get_inode(sb
, S_IFREG
| 0644);
612 err
= simple_pin_fs(&bm_fs_type
, &bm_mnt
, &entry_count
);
619 e
->dentry
= dget(dentry
);
620 inode
->i_private
= e
;
621 inode
->i_fop
= &bm_entry_operations
;
623 d_instantiate(dentry
, inode
);
624 write_lock(&entries_lock
);
625 list_add(&e
->list
, &entries
);
626 write_unlock(&entries_lock
);
632 mutex_unlock(&root
->d_inode
->i_mutex
);
642 static const struct file_operations bm_register_operations
= {
643 .write
= bm_register_write
,
644 .llseek
= noop_llseek
,
650 bm_status_read(struct file
*file
, char __user
*buf
, size_t nbytes
, loff_t
*ppos
)
652 char *s
= enabled
? "enabled\n" : "disabled\n";
654 return simple_read_from_buffer(buf
, nbytes
, ppos
, s
, strlen(s
));
657 static ssize_t
bm_status_write(struct file
* file
, const char __user
* buffer
,
658 size_t count
, loff_t
*ppos
)
660 int res
= parse_command(buffer
, count
);
664 case 1: enabled
= 0; break;
665 case 2: enabled
= 1; break;
666 case 3: root
= dget(file
->f_path
.mnt
->mnt_sb
->s_root
);
667 mutex_lock(&root
->d_inode
->i_mutex
);
669 while (!list_empty(&entries
))
670 kill_node(list_entry(entries
.next
, Node
, list
));
672 mutex_unlock(&root
->d_inode
->i_mutex
);
679 static const struct file_operations bm_status_operations
= {
680 .read
= bm_status_read
,
681 .write
= bm_status_write
,
682 .llseek
= default_llseek
,
685 /* Superblock handling */
687 static const struct super_operations s_ops
= {
688 .statfs
= simple_statfs
,
689 .evict_inode
= bm_evict_inode
,
692 static int bm_fill_super(struct super_block
* sb
, void * data
, int silent
)
694 static struct tree_descr bm_files
[] = {
695 [2] = {"status", &bm_status_operations
, S_IWUSR
|S_IRUGO
},
696 [3] = {"register", &bm_register_operations
, S_IWUSR
},
699 int err
= simple_fill_super(sb
, 0x42494e4d, bm_files
);
705 static struct dentry
*bm_mount(struct file_system_type
*fs_type
,
706 int flags
, const char *dev_name
, void *data
)
708 return mount_single(fs_type
, flags
, data
, bm_fill_super
);
711 static struct linux_binfmt misc_format
= {
712 .module
= THIS_MODULE
,
713 .load_binary
= load_misc_binary
,
716 static struct file_system_type bm_fs_type
= {
717 .owner
= THIS_MODULE
,
718 .name
= "binfmt_misc",
720 .kill_sb
= kill_litter_super
,
723 static int __init
init_misc_binfmt(void)
725 int err
= register_filesystem(&bm_fs_type
);
727 err
= insert_binfmt(&misc_format
);
729 unregister_filesystem(&bm_fs_type
);
734 static void __exit
exit_misc_binfmt(void)
736 unregister_binfmt(&misc_format
);
737 unregister_filesystem(&bm_fs_type
);
740 core_initcall(init_misc_binfmt
);
741 module_exit(exit_misc_binfmt
);
742 MODULE_LICENSE("GPL");