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