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  */
  10 #include "missing.h"
  11 #include "libradius.h"
  12 #include "radpaths.h"
  13 #include "conf.h"
  14 #include "conffile.h"
  15
  16 #include <stdarg.h>
  17
  18 #ifdef HAVE_UNISTD_H
  19 #include <unistd.h>
  20 #endif
  21
  22 #ifdef HAVE_PTHREAD_H
  23 #include        <pthread.h>
  24 typedef pthread_t child_pid_t;
  25 #define child_kill pthread_kill
  26 #else
  27 typedef pid_t child_pid_t;
  28 #define child_kill kill
  29 #endif
  30
  31 #ifdef HAVE_NETINET_IN_H
  32 #include <netinet/in.h>
  33 #endif
  34
  35 #ifdef HAVE_ARPA_INET_H
  36 #include <arpa/inet.h>
  37 #endif
  38
  39
  40 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
  41
  42 #ifndef NDEBUG
  43 #define REQUEST_MAGIC (0xdeadbeef)
  44 #endif
  45
  46 /*
  47  *      See util.c
  48  */
  49 typedef struct request_data_t request_data_t;
  50
  51 /*
  52  *      For listening on multiple IP's and ports.
  53  */
  54 typedef struct rad_listen_t rad_listen_t;
  55
  56 #define REQUEST_DATA_REGEX (0xadbeef00)
  57 #define REQUEST_MAX_REGEX (8)
  58
  59 typedef struct auth_req {
  60 #ifndef NDEBUG
  61         uint32_t                magic; /* for debugging only */
  62 #endif
  63         RADIUS_PACKET           *packet;
  64         RADIUS_PACKET           *proxy;
  65         RADIUS_PACKET           *reply;
  66         RADIUS_PACKET           *proxy_reply;
  67         VALUE_PAIR              *config_items;
  68         VALUE_PAIR              *username;
  69         VALUE_PAIR              *password;
  70
  71         request_data_t          *data;
  72         char                    secret[32];
  73         child_pid_t             child_pid;
  74         time_t                  timestamp;
  75         int                     number; /* internal server number */
  76
  77         rad_listen_t            *listener;
  78         rad_listen_t            *proxy_listener;
  79
  80         /*
  81          *      We could almost keep a const char here instead of a
  82          *      _copy_ of the secret... but what if the RADCLIENT
  83          *      structure is freed because it was taken out of the
  84          *      config file and SIGHUPed?
  85          */
  86         char                    proxysecret[32];
  87         int                     proxy_try_count;
  88         int                     proxy_outstanding;
  89         time_t                  proxy_next_try;
  90
  91         int                     simul_max;
  92         int                     simul_count;
  93         int                     simul_mpp; /* WEIRD: 1 is false, 2 is true */
  94
  95         int                     finished;
  96         int                     options; /* miscellanous options */
  97         const char              *module; /* for debugging unresponsive children */
  98         const char              *component; /* ditto */
  99         void                    *container;
 100 } REQUEST;
 101
 102 #define RAD_REQUEST_OPTION_NONE            (0)
 103 #define RAD_REQUEST_OPTION_LOGGED_CHILD    (1 << 0)
 104 #define RAD_REQUEST_OPTION_DELAYED_REJECT  (1 << 1)
 105 #define RAD_REQUEST_OPTION_DONT_CACHE      (1 << 2)
 106 #define RAD_REQUEST_OPTION_FAKE_REQUEST    (1 << 3)
 107 #define RAD_REQUEST_OPTION_REJECTED        (1 << 4)
 108 #define RAD_REQUEST_OPTION_PROXIED         (1 << 5)
 109 #define RAD_REQUEST_OPTION_STOP_NOW        (1 << 6)
 110 #define RAD_REQUEST_OPTION_REPROCESS       (1 << 7)
 111
 112 /*
 113  *  Function handler for requests.
 114  */
 115 typedef         int (*RAD_REQUEST_FUNP)(REQUEST *);
 116
 117 typedef struct radclient {
 118         lrad_ipaddr_t           ipaddr;
 119         int                     prefix;
 120         char                    *longname;
 121         u_char                  *secret;
 122         char                    *shortname;
 123         char                    *nastype;
 124         char                    *login;
 125         char                    *password;
 126         struct radclient        *next;
 127 } RADCLIENT;
 128
 129 typedef struct nas {
 130         uint32_t                ipaddr;
 131         char                    longname[256];
 132         char                    shortname[32];
 133         char                    nastype[32];
 134         struct nas              *next;
 135 } NAS;
 136
 137 typedef struct _realm {
 138         char                    realm[64];
 139         char                    server[64];
 140         char                    acct_server[64];
 141         lrad_ipaddr_t           ipaddr; /* authentication */
 142         lrad_ipaddr_t           acct_ipaddr;
 143         u_char                  secret[32];
 144         time_t                  last_reply; /* last time we saw a packet */
 145         int                     auth_port;
 146         int                     acct_port;
 147         int                     striprealm;
 148         int                     trusted; /* old */
 149         int                     notrealm;
 150         int                     active; /* is it dead? */
 151         time_t                  wakeup; /* when we should try it again */
 152         int                     acct_active;
 153         time_t                  acct_wakeup;
 154         int                     ldflag;
 155         struct _realm           *next;
 156 } REALM;
 157
 158 typedef struct pair_list {
 159         char                    *name;
 160         VALUE_PAIR              *check;
 161         VALUE_PAIR              *reply;
 162         int                     lineno;
 163         struct pair_list        *next;
 164         struct pair_list        *lastdefault;
 165 } PAIR_LIST;
 166
 167
 168 /*
 169  *      Types of listeners.
 170  *
 171  *      FIXME: Separate ports for proxy auth/acct?
 172  */
 173 typedef enum RAD_LISTEN_TYPE {
 174         RAD_LISTEN_NONE = 0,
 175         RAD_LISTEN_AUTH,
 176         RAD_LISTEN_ACCT,
 177         RAD_LISTEN_PROXY,
 178         RAD_LISTEN_DETAIL
 179 } RAD_LISTEN_TYPE;
 180
 181
 182 struct rad_listen_t {
 183         struct rad_listen_t *next; /* should be rbtree stuff */
 184         /*
 185          *      For normal sockets.
 186          */
 187         RAD_LISTEN_TYPE type;
 188         int             fd;
 189
 190         int             (*recv)(rad_listen_t *,
 191                                 RAD_REQUEST_FUNP *, REQUEST **);
 192         int             (*send)(rad_listen_t *, REQUEST *);
 193
 194         /*
 195          *      For normal sockets.
 196          */
 197         lrad_ipaddr_t   ipaddr;
 198         int             port;
 199
 200         /*
 201          *      For detail file
 202          *
 203          *      FIXME: this stuff should either be in a union,
 204          *      or in a structure allocated per-type...
 205          */
 206         const char      *detail;
 207         VALUE_PAIR      *vps;
 208         FILE            *fp;
 209         int             state;
 210         int             max_outstanding;
 211         int             *outstanding;
 212 };
 213
 214
 215 typedef enum radlog_dest_t {
 216   RADLOG_STDOUT = 0,
 217   RADLOG_FILES,
 218   RADLOG_SYSLOG,
 219   RADLOG_STDERR,
 220   RADLOG_NULL
 221 } radlog_dest_t;
 222
 223 typedef struct main_config_t {
 224         struct main_config *next;
 225         time_t          config_dead_time;
 226         lrad_ipaddr_t   myip;   /* from the command-line only */
 227         int             port;   /* from the command-line only */
 228         int             log_auth;
 229         int             log_auth_badpass;
 230         int             log_auth_goodpass;
 231         int             do_usercollide;
 232 #ifdef WITH_SNMP
 233         int             do_snmp;
 234 #endif
 235         int             allow_core_dumps;
 236         int             debug_level;
 237         int             proxy_requests;
 238         int             post_proxy_authorize;
 239         int             wake_all_if_all_dead;
 240         int             proxy_synchronous;
 241         int             proxy_dead_time;
 242         int             proxy_retry_count;
 243         int             proxy_retry_delay;
 244         int             proxy_fallback;
 245         const char      *proxy_fail_type;
 246         int             reject_delay;
 247         int             status_server;
 248         int             max_request_time;
 249         int             cleanup_delay;
 250         int             max_requests;
 251         int             kill_unresponsive_children;
 252         char            *do_lower_user;
 253         char            *do_lower_pass;
 254         char            *do_nospace_user;
 255         char            *do_nospace_pass;
 256         char            *nospace_time;
 257         char            *log_file;
 258         char            *checkrad;
 259         const char      *pid_file;
 260         const char      *uid_name;
 261         const char      *gid_name;
 262         rad_listen_t    *listen;
 263         int             syslog_facility;
 264         int             radlog_fd;
 265         radlog_dest_t   radlog_dest;
 266         CONF_SECTION    *config;
 267         RADCLIENT       *clients;
 268         REALM           *realms;
 269 } MAIN_CONFIG_T;
 270
 271 #define DEBUG   if(debug_flag)log_debug
 272 #define DEBUG2  if (debug_flag > 1)log_debug
 273 #define DEBUG3  if (debug_flag > 2)log_debug
 274
 275 #define SECONDS_PER_DAY         86400
 276 #define MAX_REQUEST_TIME        30
 277 #define CLEANUP_DELAY           5
 278 #define MAX_REQUESTS            256
 279 #define RETRY_DELAY             5
 280 #define RETRY_COUNT             3
 281 #define DEAD_TIME               120
 282
 283 #define L_DBG                   1
 284 #define L_AUTH                  2
 285 #define L_INFO                  3
 286 #define L_ERR                   4
 287 #define L_PROXY                 5
 288 #define L_CONS                  128
 289
 290 #ifndef FALSE
 291 #define FALSE 0
 292 #endif
 293 #ifndef TRUE
 294 /*
 295  *      This definition of true as NOT false is definitive. :) Making
 296  *      it '1' can cause problems on stupid platforms.  See articles
 297  *      on C portability for more information.
 298  */
 299 #define TRUE (!FALSE)
 300 #endif
 301
 302 /* for paircompare_register */
 303 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
 304
 305 typedef enum request_fail_t {
 306   REQUEST_FAIL_UNKNOWN = 0,
 307   REQUEST_FAIL_NO_THREADS,      /* no threads to handle it */
 308   REQUEST_FAIL_DECODE,          /* rad_decode didn't like it */
 309   REQUEST_FAIL_PROXY,           /* call to proxy modules failed */
 310   REQUEST_FAIL_PROXY_SEND,      /* proxy_send didn't like it */
 311   REQUEST_FAIL_NO_RESPONSE,     /* we weren't told to respond, so we reject */
 312   REQUEST_FAIL_HOME_SERVER,     /* the home server didn't respond */
 313   REQUEST_FAIL_HOME_SERVER2,    /* another case of the above */
 314   REQUEST_FAIL_HOME_SERVER3,    /* another case of the above */
 315   REQUEST_FAIL_NORMAL_REJECT,   /* authentication failure */
 316   REQUEST_FAIL_SERVER_TIMEOUT   /* the server took too long to process the request */
 317 } request_fail_t;
 318
 319 /*
 320  *      Global variables.
 321  *
 322  *      We really shouldn't have this many.
 323  */
 324 extern const char       *progname;
 325 extern int              debug_flag;
 326 extern const char       *radacct_dir;
 327 extern const char       *radlog_dir;
 328 extern const char       *radlib_dir;
 329 extern const char       *radius_dir;
 330 extern const char       *radius_libdir;
 331 extern uint32_t         expiration_seconds;
 332 extern int              log_stripped_names;
 333 extern int              log_auth_detail;
 334 extern const char      *radiusd_version;
 335
 336 /*
 337  *      Function prototypes.
 338  */
 339
 340 /* acct.c */
 341 int             rad_accounting(REQUEST *);
 342
 343 /* session.c */
 344 int             rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
 345                              const char *sessionid);
 346 int             session_zap(REQUEST *request, uint32_t nasaddr,
 347                             unsigned int port, const char *user,
 348                             const char *sessionid, uint32_t cliaddr,
 349                             char proto,int session_time);
 350
 351 /* radiusd.c */
 352 #ifndef _LIBRADIUS
 353 void            debug_pair(FILE *, VALUE_PAIR *);
 354 #endif
 355 int             log_err (char *);
 356
 357 /* util.c */
 358 void (*reset_signal(int signo, void (*func)(int)))(int);
 359 void            request_free(REQUEST **request);
 360 int             rad_mkdir(char *directory, int mode);
 361 int             rad_checkfilename(const char *filename);
 362 void            *rad_malloc(size_t size); /* calls exit(1) on error! */
 363 REQUEST         *request_alloc(void);
 364 REQUEST         *request_alloc_fake(REQUEST *oldreq);
 365 int             request_data_add(REQUEST *request,
 366                                  void *unique_ptr, int unique_int,
 367                                  void *opaque, void (*free_opaque)(void *));
 368 void            *request_data_get(REQUEST *request,
 369                                   void *unique_ptr, int unique_int);
 370 int             rad_copy_string(char *dst, const char *src);
 371 int             rad_copy_variable(char *dst, const char *from);
 372
 373 /* request_process.c */
 374 int rad_respond(REQUEST *request, RAD_REQUEST_FUNP fun);
 375 void            request_reject(REQUEST *request, request_fail_t reason);
 376 void            rfc_clean(RADIUS_PACKET *packet);
 377
 378 /* client.c */
 379 int             read_clients_file(const char *file);
 380 RADCLIENT       *client_find(const lrad_ipaddr_t *ipaddr);
 381 const char      *client_name(const lrad_ipaddr_t *ipaddr);
 382 void            clients_free(RADCLIENT *cl);
 383
 384 /* files.c */
 385 REALM           *realm_find(const char *, int);
 386 REALM           *realm_findbyaddr(uint32_t ipno, int port);
 387 void            realm_free(REALM *cl);
 388 void            realm_disable(uint32_t ipno, int port);
 389 int             pairlist_read(const char *file, PAIR_LIST **list, int complain);
 390 void            pairlist_free(PAIR_LIST **);
 391 int             read_config_files(void);
 392 int             read_realms_file(const char *file);
 393
 394 /* nas.c */
 395 int             read_naslist_file(char *);
 396 NAS             *nas_find(uint32_t ipno);
 397
 398 /* version.c */
 399 void            version(void);
 400
 401 /* log.c */
 402 int             vradlog(int, const char *, va_list ap);
 403 int             radlog(int, const char *, ...)
 404 #ifdef __GNUC__
 405                 __attribute__ ((format (printf, 2, 3)))
 406 #endif
 407 ;
 408 int             log_debug(const char *, ...)
 409 #ifdef __GNUC__
 410                 __attribute__ ((format (printf, 1, 2)))
 411 #endif
 412 ;
 413 void            vp_listdebug(VALUE_PAIR *vp);
 414
 415 /* proxy.c */
 416 int proxy_receive(REQUEST *request);
 417 int proxy_send(REQUEST *request);
 418
 419 /* auth.c */
 420 char    *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
 421 int             rad_authenticate (REQUEST *);
 422 int             rad_check_password(REQUEST *request);
 423 int             rad_postauth(REQUEST *);
 424
 425 /* exec.c */
 426 int             radius_exec_program(const char *,  REQUEST *, int,
 427                                     char *user_msg, int msg_len,
 428                                     VALUE_PAIR *input_pairs,
 429                                     VALUE_PAIR **output_pairs,
 430                                         int shell_escape);
 431
 432 /* timestr.c */
 433 int             timestr_match(char *, time_t);
 434
 435 /* valuepair.c */
 436 int             paircompare_register(int attr, int otherattr,
 437                                      RAD_COMPARE_FUNC func,
 438                                      void *instance);
 439 void            paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
 440 int             paircmp(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
 441                         VALUE_PAIR **reply);
 442 int             simplepaircmp(REQUEST *, VALUE_PAIR *, VALUE_PAIR *);
 443 void            pair_builtincompare_init(void);
 444 void            pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
 445
 446 /* xlat.c */
 447 typedef int (*RADIUS_ESCAPE_STRING)(char *out, int outlen, const char *in);
 448
 449 int            radius_xlat(char * out, int outlen, const char *fmt,
 450                            REQUEST * request, RADIUS_ESCAPE_STRING func);
 451 typedef int (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
 452 int             xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance);
 453 void            xlat_unregister(const char *module, RAD_XLAT_FUNC func);
 454
 455
 456 /* threads.c */
 457 extern          int thread_pool_init(int spawn_flag);
 458 extern          int thread_pool_clean(time_t now);
 459 extern          int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
 460 extern          pid_t rad_fork(int exec_wait);
 461 extern          pid_t rad_waitpid(pid_t pid, int *status, int options);
 462 extern          int total_active_threads(void);
 463
 464 #ifndef HAVE_PTHREAD_H
 465 #define rad_fork(n) fork()
 466 #define rad_waitpid waitpid
 467 #endif
 468
 469 /* mainconfig.c */
 470 /* Define a global config structure */
 471 extern struct main_config_t mainconfig;
 472
 473 int read_mainconfig(int reload);
 474 int free_mainconfig(void);
 475 CONF_SECTION *read_radius_conf_file(void); /* for radwho and friends. */
 476
 477 /* listen.c */
 478 void listen_free(rad_listen_t **head);
 479 int listen_init(const char *filename, rad_listen_t **head);
 480 rad_listen_t *proxy_new_listener(void);
 481
 482 #endif /*RADIUSD_H*/