xref: /linux-6.15/include/linux/binfmts.h (revision 96ecee29)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_BINFMTS_H
3 #define _LINUX_BINFMTS_H
4 
5 #include <linux/sched.h>
6 #include <linux/unistd.h>
7 #include <asm/exec.h>
8 #include <uapi/linux/binfmts.h>
9 
10 struct filename;
11 
12 #define CORENAME_MAX_SIZE 128
13 
14 /*
15  * This structure is used to hold the arguments that are used when loading binaries.
16  */
17 struct linux_binprm {
18 #ifdef CONFIG_MMU
19 	struct vm_area_struct *vma;
20 	unsigned long vma_pages;
21 #else
22 # define MAX_ARG_PAGES	32
23 	struct page *page[MAX_ARG_PAGES];
24 #endif
25 	struct mm_struct *mm;
26 	unsigned long p; /* current top of mem */
27 	unsigned long argmin; /* rlimit marker for copy_strings() */
28 	unsigned int
29 		/*
30 		 * True after the bprm_set_creds hook has been called once
31 		 * (multiple calls can be made via prepare_binprm() for
32 		 * binfmt_script/misc).
33 		 */
34 		called_set_creds:1,
35 		/*
36 		 * True if most recent call to the commoncaps bprm_set_creds
37 		 * hook (due to multiple prepare_binprm() calls from the
38 		 * binfmt_script/misc handlers) resulted in elevated
39 		 * privileges.
40 		 */
41 		cap_elevated:1,
42 		/*
43 		 * Set by bprm_set_creds hook to indicate a privilege-gaining
44 		 * exec has happened. Used to sanitize execution environment
45 		 * and to set AT_SECURE auxv for glibc.
46 		 */
47 		secureexec:1,
48 		/*
49 		 * Set when errors can no longer be returned to the
50 		 * original userspace.
51 		 */
52 		point_of_no_return:1;
53 #ifdef __alpha__
54 	unsigned int taso:1;
55 #endif
56 	unsigned int recursion_depth; /* only for search_binary_handler() */
57 	struct file * file;
58 	struct cred *cred;	/* new credentials */
59 	int unsafe;		/* how unsafe this exec is (mask of LSM_UNSAFE_*) */
60 	unsigned int per_clear;	/* bits to clear in current->personality */
61 	int argc, envc;
62 	const char * filename;	/* Name of binary as seen by procps */
63 	const char * interp;	/* Name of the binary really executed. Most
64 				   of the time same as filename, but could be
65 				   different for binfmt_{misc,script} */
66 	unsigned interp_flags;
67 	unsigned interp_data;
68 	unsigned long loader, exec;
69 
70 	struct rlimit rlim_stack; /* Saved RLIMIT_STACK used during exec. */
71 
72 	char buf[BINPRM_BUF_SIZE];
73 } __randomize_layout;
74 
75 #define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
76 #define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
77 
78 /* fd of the binary should be passed to the interpreter */
79 #define BINPRM_FLAGS_EXECFD_BIT 1
80 #define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
81 
82 /* filename of the binary will be inaccessible after exec */
83 #define BINPRM_FLAGS_PATH_INACCESSIBLE_BIT 2
84 #define BINPRM_FLAGS_PATH_INACCESSIBLE (1 << BINPRM_FLAGS_PATH_INACCESSIBLE_BIT)
85 
86 /* Function parameter for binfmt->coredump */
87 struct coredump_params {
88 	const kernel_siginfo_t *siginfo;
89 	struct pt_regs *regs;
90 	struct file *file;
91 	unsigned long limit;
92 	unsigned long mm_flags;
93 	loff_t written;
94 	loff_t pos;
95 };
96 
97 /*
98  * This structure defines the functions that are used to load the binary formats that
99  * linux accepts.
100  */
101 struct linux_binfmt {
102 	struct list_head lh;
103 	struct module *module;
104 	int (*load_binary)(struct linux_binprm *);
105 	int (*load_shlib)(struct file *);
106 	int (*core_dump)(struct coredump_params *cprm);
107 	unsigned long min_coredump;	/* minimal dump size */
108 } __randomize_layout;
109 
110 extern void __register_binfmt(struct linux_binfmt *fmt, int insert);
111 
112 /* Registration of default binfmt handlers */
113 static inline void register_binfmt(struct linux_binfmt *fmt)
114 {
115 	__register_binfmt(fmt, 0);
116 }
117 /* Same as above, but adds a new binfmt at the top of the list */
118 static inline void insert_binfmt(struct linux_binfmt *fmt)
119 {
120 	__register_binfmt(fmt, 1);
121 }
122 
123 extern void unregister_binfmt(struct linux_binfmt *);
124 
125 extern int prepare_binprm(struct linux_binprm *);
126 extern int __must_check remove_arg_zero(struct linux_binprm *);
127 extern int search_binary_handler(struct linux_binprm *);
128 extern int flush_old_exec(struct linux_binprm * bprm);
129 extern void setup_new_exec(struct linux_binprm * bprm);
130 extern void finalize_exec(struct linux_binprm *bprm);
131 extern void would_dump(struct linux_binprm *, struct file *);
132 
133 extern int suid_dumpable;
134 
135 /* Stack area protections */
136 #define EXSTACK_DEFAULT   0	/* Whatever the arch defaults to */
137 #define EXSTACK_DISABLE_X 1	/* Disable executable stacks */
138 #define EXSTACK_ENABLE_X  2	/* Enable executable stacks */
139 
140 extern int setup_arg_pages(struct linux_binprm * bprm,
141 			   unsigned long stack_top,
142 			   int executable_stack);
143 extern int transfer_args_to_stack(struct linux_binprm *bprm,
144 				  unsigned long *sp_location);
145 extern int bprm_change_interp(const char *interp, struct linux_binprm *bprm);
146 extern int copy_strings_kernel(int argc, const char *const *argv,
147 			       struct linux_binprm *bprm);
148 extern void set_binfmt(struct linux_binfmt *new);
149 extern ssize_t read_code(struct file *, unsigned long, loff_t, size_t);
150 
151 extern int do_execve(struct filename *,
152 		     const char __user * const __user *,
153 		     const char __user * const __user *);
154 extern int do_execveat(int, struct filename *,
155 		       const char __user * const __user *,
156 		       const char __user * const __user *,
157 		       int);
158 int do_execve_file(struct file *file, void *__argv, void *__envp);
159 
160 #endif /* _LINUX_BINFMTS_H */
161