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