src/include/modules.h

   1 /*
   2  * module.h     Interface to the RADIUS module system.
   3  *
   4  * Version:     $Id$
   5  *
   6  */
   7
   8 #ifndef RADIUS_MODULES_H
   9 #define RADIUS_MODULES_H
  10
  11 #include <freeradius-devel/ident.h>
  12 RCSIDH(modules_h, "$Id$")
  13
  14 #include <freeradius-devel/conffile.h>
  15
  16 typedef int (*packetmethod)(void *instance, REQUEST *request);
  17
  18 enum {
  19   RLM_COMPONENT_AUTH = 0,
  20   RLM_COMPONENT_AUTZ,           /* 1 */
  21   RLM_COMPONENT_PREACCT,        /* 2 */
  22   RLM_COMPONENT_ACCT,           /* 3 */
  23   RLM_COMPONENT_SESS,           /* 4 */
  24   RLM_COMPONENT_PRE_PROXY,      /* 5 */
  25   RLM_COMPONENT_POST_PROXY,     /* 6 */
  26   RLM_COMPONENT_POST_AUTH,      /* 7 */
  27   RLM_COMPONENT_COUNT           /* 8: How many components are there */
  28 };
  29
  30 #define RLM_TYPE_THREAD_SAFE            (0 << 0)
  31 #define RLM_TYPE_THREAD_UNSAFE          (1 << 0)
  32 #define RLM_TYPE_CHECK_CONFIG_SAFE      (1 << 1)
  33 #define RLM_TYPE_HUP_SAFE               (1 << 2)
  34
  35 #define RLM_MODULE_MAGIC_NUMBER ((uint32_t) (0xf4ee4ad2))
  36 #define RLM_MODULE_INIT RLM_MODULE_MAGIC_NUMBER
  37
  38 typedef struct module_t {
  39         uint32_t        magic;  /* may later be opaque struct */
  40         const char      *name;
  41         int             type;
  42         int             (*instantiate)(CONF_SECTION *mod_cs, void **instance);
  43         int             (*detach)(void *instance);
  44         packetmethod    methods[RLM_COMPONENT_COUNT];
  45 } module_t;
  46
  47 enum {
  48         RLM_MODULE_REJECT,      /* immediately reject the request */
  49         RLM_MODULE_FAIL,        /* module failed, don't reply */
  50         RLM_MODULE_OK,          /* the module is OK, continue */
  51         RLM_MODULE_HANDLED,     /* the module handled the request, so stop. */
  52         RLM_MODULE_INVALID,     /* the module considers the request invalid. */
  53         RLM_MODULE_USERLOCK,    /* reject the request (user is locked out) */
  54         RLM_MODULE_NOTFOUND,    /* user not found */
  55         RLM_MODULE_NOOP,        /* module succeeded without doing anything */
  56         RLM_MODULE_UPDATED,     /* OK (pairs modified) */
  57         RLM_MODULE_NUMCODES     /* How many return codes there are */
  58 };
  59
  60 int setup_modules(int, CONF_SECTION *);
  61 int detach_modules(void);
  62 int module_hup(CONF_SECTION *modules);
  63 int module_authorize(int type, REQUEST *request);
  64 int module_authenticate(int type, REQUEST *request);
  65 int module_preacct(REQUEST *request);
  66 int module_accounting(int type, REQUEST *request);
  67 int module_checksimul(int type, REQUEST *request, int maxsimul);
  68 int module_pre_proxy(int type, REQUEST *request);
  69 int module_post_proxy(int type, REQUEST *request);
  70 int module_post_auth(int type, REQUEST *request);
  71 int indexed_modcall(int comp, int idx, REQUEST *request);
  72
  73 /*
  74  *      For now, these are strongly tied together.
  75  */
  76 int virtual_servers_load(CONF_SECTION *config);
  77 void virtual_servers_free(time_t when);
  78
  79
  80 #endif /* RADIUS_MODULES_H */