include/linux/binfmts.h

   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 if most recent call to cap_bprm_set_creds
  31                  * resulted in elevated privileges.
  32                  */
  33                 cap_elevated:1,
  34                 /*
  35                  * Set by bprm_creds_for_exec hook to indicate a
  36                  * privilege-gaining exec has happened. Used to set
  37                  * AT_SECURE auxv for glibc.
  38                  */
  39                 secureexec:1,
  40                 /*
  41                  * Set when errors can no longer be returned to the
  42                  * original userspace.
  43                  */
  44                 point_of_no_return:1;
  45 #ifdef __alpha__
  46         unsigned int taso:1;
  47 #endif
  48         unsigned int recursion_depth; /* only for search_binary_handler() */
  49         struct file * file;
  50         struct cred *cred;      /* new credentials */
  51         int unsafe;             /* how unsafe this exec is (mask of LSM_UNSAFE_*) */
  52         unsigned int per_clear; /* bits to clear in current->personality */
  53         int argc, envc;
  54         const char * filename;  /* Name of binary as seen by procps */
  55         const char * interp;    /* Name of the binary really executed. Most
  56                                    of the time same as filename, but could be
  57                                    different for binfmt_{misc,script} */
  58         unsigned interp_flags;
  59         unsigned interp_data;
  60         unsigned long loader, exec;
  61
  62         struct rlimit rlim_stack; /* Saved RLIMIT_STACK used during exec. */
  63
  64         char buf[BINPRM_BUF_SIZE];
  65 } __randomize_layout;
  66
  67 #define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
  68 #define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
  69
  70 /* fd of the binary should be passed to the interpreter */
  71 #define BINPRM_FLAGS_EXECFD_BIT 1
  72 #define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
  73
  74 /* filename of the binary will be inaccessible after exec */
  75 #define BINPRM_FLAGS_PATH_INACCESSIBLE_BIT 2
  76 #define BINPRM_FLAGS_PATH_INACCESSIBLE (1 << BINPRM_FLAGS_PATH_INACCESSIBLE_BIT)
  77
  78 /* Function parameter for binfmt->coredump */
  79 struct coredump_params {
  80         const kernel_siginfo_t *siginfo;
  81         struct pt_regs *regs;
  82         struct file *file;
  83         unsigned long limit;
  84         unsigned long mm_flags;
  85         loff_t written;
  86         loff_t pos;
  87 };
  88
  89 /*
  90  * This structure defines the functions that are used to load the binary formats that
  91  * linux accepts.
  92  */
  93 struct linux_binfmt {
  94         struct list_head lh;
  95         struct module *module;
  96         int (*load_binary)(struct linux_binprm *);
  97         int (*load_shlib)(struct file *);
  98         int (*core_dump)(struct coredump_params *cprm);
  99         unsigned long min_coredump;     /* minimal dump size */
 100 } __randomize_layout;
 101
 102 extern void __register_binfmt(struct linux_binfmt *fmt, int insert);
 103
 104 /* Registration of default binfmt handlers */
 105 static inline void register_binfmt(struct linux_binfmt *fmt)
 106 {
 107         __register_binfmt(fmt, 0);
 108 }
 109 /* Same as above, but adds a new binfmt at the top of the list */
 110 static inline void insert_binfmt(struct linux_binfmt *fmt)
 111 {
 112         __register_binfmt(fmt, 1);
 113 }
 114
 115 extern void unregister_binfmt(struct linux_binfmt *);
 116
 117 extern int prepare_binprm(struct linux_binprm *);
 118 extern int __must_check remove_arg_zero(struct linux_binprm *);
 119 extern int search_binary_handler(struct linux_binprm *);
 120 extern int begin_new_exec(struct linux_binprm * bprm);
 121 extern void setup_new_exec(struct linux_binprm * bprm);
 122 extern void finalize_exec(struct linux_binprm *bprm);
 123 extern void would_dump(struct linux_binprm *, struct file *);
 124
 125 extern int suid_dumpable;
 126
 127 /* Stack area protections */
 128 #define EXSTACK_DEFAULT   0     /* Whatever the arch defaults to */
 129 #define EXSTACK_DISABLE_X 1     /* Disable executable stacks */
 130 #define EXSTACK_ENABLE_X  2     /* Enable executable stacks */
 131
 132 extern int setup_arg_pages(struct linux_binprm * bprm,
 133                            unsigned long stack_top,
 134                            int executable_stack);
 135 extern int transfer_args_to_stack(struct linux_binprm *bprm,
 136                                   unsigned long *sp_location);
 137 extern int bprm_change_interp(const char *interp, struct linux_binprm *bprm);
 138 extern int copy_strings_kernel(int argc, const char *const *argv,
 139                                struct linux_binprm *bprm);
 140 extern void set_binfmt(struct linux_binfmt *new);
 141 extern ssize_t read_code(struct file *, unsigned long, loff_t, size_t);
 142
 143 extern int do_execve(struct filename *,
 144                      const char __user * const __user *,
 145                      const char __user * const __user *);
 146 extern int do_execveat(int, struct filename *,
 147                        const char __user * const __user *,
 148                        const char __user * const __user *,
 149                        int);
 150 int do_execve_file(struct file *file, void *__argv, void *__envp);
 151
 152 #endif /* _LINUX_BINFMTS_H */