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