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