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 2001,2002,2003,2004,2005,2006 The FreeRADIUS server project
27 #ifdef HAVE_SYS_TYPES_H
28 #include <sys/types.h>
35 #ifdef HAVE_INTTYPES_H
43 #ifdef HAVE_NETINET_IN_H
44 #include <netinet/in.h>
47 #ifdef HAVE_ARPA_INET_H
48 #include <arpa/inet.h>
51 #ifdef HAVE_SYS_SOCKET_H
52 #include <sys/socket.h>
58 * Check for inclusion of <time.h>, versus <sys/time.h>
59 * Taken verbatim from the autoconf manual.
61 #if TIME_WITH_SYS_TIME
62 # include <sys/time.h>
65 # ifdef HAVE_SYS_TIME_H
66 # include <sys/time.h>
72 #include <freeradius-devel/radius.h>
73 #include <freeradius-devel/token.h>
74 #include <freeradius-devel/hash.h>
76 #ifdef SIZEOF_UNSIGNED_INT
77 #if SIZEOF_UNSIGNED_INT != 4
78 #error FATAL: sizeof(unsigned int) != 4
83 * Include for modules.
85 #include <freeradius-devel/sha1.h>
86 #include <freeradius-devel/md4.h>
90 #define AUTH_VECTOR_LEN 16
91 #define CHAP_VALUE_LENGTH 16
92 #define MAX_STRING_LEN 254 /* RFC2138: string 0-253 octets */
95 # define AUTH_HDR_LEN 20
96 # define VENDORPEC_USR 429
97 #define VENDORPEC_LUCENT 4846
98 #define VENDORPEC_STARENT 8164
99 # define VENDOR(x) ((x >> 16) & 0xffff)
100 # define DEBUG if (librad_debug) printf
101 # define debug_pair(vp) do { if (librad_debug) { \
103 vp_print(stdout, vp); \
107 # define TAG_VALID(x) ((x) > 0 && (x) < 0x20)
108 # define TAG_VALID_ZERO(x) ((x) < 0x20)
109 # define TAG_ANY -128 /* minimum signed char */
112 #if defined(__GNUC__)
113 # define PRINTF_LIKE(n) __attribute__ ((format(printf, n, n+1)))
114 # define NEVER_RETURNS __attribute__ ((noreturn))
115 # define UNUSED __attribute__ ((unused))
116 # define BLANK_FORMAT " " /* GCC_LINT whines about empty formats */
118 # define PRINTF_LIKE(n) /* ignore */
119 # define NEVER_RETURNS /* ignore */
120 # define UNUSED /* ignore */
121 # define BLANK_FORMAT ""
124 typedef struct attr_flags {
125 unsigned int addport : 1; /* add NAS-Port to IP address */
126 unsigned int has_tag : 1; /* tagged attribute */
127 unsigned int do_xlat : 1; /* strvalue is dynamic */
128 unsigned int caseless : 1; /* case insensitive compares */
130 int8_t tag; /* tag for tunneled attributes */
131 uint8_t encrypt; /* encryption method */
135 * Values of the encryption flags.
137 #define FLAG_ENCRYPT_NONE (0)
138 #define FLAG_ENCRYPT_USER_PASSWORD (1)
139 #define FLAG_ENCRYPT_TUNNEL_PASSWORD (2)
140 #define FLAG_ENCRYPT_ASCEND_SECRET (3)
142 typedef struct dict_attr {
150 typedef struct dict_value {
156 typedef struct dict_vendor {
158 int type; /* length of type data */
159 int length; /* length of length data */
163 typedef struct value_pair {
167 int length; /* of data */
169 uint32_t lvalue; /* DELETE ME ASAP */
171 struct value_pair *next;
173 char strvalue[MAX_STRING_LEN];
174 uint8_t octets[MAX_STRING_LEN];
175 struct in_addr ipaddr;
176 struct in6_addr ipv6addr;
180 uint8_t ifid[8]; /* struct? */
181 uint8_t ipv6prefix[18]; /* struct? */
184 #define vp_strvalue data.strvalue
185 #define vp_octets data.octets
186 #define vp_ipaddr lvalue
187 #define vp_ipv6addr data.ipv6addr
188 #define vp_data lvalue
189 #define vp_integer lvalue
190 #define vp_ifid data.ifid
191 #define vp_ipv6prefix data.ipv6prefix
192 #define vp_filter data.filter
195 typedef struct lrad_ipaddr_t {
196 int af; /* address family */
198 struct in_addr ip4addr;
199 struct in6_addr ip6addr; /* maybe defined in missing.h */
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
209 * verified: Filled in by rad_decode for accounting-request packets
211 * data,data_len: Used between rad_recv and rad_decode.
213 typedef struct radius_packet {
215 lrad_ipaddr_t src_ipaddr;
216 lrad_ipaddr_t dst_ipaddr;
221 uint8_t vector[AUTH_VECTOR_LEN];
231 * Printing functions.
233 void librad_safeprint(char *in, int inlen, char *out, int outlen);
234 int vp_prints_value(char *out, int outlen, VALUE_PAIR *vp,int delimitst);
235 int vp_prints(char *out, int outlen, VALUE_PAIR *vp);
236 void vp_print(FILE *, VALUE_PAIR *);
237 void vp_printlist(FILE *, VALUE_PAIR *);
238 #define fprint_attr_val vp_print
241 * Dictionary functions.
243 int dict_addvendor(const char *name, int value);
244 int dict_addattr(const char *name, int vendor, int type, int value, ATTR_FLAGS flags);
245 int dict_addvalue(const char *namestr, const char *attrstr, int value);
246 int dict_init(const char *dir, const char *fn);
247 void dict_free(void);
248 DICT_ATTR *dict_attrbyvalue(int attr);
249 DICT_ATTR *dict_attrbyname(const char *attr);
250 DICT_VALUE *dict_valbyattr(int attr, int val);
251 DICT_VALUE *dict_valbyname(int attr, const char *val);
252 int dict_vendorbyname(const char *name);
253 DICT_VENDOR *dict_vendorbyvalue(int vendor);
255 #if 1 /* FIXME: compat */
256 #define dict_attrget dict_attrbyvalue
257 #define dict_attrfind dict_attrbyname
258 #define dict_valfind dict_valbyname
259 /*#define dict_valget dict_valbyattr almost but not quite*/
262 /* get around diffrent ctime_r styles */
264 #if CTIMERSTYLE == SOLARISSTYLE
265 #define CTIME_R(a,b,c) ctime_r(a,b,c)
267 #define CTIME_R(a,b,c) ctime_r(a,b)
270 #define CTIME_R(a,b,c) ctime_r(a,b)
275 void librad_md5_calc(uint8_t *, const uint8_t *, unsigned int);
279 void lrad_hmac_md5(const uint8_t *text, int text_len,
280 const uint8_t *key, int key_len,
281 unsigned char *digest);
285 void lrad_hmac_sha1(const uint8_t *text, int text_len,
286 const uint8_t *key, int key_len,
290 int rad_send(RADIUS_PACKET *, const RADIUS_PACKET *, const char *secret);
291 int rad_packet_ok(RADIUS_PACKET *packet);
292 RADIUS_PACKET *rad_recv(int fd);
293 int rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
295 int rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, const char *secret);
296 int rad_encode(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
298 int rad_sign(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
301 RADIUS_PACKET *rad_alloc(int newvector);
302 void rad_free(RADIUS_PACKET **);
303 int rad_pwencode(char *encpw, int *len, const char *secret,
304 const uint8_t *vector);
305 int rad_pwdecode(char *encpw, int len, const char *secret,
306 const uint8_t *vector);
307 int rad_tunnel_pwencode(char *encpw, int *len, const char *secret,
308 const uint8_t *vector);
309 int rad_tunnel_pwdecode(uint8_t *encpw, int *len,
310 const char *secret, const uint8_t *vector);
311 int rad_chap_encode(RADIUS_PACKET *packet, uint8_t *output,
312 int id, VALUE_PAIR *password);
313 VALUE_PAIR *rad_attr2vp(const RADIUS_PACKET *packet, const RADIUS_PACKET *original,
314 const char *secret, int attribute, int length,
315 const uint8_t *data);
316 int rad_vp2attr(const RADIUS_PACKET *packet,
317 const RADIUS_PACKET *original, const char *secret,
318 const VALUE_PAIR *vp, uint8_t *ptr);
321 VALUE_PAIR *paircreate(int attr, int type);
322 void pairfree(VALUE_PAIR **);
323 void pairbasicfree(VALUE_PAIR *pair);
324 VALUE_PAIR *pairfind(VALUE_PAIR *, int);
325 void pairdelete(VALUE_PAIR **, int);
326 void pairadd(VALUE_PAIR **, VALUE_PAIR *);
327 void pairreplace(VALUE_PAIR **first, VALUE_PAIR *add);
328 int paircmp(VALUE_PAIR *check, VALUE_PAIR *data);
329 VALUE_PAIR *paircopy(VALUE_PAIR *vp);
330 VALUE_PAIR *paircopy2(VALUE_PAIR *vp, int attr);
331 void pairmove(VALUE_PAIR **to, VALUE_PAIR **from);
332 void pairmove2(VALUE_PAIR **to, VALUE_PAIR **from, int attr);
333 VALUE_PAIR *pairparsevalue(VALUE_PAIR *vp, const char *value);
334 VALUE_PAIR *pairmake(const char *attribute, const char *value, int operator);
335 VALUE_PAIR *pairread(char **ptr, LRAD_TOKEN *eol);
336 LRAD_TOKEN userparse(char *buffer, VALUE_PAIR **first_pair);
337 VALUE_PAIR *readvp2(FILE *fp, int *pfiledone, const char *errprefix);
343 void librad_log(const char *, ...)
345 __attribute__ ((format (printf, 1, 2)))
349 void librad_perror(const char *, ...)
351 __attribute__ ((format (printf, 1, 2)))
354 extern char librad_errstr[];
355 extern int librad_dodns; /* 0 = no dns lookups */
356 extern int librad_debug; /* 0 = no debugging information */
357 extern int librad_max_attributes; /* per incoming packet */
360 * Several handy miscellaneous functions.
362 const char * ip_ntoa(char *, uint32_t);
363 char *ifid_ntoa(char *buffer, size_t size, uint8_t *ifid);
364 uint8_t *ifid_aton(const char *ifid_str, uint8_t *ifid);
365 char *strNcpy(char *dest, const char *src, int n);
366 int rad_lockfd(int fd, int lock_len);
367 int rad_lockfd_nonblock(int fd, int lock_len);
368 int rad_unlockfd(int fd, int lock_len);
369 void lrad_bin2hex(const uint8_t *bin, char *hex, int len);
370 int lrad_hex2bin(const char *hex, uint8_t *bin, int len);
371 #ifndef HAVE_INET_PTON
372 int inet_pton(int af, const char *src, void *dst);
374 #ifndef HAVE_INET_NTOP
375 const char *inet_ntop(int af, const void *src, char *dst, size_t cnt);
377 #ifndef HAVE_CLOSEFROM
378 int closefrom(int fd);
381 int ip_hton(const char *src, int af, lrad_ipaddr_t *dst);
382 const char *ip_ntoh(const lrad_ipaddr_t *src, char *dst, size_t cnt);
387 int ascend_parse_filter(VALUE_PAIR *pair);
388 void print_abinary(VALUE_PAIR *vp, char *buffer, int len);
389 #endif /*ASCEND_BINARY*/
391 /* random numbers in isaac.c */
392 /* context of random number generator */
393 typedef struct lrad_randctx {
395 uint32_t randrsl[256];
396 uint32_t randmem[256];
402 void lrad_isaac(lrad_randctx *ctx);
403 void lrad_randinit(lrad_randctx *ctx, int flag);
404 uint32_t lrad_rand(void); /* like rand(), but better. */
405 void lrad_rand_seed(const void *, size_t ); /* seed the random pool */
408 /* crypt wrapper from crypt.c */
409 int lrad_crypt_check(const char *key, const char *salt);
412 typedef struct rbtree_t rbtree_t;
413 typedef struct rbnode_t rbnode_t;
415 rbtree_t *rbtree_create(int (*Compare)(const void *, const void *),
416 void (*freeNode)(void *),
418 void rbtree_free(rbtree_t *tree);
419 int rbtree_insert(rbtree_t *tree, void *Data);
420 void rbtree_delete(rbtree_t *tree, rbnode_t *Z);
421 int rbtree_deletebydata(rbtree_t *tree, const void *data);
422 rbnode_t *rbtree_find(rbtree_t *tree, const void *Data);
423 void *rbtree_finddata(rbtree_t *tree, const void *Data);
424 int rbtree_num_elements(rbtree_t *tree);
425 void *rbtree_node2data(rbtree_t *tree, rbnode_t *node);
427 /* callback order for walking */
428 typedef enum { PreOrder, InOrder, PostOrder } RBTREE_ORDER;
431 * The callback should be declared as:
432 * int callback(void *context, void *data)
434 * The "context" is some user-defined context.
435 * The "data" is the pointer to the user data in the node,
436 * NOT the node itself.
438 * It should return 0 if all is OK, and !0 for any error.
439 * The walking will stop on any error.
441 int rbtree_walk(rbtree_t *tree, RBTREE_ORDER order, int (*callback)(void *, void *), void *context);
446 typedef struct lrad_fifo_t lrad_fifo_t;
447 typedef void (*lrad_fifo_free_t)(void *);
448 lrad_fifo_t *lrad_fifo_create(int max_entries, lrad_fifo_free_t freeNode);
449 void lrad_fifo_free(lrad_fifo_t *fi);
450 int lrad_fifo_push(lrad_fifo_t *fi, void *data);
451 void *lrad_fifo_pop(lrad_fifo_t *fi);
453 #include <freeradius-devel/packet.h>
455 #endif /*LIBRADIUS_H*/