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;
101 child_pid_t child_pid;
103 int number; /* internal server number */
105 rad_listen_t *listener;
106 rad_listen_t *proxy_listener;
110 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
112 int options; /* miscellanous options */
113 const char *module; /* for debugging unresponsive children */
114 const char *component; /* ditto */
116 struct timeval received;
117 struct timeval when; /* to wake up */
122 RAD_LISTEN_TYPE priority;
125 struct timeval next_when;
126 lrad_event_callback_t next_callback;
131 home_server *home_server;
132 home_pool_t *home_pool; /* for dynamic failover */
134 struct timeval proxy_when;
136 int num_proxied_requests;
137 int num_proxied_responses;
141 }; /* REQUEST typedef */
143 #define RAD_REQUEST_OPTION_NONE (0)
145 #define REQUEST_ACTIVE (1)
146 #define REQUEST_STOP_PROCESSING (2)
147 #define REQUEST_COUNTED (3)
149 #define REQUEST_QUEUED (1)
150 #define REQUEST_RUNNING (2)
151 #define REQUEST_PROXIED (3)
152 #define REQUEST_REJECT_DELAY (4)
153 #define REQUEST_CLEANUP_DELAY (5)
154 #define REQUEST_DONE (6)
157 * Function handler for requests.
159 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
161 typedef struct radclient_list RADCLIENT_LIST;
163 typedef struct pair_list {
169 struct pair_list *next;
170 struct pair_list *lastdefault;
174 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
175 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
176 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
177 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
178 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
180 struct rad_listen_t {
181 struct rad_listen_t *next; /* should be rbtree stuff */
184 * For normal sockets.
186 RAD_LISTEN_TYPE type;
190 rad_listen_recv_t recv;
191 rad_listen_send_t send;
192 rad_listen_encode_t encode;
193 rad_listen_decode_t decode;
194 rad_listen_print_t print;
200 typedef enum radlog_dest_t {
209 typedef struct main_config_t {
210 struct main_config *next;
211 time_t config_dead_time;
212 lrad_ipaddr_t myip; /* from the command-line only */
213 int port; /* from the command-line only */
215 int log_auth_badpass;
216 int log_auth_goodpass;
220 int allow_core_dumps;
223 int wake_all_if_all_dead;
224 int proxy_synchronous;
226 int proxy_retry_count;
227 int proxy_retry_delay;
229 const char *proxy_fail_type;
232 int max_request_time;
235 #ifdef DELETE_BLOCKED_REQUESTS
236 int kill_unresponsive_children;
240 const char *pid_file;
241 const char *uid_name;
242 const char *gid_name;
243 rad_listen_t *listen;
246 radlog_dest_t radlog_dest;
247 CONF_SECTION *config;
248 RADCLIENT_LIST *clients;
249 const char *radiusd_conf;
252 #define DEBUG if(debug_flag)log_debug
253 #define DEBUG2 if (debug_flag > 1)log_debug
254 #define DEBUG3 if (debug_flag > 2)log_debug
256 #define SECONDS_PER_DAY 86400
257 #define MAX_REQUEST_TIME 30
258 #define CLEANUP_DELAY 5
259 #define MAX_REQUESTS 256
260 #define RETRY_DELAY 5
261 #define RETRY_COUNT 3
262 #define DEAD_TIME 120
277 * This definition of true as NOT false is definitive. :) Making
278 * it '1' can cause problems on stupid platforms. See articles
279 * on C portability for more information.
281 #define TRUE (!FALSE)
284 /* for paircompare_register */
285 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
287 typedef enum request_fail_t {
288 REQUEST_FAIL_UNKNOWN = 0,
289 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
290 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
291 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
292 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
293 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
294 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
295 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
296 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
297 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
298 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
304 * We really shouldn't have this many.
306 extern const char *progname;
307 extern int debug_flag;
308 extern const char *radacct_dir;
309 extern const char *radlog_dir;
310 extern const char *radlib_dir;
311 extern const char *radius_dir;
312 extern const char *radius_libdir;
313 extern uint32_t expiration_seconds;
314 extern int log_stripped_names;
315 extern int log_auth_detail;
316 extern const char *radiusd_version;
317 void radius_signal_self(int flag);
319 #define RADIUS_SIGNAL_SELF_NONE (0)
320 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
321 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
322 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
323 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
327 * Function prototypes.
331 int rad_accounting(REQUEST *);
334 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
335 const char *sessionid);
336 int session_zap(REQUEST *request, uint32_t nasaddr,
337 unsigned int port, const char *user,
338 const char *sessionid, uint32_t cliaddr,
339 char proto,int session_time);
343 void debug_pair(FILE *, VALUE_PAIR *);
345 int log_err (char *);
348 void (*reset_signal(int signo, void (*func)(int)))(int);
349 void request_free(REQUEST **request);
350 int rad_mkdir(char *directory, int mode);
351 int rad_checkfilename(const char *filename);
352 void *rad_malloc(size_t size); /* calls exit(1) on error! */
353 REQUEST *request_alloc(void);
354 REQUEST *request_alloc_fake(REQUEST *oldreq);
355 int request_data_add(REQUEST *request,
356 void *unique_ptr, int unique_int,
357 void *opaque, void (*free_opaque)(void *));
358 void *request_data_get(REQUEST *request,
359 void *unique_ptr, int unique_int);
360 void *request_data_reference(REQUEST *request,
361 void *unique_ptr, int unique_int);
362 int rad_copy_string(char *dst, const char *src);
363 int rad_copy_variable(char *dst, const char *from);
365 /* request_process.c */
366 int rad_respond(REQUEST *request, RAD_REQUEST_FUNP fun);
367 void request_reject(REQUEST *request, request_fail_t reason);
370 RADCLIENT_LIST *clients_init(void);
371 void clients_free(RADCLIENT_LIST *clients);
372 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
373 void client_free(RADCLIENT *client);
374 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
375 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
376 const lrad_ipaddr_t *ipaddr);
377 const char *client_name(const RADCLIENT_LIST *clients,
378 const lrad_ipaddr_t *ipaddr);
379 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
381 RADCLIENT *client_find_old(const lrad_ipaddr_t *ipaddr);
382 const char *client_name_old(const lrad_ipaddr_t *ipaddr);
385 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
386 void pairlist_free(PAIR_LIST **);
387 int read_config_files(void);
393 int vradlog(int, const char *, va_list ap);
394 int radlog(int, const char *, ...)
396 __attribute__ ((format (printf, 2, 3)))
399 int log_debug(const char *, ...)
401 __attribute__ ((format (printf, 1, 2)))
404 void vp_listdebug(VALUE_PAIR *vp);
408 int proxy_receive(REQUEST *request);
409 int proxy_send(REQUEST *request);
412 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
413 int rad_authenticate (REQUEST *);
414 int rad_postauth(REQUEST *);
417 int radius_exec_program(const char *, REQUEST *, int,
418 char *user_msg, int msg_len,
419 VALUE_PAIR *input_pairs,
420 VALUE_PAIR **output_pairs,
424 int timestr_match(char *, time_t);
427 int paircompare_register(int attr, int otherattr,
428 RAD_COMPARE_FUNC func,
430 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
431 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
433 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
434 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
435 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
436 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
437 VALUE_PAIR **reply_pairs);
438 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
439 int attribute, int type);
442 typedef int (*RADIUS_ESCAPE_STRING)(char *out, int outlen, const char *in);
444 int radius_xlat(char * out, int outlen, const char *fmt,
445 REQUEST * request, RADIUS_ESCAPE_STRING func);
446 typedef int (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
447 int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance);
448 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
449 void xlat_free(void);
452 extern int thread_pool_init(int spawn_flag);
453 extern int thread_pool_clean(time_t now);
454 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
455 extern pid_t rad_fork(void);
456 extern pid_t rad_waitpid(pid_t pid, int *status);
457 extern int total_active_threads(void);
459 #ifndef HAVE_PTHREAD_H
460 #define rad_fork(n) fork()
461 #define rad_waitpid(a,b) waitpid(a,b, 0)
465 /* Define a global config structure */
466 extern struct main_config_t mainconfig;
468 int read_mainconfig(int reload);
469 int free_mainconfig(void);
472 void listen_free(rad_listen_t **head);
473 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
474 rad_listen_t *proxy_new_listener(void);
477 int radius_event_init(int spawn_flag);
478 void radius_event_free(void);
479 int radius_event_process(struct timeval **pptv);
480 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
481 int received_request(rad_listen_t *listener,
482 RADIUS_PACKET *packet, REQUEST **prequest,
484 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
487 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
488 const char **ptr, int evaluate_it, int *presult);
489 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
490 VALUE_PAIR *input_vps, const char *name);
493 int vmps_process(REQUEST *);