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