fr_strerror -> fr_strerror()
[freeradius.git] / 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 #define EAP_START               2
57
58 #define AUTH_VECTOR_LEN         16
59 #define CHAP_VALUE_LENGTH       16
60 #define MAX_STRING_LEN          254     /* RFC2138: string 0-253 octets */
61
62 #  define VENDOR(x)             ((x >> 16) & 0x7fff)
63
64 #ifdef _LIBRADIUS
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); \
74                                      } \
75                                 } while(0)
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 */
79 #endif
80
81 #if defined(__GNUC__)
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 */
86 #else
87 # define PRINTF_LIKE(n) /* ignore */
88 # define NEVER_RETURNS /* ignore */
89 # define UNUSED /* ignore */
90 # define BLANK_FORMAT ""
91 #endif
92
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 */
104
105         int8_t                  tag;          /* tag for tunneled attributes */
106         uint8_t                 encrypt;      /* encryption method */
107 } ATTR_FLAGS;
108
109 /*
110  *  Values of the encryption flags.
111  */
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)
116
117 typedef struct dict_attr {
118         int                     attr;
119         int                     type;
120         int                     vendor;
121         ATTR_FLAGS              flags;
122         char                    name[1];
123 } DICT_ATTR;
124
125 typedef struct dict_value {
126         int                     attr;
127         int                     value;
128         char                    name[1];
129 } DICT_VALUE;
130
131 typedef struct dict_vendor {
132         int                     vendorpec;
133         int                     type; /* length of type data */
134         int                     length; /* length of length data */
135         int                     flags;
136         char                    name[1];
137 } DICT_VENDOR;
138
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;
144         uint32_t                date;
145         uint32_t                integer;
146         int32_t                 sinteger;
147         uint8_t                 filter[32];
148         uint8_t                 ifid[8]; /* struct? */
149         uint8_t                 ipv6prefix[18]; /* struct? */
150         uint8_t                 ether[6];
151         uint8_t                 *tlv;
152 } VALUE_PAIR_DATA;
153
154 typedef struct value_pair {
155         const char              *name;
156         int                     attribute;
157         int                     vendor;
158         int                     type;
159         size_t                  length; /* of data */
160         FR_TOKEN                operator;
161         ATTR_FLAGS              flags;
162         struct value_pair       *next;
163         uint32_t                lvalue;
164         VALUE_PAIR_DATA         data;
165 } VALUE_PAIR;
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
175
176 #if 0
177 #define vp_ipaddr     data.ipaddr.s_addr
178 #define vp_date       data.date
179 #define vp_integer    data.integer
180 #else
181 /*
182  *      These are left as lvalue until we audit the source for code
183  *      that prints to vp_strvalue for integer/ipaddr/date types.
184  */
185 #define vp_ipaddr     lvalue
186 #define vp_date       lvalue
187 #define vp_integer    lvalue
188 #endif
189
190
191 typedef struct fr_ipaddr_t {
192         int             af;     /* address family */
193         union {
194                 struct in_addr  ip4addr;
195                 struct in6_addr ip6addr; /* maybe defined in missing.h */
196         } ipaddr;
197 } fr_ipaddr_t;
198
199 /*
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
203  *
204  *      verified:       Filled in by rad_decode for accounting-request packets
205  *
206  *      data,data_len:  Used between rad_recv and rad_decode.
207  */
208 typedef struct radius_packet {
209         int                     sockfd;
210         fr_ipaddr_t             src_ipaddr;
211         fr_ipaddr_t             dst_ipaddr;
212         uint16_t                src_port;
213         uint16_t                dst_port;
214         int                     id;
215         unsigned int            code;
216         uint32_t                hash;
217         uint8_t                 vector[AUTH_VECTOR_LEN];
218         time_t                  timestamp;
219         uint8_t                 *data;
220         int                     data_len;
221         VALUE_PAIR              *vps;
222         ssize_t                 offset;
223 } RADIUS_PACKET;
224
225 /*
226  *      Printing functions.
227  */
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
237
238 /*
239  *      Dictionary functions.
240  */
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);
252
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*/
258 #endif
259
260 /* get around diffrent ctime_r styles */
261 #ifdef CTIMERSTYLE
262 #if CTIMERSTYLE == SOLARISSTYLE
263 #define CTIME_R(a,b,c) ctime_r(a,b,c)
264 #else
265 #define CTIME_R(a,b,c) ctime_r(a,b)
266 #endif
267 #else
268 #define CTIME_R(a,b,c) ctime_r(a,b)
269 #endif
270
271 /* md5.c */
272
273 void            fr_md5_calc(uint8_t *, const uint8_t *, unsigned int);
274
275 /* hmac.c */
276
277 void fr_hmac_md5(const uint8_t *text, int text_len,
278                    const uint8_t *key, int key_len,
279                    unsigned char *digest);
280
281 /* hmacsha1.c */
282
283 void fr_hmac_sha1(const uint8_t *text, int text_len,
284                     const uint8_t *key, int key_len,
285                     uint8_t *digest);
286
287 /* radius.c */
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,
292                         int *code);
293 void            rad_recv_discard(int sockfd);
294 int             rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
295                            const char *secret);
296 int             rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, const char *secret);
297 int             rad_encode(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
298                            const char *secret);
299 int             rad_sign(RADIUS_PACKET *packet, const RADIUS_PACKET *original,
300                          const char *secret);
301
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);
320
321 /* valuepair.c */
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);
341
342 /*
343  *      Error functions.
344  */
345 #ifdef _LIBRADIUS
346 void            fr_strerror_printf(const char *, ...)
347 #ifdef __GNUC__
348                 __attribute__ ((format (printf, 1, 2)))
349 #endif
350 ;
351 #endif
352 void            fr_perror(const char *, ...)
353 #ifdef __GNUC__
354                 __attribute__ ((format (printf, 1, 2)))
355 #endif
356 ;
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 *, ...)
363 #ifdef __GNUC__
364                 __attribute__ ((format (printf, 1, 2)))
365 #endif
366 ;
367
368 /*
369  *      Several handy miscellaneous functions.
370  */
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);
381 #endif
382 #ifndef HAVE_INET_NTOP
383 const char      *inet_ntop(int af, const void *src, char *dst, size_t cnt);
384 #endif
385 #ifndef HAVE_CLOSEFROM
386 int             closefrom(int fd);
387 #endif
388 int fr_ipaddr_cmp(const fr_ipaddr_t *a, const fr_ipaddr_t *b);
389
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);
396
397
398 #ifdef ASCEND_BINARY
399 /* filters.c */
400 int             ascend_parse_filter(VALUE_PAIR *pair);
401 void            print_abinary(VALUE_PAIR *vp, char *buffer, size_t len);
402 #endif /*ASCEND_BINARY*/
403
404 /* random numbers in isaac.c */
405 /* context of random number generator */
406 typedef struct fr_randctx {
407   uint32_t randcnt;
408   uint32_t randrsl[256];
409   uint32_t randmem[256];
410   uint32_t randa;
411   uint32_t randb;
412   uint32_t randc;
413 } fr_randctx;
414
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 */
419
420
421 /* crypt wrapper from crypt.c */
422 int fr_crypt_check(const char *key, const char *salt);
423
424 /* rbtree.c */
425 typedef struct rbtree_t rbtree_t;
426 typedef struct rbnode_t rbnode_t;
427
428 rbtree_t       *rbtree_create(int (*Compare)(const void *, const void *),
429                                void (*freeNode)(void *),
430                                int replace_flag);
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);
441
442 /* callback order for walking  */
443 typedef enum { PreOrder, InOrder, PostOrder } RBTREE_ORDER;
444
445 /*
446  *      The callback should be declared as:
447  *      int callback(void *context, void *data)
448  *
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.
452  *
453  *      It should return 0 if all is OK, and !0 for any error.
454  *      The walking will stop on any error.
455  */
456 int rbtree_walk(rbtree_t *tree, RBTREE_ORDER order, int (*callback)(void *, void *), void *context);
457
458 /*
459  *      FIFOs
460  */
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);
469
470 #include <freeradius-devel/packet.h>
471
472 #endif /*LIBRADIUS_H*/