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>
58 #define AUTH_VECTOR_LEN 16
59 #define CHAP_VALUE_LENGTH 16
60 #define MAX_STRING_LEN 254 /* RFC2138: string 0-253 octets */
62 # define VENDOR(x) ((x >> 16) & 0x7fff)
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 (fr_debug_flag && fr_log_fp) fr_printf_log
70 # define debug_pair(vp) do { if (fr_debug_flag && fr_log_fp) { \
71 fputc('\t', fr_log_fp); \
72 vp_print(fr_log_fp, vp); \
73 fputc('\n', fr_log_fp); \
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 */
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 */
87 # define PRINTF_LIKE(n) /* ignore */
88 # define NEVER_RETURNS /* ignore */
89 # define UNUSED /* ignore */
90 # define BLANK_FORMAT ""
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 unsigned int has_tlv : 1; /* has sub attributes */
102 unsigned int is_tlv : 1; /* is a sub attribute */
103 unsigned int encoded : 1; /* has been put into packet */
105 int8_t tag; /* tag for tunneled attributes */
106 uint8_t encrypt; /* encryption method */
110 * Values of the encryption flags.
112 #define FLAG_ENCRYPT_NONE (0)
113 #define FLAG_ENCRYPT_USER_PASSWORD (1)
114 #define FLAG_ENCRYPT_TUNNEL_PASSWORD (2)
115 #define FLAG_ENCRYPT_ASCEND_SECRET (3)
117 typedef struct dict_attr {
125 typedef struct dict_value {
131 typedef struct dict_vendor {
133 int type; /* length of type data */
134 int length; /* length of length data */
139 typedef union value_pair_data {
140 char strvalue[MAX_STRING_LEN];
141 uint8_t octets[MAX_STRING_LEN];
142 struct in_addr ipaddr;
143 struct in6_addr ipv6addr;
148 uint8_t ifid[8]; /* struct? */
149 uint8_t ipv6prefix[18]; /* struct? */
154 typedef struct value_pair {
159 size_t length; /* of data */
162 struct value_pair *next;
164 VALUE_PAIR_DATA data;
166 #define vp_strvalue data.strvalue
167 #define vp_octets data.octets
168 #define vp_ipv6addr data.ipv6addr
169 #define vp_ifid data.ifid
170 #define vp_ipv6prefix data.ipv6prefix
171 #define vp_filter data.filter
172 #define vp_ether data.ether
173 #define vp_signed data.sinteger
174 #define vp_tlv data.tlv
177 #define vp_ipaddr data.ipaddr.s_addr
178 #define vp_date data.date
179 #define vp_integer data.integer
182 * These are left as lvalue until we audit the source for code
183 * that prints to vp_strvalue for integer/ipaddr/date types.
185 #define vp_ipaddr lvalue
186 #define vp_date lvalue
187 #define vp_integer lvalue
191 typedef struct fr_ipaddr_t {
192 int af; /* address family */
194 struct in_addr ip4addr;
195 struct in6_addr ip6addr; /* maybe defined in missing.h */
200 * vector: Request authenticator from access-request packet
201 * Put in there by rad_decode, and must be put in the
202 * response RADIUS_PACKET as well before calling rad_send
204 * verified: Filled in by rad_decode for accounting-request packets
206 * data,data_len: Used between rad_recv and rad_decode.
208 typedef struct radius_packet {
210 fr_ipaddr_t src_ipaddr;
211 fr_ipaddr_t dst_ipaddr;
217 uint8_t vector[AUTH_VECTOR_LEN];
226 * Printing functions.
228 void fr_print_string(char *in, size_t inlen,
229 char *out, size_t outlen);
230 int vp_prints_value(char *out, size_t outlen,
231 VALUE_PAIR *vp, int delimitst);
232 const char *vp_print_name(char *buffer, size_t bufsize, int attr);
233 int vp_prints(char *out, size_t outlen, VALUE_PAIR *vp);
234 void vp_print(FILE *, VALUE_PAIR *);
235 void vp_printlist(FILE *, VALUE_PAIR *);
236 #define fprint_attr_val vp_print
239 * Dictionary functions.
241 int dict_addvendor(const char *name, int value);
242 int dict_addattr(const char *name, int vendor, int type, int value, ATTR_FLAGS flags);
243 int dict_addvalue(const char *namestr, const char *attrstr, int value);
244 int dict_init(const char *dir, const char *fn);
245 void dict_free(void);
246 DICT_ATTR *dict_attrbyvalue(int attr);
247 DICT_ATTR *dict_attrbyname(const char *attr);
248 DICT_VALUE *dict_valbyattr(int attr, int val);
249 DICT_VALUE *dict_valbyname(int attr, const char *val);
250 int dict_vendorbyname(const char *name);
251 DICT_VENDOR *dict_vendorbyvalue(int vendor);
253 #if 1 /* FIXME: compat */
254 #define dict_attrget dict_attrbyvalue
255 #define dict_attrfind dict_attrbyname
256 #define dict_valfind dict_valbyname
257 /*#define dict_valget dict_valbyattr almost but not quite*/
260 /* get around diffrent ctime_r styles */
262 #if CTIMERSTYLE == SOLARISSTYLE
263 #define CTIME_R(a,b,c) ctime_r(a,b,c)
265 #define CTIME_R(a,b,c) ctime_r(a,b)
268 #define CTIME_R(a,b,c) ctime_r(a,b)
273 void fr_md5_calc(uint8_t *, const uint8_t *, unsigned int);
277 void fr_hmac_md5(const uint8_t *text, int text_len,
278 const uint8_t *key, int key_len,
279 unsigned char *digest);
283 void fr_hmac_sha1(const uint8_t *text, int text_len,
284 const uint8_t *key, int key_len,
288 int rad_send(RADIUS_PACKET *, const RADIUS_PACKET *, const char *secret);
289 int rad_packet_ok(RADIUS_PACKET *packet, int flags);
290 RADIUS_PACKET *rad_recv(int fd, int flags);
291 ssize_t rad_recv_header(int sockfd, fr_ipaddr_t *src_ipaddr, int *src_port,
293 void rad_recv_discard(int sockfd);
294 int rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
296 int rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, const char *secret);
297 int rad_encode(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
299 int rad_sign(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
302 RADIUS_PACKET *rad_alloc(int newvector);
303 void rad_free(RADIUS_PACKET **);
304 int rad_pwencode(char *encpw, size_t *len, const char *secret,
305 const uint8_t *vector);
306 int rad_pwdecode(char *encpw, size_t len, const char *secret,
307 const uint8_t *vector);
308 int rad_tunnel_pwencode(char *encpw, size_t *len, const char *secret,
309 const uint8_t *vector);
310 int rad_tunnel_pwdecode(uint8_t *encpw, size_t *len,
311 const char *secret, const uint8_t *vector);
312 int rad_chap_encode(RADIUS_PACKET *packet, uint8_t *output,
313 int id, VALUE_PAIR *password);
314 VALUE_PAIR *rad_attr2vp(const RADIUS_PACKET *packet, const RADIUS_PACKET *original,
315 const char *secret, int attribute, int length,
316 const uint8_t *data);
317 int rad_vp2attr(const RADIUS_PACKET *packet,
318 const RADIUS_PACKET *original, const char *secret,
319 const VALUE_PAIR *vp, uint8_t *ptr);
322 VALUE_PAIR *pairalloc(DICT_ATTR *da);
323 VALUE_PAIR *paircreate(int attr, int type);
324 void pairfree(VALUE_PAIR **);
325 void pairbasicfree(VALUE_PAIR *pair);
326 VALUE_PAIR *pairfind(VALUE_PAIR *, int);
327 void pairdelete(VALUE_PAIR **, int);
328 void pairadd(VALUE_PAIR **, VALUE_PAIR *);
329 void pairreplace(VALUE_PAIR **first, VALUE_PAIR *add);
330 int paircmp(VALUE_PAIR *check, VALUE_PAIR *data);
331 VALUE_PAIR *paircopyvp(const VALUE_PAIR *vp);
332 VALUE_PAIR *paircopy(VALUE_PAIR *vp);
333 VALUE_PAIR *paircopy2(VALUE_PAIR *vp, int attr);
334 void pairmove(VALUE_PAIR **to, VALUE_PAIR **from);
335 void pairmove2(VALUE_PAIR **to, VALUE_PAIR **from, int attr);
336 VALUE_PAIR *pairparsevalue(VALUE_PAIR *vp, const char *value);
337 VALUE_PAIR *pairmake(const char *attribute, const char *value, int operator);
338 VALUE_PAIR *pairread(const char **ptr, FR_TOKEN *eol);
339 FR_TOKEN userparse(const char *buffer, VALUE_PAIR **first_pair);
340 VALUE_PAIR *readvp2(FILE *fp, int *pfiledone, const char *errprefix);
346 void fr_strerror_printf(const char *, ...)
348 __attribute__ ((format (printf, 1, 2)))
352 void fr_perror(const char *, ...)
354 __attribute__ ((format (printf, 1, 2)))
357 extern const char *fr_strerror(void);
358 extern int fr_dns_lookups; /* 0 = no dns lookups */
359 extern int fr_debug_flag; /* 0 = no debugging information */
360 extern int fr_max_attributes; /* per incoming packet */
361 extern FILE *fr_log_fp;
362 void fr_printf_log(const char *, ...)
364 __attribute__ ((format (printf, 1, 2)))
369 * Several handy miscellaneous functions.
371 const char * ip_ntoa(char *, uint32_t);
372 char *ifid_ntoa(char *buffer, size_t size, uint8_t *ifid);
373 uint8_t *ifid_aton(const char *ifid_str, uint8_t *ifid);
374 int rad_lockfd(int fd, int lock_len);
375 int rad_lockfd_nonblock(int fd, int lock_len);
376 int rad_unlockfd(int fd, int lock_len);
377 void fr_bin2hex(const uint8_t *bin, char *hex, size_t len);
378 size_t fr_hex2bin(const char *hex, uint8_t *bin, size_t len);
379 #ifndef HAVE_INET_PTON
380 int inet_pton(int af, const char *src, void *dst);
382 #ifndef HAVE_INET_NTOP
383 const char *inet_ntop(int af, const void *src, char *dst, size_t cnt);
385 #ifndef HAVE_CLOSEFROM
386 int closefrom(int fd);
388 int fr_ipaddr_cmp(const fr_ipaddr_t *a, const fr_ipaddr_t *b);
390 int ip_hton(const char *src, int af, fr_ipaddr_t *dst);
391 const char *ip_ntoh(const fr_ipaddr_t *src, char *dst, size_t cnt);
392 int fr_ipaddr2sockaddr(const fr_ipaddr_t *ipaddr, int port,
393 struct sockaddr_storage *sa, socklen_t *salen);
394 int fr_sockaddr2ipaddr(const struct sockaddr_storage *sa, socklen_t salen,
395 fr_ipaddr_t *ipaddr, int * port);
400 int ascend_parse_filter(VALUE_PAIR *pair);
401 void print_abinary(VALUE_PAIR *vp, char *buffer, size_t len);
402 #endif /*ASCEND_BINARY*/
404 /* random numbers in isaac.c */
405 /* context of random number generator */
406 typedef struct fr_randctx {
408 uint32_t randrsl[256];
409 uint32_t randmem[256];
415 void fr_isaac(fr_randctx *ctx);
416 void fr_randinit(fr_randctx *ctx, int flag);
417 uint32_t fr_rand(void); /* like rand(), but better. */
418 void fr_rand_seed(const void *, size_t ); /* seed the random pool */
421 /* crypt wrapper from crypt.c */
422 int fr_crypt_check(const char *key, const char *salt);
425 typedef struct rbtree_t rbtree_t;
426 typedef struct rbnode_t rbnode_t;
428 rbtree_t *rbtree_create(int (*Compare)(const void *, const void *),
429 void (*freeNode)(void *),
431 void rbtree_free(rbtree_t *tree);
432 int rbtree_insert(rbtree_t *tree, void *Data);
433 rbnode_t *rbtree_insertnode(rbtree_t *tree, void *Data);
434 void rbtree_delete(rbtree_t *tree, rbnode_t *Z);
435 int rbtree_deletebydata(rbtree_t *tree, const void *data);
436 rbnode_t *rbtree_find(rbtree_t *tree, const void *Data);
437 void *rbtree_finddata(rbtree_t *tree, const void *Data);
438 int rbtree_num_elements(rbtree_t *tree);
439 void *rbtree_min(rbtree_t *tree);
440 void *rbtree_node2data(rbtree_t *tree, rbnode_t *node);
442 /* callback order for walking */
443 typedef enum { PreOrder, InOrder, PostOrder } RBTREE_ORDER;
446 * The callback should be declared as:
447 * int callback(void *context, void *data)
449 * The "context" is some user-defined context.
450 * The "data" is the pointer to the user data in the node,
451 * NOT the node itself.
453 * It should return 0 if all is OK, and !0 for any error.
454 * The walking will stop on any error.
456 int rbtree_walk(rbtree_t *tree, RBTREE_ORDER order, int (*callback)(void *, void *), void *context);
461 typedef struct fr_fifo_t fr_fifo_t;
462 typedef void (*fr_fifo_free_t)(void *);
463 fr_fifo_t *fr_fifo_create(int max_entries, fr_fifo_free_t freeNode);
464 void fr_fifo_free(fr_fifo_t *fi);
465 int fr_fifo_push(fr_fifo_t *fi, void *data);
466 void *fr_fifo_pop(fr_fifo_t *fi);
467 void *fr_fifo_peek(fr_fifo_t *fi);
468 int fr_fifo_num_elements(fr_fifo_t *fi);
470 #include <freeradius-devel/packet.h>
472 #endif /*LIBRADIUS_H*/