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;
38 #include <freeradius-devel/realms.h>
42 typedef pthread_t child_pid_t;
43 #define child_kill pthread_kill
45 typedef pid_t child_pid_t;
46 #define child_kill kill
49 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
52 #define REQUEST_MAGIC (0xdeadbeef)
58 typedef struct request_data_t request_data_t;
60 typedef struct rad_snmp_client_entry_t rad_snmp_client_entry_t;
62 typedef struct radclient {
68 int message_authenticator;
73 int number; /* internal use only */
74 const CONF_SECTION *cs;
76 rad_snmp_client_entry_t *auth, *acct;
83 * Ordered by priority!
85 typedef enum RAD_LISTEN_TYPE {
98 * For listening on multiple IP's and ports.
100 typedef struct rad_listen_t rad_listen_t;
102 #define REQUEST_DATA_REGEX (0xadbeef00)
103 #define REQUEST_MAX_REGEX (8)
107 uint32_t magic; /* for debugging only */
109 RADIUS_PACKET *packet;
110 RADIUS_PACKET *proxy;
111 RADIUS_PACKET *reply;
112 RADIUS_PACKET *proxy_reply;
113 VALUE_PAIR *config_items;
114 VALUE_PAIR *username;
115 VALUE_PAIR *password;
117 struct main_config_t *root;
119 request_data_t *data;
121 child_pid_t child_pid;
123 int number; /* internal server number */
125 rad_listen_t *listener;
126 rad_listen_t *proxy_listener;
130 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
132 int options; /* miscellanous options */
133 const char *module; /* for debugging unresponsive children */
134 const char *component; /* ditto */
136 struct timeval received;
137 struct timeval when; /* to wake up */
142 RAD_LISTEN_TYPE priority;
145 struct timeval next_when;
146 fr_event_callback_t next_callback;
151 home_server *home_server;
152 home_pool_t *home_pool; /* for dynamic failover */
154 struct timeval proxy_when;
156 int num_proxied_requests;
157 int num_proxied_responses;
161 }; /* REQUEST typedef */
163 #define RAD_REQUEST_OPTION_NONE (0)
165 #define REQUEST_ACTIVE (1)
166 #define REQUEST_STOP_PROCESSING (2)
167 #define REQUEST_COUNTED (3)
169 #define REQUEST_QUEUED (1)
170 #define REQUEST_RUNNING (2)
171 #define REQUEST_PROXIED (3)
172 #define REQUEST_REJECT_DELAY (4)
173 #define REQUEST_CLEANUP_DELAY (5)
174 #define REQUEST_DONE (6)
177 * Function handler for requests.
179 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
181 typedef struct radclient_list RADCLIENT_LIST;
183 typedef struct pair_list {
189 struct pair_list *next;
190 struct pair_list *lastdefault;
194 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
195 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
196 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
197 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
198 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
200 struct rad_listen_t {
201 struct rad_listen_t *next; /* should be rbtree stuff */
204 * For normal sockets.
206 RAD_LISTEN_TYPE type;
210 rad_listen_recv_t recv;
211 rad_listen_send_t send;
212 rad_listen_encode_t encode;
213 rad_listen_decode_t decode;
214 rad_listen_print_t print;
220 typedef enum radlog_dest_t {
229 typedef struct main_config_t {
230 struct main_config *next;
232 fr_ipaddr_t myip; /* from the command-line only */
233 int port; /* from the command-line only */
235 int log_auth_badpass;
236 int log_auth_goodpass;
237 int allow_core_dumps;
242 int max_request_time;
245 #ifdef DELETE_BLOCKED_REQUESTS
246 int kill_unresponsive_children;
250 const char *pid_file;
251 rad_listen_t *listen;
254 radlog_dest_t radlog_dest;
255 CONF_SECTION *config;
260 #define DEBUG if(debug_flag)log_debug
261 #define DEBUG2 if (debug_flag > 1)log_debug
262 #define DEBUG3 if (debug_flag > 2)log_debug
264 #define SECONDS_PER_DAY 86400
265 #define MAX_REQUEST_TIME 30
266 #define CLEANUP_DELAY 5
267 #define MAX_REQUESTS 256
268 #define RETRY_DELAY 5
269 #define RETRY_COUNT 3
270 #define DEAD_TIME 120
285 * This definition of true as NOT false is definitive. :) Making
286 * it '1' can cause problems on stupid platforms. See articles
287 * on C portability for more information.
289 #define TRUE (!FALSE)
292 /* for paircompare_register */
293 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
295 typedef enum request_fail_t {
296 REQUEST_FAIL_UNKNOWN = 0,
297 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
298 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
299 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
300 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
301 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
302 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
303 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
304 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
305 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
306 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
312 * We really shouldn't have this many.
314 extern const char *progname;
315 extern int debug_flag;
316 extern const char *radacct_dir;
317 extern const char *radlog_dir;
318 extern const char *radlib_dir;
319 extern const char *radius_dir;
320 extern const char *radius_libdir;
321 extern uint32_t expiration_seconds;
322 extern int log_stripped_names;
323 extern int log_auth_detail;
324 extern const char *radiusd_version;
325 void radius_signal_self(int flag);
327 #define RADIUS_SIGNAL_SELF_NONE (0)
328 #define RADIUS_SIGNAL_SELF_HUP (1 << 0)
329 #define RADIUS_SIGNAL_SELF_TERM (1 << 1)
330 #define RADIUS_SIGNAL_SELF_EXIT (1 << 2)
331 #define RADIUS_SIGNAL_SELF_DETAIL (1 << 3)
335 * Function prototypes.
339 int rad_accounting(REQUEST *);
342 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
343 const char *sessionid);
344 int session_zap(REQUEST *request, uint32_t nasaddr,
345 unsigned int port, const char *user,
346 const char *sessionid, uint32_t cliaddr,
347 char proto,int session_time);
351 void debug_pair(FILE *, VALUE_PAIR *);
353 int log_err (char *);
356 void (*reset_signal(int signo, void (*func)(int)))(int);
357 void request_free(REQUEST **request);
358 int rad_mkdir(char *directory, int mode);
359 int rad_checkfilename(const char *filename);
360 void *rad_malloc(size_t size); /* calls exit(1) on error! */
361 REQUEST *request_alloc(void);
362 REQUEST *request_alloc_fake(REQUEST *oldreq);
363 int request_data_add(REQUEST *request,
364 void *unique_ptr, int unique_int,
365 void *opaque, void (*free_opaque)(void *));
366 void *request_data_get(REQUEST *request,
367 void *unique_ptr, int unique_int);
368 void *request_data_reference(REQUEST *request,
369 void *unique_ptr, int unique_int);
370 int rad_copy_string(char *dst, const char *src);
371 int rad_copy_variable(char *dst, const char *from);
374 RADCLIENT_LIST *clients_init(void);
375 void clients_free(RADCLIENT_LIST *clients);
376 RADCLIENT_LIST *clients_parse_section(CONF_SECTION *section);
377 void client_free(RADCLIENT *client);
378 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
379 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
380 const fr_ipaddr_t *ipaddr);
381 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
383 RADCLIENT *client_find_old(const fr_ipaddr_t *ipaddr);
386 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
387 void pairlist_free(PAIR_LIST **);
393 int vradlog(int, const char *, va_list ap);
394 int radlog(int, const char *, ...)
396 __attribute__ ((format (printf, 2, 3)))
399 int log_debug(const char *, ...)
401 __attribute__ ((format (printf, 1, 2)))
404 void vp_listdebug(VALUE_PAIR *vp);
407 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
408 int rad_authenticate (REQUEST *);
409 int rad_postauth(REQUEST *);
412 int radius_exec_program(const char *, REQUEST *, int,
413 char *user_msg, int msg_len,
414 VALUE_PAIR *input_pairs,
415 VALUE_PAIR **output_pairs,
419 int timestr_match(char *, time_t);
422 int paircompare_register(int attr, int otherattr,
423 RAD_COMPARE_FUNC func,
425 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
426 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
428 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
429 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
430 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
431 VALUE_PAIR *check, VALUE_PAIR *check_pairs,
432 VALUE_PAIR **reply_pairs);
433 VALUE_PAIR *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
434 int attribute, int type);
435 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
436 const char *attribute, const char *value,
440 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
442 int radius_xlat(char * out, int outlen, const char *fmt,
443 REQUEST * request, RADIUS_ESCAPE_STRING func);
444 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
445 int xlat_register(const char *module, RAD_XLAT_FUNC func,
447 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
448 void xlat_free(void);
451 extern int thread_pool_init(CONF_SECTION *cs, int spawn_flag);
452 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
453 extern pid_t rad_fork(void);
454 extern pid_t rad_waitpid(pid_t pid, int *status);
455 extern int total_active_threads(void);
456 extern void thread_pool_lock(void);
457 extern void thread_pool_unlock(void);
459 #ifndef HAVE_PTHREAD_H
460 #define rad_fork(n) fork()
461 #define rad_waitpid(a,b) waitpid(a,b, 0)
465 /* Define a global config structure */
466 extern struct main_config_t mainconfig;
468 int read_mainconfig(int reload);
469 int free_mainconfig(void);
472 void listen_free(rad_listen_t **head);
473 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
474 rad_listen_t *proxy_new_listener(void);
477 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
478 void radius_event_free(void);
479 int radius_event_process(void);
480 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
481 int received_request(rad_listen_t *listener,
482 RADIUS_PACKET *packet, REQUEST **prequest,
484 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
487 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
488 const char **ptr, int evaluate_it, int *presult);
489 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
490 VALUE_PAIR *input_vps, const char *name);