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;
43 #define REQUEST_MAGIC (0xdeadbeef)
47 * New defines for minimizing the size of the server, to strip
48 * out functionality. In order to ensure that people don't have
49 * to re-run "configure", after "cvs update", we play some
50 * special games with the defines. i.e. any top-level "configure"
51 * option should set both WITH_FOO and WITHOUT_FOO. After a few
52 * weeks, the WITHOUT_FOO can be deleted from the configure script.
55 #define WITH_PROXY (1)
58 #ifndef WITHOUT_DETAIL
59 #define WITH_DETAIL (1)
62 #ifndef WITHOUT_SESSION_MGMT
63 #define WITH_SESSION_MGMT (1)
66 #ifndef WITHOUT_UNLANG
67 #define WITH_UNLANG (1)
70 #ifndef WITHOUT_ACCOUNTING
71 #define WITH_ACCOUNTING (1)
73 #ifdef WITH_SESSION_MGMT
74 #error WITH_SESSION_MGMT is defined, but WITH_ACCOUNTING is not. Session management requires accounting.
77 #error WITH_DETAIL is defined, but WITH_ACCOUNTING is not. Detail file reading requires accounting.
81 #ifndef WITHOUT_DYNAMIC_CLIENTS
82 #define WITH_DYNAMIC_CLIENTS (1)
89 #ifndef WITHOUT_COMMAND_SOCKET
91 #define WITH_COMMAND_SOCKET (1)
93 #define WITHOUT_COMMAND_SOCKET (1)
100 #error WITH_COA requires WITH_PROXY
104 #include <freeradius-devel/stats.h>
105 #include <freeradius-devel/realms.h>
111 typedef struct request_data_t request_data_t;
113 typedef struct radclient {
119 int message_authenticator;
124 int number; /* internal use only */
125 const CONF_SECTION *cs;
128 #ifdef WITH_ACCOUNTING
139 #ifdef WITH_DYNAMIC_CLIENTS
141 int dynamic; /* was dynamically defined */
143 time_t last_new_client;
150 home_server *coa_server;
151 home_pool_t *coa_pool;
156 * Types of listeners.
158 * Ordered by priority!
160 typedef enum RAD_LISTEN_TYPE {
166 #ifdef WITH_ACCOUNTING
178 #ifdef WITH_COMMAND_SOCKET
189 * For listening on multiple IP's and ports.
191 typedef struct rad_listen_t rad_listen_t;
192 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
194 #define REQUEST_DATA_REGEX (0xadbeef00)
195 #define REQUEST_MAX_REGEX (8)
199 uint32_t magic; /* for debugging only */
201 RADIUS_PACKET *packet;
203 RADIUS_PACKET *proxy;
205 RADIUS_PACKET *reply;
207 RADIUS_PACKET *proxy_reply;
209 VALUE_PAIR *config_items;
210 VALUE_PAIR *username;
211 VALUE_PAIR *password;
213 struct main_config_t *root;
215 request_data_t *data;
217 #ifdef HAVE_PTHREAD_H
221 unsigned int number; /* internal server number */
223 rad_listen_t *listener;
225 rad_listen_t *proxy_listener;
229 int simul_max; /* see modcall.c && xlat.c */
230 #ifdef WITH_SESSION_MGMT
232 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
235 int options; /* miscellanous options */
236 const char *module; /* for debugging unresponsive children */
237 const char *component; /* ditto */
239 struct timeval received;
240 struct timeval when; /* to wake up */
245 RAD_LISTEN_TYPE priority;
248 struct timeval next_when;
249 fr_event_callback_t next_callback;
255 home_server *home_server;
256 home_pool_t *home_pool; /* for dynamic failover */
258 struct timeval proxy_when;
260 int num_proxied_requests;
261 int num_proxied_responses;
266 radlog_func_t radlog; /* logging function, if set */
269 int num_coa_requests;
271 }; /* REQUEST typedef */
273 #define RAD_REQUEST_OPTION_NONE (0)
274 #define RAD_REQUEST_OPTION_DEBUG (1)
275 #define RAD_REQUEST_OPTION_DEBUG2 (2)
276 #define RAD_REQUEST_OPTION_DEBUG3 (3)
277 #define RAD_REQUEST_OPTION_DEBUG4 (4)
279 #define REQUEST_ACTIVE (1)
280 #define REQUEST_STOP_PROCESSING (2)
281 #define REQUEST_COUNTED (3)
283 #define REQUEST_QUEUED (1)
284 #define REQUEST_RUNNING (2)
285 #define REQUEST_PROXIED (3)
286 #define REQUEST_REJECT_DELAY (4)
287 #define REQUEST_CLEANUP_DELAY (5)
288 #define REQUEST_DONE (6)
291 * Function handler for requests.
293 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
295 typedef struct radclient_list RADCLIENT_LIST;
297 typedef struct pair_list {
303 struct pair_list *next;
304 struct pair_list *lastdefault;
308 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
309 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
310 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
311 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
312 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
314 struct rad_listen_t {
315 struct rad_listen_t *next; /* should be rbtree stuff */
318 * For normal sockets.
320 RAD_LISTEN_TYPE type;
328 rad_listen_recv_t recv;
329 rad_listen_send_t send;
330 rad_listen_encode_t encode;
331 rad_listen_decode_t decode;
332 rad_listen_print_t print;
342 * This shouldn't really be exposed...
344 typedef struct listen_socket_t {
346 * For normal sockets.
348 fr_ipaddr_t my_ipaddr;
351 const char *interface;
356 /* for outgoing sockets */
358 fr_ipaddr_t other_ipaddr;
364 /* for a proxy connecting to home servers */
369 /* for clients connecting to the server */
372 struct listen_socket_t *parent;
375 RADIUS_PACKET *packet; /* for reading partial packets */
377 RADCLIENT_LIST *clients;
380 #define RAD_LISTEN_STATUS_INIT (0)
381 #define RAD_LISTEN_STATUS_KNOWN (1)
382 #define RAD_LISTEN_STATUS_REMOVE_FD (2)
383 #define RAD_LISTEN_STATUS_CLOSED (3)
384 #define RAD_LISTEN_STATUS_FINISH (4)
386 typedef enum radlog_dest_t {
395 typedef struct main_config_t {
396 struct main_config *next;
398 fr_ipaddr_t myip; /* from the command-line only */
399 int port; /* from the command-line only */
401 int log_auth_badpass;
402 int log_auth_goodpass;
403 int allow_core_dumps;
408 int max_request_time;
411 #ifdef DELETE_BLOCKED_REQUESTS
412 int kill_unresponsive_children;
416 const char *pid_file;
417 rad_listen_t *listen;
420 radlog_dest_t radlog_dest;
421 CONF_SECTION *config;
423 const char *auth_badpass_msg;
424 const char *auth_goodpass_msg;
427 #define DEBUG if(debug_flag)log_debug
428 #define DEBUG2 if (debug_flag > 1)log_debug
429 #define DEBUG3 if (debug_flag > 2)log_debug
430 #define DEBUG4 if (debug_flag > 3)log_debug
433 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
434 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
435 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
436 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
439 #define RDEBUG2 DEBUG2
440 #define RDEBUG3 DEBUG3
441 #define RDEBUG4 DEBUG4
444 #define SECONDS_PER_DAY 86400
445 #define MAX_REQUEST_TIME 30
446 #define CLEANUP_DELAY 5
447 #define MAX_REQUESTS 256
448 #define RETRY_DELAY 5
449 #define RETRY_COUNT 3
450 #define DEAD_TIME 120
465 * This definition of true as NOT false is definitive. :) Making
466 * it '1' can cause problems on stupid platforms. See articles
467 * on C portability for more information.
469 #define TRUE (!FALSE)
472 /* for paircompare_register */
473 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
475 typedef enum request_fail_t {
476 REQUEST_FAIL_UNKNOWN = 0,
477 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
478 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
479 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
480 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
481 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
482 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
483 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
484 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
485 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
486 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
492 * We really shouldn't have this many.
494 extern const char *progname;
495 extern int debug_flag;
496 extern const char *radacct_dir;
497 extern const char *radlog_dir;
498 extern const char *radlib_dir;
499 extern const char *radius_dir;
500 extern const char *radius_libdir;
501 extern uint32_t expiration_seconds;
502 extern int log_stripped_names;
503 extern int log_auth_detail;
504 extern const char *radiusd_version;
505 void radius_signal_self(int flag);
507 #define RADIUS_SIGNAL_SELF_NONE (0)
508 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
509 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
510 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
511 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
512 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
513 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
517 * Function prototypes.
521 int rad_accounting(REQUEST *);
524 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
525 const char *sessionid);
526 int session_zap(REQUEST *request, uint32_t nasaddr,
527 unsigned int port, const char *user,
528 const char *sessionid, uint32_t cliaddr,
529 char proto,int session_time);
533 void debug_pair(VALUE_PAIR *);
534 void debug_pair_list(VALUE_PAIR *);
535 int log_err (char *);
538 void (*reset_signal(int signo, void (*func)(int)))(int);
539 void request_free(REQUEST **request);
540 int rad_mkdir(char *directory, int mode);
541 int rad_checkfilename(const char *filename);
542 void *rad_malloc(size_t size); /* calls exit(1) on error! */
543 REQUEST *request_alloc(void);
544 REQUEST *request_alloc_fake(REQUEST *oldreq);
545 REQUEST *request_alloc_coa(REQUEST *request);
546 int request_data_add(REQUEST *request,
547 void *unique_ptr, int unique_int,
548 void *opaque, void (*free_opaque)(void *));
549 void *request_data_get(REQUEST *request,
550 void *unique_ptr, int unique_int);
551 void *request_data_reference(REQUEST *request,
552 void *unique_ptr, int unique_int);
553 int rad_copy_string(char *dst, const char *src);
554 int rad_copy_variable(char *dst, const char *from);
557 RADCLIENT_LIST *clients_init(void);
558 void clients_free(RADCLIENT_LIST *clients);
559 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
560 void client_free(RADCLIENT *client);
561 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
562 #ifdef WITH_DYNAMIC_CLIENTS
563 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
564 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
566 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
567 const fr_ipaddr_t *ipaddr, int proto);
569 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
571 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
572 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
574 RADCLIENT *client_read(const char *filename, int in_server, int flag);
578 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
579 void pairlist_free(PAIR_LIST **);
585 int vradlog(int, const char *, va_list ap);
586 int radlog(int, const char *, ...)
588 __attribute__ ((format (printf, 2, 3)))
591 int log_debug(const char *, ...)
593 __attribute__ ((format (printf, 1, 2)))
596 void vp_listdebug(VALUE_PAIR *vp);
597 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
599 __attribute__ ((format (printf, 4, 5)))
604 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
605 int rad_authenticate (REQUEST *);
606 int rad_postauth(REQUEST *);
609 int radius_exec_program(const char *, REQUEST *, int,
610 char *user_msg, int msg_len,
611 VALUE_PAIR *input_pairs,
612 VALUE_PAIR **output_pairs,
616 int timestr_match(char *, time_t);
619 int paircompare_register(int attr, int otherattr,
620 RAD_COMPARE_FUNC func,
622 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
623 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
625 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
626 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
627 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
628 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
629 VALUE_PAIR **reply_pairs);
630 int radius_find_compare(int attribute);
631 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
632 int attribute, int vendor, int type);
633 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
634 const char *attribute, const char *value,
638 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
640 int radius_xlat(char * out, int outlen, const char *fmt,
641 REQUEST * request, RADIUS_ESCAPE_STRING func);
642 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
643 int xlat_register(const char *module, RAD_XLAT_FUNC func,
645 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
646 void xlat_free(void);
649 extern int thread_pool_init(CONF_SECTION *cs, int *spawn_flag);
650 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
651 extern pid_t rad_fork(void);
652 extern pid_t rad_waitpid(pid_t pid, int *status);
653 extern int total_active_threads(void);
654 extern void thread_pool_lock(void);
655 extern void thread_pool_unlock(void);
656 extern void thread_pool_queue_stats(int *array);
658 #ifndef HAVE_PTHREAD_H
659 #define rad_fork(n) fork()
660 #define rad_waitpid(a,b) waitpid(a,b, 0)
664 /* Define a global config structure */
665 extern struct main_config_t mainconfig;
667 int read_mainconfig(int reload);
668 int free_mainconfig(void);
669 void hup_mainconfig(void);
670 void fr_suid_down(void);
671 void fr_suid_up(void);
672 void fr_suid_down_permanent(void);
675 void listen_free(rad_listen_t **head);
676 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
677 int proxy_new_listener(home_server *home, int src_port);
678 RADCLIENT *client_listener_find(const rad_listen_t *listener,
679 const fr_ipaddr_t *ipaddr, int src_port);
682 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
684 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
688 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
689 void radius_event_free(void);
690 int radius_event_process(void);
691 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
692 int received_request(rad_listen_t *listener,
693 RADIUS_PACKET *packet, REQUEST **prequest,
695 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
696 int event_new_fd(rad_listen_t *listener);
699 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
700 const char **ptr, int evaluate_it, int *presult);
701 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
702 VALUE_PAIR *input_vps, const char *name);
703 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);