4 * radiusd.h Structures, prototypes and global variables
5 * for the FreeRADIUS server.
11 #include <freeradius-devel/ident.h>
12 RCSIDH(radiusd_h, "$Id$")
14 #include <freeradius-devel/libradius.h>
15 #include <freeradius-devel/radpaths.h>
16 #include <freeradius-devel/conf.h>
17 #include <freeradius-devel/conffile.h>
18 #include <freeradius-devel/event.h>
20 typedef struct auth_req REQUEST;
22 #include <freeradius-devel/realms.h>
26 typedef pthread_t child_pid_t;
27 #define child_kill pthread_kill
29 typedef pid_t child_pid_t;
30 #define child_kill kill
33 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
36 #define REQUEST_MAGIC (0xdeadbeef)
42 typedef struct request_data_t request_data_t;
44 typedef struct rad_snmp_client_entry_t rad_snmp_client_entry_t;
46 typedef struct radclient {
56 int number; /* internal use only */
58 rad_snmp_client_entry_t *auth, *acct;
65 * Ordered by priority!
67 typedef enum RAD_LISTEN_TYPE {
80 * For listening on multiple IP's and ports.
82 typedef struct rad_listen_t rad_listen_t;
84 #define REQUEST_DATA_REGEX (0xadbeef00)
85 #define REQUEST_MAX_REGEX (8)
89 uint32_t magic; /* for debugging only */
91 RADIUS_PACKET *packet;
94 RADIUS_PACKET *proxy_reply;
95 VALUE_PAIR *config_items;
99 struct main_config_t *root;
101 request_data_t *data;
103 child_pid_t child_pid;
105 int number; /* internal server number */
107 rad_listen_t *listener;
108 rad_listen_t *proxy_listener;
112 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
114 int options; /* miscellanous options */
115 const char *module; /* for debugging unresponsive children */
116 const char *component; /* ditto */
118 struct timeval received;
119 struct timeval when; /* to wake up */
124 RAD_LISTEN_TYPE priority;
127 struct timeval next_when;
128 lrad_event_callback_t next_callback;
133 home_server *home_server;
134 home_pool_t *home_pool; /* for dynamic failover */
136 struct timeval proxy_when;
138 int num_proxied_requests;
139 int num_proxied_responses;
143 }; /* REQUEST typedef */
145 #define RAD_REQUEST_OPTION_NONE (0)
147 #define REQUEST_ACTIVE (1)
148 #define REQUEST_STOP_PROCESSING (2)
149 #define REQUEST_COUNTED (3)
151 #define REQUEST_QUEUED (1)
152 #define REQUEST_RUNNING (2)
153 #define REQUEST_PROXIED (3)
154 #define REQUEST_REJECT_DELAY (4)
155 #define REQUEST_CLEANUP_DELAY (5)
156 #define REQUEST_DONE (6)
159 * Function handler for requests.
161 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
163 typedef struct radclient_list RADCLIENT_LIST;
165 typedef struct pair_list {
171 struct pair_list *next;
172 struct pair_list *lastdefault;
176 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
177 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
178 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
179 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
180 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
182 struct rad_listen_t {
183 struct rad_listen_t *next; /* should be rbtree stuff */
186 * For normal sockets.
188 RAD_LISTEN_TYPE type;
192 rad_listen_recv_t recv;
193 rad_listen_send_t send;
194 rad_listen_encode_t encode;
195 rad_listen_decode_t decode;
196 rad_listen_print_t print;
202 typedef enum radlog_dest_t {
211 typedef struct main_config_t {
212 struct main_config *next;
213 time_t config_dead_time;
214 lrad_ipaddr_t myip; /* from the command-line only */
215 int port; /* from the command-line only */
217 int log_auth_badpass;
218 int log_auth_goodpass;
222 int allow_core_dumps;
227 int max_request_time;
230 #ifdef DELETE_BLOCKED_REQUESTS
231 int kill_unresponsive_children;
235 const char *pid_file;
236 const char *uid_name;
237 const char *gid_name;
238 rad_listen_t *listen;
241 radlog_dest_t radlog_dest;
242 CONF_SECTION *config;
243 RADCLIENT_LIST *clients;
244 const char *radiusd_conf;
247 #define DEBUG if(debug_flag)log_debug
248 #define DEBUG2 if (debug_flag > 1)log_debug
249 #define DEBUG3 if (debug_flag > 2)log_debug
251 #define SECONDS_PER_DAY 86400
252 #define MAX_REQUEST_TIME 30
253 #define CLEANUP_DELAY 5
254 #define MAX_REQUESTS 256
255 #define RETRY_DELAY 5
256 #define RETRY_COUNT 3
257 #define DEAD_TIME 120
272 * This definition of true as NOT false is definitive. :) Making
273 * it '1' can cause problems on stupid platforms. See articles
274 * on C portability for more information.
276 #define TRUE (!FALSE)
279 /* for paircompare_register */
280 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
282 typedef enum request_fail_t {
283 REQUEST_FAIL_UNKNOWN = 0,
284 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
285 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
286 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
287 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
288 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
289 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
290 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
291 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
292 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
293 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
299 * We really shouldn't have this many.
301 extern const char *progname;
302 extern int debug_flag;
303 extern const char *radacct_dir;
304 extern const char *radlog_dir;
305 extern const char *radlib_dir;
306 extern const char *radius_dir;
307 extern const char *radius_libdir;
308 extern uint32_t expiration_seconds;
309 extern int log_stripped_names;
310 extern int log_auth_detail;
311 extern const char *radiusd_version;
312 void radius_signal_self(int flag);
314 #define RADIUS_SIGNAL_SELF_NONE (0)
315 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
316 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
317 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
318 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
322 * Function prototypes.
326 int rad_accounting(REQUEST *);
329 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
330 const char *sessionid);
331 int session_zap(REQUEST *request, uint32_t nasaddr,
332 unsigned int port, const char *user,
333 const char *sessionid, uint32_t cliaddr,
334 char proto,int session_time);
338 void debug_pair(FILE *, VALUE_PAIR *);
340 int log_err (char *);
343 void (*reset_signal(int signo, void (*func)(int)))(int);
344 void request_free(REQUEST **request);
345 int rad_mkdir(char *directory, int mode);
346 int rad_checkfilename(const char *filename);
347 void *rad_malloc(size_t size); /* calls exit(1) on error! */
348 REQUEST *request_alloc(void);
349 REQUEST *request_alloc_fake(REQUEST *oldreq);
350 int request_data_add(REQUEST *request,
351 void *unique_ptr, int unique_int,
352 void *opaque, void (*free_opaque)(void *));
353 void *request_data_get(REQUEST *request,
354 void *unique_ptr, int unique_int);
355 void *request_data_reference(REQUEST *request,
356 void *unique_ptr, int unique_int);
357 int rad_copy_string(char *dst, const char *src);
358 int rad_copy_variable(char *dst, const char *from);
360 /* request_process.c */
361 int rad_respond(REQUEST *request, RAD_REQUEST_FUNP fun);
362 void request_reject(REQUEST *request, request_fail_t reason);
365 RADCLIENT_LIST *clients_init(void);
366 void clients_free(RADCLIENT_LIST *clients);
367 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
368 void client_free(RADCLIENT *client);
369 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
370 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
371 const lrad_ipaddr_t *ipaddr);
372 const char *client_name(const RADCLIENT_LIST *clients,
373 const lrad_ipaddr_t *ipaddr);
374 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
376 RADCLIENT *client_find_old(const lrad_ipaddr_t *ipaddr);
377 const char *client_name_old(const lrad_ipaddr_t *ipaddr);
380 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
381 void pairlist_free(PAIR_LIST **);
382 int read_config_files(void);
388 int vradlog(int, const char *, va_list ap);
389 int radlog(int, const char *, ...)
391 __attribute__ ((format (printf, 2, 3)))
394 int log_debug(const char *, ...)
396 __attribute__ ((format (printf, 1, 2)))
399 void vp_listdebug(VALUE_PAIR *vp);
403 int proxy_receive(REQUEST *request);
404 int proxy_send(REQUEST *request);
407 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
408 int rad_authenticate (REQUEST *);
409 int rad_postauth(REQUEST *);
412 int radius_exec_program(const char *, REQUEST *, int,
413 char *user_msg, int msg_len,
414 VALUE_PAIR *input_pairs,
415 VALUE_PAIR **output_pairs,
419 int timestr_match(char *, time_t);
422 int paircompare_register(int attr, int otherattr,
423 RAD_COMPARE_FUNC func,
425 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
426 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
428 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
429 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
430 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
431 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
432 VALUE_PAIR **reply_pairs);
433 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
434 int attribute, int type);
437 typedef int (*RADIUS_ESCAPE_STRING)(char *out, int outlen, const char *in);
439 int radius_xlat(char * out, int outlen, const char *fmt,
440 REQUEST * request, RADIUS_ESCAPE_STRING func);
441 typedef int (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
442 int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance);
443 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
444 void xlat_free(void);
447 extern int thread_pool_init(int spawn_flag);
448 extern int thread_pool_clean(time_t now);
449 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
450 extern pid_t rad_fork(void);
451 extern pid_t rad_waitpid(pid_t pid, int *status);
452 extern int total_active_threads(void);
454 #ifndef HAVE_PTHREAD_H
455 #define rad_fork(n) fork()
456 #define rad_waitpid(a,b) waitpid(a,b, 0)
460 /* Define a global config structure */
461 extern struct main_config_t mainconfig;
463 int read_mainconfig(int reload);
464 int free_mainconfig(void);
467 void listen_free(rad_listen_t **head);
468 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
469 rad_listen_t *proxy_new_listener(void);
472 int radius_event_init(int spawn_flag);
473 void radius_event_free(void);
474 int radius_event_process(struct timeval **pptv);
475 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
476 int received_request(rad_listen_t *listener,
477 RADIUS_PACKET *packet, REQUEST **prequest,
479 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
482 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
483 const char **ptr, int evaluate_it, int *presult);
484 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
485 VALUE_PAIR *input_vps, const char *name);
488 int vmps_process(REQUEST *);