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;
40 typedef pthread_t child_pid_t;
41 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
45 #define REQUEST_MAGIC (0xdeadbeef)
49 * New defines for minimizing the size of the server, to strip
50 * out functionality. In order to ensure that people don't have
51 * to re-run "configure", after "cvs update", we play some
52 * special games with the defines. i.e. any top-level "configure"
53 * option should set both WITH_FOO and WITHOUT_FOO. After a few
54 * weeks, the WITHOUT_FOO can be deleted from the configure script.
57 #define WITH_PROXY (1)
60 #ifndef WITHOUT_DETAIL
61 #define WITH_DETAIL (1)
64 #ifndef WITHOUT_SESSION_MGMT
65 #define WITH_SESSION_MGMT (1)
68 #ifndef WITHOUT_UNLANG
69 #define WITH_UNLANG (1)
72 #ifndef WITHOUT_ACCOUNTING
73 #define WITH_ACCOUNTING (1)
75 #ifdef WITH_SESSION_MGMT
76 #error WITH_SESSION_MGMT is defined, but WITH_ACCOUNTING is not. Session management requires accounting.
79 #error WITH_DETAIL is defined, but WITH_ACCOUNTING is not. Detail file reading requires accounting.
83 #ifndef WITHOUT_DYNAMIC_CLIENTS
84 #define WITH_DYNAMIC_CLIENTS (1)
90 #include <freeradius-devel/stats.h>
91 #include <freeradius-devel/realms.h>
97 typedef struct request_data_t request_data_t;
99 typedef struct radclient {
105 int message_authenticator;
110 int number; /* internal use only */
111 const CONF_SECTION *cs;
114 #ifdef WITH_ACCOUNTING
119 #ifdef WITH_DYNAMIC_CLIENTS
121 int dynamic; /* was dynamically defined */
123 time_t last_new_client;
129 * Types of listeners.
131 * Ordered by priority!
133 typedef enum RAD_LISTEN_TYPE {
146 * For listening on multiple IP's and ports.
148 typedef struct rad_listen_t rad_listen_t;
149 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
151 #define REQUEST_DATA_REGEX (0xadbeef00)
152 #define REQUEST_MAX_REGEX (8)
156 uint32_t magic; /* for debugging only */
158 RADIUS_PACKET *packet;
160 RADIUS_PACKET *proxy;
162 RADIUS_PACKET *reply;
164 RADIUS_PACKET *proxy_reply;
166 VALUE_PAIR *config_items;
167 VALUE_PAIR *username;
168 VALUE_PAIR *password;
170 struct main_config_t *root;
172 request_data_t *data;
174 #ifdef HAVE_PTHREAD_H
175 child_pid_t child_pid;
178 int number; /* internal server number */
180 rad_listen_t *listener;
182 rad_listen_t *proxy_listener;
186 int simul_max; /* see modcall.c && xlat.c */
187 #ifdef WITH_SESSION_MGMT
189 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
192 int options; /* miscellanous options */
193 const char *module; /* for debugging unresponsive children */
194 const char *component; /* ditto */
196 struct timeval received;
197 struct timeval when; /* to wake up */
202 RAD_LISTEN_TYPE priority;
205 struct timeval next_when;
206 fr_event_callback_t next_callback;
212 home_server *home_server;
213 home_pool_t *home_pool; /* for dynamic failover */
215 struct timeval proxy_when;
217 int num_proxied_requests;
218 int num_proxied_responses;
223 radlog_func_t radlog; /* logging function, if set */
224 }; /* REQUEST typedef */
226 #define RAD_REQUEST_OPTION_NONE (0)
227 #define RAD_REQUEST_OPTION_DEBUG (1)
228 #define RAD_REQUEST_OPTION_DEBUG2 (2)
229 #define RAD_REQUEST_OPTION_DEBUG3 (3)
230 #define RAD_REQUEST_OPTION_DEBUG4 (4)
232 #define REQUEST_ACTIVE (1)
233 #define REQUEST_STOP_PROCESSING (2)
234 #define REQUEST_COUNTED (3)
236 #define REQUEST_QUEUED (1)
237 #define REQUEST_RUNNING (2)
238 #define REQUEST_PROXIED (3)
239 #define REQUEST_REJECT_DELAY (4)
240 #define REQUEST_CLEANUP_DELAY (5)
241 #define REQUEST_DONE (6)
244 * Function handler for requests.
246 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
248 typedef struct radclient_list RADCLIENT_LIST;
250 typedef struct pair_list {
256 struct pair_list *next;
257 struct pair_list *lastdefault;
261 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
262 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
263 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
264 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
265 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
267 struct rad_listen_t {
268 struct rad_listen_t *next; /* should be rbtree stuff */
271 * For normal sockets.
273 RAD_LISTEN_TYPE type;
277 rad_listen_recv_t recv;
278 rad_listen_send_t send;
279 rad_listen_encode_t encode;
280 rad_listen_decode_t decode;
281 rad_listen_print_t print;
291 typedef enum radlog_dest_t {
300 typedef struct main_config_t {
301 struct main_config *next;
303 fr_ipaddr_t myip; /* from the command-line only */
304 int port; /* from the command-line only */
306 int log_auth_badpass;
307 int log_auth_goodpass;
308 int allow_core_dumps;
313 int max_request_time;
316 #ifdef DELETE_BLOCKED_REQUESTS
317 int kill_unresponsive_children;
321 const char *pid_file;
322 rad_listen_t *listen;
325 radlog_dest_t radlog_dest;
326 CONF_SECTION *config;
330 #define DEBUG if(debug_flag)log_debug
331 #define DEBUG2 if (debug_flag > 1)log_debug
332 #define DEBUG3 if (debug_flag > 2)log_debug
335 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
336 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
337 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
338 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
341 #define RDEBUG2 DEBUG2
342 #define RDEBUG3 DEBUG3
343 #define RDEBUG4 DEBUG4
346 #define SECONDS_PER_DAY 86400
347 #define MAX_REQUEST_TIME 30
348 #define CLEANUP_DELAY 5
349 #define MAX_REQUESTS 256
350 #define RETRY_DELAY 5
351 #define RETRY_COUNT 3
352 #define DEAD_TIME 120
367 * This definition of true as NOT false is definitive. :) Making
368 * it '1' can cause problems on stupid platforms. See articles
369 * on C portability for more information.
371 #define TRUE (!FALSE)
374 /* for paircompare_register */
375 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
377 typedef enum request_fail_t {
378 REQUEST_FAIL_UNKNOWN = 0,
379 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
380 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
381 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
382 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
383 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
384 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
385 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
386 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
387 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
388 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
394 * We really shouldn't have this many.
396 extern const char *progname;
397 extern int debug_flag;
398 extern const char *radacct_dir;
399 extern const char *radlog_dir;
400 extern const char *radlib_dir;
401 extern const char *radius_dir;
402 extern const char *radius_libdir;
403 extern uint32_t expiration_seconds;
404 extern int log_stripped_names;
405 extern int log_auth_detail;
406 extern const char *radiusd_version;
407 void radius_signal_self(int flag);
409 #define RADIUS_SIGNAL_SELF_NONE (0)
410 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
411 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
412 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
413 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
414 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
415 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
419 * Function prototypes.
423 int rad_accounting(REQUEST *);
426 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
427 const char *sessionid);
428 int session_zap(REQUEST *request, uint32_t nasaddr,
429 unsigned int port, const char *user,
430 const char *sessionid, uint32_t cliaddr,
431 char proto,int session_time);
435 void debug_pair(VALUE_PAIR *);
436 void debug_pair_list(VALUE_PAIR *);
437 int log_err (char *);
440 void (*reset_signal(int signo, void (*func)(int)))(int);
441 void request_free(REQUEST **request);
442 int rad_mkdir(char *directory, int mode);
443 int rad_checkfilename(const char *filename);
444 void *rad_malloc(size_t size); /* calls exit(1) on error! */
445 REQUEST *request_alloc(void);
446 REQUEST *request_alloc_fake(REQUEST *oldreq);
447 int request_data_add(REQUEST *request,
448 void *unique_ptr, int unique_int,
449 void *opaque, void (*free_opaque)(void *));
450 void *request_data_get(REQUEST *request,
451 void *unique_ptr, int unique_int);
452 void *request_data_reference(REQUEST *request,
453 void *unique_ptr, int unique_int);
454 int rad_copy_string(char *dst, const char *src);
455 int rad_copy_variable(char *dst, const char *from);
458 RADCLIENT_LIST *clients_init(void);
459 void clients_free(RADCLIENT_LIST *clients);
460 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
461 void client_free(RADCLIENT *client);
462 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
463 #ifdef WITH_DYNAMIC_CLIENTS
464 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
465 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
467 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
468 const fr_ipaddr_t *ipaddr);
469 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
471 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
472 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
474 RADCLIENT *client_read(const char *filename, int in_server);
478 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
479 void pairlist_free(PAIR_LIST **);
485 int vradlog(int, const char *, va_list ap);
486 int radlog(int, const char *, ...)
488 __attribute__ ((format (printf, 2, 3)))
491 int log_debug(const char *, ...)
493 __attribute__ ((format (printf, 1, 2)))
496 void vp_listdebug(VALUE_PAIR *vp);
497 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
499 __attribute__ ((format (printf, 4, 5)))
504 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
505 int rad_authenticate (REQUEST *);
506 int rad_postauth(REQUEST *);
509 int radius_exec_program(const char *, REQUEST *, int,
510 char *user_msg, int msg_len,
511 VALUE_PAIR *input_pairs,
512 VALUE_PAIR **output_pairs,
516 int timestr_match(char *, time_t);
519 int paircompare_register(int attr, int otherattr,
520 RAD_COMPARE_FUNC func,
522 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
523 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
525 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
526 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
527 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
528 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
529 VALUE_PAIR **reply_pairs);
530 int radius_find_compare(int attribute);
531 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
532 int attribute, int type);
533 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
534 const char *attribute, const char *value,
538 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
540 int radius_xlat(char * out, int outlen, const char *fmt,
541 REQUEST * request, RADIUS_ESCAPE_STRING func);
542 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
543 int xlat_register(const char *module, RAD_XLAT_FUNC func,
545 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
546 void xlat_free(void);
549 extern int thread_pool_init(CONF_SECTION *cs, int spawn_flag);
550 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
551 extern pid_t rad_fork(void);
552 extern pid_t rad_waitpid(pid_t pid, int *status);
553 extern int total_active_threads(void);
554 extern void thread_pool_lock(void);
555 extern void thread_pool_unlock(void);
556 extern void thread_pool_queue_stats(int *array);
558 #ifndef HAVE_PTHREAD_H
559 #define rad_fork(n) fork()
560 #define rad_waitpid(a,b) waitpid(a,b, 0)
564 /* Define a global config structure */
565 extern struct main_config_t mainconfig;
567 int read_mainconfig(int reload);
568 int free_mainconfig(void);
571 void listen_free(rad_listen_t **head);
572 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
573 rad_listen_t *proxy_new_listener(void);
574 RADCLIENT *client_listener_find(const rad_listen_t *listener,
575 const fr_ipaddr_t *ipaddr);
577 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
579 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
583 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
584 void radius_event_free(void);
585 int radius_event_process(void);
586 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
587 int received_request(rad_listen_t *listener,
588 RADIUS_PACKET *packet, REQUEST **prequest,
590 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
593 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
594 const char **ptr, int evaluate_it, int *presult);
595 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
596 VALUE_PAIR *input_vps, const char *name);
597 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);