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
103 /*#include "realms.h"*/
109 typedef struct request_data_t request_data_t;
111 typedef struct radclient {
117 int message_authenticator;
123 const CONF_SECTION *cs;
126 #ifdef WITH_ACCOUNTING
131 #ifdef WITH_DYNAMIC_CLIENTS
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
173 #include <sys/time.h>
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 radlog_func_t radlog; /* logging function, if set */
246 int num_coa_requests;
248 }; /* REQUEST typedef */
250 #define RAD_REQUEST_OPTION_NONE (0)
251 #define RAD_REQUEST_OPTION_DEBUG (1)
252 #define RAD_REQUEST_OPTION_DEBUG2 (2)
253 #define RAD_REQUEST_OPTION_DEBUG3 (3)
254 #define RAD_REQUEST_OPTION_DEBUG4 (4)
256 #define REQUEST_ACTIVE (1)
257 #define REQUEST_STOP_PROCESSING (2)
258 #define REQUEST_COUNTED (3)
260 #define REQUEST_QUEUED (1)
261 #define REQUEST_RUNNING (2)
262 #define REQUEST_PROXIED (3)
263 #define REQUEST_REJECT_DELAY (4)
264 #define REQUEST_CLEANUP_DELAY (5)
265 #define REQUEST_DONE (6)
268 * Function handler for requests.
270 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
272 typedef struct radclient_list RADCLIENT_LIST;
274 typedef struct pair_list {
280 struct pair_list *next;
281 struct pair_list *lastdefault;
285 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
286 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
287 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
288 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
289 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
291 struct rad_listen_t {
292 struct rad_listen_t *next; /* should be rbtree stuff */
295 * For normal sockets.
297 RAD_LISTEN_TYPE type;
302 rad_listen_recv_t recv;
303 rad_listen_send_t send;
304 rad_listen_encode_t encode;
305 rad_listen_decode_t decode;
306 rad_listen_print_t print;
315 #define RAD_LISTEN_STATUS_INIT (0)
316 #define RAD_LISTEN_STATUS_KNOWN (1)
317 #define RAD_LISTEN_STATUS_CLOSED (2)
318 #define RAD_LISTEN_STATUS_FINISH (3)
320 typedef enum radlog_dest_t {
329 typedef struct main_config_t {
330 struct main_config *next;
332 fr_ipaddr_t myip; /* from the command-line only */
333 int port; /* from the command-line only */
335 int log_auth_badpass;
336 int log_auth_goodpass;
337 int allow_core_dumps;
342 int max_request_time;
345 #ifdef DELETE_BLOCKED_REQUESTS
346 int kill_unresponsive_children;
350 const char *pid_file;
351 rad_listen_t *listen;
354 radlog_dest_t radlog_dest;
355 CONF_SECTION *config;
357 const char *auth_badpass_msg;
358 const char *auth_goodpass_msg;
361 #define DEBUG if(debug_flag)log_debug
362 #define DEBUG2 if (debug_flag > 1)log_debug
363 #define DEBUG3 if (debug_flag > 2)log_debug
364 #define DEBUG4 if (debug_flag > 3)log_debug
367 #define RDEBUG(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 1, request, fmt, ## __VA_ARGS__)
368 #define RDEBUG2(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 2, request, fmt, ## __VA_ARGS__)
369 #define RDEBUG3(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 3, request, fmt, ## __VA_ARGS__)
370 #define RDEBUG4(fmt, ...) if(request && request->radlog) request->radlog(L_DBG, 4, request, fmt, ## __VA_ARGS__)
373 #define RDEBUG2 DEBUG2
374 #define RDEBUG3 DEBUG3
375 #define RDEBUG4 DEBUG4
378 #define SECONDS_PER_DAY 86400
379 #define MAX_REQUEST_TIME 30
380 #define CLEANUP_DELAY 5
381 #define MAX_REQUESTS 256
382 #define RETRY_DELAY 5
383 #define RETRY_COUNT 3
384 #define DEAD_TIME 120
399 * This definition of true as NOT false is definitive. :) Making
400 * it '1' can cause problems on stupid platforms. See articles
401 * on C portability for more information.
403 #define TRUE (!FALSE)
406 /* for paircompare_register */
407 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
409 typedef enum request_fail_t {
410 REQUEST_FAIL_UNKNOWN = 0,
411 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
412 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
413 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
414 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
415 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
416 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
417 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
418 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
419 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
420 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
426 * We really shouldn't have this many.
428 extern const char *progname;
429 extern int debug_flag;
430 extern const char *radacct_dir;
431 extern const char *radlog_dir;
432 extern const char *radlib_dir;
433 extern const char *radius_dir;
434 extern const char *radius_libdir;
435 extern uint32_t expiration_seconds;
436 extern int log_stripped_names;
437 extern int log_auth_detail;
438 extern const char *radiusd_version;
439 void radius_signal_self(int flag);
441 #define RADIUS_SIGNAL_SELF_NONE (0)
442 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
443 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
444 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
445 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
446 #define RADIUS_SIGNAL_SELF_NEW_FD (1 << 4)
447 #define RADIUS_SIGNAL_SELF_MAX (1 << 5)
451 * Function prototypes.
455 int rad_accounting(REQUEST *);
458 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
459 const char *sessionid);
460 int session_zap(REQUEST *request, uint32_t nasaddr,
461 unsigned int port, const char *user,
462 const char *sessionid, uint32_t cliaddr,
463 char proto,int session_time);
467 void debug_pair(VALUE_PAIR *);
468 void debug_pair_list(VALUE_PAIR *);
469 int log_err (char *);
472 void (*reset_signal(int signo, void (*func)(int)))(int);
473 void request_free(REQUEST **request);
474 int rad_mkdir(char *directory, int mode);
475 int rad_checkfilename(const char *filename);
476 void *rad_malloc(size_t size); /* calls exit(1) on error! */
477 REQUEST *request_alloc(void);
478 REQUEST *request_alloc_fake(REQUEST *oldreq);
479 REQUEST *request_alloc_coa(REQUEST *request);
480 int request_data_add(REQUEST *request,
481 void *unique_ptr, int unique_int,
482 void *opaque, void (*free_opaque)(void *));
483 void *request_data_get(REQUEST *request,
484 void *unique_ptr, int unique_int);
485 void *request_data_reference(REQUEST *request,
486 void *unique_ptr, int unique_int);
487 int rad_copy_string(char *dst, const char *src);
488 int rad_copy_variable(char *dst, const char *from);
491 RADCLIENT_LIST *clients_init(void);
492 void clients_free(RADCLIENT_LIST *clients);
493 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
494 void client_free(RADCLIENT *client);
495 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
496 #ifdef WITH_DYNAMIC_CLIENTS
497 void client_delete(RADCLIENT_LIST *clients, RADCLIENT *client);
498 RADCLIENT *client_create(RADCLIENT_LIST *clients, REQUEST *request);
500 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
501 const fr_ipaddr_t *ipaddr);
502 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
504 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
505 int client_validate(RADCLIENT_LIST *clients, RADCLIENT *master,
507 RADCLIENT *client_read(const char *filename, int in_server, int flag);
511 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
512 void pairlist_free(PAIR_LIST **);
518 int vradlog(int, const char *, va_list ap);
519 int radlog(int, const char *, ...)
521 __attribute__ ((format (printf, 2, 3)))
524 int log_debug(const char *, ...)
526 __attribute__ ((format (printf, 1, 2)))
529 void vp_listdebug(VALUE_PAIR *vp);
530 void radlog_request(int lvl, int priority, REQUEST *request, const char *msg, ...)
532 __attribute__ ((format (printf, 4, 5)))
537 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
538 int rad_authenticate (REQUEST *);
539 int rad_postauth(REQUEST *);
542 int radius_exec_program(const char *, REQUEST *, int,
543 char *user_msg, int msg_len,
544 VALUE_PAIR *input_pairs,
545 VALUE_PAIR **output_pairs,
549 int timestr_match(char *, time_t);
552 int paircompare_register(int attr, int otherattr,
553 RAD_COMPARE_FUNC func,
555 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
556 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
558 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
559 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
560 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
561 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
562 VALUE_PAIR **reply_pairs);
563 int radius_find_compare(int attribute);
564 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
565 int attribute, int type);
566 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
567 const char *attribute, const char *value,
571 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
573 int radius_xlat(char * out, int outlen, const char *fmt,
574 REQUEST * request, RADIUS_ESCAPE_STRING func);
575 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
576 int xlat_register(const char *module, RAD_XLAT_FUNC func,
578 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
579 void xlat_free(void);
582 extern int thread_pool_init(CONF_SECTION *cs, int *spawn_flag);
583 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
584 extern pid_t rad_fork(void);
585 extern pid_t rad_waitpid(pid_t pid, int *status);
586 extern int total_active_threads(void);
587 extern void thread_pool_lock(void);
588 extern void thread_pool_unlock(void);
589 extern void thread_pool_queue_stats(int *array);
591 #ifndef HAVE_PTHREAD_H
592 #define rad_fork(n) fork()
593 #define rad_waitpid(a,b) waitpid(a,b, 0)
597 /* Define a global config structure */
598 extern struct main_config_t mainconfig;
600 int read_mainconfig(int reload);
601 int free_mainconfig(void);
602 void hup_mainconfig(void);
603 void fr_suid_down(void);
604 void fr_suid_up(void);
605 void fr_suid_down_permanent(void);
608 void listen_free(rad_listen_t **head);
609 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
610 rad_listen_t *proxy_new_listener(fr_ipaddr_t *ipaddr, int exists);
611 RADCLIENT *client_listener_find(const rad_listen_t *listener,
612 const fr_ipaddr_t *ipaddr, int src_port);
614 RADCLIENT_LIST *listener_find_client_list(const fr_ipaddr_t *ipaddr,
616 rad_listen_t *listener_find_byipaddr(const fr_ipaddr_t *ipaddr, int port);
620 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
621 void radius_event_free(void);
622 int radius_event_process(void);
623 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
624 int received_request(rad_listen_t *listener,
625 RADIUS_PACKET *packet, REQUEST **prequest,
627 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
628 void event_new_fd(rad_listen_t *listener);
631 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
632 const char **ptr, int evaluate_it, int *presult);
633 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
634 VALUE_PAIR *input_vps, const char *name);
635 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);