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;
147 home_server *coa_server;
148 home_pool_t *coa_pool;
153 * Types of listeners.
155 * Ordered by priority!
157 typedef enum RAD_LISTEN_TYPE {
163 #ifdef WITH_ACCOUNTING
175 #ifdef WITH_COMMAND_SOCKET
186 * For listening on multiple IP's and ports.
188 typedef struct rad_listen_t rad_listen_t;
189 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
191 #define REQUEST_DATA_REGEX (0xadbeef00)
192 #define REQUEST_MAX_REGEX (8)
196 uint32_t magic; /* for debugging only */
198 RADIUS_PACKET *packet;
200 RADIUS_PACKET *proxy;
202 RADIUS_PACKET *reply;
204 RADIUS_PACKET *proxy_reply;
206 VALUE_PAIR *config_items;
207 VALUE_PAIR *username;
208 VALUE_PAIR *password;
210 struct main_config_t *root;
212 request_data_t *data;
214 #ifdef HAVE_PTHREAD_H
218 int number; /* internal server number */
220 rad_listen_t *listener;
222 rad_listen_t *proxy_listener;
226 int simul_max; /* see modcall.c && xlat.c */
227 #ifdef WITH_SESSION_MGMT
229 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
232 int options; /* miscellanous options */
233 const char *module; /* for debugging unresponsive children */
234 const char *component; /* ditto */
236 struct timeval received;
237 struct timeval when; /* to wake up */
242 RAD_LISTEN_TYPE priority;
245 struct timeval next_when;
246 fr_event_callback_t next_callback;
252 home_server *home_server;
253 home_pool_t *home_pool; /* for dynamic failover */
255 struct timeval proxy_when;
257 int num_proxied_requests;
258 int num_proxied_responses;
263 radlog_func_t radlog; /* logging function, if set */
266 int num_coa_requests;
268 }; /* REQUEST typedef */
270 #define RAD_REQUEST_OPTION_NONE (0)
271 #define RAD_REQUEST_OPTION_DEBUG (1)
272 #define RAD_REQUEST_OPTION_DEBUG2 (2)
273 #define RAD_REQUEST_OPTION_DEBUG3 (3)
274 #define RAD_REQUEST_OPTION_DEBUG4 (4)
276 #define REQUEST_ACTIVE (1)
277 #define REQUEST_STOP_PROCESSING (2)
278 #define REQUEST_COUNTED (3)
280 #define REQUEST_QUEUED (1)
281 #define REQUEST_RUNNING (2)
282 #define REQUEST_PROXIED (3)
283 #define REQUEST_REJECT_DELAY (4)
284 #define REQUEST_CLEANUP_DELAY (5)
285 #define REQUEST_DONE (6)
288 * Function handler for requests.
290 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
292 typedef struct radclient_list RADCLIENT_LIST;
294 typedef struct pair_list {
300 struct pair_list *next;
301 struct pair_list *lastdefault;
305 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
306 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
307 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
308 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
309 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
311 struct rad_listen_t {
312 struct rad_listen_t *next; /* should be rbtree stuff */
315 * For normal sockets.
317 RAD_LISTEN_TYPE type;
325 rad_listen_recv_t recv;
326 rad_listen_send_t send;
327 rad_listen_encode_t encode;
328 rad_listen_decode_t decode;
329 rad_listen_print_t print;
338 #define RAD_LISTEN_STATUS_INIT (0)
339 #define RAD_LISTEN_STATUS_KNOWN (1)
340 #define RAD_LISTEN_STATUS_CLOSED (2)
341 #define RAD_LISTEN_STATUS_FINISH (3)
343 typedef enum radlog_dest_t {
352 typedef struct main_config_t {
353 struct main_config *next;
355 fr_ipaddr_t myip; /* from the command-line only */
356 int port; /* from the command-line only */
358 int log_auth_badpass;
359 int log_auth_goodpass;
360 int allow_core_dumps;
365 int max_request_time;
368 #ifdef DELETE_BLOCKED_REQUESTS
369 int kill_unresponsive_children;
373 const char *pid_file;
374 rad_listen_t *listen;
377 radlog_dest_t radlog_dest;
378 CONF_SECTION *config;
380 const char *auth_badpass_msg;
381 const char *auth_goodpass_msg;
384 #define DEBUG if(debug_flag)log_debug
385 #define DEBUG2 if (debug_flag > 1)log_debug
386 #define DEBUG3 if (debug_flag > 2)log_debug
387 #define DEBUG4 if (debug_flag > 3)log_debug
390 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
391 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
392 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
393 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
396 #define RDEBUG2 DEBUG2
397 #define RDEBUG3 DEBUG3
398 #define RDEBUG4 DEBUG4
401 #define SECONDS_PER_DAY 86400
402 #define MAX_REQUEST_TIME 30
403 #define CLEANUP_DELAY 5
404 #define MAX_REQUESTS 256
405 #define RETRY_DELAY 5
406 #define RETRY_COUNT 3
407 #define DEAD_TIME 120
422 * This definition of true as NOT false is definitive. :) Making
423 * it '1' can cause problems on stupid platforms. See articles
424 * on C portability for more information.
426 #define TRUE (!FALSE)
429 /* for paircompare_register */
430 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
432 typedef enum request_fail_t {
433 REQUEST_FAIL_UNKNOWN = 0,
434 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
435 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
436 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
437 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
438 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
439 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
440 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
441 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
442 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
443 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
449 * We really shouldn't have this many.
451 extern const char *progname;
452 extern int debug_flag;
453 extern const char *radacct_dir;
454 extern const char *radlog_dir;
455 extern const char *radlib_dir;
456 extern const char *radius_dir;
457 extern const char *radius_libdir;
458 extern uint32_t expiration_seconds;
459 extern int log_stripped_names;
460 extern int log_auth_detail;
461 extern const char *radiusd_version;
462 void radius_signal_self(int flag);
464 #define RADIUS_SIGNAL_SELF_NONE (0)
465 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
466 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
467 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
468 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
469 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
470 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
474 * Function prototypes.
478 int rad_accounting(REQUEST *);
481 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
482 const char *sessionid);
483 int session_zap(REQUEST *request, uint32_t nasaddr,
484 unsigned int port, const char *user,
485 const char *sessionid, uint32_t cliaddr,
486 char proto,int session_time);
490 void debug_pair(VALUE_PAIR *);
491 void debug_pair_list(VALUE_PAIR *);
492 int log_err (char *);
495 void (*reset_signal(int signo, void (*func)(int)))(int);
496 void request_free(REQUEST **request);
497 int rad_mkdir(char *directory, int mode);
498 int rad_checkfilename(const char *filename);
499 void *rad_malloc(size_t size); /* calls exit(1) on error! */
500 REQUEST *request_alloc(void);
501 REQUEST *request_alloc_fake(REQUEST *oldreq);
502 REQUEST *request_alloc_coa(REQUEST *request);
503 int request_data_add(REQUEST *request,
504 void *unique_ptr, int unique_int,
505 void *opaque, void (*free_opaque)(void *));
506 void *request_data_get(REQUEST *request,
507 void *unique_ptr, int unique_int);
508 void *request_data_reference(REQUEST *request,
509 void *unique_ptr, int unique_int);
510 int rad_copy_string(char *dst, const char *src);
511 int rad_copy_variable(char *dst, const char *from);
514 RADCLIENT_LIST *clients_init(void);
515 void clients_free(RADCLIENT_LIST *clients);
516 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
517 void client_free(RADCLIENT *client);
518 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
519 #ifdef WITH_DYNAMIC_CLIENTS
520 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
521 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
523 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
524 const fr_ipaddr_t *ipaddr
529 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
531 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
532 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
534 RADCLIENT *client_read(const char *filename, int in_server, int flag);
538 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
539 void pairlist_free(PAIR_LIST **);
545 int vradlog(int, const char *, va_list ap);
546 int radlog(int, const char *, ...)
548 __attribute__ ((format (printf, 2, 3)))
551 int log_debug(const char *, ...)
553 __attribute__ ((format (printf, 1, 2)))
556 void vp_listdebug(VALUE_PAIR *vp);
557 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
559 __attribute__ ((format (printf, 4, 5)))
564 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
565 int rad_authenticate (REQUEST *);
566 int rad_postauth(REQUEST *);
569 int radius_exec_program(const char *, REQUEST *, int,
570 char *user_msg, int msg_len,
571 VALUE_PAIR *input_pairs,
572 VALUE_PAIR **output_pairs,
576 int timestr_match(char *, time_t);
579 int paircompare_register(int attr, int otherattr,
580 RAD_COMPARE_FUNC func,
582 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
583 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
585 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
586 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
587 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
588 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
589 VALUE_PAIR **reply_pairs);
590 int radius_find_compare(int attribute);
591 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
592 int attribute, int type);
593 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
594 const char *attribute, const char *value,
598 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
600 int radius_xlat(char * out, int outlen, const char *fmt,
601 REQUEST * request, RADIUS_ESCAPE_STRING func);
602 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
603 int xlat_register(const char *module, RAD_XLAT_FUNC func,
605 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
606 void xlat_free(void);
609 extern int thread_pool_init(CONF_SECTION *cs, int *spawn_flag);
610 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
611 extern pid_t rad_fork(void);
612 extern pid_t rad_waitpid(pid_t pid, int *status);
613 extern int total_active_threads(void);
614 extern void thread_pool_lock(void);
615 extern void thread_pool_unlock(void);
616 extern void thread_pool_queue_stats(int *array);
618 #ifndef HAVE_PTHREAD_H
619 #define rad_fork(n) fork()
620 #define rad_waitpid(a,b) waitpid(a,b, 0)
624 /* Define a global config structure */
625 extern struct main_config_t mainconfig;
627 int read_mainconfig(int reload);
628 int free_mainconfig(void);
629 void hup_mainconfig(void);
630 void fr_suid_down(void);
631 void fr_suid_up(void);
632 void fr_suid_down_permanent(void);
635 void listen_free(rad_listen_t **head);
636 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
637 rad_listen_t *proxy_new_listener(fr_ipaddr_t *ipaddr, int exists);
638 RADCLIENT *client_listener_find(const rad_listen_t *listener,
639 const fr_ipaddr_t *ipaddr, int src_port);
641 fr_tcp_radius_t *fr_listen2tcp(rad_listen_t *this);
642 rad_listen_t *proxy_new_tcp_listener(home_server *home);
643 void proxy_close_tcp_listener(rad_listen_t *listener);
647 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
649 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
653 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
654 void radius_event_free(void);
655 int radius_event_process(void);
656 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
657 int received_request(rad_listen_t *listener,
658 RADIUS_PACKET *packet, REQUEST **prequest,
660 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
661 void event_new_fd(rad_listen_t *listener);
663 REQUEST *received_proxy_tcp_response(RADIUS_PACKET *packet,
664 fr_tcp_radius_t *tcp);
668 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
669 const char **ptr, int evaluate_it, int *presult);
670 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
671 VALUE_PAIR *input_vps, const char *name);
672 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);