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