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