/* * Copyright (c) 2011-2012 Todd C. Miller * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef _SUDO_DEBUG_H #define _SUDO_DEBUG_H #include /* * The priority and subsystem are encoded in a single 32-bit value. * The lower 4 bits are the priority and the top 26 bits are the subsystem. * This allows for 16 priorities and a very large number of subsystems. * Bit 5 is used as a flag to specify whether to log the errno value. * Bit 6 specifies whether to log the function, file and line number data. */ /* * Sudo debug priorities, ordered least to most verbose, * in other words, highest to lowest priority. Max pri is 15. * Note: order must match sudo_debug_priorities[] */ #define SUDO_DEBUG_CRIT 1 /* critical errors */ #define SUDO_DEBUG_ERROR 2 /* non-critical errors */ #define SUDO_DEBUG_WARN 3 /* non-fatal warnings */ #define SUDO_DEBUG_NOTICE 4 /* non-error condition notices */ #define SUDO_DEBUG_DIAG 5 /* diagnostic messages */ #define SUDO_DEBUG_INFO 6 /* informational message */ #define SUDO_DEBUG_TRACE 7 /* log function enter/exit */ #define SUDO_DEBUG_DEBUG 8 /* very verbose debugging */ /* * Sudo debug subsystems. * This includes subsystems in the sudoers plugin. * Note: order must match sudo_debug_subsystems[] */ #define SUDO_DEBUG_MAIN ( 1<<6) /* sudo main() */ #define SUDO_DEBUG_ARGS ( 2<<6) /* command line argument processing */ #define SUDO_DEBUG_EXEC ( 3<<6) /* command execution */ #define SUDO_DEBUG_PTY ( 4<<6) /* pseudo-tty */ #define SUDO_DEBUG_UTMP ( 5<<6) /* utmp file ops */ #define SUDO_DEBUG_CONV ( 6<<6) /* user conversation */ #define SUDO_DEBUG_PCOMM ( 7<<6) /* plugin communications */ #define SUDO_DEBUG_UTIL ( 8<<6) /* utility functions */ #define SUDO_DEBUG_NETIF ( 9<<6) /* network interface functions */ #define SUDO_DEBUG_AUDIT (10<<6) /* audit */ #define SUDO_DEBUG_EDIT (11<<6) /* sudoedit */ #define SUDO_DEBUG_SELINUX (12<<6) /* selinux */ #define SUDO_DEBUG_LDAP (13<<6) /* sudoers LDAP */ #define SUDO_DEBUG_MATCH (14<<6) /* sudoers matching */ #define SUDO_DEBUG_PARSER (15<<6) /* sudoers parser */ #define SUDO_DEBUG_ALIAS (16<<6) /* sudoers alias functions */ #define SUDO_DEBUG_DEFAULTS (17<<6) /* sudoers defaults settings */ #define SUDO_DEBUG_AUTH (18<<6) /* authentication functions */ #define SUDO_DEBUG_ENV (19<<6) /* environment handling */ #define SUDO_DEBUG_LOGGING (20<<6) /* logging functions */ #define SUDO_DEBUG_NSS (21<<6) /* network service switch */ #define SUDO_DEBUG_RBTREE (22<<6) /* red-black tree functions */ #define SUDO_DEBUG_PERMS (23<<6) /* uid/gid swapping functions */ #define SUDO_DEBUG_PLUGIN (24<<6) /* main plugin functions */ #define SUDO_DEBUG_HOOKS (25<<6) /* hook functions */ #define SUDO_DEBUG_SSSD (26<<6) /* sudoers SSSD */ #define SUDO_DEBUG_ALL 0xfff0 /* all subsystems */ /* Flag to include string version of errno in debug info. */ #define SUDO_DEBUG_ERRNO (1<<4) /* Flag to include function, file and line number in debug info. */ #define SUDO_DEBUG_LINENO (1<<5) /* Extract priority and convert to an index. */ #define SUDO_DEBUG_PRI(n) (((n) & 0xf) - 1) /* Extract subsystem and convert to an index. */ #define SUDO_DEBUG_SUBSYS(n) (((n) >> 6) - 1) /* * Wrapper for sudo_debug_enter() that declares __func__ as needed * and sets sudo_debug_subsys for sudo_debug_exit(). */ #ifdef HAVE___FUNC__ # define debug_decl(funcname, subsys) \ const int sudo_debug_subsys = (subsys); \ sudo_debug_enter(__func__, __FILE__, __LINE__, sudo_debug_subsys); #else # define debug_decl(funcname, subsys) \ const int sudo_debug_subsys = (subsys); \ const char *__func__ = #funcname; \ sudo_debug_enter(__func__, __FILE__, __LINE__, sudo_debug_subsys); #endif /* * Wrappers for sudo_debug_exit() and friends. */ #define debug_return \ do { \ sudo_debug_exit(__func__, __FILE__, __LINE__, sudo_debug_subsys); \ return; \ } while (0) #define debug_return_int(rval) \ do { \ int sudo_debug_rval = (rval); \ sudo_debug_exit_int(__func__, __FILE__, __LINE__, sudo_debug_subsys, \ sudo_debug_rval); \ return sudo_debug_rval; \ } while (0) #define debug_return_size_t(rval) \ do { \ size_t sudo_debug_rval = (rval); \ sudo_debug_exit_size_t(__func__, __FILE__, __LINE__, sudo_debug_subsys,\ sudo_debug_rval); \ return sudo_debug_rval; \ } while (0) #define debug_return_long(rval) \ do { \ long sudo_debug_rval = (rval); \ sudo_debug_exit_long(__func__, __FILE__, __LINE__, sudo_debug_subsys, \ sudo_debug_rval); \ return sudo_debug_rval; \ } while (0) #define debug_return_bool(rval) \ do { \ int sudo_debug_rval = (rval); \ sudo_debug_exit_bool(__func__, __FILE__, __LINE__, sudo_debug_subsys, \ sudo_debug_rval); \ return sudo_debug_rval; \ } while (0) #define debug_return_str(rval) \ do { \ const char *sudo_debug_rval = (rval); \ sudo_debug_exit_str(__func__, __FILE__, __LINE__, sudo_debug_subsys, \ sudo_debug_rval); \ return (char *)sudo_debug_rval; \ } while (0) #define debug_return_str_masked(rval) \ do { \ const char *sudo_debug_rval = (rval); \ sudo_debug_exit_str_masked(__func__, __FILE__, __LINE__, \ sudo_debug_subsys, sudo_debug_rval); \ return (char *)sudo_debug_rval; \ } while (0) #define debug_return_ptr(rval) \ do { \ const void *sudo_debug_rval = (rval); \ sudo_debug_exit_ptr(__func__, __FILE__, __LINE__, sudo_debug_subsys, \ sudo_debug_rval); \ return (void *)sudo_debug_rval; \ } while (0) /* * Variadic macros are a C99 feature but GNU cpp has supported * a (different) version of them for a long time. */ #if defined(__GNUC__) && __GNUC__ == 2 # define sudo_debug_printf(pri, fmt...) \ sudo_debug_printf2(__func__, __FILE__, __LINE__, (pri)|sudo_debug_subsys, \ fmt) #else # define sudo_debug_printf(pri, ...) \ sudo_debug_printf2(__func__, __FILE__, __LINE__, (pri)|sudo_debug_subsys, \ __VA_ARGS__) #endif #define sudo_debug_execve(pri, path, argv, envp) \ sudo_debug_execve2((pri)|sudo_debug_subsys, (path), (argv), (envp)) /* * NULL-terminated string lists of priorities and subsystems. */ extern const char *const sudo_debug_priorities[]; extern const char *const sudo_debug_subsystems[]; void sudo_debug_enter(const char *func, const char *file, int line, int subsys); void sudo_debug_execve2(int level, const char *path, char *const argv[], char *const envp[]); void sudo_debug_exit(const char *func, const char *file, int line, int subsys); void sudo_debug_exit_int(const char *func, const char *file, int line, int subsys, int rval); void sudo_debug_exit_long(const char *func, const char *file, int line, int subsys, long rval); void sudo_debug_exit_size_t(const char *func, const char *file, int line, int subsys, size_t rval); void sudo_debug_exit_bool(const char *func, const char *file, int line, int subsys, int rval); void sudo_debug_exit_str(const char *func, const char *file, int line, int subsys, const char *rval); void sudo_debug_exit_str_masked(const char *func, const char *file, int line, int subsys, const char *rval); void sudo_debug_exit_ptr(const char *func, const char *file, int line, int subsys, const void *rval); int sudo_debug_fd_set(int fd); int sudo_debug_init(const char *debugfile, const char *settings); void sudo_debug_printf2(const char *func, const char *file, int line, int level, const char *fmt, ...) __printf0like(5, 6); void sudo_debug_vprintf2(const char *func, const char *file, int line, int level, const char *fmt, va_list ap) __printf0like(5, 0); void sudo_debug_write(const char *str, int len, int errno_val); void sudo_debug_write2(const char *func, const char *file, int line, const char *str, int len, int errno_val); pid_t sudo_debug_fork(void); #endif /* _SUDO_DEBUG_H */