2 * module.h Interface to the RADIUS module system.
8 #ifndef RADIUS_MODULES_H
9 #define RADIUS_MODULES_H
11 #include <freeradius-devel/ident.h>
12 RCSIDH(modules_h, "$Id$")
14 #include <freeradius-devel/conffile.h>
16 typedef int (*packetmethod)(void *instance, REQUEST *request);
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 */
30 #define RLM_TYPE_THREAD_SAFE (0 << 0)
31 #define RLM_TYPE_THREAD_UNSAFE (1 << 0)
33 #define RLM_MODULE_MAGIC_NUMBER ((uint32_t) (0xf4ee4ad2))
34 #define RLM_MODULE_INIT RLM_MODULE_MAGIC_NUMBER
36 typedef struct module_t {
37 uint32_t magic; /* may later be opaque struct */
40 int (*instantiate)(CONF_SECTION *mod_cs, void **instance);
41 int (*detach)(void *instance);
42 packetmethod methods[RLM_COMPONENT_COUNT];
46 RLM_MODULE_REJECT, /* immediately reject the request */
47 RLM_MODULE_FAIL, /* module failed, don't reply */
48 RLM_MODULE_OK, /* the module is OK, continue */
49 RLM_MODULE_HANDLED, /* the module handled the request, so stop. */
50 RLM_MODULE_INVALID, /* the module considers the request invalid. */
51 RLM_MODULE_USERLOCK, /* reject the request (user is locked out) */
52 RLM_MODULE_NOTFOUND, /* user not found */
53 RLM_MODULE_NOOP, /* module succeeded without doing anything */
54 RLM_MODULE_UPDATED, /* OK (pairs modified) */
55 RLM_MODULE_NUMCODES /* How many return codes there are */
58 int setup_modules(int, CONF_SECTION *);
59 int detach_modules(void);
60 int module_authorize(int type, REQUEST *request);
61 int module_authenticate(int type, REQUEST *request);
62 int module_preacct(REQUEST *request);
63 int module_accounting(int type, REQUEST *request);
64 int module_checksimul(int type, REQUEST *request, int maxsimul);
65 int module_pre_proxy(int type, REQUEST *request);
66 int module_post_proxy(int type, REQUEST *request);
67 int module_post_auth(int type, REQUEST *request);
68 int module_vmps(REQUEST *request);
70 #endif /* RADIUS_MODULES_H */