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>
114 typedef struct request_data_t request_data_t;
116 typedef struct radclient {
122 int message_authenticator;
127 int number; /* internal use only */
128 const CONF_SECTION *cs;
131 #ifdef WITH_ACCOUNTING
142 #ifdef WITH_DYNAMIC_CLIENTS
144 int dynamic; /* was dynamically defined */
146 time_t last_new_client;
153 home_server *coa_server;
154 home_pool_t *coa_pool;
159 * Types of listeners.
161 * Ordered by priority!
163 typedef enum RAD_LISTEN_TYPE {
169 #ifdef WITH_ACCOUNTING
181 #ifdef WITH_COMMAND_SOCKET
192 * For listening on multiple IP's and ports.
194 typedef struct rad_listen_t rad_listen_t;
195 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
197 #define REQUEST_DATA_REGEX (0xadbeef00)
198 #define REQUEST_MAX_REGEX (8)
202 uint32_t magic; /* for debugging only */
204 RADIUS_PACKET *packet;
206 RADIUS_PACKET *proxy;
208 RADIUS_PACKET *reply;
210 RADIUS_PACKET *proxy_reply;
212 VALUE_PAIR *config_items;
213 VALUE_PAIR *username;
214 VALUE_PAIR *password;
216 struct main_config_t *root;
218 request_data_t *data;
220 #ifdef HAVE_PTHREAD_H
224 unsigned int number; /* internal server number */
226 rad_listen_t *listener;
228 rad_listen_t *proxy_listener;
232 int simul_max; /* see modcall.c && xlat.c */
233 #ifdef WITH_SESSION_MGMT
235 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
238 int options; /* miscellanous options */
239 const char *module; /* for debugging unresponsive children */
240 const char *component; /* ditto */
242 struct timeval received;
243 struct timeval when; /* to wake up */
248 RAD_LISTEN_TYPE priority;
251 struct timeval next_when;
252 fr_event_callback_t next_callback;
258 home_server *home_server;
259 home_pool_t *home_pool; /* for dynamic failover */
261 struct timeval proxy_when;
263 int num_proxied_requests;
264 int num_proxied_responses;
269 radlog_func_t radlog; /* logging function, if set */
272 int num_coa_requests;
274 }; /* REQUEST typedef */
276 #define RAD_REQUEST_OPTION_NONE (0)
277 #define RAD_REQUEST_OPTION_DEBUG (1)
278 #define RAD_REQUEST_OPTION_DEBUG2 (2)
279 #define RAD_REQUEST_OPTION_DEBUG3 (3)
280 #define RAD_REQUEST_OPTION_DEBUG4 (4)
282 #define REQUEST_ACTIVE (1)
283 #define REQUEST_STOP_PROCESSING (2)
284 #define REQUEST_COUNTED (3)
286 #define REQUEST_QUEUED (1)
287 #define REQUEST_RUNNING (2)
288 #define REQUEST_PROXIED (3)
289 #define REQUEST_REJECT_DELAY (4)
290 #define REQUEST_CLEANUP_DELAY (5)
291 #define REQUEST_DONE (6)
294 * Function handler for requests.
296 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
298 typedef struct radclient_list RADCLIENT_LIST;
300 typedef struct pair_list {
306 struct pair_list *next;
307 struct pair_list *lastdefault;
311 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
312 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
313 typedef int (*rad_listen_print_t)(const rad_listen_t *, char *, size_t);
314 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
315 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
317 struct rad_listen_t {
318 struct rad_listen_t *next; /* should be rbtree stuff */
321 * For normal sockets.
323 RAD_LISTEN_TYPE type;
331 rad_listen_recv_t recv;
332 rad_listen_send_t send;
333 rad_listen_encode_t encode;
334 rad_listen_decode_t decode;
335 rad_listen_print_t print;
345 * This shouldn't really be exposed...
347 typedef struct listen_socket_t {
349 * For normal sockets.
351 fr_ipaddr_t my_ipaddr;
354 const char *interface;
359 /* for outgoing sockets */
361 fr_ipaddr_t other_ipaddr;
367 /* for a proxy connecting to home servers */
372 /* for clients connecting to the server */
375 struct listen_socket_t *parent;
378 RADIUS_PACKET *packet; /* for reading partial packets */
380 RADCLIENT_LIST *clients;
383 #define RAD_LISTEN_STATUS_INIT (0)
384 #define RAD_LISTEN_STATUS_KNOWN (1)
385 #define RAD_LISTEN_STATUS_REMOVE_FD (2)
386 #define RAD_LISTEN_STATUS_CLOSED (3)
387 #define RAD_LISTEN_STATUS_FINISH (4)
389 typedef enum radlog_dest_t {
398 typedef struct main_config_t {
399 struct main_config *next;
401 fr_ipaddr_t myip; /* from the command-line only */
402 int port; /* from the command-line only */
404 int log_auth_badpass;
405 int log_auth_goodpass;
406 int allow_core_dumps;
413 int max_request_time;
416 #ifdef DELETE_BLOCKED_REQUESTS
417 int kill_unresponsive_children;
421 const char *pid_file;
422 rad_listen_t *listen;
425 radlog_dest_t radlog_dest;
426 CONF_SECTION *config;
428 const char *auth_badpass_msg;
429 const char *auth_goodpass_msg;
432 #define DEBUG if(debug_flag)log_debug
433 #define DEBUG2 if (debug_flag > 1)log_debug
434 #define DEBUG3 if (debug_flag > 2)log_debug
435 #define DEBUG4 if (debug_flag > 3)log_debug
438 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
439 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
440 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
441 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
444 #define RDEBUG2 DEBUG2
445 #define RDEBUG3 DEBUG3
446 #define RDEBUG4 DEBUG4
449 #define SECONDS_PER_DAY 86400
450 #define MAX_REQUEST_TIME 30
451 #define CLEANUP_DELAY 5
452 #define MAX_REQUESTS 256
453 #define RETRY_DELAY 5
454 #define RETRY_COUNT 3
455 #define DEAD_TIME 120
470 * This definition of true as NOT false is definitive. :) Making
471 * it '1' can cause problems on stupid platforms. See articles
472 * on C portability for more information.
474 #define TRUE (!FALSE)
477 /* for paircompare_register */
478 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
480 typedef enum request_fail_t {
481 REQUEST_FAIL_UNKNOWN = 0,
482 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
483 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
484 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
485 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
486 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
487 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
488 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
489 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
490 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
491 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
497 * We really shouldn't have this many.
499 extern const char *progname;
500 extern int debug_flag;
501 extern const char *radacct_dir;
502 extern const char *radlog_dir;
503 extern const char *radlib_dir;
504 extern char *radius_dir;
505 extern const char *radius_libdir;
506 extern uint32_t expiration_seconds;
507 extern int log_stripped_names;
508 extern int log_auth_detail;
509 extern const char *radiusd_version;
510 void radius_signal_self(int flag);
512 #define RADIUS_SIGNAL_SELF_NONE (0)
513 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
514 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
515 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
516 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
517 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
518 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
522 * Function prototypes.
526 int rad_accounting(REQUEST *);
529 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
530 const char *sessionid);
531 int session_zap(REQUEST *request, uint32_t nasaddr,
532 unsigned int port, const char *user,
533 const char *sessionid, uint32_t cliaddr,
534 char proto,int session_time);
538 void debug_pair(VALUE_PAIR *);
539 void debug_pair_list(VALUE_PAIR *);
540 int log_err (char *);
543 void (*reset_signal(int signo, void (*func)(int)))(int);
544 void request_free(REQUEST **request);
545 int rad_mkdir(char *directory, int mode);
546 int rad_checkfilename(const char *filename);
547 void *rad_malloc(size_t size); /* calls exit(1) on error! */
548 REQUEST *request_alloc(void);
549 REQUEST *request_alloc_fake(REQUEST *oldreq);
550 REQUEST *request_alloc_coa(REQUEST *request);
551 int request_data_add(REQUEST *request,
552 void *unique_ptr, int unique_int,
553 void *opaque, void (*free_opaque)(void *));
554 void *request_data_get(REQUEST *request,
555 void *unique_ptr, int unique_int);
556 void *request_data_reference(REQUEST *request,
557 void *unique_ptr, int unique_int);
558 int rad_copy_string(char *dst, const char *src);
559 int rad_copy_variable(char *dst, const char *from);
562 RADCLIENT_LIST *clients_init(void);
563 void clients_free(RADCLIENT_LIST *clients);
564 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
565 void client_free(RADCLIENT *client);
566 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
567 #ifdef WITH_DYNAMIC_CLIENTS
568 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
569 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
571 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
572 const fr_ipaddr_t *ipaddr, int proto);
574 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
576 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
577 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
579 RADCLIENT *client_read(const char *filename, int in_server, int flag);
583 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
584 void pairlist_free(PAIR_LIST **);
590 int vradlog(int, const char *, va_list ap);
591 int radlog(int, const char *, ...)
593 __attribute__ ((format (printf, 2, 3)))
596 int log_debug(const char *, ...)
598 __attribute__ ((format (printf, 1, 2)))
601 void vp_listdebug(VALUE_PAIR *vp);
602 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
604 __attribute__ ((format (printf, 4, 5)))
609 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
610 int rad_authenticate (REQUEST *);
611 int rad_postauth(REQUEST *);
614 int radius_exec_program(const char *, REQUEST *, int,
615 char *user_msg, int msg_len,
616 VALUE_PAIR *input_pairs,
617 VALUE_PAIR **output_pairs,
621 int timestr_match(char *, time_t);
624 int paircompare_register(unsigned int attr, int otherattr,
625 RAD_COMPARE_FUNC func,
627 void paircompare_unregister(unsigned int attr, RAD_COMPARE_FUNC func);
628 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
630 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
631 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
632 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
633 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
634 VALUE_PAIR **reply_pairs);
635 int radius_find_compare(unsigned int attribute);
636 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
637 unsigned int attribute, unsigned int vendor, int type);
638 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
639 const char *attribute, const char *value,
643 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
645 int radius_xlat(char * out, int outlen, const char *fmt,
646 REQUEST * request, RADIUS_ESCAPE_STRING func);
647 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
648 int xlat_register(const char *module, RAD_XLAT_FUNC func,
650 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
651 void xlat_free(void);
654 extern int thread_pool_init(CONF_SECTION *cs, int *spawn_flag);
655 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
656 extern pid_t rad_fork(void);
657 extern pid_t rad_waitpid(pid_t pid, int *status);
658 extern int total_active_threads(void);
659 extern void thread_pool_lock(void);
660 extern void thread_pool_unlock(void);
661 extern void thread_pool_queue_stats(int *array);
663 #ifndef HAVE_PTHREAD_H
664 #define rad_fork(n) fork()
665 #define rad_waitpid(a,b) waitpid(a,b, 0)
669 /* Define a global config structure */
670 extern struct main_config_t mainconfig;
672 int read_mainconfig(int reload);
673 int free_mainconfig(void);
674 void hup_mainconfig(void);
675 void fr_suid_down(void);
676 void fr_suid_up(void);
677 void fr_suid_down_permanent(void);
680 void listen_free(rad_listen_t **head);
681 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
682 int proxy_new_listener(home_server *home, int src_port);
683 RADCLIENT *client_listener_find(rad_listen_t *listener,
684 const fr_ipaddr_t *ipaddr, int src_port);
687 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
690 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
693 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
694 void radius_event_free(void);
695 int radius_event_process(void);
696 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
697 int received_request(rad_listen_t *listener,
698 RADIUS_PACKET *packet, REQUEST **prequest,
700 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
701 int event_new_fd(rad_listen_t *listener);
702 void revive_home_server(void *ctx);
703 void mark_home_server_dead(home_server *home, struct timeval *when);
706 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
707 const char **ptr, int evaluate_it, int *presult);
708 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
709 VALUE_PAIR *input_vps, const char *name);
710 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);
711 int radius_get_vp(REQUEST *request, const char *name, VALUE_PAIR **vp_p);