varnish-cache/vmod/vmod_cookie.c
0
/*-
1
 * Copyright (c) 2012-2020 Varnish Software AS
2
 *
3
 * Author: Lasse Karstensen <lasse.karstensen@gmail.com>
4
 * Author: Lasse Karstensen <lkarsten@varnish-software.com>
5
 * Author: Dridi Boukelmoune <dridi.boukelmoune@gmail.com>
6
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 *
30
 * Cookie VMOD that simplifies handling of the Cookie request header.
31
 */
32
33
#include "config.h"
34
35
#include <stdlib.h>
36
#include <stdio.h>
37
#include <string.h>
38
#include <ctype.h>
39
#include <pthread.h>
40
41
#include <cache/cache.h>
42
43
#include <vsb.h>
44
45
#include "vcc_cookie_if.h"
46
47
enum filter_action {
48
        blacklist,
49
        whitelist
50
};
51
52
struct cookie {
53
        unsigned                magic;
54
#define VMOD_COOKIE_ENTRY_MAGIC 0x3BB41543
55
        const char              *name;
56
        const char              *value;
57
        VTAILQ_ENTRY(cookie)    list;
58
};
59
60
/* A structure to represent both whitelists and blacklists */
61
struct matchlist {
62
        char                    *name;
63
        VTAILQ_ENTRY(matchlist) list;
64
};
65
66
struct vmod_cookie {
67
        unsigned                magic;
68
#define VMOD_COOKIE_MAGIC       0x4EE5FB2E
69
        VTAILQ_HEAD(, cookie)   cookielist;
70
};
71
72
static void
73 2108
cobj_free(VRT_CTX, void *p)
74
{
75
        struct vmod_cookie *vcp;
76
77 2108
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
78 2108
        CAST_OBJ_NOTNULL(vcp, p, VMOD_COOKIE_MAGIC);
79 2108
        FREE_OBJ(vcp);
80 2108
}
81
82
static const struct vmod_priv_methods cookie_cobj_priv_methods[1] = {{
83
        .magic = VMOD_PRIV_METHODS_MAGIC,
84
        .type = "vmod_cookie_cobj",
85
        .fini = cobj_free
86
}};
87
88
static struct vmod_cookie *
89 9894
cobj_get(struct vmod_priv *priv)
90
{
91
        struct vmod_cookie *vcp;
92
93 9894
        if (priv->priv == NULL) {
94 2108
                ALLOC_OBJ(vcp, VMOD_COOKIE_MAGIC);
95 2108
                AN(vcp);
96 2108
                VTAILQ_INIT(&vcp->cookielist);
97 2108
                priv->priv = vcp;
98 2108
                priv->methods = cookie_cobj_priv_methods;
99 2108
        } else
100 7786
                CAST_OBJ_NOTNULL(vcp, priv->priv, VMOD_COOKIE_MAGIC);
101
102 9894
        return (vcp);
103
}
104
105
VCL_VOID
106 1904
vmod_parse(VRT_CTX, struct vmod_priv *priv, VCL_STRING cookieheader)
107
{
108 1904
        struct vmod_cookie *vcp = cobj_get(priv);
109
        char *name, *value;
110
        const char *p, *sep;
111 1904
        int i = 0;
112
113 1904
        if (cookieheader == NULL || *cookieheader == '\0') {
114 68
                VSLb(ctx->vsl, SLT_Debug, "cookie: nothing to parse");
115 68
                return;
116
        }
117
118
        /* If called twice during the same request, clean out old state. */
119 1836
        if (!VTAILQ_EMPTY(&vcp->cookielist))
120 102
                vmod_clean(ctx, priv);
121
122 1836
        p = cookieheader;
123 3604
        while (*p != '\0') {
124 5270
                while (isspace(*p))
125 1700
                        p++;
126 3570
                sep = strchr(p, '=');
127 3570
                if (sep == NULL)
128 0
                        break;
129 3570
                name = strndup(p, pdiff(p, sep));
130 3570
                p = sep + 1;
131
132 3570
                sep = p;
133 313242
                while (*sep != '\0' && *sep != ';')
134 309672
                        sep++;
135 3570
                value = strndup(p, pdiff(p, sep));
136
137 3570
                vmod_set(ctx, priv, name, value);
138 3570
                free(name);
139 3570
                free(value);
140 3570
                i++;
141 3570
                if (*sep == '\0')
142 1802
                        break;
143 1768
                p = sep + 1;
144
        }
145
146 1836
        VSLb(ctx->vsl, SLT_Debug, "cookie: parsed %i cookies.", i);
147 1904
}
148
149
static struct cookie *
150 4760
find_cookie(const struct vmod_cookie *vcp, VCL_STRING name)
151
{
152
        struct cookie *cookie;
153
154 7752
        VTAILQ_FOREACH(cookie, &vcp->cookielist, list) {
155 3230
                CHECK_OBJ_NOTNULL(cookie, VMOD_COOKIE_ENTRY_MAGIC);
156 3230
                if (!strcmp(cookie->name, name))
157 238
                        break;
158 2992
        }
159 4760
        return (cookie);
160
}
161
162
VCL_VOID
163 4556
vmod_set(VRT_CTX, struct vmod_priv *priv, VCL_STRING name, VCL_STRING value)
164
{
165 4556
        struct vmod_cookie *vcp = cobj_get(priv);
166
        struct cookie *cookie;
167
        const char *p;
168
169 4556
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
170 4556
        CHECK_OBJ_NOTNULL(ctx->ws, WS_MAGIC);
171
172
        /* Empty cookies should be ignored. */
173 4556
        if (name == NULL || *name == '\0')
174 102
                return;
175 4454
        if (value == NULL || *value == '\0')
176 68
                return;
177
178 4386
        cookie = find_cookie(vcp, name);
179 4386
        if (cookie != NULL) {
180 34
                p = WS_Printf(ctx->ws, "%s", value);
181 34
                if (p == NULL) {
182 0
                        VSLb(ctx->vsl, SLT_Error,
183
                            "cookie: Workspace overflow in set()");
184 0
                } else
185 34
                        cookie->value = p;
186 34
                return;
187
        }
188
189 8704
        WS_TASK_ALLOC_OBJ(ctx, cookie, VMOD_COOKIE_ENTRY_MAGIC);
190 4352
        if (cookie == NULL)
191 0
                return;
192
193 4352
        cookie->name = WS_Printf(ctx->ws, "%s", name);
194 4352
        cookie->value = WS_Printf(ctx->ws, "%s", value);
195 4352
        if (cookie->name == NULL || cookie->value == NULL) {
196 0
                VSLb(ctx->vsl, SLT_Error,
197
                    "cookie: unable to get storage for cookie");
198 0
                return;
199
        }
200 4352
        VTAILQ_INSERT_TAIL(&vcp->cookielist, cookie, list);
201 4556
}
202
203
VCL_BOOL
204 204
vmod_isset(VRT_CTX, struct vmod_priv *priv, const char *name)
205
{
206 204
        struct vmod_cookie *vcp = cobj_get(priv);
207
        struct cookie *cookie;
208
209 204
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
210 204
        if (name == NULL || *name == '\0')
211 68
                return (0);
212
213 136
        cookie = find_cookie(vcp, name);
214 136
        return (cookie ? 1 : 0);
215 204
}
216
217
VCL_STRING
218 136
vmod_get(VRT_CTX, struct vmod_priv *priv, VCL_STRING name)
219
{
220 136
        struct vmod_cookie *vcp = cobj_get(priv);
221
        struct cookie *cookie;
222
223 136
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
224 136
        if (name == NULL || *name == '\0')
225 0
                return (NULL);
226
227 136
        cookie = find_cookie(vcp, name);
228 136
        return (cookie ? cookie->value : NULL);
229 136
}
230
231
232
VCL_STRING
233 136
vmod_get_re(VRT_CTX, struct vmod_priv *priv, VCL_REGEX re)
234
{
235 136
        struct vmod_cookie *vcp = cobj_get(priv);
236 136
        struct cookie *cookie = NULL;
237
        struct cookie *current;
238
        unsigned match;
239
240 136
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
241 136
        AN(re);
242
243 340
        VTAILQ_FOREACH(current, &vcp->cookielist, list) {
244 272
                CHECK_OBJ_NOTNULL(current, VMOD_COOKIE_ENTRY_MAGIC);
245 272
                VSLb(ctx->vsl, SLT_Debug, "cookie: checking %s", current->name);
246 272
                match = VRT_re_match(ctx, current->name, re);
247 272
                if (!match)
248 204
                        continue;
249 68
                cookie = current;
250 68
                break;
251
        }
252
253 136
        return (cookie ? cookie->value : NULL);
254
}
255
256
VCL_VOID
257 136
vmod_delete(VRT_CTX, struct vmod_priv *priv, VCL_STRING name)
258
{
259 136
        struct vmod_cookie *vcp = cobj_get(priv);
260
        struct cookie *cookie;
261
262 136
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
263 136
        if (name == NULL || *name == '\0')
264 34
                return;
265
266 102
        cookie = find_cookie(vcp, name);
267
268 102
        if (cookie != NULL)
269 34
                VTAILQ_REMOVE(&vcp->cookielist, cookie, list);
270 136
}
271
272
VCL_VOID
273 170
vmod_clean(VRT_CTX, struct vmod_priv *priv)
274
{
275 170
        struct vmod_cookie *vcp = cobj_get(priv);
276
277 170
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
278 170
        AN(vcp);
279 170
        VTAILQ_INIT(&vcp->cookielist);
280 170
}
281
282
static void
283 204
filter_cookies(struct vmod_priv *priv, VCL_STRING list_s,
284
    enum filter_action mode)
285
{
286
        struct cookie *cookieptr, *safeptr;
287 204
        struct vmod_cookie *vcp = cobj_get(priv);
288
        struct matchlist *mlentry, *mlsafe;
289 204
        char const *p = list_s, *q;
290 204
        int matched = 0;
291
        VTAILQ_HEAD(, matchlist) matchlist_head;
292
293 204
        VTAILQ_INIT(&matchlist_head);
294
295
        /* Parse the supplied list. */
296 918
        while (p && *p != '\0') {
297 986
                while (isspace(*p))
298 272
                        p++;
299 714
                if (*p == '\0')
300 0
                        break;
301
302 714
                q = p;
303 2686
                while (*q != '\0' && *q != ',')
304 1972
                        q++;
305
306 714
                if (q == p) {
307 340
                        p++;
308 340
                        continue;
309
                }
310
311
                /* XXX: can we reserve/release lumps of txt instead of
312
                 * malloc/free?
313
                 */
314 374
                mlentry = malloc(sizeof *mlentry);
315 374
                AN(mlentry);
316 374
                mlentry->name = strndup(p, q - p);
317 374
                AN(mlentry->name);
318
319 374
                VTAILQ_INSERT_TAIL(&matchlist_head, mlentry, list);
320
321 374
                p = q;
322 374
                if (*p != '\0')
323 306
                        p++;
324
        }
325
326
        /* Filter existing cookies that either aren't in the whitelist or
327
         * are in the blacklist (depending on the filter_action) */
328 748
        VTAILQ_FOREACH_SAFE(cookieptr, &vcp->cookielist, list, safeptr) {
329 544
                CHECK_OBJ_NOTNULL(cookieptr, VMOD_COOKIE_ENTRY_MAGIC);
330 544
                matched = 0;
331
332 1122
                VTAILQ_FOREACH(mlentry, &matchlist_head, list) {
333 816
                        if (strcmp(cookieptr->name, mlentry->name) == 0) {
334 238
                                matched = 1;
335 238
                                break;
336
                        }
337 578
                }
338 544
                if (matched != mode)
339 238
                        VTAILQ_REMOVE(&vcp->cookielist, cookieptr, list);
340 544
        }
341
342 578
        VTAILQ_FOREACH_SAFE(mlentry, &matchlist_head, list, mlsafe) {
343 374
                VTAILQ_REMOVE(&matchlist_head, mlentry, list);
344 374
                free(mlentry->name);
345 374
                free(mlentry);
346 374
        }
347 204
}
348
349
VCL_VOID
350 102
vmod_keep(VRT_CTX, struct vmod_priv *priv, VCL_STRING whitelist_s)
351
{
352
353 102
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
354 102
        filter_cookies(priv, whitelist_s, whitelist);
355 102
}
356
357
358
VCL_VOID
359 102
vmod_filter(VRT_CTX, struct vmod_priv *priv, VCL_STRING blacklist_s)
360
{
361
362 102
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
363 102
        filter_cookies(priv, blacklist_s, blacklist);
364 102
}
365
366
static VCL_VOID
367 238
re_filter(VRT_CTX, struct vmod_priv *priv, VCL_REGEX re, enum filter_action mode)
368
{
369 238
        struct vmod_cookie *vcp = cobj_get(priv);
370
        struct cookie *current, *safeptr;
371
        unsigned match;
372
373 238
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
374 238
        AN(re);
375
376 884
        VTAILQ_FOREACH_SAFE(current, &vcp->cookielist, list, safeptr) {
377 646
                CHECK_OBJ_NOTNULL(current, VMOD_COOKIE_ENTRY_MAGIC);
378
379 646
                match = VRT_re_match(ctx, current->name, re);
380
381 646
                switch (mode) {
382
                case blacklist:
383 374
                        if (!match)
384 272
                                continue;
385 204
                        VSLb(ctx->vsl, SLT_Debug,
386
                            "Removing matching cookie %s (value: %s)",
387 102
                            current->name, current->value);
388 102
                        VTAILQ_REMOVE(&vcp->cookielist, current, list);
389 102
                        break;
390
                case whitelist:
391 272
                        if (match)
392 170
                                continue;
393
394 204
                        VSLb(ctx->vsl, SLT_Debug,
395
                            "Removing cookie %s (value: %s)",
396 102
                            current->name, current->value);
397 102
                        VTAILQ_REMOVE(&vcp->cookielist, current, list);
398 102
                        break;
399
                default:
400 0
                        WRONG("invalid mode");
401 0
                }
402 204
        }
403 238
}
404
405
406
VCL_VOID
407 102
vmod_keep_re(VRT_CTX, struct vmod_priv *priv, VCL_REGEX re)
408
{
409
410 102
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
411 102
        re_filter(ctx, priv, re, whitelist);
412 102
}
413
414
415
VCL_VOID
416 136
vmod_filter_re(VRT_CTX, struct vmod_priv *priv, VCL_REGEX re)
417
{
418
419 136
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
420 136
        re_filter(ctx, priv, re, blacklist);
421 136
}
422
423
424
VCL_STRING
425 2210
vmod_get_string(VRT_CTX, struct vmod_priv *priv)
426
{
427
        struct cookie *curr;
428
        struct vsb output[1];
429 2210
        struct vmod_cookie *vcp = cobj_get(priv);
430 2210
        const char *sep = "", *res;
431
432 2210
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
433 2210
        CHECK_OBJ_NOTNULL(ctx->ws, WS_MAGIC);
434 2210
        WS_VSB_new(output, ctx->ws);
435
436 6052
        VTAILQ_FOREACH(curr, &vcp->cookielist, list) {
437 3842
                CHECK_OBJ_NOTNULL(curr, VMOD_COOKIE_ENTRY_MAGIC);
438 3842
                AN(curr->name);
439 3842
                AN(curr->value);
440 3842
                VSB_printf(output, "%s%s=%s", sep, curr->name, curr->value);
441 3842
                sep = "; ";
442 3842
        }
443 2210
        res = WS_VSB_finish(output, ctx->ws, NULL);
444 2210
        if (res == NULL)
445 0
                VSLb(ctx->vsl, SLT_Error, "cookie: Workspace overflow");
446 2210
        return (res);
447
}
448
449
VCL_STRING
450 34
vmod_format_date(VRT_CTX, VCL_TIME ts, VCL_DURATION duration)
451
{
452
453 34
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
454 34
        return (VRT_TIME_string(ctx, ts + duration));
455
}