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