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)
98 #error WITH_COA requires WITH_PROXY
102 #include <freeradius-devel/stats.h>
103 #include <freeradius-devel/realms.h>
109 typedef struct request_data_t request_data_t;
111 typedef struct radclient {
117 int message_authenticator;
122 int number; /* internal use only */
123 const CONF_SECTION *cs;
126 #ifdef WITH_ACCOUNTING
137 #ifdef WITH_DYNAMIC_CLIENTS
139 int dynamic; /* was dynamically defined */
141 time_t last_new_client;
148 home_server *coa_server;
149 home_pool_t *coa_pool;
154 * Types of listeners.
156 * Ordered by priority!
158 typedef enum RAD_LISTEN_TYPE {
164 #ifdef WITH_ACCOUNTING
176 #ifdef WITH_COMMAND_SOCKET
187 * For listening on multiple IP's and ports.
189 typedef struct rad_listen_t rad_listen_t;
190 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
192 #define REQUEST_DATA_REGEX (0xadbeef00)
193 #define REQUEST_MAX_REGEX (8)
197 uint32_t magic; /* for debugging only */
199 RADIUS_PACKET *packet;
201 RADIUS_PACKET *proxy;
203 RADIUS_PACKET *reply;
205 RADIUS_PACKET *proxy_reply;
207 VALUE_PAIR *config_items;
208 VALUE_PAIR *username;
209 VALUE_PAIR *password;
211 struct main_config_t *root;
213 request_data_t *data;
215 #ifdef HAVE_PTHREAD_H
219 unsigned int number; /* internal server number */
221 rad_listen_t *listener;
223 rad_listen_t *proxy_listener;
227 int simul_max; /* see modcall.c && xlat.c */
228 #ifdef WITH_SESSION_MGMT
230 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
233 int options; /* miscellanous options */
234 const char *module; /* for debugging unresponsive children */
235 const char *component; /* ditto */
237 struct timeval received;
238 struct timeval when; /* to wake up */
243 RAD_LISTEN_TYPE priority;
246 struct timeval next_when;
247 fr_event_callback_t next_callback;
253 home_server *home_server;
254 home_pool_t *home_pool; /* for dynamic failover */
256 struct timeval proxy_when;
258 int num_proxied_requests;
259 int num_proxied_responses;
264 radlog_func_t radlog; /* logging function, if set */
267 int num_coa_requests;
269 }; /* REQUEST typedef */
271 #define RAD_REQUEST_OPTION_NONE (0)
272 #define RAD_REQUEST_OPTION_DEBUG (1)
273 #define RAD_REQUEST_OPTION_DEBUG2 (2)
274 #define RAD_REQUEST_OPTION_DEBUG3 (3)
275 #define RAD_REQUEST_OPTION_DEBUG4 (4)
277 #define REQUEST_ACTIVE (1)
278 #define REQUEST_STOP_PROCESSING (2)
279 #define REQUEST_COUNTED (3)
281 #define REQUEST_QUEUED (1)
282 #define REQUEST_RUNNING (2)
283 #define REQUEST_PROXIED (3)
284 #define REQUEST_REJECT_DELAY (4)
285 #define REQUEST_CLEANUP_DELAY (5)
286 #define REQUEST_DONE (6)
289 * Function handler for requests.
291 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
293 typedef struct radclient_list RADCLIENT_LIST;
295 typedef struct pair_list {
301 struct pair_list *next;
302 struct pair_list *lastdefault;
306 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
307 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
308 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
309 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
310 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
312 struct rad_listen_t {
313 struct rad_listen_t *next; /* should be rbtree stuff */
316 * For normal sockets.
318 RAD_LISTEN_TYPE type;
326 rad_listen_recv_t recv;
327 rad_listen_send_t send;
328 rad_listen_encode_t encode;
329 rad_listen_decode_t decode;
330 rad_listen_print_t print;
340 * This shouldn't really be exposed...
342 typedef struct listen_socket_t {
344 * For normal sockets.
346 fr_ipaddr_t my_ipaddr;
349 const char *interface;
354 /* for outgoing sockets */
356 fr_ipaddr_t other_ipaddr;
362 /* for a proxy connecting to home servers */
367 /* for clients connecting to the server */
370 struct listen_socket_t *parent;
373 RADIUS_PACKET *packet; /* for reading partial packets */
375 RADCLIENT_LIST *clients;
378 #define RAD_LISTEN_STATUS_INIT (0)
379 #define RAD_LISTEN_STATUS_KNOWN (1)
380 #define RAD_LISTEN_STATUS_REMOVE_FD (2)
381 #define RAD_LISTEN_STATUS_CLOSED (3)
382 #define RAD_LISTEN_STATUS_FINISH (4)
384 typedef enum radlog_dest_t {
393 typedef struct main_config_t {
394 struct main_config *next;
396 fr_ipaddr_t myip; /* from the command-line only */
397 int port; /* from the command-line only */
399 int log_auth_badpass;
400 int log_auth_goodpass;
401 int allow_core_dumps;
406 int max_request_time;
409 #ifdef DELETE_BLOCKED_REQUESTS
410 int kill_unresponsive_children;
414 const char *pid_file;
415 rad_listen_t *listen;
418 radlog_dest_t radlog_dest;
419 CONF_SECTION *config;
421 const char *auth_badpass_msg;
422 const char *auth_goodpass_msg;
425 #define DEBUG if(debug_flag)log_debug
426 #define DEBUG2 if (debug_flag > 1)log_debug
427 #define DEBUG3 if (debug_flag > 2)log_debug
428 #define DEBUG4 if (debug_flag > 3)log_debug
431 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
432 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
433 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
434 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
437 #define RDEBUG2 DEBUG2
438 #define RDEBUG3 DEBUG3
439 #define RDEBUG4 DEBUG4
442 #define SECONDS_PER_DAY 86400
443 #define MAX_REQUEST_TIME 30
444 #define CLEANUP_DELAY 5
445 #define MAX_REQUESTS 256
446 #define RETRY_DELAY 5
447 #define RETRY_COUNT 3
448 #define DEAD_TIME 120
463 * This definition of true as NOT false is definitive. :) Making
464 * it '1' can cause problems on stupid platforms. See articles
465 * on C portability for more information.
467 #define TRUE (!FALSE)
470 /* for paircompare_register */
471 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
473 typedef enum request_fail_t {
474 REQUEST_FAIL_UNKNOWN = 0,
475 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
476 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
477 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
478 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
479 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
480 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
481 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
482 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
483 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
484 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
490 * We really shouldn't have this many.
492 extern const char *progname;
493 extern int debug_flag;
494 extern const char *radacct_dir;
495 extern const char *radlog_dir;
496 extern const char *radlib_dir;
497 extern const char *radius_dir;
498 extern const char *radius_libdir;
499 extern uint32_t expiration_seconds;
500 extern int log_stripped_names;
501 extern int log_auth_detail;
502 extern const char *radiusd_version;
503 void radius_signal_self(int flag);
505 #define RADIUS_SIGNAL_SELF_NONE (0)
506 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
507 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
508 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
509 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
510 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
511 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
515 * Function prototypes.
519 int rad_accounting(REQUEST *);
522 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
523 const char *sessionid);
524 int session_zap(REQUEST *request, uint32_t nasaddr,
525 unsigned int port, const char *user,
526 const char *sessionid, uint32_t cliaddr,
527 char proto,int session_time);
531 void debug_pair(VALUE_PAIR *);
532 void debug_pair_list(VALUE_PAIR *);
533 int log_err (char *);
536 void (*reset_signal(int signo, void (*func)(int)))(int);
537 void request_free(REQUEST **request);
538 int rad_mkdir(char *directory, int mode);
539 int rad_checkfilename(const char *filename);
540 void *rad_malloc(size_t size); /* calls exit(1) on error! */
541 REQUEST *request_alloc(void);
542 REQUEST *request_alloc_fake(REQUEST *oldreq);
543 REQUEST *request_alloc_coa(REQUEST *request);
544 int request_data_add(REQUEST *request,
545 void *unique_ptr, int unique_int,
546 void *opaque, void (*free_opaque)(void *));
547 void *request_data_get(REQUEST *request,
548 void *unique_ptr, int unique_int);
549 void *request_data_reference(REQUEST *request,
550 void *unique_ptr, int unique_int);
551 int rad_copy_string(char *dst, const char *src);
552 int rad_copy_variable(char *dst, const char *from);
555 RADCLIENT_LIST *clients_init(void);
556 void clients_free(RADCLIENT_LIST *clients);
557 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
558 void client_free(RADCLIENT *client);
559 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
560 #ifdef WITH_DYNAMIC_CLIENTS
561 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
562 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
564 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
565 const fr_ipaddr_t *ipaddr, int proto);
567 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
569 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
570 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
572 RADCLIENT *client_read(const char *filename, int in_server, int flag);
576 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
577 void pairlist_free(PAIR_LIST **);
583 int vradlog(int, const char *, va_list ap);
584 int radlog(int, const char *, ...)
586 __attribute__ ((format (printf, 2, 3)))
589 int log_debug(const char *, ...)
591 __attribute__ ((format (printf, 1, 2)))
594 void vp_listdebug(VALUE_PAIR *vp);
595 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
597 __attribute__ ((format (printf, 4, 5)))
602 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
603 int rad_authenticate (REQUEST *);
604 int rad_postauth(REQUEST *);
607 int radius_exec_program(const char *, REQUEST *, int,
608 char *user_msg, int msg_len,
609 VALUE_PAIR *input_pairs,
610 VALUE_PAIR **output_pairs,
614 int timestr_match(char *, time_t);
617 int paircompare_register(int attr, int otherattr,
618 RAD_COMPARE_FUNC func,
620 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
621 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
623 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
624 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
625 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
626 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
627 VALUE_PAIR **reply_pairs);
628 int radius_find_compare(int attribute);
629 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
630 int attribute, int vendor, int type);
631 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
632 const char *attribute, const char *value,
636 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
638 int radius_xlat(char * out, int outlen, const char *fmt,
639 REQUEST * request, RADIUS_ESCAPE_STRING func);
640 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
641 int xlat_register(const char *module, RAD_XLAT_FUNC func,
643 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
644 void xlat_free(void);
647 extern int thread_pool_init(CONF_SECTION *cs, int *spawn_flag);
648 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
649 extern pid_t rad_fork(void);
650 extern pid_t rad_waitpid(pid_t pid, int *status);
651 extern int total_active_threads(void);
652 extern void thread_pool_lock(void);
653 extern void thread_pool_unlock(void);
654 extern void thread_pool_queue_stats(int *array);
656 #ifndef HAVE_PTHREAD_H
657 #define rad_fork(n) fork()
658 #define rad_waitpid(a,b) waitpid(a,b, 0)
662 /* Define a global config structure */
663 extern struct main_config_t mainconfig;
665 int read_mainconfig(int reload);
666 int free_mainconfig(void);
667 void hup_mainconfig(void);
668 void fr_suid_down(void);
669 void fr_suid_up(void);
670 void fr_suid_down_permanent(void);
673 void listen_free(rad_listen_t **head);
674 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
675 int proxy_new_listener(home_server *home, int src_port);
676 RADCLIENT *client_listener_find(const rad_listen_t *listener,
677 const fr_ipaddr_t *ipaddr, int src_port);
680 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
682 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
686 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
687 void radius_event_free(void);
688 int radius_event_process(void);
689 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
690 int received_request(rad_listen_t *listener,
691 RADIUS_PACKET *packet, REQUEST **prequest,
693 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
694 int event_new_fd(rad_listen_t *listener);
697 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
698 const char **ptr, int evaluate_it, int *presult);
699 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
700 VALUE_PAIR *input_vps, const char *name);
701 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);