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)
91 #ifndef WITHOUT_COMMAND_SOCKET
93 #define WITH_COMMAND_SOCKET (1)
97 #include <freeradius-devel/stats.h>
98 #include <freeradius-devel/realms.h>
104 typedef struct request_data_t request_data_t;
106 typedef struct radclient {
112 int message_authenticator;
117 int number; /* internal use only */
118 const CONF_SECTION *cs;
121 #ifdef WITH_ACCOUNTING
126 #ifdef WITH_DYNAMIC_CLIENTS
128 int dynamic; /* was dynamically defined */
130 time_t last_new_client;
136 * Types of listeners.
138 * Ordered by priority!
140 typedef enum RAD_LISTEN_TYPE {
146 #ifdef WITH_ACCOUNTING
158 #ifdef WITH_COMMAND_SOCKET
166 * For listening on multiple IP's and ports.
168 typedef struct rad_listen_t rad_listen_t;
169 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
171 #define REQUEST_DATA_REGEX (0xadbeef00)
172 #define REQUEST_MAX_REGEX (8)
176 uint32_t magic; /* for debugging only */
178 RADIUS_PACKET *packet;
180 RADIUS_PACKET *proxy;
182 RADIUS_PACKET *reply;
184 RADIUS_PACKET *proxy_reply;
186 VALUE_PAIR *config_items;
187 VALUE_PAIR *username;
188 VALUE_PAIR *password;
190 struct main_config_t *root;
192 request_data_t *data;
194 #ifdef HAVE_PTHREAD_H
195 child_pid_t child_pid;
198 int number; /* internal server number */
200 rad_listen_t *listener;
202 rad_listen_t *proxy_listener;
206 int simul_max; /* see modcall.c && xlat.c */
207 #ifdef WITH_SESSION_MGMT
209 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
212 int options; /* miscellanous options */
213 const char *module; /* for debugging unresponsive children */
214 const char *component; /* ditto */
216 struct timeval received;
217 struct timeval when; /* to wake up */
222 RAD_LISTEN_TYPE priority;
225 struct timeval next_when;
226 fr_event_callback_t next_callback;
232 home_server *home_server;
233 home_pool_t *home_pool; /* for dynamic failover */
235 struct timeval proxy_when;
237 int num_proxied_requests;
238 int num_proxied_responses;
243 radlog_func_t radlog; /* logging function, if set */
244 }; /* REQUEST typedef */
246 #define RAD_REQUEST_OPTION_NONE (0)
247 #define RAD_REQUEST_OPTION_DEBUG (1)
248 #define RAD_REQUEST_OPTION_DEBUG2 (2)
249 #define RAD_REQUEST_OPTION_DEBUG3 (3)
250 #define RAD_REQUEST_OPTION_DEBUG4 (4)
252 #define REQUEST_ACTIVE (1)
253 #define REQUEST_STOP_PROCESSING (2)
254 #define REQUEST_COUNTED (3)
256 #define REQUEST_QUEUED (1)
257 #define REQUEST_RUNNING (2)
258 #define REQUEST_PROXIED (3)
259 #define REQUEST_REJECT_DELAY (4)
260 #define REQUEST_CLEANUP_DELAY (5)
261 #define REQUEST_DONE (6)
264 * Function handler for requests.
266 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
268 typedef struct radclient_list RADCLIENT_LIST;
270 typedef struct pair_list {
276 struct pair_list *next;
277 struct pair_list *lastdefault;
281 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
282 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
283 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
284 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
285 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
287 struct rad_listen_t {
288 struct rad_listen_t *next; /* should be rbtree stuff */
291 * For normal sockets.
293 RAD_LISTEN_TYPE type;
298 rad_listen_recv_t recv;
299 rad_listen_send_t send;
300 rad_listen_encode_t encode;
301 rad_listen_decode_t decode;
302 rad_listen_print_t print;
311 #define RAD_LISTEN_STATUS_INIT (0)
312 #define RAD_LISTEN_STATUS_KNOWN (1)
313 #define RAD_LISTEN_STATUS_CLOSED (2)
314 #define RAD_LISTEN_STATUS_FINISH (3)
316 typedef enum radlog_dest_t {
325 typedef struct main_config_t {
326 struct main_config *next;
328 fr_ipaddr_t myip; /* from the command-line only */
329 int port; /* from the command-line only */
331 int log_auth_badpass;
332 int log_auth_goodpass;
333 int allow_core_dumps;
338 int max_request_time;
341 #ifdef DELETE_BLOCKED_REQUESTS
342 int kill_unresponsive_children;
346 const char *pid_file;
347 rad_listen_t *listen;
350 radlog_dest_t radlog_dest;
351 CONF_SECTION *config;
355 #define DEBUG if(debug_flag)log_debug
356 #define DEBUG2 if (debug_flag > 1)log_debug
357 #define DEBUG3 if (debug_flag > 2)log_debug
360 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
361 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
362 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
363 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
366 #define RDEBUG2 DEBUG2
367 #define RDEBUG3 DEBUG3
368 #define RDEBUG4 DEBUG4
371 #define SECONDS_PER_DAY 86400
372 #define MAX_REQUEST_TIME 30
373 #define CLEANUP_DELAY 5
374 #define MAX_REQUESTS 256
375 #define RETRY_DELAY 5
376 #define RETRY_COUNT 3
377 #define DEAD_TIME 120
392 * This definition of true as NOT false is definitive. :) Making
393 * it '1' can cause problems on stupid platforms. See articles
394 * on C portability for more information.
396 #define TRUE (!FALSE)
399 /* for paircompare_register */
400 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
402 typedef enum request_fail_t {
403 REQUEST_FAIL_UNKNOWN = 0,
404 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
405 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
406 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
407 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
408 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
409 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
410 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
411 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
412 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
413 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
419 * We really shouldn't have this many.
421 extern const char *progname;
422 extern int debug_flag;
423 extern const char *radacct_dir;
424 extern const char *radlog_dir;
425 extern const char *radlib_dir;
426 extern const char *radius_dir;
427 extern const char *radius_libdir;
428 extern uint32_t expiration_seconds;
429 extern int log_stripped_names;
430 extern int log_auth_detail;
431 extern const char *radiusd_version;
432 void radius_signal_self(int flag);
434 #define RADIUS_SIGNAL_SELF_NONE (0)
435 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
436 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
437 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
438 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
439 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
440 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
444 * Function prototypes.
448 int rad_accounting(REQUEST *);
451 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
452 const char *sessionid);
453 int session_zap(REQUEST *request, uint32_t nasaddr,
454 unsigned int port, const char *user,
455 const char *sessionid, uint32_t cliaddr,
456 char proto,int session_time);
460 void debug_pair(VALUE_PAIR *);
461 void debug_pair_list(VALUE_PAIR *);
462 int log_err (char *);
465 void (*reset_signal(int signo, void (*func)(int)))(int);
466 void request_free(REQUEST **request);
467 int rad_mkdir(char *directory, int mode);
468 int rad_checkfilename(const char *filename);
469 void *rad_malloc(size_t size); /* calls exit(1) on error! */
470 REQUEST *request_alloc(void);
471 REQUEST *request_alloc_fake(REQUEST *oldreq);
472 int request_data_add(REQUEST *request,
473 void *unique_ptr, int unique_int,
474 void *opaque, void (*free_opaque)(void *));
475 void *request_data_get(REQUEST *request,
476 void *unique_ptr, int unique_int);
477 void *request_data_reference(REQUEST *request,
478 void *unique_ptr, int unique_int);
479 int rad_copy_string(char *dst, const char *src);
480 int rad_copy_variable(char *dst, const char *from);
483 RADCLIENT_LIST *clients_init(void);
484 void clients_free(RADCLIENT_LIST *clients);
485 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
486 void client_free(RADCLIENT *client);
487 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
488 #ifdef WITH_DYNAMIC_CLIENTS
489 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
490 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
492 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
493 const fr_ipaddr_t *ipaddr);
494 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
496 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
497 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
499 RADCLIENT *client_read(const char *filename, int in_server, int flag);
503 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
504 void pairlist_free(PAIR_LIST **);
510 int vradlog(int, const char *, va_list ap);
511 int radlog(int, const char *, ...)
513 __attribute__ ((format (printf, 2, 3)))
516 int log_debug(const char *, ...)
518 __attribute__ ((format (printf, 1, 2)))
521 void vp_listdebug(VALUE_PAIR *vp);
522 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
524 __attribute__ ((format (printf, 4, 5)))
529 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
530 int rad_authenticate (REQUEST *);
531 int rad_postauth(REQUEST *);
534 int radius_exec_program(const char *, REQUEST *, int,
535 char *user_msg, int msg_len,
536 VALUE_PAIR *input_pairs,
537 VALUE_PAIR **output_pairs,
541 int timestr_match(char *, time_t);
544 int paircompare_register(int attr, int otherattr,
545 RAD_COMPARE_FUNC func,
547 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
548 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
550 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
551 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
552 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
553 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
554 VALUE_PAIR **reply_pairs);
555 int radius_find_compare(int attribute);
556 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
557 int attribute, int type);
558 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
559 const char *attribute, const char *value,
563 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
565 int radius_xlat(char * out, int outlen, const char *fmt,
566 REQUEST * request, RADIUS_ESCAPE_STRING func);
567 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
568 int xlat_register(const char *module, RAD_XLAT_FUNC func,
570 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
571 void xlat_free(void);
574 extern int thread_pool_init(CONF_SECTION *cs, int spawn_flag);
575 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
576 extern pid_t rad_fork(void);
577 extern pid_t rad_waitpid(pid_t pid, int *status);
578 extern int total_active_threads(void);
579 extern void thread_pool_lock(void);
580 extern void thread_pool_unlock(void);
581 extern void thread_pool_queue_stats(int *array);
583 #ifndef HAVE_PTHREAD_H
584 #define rad_fork(n) fork()
585 #define rad_waitpid(a,b) waitpid(a,b, 0)
589 /* Define a global config structure */
590 extern struct main_config_t mainconfig;
592 int read_mainconfig(int reload);
593 int free_mainconfig(void);
596 void listen_free(rad_listen_t **head);
597 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
598 rad_listen_t *proxy_new_listener(void);
599 RADCLIENT *client_listener_find(const rad_listen_t *listener,
600 const fr_ipaddr_t *ipaddr);
602 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
604 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
608 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
609 void radius_event_free(void);
610 int radius_event_process(void);
611 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
612 int received_request(rad_listen_t *listener,
613 RADIUS_PACKET *packet, REQUEST **prequest,
615 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
616 void event_new_fd(rad_listen_t *listener);
619 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
620 const char **ptr, int evaluate_it, int *presult);
621 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
622 VALUE_PAIR *input_vps, const char *name);
623 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);