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