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