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
131 #ifdef WITH_DYNAMIC_CLIENTS
133 int dynamic; /* was dynamically defined */
135 time_t last_new_client;
141 home_server *coa_server;
142 home_pool_t *coa_pool;
147 * Types of listeners.
149 * Ordered by priority!
151 typedef enum RAD_LISTEN_TYPE {
157 #ifdef WITH_ACCOUNTING
169 #ifdef WITH_COMMAND_SOCKET
177 * For listening on multiple IP's and ports.
179 typedef struct rad_listen_t rad_listen_t;
180 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
182 #define REQUEST_DATA_REGEX (0xadbeef00)
183 #define REQUEST_MAX_REGEX (8)
187 uint32_t magic; /* for debugging only */
189 RADIUS_PACKET *packet;
191 RADIUS_PACKET *proxy;
193 RADIUS_PACKET *reply;
195 RADIUS_PACKET *proxy_reply;
197 VALUE_PAIR *config_items;
198 VALUE_PAIR *username;
199 VALUE_PAIR *password;
201 struct main_config_t *root;
203 request_data_t *data;
205 #ifdef HAVE_PTHREAD_H
209 int number; /* internal server number */
211 rad_listen_t *listener;
213 rad_listen_t *proxy_listener;
217 int simul_max; /* see modcall.c && xlat.c */
218 #ifdef WITH_SESSION_MGMT
220 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
223 int options; /* miscellanous options */
224 const char *module; /* for debugging unresponsive children */
225 const char *component; /* ditto */
227 struct timeval received;
228 struct timeval when; /* to wake up */
233 RAD_LISTEN_TYPE priority;
236 struct timeval next_when;
237 fr_event_callback_t next_callback;
243 home_server *home_server;
244 home_pool_t *home_pool; /* for dynamic failover */
246 struct timeval proxy_when;
248 int num_proxied_requests;
249 int num_proxied_responses;
254 radlog_func_t radlog; /* logging function, if set */
257 int num_coa_requests;
259 }; /* REQUEST typedef */
261 #define RAD_REQUEST_OPTION_NONE (0)
262 #define RAD_REQUEST_OPTION_DEBUG (1)
263 #define RAD_REQUEST_OPTION_DEBUG2 (2)
264 #define RAD_REQUEST_OPTION_DEBUG3 (3)
265 #define RAD_REQUEST_OPTION_DEBUG4 (4)
267 #define REQUEST_ACTIVE (1)
268 #define REQUEST_STOP_PROCESSING (2)
269 #define REQUEST_COUNTED (3)
271 #define REQUEST_QUEUED (1)
272 #define REQUEST_RUNNING (2)
273 #define REQUEST_PROXIED (3)
274 #define REQUEST_REJECT_DELAY (4)
275 #define REQUEST_CLEANUP_DELAY (5)
276 #define REQUEST_DONE (6)
279 * Function handler for requests.
281 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
283 typedef struct radclient_list RADCLIENT_LIST;
285 typedef struct pair_list {
291 struct pair_list *next;
292 struct pair_list *lastdefault;
296 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
297 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
298 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
299 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
300 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
302 struct rad_listen_t {
303 struct rad_listen_t *next; /* should be rbtree stuff */
306 * For normal sockets.
308 RAD_LISTEN_TYPE type;
313 rad_listen_recv_t recv;
314 rad_listen_send_t send;
315 rad_listen_encode_t encode;
316 rad_listen_decode_t decode;
317 rad_listen_print_t print;
326 #define RAD_LISTEN_STATUS_INIT (0)
327 #define RAD_LISTEN_STATUS_KNOWN (1)
328 #define RAD_LISTEN_STATUS_CLOSED (2)
329 #define RAD_LISTEN_STATUS_FINISH (3)
331 typedef enum radlog_dest_t {
340 typedef struct main_config_t {
341 struct main_config *next;
343 fr_ipaddr_t myip; /* from the command-line only */
344 int port; /* from the command-line only */
346 int log_auth_badpass;
347 int log_auth_goodpass;
348 int allow_core_dumps;
353 int max_request_time;
356 #ifdef DELETE_BLOCKED_REQUESTS
357 int kill_unresponsive_children;
361 const char *pid_file;
362 rad_listen_t *listen;
365 radlog_dest_t radlog_dest;
366 CONF_SECTION *config;
370 #define DEBUG if(debug_flag)log_debug
371 #define DEBUG2 if (debug_flag > 1)log_debug
372 #define DEBUG3 if (debug_flag > 2)log_debug
373 #define DEBUG4 if (debug_flag > 3)log_debug
376 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
377 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
378 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
379 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
382 #define RDEBUG2 DEBUG2
383 #define RDEBUG3 DEBUG3
384 #define RDEBUG4 DEBUG4
387 #define SECONDS_PER_DAY 86400
388 #define MAX_REQUEST_TIME 30
389 #define CLEANUP_DELAY 5
390 #define MAX_REQUESTS 256
391 #define RETRY_DELAY 5
392 #define RETRY_COUNT 3
393 #define DEAD_TIME 120
408 * This definition of true as NOT false is definitive. :) Making
409 * it '1' can cause problems on stupid platforms. See articles
410 * on C portability for more information.
412 #define TRUE (!FALSE)
415 /* for paircompare_register */
416 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
418 typedef enum request_fail_t {
419 REQUEST_FAIL_UNKNOWN = 0,
420 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
421 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
422 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
423 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
424 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
425 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
426 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
427 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
428 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
429 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
435 * We really shouldn't have this many.
437 extern const char *progname;
438 extern int debug_flag;
439 extern const char *radacct_dir;
440 extern const char *radlog_dir;
441 extern const char *radlib_dir;
442 extern const char *radius_dir;
443 extern const char *radius_libdir;
444 extern uint32_t expiration_seconds;
445 extern int log_stripped_names;
446 extern int log_auth_detail;
447 extern const char *radiusd_version;
448 void radius_signal_self(int flag);
450 #define RADIUS_SIGNAL_SELF_NONE (0)
451 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
452 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
453 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
454 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
455 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
456 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
460 * Function prototypes.
464 int rad_accounting(REQUEST *);
467 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
468 const char *sessionid);
469 int session_zap(REQUEST *request, uint32_t nasaddr,
470 unsigned int port, const char *user,
471 const char *sessionid, uint32_t cliaddr,
472 char proto,int session_time);
476 void debug_pair(VALUE_PAIR *);
477 void debug_pair_list(VALUE_PAIR *);
478 int log_err (char *);
481 void (*reset_signal(int signo, void (*func)(int)))(int);
482 void request_free(REQUEST **request);
483 int rad_mkdir(char *directory, int mode);
484 int rad_checkfilename(const char *filename);
485 void *rad_malloc(size_t size); /* calls exit(1) on error! */
486 REQUEST *request_alloc(void);
487 REQUEST *request_alloc_fake(REQUEST *oldreq);
488 REQUEST *request_alloc_coa(REQUEST *request);
489 int request_data_add(REQUEST *request,
490 void *unique_ptr, int unique_int,
491 void *opaque, void (*free_opaque)(void *));
492 void *request_data_get(REQUEST *request,
493 void *unique_ptr, int unique_int);
494 void *request_data_reference(REQUEST *request,
495 void *unique_ptr, int unique_int);
496 int rad_copy_string(char *dst, const char *src);
497 int rad_copy_variable(char *dst, const char *from);
500 RADCLIENT_LIST *clients_init(void);
501 void clients_free(RADCLIENT_LIST *clients);
502 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
503 void client_free(RADCLIENT *client);
504 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
505 #ifdef WITH_DYNAMIC_CLIENTS
506 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
507 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
509 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
510 const fr_ipaddr_t *ipaddr);
511 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
513 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
514 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
516 RADCLIENT *client_read(const char *filename, int in_server, int flag);
520 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
521 void pairlist_free(PAIR_LIST **);
527 int vradlog(int, const char *, va_list ap);
528 int radlog(int, const char *, ...)
530 __attribute__ ((format (printf, 2, 3)))
533 int log_debug(const char *, ...)
535 __attribute__ ((format (printf, 1, 2)))
538 void vp_listdebug(VALUE_PAIR *vp);
539 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
541 __attribute__ ((format (printf, 4, 5)))
546 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
547 int rad_authenticate (REQUEST *);
548 int rad_postauth(REQUEST *);
551 int radius_exec_program(const char *, REQUEST *, int,
552 char *user_msg, int msg_len,
553 VALUE_PAIR *input_pairs,
554 VALUE_PAIR **output_pairs,
558 int timestr_match(char *, time_t);
561 int paircompare_register(int attr, int otherattr,
562 RAD_COMPARE_FUNC func,
564 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
565 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
567 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
568 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
569 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
570 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
571 VALUE_PAIR **reply_pairs);
572 int radius_find_compare(int attribute);
573 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
574 int attribute, int type);
575 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
576 const char *attribute, const char *value,
580 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
582 int radius_xlat(char * out, int outlen, const char *fmt,
583 REQUEST * request, RADIUS_ESCAPE_STRING func);
584 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
585 int xlat_register(const char *module, RAD_XLAT_FUNC func,
587 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
588 void xlat_free(void);
591 extern int thread_pool_init(CONF_SECTION *cs, int spawn_flag);
592 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
593 extern pid_t rad_fork(void);
594 extern pid_t rad_waitpid(pid_t pid, int *status);
595 extern int total_active_threads(void);
596 extern void thread_pool_lock(void);
597 extern void thread_pool_unlock(void);
598 extern void thread_pool_queue_stats(int *array);
600 #ifndef HAVE_PTHREAD_H
601 #define rad_fork(n) fork()
602 #define rad_waitpid(a,b) waitpid(a,b, 0)
606 /* Define a global config structure */
607 extern struct main_config_t mainconfig;
609 int read_mainconfig(int reload);
610 int free_mainconfig(void);
611 void hup_mainconfig(void);
612 void fr_suid_down(void);
613 void fr_suid_up(void);
614 void fr_suid_down_permanent(void);
617 void listen_free(rad_listen_t **head);
618 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
619 rad_listen_t *proxy_new_listener(void);
620 RADCLIENT *client_listener_find(const rad_listen_t *listener,
621 const fr_ipaddr_t *ipaddr, int src_port);
623 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
625 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
629 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
630 void radius_event_free(void);
631 int radius_event_process(void);
632 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
633 int received_request(rad_listen_t *listener,
634 RADIUS_PACKET *packet, REQUEST **prequest,
636 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
637 void event_new_fd(rad_listen_t *listener);
640 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
641 const char **ptr, int evaluate_it, int *presult);
642 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
643 VALUE_PAIR *input_vps, const char *name);
644 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);