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