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