src/include/libradius.h

   1 #ifndef LIBRADIUS_H
   2 #define LIBRADIUS_H
   3
   4 /*
   5  * libradius.h  Structures and prototypes
   6  *              for the radius library.
   7  *
   8  * Version:     $Id$
   9  *
  10  *   This program is free software; you can redistribute it and/or modify
  11  *   it under the terms of the GNU General Public License as published by
  12  *   the Free Software Foundation; either version 2 of the License, or
  13  *   (at your option) any later version.
  14  *
  15  *   This program is distributed in the hope that it will be useful,
  16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *   GNU General Public License for more details.
  19  *
  20  *   You should have received a copy of the GNU General Public License
  21  *   along with this program; if not, write to the Free Software
  22  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  23  *
  24  * Copyright 2001,2002,2003,2004,2005,2006  The FreeRADIUS server project
  25  */
  26
  27 #include <freeradius-devel/ident.h>
  28 RCSIDH(libradius_h, "$Id$")
  29
  30 #ifdef HAVE_SYS_TYPES_H
  31 #include <sys/types.h>
  32 #endif
  33
  34 #ifdef HAVE_STDINT_H
  35 #include <stdint.h>
  36 #endif
  37
  38 #ifdef HAVE_INTTYPES_H
  39 #include <inttypes.h>
  40 #endif
  41
  42 #ifdef HAVE_ERRNO_H
  43 #include <errno.h>
  44 #endif
  45
  46 #ifdef HAVE_NETINET_IN_H
  47 #include        <netinet/in.h>
  48 #endif
  49
  50 #ifdef HAVE_ARPA_INET_H
  51 #include        <arpa/inet.h>
  52 #endif
  53
  54 #ifdef HAVE_SYS_SOCKET_H
  55 #include        <sys/socket.h>
  56 #endif
  57
  58 #include <stdio.h>
  59 #include <stdarg.h>
  60
  61 /*
  62  *  Check for inclusion of <time.h>, versus <sys/time.h>
  63  *  Taken verbatim from the autoconf manual.
  64  */
  65 #if TIME_WITH_SYS_TIME
  66 # include <sys/time.h>
  67 # include <time.h>
  68 #else
  69 # ifdef HAVE_SYS_TIME_H
  70 #  include <sys/time.h>
  71 # else
  72 #  include <time.h>
  73 # endif
  74 #endif
  75
  76 #include <freeradius-devel/radius.h>
  77 #include <freeradius-devel/token.h>
  78 #include <freeradius-devel/hash.h>
  79
  80 #ifdef SIZEOF_UNSIGNED_INT
  81 #if SIZEOF_UNSIGNED_INT != 4
  82 #error FATAL: sizeof(unsigned int) != 4
  83 #endif
  84 #endif
  85
  86 /*
  87  *  Include for modules.
  88  */
  89 #include <freeradius-devel/sha1.h>
  90 #include <freeradius-devel/md4.h>
  91
  92 #define EAP_START               2
  93
  94 #define AUTH_VECTOR_LEN         16
  95 #define CHAP_VALUE_LENGTH       16
  96 #define MAX_STRING_LEN          254     /* RFC2138: string 0-253 octets */
  97
  98 #  define VENDOR(x)             ((x >> 16) & 0x7fff)
  99
 100 #ifdef _LIBRADIUS
 101 #  define AUTH_HDR_LEN          20
 102 #  define VENDORPEC_USR         429
 103 #define VENDORPEC_LUCENT        4846
 104 #define VENDORPEC_STARENT       8164
 105 #  define DEBUG                 if (librad_debug) printf
 106 #  define debug_pair(vp)        do { if (librad_debug) { \
 107                                         putchar('\t'); \
 108                                         vp_print(stdout, vp); \
 109                                         putchar('\n'); \
 110                                      } \
 111                                 } while(0)
 112 #  define TAG_VALID(x)          ((x) > 0 && (x) < 0x20)
 113 #  define TAG_VALID_ZERO(x)     ((x) < 0x20)
 114 #  define TAG_ANY               -128   /* minimum signed char */
 115 #endif
 116
 117 #if defined(__GNUC__)
 118 # define PRINTF_LIKE(n) __attribute__ ((format(printf, n, n+1)))
 119 # define NEVER_RETURNS __attribute__ ((noreturn))
 120 # define UNUSED __attribute__ ((unused))
 121 # define BLANK_FORMAT " "       /* GCC_LINT whines about empty formats */
 122 #else
 123 # define PRINTF_LIKE(n) /* ignore */
 124 # define NEVER_RETURNS /* ignore */
 125 # define UNUSED /* ignore */
 126 # define BLANK_FORMAT ""
 127 #endif
 128
 129 typedef struct attr_flags {
 130         unsigned int            addport : 1;  /* add NAS-Port to IP address */
 131         unsigned int            has_tag : 1;  /* tagged attribute */
 132         unsigned int            do_xlat : 1;  /* strvalue is dynamic */
 133         unsigned int            caseless : 1; /* case insensitive compares */
 134         unsigned int            array : 1; /* pack multiples into 1 attr */
 135         unsigned int            has_value : 1; /* has a value */
 136         unsigned int            has_value_alias : 1; /* has a value alias */
 137
 138         int8_t                  tag;          /* tag for tunneled attributes */
 139         uint8_t                 encrypt;      /* encryption method */
 140 } ATTR_FLAGS;
 141
 142 /*
 143  *  Values of the encryption flags.
 144  */
 145 #define FLAG_ENCRYPT_NONE            (0)
 146 #define FLAG_ENCRYPT_USER_PASSWORD   (1)
 147 #define FLAG_ENCRYPT_TUNNEL_PASSWORD (2)
 148 #define FLAG_ENCRYPT_ASCEND_SECRET   (3)
 149
 150 typedef struct dict_attr {
 151         char                    name[40];
 152         int                     attr;
 153         int                     type;
 154         int                     vendor;
 155         ATTR_FLAGS              flags;
 156 } DICT_ATTR;
 157
 158 typedef struct dict_value {
 159         int                     attr;
 160         int                     value;
 161         char                    name[1];
 162 } DICT_VALUE;
 163
 164 typedef struct dict_vendor {
 165         int                     vendorpec;
 166         int                     type; /* length of type data */
 167         int                     length; /* length of length data */
 168         char                    name[1];
 169 } DICT_VENDOR;
 170
 171 typedef struct value_pair {
 172         char                    name[40];
 173         int                     attribute;
 174         int                     vendor;
 175         int                     type;
 176         int                     length; /* of data */
 177         LRAD_TOKEN              operator;
 178         uint32_t                lvalue; /* DELETE ME ASAP */
 179         ATTR_FLAGS              flags;
 180         struct value_pair       *next;
 181         union {
 182                 char                    strvalue[MAX_STRING_LEN];
 183                 uint8_t                 octets[MAX_STRING_LEN];
 184                 struct in_addr          ipaddr;
 185                 struct in6_addr         ipv6addr;
 186                 uint32_t                date;
 187                 uint32_t                integer;
 188                 uint8_t                 filter[32];
 189                 uint8_t                 ifid[8]; /* struct? */
 190                 uint8_t                 ipv6prefix[18]; /* struct? */
 191         } data;
 192 } VALUE_PAIR;
 193 #define vp_strvalue   data.strvalue
 194 #define vp_octets     data.octets
 195 #define vp_ipaddr     lvalue
 196 #define vp_ipv6addr   data.ipv6addr
 197 #define vp_date       lvalue
 198 #define vp_integer    lvalue
 199 #define vp_ifid       data.ifid
 200 #define vp_ipv6prefix data.ipv6prefix
 201 #define vp_filter     data.filter
 202
 203
 204 typedef struct lrad_ipaddr_t {
 205         int             af;     /* address family */
 206         union {
 207                 struct in_addr  ip4addr;
 208                 struct in6_addr ip6addr; /* maybe defined in missing.h */
 209         } ipaddr;
 210 } lrad_ipaddr_t;
 211
 212
 213 /*
 214  *      vector:         Request authenticator from access-request packet
 215  *                      Put in there by rad_decode, and must be put in the
 216  *                      response RADIUS_PACKET as well before calling rad_send
 217  *
 218  *      verified:       Filled in by rad_decode for accounting-request packets
 219  *
 220  *      data,data_len:  Used between rad_recv and rad_decode.
 221  */
 222 typedef struct radius_packet {
 223         int                     sockfd;
 224         lrad_ipaddr_t           src_ipaddr;
 225         lrad_ipaddr_t           dst_ipaddr;
 226         uint16_t                src_port;
 227         uint16_t                dst_port;
 228         int                     id;
 229         unsigned int            code;
 230         uint8_t                 vector[AUTH_VECTOR_LEN];
 231         time_t                  timestamp;
 232         int                     verified;
 233         uint8_t                 *data;
 234         int                     data_len;
 235         VALUE_PAIR              *vps;
 236         uint32_t                hash;
 237 } RADIUS_PACKET;
 238
 239 /*
 240  *      Printing functions.
 241  */
 242 void            librad_safeprint(char *in, int inlen, char *out, int outlen);
 243 int     vp_prints_value(char *out, int outlen, VALUE_PAIR *vp,int delimitst);
 244 int     vp_prints(char *out, int outlen, VALUE_PAIR *vp);
 245 void            vp_print(FILE *, VALUE_PAIR *);
 246 void            vp_printlist(FILE *, VALUE_PAIR *);
 247 #define         fprint_attr_val vp_print
 248
 249 /*
 250  *      Dictionary functions.
 251  */
 252 int             dict_addvendor(const char *name, int value);
 253 int             dict_addattr(const char *name, int vendor, int type, int value, ATTR_FLAGS flags);
 254 int             dict_addvalue(const char *namestr, const char *attrstr, int value);
 255 int             dict_init(const char *dir, const char *fn);
 256 void            dict_free(void);
 257 DICT_ATTR       *dict_attrbyvalue(int attr);
 258 DICT_ATTR       *dict_attrbyname(const char *attr);
 259 DICT_VALUE      *dict_valbyattr(int attr, int val);
 260 DICT_VALUE      *dict_valbyname(int attr, const char *val);
 261 int             dict_vendorbyname(const char *name);
 262 DICT_VENDOR     *dict_vendorbyvalue(int vendor);
 263
 264 #if 1 /* FIXME: compat */
 265 #define dict_attrget    dict_attrbyvalue
 266 #define dict_attrfind   dict_attrbyname
 267 #define dict_valfind    dict_valbyname
 268 /*#define dict_valget   dict_valbyattr almost but not quite*/
 269 #endif
 270
 271 /* get around diffrent ctime_r styles */
 272 #ifdef CTIMERSTYLE
 273 #if CTIMERSTYLE == SOLARISSTYLE
 274 #define CTIME_R(a,b,c) ctime_r(a,b,c)
 275 #else
 276 #define CTIME_R(a,b,c) ctime_r(a,b)
 277 #endif
 278 #else
 279 #define CTIME_R(a,b,c) ctime_r(a,b)
 280 #endif
 281
 282 /* md5.c */
 283
 284 void            librad_md5_calc(uint8_t *, const uint8_t *, unsigned int);
 285
 286 /* hmac.c */
 287
 288 void lrad_hmac_md5(const uint8_t *text, int text_len,
 289                    const uint8_t *key, int key_len,
 290                    unsigned char *digest);
 291
 292 /* hmacsha1.c */
 293
 294 void lrad_hmac_sha1(const uint8_t *text, int text_len,
 295                     const uint8_t *key, int key_len,
 296                     uint8_t *digest);
 297
 298 /* radius.c */
 299 int             rad_send(RADIUS_PACKET *, const RADIUS_PACKET *, const char *secret);
 300 int             rad_packet_ok(RADIUS_PACKET *packet);
 301 RADIUS_PACKET   *rad_recv(int fd);
 302 int             rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
 303                            const char *secret);
 304 int             rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, const char *secret);
 305 int             rad_encode(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
 306                            const char *secret);
 307 int             rad_sign(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
 308                          const char *secret);
 309
 310 RADIUS_PACKET   *rad_alloc(int newvector);
 311 void            rad_free(RADIUS_PACKET **);
 312 int             rad_pwencode(char *encpw, int *len, const char *secret,
 313                              const uint8_t *vector);
 314 int             rad_pwdecode(char *encpw, int len, const char *secret,
 315                              const uint8_t *vector);
 316 int             rad_tunnel_pwencode(char *encpw, int *len, const char *secret,
 317                                     const uint8_t *vector);
 318 int             rad_tunnel_pwdecode(uint8_t *encpw, int *len,
 319                                     const char *secret, const uint8_t *vector);
 320 int             rad_chap_encode(RADIUS_PACKET *packet, uint8_t *output,
 321                                 int id, VALUE_PAIR *password);
 322 VALUE_PAIR      *rad_attr2vp(const RADIUS_PACKET *packet, const RADIUS_PACKET *original,
 323                              const char *secret, int attribute, int length,
 324                              const uint8_t *data);
 325 int             rad_vp2attr(const RADIUS_PACKET *packet,
 326                             const RADIUS_PACKET *original, const char *secret,
 327                             const VALUE_PAIR *vp, uint8_t *ptr);
 328
 329 /* valuepair.c */
 330 VALUE_PAIR      *paircreate(int attr, int type);
 331 void            pairfree(VALUE_PAIR **);
 332 void            pairbasicfree(VALUE_PAIR *pair);
 333 VALUE_PAIR      *pairfind(VALUE_PAIR *, int);
 334 void            pairdelete(VALUE_PAIR **, int);
 335 void            pairadd(VALUE_PAIR **, VALUE_PAIR *);
 336 void            pairreplace(VALUE_PAIR **first, VALUE_PAIR *add);
 337 int             paircmp(VALUE_PAIR *check, VALUE_PAIR *data);
 338 VALUE_PAIR      *paircopy(VALUE_PAIR *vp);
 339 VALUE_PAIR      *paircopy2(VALUE_PAIR *vp, int attr);
 340 void            pairmove(VALUE_PAIR **to, VALUE_PAIR **from);
 341 void            pairmove2(VALUE_PAIR **to, VALUE_PAIR **from, int attr);
 342 VALUE_PAIR      *pairparsevalue(VALUE_PAIR *vp, const char *value);
 343 VALUE_PAIR      *pairmake(const char *attribute, const char *value, int operator);
 344 VALUE_PAIR      *pairread(char **ptr, LRAD_TOKEN *eol);
 345 LRAD_TOKEN      userparse(char *buffer, VALUE_PAIR **first_pair);
 346 VALUE_PAIR     *readvp2(FILE *fp, int *pfiledone, const char *errprefix);
 347
 348 /*
 349  *      Error functions.
 350  */
 351 #ifdef _LIBRADIUS
 352 void            librad_log(const char *, ...)
 353 #ifdef __GNUC__
 354                 __attribute__ ((format (printf, 1, 2)))
 355 #endif
 356 ;
 357 #endif
 358 void            librad_perror(const char *, ...)
 359 #ifdef __GNUC__
 360                 __attribute__ ((format (printf, 1, 2)))
 361 #endif
 362 ;
 363 extern char     librad_errstr[];
 364 extern int      librad_dodns;   /* 0 = no dns lookups */
 365 extern int      librad_debug;   /* 0 = no debugging information */
 366 extern int      librad_max_attributes; /* per incoming packet */
 367
 368 /*
 369  *      Several handy miscellaneous functions.
 370  */
 371 const char *    ip_ntoa(char *, uint32_t);
 372 char            *ifid_ntoa(char *buffer, size_t size, uint8_t *ifid);
 373 uint8_t         *ifid_aton(const char *ifid_str, uint8_t *ifid);
 374 int             rad_lockfd(int fd, int lock_len);
 375 int             rad_lockfd_nonblock(int fd, int lock_len);
 376 int             rad_unlockfd(int fd, int lock_len);
 377 void            lrad_bin2hex(const uint8_t *bin, char *hex, int len);
 378 int             lrad_hex2bin(const char *hex, uint8_t *bin, int len);
 379 #ifndef HAVE_INET_PTON
 380 int             inet_pton(int af, const char *src, void *dst);
 381 #endif
 382 #ifndef HAVE_INET_NTOP
 383 const char      *inet_ntop(int af, const void *src, char *dst, size_t cnt);
 384 #endif
 385 #ifndef HAVE_CLOSEFROM
 386 int             closefrom(int fd);
 387 #endif
 388
 389 int             ip_hton(const char *src, int af, lrad_ipaddr_t *dst);
 390 const char      *ip_ntoh(const lrad_ipaddr_t *src, char *dst, size_t cnt);
 391
 392
 393 #ifdef ASCEND_BINARY
 394 /* filters.c */
 395 int             ascend_parse_filter(VALUE_PAIR *pair);
 396 void            print_abinary(VALUE_PAIR *vp, char *buffer, int len);
 397 #endif /*ASCEND_BINARY*/
 398
 399 /* random numbers in isaac.c */
 400 /* context of random number generator */
 401 typedef struct lrad_randctx {
 402   uint32_t randcnt;
 403   uint32_t randrsl[256];
 404   uint32_t randmem[256];
 405   uint32_t randa;
 406   uint32_t randb;
 407   uint32_t randc;
 408 } lrad_randctx;
 409
 410 void lrad_isaac(lrad_randctx *ctx);
 411 void lrad_randinit(lrad_randctx *ctx, int flag);
 412 uint32_t lrad_rand(void);       /* like rand(), but better. */
 413 void lrad_rand_seed(const void *, size_t ); /* seed the random pool */
 414
 415
 416 /* crypt wrapper from crypt.c */
 417 int lrad_crypt_check(const char *key, const char *salt);
 418
 419 /* rbtree.c */
 420 typedef struct rbtree_t rbtree_t;
 421 typedef struct rbnode_t rbnode_t;
 422
 423 rbtree_t       *rbtree_create(int (*Compare)(const void *, const void *),
 424                                void (*freeNode)(void *),
 425                                int replace_flag);
 426 void            rbtree_free(rbtree_t *tree);
 427 int             rbtree_insert(rbtree_t *tree, void *Data);
 428 void            rbtree_delete(rbtree_t *tree, rbnode_t *Z);
 429 int             rbtree_deletebydata(rbtree_t *tree, const void *data);
 430 rbnode_t       *rbtree_find(rbtree_t *tree, const void *Data);
 431 void           *rbtree_finddata(rbtree_t *tree, const void *Data);
 432 int             rbtree_num_elements(rbtree_t *tree);
 433 void           *rbtree_node2data(rbtree_t *tree, rbnode_t *node);
 434
 435 /* callback order for walking  */
 436 typedef enum { PreOrder, InOrder, PostOrder } RBTREE_ORDER;
 437
 438 /*
 439  *      The callback should be declared as:
 440  *      int callback(void *context, void *data)
 441  *
 442  *      The "context" is some user-defined context.
 443  *      The "data" is the pointer to the user data in the node,
 444  *        NOT the node itself.
 445  *
 446  *      It should return 0 if all is OK, and !0 for any error.
 447  *      The walking will stop on any error.
 448  */
 449 int rbtree_walk(rbtree_t *tree, RBTREE_ORDER order, int (*callback)(void *, void *), void *context);
 450
 451 /*
 452  *      FIFOs
 453  */
 454 typedef struct lrad_fifo_t lrad_fifo_t;
 455 typedef void (*lrad_fifo_free_t)(void *);
 456 lrad_fifo_t *lrad_fifo_create(int max_entries, lrad_fifo_free_t freeNode);
 457 void lrad_fifo_free(lrad_fifo_t *fi);
 458 int lrad_fifo_push(lrad_fifo_t *fi, void *data);
 459 void *lrad_fifo_pop(lrad_fifo_t *fi);
 460
 461 #include <freeradius-devel/packet.h>
 462
 463 #endif /*LIBRADIUS_H*/