src/include/libradius.h

   1 /*
   2  *   This library is free software; you can redistribute it and/or
   3  *   modify it under the terms of the GNU Lesser General Public
   4  *   License as published by the Free Software Foundation; either
   5  *   version 2.1 of the License, or (at your option) any later version.
   6  *
   7  *   This library is distributed in the hope that it will be useful,
   8  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10  *   Lesser General Public License for more details.
  11  *
  12  *   You should have received a copy of the GNU Lesser General Public
  13  *   License along with this library; if not, write to the Free Software
  14  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  15  */
  16 #ifndef LIBRADIUS_H
  17 #define LIBRADIUS_H
  18 /*
  19  * $Id$
  20  *
  21  * @file libradius.h
  22  * @brief Structures and prototypes for the radius library.
  23  *
  24  * @copyright 1999-2014 The FreeRADIUS server project
  25  */
  26 RCSIDH(libradius_h, "$Id$")
  27
  28 /*
  29  *  Preprocessor hacks.
  30  */
  31 #ifndef STRINGIFY
  32 #  define XSTRINGIFY(x) #x
  33 #  define STRINGIFY(x) XSTRINGIFY(x)
  34 #endif
  35
  36 #ifndef HEXIFY
  37 #  define XHEXIFY4(b1,b2,b3,b4) (0x ## b1 ## b2 ## b3 ## b4)
  38 #  define HEXIFY4(b1,b2,b3,b4)  XHEXIFY4(b1, b2, b3, b4)
  39
  40 #  define XHEXIFY3(b1,b2,b3)    (0x ## b1 ## b2 ## b3)
  41 #  define HEXIFY3(b1,b2,b3)     XHEXIFY3(b1, b2, b3)
  42
  43 #  define XHEXIFY2(b1,b2)       (0x ## b1 ## b2)
  44 #  define HEXIFY2(b1,b2)        XHEXIFY2(b1, b2)
  45
  46 #  define XHEXIFY(b1)           (0x ## b1)
  47 #  define HEXIFY(b1)            XHEXIFY(b1)
  48 #endif
  49
  50 /*
  51  *  Let any external program building against the library know what
  52  *  features the library was built with.
  53  */
  54 #include <freeradius-devel/features.h>
  55
  56 #ifdef WITHOUT_VERSION_CHECK
  57 #  define RADIUSD_MAGIC_NUMBER  ((uint64_t) (0xf4ee4ad3f4ee4ad3))
  58 #  define MAGIC_PREFIX(_x)      ((uint8_t) 0x00)
  59 #  define MAGIC_VERSION(_x)     ((uint32_t) 0x00000000)
  60 #  define MAGIC_COMMIT(_x)      ((uint32_t) 0x00000000)
  61 #else
  62 #  ifdef RADIUSD_VERSION_COMMIT
  63 #    define RADIUSD_MAGIC_NUMBER ((uint64_t) HEXIFY4(f4, RADIUSD_VERSION, RADIUSD_VERSION_COMMIT, 0))
  64 #  else
  65 #    define RADIUSD_MAGIC_NUMBER ((uint64_t) HEXIFY3(f4, RADIUSD_VERSION, 00000000))
  66 #  endif
  67 #  define MAGIC_PREFIX(_x)      ((uint8_t) (_x >> 56))
  68 #  define MAGIC_VERSION(_x)     ((uint32_t) ((_x >> 32) & 0x00ffffff))
  69 #  define MAGIC_COMMIT(_x)      ((uint32_t) (_x & 0xffffffff))
  70 #endif
  71
  72 /*
  73  *  Talloc memory allocation is used in preference to malloc throughout
  74  *  the libraries and server.
  75  */
  76 #include <talloc.h>
  77
  78 /*
  79  *  Defines signatures for any missing functions.
  80  */
  81 #include <freeradius-devel/missing.h>
  82
  83 /*
  84  *  Include system headers.
  85  */
  86 #include <stdio.h>
  87 #include <stdlib.h>
  88 #include <stdarg.h>
  89 #include <stdbool.h>
  90 #include <signal.h>
  91
  92 #include <freeradius-devel/threads.h>
  93 #include <freeradius-devel/radius.h>
  94 #include <freeradius-devel/token.h>
  95 #include <freeradius-devel/hash.h>
  96
  97 #ifdef SIZEOF_UNSIGNED_INT
  98 #if SIZEOF_UNSIGNED_INT != 4
  99 #error FATAL: sizeof(unsigned int) != 4
 100 #endif
 101 #endif
 102
 103 /*
 104  *  Include for modules.
 105  */
 106 #include <freeradius-devel/sha1.h>
 107 #include <freeradius-devel/md4.h>
 108
 109 #ifdef __cplusplus
 110 extern "C" {
 111 #endif
 112
 113 #if defined(WITH_VERIFY_PTR)
 114 /*
 115  *      Requires typeof(), which is in most modern C compilers.
 116  */
 117
 118 /*
 119 #define VERIFY_VP(_x) do { (void) talloc_get_type_abort(_x, VALUE_PAIR); \
 120                         if (_x->da) { \
 121                                 (void) talloc_get_type_abort(_x->da, DICT_ATTR); \
 122                         } \
 123                       } while (0)
 124 */
 125 #define FREE_MAGIC (0xF4EEF4EE)
 126
 127 #define VERIFY_VP(_x) (void) talloc_get_type_abort(_x, VALUE_PAIR)
 128 #define VERIFY_PACKET(_x) (void) talloc_get_type_abort(_x, RADIUS_PACKET)
 129 #else
 130 #define VERIFY_VP(_x)
 131 #define VERIFY_PACKET(_x)
 132 #endif
 133
 134 #define AUTH_VECTOR_LEN         16
 135 #define CHAP_VALUE_LENGTH       16
 136 #define MAX_STRING_LEN          254     /* RFC2138: string 0-253 octets */
 137 #define FR_MAX_VENDOR           (1 << 24) /* RFC limitations */
 138
 139 #ifdef _LIBRADIUS
 140 #  define AUTH_HDR_LEN          20
 141 #  define VENDORPEC_USR         429
 142 #define VENDORPEC_LUCENT        4846
 143 #define VENDORPEC_STARENT       8164
 144 #  define DEBUG                 if (fr_debug_flag && fr_log_fp) fr_printf_log
 145 #  define debug_pair(vp)        do { if (fr_debug_flag && fr_log_fp) { \
 146                                         vp_print(fr_log_fp, vp); \
 147                                      } \
 148                                 } while(0)
 149 #endif
 150
 151 #define TAG_VALID(x)            ((x) > 0 && (x) < 0x20)
 152 #define TAG_VALID_ZERO(x)       ((x) < 0x20)
 153 #define TAG_ANY                 -128    /* minimum signed char */
 154 #define TAG_UNUSED              0
 155
 156 #define PAD(_x, _y)             (_y - ((_x) % _y))
 157
 158 #if defined(__GNUC__)
 159 # define PRINTF_LIKE(n) __attribute__ ((format(printf, n, n+1)))
 160 # define NEVER_RETURNS __attribute__ ((noreturn))
 161 # define UNUSED __attribute__ ((unused))
 162 # define BLANK_FORMAT " "       /* GCC_LINT whines about empty formats */
 163 #else
 164 # define PRINTF_LIKE(n) /* ignore */
 165 # define NEVER_RETURNS /* ignore */
 166 # define UNUSED /* ignore */
 167 # define BLANK_FORMAT ""
 168 #endif
 169
 170 typedef struct attr_flags {
 171         unsigned int    is_unknown : 1;                         //!< Attribute number or vendor is unknown.
 172         unsigned int    is_tlv : 1;                             //!< Is a sub attribute.
 173         unsigned int    vp_free : 1;                            //!< Should be freed when VALUE_PAIR is freed.
 174
 175         unsigned int    has_tag : 1;                            //!< Tagged attribute.
 176         unsigned int    array : 1;                              //!< Pack multiples into 1 attr.
 177         unsigned int    has_value : 1;                          //!< Has a value.
 178         unsigned int    has_value_alias : 1;                    //!< Has a value alias.
 179         unsigned int    has_tlv : 1;                            //!< Has sub attributes.
 180
 181         unsigned int    extended : 1;                           //!< Extended attribute.
 182         unsigned int    long_extended : 1;                      //!< Long format.
 183         unsigned int    evs : 1;                                //!< Extended VSA.
 184         unsigned int    wimax: 1;                               //!< WiMAX format=1,1,c.
 185
 186         unsigned int    concat : 1;                             //!< concatenate multiple instances
 187         unsigned int    is_pointer : 1;                         //!< data is a pointer
 188
 189         uint8_t         encrypt;                                //!< Ecryption method.
 190         uint8_t         length;
 191 } ATTR_FLAGS;
 192
 193 /*
 194  *  Values of the encryption flags.
 195  */
 196 #define FLAG_ENCRYPT_NONE           (0)
 197 #define FLAG_ENCRYPT_USER_PASSWORD   (1)
 198 #define FLAG_ENCRYPT_TUNNEL_PASSWORD (2)
 199 #define FLAG_ENCRYPT_ASCEND_SECRET   (3)
 200
 201 extern const FR_NAME_NUMBER dict_attr_types[];
 202 extern const size_t dict_attr_sizes[PW_TYPE_MAX][2];
 203
 204 /** dictionary attribute
 205  *
 206  */
 207 typedef struct dict_attr {
 208         unsigned int            attr;
 209         PW_TYPE                 type;
 210         unsigned int            vendor;
 211         ATTR_FLAGS              flags;
 212         char                    name[1];
 213 } DICT_ATTR;
 214
 215 /** value of an enumerated attribute
 216  *
 217  */
 218 typedef struct dict_value {
 219         unsigned int            attr;
 220         unsigned int            vendor;
 221         int                     value;
 222         char                    name[1];
 223 } DICT_VALUE;
 224
 225 /** dictionary vendor
 226  *
 227  */
 228 typedef struct dict_vendor {
 229         unsigned int            vendorpec;
 230         size_t                  type;                           //!< Length of type data
 231         size_t                  length;                         //!< Length of length data
 232         size_t                  flags;
 233         char                    name[1];
 234 } DICT_VENDOR;
 235
 236 /** Union containing all data types supported by the server
 237  *
 238  * This union contains all data types that can be represented with VALUE_PAIRs. It may also be used in other parts
 239  * of the server where values of different types need to be stored.
 240  *
 241  * PW_TYPE should be an enumeration of the values in this union.
 242  */
 243 typedef union value_data {
 244         char const              *strvalue;                      //!< Pointer to UTF-8 string.
 245         uint8_t const           *octets;                        //!< Pointer to binary string.
 246         struct in_addr          ipaddr;                         //!< IPv4 Address.
 247         struct in6_addr         ipv6addr;                       //!< IPv6 Address.
 248         uint32_t                date;                           //!< Date (32bit Unix timestamp).
 249         uint32_t                integer;                        //!< 32bit unsigned integer.
 250         int32_t                 sinteger;                       //!< 32bit signed integer.
 251         uint64_t                integer64;                      //!< 64bit unsigned integer.
 252         size_t                  filter[32/sizeof(size_t)];      //!< Ascend binary filter.
 253         uint8_t                 ifid[8]; /* struct? */          //!< IPv6 interface ID.
 254         uint8_t                 ipv6prefix[18]; /* struct? */   //!< IPv6 prefix.
 255         uint8_t                 ipv4prefix[6]; /* struct? */    //!< IPv4 prefix.
 256         uint8_t                 ether[6];                       //!< Ethernet (MAC) address.
 257         uint8_t                 *tlv;                           //!< Nested TLV (should go away).
 258         void const              *ptr;                           //!< generic pointer.
 259 } value_data_t;
 260
 261 /** The type of value a VALUE_PAIR contains
 262  *
 263  * This is used to add structure to nested VALUE_PAIRs and specifies what type of node it is (set, list, data).
 264  *
 265  * xlat is another type of data node which must first be expanded before use.
 266  */
 267 typedef enum value_type {
 268         VT_NONE = 0,                                            //!< VALUE_PAIR has no value.
 269         VT_SET,                                                 //!< VALUE_PAIR has children.
 270         VT_LIST,                                                //!< VALUE_PAIR has multiple values.
 271         VT_DATA,                                                //!< VALUE_PAIR has a single value.
 272         VT_XLAT                                                 //!< valuepair value must be xlat expanded when it's
 273                                                                 //!< added to VALUE_PAIR tree.
 274 } value_type_t;
 275
 276 /** Stores an attribute, a value and various bits of other data
 277  *
 278  * VALUE_PAIRs are the main data structure used in the server, they specify an attribute, it's children and
 279  * it's siblings.
 280  *
 281  * They also specify what behaviour should be used when the attribute is merged into a new list/tree.
 282  */
 283 typedef struct value_pair {
 284         DICT_ATTR const         *da;                            //!< Dictionary attribute defines the attribute
 285                                                                 //!< number, vendor and type of the attribute.
 286
 287         struct value_pair       *next;
 288
 289         FR_TOKEN                op;                             //!< Operator to use when moving or inserting
 290                                                                 //!< valuepair into a list.
 291
 292         int8_t                  tag;                            //!< Tag value used to group valuepairs.
 293
 294         union {
 295         //      VALUE_SET       *set;                           //!< Set of child attributes.
 296         //      VALUE_LIST      *list;                          //!< List of values for
 297                                                                 //!< multivalued attribute.
 298         //      value_data_t    *data;                          //!< Value data for this attribute.
 299
 300                 char const      *xlat;                          //!< Source string for xlat expansion.
 301         } value;
 302
 303         value_type_t            type;                           //!< Type of pointer in value union.
 304
 305         size_t                  length;                         //!< of Data field.
 306         value_data_t            data;
 307 } VALUE_PAIR;
 308
 309 /** Abstraction to allow iterating over different configurations of VALUE_PAIRs
 310  *
 311  * This allows functions which do not care about the structure of collections of VALUE_PAIRs
 312  * to iterate over all members in a collection.
 313  *
 314  * Field within a vp_cursor should not be accessed directly, and vp_cursors should only be
 315  * manipulated with the pair* functions.
 316  */
 317 typedef struct vp_cursor {
 318         VALUE_PAIR      **first;
 319         VALUE_PAIR      *found;                                 //!< pairfind marker.
 320         VALUE_PAIR      *last;                                  //!< Temporary only used for pairinsert
 321         VALUE_PAIR      *current;                               //!< The current attribute.
 322         VALUE_PAIR      *next;                                  //!< Next attribute to process.
 323 } vp_cursor_t;
 324
 325 /** A VALUE_PAIR in string format.
 326  *
 327  * Used to represent pairs in the legacy 'users' file format.
 328  */
 329 typedef struct value_pair_raw {
 330         char l_opand[256];                                      //!< Left hand side of the pair.
 331         char r_opand[1024];                                     //!< Right hand side of the pair.
 332
 333         FR_TOKEN quote;                                         //!< Type of quoting around the r_opand.
 334
 335         FR_TOKEN op;                                            //!< Operator.
 336 } VALUE_PAIR_RAW;
 337
 338 #define vp_strvalue   data.strvalue
 339 #define vp_octets     data.octets
 340 #define vp_ipv6addr   data.ipv6addr
 341 #define vp_ifid       data.ifid
 342 #define vp_ipv6prefix data.ipv6prefix
 343 #define vp_ipv4prefix data.ipv4prefix
 344 #define vp_filter     data.filter
 345 #define vp_ether      data.ether
 346 #define vp_signed     data.sinteger
 347 #define vp_tlv        data.tlv
 348 #define vp_integer64  data.integer64
 349 #define vp_ipaddr     data.ipaddr.s_addr
 350 #define vp_date       data.date
 351 #define vp_integer    data.integer
 352
 353 typedef struct fr_ipaddr_t {
 354         int             af;     /* address family */
 355         union {
 356                 struct in_addr  ip4addr;
 357                 struct in6_addr ip6addr; /* maybe defined in missing.h */
 358         } ipaddr;
 359         uint32_t        scope;  /* for IPv6 */
 360 } fr_ipaddr_t;
 361
 362 /*
 363  *      vector:         Request authenticator from access-request packet
 364  *                      Put in there by rad_decode, and must be put in the
 365  *                      response RADIUS_PACKET as well before calling rad_send
 366  *
 367  *      verified:       Filled in by rad_decode for accounting-request packets
 368  *
 369  *      data,data_len:  Used between rad_recv and rad_decode.
 370  */
 371 typedef struct radius_packet {
 372         int                     sockfd;
 373         fr_ipaddr_t             src_ipaddr;
 374         fr_ipaddr_t             dst_ipaddr;
 375         uint16_t                src_port;
 376         uint16_t                dst_port;
 377         int                     id;
 378         unsigned int            code;
 379         uint8_t                 vector[AUTH_VECTOR_LEN];
 380         struct timeval          timestamp;
 381         uint8_t                 *data;
 382         size_t                  data_len;
 383         VALUE_PAIR              *vps;
 384         ssize_t                 offset;
 385 #ifdef WITH_TCP
 386         size_t                  partial;
 387         int                     proto;
 388 #endif
 389 } RADIUS_PACKET;
 390
 391 /*
 392  *      Version check.
 393  */
 394 int             fr_check_lib_magic(uint64_t magic);
 395
 396 /*
 397  *      Printing functions.
 398  */
 399 int             fr_utf8_char(uint8_t const *str);
 400 size_t          fr_print_string(char const *in, size_t inlen,
 401                                  char *out, size_t outlen);
 402 size_t          vp_prints_value(char *out, size_t outlen, VALUE_PAIR const *vp, int8_t quote);
 403 char            *vp_aprinttype(TALLOC_CTX *ctx, PW_TYPE type);
 404 char            *vp_aprint(TALLOC_CTX *ctx, VALUE_PAIR const *vp);
 405 size_t          vp_prints_value_json(char *out, size_t outlen, VALUE_PAIR const *vp);
 406 size_t          vp_print_name(char *out, size_t outlen, unsigned int attr, unsigned int vendor);
 407 size_t          vp_prints(char *out, size_t outlen, VALUE_PAIR const *vp);
 408 void            vp_print(FILE *, VALUE_PAIR const *);
 409 void            vp_printlist(FILE *, VALUE_PAIR const *);
 410 #define         fprint_attr_val vp_print
 411
 412 /*
 413  *      Dictionary functions.
 414  */
 415 extern const int dict_attr_allowed_chars[256];
 416 int             str2argv(char *str, char **argv, int max_argc);
 417 int             dict_str2oid(char const *ptr, unsigned int *pattr,
 418                              unsigned int *pvendor, int tlv_depth);
 419 int             dict_addvendor(char const *name, unsigned int value);
 420 int             dict_addattr(char const *name, int attr, unsigned int vendor, PW_TYPE type, ATTR_FLAGS flags);
 421 int             dict_addvalue(char const *namestr, char const *attrstr, int value);
 422 int             dict_init(char const *dir, char const *fn);
 423 void            dict_free(void);
 424 int             dict_read(char const *dir, char const *filename);
 425 void            dict_attr_free(DICT_ATTR const **da);
 426 DICT_ATTR const *dict_attr_copy(DICT_ATTR const *da, int vp_free);
 427 DICT_ATTR const *dict_attrunknown(unsigned int attr, unsigned int vendor, int vp_free);
 428 DICT_ATTR const *dict_attrunknownbyname(char const *attribute, int vp_free);
 429 DICT_ATTR const *dict_attrbyvalue(unsigned int attr, unsigned int vendor);
 430 DICT_ATTR const *dict_attrbyname(char const *attr);
 431 DICT_ATTR const *dict_attrbytype(unsigned int attr, unsigned int vendor,
 432                                  PW_TYPE type);
 433 DICT_ATTR const *dict_attrbyparent(DICT_ATTR const *parent, unsigned int attr,
 434                                            unsigned int vendor);
 435 int             dict_attr_child(DICT_ATTR const *parent,
 436                                 unsigned int *pattr, unsigned int *pvendor);
 437 DICT_VALUE      *dict_valbyattr(unsigned int attr, unsigned int vendor, int val);
 438 DICT_VALUE      *dict_valbyname(unsigned int attr, unsigned int vendor, char const *val);
 439 char const      *dict_valnamebyattr(unsigned int attr, unsigned int vendor, int value);
 440 int             dict_vendorbyname(char const *name);
 441 DICT_VENDOR     *dict_vendorbyvalue(int vendor);
 442
 443 #if 1 /* FIXME: compat */
 444 #define dict_attrget    dict_attrbyvalue
 445 #define dict_attrfind   dict_attrbyname
 446 #define dict_valfind    dict_valbyname
 447 /*#define dict_valget   dict_valbyattr almost but not quite*/
 448 #endif
 449
 450 /* md5.c */
 451
 452 void            fr_md5_calc(uint8_t *, uint8_t const *, unsigned int);
 453
 454 /* hmac.c */
 455
 456 void fr_hmac_md5(uint8_t const *text, size_t text_len, uint8_t const *key, size_t key_len, unsigned char *digest);
 457
 458 /* hmacsha1.c */
 459
 460 void fr_hmac_sha1(uint8_t const *text, size_t text_len, uint8_t const *key, size_t key_len, uint8_t *digest);
 461
 462 /* radius.c */
 463 int             rad_send(RADIUS_PACKET *, RADIUS_PACKET const *, char const *secret);
 464 int             rad_packet_ok(RADIUS_PACKET *packet, int flags);
 465 RADIUS_PACKET   *rad_recv(int fd, int flags);
 466 ssize_t rad_recv_header(int sockfd, fr_ipaddr_t *src_ipaddr, int *src_port,
 467                         int *code);
 468 void            rad_recv_discard(int sockfd);
 469 int             rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
 470                            char const *secret);
 471 int             rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, char const *secret);
 472 int             rad_encode(RADIUS_PACKET *packet, RADIUS_PACKET const *original,
 473                            char const *secret);
 474 int             rad_sign(RADIUS_PACKET *packet, RADIUS_PACKET const *original,
 475                          char const *secret);
 476
 477 int rad_digest_cmp(uint8_t const *a, uint8_t const *b, size_t length);
 478 RADIUS_PACKET   *rad_alloc(TALLOC_CTX *ctx, int newvector);
 479 RADIUS_PACKET   *rad_alloc_reply(TALLOC_CTX *ctx, RADIUS_PACKET *);
 480 void            rad_free(RADIUS_PACKET **);
 481 int             rad_pwencode(char *encpw, size_t *len, char const *secret,
 482                              uint8_t const *vector);
 483 int             rad_pwdecode(char *encpw, size_t len, char const *secret,
 484                              uint8_t const *vector);
 485
 486 #define FR_TUNNEL_PW_ENC_LENGTH(_x) (2 + 1 + _x + PAD(_x + 1, 16))
 487 int             rad_tunnel_pwencode(char *encpw, size_t *len, char const *secret,
 488                                     uint8_t const *vector);
 489 int             rad_tunnel_pwdecode(uint8_t *encpw, size_t *len,
 490                                     char const *secret, uint8_t const *vector);
 491 int             rad_chap_encode(RADIUS_PACKET *packet, uint8_t *output,
 492                                 int id, VALUE_PAIR *password);
 493
 494 int rad_attr_ok(RADIUS_PACKET const *packet, RADIUS_PACKET const *original,
 495                 DICT_ATTR *da,
 496                 uint8_t const *data, size_t length);
 497 int rad_tlv_ok(uint8_t const *data, size_t length,
 498                size_t dv_type, size_t dv_length);
 499
 500 ssize_t rad_attr2vp(RADIUS_PACKET *packet, RADIUS_PACKET const *original,
 501                     char const *secret,
 502                     uint8_t const *data, size_t length,
 503                     VALUE_PAIR **pvp);
 504
 505 ssize_t  rad_data2vp(unsigned int attribute, unsigned int vendor,
 506                      uint8_t const *data, size_t length,
 507                      VALUE_PAIR **pvp);
 508
 509 ssize_t rad_vp2data(uint8_t const **out, VALUE_PAIR const *vp);
 510
 511 int rad_vp2extended(RADIUS_PACKET const *packet,
 512                     RADIUS_PACKET const *original,
 513                     char const *secret, VALUE_PAIR const **pvp,
 514                     uint8_t *ptr, size_t room);
 515 int rad_vp2wimax(RADIUS_PACKET const *packet,
 516                  RADIUS_PACKET const *original,
 517                  char const *secret, VALUE_PAIR const **pvp,
 518                  uint8_t *ptr, size_t room);
 519 int rad_vp2vsa(RADIUS_PACKET const *packet, RADIUS_PACKET const *original,
 520                char const *secret, VALUE_PAIR const **pvp, uint8_t *start,
 521                size_t room);
 522 int rad_vp2rfc(RADIUS_PACKET const *packet,
 523                RADIUS_PACKET const *original,
 524                char const *secret, VALUE_PAIR const **pvp,
 525                uint8_t *ptr, size_t room);
 526
 527 int rad_vp2attr(RADIUS_PACKET const *packet,
 528                 RADIUS_PACKET const *original, char const *secret,
 529                 VALUE_PAIR const **pvp, uint8_t *ptr, size_t room);
 530
 531 /* valuepair.c */
 532 VALUE_PAIR      *pairalloc(TALLOC_CTX *ctx, DICT_ATTR const *da);
 533 VALUE_PAIR      *paircreate(TALLOC_CTX *ctx, unsigned int attr, unsigned int vendor);
 534 int             pair2unknown(VALUE_PAIR *vp);
 535 void            pairfree(VALUE_PAIR **);
 536 VALUE_PAIR      *pairfind(VALUE_PAIR *, unsigned int attr, unsigned int vendor, int8_t tag);
 537
 538 #define         paircursor(_x, _y)      paircursorc(_x,(VALUE_PAIR const * const *) _y)
 539 VALUE_PAIR      *paircursorc(vp_cursor_t *cursor, VALUE_PAIR const * const *node);
 540 VALUE_PAIR      *pairfirst(vp_cursor_t *cursor);
 541 VALUE_PAIR      *pairfindnext(vp_cursor_t *cursor, unsigned int attr, unsigned int vendor, int8_t tag);
 542 VALUE_PAIR      *pairnext(vp_cursor_t *cursor);
 543 VALUE_PAIR      *pairlast(vp_cursor_t *cursor);
 544 VALUE_PAIR      *paircurrent(vp_cursor_t *cursor);
 545 void            pairinsert(vp_cursor_t *cursor, VALUE_PAIR *vp);
 546 VALUE_PAIR      *pairremove(vp_cursor_t *cursor);
 547 void            pairdelete(VALUE_PAIR **, unsigned int attr, unsigned int vendor, int8_t tag);
 548 void            pairadd(VALUE_PAIR **, VALUE_PAIR *);
 549 void            pairreplace(VALUE_PAIR **first, VALUE_PAIR *add);
 550 int             paircmp(VALUE_PAIR *check, VALUE_PAIR *data);
 551 int             paircmp_op(VALUE_PAIR const *one, FR_TOKEN op, VALUE_PAIR const *two);
 552 void            pairsort(VALUE_PAIR **vps, bool with_tag);
 553 bool            pairvalidate(VALUE_PAIR *filter, VALUE_PAIR *list);
 554 VALUE_PAIR      *paircopyvp(TALLOC_CTX *ctx, VALUE_PAIR const *vp);
 555 VALUE_PAIR      *paircopyvpdata(TALLOC_CTX *ctx, DICT_ATTR const *da, VALUE_PAIR const *vp);
 556 VALUE_PAIR      *paircopy(TALLOC_CTX *ctx, VALUE_PAIR *from);
 557 VALUE_PAIR      *paircopy2(TALLOC_CTX *ctx, VALUE_PAIR *from, unsigned int attr, unsigned int vendor, int8_t tag);
 558 void            pairmemcpy(VALUE_PAIR *vp, uint8_t const * src, size_t len);
 559 void            pairmemsteal(VALUE_PAIR *vp, uint8_t const *src);
 560 void            pairstrsteal(VALUE_PAIR *vp, char const *src);
 561 void            pairstrcpy(VALUE_PAIR *vp, char const * src);
 562 void            pairsprintf(VALUE_PAIR *vp, char const * fmt, ...)
 563 #ifdef __GNUC__
 564                 __attribute__ ((format (printf, 2, 3)))
 565 #endif
 566 ;
 567 void            pairmove(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from);
 568 void            pairfilter(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from,
 569                                            unsigned int attr, unsigned int vendor, int8_t tag);
 570 bool            pairparsevalue(VALUE_PAIR *vp, char const *value);
 571 VALUE_PAIR      *pairmake(TALLOC_CTX *ctx, VALUE_PAIR **vps, char const *attribute, char const *value, FR_TOKEN op);
 572 int             pairmark_xlat(VALUE_PAIR *vp, char const *value);
 573 FR_TOKEN        pairread(char const **ptr, VALUE_PAIR_RAW *raw);
 574 FR_TOKEN        userparse(TALLOC_CTX *ctx, char const *buffer, VALUE_PAIR **head);
 575 VALUE_PAIR      *readvp2(TALLOC_CTX *ctx, FILE *fp, int *pfiledone, char const *errprefix);
 576
 577 /*
 578  *      Error functions.
 579  */
 580 #ifdef _LIBRADIUS
 581 void            fr_strerror_printf(char const *, ...)
 582 #ifdef __GNUC__
 583                 __attribute__ ((format (printf, 1, 2)))
 584 #endif
 585 ;
 586 #endif
 587 void            fr_perror(char const *, ...)
 588 #ifdef __GNUC__
 589                 __attribute__ ((format (printf, 1, 2)))
 590 #endif
 591 ;
 592 char const *fr_syserror(int num);
 593 extern bool fr_assert_cond(char const *file, int line, char const *expr, bool cond);
 594 #define fr_assert(_x) fr_assert_cond(__FILE__,  __LINE__, #_x, (_x))
 595
 596 extern void NEVER_RETURNS _fr_exit(char const *file, int line, int status);
 597 #define fr_exit(_x) _fr_exit(__FILE__,  __LINE__, (_x))
 598
 599 extern void NEVER_RETURNS _fr_exit_now(char const *file, int line, int status);
 600 #define fr_exit_now(_x) _fr_exit_now(__FILE__,  __LINE__, (_x))
 601
 602 extern char const *fr_strerror(void);
 603 extern bool     fr_dns_lookups; /* do IP -> hostname lookups? */
 604 extern bool     fr_hostname_lookups; /* do hostname -> IP lookups? */
 605 extern int      fr_debug_flag;  /* 0 = no debugging information */
 606 extern int      fr_max_attributes; /* per incoming packet */
 607 #define FR_MAX_PACKET_CODE (52)
 608 extern char const *fr_packet_codes[FR_MAX_PACKET_CODE];
 609 extern FILE     *fr_log_fp;
 610 extern void rad_print_hex(RADIUS_PACKET *packet);
 611 void            fr_printf_log(char const *, ...)
 612 #ifdef __GNUC__
 613                 __attribute__ ((format (printf, 1, 2)))
 614 #endif
 615 ;
 616
 617 /*
 618  *      Several handy miscellaneous functions.
 619  */
 620 int             fr_set_signal(int sig, sig_t func);
 621 TALLOC_CTX      *fr_autofree_ctx(void);
 622 char const      *fr_inet_ntop(int af, void const *src);
 623 char const      *ip_ntoa(char *, uint32_t);
 624 char            *ifid_ntoa(char *buffer, size_t size, uint8_t const *ifid);
 625 uint8_t         *ifid_aton(char const *ifid_str, uint8_t *ifid);
 626 int             rad_lockfd(int fd, int lock_len);
 627 int             rad_lockfd_nonblock(int fd, int lock_len);
 628 int             rad_unlockfd(int fd, int lock_len);
 629 size_t          fr_bin2hex(char *hex, uint8_t const *bin, size_t inlen);
 630 size_t          fr_hex2bin(uint8_t *bin, char const *hex, size_t outlen);
 631 uint32_t        fr_strtoul(char const *value, char **end);
 632 bool            fr_whitespace_check(char const *value);
 633 bool            fr_integer_check(char const *value);
 634
 635 int             fr_ipaddr_cmp(fr_ipaddr_t const *a, fr_ipaddr_t const *b);
 636
 637 int             ip_ptonx(char const *src, fr_ipaddr_t *dst);
 638 int             ip_hton(char const *src, int af, fr_ipaddr_t *dst);
 639 char const      *ip_ntoh(fr_ipaddr_t const *src, char *dst, size_t cnt);
 640 int fr_ipaddr2sockaddr(fr_ipaddr_t const *ipaddr, int port,
 641                        struct sockaddr_storage *sa, socklen_t *salen);
 642 int fr_sockaddr2ipaddr(struct sockaddr_storage const *sa, socklen_t salen,
 643                        fr_ipaddr_t *ipaddr, int * port);
 644 ssize_t         fr_utf8_to_ucs2(uint8_t *out, size_t outlen, char const *in, size_t inlen);
 645 int64_t         fr_pow(int32_t base, uint8_t exp);
 646 int             fr_get_time(char const *date_str, time_t *date);
 647
 648 /*
 649  *      Define TALLOC_DEBUG to check overflows with talloc.
 650  *      we can't use valgrind, because the memory used by
 651  *      talloc is valid memory... just not for us.
 652  */
 653 #ifdef TALLOC_DEBUG
 654 void fr_talloc_verify_cb(const void *ptr, int depth,
 655                          int max_depth, int is_ref,
 656                          void *private_data);
 657 #define VERIFY_ALL_TALLOC talloc_report_depth_cb(NULL, 0, -1, fr_talloc_verify_cb, NULL)
 658 #else
 659 #define VERIFY_ALL_TALLOC
 660 #endif
 661
 662 #ifdef WITH_ASCEND_BINARY
 663 /* filters.c */
 664 int             ascend_parse_filter(VALUE_PAIR *vp, char const *value);
 665 void            print_abinary(VALUE_PAIR const *vp, char *buffer, size_t len, int8_t quote);
 666 #endif /*WITH_ASCEND_BINARY*/
 667
 668 /* random numbers in isaac.c */
 669 /* context of random number generator */
 670 typedef struct fr_randctx {
 671         uint32_t randcnt;
 672         uint32_t randrsl[256];
 673         uint32_t randmem[256];
 674         uint32_t randa;
 675         uint32_t randb;
 676         uint32_t randc;
 677 } fr_randctx;
 678
 679 void fr_isaac(fr_randctx *ctx);
 680 void fr_randinit(fr_randctx *ctx, int flag);
 681 uint32_t fr_rand(void); /* like rand(), but better. */
 682 void fr_rand_seed(void const *, size_t ); /* seed the random pool */
 683
 684
 685 /* crypt wrapper from crypt.c */
 686 int fr_crypt_check(char const *key, char const *salt);
 687
 688 /* cbuff.c */
 689 typedef struct fr_cbuff fr_cbuff_t;
 690
 691 fr_cbuff_t      *fr_cbuff_alloc(TALLOC_CTX *ctx, uint32_t size, bool lock);
 692 void            fr_cbuff_rp_insert(fr_cbuff_t *cbuff, void *obj);
 693 void            *fr_cbuff_rp_next(fr_cbuff_t *cbuff, TALLOC_CTX *ctx);
 694
 695 /* debug.c */
 696 typedef struct fr_bt_marker fr_bt_marker_t;
 697
 698 void            fr_debug_break(void);
 699 void            backtrace_print(fr_cbuff_t *cbuff, void *obj);
 700 fr_bt_marker_t  *fr_backtrace_attach(fr_cbuff_t **cbuff, TALLOC_CTX *obj);
 701 int             fr_fault_setup(char const *cmd, char const *program);
 702
 703 /* rbtree.c */
 704 typedef struct rbtree_t rbtree_t;
 705 typedef struct rbnode_t rbnode_t;
 706
 707 /* callback order for walking  */
 708 typedef enum {
 709         RBTREE_PRE_ORDER,
 710         RBTREE_IN_ORDER,
 711         RBTREE_POST_ORDER,
 712         RBTREE_DELETE_ORDER
 713 } rb_order_t;
 714
 715 #define RBTREE_FLAG_NONE    (0)
 716 #define RBTREE_FLAG_REPLACE (1 << 0)
 717 #define RBTREE_FLAG_LOCK    (1 << 1)
 718
 719 typedef int (*rb_comparator_t)(void const *ctx, void const *data);
 720 typedef int (*rb_walker_t)(void *ctx, void *data);
 721 typedef void (*rb_free_t)(void *data);
 722
 723 rbtree_t       *rbtree_create(rb_comparator_t compare, rb_free_t node_free, int flags);
 724 void            rbtree_free(rbtree_t *tree);
 725 bool            rbtree_insert(rbtree_t *tree, void *data);
 726 rbnode_t        *rbtree_insert_node(rbtree_t *tree, void *data);
 727 void            rbtree_delete(rbtree_t *tree, rbnode_t *z);
 728 bool            rbtree_deletebydata(rbtree_t *tree, void const *data);
 729 rbnode_t       *rbtree_find(rbtree_t *tree, void const *data);
 730 void           *rbtree_finddata(rbtree_t *tree, void const *data);
 731 int             rbtree_num_elements(rbtree_t *tree);
 732 void           *rbtree_min(rbtree_t *tree);
 733 void           *rbtree_node2data(rbtree_t *tree, rbnode_t *node);
 734
 735 /*
 736  *      The callback should be declared as:
 737  *      int callback(void *context, void *data)
 738  *
 739  *      The "context" is some user-defined context.
 740  *      The "data" is the pointer to the user data in the node,
 741  *        NOT the node itself.
 742  *
 743  *      It should return 0 if all is OK, and !0 for any error.
 744  *      The walking will stop on any error.
 745  *
 746  *      Except with RBTREE_DELETE_ORDER, where the callback should return <0 for
 747  *      errors, and may return 1 to delete the current node and halt,
 748  *      or 2 to delete the current node and continue.  This may be
 749  *      used to batch-delete select nodes from a locked rbtree.
 750  */
 751 int rbtree_walk(rbtree_t *tree, rb_order_t order, rb_walker_t compare, void *context);
 752
 753 /*
 754  *      Find a matching data item in an rbtree and, if one is found,
 755  *      perform a callback on it.
 756  *
 757  *      The callback is similar to rbtree_walk above, except that a
 758  *      positive return code from the callback will cause the found node
 759  *      to be deleted from the tree.  If the tree was created with
 760  *      RBTREE_FLAG_LOCK, then the entire find/callback/delete/rebalance
 761  *      sequence happens while the lock is held.
 762  *
 763  *      Note that the callback MUST NOT alter any of the data which
 764  *      is used as the rbtree key, nor attempt to alter the rest of
 765  *      the rbtree in any way.
 766  *
 767  *      Returns a pointer to the user data in the found node, or NULL if the
 768  *      item was not found, or NULL if the item was deleted and the tree was
 769  *      created with a freeNode garbage collection routine.
 770  */
 771 void *rbtree_callbydata(rbtree_t *tree, void const *data, rb_comparator_t compare, void *context);
 772
 773 /*
 774  *      FIFOs
 775  */
 776 typedef struct fr_fifo_t fr_fifo_t;
 777 typedef void (*fr_fifo_free_t)(void *);
 778 fr_fifo_t *fr_fifo_create(int max_entries, fr_fifo_free_t freeNode);
 779 void fr_fifo_free(fr_fifo_t *fi);
 780 int fr_fifo_push(fr_fifo_t *fi, void *data);
 781 void *fr_fifo_pop(fr_fifo_t *fi);
 782 void *fr_fifo_peek(fr_fifo_t *fi);
 783 int fr_fifo_num_elements(fr_fifo_t *fi);
 784
 785 #ifdef __cplusplus
 786 }
 787 #endif
 788
 789 #include <freeradius-devel/packet.h>
 790
 791 #ifdef WITH_TCP
 792 #include <freeradius-devel/tcp.h>
 793 #endif
 794
 795 #endif /*LIBRADIUS_H*/