granicus.if.org Git - sudo/blob - plugins/sudoers/sudoers.h

   1 /*
   2  * Copyright (c) 1993-1996, 1998-2005, 2007-2017
   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 SUDOERS_SUDOERS_H
  23 #define SUDOERS_SUDOERS_H
  24
  25 #include <limits.h>
  26 #ifdef HAVE_STDBOOL_H
  27 # include <stdbool.h>
  28 #else
  29 # include "compat/stdbool.h"
  30 #endif /* HAVE_STDBOOL_H */
  31
  32 #define DEFAULT_TEXT_DOMAIN     "sudoers"
  33 #include "sudo_gettext.h"       /* must be included before sudo_compat.h */
  34
  35 #include <pathnames.h>
  36 #include "sudo_compat.h"
  37 #include "sudo_fatal.h"
  38 #include "sudo_queue.h"
  39 #include "defaults.h"
  40 #include "logging.h"
  41 #include "parse.h"
  42 #include "sudo_nss.h"
  43 #include "sudo_plugin.h"
  44 #include "sudo_conf.h"
  45 #include "sudo_util.h"
  46 #include "sudoers_debug.h"
  47
  48 /*
  49  * Supplementary group IDs for a user.
  50  */
  51 struct gid_list {
  52     int ngids;
  53     GETGROUPS_T *gids;
  54 };
  55
  56 /*
  57  * Supplementary group names for a user.
  58  */
  59 struct group_list {
  60     int ngroups;
  61     char **groups;
  62 };
  63
  64 /*
  65  * Info pertaining to the invoking user.
  66  */
  67 struct sudo_user {
  68     struct passwd *pw;
  69     struct passwd *_runas_pw;
  70     struct group *_runas_gr;
  71     struct stat *cmnd_stat;
  72     char *name;
  73     char *path;
  74     char *tty;
  75     char *ttypath;
  76     char *host;
  77     char *shost;
  78     char *runhost;
  79     char *srunhost;
  80     char *prompt;
  81     char *cmnd;
  82     char *cmnd_args;
  83     char *cmnd_base;
  84     char *cmnd_safe;
  85     char *class_name;
  86     char *krb5_ccname;
  87     struct gid_list *gid_list;
  88     char * const * env_vars;
  89 #ifdef HAVE_SELINUX
  90     char *role;
  91     char *type;
  92 #endif
  93 #ifdef HAVE_PRIV_SET
  94     char *privs;
  95     char *limitprivs;
  96 #endif
  97     const char *cwd;
  98     char *iolog_file;
  99     GETGROUPS_T *gids;
 100     int   execfd;
 101     int   ngids;
 102     int   closefrom;
 103     int   lines;
 104     int   cols;
 105     int   flags;
 106     int   max_groups;
 107     int   timeout;
 108     mode_t umask;
 109     uid_t uid;
 110     uid_t gid;
 111     pid_t sid;
 112 };
 113
 114 /*
 115  * sudo_get_gidlist() type values
 116  */
 117 #define ENTRY_TYPE_ANY          0x00
 118 #define ENTRY_TYPE_QUERIED      0x01
 119 #define ENTRY_TYPE_FRONTEND     0x02
 120
 121 /*
 122  * sudo_user flag values
 123  */
 124 #define RUNAS_USER_SPECIFIED    0x01
 125 #define RUNAS_GROUP_SPECIFIED   0x02
 126
 127 /*
 128  * Return values for sudoers_lookup(), also used as arguments for log_auth()
 129  * Note: cannot use '0' as a value here.
 130  */
 131 #define VALIDATE_ERROR          0x001
 132 #define VALIDATE_SUCCESS        0x002
 133 #define VALIDATE_FAILURE        0x004
 134 #define FLAG_CHECK_USER         0x010
 135 #define FLAG_NO_USER            0x020
 136 #define FLAG_NO_HOST            0x040
 137 #define FLAG_NO_CHECK           0x080
 138 #define FLAG_NON_INTERACTIVE    0x100
 139 #define FLAG_BAD_PASSWORD       0x200
 140
 141 /*
 142  * find_path()/set_cmnd() return values
 143  */
 144 #define FOUND                   0
 145 #define NOT_FOUND               1
 146 #define NOT_FOUND_DOT           2
 147 #define NOT_FOUND_ERROR         3
 148 #define NOT_FOUND_PATH          4
 149
 150 /*
 151  * Various modes sudo can be in (based on arguments) in hex
 152  */
 153 #define MODE_RUN                0x00000001
 154 #define MODE_EDIT               0x00000002
 155 #define MODE_VALIDATE           0x00000004
 156 #define MODE_INVALIDATE         0x00000008
 157 #define MODE_KILL               0x00000010
 158 #define MODE_VERSION            0x00000020
 159 #define MODE_HELP               0x00000040
 160 #define MODE_LIST               0x00000080
 161 #define MODE_CHECK              0x00000100
 162 #define MODE_ERROR              0x00000200
 163 #define MODE_MASK               0x0000ffff
 164
 165 /* Mode flags */
 166 #define MODE_BACKGROUND         0x00010000 /* XXX - unused */
 167 #define MODE_SHELL              0x00020000
 168 #define MODE_LOGIN_SHELL        0x00040000
 169 #define MODE_IMPLIED_SHELL      0x00080000
 170 #define MODE_RESET_HOME         0x00100000
 171 #define MODE_PRESERVE_GROUPS    0x00200000
 172 #define MODE_PRESERVE_ENV       0x00400000
 173 #define MODE_NONINTERACTIVE     0x00800000
 174 #define MODE_IGNORE_TICKET      0x01000000
 175
 176 /*
 177  * Used with set_perms()
 178  */
 179 #define PERM_INITIAL            0x00
 180 #define PERM_ROOT               0x01
 181 #define PERM_USER               0x02
 182 #define PERM_FULL_USER          0x03
 183 #define PERM_SUDOERS            0x04
 184 #define PERM_RUNAS              0x05
 185 #define PERM_TIMESTAMP          0x06
 186 #define PERM_IOLOG              0x07
 187
 188 /*
 189  * Shortcuts for sudo_user contents.
 190  */
 191 #define user_name               (sudo_user.name)
 192 #define user_uid                (sudo_user.uid)
 193 #define user_gid                (sudo_user.gid)
 194 #define user_sid                (sudo_user.sid)
 195 #define user_umask              (sudo_user.umask)
 196 #define user_passwd             (sudo_user.pw->pw_passwd)
 197 #define user_dir                (sudo_user.pw->pw_dir)
 198 #define user_gids               (sudo_user.gids)
 199 #define user_ngids              (sudo_user.ngids)
 200 #define user_gid_list           (sudo_user.gid_list)
 201 #define user_tty                (sudo_user.tty)
 202 #define user_ttypath            (sudo_user.ttypath)
 203 #define user_cwd                (sudo_user.cwd)
 204 #define user_cmnd               (sudo_user.cmnd)
 205 #define user_args               (sudo_user.cmnd_args)
 206 #define user_base               (sudo_user.cmnd_base)
 207 #define user_stat               (sudo_user.cmnd_stat)
 208 #define user_path               (sudo_user.path)
 209 #define user_prompt             (sudo_user.prompt)
 210 #define user_host               (sudo_user.host)
 211 #define user_shost              (sudo_user.shost)
 212 #define user_runhost            (sudo_user.runhost)
 213 #define user_srunhost           (sudo_user.srunhost)
 214 #define user_ccname             (sudo_user.krb5_ccname)
 215 #define safe_cmnd               (sudo_user.cmnd_safe)
 216 #define cmnd_fd                 (sudo_user.execfd)
 217 #define login_class             (sudo_user.class_name)
 218 #define runas_pw                (sudo_user._runas_pw)
 219 #define runas_gr                (sudo_user._runas_gr)
 220 #define user_role               (sudo_user.role)
 221 #define user_type               (sudo_user.type)
 222 #define user_closefrom          (sudo_user.closefrom)
 223 #define runas_privs             (sudo_user.privs)
 224 #define runas_limitprivs        (sudo_user.limitprivs)
 225 #define user_timeout            (sudo_user.timeout)
 226
 227 /* Default sudoers uid/gid/mode if not set by the Makefile. */
 228 #ifndef SUDOERS_UID
 229 # define SUDOERS_UID    0
 230 #endif
 231 #ifndef SUDOERS_GID
 232 # define SUDOERS_GID    0
 233 #endif
 234 #ifndef SUDOERS_MODE
 235 # define SUDOERS_MODE   0600
 236 #endif
 237
 238 #ifdef __TANDEM
 239 # define ROOT_UID       65535
 240 #else
 241 # define ROOT_UID       0
 242 #endif
 243 #define ROOT_GID        0
 244
 245 struct sudo_lbuf;
 246 struct passwd;
 247 struct stat;
 248 struct timespec;
 249
 250 /*
 251  * Function prototypes
 252  */
 253 #define YY_DECL int sudoerslex(void)
 254
 255 /* goodpath.c */
 256 bool sudo_goodpath(const char *path, struct stat *sbp);
 257
 258 /* findpath.c */
 259 int find_path(const char *infile, char **outfile, struct stat *sbp,
 260     const char *path, int ignore_dot, char * const *whitelist);
 261
 262 /* check.c */
 263 int check_user(int validate, int mode);
 264 bool user_is_exempt(void);
 265
 266 /* prompt.c */
 267 char *expand_prompt(const char *old_prompt, const char *auth_user);
 268
 269 /* timestamp.c */
 270 int timestamp_remove(bool unlinkit);
 271
 272 /* sudo_auth.c */
 273 bool sudo_auth_needs_end_session(void);
 274 int verify_user(struct passwd *pw, char *prompt, int validated, struct sudo_conv_callback *callback);
 275 int sudo_auth_begin_session(struct passwd *pw, char **user_env[]);
 276 int sudo_auth_end_session(struct passwd *pw);
 277 int sudo_auth_init(struct passwd *pw);
 278 int sudo_auth_approval(struct passwd *pw, int validated, bool exempt);
 279 int sudo_auth_cleanup(struct passwd *pw);
 280
 281 /* set_perms.c */
 282 bool rewind_perms(void);
 283 bool set_perms(int);
 284 bool restore_perms(void);
 285 int pam_prep_user(struct passwd *);
 286
 287 /* gram.y */
 288 int sudoersparse(void);
 289 extern char *login_style;
 290 extern char *errorfile;
 291 extern int errorlineno;
 292 extern bool parse_error;
 293 extern bool sudoers_warnings;
 294
 295 /* toke.l */
 296 YY_DECL;
 297 extern FILE *sudoersin;
 298 extern const char *sudoers_file;
 299 extern char *sudoers;
 300 extern mode_t sudoers_mode;
 301 extern uid_t sudoers_uid;
 302 extern gid_t sudoers_gid;
 303 extern int sudolineno;
 304 extern int last_token;
 305
 306 /* defaults.c */
 307 void dump_defaults(void);
 308 void dump_auth_methods(void);
 309
 310 /* getspwuid.c */
 311 char *sudo_getepw(const struct passwd *);
 312
 313 /* pwutil.c */
 314 typedef struct cache_item * (*sudo_make_pwitem_t)(uid_t uid, const char *user);
 315 typedef struct cache_item * (*sudo_make_gritem_t)(gid_t gid, const char *group);
 316 typedef struct cache_item * (*sudo_make_gidlist_item_t)(const struct passwd *pw, char * const *gids, unsigned int type);
 317 typedef struct cache_item * (*sudo_make_grlist_item_t)(const struct passwd *pw, char * const *groups);
 318 __dso_public struct group *sudo_getgrgid(gid_t);
 319 __dso_public struct group *sudo_getgrnam(const char *);
 320 __dso_public void sudo_gr_addref(struct group *);
 321 __dso_public void sudo_gr_delref(struct group *);
 322 bool user_in_group(const struct passwd *, const char *);
 323 struct group *sudo_fakegrnam(const char *);
 324 struct gid_list *sudo_get_gidlist(const struct passwd *pw, unsigned int type);
 325 struct group_list *sudo_get_grlist(const struct passwd *pw);
 326 struct passwd *sudo_fakepwnam(const char *, gid_t);
 327 struct passwd *sudo_mkpwent(const char *user, uid_t uid, gid_t gid, const char *home, const char *shell);
 328 struct passwd *sudo_getpwnam(const char *);
 329 struct passwd *sudo_getpwuid(uid_t);
 330 void sudo_endspent(void);
 331 void sudo_freegrcache(void);
 332 void sudo_freepwcache(void);
 333 void sudo_gidlist_addref(struct gid_list *);
 334 void sudo_gidlist_delref(struct gid_list *);
 335 void sudo_grlist_addref(struct group_list *);
 336 void sudo_grlist_delref(struct group_list *);
 337 void sudo_pw_addref(struct passwd *);
 338 void sudo_pw_delref(struct passwd *);
 339 int  sudo_set_gidlist(struct passwd *pw, char * const *gids, unsigned int type);
 340 int  sudo_set_grlist(struct passwd *pw, char * const *groups);
 341 void sudo_pwutil_set_backend(sudo_make_pwitem_t, sudo_make_gritem_t, sudo_make_gidlist_item_t, sudo_make_grlist_item_t);
 342 void sudo_setspent(void);
 343
 344 /* timestr.c */
 345 char *get_timestr(time_t, int);
 346
 347 /* boottime.c */
 348 bool get_boottime(struct timespec *);
 349
 350 /* iolog.c */
 351 bool io_nextid(char *iolog_dir, char *iolog_dir_fallback, char sessid[7]);
 352 bool cb_maxseq(const union sudo_defs_val *sd_un);
 353 bool cb_iolog_user(const union sudo_defs_val *sd_un);
 354 bool cb_iolog_group(const union sudo_defs_val *sd_un);
 355 bool cb_iolog_mode(const union sudo_defs_val *sd_un);
 356 extern uid_t iolog_uid;
 357 extern gid_t iolog_gid;
 358
 359 /* iolog_path.c */
 360 char *expand_iolog_path(const char *prefix, const char *dir, const char *file,
 361     char **slashp);
 362
 363 /* env.c */
 364 char **env_get(void);
 365 bool env_merge(char * const envp[]);
 366 bool env_swap_old(void);
 367 bool env_init(char * const envp[]);
 368 bool init_envtables(void);
 369 bool insert_env_vars(char * const envp[]);
 370 bool read_env_file(const char *path, bool overwrite, bool restricted);
 371 bool rebuild_env(void);
 372 bool validate_env_vars(char * const envp[]);
 373 int sudo_setenv(const char *var, const char *val, int overwrite);
 374 int sudo_unsetenv(const char *var);
 375 char *sudo_getenv(const char *name);
 376 int sudoers_hook_getenv(const char *name, char **value, void *closure);
 377 int sudoers_hook_putenv(char *string, void *closure);
 378 int sudoers_hook_setenv(const char *name, const char *value, int overwrite, void *closure);
 379 int sudoers_hook_unsetenv(const char *name, void *closure);
 380 void register_env_file(void * (*ef_open)(const char *), void (*ef_close)(void *), char * (*ef_next)(void *, int *), bool system);
 381
 382 /* env_pattern.c */
 383 bool matches_env_pattern(const char *pattern, const char *var, bool *full_match);
 384
 385 /* sudoers.c */
 386 FILE *open_sudoers(const char *, bool, bool *);
 387 int sudoers_policy_init(void *info, char * const envp[]);
 388 int sudoers_policy_main(int argc, char * const argv[], int pwflag, char *env_add[], bool verbose, void *closure);
 389 void sudoers_cleanup(void);
 390 extern struct sudo_user sudo_user;
 391 extern struct passwd *list_pw;
 392 extern int sudo_mode;
 393 extern uid_t timestamp_uid;
 394 extern gid_t timestamp_gid;
 395 extern sudo_conv_t sudo_conv;
 396 extern sudo_printf_t sudo_printf;
 397
 398 /* sudoers_debug.c */
 399 bool sudoers_debug_parse_flags(struct sudo_conf_debug_file_list *debug_files, const char *entry);
 400 bool sudoers_debug_register(const char *plugin_path, struct sudo_conf_debug_file_list *debug_files);
 401 void sudoers_debug_deregister(void);
 402
 403 /* policy.c */
 404 int sudoers_policy_deserialize_info(void *v, char **runas_user, char **runas_group);
 405 int sudoers_policy_exec_setup(char *argv[], char *envp[], mode_t cmnd_umask, char *iolog_path, void *v);
 406 extern const char *path_ldap_conf;
 407 extern const char *path_ldap_secret;
 408
 409 /* group_plugin.c */
 410 int group_plugin_load(char *plugin_info);
 411 void group_plugin_unload(void);
 412 int group_plugin_query(const char *user, const char *group,
 413     const struct passwd *pwd);
 414 bool cb_group_plugin(const union sudo_defs_val *sd_un);
 415 extern const char *path_plugin_dir;
 416
 417 /* editor.c */
 418 char *find_editor(int nfiles, char **files, int *argc_out, char ***argv_out,
 419      char * const *whitelist, const char **env_editor, bool env_error);
 420
 421 /* mkdir_parents.c */
 422 bool sudo_mkdir_parents(char *path, uid_t uid, gid_t gid, mode_t mode, bool quiet);
 423
 424 /* gc.c */
 425 enum sudoers_gc_types {
 426     GC_UNKNOWN,
 427     GC_VECTOR,
 428     GC_PTR
 429 };
 430 bool sudoers_gc_add(enum sudoers_gc_types type, void *ptr);
 431 bool sudoers_gc_remove(enum sudoers_gc_types type, void *ptr);
 432 void sudoers_gc_init(void);
 433
 434 /* rcstr.c */
 435 char *rcstr_dup(const char *src);
 436 char *rcstr_alloc(size_t len);
 437 char *rcstr_addref(const char *s);
 438 void rcstr_delref(const char *s);
 439
 440 #endif /* SUDOERS_SUDOERS_H */