src/include/radiusd.h

   1 #ifndef RADIUSD_H
   2 #define RADIUSD_H
   3 /*
   4  * radiusd.h    Structures, prototypes and global variables
   5  *              for the FreeRADIUS server.
   6  *
   7  * Version:     $Id$
   8  *
   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.
  13  *
  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.
  18  *
  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
  22  *
  23  * Copyright 1999,2000,2002,2003,2004,2005,2006,2007,2008  The FreeRADIUS server project
  24  *
  25  */
  26
  27 #include <freeradius-devel/ident.h>
  28 RCSIDH(radiusd_h, "$Id$")
  29
  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>
  35
  36 typedef struct auth_req REQUEST;
  37
  38 #include <freeradius-devel/realms.h>
  39
  40 #ifdef HAVE_PTHREAD_H
  41 #include        <pthread.h>
  42 typedef pthread_t child_pid_t;
  43 #define child_kill pthread_kill
  44 #else
  45 typedef pid_t child_pid_t;
  46 #define child_kill kill
  47 #endif
  48
  49 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
  50
  51 #ifndef NDEBUG
  52 #define REQUEST_MAGIC (0xdeadbeef)
  53 #endif
  54
  55 /*
  56  *      See util.c
  57  */
  58 typedef struct request_data_t request_data_t;
  59
  60 typedef struct rad_snmp_client_entry_t rad_snmp_client_entry_t;
  61
  62 typedef struct radclient {
  63         fr_ipaddr_t             ipaddr;
  64         int                     prefix;
  65         char                    *longname;
  66         char                    *secret;
  67         char                    *shortname;
  68         int                     message_authenticator;
  69         char                    *nastype;
  70         char                    *login;
  71         char                    *password;
  72         char                    *server;
  73         int                     number; /* internal use only */
  74         const CONF_SECTION      *cs;
  75 #ifdef WITH_SNMP
  76         rad_snmp_client_entry_t *auth, *acct;
  77 #endif
  78 } RADCLIENT;
  79
  80 /*
  81  *      Types of listeners.
  82  *
  83  *      Ordered by priority!
  84  */
  85 typedef enum RAD_LISTEN_TYPE {
  86         RAD_LISTEN_NONE = 0,
  87         RAD_LISTEN_PROXY,
  88         RAD_LISTEN_AUTH,
  89         RAD_LISTEN_ACCT,
  90         RAD_LISTEN_DETAIL,
  91         RAD_LISTEN_VQP,
  92         RAD_LISTEN_DHCP,
  93         RAD_LISTEN_SNMP,
  94         RAD_LISTEN_MAX
  95 } RAD_LISTEN_TYPE;
  96
  97
  98 /*
  99  *      For listening on multiple IP's and ports.
 100  */
 101 typedef struct rad_listen_t rad_listen_t;
 102
 103 #define REQUEST_DATA_REGEX (0xadbeef00)
 104 #define REQUEST_MAX_REGEX (8)
 105
 106 struct auth_req {
 107 #ifndef NDEBUG
 108         uint32_t                magic; /* for debugging only */
 109 #endif
 110         RADIUS_PACKET           *packet;
 111         RADIUS_PACKET           *proxy;
 112         RADIUS_PACKET           *reply;
 113         RADIUS_PACKET           *proxy_reply;
 114         VALUE_PAIR              *config_items;
 115         VALUE_PAIR              *username;
 116         VALUE_PAIR              *password;
 117
 118         struct main_config_t    *root;
 119
 120         request_data_t          *data;
 121         RADCLIENT               *client;
 122         child_pid_t             child_pid;
 123         time_t                  timestamp;
 124         int                     number; /* internal server number */
 125
 126         rad_listen_t            *listener;
 127         rad_listen_t            *proxy_listener;
 128
 129         int                     simul_max;
 130         int                     simul_count;
 131         int                     simul_mpp; /* WEIRD: 1 is false, 2 is true */
 132
 133         int                     options; /* miscellanous options */
 134         const char              *module; /* for debugging unresponsive children */
 135         const char              *component; /* ditto */
 136
 137         struct timeval          received;
 138         struct timeval          when;           /* to wake up */
 139         int                     delay;
 140
 141         int                     master_state;
 142         int                     child_state;
 143         RAD_LISTEN_TYPE         priority;
 144
 145         fr_event_t              *ev;
 146         struct timeval          next_when;
 147         fr_event_callback_t     next_callback;
 148
 149         int                     in_request_hash;
 150         int                     in_proxy_hash;
 151
 152         home_server             *home_server;
 153         home_pool_t             *home_pool; /* for dynamic failover */
 154
 155         struct timeval          proxy_when;
 156
 157         int                     num_proxied_requests;
 158         int                     num_proxied_responses;
 159
 160         const char              *server;
 161         REQUEST                 *parent;
 162 };                              /* REQUEST typedef */
 163
 164 #define RAD_REQUEST_OPTION_NONE            (0)
 165
 166 #define REQUEST_ACTIVE          (1)
 167 #define REQUEST_STOP_PROCESSING (2)
 168 #define REQUEST_COUNTED         (3)
 169
 170 #define REQUEST_QUEUED          (1)
 171 #define REQUEST_RUNNING         (2)
 172 #define REQUEST_PROXIED         (3)
 173 #define REQUEST_REJECT_DELAY    (4)
 174 #define REQUEST_CLEANUP_DELAY   (5)
 175 #define REQUEST_DONE            (6)
 176
 177 /*
 178  *  Function handler for requests.
 179  */
 180 typedef         int (*RAD_REQUEST_FUNP)(REQUEST *);
 181
 182 typedef struct radclient_list RADCLIENT_LIST;
 183
 184 typedef struct pair_list {
 185         const char              *name;
 186         VALUE_PAIR              *check;
 187         VALUE_PAIR              *reply;
 188         int                     lineno;
 189         int                     order;
 190         struct pair_list        *next;
 191         struct pair_list        *lastdefault;
 192 } PAIR_LIST;
 193
 194
 195 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
 196 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
 197 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
 198 typedef int (*rad_listen_encode_t)(rad_listen_t *, REQUEST *);
 199 typedef int (*rad_listen_decode_t)(rad_listen_t *, REQUEST *);
 200
 201 struct rad_listen_t {
 202         struct rad_listen_t *next; /* should be rbtree stuff */
 203
 204         /*
 205          *      For normal sockets.
 206          */
 207         RAD_LISTEN_TYPE type;
 208         int             fd;
 209         const char      *server;
 210
 211         rad_listen_recv_t recv;
 212         rad_listen_send_t send;
 213         rad_listen_encode_t encode;
 214         rad_listen_decode_t decode;
 215         rad_listen_print_t print;
 216
 217         void            *data;
 218 };
 219
 220
 221 typedef enum radlog_dest_t {
 222   RADLOG_STDOUT = 0,
 223   RADLOG_FILES,
 224   RADLOG_SYSLOG,
 225   RADLOG_STDERR,
 226   RADLOG_NULL,
 227   RADLOG_NUM_DEST
 228 } radlog_dest_t;
 229
 230 typedef struct main_config_t {
 231         struct main_config *next;
 232         int             refcount;
 233         fr_ipaddr_t     myip;   /* from the command-line only */
 234         int             port;   /* from the command-line only */
 235         int             log_auth;
 236         int             log_auth_badpass;
 237         int             log_auth_goodpass;
 238         int             allow_core_dumps;
 239         int             debug_level;
 240         int             proxy_requests;
 241         int             reject_delay;
 242         int             status_server;
 243         int             max_request_time;
 244         int             cleanup_delay;
 245         int             max_requests;
 246 #ifdef DELETE_BLOCKED_REQUESTS
 247         int             kill_unresponsive_children;
 248 #endif
 249         char            *log_file;
 250         char            *checkrad;
 251         const char      *pid_file;
 252         rad_listen_t    *listen;
 253         int             syslog_facility;
 254         int             radlog_fd;
 255         radlog_dest_t   radlog_dest;
 256         CONF_SECTION    *config;
 257         const char      *name;
 258         int             do_snmp;
 259 } MAIN_CONFIG_T;
 260
 261 #define DEBUG   if(debug_flag)log_debug
 262 #define DEBUG2  if (debug_flag > 1)log_debug
 263 #define DEBUG3  if (debug_flag > 2)log_debug
 264
 265 #define SECONDS_PER_DAY         86400
 266 #define MAX_REQUEST_TIME        30
 267 #define CLEANUP_DELAY           5
 268 #define MAX_REQUESTS            256
 269 #define RETRY_DELAY             5
 270 #define RETRY_COUNT             3
 271 #define DEAD_TIME               120
 272
 273 #define L_DBG                   1
 274 #define L_AUTH                  2
 275 #define L_INFO                  3
 276 #define L_ERR                   4
 277 #define L_PROXY                 5
 278 #define L_ACCT                  6
 279 #define L_CONS                  128
 280
 281 #ifndef FALSE
 282 #define FALSE 0
 283 #endif
 284 #ifndef TRUE
 285 /*
 286  *      This definition of true as NOT false is definitive. :) Making
 287  *      it '1' can cause problems on stupid platforms.  See articles
 288  *      on C portability for more information.
 289  */
 290 #define TRUE (!FALSE)
 291 #endif
 292
 293 /* for paircompare_register */
 294 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
 295
 296 typedef enum request_fail_t {
 297   REQUEST_FAIL_UNKNOWN = 0,
 298   REQUEST_FAIL_NO_THREADS,      /* no threads to handle it */
 299   REQUEST_FAIL_DECODE,          /* rad_decode didn't like it */
 300   REQUEST_FAIL_PROXY,           /* call to proxy modules failed */
 301   REQUEST_FAIL_PROXY_SEND,      /* proxy_send didn't like it */
 302   REQUEST_FAIL_NO_RESPONSE,     /* we weren't told to respond, so we reject */
 303   REQUEST_FAIL_HOME_SERVER,     /* the home server didn't respond */
 304   REQUEST_FAIL_HOME_SERVER2,    /* another case of the above */
 305   REQUEST_FAIL_HOME_SERVER3,    /* another case of the above */
 306   REQUEST_FAIL_NORMAL_REJECT,   /* authentication failure */
 307   REQUEST_FAIL_SERVER_TIMEOUT   /* the server took too long to process the request */
 308 } request_fail_t;
 309
 310 /*
 311  *      Global variables.
 312  *
 313  *      We really shouldn't have this many.
 314  */
 315 extern const char       *progname;
 316 extern int              debug_flag;
 317 extern const char       *radacct_dir;
 318 extern const char       *radlog_dir;
 319 extern const char       *radlib_dir;
 320 extern const char       *radius_dir;
 321 extern const char       *radius_libdir;
 322 extern uint32_t         expiration_seconds;
 323 extern int              log_stripped_names;
 324 extern int              log_auth_detail;
 325 extern const char      *radiusd_version;
 326 void                    radius_signal_self(int flag);
 327
 328 #define RADIUS_SIGNAL_SELF_NONE         (0)
 329 #define RADIUS_SIGNAL_SELF_HUP          (1 << 0)
 330 #define RADIUS_SIGNAL_SELF_TERM         (1 << 1)
 331 #define RADIUS_SIGNAL_SELF_EXIT         (1 << 2)
 332 #define RADIUS_SIGNAL_SELF_DETAIL       (1 << 3)
 333 #define RADIUS_SIGNAL_SELF_NEW_FD       (1 << 4)
 334 #define RADIUS_SIGNAL_SELF_MAX          (1 << 5)
 335
 336
 337 /*
 338  *      Function prototypes.
 339  */
 340
 341 /* acct.c */
 342 int             rad_accounting(REQUEST *);
 343
 344 /* session.c */
 345 int             rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
 346                              const char *sessionid);
 347 int             session_zap(REQUEST *request, uint32_t nasaddr,
 348                             unsigned int port, const char *user,
 349                             const char *sessionid, uint32_t cliaddr,
 350                             char proto,int session_time);
 351
 352 /* radiusd.c */
 353 #undef debug_pair
 354 void            debug_pair(VALUE_PAIR *);
 355 void            debug_pair_list(VALUE_PAIR *);
 356 int             log_err (char *);
 357
 358 /* util.c */
 359 void (*reset_signal(int signo, void (*func)(int)))(int);
 360 void            request_free(REQUEST **request);
 361 int             rad_mkdir(char *directory, int mode);
 362 int             rad_checkfilename(const char *filename);
 363 void            *rad_malloc(size_t size); /* calls exit(1) on error! */
 364 REQUEST         *request_alloc(void);
 365 REQUEST         *request_alloc_fake(REQUEST *oldreq);
 366 int             request_data_add(REQUEST *request,
 367                                  void *unique_ptr, int unique_int,
 368                                  void *opaque, void (*free_opaque)(void *));
 369 void            *request_data_get(REQUEST *request,
 370                                   void *unique_ptr, int unique_int);
 371 void            *request_data_reference(REQUEST *request,
 372                                   void *unique_ptr, int unique_int);
 373 int             rad_copy_string(char *dst, const char *src);
 374 int             rad_copy_variable(char *dst, const char *from);
 375
 376 /* client.c */
 377 RADCLIENT_LIST  *clients_init(void);
 378 void            clients_free(RADCLIENT_LIST *clients);
 379 RADCLIENT_LIST  *clients_parse_section(CONF_SECTION *section);
 380 void            client_free(RADCLIENT *client);
 381 int             client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
 382 RADCLIENT       *client_find(const RADCLIENT_LIST *clients,
 383                              const fr_ipaddr_t *ipaddr);
 384 RADCLIENT       *client_findbynumber(const RADCLIENT_LIST *clients,
 385                                      int number);
 386 RADCLIENT       *client_find_old(const fr_ipaddr_t *ipaddr);
 387
 388 /* files.c */
 389 int             pairlist_read(const char *file, PAIR_LIST **list, int complain);
 390 void            pairlist_free(PAIR_LIST **);
 391
 392 /* version.c */
 393 void            version(void);
 394
 395 /* log.c */
 396 int             vradlog(int, const char *, va_list ap);
 397 int             radlog(int, const char *, ...)
 398 #ifdef __GNUC__
 399                 __attribute__ ((format (printf, 2, 3)))
 400 #endif
 401 ;
 402 int             log_debug(const char *, ...)
 403 #ifdef __GNUC__
 404                 __attribute__ ((format (printf, 1, 2)))
 405 #endif
 406 ;
 407 void            vp_listdebug(VALUE_PAIR *vp);
 408
 409 /* auth.c */
 410 char    *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
 411 int             rad_authenticate (REQUEST *);
 412 int             rad_postauth(REQUEST *);
 413
 414 /* exec.c */
 415 int             radius_exec_program(const char *,  REQUEST *, int,
 416                                     char *user_msg, int msg_len,
 417                                     VALUE_PAIR *input_pairs,
 418                                     VALUE_PAIR **output_pairs,
 419                                         int shell_escape);
 420
 421 /* timestr.c */
 422 int             timestr_match(char *, time_t);
 423
 424 /* valuepair.c */
 425 int             paircompare_register(int attr, int otherattr,
 426                                      RAD_COMPARE_FUNC func,
 427                                      void *instance);
 428 void            paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
 429 int             paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
 430                             VALUE_PAIR **reply);
 431 void            pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
 432 int radius_compare_vps(REQUEST *request, VALUE_PAIR *check, VALUE_PAIR *vp);
 433 int radius_callback_compare(REQUEST *req, VALUE_PAIR *request,
 434                             VALUE_PAIR *check, VALUE_PAIR *check_pairs,
 435                             VALUE_PAIR **reply_pairs);
 436 VALUE_PAIR      *radius_paircreate(REQUEST *request, VALUE_PAIR **vps,
 437                                   int attribute, int type);
 438 VALUE_PAIR *radius_pairmake(REQUEST *request, VALUE_PAIR **vps,
 439                             const char *attribute, const char *value,
 440                             int operator);
 441
 442 /* xlat.c */
 443 typedef size_t (*RADIUS_ESCAPE_STRING)(char *out, size_t outlen, const char *in);
 444
 445 int            radius_xlat(char * out, int outlen, const char *fmt,
 446                            REQUEST * request, RADIUS_ESCAPE_STRING func);
 447 typedef size_t (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
 448 int             xlat_register(const char *module, RAD_XLAT_FUNC func,
 449                               void *instance);
 450 void            xlat_unregister(const char *module, RAD_XLAT_FUNC func);
 451 void            xlat_free(void);
 452
 453 /* threads.c */
 454 extern          int thread_pool_init(CONF_SECTION *cs, int spawn_flag);
 455 extern          int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
 456 extern          pid_t rad_fork(void);
 457 extern          pid_t rad_waitpid(pid_t pid, int *status);
 458 extern          int total_active_threads(void);
 459 extern          void thread_pool_lock(void);
 460 extern          void thread_pool_unlock(void);
 461
 462 #ifndef HAVE_PTHREAD_H
 463 #define rad_fork(n) fork()
 464 #define rad_waitpid(a,b) waitpid(a,b, 0)
 465 #endif
 466
 467 /* mainconfig.c */
 468 /* Define a global config structure */
 469 extern struct main_config_t mainconfig;
 470
 471 int read_mainconfig(int reload);
 472 int free_mainconfig(void);
 473
 474 /* listen.c */
 475 void listen_free(rad_listen_t **head);
 476 int listen_init(CONF_SECTION *cs, rad_listen_t **head);
 477 rad_listen_t *proxy_new_listener(void);
 478 RADCLIENT *client_listener_find(const rad_listen_t *listener,
 479                                 const fr_ipaddr_t *ipaddr);
 480
 481 /* event.c */
 482 int radius_event_init(CONF_SECTION *cs, int spawn_flag);
 483 void radius_event_free(void);
 484 int radius_event_process(void);
 485 void radius_handle_request(REQUEST *request, RAD_REQUEST_FUNP fun);
 486 int received_request(rad_listen_t *listener,
 487                      RADIUS_PACKET *packet, REQUEST **prequest,
 488                      RADCLIENT *client);
 489 REQUEST *received_proxy_response(RADIUS_PACKET *packet);
 490
 491 /* evaluate.c */
 492 int radius_evaluate_condition(REQUEST *request, int modreturn, int depth,
 493                               const char **ptr, int evaluate_it, int *presult);
 494 int radius_update_attrlist(REQUEST *request, CONF_SECTION *cs,
 495                            VALUE_PAIR *input_vps, const char *name);
 496 void radius_pairmove(REQUEST *request, VALUE_PAIR **to, VALUE_PAIR *from);
 497 #endif /*RADIUSD_H*/