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