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