-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
tmpl.c
2869 lines (2465 loc) · 77.4 KB
/
tmpl.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*/
/**
* $Id$
*
* @brief #VALUE_PAIR template functions
* @file src/lib/server/tmpl.c
*
* @ingroup AVP
*
* @copyright 2014-2015 The FreeRADIUS server project
*/
RCSID("$Id$")
#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/rad_assert.h>
#include <freeradius-devel/util/misc.h>
#include <ctype.h>
/** Map #tmpl_type_t values to descriptive strings
*/
fr_table_num_sorted_t const tmpl_type_table[] = {
{ "attr", TMPL_TYPE_ATTR },
{ "data", TMPL_TYPE_DATA },
{ "exec", TMPL_TYPE_EXEC },
{ "list", TMPL_TYPE_LIST },
{ "literal", TMPL_TYPE_UNPARSED },
{ "null", TMPL_TYPE_NULL },
{ "parsed regex", TMPL_TYPE_REGEX_STRUCT },
{ "parsed xlat", TMPL_TYPE_XLAT_STRUCT },
{ "regex", TMPL_TYPE_REGEX },
{ "unknown attr", TMPL_TYPE_ATTR_UNDEFINED },
{ "xlat", TMPL_TYPE_XLAT }
};
size_t tmpl_type_table_len = NUM_ELEMENTS(tmpl_type_table);
/** Map keywords to #pair_list_t values
*/
fr_table_num_ordered_t const pair_list_table[] = {
{ "request", PAIR_LIST_REQUEST },
{ "reply", PAIR_LIST_REPLY },
{ "control", PAIR_LIST_CONTROL }, /* New name should have priority */
{ "config", PAIR_LIST_CONTROL },
{ "session-state", PAIR_LIST_STATE },
#ifdef WITH_PROXY
{ "proxy-request", PAIR_LIST_PROXY_REQUEST },
{ "proxy-reply", PAIR_LIST_PROXY_REPLY }
#endif
};
size_t pair_list_table_len = NUM_ELEMENTS(pair_list_table);
/** Map keywords to #request_ref_t values
*/
fr_table_num_sorted_t const request_ref_table[] = {
{ "current", REQUEST_CURRENT },
{ "outer", REQUEST_OUTER },
{ "parent", REQUEST_PARENT },
{ "proxy", REQUEST_PROXY }
};
size_t request_ref_table_len = NUM_ELEMENTS(request_ref_table);
/** @name Parse list and request qualifiers to #pair_list_t and #request_ref_t values
*
* These functions also resolve #pair_list_t and #request_ref_t values to #REQUEST
* structs and the head of #VALUE_PAIR lists in those structs.
*
* For adding new #VALUE_PAIR to the lists, the #radius_list_ctx function can be used
* to obtain the appropriate TALLOC_CTX pointer.
*
* @note These don't really have much to do with #vp_tmpl_t. They're in the same
* file as they're used almost exclusively by the tmpl_* functions.
* @{
*/
/** Resolve attribute name to a #pair_list_t value.
*
* Check the name string for #pair_list_t qualifiers and write a #pair_list_t value
* for that list to out. This value may be passed to #radius_list, along with the current
* #REQUEST, to get a pointer to the actual list in the #REQUEST.
*
* If we're sure we've definitely found a list qualifier token delimiter (``:``) but the
* string doesn't match a #radius_list qualifier, return 0 and write #PAIR_LIST_UNKNOWN
* to out.
*
* If we can't find a string that looks like a request qualifier, set out to def, and
* return 0.
*
* @note #radius_list_name should be called before passing a name string that may
* contain qualifiers to #fr_dict_attr_by_name.
*
* @param[out] out Where to write the list qualifier.
* @param[in] name String containing list qualifiers to parse.
* @param[in] def the list to return if no qualifiers were found.
* @return 0 if no valid list qualifier could be found, else the number of bytes consumed.
* The caller may then advanced the name pointer by the value returned, to get the
* start of the attribute name (if any).
*
* @see pair_list
* @see radius_list
*/
size_t radius_list_name(pair_list_t *out, char const *name, pair_list_t def)
{
char const *p = name;
char const *q;
/* This should never be a NULL pointer */
rad_assert(name);
/*
* Try and determine the end of the token
*/
for (q = p; fr_dict_attr_allowed_chars[(uint8_t) *q]; q++);
switch (*q) {
/*
* It's a bareword made up entirely of dictionary chars
* check and see if it's a list qualifier, and if it's
* not, return the def and say we couldn't parse
* anything.
*/
case '\0':
*out = fr_table_value_by_substr(pair_list_table, p, (q - p), PAIR_LIST_UNKNOWN);
if (*out != PAIR_LIST_UNKNOWN) return q - p;
*out = def;
return 0;
/*
* It may be a list qualifier delimiter. Because of tags
* We need to check that it doesn't look like a tag suffix.
* We do this by looking at the chars between ':' and the
* next token delimiter, and seeing if they're all digits.
*/
case ':':
{
char const *d = q + 1;
if (isdigit((int) *d)) {
while (isdigit((int) *d)) d++;
/*
* Char after the number string
* was a token delimiter, so this is a
* tag, not a list qualifier.
*/
if (!fr_dict_attr_allowed_chars[(uint8_t) *d]) {
*out = def;
return 0;
}
}
*out = fr_table_value_by_substr(pair_list_table, p, (q - p), PAIR_LIST_UNKNOWN);
if (*out == PAIR_LIST_UNKNOWN) return 0;
return (q + 1) - name; /* Consume the list and delimiter */
}
default:
*out = def;
return 0;
}
}
/** Resolve attribute #pair_list_t value to an attribute list.
*
* The value returned is a pointer to the pointer of the HEAD of a #VALUE_PAIR list in the
* #REQUEST. If the head of the list changes, the pointer will still be valid.
*
* @param[in] request containing the target lists.
* @param[in] list #pair_list_t value to resolve to #VALUE_PAIR list. Will be NULL if list
* name couldn't be resolved.
* @return a pointer to the HEAD of a list in the #REQUEST.
*
* @see tmpl_cursor_init
*/
VALUE_PAIR **radius_list(REQUEST *request, pair_list_t list)
{
if (!request) return NULL;
switch (list) {
/* Don't add default */
case PAIR_LIST_UNKNOWN:
break;
case PAIR_LIST_REQUEST:
if (!request->packet) return NULL;
return &request->packet->vps;
case PAIR_LIST_REPLY:
if (!request->reply) return NULL;
return &request->reply->vps;
case PAIR_LIST_CONTROL:
return &request->control;
case PAIR_LIST_STATE:
return &request->state;
#ifdef WITH_PROXY
case PAIR_LIST_PROXY_REQUEST:
if (!request->proxy || !request->proxy->packet) break;
return &request->proxy->packet->vps;
case PAIR_LIST_PROXY_REPLY:
if (!request->proxy || !request->proxy->reply) break;
return &request->proxy->reply->vps;
#endif
}
RWDEBUG2("List \"%s\" is not available",
fr_table_str_by_value(pair_list_table, list, "<INVALID>"));
return NULL;
}
/** Resolve a list to the #RADIUS_PACKET holding the HEAD pointer for a #VALUE_PAIR list
*
* Returns a pointer to the #RADIUS_PACKET that holds the HEAD pointer of a given list,
* for the current #REQUEST.
*
* @param[in] request To resolve list in.
* @param[in] list #pair_list_t value to resolve to #RADIUS_PACKET.
* @return
* - #RADIUS_PACKET on success.
* - NULL on failure.
*
* @see radius_list
*/
RADIUS_PACKET *radius_packet(REQUEST *request, pair_list_t list)
{
switch (list) {
/* Don't add default */
case PAIR_LIST_STATE:
case PAIR_LIST_CONTROL:
case PAIR_LIST_UNKNOWN:
return NULL;
case PAIR_LIST_REQUEST:
return request->packet;
case PAIR_LIST_REPLY:
return request->reply;
#ifdef WITH_PROXY
case PAIR_LIST_PROXY_REQUEST:
if (!request->proxy) return NULL;
return request->proxy->packet;
case PAIR_LIST_PROXY_REPLY:
if (!request->proxy) return NULL;
return request->proxy->reply;
#endif
}
return NULL;
}
/** Return the correct TALLOC_CTX to alloc #VALUE_PAIR in, for a list
*
* Allocating new #VALUE_PAIR in the context of a #REQUEST is usually wrong.
* #VALUE_PAIR should be allocated in the context of a #RADIUS_PACKET, so that if the
* #RADIUS_PACKET is freed before the #REQUEST, the associated #VALUE_PAIR lists are
* freed too.
*
* @param[in] request containing the target lists.
* @param[in] list #pair_list_t value to resolve to TALLOC_CTX.
* @return
* - TALLOC_CTX on success.
* - NULL on failure.
*
* @see radius_list
*/
TALLOC_CTX *radius_list_ctx(REQUEST *request, pair_list_t list)
{
if (!request) return NULL;
switch (list) {
case PAIR_LIST_REQUEST:
return request->packet;
case PAIR_LIST_REPLY:
return request->reply;
case PAIR_LIST_CONTROL:
return request;
case PAIR_LIST_STATE:
return request->state_ctx;
#ifdef WITH_PROXY
case PAIR_LIST_PROXY_REQUEST:
if (!request->proxy) return NULL;
return request->proxy->packet;
case PAIR_LIST_PROXY_REPLY:
if (!request->proxy) return NULL;
return request->proxy->reply;
#endif
/* Don't add default */
case PAIR_LIST_UNKNOWN:
break;
}
return NULL;
}
/** Resolve attribute name to a #request_ref_t value.
*
* Check the name string for qualifiers that reference a parent #REQUEST.
*
* If we find a string that matches a #request_ref_t qualifier, return the number of chars
* we consumed.
*
* If we're sure we've definitely found a list qualifier token delimiter (``*``) but the
* qualifier doesn't match one of the #request_ref_t qualifiers, return 0 and set out to
* #REQUEST_UNKNOWN.
*
* If we can't find a string that looks like a request qualifier, set out to def, and
* return 0.
*
* @param[out] out The #request_ref_t value the name resolved to (or #REQUEST_UNKNOWN).
* @param[in] name of attribute.
* @param[in] def default request ref to return if no request qualifier is present.
* @return 0 if no valid request qualifier could be found, else the number of bytes consumed.
* The caller may then advanced the name pointer by the value returned, to get the
* start of the attribute list or attribute name(if any).
*
* @see radius_list_name
* @see request_ref_table
*/
size_t radius_request_name(request_ref_t *out, char const *name, request_ref_t def)
{
char const *p, *q;
p = name;
/*
* Try and determine the end of the token
*/
for (q = p; fr_dict_attr_allowed_chars[(uint8_t) *q] && (*q != '.') && (*q != '-'); q++);
/*
* First token delimiter wasn't a '.'
*/
if (*q != '.') {
*out = def;
return 0;
}
*out = fr_table_value_by_substr(request_ref_table, name, q - p, REQUEST_UNKNOWN);
if (*out == REQUEST_UNKNOWN) return 0;
return (q + 1) - p;
}
/** Resolve a #request_ref_t to a #REQUEST.
*
* Sometimes #REQUEST structs may be chained to each other, as is the case
* when internally proxying EAP. This function resolves a #request_ref_t
* to a #REQUEST higher in the chain than the current #REQUEST.
*
* @see radius_list
* @param[in,out] context #REQUEST to start resolving from, and where to write
* a pointer to the resolved #REQUEST back to.
* @param[in] name (request) to resolve.
* @return
* - 0 if request is valid in this context.
* - -1 if request is not valid in this context.
*/
int radius_request(REQUEST **context, request_ref_t name)
{
REQUEST *request = *context;
switch (name) {
case REQUEST_CURRENT:
return 0;
case REQUEST_PARENT: /* for future use in request chaining */
case REQUEST_OUTER:
if (!request->parent) {
return -1;
}
*context = request->parent;
break;
case REQUEST_PROXY:
if (!request->proxy) {
return -1;
}
*context = request->proxy;
break;
case REQUEST_UNKNOWN:
default:
rad_assert(0);
return -1;
}
return 0;
}
/** @} */
/** @name Alloc or initialise #vp_tmpl_t
*
* @note Should not usually be called outside of tmpl_* functions, use one of
* the tmpl_*from_* functions instead.
* @{
*/
/** Initialise stack allocated #vp_tmpl_t
*
* @note Name is not talloc_strdup'd or memcpy'd so must be available, and must not change
* for the lifetime of the #vp_tmpl_t.
*
* @param[out] vpt to initialise.
* @param[in] type to set in the #vp_tmpl_t.
* @param[in] name of the #vp_tmpl_t.
* @param[in] len The length of the buffer (or a substring of the buffer) pointed to by name.
* If < 0 strlen will be used to determine the length.
* @param[in] quote The type of quoting around the template name.
* @return a pointer to the initialised #vp_tmpl_t. The same value as vpt.
*/
vp_tmpl_t *tmpl_init(vp_tmpl_t *vpt, tmpl_type_t type, char const *name, ssize_t len, FR_TOKEN quote)
{
rad_assert(vpt);
rad_assert(type != TMPL_TYPE_UNKNOWN);
rad_assert(type <= TMPL_TYPE_NULL);
memset(vpt, 0, sizeof(vp_tmpl_t));
vpt->type = type;
if (name) {
vpt->name = name;
vpt->len = len < 0 ? strlen(name) :
(size_t) len;
vpt->quote = quote;
}
return vpt;
}
/** Create a new heap allocated #vp_tmpl_t
*
* @param[in,out] ctx to allocate in.
* @param[in] type to set in the #vp_tmpl_t.
* @param[in] name of the #vp_tmpl_t (will be copied to a new talloc buffer parented
* by the #vp_tmpl_t).
* @param[in] len The length of the buffer (or a substring of the buffer) pointed to by name.
* If < 0 strlen will be used to determine the length.
* @param[in] quote The type of quoting around the template name.
* @return the newly allocated #vp_tmpl_t.
*/
vp_tmpl_t *tmpl_alloc(TALLOC_CTX *ctx, tmpl_type_t type, char const *name, ssize_t len, FR_TOKEN quote)
{
vp_tmpl_t *vpt;
rad_assert(type != TMPL_TYPE_UNKNOWN);
rad_assert(type <= TMPL_TYPE_NULL);
#ifndef HAVE_REGEX
if ((type == TMPL_TYPE_REGEX) || (type == TMPL_TYPE_REGEX_STRUCT)) {
return NULL;
}
#endif
vpt = talloc_zero(ctx, vp_tmpl_t);
if (!vpt) return NULL;
vpt->type = type;
if (name) {
vpt->name = talloc_bstrndup(vpt, name, len < 0 ? strlen(name) : (size_t)len);
vpt->len = talloc_array_length(vpt->name) - 1;
vpt->quote = quote;
}
return vpt;
}
/* @} **/
/** @name Create new #vp_tmpl_t from a string
*
* @{
*/
/** Initialise a #vp_tmpl_t to search for, or create attributes
*
* @param vpt to initialise.
* @param da of #VALUE_PAIR type to operate on.
* @param tag Must be one of:
* - A positive integer specifying a specific tag.
* - #TAG_ANY - Attribute with no specific tag value.
* - #TAG_NONE - No tag.
* @param num Specific instance, or all instances. Must be one of:
* - A positive integer specifying an instance.
* - #NUM_ALL - All instances.
* - #NUM_ANY - The first instance found.
* - #NUM_LAST - The last instance found.
* @param request to operate on.
* @param list to operate on.
*/
void tmpl_from_da(vp_tmpl_t *vpt, fr_dict_attr_t const *da, int8_t tag, int num,
request_ref_t request, pair_list_t list)
{
static char const name[] = "internal";
rad_assert(da);
tmpl_init(vpt, TMPL_TYPE_ATTR, name, sizeof(name), T_BARE_WORD);
vpt->tmpl_da = da;
vpt->tmpl_request = request;
vpt->tmpl_list = list;
/*
* No tags can't have any tags
*/
if (!vpt->tmpl_da->flags.has_tag) {
vpt->tmpl_tag = TAG_NONE;
} else {
vpt->tmpl_tag = tag;
}
vpt->tmpl_num = num;
}
/** Create a #vp_tmpl_t from a #fr_value_box_t
*
* @param[in,out] ctx to allocate #vp_tmpl_t in.
* @param[out] out Where to write pointer to new #vp_tmpl_t.
* @param[in] data to convert.
* @param[in] steal If true, any buffers are moved to the new
* ctx instead of being duplicated.
* @return
* - 0 on success.
* - -1 on failure.
*/
int tmpl_afrom_value_box(TALLOC_CTX *ctx, vp_tmpl_t **out, fr_value_box_t *data, bool steal)
{
char const *name;
vp_tmpl_t *vpt;
vpt = talloc(ctx, vp_tmpl_t);
name = fr_value_box_asprint(vpt, data, '\0');
tmpl_init(vpt, TMPL_TYPE_DATA, name, talloc_array_length(name),
(data->type == FR_TYPE_STRING) ? T_SINGLE_QUOTED_STRING : T_BARE_WORD);
if (steal) {
if (fr_value_box_steal(vpt, &vpt->tmpl_value, data) < 0) {
talloc_free(vpt);
return -1;
}
} else {
if (fr_value_box_copy(vpt, &vpt->tmpl_value, data) < 0) {
talloc_free(vpt);
return -1;
}
}
*out = vpt;
return 0;
}
/** Default parser rules
*
* Because this is getting to be a ridiculous number of parsing rules
* to pass in via arguments.
*
* Defaults are used if a NULL rules pointer is passed to the parsing function.
*/
static vp_tmpl_rules_t const default_rules = {
.request_def = REQUEST_CURRENT,
.list_def = PAIR_LIST_REQUEST
};
/** Parse a string into a TMPL_TYPE_ATTR_* or #TMPL_TYPE_LIST type #vp_tmpl_t
*
* @param[in,out] ctx to allocate #vp_tmpl_t in.
* @param[out] err May be NULL. Provides the exact error that the parser hit
* when processing the attribute ref.
* @param[out] out Where to write pointer to new #vp_tmpl_t.
* @param[in] name of attribute including #request_ref_t and #pair_list_t qualifiers.
* If only #request_ref_t #pair_list_t qualifiers are found,
* a #TMPL_TYPE_LIST #vp_tmpl_t will be produced.
* @param[in] rules Rules which control parsing:
* - dict_def The default dictionary to use if attributes
* are unqualified.
* - request_def The default #REQUEST to set if no
* #request_ref_t qualifiers are found in name.
* - list_def The default list to set if no #pair_list_t
* qualifiers are found in the name.
* - allow_unknown If true attributes in the format accepted by
* #fr_dict_unknown_afrom_oid_substr will be allowed,
* even if they're not in the main dictionaries.
* If an unknown attribute is found a #TMPL_TYPE_ATTR
* #vp_tmpl_t will be produced.
* If #tmpl_afrom_attr_substr is being called on
* startup, the #vp_tmpl_t may be passed to
* #tmpl_define_unknown_attr to
* add the unknown attribute to the main dictionary.
* If the unknown attribute is not added to
* the main dictionary the #vp_tmpl_t cannot be used
* to search for a #VALUE_PAIR in a #REQUEST.
* - allow_undefined If true, we don't generate a parse error on
* unknown attributes. If an unknown attribute is
* found a #TMPL_TYPE_ATTR_UNDEFINED
* #vp_tmpl_t will be produced.
* - allow_foreign If true, allow attribute names to be qualified
* with a protocol outside of the passed dict_def.
* - disallow_internal If true, don't allow fallback to internal
* attributes.
*
* @see REMARKER to produce pretty error markers from the return value.
*
* @return
* - <= 0 on error (offset as negative integer)
* - > 0 on success (number of bytes parsed).
*/
ssize_t tmpl_afrom_attr_substr(TALLOC_CTX *ctx, attr_ref_error_t *err,
vp_tmpl_t **out, char const *name, vp_tmpl_rules_t const *rules)
{
char const *p, *q;
long num;
ssize_t slen;
vp_tmpl_t *vpt;
if (!rules) rules = &default_rules; /* Use the defaults */
if (err) *err = ATTR_REF_ERROR_NONE;
p = name;
if (!*p) {
fr_strerror_printf("Empty attribute reference");
if (err) *err = ATTR_REF_ERROR_EMPTY;
return 0;
}
/*
* Check to see if we expect a reference prefix
*/
switch (rules->prefix) {
case VP_ATTR_REF_PREFIX_YES:
if (*p != '&') {
fr_strerror_printf("Invalid attribute reference, missing '&' prefix");
if (err) *err = ATTR_REF_ERROR_BAD_PREFIX;
return 0;
}
p++;
break;
case VP_ATTR_REF_PREFIX_NO:
if (*p == '&') {
fr_strerror_printf("Attribute references used here must not have a '&' prefix");
if (err) *err = ATTR_REF_ERROR_BAD_PREFIX;
return 0;
}
break;
case VP_ATTR_REF_PREFIX_AUTO:
if (*p == '&') p++;
break;
}
MEM(vpt = talloc_zero(ctx, vp_tmpl_t));
/*
* Search for a recognised list
*
* There may be multiple '.' separated
* components, so don't error out if
* the first one doesn't match a known list.
*
* The next check for a list qualifier
*/
q = p;
p += radius_request_name(&vpt->tmpl_request, p, rules->request_def);
if (rules->disallow_qualifiers && (p != q)) {
fr_strerror_printf("It is not permitted to specify a request list here.");
goto invalid_list;
}
if (vpt->tmpl_request == REQUEST_UNKNOWN) vpt->tmpl_request = rules->request_def;
/*
* Finding a list qualifier is optional
*
* Because the list name parser can
* determine if something was a tag
* or a list, we trust that when it
* returns PAIR_LIST_UNKOWN that
* the input string is invalid.
*/
q = p;
p += radius_list_name(&vpt->tmpl_list, p, rules->list_def);
if (rules->disallow_qualifiers && (p != q)) {
fr_strerror_printf("It is not permitted to specify a pair list here.");
invalid_list:
if (err) *err = ATTR_REF_ERROR_INVALID_LIST_QUALIFIER;
slen = -(q - name);
goto error;
}
if (vpt->tmpl_list == PAIR_LIST_UNKNOWN) {
fr_strerror_printf("Invalid list qualifier");
if (err) *err = ATTR_REF_ERROR_INVALID_LIST_QUALIFIER;
slen = -(p - name);
error:
talloc_free(vpt);
return slen;
}
vpt->tmpl_tag = TAG_NONE;
vpt->tmpl_num = NUM_ANY;
vpt->type = TMPL_TYPE_ATTR;
/*
* This may be just a bare list, but it can still
* have instance selectors and tag selectors.
*/
switch (*p) {
case '\0':
vpt->type = TMPL_TYPE_LIST;
goto finish;
case '[':
vpt->type = TMPL_TYPE_LIST;
goto do_num;
default:
break;
}
/*
* Look up by name, *including* any Attr-1.2.3.4 which was created when
* parsing the configuration files.
*/
slen = fr_dict_attr_by_qualified_name_substr(NULL, &vpt->tmpl_da,
rules->dict_def, p, !rules->disallow_internal);
if (slen <= 0) {
fr_strerror(); /* Clear out any existing errors */
/*
* At this point, the OID *must* be unknown, and
* not previously used.
*/
slen = fr_dict_unknown_afrom_oid_substr(vpt, &vpt->tmpl_unknown,
fr_dict_root(rules->dict_def), p);
/*
* Attr-1.2.3.4 is OK.
*/
if (slen > 0) {
if (!rules->allow_unknown) {
fr_strerror_printf("Unknown attribute");
if (err) *err = ATTR_REF_ERROR_UNKNOWN_ATTRIBUTE_NOT_ALLOWED;
slen = -(p - name);
goto error;
}
/*
* Unknown attributes can't be encoded, as we don't
* know how to encode them!
*/
vpt->tmpl_unknown->flags.internal = 1;
vpt->tmpl_da = vpt->tmpl_unknown;
p += slen;
goto do_num; /* unknown attributes can't have tags */
}
/*
* Can't parse it as an attribute, might be a literal string
* let the caller decide.
*
* Don't alter the fr_strerror buffer, should contain the parse
* error from fr_dict_unknown_from_suboid.
*/
if (!rules->allow_undefined) {
fr_strerror_printf_push("Undefined attributes not allowed here");
if (err) *err = ATTR_REF_ERROR_UNDEFINED_ATTRIBUTE_NOT_ALLOWED;
slen = -(p - name);
goto error;
}
/*
* Copy the name to a field for later resolution
*/
vpt->type = TMPL_TYPE_ATTR_UNDEFINED;
for (q = p; fr_dict_attr_allowed_chars[(uint8_t) *q]; q++);
if (q == p) {
fr_strerror_printf("Invalid attribute name");
if (err) *err = ATTR_REF_ERROR_INVALID_ATTRIBUTE_NAME;
slen = -(p - name);
goto error;
}
if ((q - p) > FR_DICT_ATTR_MAX_NAME_LEN) {
fr_strerror_printf("Attribute name is too long");
if (err) *err = ATTR_REF_ERROR_INVALID_ATTRIBUTE_NAME;
slen = -(p - name);
goto error;
}
vpt->tmpl_unknown_name = talloc_strndup(vpt, p, q - p);
p = q;
goto do_num;
}
/*
* Attribute location checks
*/
{
fr_dict_t *found_in = fr_dict_by_da(vpt->tmpl_da);
/*
* Even if allow_foreign is false, if disallow_internal is not
* true, we still allow foreign
*/
if (found_in == fr_dict_internal) {
if (rules->disallow_internal) {
fr_strerror_printf("Internal attributes not allowed here");
if (err) *err = ATTR_REF_ERROR_INTERNAL_ATTRIBUTE_NOT_ALLOWED;
slen = -(p - name);
goto error;
}
/*
* Check that the attribute we resolved was from an allowed dictionary
*/
}
#if 0
else if ((rules->dict_def && (found_in != rules->dict_def))) {
/*
* @fixme - We can't enforce this until we support nested attributes
* where the change of attribute context gives us a new dictionary.
*
* i.e.
*
* My-Dhcp-In-RADIUS-Attribute.My-DHCP-Attribute
* | ||_ DHCP attribute
* | |_ Lookup inside linking attribute triggers dictionary change
* |_ RADIUS attribute
*/
if (!rules->allow_foreign) {
fr_strerror_printf("Only attributes from the %s protocol are allowed here",
fr_dict_root(rules->dict_def)->name);
if (err) *err = ATTR_REF_ERROR_FOREIGN_ATTRIBUTES_NOT_ALLOWED;
slen = -(p - name);
goto error;
}
}
#endif
}
/*
* Parsing was successful, so advance the pointer
*/
p += slen;
/*
* If it's an attribute, look for a tag.
*
* Note that we check for tags even if the attribute
* isn't tagged. This lets us print more useful error
* messages.
*/
if (*p == ':') {
char *end;
if (!vpt->tmpl_da->flags.has_tag) { /* Lists don't have a da */
fr_strerror_printf("Attribute '%s' cannot have a tag", vpt->tmpl_da->name);
if (err) *err = ATTR_REF_ERROR_TAGGED_ATTRIBUTE_NOT_ALLOWED;
slen = -(p - name);
goto error;
}
/*
* Allow '*' as an explicit wildcard.
*/
if (p[1] == '*') {
vpt->tmpl_tag = TAG_ANY;
p += 2;
} else {
num = strtol(p + 1, &end, 10);
if (!TAG_VALID_ZERO(num)) {
fr_strerror_printf("Invalid tag value '%li' (should be between 0-31)", num);
if (err) *err = ATTR_REF_ERROR_INVALID_TAG;
slen = -((p + 1) - name);
goto error;
}
vpt->tmpl_tag = num;
p = end;
}
/*
* The attribute is tagged, but the admin didn't
* specify one. This means it's likely a
* "search" thingy.. i.e. "find me ANY attribute,
* no matter what the tag".
*/
} else if (vpt->tmpl_da->flags.has_tag) {
vpt->tmpl_tag = TAG_ANY;
}
do_num:
if (*p == '\0') goto finish;
if (*p == '[') {
p++;
switch (*p) {
case '#':
vpt->tmpl_num = NUM_COUNT;
p++;
break;
case '*':
vpt->tmpl_num = NUM_ALL;
p++;
break;
case 'n':
vpt->tmpl_num = NUM_LAST;
p++;
break;
default:
{
char *end;
num = strtol(p, &end, 10);
if (p == end) {
fr_strerror_printf("Array index is not an integer");
if (err) *err = ATTR_REF_ERROR_INVALID_ARRAY_INDEX;
slen = -(p - name);
goto error;
}
if ((num > 1000) || (num < 0)) {
fr_strerror_printf("Invalid array reference '%li' (should be between 0-1000)", num);
if (err) *err = ATTR_REF_ERROR_INVALID_ARRAY_INDEX;
slen = -(p - name);
goto error;
}
vpt->tmpl_num = num;
p = end;
}
break;
}
if (*p != ']') {
fr_strerror_printf("No closing ']' for array index");
if (err) *err = ATTR_REF_ERROR_INVALID_ARRAY_INDEX;
slen = -(p - name);
goto error;
}
p++;
}
finish:
vpt->name = talloc_strndup(vpt, name, p - name);
vpt->len = p - name;
vpt->quote = T_BARE_WORD;
/*
* Copy over the attribute definition, now we're
* sure what we were passed is valid.
*/
if (tmpl_is_attr(vpt) && vpt->tmpl_da->flags.is_unknown) vpt->tmpl_da = vpt->tmpl_unknown;
TMPL_VERIFY(vpt); /* Because we want to ensure we produced something sane */
*out = vpt;
return vpt->len;
}
/** Parse a string into a TMPL_TYPE_ATTR_* or #TMPL_TYPE_LIST type #vp_tmpl_t
*
* @note Unlike #tmpl_afrom_attr_substr this function will error out if the entire
* name string isn't parsed.
*
* @copydetails tmpl_afrom_attr_substr
*/