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: 2f15b7aaf1fae0a8636443aae1ac606fab50dc90 $
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: 2f15b7aaf1fae0a8636443aae1ac606fab50dc90 $")
27
28 /*
29 * Compiler hinting macros. Included here for 3rd party consumers
30 * of libradius.h.
31 */
32 #include <freeradius-devel/build.h>
33
34 /*
35 * Let any external program building against the library know what
36 * features the library was built with.
37 */
38 #include <freeradius-devel/features.h>
39
40 #ifdef WITHOUT_VERSION_CHECK
41 # define RADIUSD_MAGIC_NUMBER ((uint64_t) (0xf4ee4ad3f4ee4ad3))
42 # define MAGIC_PREFIX(_x) ((uint8_t) 0x00)
43 # define MAGIC_VERSION(_x) ((uint32_t) 0x00000000)
44 # define MAGIC_COMMIT(_x) ((uint32_t) 0x00000000)
45 #else
46 # ifdef RADIUSD_VERSION_COMMIT
47 # define RADIUSD_MAGIC_NUMBER ((uint64_t) HEXIFY3(f, RADIUSD_VERSION, RADIUSD_VERSION_COMMIT))
48 # else
49 # define RADIUSD_MAGIC_NUMBER ((uint64_t) HEXIFY3(f, RADIUSD_VERSION, 00000))
50 # endif
51 # define MAGIC_PREFIX(_x) ((uint8_t) (_x >> 56))
52 # define MAGIC_VERSION(_x) ((uint32_t) ((_x >> 32) & 0x00ffffff))
53 # define MAGIC_COMMIT(_x) ((uint32_t) (_x & 0xffffffff))
54 #endif
55
56 /*
57 * Talloc memory allocation is used in preference to malloc throughout
58 * the libraries and server.
59 */
60 #ifdef HAVE_WDOCUMENTATION
DIAG_OFF(documentation)61 DIAG_OFF(documentation)
62 #endif
63 #include <talloc.h>
64 #ifdef HAVE_WDOCUMENTATION
65 DIAG_ON(documentation)
66 #endif
67
68 /*
69 * Defines signatures for any missing functions.
70 */
71 #include <freeradius-devel/missing.h>
72
73 /*
74 * Include system headers.
75 */
76 #include <stdio.h>
77 #include <stdlib.h>
78 #include <stdarg.h>
79 #include <stdbool.h>
80 #include <signal.h>
81
82 #ifdef HAVE_LIMITS_H
83 # include <limits.h>
84 #endif
85
86 #include <freeradius-devel/threads.h>
87 #include <freeradius-devel/radius.h>
88 #include <freeradius-devel/token.h>
89 #include <freeradius-devel/hash.h>
90 #include <freeradius-devel/regex.h>
91
92 #ifdef SIZEOF_UNSIGNED_INT
93 # if SIZEOF_UNSIGNED_INT != 4
94 # error FATAL: sizeof(unsigned int) != 4
95 # endif
96 #endif
97
98 /*
99 * Include for modules.
100 */
101 #include <freeradius-devel/sha1.h>
102 #include <freeradius-devel/md4.h>
103
104 #ifdef __cplusplus
105 extern "C" {
106 #endif
107
108 #ifndef HAVE_SIG_T
109 typedef void (*sig_t)(int);
110 #endif
111
112 #if defined(WITH_VERIFY_PTR)
113 # define FREE_MAGIC (0xF4EEF4EE)
114
115 /*
116 * @FIXME
117 * Add if (_x->da) (void) talloc_get_type_abort(_x->da, DICT_ATTR);
118 * to the macro below when dictionaries are talloced.
119 */
120 # define VERIFY_VP(_x) fr_pair_verify(__FILE__, __LINE__, _x)
121 # define VERIFY_LIST(_x, _name) fr_pair_list_verify(__FILE__, __LINE__, NULL, _x, _name)
122 # define VERIFY_PACKET(_x) (void) talloc_get_type_abort(_x, RADIUS_PACKET)
123 #else
124 /*
125 * Even if were building without WITH_VERIFY_PTR
126 * the pointer must not be NULL when these various macros are used
127 * so we can add some sneaky soft asserts.
128 */
129 # define VERIFY_VP(_x) fr_assert(_x)
130 # define VERIFY_LIST(_x, _name) fr_assert(_x)
131 # define VERIFY_PACKET(_x) fr_assert(_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 RADIUS_HDR_LEN 20
141 # define VENDORPEC_USR 429
142 # define VENDORPEC_LUCENT 4846
143 # define VENDORPEC_STARENT 8164
144 # define DEBUG if (fr_debug_lvl && fr_log_fp) fr_printf_log
145 #endif
146
147 # define debug_pair(vp) do { if (fr_debug_lvl && fr_log_fp) { \
148 vp_print(fr_log_fp, vp); \
149 } \
150 } while(0)
151
152 #define TAG_VALID(x) ((x) > 0 && (x) < 0x20)
153 #define TAG_VALID_ZERO(x) ((x) < 0x20)
154 #define TAG_ANY INT8_MIN
155 #define TAG_NONE 0
156 /** Check if tags are equal
157 *
158 * @param _x tag were matching on.
159 * @param _y tag belonging to the attribute were checking.
160 */
161 #define TAG_EQ(_x, _y) ((_x == _y) || (_x == TAG_ANY) || ((_x == TAG_NONE) && (_y == TAG_ANY)))
162 #define ATTRIBUTE_EQ(_x, _y) ((_x && _y) && (_x->da == _y->da) && (!_x->da->flags.has_tag || TAG_EQ(_x->tag, _y->tag)))
163
164 #define NUM_ANY INT_MIN
165 #define NUM_ALL (INT_MIN + 1)
166 #define NUM_COUNT (INT_MIN + 2)
167 #define NUM_LAST (INT_MIN + 3)
168
169 #define PAD(_x, _y) (_y - ((_x) % _y))
170
171 #define PRINTF_LIKE(n) CC_HINT(format(printf, n, n+1))
172 #define NEVER_RETURNS CC_HINT(noreturn)
173 #define UNUSED CC_HINT(unused)
174 #define BLANK_FORMAT " " /* GCC_LINT whines about empty formats */
175
176 typedef struct attr_flags {
177 unsigned int is_unknown : 1; //!< Attribute number or vendor is unknown.
178 unsigned int is_tlv : 1; //!< Is a sub attribute.
179
180 unsigned int has_tag : 1; //!< Tagged attribute.
181 unsigned int array : 1; //!< Pack multiples into 1 attr.
182 unsigned int has_value : 1; //!< Has a value.
183 unsigned int has_value_alias : 1; //!< Has a value alias.
184 unsigned int has_tlv : 1; //!< Has sub attributes.
185
186 unsigned int extended : 1; //!< Extended attribute.
187 unsigned int long_extended : 1; //!< Long format.
188 unsigned int evs : 1; //!< Extended VSA.
189 unsigned int wimax: 1; //!< WiMAX format=1,1,c.
190
191 unsigned int concat : 1; //!< concatenate multiple instances
192 unsigned int is_pointer : 1; //!< data is a pointer
193
194 unsigned int virtual : 1; //!< for dynamic expansion
195
196 unsigned int compare : 1; //!< has a paircompare registered
197
198 unsigned int is_dup : 1; //!< is a duplicate of another attribute
199
200 unsigned int secret : 1; //!< is a secret thingy
201
202 uint8_t encrypt; //!< Ecryption method.
203 uint8_t length;
204 } ATTR_FLAGS;
205
206 /*
207 * Values of the encryption flags.
208 */
209 #define FLAG_ENCRYPT_NONE (0)
210 #define FLAG_ENCRYPT_USER_PASSWORD (1)
211 #define FLAG_ENCRYPT_TUNNEL_PASSWORD (2)
212 #define FLAG_ENCRYPT_ASCEND_SECRET (3)
213
214 extern const FR_NAME_NUMBER dict_attr_types[];
215 extern const size_t dict_attr_sizes[PW_TYPE_MAX][2];
216 extern const int fr_attr_max_tlv;
217 extern const int fr_attr_shift[];
218 extern const unsigned int fr_attr_mask[];
219
220 /** dictionary attribute
221 *
222 */
223 typedef struct dict_attr {
224 unsigned int attr;
225 PW_TYPE type;
226 unsigned int vendor;
227 ATTR_FLAGS flags;
228 char name[1];
229 } DICT_ATTR;
230
231 /** value of an enumerated attribute
232 *
233 */
234 typedef struct dict_value {
235 unsigned int attr;
236 unsigned int vendor;
237 int value;
238 char name[1];
239 } DICT_VALUE;
240
241 /** dictionary vendor
242 *
243 */
244 typedef struct dict_vendor {
245 unsigned int vendorpec;
246 size_t type; //!< Length of type data
247 size_t length; //!< Length of length data
248 size_t flags;
249 char name[1];
250 } DICT_VENDOR;
251
252 /** Union containing all data types supported by the server
253 *
254 * This union contains all data types that can be represented by VALUE_PAIRs. It may also be used in other parts
255 * of the server where values of different types need to be stored.
256 *
257 * PW_TYPE should be an enumeration of the values in this union.
258 */
259 typedef union value_data {
260 char const *strvalue; //!< Pointer to UTF-8 string.
261 uint8_t const *octets; //!< Pointer to binary string.
262 uint32_t integer; //!< 32bit unsigned integer.
263 struct in_addr ipaddr; //!< IPv4 Address.
264 uint32_t date; //!< Date (32bit Unix timestamp).
265 size_t filter[32/sizeof(size_t)]; //!< Ascend binary format a packed data
266 //!< structure.
267
268 uint8_t ifid[8]; //!< IPv6 interface ID (should be struct?).
269 struct in6_addr ipv6addr; //!< IPv6 Address.
270 uint8_t ipv6prefix[18]; //!< IPv6 prefix (should be struct?).
271
272 uint8_t byte; //!< 8bit unsigned integer.
273 uint16_t ushort; //!< 16bit unsigned integer.
274
275 uint8_t ether[6]; //!< Ethernet (MAC) address.
276
277 int32_t sinteger; //!< 32bit signed integer.
278 uint64_t integer64; //!< 64bit unsigned integer.
279
280 uint8_t ipv4prefix[6]; //!< IPv4 prefix (should be struct?).
281
282 void *ptr; //!< generic pointer.
283 } value_data_t;
284
285 /** The type of value a VALUE_PAIR contains
286 *
287 * This is used to add structure to nested VALUE_PAIRs and specifies what type of node it is (set, list, data).
288 *
289 * xlat is another type of data node which must first be expanded before use.
290 */
291 typedef enum value_type {
292 VT_NONE = 0, //!< VALUE_PAIR has no value.
293 VT_SET, //!< VALUE_PAIR has children.
294 VT_LIST, //!< VALUE_PAIR has multiple values.
295 VT_DATA, //!< VALUE_PAIR has a single value.
296 VT_XLAT //!< valuepair value must be xlat expanded when it's
297 //!< added to VALUE_PAIR tree.
298 } value_type_t;
299
300 /** Stores an attribute, a value and various bits of other data
301 *
302 * VALUE_PAIRs are the main data structure used in the server
303 *
304 * They also specify what behaviour should be used when the attribute is merged into a new list/tree.
305 */
306 typedef struct value_pair {
307 DICT_ATTR const *da; //!< Dictionary attribute defines the attribute
308 //!< number, vendor and type of the attribute.
309
310 struct value_pair *next;
311
312 FR_TOKEN op; //!< Operator to use when moving or inserting
313 //!< valuepair into a list.
314
315 int8_t tag; //!< Tag value used to group valuepairs.
316
317 union {
318 // VALUE_SET *set; //!< Set of child attributes.
319 // VALUE_LIST *list; //!< List of values for
320 //!< multivalued attribute.
321 // value_data_t *data; //!< Value data for this attribute.
322
323 char const *xlat; //!< Source string for xlat expansion.
324 } value;
325
326 value_type_t type; //!< Type of pointer in value union.
327
328 size_t length; //!< of Data field.
329 value_data_t data;
330 } VALUE_PAIR;
331
332 /** Abstraction to allow iterating over different configurations of VALUE_PAIRs
333 *
334 * This allows functions which do not care about the structure of collections of VALUE_PAIRs
335 * to iterate over all members in a collection.
336 *
337 * Field within a vp_cursor should not be accessed directly, and vp_cursors should only be
338 * manipulated with the pair* functions.
339 */
340 typedef struct vp_cursor {
341 VALUE_PAIR **first;
342 VALUE_PAIR *found; //!< pairfind marker.
343 VALUE_PAIR *last; //!< Temporary only used for fr_cursor_insert
344 VALUE_PAIR *current; //!< The current attribute.
345 VALUE_PAIR *next; //!< Next attribute to process.
346 } vp_cursor_t;
347
348 /** A VALUE_PAIR in string format.
349 *
350 * Used to represent pairs in the legacy 'users' file format.
351 */
352 typedef struct value_pair_raw {
353 char l_opand[256]; //!< Left hand side of the pair.
354 char r_opand[1024]; //!< Right hand side of the pair.
355
356 FR_TOKEN quote; //!< Type of quoting around the r_opand.
357
358 FR_TOKEN op; //!< Operator.
359 } VALUE_PAIR_RAW;
360
361 #define vp_strvalue data.strvalue
362 #define vp_integer data.integer
363 #define vp_ipaddr data.ipaddr.s_addr
364 #define vp_date data.date
365 #define vp_filter data.filter
366 #define vp_octets data.octets
367 #define vp_ifid data.ifid
368 #define vp_ipv6addr data.ipv6addr
369 #define vp_ipv6prefix data.ipv6prefix
370 #define vp_byte data.byte
371 #define vp_short data.ushort
372 #define vp_ether data.ether
373 #define vp_signed data.sinteger
374 #define vp_integer64 data.integer64
375 #define vp_ipv4prefix data.ipv4prefix
376 #define vp_length length
377
378 typedef struct fr_ipaddr_t {
379 int af; /* address family */
380 union {
381 struct in_addr ip4addr;
382 struct in6_addr ip6addr; /* maybe defined in missing.h */
383 } ipaddr;
384 uint8_t prefix;
385 uint32_t scope; /* for IPv6 */
386 } fr_ipaddr_t;
387
388 /*
389 * vector: Request authenticator from access-request packet
390 * Put in there by rad_decode, and must be put in the
391 * response RADIUS_PACKET as well before calling rad_send
392 *
393 * verified: Filled in by rad_decode for accounting-request packets
394 *
395 * data,data_len: Used between rad_recv and rad_decode.
396 */
397 typedef struct radius_packet {
398 int sockfd;
399 fr_ipaddr_t src_ipaddr;
400 fr_ipaddr_t dst_ipaddr;
401 uint16_t src_port;
402 uint16_t dst_port;
403 int id;
404 unsigned int code;
405 uint8_t vector[AUTH_VECTOR_LEN];
406 struct timeval timestamp;
407 uint8_t *data;
408 size_t data_len;
409 VALUE_PAIR *vps;
410 ssize_t offset;
411 #ifdef WITH_TCP
412 size_t partial;
413 int proto;
414 #endif
415 } RADIUS_PACKET;
416
417 typedef enum {
418 DECODE_FAIL_NONE = 0,
419 DECODE_FAIL_MIN_LENGTH_PACKET,
420 DECODE_FAIL_MIN_LENGTH_FIELD,
421 DECODE_FAIL_MIN_LENGTH_MISMATCH,
422 DECODE_FAIL_HEADER_OVERFLOW,
423 DECODE_FAIL_UNKNOWN_PACKET_CODE,
424 DECODE_FAIL_INVALID_ATTRIBUTE,
425 DECODE_FAIL_ATTRIBUTE_TOO_SHORT,
426 DECODE_FAIL_ATTRIBUTE_OVERFLOW,
427 DECODE_FAIL_MA_INVALID_LENGTH,
428 DECODE_FAIL_ATTRIBUTE_UNDERFLOW,
429 DECODE_FAIL_TOO_MANY_ATTRIBUTES,
430 DECODE_FAIL_MA_MISSING,
431 DECODE_FAIL_TOO_MANY_AUTH,
432 DECODE_FAIL_MAX
433 } decode_fail_t;
434
435 /*
436 * Version check.
437 */
438 int fr_check_lib_magic(uint64_t magic);
439
440 /*
441 * Printing functions.
442 */
443 int fr_utf8_char(uint8_t const *str, ssize_t inlen);
444 char const *fr_utf8_strchr(int *chr_len, char const *str, char const *chr);
445 size_t fr_prints(char *out, size_t outlen, char const *in, ssize_t inlen, char quote);
446 size_t fr_prints_len(char const *in, ssize_t inlen, char quote);
447 char *fr_aprints(TALLOC_CTX *ctx, char const *in, ssize_t inlen, char quote);
448
449 #define is_truncated(_ret, _max) ((_ret) >= (_max))
450 #define truncate_len(_ret, _max) (((_ret) >= (_max)) ? ((_max) - 1) : _ret)
451 size_t vp_prints_value(char *out, size_t outlen, VALUE_PAIR const *vp, char quote);
452
453
454 char *vp_aprints_value(TALLOC_CTX *ctx, VALUE_PAIR const *vp, char quote);
455
456 size_t vp_prints_value_json(char *out, size_t outlen, VALUE_PAIR const *vp, bool raw_value);
457 size_t vp_prints(char *out, size_t outlen, VALUE_PAIR const *vp);
458 void vp_print(FILE *, VALUE_PAIR const *);
459 void vp_printlist(FILE *, VALUE_PAIR const *);
460 char *vp_aprints_type(TALLOC_CTX *ctx, PW_TYPE type);
461
462 char *vp_aprints(TALLOC_CTX *ctx, VALUE_PAIR const *vp, char quote);
463 #define fprint_attr_val vp_print
464
465 /*
466 * Dictionary functions.
467 */
468 #define DICT_VALUE_MAX_NAME_LEN (128)
469 #define DICT_VENDOR_MAX_NAME_LEN (128)
470 #define DICT_ATTR_MAX_NAME_LEN (128)
471
472 #define DICT_ATTR_SIZE sizeof(DICT_ATTR) + DICT_ATTR_MAX_NAME_LEN
473
474 extern const int dict_attr_allowed_chars[256];
475 int dict_valid_name(char const *name);
476 int str2argv(char *str, char **argv, int max_argc);
477 int dict_str2oid(char const *ptr, unsigned int *pattr,
478 unsigned int *pvendor, int tlv_depth);
479 int dict_addvendor(char const *name, unsigned int value);
480 int dict_addattr(char const *name, int attr, unsigned int vendor, PW_TYPE type, ATTR_FLAGS flags);
481 int dict_addvalue(char const *namestr, char const *attrstr, int value);
482 int dict_init(char const *dir, char const *fn);
483 void dict_free(void);
484 int dict_read(char const *dir, char const *filename);
485 size_t dict_print_oid(char *buffer, size_t buflen, DICT_ATTR const *da);
486 int dict_walk(fr_hash_table_walk_t callback, void *context);
487
488 void dict_attr_free(DICT_ATTR const **da);
489 int dict_unknown_from_fields(DICT_ATTR *da, unsigned int attr, unsigned int vendor);
490 DICT_ATTR const *dict_unknown_afrom_fields(TALLOC_CTX *ctx, unsigned int attr, unsigned int vendor);
491 int dict_unknown_from_str(DICT_ATTR *da, char const *name);
492 int dict_unknown_from_substr(DICT_ATTR *da, char const **name);
493 DICT_ATTR const *dict_unknown_afrom_str(TALLOC_CTX *ctx, char const *name);
494 DICT_ATTR const *dict_unknown_add(DICT_ATTR const *old);
495
496 DICT_ATTR const *dict_attrbyvalue(unsigned int attr, unsigned int vendor);
497 DICT_ATTR const *dict_attrbyname(char const *attr);
498 DICT_ATTR const *dict_attrbyname_substr(char const **name);
499 DICT_ATTR const *dict_attrbytype(unsigned int attr, unsigned int vendor,
500 PW_TYPE type);
501 DICT_ATTR const *dict_attrbyparent(DICT_ATTR const *parent, unsigned int attr,
502 unsigned int vendor);
503 DICT_ATTR const *dict_parent(unsigned int attr, unsigned int vendor);
504 int dict_attr_child(DICT_ATTR const *parent,
505 unsigned int *pattr, unsigned int *pvendor);
506 DICT_VALUE *dict_valbyattr(unsigned int attr, unsigned int vendor, int val);
507 DICT_VALUE *dict_valbyname(unsigned int attr, unsigned int vendor, char const *val);
508 char const *dict_valnamebyattr(unsigned int attr, unsigned int vendor, int value);
509 int dict_vendorbyname(char const *name);
510 DICT_VENDOR *dict_vendorbyvalue(int vendor);
511
512 #if 1 /* FIXME: compat */
513 #define dict_attrget dict_attrbyvalue
514 #define dict_attrfind dict_attrbyname
515 #define dict_valfind dict_valbyname
516 /*#define dict_valget dict_valbyattr almost but not quite*/
517 #endif
518
519 /* radius.c */
520 int rad_send(RADIUS_PACKET *, RADIUS_PACKET const *, char const *secret);
521 bool rad_packet_ok(RADIUS_PACKET *packet, int flags, decode_fail_t *reason);
522 RADIUS_PACKET *rad_recv(TALLOC_CTX *ctx, int fd, int flags);
523 ssize_t rad_recv_header(int sockfd, fr_ipaddr_t *src_ipaddr, uint16_t *src_port, int *code);
524 void rad_recv_discard(int sockfd);
525 int rad_verify(RADIUS_PACKET *packet, RADIUS_PACKET *original,
526 char const *secret);
527 int rad_decode(RADIUS_PACKET *packet, RADIUS_PACKET *original, char const *secret);
528 int rad_encode(RADIUS_PACKET *packet, RADIUS_PACKET const *original,
529 char const *secret);
530 int rad_sign(RADIUS_PACKET *packet, RADIUS_PACKET const *original,
531 char const *secret);
532
533 int rad_digest_cmp(uint8_t const *a, uint8_t const *b, size_t length);
534 RADIUS_PACKET *rad_alloc(TALLOC_CTX *ctx, bool new_vector);
535 RADIUS_PACKET *rad_alloc_reply(TALLOC_CTX *ctx, RADIUS_PACKET *);
536 RADIUS_PACKET *rad_copy_packet(TALLOC_CTX *ctx, RADIUS_PACKET const *in);
537
538 void rad_free(RADIUS_PACKET **);
539 int rad_pwencode(char *encpw, size_t *len, char const *secret,
540 uint8_t const *vector);
541 int rad_pwdecode(char *encpw, size_t len, char const *secret,
542 uint8_t const *vector);
543
544 #define FR_TUNNEL_PW_ENC_LENGTH(_x) (2 + 1 + _x + PAD(_x + 1, 16))
545 ssize_t rad_tunnel_pwencode(char *encpw, size_t *len, char const *secret,
546 uint8_t const *vector);
547 ssize_t rad_tunnel_pwdecode(uint8_t *encpw, size_t *len,
548 char const *secret, uint8_t const *vector);
549 int rad_chap_encode(RADIUS_PACKET *packet, uint8_t *output,
550 int id, VALUE_PAIR *password);
551
552 int rad_attr_ok(RADIUS_PACKET const *packet, RADIUS_PACKET const *original,
553 DICT_ATTR *da, uint8_t const *data, size_t length);
554 int rad_tlv_ok(uint8_t const *data, size_t length,
555 size_t dv_type, size_t dv_length);
556
557 ssize_t data2vp(TALLOC_CTX *ctx,
558 RADIUS_PACKET *packet, RADIUS_PACKET const *original,
559 char const *secret,
560 DICT_ATTR const *da, uint8_t const *start,
561 size_t const attrlen, size_t const packetlen,
562 VALUE_PAIR **pvp);
563
564 ssize_t rad_attr2vp(TALLOC_CTX *ctx,
565 RADIUS_PACKET *packet, RADIUS_PACKET const *original,
566 char const *secret,
567 uint8_t const *data, size_t length,
568 VALUE_PAIR **pvp);
569
570 ssize_t rad_data2vp_tlvs(TALLOC_CTX *ctx,
571 RADIUS_PACKET *packet, RADIUS_PACKET const *original,
572 char const *secret, DICT_ATTR const *da,
573 uint8_t const *start, size_t length,
574 VALUE_PAIR **pvp);
575
576 ssize_t rad_vp2data(uint8_t const **out, VALUE_PAIR const *vp);
577
578 int rad_vp2extended(RADIUS_PACKET const *packet,
579 RADIUS_PACKET const *original,
580 char const *secret, VALUE_PAIR const **pvp,
581 uint8_t *ptr, size_t room);
582 int rad_vp2wimax(RADIUS_PACKET const *packet,
583 RADIUS_PACKET const *original,
584 char const *secret, VALUE_PAIR const **pvp,
585 uint8_t *ptr, size_t room);
586
587 int rad_vp2vsa(RADIUS_PACKET const *packet, RADIUS_PACKET const *original,
588 char const *secret, VALUE_PAIR const **pvp, uint8_t *start,
589 size_t room);
590
591 int rad_vp2rfc(RADIUS_PACKET const *packet,
592 RADIUS_PACKET const *original,
593 char const *secret, VALUE_PAIR const **pvp,
594 uint8_t *ptr, size_t room);
595
596 int rad_vp2attr(RADIUS_PACKET const *packet,
597 RADIUS_PACKET const *original, char const *secret,
598 VALUE_PAIR const **pvp, uint8_t *ptr, size_t room);
599
600 /* pair.c */
601 VALUE_PAIR *fr_pair_alloc(TALLOC_CTX *ctx);
602 VALUE_PAIR *fr_pair_afrom_da(TALLOC_CTX *ctx, DICT_ATTR const *da);
603 VALUE_PAIR *fr_pair_afrom_num(TALLOC_CTX *ctx, unsigned int attr, unsigned int vendor);
604 int fr_pair_to_unknown(VALUE_PAIR *vp);
605 void fr_pair_list_free(VALUE_PAIR **);
606 VALUE_PAIR *fr_pair_find_by_num(VALUE_PAIR *, unsigned int attr, unsigned int vendor, int8_t tag);
607 VALUE_PAIR *fr_pair_find_by_da(VALUE_PAIR *, DICT_ATTR const *da, int8_t tag);
608
609 VALUE_PAIR *fr_cursor_init(vp_cursor_t *cursor, VALUE_PAIR * const *node);
610 void fr_cursor_copy(vp_cursor_t *out, vp_cursor_t *in);
611 VALUE_PAIR *fr_cursor_first(vp_cursor_t *cursor);
612 VALUE_PAIR *fr_cursor_last(vp_cursor_t *cursor);
613 VALUE_PAIR *fr_cursor_next_by_num(vp_cursor_t *cursor, unsigned int attr, unsigned int vendor, int8_t tag);
614
615 VALUE_PAIR *fr_cursor_next_by_da(vp_cursor_t *cursor, DICT_ATTR const *da, int8_t tag)
616 CC_HINT(nonnull);
617
618 VALUE_PAIR *fr_cursor_next(vp_cursor_t *cursor);
619 VALUE_PAIR *fr_cursor_next_peek(vp_cursor_t *cursor);
620 VALUE_PAIR *fr_cursor_current(vp_cursor_t *cursor);
621 void fr_cursor_insert(vp_cursor_t *cursor, VALUE_PAIR *vp);
622 void fr_cursor_merge(vp_cursor_t *cursor, VALUE_PAIR *vp);
623 VALUE_PAIR *fr_cursor_remove(vp_cursor_t *cursor);
624 VALUE_PAIR *fr_cursor_replace(vp_cursor_t *cursor, VALUE_PAIR *new);
625 void fr_pair_delete_by_num(VALUE_PAIR **, unsigned int attr, unsigned int vendor, int8_t tag);
626 void fr_pair_add(VALUE_PAIR **, VALUE_PAIR *);
627 void fr_pair_prepend(VALUE_PAIR **, VALUE_PAIR *);
628 void fr_pair_replace(VALUE_PAIR **first, VALUE_PAIR *add);
629 int fr_pair_cmp(VALUE_PAIR *a, VALUE_PAIR *b);
630 int fr_pair_list_cmp(VALUE_PAIR *a, VALUE_PAIR *b);
631
632 typedef int8_t (*fr_cmp_t)(void const *a, void const *b);
633 int8_t attrcmp(void const *a, void const *b);
634 int8_t fr_pair_cmp_by_da_tag(void const *a, void const *b);
635 void fr_pair_list_sort(VALUE_PAIR **vps, fr_cmp_t cmp);
636 void fr_pair_validate_debug(TALLOC_CTX *ctx, VALUE_PAIR const *failed[2]);
637 bool fr_pair_validate(VALUE_PAIR const *failed[2], VALUE_PAIR *filter, VALUE_PAIR *list);
638 bool fr_pair_validate_relaxed(VALUE_PAIR const *failed[2], VALUE_PAIR *filter, VALUE_PAIR *list);
639 VALUE_PAIR *fr_pair_copy(TALLOC_CTX *ctx, VALUE_PAIR const *vp);
640 VALUE_PAIR *fr_pair_list_copy(TALLOC_CTX *ctx, VALUE_PAIR *from);
641 VALUE_PAIR *fr_pair_list_copy_by_num(TALLOC_CTX *ctx, VALUE_PAIR *from, unsigned int attr, unsigned int vendor, int8_t tag);
642 void fr_pair_steal(TALLOC_CTX *ctx, VALUE_PAIR *vp);
643 void fr_pair_value_memcpy(VALUE_PAIR *vp, uint8_t const * src, size_t len);
644 void fr_pair_value_memsteal(VALUE_PAIR *vp, uint8_t const *src);
645 void fr_pair_value_strsteal(VALUE_PAIR *vp, char const *src);
646 void fr_pair_value_strcpy(VALUE_PAIR *vp, char const * src);
647 void fr_pair_value_bstrncpy(VALUE_PAIR *vp, void const * src, size_t len);
648 void fr_pair_value_sprintf(VALUE_PAIR *vp, char const * fmt, ...) CC_HINT(format (printf, 2, 3));
649 void fr_pair_list_move(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from, FR_TOKEN op);
650 void fr_pair_list_move_by_num(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from,
651 unsigned int attr, unsigned int vendor, int8_t tag);
652 void fr_pair_list_mcopy_by_num(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from,
653 unsigned int attr, unsigned int vendor, int8_t tag);
654 VALUE_PAIR *fr_pair_afrom_ip_str(TALLOC_CTX *ctx, char const *value,
655 DICT_ATTR *ipv4, DICT_ATTR *ipv6, DICT_ATTR *ipv4_prefix, DICT_ATTR *ipv6_prefix);
656 int fr_pair_value_from_str(VALUE_PAIR *vp, char const *value, size_t len);
657 VALUE_PAIR *fr_pair_make(TALLOC_CTX *ctx, VALUE_PAIR **vps, char const *attribute, char const *value, FR_TOKEN op);
658 int fr_pair_mark_xlat(VALUE_PAIR *vp, char const *value);
659 FR_TOKEN fr_pair_raw_from_str(char const **ptr, VALUE_PAIR_RAW *raw);
660 FR_TOKEN fr_pair_list_afrom_str(TALLOC_CTX *ctx, char const *buffer, VALUE_PAIR **head);
661 int fr_pair_list_afrom_file(TALLOC_CTX *ctx, VALUE_PAIR **out, FILE *fp, bool *pfiledone);
662
663
664 /** Compare two attributes using and operator.
665 *
666 * @return 1 if equal, 0 if not eaqual, -1 on error.
667 */
668 #define fr_pair_cmp_op(_op, _a, _b) value_data_cmp_op(_op, _a->da->type, &_a->data, _a->vp_length, _b->da->type, &_b->data, _b->vp_length)
669
670 /* value.c */
671 int value_data_cmp(PW_TYPE a_type, value_data_t const *a, size_t a_len,
672 PW_TYPE b_type, value_data_t const *b, size_t b_len);
673
674 int value_data_cmp_op(FR_TOKEN op,
675 PW_TYPE a_type, value_data_t const *a, size_t a_len,
676 PW_TYPE b_type, value_data_t const *b, size_t b_len);
677
678 ssize_t value_data_from_str(TALLOC_CTX *ctx, value_data_t *dst,
679 PW_TYPE *src_type, DICT_ATTR const *src_enumv,
680 char const *src, ssize_t src_len, char quote);
681
682 ssize_t value_data_cast(TALLOC_CTX *ctx, value_data_t *dst,
683 PW_TYPE dst_type, DICT_ATTR const *dst_enumv,
684 PW_TYPE src_type, DICT_ATTR const *src_enumv,
685 value_data_t const *src, size_t src_len);
686
687 ssize_t value_data_copy(TALLOC_CTX *ctx, value_data_t *dst, PW_TYPE type,
688 const value_data_t *src, size_t src_len);
689
690 size_t value_data_prints(char *out, size_t outlen,
691 PW_TYPE type, DICT_ATTR const *enumv,
692 value_data_t const *data, ssize_t inlen, char quote);
693
694 char *value_data_aprints(TALLOC_CTX *ctx,
695 PW_TYPE type, DICT_ATTR const *enumv, value_data_t const *data,
696 size_t inlen, char quote);
697
698 /*
699 * Error functions.
700 */
701 void fr_strerror_printf(char const *, ...) CC_HINT(format (printf, 1, 2));
702 void fr_perror(char const *, ...) CC_HINT(format (printf, 1, 2));
703
704
705 char const *fr_strerror(void);
706 char const *fr_syserror(int num);
707 extern bool fr_dns_lookups; /* do IP -> hostname lookups? */
708 extern bool fr_hostname_lookups; /* do hostname -> IP lookups? */
709 extern int fr_debug_lvl; /* 0 = no debugging information */
710 extern uint32_t fr_max_attributes; /* per incoming packet */
711 #define FR_MAX_PACKET_CODE (52)
712 extern char const *fr_packet_codes[FR_MAX_PACKET_CODE];
713 #define is_radius_code(_x) ((_x > 0) && (_x < FR_MAX_PACKET_CODE))
714 extern FILE *fr_log_fp;
715 void rad_print_hex(RADIUS_PACKET const *packet);
716 void fr_printf_log(char const *, ...) CC_HINT(format (printf, 1, 2));
717
718 /*
719 * Several handy miscellaneous functions.
720 */
721 int fr_set_signal(int sig, sig_t func);
722 int fr_unset_signal(int sig);
723 int fr_link_talloc_ctx_free(TALLOC_CTX *parent, TALLOC_CTX *child);
724 char const *fr_inet_ntop(int af, void const *src);
725 char const *ip_ntoa(char *, uint32_t);
726 int fr_pton4(fr_ipaddr_t *out, char const *value, ssize_t inlen, bool resolve, bool fallback);
727 int fr_pton6(fr_ipaddr_t *out, char const *value, ssize_t inlen, bool resolve, bool fallback);
728 int fr_pton(fr_ipaddr_t *out, char const *value, ssize_t inlen, int af, bool resolve);
729 int fr_pton_port(fr_ipaddr_t *out, uint16_t *port_out, char const *value, ssize_t inlen, int af,
730 bool resolve);
731 int fr_ntop(char *out, size_t outlen, fr_ipaddr_t const *addr);
732 char *ifid_ntoa(char *buffer, size_t size, uint8_t const *ifid);
733 uint8_t *ifid_aton(char const *ifid_str, uint8_t *ifid);
734 int rad_lockfd(int fd, int lock_len);
735 int rad_lockfd_nonblock(int fd, int lock_len);
736 int rad_unlockfd(int fd, int lock_len);
737 char *fr_abin2hex(TALLOC_CTX *ctx, uint8_t const *bin, size_t inlen);
738 size_t fr_bin2hex(char *hex, uint8_t const *bin, size_t inlen);
739 size_t fr_hex2bin(uint8_t *bin, size_t outlen, char const *hex, size_t inlen);
740 uint32_t fr_strtoul(char const *value, char **end);
741 bool is_whitespace(char const *value);
742 bool is_printable(void const *value, size_t len);
743 bool is_integer(char const *value);
744 bool is_zero(char const *value);
745
746 int fr_ipaddr_cmp(fr_ipaddr_t const *a, fr_ipaddr_t const *b);
747
748 int ip_hton(fr_ipaddr_t *out, int af, char const *hostname, bool fallback);
749 char const *ip_ntoh(fr_ipaddr_t const *src, char *dst, size_t cnt);
750 struct in_addr fr_inaddr_mask(struct in_addr const *ipaddr, uint8_t prefix);
751 struct in6_addr fr_in6addr_mask(struct in6_addr const *ipaddr, uint8_t prefix);
752 void fr_ipaddr_mask(fr_ipaddr_t *addr, uint8_t prefix);
753 int fr_ipaddr2sockaddr(fr_ipaddr_t const *ipaddr, uint16_t port,
754 struct sockaddr_storage *sa, socklen_t *salen);
755 int fr_sockaddr2ipaddr(struct sockaddr_storage const *sa, socklen_t salen,
756 fr_ipaddr_t *ipaddr, uint16_t *port);
757 int fr_nonblock(int fd);
758 int fr_blocking(int fd);
759 ssize_t fr_writev(int fd, struct iovec[], int iovcnt, struct timeval *timeout);
760
761 ssize_t fr_utf8_to_ucs2(uint8_t *out, size_t outlen, char const *in, size_t inlen);
762 size_t fr_prints_uint128(char *out, size_t outlen, uint128_t const num);
763 int fr_get_time(char const *date_str, time_t *date);
764 int8_t fr_pointer_cmp(void const *a, void const *b);
765 void fr_quick_sort(void const *to_sort[], int min_idx, int max_idx, fr_cmp_t cmp);
766
767 void fr_timeval_from_ms(struct timeval *out, uint64_t ms);
768 void fr_timeval_from_usec(struct timeval *out, uint64_t usec);
769
770 /*
771 * Define TALLOC_DEBUG to check overflows with talloc.
772 * we can't use valgrind, because the memory used by
773 * talloc is valid memory... just not for us.
774 */
775 #ifdef TALLOC_DEBUG
776 void fr_talloc_verify_cb(const void *ptr, int depth,
777 int max_depth, int is_ref,
778 void *private_data);
779 #define VERIFY_ALL_TALLOC talloc_report_depth_cb(NULL, 0, -1, fr_talloc_verify_cb, NULL)
780 #else
781 #define VERIFY_ALL_TALLOC
782 #endif
783
784 #ifdef WITH_ASCEND_BINARY
785 /* filters.c */
786 int ascend_parse_filter(value_data_t *out, char const *value, size_t len);
787 void print_abinary(char *out, size_t outlen, uint8_t const *data, size_t len, int8_t quote);
788 #endif /*WITH_ASCEND_BINARY*/
789
790 /* random numbers in isaac.c */
791 /* context of random number generator */
792 typedef struct fr_randctx {
793 uint32_t randcnt;
794 uint32_t randrsl[256];
795 uint32_t randmem[256];
796 uint32_t randa;
797 uint32_t randb;
798 uint32_t randc;
799 } fr_randctx;
800
801 void fr_isaac(fr_randctx *ctx);
802 void fr_randinit(fr_randctx *ctx, int flag);
803 uint32_t fr_rand(void); /* like rand(), but better. */
804 void fr_rand_seed(void const *, size_t ); /* seed the random pool */
805
806
807 /* crypt wrapper from crypt.c */
808 int fr_crypt_check(char const *key, char const *salt);
809
810 /* cbuff.c */
811
812 typedef struct fr_cbuff fr_cbuff_t;
813
814 fr_cbuff_t *fr_cbuff_alloc(TALLOC_CTX *ctx, uint32_t size, bool lock);
815 void fr_cbuff_rp_insert(fr_cbuff_t *cbuff, void *obj);
816 void *fr_cbuff_rp_next(fr_cbuff_t *cbuff, TALLOC_CTX *ctx);
817
818 /* debug.c */
819 typedef enum {
820 DEBUG_STATE_UNKNOWN_NO_PTRACE = -3, //!< We don't have ptrace so can't check.
821 DEBUG_STATE_UNKNOWN_NO_PTRACE_CAP = -2, //!< CAP_SYS_PTRACE not set for the process.
822 DEBUG_STATE_UNKNOWN = -1, //!< Unknown, likely fr_get_debug_state() not called yet.
823 DEBUG_STATE_NOT_ATTACHED = 0, //!< We can attach, so a debugger must not be.
824 DEBUG_STATE_ATTACHED = 1 //!< We can't attach, it's likely a debugger is already tracing.
825 } fr_debug_state_t;
826
827 #define FR_FAULT_LOG(fmt, ...) fr_fault_log(fmt "\n", ## __VA_ARGS__)
828 typedef void (*fr_fault_log_t)(char const *msg, ...) CC_HINT(format (printf, 1, 2));
829 extern fr_debug_state_t fr_debug_state;
830
831 /** Optional callback passed to fr_fault_setup
832 *
833 * Allows optional logic to be run before calling the main fault handler.
834 *
835 * If the callback returns < 0, the main fault handler will not be called.
836 *
837 * @param signum signal raised.
838 * @return 0 on success < 0 on failure.
839 */
840 typedef int (*fr_fault_cb_t)(int signum);
841 typedef struct fr_bt_marker fr_bt_marker_t;
842
843 void fr_store_debug_state(void);
844 char const *fr_debug_state_to_msg(fr_debug_state_t state);
845 void fr_debug_break(bool always);
846 void backtrace_print(fr_cbuff_t *cbuff, void *obj);
847 int fr_backtrace_do(fr_bt_marker_t *marker);
848 fr_bt_marker_t *fr_backtrace_attach(fr_cbuff_t **cbuff, TALLOC_CTX *obj);
849
850 void fr_panic_on_free(TALLOC_CTX *ctx);
851 int fr_set_dumpable_init(void);
852 int fr_set_dumpable(bool allow_core_dumps);
853 int fr_reset_dumpable(void);
854 int fr_log_talloc_report(TALLOC_CTX *ctx);
855 void fr_fault(int sig);
856 void fr_talloc_fault_setup(void);
857 int fr_fault_setup(char const *cmd, char const *program);
858 void fr_fault_set_cb(fr_fault_cb_t func);
859 void fr_fault_set_log_fd(int fd);
860 void fr_fault_log(char const *msg, ...) CC_HINT(format (printf, 1, 2));
861
862 # ifdef WITH_VERIFY_PTR
863 void fr_pair_verify(char const *file, int line, VALUE_PAIR const *vp);
864 void fr_pair_list_verify(char const *file, int line, TALLOC_CTX *expected, VALUE_PAIR *vps, char const *name);
865 # endif
866
867 bool fr_assert_cond(char const *file, int line, char const *expr, bool cond);
868 # define fr_assert(_x) fr_assert_cond(__FILE__, __LINE__, #_x, (_x))
869
870 void NEVER_RETURNS _fr_exit(char const *file, int line, int status);
871 # define fr_exit(_x) _fr_exit(__FILE__, __LINE__, (_x))
872
873 void NEVER_RETURNS _fr_exit_now(char const *file, int line, int status);
874 # define fr_exit_now(_x) _fr_exit_now(__FILE__, __LINE__, (_x))
875
876 /* rbtree.c */
877 typedef struct rbtree_t rbtree_t;
878 typedef struct rbnode_t rbnode_t;
879
880 /* callback order for walking */
881 typedef enum {
882 RBTREE_PRE_ORDER,
883 RBTREE_IN_ORDER,
884 RBTREE_POST_ORDER,
885 RBTREE_DELETE_ORDER
886 } rb_order_t;
887
888 #define RBTREE_FLAG_NONE (0)
889 #define RBTREE_FLAG_REPLACE (1 << 0)
890 #define RBTREE_FLAG_LOCK (1 << 1)
891
892 typedef int (*rb_comparator_t)(void const *ctx, void const *data);
893 typedef int (*rb_walker_t)(void *ctx, void *data);
894 typedef void (*rb_free_t)(void *data);
895
896 rbtree_t *rbtree_create(TALLOC_CTX *ctx, rb_comparator_t compare, rb_free_t node_free, int flags);
897 void rbtree_free(rbtree_t *tree);
898 bool rbtree_insert(rbtree_t *tree, void *data);
899 rbnode_t *rbtree_insert_node(rbtree_t *tree, void *data);
900 void rbtree_delete(rbtree_t *tree, rbnode_t *z);
901 bool rbtree_deletebydata(rbtree_t *tree, void const *data);
902 rbnode_t *rbtree_find(rbtree_t *tree, void const *data);
903 void *rbtree_finddata(rbtree_t *tree, void const *data);
904 uint32_t rbtree_num_elements(rbtree_t *tree);
905 void *rbtree_node2data(rbtree_t *tree, rbnode_t *node);
906
907 /*
908 * The callback should be declared as:
909 * int callback(void *context, void *data)
910 *
911 * The "context" is some user-defined context.
912 * The "data" is the pointer to the user data in the node,
913 * NOT the node itself.
914 *
915 * It should return 0 if all is OK, and !0 for any error.
916 * The walking will stop on any error.
917 *
918 * Except with RBTREE_DELETE_ORDER, where the callback should return <0 for
919 * errors, and may return 1 to delete the current node and halt,
920 * or 2 to delete the current node and continue. This may be
921 * used to batch-delete select nodes from a locked rbtree.
922 */
923 int rbtree_walk(rbtree_t *tree, rb_order_t order, rb_walker_t compare, void *context);
924
925 /*
926 * FIFOs
927 */
928 typedef struct fr_fifo_t fr_fifo_t;
929 typedef void (*fr_fifo_free_t)(void *);
930 fr_fifo_t *fr_fifo_create(TALLOC_CTX *ctx, int max_entries, fr_fifo_free_t freeNode);
931 void fr_fifo_free(fr_fifo_t *fi);
932 int fr_fifo_push(fr_fifo_t *fi, void *data);
933 void *fr_fifo_pop(fr_fifo_t *fi);
934 void *fr_fifo_peek(fr_fifo_t *fi);
935 unsigned int fr_fifo_num_elements(fr_fifo_t *fi);
936
937 /*
938 * socket.c
939 */
940 int fr_socket_client_unix(char const *path, bool async);
941 int fr_socket_client_udp(fr_ipaddr_t *src_ipaddr, fr_ipaddr_t *dst_ipaddr, uint16_t dst_port, bool async);
942 int fr_socket_client_tcp(fr_ipaddr_t *src_ipaddr, fr_ipaddr_t *dst_ipaddr, uint16_t dst_port, bool async);
943 int fr_socket_wait_for_connect(int sockfd, struct timeval *timeout);
944
945 #ifdef __cplusplus
946 }
947 #endif
948
949 #include <freeradius-devel/packet.h>
950
951 #ifdef WITH_TCP
952 # include <freeradius-devel/tcp.h>
953 #endif
954
955 #endif /*LIBRADIUS_H*/
956