4 * radiusd.h Structures, prototypes and global variables
5 * for the FreeRADIUS server.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 * Copyright 1999,2000,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project
27 #include <freeradius-devel/ident.h>
28 RCSIDH(radiusd_h, "$Id$")
30 #include <freeradius-devel/libradius.h>
31 #include <freeradius-devel/radpaths.h>
32 #include <freeradius-devel/conf.h>
33 #include <freeradius-devel/conffile.h>
34 #include <freeradius-devel/event.h>
36 typedef struct auth_req REQUEST;
40 typedef pthread_t child_pid_t;
41 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
45 #define REQUEST_MAGIC (0xdeadbeef)
49 * New defines for minimizing the size of the server, to strip
50 * out functionality. In order to ensure that people don't have
51 * to re-run "configure", after "cvs update", we play some
52 * special games with the defines. i.e. any top-level "configure"
53 * option should set both WITH_FOO and WITHOUT_FOO. After a few
54 * weeks, the WITHOUT_FOO can be deleted from the configure script.
57 #define WITH_PROXY (1)
60 #ifndef WITHOUT_DETAIL
61 #define WITH_DETAIL (1)
64 #ifndef WITHOUT_SESSION_MGMT
65 #define WITH_SESSION_MGMT (1)
68 #ifndef WITHOUT_UNLANG
69 #define WITH_UNLANG (1)
72 #ifndef WITHOUT_ACCOUNTING
73 #define WITH_ACCOUNTING (1)
75 #ifdef WITH_SESSION_MGMT
76 #error WITH_SESSION_MGMT is defined, but WITH_ACCOUNTING is not. Session management requires accounting.
79 #error WITH_DETAIL is defined, but WITH_ACCOUNTING is not. Detail file reading requires accounting.
83 #ifndef WITHOUT_DYNAMIC_CLIENTS
84 #define WITH_DYNAMIC_CLIENTS (1)
91 #ifndef WITHOUT_COMMAND_SOCKET
93 #define WITH_COMMAND_SOCKET (1)
97 #include <freeradius-devel/stats.h>
98 #include <freeradius-devel/realms.h>
104 typedef struct request_data_t request_data_t;
106 typedef struct radclient {
112 int message_authenticator;
117 int number; /* internal use only */
118 const CONF_SECTION *cs;
121 #ifdef WITH_ACCOUNTING
126 #ifdef WITH_DYNAMIC_CLIENTS
128 int dynamic; /* was dynamically defined */
130 time_t last_new_client;
136 * Types of listeners.
138 * Ordered by priority!
140 typedef enum RAD_LISTEN_TYPE {
153 * For listening on multiple IP's and ports.
155 typedef struct rad_listen_t rad_listen_t;
156 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
158 #define REQUEST_DATA_REGEX (0xadbeef00)
159 #define REQUEST_MAX_REGEX (8)
163 uint32_t magic; /* for debugging only */
165 RADIUS_PACKET *packet;
167 RADIUS_PACKET *proxy;
169 RADIUS_PACKET *reply;
171 RADIUS_PACKET *proxy_reply;
173 VALUE_PAIR *config_items;
174 VALUE_PAIR *username;
175 VALUE_PAIR *password;
177 struct main_config_t *root;
179 request_data_t *data;
181 #ifdef HAVE_PTHREAD_H
182 child_pid_t child_pid;
185 int number; /* internal server number */
187 rad_listen_t *listener;
189 rad_listen_t *proxy_listener;
193 int simul_max; /* see modcall.c && xlat.c */
194 #ifdef WITH_SESSION_MGMT
196 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
199 int options; /* miscellanous options */
200 const char *module; /* for debugging unresponsive children */
201 const char *component; /* ditto */
203 struct timeval received;
204 struct timeval when; /* to wake up */
209 RAD_LISTEN_TYPE priority;
212 struct timeval next_when;
213 fr_event_callback_t next_callback;
219 home_server *home_server;
220 home_pool_t *home_pool; /* for dynamic failover */
222 struct timeval proxy_when;
224 int num_proxied_requests;
225 int num_proxied_responses;
230 radlog_func_t radlog; /* logging function, if set */
231 }; /* REQUEST typedef */
233 #define RAD_REQUEST_OPTION_NONE (0)
234 #define RAD_REQUEST_OPTION_DEBUG (1)
235 #define RAD_REQUEST_OPTION_DEBUG2 (2)
236 #define RAD_REQUEST_OPTION_DEBUG3 (3)
237 #define RAD_REQUEST_OPTION_DEBUG4 (4)
239 #define REQUEST_ACTIVE (1)
240 #define REQUEST_STOP_PROCESSING (2)
241 #define REQUEST_COUNTED (3)
243 #define REQUEST_QUEUED (1)
244 #define REQUEST_RUNNING (2)
245 #define REQUEST_PROXIED (3)
246 #define REQUEST_REJECT_DELAY (4)
247 #define REQUEST_CLEANUP_DELAY (5)
248 #define REQUEST_DONE (6)
251 * Function handler for requests.
253 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
255 typedef struct radclient_list RADCLIENT_LIST;
257 typedef struct pair_list {
263 struct pair_list *next;
264 struct pair_list *lastdefault;
268 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
269 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
270 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
271 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
272 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
274 struct rad_listen_t {
275 struct rad_listen_t *next; /* should be rbtree stuff */
278 * For normal sockets.
280 RAD_LISTEN_TYPE type;
285 rad_listen_recv_t recv;
286 rad_listen_send_t send;
287 rad_listen_encode_t encode;
288 rad_listen_decode_t decode;
289 rad_listen_print_t print;
298 #define RAD_LISTEN_STATUS_INIT (0)
299 #define RAD_LISTEN_STATUS_KNOWN (1)
300 #define RAD_LISTEN_STATUS_CLOSED (2)
301 #define RAD_LISTEN_STATUS_FINISH (3)
303 typedef enum radlog_dest_t {
312 typedef struct main_config_t {
313 struct main_config *next;
315 fr_ipaddr_t myip; /* from the command-line only */
316 int port; /* from the command-line only */
318 int log_auth_badpass;
319 int log_auth_goodpass;
320 int allow_core_dumps;
325 int max_request_time;
328 #ifdef DELETE_BLOCKED_REQUESTS
329 int kill_unresponsive_children;
333 const char *pid_file;
334 rad_listen_t *listen;
337 radlog_dest_t radlog_dest;
338 CONF_SECTION *config;
342 #define DEBUG if(debug_flag)log_debug
343 #define DEBUG2 if (debug_flag > 1)log_debug
344 #define DEBUG3 if (debug_flag > 2)log_debug
347 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
348 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
349 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
350 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
353 #define RDEBUG2 DEBUG2
354 #define RDEBUG3 DEBUG3
355 #define RDEBUG4 DEBUG4
358 #define SECONDS_PER_DAY 86400
359 #define MAX_REQUEST_TIME 30
360 #define CLEANUP_DELAY 5
361 #define MAX_REQUESTS 256
362 #define RETRY_DELAY 5
363 #define RETRY_COUNT 3
364 #define DEAD_TIME 120
379 * This definition of true as NOT false is definitive. :) Making
380 * it '1' can cause problems on stupid platforms. See articles
381 * on C portability for more information.
383 #define TRUE (!FALSE)
386 /* for paircompare_register */
387 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
389 typedef enum request_fail_t {
390 REQUEST_FAIL_UNKNOWN = 0,
391 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
392 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
393 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
394 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
395 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
396 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
397 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
398 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
399 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
400 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
406 * We really shouldn't have this many.
408 extern const char *progname;
409 extern int debug_flag;
410 extern const char *radacct_dir;
411 extern const char *radlog_dir;
412 extern const char *radlib_dir;
413 extern const char *radius_dir;
414 extern const char *radius_libdir;
415 extern uint32_t expiration_seconds;
416 extern int log_stripped_names;
417 extern int log_auth_detail;
418 extern const char *radiusd_version;
419 void radius_signal_self(int flag);
421 #define RADIUS_SIGNAL_SELF_NONE (0)
422 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
423 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
424 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
425 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
426 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
427 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
431 * Function prototypes.
435 int rad_accounting(REQUEST *);
438 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
439 const char *sessionid);
440 int session_zap(REQUEST *request, uint32_t nasaddr,
441 unsigned int port, const char *user,
442 const char *sessionid, uint32_t cliaddr,
443 char proto,int session_time);
447 void debug_pair(VALUE_PAIR *);
448 void debug_pair_list(VALUE_PAIR *);
449 int log_err (char *);
452 void (*reset_signal(int signo, void (*func)(int)))(int);
453 void request_free(REQUEST **request);
454 int rad_mkdir(char *directory, int mode);
455 int rad_checkfilename(const char *filename);
456 void *rad_malloc(size_t size); /* calls exit(1) on error! */
457 REQUEST *request_alloc(void);
458 REQUEST *request_alloc_fake(REQUEST *oldreq);
459 int request_data_add(REQUEST *request,
460 void *unique_ptr, int unique_int,
461 void *opaque, void (*free_opaque)(void *));
462 void *request_data_get(REQUEST *request,
463 void *unique_ptr, int unique_int);
464 void *request_data_reference(REQUEST *request,
465 void *unique_ptr, int unique_int);
466 int rad_copy_string(char *dst, const char *src);
467 int rad_copy_variable(char *dst, const char *from);
470 RADCLIENT_LIST *clients_init(void);
471 void clients_free(RADCLIENT_LIST *clients);
472 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
473 void client_free(RADCLIENT *client);
474 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
475 #ifdef WITH_DYNAMIC_CLIENTS
476 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
477 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
479 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
480 const fr_ipaddr_t *ipaddr);
481 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
483 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
484 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
486 RADCLIENT *client_read(const char *filename, int in_server);
490 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
491 void pairlist_free(PAIR_LIST **);
497 int vradlog(int, const char *, va_list ap);
498 int radlog(int, const char *, ...)
500 __attribute__ ((format (printf, 2, 3)))
503 int log_debug(const char *, ...)
505 __attribute__ ((format (printf, 1, 2)))
508 void vp_listdebug(VALUE_PAIR *vp);
509 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
511 __attribute__ ((format (printf, 4, 5)))
516 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
517 int rad_authenticate (REQUEST *);
518 int rad_postauth(REQUEST *);
521 int radius_exec_program(const char *, REQUEST *, int,
522 char *user_msg, int msg_len,
523 VALUE_PAIR *input_pairs,
524 VALUE_PAIR **output_pairs,
528 int timestr_match(char *, time_t);
531 int paircompare_register(int attr, int otherattr,
532 RAD_COMPARE_FUNC func,
534 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
535 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
537 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
538 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
539 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
540 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
541 VALUE_PAIR **reply_pairs);
542 int radius_find_compare(int attribute);
543 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
544 int attribute, int type);
545 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
546 const char *attribute, const char *value,
550 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
552 int radius_xlat(char * out, int outlen, const char *fmt,
553 REQUEST * request, RADIUS_ESCAPE_STRING func);
554 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
555 int xlat_register(const char *module, RAD_XLAT_FUNC func,
557 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
558 void xlat_free(void);
561 extern int thread_pool_init(CONF_SECTION *cs, int spawn_flag);
562 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
563 extern pid_t rad_fork(void);
564 extern pid_t rad_waitpid(pid_t pid, int *status);
565 extern int total_active_threads(void);
566 extern void thread_pool_lock(void);
567 extern void thread_pool_unlock(void);
568 extern void thread_pool_queue_stats(int *array);
570 #ifndef HAVE_PTHREAD_H
571 #define rad_fork(n) fork()
572 #define rad_waitpid(a,b) waitpid(a,b, 0)
576 /* Define a global config structure */
577 extern struct main_config_t mainconfig;
579 int read_mainconfig(int reload);
580 int free_mainconfig(void);
583 void listen_free(rad_listen_t **head);
584 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
585 rad_listen_t *proxy_new_listener(void);
586 RADCLIENT *client_listener_find(const rad_listen_t *listener,
587 const fr_ipaddr_t *ipaddr);
589 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
591 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
595 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
596 void radius_event_free(void);
597 int radius_event_process(void);
598 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
599 int received_request(rad_listen_t *listener,
600 RADIUS_PACKET *packet, REQUEST **prequest,
602 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
603 void event_new_fd(rad_listen_t *listener);
606 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
607 const char **ptr, int evaluate_it, int *presult);
608 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
609 VALUE_PAIR *input_vps, const char *name);
610 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);