4 * radiusd.h Structures, prototypes and global variables
5 * for the FreeRADIUS server.
7 * Version: $Id: radiusd.h,v 1.1 2010/08/14 04:13:52 faust Exp $
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/ident.h>
28 RCSIDH(radiusd_h, "$Id: radiusd.h,v 1.1 2010/08/14 04:13:52 faust Exp $")
30 #include "libradius.h"
31 #include <freeradius/radpaths.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
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 * Types of listeners.
143 * Ordered by priority!
145 typedef enum RAD_LISTEN_TYPE {
151 #ifdef WITH_ACCOUNTING
163 #ifdef WITH_COMMAND_SOCKET
174 * For listening on multiple IP's and ports.
176 typedef struct rad_listen_t rad_listen_t;
177 typedef void (*radlog_func_t)(int, int, REQUEST *, const char *, ...);
179 #define REQUEST_DATA_REGEX (0xadbeef00)
180 #define REQUEST_MAX_REGEX (8)
184 uint32_t magic; /* for debugging only */
186 RADIUS_PACKET *packet;
188 RADIUS_PACKET *proxy;
190 RADIUS_PACKET *reply;
192 RADIUS_PACKET *proxy_reply;
194 VALUE_PAIR *config_items;
195 VALUE_PAIR *username;
196 VALUE_PAIR *password;
198 struct main_config_t *root;
200 request_data_t *data;
202 #ifdef HAVE_PTHREAD_H
206 int number; /* internal server number */
208 rad_listen_t *listener;
210 rad_listen_t *proxy_listener;
214 int simul_max; /* see modcall.c && xlat.c */
215 #ifdef WITH_SESSION_MGMT
217 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
220 int options; /* miscellanous options */
221 const char *module; /* for debugging unresponsive children */
222 const char *component; /* ditto */
224 struct timeval received;
225 struct timeval when; /* to wake up */
230 RAD_LISTEN_TYPE priority;
233 struct timeval next_when;
234 fr_event_callback_t next_callback;
240 radlog_func_t radlog; /* logging function, if set */
243 int num_coa_requests;
245 }; /* REQUEST typedef */
247 #define RAD_REQUEST_OPTION_NONE (0)
248 #define RAD_REQUEST_OPTION_DEBUG (1)
249 #define RAD_REQUEST_OPTION_DEBUG2 (2)
250 #define RAD_REQUEST_OPTION_DEBUG3 (3)
251 #define RAD_REQUEST_OPTION_DEBUG4 (4)
253 #define REQUEST_ACTIVE (1)
254 #define REQUEST_STOP_PROCESSING (2)
255 #define REQUEST_COUNTED (3)
257 #define REQUEST_QUEUED (1)
258 #define REQUEST_RUNNING (2)
259 #define REQUEST_PROXIED (3)
260 #define REQUEST_REJECT_DELAY (4)
261 #define REQUEST_CLEANUP_DELAY (5)
262 #define REQUEST_DONE (6)
265 * Function handler for requests.
267 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
269 typedef struct radclient_list RADCLIENT_LIST;
271 typedef struct pair_list {
277 struct pair_list *next;
278 struct pair_list *lastdefault;
282 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
283 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
284 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
285 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
286 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
288 struct rad_listen_t {
289 struct rad_listen_t *next; /* should be rbtree stuff */
292 * For normal sockets.
294 RAD_LISTEN_TYPE type;
299 rad_listen_recv_t recv;
300 rad_listen_send_t send;
301 rad_listen_encode_t encode;
302 rad_listen_decode_t decode;
303 rad_listen_print_t print;
312 #define RAD_LISTEN_STATUS_INIT (0)
313 #define RAD_LISTEN_STATUS_KNOWN (1)
314 #define RAD_LISTEN_STATUS_CLOSED (2)
315 #define RAD_LISTEN_STATUS_FINISH (3)
317 typedef enum radlog_dest_t {
326 typedef struct main_config_t {
327 struct main_config *next;
329 fr_ipaddr_t myip; /* from the command-line only */
330 int port; /* from the command-line only */
332 int log_auth_badpass;
333 int log_auth_goodpass;
334 int allow_core_dumps;
339 int max_request_time;
342 #ifdef DELETE_BLOCKED_REQUESTS
343 int kill_unresponsive_children;
347 const char *pid_file;
348 rad_listen_t *listen;
351 radlog_dest_t radlog_dest;
352 CONF_SECTION *config;
354 const char *auth_badpass_msg;
355 const char *auth_goodpass_msg;
358 #define DEBUG if(debug_flag)log_debug
359 #define DEBUG2 if (debug_flag > 1)log_debug
360 #define DEBUG3 if (debug_flag > 2)log_debug
361 #define DEBUG4 if (debug_flag > 3)log_debug
364 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
365 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
366 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
367 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
370 #define RDEBUG2 DEBUG2
371 #define RDEBUG3 DEBUG3
372 #define RDEBUG4 DEBUG4
375 #define SECONDS_PER_DAY 86400
376 #define MAX_REQUEST_TIME 30
377 #define CLEANUP_DELAY 5
378 #define MAX_REQUESTS 256
379 #define RETRY_DELAY 5
380 #define RETRY_COUNT 3
381 #define DEAD_TIME 120
396 * This definition of true as NOT false is definitive. :) Making
397 * it '1' can cause problems on stupid platforms. See articles
398 * on C portability for more information.
400 #define TRUE (!FALSE)
403 /* for paircompare_register */
404 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
406 typedef enum request_fail_t {
407 REQUEST_FAIL_UNKNOWN = 0,
408 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
409 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
410 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
411 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
412 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
413 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
414 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
415 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
416 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
417 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
423 * We really shouldn't have this many.
425 extern const char *progname;
426 extern int debug_flag;
427 extern const char *radacct_dir;
428 extern const char *radlog_dir;
429 extern const char *radlib_dir;
430 extern const char *radius_dir;
431 extern const char *radius_libdir;
432 extern uint32_t expiration_seconds;
433 extern int log_stripped_names;
434 extern int log_auth_detail;
435 extern const char *radiusd_version;
436 void radius_signal_self(int flag);
438 #define RADIUS_SIGNAL_SELF_NONE (0)
439 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
440 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
441 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
442 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
443 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
444 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
448 * Function prototypes.
452 int rad_accounting(REQUEST *);
455 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
456 const char *sessionid);
457 int session_zap(REQUEST *request, uint32_t nasaddr,
458 unsigned int port, const char *user,
459 const char *sessionid, uint32_t cliaddr,
460 char proto,int session_time);
464 void debug_pair(VALUE_PAIR *);
465 void debug_pair_list(VALUE_PAIR *);
466 int log_err (char *);
469 void (*reset_signal(int signo, void (*func)(int)))(int);
470 void request_free(REQUEST **request);
471 int rad_mkdir(char *directory, int mode);
472 int rad_checkfilename(const char *filename);
473 void *rad_malloc(size_t size); /* calls exit(1) on error! */
474 REQUEST *request_alloc(void);
475 REQUEST *request_alloc_fake(REQUEST *oldreq);
476 REQUEST *request_alloc_coa(REQUEST *request);
477 int request_data_add(REQUEST *request,
478 void *unique_ptr, int unique_int,
479 void *opaque, void (*free_opaque)(void *));
480 void *request_data_get(REQUEST *request,
481 void *unique_ptr, int unique_int);
482 void *request_data_reference(REQUEST *request,
483 void *unique_ptr, int unique_int);
484 int rad_copy_string(char *dst, const char *src);
485 int rad_copy_variable(char *dst, const char *from);
488 RADCLIENT_LIST *clients_init(void);
489 void clients_free(RADCLIENT_LIST *clients);
490 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
491 void client_free(RADCLIENT *client);
492 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
493 #ifdef WITH_DYNAMIC_CLIENTS
494 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
495 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
497 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
498 const fr_ipaddr_t *ipaddr);
499 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
501 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
502 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
504 RADCLIENT *client_read(const char *filename, int in_server, int flag);
508 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
509 void pairlist_free(PAIR_LIST **);
515 int vradlog(int, const char *, va_list ap);
516 int radlog(int, const char *, ...)
518 __attribute__ ((format (printf, 2, 3)))
521 int log_debug(const char *, ...)
523 __attribute__ ((format (printf, 1, 2)))
526 void vp_listdebug(VALUE_PAIR *vp);
527 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
529 __attribute__ ((format (printf, 4, 5)))
534 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
535 int rad_authenticate (REQUEST *);
536 int rad_postauth(REQUEST *);
539 int radius_exec_program(const char *, REQUEST *, int,
540 char *user_msg, int msg_len,
541 VALUE_PAIR *input_pairs,
542 VALUE_PAIR **output_pairs,
546 int timestr_match(char *, time_t);
549 int paircompare_register(int attr, int otherattr,
550 RAD_COMPARE_FUNC func,
552 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
553 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
555 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
556 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
557 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
558 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
559 VALUE_PAIR **reply_pairs);
560 int radius_find_compare(int attribute);
561 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
562 int attribute, int type);
563 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
564 const char *attribute, const char *value,
568 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
570 int radius_xlat(char * out, int outlen, const char *fmt,
571 REQUEST * request, RADIUS_ESCAPE_STRING func);
572 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
573 int xlat_register(const char *module, RAD_XLAT_FUNC func,
575 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
576 void xlat_free(void);
579 extern int thread_pool_init(CONF_SECTION *cs, int *spawn_flag);
580 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
581 extern pid_t rad_fork(void);
582 extern pid_t rad_waitpid(pid_t pid, int *status);
583 extern int total_active_threads(void);
584 extern void thread_pool_lock(void);
585 extern void thread_pool_unlock(void);
586 extern void thread_pool_queue_stats(int *array);
588 #ifndef HAVE_PTHREAD_H
589 #define rad_fork(n) fork()
590 #define rad_waitpid(a,b) waitpid(a,b, 0)
594 /* Define a global config structure */
595 extern struct main_config_t mainconfig;
597 int read_mainconfig(int reload);
598 int free_mainconfig(void);
599 void hup_mainconfig(void);
600 void fr_suid_down(void);
601 void fr_suid_up(void);
602 void fr_suid_down_permanent(void);
605 void listen_free(rad_listen_t **head);
606 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
607 rad_listen_t *proxy_new_listener(fr_ipaddr_t *ipaddr, int exists);
608 RADCLIENT *client_listener_find(const rad_listen_t *listener,
609 const fr_ipaddr_t *ipaddr, int src_port);
611 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
613 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
617 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
618 void radius_event_free(void);
619 int radius_event_process(void);
620 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
621 int received_request(rad_listen_t *listener,
622 RADIUS_PACKET *packet, REQUEST **prequest,
624 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
625 void event_new_fd(rad_listen_t *listener);
628 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
629 const char **ptr, int evaluate_it, int *presult);
630 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
631 VALUE_PAIR *input_vps, const char *name);
632 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);