5 * libradius.h Structures and prototypes
6 * for the radius library.
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.
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.
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
24 * Copyright 1999,2000,2001,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project
27 #include <freeradius-devel/ident.h>
28 RCSIDH(libradius_h, "$Id$")
30 #include <freeradius-devel/missing.h>
40 #include <freeradius-devel/radius.h>
41 #include <freeradius-devel/token.h>
42 #include <freeradius-devel/hash.h>
44 #ifdef SIZEOF_UNSIGNED_INT
45 #if SIZEOF_UNSIGNED_INT != 4
46 #error FATAL: sizeof(unsigned int) != 4
51 * Include for modules.
53 #include <freeradius-devel/sha1.h>
54 #include <freeradius-devel/md4.h>
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 */
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); \
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 */
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 */
90 # define PRINTF_LIKE(n) /* ignore */
91 # define NEVER_RETURNS /* ignore */
92 # define UNUSED /* ignore */
93 # define BLANK_FORMAT ""
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 */
108 int8_t tag; /* tag for tunneled attributes */
109 uint8_t encrypt; /* encryption method */
114 * Values of the encryption flags.
116 #define FLAG_ENCRYPT_NONE (0)
117 #define FLAG_ENCRYPT_USER_PASSWORD (1)
118 #define FLAG_ENCRYPT_TUNNEL_PASSWORD (2)
119 #define FLAG_ENCRYPT_ASCEND_SECRET (3)
121 typedef struct dict_attr {
129 typedef struct dict_value {
136 typedef struct dict_vendor {
138 int type; /* length of type data */
139 int length; /* length of length data */
144 typedef union value_pair_data {
145 char strvalue[MAX_STRING_LEN];
146 uint8_t octets[MAX_STRING_LEN];
147 struct in_addr ipaddr;
148 struct in6_addr ipv6addr;
153 uint8_t ifid[8]; /* struct? */
154 uint8_t ipv6prefix[18]; /* struct? */
159 typedef struct value_pair {
161 unsigned int attribute;
164 size_t length; /* of data */
167 struct value_pair *next;
169 VALUE_PAIR_DATA data;
171 #define vp_strvalue data.strvalue
172 #define vp_octets data.octets
173 #define vp_ipv6addr data.ipv6addr
174 #define vp_ifid data.ifid
175 #define vp_ipv6prefix data.ipv6prefix
176 #define vp_filter data.filter
177 #define vp_ether data.ether
178 #define vp_signed data.sinteger
179 #define vp_tlv data.tlv
182 #define vp_ipaddr data.ipaddr.s_addr
183 #define vp_date data.date
184 #define vp_integer data.integer
187 * These are left as lvalue until we audit the source for code
188 * that prints to vp_strvalue for integer/ipaddr/date types.
190 #define vp_ipaddr lvalue
191 #define vp_date lvalue
192 #define vp_integer lvalue
196 typedef struct fr_ipaddr_t {
197 int af; /* address family */
199 struct in_addr ip4addr;
200 struct in6_addr ip6addr; /* maybe defined in missing.h */
202 uint32_t scope; /* for IPv6 */
206 * vector: Request authenticator from access-request packet
207 * Put in there by rad_decode, and must be put in the
208 * response RADIUS_PACKET as well before calling rad_send
210 * verified: Filled in by rad_decode for accounting-request packets
212 * data,data_len: Used between rad_recv and rad_decode.
214 typedef struct radius_packet {
216 fr_ipaddr_t src_ipaddr;
217 fr_ipaddr_t dst_ipaddr;
223 uint8_t vector[AUTH_VECTOR_LEN];
235 * Printing functions.
237 int fr_utf8_char(const uint8_t *str);
238 void fr_print_string(const char *in, size_t inlen,
239 char *out, size_t outlen);
240 int vp_prints_value(char *out, size_t outlen,
241 VALUE_PAIR *vp, int delimitst);
242 const char *vp_print_name(char *buffer, size_t bufsize, int attr, int vendor);
243 int vp_prints(char *out, size_t outlen, VALUE_PAIR *vp);
244 void vp_print(FILE *, VALUE_PAIR *);
245 void vp_printlist(FILE *, VALUE_PAIR *);
246 #define fprint_attr_val vp_print
249 * Dictionary functions.
251 int dict_addvendor(const char *name, int value);
252 int dict_addattr(const char *name, int attr, int vendor, int type, ATTR_FLAGS flags);
253 int dict_addvalue(const char *namestr, const char *attrstr, int value);
254 int dict_init(const char *dir, const char *fn);
255 void dict_free(void);
256 DICT_ATTR *dict_attrbyvalue(unsigned int attr, unsigned int vendor);
257 DICT_ATTR *dict_attrbyname(const char *attr);
258 DICT_VALUE *dict_valbyattr(unsigned int attr, unsigned int vendor, int val);
259 DICT_VALUE *dict_valbyname(unsigned int attr, unsigned int vendor, const char *val);
260 int dict_vendorbyname(const char *name);
261 DICT_VENDOR *dict_vendorbyvalue(int vendor);
263 #if 1 /* FIXME: compat */
264 #define dict_attrget dict_attrbyvalue
265 #define dict_attrfind dict_attrbyname
266 #define dict_valfind dict_valbyname
267 /*#define dict_valget dict_valbyattr almost but not quite*/
270 /* get around diffrent ctime_r styles */
272 #if CTIMERSTYLE == SOLARISSTYLE
273 #define CTIME_R(a,b,c) ctime_r(a,b,c)
275 #define CTIME_R(a,b,c) ctime_r(a,b)
278 #define CTIME_R(a,b,c) ctime_r(a,b)
283 void fr_md5_calc(uint8_t *, const uint8_t *, unsigned int);
287 void fr_hmac_md5(const uint8_t *text, int text_len,
288 const uint8_t *key, int key_len,
289 unsigned char *digest);
293 void fr_hmac_sha1(const uint8_t *text, int text_len,
294 const uint8_t *key, int key_len,
298 int rad_send(RADIUS_PACKET *, const RADIUS_PACKET *, const char *secret);
299 int rad_packet_ok(RADIUS_PACKET *packet, int flags);
300 RADIUS_PACKET *rad_recv(int fd, int flags);
301 ssize_t rad_recv_header(int sockfd, fr_ipaddr_t *src_ipaddr, int *src_port,
303 void rad_recv_discard(int sockfd);
304 int rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
306 int rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, const char *secret);
307 int rad_encode(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
309 int rad_sign(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
312 RADIUS_PACKET *rad_alloc(int newvector);
313 RADIUS_PACKET *rad_alloc_reply(RADIUS_PACKET *);
314 void rad_free(RADIUS_PACKET **);
315 int rad_pwencode(char *encpw, size_t *len, const char *secret,
316 const uint8_t *vector);
317 int rad_pwdecode(char *encpw, size_t len, const char *secret,
318 const uint8_t *vector);
319 int rad_tunnel_pwencode(char *encpw, size_t *len, const char *secret,
320 const uint8_t *vector);
321 int rad_tunnel_pwdecode(uint8_t *encpw, size_t *len,
322 const char *secret, const uint8_t *vector);
323 int rad_chap_encode(RADIUS_PACKET *packet, uint8_t *output,
324 int id, VALUE_PAIR *password);
325 VALUE_PAIR *rad_attr2vp(const RADIUS_PACKET *packet, const RADIUS_PACKET *original,
326 const char *secret, int attribute, int vendor,
327 int length, const uint8_t *data);
328 int rad_vp2attr(const RADIUS_PACKET *packet,
329 const RADIUS_PACKET *original, const char *secret,
330 const VALUE_PAIR *vp, uint8_t *ptr, size_t room);
333 VALUE_PAIR *pairalloc(DICT_ATTR *da);
334 VALUE_PAIR *paircreate_raw(int attr, int vendor, int type, VALUE_PAIR *);
335 VALUE_PAIR *paircreate(int attr, int vendor, int type);
336 void pairfree(VALUE_PAIR **);
337 void pairbasicfree(VALUE_PAIR *pair);
338 VALUE_PAIR *pairfind(VALUE_PAIR *, int attr, int vendor);
339 void pairdelete(VALUE_PAIR **, int attr, int vendor);
340 void pairadd(VALUE_PAIR **, VALUE_PAIR *);
341 void pairreplace(VALUE_PAIR **first, VALUE_PAIR *add);
342 int paircmp(VALUE_PAIR *check, VALUE_PAIR *data);
343 VALUE_PAIR *paircopyvp(const VALUE_PAIR *vp);
344 VALUE_PAIR *paircopy(VALUE_PAIR *vp);
345 VALUE_PAIR *paircopy2(VALUE_PAIR *vp, int attr, int vendor);
346 void pairmove(VALUE_PAIR **to, VALUE_PAIR **from);
347 void pairmove2(VALUE_PAIR **to, VALUE_PAIR **from, int attr, int vendor);
348 VALUE_PAIR *pairparsevalue(VALUE_PAIR *vp, const char *value);
349 VALUE_PAIR *pairmake(const char *attribute, const char *value, int operator);
350 VALUE_PAIR *pairread(const char **ptr, FR_TOKEN *eol);
351 FR_TOKEN userparse(const char *buffer, VALUE_PAIR **first_pair);
352 VALUE_PAIR *readvp2(FILE *fp, int *pfiledone, const char *errprefix);
358 void fr_strerror_printf(const char *, ...)
360 __attribute__ ((format (printf, 1, 2)))
364 void fr_perror(const char *, ...)
366 __attribute__ ((format (printf, 1, 2)))
369 extern const char *fr_strerror(void);
370 extern int fr_dns_lookups; /* 0 = no dns lookups */
371 extern int fr_debug_flag; /* 0 = no debugging information */
372 extern int fr_max_attributes; /* per incoming packet */
373 #define FR_MAX_PACKET_CODE (52)
374 extern const char *fr_packet_codes[FR_MAX_PACKET_CODE];
375 extern FILE *fr_log_fp;
376 void fr_printf_log(const char *, ...)
378 __attribute__ ((format (printf, 1, 2)))
383 * Several handy miscellaneous functions.
385 const char * ip_ntoa(char *, uint32_t);
386 char *ifid_ntoa(char *buffer, size_t size, uint8_t *ifid);
387 uint8_t *ifid_aton(const char *ifid_str, uint8_t *ifid);
388 int rad_lockfd(int fd, int lock_len);
389 int rad_lockfd_nonblock(int fd, int lock_len);
390 int rad_unlockfd(int fd, int lock_len);
391 void fr_bin2hex(const uint8_t *bin, char *hex, size_t len);
392 size_t fr_hex2bin(const char *hex, uint8_t *bin, size_t len);
393 #ifndef HAVE_INET_PTON
394 int inet_pton(int af, const char *src, void *dst);
396 #ifndef HAVE_INET_NTOP
397 const char *inet_ntop(int af, const void *src, char *dst, size_t cnt);
399 #ifndef HAVE_CLOSEFROM
400 int closefrom(int fd);
402 int fr_ipaddr_cmp(const fr_ipaddr_t *a, const fr_ipaddr_t *b);
404 int ip_hton(const char *src, int af, fr_ipaddr_t *dst);
405 const char *ip_ntoh(const fr_ipaddr_t *src, char *dst, size_t cnt);
406 int fr_ipaddr2sockaddr(const fr_ipaddr_t *ipaddr, int port,
407 struct sockaddr_storage *sa, socklen_t *salen);
408 int fr_sockaddr2ipaddr(const struct sockaddr_storage *sa, socklen_t salen,
409 fr_ipaddr_t *ipaddr, int * port);
414 int ascend_parse_filter(VALUE_PAIR *pair);
415 void print_abinary(VALUE_PAIR *vp, char *buffer, size_t len);
416 #endif /*ASCEND_BINARY*/
418 /* random numbers in isaac.c */
419 /* context of random number generator */
420 typedef struct fr_randctx {
422 uint32_t randrsl[256];
423 uint32_t randmem[256];
429 void fr_isaac(fr_randctx *ctx);
430 void fr_randinit(fr_randctx *ctx, int flag);
431 uint32_t fr_rand(void); /* like rand(), but better. */
432 void fr_rand_seed(const void *, size_t ); /* seed the random pool */
435 /* crypt wrapper from crypt.c */
436 int fr_crypt_check(const char *key, const char *salt);
439 typedef struct rbtree_t rbtree_t;
440 typedef struct rbnode_t rbnode_t;
442 rbtree_t *rbtree_create(int (*Compare)(const void *, const void *),
443 void (*freeNode)(void *),
445 void rbtree_free(rbtree_t *tree);
446 int rbtree_insert(rbtree_t *tree, void *Data);
447 rbnode_t *rbtree_insertnode(rbtree_t *tree, void *Data);
448 void rbtree_delete(rbtree_t *tree, rbnode_t *Z);
449 int rbtree_deletebydata(rbtree_t *tree, const void *data);
450 rbnode_t *rbtree_find(rbtree_t *tree, const void *Data);
451 void *rbtree_finddata(rbtree_t *tree, const void *Data);
452 int rbtree_num_elements(rbtree_t *tree);
453 void *rbtree_min(rbtree_t *tree);
454 void *rbtree_node2data(rbtree_t *tree, rbnode_t *node);
456 /* callback order for walking */
457 typedef enum { PreOrder, InOrder, PostOrder } RBTREE_ORDER;
460 * The callback should be declared as:
461 * int callback(void *context, void *data)
463 * The "context" is some user-defined context.
464 * The "data" is the pointer to the user data in the node,
465 * NOT the node itself.
467 * It should return 0 if all is OK, and !0 for any error.
468 * The walking will stop on any error.
470 int rbtree_walk(rbtree_t *tree, RBTREE_ORDER order, int (*callback)(void *, void *), void *context);
475 typedef struct fr_fifo_t fr_fifo_t;
476 typedef void (*fr_fifo_free_t)(void *);
477 fr_fifo_t *fr_fifo_create(int max_entries, fr_fifo_free_t freeNode);
478 void fr_fifo_free(fr_fifo_t *fi);
479 int fr_fifo_push(fr_fifo_t *fi, void *data);
480 void *fr_fifo_pop(fr_fifo_t *fi);
481 void *fr_fifo_peek(fr_fifo_t *fi);
482 int fr_fifo_num_elements(fr_fifo_t *fi);
484 #include <freeradius-devel/packet.h>
487 #include <freeradius-devel/tcp.h>
490 #endif /*LIBRADIUS_H*/