git.gag.com Git - debian/sudo/blob - sudo.h

   1 /*
   2  * Copyright (c) 1993-1996,1998-2007 Todd C. Miller <Todd.Miller@courtesan.com>
   3  *
   4  * Permission to use, copy, modify, and distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  *
  16  * Sponsored in part by the Defense Advanced Research Projects
  17  * Agency (DARPA) and Air Force Research Laboratory, Air Force
  18  * Materiel Command, USAF, under agreement number F39502-99-1-0512.
  19  *
  20  * $Sudo: sudo.h,v 1.209.2.11 2007/09/13 23:06:51 millert Exp $
  21  */
  22
  23 #ifndef _SUDO_SUDO_H
  24 #define _SUDO_SUDO_H
  25
  26 #include <pathnames.h>
  27 #include <limits.h>
  28 #include "compat.h"
  29 #include "defaults.h"
  30 #include "logging.h"
  31
  32 /*
  33  * Info pertaining to the invoking user.
  34  */
  35 struct sudo_user {
  36     struct passwd *pw;
  37     struct passwd *_runas_pw;
  38     struct stat *cmnd_stat;
  39     char *path;
  40     char *shell;
  41     char *tty;
  42     char *ttypath;
  43     char  cwd[PATH_MAX];
  44     char *host;
  45     char *shost;
  46     char **runas;
  47     char *prompt;
  48     char *cmnd;
  49     char *cmnd_args;
  50     char *cmnd_base;
  51     char *cmnd_safe;
  52     char *class_name;
  53     int ngroups;
  54     gid_t *groups;
  55     struct list_member *env_vars;
  56 };
  57
  58 /*
  59  * Return values for sudoers_lookup(), also used as arguments for log_auth()
  60  * Note: cannot use '0' as a value here.
  61  */
  62 /* XXX - VALIDATE_SUCCESS and VALIDATE_FAILURE instead? */
  63 #define VALIDATE_ERROR          0x001
  64 #define VALIDATE_OK             0x002
  65 #define VALIDATE_NOT_OK         0x004
  66 #define FLAG_CHECK_USER         0x010
  67 #define FLAG_NOPASS             0x020
  68 #define FLAG_NO_USER            0x040
  69 #define FLAG_NO_HOST            0x080
  70 #define FLAG_NO_CHECK           0x100
  71 #define FLAG_NOEXEC             0x200
  72 #define FLAG_SETENV             0x400
  73
  74 /*
  75  * Pseudo-boolean values
  76  */
  77 #undef TRUE
  78 #define TRUE                     1
  79 #undef FALSE
  80 #define FALSE                    0
  81 #undef NOMATCH
  82 #define NOMATCH                 -1
  83 #undef UNSPEC
  84 #define UNSPEC                  -2
  85
  86 /*
  87  * find_path()/load_cmnd() return values
  88  */
  89 #define FOUND                    1
  90 #define NOT_FOUND                0
  91 #define NOT_FOUND_DOT           -1
  92
  93 /*
  94  * Various modes sudo can be in (based on arguments) in hex
  95  */
  96 #define MODE_RUN                0x0001
  97 #define MODE_EDIT               0x0002
  98 #define MODE_VALIDATE           0x0004
  99 #define MODE_INVALIDATE         0x0008
 100 #define MODE_KILL               0x0010
 101 #define MODE_VERSION            0x0020
 102 #define MODE_HELP               0x0040
 103 #define MODE_LIST               0x0080
 104 #define MODE_LISTDEFS           0x0100
 105 #define MODE_BACKGROUND         0x0200
 106 #define MODE_SHELL              0x0400
 107 #define MODE_LOGIN_SHELL        0x0800
 108 #define MODE_IMPLIED_SHELL      0x1000
 109 #define MODE_RESET_HOME         0x2000
 110 #define MODE_PRESERVE_GROUPS    0x4000
 111 #define MODE_PRESERVE_ENV       0x8000
 112
 113 /*
 114  * Used with set_perms()
 115  */
 116 #define PERM_ROOT                0x00
 117 #define PERM_USER                0x01
 118 #define PERM_FULL_USER           0x02
 119 #define PERM_SUDOERS             0x03
 120 #define PERM_RUNAS               0x04
 121 #define PERM_FULL_RUNAS          0x05
 122 #define PERM_TIMESTAMP           0x06
 123
 124 /*
 125  * Shortcuts for sudo_user contents.
 126  */
 127 #define user_name               (sudo_user.pw->pw_name)
 128 #define user_passwd             (sudo_user.pw->pw_passwd)
 129 #define user_uid                (sudo_user.pw->pw_uid)
 130 #define user_gid                (sudo_user.pw->pw_gid)
 131 #define user_dir                (sudo_user.pw->pw_dir)
 132 #define user_shell              (sudo_user.shell)
 133 #define user_ngroups            (sudo_user.ngroups)
 134 #define user_groups             (sudo_user.groups)
 135 #define user_tty                (sudo_user.tty)
 136 #define user_ttypath            (sudo_user.ttypath)
 137 #define user_cwd                (sudo_user.cwd)
 138 #define user_runas              (sudo_user.runas)
 139 #define user_cmnd               (sudo_user.cmnd)
 140 #define user_args               (sudo_user.cmnd_args)
 141 #define user_base               (sudo_user.cmnd_base)
 142 #define user_stat               (sudo_user.cmnd_stat)
 143 #define user_path               (sudo_user.path)
 144 #define user_prompt             (sudo_user.prompt)
 145 #define user_host               (sudo_user.host)
 146 #define user_shost              (sudo_user.shost)
 147 #define safe_cmnd               (sudo_user.cmnd_safe)
 148 #define login_class             (sudo_user.class_name)
 149 #define runas_pw                (sudo_user._runas_pw)
 150
 151 /*
 152  * We used to use the system definition of PASS_MAX or _PASSWD_LEN,
 153  * but that caused problems with various alternate authentication
 154  * methods.  So, we just define our own and assume that it is >= the
 155  * system max.
 156  */
 157 #define SUDO_PASS_MAX   256
 158
 159 /*
 160  * Flags for lock_file()
 161  */
 162 #define SUDO_LOCK       1               /* lock a file */
 163 #define SUDO_TLOCK      2               /* test & lock a file (non-blocking) */
 164 #define SUDO_UNLOCK     4               /* unlock a file */
 165
 166 /*
 167  * Flags for tgetpass()
 168  */
 169 #define TGP_ECHO        0x01            /* leave echo on when reading passwd */
 170 #define TGP_STDIN       0x02            /* read from stdin, not /dev/tty */
 171
 172 struct passwd;
 173 struct timespec;
 174 struct timeval;
 175
 176 /*
 177  * Function prototypes
 178  */
 179 #define YY_DECL int yylex __P((void))
 180
 181 #ifndef HAVE_CLOSEFROM
 182 void closefrom          __P((int));
 183 #endif
 184 #ifndef HAVE_GETCWD
 185 char *getcwd            __P((char *, size_t size));
 186 #endif
 187 #ifndef HAVE_UTIMES
 188 int utimes              __P((const char *, const struct timeval *));
 189 #endif
 190 #ifdef HAVE_FUTIME
 191 int futimes             __P((int, const struct timeval *));
 192 #endif
 193 #ifndef HAVE_SNPRINTF
 194 int snprintf            __P((char *, size_t, const char *, ...))
 195                             __printflike(3, 4);
 196 #endif
 197 #ifndef HAVE_VSNPRINTF
 198 int vsnprintf           __P((char *, size_t, const char *, va_list))
 199                             __printflike(3, 0);
 200 #endif
 201 #ifndef HAVE_ASPRINTF
 202 int asprintf            __P((char **, const char *, ...))
 203                             __printflike(2, 3);
 204 #endif
 205 #ifndef HAVE_VASPRINTF
 206 int vasprintf           __P((char **, const char *, va_list))
 207                             __printflike(2, 0);
 208 #endif
 209 #ifndef HAVE_STRCASECMP
 210 int strcasecmp          __P((const char *, const char *));
 211 #endif
 212 #ifndef HAVE_STRLCAT
 213 size_t strlcat          __P((char *, const char *, size_t));
 214 #endif
 215 #ifndef HAVE_STRLCPY
 216 size_t strlcpy          __P((char *, const char *, size_t));
 217 #endif
 218 #ifndef HAVE_MEMRCHR
 219 VOID *memrchr           __P((const VOID *, int, size_t));
 220 #endif
 221 #ifndef HAVE_MKSTEMP
 222 int mkstemp             __P((char *));
 223 #endif
 224 char *sudo_goodpath     __P((const char *, struct stat *));
 225 char *tgetpass          __P((const char *, int, int));
 226 int find_path           __P((char *, char **, struct stat *, char *));
 227 void check_user         __P((int));
 228 void verify_user        __P((struct passwd *, char *));
 229 int sudoers_lookup      __P((int));
 230 #ifdef HAVE_LDAP
 231 int sudo_ldap_check     __P((int));
 232 void sudo_ldap_list_matches __P((void));
 233 #endif
 234 void set_perms          __P((int));
 235 void remove_timestamp   __P((int));
 236 int check_secureware    __P((char *));
 237 void sia_attempt_auth   __P((void));
 238 void pam_attempt_auth   __P((void));
 239 int yyparse             __P((void));
 240 void pass_warn          __P((FILE *));
 241 VOID *emalloc           __P((size_t));
 242 VOID *emalloc2          __P((size_t, size_t));
 243 VOID *erealloc          __P((VOID *, size_t));
 244 VOID *erealloc3         __P((VOID *, size_t, size_t));
 245 char *estrdup           __P((const char *));
 246 int easprintf           __P((char **, const char *, ...))
 247                             __printflike(2, 3);
 248 int evasprintf          __P((char **, const char *, va_list))
 249                             __printflike(2, 0);
 250 void efree              __P((VOID *));
 251 void dump_defaults      __P((void));
 252 void dump_auth_methods  __P((void));
 253 void init_envtables     __P((void));
 254 int lock_file           __P((int, int));
 255 int touch               __P((int, char *, struct timespec *));
 256 int user_is_exempt      __P((void));
 257 void set_fqdn           __P((void));
 258 int set_runaspw         __P((char *));
 259 char *sudo_getepw       __P((const struct passwd *));
 260 int pam_prep_user       __P((struct passwd *));
 261 void zero_bytes         __P((volatile VOID *, size_t));
 262 int gettime             __P((struct timespec *));
 263 YY_DECL;
 264
 265 /* Only provide extern declarations outside of sudo.c. */
 266 #ifndef _SUDO_MAIN
 267 extern struct sudo_user sudo_user;
 268 extern struct passwd *auth_pw;
 269
 270 extern FILE *sudoers_fp;
 271 extern int tgetpass_flags;
 272 extern uid_t timestamp_uid;
 273 #endif
 274 #ifndef errno
 275 extern int errno;
 276 #endif
 277
 278 #endif /* _SUDO_SUDO_H */