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