4 * radiusd.h Structures, prototypes and global variables
5 * for the FreeRADIUS server.
11 #include <freeradius-devel/ident.h>
12 RCSIDH(radiusd_h, "$Id$")
14 #include <freeradius-devel/libradius.h>
15 #include <freeradius-devel/radpaths.h>
16 #include <freeradius-devel/conf.h>
17 #include <freeradius-devel/conffile.h>
18 #include <freeradius-devel/event.h>
20 typedef struct auth_req REQUEST;
22 #include <freeradius-devel/realms.h>
26 typedef pthread_t child_pid_t;
27 #define child_kill pthread_kill
29 typedef pid_t child_pid_t;
30 #define child_kill kill
33 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
36 #define REQUEST_MAGIC (0xdeadbeef)
42 typedef struct request_data_t request_data_t;
45 * For listening on multiple IP's and ports.
47 typedef struct rad_listen_t rad_listen_t;
49 #define REQUEST_DATA_REGEX (0xadbeef00)
50 #define REQUEST_MAX_REGEX (8)
54 uint32_t magic; /* for debugging only */
56 RADIUS_PACKET *packet;
59 RADIUS_PACKET *proxy_reply;
60 VALUE_PAIR *config_items;
66 child_pid_t child_pid;
68 int number; /* internal server number */
70 rad_listen_t *listener;
71 rad_listen_t *proxy_listener;
75 int simul_mpp; /* WEIRD: 1 is false, 2 is true */
77 int options; /* miscellanous options */
78 const char *module; /* for debugging unresponsive children */
79 const char *component; /* ditto */
81 struct timeval received;
82 struct timeval when; /* to wake up */
88 struct timeval next_when;
89 lrad_event_callback_t next_callback;
94 home_server *home_server;
95 home_pool_t *home_pool; /* for dynamic failover */
97 struct timeval proxy_when;
99 int num_proxied_requests;
100 int num_proxied_responses;
102 }; /* REQUEST typedef */
104 #define RAD_REQUEST_OPTION_NONE (0)
106 #define REQUEST_ACTIVE (1)
107 #define REQUEST_STOP_PROCESSING (2)
109 #define REQUEST_QUEUED (1)
110 #define REQUEST_RUNNING (2)
111 #define REQUEST_PROXIED (3)
112 #define REQUEST_REJECT_DELAY (4)
113 #define REQUEST_CLEANUP_DELAY (5)
114 #define REQUEST_DONE (6)
117 * Function handler for requests.
119 typedef int (*RAD_REQUEST_FUNP)(REQUEST *);
121 typedef struct radclient {
122 lrad_ipaddr_t ipaddr;
130 int number; /* internal use only */
133 typedef struct radclient_list RADCLIENT_LIST;
135 typedef struct pair_list {
141 struct pair_list *next;
142 struct pair_list *lastdefault;
147 * Types of listeners.
149 * FIXME: Separate ports for proxy auth/acct?
151 typedef enum RAD_LISTEN_TYPE {
161 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
162 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
163 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
164 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
165 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
167 struct rad_listen_t {
168 struct rad_listen_t *next; /* should be rbtree stuff */
171 * For normal sockets.
173 RAD_LISTEN_TYPE type;
175 const char *identity;
177 rad_listen_recv_t recv;
178 rad_listen_send_t send;
179 rad_listen_encode_t encode;
180 rad_listen_decode_t decode;
181 rad_listen_print_t print;
187 typedef enum radlog_dest_t {
196 typedef struct main_config_t {
197 struct main_config *next;
198 time_t config_dead_time;
199 lrad_ipaddr_t myip; /* from the command-line only */
200 int port; /* from the command-line only */
202 int log_auth_badpass;
203 int log_auth_goodpass;
207 int allow_core_dumps;
210 int wake_all_if_all_dead;
211 int proxy_synchronous;
213 int proxy_retry_count;
214 int proxy_retry_delay;
216 const char *proxy_fail_type;
219 int max_request_time;
222 #ifdef DELETE_BLOCKED_REQUESTS
223 int kill_unresponsive_children;
227 const char *pid_file;
228 const char *uid_name;
229 const char *gid_name;
230 rad_listen_t *listen;
233 radlog_dest_t radlog_dest;
234 CONF_SECTION *config;
235 RADCLIENT_LIST *clients;
236 const char *radiusd_conf;
239 #define DEBUG if(debug_flag)log_debug
240 #define DEBUG2 if (debug_flag > 1)log_debug
241 #define DEBUG3 if (debug_flag > 2)log_debug
243 #define SECONDS_PER_DAY 86400
244 #define MAX_REQUEST_TIME 30
245 #define CLEANUP_DELAY 5
246 #define MAX_REQUESTS 256
247 #define RETRY_DELAY 5
248 #define RETRY_COUNT 3
249 #define DEAD_TIME 120
264 * This definition of true as NOT false is definitive. :) Making
265 * it '1' can cause problems on stupid platforms. See articles
266 * on C portability for more information.
268 #define TRUE (!FALSE)
271 /* for paircompare_register */
272 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
274 typedef enum request_fail_t {
275 REQUEST_FAIL_UNKNOWN = 0,
276 REQUEST_FAIL_NO_THREADS, /* no threads to handle it */
277 REQUEST_FAIL_DECODE, /* rad_decode didn't like it */
278 REQUEST_FAIL_PROXY, /* call to proxy modules failed */
279 REQUEST_FAIL_PROXY_SEND, /* proxy_send didn't like it */
280 REQUEST_FAIL_NO_RESPONSE, /* we weren't told to respond, so we reject */
281 REQUEST_FAIL_HOME_SERVER, /* the home server didn't respond */
282 REQUEST_FAIL_HOME_SERVER2, /* another case of the above */
283 REQUEST_FAIL_HOME_SERVER3, /* another case of the above */
284 REQUEST_FAIL_NORMAL_REJECT, /* authentication failure */
285 REQUEST_FAIL_SERVER_TIMEOUT /* the server took too long to process the request */
291 * We really shouldn't have this many.
293 extern const char *progname;
294 extern int debug_flag;
295 extern const char *radacct_dir;
296 extern const char *radlog_dir;
297 extern const char *radlib_dir;
298 extern const char *radius_dir;
299 extern const char *radius_libdir;
300 extern uint32_t expiration_seconds;
301 extern int log_stripped_names;
302 extern int log_auth_detail;
303 extern const char *radiusd_version;
306 * Function prototypes.
310 int rad_accounting(REQUEST *);
313 int rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
314 const char *sessionid);
315 int session_zap(REQUEST *request, uint32_t nasaddr,
316 unsigned int port, const char *user,
317 const char *sessionid, uint32_t cliaddr,
318 char proto,int session_time);
322 void debug_pair(FILE *, VALUE_PAIR *);
324 int log_err (char *);
327 void (*reset_signal(int signo, void (*func)(int)))(int);
328 void request_free(REQUEST **request);
329 int rad_mkdir(char *directory, int mode);
330 int rad_checkfilename(const char *filename);
331 void *rad_malloc(size_t size); /* calls exit(1) on error! */
332 REQUEST *request_alloc(void);
333 REQUEST *request_alloc_fake(REQUEST *oldreq);
334 int request_data_add(REQUEST *request,
335 void *unique_ptr, int unique_int,
336 void *opaque, void (*free_opaque)(void *));
337 void *request_data_get(REQUEST *request,
338 void *unique_ptr, int unique_int);
339 void *request_data_reference(REQUEST *request,
340 void *unique_ptr, int unique_int);
341 int rad_copy_string(char *dst, const char *src);
342 int rad_copy_variable(char *dst, const char *from);
344 /* request_process.c */
345 int rad_respond(REQUEST *request, RAD_REQUEST_FUNP fun);
346 void request_reject(REQUEST *request, request_fail_t reason);
349 RADCLIENT_LIST *clients_init(void);
350 void clients_free(RADCLIENT_LIST *clients);
351 RADCLIENT_LIST *clients_parse_section(const char *filename,
352 CONF_SECTION *section);
353 void client_free(RADCLIENT *client);
354 int client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
355 RADCLIENT *client_find(const RADCLIENT_LIST *clients,
356 const lrad_ipaddr_t *ipaddr);
357 const char *client_name(const RADCLIENT_LIST *clients,
358 const lrad_ipaddr_t *ipaddr);
359 RADCLIENT *client_findbynumber(const RADCLIENT_LIST *clients,
361 RADCLIENT *client_find_old(const lrad_ipaddr_t *ipaddr);
362 const char *client_name_old(const lrad_ipaddr_t *ipaddr);
365 int pairlist_read(const char *file, PAIR_LIST **list, int complain);
366 void pairlist_free(PAIR_LIST **);
367 int read_config_files(void);
373 int vradlog(int, const char *, va_list ap);
374 int radlog(int, const char *, ...)
376 __attribute__ ((format (printf, 2, 3)))
379 int log_debug(const char *, ...)
381 __attribute__ ((format (printf, 1, 2)))
384 void vp_listdebug(VALUE_PAIR *vp);
387 int proxy_receive(REQUEST *request);
388 int proxy_send(REQUEST *request);
391 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
392 int rad_authenticate (REQUEST *);
393 int rad_postauth(REQUEST *);
396 int radius_exec_program(const char *, REQUEST *, int,
397 char *user_msg, int msg_len,
398 VALUE_PAIR *input_pairs,
399 VALUE_PAIR **output_pairs,
403 int timestr_match(char *, time_t);
406 int paircompare_register(int attr, int otherattr,
407 RAD_COMPARE_FUNC func,
409 void paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
410 int paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
412 int simplepaircmp(REQUEST *, VALUE_PAIR *, VALUE_PAIR *);
413 void pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
416 typedef int (*RADIUS_ESCAPE_STRING)(char *out, int outlen, const char *in);
418 int radius_xlat(char * out, int outlen, const char *fmt,
419 REQUEST * request, RADIUS_ESCAPE_STRING func);
420 typedef int (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
421 int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance);
422 void xlat_unregister(const char *module, RAD_XLAT_FUNC func);
426 extern int thread_pool_init(int spawn_flag);
427 extern int thread_pool_clean(time_t now);
428 extern int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
429 extern pid_t rad_fork(void);
430 extern pid_t rad_waitpid(pid_t pid, int *status);
431 extern int total_active_threads(void);
433 #ifndef HAVE_PTHREAD_H
434 #define rad_fork(n) fork()
435 #define rad_waitpid(a,b) waitpid(a,b, 0)
439 /* Define a global config structure */
440 extern struct main_config_t mainconfig;
442 int read_mainconfig(int reload);
443 int free_mainconfig(void);
446 void listen_free(rad_listen_t **head);
447 int listen_init(const char *filename, rad_listen_t **head);
448 rad_listen_t *proxy_new_listener(void);
451 int radius_event_init(int spawn_flag);
452 void radius_event_free(void);
453 int radius_event_process(struct timeval **pptv);
454 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
455 int received_request(rad_listen_t *listener,
456 RADIUS_PACKET *packet, REQUEST **prequest,
457 const RADCLIENT *client);
458 REQUEST *received_proxy_response(RADIUS_PACKET *packet);