granicus.if.org Git - sudo/blob - src/sudo.h

   1 /*
   2  * Copyright (c) 1993-1996, 1998-2005, 2007-2016
   3  *      Todd C. Miller <Todd.Miller@sudo.ws>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  *
  17  * Sponsored in part by the Defense Advanced Research Projects
  18  * Agency (DARPA) and Air Force Research Laboratory, Air Force
  19  * Materiel Command, USAF, under agreement number F39502-99-1-0512.
  20  */
  21
  22 #ifndef SUDO_SUDO_H
  23 #define SUDO_SUDO_H
  24
  25 #include <limits.h>
  26 #include <pathnames.h>
  27 #ifdef HAVE_STDBOOL_H
  28 # include <stdbool.h>
  29 #else
  30 # include "compat/stdbool.h"
  31 #endif /* HAVE_STDBOOL_H */
  32
  33 #include "sudo_gettext.h"       /* must be included before sudo_compat.h */
  34
  35 #include "sudo_compat.h"
  36 #include "sudo_fatal.h"
  37 #include "sudo_conf.h"
  38 #include "sudo_debug.h"
  39 #include "sudo_queue.h"
  40 #include "sudo_util.h"
  41
  42 #ifdef HAVE_PRIV_SET
  43 # include <priv.h>
  44 #endif
  45
  46 #ifdef __TANDEM
  47 # define ROOT_UID       65535
  48 #else
  49 # define ROOT_UID       0
  50 #endif
  51
  52 /*
  53  * Various modes sudo can be in (based on arguments) in hex
  54  */
  55 #define MODE_RUN                0x00000001
  56 #define MODE_EDIT               0x00000002
  57 #define MODE_VALIDATE           0x00000004
  58 #define MODE_INVALIDATE         0x00000008
  59 #define MODE_KILL               0x00000010
  60 #define MODE_VERSION            0x00000020
  61 #define MODE_HELP               0x00000040
  62 #define MODE_LIST               0x00000080
  63 #define MODE_CHECK              0x00000100
  64 #define MODE_MASK               0x0000ffff
  65
  66 /* Mode flags */
  67 /* XXX - prune this */
  68 #define MODE_BACKGROUND         0x00010000
  69 #define MODE_SHELL              0x00020000
  70 #define MODE_LOGIN_SHELL        0x00040000
  71 #define MODE_IMPLIED_SHELL      0x00080000
  72 #define MODE_RESET_HOME         0x00100000
  73 #define MODE_PRESERVE_GROUPS    0x00200000
  74 #define MODE_PRESERVE_ENV       0x00400000
  75 #define MODE_NONINTERACTIVE     0x00800000
  76 #define MODE_LONG_LIST          0x01000000
  77
  78 /*
  79  * Flags for tgetpass()
  80  */
  81 #define TGP_NOECHO      0x00            /* turn echo off reading pw (default) */
  82 #define TGP_ECHO        0x01            /* leave echo on when reading passwd */
  83 #define TGP_STDIN       0x02            /* read from stdin, not /dev/tty */
  84 #define TGP_ASKPASS     0x04            /* read from askpass helper program */
  85 #define TGP_MASK        0x08            /* mask user input when reading */
  86 #define TGP_NOECHO_TRY  0x10            /* turn off echo if possible */
  87
  88 /* name/value pairs for command line settings. */
  89 struct sudo_settings {
  90     const char *name;
  91     const char *value;
  92 };
  93
  94 struct user_details {
  95     pid_t pid;
  96     pid_t ppid;
  97     pid_t pgid;
  98     pid_t tcpgid;
  99     pid_t sid;
 100     uid_t uid;
 101     uid_t euid;
 102     uid_t gid;
 103     uid_t egid;
 104     const char *username;
 105     const char *cwd;
 106     const char *tty;
 107     const char *host;
 108     const char *shell;
 109     GETGROUPS_T *groups;
 110     int ngroups;
 111     int ts_rows;
 112     int ts_cols;
 113 };
 114
 115 #define CD_SET_UID              0x00001
 116 #define CD_SET_EUID             0x00002
 117 #define CD_SET_GID              0x00004
 118 #define CD_SET_EGID             0x00008
 119 #define CD_PRESERVE_GROUPS      0x00010
 120 #define CD_NOEXEC               0x00020
 121 #define CD_SET_PRIORITY         0x00040
 122 #define CD_SET_UMASK            0x00080
 123 #define CD_SET_TIMEOUT          0x00100
 124 #define CD_SUDOEDIT             0x00200
 125 #define CD_BACKGROUND           0x00400
 126 #define CD_RBAC_ENABLED         0x00800
 127 #define CD_USE_PTY              0x01000
 128 #define CD_SET_UTMP             0x02000
 129 #define CD_EXEC_BG              0x04000
 130 #define CD_SUDOEDIT_COPY        0x08000
 131 #define CD_SUDOEDIT_FOLLOW      0x10000
 132 #define CD_SUDOEDIT_CHECKDIR    0x20000
 133 #define CD_SET_GROUPS           0x40000
 134 #define CD_LOGIN_SHELL          0x80000
 135
 136 struct preserved_fd {
 137     TAILQ_ENTRY(preserved_fd) entries;
 138     int lowfd;
 139     int highfd;
 140     int flags;
 141 };
 142 TAILQ_HEAD(preserved_fd_list, preserved_fd);
 143
 144 struct command_details {
 145     uid_t uid;
 146     uid_t euid;
 147     gid_t gid;
 148     gid_t egid;
 149     mode_t umask;
 150     int priority;
 151     int timeout;
 152     int ngroups;
 153     int closefrom;
 154     int flags;
 155     int execfd;
 156     struct preserved_fd_list preserved_fds;
 157     struct passwd *pw;
 158     GETGROUPS_T *groups;
 159     const char *command;
 160     const char *cwd;
 161     const char *login_class;
 162     const char *chroot;
 163     const char *selinux_role;
 164     const char *selinux_type;
 165     const char *utmp_user;
 166     char **argv;
 167     char **envp;
 168 #ifdef HAVE_PRIV_SET
 169     priv_set_t *privs;
 170     priv_set_t *limitprivs;
 171 #endif
 172 };
 173
 174 /* Status passed between parent and child via socketpair */
 175 struct command_status {
 176 #define CMD_INVALID     0
 177 #define CMD_ERRNO       1
 178 #define CMD_WSTATUS     2
 179 #define CMD_SIGNO       3
 180 #define CMD_PID         4
 181 #define CMD_TTYWINCH    5
 182     int type;
 183     int val;
 184 };
 185
 186 /* Garbage collector data types. */
 187 enum sudo_gc_types {
 188     GC_UNKNOWN,
 189     GC_VECTOR,
 190     GC_PTR
 191 };
 192
 193 /* For fatal() and fatalx() (XXX - needed?) */
 194 void cleanup(int);
 195
 196 /* tgetpass.c */
 197 char *tgetpass(const char *prompt, int timeout, int flags,
 198     struct sudo_conv_callback *callback);
 199
 200 /* exec.c */
 201 int sudo_execute(struct command_details *details, struct command_status *cstat);
 202
 203 /* parse_args.c */
 204 int parse_args(int argc, char **argv, int *nargc, char ***nargv,
 205     struct sudo_settings **settingsp, char ***env_addp);
 206 extern int tgetpass_flags;
 207
 208 /* get_pty.c */
 209 bool get_pty(int *master, int *slave, char *name, size_t namesz, uid_t uid);
 210
 211 /* sudo.c */
 212 int policy_init_session(struct command_details *details);
 213 int run_command(struct command_details *details);
 214 int os_init_common(int argc, char *argv[], char *envp[]);
 215 bool gc_add(enum sudo_gc_types type, void *v);
 216 void disable_coredump(bool restore);
 217 bool set_user_groups(struct command_details *details);
 218 extern const char *list_user;
 219 extern struct user_details user_details;
 220 extern int sudo_debug_instance;
 221
 222 /* sudo_edit.c */
 223 int sudo_edit(struct command_details *details);
 224
 225 /* parse_args.c */
 226 void usage(int);
 227
 228 /* openbsd.c */
 229 int os_init_openbsd(int argc, char *argv[], char *envp[]);
 230
 231 /* selinux.c */
 232 int selinux_restore_tty(void);
 233 int selinux_setup(const char *role, const char *type, const char *ttyn,
 234     int ttyfd);
 235 void selinux_execve(int fd, const char *path, char *const argv[],
 236     char *envp[], bool noexec);
 237
 238 /* solaris.c */
 239 void set_project(struct passwd *);
 240 int os_init_solaris(int argc, char *argv[], char *envp[]);
 241
 242 /* hooks.c */
 243 /* XXX - move to sudo_plugin_int.h? */
 244 struct sudo_hook;
 245 int register_hook(struct sudo_hook *hook);
 246 int deregister_hook(struct sudo_hook *hook);
 247 int process_hooks_getenv(const char *name, char **val);
 248 int process_hooks_setenv(const char *name, const char *value, int overwrite);
 249 int process_hooks_putenv(char *string);
 250 int process_hooks_unsetenv(const char *name);
 251
 252 /* env_hooks.c */
 253 char *getenv_unhooked(const char *name);
 254
 255 /* interfaces.c */
 256 int get_net_ifs(char **addrinfo);
 257
 258 /* ttyname.c */
 259 char *get_process_ttyname(char *name, size_t namelen);
 260
 261 /* signal.c */
 262 struct sigaction;
 263 int sudo_sigaction(int signo, struct sigaction *sa, struct sigaction *osa);
 264 void init_signals(void);
 265 void restore_signals(void);
 266 void save_signals(void);
 267 bool signal_pending(int signo);
 268
 269 /* preload.c */
 270 void preload_static_symbols(void);
 271
 272 /* preserve_fds.c */
 273 int add_preserved_fd(struct preserved_fd_list *pfds, int fd);
 274 void closefrom_except(int startfd, struct preserved_fd_list *pfds);
 275 void parse_preserved_fds(struct preserved_fd_list *pfds, const char *fdstr);
 276
 277 /* setpgrp_nobg.c */
 278 int tcsetpgrp_nobg(int fd, pid_t pgrp_id);
 279
 280 #endif /* SUDO_SUDO_H */