vinyl-cache/vmod/vmod_std.c
0
/*-
1
 * Copyright (c) 2010-2017 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Poul-Henning Kamp <phk@FreeBSD.org>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 */
29
30
#include "config.h"
31
32
#include <sys/stat.h>
33
34
#include <netinet/in.h>
35
36
#include <ctype.h>
37
#include <stdlib.h>
38
#include <string.h>
39
#include <syslog.h>
40
#include <sys/socket.h>
41
#include <fnmatch.h>
42
43
#include "cache/cache.h"
44
45
#include "vrnd.h"
46
#include "vtcp.h"
47
#include "vsa.h"
48
#include "vtim.h"
49
#include "vcl.h"
50
51
#include "vcc_std_if.h"
52
53
VCL_VOID v_matchproto_(td_std_set_ip_tos)
54 6
vmod_set_ip_tos(VRT_CTX, VCL_INT tos)
55
{
56
        struct suckaddr *sa;
57 6
        int fam, itos = tos;
58
59 6
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
60 6
        AZ(SES_Get_local_addr(ctx->req->sp, &sa));
61
        /* Silently ignore for non-IP addresses. */
62 6
        if (VSA_Compare(sa, bogo_ip) == 0)
63 3
                return;
64 3
        fam = VSA_Get_Proto(sa);
65 3
        switch (fam) {
66
        case PF_INET:
67 3
                VTCP_Assert(setsockopt(ctx->req->sp->fd,
68
                    IPPROTO_IP, IP_TOS, &itos, sizeof(itos)));
69 3
                break;
70
        case PF_INET6:
71 0
                VTCP_Assert(setsockopt(ctx->req->sp->fd,
72
                    IPPROTO_IPV6, IPV6_TCLASS, &itos, sizeof(itos)));
73 0
                break;
74
        default:
75 0
                INCOMPL();
76 0
        }
77 6
}
78
79
static const char *
80 36
vmod_updown(VRT_CTX, int up, VCL_STRANDS s)
81
{
82
        unsigned u;
83
        char *b, *e;
84
        const char *p;
85
        int i;
86
87 36
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
88 36
        CHECK_OBJ_NOTNULL(s, STRANDS_MAGIC);
89 36
        u = WS_ReserveAll(ctx->ws);
90 36
        e = b = WS_Reservation(ctx->ws);
91 36
        e += u;
92 72
        for (i = 0; i < s->n && b < e; i++) {
93 36
                p = s->p[i];
94 6582
                while (p != NULL && *p != '\0' && b < e) {
95 6546
                        if (up)
96 3246
                                *b++ = (char)toupper(*p++);
97
                        else
98 3300
                                *b++ = (char)tolower(*p++);
99
                }
100 36
        }
101 36
        if (b < e)
102 36
                *b = '\0';
103 36
        b++;
104 36
        if (b > e) {
105 0
                WS_MarkOverflow(ctx->ws);
106 0
                WS_Release(ctx->ws, 0);
107 0
                return (NULL);
108
        } else {
109 36
                e = b;
110 36
                b = WS_Reservation(ctx->ws);
111 36
                WS_Release(ctx->ws, e - b);
112 36
                return (b);
113
        }
114 36
}
115
116
VCL_STRING v_matchproto_(td_std_toupper)
117 12
vmod_toupper(VRT_CTX, VCL_STRANDS s)
118
{
119
120 12
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
121 12
        return (vmod_updown(ctx, 1, s));
122
}
123
124
VCL_STRING v_matchproto_(td_std_tolower)
125 24
vmod_tolower(VRT_CTX, VCL_STRANDS s)
126
{
127
128 24
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
129 24
        return (vmod_updown(ctx, 0, s));
130
}
131
132
VCL_REAL v_matchproto_(td_std_random)
133 18
vmod_random(VRT_CTX, VCL_REAL lo, VCL_REAL hi)
134
{
135
        double a;
136
137 18
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
138 18
        a = VRND_RandomTestableDouble();
139 18
        a *= hi - lo;
140 18
        a += lo;
141 18
        return (a);
142
}
143
144
VCL_VOID v_matchproto_(td_std_log)
145 447
vmod_log(VRT_CTX, VCL_STRANDS s)
146
{
147 447
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
148
149 447
        if (ctx->vsl != NULL)
150 348
                VSLbs(ctx->vsl, SLT_VCL_Log, s);
151
        else
152 99
                VSLs(SLT_VCL_Log, NO_VXID, s);
153 447
}
154
155
/* XXX use vsyslog() ? */
156
VCL_VOID v_matchproto_(td_std_syslog)
157 15
vmod_syslog(VRT_CTX, VCL_INT fac, VCL_STRANDS s)
158
{
159
        const char *p;
160
        uintptr_t sn;
161
162 15
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
163 15
        sn = WS_Snapshot(ctx->ws);
164 15
        p = VRT_StrandsWS(ctx->ws, NULL, s);
165 15
        if (p != NULL)
166 12
                syslog((int)fac, "%s", p);
167 15
        WS_Reset(ctx->ws, sn);
168 15
}
169
170
VCL_BOOL v_matchproto_(td_std_file_exists)
171 6
vmod_file_exists(VRT_CTX, VCL_STRING file_name)
172
{
173
        struct stat st;
174
175 6
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
176 6
        return (stat(file_name, &st) == 0);
177
}
178
179
VCL_VOID v_matchproto_(td_std_collect)
180 39
vmod_collect(VRT_CTX, VCL_HEADER hdr, VCL_STRING sep)
181
{
182
        struct http *hp;
183
184 39
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
185 39
        if (hdr == NULL) {
186 0
                VRT_fail(ctx, "std.collect(): header argument is NULL");
187 0
                return;
188
        }
189 39
        hp = VRT_selecthttp(ctx, hdr->where);
190 39
        if (hp == NULL) {
191 3
                VRT_fail(ctx, "std.collect(): header argument "
192
                    "cannot be used here");
193 3
                return;
194
        }
195 36
        http_CollectHdrSep(hp, hdr->what, sep);
196 39
}
197
198
VCL_BOOL v_matchproto_(td_std_healthy)
199 111
vmod_healthy(VRT_CTX, VCL_BACKEND be)
200
{
201 111
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
202 111
        CHECK_OBJ_ORNULL(be, DIRECTOR_MAGIC);
203 111
        return (VRT_Healthy(ctx, be, NULL));
204
}
205
206
VCL_INT v_matchproto_(td_std_port)
207 336
vmod_port(VRT_CTX, VCL_IP ip)
208
{
209 336
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
210 336
        if (ip == NULL)
211 0
                return (0);
212 336
        return (VSA_Port(ip));
213 336
}
214
215
VCL_VOID v_matchproto_(td_std_rollback)
216 69
vmod_rollback(VRT_CTX, VCL_HTTP hp)
217
{
218 69
        VRT_Rollback(ctx, hp);
219 69
}
220
221
VCL_VOID v_matchproto_(td_std_timestamp)
222 63
vmod_timestamp(VRT_CTX, VCL_STRING label)
223
{
224
225 63
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
226 63
        if (label == NULL)
227 0
                return;
228 63
        if (*label == '\0')
229 0
                return;
230 63
        if (ctx->bo != NULL && ctx->req == NULL) {
231
                /* Called from backend vcl methods */
232 3
                CHECK_OBJ_NOTNULL(ctx->bo, BUSYOBJ_MAGIC);
233 3
                VSLb_ts_busyobj(ctx->bo, label, VTIM_real());
234 63
        } else if (ctx->req != NULL) {
235
                /* Called from request vcl methods */
236 57
                CHECK_OBJ(ctx->req, REQ_MAGIC);
237 57
                VSLb_ts_req(ctx->req, label, VTIM_real());
238 57
        }
239 63
}
240
241
VCL_BOOL v_matchproto_(td_std_cache_req_body)
242 126
vmod_cache_req_body(VRT_CTX, VCL_BYTES size)
243
{
244 126
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
245 126
        size = vmax_t(VCL_BYTES, size, 0);
246 126
        if (VRT_CacheReqBody(ctx, (size_t)size) < 0)
247 18
                return (0);
248 108
        return (1);
249 126
}
250
251
VCL_STRING v_matchproto_(td_std_strstr)
252 9
vmod_strstr(VRT_CTX, VCL_STRING s1, VCL_STRING s2)
253
{
254 9
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
255 9
        if (s1 == NULL || s2 == NULL)
256 3
                return (NULL);
257 6
        return (strstr(s1, s2));
258 9
}
259
260
VCL_STRING v_matchproto_(td_std_getenv)
261 15
vmod_getenv(VRT_CTX, VCL_STRING name, VCL_STRING fallback)
262
{
263
        const char *val;
264
265 15
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
266 15
        if (name == NULL || *name == '\0')
267 3
                return (NULL);
268
269 12
        val = getenv(name);
270 12
        if (val == NULL)
271 6
                return (fallback);
272 6
        return (val);
273 15
}
274
275
VCL_VOID v_matchproto_(td_std_late_100_continue)
276 15
vmod_late_100_continue(VRT_CTX, VCL_BOOL late)
277
{
278 15
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
279 15
        assert(ctx->method == VCL_MET_RECV);
280 15
        CHECK_OBJ_NOTNULL(ctx->req, REQ_MAGIC);
281 15
        if (ctx->req->want100cont)
282 15
                ctx->req->late100cont = late;
283 15
}
284
285
VCL_BOOL v_matchproto_(td_std_syntax)
286 18
vmod_syntax(VRT_CTX, VCL_REAL r)
287
{
288
289 18
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
290 18
        assert(ctx->syntax == 40 || ctx->syntax == 41);
291
        /*
292
         * We need to be careful because non-integer numbers have imprecise
293
         * IEE754 representation (4.1 is 0x1.0666666666666p+2 = 4.09999...)
294
         * By scaling up and rounding, this is taken care of.
295
         */
296 18
        return (round(r * 10) <= ctx->syntax);
297
}
298
299
VCL_BOOL v_matchproto_(td_std_fnmatch)
300 186
vmod_fnmatch(VRT_CTX, VCL_STRING pattern, VCL_STRING subject,
301
             VCL_BOOL pathname, VCL_BOOL noescape, VCL_BOOL period)
302
{
303 186
        int flags = 0;
304
305 186
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
306 186
        if (pattern == NULL) {
307 3
                VRT_fail(ctx, "std.fnmatch(): pattern is NULL");
308 3
                return (0);
309
        }
310 183
        if (subject == NULL) {
311 3
                VRT_fail(ctx, "std.fnmatch(): subject is NULL");
312 3
                return (0);
313
        }
314
315 180
        if (pathname)
316 135
                flags |= FNM_PATHNAME;
317 180
        if (noescape)
318 45
                flags |= FNM_NOESCAPE;
319 180
        if (period)
320 45
                flags |= FNM_PERIOD;
321 180
        return (fnmatch(pattern, subject, flags) != FNM_NOMATCH);
322 186
}
323
324
static const void * const priv_task_id_ban = &priv_task_id_ban;
325
326
VCL_BOOL v_matchproto_(td_std_ban)
327 66
vmod_ban(VRT_CTX, VCL_STRING s)
328
{
329
        struct vmod_priv *priv_task;
330
        VCL_STRING r;
331
332 66
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
333
334 66
        r = VRT_ban_string(ctx, s);
335 66
        priv_task = VRT_priv_task_get(ctx, priv_task_id_ban);
336
337 66
        if (r == NULL && priv_task == NULL)
338 30
                return (1);
339
340 36
        if (priv_task == NULL)
341 6
                priv_task = VRT_priv_task(ctx, priv_task_id_ban);
342
343 36
        if (priv_task == NULL) {
344 0
                VRT_fail(ctx, "std.ban(): no priv_task (out of workspace?)");
345 0
                return (0);
346
        }
347
348
        /*
349
         * TRUST_ME: the ban error is const. We save it in the un-const priv
350
         * pointer, but promise to only ever return it as a (const) VCL_STRING
351
         */
352 36
        priv_task->priv = TRUST_ME(r);
353
354 36
        return (r == NULL);
355 66
}
356
357
VCL_STRING v_matchproto_(td_std_ban_error)
358 36
vmod_ban_error(VRT_CTX)
359
{
360
        struct vmod_priv *priv_task;
361
        VCL_STRING r;
362
363 36
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
364
365 36
        priv_task = VRT_priv_task_get(ctx, priv_task_id_ban);
366 36
        if (priv_task == NULL)
367 0
                return ("");
368
369 36
        r = priv_task->priv;
370 36
        if (r == NULL)
371 3
                r = "";
372 36
        return (r);
373 36
}
374
375
VCL_TIME v_matchproto_(td_std_now)
376 6
vmod_now(VRT_CTX)
377
{
378
379 6
        (void) ctx;
380 6
        return (VTIM_real());
381
}
382
383
VCL_DURATION v_matchproto_(td_std_timed_call)
384 3
vmod_timed_call(VRT_CTX, VCL_SUB sub)
385
{
386
        vtim_mono b;
387
388 3
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
389 3
        b = VTIM_mono();
390 3
        VRT_call(ctx, sub);
391 3
        return (VTIM_mono() - b);
392
}
393
394
VCL_VOID v_matchproto_(td_std_rfc_ttl)
395 6
vmod_rfc_ttl(VRT_CTX)
396
{
397
        struct busyobj *bo;
398
        struct objcore *oc;
399
400 6
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
401
        // $Restrict guarantees
402 6
        bo = ctx->bo;
403 6
        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
404 6
        oc = bo->fetch_objcore;
405 6
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
406
407 12
        RFC2616_Ttl(bo, ctx->now,
408 6
             &oc->t_origin,
409 6
             &oc->ttl,
410 6
             &oc->grace,
411 6
             &oc->keep);
412 6
}