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