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