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 <freeradius-devel/missing.h>
  11 #include <freeradius-devel/libradius.h>
  12 #include <freeradius-devel/radpaths.h>
  13 #include <freeradius-devel/conf.h>
  14 #include <freeradius-devel/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 #define NO_SUCH_CHILD_PID (child_pid_t) (0)
  36
  37 #ifndef NDEBUG
  38 #define REQUEST_MAGIC (0xdeadbeef)
  39 #endif
  40
  41 /*
  42  *      See util.c
  43  */
  44 typedef struct request_data_t request_data_t;
  45
  46 /*
  47  *      For listening on multiple IP's and ports.
  48  */
  49 typedef struct rad_listen_t rad_listen_t;
  50
  51 /*
  52  *      For request lists.
  53  */
  54 typedef struct request_list_t request_list_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_start_time;
  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         char                    *secret;
 122         char                    *shortname;
 123         char                    *nastype;
 124         char                    *login;
 125         char                    *password;
 126         int                     number; /* internal use only */
 127 } RADCLIENT;
 128
 129 typedef struct radclient_list RADCLIENT_LIST;
 130
 131 typedef struct _realm {
 132         char                    realm[64];
 133         char                    server[64];
 134         char                    acct_server[64];
 135         lrad_ipaddr_t           ipaddr; /* authentication */
 136         lrad_ipaddr_t           acct_ipaddr;
 137         char                    secret[32];
 138         time_t                  last_reply; /* last time we saw a packet */
 139         int                     auth_port;
 140         int                     acct_port;
 141         int                     striprealm;
 142         int                     trusted; /* old */
 143         int                     notrealm;
 144         int                     active; /* is it dead? */
 145         time_t                  wakeup; /* when we should try it again */
 146         int                     acct_active;
 147         time_t                  acct_wakeup;
 148         int                     ldflag;
 149         struct _realm           *next;
 150 } REALM;
 151
 152 typedef struct pair_list {
 153         char                    *name;
 154         VALUE_PAIR              *check;
 155         VALUE_PAIR              *reply;
 156         int                     lineno;
 157         struct pair_list        *next;
 158         struct pair_list        *lastdefault;
 159 } PAIR_LIST;
 160
 161
 162 /*
 163  *      Types of listeners.
 164  *
 165  *      FIXME: Separate ports for proxy auth/acct?
 166  */
 167 typedef enum RAD_LISTEN_TYPE {
 168         RAD_LISTEN_NONE = 0,
 169         RAD_LISTEN_AUTH,
 170         RAD_LISTEN_ACCT,
 171         RAD_LISTEN_PROXY,
 172         RAD_LISTEN_DETAIL,
 173         RAD_LISTEN_MAX
 174 } RAD_LISTEN_TYPE;
 175
 176 typedef int (*rad_listen_recv_t)(rad_listen_t *, RAD_REQUEST_FUNP *, REQUEST **);
 177 typedef int (*rad_listen_send_t)(rad_listen_t *, REQUEST *);
 178 typedef int (*rad_listen_update_t)(rad_listen_t *, time_t);
 179 typedef int (*rad_listen_print_t)(rad_listen_t *, char *, size_t);
 180
 181 struct rad_listen_t {
 182         struct rad_listen_t *next; /* should be rbtree stuff */
 183         /*
 184          *      For normal sockets.
 185          */
 186         RAD_LISTEN_TYPE type;
 187         int             fd;
 188         const char      *identity;
 189         request_list_t  *rl;
 190
 191         rad_listen_recv_t recv;
 192         rad_listen_send_t send;
 193         rad_listen_update_t update;
 194         rad_listen_print_t print;
 195
 196         void            *data;
 197 };
 198
 199
 200 typedef enum radlog_dest_t {
 201   RADLOG_STDOUT = 0,
 202   RADLOG_FILES,
 203   RADLOG_SYSLOG,
 204   RADLOG_STDERR,
 205   RADLOG_NULL,
 206   RADLOG_NUM_DEST
 207 } radlog_dest_t;
 208
 209 typedef struct main_config_t {
 210         struct main_config *next;
 211         time_t          config_dead_time;
 212         lrad_ipaddr_t   myip;   /* from the command-line only */
 213         int             port;   /* from the command-line only */
 214         int             log_auth;
 215         int             log_auth_badpass;
 216         int             log_auth_goodpass;
 217 #ifdef WITH_SNMP
 218         int             do_snmp;
 219 #endif
 220         int             allow_core_dumps;
 221         int             debug_level;
 222         int             proxy_requests;
 223         int             wake_all_if_all_dead;
 224         int             proxy_synchronous;
 225         int             proxy_dead_time;
 226         int             proxy_retry_count;
 227         int             proxy_retry_delay;
 228         int             proxy_fallback;
 229         const char      *proxy_fail_type;
 230         int             reject_delay;
 231         int             status_server;
 232         int             max_request_time;
 233         int             cleanup_delay;
 234         int             max_requests;
 235         int             kill_unresponsive_children;
 236         char            *log_file;
 237         char            *checkrad;
 238         const char      *pid_file;
 239         const char      *uid_name;
 240         const char      *gid_name;
 241         rad_listen_t    *listen;
 242         int             syslog_facility;
 243         int             radlog_fd;
 244         radlog_dest_t   radlog_dest;
 245         CONF_SECTION    *config;
 246         RADCLIENT_LIST  *clients;
 247         REALM           *realms;
 248         const char      *radiusd_conf;
 249 } MAIN_CONFIG_T;
 250
 251 #define DEBUG   if(debug_flag)log_debug
 252 #define DEBUG2  if (debug_flag > 1)log_debug
 253 #define DEBUG3  if (debug_flag > 2)log_debug
 254
 255 #define SECONDS_PER_DAY         86400
 256 #define MAX_REQUEST_TIME        30
 257 #define CLEANUP_DELAY           5
 258 #define MAX_REQUESTS            256
 259 #define RETRY_DELAY             5
 260 #define RETRY_COUNT             3
 261 #define DEAD_TIME               120
 262
 263 #define L_DBG                   1
 264 #define L_AUTH                  2
 265 #define L_INFO                  3
 266 #define L_ERR                   4
 267 #define L_PROXY                 5
 268 #define L_CONS                  128
 269
 270 #ifndef FALSE
 271 #define FALSE 0
 272 #endif
 273 #ifndef TRUE
 274 /*
 275  *      This definition of true as NOT false is definitive. :) Making
 276  *      it '1' can cause problems on stupid platforms.  See articles
 277  *      on C portability for more information.
 278  */
 279 #define TRUE (!FALSE)
 280 #endif
 281
 282 /* for paircompare_register */
 283 typedef int (*RAD_COMPARE_FUNC)(void *instance, REQUEST *,VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
 284
 285 typedef enum request_fail_t {
 286   REQUEST_FAIL_UNKNOWN = 0,
 287   REQUEST_FAIL_NO_THREADS,      /* no threads to handle it */
 288   REQUEST_FAIL_DECODE,          /* rad_decode didn't like it */
 289   REQUEST_FAIL_PROXY,           /* call to proxy modules failed */
 290   REQUEST_FAIL_PROXY_SEND,      /* proxy_send didn't like it */
 291   REQUEST_FAIL_NO_RESPONSE,     /* we weren't told to respond, so we reject */
 292   REQUEST_FAIL_HOME_SERVER,     /* the home server didn't respond */
 293   REQUEST_FAIL_HOME_SERVER2,    /* another case of the above */
 294   REQUEST_FAIL_HOME_SERVER3,    /* another case of the above */
 295   REQUEST_FAIL_NORMAL_REJECT,   /* authentication failure */
 296   REQUEST_FAIL_SERVER_TIMEOUT   /* the server took too long to process the request */
 297 } request_fail_t;
 298
 299 /*
 300  *      Global variables.
 301  *
 302  *      We really shouldn't have this many.
 303  */
 304 extern const char       *progname;
 305 extern int              debug_flag;
 306 extern const char       *radacct_dir;
 307 extern const char       *radlog_dir;
 308 extern const char       *radlib_dir;
 309 extern const char       *radius_dir;
 310 extern const char       *radius_libdir;
 311 extern uint32_t         expiration_seconds;
 312 extern int              log_stripped_names;
 313 extern int              log_auth_detail;
 314 extern const char      *radiusd_version;
 315
 316 /*
 317  *      Function prototypes.
 318  */
 319
 320 /* acct.c */
 321 int             rad_accounting(REQUEST *);
 322
 323 /* session.c */
 324 int             rad_check_ts(uint32_t nasaddr, unsigned int port, const char *user,
 325                              const char *sessionid);
 326 int             session_zap(REQUEST *request, uint32_t nasaddr,
 327                             unsigned int port, const char *user,
 328                             const char *sessionid, uint32_t cliaddr,
 329                             char proto,int session_time);
 330
 331 /* radiusd.c */
 332 #ifndef _LIBRADIUS
 333 void            debug_pair(FILE *, VALUE_PAIR *);
 334 #endif
 335 int             log_err (char *);
 336
 337 /* util.c */
 338 void (*reset_signal(int signo, void (*func)(int)))(int);
 339 void            request_free(REQUEST **request);
 340 int             rad_mkdir(char *directory, int mode);
 341 int             rad_checkfilename(const char *filename);
 342 void            *rad_malloc(size_t size); /* calls exit(1) on error! */
 343 REQUEST         *request_alloc(void);
 344 REQUEST         *request_alloc_fake(REQUEST *oldreq);
 345 int             request_data_add(REQUEST *request,
 346                                  void *unique_ptr, int unique_int,
 347                                  void *opaque, void (*free_opaque)(void *));
 348 void            *request_data_get(REQUEST *request,
 349                                   void *unique_ptr, int unique_int);
 350 int             rad_copy_string(char *dst, const char *src);
 351 int             rad_copy_variable(char *dst, const char *from);
 352
 353 /* request_process.c */
 354 int rad_respond(REQUEST *request, RAD_REQUEST_FUNP fun);
 355 void            request_reject(REQUEST *request, request_fail_t reason);
 356 void            rfc_clean(RADIUS_PACKET *packet);
 357
 358 /* client.c */
 359 RADCLIENT_LIST  *clients_init(void);
 360 void            clients_free(RADCLIENT_LIST *clients);
 361 RADCLIENT_LIST  *clients_parse_section(const char *filename,
 362                                        CONF_SECTION *section);
 363 void            client_free(RADCLIENT *client);
 364 int             client_add(RADCLIENT_LIST *clients, RADCLIENT *client);
 365 RADCLIENT       *client_find(const RADCLIENT_LIST *clients,
 366                              const lrad_ipaddr_t *ipaddr);
 367 const char      *client_name(const RADCLIENT_LIST *clients,
 368                              const lrad_ipaddr_t *ipaddr);
 369 RADCLIENT       *client_findbynumber(const RADCLIENT_LIST *clients,
 370                                      int number);
 371 RADCLIENT       *client_find_old(const lrad_ipaddr_t *ipaddr);
 372 const char      *client_name_old(const lrad_ipaddr_t *ipaddr);
 373
 374 /* files.c */
 375 REALM           *realm_find(const char *, int);
 376 REALM           *realm_findbyaddr(uint32_t ipno, int port);
 377 void            realm_free(REALM *cl);
 378 void            realm_disable(REQUEST *);
 379 int             pairlist_read(const char *file, PAIR_LIST **list, int complain);
 380 void            pairlist_free(PAIR_LIST **);
 381 int             read_config_files(void);
 382 int             read_realms_file(const char *file);
 383
 384 /* version.c */
 385 void            version(void);
 386
 387 /* log.c */
 388 int             vradlog(int, const char *, va_list ap);
 389 int             radlog(int, const char *, ...)
 390 #ifdef __GNUC__
 391                 __attribute__ ((format (printf, 2, 3)))
 392 #endif
 393 ;
 394 int             log_debug(const char *, ...)
 395 #ifdef __GNUC__
 396                 __attribute__ ((format (printf, 1, 2)))
 397 #endif
 398 ;
 399 void            vp_listdebug(VALUE_PAIR *vp);
 400
 401 /* proxy.c */
 402 int proxy_receive(REQUEST *request);
 403 int proxy_send(REQUEST *request);
 404
 405 /* auth.c */
 406 char    *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli);
 407 int             rad_authenticate (REQUEST *);
 408 int             rad_postauth(REQUEST *);
 409
 410 /* exec.c */
 411 int             radius_exec_program(const char *,  REQUEST *, int,
 412                                     char *user_msg, int msg_len,
 413                                     VALUE_PAIR *input_pairs,
 414                                     VALUE_PAIR **output_pairs,
 415                                         int shell_escape);
 416
 417 /* timestr.c */
 418 int             timestr_match(char *, time_t);
 419
 420 /* valuepair.c */
 421 int             paircompare_register(int attr, int otherattr,
 422                                      RAD_COMPARE_FUNC func,
 423                                      void *instance);
 424 void            paircompare_unregister(int attr, RAD_COMPARE_FUNC func);
 425 int             paircompare(REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
 426                             VALUE_PAIR **reply);
 427 int             simplepaircmp(REQUEST *, VALUE_PAIR *, VALUE_PAIR *);
 428 void            pair_builtincompare_init(void);
 429 void            pairxlatmove(REQUEST *, VALUE_PAIR **to, VALUE_PAIR **from);
 430
 431 /* xlat.c */
 432 typedef int (*RADIUS_ESCAPE_STRING)(char *out, int outlen, const char *in);
 433
 434 int            radius_xlat(char * out, int outlen, const char *fmt,
 435                            REQUEST * request, RADIUS_ESCAPE_STRING func);
 436 typedef int (*RAD_XLAT_FUNC)(void *instance, REQUEST *, char *, char *, size_t, RADIUS_ESCAPE_STRING func);
 437 int             xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance);
 438 void            xlat_unregister(const char *module, RAD_XLAT_FUNC func);
 439
 440
 441 /* threads.c */
 442 extern          int thread_pool_init(int spawn_flag);
 443 extern          int thread_pool_clean(time_t now);
 444 extern          int thread_pool_addrequest(REQUEST *, RAD_REQUEST_FUNP);
 445 extern          pid_t rad_fork(int exec_wait);
 446 extern          pid_t rad_waitpid(pid_t pid, int *status, int options);
 447 extern          int total_active_threads(void);
 448
 449 #ifndef HAVE_PTHREAD_H
 450 #define rad_fork(n) fork()
 451 #define rad_waitpid waitpid
 452 #endif
 453
 454 /* mainconfig.c */
 455 /* Define a global config structure */
 456 extern struct main_config_t mainconfig;
 457
 458 int read_mainconfig(int reload);
 459 int free_mainconfig(void);
 460
 461 /* listen.c */
 462 void listen_free(rad_listen_t **head);
 463 int listen_init(const char *filename, rad_listen_t **head);
 464 rad_listen_t *proxy_new_listener(void);
 465
 466 #endif /*RADIUSD_H*/