127 lines
5.0 KiB
C
127 lines
5.0 KiB
C
/*
|
|
* Copyright (c) 2009-2011 Todd C. Miller <Todd.Miller@courtesan.com>
|
|
*
|
|
* 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_PLUGIN_H
|
|
#define _SUDO_PLUGIN_H
|
|
|
|
/* API version major/minor */
|
|
#define SUDO_API_VERSION_MAJOR 1
|
|
#define SUDO_API_VERSION_MINOR 1
|
|
#define SUDO_API_MKVERSION(x, y) ((x << 16) | y)
|
|
#define SUDO_API_VERSION SUDO_API_MKVERSION(SUDO_API_VERSION_MAJOR, SUDO_API_VERSION_MINOR)
|
|
|
|
/* Getters and setters for API version */
|
|
#define SUDO_API_VERSION_GET_MAJOR(v) ((v) >> 16)
|
|
#define SUDO_API_VERSION_GET_MINOR(v) ((v) & 0xffff)
|
|
#define SUDO_API_VERSION_SET_MAJOR(vp, n) do { \
|
|
*(vp) = (*(vp) & 0x0000ffff) | ((n) << 16); \
|
|
} while(0)
|
|
#define SUDO_VERSION_SET_MINOR(vp, n) do { \
|
|
*(vp) = (*(vp) & 0xffff0000) | (n); \
|
|
} while(0)
|
|
|
|
/* Conversation function types and defines */
|
|
struct sudo_conv_message {
|
|
#define SUDO_CONV_PROMPT_ECHO_OFF 0x0001 /* do not echo user input */
|
|
#define SUDO_CONV_PROMPT_ECHO_ON 0x0002 /* echo user input */
|
|
#define SUDO_CONV_ERROR_MSG 0x0003 /* error message */
|
|
#define SUDO_CONV_INFO_MSG 0x0004 /* informational message */
|
|
#define SUDO_CONV_PROMPT_MASK 0x0005 /* mask user input */
|
|
#define SUDO_CONV_DEBUG_MSG 0x0006 /* debugging message */
|
|
#define SUDO_CONV_PROMPT_ECHO_OK 0x1000 /* flag: allow echo if no tty */
|
|
int msg_type;
|
|
int timeout;
|
|
const char *msg;
|
|
};
|
|
|
|
struct sudo_conv_reply {
|
|
char *reply;
|
|
};
|
|
|
|
typedef int (*sudo_conv_t)(int num_msgs, const struct sudo_conv_message msgs[],
|
|
struct sudo_conv_reply replies[]);
|
|
typedef int (*sudo_printf_t)(int msg_type, const char *fmt, ...);
|
|
|
|
/* Policy plugin type and defines */
|
|
struct passwd;
|
|
struct policy_plugin {
|
|
#define SUDO_POLICY_PLUGIN 1
|
|
unsigned int type; /* always SUDO_POLICY_PLUGIN */
|
|
unsigned int version; /* always SUDO_API_VERSION */
|
|
int (*open)(unsigned int version, sudo_conv_t conversation,
|
|
sudo_printf_t sudo_printf, char * const settings[],
|
|
char * const user_info[], char * const user_env[]);
|
|
void (*close)(int exit_status, int error); /* wait status or error */
|
|
int (*show_version)(int verbose);
|
|
int (*check_policy)(int argc, char * const argv[],
|
|
char *env_add[], char **command_info[],
|
|
char **argv_out[], char **user_env_out[]);
|
|
int (*list)(int argc, char * const argv[], int verbose,
|
|
const char *list_user);
|
|
int (*validate)(void);
|
|
void (*invalidate)(int remove);
|
|
int (*init_session)(struct passwd *pwd);
|
|
};
|
|
|
|
/* I/O plugin type and defines */
|
|
struct io_plugin {
|
|
#define SUDO_IO_PLUGIN 2
|
|
unsigned int type; /* always SUDO_IO_PLUGIN */
|
|
unsigned int version; /* always SUDO_API_VERSION */
|
|
int (*open)(unsigned int version, sudo_conv_t conversation,
|
|
sudo_printf_t sudo_printf, char * const settings[],
|
|
char * const user_info[], char * const command_info[],
|
|
int argc, char * const argv[], char * const user_env[]);
|
|
void (*close)(int exit_status, int error); /* wait status or error */
|
|
int (*show_version)(int verbose);
|
|
int (*log_ttyin)(const char *buf, unsigned int len);
|
|
int (*log_ttyout)(const char *buf, unsigned int len);
|
|
int (*log_stdin)(const char *buf, unsigned int len);
|
|
int (*log_stdout)(const char *buf, unsigned int len);
|
|
int (*log_stderr)(const char *buf, unsigned int len);
|
|
};
|
|
|
|
/* Sudoers group plugin version major/minor */
|
|
#define GROUP_API_VERSION_MAJOR 1
|
|
#define GROUP_API_VERSION_MINOR 0
|
|
#define GROUP_API_VERSION ((GROUP_API_VERSION_MAJOR << 16) | GROUP_API_VERSION_MINOR)
|
|
|
|
/* Getters and setters for group version */
|
|
#define GROUP_API_VERSION_GET_MAJOR(v) ((v) >> 16)
|
|
#define GROUP_API_VERSION_GET_MINOR(v) ((v) & 0xffff)
|
|
#define GROUP_API_VERSION_SET_MAJOR(vp, n) do { \
|
|
*(vp) = (*(vp) & 0x0000ffff) | ((n) << 16); \
|
|
} while(0)
|
|
#define GROUP_API_VERSION_SET_MINOR(vp, n) do { \
|
|
*(vp) = (*(vp) & 0xffff0000) | (n); \
|
|
} while(0)
|
|
|
|
/*
|
|
* version: for compatibility checking
|
|
* group_init: return 1 on success, 0 if unconfigured, -1 on error.
|
|
* group_cleanup: called to clean up resources used by provider
|
|
* user_in_group: returns 1 if user is in group, 0 if not.
|
|
* note that pwd may be NULL if the user is not in passwd.
|
|
*/
|
|
struct sudoers_group_plugin {
|
|
unsigned int version;
|
|
int (*init)(int version, sudo_printf_t sudo_printf, char *const argv[]);
|
|
void (*cleanup)(void);
|
|
int (*query)(const char *user, const char *group, const struct passwd *pwd);
|
|
};
|
|
|
|
#endif /* _SUDO_PLUGIN_H */
|