/* * ProFTPD - FTP server daemon * Copyright (c) 1997, 1998 Public Flood Software * Copyright (C) 1999, 2000 MacGyver aka Habeeb J. Dihu * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. * * As a special exemption, Public Flood Software/MacGyver aka Habeeb J. Dihu * and other respective copyright holders give permission to link this program * with OpenSSL, and distribute the resulting executable, without including * the source code for OpenSSL in the source distribution. */ /* ProFTPD module definitions. * * $Id: modules.h,v 1.4 2001/06/18 17:12:45 flood Exp $ */ #ifndef __MODULES_H #define __MODULES_H typedef struct module_struc module; typedef struct modret_struc modret_t; struct modret_struc { module *mr_handler_module; /* which module handled this? */ int mr_error; /* !0 if error */ char *mr_numeric; /* numeric error code */ char *mr_message; /* text message */ void *data; /* add'l data -- undefined */ }; /* Possible error codes for auth handlers */ /* Account does not exist */ #define AUTH_NOPWD -1 /* Password mismatch */ #define AUTH_BADPWD -2 /* Password hasn't been changed recently enough */ #define AUTH_AGEPWD -3 /* Account has been disabled */ #define AUTH_DISABLEDPWD -4 /* The following macros are for creating basic modret_t, and can * only be used inside of module handlers */ #define MODRET static modret_t* #define HANDLED(cmd) mod_create_ret((cmd),\ 0,NULL,NULL) #define DECLINED(cmd) (modret_t*)NULL #define ERROR(cmd) mod_create_ret((cmd),\ 1,NULL,NULL) #define ERROR_MSG(cmd,n,m) mod_create_ret((cmd),\ 1,(n),(m)) #define ERROR_INT(cmd,n) mod_create_error((cmd),(n)) #define MODRET_ISDECLINED(x) ((x) == NULL) #define MODRET_ISHANDLED(x) ((x) && !(x)->mr_error) #define MODRET_ISERROR(x) ((x) && (x)->mr_error) #define MODRET_HASNUM(x) ((x) && (x)->mr_numeric) #define MODRET_HASMSG(x) ((x) && (x)->mr_message) #define MODRET_ERROR(x) ((x) ? (x)->mr_error : 0) #define MODRET_ERRNUM(x) ((x) ? (x)->mr_numeric : NULL) #define MODRET_ERRMSG(x) ((x) ? (x)->mr_message : NULL) #define MODRET_HASDATA(x) ((x) ? ((x)->data ? TRUE : FALSE) : FALSE) /* private data structure returned by mod_priv* */ struct privdata { char *tag; union { void *ptr_val; int int_val; long long_val; char *str_val; } value; module *m; }; typedef struct { char *directive; modret_t *(*handler)(cmd_rec*); module *m; /* Reference to owning module * set when module is initialized */ } conftable; /* classes for command table */ #define CL_NONE 0x0 #define CL_AUTH (1 << 0) /* USER, PASS */ #define CL_INFO (1 << 1) /* Informational commands (PWD, SYST, etc) */ #define CL_DIRS (1 << 2) /* Directory commands (LIST, NLST, CWD, etc) */ #define CL_READ (1 << 3) /* File reading commands (RETR) */ #define CL_WRITE (1 << 4) /* Writing commands (STOR, MKD, etc) */ #define CL_MISC (1 << 5) /* Miscellaneous (RNFR/RNTO, SITE, etc) */ #define CL_ALL (CL_AUTH|CL_INFO|CL_DIRS|CL_READ| \ CL_WRITE|CL_MISC) /* command types for command table */ #define PRE_CMD 1 #define CMD 2 #define POST_CMD 3 #define LOG_CMD 4 #define LOG_CMD_ERR 5 typedef struct { int cmd_type; /* see above for cmd types */ char *command; char *group; /* Command grouping */ modret_t *(*handler)(cmd_rec*); int requires_auth; /* Authenication required? */ int interrupt_xfer; /* Allowed to issue during xfer? */ int class; module *m; } cmdtable; typedef struct { int auth_type; /* future use */ char *name; modret_t *(*handler)(cmd_rec*); module *m; } authtable; struct module_struc { module *next,*prev; int ver; /* API version _not_ module version */ char *name; /* Module name */ conftable *conftable; /* Configuration directive table */ cmdtable *cmdtable; /* Command table */ authtable *authtable; /* Authentication handler table */ int (*module_init)(); /* Module initialization */ int (*module_init_child)(); /* Initialize newly forked child */ int priority; /* internal use, higher == higher priority */ }; /* These are stored in modules.c */ extern conftable *m_conftable; /* Master conftable */ extern cmdtable *m_cmdtable; /* Master cmdtable */ #define ANY_MODULE ((module*)0xffffffff) /* Prototypes */ void list_modules(); int init_modules(); /* Initialize modules */ int init_child_modules(); modret_t *call_module(module *m, modret_t *(*func)(cmd_rec*), cmd_rec *cmd); modret_t *call_module_cmd(module *m, modret_t *(*func)(cmd_rec*), cmd_rec *cmd); modret_t *call_module_auth(module *m, modret_t *(*func)(cmd_rec*), cmd_rec *cmd); /* Symbol table lookup functions */ conftable *mod_find_conf_symbol(char*,int*,conftable*); cmdtable *mod_find_cmd_symbol(char*,int*,cmdtable*); authtable *mod_find_auth_symbol(char*,int*,authtable*); /* This function is in main.c, but is prototyped here */ void set_auth_check(int (*ck)(cmd_rec*)); void xfer_set_data_port(p_in_addr_t*,int); /* For use from inside module handler functions */ modret_t *mod_create_ret(cmd_rec*,unsigned char,char*,char*); modret_t *mod_create_error(cmd_rec*,int); modret_t *mod_create_data(cmd_rec*,void*); privdata_t *mod_privdata_alloc(cmd_rec*,char*,int); privdata_t *mod_privdata_find(cmd_rec*,char*,module*); /* prototypes for auth.c */ void auth_setpwent(pool*); void auth_endpwent(pool*); void auth_setgrent(pool*); void auth_endgrent(pool*); struct passwd *auth_getpwent(pool*); struct group *auth_getgrent(pool*); struct passwd *auth_getpwnam(pool*,const char*); struct passwd *auth_getpwuid(pool*,uid_t); struct group *auth_getgrnam(pool*,const char*); struct group *auth_getgrgid(pool*,gid_t); int auth_authenticate(pool*,const char*,const char*); int auth_check(pool*,const char*,const char*,const char*); const char *auth_uid_name(pool*,uid_t); const char *auth_gid_name(pool*,gid_t); uid_t auth_name_uid(pool*,const char*); gid_t auth_name_gid(pool*,const char*); int get_groups(pool *, const char *, array_header **, array_header **); int set_groups(pool *, gid_t, array_header *); #endif /* __MODULES_H */