The FreeRADIUS server $Id: f3670dba8951ca10eb4948feb3dc3db9423a334f $
Loading...
Searching...
No Matches
xlat_builtin.c
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program 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
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/**
18 * $Id: 9fe562db11bedb9e72a7db318449fe946c14f58b $
19 *
20 * @file xlat_builtin.c
21 * @brief String expansion ("translation"). Baked in expansions.
22 *
23 * @copyright 2000,2006 The FreeRADIUS server project
24 * @copyright 2000 Alan DeKok (aland@freeradius.org)
25 */
26RCSID("$Id: 9fe562db11bedb9e72a7db318449fe946c14f58b $")
27
28/**
29 * @defgroup xlat_functions xlat expansion functions
30 */
31#include <freeradius-devel/server/base.h>
32#include <freeradius-devel/server/tmpl_dcursor.h>
33#include <freeradius-devel/server/main_config.h>
34#include <freeradius-devel/unlang/xlat_priv.h>
35
36#include <freeradius-devel/io/test_point.h>
37
38#include <freeradius-devel/util/base16.h>
39
40#ifdef HAVE_OPENSSL_EVP_H
41# include <freeradius-devel/tls/openssl_user_macros.h>
42# include <openssl/evp.h>
43#endif
44
45#include <sys/stat.h>
46#include <fcntl.h>
47
48static char const hextab[] = "0123456789abcdef";
49static TALLOC_CTX *xlat_ctx;
50
51typedef struct {
53 fr_dict_t const *dict; //!< Restrict xlat to this namespace
55
56/** Copy an argument from the input list to the output cursor.
57 *
58 * For now we just move it. This utility function will let us have
59 * value-box cursors as input arguments.
60 *
61 * @param[in] ctx talloc ctx
62 * @param[out] out where the value-box will be stored
63 * @param[in] in input value-box list
64 * @param[in] vb the argument to copy
65 */
66void xlat_arg_copy_out(TALLOC_CTX *ctx, fr_dcursor_t *out, fr_value_box_list_t *in, fr_value_box_t *vb)
67{
68 fr_value_box_list_remove(in, vb);
69 if (talloc_parent(vb) != ctx) {
70 (void) talloc_steal(ctx, vb);
71 }
73}
74
75/*
76 * Regular xlat functions
77 */
79 { .single = true, .type = FR_TYPE_INT8 },
81};
82
83/** Dynamically change the debugging level for the current request
84 *
85 * Example:
86@verbatim
87%debug(3)
88@endverbatim
89 *
90 * @ingroup xlat_functions
91 */
93 UNUSED xlat_ctx_t const *xctx,
94 request_t *request, fr_value_box_list_t *args)
95{
96 int level = 0;
97 fr_value_box_t *vb, *lvl_vb;
98
99 XLAT_ARGS(args, &lvl_vb);
100
101 /*
102 * Expand to previous (or current) level
103 */
104 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_INT8, NULL));
105 vb->vb_int8 = request->log.lvl;
107
108 /*
109 * Assume we just want to get the current value and NOT set it to 0
110 */
111 if (!lvl_vb) goto done;
112
113 level = lvl_vb->vb_int8;
114 if (level == 0) {
115 request->log.lvl = RAD_REQUEST_LVL_NONE;
116 } else {
117 if (level > L_DBG_LVL_MAX) level = L_DBG_LVL_MAX;
118 request->log.lvl = level;
119 }
120
121done:
122 return XLAT_ACTION_DONE;
123}
124
125
126static void xlat_debug_attr_vp(request_t *request, fr_pair_t const *vp,
127 fr_dict_attr_t const *da);
128
129static void xlat_debug_attr_list(request_t *request, fr_pair_list_t const *list,
130 fr_dict_attr_t const *parent)
131{
132 fr_pair_t *vp;
133
134 for (vp = fr_pair_list_next(list, NULL);
135 vp != NULL;
136 vp = fr_pair_list_next(list, vp)) {
137 xlat_debug_attr_vp(request, vp, parent);
138 }
139}
140
141
146
147static void xlat_debug_attr_vp(request_t *request, fr_pair_t const *vp,
148 fr_dict_attr_t const *parent)
149{
150 fr_dict_vendor_t const *vendor;
152 size_t i;
153 ssize_t slen;
154 fr_sbuff_t sbuff;
155 char buffer[1024];
156
157 sbuff = FR_SBUFF_OUT(buffer, sizeof(buffer));
158
159 /*
160 * Squash the names down if necessary.
161 */
162 if (!RDEBUG_ENABLED3) {
163 slen = fr_pair_print_name(&sbuff, parent, &vp);
164 } else {
165 slen = fr_sbuff_in_sprintf(&sbuff, "%s %s ", vp->da->name, fr_tokens[vp->op]);
166 }
167 if (slen <= 0) return;
168
169 switch (vp->vp_type) {
171 RIDEBUG2("%s{", buffer);
172 RINDENT();
173 xlat_debug_attr_list(request, &vp->vp_group, vp->da);
174 REXDENT();
175 RIDEBUG2("}");
176 break;
177
178 default:
179 RIDEBUG2("%s%pV", buffer, &vp->data);
180 }
181
182 if (!RDEBUG_ENABLED3) return;
183
184 RINDENT();
185 RIDEBUG3("da : %p", vp->da);
186 RIDEBUG3("is_raw : %pV", fr_box_bool(vp->vp_raw));
187 RIDEBUG3("is_unknown : %pV", fr_box_bool(vp->da->flags.is_unknown));
188
189 if (RDEBUG_ENABLED3) {
190 RIDEBUG3("parent : %s (%p)", vp->da->parent->name, vp->da->parent);
191 } else {
192 RIDEBUG2("parent : %s", vp->da->parent->name);
193 }
194 RIDEBUG3("attr : %u", vp->da->attr);
195 vendor = fr_dict_vendor_by_da(vp->da);
196 if (vendor) RIDEBUG2("vendor : %u (%s)", vendor->pen, vendor->name);
197 RIDEBUG3("type : %s", fr_type_to_str(vp->vp_type));
198
199 switch (vp->vp_type) {
200 case FR_TYPE_LEAF:
201 if (fr_box_is_variable_size(&vp->data)) {
202 RIDEBUG3("length : %zu", vp->vp_length);
203 }
204 RIDEBUG3("tainted : %pV", fr_box_bool(vp->data.tainted));
205 break;
206 default:
207 break;
208 }
209
210 if (!RDEBUG_ENABLED4) {
211 REXDENT();
212 return;
213 }
214
215 for (i = 0; i < fr_type_table_len; i++) {
216 int pad;
217
218 fr_value_box_t *dst = NULL;
219
220 type = &fr_type_table[i];
221
222 if ((fr_type_t) type->value == vp->vp_type) goto next_type;
223
224 /*
225 * Don't cast TO structural, or FROM structural types.
226 */
227 if (!fr_type_is_leaf(type->value) || !fr_type_is_leaf(vp->vp_type)) goto next_type;
228
229 MEM(dst = fr_value_box_acopy(NULL, &vp->data));
230
231 /* We expect some to fail */
232 if (fr_value_box_cast_in_place(dst, dst, type->value, NULL) < 0) {
233 goto next_type;
234 }
235
236 if ((pad = (11 - type->name.len)) < 0) pad = 0;
237
238 RINDENT();
239 RDEBUG4("as %s%*s: %pV", type->name.str, pad, " ", dst);
240 REXDENT();
241
242 next_type:
243 talloc_free(dst);
244 }
245
246 REXDENT();
247}
248
249/** Common function to move boxes from input list to output list
250 *
251 * This can be used to implement safe_for functions, as the xlat framework
252 * can be used for concatenation, casting, and marking up output boxes as
253 * safe_for.
254 */
256 UNUSED xlat_ctx_t const *xctx,
257 UNUSED request_t *request, fr_value_box_list_t *args)
258{
260 xlat_arg_copy_out(ctx, out, args, vb);
261 }
262
263 return XLAT_ACTION_DONE;
264}
265
266/** Print out attribute info
267 *
268 * Prints out all instances of a current attribute, or all attributes in a list.
269 *
270 * At higher debugging levels, also prints out alternative decodings of the same
271 * value. This is helpful to determine types for unknown attributes of long
272 * passed vendors, or just crazy/broken NAS.
273 *
274 * This expands to a zero length string.
275 *
276 * Example:
277@verbatim
278%pairs.debug(&request)
279@endverbatim
280 *
281 * @ingroup xlat_functions
282 */
284 UNUSED xlat_ctx_t const *xctx,
285 request_t *request, fr_value_box_list_t *args)
286{
287 fr_pair_t *vp;
288 fr_dcursor_t *cursor;
289 fr_value_box_t *in_head;
290
291 XLAT_ARGS(args, &in_head);
292
293 if (!RDEBUG_ENABLED2) return XLAT_ACTION_DONE; /* NOOP if debugging isn't enabled */
294
295 cursor = fr_value_box_get_cursor(in_head);
296
297 RDEBUG("Attributes matching \"%s\"", in_head->vb_cursor_name);
298
299 RINDENT();
300 for (vp = fr_dcursor_current(cursor);
301 vp;
302 vp = fr_dcursor_next(cursor)) {
303 xlat_debug_attr_vp(request, vp, NULL);
304 }
305 REXDENT();
306
307 return XLAT_ACTION_DONE;
308}
309
310#ifdef __clang__
311#pragma clang diagnostic ignored "-Wgnu-designator"
312#endif
313
314#define FR_FILENAME_SAFE_FOR ((uintptr_t) filename_xlat_escape)
315
316static int CC_HINT(nonnull(2,3)) filename_xlat_escape(UNUSED request_t *request, fr_value_box_t *vb, UNUSED void *uctx)
317{
318 fr_sbuff_t *out = NULL;
319 fr_value_box_entry_t entry;
320
322
323 /*
324 * Integers are just numbers, so they don't need to be escaped.
325 *
326 * Except that FR_TYPE_INTEGER includes 'date' and 'time_delta', which is annoying.
327 *
328 * 'octets' get printed as hex, so they don't need to be escaped.
329 */
330 switch (vb->type) {
331 case FR_TYPE_BOOL:
332 case FR_TYPE_UINT8:
333 case FR_TYPE_UINT16:
334 case FR_TYPE_UINT32:
335 case FR_TYPE_UINT64:
336 case FR_TYPE_INT8:
337 case FR_TYPE_INT16:
338 case FR_TYPE_INT32:
339 case FR_TYPE_INT64:
340 case FR_TYPE_SIZE:
341 case FR_TYPE_OCTETS:
342 return 0;
343
344 case FR_TYPE_NON_LEAF:
345 fr_assert(0);
346 return -1;
347
348 case FR_TYPE_DATE:
350 case FR_TYPE_IFID:
351 case FR_TYPE_ETHERNET:
352 case FR_TYPE_FLOAT32:
353 case FR_TYPE_FLOAT64:
360 case FR_TYPE_ATTR:
361 /*
362 * Printing prefixes etc. does NOT result in the escape function being called! So
363 * instead, we cast the results to a string, and then escape the string.
364 */
365 if (fr_value_box_cast_in_place(vb, vb, FR_TYPE_STRING, NULL) < 0) return -1;
366
368 break;
369
370 case FR_TYPE_STRING:
371 /*
372 * Note that we set ".always_escape" in the function arguments, so that we get called for
373 * IP addresses. Otherwise, the xlat evaluator and/or the list_concat_as_string
374 * functions won't call us. And the expansion will return IP addresses with '/' in them.
375 * Which is not what we want.
376 */
378
379 /*
380 * If the tainted string has a leading '.', then escape _all_ periods in it. This is so that we
381 * don't accidentally allow a "safe" value to end with '/', and then an "unsafe" value contains
382 * "..", and we now have a directory traversal attack.
383 *
384 * The escape rules will escape '/' in unsafe strings, so there's no possibility for an unsafe
385 * string to either end with a '/', or to contain "/.." itself.
386 *
387 * Allowing '.' in the middle of the string means we can have filenames based on realms, such as
388 * "log/aland@freeradius.org".
389 */
390 if (vb->vb_strvalue[0] == '.') {
392 } else {
394 }
395
396 break;
397 }
398
399 entry = vb->entry;
401 (void) fr_value_box_bstrndup(vb, vb, NULL, fr_sbuff_start(out), fr_sbuff_used(out), false);
402 vb->entry = entry;
403
404 return 0;
405}
406
408 { .required = true, .concat = true, .type = FR_TYPE_STRING,
409 .func = filename_xlat_escape, .safe_for = FR_FILENAME_SAFE_FOR, .always_escape = true },
411};
412
414 { .required = true, .concat = true, .type = FR_TYPE_STRING,
415 .func = filename_xlat_escape, .safe_for = FR_FILENAME_SAFE_FOR, .always_escape = true },
416 { .required = false, .type = FR_TYPE_UINT32 },
418};
419
420
421/*
422 * Limit the %file...() functions to a particular subset of directories.
423 */
424static bool xlat_file_allowed(request_t *request, char const *filename, size_t len)
425{
426 size_t i, num_files;
427
428 if (!main_config->limit_files) return true;
429
430 num_files = talloc_array_length(main_config->limit_files);
431 if (!num_files) goto fail;
432
433 for (i = 0; i < num_files; i++) {
434 size_t alen = talloc_array_length(main_config->limit_files[i]);
435
436 /*
437 * The allowed directory is longer than the filename, it's not allowed.
438 */
439 if (alen > len) continue;
440
441 /*
442 * No leading match, it's not allowed.
443 */
444 if (memcmp(filename, main_config->limit_files[i], alen) != 0) continue;
445
446 if (alen == len) return true;
447
448 /*
449 * Setting "allow = foo/bar" does NOT mean that
450 * we allow "foo/bard". It MUST be "foo/bar/bad"
451 */
452 if (filename[alen] != '/') break;
453
454 return true;
455 }
456
457fail:
458 REDEBUG("Failed accessing file %s - it is outside of 'limit files { ... }'", filename);
459 return false;
460}
461
462#define XLAT_FILE_ALLOWED(_vb) xlat_file_allowed(request, (_vb)->vb_strvalue, (_vb)->vb_length)
463
465 UNUSED xlat_ctx_t const *xctx,
466 UNUSED request_t *request, fr_value_box_list_t *args)
467{
468 fr_value_box_t *dst, *vb;
469 char const *filename;
470 struct stat buf;
471
472 XLAT_ARGS(args, &vb);
473 fr_assert(vb->type == FR_TYPE_STRING);
474 filename = vb->vb_strvalue;
475
476 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
477
478 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
480
481 dst->vb_bool = (stat(filename, &buf) == 0);
482
483 return XLAT_ACTION_DONE;
484}
485
486
488 UNUSED xlat_ctx_t const *xctx,
489 request_t *request, fr_value_box_list_t *args)
490{
491 fr_value_box_t *dst, *vb;
492 char const *filename;
493 ssize_t len;
494 int fd;
495 char *p, buffer[256];
496
497 XLAT_ARGS(args, &vb);
498 fr_assert(vb->type == FR_TYPE_STRING);
499 filename = vb->vb_strvalue;
500
501 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
502
503 fd = open(filename, O_RDONLY);
504 if (fd < 0) {
505 REDEBUG3("Failed opening file %s - %s", filename, fr_syserror(errno));
506 return XLAT_ACTION_FAIL;
507 }
508
509 len = read(fd, buffer, sizeof(buffer));
510 if (len < 0) {
511 REDEBUG3("Failed reading file %s - %s", filename, fr_syserror(errno));
512 close(fd);
513 return XLAT_ACTION_FAIL;
514 }
515
516 /*
517 * Find the first CR/LF, but bail if we get any weird characters.
518 */
519 for (p = buffer; p < (buffer + len); p++) {
520 if ((*p == '\r') || (*p == '\n')) {
521 break;
522 }
523
524 if ((*p < ' ') && (*p != '\t')) {
525 invalid:
526 REDEBUG("Invalid text in file %s", filename);
527 close(fd);
528 return XLAT_ACTION_FAIL;
529 }
530 }
531
532 if ((p - buffer) > len) goto invalid;
533 close(fd);
534
535 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL));
536 if (fr_value_box_bstrndup(dst, dst, NULL, buffer, p - buffer, false) < 0) {
537 talloc_free(dst);
538 return XLAT_ACTION_FAIL;
539 }
540
542
543 return XLAT_ACTION_DONE;
544}
545
546
548 UNUSED xlat_ctx_t const *xctx,
549 request_t *request, fr_value_box_list_t *args)
550{
551 fr_value_box_t *dst, *vb;
552 char const *filename;
553 struct stat buf;
554
555 XLAT_ARGS(args, &vb);
556 fr_assert(vb->type == FR_TYPE_STRING);
557 filename = vb->vb_strvalue;
558
559 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
560
561 if (stat(filename, &buf) < 0) {
562 REDEBUG3("Failed checking file %s - %s", filename, fr_syserror(errno));
563 return XLAT_ACTION_FAIL;
564 }
565
566 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_UINT64, NULL)); /* off_t is signed, but file sizes shouldn't be negative */
568
569 dst->vb_uint64 = buf.st_size;
570
571 return XLAT_ACTION_DONE;
572}
573
574
576 UNUSED xlat_ctx_t const *xctx,
577 request_t *request, fr_value_box_list_t *args)
578{
579 fr_value_box_t *dst, *vb, *num = NULL;
580 char const *filename;
581 ssize_t len;
582 off_t offset;
583 int fd;
584 int crlf, stop = 1;
585 char *p, *end, *found, buffer[256];
586
587 XLAT_ARGS(args, &vb, &num);
588 fr_assert(vb->type == FR_TYPE_STRING);
589 filename = vb->vb_strvalue;
590
591 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
592
593 fd = open(filename, O_RDONLY);
594 if (fd < 0) {
595 REDEBUG3("Failed opening file %s - %s", filename, fr_syserror(errno));
596 return XLAT_ACTION_FAIL;
597 }
598
599 offset = lseek(fd, 0, SEEK_END);
600 if (offset < 0) {
601 REDEBUG3("Failed seeking to end of file %s - %s", filename, fr_syserror(errno));
602 goto fail;
603 }
604
605 if (offset > (off_t) sizeof(buffer)) {
606 offset -= sizeof(buffer);
607 } else {
608 offset = 0;
609 }
610
611 if (lseek(fd, offset, SEEK_SET) < 0) {
612 REDEBUG3("Failed seeking backwards from end of file %s - %s", filename, fr_syserror(errno));
613 goto fail;
614 }
615
616 len = read(fd, buffer, sizeof(buffer));
617 if (len < 0) {
618 fail:
619 REDEBUG3("Failed reading file %s - %s", filename, fr_syserror(errno));
620 close(fd);
621 return XLAT_ACTION_FAIL;
622 }
623 close(fd);
624
625 found = buffer;
626 end = buffer + len;
627
628 /*
629 * No data, OR just one CR / LF, we print it all out.
630 */
631 if (len <= 1) goto done;
632
633 /*
634 * Clamp number of lines to a reasonable value. They
635 * still all have to fit into 256 characters, though.
636 *
637 * @todo - have a large thread-local temporary buffer for this stuff.
638 */
639 if (num) {
640 fr_assert(num->type == FR_TYPE_GROUP);
641 fr_assert(fr_value_box_list_num_elements(&num->vb_group) == 1);
642
643 num = fr_value_box_list_head(&num->vb_group);
644 fr_assert(num->type == FR_TYPE_UINT32);
645
646 if (!num->vb_uint32) {
647 stop = 1;
648
649 } else if (num->vb_uint32 <= 16) {
650 stop = num->vb_uint32;
651
652 } else {
653 stop = 16;
654 }
655 } else {
656 stop = 1;
657 }
658
659 p = end - 1;
660 crlf = 0;
661
662 /*
663 * Skip any trailing CRLF first.
664 */
665 while (p > buffer) {
666 /*
667 * Could be CRLF, or just LF.
668 */
669 if (*p == '\n') {
670 end = p;
671 p--;
672 if (p == buffer) {
673 goto done;
674 }
675 if (*p >= ' ') {
676 break;
677 }
678 }
679
680 if (*p == '\r') {
681 end = p;
682 p--;
683 break;
684 }
685
686 /*
687 * We've found CR, LF, or CRLF. The previous
688 * thing is either raw text, or is another CR/LF.
689 */
690 break;
691 }
692
693 found = p;
694
695 while (p > buffer) {
696 crlf++;
697
698 /*
699 * If the current line is empty, we can stop.
700 */
701 if ((crlf == stop) && (*found < ' ')) {
702 found++;
703 goto done;
704 }
705
706 while (*p >= ' ') {
707 found = p;
708 p--;
709 if (p == buffer) {
710 found = buffer;
711 goto done;
712 }
713 }
714 if (crlf == stop) {
715 break;
716 }
717
718 /*
719 * Check again for CRLF.
720 */
721 if (*p == '\n') {
722 p--;
723 if (p == buffer) {
724 break;
725 }
726 if (*p >= ' ') {
727 continue;
728 }
729 }
730
731 if (*p == '\r') {
732 p--;
733 if (p == buffer) {
734 break;
735 }
736 continue;
737 }
738 }
739
740done:
741
742 /*
743 * @todo - return a _list_ of value-boxes, one for each line in the file.
744 * Which means chopping off each CRLF in the file
745 */
746
747 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL));
748 if (fr_value_box_bstrndup(dst, dst, NULL, found, (size_t) (end - found), false) < 0) {
749 talloc_free(dst);
750 return XLAT_ACTION_FAIL;
751 }
752
754
755 return XLAT_ACTION_DONE;
756}
757
759 { .required = true, .concat = true, .type = FR_TYPE_STRING,
760 .func = filename_xlat_escape, .safe_for = FR_FILENAME_SAFE_FOR, .always_escape = true },
761 { .required = true, .type = FR_TYPE_SIZE, .single = true },
763};
764
766 UNUSED xlat_ctx_t const *xctx,
767 request_t *request, fr_value_box_list_t *args)
768{
769 fr_value_box_t *dst, *vb, *max_size;
770 char const *filename;
771 ssize_t len;
772 int fd;
773 struct stat buf;
775
776 XLAT_ARGS(args, &vb, &max_size);
777 fr_assert(vb->type == FR_TYPE_STRING);
778 filename = vb->vb_strvalue;
779
780 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
781
782 fd = open(filename, O_RDONLY);
783 if (fd < 0) {
784 RPERROR("Failed opening file %s - %s", filename, fr_syserror(errno));
785 return XLAT_ACTION_FAIL;
786 }
787
788 if (fstat(fd, &buf) < 0) {
789 RPERROR("Failed checking file %s - %s", filename, fr_syserror(errno));
790 fail:
791 close(fd);
792 return XLAT_ACTION_FAIL;
793 }
794
795 if ((size_t)buf.st_size > max_size->vb_size) {
796 RPERROR("File larger than specified maximum (%"PRIu64" vs %zu)", buf.st_size, max_size->vb_size);
797 goto fail;
798 }
799
800 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_OCTETS, NULL));
801 fr_value_box_mem_alloc(dst, &buffer, dst, NULL, buf.st_size, true);
802
803 len = read(fd, buffer, buf.st_size);
804 if (len < 0) {
805 RPERROR("Failed reading file %s - %s", filename, fr_syserror(errno));
806 talloc_free(dst);
807 goto fail;
808 }
809 close(fd);
810
811 if (len < buf.st_size) {
812 RPERROR("Failed reading all of file %s", filename);
813 talloc_free(dst);
814 return XLAT_ACTION_FAIL;
815 }
816
818
819 return XLAT_ACTION_DONE;
820}
821
823 UNUSED xlat_ctx_t const *xctx,
824 request_t *request, fr_value_box_list_t *args)
825{
826 fr_value_box_t *dst, *vb;
827 char const *filename;
828
829 XLAT_ARGS(args, &vb);
830 fr_assert(vb->type == FR_TYPE_STRING);
831 filename = vb->vb_strvalue;
832
833 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
834
835 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
837
838 dst->vb_bool = (unlink(filename) == 0);
839 if (!dst->vb_bool) {
840 REDEBUG3("Failed unlinking file %s - %s", filename, fr_syserror(errno));
841 }
842
843 return XLAT_ACTION_DONE;
844}
845
847 request_t *request, fr_value_box_list_t *args)
848{
849 fr_value_box_t *dst, *vb;
850 char const *filename;
851 int fd;
852
853 XLAT_ARGS(args, &vb);
854 fr_assert(vb->type == FR_TYPE_STRING);
855 filename = vb->vb_strvalue;
856
857 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
858
859 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
861
862 fd = open(filename, O_CREAT | O_WRONLY, 0600);
863 if (fd < 0) {
864 dst->vb_bool = false;
865 REDEBUG3("Failed touching file %s - %s", filename, fr_syserror(errno));
866 return XLAT_ACTION_DONE;
867 }
868 dst->vb_bool = true;
869
870 close(fd);
871
872 return XLAT_ACTION_DONE;
873}
874
876 request_t *request, fr_value_box_list_t *args)
877{
878 fr_value_box_t *dst, *vb;
879 char const *dirname;
880
881 XLAT_ARGS(args, &vb);
882 fr_assert(vb->type == FR_TYPE_STRING);
883 dirname = vb->vb_strvalue;
884
885 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
886
887 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
889
890 dst->vb_bool = (fr_mkdir(NULL, dirname, -1, 0700, NULL, NULL) == 0);
891 if (!dst->vb_bool) {
892 REDEBUG3("Failed creating directory %s - %s", dirname, fr_syserror(errno));
893 }
894
895 return XLAT_ACTION_DONE;
896}
897
899 request_t *request, fr_value_box_list_t *args)
900{
901 fr_value_box_t *dst, *vb;
902 char const *dirname;
903
904 XLAT_ARGS(args, &vb);
905 fr_assert(vb->type == FR_TYPE_STRING);
906 dirname = vb->vb_strvalue;
907
908 if (!XLAT_FILE_ALLOWED(vb)) return XLAT_ACTION_FAIL;
909
910 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
912
913 dst->vb_bool = (rmdir(dirname) == 0);
914 if (!dst->vb_bool) {
915 REDEBUG3("Failed removing directory %s - %s", dirname, fr_syserror(errno));
916 }
917
918 return XLAT_ACTION_DONE;
919}
920
922 { .required = true, .type = FR_TYPE_VOID },
923 { .variadic = XLAT_ARG_VARIADIC_EMPTY_KEEP, .type = FR_TYPE_VOID },
925};
926
928 UNUSED xlat_ctx_t const *xctx,
929 UNUSED request_t *request, fr_value_box_list_t *in)
930{
931 fr_value_box_t *vb;
932
934 while ((vb = fr_value_box_list_pop_head(in)) != NULL) {
936 }
937
938 return XLAT_ACTION_DONE;
939}
940
942 UNUSED xlat_ctx_t const *xctx,
943 UNUSED request_t *request, fr_value_box_list_t *in)
944{
945 fr_value_box_t *vb;
946
947 while ((vb = fr_value_box_list_pop_head(in)) != NULL) {
948 fr_value_box_t *child;
949
950 fr_assert(vb->type == FR_TYPE_GROUP);
951
952 while ((child = fr_value_box_list_pop_head(&vb->vb_group)) != NULL) {
953 child->tainted = true;
955
956 fr_dcursor_append(out, child);
957 }
958 }
959
960 return XLAT_ACTION_DONE;
961}
962
964 { .required = true, .type = FR_TYPE_STRING },
965 { .required = true, .concat = true, .type = FR_TYPE_STRING },
967};
968
969/** Split a string into multiple new strings based on a delimiter
970 *
971@verbatim
972%explode(<string>, <delim>)
973@endverbatim
974 *
975 * Example:
976@verbatim
977update request {
978 &Tmp-String-1 := "a,b,c"
979}
980"%concat(%explode(%{Tmp-String-1}, ','), '|')" == "a|b|c"g
981@endverbatim
982 *
983 * @ingroup xlat_functions
984 */
986 UNUSED xlat_ctx_t const *xctx,
987 request_t *request, fr_value_box_list_t *args)
988{
990 fr_value_box_list_t *list;
991 fr_value_box_t *delim_vb;
992 ssize_t delim_len;
993 char const *delim;
994 fr_value_box_t *string, *vb;
995
996 XLAT_ARGS(args, &strings, &delim_vb);
997
998 list = &strings->vb_group;
999
1000 /* coverity[dereference] */
1001 if (delim_vb->vb_length == 0) {
1002 REDEBUG("Delimiter must be greater than zero characters");
1003 return XLAT_ACTION_FAIL;
1004 }
1005
1006 delim = delim_vb->vb_strvalue;
1007 delim_len = delim_vb->vb_length;
1008
1009 while ((string = fr_value_box_list_pop_head(list))) {
1010 fr_sbuff_t sbuff = FR_SBUFF_IN(string->vb_strvalue, string->vb_length);
1011 fr_sbuff_marker_t m_start;
1012
1013 /*
1014 * If the delimiter is not in the string, just move to the output
1015 */
1016 if (!fr_sbuff_adv_to_str(&sbuff, SIZE_MAX, delim, delim_len)) {
1017 fr_dcursor_append(out, string);
1018 continue;
1019 }
1020
1021 fr_sbuff_set_to_start(&sbuff);
1022 fr_sbuff_marker(&m_start, &sbuff);
1023
1024 while (fr_sbuff_remaining(&sbuff)) {
1025 if (fr_sbuff_adv_to_str(&sbuff, SIZE_MAX, delim, delim_len)) {
1026 /*
1027 * If there's nothing before the delimiter skip
1028 */
1029 if (fr_sbuff_behind(&m_start) == 0) goto advance;
1030
1031 MEM(vb = fr_value_box_alloc_null(ctx));
1032 fr_value_box_bstrndup(vb, vb, NULL, fr_sbuff_current(&m_start),
1033 fr_sbuff_behind(&m_start), false);
1034 fr_value_box_safety_copy(vb, string);
1036
1037 advance:
1038 fr_sbuff_advance(&sbuff, delim_len);
1039 fr_sbuff_set(&m_start, &sbuff);
1040 continue;
1041 }
1042
1043 fr_sbuff_set_to_end(&sbuff);
1044 MEM(vb = fr_value_box_alloc_null(ctx));
1045 fr_value_box_bstrndup(vb, vb, NULL, fr_sbuff_current(&m_start),
1046 fr_sbuff_behind(&m_start), false);
1047
1048 fr_value_box_safety_copy(vb, string);
1050 break;
1051 }
1052 talloc_free(string);
1053 }
1054
1055 return XLAT_ACTION_DONE;
1056}
1057
1058/** Mark one or more attributes as immutable
1059 *
1060 * Example:
1061@verbatim
1062%pairs.immutable(request.State[*])
1063@endverbatim
1064 *
1065 * @ingroup xlat_functions
1066 */
1068 UNUSED xlat_ctx_t const *xctx,
1069 request_t *request, fr_value_box_list_t *args)
1070{
1071 fr_pair_t *vp;
1072 fr_dcursor_t *cursor;
1073 fr_value_box_t *in_head;
1074
1075 XLAT_ARGS(args, &in_head);
1076
1077 cursor = fr_value_box_get_cursor(in_head);
1078
1079 RDEBUG("Attributes matching \"%s\"", in_head->vb_cursor_name);
1080
1081 RINDENT();
1082 for (vp = fr_dcursor_current(cursor);
1083 vp;
1084 vp = fr_dcursor_next(cursor)) {
1086 }
1087 REXDENT();
1088
1089 return XLAT_ACTION_DONE;
1090}
1091
1093 { .required = true, .single = true, .type = FR_TYPE_VOID },
1095};
1096
1097/** Print data as integer, not as VALUE.
1098 *
1099 * Example:
1100@verbatim
1101update request {
1102 &Tmp-IP-Address-0 := "127.0.0.5"
1103}
1104%integer(%{Tmp-IP-Address-0}) == 2130706437
1105@endverbatim
1106 * @ingroup xlat_functions
1107 */
1109 UNUSED xlat_ctx_t const *xctx,
1110 request_t *request, fr_value_box_list_t *args)
1111{
1112 fr_value_box_t *in_vb;
1113 char const *p;
1114
1115 XLAT_ARGS(args, &in_vb);
1116
1117 fr_strerror_clear(); /* Make sure we don't print old errors */
1118
1119 fr_value_box_list_remove(args, in_vb);
1120
1121 switch (in_vb->type) {
1122 default:
1123 error:
1124 RPEDEBUG("Failed converting %pR (%s) to an integer", in_vb,
1125 fr_type_to_str(in_vb->type));
1126 talloc_free(in_vb);
1127 return XLAT_ACTION_FAIL;
1128
1129 case FR_TYPE_NUMERIC:
1130 /*
1131 * Ensure enumeration is NULL so that the integer
1132 * version of a box is returned
1133 */
1134 in_vb->enumv = NULL;
1135
1136 /*
1137 * FR_TYPE_DATE and FR_TYPE_TIME_DELTA need to be cast
1138 * to int64_t so that they're printed in a
1139 * numeric format.
1140 */
1141 if ((in_vb->type == FR_TYPE_DATE) || (in_vb->type == FR_TYPE_TIME_DELTA)) {
1142 if (fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_INT64, NULL) < 0) goto error;
1143 }
1144 break;
1145
1146 case FR_TYPE_STRING:
1147 /*
1148 * Strings are always zero terminated. They may
1149 * also have zeros in the middle, but if that
1150 * happens, the caller will only get the part up
1151 * to the first zero.
1152 *
1153 * We check for negative numbers, just to be
1154 * nice.
1155 */
1156 for (p = in_vb->vb_strvalue; *p != '\0'; p++) {
1157 if (*p == '-') break;
1158 }
1159
1160 if (*p == '-') {
1161 if (fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_INT64, NULL) < 0) goto error;
1162 } else {
1163 if (fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT64, NULL) < 0) goto error;
1164 }
1165 break;
1166
1167 case FR_TYPE_OCTETS:
1168 if (in_vb->vb_length > sizeof(uint64_t)) {
1169 fr_strerror_printf("Expected octets length <= %zu, got %zu", sizeof(uint64_t), in_vb->vb_length);
1170 goto error;
1171 }
1172
1173 if (in_vb->vb_length > sizeof(uint32_t)) {
1174 if (unlikely(fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT64, NULL) < 0)) goto error;
1175 } else if (in_vb->vb_length > sizeof(uint16_t)) {
1176 if (unlikely(fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT32, NULL) < 0)) goto error;
1177 } else if (in_vb->vb_length > sizeof(uint8_t)) {
1178 if (unlikely(fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT16, NULL) < 0)) goto error;
1179 } else {
1180 if (unlikely(fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT8, NULL) < 0)) goto error;
1181 }
1182
1183 break;
1184
1185 case FR_TYPE_IPV4_ADDR:
1187 if (fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT32, NULL) < 0) goto error;
1188 break;
1189
1190 case FR_TYPE_ETHERNET:
1191 if (fr_value_box_cast_in_place(ctx, in_vb, FR_TYPE_UINT64, NULL) < 0) goto error;
1192 break;
1193
1194 case FR_TYPE_IPV6_ADDR:
1196 {
1197 uint128_t ipv6int;
1198 char buff[40];
1199 fr_value_box_t *vb;
1200
1201 /*
1202 * Needed for correct alignment (as flagged by ubsan)
1203 */
1204 memcpy(&ipv6int, &in_vb->vb_ipv6addr, sizeof(ipv6int));
1205
1206 fr_snprint_uint128(buff, sizeof(buff), ntohlll(ipv6int));
1207
1208 MEM(vb = fr_value_box_alloc_null(ctx));
1209 fr_value_box_bstrndup(vb, vb, NULL, buff, strlen(buff), false);
1211 talloc_free(in_vb);
1212 return XLAT_ACTION_DONE;
1213 }
1214 }
1215
1216 fr_dcursor_append(out, in_vb);
1217
1218 return XLAT_ACTION_DONE;
1219}
1220
1222 { .concat = true, .type = FR_TYPE_STRING },
1224};
1225
1226/** Log something at INFO level.
1227 *
1228 * Example:
1229@verbatim
1230%log("This is an informational message")
1231@endverbatim
1232 *
1233 * @ingroup xlat_functions
1234 */
1236 UNUSED xlat_ctx_t const *xctx,
1237 request_t *request, fr_value_box_list_t *args)
1238{
1239 fr_value_box_t *vb;
1240
1241 XLAT_ARGS(args, &vb);
1242
1243 if (!vb) return XLAT_ACTION_DONE;
1244
1245 RINFO("%s", vb->vb_strvalue);
1246
1247 return XLAT_ACTION_DONE;
1248}
1249
1250
1251/** Log something at DEBUG level.
1252 *
1253 * Example:
1254@verbatim
1255%log.debug("This is a message")
1256@endverbatim
1257 *
1258 * @ingroup xlat_functions
1259 */
1261 UNUSED xlat_ctx_t const *xctx,
1262 request_t *request, fr_value_box_list_t *args)
1263{
1264 fr_value_box_t *vb;
1265
1266 XLAT_ARGS(args, &vb);
1267
1268 if (!vb) return XLAT_ACTION_DONE;
1269
1270 RDEBUG("%s", vb->vb_strvalue);
1271
1272 return XLAT_ACTION_DONE;
1273}
1274
1275
1276/** Log something at DEBUG level.
1277 *
1278 * Example:
1279@verbatim
1280%log.err("Big error here")
1281@endverbatim
1282 *
1283 * @ingroup xlat_functions
1284 */
1286 UNUSED xlat_ctx_t const *xctx,
1287 request_t *request, fr_value_box_list_t *args)
1288{
1289 fr_value_box_t *vb;
1290
1291 XLAT_ARGS(args, &vb);
1292
1293 if (!vb) return XLAT_ACTION_DONE;
1294
1295 REDEBUG("%s", vb->vb_strvalue);
1296
1297 return XLAT_ACTION_DONE;
1298}
1299
1300
1301/** Log something at WARN level.
1302 *
1303 * Example:
1304@verbatim
1305%log.warn("Maybe something bad happened")
1306@endverbatim
1307 *
1308 * @ingroup xlat_functions
1309 */
1311 UNUSED xlat_ctx_t const *xctx,
1312 request_t *request, fr_value_box_list_t *args)
1313{
1314 fr_value_box_t *vb;
1315
1316 XLAT_ARGS(args, &vb);
1317
1318 if (!vb) return XLAT_ACTION_DONE;
1319
1320 RWDEBUG("%s", vb->vb_strvalue);
1321
1322 return XLAT_ACTION_DONE;
1323}
1324
1325static int _log_dst_free(fr_log_t *log)
1326{
1327 close(log->fd);
1328 return 0;
1329}
1330
1332 { .required = false, .type = FR_TYPE_STRING, .concat = true },
1333 { .required = false, .type = FR_TYPE_UINT32, .single = true },
1334 { .required = false, .type = FR_TYPE_STRING, .concat = true },
1336};
1337
1338/** Change the log destination to the named one
1339 *
1340 * Example:
1341@verbatim
1342%log.destination('foo')
1343@endverbatim
1344 *
1345 * @ingroup xlat_functions
1346 */
1348 UNUSED xlat_ctx_t const *xctx,
1349 request_t *request, fr_value_box_list_t *args)
1350{
1351 fr_value_box_t *dst, *lvl, *file;
1352 fr_log_t *log, *dbg;
1353 uint32_t level = 2;
1354
1355 XLAT_ARGS(args, &dst, &lvl, &file);
1356
1357 /*
1358 * An explicit `null` is treated the same as a missing arg.
1359 * vb_strvalue on an FR_TYPE_NULL box is unset, so reading
1360 * it below would be UB.
1361 */
1362 if (dst && fr_type_is_null(dst->type)) dst = NULL;
1363 if (lvl && fr_type_is_null(lvl->type)) lvl = NULL;
1364 if (file && fr_type_is_null(file->type)) file = NULL;
1365
1366 if (!dst || !*dst->vb_strvalue) {
1367 request_log_prepend(request, NULL, L_DBG_LVL_DISABLE);
1368 return XLAT_ACTION_DONE;
1369 }
1370
1371 log = log_dst_by_name(dst->vb_strvalue);
1372 if (!log) return XLAT_ACTION_FAIL;
1373
1374 if (lvl) level = lvl->vb_uint32;
1375
1376 if (!file || ((log->dst != L_DST_NULL) && (log->dst != L_DST_FILES))) {
1377 request_log_prepend(request, log, level);
1378 return XLAT_ACTION_DONE;
1379 }
1380
1381 /*
1382 * Clone it.
1383 */
1384 MEM(dbg = talloc_memdup(request, log, sizeof(*log)));
1385 dbg->parent = log;
1386
1387 /*
1388 * Open the new filename.
1389 */
1390 dbg->dst = L_DST_FILES;
1391 dbg->file = talloc_strdup(dbg, file->vb_strvalue);
1392 dbg->fd = open(dbg->file, O_WRONLY | O_CREAT | O_CLOEXEC, 0600);
1393 if (dbg->fd < 0) {
1394 REDEBUG("Failed opening %s - %s", dbg->file, fr_syserror(errno));
1395 talloc_free(dbg);
1396 return XLAT_ACTION_DONE;
1397 }
1398
1399 /*
1400 * Ensure that we close the file handle when done.
1401 */
1402 talloc_set_destructor(dbg, _log_dst_free);
1403
1404 request_log_prepend(request, dbg, level);
1405 return XLAT_ACTION_DONE;
1406}
1407
1408
1410 { .required = true, .type = FR_TYPE_STRING },
1412};
1413
1414/** Processes fmt as a map string and applies it to the current request
1415 *
1416 * e.g.
1417@verbatim
1418%map("User-Name := 'foo'")
1419@endverbatim
1420 *
1421 * Allows sets of modifications to be cached and then applied.
1422 * Useful for processing generic attributes from LDAP.
1423 *
1424 * @ingroup xlat_functions
1425 */
1427 UNUSED xlat_ctx_t const *xctx,
1428 request_t *request, fr_value_box_list_t *args)
1429{
1430 map_t *map = NULL;
1431 int ret;
1432 fr_value_box_t *fmt_vb;
1433 fr_value_box_t *vb;
1434
1435 tmpl_rules_t attr_rules = {
1436 .attr = {
1437 .dict_def = request->local_dict,
1438 .list_def = request_attr_request,
1439 },
1440 .xlat = {
1441 .runtime_el = unlang_interpret_event_list(request)
1442 }
1443 };
1444
1445 XLAT_ARGS(args, &fmt_vb);
1446
1447 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
1448 vb->vb_bool = false; /* Default fail value - changed to true on success */
1450
1451 fr_value_box_list_foreach(&fmt_vb->vb_group, fmt) {
1452 if (map_afrom_attr_str(request, &map, fmt->vb_strvalue, &attr_rules, &attr_rules) < 0) {
1453 RPEDEBUG("Failed parsing \"%s\" as map", fmt_vb->vb_strvalue);
1454 return XLAT_ACTION_FAIL;
1455 }
1456
1457 switch (map->lhs->type) {
1458 case TMPL_TYPE_ATTR:
1459 case TMPL_TYPE_XLAT:
1460 break;
1461
1462 default:
1463 REDEBUG("Unexpected type %s in left hand side of expression",
1464 tmpl_type_to_str(map->lhs->type));
1465 return XLAT_ACTION_FAIL;
1466 }
1467
1468 switch (map->rhs->type) {
1469 case TMPL_TYPE_ATTR:
1470 case TMPL_TYPE_EXEC:
1471 case TMPL_TYPE_DATA:
1474 case TMPL_TYPE_XLAT:
1475 break;
1476
1477 default:
1478 REDEBUG("Unexpected type %s in right hand side of expression",
1479 tmpl_type_to_str(map->rhs->type));
1480 return XLAT_ACTION_FAIL;
1481 }
1482
1483 RINDENT();
1484 ret = map_to_request(request, map, map_to_vp, NULL);
1485 REXDENT();
1486 talloc_free(map);
1487 if (ret < 0) return XLAT_ACTION_FAIL;
1488 }
1489
1490 vb->vb_bool = true;
1491 return XLAT_ACTION_DONE;
1492}
1493
1494
1499
1500
1502 { .required = true, .concat = true, .type = FR_TYPE_STRING },
1504};
1505
1506/** Just serves to push the result up the stack
1507 *
1508 */
1510 xlat_ctx_t const *xctx,
1511 UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
1512{
1513 xlat_module_call_rctx_t *rctx = talloc_get_type_abort(xctx->rctx, xlat_module_call_rctx_t);
1515
1516 talloc_free(rctx);
1517
1518 return xa;
1519}
1520
1521
1522/** Calls a named virtual module
1523 *
1524 * e.g.
1525@verbatim
1526%module.call("foo")
1527@endverbatim
1528 *
1529 * @ingroup xlat_functions
1530 */
1532 UNUSED xlat_ctx_t const *xctx,
1533 request_t *request, fr_value_box_list_t *args)
1534{
1535 fr_value_box_t *box;
1536 CONF_SECTION *cs;
1538 fr_dict_t const *dict;
1539
1540 XLAT_ARGS(args, &box);
1541
1542 cs = module_rlm_virtual_by_name(box->vb_strvalue);
1543 if (!cs) {
1544 REDEBUG("Unknown module %pV", box);
1545 return XLAT_ACTION_FAIL;
1546 }
1547
1549 if (!dict) {
1550 REDEBUG("Virtual module %pV does not have a known dictionary - ignoring", box);
1551 return XLAT_ACTION_FAIL;
1552 }
1553
1554 if (!fr_dict_compatible(request->proto_dict, dict)) {
1555 REDEBUG("Virtual module %pV has incompatible namespace %s", box, fr_dict_root(dict)->name);
1556 return XLAT_ACTION_FAIL;
1557 }
1558
1559 MEM(rctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), xlat_module_call_rctx_t));
1560
1561 /*
1562 * Push the resumption point BEFORE pushing the module onto
1563 * the stack.
1564 */
1565 (void) unlang_xlat_yield(request, xlat_module_call_resume, NULL, 0, rctx);
1566
1567 if (unlang_interpret_push_section(&rctx->last_result, request, cs,
1569 return XLAT_ACTION_FAIL;
1570 }
1571
1573}
1574
1575
1577 { .required = true, .concat = true, .type = FR_TYPE_STRING },
1579};
1580
1581/** Calculate number of seconds until the next n hour(s), day(s), week(s), year(s).
1582 *
1583 * For example, if it were 16:18 %time.next(1h) would expand to 2520.
1584 *
1585 * The envisaged usage for this function is to limit sessions so that they don't
1586 * cross billing periods. The output of the xlat should be combined with %rand() to create
1587 * some jitter, unless the desired effect is every subscriber on the network
1588 * re-authenticating at the same time.
1589 *
1590 * @ingroup xlat_functions
1591 */
1593 UNUSED xlat_ctx_t const *xctx,
1594 request_t *request, fr_value_box_list_t *args)
1595{
1596 unsigned long num;
1597
1598 char const *p;
1599 char *q;
1600 time_t now;
1601 struct tm *local, local_buff;
1602 fr_value_box_t *in_head;
1603 fr_value_box_t *vb;
1604
1605 XLAT_ARGS(args, &in_head);
1606
1607 /*
1608 * We want to limit based on _now_, not on when they logged in.
1609 */
1610 now = time(NULL);
1611 local = localtime_r(&now, &local_buff);
1612
1613 p = in_head->vb_strvalue;
1614
1615 num = strtoul(p, &q, 10);
1616 if ((num == ULONG_MAX) || !q || *q == '\0') {
1617 REDEBUG("<int> must be followed by time period (h|d|w|m|y)");
1618 return XLAT_ACTION_FAIL;
1619 }
1620 if (num == 0) {
1621 REDEBUG("<int> must be greater than zero");
1622 return XLAT_ACTION_FAIL;
1623 }
1624
1625 if (p == q) {
1626 num = 1;
1627 } else {
1628 p += q - p;
1629 }
1630
1631 local->tm_sec = 0;
1632 local->tm_min = 0;
1633
1634 switch (*p) {
1635 case 'h':
1636 local->tm_hour += num;
1637 break;
1638
1639 case 'd':
1640 local->tm_hour = 0;
1641 local->tm_mday += num;
1642 break;
1643
1644 case 'w':
1645 local->tm_hour = 0;
1646 local->tm_mday += (7 - local->tm_wday) + (7 * (num-1));
1647 break;
1648
1649 case 'm':
1650 local->tm_hour = 0;
1651 local->tm_mday = 1;
1652 local->tm_mon += num;
1653 break;
1654
1655 case 'y':
1656 local->tm_hour = 0;
1657 local->tm_mday = 1;
1658 local->tm_mon = 0;
1659 local->tm_year += num;
1660 break;
1661
1662 default:
1663 REDEBUG("Invalid time period '%c', must be h|d|w|m|y", *p);
1664 return XLAT_ACTION_FAIL;
1665 }
1666
1667 MEM(vb = fr_value_box_alloc_null(ctx));
1668 fr_value_box_uint64(vb, NULL, (uint64_t)(mktime(local) - now), false);
1670 return XLAT_ACTION_DONE;
1671}
1672
1677
1678/** Just serves to push the result up the stack
1679 *
1680 */
1682 xlat_ctx_t const *xctx,
1683 UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
1684{
1685 xlat_eval_rctx_t *rctx = talloc_get_type_abort(xctx->rctx, xlat_eval_rctx_t);
1687
1688 talloc_free(rctx);
1689
1690 return xa;
1691}
1692
1694 { .required = true, .concat = true, .type = FR_TYPE_STRING },
1696};
1697
1698/** Dynamically evaluate an expansion string
1699 *
1700 * @ingroup xlat_functions
1701 */
1703 UNUSED xlat_ctx_t const *xctx,
1704 request_t *request, fr_value_box_list_t *args)
1705{
1706 /*
1707 * These are escaping rules applied to the
1708 * input string. They're mostly here to
1709 * allow \% and \\ to work.
1710 *
1711 * Everything else should be passed in as
1712 * unescaped data.
1713 */
1714 static fr_sbuff_unescape_rules_t const escape_rules = {
1715 .name = "xlat",
1716 .chr = '\\',
1717 .subs = {
1718 ['%'] = '%',
1719 ['\\'] = '\\',
1720 },
1721 .do_hex = false,
1722 .do_oct = false
1723 };
1724
1725 xlat_eval_rctx_t *rctx;
1726 fr_value_box_t *arg = fr_value_box_list_head(args);
1727
1728 XLAT_ARGS(args, &arg);
1729
1730 MEM(rctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), xlat_eval_rctx_t));
1731
1732 /*
1733 * Parse the input as a literal expansion
1734 */
1735 if (xlat_tokenize_expression(rctx,
1736 &rctx->ex,
1737 &FR_SBUFF_IN(arg->vb_strvalue, arg->vb_length),
1738 &(fr_sbuff_parse_rules_t){
1739 .escapes = &escape_rules
1740 },
1741 &(tmpl_rules_t){
1742 .attr = {
1743 .dict_def = request->local_dict,
1744 .list_def = request_attr_request,
1745 .allow_unknown = false,
1746 .allow_unresolved = false,
1747 .allow_foreign = false,
1748 },
1749 .xlat = {
1750 .runtime_el = unlang_interpret_event_list(request),
1751 },
1752 .at_runtime = true
1753 }) < 0) {
1754 RPEDEBUG("Failed parsing expansion");
1755 error:
1756 talloc_free(rctx);
1757 return XLAT_ACTION_FAIL;
1758 }
1759
1760 /*
1761 * Call the resolution function so we produce
1762 * good errors about what function was
1763 * unresolved.
1764 */
1765 if (rctx->ex->flags.needs_resolving &&
1766 (xlat_resolve(rctx->ex, &(xlat_res_rules_t){ .allow_unresolved = false }) < 0)) {
1767 RPEDEBUG("Unresolved expansion functions in expansion");
1768 goto error;
1769
1770 }
1771
1772 if (unlang_xlat_yield(request, xlat_eval_resume, NULL, 0, rctx) != XLAT_ACTION_YIELD) goto error;
1773
1774 if (unlang_xlat_push(ctx, &rctx->last_result, (fr_value_box_list_t *)out->dlist,
1775 request, rctx->ex, UNLANG_SUB_FRAME) < 0) goto error;
1776
1778}
1779
1781 { .required = true, .type = FR_TYPE_STRING },
1782 { .required = true, .single = true, .type = FR_TYPE_UINT64 },
1783 { .concat = true, .type = FR_TYPE_STRING },
1785};
1786
1787/** lpad a string
1788 *
1789@verbatim
1790%lpad(%{Attribute-Name}, <length> [, <fill>])
1791@endverbatim
1792 *
1793 * Example: (User-Name = "foo")
1794@verbatim
1795%lpad(%{User-Name}, 5 'x') == "xxfoo"
1796@endverbatim
1797 *
1798 * @ingroup xlat_functions
1799 */
1801 UNUSED xlat_ctx_t const *xctx,
1802 request_t *request, fr_value_box_list_t *args)
1803{
1804 fr_value_box_t *values;
1805 fr_value_box_t *pad;
1807
1808 fr_value_box_list_t *list;
1809
1810 size_t pad_len;
1811
1812 char const *fill_str = NULL;
1813 size_t fill_len = 0;
1814
1815 fr_value_box_t *in = NULL;
1816
1817 XLAT_ARGS(args, &values, &pad, &fill);
1818
1819 /* coverity[dereference] */
1820 list = &values->vb_group;
1821 /* coverity[dereference] */
1822 pad_len = (size_t)pad->vb_uint64;
1823
1824 /*
1825 * Fill is optional
1826 */
1827 if (fill) {
1828 fill_str = fill->vb_strvalue;
1829 fill_len = talloc_strlen(fill_str);
1830 }
1831
1832 if (fill_len == 0) {
1833 fill_str = " ";
1834 fill_len = 1;
1835 }
1836
1837 while ((in = fr_value_box_list_pop_head(list))) {
1838 size_t len = talloc_strlen(in->vb_strvalue);
1839 size_t remaining;
1840 char *buff;
1841 fr_sbuff_t sbuff;
1842 fr_sbuff_marker_t m_data;
1843
1845
1846 if (len >= pad_len) continue;
1847
1848 if (fr_value_box_bstr_realloc(in, &buff, in, pad_len) < 0) {
1849 RPEDEBUG("Failed reallocing input data");
1850 return XLAT_ACTION_FAIL;
1851 }
1852
1853 fr_sbuff_init_in(&sbuff, buff, pad_len);
1854 fr_sbuff_marker(&m_data, &sbuff);
1855
1856 /*
1857 * ...nothing to move if the input
1858 * string is empty.
1859 */
1860 if (len > 0) {
1861 fr_sbuff_advance(&m_data, pad_len - len); /* Mark where we want the data to go */
1862 fr_sbuff_move(&FR_SBUFF(&m_data), &FR_SBUFF(&sbuff), len); /* Shift the data */
1863 }
1864
1865 if (fill_len == 1) {
1866 memset(fr_sbuff_current(&sbuff), *fill_str, fr_sbuff_ahead(&m_data));
1867 continue;
1868 }
1869
1870 /*
1871 * Copy fill as a repeating pattern
1872 */
1873 while ((remaining = fr_sbuff_ahead(&m_data))) {
1874 size_t to_copy = remaining >= fill_len ? fill_len : remaining;
1875 memcpy(fr_sbuff_current(&sbuff), fill_str, to_copy); /* avoid \0 termination */
1876 fr_sbuff_advance(&sbuff, to_copy);
1877 }
1878 fr_sbuff_set_to_end(&sbuff);
1879 fr_sbuff_terminate(&sbuff); /* Move doesn't re-terminate */
1880 }
1881
1882 return XLAT_ACTION_DONE;
1883}
1884
1885/** Right pad a string
1886 *
1887@verbatim
1888%rpad(%{Attribute-Name}, <length> [, <fill>])
1889@endverbatim
1890 *
1891 * Example: (User-Name = "foo")
1892@verbatim
1893%rpad(%{User-Name}, 5 'x') == "fooxx"
1894@endverbatim
1895 *
1896 * @ingroup xlat_functions
1897 */
1899 UNUSED xlat_ctx_t const *xctx,
1900 request_t *request, fr_value_box_list_t *args)
1901{
1902 fr_value_box_t *values;
1903 fr_value_box_list_t *list;
1904 fr_value_box_t *pad;
1905 /* coverity[dereference] */
1906 size_t pad_len;
1908 char const *fill_str = NULL;
1909 size_t fill_len = 0;
1910
1911 fr_value_box_t *in = NULL;
1912
1913 XLAT_ARGS(args, &values, &pad, &fill);
1914
1915 list = &values->vb_group;
1916 pad_len = (size_t)pad->vb_uint64;
1917
1918 /*
1919 * Fill is optional
1920 */
1921 if (fill) {
1922 fill_str = fill->vb_strvalue;
1923 fill_len = talloc_strlen(fill_str);
1924 }
1925
1926 if (fill_len == 0) {
1927 fill_str = " ";
1928 fill_len = 1;
1929 }
1930
1931 while ((in = fr_value_box_list_pop_head(list))) {
1932 size_t len = talloc_strlen(in->vb_strvalue);
1933 size_t remaining;
1934 char *buff;
1935 fr_sbuff_t sbuff;
1936
1938
1939 if (len >= pad_len) continue;
1940
1941 if (fr_value_box_bstr_realloc(in, &buff, in, pad_len) < 0) {
1942 fail:
1943 RPEDEBUG("Failed reallocing input data");
1944 return XLAT_ACTION_FAIL;
1945 }
1946
1947 fr_sbuff_init_in(&sbuff, buff, pad_len);
1948 fr_sbuff_advance(&sbuff, len);
1949
1950 if (fill_len == 1) {
1951 memset(fr_sbuff_current(&sbuff), *fill_str, fr_sbuff_remaining(&sbuff));
1952 continue;
1953 }
1954
1955 /*
1956 * Copy fill as a repeating pattern
1957 */
1958 while ((remaining = fr_sbuff_remaining(&sbuff))) {
1959 if (fr_sbuff_in_bstrncpy(&sbuff, fill_str, remaining >= fill_len ? fill_len : remaining) < 0) {
1960 goto fail;
1961 }
1962 }
1963 }
1964
1965 return XLAT_ACTION_DONE;
1966}
1967
1969 { .required = true, .concat = true, .type = FR_TYPE_OCTETS },
1971};
1972
1973/** Encode string or attribute as base64
1974 *
1975 * Example:
1976@verbatim
1977%base64.encode("foo") == "Zm9v"
1978@endverbatim
1979 *
1980 * @ingroup xlat_functions
1981 */
1983 UNUSED xlat_ctx_t const *xctx,
1984 request_t *request, fr_value_box_list_t *args)
1985{
1986 size_t alen;
1987 ssize_t elen;
1988 char *buff;
1989 fr_value_box_t *vb;
1991
1992 XLAT_ARGS(args, &in);
1993
1994 alen = FR_BASE64_ENC_LENGTH(in->vb_length);
1995
1996 MEM(vb = fr_value_box_alloc_null(ctx));
1997 if (fr_value_box_bstr_alloc(vb, &buff, vb, NULL, alen, false) < 0) {
1998 talloc_free(vb);
1999 return XLAT_ACTION_FAIL;
2000 }
2001
2002 elen = fr_base64_encode(&FR_SBUFF_OUT(buff, talloc_array_length(buff)),
2003 &FR_DBUFF_TMP(in->vb_octets, in->vb_length), true);
2004 if (elen < 0) {
2005 RPEDEBUG("Base64 encoding failed");
2006 talloc_free(vb);
2007 return XLAT_ACTION_FAIL;
2008 }
2009 fr_assert((size_t)elen <= alen);
2012
2013 return XLAT_ACTION_DONE;
2014}
2015
2017 { .required = true, .concat = true, .type = FR_TYPE_OCTETS },
2019};
2020
2021/** Decode base64 string
2022 *
2023 * Example:
2024@verbatim
2025%base64.decode("Zm9v") == "foo"
2026@endverbatim
2027 *
2028 * @ingroup xlat_functions
2029 */
2031 UNUSED xlat_ctx_t const *xctx,
2032 request_t *request, fr_value_box_list_t *args)
2033{
2034 size_t alen;
2035 ssize_t declen = 0;
2036 uint8_t *decbuf;
2037 fr_value_box_t *vb;
2039
2040 XLAT_ARGS(args, &in);
2041
2042 /*
2043 * Pass empty arguments through
2044 *
2045 * FR_BASE64_DEC_LENGTH produces 2 for empty strings...
2046 */
2047 if (in->vb_length == 0) {
2048 xlat_arg_copy_out(ctx, out, args, in);
2049 return XLAT_ACTION_DONE;
2050 }
2051
2052 alen = FR_BASE64_DEC_LENGTH(in->vb_length);
2053 MEM(vb = fr_value_box_alloc_null(ctx));
2054 if (alen > 0) {
2055 MEM(fr_value_box_mem_alloc(vb, &decbuf, vb, NULL, alen, false) == 0);
2056 declen = fr_base64_decode(&FR_DBUFF_TMP(decbuf, alen),
2057 &FR_SBUFF_IN(in->vb_strvalue, in->vb_length), true, true);
2058 if (declen < 0) {
2059 RPEDEBUG("Base64 string invalid");
2060 talloc_free(vb);
2061 return XLAT_ACTION_FAIL;
2062 }
2063
2064 MEM(fr_value_box_mem_realloc(vb, NULL, vb, declen) == 0);
2065 }
2066
2069
2070 return XLAT_ACTION_DONE;
2071}
2072
2074 { .required = true, .type = FR_TYPE_STRING },
2076};
2077
2078/** Convert hex string to binary
2079 *
2080 * Example:
2081@verbatim
2082%bin("666f6f626172") == "foobar"
2083@endverbatim
2084 *
2085 * @see #xlat_func_hex
2086 *
2087 * @ingroup xlat_functions
2088 */
2090 UNUSED xlat_ctx_t const *xctx,
2091 request_t *request, fr_value_box_list_t *args)
2092{
2093 fr_value_box_t *result;
2094 char const *p, *end;
2095 uint8_t *bin;
2096 size_t len, outlen;
2098 fr_value_box_t *list, *hex;
2099
2100 XLAT_ARGS(args, &list);
2101
2102 while ((hex = fr_value_box_list_pop_head(&list->vb_group))) {
2103 len = hex->vb_length;
2104 if ((len > 1) && (len & 0x01)) {
2105 REDEBUG("Input data length must be >1 and even, got %zu", len);
2106 return XLAT_ACTION_FAIL;
2107 }
2108
2109 p = hex->vb_strvalue;
2110 end = p + len;
2111
2112 /*
2113 * Look for 0x at the start of the string, and ignore if we see it.
2114 */
2115 if ((p[0] == '0') && (p[1] == 'x')) {
2116 p += 2;
2117 len -=2;
2118 }
2119
2120 /*
2121 * Zero length octets string
2122 */
2123 if (p == end) continue;
2124
2125 outlen = len / 2;
2126
2127 MEM(result = fr_value_box_alloc_null(ctx));
2128 MEM(fr_value_box_mem_alloc(result, &bin, result, NULL, outlen, false) == 0);
2129 fr_base16_decode(&err, &FR_DBUFF_TMP(bin, outlen), &FR_SBUFF_IN(p, end - p), true);
2130 if (err) {
2131 REDEBUG2("Invalid hex string");
2132 talloc_free(result);
2133 return XLAT_ACTION_FAIL;
2134 }
2135
2137 fr_dcursor_append(out, result);
2138 }
2139
2140 return XLAT_ACTION_DONE;
2141}
2142
2144 { .required = true, .single = true, .type = FR_TYPE_TIME_DELTA },
2146};
2147
2148/** Block for the specified duration
2149 *
2150 * This is for developer use only to simulate blocking, synchronous I/O.
2151 * For normal use, use the %delay() xlat instead.
2152 *
2153 * Example:
2154@verbatim
2155%block(1s)
2156@endverbatim
2157 *
2158 * @ingroup xlat_functions
2159 */
2161 UNUSED xlat_ctx_t const *xctx,
2162 UNUSED request_t *request, fr_value_box_list_t *args)
2163{
2164 fr_value_box_t *delay;
2165 fr_value_box_t *vb;
2166 struct timespec ts_in, ts_remain = {};
2167
2168 XLAT_ARGS(args, &delay);
2169
2170 ts_in = fr_time_delta_to_timespec(delay->vb_time_delta);
2171
2172 (void)nanosleep(&ts_in, &ts_remain);
2173
2174 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_TIME_DELTA, NULL));
2175 vb->vb_time_delta = fr_time_delta_sub(delay->vb_time_delta,
2176 fr_time_delta_from_timespec(&ts_remain));
2178
2179 return XLAT_ACTION_DONE;
2180}
2181
2183 { .required = true, .single = true, .type = FR_TYPE_VOID },
2184 { .type = FR_TYPE_VOID },
2185 { .variadic = XLAT_ARG_VARIADIC_EMPTY_KEEP, .type = FR_TYPE_VOID },
2187};
2188
2189/** Cast one or more output value-boxes to the given type
2190 *
2191 * First argument of is type to cast to.
2192 *
2193 * Example:
2194@verbatim
2195%cast('string', %{request[*]}) results in all of the input boxes being cast to string/
2196@endverbatim
2197 *
2198 * @ingroup xlat_functions
2199 */
2201 UNUSED xlat_ctx_t const *xctx,
2202 request_t *request, fr_value_box_list_t *args)
2203{
2205 fr_value_box_t *arg;
2207 fr_dict_attr_t const *time_res = NULL;
2208
2209 XLAT_ARGS(args, &name);
2210
2211 /*
2212 * Get the type, which can be in one of a few formats.
2213 */
2214 if (fr_type_is_numeric(name->type)) {
2216 RPEDEBUG("Failed parsing '%pV' as a numerical data type", name);
2217 return XLAT_ACTION_FAIL;
2218 }
2219 type = name->vb_uint8;
2220
2221 } else {
2222 if (name->type != FR_TYPE_STRING) {
2224 RPEDEBUG("Failed parsing '%pV' as a string data type", name);
2225 return XLAT_ACTION_FAIL;
2226 }
2227 }
2228
2230 if (type == FR_TYPE_NULL) {
2231 if ((time_res = xlat_time_res_attr(name->vb_strvalue)) == NULL) {
2232 RDEBUG("Unknown data type '%s'", name->vb_strvalue);
2233 return XLAT_ACTION_FAIL;
2234 }
2235
2237 }
2238 }
2239
2240 (void) fr_value_box_list_pop_head(args);
2241
2242 /*
2243 * When we cast nothing to a string / octets, the result is an empty string/octets.
2244 */
2245 if (unlikely(!fr_value_box_list_head(args))) {
2246 if ((type == FR_TYPE_STRING) || (type == FR_TYPE_OCTETS)) {
2247 fr_value_box_t *dst;
2248
2249 MEM(dst = fr_value_box_alloc(ctx, type, NULL));
2250 fr_dcursor_append(out, dst);
2251 VALUE_BOX_LIST_VERIFY((fr_value_box_list_t *)out->dlist);
2252
2253 return XLAT_ACTION_DONE;
2254 }
2255
2256 RDEBUG("No data for cast to '%s'", fr_type_to_str(type));
2257 return XLAT_ACTION_FAIL;
2258 }
2259
2260 /*
2261 * Cast to string means *print* to string.
2262 */
2263 if (type == FR_TYPE_STRING) {
2264 fr_sbuff_t *agg;
2265 fr_value_box_t *dst;
2266
2268
2269 FR_SBUFF_TALLOC_THREAD_LOCAL(&agg, 256, SIZE_MAX);
2270
2271 MEM(dst = fr_value_box_alloc_null(ctx));
2273
2274 if (fr_value_box_list_concat_as_string(dst, agg, args, NULL, 0, NULL,
2276 RPEDEBUG("Failed concatenating string");
2277 return XLAT_ACTION_FAIL;
2278 }
2279
2280 fr_value_box_bstrndup(dst, dst, NULL, fr_sbuff_start(agg), fr_sbuff_used(agg), false);
2281 fr_dcursor_append(out, dst);
2282 VALUE_BOX_LIST_VERIFY((fr_value_box_list_t *)out->dlist);
2283
2284 return XLAT_ACTION_DONE;
2285 }
2286
2287 /*
2288 * Copy inputs to outputs, casting them along the way.
2289 */
2290 arg = NULL;
2291 while ((arg = fr_value_box_list_next(args, arg)) != NULL) {
2292 fr_value_box_t *vb, *p;
2293
2294 fr_assert(arg->type == FR_TYPE_GROUP);
2295
2296 vb = fr_value_box_list_head(&arg->vb_group);
2297 while (vb) {
2298 p = fr_value_box_list_remove(&arg->vb_group, vb);
2299
2300 if (fr_value_box_cast_in_place(vb, vb, type, time_res) < 0) {
2301 RPEDEBUG("Failed casting %pV to data type '%s'", vb, fr_type_to_str(type));
2302 return XLAT_ACTION_FAIL;
2303 }
2305 vb = fr_value_box_list_next(&arg->vb_group, p);
2306 }
2307 }
2308 VALUE_BOX_LIST_VERIFY((fr_value_box_list_t *)out->dlist);
2309
2310 return XLAT_ACTION_DONE;
2311}
2312
2314 { .required = true, .type = FR_TYPE_VOID },
2315 { .concat = true, .type = FR_TYPE_STRING },
2317};
2318
2319/** Concatenate string representation of values of given attributes using separator
2320 *
2321 * First argument of is the list of attributes to concatenate, followed
2322 * by an optional separator
2323 *
2324 * Example:
2325@verbatim
2326%concat(%{request.[*]}, ',') == "<attr1value>,<attr2value>,<attr3value>,..."
2327%concat(%{Tmp-String-0[*]}, '. ') == "<str1value>. <str2value>. <str3value>. ..."
2328%concat(%join(%{User-Name}, %{Calling-Station-Id}), ', ') == "bob, aa:bb:cc:dd:ee:ff"
2329@endverbatim
2330 *
2331 * @ingroup xlat_functions
2332 */
2334 UNUSED xlat_ctx_t const *xctx,
2335 request_t *request, fr_value_box_list_t *args)
2336{
2337 fr_value_box_t *result;
2338 fr_value_box_t *list;
2339 fr_value_box_t *separator;
2340 fr_value_box_list_t *to_concat;
2341 char *buff;
2342 char const *sep;
2343
2344 XLAT_ARGS(args, &list, &separator);
2345
2346 sep = (separator) ? separator->vb_strvalue : "";
2347 to_concat = &list->vb_group;
2348
2349 result = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL);
2350 if (!result) {
2351 error:
2352 RPEDEBUG("Failed concatenating input");
2353 return XLAT_ACTION_FAIL;
2354 }
2355
2356 buff = fr_value_box_list_aprint(result, to_concat, sep, NULL);
2357 if (!buff) goto error;
2358
2360
2361 fr_dcursor_append(out, result);
2362
2363 return XLAT_ACTION_DONE;
2364}
2365
2367 { .required = true, .type = FR_TYPE_OCTETS },
2369};
2370
2371/** Print data as hex, not as VALUE.
2372 *
2373 * Example:
2374@verbatim
2375%hex("foobar") == "666f6f626172"
2376@endverbatim
2377 *
2378 * @see #xlat_func_bin
2379 *
2380 * @ingroup xlat_functions
2381 */
2383 UNUSED xlat_ctx_t const *xctx,
2384 UNUSED request_t *request, fr_value_box_list_t *args)
2385{
2386 char *new_buff;
2387 fr_value_box_t *list, *bin;
2388 fr_value_box_t safety;
2389
2390 XLAT_ARGS(args, &list);
2391
2392 while ((bin = fr_value_box_list_pop_head(&list->vb_group))) {
2393 fr_value_box_safety_copy(&safety, bin);
2394
2395 /*
2396 * Use existing box, but with new buffer
2397 */
2398 MEM(new_buff = talloc_zero_array(bin, char, (bin->vb_length * 2) + 1));
2399 if (bin->vb_length) {
2400 fr_base16_encode(&FR_SBUFF_OUT(new_buff, (bin->vb_length * 2) + 1),
2401 &FR_DBUFF_TMP(bin->vb_octets, bin->vb_length));
2403 fr_value_box_strdup_shallow(bin, NULL, new_buff, false);
2404 /*
2405 * Zero length binary > zero length hex string
2406 */
2407 } else {
2409 fr_value_box_strdup(bin, bin, NULL, "", false);
2410 }
2411
2412 fr_value_box_safety_copy(bin, &safety);
2413 fr_dcursor_append(out, bin);
2414 }
2415
2416 return XLAT_ACTION_DONE;
2417}
2418
2423
2424static xlat_action_t xlat_hmac(TALLOC_CTX *ctx, fr_dcursor_t *out,
2425 fr_value_box_list_t *args, uint8_t *digest, int digest_len, hmac_type type)
2426{
2427 fr_value_box_t *vb, *data, *key;
2428
2429 XLAT_ARGS(args, &data, &key);
2430
2431 if (type == HMAC_MD5) {
2432 /* coverity[dereference] */
2433 fr_hmac_md5(digest, data->vb_octets, data->vb_length, key->vb_octets, key->vb_length);
2434 } else if (type == HMAC_SHA1) {
2435 /* coverity[dereference] */
2436 fr_hmac_sha1(digest, data->vb_octets, data->vb_length, key->vb_octets, key->vb_length);
2437 }
2438
2439 MEM(vb = fr_value_box_alloc_null(ctx));
2440 fr_value_box_memdup(vb, vb, NULL, digest, digest_len, false);
2441
2443
2444 return XLAT_ACTION_DONE;
2445}
2446
2448 { .required = true, .concat = true, .type = FR_TYPE_STRING },
2449 { .required = true, .concat = true, .type = FR_TYPE_STRING },
2451};
2452
2453/** Generate the HMAC-MD5 of a string or attribute
2454 *
2455 * Example:
2456@verbatim
2457%hmacmd5('foo', 'bar') == "0x31b6db9e5eb4addb42f1a6ca07367adc"
2458@endverbatim
2459 *
2460 * @ingroup xlat_functions
2461 */
2463 UNUSED xlat_ctx_t const *xctx,
2464 UNUSED request_t *request, fr_value_box_list_t *in)
2465{
2466 uint8_t digest[MD5_DIGEST_LENGTH];
2467 return xlat_hmac(ctx, out, in, digest, MD5_DIGEST_LENGTH, HMAC_MD5);
2468}
2469
2470
2471/** Generate the HMAC-SHA1 of a string or attribute
2472 *
2473 * Example:
2474@verbatim
2475%hmacsha1('foo', 'bar') == "0x85d155c55ed286a300bd1cf124de08d87e914f3a"
2476@endverbatim
2477 *
2478 * @ingroup xlat_functions
2479 */
2481 UNUSED xlat_ctx_t const *xctx,
2482 UNUSED request_t *request, fr_value_box_list_t *in)
2483{
2485 return xlat_hmac(ctx, out, in, digest, SHA1_DIGEST_LENGTH, HMAC_SHA1);
2486}
2487
2489 { .required = true, .type = FR_TYPE_VOID },
2490 { .variadic = XLAT_ARG_VARIADIC_EMPTY_SQUASH, .type = FR_TYPE_VOID },
2492};
2493
2494/** Join a series of arguments to form a single list
2495 *
2496 * null boxes are not preserved.
2497 */
2499 UNUSED xlat_ctx_t const *xctx,
2500 UNUSED request_t *request, fr_value_box_list_t *in)
2501{
2503 fr_assert(arg->type == FR_TYPE_GROUP);
2504
2505 fr_value_box_list_foreach(&arg->vb_group, vb) {
2506 xlat_arg_copy_out(ctx, out, &arg->vb_group, vb);
2507 }
2508 }
2509 return XLAT_ACTION_DONE;
2510}
2511
2512static void ungroup(fr_dcursor_t *out, fr_value_box_list_t *in)
2513{
2514 fr_value_box_t *vb;
2515
2516 while ((vb = fr_value_box_list_pop_head(in)) != NULL) {
2517 if (vb->type != FR_TYPE_GROUP) {
2519 continue;
2520 }
2521 talloc_free(vb);
2522 }
2523}
2524
2525/** Ungroups all of its arguments into one flat list.
2526 *
2527 */
2529 UNUSED xlat_ctx_t const *xctx,
2530 UNUSED request_t *request, fr_value_box_list_t *in)
2531{
2532 fr_value_box_t *arg = NULL;
2533
2534 while ((arg = fr_value_box_list_next(in, arg)) != NULL) {
2535 fr_assert(arg->type == FR_TYPE_GROUP);
2536
2537 ungroup(out, &arg->vb_group);
2538 }
2539 return XLAT_ACTION_DONE;
2540}
2541
2543 { .single = true, .variadic = XLAT_ARG_VARIADIC_EMPTY_KEEP, .type = FR_TYPE_VOID },
2545};
2546
2547/** Return the on-the-wire size of the boxes in bytes
2548 *
2549 * skips null values
2550 *
2551 * Example:
2552@verbatim
2553%length(foobar) == 6
2554%length(%bin("0102030005060708")) == 8
2555@endverbatim
2556 *
2557 * @see #xlat_func_strlen
2558 *
2559 * @ingroup xlat_functions
2560 */
2562 UNUSED xlat_ctx_t const *xctx,
2563 UNUSED request_t *request, fr_value_box_list_t *in)
2564
2565{
2568
2569 MEM(my = fr_value_box_alloc(ctx, FR_TYPE_SIZE, NULL));
2570 if (!fr_type_is_null(vb->type)) my->vb_size = fr_value_box_network_length(vb);
2572 }
2573
2574 return XLAT_ACTION_DONE;
2575}
2576
2577
2579 { .concat = true, .type = FR_TYPE_OCTETS },
2581};
2582
2583/** Calculate the MD4 hash of a string or attribute.
2584 *
2585 * Example:
2586@verbatim
2587%md4("foo") == "0ac6700c491d70fb8650940b1ca1e4b2"
2588@endverbatim
2589 *
2590 * @ingroup xlat_functions
2591 */
2593 UNUSED xlat_ctx_t const *xctx,
2594 UNUSED request_t *request, fr_value_box_list_t *args)
2595{
2596 uint8_t digest[MD4_DIGEST_LENGTH];
2597 fr_value_box_t *vb;
2598 fr_value_box_t *in_head;
2599
2600 XLAT_ARGS(args, &in_head);
2601
2602 if (in_head) {
2603 fr_md4_calc(digest, in_head->vb_octets, in_head->vb_length);
2604 } else {
2605 /* Digest of empty string */
2606 fr_md4_calc(digest, NULL, 0);
2607 }
2608
2609 MEM(vb = fr_value_box_alloc_null(ctx));
2610 fr_value_box_memdup(vb, vb, NULL, digest, sizeof(digest), false);
2611
2613 VALUE_BOX_LIST_VERIFY((fr_value_box_list_t *)out->dlist);
2614
2615 return XLAT_ACTION_DONE;
2616}
2617
2619 { .concat = true, .type = FR_TYPE_OCTETS },
2621};
2622
2623/** Calculate the MD5 hash of a string or attribute.
2624 *
2625 * Example:
2626@verbatim
2627%md5("foo") == "acbd18db4cc2f85cedef654fccc4a4d8"
2628@endverbatim
2629 *
2630 * @ingroup xlat_functions
2631 */
2633 UNUSED xlat_ctx_t const *xctx,
2634 UNUSED request_t *request, fr_value_box_list_t *args)
2635{
2636 uint8_t digest[MD5_DIGEST_LENGTH];
2637 fr_value_box_t *vb;
2638 fr_value_box_t *in_head;
2639
2640 XLAT_ARGS(args, &in_head);
2641
2642 if (in_head) {
2643 fr_md5_calc(digest, in_head->vb_octets, in_head->vb_length);
2644 } else {
2645 /* Digest of empty string */
2646 fr_md5_calc(digest, NULL, 0);
2647 }
2648
2649 MEM(vb = fr_value_box_alloc_null(ctx));
2650 fr_value_box_memdup(vb, vb, NULL, digest, sizeof(digest), false);
2651
2653
2654 return XLAT_ACTION_DONE;
2655}
2656
2657
2658/** Encode attributes as a series of string attribute/value pairs
2659 *
2660 * This is intended to serialize one or more attributes as a comma
2661 * delimited string.
2662 *
2663 * Example:
2664@verbatim
2665%pairs.print(request.[*]) == 'User-Name = "foo"User-Password = "bar"'
2666%concat(%pairs.print.print(request.[*]), ', ') == 'User-Name = "foo", User-Password = "bar"'
2667@endverbatim
2668 *
2669 * @see #xlat_func_concat
2670 *
2671 * @ingroup xlat_functions
2672 */
2674 UNUSED xlat_ctx_t const *xctx,
2675 request_t *request, fr_value_box_list_t *args)
2676{
2677 fr_pair_t *vp;
2678 fr_dcursor_t *cursor;
2679 fr_value_box_t *vb;
2680 fr_value_box_t *in_head;
2681
2682 XLAT_ARGS(args, &in_head);
2683
2684 cursor = fr_value_box_get_cursor(in_head);
2685
2686 for (vp = fr_dcursor_current(cursor);
2687 vp;
2688 vp = fr_dcursor_next(cursor)) {
2689 char *buff;
2690
2691 MEM(vb = fr_value_box_alloc_null(ctx));
2692 if (unlikely(fr_pair_aprint(vb, &buff, NULL, vp) < 0)) {
2693 RPEDEBUG("Failed printing pair");
2694 talloc_free(vb);
2695 return XLAT_ACTION_FAIL;
2696 }
2697
2698 fr_value_box_bstrdup_buffer_shallow(NULL, vb, NULL, buff, false);
2700
2701 VALUE_BOX_VERIFY(vb);
2702 }
2703
2704 return XLAT_ACTION_DONE;
2705}
2706
2708 { .required = true, .single = true, .type = FR_TYPE_UINT32 },
2710};
2711
2712/** Generate a random integer value
2713 *
2714 * For "N = %rand(MAX)", 0 <= N < MAX
2715 *
2716 * Example:
2717@verbatim
2718%rand(100) == 42
2719@endverbatim
2720 *
2721 * @ingroup xlat_functions
2722 */
2724 UNUSED xlat_ctx_t const *xctx,
2725 UNUSED request_t *request, fr_value_box_list_t *in)
2726{
2727 int64_t result;
2728 fr_value_box_t *vb;
2729 fr_value_box_t *in_head = fr_value_box_list_head(in);
2730
2731 result = in_head->vb_uint32;
2732
2733 /* Make sure it isn't too big */
2734 if (result > (1 << 30)) result = (1 << 30);
2735
2736 result *= fr_rand(); /* 0..2^32-1 */
2737 result >>= 32;
2738
2739 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_UINT64, NULL));
2740 vb->vb_uint64 = result;
2741
2743
2744 return XLAT_ACTION_DONE;
2745}
2746
2748 { .required = true, .concat = true, .type = FR_TYPE_STRING },
2750};
2751
2752/** Generate a string of random chars
2753 *
2754 * Build strings of random chars, useful for generating tokens and passcodes
2755 * Format similar to String::Random.
2756 *
2757 * Format characters may include the following, and may be
2758 * preceded by a repetition count:
2759 * - "c" lowercase letters
2760 * - "C" uppercase letters
2761 * - "n" numbers
2762 * - "a" alphanumeric
2763 * - "!" punctuation
2764 * - "." alphanumeric + punctuation
2765 * - "s" alphanumeric + "./"
2766 * - "o" characters suitable for OTP (easily confused removed)
2767 * - "b" binary data
2768 *
2769 * Example:
2770@verbatim
2771%randstr("CCCC!!cccnnn") == "IPFL>{saf874"
2772%randstr("42o") == "yHdupUwVbdHprKCJRYfGbaWzVwJwUXG9zPabdGAhM9"
2773%hex(%randstr("bbbb")) == "a9ce04f3"
2774%hex(%randstr("8b")) == "fe165529f9f66839"
2775@endverbatim
2776 * @ingroup xlat_functions
2777 */
2779 UNUSED xlat_ctx_t const *xctx,
2780 request_t *request, fr_value_box_list_t *args)
2781{
2782 /*
2783 * Lookup tables for randstr char classes
2784 */
2785 static char randstr_punc[] = "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~";
2786 static char randstr_salt[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmopqrstuvwxyz/.";
2787
2788 /*
2789 * Characters humans rarely confuse. Reduces char set considerably
2790 * should only be used for things such as one time passwords.
2791 */
2792 static char randstr_otp[] = "469ACGHJKLMNPQRUVWXYabdfhijkprstuvwxyz";
2793
2794 char const *p, *start, *end;
2795 char *endptr;
2796 char *buff_p;
2797 unsigned int result;
2798 unsigned int reps;
2799 size_t outlen = 0;
2800 fr_value_box_t* vb;
2801 fr_value_box_t *in_head;
2802
2803 XLAT_ARGS(args, &in_head);
2804
2805 /** Max repetitions of a single character class
2806 *
2807 */
2808#define REPETITION_MAX 1024
2809
2810 start = p = in_head->vb_strvalue;
2811 end = p + in_head->vb_length;
2812
2813 /*
2814 * Calculate size of output
2815 */
2816 while (p < end) {
2817 /*
2818 * Repetition modifiers.
2819 *
2820 * We limit it to REPETITION_MAX, because we don't want
2821 * utter stupidity.
2822 */
2823 if (isdigit((uint8_t) *p)) {
2824 reps = strtol(p, &endptr, 10);
2825 if (reps > REPETITION_MAX) reps = REPETITION_MAX;
2826 outlen += reps;
2827 p = endptr;
2828 } else {
2829 outlen++;
2830 }
2831 p++;
2832 }
2833
2834 MEM(vb = fr_value_box_alloc_null(ctx));
2835 MEM(fr_value_box_bstr_alloc(vb, &buff_p, vb, NULL, outlen, false) == 0);
2836
2837 /* Reset p to start position */
2838 p = start;
2839
2840 while (p < end) {
2841 size_t i;
2842
2843 if (isdigit((uint8_t) *p)) {
2844 reps = strtol(p, &endptr, 10);
2845 if (reps > REPETITION_MAX) {
2846 reps = REPETITION_MAX;
2847 RMARKER(L_WARN, L_DBG_LVL_2, start, p - start,
2848 "Forcing repetition to %u", (unsigned int)REPETITION_MAX);
2849 }
2850 p = endptr;
2851 } else {
2852 reps = 1;
2853 }
2854
2855 for (i = 0; i < reps; i++) {
2856 result = fr_rand();
2857 switch (*p) {
2858 /*
2859 * Lowercase letters
2860 */
2861 case 'c':
2862 *buff_p++ = 'a' + (result % 26);
2863 break;
2864
2865 /*
2866 * Uppercase letters
2867 */
2868 case 'C':
2869 *buff_p++ = 'A' + (result % 26);
2870 break;
2871
2872 /*
2873 * Numbers
2874 */
2875 case 'n':
2876 *buff_p++ = '0' + (result % 10);
2877 break;
2878
2879 /*
2880 * Alpha numeric
2881 */
2882 case 'a':
2883 *buff_p++ = randstr_salt[result % (sizeof(randstr_salt) - 3)];
2884 break;
2885
2886 /*
2887 * Punctuation
2888 */
2889 case '!':
2890 *buff_p++ = randstr_punc[result % (sizeof(randstr_punc) - 1)];
2891 break;
2892
2893 /*
2894 * Alpha numeric + punctuation
2895 */
2896 case '.':
2897 *buff_p++ = '!' + (result % 95);
2898 break;
2899
2900 /*
2901 * Alpha numeric + salt chars './'
2902 */
2903 case 's':
2904 *buff_p++ = randstr_salt[result % (sizeof(randstr_salt) - 1)];
2905 break;
2906
2907 /*
2908 * Chars suitable for One Time Password tokens.
2909 * Alpha numeric with easily confused char pairs removed.
2910 */
2911 case 'o':
2912 *buff_p++ = randstr_otp[result % (sizeof(randstr_otp) - 1)];
2913 break;
2914
2915 /*
2916 * Binary data - Copy between 1-4 bytes at a time
2917 */
2918 case 'b':
2919 {
2920 size_t copy = (reps - i) > sizeof(result) ? sizeof(result) : reps - i;
2921
2922 memcpy(buff_p, (uint8_t *)&result, copy);
2923 buff_p += copy;
2924 i += (copy - 1); /* Loop +1 */
2925 }
2926 break;
2927
2928 default:
2929 REDEBUG("Invalid character class '%c'", *p);
2930 talloc_free(vb);
2931
2932 return XLAT_ACTION_FAIL;
2933 }
2934 }
2935
2936 p++;
2937 }
2938
2939 *buff_p++ = '\0';
2940
2942
2943 return XLAT_ACTION_DONE;
2944}
2945
2946/** Convert a UUID in an array of uint32_t to the conventional string representation.
2947 */
2948static int uuid_print_vb(fr_value_box_t *vb, uint32_t vals[4])
2949{
2950 char buffer[36];
2951 int i, j = 0;
2952
2953#define UUID_CHARS(_v, _num) for (i = 0; i < _num; i++) { \
2954 buffer[j++] = fr_base16_alphabet_encode_lc[(uint8_t)((vals[_v] & 0xf0000000) >> 28)]; \
2955 vals[_v] = vals[_v] << 4; \
2956 }
2957
2958 UUID_CHARS(0, 8)
2959 buffer[j++] = '-';
2960 UUID_CHARS(1, 4)
2961 buffer[j++] = '-';
2962 UUID_CHARS(1, 4);
2963 buffer[j++] = '-';
2964 UUID_CHARS(2, 4);
2965 buffer[j++] = '-';
2966 UUID_CHARS(2, 4);
2967 UUID_CHARS(3, 8);
2968
2969 return fr_value_box_bstrndup(vb, vb, NULL, buffer, sizeof(buffer), false);
2970}
2971
2972static inline void uuid_set_version(uint32_t vals[4], uint8_t version)
2973{
2974 /*
2975 * The version is indicated by the upper 4 bits of byte 7 - the 3rd byte of vals[1]
2976 */
2977 vals[1] = (vals[1] & 0xffff0fff) | (((uint32_t)version & 0x0f) << 12);
2978}
2979
2980static inline void uuid_set_variant(uint32_t vals[4], uint8_t variant)
2981{
2982 /*
2983 * The variant is indicated by the first 1, 2 or 3 bits of byte 9
2984 * The number of bits is determined by the variant.
2985 */
2986 switch (variant) {
2987 case 0:
2988 vals[2] = vals[2] & 0x7fffffff;
2989 break;
2990
2991 case 1:
2992 vals[2] = (vals[2] & 0x3fffffff) | 0x80000000;
2993 break;
2994
2995 case 2:
2996 vals[2] = (vals[2] & 0x3fffffff) | 0xc0000000;
2997 break;
2998
2999 case 3:
3000 vals[2] = vals[2] | 0xe0000000;
3001 break;
3002 }
3003}
3004
3005/** Generate a version 4 UUID
3006 *
3007 * Version 4 UUIDs are all random except the version and variant fields
3008 *
3009 * Example:
3010@verbatim
3011%uuid.v4 == "cba48bda-641c-42ae-8173-d97aa04f888a"
3012@endverbatim
3013 * @ingroup xlat_functions
3014 */
3015static xlat_action_t xlat_func_uuid_v4(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx,
3016 UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
3017{
3018 fr_value_box_t *vb;
3019 uint32_t vals[4];
3020 int i;
3021
3022 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL));
3023
3024 /*
3025 * A type 4 UUID is all random except a few bits.
3026 * Start with 128 bits of random.
3027 */
3028 for (i = 0; i < 4; i++) vals[i] = fr_rand();
3029
3030 /*
3031 * Set the version and variant fields
3032 */
3033 uuid_set_version(vals, 4);
3034 uuid_set_variant(vals, 1);
3035
3036 if (uuid_print_vb(vb, vals) < 0) {
3037 talloc_free(vb);
3038 return XLAT_ACTION_FAIL;
3039 }
3040
3042 return XLAT_ACTION_DONE;
3043}
3044
3045/** Generate a version 7 UUID
3046 *
3047 * Version 7 UUIDs use 48 bits of unix millisecond epoch and 74 bits of random
3048 *
3049 * Example:
3050@verbatim
3051%uuid.v7 == "019a58d8-8524-7342-aa07-c0fa2bba6a4e"
3052@endverbatim
3053 * @ingroup xlat_functions
3054 */
3055static xlat_action_t xlat_func_uuid_v7(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx,
3056 UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
3057{
3058 fr_value_box_t *vb;
3059 uint32_t vals[4];
3060 int i;
3061 uint64_t now;
3062
3063 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL));
3064
3065 /*
3066 * A type 7 UUID has random data from bit 48
3067 * Start with random from bit 32 - since fr_rand is uint32
3068 */
3069 for (i = 1; i < 4; i++) vals[i] = fr_rand();
3070
3071 /*
3072 * The millisecond epoch fills the first 48 bits
3073 */
3074 now = fr_time_to_msec(fr_time());
3075 now = now << 16;
3076 vals[0] = now >> 32;
3077 vals[1] = (vals[1] & 0x0000ffff) | (now & 0xffff0000);
3078
3079 /*
3080 * Set the version and variant fields
3081 */
3082 uuid_set_version(vals, 7);
3083 uuid_set_variant(vals, 1);
3084
3085 if (uuid_print_vb(vb, vals) < 0) return XLAT_ACTION_FAIL;
3086
3088 return XLAT_ACTION_DONE;
3089}
3090
3092 { .required = true, .type = FR_TYPE_UINT64 },
3093 { .required = false, .type = FR_TYPE_UINT64 },
3094 { .required = false, .type = FR_TYPE_UINT64 },
3096};
3097
3098/** Generate a range of uint64 numbers
3099 *
3100 * Example:
3101@verbatim
3102%range(end) - 0..end
3103%rang(start, end)
3104%range(start,end, step)
3105@endverbatim
3106 * @ingroup xlat_functions
3107 */
3109 UNUSED xlat_ctx_t const *xctx,
3110 request_t *request, fr_value_box_list_t *args)
3111{
3112 fr_value_box_t *start_vb, *end_vb, *step_vb;
3113 fr_value_box_t *dst;
3114 uint64_t i, start, end, step;
3115
3116 XLAT_ARGS(args, &start_vb, &end_vb, &step_vb);
3117
3118 /*
3119 * Explicit `null` for an optional arg is equivalent to the
3120 * arg being absent. The vb_group field on an FR_TYPE_NULL
3121 * box is zeroed, so list_head() would return NULL and the
3122 * downstream `->vb_uint64` would dereference NULL.
3123 */
3124 if (end_vb && fr_type_is_null(end_vb->type)) end_vb = NULL;
3125 if (step_vb && fr_type_is_null(step_vb->type)) step_vb = NULL;
3126
3127 if (step_vb) {
3128 if (!end_vb) {
3129 REDEBUG("Invalid range - 'end' cannot be null when 'step' is provided");
3130 return XLAT_ACTION_FAIL;
3131 }
3132
3133 start = fr_value_box_list_head(&start_vb->vb_group)->vb_uint64;
3134 end = fr_value_box_list_head(&end_vb->vb_group)->vb_uint64;
3135 step = fr_value_box_list_head(&step_vb->vb_group)->vb_uint64;
3136
3137 } else if (end_vb) {
3138 start = fr_value_box_list_head(&start_vb->vb_group)->vb_uint64;
3139 end = fr_value_box_list_head(&end_vb->vb_group)->vb_uint64;
3140 step = 1;
3141
3142 } else {
3143 start = 0;
3144 end = fr_value_box_list_head(&start_vb->vb_group)->vb_uint64;
3145 step = 1;
3146 }
3147
3148 if (end <= start) {
3149 REDEBUG("Invalid range - 'start' must be less than 'end'");
3150 return XLAT_ACTION_FAIL;
3151 }
3152
3153 if (!step) {
3154 REDEBUG("Invalid range - 'step' must be greater than zero");
3155 return XLAT_ACTION_FAIL;
3156 }
3157
3158 if (step > (end - start)) {
3159 REDEBUG("Invalid range - 'step' must allow for at least one result");
3160 return XLAT_ACTION_FAIL;
3161 }
3162
3163 if (((end - start) / step) > 1000) {
3164 REDEBUG("Invalid range - Too many results");
3165 return XLAT_ACTION_FAIL;
3166 }
3167
3168 for (i = start; i < end; i += step) {
3169 MEM(dst = fr_value_box_alloc(ctx, FR_TYPE_UINT64, NULL));
3170 dst->vb_uint64 = i;
3171 fr_dcursor_append(out, dst);
3172 }
3173
3174 return XLAT_ACTION_DONE;
3175}
3176
3177static int CC_HINT(nonnull(2,3)) regex_xlat_escape(UNUSED request_t *request, fr_value_box_t *vb, UNUSED void *uctx)
3178{
3179 ssize_t slen;
3180 fr_sbuff_t *out = NULL;
3181 fr_value_box_entry_t entry;
3182
3183 FR_SBUFF_TALLOC_THREAD_LOCAL(&out, 256, 4096);
3184
3185 slen = fr_value_box_print(out, vb, &regex_escape_rules);
3186 if (slen < 0) return -1;
3187
3188 entry = vb->entry;
3190 (void) fr_value_box_bstrndup(vb, vb, NULL, fr_sbuff_start(out), fr_sbuff_used(out), false);
3191 vb->entry = entry;
3192
3193 return 0;
3194}
3195
3200
3201
3202/** Get named subcapture value from previous regex
3203 *
3204 * Example:
3205@verbatim
3206if ("foo" =~ /^(?<name>.*)/) {
3207 noop
3208}
3209%regex.match(name) == "foo"
3210@endverbatim
3211 *
3212 * @ingroup xlat_functions
3213 */
3215 UNUSED xlat_ctx_t const *xctx,
3216 request_t *request, fr_value_box_list_t *in)
3217{
3218 fr_value_box_t *in_head = fr_value_box_list_head(in);
3219
3220 /*
3221 * Find the first child of the first argument group
3222 */
3223 fr_value_box_t *arg = fr_value_box_list_head(&in_head->vb_group);
3224
3225 /*
3226 * Return the complete capture if no other capture is specified
3227 */
3228 if (!arg) {
3229 fr_value_box_t *vb;
3230
3231 MEM(vb = fr_value_box_alloc_null(ctx));
3232 if (regex_request_to_sub(vb, vb, request, 0) < 0) {
3233 REDEBUG2("No previous regex capture");
3234 talloc_free(vb);
3235 return XLAT_ACTION_FAIL;
3236 }
3237
3239
3240 return XLAT_ACTION_DONE;
3241 }
3242
3243 switch (arg->type) {
3244 /*
3245 * If the input is an integer value then get an
3246 * arbitrary subcapture index.
3247 */
3248 case FR_TYPE_NUMERIC:
3249 {
3250 fr_value_box_t idx;
3251 fr_value_box_t *vb;
3252
3253 if (fr_value_box_list_next(in, in_head)) {
3254 REDEBUG("Only one subcapture argument allowed");
3255 return XLAT_ACTION_FAIL;
3256 }
3257
3258 if (fr_value_box_cast(NULL, &idx, FR_TYPE_UINT32, NULL, arg) < 0) {
3259 RPEDEBUG("Bad subcapture index");
3260 return XLAT_ACTION_FAIL;
3261 }
3262
3263 MEM(vb = fr_value_box_alloc_null(ctx));
3264 if (regex_request_to_sub(vb, vb, request, idx.vb_uint32) < 0) {
3265 REDEBUG2("No previous numbered regex capture group '%u'", idx.vb_uint32);
3266 talloc_free(vb);
3267 return XLAT_ACTION_DONE;
3268 }
3270
3271 return XLAT_ACTION_DONE;
3272 }
3273
3274 default:
3275#if defined(HAVE_REGEX_PCRE) || defined(HAVE_REGEX_PCRE2)
3276 {
3277 fr_value_box_t *vb;
3278
3279 /*
3280 * Concatenate all input
3281 */
3283 arg, &in_head->vb_group, FR_TYPE_STRING,
3285 SIZE_MAX) < 0) {
3286 RPEDEBUG("Failed concatenating input");
3287 return XLAT_ACTION_FAIL;
3288 }
3289
3290 MEM(vb = fr_value_box_alloc_null(ctx));
3291 if (regex_request_to_sub_named(vb, vb, request, arg->vb_strvalue) < 0) {
3292 REDEBUG2("No previous named regex capture group '%s'", arg->vb_strvalue);
3293 talloc_free(vb);
3294 return XLAT_ACTION_DONE; /* NOT an error, just an empty result */
3295 }
3297
3298 return XLAT_ACTION_DONE;
3299 }
3300#else
3301 RDEBUG("Named regex captures are not supported (they require libpcre2)");
3302 return XLAT_ACTION_FAIL;
3303#endif
3304 }
3305}
3306
3308 { .concat = true, .type = FR_TYPE_OCTETS },
3310};
3311
3312/** Calculate the SHA1 hash of a string or attribute.
3313 *
3314 * Example:
3315@verbatim
3316%sha1(foo) == "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"
3317@endverbatim
3318 *
3319 * @ingroup xlat_functions
3320 */
3322 UNUSED xlat_ctx_t const *xctx,
3323 UNUSED request_t *request, fr_value_box_list_t *args)
3324{
3326 fr_sha1_ctx sha1_ctx;
3327 fr_value_box_t *vb;
3328 fr_value_box_t *in_head;
3329
3330 XLAT_ARGS(args, &in_head);
3331
3332 fr_sha1_init(&sha1_ctx);
3333 if (in_head) {
3334 fr_sha1_update(&sha1_ctx, in_head->vb_octets, in_head->vb_length);
3335 } else {
3336 /* sha1 of empty string */
3337 fr_sha1_update(&sha1_ctx, NULL, 0);
3338 }
3339 fr_sha1_final(digest, &sha1_ctx);
3340
3341 MEM(vb = fr_value_box_alloc_null(ctx));
3342 fr_value_box_memdup(vb, vb, NULL, digest, sizeof(digest), false);
3343
3345
3346 return XLAT_ACTION_DONE;
3347}
3348
3349/** Calculate any digest supported by OpenSSL EVP_MD
3350 *
3351 * Example:
3352@verbatim
3353%sha2_256(foo) == "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"
3354@endverbatim
3355 *
3356 * @ingroup xlat_functions
3357 */
3358#ifdef HAVE_OPENSSL_EVP_H
3359static xlat_action_t xlat_evp_md(TALLOC_CTX *ctx, fr_dcursor_t *out,
3360 UNUSED xlat_ctx_t const *xctx,
3361 UNUSED request_t *request, fr_value_box_list_t *args, EVP_MD const *md)
3362{
3363 uint8_t digest[EVP_MAX_MD_SIZE];
3364 unsigned int digestlen;
3365 EVP_MD_CTX *md_ctx;
3366 fr_value_box_t *vb;
3367 fr_value_box_t *in_head;
3368
3369 XLAT_ARGS(args, &in_head);
3370
3371 md_ctx = EVP_MD_CTX_create();
3372 EVP_DigestInit_ex(md_ctx, md, NULL);
3373 if (in_head) {
3374 EVP_DigestUpdate(md_ctx, in_head->vb_octets, in_head->vb_length);
3375 } else {
3376 EVP_DigestUpdate(md_ctx, NULL, 0);
3377 }
3378 EVP_DigestFinal_ex(md_ctx, digest, &digestlen);
3379 EVP_MD_CTX_destroy(md_ctx);
3380
3381 MEM(vb = fr_value_box_alloc_null(ctx));
3382 fr_value_box_memdup(vb, vb, NULL, digest, digestlen, false);
3383
3385
3386 return XLAT_ACTION_DONE;
3387}
3388
3389# define EVP_MD_XLAT(_md, _md_func) \
3390static xlat_action_t xlat_func_##_md(TALLOC_CTX *ctx, fr_dcursor_t *out,\
3391 xlat_ctx_t const *xctx, \
3392 request_t *request,\
3393 fr_value_box_list_t *in)\
3394{\
3395 return xlat_evp_md(ctx, out, xctx, request, in, EVP_##_md_func());\
3396}
3397
3398EVP_MD_XLAT(sha2_224, sha224)
3399EVP_MD_XLAT(sha2_256, sha256)
3400EVP_MD_XLAT(sha2_384, sha384)
3401EVP_MD_XLAT(sha2_512, sha512)
3402
3403/*
3404 * OpenWRT's OpenSSL library doesn't contain these by default
3405 */
3406#ifdef HAVE_EVP_BLAKE2S256
3407EVP_MD_XLAT(blake2s_256, blake2s256)
3408#endif
3409
3410#ifdef HAVE_EVP_BLAKE2B512
3411EVP_MD_XLAT(blake2b_512, blake2b512)
3412#endif
3413
3414EVP_MD_XLAT(sha3_224, sha3_224)
3415EVP_MD_XLAT(sha3_256, sha3_256)
3416EVP_MD_XLAT(sha3_384, sha3_384)
3417EVP_MD_XLAT(sha3_512, sha3_512)
3418#endif
3419
3420
3422 { .required = true, .concat = true, .type = FR_TYPE_STRING },
3424};
3425
3427 { .concat = true, .type = FR_TYPE_STRING },
3429};
3430
3431/** Print length of given string
3432 *
3433 * Example:
3434@verbatim
3435%strlen(foo) == 3
3436@endverbatim
3437 *
3438 * @see #xlat_func_length
3439 *
3440 * @ingroup xlat_functions
3441 */
3443 UNUSED xlat_ctx_t const *xctx,
3444 UNUSED request_t *request, fr_value_box_list_t *args)
3445{
3446 fr_value_box_t *vb;
3447 fr_value_box_t *in_head;
3448
3449 XLAT_ARGS(args, &in_head);
3450
3451 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_SIZE, NULL));
3452
3453 if (!in_head) {
3454 vb->vb_size = 0;
3455 } else {
3456 vb->vb_size = strlen(in_head->vb_strvalue);
3457 }
3458
3460
3461 return XLAT_ACTION_DONE;
3462}
3463
3465 { .concat = true, .type = FR_TYPE_STRING, .required = true, },
3466 { .single = true, .type = FR_TYPE_BOOL },
3468};
3469
3470/** Return whether a string has only printable chars
3471 *
3472 * This function returns true if the input string contains UTF8 sequences and printable chars.
3473 *
3474 * @note "\t" and " " are considered unprintable chars, unless the second argument(relaxed) is true.
3475 *
3476 * Example:
3477@verbatim
3478%str.printable("🍉abcdef🍓") == true
3479%str.printable("\000\n\r\t") == false
3480%str.printable("\t abcd", yes) == true
3481@endverbatim
3482 *
3483 * @ingroup xlat_functions
3484 */
3486 UNUSED xlat_ctx_t const *xctx,
3487 UNUSED request_t *request, fr_value_box_list_t *args)
3488{
3489 fr_value_box_t *vb;
3490 fr_value_box_t *str;
3491 fr_value_box_t *relaxed_vb;
3492 uint8_t const *p, *end;
3493 bool relaxed = false;
3494
3495 XLAT_ARGS(args, &str, &relaxed_vb);
3496
3497 if (relaxed_vb) relaxed = relaxed_vb->vb_bool;
3498
3499 p = (uint8_t const *)str->vb_strvalue;
3500 end = p + str->vb_length;
3501
3502 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
3504 vb->vb_bool = false;
3505
3506 do {
3507 size_t clen;
3508
3509 if ((*p < '!') &&
3510 (!relaxed || ((*p != '\t') && (*p != ' ')))) return XLAT_ACTION_DONE;
3511
3512 if (*p == 0x7f) return XLAT_ACTION_DONE;
3513
3514 clen = fr_utf8_char(p, end - p);
3515 if (clen == 0) return XLAT_ACTION_DONE;
3516 p += clen;
3517 } while (p < end);
3518
3519 vb->vb_bool = true;
3520
3521 return XLAT_ACTION_DONE;
3522}
3523
3525 { .concat = true, .type = FR_TYPE_STRING },
3527};
3528
3529/** Return whether a string is valid UTF-8
3530 *
3531 * This function returns true if the input string is valid UTF-8, false otherwise.
3532 *
3533 * Example:
3534@verbatim
3535%str.utf8(🍉🥝🍓) == true
3536%str.utf8(🍉\xff🍓) == false
3537@endverbatim
3538 *
3539 * @ingroup xlat_functions
3540 */
3542 UNUSED xlat_ctx_t const *xctx,
3543 UNUSED request_t *request, fr_value_box_list_t *args)
3544{
3545 fr_value_box_t *vb;
3546 fr_value_box_t *in_head;
3547
3548 XLAT_ARGS(args, &in_head);
3549
3550 if (!in_head) return XLAT_ACTION_FAIL;
3551
3552 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
3553 vb->vb_bool = (fr_utf8_str((uint8_t const *)in_head->vb_strvalue,
3554 in_head->vb_length) >= 0);
3555
3557
3558 return XLAT_ACTION_DONE;
3559}
3560
3562 { .single = true, .required = true, .type = FR_TYPE_VOID },
3563 { .single = true, .required = true, .type = FR_TYPE_INT32 },
3564 { .single = true, .type = FR_TYPE_INT32 },
3566};
3567
3568/** Extract a substring from string / octets data
3569 *
3570 * Non string / octets data is cast to a string.
3571 *
3572 * Second parameter is start position, optional third parameter is length
3573 * Negative start / length count from RHS of data.
3574 *
3575 * Example: (User-Name = "hello")
3576@verbatim
3577%substr(&User-Name, 1, 3) == 'ell'
3578@endverbatim
3579 *
3580 * @ingroup xlat_functions
3581 */
3582static xlat_action_t xlat_func_substr(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx,
3583 request_t *request, fr_value_box_list_t *args)
3584{
3585 fr_value_box_t *in = NULL, *start_vb, *len_vb, *vb;
3586 int32_t start, end, len;
3587
3588 XLAT_ARGS(args, &in, &start_vb, &len_vb);
3589
3590 switch (in->type) {
3591 case FR_TYPE_OCTETS:
3592 case FR_TYPE_STRING:
3593 break;
3594
3595 default:
3597 RPEDEBUG("Failed casting value to string");
3598 return XLAT_ACTION_FAIL;
3599 }
3600 break;
3601 }
3602
3603 if (start_vb->vb_int32 > (int32_t)in->vb_length) return XLAT_ACTION_DONE;
3604
3605 if (start_vb->vb_int32 < 0) {
3606 start = in->vb_length + start_vb->vb_int32;
3607 if (start < 0) start = 0;
3608 } else {
3609 start = start_vb->vb_int32;
3610 }
3611
3612 if (len_vb) {
3613 if (len_vb->vb_int32 < 0) {
3614 end = in->vb_length + len_vb->vb_int32;
3615 if (end < 0) return XLAT_ACTION_DONE;
3616 } else {
3617 end = start + len_vb->vb_int32;
3618 if (end > (int32_t)in->vb_length) end = in->vb_length;
3619 }
3620 } else {
3621 end = in->vb_length;
3622 }
3623
3624 if (start >= end) return XLAT_ACTION_DONE;
3625
3626 MEM(vb = fr_value_box_alloc(ctx, in->type, NULL));
3627
3628 len = end - start;
3629 switch (in->type) {
3630 case FR_TYPE_STRING:
3631 fr_value_box_bstrndup(vb, vb, NULL, &in->vb_strvalue[start], len, false);
3632 break;
3633 case FR_TYPE_OCTETS:
3634 {
3635 uint8_t *buf;
3636 fr_value_box_mem_alloc(vb, &buf, vb, NULL, len, false);
3637 memcpy(buf, &in->vb_octets[start], len);
3638 }
3639 break;
3640
3641 default: /* 'in' was cast to #FR_TYPE_STRING */
3642 fr_assert(0);
3643 }
3644
3647
3648 return XLAT_ACTION_DONE;
3649}
3650
3651#ifdef HAVE_REGEX_PCRE2
3652/** Cache statically compiled expressions
3653 */
3654typedef struct {
3655 regex_t *pattern;
3656 fr_regex_flags_t flags;
3657} xlat_subst_regex_inst_t;
3658
3659/** Pre-compile regexes where possible
3660 */
3661static int xlat_instantiate_subst_regex(xlat_inst_ctx_t const *xctx)
3662{
3663 xlat_subst_regex_inst_t *inst = talloc_get_type_abort(xctx->inst, xlat_subst_regex_inst_t);
3664 xlat_exp_t *patt_exp;
3665 fr_sbuff_t sbuff;
3666 fr_sbuff_marker_t start_m, end_m;
3667
3668 /* args #2 (pattern) */
3669 patt_exp = fr_dlist_next(&xctx->ex->call.args->dlist, fr_dlist_head(&xctx->ex->call.args->dlist));
3670 fr_assert(patt_exp && patt_exp->type == XLAT_GROUP); /* args must be groups */
3671
3672 /* If there are dynamic expansions, we can't pre-compile */
3673 if (!xlat_is_literal(patt_exp->group)) return 0;
3674 fr_assert(fr_dlist_num_elements(&patt_exp->group->dlist) == 1);
3675
3676 patt_exp = fr_dlist_head(&patt_exp->group->dlist);
3677
3678 /* We can only pre-compile strings */
3679 if (!fr_type_is_string(patt_exp->data.type)) return 0;
3680
3681 sbuff = FR_SBUFF_IN(patt_exp->data.vb_strvalue, patt_exp->data.vb_length);
3682
3683 /* skip any whitesapce */
3684 fr_sbuff_adv_past_whitespace(&sbuff, SIZE_MAX, 0);
3685
3686 /* Is the next char a forward slash? */
3687 if (fr_sbuff_next_if_char(&sbuff, '/')) {
3688 fr_slen_t slen;
3689
3690 fr_sbuff_marker(&start_m, &sbuff);
3691
3692 if (!fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '/')) return 0; /* Not a regex */
3693
3694 fr_sbuff_marker(&end_m, &sbuff);
3695 fr_sbuff_next(&sbuff); /* skip trailing slash */
3696
3697 if (fr_sbuff_remaining(&sbuff)) {
3698 slen = regex_flags_parse(NULL, &inst->flags,
3699 &sbuff,
3700 NULL, true);
3701 if (slen < 0) {
3702 PERROR("Failed parsing regex flags in \"%s\"", patt_exp->data.vb_strvalue);
3703 return -1;
3704 }
3705 }
3706
3707 if (regex_compile(inst, &inst->pattern,
3708 fr_sbuff_current(&start_m), fr_sbuff_current(&end_m) - fr_sbuff_current(&start_m),
3709 &inst->flags, true, false) <= 0) {
3710 PERROR("Failed compiling regex \"%s\"", patt_exp->data.vb_strvalue);
3711 return -1;
3712 }
3713 }
3714 /* No... then it's not a regex */
3715
3716 return 0;
3717}
3718
3719/** Perform regex substitution TODO CHECK
3720 *
3721 * Called when %subst() pattern begins with "/"
3722 *
3723@verbatim
3724%subst(<subject>, /<regex>/[flags], <replace>)
3725@endverbatim
3726 *
3727 * Example: (User-Name = "foo")
3728@verbatim
3729%subst(%{User-Name}, /oo.*$/, 'un') == "fun"
3730@endverbatim
3731 *
3732 * @note References can be specified in the replacement string with $<ref>
3733 *
3734 * @see #xlat_func_subst
3735 *
3736 * @ingroup xlat_functions
3737 */
3738static int xlat_func_subst_regex(TALLOC_CTX *ctx, fr_dcursor_t *out,
3739 xlat_ctx_t const *xctx, request_t *request,
3740 fr_value_box_list_t *args)
3741{
3742 xlat_subst_regex_inst_t const *inst = talloc_get_type_abort_const(xctx->inst, xlat_subst_regex_inst_t);
3743 fr_sbuff_t sbuff;
3744 fr_sbuff_marker_t start_m, end_m;
3745 char *buff;
3746 ssize_t slen;
3747 regex_t *pattern, *our_pattern = NULL;
3748 fr_regex_flags_t const *flags;
3749 fr_regex_flags_t our_flags = {};
3750 fr_value_box_t *vb;
3751 fr_value_box_t *subject_vb;
3752 fr_value_box_t *regex_vb;
3753 fr_value_box_t *rep_vb;
3754
3755 XLAT_ARGS(args, &subject_vb, &regex_vb, &rep_vb);
3756
3757 /*
3758 * Was not pre-compiled, so we need to compile it now
3759 */
3760 if (!inst->pattern) {
3761 sbuff = FR_SBUFF_IN(regex_vb->vb_strvalue, regex_vb->vb_length);
3762 if (fr_sbuff_len(&sbuff) == 0) {
3763 REDEBUG("Regex must not be empty");
3764 return XLAT_ACTION_FAIL;
3765 }
3766
3767 fr_sbuff_next(&sbuff); /* skip leading slash */
3768 fr_sbuff_marker(&start_m, &sbuff);
3769
3770 if (!fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '/')) return 1; /* Not a regex */
3771
3772 fr_sbuff_marker(&end_m, &sbuff);
3773 fr_sbuff_next(&sbuff); /* skip trailing slash */
3774
3775 slen = regex_flags_parse(NULL, &our_flags, &sbuff, NULL, true);
3776 if (slen < 0) {
3777 RPEDEBUG("Failed parsing regex flags");
3778 return -1;
3779 }
3780
3781 /*
3782 * Process the substitution
3783 */
3784 if (regex_compile(NULL, &our_pattern,
3785 fr_sbuff_current(&start_m), fr_sbuff_current(&end_m) - fr_sbuff_current(&start_m),
3786 &our_flags, true, true) <= 0) {
3787 RPEDEBUG("Failed compiling regex");
3788 return -1;
3789 }
3790 pattern = our_pattern;
3791 flags = &our_flags;
3792 } else {
3793 pattern = inst->pattern;
3794 flags = &inst->flags;
3795 }
3796
3797 MEM(vb = fr_value_box_alloc_null(ctx));
3798 if (regex_substitute(vb, &buff, 0, pattern, flags,
3799 subject_vb->vb_strvalue, subject_vb->vb_length,
3800 rep_vb->vb_strvalue, rep_vb->vb_length, NULL) < 0) {
3801 RPEDEBUG("Failed performing substitution");
3802 talloc_free(vb);
3803 talloc_free(pattern);
3804 return -1;
3805 }
3806 fr_value_box_bstrdup_buffer_shallow(NULL, vb, NULL, buff, false);
3807
3808 fr_value_box_safety_copy(vb, subject_vb);
3809 fr_value_box_safety_merge(vb, rep_vb);
3810
3812
3813 talloc_free(our_pattern);
3814
3815 return 0;
3816}
3817#endif
3818
3820 { .required = true, .concat = true, .type = FR_TYPE_STRING },
3821 { .required = true, .concat = true, .type = FR_TYPE_STRING },
3822 { .required = true, .concat = true, .type = FR_TYPE_STRING },
3824};
3825
3826/** Perform regex substitution
3827 *
3828@verbatim
3829%subst(<subject>, <pattern>, <replace>)
3830@endverbatim
3831 *
3832 * Example: (User-Name = "foobar")
3833@verbatim
3834%subst(%{User-Name}, 'oo', 'un') == "funbar"
3835@endverbatim
3836 *
3837 * @see xlat_func_subst_regex
3838 *
3839 * @ingroup xlat_functions
3840 */
3842#ifdef HAVE_REGEX_PCRE2
3843 xlat_ctx_t const *xctx,
3844#else
3845 UNUSED xlat_ctx_t const *xctx,
3846#endif
3847 request_t *request, fr_value_box_list_t *args)
3848{
3849 char const *p, *q, *end;
3850 char *vb_str;
3851
3852 char const *pattern, *rep;
3853 size_t pattern_len, rep_len;
3854
3855 fr_value_box_t *rep_vb, *vb;
3856 fr_value_box_t *subject_vb;
3857 fr_value_box_t *pattern_vb;
3858
3859 XLAT_ARGS(args, &subject_vb, &pattern_vb, &rep_vb);
3860
3861 /* coverity[dereference] */
3862 pattern = pattern_vb->vb_strvalue;
3863 if (*pattern == '/') {
3864#ifdef HAVE_REGEX_PCRE2
3865 switch (xlat_func_subst_regex(ctx, out, xctx, request, args)) {
3866 case 0:
3867 return XLAT_ACTION_DONE;
3868
3869 case 1:
3870 /* Not a regex, fall through */
3871 break;
3872
3873 case -1:
3874 return XLAT_ACTION_FAIL;
3875 }
3876#else
3877 if (memchr(pattern, '/', pattern_vb->vb_length - 1)) {
3878 REDEBUG("regex based substitutions require libpcre2. "
3879 "Check ${features.regex-pcre2} to determine support");
3880 }
3881 return XLAT_ACTION_FAIL;
3882#endif
3883 }
3884
3885 /*
3886 * Check for empty pattern
3887 */
3888 pattern_len = pattern_vb->vb_length;
3889 if (pattern_len == 0) {
3890 REDEBUG("Empty pattern");
3891 return XLAT_ACTION_FAIL;
3892 }
3893
3894 rep = rep_vb->vb_strvalue;
3895 rep_len = rep_vb->vb_length;
3896
3897 p = subject_vb->vb_strvalue;
3898 end = p + subject_vb->vb_length;
3899
3900 MEM(vb = fr_value_box_alloc_null(ctx));
3901 vb_str = talloc_bstrndup(vb, "", 0);
3902
3903 while (p < end) {
3904 q = memmem(p, end - p, pattern, pattern_len);
3905 if (!q) {
3906 MEM(vb_str = talloc_bstr_append(vb, vb_str, p, end - p));
3907 break;
3908 }
3909
3910 if (q > p) MEM(vb_str = talloc_bstr_append(vb, vb_str, p, q - p));
3911 if (rep_len) MEM(vb_str = talloc_bstr_append(vb, vb_str, rep, rep_len));
3912 p = q + pattern_len;
3913 }
3914
3915 if (fr_value_box_bstrdup_buffer_shallow(NULL, vb, NULL, vb_str, false) < 0) {
3916 RPEDEBUG("Failed creating output box");
3917 talloc_free(vb);
3918 return XLAT_ACTION_FAIL;
3919 }
3920
3921 fr_value_box_safety_copy(vb, subject_vb);
3922 fr_value_box_safety_merge(vb, rep_vb);
3923
3925
3926 return XLAT_ACTION_DONE;
3927}
3928
3929/*
3930 * Debug builds only, we don't want to allow unsanitised inputs to crash the server
3931 */
3932#ifndef NDEBUG
3934 { .single = true, .required = true, .type = FR_TYPE_STRING },
3936};
3937
3939 UNUSED xlat_ctx_t const *xctx, request_t *request,
3940 fr_value_box_list_t *args)
3941{
3942 static fr_table_num_sorted_t const signal_table[] = {
3943 { L("break"), SIGTRAP }, /* Save flailing at the keyboard */
3944 { L("BREAK"), SIGTRAP },
3945 { L("SIGABRT"), SIGABRT },
3946 { L("SIGALRM"), SIGALRM },
3947#ifdef SIGBUS
3948 { L("SIGBUS"), SIGBUS },
3949#endif
3950 { L("SIGCHLD"), SIGCHLD },
3951 { L("SIGCONT"), SIGCONT },
3952 { L("SIGFPE"), SIGFPE },
3953 { L("SIGHUP"), SIGHUP },
3954 { L("SIGILL"), SIGILL },
3955 { L("SIGINT"), SIGINT },
3956 { L("SIGKILL"), SIGKILL },
3957 { L("SIGPIPE"), SIGPIPE },
3958#ifdef SIGPOLL
3959 { L("SIGPOLL"), SIGPOLL },
3960#endif
3961 { L("SIGPROF"), SIGPROF },
3962 { L("SIGQUIT"), SIGQUIT },
3963 { L("SIGSEGV"), SIGSEGV },
3964 { L("SIGSTOP"), SIGSTOP },
3965#ifdef SIGSYS
3966 { L("SIGSYS"), SIGSYS },
3967#endif
3968 { L("SIGTERM"), SIGTERM },
3969#ifdef SIGTRAP
3970 { L("SIGTRAP"), SIGTRAP },
3971#endif
3972 { L("SIGTSTP"), SIGTSTP },
3973 { L("SIGTTIN"), SIGTTIN },
3974 { L("SIGTTOU"), SIGTTOU },
3975 { L("SIGURG"), SIGURG },
3976 { L("SIGUSR1"), SIGUSR1 },
3977 { L("SIGUSR2"), SIGUSR2 },
3978 { L("SIGVTALRM"), SIGVTALRM },
3979 { L("SIGXCPU"), SIGXCPU },
3980 { L("SIGXFSZ"), SIGXFSZ }
3981 };
3982 static size_t signal_table_len = NUM_ELEMENTS(signal_table);
3983
3984 fr_value_box_t *signal_vb;
3985 int signal;
3986
3987 XLAT_ARGS(args, &signal_vb);
3988
3989 signal = fr_table_value_by_substr(signal_table, signal_vb->vb_strvalue, signal_vb->vb_length, -1);
3990 if (signal < 0) {
3991 RERROR("Invalid signal \"%pV\"", signal_vb);
3992 return XLAT_ACTION_FAIL;
3993 }
3994 if (raise(signal) < 0) {
3995 RERROR("Failed raising signal %d: %s", signal, strerror(errno));
3996 return XLAT_ACTION_FAIL;
3997 }
3998 return XLAT_ACTION_DONE;
3999}
4000#endif
4001
4003 { .required = false, .single = true, .type = FR_TYPE_STRING },
4005};
4006
4007/** Return the time as a #FR_TYPE_DATE
4008 *
4009 * Note that all operations are UTC.
4010 *
4011@verbatim
4012%time()
4013@endverbatim
4014 *
4015 * Example:
4016@verbatim
4017update reply {
4018 &Reply-Message := "%{%time(now) - %time(request)}"
4019}
4020@endverbatim
4021 *
4022 * @ingroup xlat_functions
4023 */
4025 UNUSED xlat_ctx_t const *xctx,
4026 request_t *request, fr_value_box_list_t *args)
4027{
4028 fr_value_box_t *arg;
4029 fr_value_box_t *vb;
4031
4032 XLAT_ARGS(args, &arg);
4033
4034 /*
4035 * An explicit `null` is treated the same as a missing arg -
4036 * vb_strvalue is unset on an FR_TYPE_NULL box, so reading it
4037 * would be UB.
4038 */
4039 if (arg && fr_type_is_null(arg->type)) arg = NULL;
4040
4041 if (!arg || (strcmp(arg->vb_strvalue, "now") == 0)) {
4043
4044 } else if (strcmp(arg->vb_strvalue, "request") == 0) {
4045 value = fr_time_to_unix_time(request->packet->timestamp);
4046
4047 } else if (strcmp(arg->vb_strvalue, "offset") == 0) {
4048 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_TIME_DELTA, NULL));
4049 vb->vb_time_delta = fr_time_gmtoff();
4050 goto append;
4051
4052 } else if (strcmp(arg->vb_strvalue, "dst") == 0) {
4053 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
4054 vb->vb_bool = fr_time_is_dst();
4055 goto append;
4056
4057 } else if (strcmp(arg->vb_strvalue, "mday_offset") == 0) {
4058 struct tm tm;
4059 fr_unix_time_t unix_time = fr_time_to_unix_time(request->packet->timestamp);
4060 time_t when = fr_unix_time_to_sec(unix_time);
4061 int64_t nsec;
4062
4063 gmtime_r(&when, &tm);
4064
4065 nsec = (int64_t) 86400 * (tm.tm_mday - 1);
4066 nsec += when % 86400;
4067 nsec *= NSEC;
4068 nsec += fr_unix_time_unwrap(unix_time) % NSEC;
4069
4070 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_TIME_DELTA, NULL));
4071 vb->vb_time_delta = fr_time_delta_wrap(nsec);
4072 goto append;
4073
4074 } else if (strcmp(arg->vb_strvalue, "wday_offset") == 0) {
4075 struct tm tm;
4076 fr_unix_time_t unix_time = fr_time_to_unix_time(request->packet->timestamp);
4077 time_t when = fr_unix_time_to_sec(unix_time);
4078 int64_t nsec;
4079
4080 gmtime_r(&when, &tm);
4081
4082 nsec = (int64_t) 86400 * tm.tm_wday;
4083 nsec += when % 86400;
4084 nsec *= NSEC;
4085 nsec += fr_unix_time_unwrap(unix_time) % NSEC;
4086
4087 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_TIME_DELTA, NULL));
4088 vb->vb_time_delta = fr_time_delta_wrap(nsec);
4089 goto append;
4090
4091 } else if (fr_unix_time_from_str(&value, arg->vb_strvalue, FR_TIME_RES_SEC) < 0) {
4092 REDEBUG("Invalid time specification '%s'", arg->vb_strvalue);
4093 return XLAT_ACTION_FAIL;
4094 }
4095
4096 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_DATE, NULL));
4097 vb->vb_date = value;
4098
4099append:
4101
4102 return XLAT_ACTION_DONE;
4103}
4104
4105/** Return the current time as a #FR_TYPE_DATE
4106 *
4107 * Note that all operations are UTC.
4108 *
4109@verbatim
4110%time.now()
4111@endverbatim
4112 *
4113 * Example:
4114@verbatim
4115update reply {
4116 &Reply-Message := "%{%time.now() - %time.request()}"
4117}
4118@endverbatim
4119 *
4120 * @ingroup xlat_functions
4121 */
4123 UNUSED xlat_ctx_t const *xctx,
4124 UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
4125{
4126 fr_value_box_t *vb;
4127
4128 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_DATE, NULL));
4129 vb->vb_date = fr_time_to_unix_time(fr_time());
4130
4132
4133 return XLAT_ACTION_DONE;
4134}
4135
4136/** Return the request receive time as a #FR_TYPE_DATE
4137 *
4138 * Note that all operations are UTC.
4139 *
4140@verbatim
4141%time.request()
4142@endverbatim
4143 *
4144 * Example:
4145@verbatim
4146update reply {
4147 &Reply-Message := "%{%time.now() - %time.request()}"
4148}
4149@endverbatim
4150 *
4151 * @ingroup xlat_functions
4152 */
4154 UNUSED xlat_ctx_t const *xctx,
4155 request_t *request, UNUSED fr_value_box_list_t *args)
4156{
4157 fr_value_box_t *vb;
4158
4159 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_DATE, NULL));
4160 vb->vb_date = fr_time_to_unix_time(request->packet->timestamp);
4161
4163
4164 return XLAT_ACTION_DONE;
4165}
4166
4167
4168/** Return the current time offset from gmt
4169 *
4170 * @ingroup xlat_functions
4171 */
4173 UNUSED xlat_ctx_t const *xctx,
4174 UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
4175{
4176 fr_value_box_t *vb;
4177
4178 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_TIME_DELTA, NULL));
4179 vb->vb_time_delta = fr_time_gmtoff();
4180
4182
4183 return XLAT_ACTION_DONE;
4184}
4185
4186
4187/** Return whether we are in daylight savings or not
4188 *
4189 * @ingroup xlat_functions
4190 */
4192 UNUSED xlat_ctx_t const *xctx,
4193 UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
4194{
4195 fr_value_box_t *vb;
4196
4197 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
4198 vb->vb_bool = fr_time_is_dst();
4199
4201
4202 return XLAT_ACTION_DONE;
4203}
4204
4205
4206/** Change case of a string
4207 *
4208 * If upper is true, change to uppercase, otherwise, change to lowercase
4209 */
4211 UNUSED request_t *request, fr_value_box_list_t *args, bool upper)
4212{
4213 char *p;
4214 char const *end;
4215 fr_value_box_t *vb;
4216
4217 XLAT_ARGS(args, &vb);
4218
4219 p = UNCONST(char *, vb->vb_strvalue);
4220 end = p + vb->vb_length;
4221
4222 while (p < end) {
4223 *(p) = upper ? toupper ((uint8_t) *(p)) : tolower((uint8_t) *(p));
4224 p++;
4225 }
4226
4227 xlat_arg_copy_out(ctx, out, args, vb);
4228
4229 return XLAT_ACTION_DONE;
4230}
4231
4233 { .required = true, .concat = true, .type = FR_TYPE_STRING },
4235};
4236
4237
4238/** Convert a string to lowercase
4239 *
4240 * Example:
4241@verbatim
4242%tolower("Bar") == "bar"
4243@endverbatim
4244 *
4245 * Probably only works for ASCII
4246 *
4247 * @ingroup xlat_functions
4248 */
4250 UNUSED xlat_ctx_t const *xctx,
4251 request_t *request, fr_value_box_list_t *in)
4252{
4253 return xlat_change_case(ctx, out, request, in, false);
4254}
4255
4256
4257/** Convert a string to uppercase
4258 *
4259 * Example:
4260@verbatim
4261%toupper("Foo") == "FOO"
4262@endverbatim
4263 *
4264 * Probably only works for ASCII
4265 *
4266 * @ingroup xlat_functions
4267 */
4269 UNUSED xlat_ctx_t const *xctx,
4270 request_t *request, fr_value_box_list_t *in)
4271{
4272 return xlat_change_case(ctx, out, request, in, true);
4273}
4274
4275
4277 { .required = true, .concat = true, .type = FR_TYPE_STRING },
4279};
4280
4281/** URLencode special characters
4282 *
4283 * Example:
4284@verbatim
4285%urlquote("http://example.org/") == "http%3A%47%47example.org%47"
4286@endverbatim
4287 *
4288 * @ingroup xlat_functions
4289 */
4291 UNUSED xlat_ctx_t const *xctx,
4292 UNUSED request_t *request, fr_value_box_list_t *args)
4293{
4294 char const *p, *end;
4295 char *buff_p;
4296 size_t outlen = 0;
4297 fr_value_box_t *vb;
4298 fr_value_box_t *in_head;
4299
4300 XLAT_ARGS(args, &in_head);
4301
4302 p = in_head->vb_strvalue;
4303 end = p + in_head->vb_length;
4304
4305 /*
4306 * Calculate size of output
4307 */
4308 while (p < end) {
4309 if (isalnum(*p) ||
4310 *p == '-' ||
4311 *p == '_' ||
4312 *p == '.' ||
4313 *p == '~') {
4314 outlen++;
4315 } else {
4316 outlen += 3;
4317 }
4318 p++;
4319 }
4320
4321 MEM(vb = fr_value_box_alloc_null(ctx));
4322 MEM(fr_value_box_bstr_alloc(vb, &buff_p, vb, NULL, outlen, false) == 0);
4323 fr_value_box_safety_copy(vb, in_head);
4324
4325 /* Reset p to start position */
4326 p = in_head->vb_strvalue;
4327
4328 while (p < end) {
4329 if (isalnum(*p)) {
4330 *buff_p++ = *p++;
4331 continue;
4332 }
4333
4334 switch (*p) {
4335 case '-':
4336 case '_':
4337 case '.':
4338 case '~':
4339 *buff_p++ = *p++;
4340 break;
4341
4342 default:
4343 /* MUST be upper case hex to be compliant */
4344 snprintf(buff_p, 4, "%%%02X", (uint8_t) *p++); /* %XX */
4345
4346 buff_p += 3;
4347 }
4348 }
4349
4350 *buff_p = '\0';
4351
4352 // @todo - mark as safe for URL?
4354
4355 return XLAT_ACTION_DONE;
4356}
4357
4358
4360 { .required = true, .concat = true, .type = FR_TYPE_STRING },
4362};
4363
4364/** URLdecode special characters
4365 *
4366 * @note Remember to escape % with %% in strings, else xlat will try to parse it.
4367 *
4368 * Example:
4369@verbatim
4370%urlunquote("http%%3A%%47%%47example.org%%47") == "http://example.org/"
4371@endverbatim
4372 *
4373 * @ingroup xlat_functions
4374 */
4376 UNUSED xlat_ctx_t const *xctx,
4377 request_t *request, fr_value_box_list_t *args)
4378{
4379 char const *p, *end;
4380 char *buff_p;
4381 char const *c1, *c2;
4382 size_t outlen = 0;
4383 fr_value_box_t *vb;
4384 fr_value_box_t *in_head;
4385
4386 XLAT_ARGS(args, &in_head);
4387
4388 p = in_head->vb_strvalue;
4389 end = p + in_head->vb_length;
4390
4391 /*
4392 * Calculate size of output
4393 */
4394 while (p < end) {
4395 if (*p == '%') {
4396 if (!p[1] || !p[2]) {
4397 REMARKER(in_head->vb_strvalue, p - in_head->vb_strvalue, "Invalid %% sequence");
4398 return XLAT_ACTION_FAIL;
4399 }
4400 p += 3;
4401 } else {
4402 p++;
4403 }
4404 outlen++;
4405 }
4406
4407 MEM(vb = fr_value_box_alloc_null(ctx));
4408 MEM(fr_value_box_bstr_alloc(vb, &buff_p, vb, NULL, outlen, false) == 0);
4409 fr_value_box_safety_copy(vb, in_head);
4410
4411 /* Reset p to start position */
4412 p = in_head->vb_strvalue;
4413
4414 while (p < end) {
4415 if (*p != '%') {
4416 *buff_p++ = *p++;
4417 continue;
4418 }
4419 /* Is a % char */
4420
4421 /* Don't need \0 check, as it won't be in the hextab */
4422 if (!(c1 = memchr(hextab, tolower((uint8_t) *++p), 16)) ||
4423 !(c2 = memchr(hextab, tolower((uint8_t) *++p), 16))) {
4424 REMARKER(in_head->vb_strvalue, p - in_head->vb_strvalue, "Non-hex char in %% sequence");
4425 talloc_free(vb);
4426
4427 return XLAT_ACTION_FAIL;
4428 }
4429 p++;
4430 *buff_p++ = ((c1 - hextab) << 4) + (c2 - hextab);
4431 }
4432
4433 *buff_p = '\0';
4435
4436 return XLAT_ACTION_DONE;
4437}
4438
4440 { .required = true, .type = FR_TYPE_VOID },
4441 { .single = true, .type = FR_TYPE_ATTR },
4443};
4444
4445/** Decode any protocol attribute / options
4446 *
4447 * Creates protocol-specific attributes based on the given binary option data
4448 *
4449 * Example:
4450@verbatim
4451%dhcpv4.decode(%{Tmp-Octets-0})
4452@endverbatim
4453 *
4454 * @ingroup xlat_functions
4455 */
4457 xlat_ctx_t const *xctx,
4458 request_t *request, fr_value_box_list_t *in)
4459{
4460 int decoded;
4461 fr_value_box_t *vb, *in_head, *root_da;
4462 void *decode_ctx = NULL;
4463 xlat_pair_decode_uctx_t const *decode_uctx = talloc_get_type_abort(*(void * const *)xctx->inst, xlat_pair_decode_uctx_t);
4464 fr_test_point_pair_decode_t const *tp_decode = decode_uctx->tp_decode;
4465 fr_pair_t *vp = NULL;
4466 bool created = false;
4467
4468 XLAT_ARGS(in, &in_head, &root_da);
4469
4470 fr_assert(in_head->type == FR_TYPE_GROUP);
4471
4472 if (decode_uctx->dict && decode_uctx->dict != request->proto_dict) {
4473 REDEBUG2("Can't call %%%s() when in %s namespace", xctx->ex->call.func->name,
4474 fr_dict_root(request->proto_dict)->name);
4475 return XLAT_ACTION_FAIL;
4476 }
4477
4478 if (root_da) {
4479 int ret;
4480 if (!fr_type_is_structural(root_da->vb_attr->type)) {
4481 REDEBUG2("Decoding context must be a structural attribute reference");
4482 return XLAT_ACTION_FAIL;
4483 }
4484 ret = fr_pair_update_by_da_parent(fr_pair_list_parent(&request->request_pairs), &vp, root_da->vb_attr);
4485 if (ret < 0) {
4486 REDEBUG2("Failed creating decoding root pair");
4487 return XLAT_ACTION_FAIL;
4488 }
4489 if (ret == 0) created = true;
4490 }
4491
4492 if (tp_decode->test_ctx) {
4493 if (tp_decode->test_ctx(&decode_ctx, ctx, request->proto_dict, root_da ? root_da->vb_attr : NULL) < 0) {
4494 goto fail;
4495 }
4496 }
4497
4498 decoded = xlat_decode_value_box_list(root_da ? vp : request->request_ctx,
4499 root_da ? &vp->vp_group : &request->request_pairs,
4500 request, decode_ctx, tp_decode->func, &in_head->vb_group);
4501 if (decoded <= 0) {
4502 talloc_free(decode_ctx);
4503 RPERROR("Protocol decoding failed");
4504 fail:
4505 if (created) fr_pair_delete(&request->request_pairs, vp);
4506 return XLAT_ACTION_FAIL;
4507 }
4508
4509 /*
4510 * Create a value box to hold the decoded count, and add
4511 * it to the output list.
4512 */
4513 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_UINT32, NULL));
4514 vb->vb_uint32 = decoded;
4516
4517 talloc_free(decode_ctx);
4518 return XLAT_ACTION_DONE;
4519}
4520
4522 { .required = true, .single = true, .type = FR_TYPE_IPV4_PREFIX },
4524};
4525
4526/** Calculate the subnet mask from a IPv4 prefix
4527 *
4528 * Example:
4529@verbatim
4530%ip.v4.netmask(%{Network-Prefix})
4531@endverbatim
4532 *
4533 * @ingroup xlat_functions
4534 */
4536 UNUSED request_t *request, fr_value_box_list_t *args)
4537{
4538 fr_value_box_t *subnet, *vb;
4539 XLAT_ARGS(args, &subnet);
4540
4541 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_IPV4_ADDR, NULL));
4542
4543 switch (subnet->vb_ip.prefix) {
4544 case 0:
4545 vb->vb_ipv4addr = 0;
4546 break;
4547
4548 case 32:
4549 vb->vb_ipv4addr = 0xffffffff;
4550 break;
4551
4552 default:
4553 vb->vb_ipv4addr = htonl((uint32_t)0xffffffff << (32 - subnet->vb_ip.prefix));
4554 break;
4555 }
4556
4558
4559 return XLAT_ACTION_DONE;
4560}
4561
4562/** Calculate the broadcast address from a IPv4 prefix
4563 *
4564 * Example:
4565@verbatim
4566%ip.v4.broadcast(%{Network-Prefix})
4567@endverbatim
4568 *
4569 * @ingroup xlat_functions
4570 */
4572 UNUSED request_t *request, fr_value_box_list_t *args)
4573{
4574 fr_value_box_t *subnet, *vb;
4575 XLAT_ARGS(args, &subnet);
4576
4577 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_IPV4_ADDR, NULL));
4578 vb->vb_ipv4addr = htonl( ntohl(subnet->vb_ipv4addr) | ((uint32_t)0xffffffff >> subnet->vb_ip.prefix));
4580
4581 return XLAT_ACTION_DONE;
4582}
4583
4585{
4586 *(void **) mctx->inst = mctx->uctx;
4587 return 0;
4588}
4589
4595
4596/** Encode protocol attributes / options
4597 *
4598 * Returns octet string created from the provided pairs
4599 *
4600 * Example:
4601@verbatim
4602%dhcpv4.encode(&request[*])
4603@endverbatim
4604 *
4605 * @ingroup xlat_functions
4606 */
4608 xlat_ctx_t const *xctx,
4609 request_t *request, fr_value_box_list_t *args)
4610{
4611 fr_pair_t *vp;
4612 fr_dcursor_t *cursor;
4613 bool tainted = false, encode_children = false;
4614 fr_value_box_t *encoded;
4615
4616 fr_dbuff_t *dbuff;
4617 ssize_t len = 0;
4618 fr_value_box_t *in_head, *root_da;
4619 void *encode_ctx = NULL;
4620 fr_test_point_pair_encode_t const *tp_encode;
4621
4622 FR_DBUFF_TALLOC_THREAD_LOCAL(&dbuff, 2048, SIZE_MAX);
4623
4624 XLAT_ARGS(args, &in_head, &root_da);
4625
4626 memcpy(&tp_encode, xctx->inst, sizeof(tp_encode)); /* const issues */
4627
4628 cursor = fr_value_box_get_cursor(in_head);
4629
4630 /*
4631 * Create the encoding context.
4632 */
4633 if (tp_encode->test_ctx) {
4634 if (tp_encode->test_ctx(&encode_ctx, cursor, request->proto_dict, root_da ? root_da->vb_attr : NULL) < 0) {
4635 return XLAT_ACTION_FAIL;
4636 }
4637 }
4638
4639 if (root_da) {
4640 if (!fr_type_is_structural(root_da->vb_attr->type)) {
4641 REDEBUG2("Encoding context must be a structural attribute reference");
4642 return XLAT_ACTION_FAIL;
4643 }
4644 vp = fr_dcursor_current(cursor);
4645 if (!fr_dict_attr_common_parent(root_da->vb_attr, vp->da, true) && (root_da->vb_attr != vp->da)) {
4646 REDEBUG2("%s is not a child of %s", vp->da->name, root_da->vb_attr->name);
4647 return XLAT_ACTION_FAIL;
4648 }
4649 if (root_da->vb_attr == vp->da) encode_children = true;
4650 }
4651
4652 /*
4653 * Loop over the attributes, encoding them.
4654 */
4655 RDEBUG2("Encoding attributes");
4656
4657 if (RDEBUG_ENABLED2) {
4658 RINDENT();
4659 for (vp = fr_dcursor_current(cursor);
4660 vp != NULL;
4661 vp = fr_dcursor_next(cursor)) {
4662 RDEBUG2("%pP", vp);
4663 }
4664 REXDENT();
4665 }
4666
4667 /*
4668 * Encoders advance the cursor, so we just need to feed
4669 * in the next pair. This was originally so we could
4670 * extend the output buffer, but with dbuffs that's
4671 * no longer necessary... we might want to refactor this
4672 * in future.
4673 */
4674 for (vp = fr_dcursor_head(cursor);
4675 vp != NULL;
4676 vp = fr_dcursor_current(cursor)) {
4677 /*
4678 *
4679 * Don't check for internal attributes, the
4680 * encoders can skip them if they need to, and the
4681 * internal encoder can encode anything, as can
4682 * things like CBOR.
4683 *
4684 * Don't check the dictionaries. By definition,
4685 * vp->da->dict==request->proto_dict, OR else we're
4686 * using the internal encoder and encoding a real
4687 * protocol.
4688 *
4689 * However, we likely still want a
4690 * dictionary-specific "is encodable" function,
4691 * as AKA/SIM and DHCPv6 encode "bool"s only if
4692 * their value is true.
4693 */
4694 if (encode_children) {
4695 fr_dcursor_t child_cursor;
4696
4698
4699 /*
4700 * If we're given an encoding context which is the
4701 * same as the DA returned by the cursor, that means
4702 * encode the children.
4703 */
4704 fr_pair_dcursor_init(&child_cursor, &vp->vp_group);
4705 while (fr_dcursor_current(&child_cursor)) {
4706 len = tp_encode->func(dbuff, &child_cursor, encode_ctx);
4707 if (len < 0) break;
4708 }
4709 fr_dcursor_next(cursor);
4710 } else {
4711 len = tp_encode->func(dbuff, cursor, encode_ctx);
4712 }
4713 if (len < 0) {
4714 RPEDEBUG("Protocol encoding failed");
4715 return XLAT_ACTION_FAIL;
4716 }
4717
4718 tainted |= vp->vp_tainted;
4719 }
4720
4721 /*
4722 * Pass the options string back to the caller.
4723 */
4724 MEM(encoded = fr_value_box_alloc_null(ctx));
4725 fr_value_box_memdup(encoded, encoded, NULL, fr_dbuff_start(dbuff), fr_dbuff_used(dbuff), tainted);
4726 fr_dcursor_append(out, encoded);
4727
4728 return XLAT_ACTION_DONE;
4729}
4730
4731static int xlat_protocol_register_by_name(dl_t *dl, char const *name, fr_dict_t const *dict)
4732{
4733 fr_test_point_pair_decode_t *tp_decode;
4734 fr_test_point_pair_encode_t *tp_encode;
4735 xlat_pair_decode_uctx_t *decode_uctx;
4736 xlat_t *xlat;
4737 char buffer[256+32];
4738
4739 /*
4740 * See if there's a decode function for it.
4741 */
4742 snprintf(buffer, sizeof(buffer), "%s_tp_decode_pair", name);
4743 tp_decode = dlsym(dl->handle, buffer);
4744 if (tp_decode) {
4745 snprintf(buffer, sizeof(buffer), "%s.decode", name);
4746
4747 /* May be called multiple times, so just skip protocols we've already registered */
4748 if (xlat_func_find(buffer, -1)) return 1;
4749
4750 if (unlikely((xlat = xlat_func_register(NULL, buffer, xlat_pair_decode, FR_TYPE_UINT32)) == NULL)) return -1;
4752 decode_uctx = talloc(xlat, xlat_pair_decode_uctx_t);
4753 decode_uctx->tp_decode = tp_decode;
4754 decode_uctx->dict = dict;
4755 /* coverity[suspicious_sizeof] */
4758 }
4759
4760 /*
4761 * See if there's an encode function for it.
4762 */
4763 snprintf(buffer, sizeof(buffer), "%s_tp_encode_pair", name);
4764 tp_encode = dlsym(dl->handle, buffer);
4765 if (tp_encode) {
4766 snprintf(buffer, sizeof(buffer), "%s.encode", name);
4767
4768 if (xlat_func_find(buffer, -1)) return 1;
4769
4770 if (unlikely((xlat = xlat_func_register(NULL, buffer, xlat_pair_encode, FR_TYPE_OCTETS)) == NULL)) return -1;
4772 /* coverity[suspicious_sizeof] */
4775 }
4776
4777 return 0;
4778}
4779
4780static int xlat_protocol_register(fr_dict_t const *dict)
4781{
4782 dl_t *dl = fr_dict_dl(dict);
4783 char *p, name[256];
4784
4785 /*
4786 * No library for this protocol, skip it.
4787 *
4788 * Protocol TEST has no libfreeradius-test, so that's OK.
4789 */
4790 if (!dl) return 0;
4791
4792 strlcpy(name, fr_dict_root(dict)->name, sizeof(name));
4793 for (p = name; *p != '\0'; p++) {
4794 *p = tolower((uint8_t) *p);
4795 }
4796
4798}
4799
4801
4803{
4804 dl_t *dl;
4805
4806 cbor_loader = dl_loader_init(NULL, NULL, false, false);
4807 if (!cbor_loader) return 0;
4808
4809 dl = dl_by_name(cbor_loader, "libfreeradius-cbor", NULL, false);
4810 if (!dl) return 0;
4811
4812 if (xlat_protocol_register_by_name(dl, "cbor", NULL) < 0) return -1;
4813
4814 return 0;
4815}
4816
4817
4818/** Register xlats for any loaded dictionaries
4819 */
4821{
4822 fr_dict_t *dict;
4824
4825 for (dict = fr_dict_global_ctx_iter_init(&iter);
4826 dict != NULL;
4828 if (xlat_protocol_register(dict) < 0) return -1;
4829 }
4830
4831 /*
4832 * And the internal protocol, too.
4833 */
4834 if (xlat_protocol_register(fr_dict_internal()) < 0) return -1;
4835
4836 /*
4837 * And cbor stuff
4838 */
4839 if (xlat_protocol_register_cbor() < 0) return -1;
4840
4841 return 0;
4842}
4843
4844/** De-register all xlat functions we created
4845 *
4846 */
4847static int _xlat_global_free(UNUSED void *uctx)
4848{
4849 TALLOC_FREE(xlat_ctx);
4853
4854 return 0;
4855}
4856
4857/** Global initialisation for xlat
4858 *
4859 * @note Free memory with #xlat_free
4860 *
4861 * @return
4862 * - 0 on success.
4863 * - -1 on failure.
4864 *
4865 * @hidecallgraph
4866 */
4867static int _xlat_global_init(UNUSED void *uctx)
4868{
4869 xlat_t *xlat;
4870
4871 xlat_ctx = talloc_init("xlat");
4872 if (!xlat_ctx) return -1;
4873
4874 if (xlat_func_init() < 0) return -1;
4875
4876 /*
4877 * Lookup attributes used by virtual xlat expansions.
4878 */
4879 if (xlat_eval_init() < 0) return -1;
4880
4881 /*
4882 * Registers async xlat operations in the `unlang` interpreter.
4883 */
4885
4886 /*
4887 * These are all "pure" functions.
4888 */
4889#define XLAT_REGISTER_ARGS(_xlat, _func, _return_type, _args) \
4890do { \
4891 if (unlikely((xlat = xlat_func_register(xlat_ctx, _xlat, _func, _return_type)) == NULL)) return -1; \
4892 xlat_func_args_set(xlat, _args); \
4893 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
4894} while (0)
4895
4896#define XLAT_NEW(_x) xlat->replaced_with = _x
4897
4899
4902 XLAT_NEW("str.concat");
4903
4906 XLAT_NEW("str.split");
4907
4909
4912 XLAT_NEW("hmac.md5");
4913
4916 XLAT_NEW("hmac.sha1");
4917
4919 xlat->deprecated = true;
4920
4923 xlat->deprecated = true;
4924
4926
4929 XLAT_NEW("str.lpad");
4930
4933 XLAT_NEW("str.rpad");
4934
4937 XLAT_NEW("str.substr");
4938
4941
4942 /*
4943 * The inputs to these functions are variable.
4944 */
4945#undef XLAT_REGISTER_ARGS
4946#define XLAT_REGISTER_ARGS(_xlat, _func, _return_type, _args) \
4947do { \
4948 if (unlikely((xlat = xlat_func_register(xlat_ctx, _xlat, _func, _return_type)) == NULL)) return -1; \
4949 xlat_func_args_set(xlat, _args); \
4950 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_INTERNAL); \
4951} while (0)
4952
4953#undef XLAT_REGISTER_VOID
4954#define XLAT_REGISTER_VOID(_xlat, _func, _return_type) \
4955do { \
4956 if (unlikely((xlat = xlat_func_register(xlat_ctx, _xlat, _func, _return_type)) == NULL)) return -1; \
4957 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_INTERNAL); \
4958} while (0)
4959
4963 XLAT_NEW("pairs.debug");
4964
4974
4976 XLAT_NEW("pairs.immutable");
4978
4984
4986 XLAT_NEW("time.next");
4988
4990 XLAT_NEW("pairs.print");
4992
4994
4996#ifdef HAVE_REGEX_PCRE2
4997 xlat_func_instantiate_set(xlat, xlat_instantiate_subst_regex, xlat_subst_regex_inst_t, NULL, NULL);
4998#endif
5000 XLAT_NEW("str.subst");
5001#ifdef HAVE_REGEX_PCRE2
5002 xlat_func_instantiate_set(xlat, xlat_instantiate_subst_regex, xlat_subst_regex_inst_t, NULL, NULL);
5003#endif
5004
5005#ifndef NDEBUG
5007#endif
5008
5014
5020
5023 XLAT_NEW("str.rand");
5024
5027
5029
5030 if (unlikely((xlat = xlat_func_register(xlat_ctx, "untaint", xlat_func_untaint, FR_TYPE_VOID)) == NULL)) return -1;
5033
5034 if (unlikely((xlat = xlat_func_register(xlat_ctx, "taint", xlat_func_taint, FR_TYPE_VOID)) == NULL)) return -1;
5037
5038 /*
5039 * All of these functions are pure.
5040 */
5041#define XLAT_REGISTER_PURE(_xlat, _func, _return_type, _arg) \
5042do { \
5043 if (unlikely((xlat = xlat_func_register(xlat_ctx, _xlat, _func, _return_type)) == NULL)) return -1; \
5044 xlat_func_args_set(xlat, _arg); \
5045 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
5046} while (0)
5047
5052 XLAT_NEW("hash.md4");
5053
5056 XLAT_NEW("hash.md4");
5057
5058 if (unlikely((xlat = xlat_func_register(xlat_ctx, "regex.match", xlat_func_regex, FR_TYPE_STRING)) == NULL)) return -1;
5061 if (unlikely((xlat = xlat_func_register(xlat_ctx, "regex", xlat_func_regex, FR_TYPE_STRING)) == NULL)) return -1;
5064 XLAT_NEW("regex.match");
5065
5066 {
5067 static xlat_arg_parser_t const xlat_regex_safe_args[] = {
5068 { .type = FR_TYPE_STRING, .variadic = true, .concat = true },
5070 };
5071
5072 static xlat_arg_parser_t const xlat_regex_escape_args[] = {
5073 { .type = FR_TYPE_STRING,
5074 .func = regex_xlat_escape, .safe_for = FR_REGEX_SAFE_FOR, .always_escape = true,
5075 .variadic = true, .concat = true },
5077 };
5078
5079 if (unlikely((xlat = xlat_func_register(xlat_ctx, "regex.safe",
5080 xlat_transparent, FR_TYPE_STRING)) == NULL)) return -1;
5082 xlat_func_args_set(xlat, xlat_regex_safe_args);
5083 xlat_func_safe_for_set(xlat, FR_REGEX_SAFE_FOR);
5084
5085 if (unlikely((xlat = xlat_func_register(xlat_ctx, "regex.escape",
5086 xlat_transparent, FR_TYPE_STRING)) == NULL)) return -1;
5088 xlat_func_args_set(xlat, xlat_regex_escape_args);
5089 xlat_func_safe_for_set(xlat, FR_REGEX_SAFE_FOR);
5090 }
5091
5092#define XLAT_REGISTER_HASH(_name, _func) do { \
5093 XLAT_REGISTER_PURE("hash." _name, _func, FR_TYPE_OCTETS, xlat_func_sha_arg); \
5094 XLAT_REGISTER_PURE(_name, _func, FR_TYPE_OCTETS, xlat_func_sha_arg); \
5095 XLAT_NEW("hash." _name); \
5096 } while (0)
5097
5099
5100#ifdef HAVE_OPENSSL_EVP_H
5101 XLAT_REGISTER_HASH("sha2_224", xlat_func_sha2_224);
5102 XLAT_REGISTER_HASH("sha2_256", xlat_func_sha2_256);
5103 XLAT_REGISTER_HASH("sha2_384", xlat_func_sha2_384);
5104 XLAT_REGISTER_HASH("sha2_512", xlat_func_sha2_512);
5105 XLAT_REGISTER_HASH("sha2", xlat_func_sha2_256);
5106
5107# ifdef HAVE_EVP_BLAKE2S256
5108 XLAT_REGISTER_HASH("blake2s_256", xlat_func_blake2s_256);
5109# endif
5110# ifdef HAVE_EVP_BLAKE2B512
5111 XLAT_REGISTER_HASH("blake2b_512", xlat_func_blake2b_512);
5112# endif
5113
5114 XLAT_REGISTER_HASH("sha3_224", xlat_func_sha3_224);
5115 XLAT_REGISTER_HASH("sha3_256", xlat_func_sha3_256);
5116 XLAT_REGISTER_HASH("sha3_384", xlat_func_sha3_384);
5117 XLAT_REGISTER_HASH("sha3_512", xlat_func_sha3_512);
5118 XLAT_REGISTER_HASH("sha3", xlat_func_sha3_256);
5119#endif
5120
5122 xlat->deprecated = true;
5124 XLAT_NEW("length");
5125
5128
5131 XLAT_NEW("str.lower");
5132
5135 XLAT_NEW("str.upper");
5136
5139 XLAT_NEW("url.quote");
5140
5143 XLAT_NEW("url.unquote");
5144
5146
5148}
5149
5151{
5152 int ret;
5153 fr_atexit_global_once_ret(&ret, _xlat_global_init, _xlat_global_free, NULL);
5154 return ret;
5155}
static int const char char buffer[256]
Definition acutest.h:576
int const char * file
Definition acutest.h:702
va_list args
Definition acutest.h:770
static int const char * fmt
Definition acutest.h:573
#define fr_base16_encode(_out, _in)
Definition base16.h:54
#define fr_base16_decode(_err, _out, _in, _no_trailing)
Definition base16.h:92
#define fr_base64_encode(_out, _in, _add_padding)
Definition base64.h:71
#define fr_base64_decode(_out, _in, _expect_padding, _no_trailing)
Definition base64.h:78
#define FR_BASE64_DEC_LENGTH(_inlen)
Definition base64.h:41
#define FR_BASE64_ENC_LENGTH(_inlen)
Encode/decode binary data using printable characters (base64 format)
Definition base64.h:40
static bool stop
Definition radmin.c:68
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
Definition build.h:186
#define RCSID(id)
Definition build.h:512
#define L(_str)
Helper for initialising arrays of string literals.
Definition build.h:228
#define unlikely(_x)
Definition build.h:407
#define UNUSED
Definition build.h:336
#define NUM_ELEMENTS(_t)
Definition build.h:358
A section grouping multiple CONF_PAIR.
Definition cf_priv.h:106
fr_dict_t * dict
Definition common.c:31
fr_dict_attr_t const * root_da
Definition common.c:32
#define fr_dbuff_used(_dbuff_or_marker)
Return the number of bytes remaining between the start of the dbuff or marker and the current positio...
Definition dbuff.h:775
#define fr_dbuff_start(_dbuff_or_marker)
Return the 'start' position of a dbuff or marker.
Definition dbuff.h:906
#define FR_DBUFF_TALLOC_THREAD_LOCAL(_out, _init, _max)
Create a function local and thread local extensible dbuff.
Definition dbuff.h:564
#define FR_DBUFF_TMP(_start, _len_or_end)
Creates a compound literal to pass into functions which accept a dbuff.
Definition dbuff.h:522
static void * fr_dcursor_next(fr_dcursor_t *cursor)
Advanced the cursor to the next item.
Definition dcursor.h:288
static int fr_dcursor_append(fr_dcursor_t *cursor, void *v)
Insert a single item at the end of the list.
Definition dcursor.h:406
static void * fr_dcursor_current(fr_dcursor_t *cursor)
Return the item the cursor current points to.
Definition dcursor.h:337
static void * fr_dcursor_head(fr_dcursor_t *cursor)
Rewind cursor to the start of the list.
Definition dcursor.h:232
#define MEM(x)
Definition debug.h:36
fr_dict_t * fr_dict_global_ctx_iter_next(fr_dict_global_ctx_iter_t *iter)
Definition dict_util.c:4869
char const * name
Vendor name.
Definition dict.h:274
fr_dict_attr_t const * fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor)
Find a common ancestor that two TLV type attributes share.
Definition dict_util.c:2287
static fr_slen_t err
Definition dict.h:882
bool fr_dict_compatible(fr_dict_t const *dict1, fr_dict_t const *dict2)
See if two dictionaries have the same end parent.
Definition dict_util.c:2861
fr_dict_t * fr_dict_global_ctx_iter_init(fr_dict_global_ctx_iter_t *iter)
Iterate protocols by name.
Definition dict_util.c:4862
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2639
dl_t * fr_dict_dl(fr_dict_t const *dict)
Definition dict_util.c:2649
uint32_t pen
Private enterprise number.
Definition dict.h:270
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4905
static fr_slen_t in
Definition dict.h:882
fr_dict_vendor_t const * fr_dict_vendor_by_da(fr_dict_attr_t const *da)
Look up a vendor by one of its child attributes.
Definition dict_util.c:2877
Private enterprise.
Definition dict.h:269
Test enumeration values.
Definition dict_test.h:92
dl_loader_t * dl_loader_init(TALLOC_CTX *ctx, void *uctx, bool uctx_free, bool defer_symbol_init)
Initialise structures needed by the dynamic linker.
Definition dl.c:900
dl_t * dl_by_name(dl_loader_t *dl_loader, char const *name, void *uctx, bool uctx_free)
Search for a dl's shared object in various locations.
Definition dl.c:470
A dynamic loader.
Definition dl.c:81
void * handle
Handle returned by dlopen.
Definition dl.h:61
Module handle.
Definition dl.h:57
static void * fr_dlist_head(fr_dlist_head_t const *list_head)
Return the HEAD item of a list or NULL if the list is empty.
Definition dlist.h:468
static unsigned int fr_dlist_num_elements(fr_dlist_head_t const *head)
Return the number of elements in the dlist.
Definition dlist.h:921
static void * fr_dlist_next(fr_dlist_head_t const *list_head, void const *ptr)
Get the next item in a list.
Definition dlist.h:537
void fr_bio_shutdown & my
Definition fd_errno.h:73
static xlat_action_t xlat_func_time_now(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
Return the current time as a FR_TYPE_DATE.
static xlat_action_t xlat_func_next_time(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Calculate number of seconds until the next n hour(s), day(s), week(s), year(s).
static xlat_action_t xlat_func_lpad(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
lpad a string
static xlat_action_t xlat_func_bin(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Convert hex string to binary.
static xlat_action_t xlat_func_pairs_debug(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Print out attribute info.
static xlat_action_t xlat_func_subst(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Perform regex substitution.
static xlat_action_t xlat_func_urlunquote(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
URLdecode special characters.
static xlat_action_t xlat_pair_decode(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Decode any protocol attribute / options.
static xlat_action_t xlat_func_base64_decode(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Decode base64 string.
static xlat_action_t xlat_func_hmac_md5(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Generate the HMAC-MD5 of a string or attribute.
static xlat_action_t xlat_func_base64_encode(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Encode string or attribute as base64.
static xlat_action_t xlat_func_log_info(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Log something at INFO level.
static xlat_action_t xlat_func_log_warn(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Log something at WARN level.
static xlat_action_t xlat_func_map(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Processes fmt as a map string and applies it to the current request.
static xlat_action_t xlat_func_debug(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Dynamically change the debugging level for the current request.
static xlat_action_t xlat_func_log_debug(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Log something at DEBUG level.
static xlat_action_t xlat_func_log_dst(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Change the log destination to the named one.
static xlat_arg_parser_t const xlat_func_string_arg[]
Calculate any digest supported by OpenSSL EVP_MD.
static xlat_action_t xlat_func_module_call(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Calls a named virtual module.
static xlat_action_t xlat_func_block(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Block for the specified duration.
static xlat_action_t xlat_func_concat(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Concatenate string representation of values of given attributes using separator.
static xlat_action_t xlat_func_urlquote(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
URLencode special characters.
static xlat_action_t xlat_func_rpad(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Right pad a string.
static xlat_action_t xlat_func_md4(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Calculate the MD4 hash of a string or attribute.
static xlat_action_t xlat_func_explode(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Split a string into multiple new strings based on a delimiter.
static xlat_action_t xlat_func_pairs_print(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Encode attributes as a series of string attribute/value pairs.
static xlat_action_t xlat_func_time_request(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *args)
Return the request receive time as a FR_TYPE_DATE.
static xlat_action_t xlat_func_regex(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Get named subcapture value from previous regex.
static xlat_action_t xlat_func_substr(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Extract a substring from string / octets data.
static xlat_action_t xlat_func_length(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Return the on-the-wire size of the boxes in bytes.
static xlat_action_t xlat_func_immutable_attr(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Mark one or more attributes as immutable.
static xlat_action_t xlat_func_rand(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Generate a random integer value.
static xlat_action_t xlat_pair_encode(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Encode protocol attributes / options.
static xlat_action_t xlat_func_log_err(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Log something at DEBUG level.
static xlat_action_t xlat_func_hmac_sha1(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Generate the HMAC-SHA1 of a string or attribute.
static xlat_action_t xlat_func_eval(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Dynamically evaluate an expansion string.
static xlat_action_t xlat_func_time_is_dst(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
Return whether we are in daylight savings or not.
static xlat_action_t xlat_func_integer(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Print data as integer, not as VALUE.
static xlat_action_t xlat_func_time(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Return the time as a FR_TYPE_DATE.
static xlat_action_t xlat_func_toupper(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Convert a string to uppercase.
static xlat_action_t xlat_func_uuid_v7(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
Generate a version 7 UUID.
static xlat_action_t xlat_func_uuid_v4(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
Generate a version 4 UUID.
static xlat_action_t xlat_func_cast(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Cast one or more output value-boxes to the given type.
static xlat_action_t xlat_func_hex(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Print data as hex, not as VALUE.
static xlat_action_t xlat_func_md5(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Calculate the MD5 hash of a string or attribute.
static xlat_action_t xlat_func_subnet_netmask(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Calculate the subnet mask from a IPv4 prefix.
static xlat_action_t xlat_func_sha1(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Calculate the SHA1 hash of a string or attribute.
static xlat_action_t xlat_func_str_printable(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Return whether a string has only printable chars.
static xlat_action_t xlat_func_range(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Generate a range of uint64 numbers.
static xlat_action_t xlat_func_randstr(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Generate a string of random chars.
static xlat_action_t xlat_func_tolower(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Convert a string to lowercase.
static xlat_action_t xlat_func_subnet_broadcast(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Calculate the broadcast address from a IPv4 prefix.
static xlat_action_t xlat_func_str_utf8(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Return whether a string is valid UTF-8.
static xlat_action_t xlat_func_time_offset(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *args)
Return the current time offset from gmt.
static xlat_action_t xlat_func_strlen(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Print length of given string.
Stores the state of the current iteration operation.
Definition hash.h:41
talloc_free(hp)
int fr_hmac_md5(uint8_t digest[MD5_DIGEST_LENGTH], uint8_t const *in, size_t inlen, uint8_t const *key, size_t key_len)
Calculate HMAC using internal MD5 implementation.
Definition hmac_md5.c:119
int fr_hmac_sha1(uint8_t digest[static SHA1_DIGEST_LENGTH], uint8_t const *in, size_t inlen, uint8_t const *key, size_t key_len)
Calculate HMAC using internal SHA1 implementation.
Definition hmac_sha1.c:123
TALLOC_CTX * unlang_interpret_frame_talloc_ctx(request_t *request)
Get a talloc_ctx which is valid only for this frame.
Definition interpret.c:2042
int unlang_interpret_push_section(unlang_result_t *p_result, request_t *request, CONF_SECTION *cs, unlang_frame_conf_t const *conf)
Push a configuration section onto the request stack for later interpretation.
Definition interpret.c:1524
fr_event_list_t * unlang_interpret_event_list(request_t *request)
Get the event list for the current interpreter.
Definition interpret.c:2418
#define FRAME_CONF(_default_rcode, _top_frame)
Definition interpret.h:157
#define UNLANG_SUB_FRAME
Definition interpret.h:37
fr_log_t * log_dst_by_name(char const *name)
Get a logging destination by name.
Definition log.c:1082
#define PERROR(_fmt,...)
Definition log.h:228
#define REXDENT()
Exdent (unindent) R* messages by one level.
Definition log.h:455
#define RWDEBUG(fmt,...)
Definition log.h:373
#define RDEBUG_ENABLED3
True if request debug level 1-3 messages are enabled.
Definition log.h:347
#define REDEBUG3(fmt,...)
Definition log.h:385
#define RERROR(fmt,...)
Definition log.h:310
#define RPERROR(fmt,...)
Definition log.h:314
#define REMARKER(_str, _marker_idx, _marker,...)
Output string with error marker, showing where format error occurred.
Definition log.h:510
#define RINFO(fmt,...)
Definition log.h:308
#define RMARKER(_type, _lvl, _str, _marker_idx, _marker,...)
Output string with error marker, showing where format error occurred.
Definition log.h:481
#define RPEDEBUG(fmt,...)
Definition log.h:388
#define RDEBUG4(fmt,...)
Definition log.h:356
#define RDEBUG_ENABLED4
True if request debug level 1-4 messages are enabled.
Definition log.h:348
#define RIDEBUG2(fmt,...)
Definition log.h:364
#define REDEBUG2(fmt,...)
Definition log.h:384
#define RIDEBUG3(fmt,...)
Definition log.h:365
#define RINDENT()
Indent R* messages by one level.
Definition log.h:442
int map_to_vp(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, map_t const *map, UNUSED void *uctx)
Convert a map to a fr_pair_t.
Definition map.c:1604
int map_to_request(request_t *request, map_t const *map, radius_map_getvalue_t func, void *ctx)
Convert map_t to fr_pair_t (s) and add them to a request_t.
Definition map.c:1884
int map_afrom_attr_str(TALLOC_CTX *ctx, map_t **out, char const *vp_str, tmpl_rules_t const *lhs_rules, tmpl_rules_t const *rhs_rules)
Convert a value pair string to valuepair map.
Definition map.c:1433
#define fr_time()
Definition event.c:60
ssize_t fr_mkdir(int *fd_out, char const *path, ssize_t len, mode_t mode, fr_mkdir_func_t func, void *uctx)
Create directories that are missing in the specified path.
Definition file.c:218
const fr_sbuff_escape_rules_t fr_filename_escape
Definition file.c:916
const fr_sbuff_escape_rules_t fr_filename_escape_dots
Definition file.c:932
@ L_DST_NULL
Discard log messages.
Definition log.h:80
@ L_DST_FILES
Log to a file on disk.
Definition log.h:76
@ L_DBG_LVL_DISABLE
Don't print messages.
Definition log.h:65
@ L_DBG_LVL_2
2nd highest priority debug messages (-xx | -X).
Definition log.h:68
@ L_DBG_LVL_MAX
Lowest priority debug messages (-xxxxx | -Xxxx).
Definition log.h:71
@ L_WARN
Warning.
Definition log.h:54
main_config_t const * main_config
Main server configuration.
Definition main_config.c:56
char const ** limit_files
where file....() is limited to
void fr_md4_calc(uint8_t out[static MD4_DIGEST_LENGTH], uint8_t const *in, size_t inlen)
Calculate the MD4 hash of the contents of a buffer.
Definition md4.c:473
#define MD4_DIGEST_LENGTH
Definition md4.h:22
#define MD5_DIGEST_LENGTH
unsigned short uint16_t
fr_type_t
@ FR_TYPE_TIME_DELTA
A period of time measured in nanoseconds.
@ FR_TYPE_FLOAT32
Single precision floating point.
@ FR_TYPE_IPV4_ADDR
32 Bit IPv4 Address.
@ FR_TYPE_INT8
8 Bit signed integer.
@ FR_TYPE_ETHERNET
48 Bit Mac-Address.
@ FR_TYPE_IPV6_PREFIX
IPv6 Prefix.
@ FR_TYPE_STRING
String of printable characters.
@ FR_TYPE_NULL
Invalid (uninitialised) attribute type.
@ FR_TYPE_UINT16
16 Bit unsigned integer.
@ FR_TYPE_INT64
64 Bit signed integer.
@ FR_TYPE_INT16
16 Bit signed integer.
@ FR_TYPE_DATE
Unix time stamp, always has value >2^31.
@ FR_TYPE_COMBO_IP_PREFIX
IPv4 or IPv6 address prefix depending on length.
@ FR_TYPE_UINT8
8 Bit unsigned integer.
@ FR_TYPE_UINT32
32 Bit unsigned integer.
@ FR_TYPE_INT32
32 Bit signed integer.
@ FR_TYPE_UINT64
64 Bit unsigned integer.
@ FR_TYPE_IPV6_ADDR
128 Bit IPv6 Address.
@ FR_TYPE_IPV4_PREFIX
IPv4 Prefix.
@ FR_TYPE_VOID
User data.
@ FR_TYPE_BOOL
A truth value.
@ FR_TYPE_SIZE
Unsigned integer capable of representing any memory address on the local system.
@ FR_TYPE_COMBO_IP_ADDR
IPv4 or IPv6 address depending on length.
@ FR_TYPE_IFID
Interface ID.
@ FR_TYPE_OCTETS
Raw octets.
@ FR_TYPE_GROUP
A grouping of other attributes.
@ FR_TYPE_FLOAT64
Double precision floating point.
unsigned int uint32_t
long int ssize_t
void fr_md5_calc(uint8_t out[static MD5_DIGEST_LENGTH], uint8_t const *in, size_t inlen)
Perform a single digest operation on a single input buffer.
unsigned char uint8_t
ssize_t fr_slen_t
long long int off_t
unsigned long int size_t
fr_sbuff_parse_error_t
size_t fr_snprint_uint128(char *out, size_t outlen, uint128_t const num)
Write 128bit unsigned integer to buffer.
Definition misc.c:401
struct tm * gmtime_r(time_t const *l_clock, struct tm *result)
Definition missing.c:205
struct tm * localtime_r(time_t const *l_clock, struct tm *result)
Definition missing.c:162
CONF_SECTION * module_rlm_virtual_by_name(char const *asked_name)
Definition module_rlm.c:799
fr_pair_t * fr_pair_list_parent(fr_pair_list_t const *list)
Return a pointer to the parent pair which contains this list.
Definition pair.c:970
int fr_pair_update_by_da_parent(fr_pair_t *parent, fr_pair_t **out, fr_dict_attr_t const *da)
Return the first fr_pair_t matching the fr_dict_attr_t or alloc a new fr_pair_t and its subtree (and ...
Definition pair.c:1602
int fr_pair_delete(fr_pair_list_t *list, fr_pair_t *vp)
Remove fr_pair_t from a list and free.
Definition pair.c:1833
fr_slen_t fr_utf8_str(uint8_t const *str, ssize_t inlen)
Validate a complete UTF8 string.
Definition print.c:153
size_t fr_utf8_char(uint8_t const *str, ssize_t inlen)
Checks for utf-8, taken from http://www.w3.org/International/questions/qa-forms-utf-8.
Definition print.c:39
static fr_internal_encode_ctx_t encode_ctx
#define fr_assert(_expr)
Definition rad_assert.h:37
#define REDEBUG(fmt,...)
#define RDEBUG_ENABLED2()
#define RDEBUG2(fmt,...)
#define RDEBUG(fmt,...)
static bool done
Definition radclient.c:80
#define fill(_expr)
uint32_t fr_rand(void)
Return a 32-bit random number.
Definition rand.c:104
@ RLM_MODULE_NOOP
Module succeeded without doing anything.
Definition rcode.h:54
fr_dict_attr_t const * request_attr_request
Definition request.c:43
void request_log_prepend(request_t *request, fr_log_t *log_dst, fr_log_lvl_t lvl)
Prepend another logging destination to the list.
Definition request.c:92
#define RAD_REQUEST_LVL_NONE
No debug messages should be printed.
Definition request.h:314
static char const * name
char * fr_sbuff_adv_to_str(fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len)
Wind position to the first instance of the specified needle.
Definition sbuff.c:2080
char * fr_sbuff_adv_to_chr(fr_sbuff_t *sbuff, size_t len, char c)
Wind position to first instance of specified char.
Definition sbuff.c:2044
ssize_t fr_sbuff_in_bstrncpy(fr_sbuff_t *sbuff, char const *str, size_t len)
Copy bytes into the sbuff up to the first \0.
Definition sbuff.c:1493
ssize_t fr_sbuff_in_sprintf(fr_sbuff_t *sbuff, char const *fmt,...)
Print using a fmt string to an sbuff.
Definition sbuff.c:1609
bool fr_sbuff_next_if_char(fr_sbuff_t *sbuff, char c)
Return true if the current char matches, and if it does, advance.
Definition sbuff.c:2176
#define fr_sbuff_start(_sbuff_or_marker)
#define fr_sbuff_set(_dst, _src)
#define FR_SBUFF_IN(_start, _len_or_end)
#define fr_sbuff_adv_past_whitespace(_sbuff, _len, _tt)
#define fr_sbuff_current(_sbuff_or_marker)
char const * name
Name for rule set to aid we debugging.
Definition sbuff.h:209
#define FR_SBUFF(_sbuff_or_marker)
#define fr_sbuff_advance(_sbuff_or_marker, _len)
#define fr_sbuff_init_in(_out, _start, _len_or_end)
#define fr_sbuff_remaining(_sbuff_or_marker)
#define fr_sbuff_len(_sbuff_or_marker)
#define FR_SBUFF_OUT(_start, _len_or_end)
#define fr_sbuff_move(_out, _in, _len)
#define fr_sbuff_used(_sbuff_or_marker)
#define fr_sbuff_behind(_sbuff_or_marker)
#define fr_sbuff_ahead(_sbuff_or_marker)
#define FR_SBUFF_TALLOC_THREAD_LOCAL(_out, _init, _max)
Set of parsing rules for *unescape_until functions.
static char const * tmpl_type_to_str(tmpl_type_t type)
Return a static string containing the type name.
Definition tmpl.h:638
@ TMPL_TYPE_ATTR
Reference to one or more attributes.
Definition tmpl.h:142
@ TMPL_TYPE_XLAT
Pre-parsed xlat expansion.
Definition tmpl.h:146
@ TMPL_TYPE_EXEC
Callout to an external script or program.
Definition tmpl.h:150
@ TMPL_TYPE_REGEX_XLAT_UNRESOLVED
A regular expression with unresolved xlat functions or attribute references.
Definition tmpl.h:197
@ TMPL_TYPE_DATA
Value in native boxed format.
Definition tmpl.h:138
@ TMPL_TYPE_DATA_UNRESOLVED
Unparsed literal string.
Definition tmpl.h:179
tmpl_attr_rules_t attr
Rules/data for parsing attribute references.
Definition tmpl.h:339
Optional arguments passed to vp_tmpl functions.
Definition tmpl.h:336
void fr_sha1_init(fr_sha1_ctx *context)
Definition sha1.c:93
void fr_sha1_final(uint8_t digest[static SHA1_DIGEST_LENGTH], fr_sha1_ctx *context)
Definition sha1.c:141
void fr_sha1_update(fr_sha1_ctx *context, uint8_t const *in, size_t len)
Definition sha1.c:105
#define SHA1_DIGEST_LENGTH
Definition sha1.h:29
static char buff[sizeof("18446744073709551615")+3]
Definition size_tests.c:37
PUBLIC int snprintf(char *string, size_t length, char *format, va_alist)
Definition snprintf.c:689
PRIVATE void strings()
eap_aka_sim_process_conf_t * inst
fr_aka_sim_id_type_t type
fr_pair_t * vp
size_t strlcpy(char *dst, char const *src, size_t siz)
Definition strlcpy.c:34
Definition log.h:93
fr_log_t * parent
Log destination this was cloned from.
Definition log.h:118
fr_log_dst_t dst
Log destination.
Definition log.h:94
int fd
File descriptor to write messages to.
Definition log.h:109
char const * file
Path to log file.
Definition log.h:110
Value pair map.
Definition map.h:77
tmpl_t * lhs
Typically describes the attribute to add, modify or compare.
Definition map.h:78
tmpl_t * rhs
Typically describes a literal value or a src attribute to copy or compare.
Definition map.h:79
fr_dict_t const * dict_def
Default dictionary to use with unqualified attribute references.
Definition tmpl.h:273
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
fr_dict_attr_t const *_CONST da
Dictionary attribute defines the attribute number, vendor and type of the pair.
Definition pair.h:69
char const * fr_syserror(int num)
Guaranteed to be thread-safe version of strerror.
Definition syserror.c:243
#define fr_table_value_by_str(_table, _name, _def)
Convert a string to a value using a sorted or ordered table.
Definition table.h:685
#define fr_table_value_by_substr(_table, _name, _name_len, _def)
Convert a partial string to a value using an ordered or sorted table.
Definition table.h:725
An element in an arbitrarily ordered array of name to num mappings.
Definition table.h:57
An element in a lexicographically sorted array of name to num mappings.
Definition table.h:49
char * talloc_bstrndup(TALLOC_CTX *ctx, char const *in, size_t inlen)
Binary safe strndup function.
Definition talloc.c:618
char * talloc_bstr_append(TALLOC_CTX *ctx, char *to, char const *from, size_t from_len)
Append a bstr to a bstr.
Definition talloc.c:646
#define talloc_get_type_abort_const
Definition talloc.h:117
#define talloc_strdup(_ctx, _str)
Definition talloc.h:149
static size_t talloc_strlen(char const *s)
Returns the length of a talloc array containing a string.
Definition talloc.h:143
fr_test_point_ctx_alloc_t test_ctx
Allocate a test ctx for the encoder.
Definition test_point.h:86
fr_test_point_ctx_alloc_t test_ctx
Allocate a test ctx for the encoder.
Definition test_point.h:94
fr_pair_decode_t func
Decoder for pairs.
Definition test_point.h:87
fr_pair_encode_t func
Encoder for pairs.
Definition test_point.h:95
Entry point for pair decoders.
Definition test_point.h:85
Entry point for pair encoders.
Definition test_point.h:93
bool fr_time_is_dst(void)
Whether or not we're daylight savings.
Definition time.c:1228
int fr_unix_time_from_str(fr_unix_time_t *date, char const *date_str, fr_time_res_t hint)
Convert string in various formats to a fr_unix_time_t.
Definition time.c:810
fr_time_delta_t fr_time_gmtoff(void)
Get the offset to gmt.
Definition time.c:1220
#define fr_time_delta_to_timespec(_delta)
Convert a delta to a timespec.
Definition time.h:666
static int64_t fr_time_to_msec(fr_time_t when)
Convert an fr_time_t (internal time) to number of msec since the unix epoch (wallclock time)
Definition time.h:711
static int64_t fr_unix_time_to_sec(fr_unix_time_t delta)
Definition time.h:506
#define fr_time_delta_wrap(_time)
Definition time.h:152
@ FR_TIME_RES_SEC
Definition time.h:50
#define NSEC
Definition time.h:379
static uint64_t fr_unix_time_unwrap(fr_unix_time_t time)
Definition time.h:161
static fr_time_delta_t fr_time_delta_sub(fr_time_delta_t a, fr_time_delta_t b)
Definition time.h:261
static fr_unix_time_t fr_time_to_unix_time(fr_time_t when)
Convert an fr_time_t (internal time) to our version of unix time (wallclock time)
Definition time.h:688
static fr_time_delta_t fr_time_delta_from_timespec(struct timespec const *ts)
Definition time.h:614
"Unix" time.
Definition time.h:95
char const * fr_tokens[T_TOKEN_LAST]
Definition token.c:146
static dl_t * dl
xlat_action_t unlang_xlat_yield(request_t *request, xlat_func_t resume, xlat_func_signal_t signal, fr_signal_t sigmask, void *rctx)
Yield a request back to the interpreter from within a module.
Definition xlat.c:543
int unlang_xlat_push(TALLOC_CTX *ctx, unlang_result_t *p_result, fr_value_box_list_t *out, request_t *request, xlat_exp_head_t const *xlat, bool top_frame)
Push a pre-compiled xlat onto the stack for evaluation.
Definition xlat.c:269
void unlang_xlat_init(void)
Register xlat operation with the interpreter.
Definition xlat.c:805
fr_type_t type
Type to cast argument to.
Definition xlat.h:155
bool xlat_is_literal(xlat_exp_head_t const *head)
Check to see if the expansion consists entirely of value-box elements.
#define XLAT_ARG_PARSER_CURSOR
Definition xlat.h:162
unsigned int concat
Concat boxes together.
Definition xlat.h:147
@ XLAT_ARG_VARIADIC_EMPTY_KEEP
Empty argument groups are left alone, and either passed through as empty groups or null boxes.
Definition xlat.h:137
@ XLAT_ARG_VARIADIC_EMPTY_SQUASH
Empty argument groups are removed.
Definition xlat.h:136
xlat_arg_parser_variadic_t variadic
All additional boxes should be processed using this definition.
Definition xlat.h:153
#define XLAT_RESULT_SUCCESS(_p_result)
Definition xlat.h:500
#define XLAT_ARGS(_list,...)
Populate local variables with value boxes from the input list.
Definition xlat.h:383
unsigned int required
Argument must be present, and non-empty.
Definition xlat.h:146
unsigned int single
Argument must only contain a single box.
Definition xlat.h:148
int xlat_resolve(xlat_exp_head_t *head, xlat_res_rules_t const *xr_rules)
Walk over an xlat tree recursively, resolving any unresolved functions or references.
#define XLAT_ARG_PARSER_TERMINATOR
Definition xlat.h:170
xlat_action_t
Definition xlat.h:37
@ XLAT_ACTION_FAIL
An xlat function failed.
Definition xlat.h:44
@ XLAT_ACTION_YIELD
An xlat function pushed a resume frame onto the stack.
Definition xlat.h:42
@ XLAT_ACTION_PUSH_UNLANG
An xlat function pushed an unlang frame onto the unlang stack.
Definition xlat.h:39
@ XLAT_ACTION_DONE
We're done evaluating this level of nesting.
Definition xlat.h:43
fr_slen_t xlat_tokenize_expression(TALLOC_CTX *ctx, xlat_exp_head_t **head, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Definition xlat_expr.c:3163
Definition for a single argument consumed by an xlat function.
Definition xlat.h:145
static fr_slen_t fr_pair_aprint(TALLOC_CTX *ctx, char **out, fr_dict_attr_t const *parent, fr_pair_t const *vp) 1(fr_pair_print
fr_pair_t * fr_pair_list_next(fr_pair_list_t const *list, fr_pair_t const *item))
Get the next item in a valuepair list after a specific entry.
Definition pair_inline.c:69
static void fr_pair_set_immutable(fr_pair_t *vp)
Definition pair.h:699
static fr_slen_t quote ssize_t fr_pair_print_name(fr_sbuff_t *out, fr_dict_attr_t const *parent, fr_pair_t const **vp_p)
Print an attribute name.
Definition pair_print.c:136
#define fr_pair_dcursor_init(_cursor, _list)
Initialises a special dcursor with callbacks that will maintain the attr sublists correctly.
Definition pair.h:604
static fr_slen_t parent
Definition pair.h:858
void fr_strerror_clear(void)
Clears all pending messages from the talloc pools.
Definition strerror.c:581
#define fr_strerror_printf(_fmt,...)
Log to thread local error buffer.
Definition strerror.h:64
fr_table_num_ordered_t const fr_type_table[]
Map data types to names representing those types.
Definition types.c:31
size_t fr_type_table_len
Definition types.c:87
#define fr_type_is_structural(_x)
Definition types.h:392
@ FR_TYPE_ATTR
A contains an attribute reference.
Definition types.h:83
#define FR_TYPE_NON_LEAF
Definition types.h:318
#define fr_type_is_string(_x)
Definition types.h:348
#define fr_type_is_numeric(_x)
Definition types.h:382
#define FR_TYPE_STRUCTURAL
Definition types.h:316
#define fr_type_is_null(_x)
Definition types.h:347
#define fr_type_is_leaf(_x)
Definition types.h:393
static char const * fr_type_to_str(fr_type_t type)
Return a static string containing the type name.
Definition types.h:454
#define FR_TYPE_LEAF
Definition types.h:317
#define FR_TYPE_NUMERIC
Definition types.h:306
size_t fr_value_box_network_length(fr_value_box_t const *value)
Get the size of the value held by the fr_value_box_t.
Definition value.c:1409
void fr_value_box_mark_unsafe(fr_value_box_t *vb)
Mark a value-box as "unsafe".
Definition value.c:7300
ssize_t fr_value_box_list_concat_as_string(fr_value_box_t *safety, fr_sbuff_t *sbuff, fr_value_box_list_t *list, char const *sep, size_t sep_len, fr_sbuff_escape_rules_t const *e_rules, fr_value_box_list_action_t proc_action, fr_value_box_safe_for_t safe_for, bool flatten)
Concatenate a list of value boxes together.
Definition value.c:6388
ssize_t fr_value_box_print(fr_sbuff_t *out, fr_value_box_t const *data, fr_sbuff_escape_rules_t const *e_rules)
Print one boxed value to a string.
Definition value.c:6105
int fr_value_box_mem_alloc(TALLOC_CTX *ctx, uint8_t **out, fr_value_box_t *dst, fr_dict_attr_t const *enumv, size_t len, bool tainted)
Pre-allocate an octets buffer for filling by the caller.
Definition value.c:4985
int fr_value_box_cast(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, fr_value_box_t const *src)
Convert one type of fr_value_box_t to another.
Definition value.c:3946
char * fr_value_box_list_aprint(TALLOC_CTX *ctx, fr_value_box_list_t const *list, char const *delim, fr_sbuff_escape_rules_t const *e_rules)
Concatenate the string representations of a list of value boxes together.
Definition value.c:6987
int fr_value_box_mem_realloc(TALLOC_CTX *ctx, uint8_t **out, fr_value_box_t *dst, size_t len)
Change the length of a buffer already allocated to a value box.
Definition value.c:5018
void fr_value_box_list_untaint(fr_value_box_list_t *head)
Untaint every list member (and their children)
Definition value.c:7184
int fr_value_box_cast_in_place(TALLOC_CTX *ctx, fr_value_box_t *vb, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv)
Convert one type of fr_value_box_t to another in place.
Definition value.c:4196
void fr_value_box_clear_value(fr_value_box_t *data)
Clear/free any existing value.
Definition value.c:4331
int fr_value_box_strdup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Copy a nul terminated string to a fr_value_box_t.
Definition value.c:4619
void fr_value_box_safety_copy_changed(fr_value_box_t *out, fr_value_box_t const *in)
Copy the safety values from one box to another.
Definition value.c:7343
void fr_value_box_safety_merge(fr_value_box_t *out, fr_value_box_t const *in)
Merge safety results.
Definition value.c:7352
void fr_value_box_strdup_shallow(fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Assign a buffer containing a nul terminated string to a box, but don't copy it.
Definition value.c:4729
void fr_value_box_safety_copy(fr_value_box_t *out, fr_value_box_t const *in)
Copy the safety values from one box to another.
Definition value.c:7330
int fr_value_box_bstr_alloc(TALLOC_CTX *ctx, char **out, fr_value_box_t *dst, fr_dict_attr_t const *enumv, size_t len, bool tainted)
Alloc and assign an empty \0 terminated string to a fr_value_box_t.
Definition value.c:4764
void fr_value_box_clear(fr_value_box_t *data)
Clear/free any existing value and metadata.
Definition value.c:4377
bool fr_value_box_list_tainted(fr_value_box_list_t const *head)
Check to see if any list members (or their children) are tainted.
Definition value.c:7153
int fr_value_box_bstr_realloc(TALLOC_CTX *ctx, char **out, fr_value_box_t *dst, size_t len)
Change the length of a buffer already allocated to a value box.
Definition value.c:4797
int fr_value_box_bstrndup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, size_t len, bool tainted)
Copy a string to to a fr_value_box_t.
Definition value.c:4838
int fr_value_box_bstrdup_buffer_shallow(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Assign a talloced buffer containing a nul terminated string to a box, but don't copy it.
Definition value.c:4946
int fr_value_box_memdup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, uint8_t const *src, size_t len, bool tainted)
Copy a buffer to a fr_value_box_t.
Definition value.c:5079
int fr_value_box_list_concat_in_place(TALLOC_CTX *ctx, fr_value_box_t *out, fr_value_box_list_t *list, fr_type_t type, fr_value_box_list_action_t proc_action, bool flatten, size_t max_size)
Concatenate a list of value boxes.
Definition value.c:6604
@ FR_VALUE_BOX_LIST_FREE
Definition value.h:238
@ FR_VALUE_BOX_LIST_FREE_BOX
Free each processed box.
Definition value.h:235
#define fr_value_box_alloc(_ctx, _type, _enumv)
Allocate a value box of a specific type.
Definition value.h:644
#define fr_value_box_mark_safe_for(_box, _safe_for)
Definition value.h:1093
static fr_slen_t data
Definition value.h:1340
static fr_value_box_t * fr_value_box_acopy(TALLOC_CTX *ctx, fr_value_box_t const *src)
Copy an existing box, allocating a new box to hold its contents.
Definition value.h:744
#define fr_value_box_is_safe_for(_box, _safe_for)
Definition value.h:1100
#define fr_box_is_variable_size(_x)
Definition value.h:464
#define fr_value_box_get_cursor(_dst)
Definition value.h:1261
#define VALUE_BOX_VERIFY(_x)
Definition value.h:1370
#define VALUE_BOX_LIST_VERIFY(_x)
Definition value.h:1371
int nonnull(2, 5))
#define fr_value_box_alloc_null(_ctx)
Allocate a value box for later use with a value assignment function.
Definition value.h:655
#define fr_value_box_list_foreach(_list_head, _iter)
Definition value.h:224
static size_t char ** out
Definition value.h:1030
#define fr_box_bool(_val)
Definition value.h:331
#define FR_VALUE_BOX_SAFE_FOR_ANY
Definition value.h:173
fr_dict_t const * virtual_server_dict_by_cs(CONF_SECTION const *cs)
Return the namespace for specified CONF_SECTION.
static xlat_arg_parser_t const xlat_func_bin_arg[]
static int xlat_protocol_register_cbor(void)
static xlat_arg_parser_t const xlat_func_map_arg[]
static xlat_action_t xlat_func_file_tail(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
#define XLAT_REGISTER_VOID(_xlat, _func, _return_type)
static xlat_arg_parser_t const xlat_func_log_dst_args[]
static xlat_arg_parser_t const xlat_func_taint_args[]
static xlat_arg_parser_t const xlat_func_time_args[]
static xlat_arg_parser_t const xlat_func_base64_encode_arg[]
unlang_result_t last_result
static xlat_action_t xlat_change_case(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED request_t *request, fr_value_box_list_t *args, bool upper)
Change case of a string.
static int _log_dst_free(fr_log_t *log)
unlang_result_t last_result
static xlat_arg_parser_t const xlat_pair_encode_args[]
static xlat_action_t xlat_hmac(TALLOC_CTX *ctx, fr_dcursor_t *out, fr_value_box_list_t *args, uint8_t *digest, int digest_len, hmac_type type)
static xlat_arg_parser_t const xlat_func_signal_raise_args[]
static void xlat_debug_attr_vp(request_t *request, fr_pair_t const *vp, fr_dict_attr_t const *da)
static xlat_arg_parser_t const xlat_func_log_arg[]
static xlat_action_t xlat_func_file_mkdir(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
static xlat_arg_parser_t const xlat_func_sha_arg[]
static xlat_arg_parser_t const xlat_func_cast_args[]
static int xlat_pair_dencode_instantiate(xlat_inst_ctx_t const *mctx)
xlat_action_t xlat_transparent(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
Common function to move boxes from input list to output list.
hmac_type
@ HMAC_MD5
@ HMAC_SHA1
static xlat_arg_parser_t const xlat_func_hex_arg[]
static xlat_arg_parser_t const xlat_func_substr_args[]
static xlat_action_t xlat_func_file_exists(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *args)
static xlat_action_t xlat_func_file_head(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
static xlat_arg_parser_t const xlat_func_block_args[]
static xlat_arg_parser_t const xlat_func_subnet_args[]
static xlat_arg_parser_t const xlat_func_module_call_arg[]
#define XLAT_REGISTER_PURE(_xlat, _func, _return_type, _arg)
static xlat_arg_parser_t const xlat_func_str_printable_arg[]
static xlat_arg_parser_t const xlat_func_randstr_arg[]
static xlat_arg_parser_t const xlat_func_eval_arg[]
static xlat_arg_parser_t const xlat_func_subst_args[]
static xlat_arg_parser_t const xlat_func_explode_args[]
int xlat_protocols_register(void)
Register xlats for any loaded dictionaries.
static xlat_arg_parser_t const xlat_func_str_utf8_arg[]
#define REPETITION_MAX
static dl_loader_t * cbor_loader
static xlat_arg_parser_t const xlat_change_case_arg[]
static xlat_arg_parser_t const xlat_func_strlen_arg[]
static int xlat_protocol_register(fr_dict_t const *dict)
static xlat_arg_parser_t const xlat_func_md5_arg[]
int xlat_global_init(void)
static xlat_arg_parser_t const xlat_func_urlquote_arg[]
static xlat_arg_parser_t const xlat_pair_cursor_args[]
static xlat_action_t xlat_func_file_size(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
static void ungroup(fr_dcursor_t *out, fr_value_box_list_t *in)
static xlat_arg_parser_t const xlat_func_md4_arg[]
static int regex_xlat_escape(UNUSED request_t *request, fr_value_box_t *vb, UNUSED void *uctx)
static bool xlat_file_allowed(request_t *request, char const *filename, size_t len)
static xlat_arg_parser_t const xlat_func_join_args[]
static xlat_action_t xlat_module_call_resume(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
Just serves to push the result up the stack.
#define XLAT_NEW(_x)
static xlat_action_t xlat_eval_resume(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
Just serves to push the result up the stack.
static xlat_action_t xlat_func_taint(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
#define XLAT_REGISTER_HASH(_name, _func)
static xlat_arg_parser_t const xlat_func_debug_args[]
static char const hextab[]
#define FR_FILENAME_SAFE_FOR
static xlat_action_t xlat_func_signal_raise(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
fr_test_point_pair_decode_t * tp_decode
static xlat_arg_parser_t const xlat_func_pad_args[]
static int uuid_print_vb(fr_value_box_t *vb, uint32_t vals[4])
Convert a UUID in an array of uint32_t to the conventional string representation.
static xlat_arg_parser_t const xlat_func_urlunquote_arg[]
static xlat_action_t xlat_func_file_touch(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
fr_dict_t const * dict
Restrict xlat to this namespace.
static xlat_arg_parser_t const xlat_pair_decode_args[]
static xlat_arg_parser_t const xlat_func_rand_arg[]
static void uuid_set_variant(uint32_t vals[4], uint8_t variant)
static int filename_xlat_escape(UNUSED request_t *request, fr_value_box_t *vb, UNUSED void *uctx)
static xlat_arg_parser_t const xlat_func_concat_args[]
#define XLAT_FILE_ALLOWED(_vb)
static xlat_action_t xlat_func_join(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Join a series of arguments to form a single list.
static xlat_arg_parser_t const xlat_func_file_name_count_args[]
void xlat_arg_copy_out(TALLOC_CTX *ctx, fr_dcursor_t *out, fr_value_box_list_t *in, fr_value_box_t *vb)
Copy an argument from the input list to the output cursor.
static xlat_arg_parser_t const xlat_func_range_arg[]
static xlat_arg_parser_t const xlat_func_integer_args[]
static int _xlat_global_init(UNUSED void *uctx)
Global initialisation for xlat.
#define XLAT_REGISTER_ARGS(_xlat, _func, _return_type, _args)
xlat_exp_head_t * ex
static xlat_action_t xlat_func_untaint(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
static xlat_action_t xlat_func_file_cat(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
static xlat_action_t xlat_func_file_rm(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
xlat_exp_head_t * ex
static xlat_arg_parser_t const xlat_func_length_args[]
static xlat_action_t xlat_func_ungroup(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Ungroups all of its arguments into one flat list.
static int xlat_protocol_register_by_name(dl_t *dl, char const *name, fr_dict_t const *dict)
static xlat_arg_parser_t const xlat_func_file_cat_args[]
static void uuid_set_version(uint32_t vals[4], uint8_t version)
static xlat_action_t xlat_func_file_rmdir(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
#define UUID_CHARS(_v, _num)
static void xlat_debug_attr_list(request_t *request, fr_pair_list_t const *list, fr_dict_attr_t const *parent)
static xlat_arg_parser_t const xlat_func_file_name_args[]
static TALLOC_CTX * xlat_ctx
static xlat_arg_parser_t const xlat_func_next_time_args[]
static int _xlat_global_free(UNUSED void *uctx)
De-register all xlat functions we created.
static xlat_arg_parser_t const xlat_func_base64_decode_arg[]
static xlat_arg_parser_t const xlat_hmac_args[]
static xlat_arg_parser_t const xlat_func_regex_args[]
void * rctx
Resume context.
Definition xlat_ctx.h:54
xlat_exp_t const * ex
Tokenized expression.
Definition xlat_ctx.h:55
xlat_exp_t * ex
Tokenized expression to use in expansion.
Definition xlat_ctx.h:64
void const * inst
xlat instance data.
Definition xlat_ctx.h:50
void * uctx
Passed to the registration function.
Definition xlat_ctx.h:66
void * inst
xlat instance data to populate.
Definition xlat_ctx.h:63
An xlat calling ctx.
Definition xlat_ctx.h:49
An xlat instantiation ctx.
Definition xlat_ctx.h:62
fr_dict_attr_t const * xlat_time_res_attr(char const *res)
Definition xlat_eval.c:127
int xlat_eval_init(void)
Definition xlat_eval.c:2022
void xlat_eval_free(void)
Definition xlat_eval.c:2044
int xlat_register_expressions(void)
Definition xlat_expr.c:1859
void xlat_func_free(void)
Definition xlat_func.c:556
void xlat_func_flags_set(xlat_t *x, xlat_func_flags_t flags)
Specify flags that alter the xlat's behaviour.
Definition xlat_func.c:392
int xlat_func_args_set(xlat_t *x, xlat_arg_parser_t const args[])
Register the arguments of an xlat.
Definition xlat_func.c:365
xlat_t * xlat_func_register(TALLOC_CTX *ctx, char const *name, xlat_func_t func, fr_type_t return_type)
Register an xlat function.
Definition xlat_func.c:216
int xlat_func_init(void)
Definition xlat_func.c:540
xlat_t * xlat_func_find(char const *in, ssize_t inlen)
Definition xlat_func.c:77
#define xlat_func_instantiate_set(_xlat, _instantiate, _inst_struct, _detach, _uctx)
Set a callback for global instantiation of xlat functions.
Definition xlat_func.h:93
#define xlat_func_safe_for_set(_xlat, _escaped)
Set the escaped values for output boxes.
Definition xlat_func.h:82
@ XLAT_FUNC_FLAG_PURE
Definition xlat_func.h:38
@ XLAT_FUNC_FLAG_INTERNAL
Definition xlat_func.h:39
int xlat_decode_value_box_list(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, void *decode_ctx, fr_pair_decode_t decode, fr_value_box_list_t *in)
Decode all of the value boxes into the output cursor.
Definition xlat_pair.c:90
@ XLAT_GROUP
encapsulated string of xlats
Definition xlat_priv.h:116
bool deprecated
this function was deprecated
Definition xlat_priv.h:68
xlat_type_t _CONST type
type of this expansion.
Definition xlat_priv.h:155
An xlat expansion node.
Definition xlat_priv.h:148