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