varnish-cache/lib/libvarnishapi/vsl_arg.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2015 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 * Author: Martin Blix Grydeland <martin@varnish-software.com>
7
 *
8
 * SPDX-License-Identifier: BSD-2-Clause
9
 *
10
 * Redistribution and use in source and binary forms, with or without
11
 * modification, are permitted provided that the following conditions
12
 * are met:
13
 * 1. Redistributions of source code must retain the above copyright
14
 *    notice, this list of conditions and the following disclaimer.
15
 * 2. Redistributions in binary form must reproduce the above copyright
16
 *    notice, this list of conditions and the following disclaimer in the
17
 *    documentation and/or other materials provided with the distribution.
18
 *
19
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
23
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29
 * SUCH DAMAGE.
30
 */
31
32
#include "config.h"
33
34
#include <ctype.h>
35
#include <limits.h>
36
#include <math.h>
37
#include <stdio.h>
38
#include <stdlib.h>
39
40
#include "vdef.h"
41
#include "vas.h"
42
#include "miniobj.h"
43
44
#include "vbm.h"
45
#include "vnum.h"
46
#include "vqueue.h"
47
#include "vre.h"
48
#include "vsb.h"
49
50
#include "vapi/vsl.h"
51
52
#include "vsl_api.h"
53
54
/*--------------------------------------------------------------------
55
 * Look up a tag
56
 *   0..255     tag number
57
 *   -1         no tag matches
58
 *   -2         multiple tags match
59
 */
60
61
int
62 44252
VSL_Name2Tag(const char *name, int l)
63
{
64
        int i, n;
65
66 44252
        if (l == -1)
67 4186
                l = strlen(name);
68 44252
        n = -1;
69 2014432
        for (i = 0; i < SLT__MAX; i++) {
70 2014064
                if (VSL_tags[i] != NULL &&
71 1910196
                    !strncasecmp(name, VSL_tags[i], l)) {
72 44666
                        if (strlen(VSL_tags[i]) == l) {
73
                                /* Exact match */
74 43884
                                return (i);
75
                        }
76 782
                        if (n == -1)
77 92
                                n = i;
78
                        else
79 690
                                n = -2;
80 782
                }
81 1970180
        }
82 368
        return (n);
83 44252
}
84
85
int
86 5566
VSL_Glob2Tags(const char *glob, int l, VSL_tagfind_f *func, void *priv)
87
{
88 5566
        const char *p1 = NULL;
89 5566
        const char *p2 = NULL;
90
        const char *e, *p;
91 5566
        int i, l1 = 0, l2 = 0, r = 0;
92
93 5566
        AN(glob);
94 5566
        if (l >= 0)
95 1403
                e = glob + l;
96
        else
97 4163
                e = strchr(glob, '\0');
98 5566
        if (glob == e)
99 46
                return (-1);            // Empty pattern cannot match
100
101 44827
        for (p = glob; p < e; p++)
102 39790
                if (*p == '*')
103 483
                        break;
104
105 5520
        if (p == e) {                   // No wildcard
106 5037
                i = VSL_Name2Tag(glob, l);
107 5037
                if (i < 0)
108 207
                        return (i);
109 4830
                if (func != NULL)
110 4830
                        (func)(i, priv);
111 4830
                return (1);
112
        }
113
114 483
        if (p != glob) {                // Prefix match
115 322
                p1 = glob;
116 322
                l1 = p - p1;
117 322
        }
118
119 483
        if (p != e - 1) {               // Postfix match
120 230
                p2 = p + 1;
121 230
                l2 = e - p2;
122 230
        }
123
124 920
        for (p++; p < e; p++)
125 575
                if (*p == '*')
126 138
                        return (-3);    // More than one wildcard
127
128 88665
        for (i = 0; i < SLT__MAX; i++) {
129 88320
                p = VSL_tags[i];
130 88320
                if (p == NULL)
131 56235
                        continue;
132 32085
                e = strchr(p, '\0');
133 32085
                if ((e - p) - l1 < l2)
134 2254
                        continue;
135 29831
                if (p1 != NULL && strncasecmp(p, p1, l1))
136 21643
                        continue;
137 8188
                if (p2 != NULL && strncasecmp(e - l2, p2, l2))
138 3680
                        continue;
139 4508
                if (func != NULL)
140 4508
                        (func)(i, priv);
141 4508
                r++;
142 4508
        }
143 345
        if (r == 0)
144 23
                return (-1);
145 322
        return (r);
146 5566
}
147
148
int
149 1104
VSL_List2Tags(const char *list, int l, VSL_tagfind_f *func, void *priv)
150
{
151
        const char *p, *b, *e;
152 1104
        int r, t = 0;
153
154 1104
        p = list;
155 1104
        if (l >= 0)
156 69
                e = p + l;
157
        else
158 1035
                e = strchr(p, '\0');
159 2300
        while (p < e) {
160 1771
                while (p < e && *p == ',')
161 368
                        p++;
162 1403
                if (p == e)
163 23
                        break;
164 1380
                b = p;
165 9108
                while (p < e && *p != ',')
166 7728
                        p++;
167 1380
                r = VSL_Glob2Tags(b, p - b, func, priv);
168 1380
                if (r < 0)
169 184
                        return (r);
170 1196
                t += r;
171
        }
172 920
        if (t == 0)
173 23
                return (-1);
174 897
        return (t);
175 1104
}
176
177
const char *VSLQ_grouping[VSL_g__MAX] = {
178
        [VSL_g_raw]     = "raw",
179
        [VSL_g_vxid]    = "vxid",
180
        [VSL_g_request] = "request",
181
        [VSL_g_session] = "session",
182
};
183
184
int
185 5290
VSLQ_Name2Grouping(const char *name, int l)
186
{
187
        int i, n;
188
189 5290
        AN(name);
190 5290
        if (l == -1)
191 322
                l = strlen(name);
192 5290
        n = -1;
193 9476
        for (i = 0; i < VSL_g__MAX; i++) {
194 9430
                if (!strncasecmp(name, VSLQ_grouping[i], l)) {
195 5290
                        if (strlen(VSLQ_grouping[i]) == l) {
196
                                /* Exact match */
197 5244
                                return (i);
198
                        }
199 46
                        if (n == -1)
200 23
                                n = i;
201
                        else
202 23
                                n = -2;
203 46
                }
204 4186
        }
205 46
        return (n);
206 5290
}
207
208
void v_matchproto_(VSL_tagfind_f)
209 4347
vsl_vbm_bitset(int bit, void *priv)
210
{
211
212 4347
        vbit_set((struct vbitmap *)priv, bit);
213 4347
}
214
215
void v_matchproto_(VSL_tagfind_f)
216 966
vsl_vbm_bitclr(int bit, void *priv)
217
{
218
219 966
        vbit_clr((struct vbitmap *)priv, bit);
220 966
}
221
222
static int
223 920
vsl_ix_arg(struct VSL_data *vsl, int opt, const char *arg)
224
{
225
        int i;
226
227 920
        CHECK_OBJ_NOTNULL(vsl, VSL_MAGIC);
228 920
        vsl->flags |= F_SEEN_ixIX;
229
230 1840
        i = VSL_List2Tags(arg, -1, opt == 'x' ? vsl_vbm_bitset : vsl_vbm_bitclr,
231 920
            vsl->vbm_suppress);
232 920
        if (i == -1)
233 46
                return (vsl_diag(vsl, "-%c: \"%s\" matches zero tags",
234 23
                    (char)opt, arg));
235 897
        else if (i == -2)
236 46
                return (vsl_diag(vsl, "-%c: \"%s\" is ambiguous",
237 23
                    (char)opt, arg));
238 874
        else if (i == -3)
239 92
                return (vsl_diag(vsl, "-%c: Syntax error in \"%s\"",
240 46
                    (char)opt, arg));
241
242 828
        return (1);
243 920
}
244
245
static int
246 184
vsl_IX_arg(struct VSL_data *vsl, int opt, const char *arg)
247
{
248
        int i, l, off, err;
249
        const char *b, *e;
250
        vre_t *vre;
251
        struct vsb vsb[1];
252
        struct vslf *vslf;
253 184
        struct vbitmap *tags = NULL;
254
        char errbuf[VRE_ERROR_LEN];
255
256
257 184
        CHECK_OBJ_NOTNULL(vsl, VSL_MAGIC);
258 184
        AN(arg);
259 184
        vsl->flags |= F_SEEN_ixIX;
260
261 184
        b = arg;
262 184
        e = strchr(b, ':');
263 184
        if (e) {
264 69
                tags = vbit_new(SLT__MAX);
265 69
                AN(tags);
266 69
                l = e - b;
267 69
                i = VSL_List2Tags(b, l, vsl_vbm_bitset, tags);
268 69
                if (i < 0)
269 69
                        vbit_destroy(tags);
270 69
                if (i == -1)
271 46
                        return (vsl_diag(vsl,
272
                            "-%c: \"%*.*s\" matches zero tags",
273 23
                            (char)opt, l, l, b));
274 46
                else if (i == -2)
275 46
                        return (vsl_diag(vsl,
276
                            "-%c: \"%*.*s\" is ambiguous",
277 23
                            (char)opt, l, l, b));
278 23
                else if (i <= -3)
279 46
                        return (vsl_diag(vsl,
280
                            "-%c: Syntax error in \"%*.*s\"",
281 23
                            (char)opt, l, l, b));
282 0
                b = e + 1;
283 0
        }
284
285 115
        vre = VRE_compile(b, vsl->C_opt ? VRE_CASELESS : 0, &err, &off, 1);
286 115
        if (vre == NULL) {
287 23
                if (tags)
288 0
                        vbit_destroy(tags);
289 23
                AN(VSB_init(vsb, errbuf, sizeof errbuf));
290 23
                AZ(VRE_error(vsb, err));
291 23
                AZ(VSB_finish(vsb));
292 23
                VSB_fini(vsb);
293 46
                return (vsl_diag(vsl, "-%c: Regex error at position %d (%s)",
294 23
                    (char)opt, off, errbuf));
295
        }
296
297 92
        ALLOC_OBJ(vslf, VSLF_MAGIC);
298 92
        AN(vslf);
299 92
        vslf->tags = tags;
300 92
        vslf->vre = vre;
301
302 92
        if (opt == 'I')
303 46
                VTAILQ_INSERT_TAIL(&vsl->vslf_select, vslf, list);
304
        else {
305 46
                assert(opt == 'X');
306 46
                VTAILQ_INSERT_TAIL(&vsl->vslf_suppress, vslf, list);
307
        }
308
309 92
        return (1);
310 184
}
311
312
static int
313 253
vsl_R_arg(struct VSL_data *vsl, const char *arg)
314
{
315 253
        char buf[32] = "";
316
        char *p;
317
        long l;
318
319 253
        AN(arg);
320 253
        CHECK_OBJ_NOTNULL(vsl, VSL_MAGIC);
321
322 253
        errno = 0;
323 253
        l = strtol(arg, &p, 0);
324 253
        if ((l == LONG_MIN || l == LONG_MAX) && errno == ERANGE)
325 0
                return (vsl_diag(vsl, "-R: Range error"));
326 253
        if (l <= 0 || l > INT_MAX)
327 69
                return (vsl_diag(vsl, "-R: Range error"));
328 184
        vsl->R_opt_l = l;
329 184
        assert(p != arg);
330 184
        AN(p);
331 184
        if (*p == '\0') {
332 0
                vsl->R_opt_p = 1.0;
333 0
                return (1);
334
        }
335 184
        if (*p != '/' || p[1] == '\0')
336 23
                return (vsl_diag(vsl, "-R: Syntax error"));
337 161
        p++;
338 161
        if (strlen(p) > sizeof(buf) - 2)
339 23
                return (vsl_diag(vsl, "-R: Syntax error"));
340 138
        if (!isdigit(*p))
341 69
                strcat(buf, "1");
342 138
        strcat(buf, p);
343 138
        vsl->R_opt_p = VNUM_duration(buf);
344 138
        if (isnan(vsl->R_opt_p) || vsl->R_opt_p <= 0.0)
345 92
                return (vsl_diag(vsl, "-R: Syntax error: Invalid duration"));
346 46
        return (1);
347 253
}
348
349
int
350 3795
VSL_Arg(struct VSL_data *vsl, int opt, const char *arg)
351
{
352
        int i;
353
        char *p;
354
        double d;
355
        long l;
356
357 3795
        CHECK_OBJ_NOTNULL(vsl, VSL_MAGIC);
358
        /* If first option is 'i', set all bits for suppression */
359 3795
        if ((opt == 'i' || opt == 'I') && !(vsl->flags & F_SEEN_ixIX))
360 159597
                for (i = 0; i < SLT__MAX; i++)
361 159597
                        vbit_set(vsl->vbm_suppress, i);
362
363 3795
        switch (opt) {
364 391
        case 'b': vsl->b_opt = 1; return (1);
365 1679
        case 'c': vsl->c_opt = 1; return (1);
366
        case 'C':
367
                /* Caseless regular expressions */
368 46
                vsl->C_opt = 1;
369 46
                return (1);
370
        case 'E':
371 207
                vsl->E_opt = 1;
372 207
                vsl->c_opt = 1;
373 207
                return (1);
374 920
        case 'i': case 'x': return (vsl_ix_arg(vsl, opt, arg));
375 184
        case 'I': case 'X': return (vsl_IX_arg(vsl, opt, arg));
376
        case 'L':
377 23
                AN(arg);
378 23
                l = strtol(arg, &p, 0);
379 23
                while (isspace(*p))
380 0
                        p++;
381 23
                if (*p != '\0')
382 0
                        return (vsl_diag(vsl, "-L: Syntax error"));
383 23
                if (l <= 0 || l > INT_MAX)
384 23
                        return (vsl_diag(vsl, "-L: Range error"));
385 0
                vsl->L_opt = (int)l;
386 0
                return (1);
387
        case 'R':
388 253
                return (vsl_R_arg(vsl, arg));
389
        case 'T':
390 23
                AN(arg);
391 23
                d = VNUM(arg);
392 23
                if (isnan(d))
393 0
                        return (vsl_diag(vsl, "-T: Syntax error"));
394 23
                if (d < 0.)
395 0
                        return (vsl_diag(vsl, "-T: Range error"));
396 23
                vsl->T_opt = d;
397 23
                return (1);
398 23
        case 'v': vsl->v_opt = 1; return (1);
399
        default:
400 46
                return (0);
401
        }
402 3795
}