varnish-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 80
vmod_set_ip_tos(VRT_CTX, VCL_INT tos)
55
{
56
        struct suckaddr *sa;
57 80
        int fam, itos = tos;
58
59 80
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
60 80
        AZ(SES_Get_local_addr(ctx->req->sp, &sa));
61
        /* Silently ignore for non-IP addresses. */
62 80
        if (VSA_Compare(sa, bogo_ip) == 0)
63 40
                return;
64 40
        fam = VSA_Get_Proto(sa);
65 40
        switch (fam) {
66
        case PF_INET:
67 40
                VTCP_Assert(setsockopt(ctx->req->sp->fd,
68
                    IPPROTO_IP, IP_TOS, &itos, sizeof(itos)));
69 40
                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 80
}
78
79
static const char *
80 480
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 480
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
88 480
        u = WS_ReserveAll(ctx->ws);
89 480
        e = b = WS_Reservation(ctx->ws);
90 480
        e += u;
91 960
        for (i = 0; i < s->n && b < e; i++) {
92 480
                p = s->p[i];
93 87760
                while (p != NULL && *p != '\0' && b < e) {
94 87280
                        if (up)
95 43280
                                *b++ = (char)toupper(*p++);
96
                        else
97 44000
                                *b++ = (char)tolower(*p++);
98
                }
99 480
        }
100 480
        if (b < e)
101 480
                *b = '\0';
102 480
        b++;
103 480
        if (b > e) {
104 0
                WS_MarkOverflow(ctx->ws);
105 0
                WS_Release(ctx->ws, 0);
106 0
                return (NULL);
107
        } else {
108 480
                e = b;
109 480
                b = WS_Reservation(ctx->ws);
110 480
                WS_Release(ctx->ws, e - b);
111 480
                return (b);
112
        }
113 480
}
114
115
VCL_STRING v_matchproto_(td_std_toupper)
116 160
vmod_toupper(VRT_CTX, VCL_STRANDS s)
117
{
118
119 160
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
120 160
        return (vmod_updown(ctx, 1, s));
121
}
122
123
VCL_STRING v_matchproto_(td_std_tolower)
124 320
vmod_tolower(VRT_CTX, VCL_STRANDS s)
125
{
126
127 320
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
128 320
        return (vmod_updown(ctx, 0, s));
129
}
130
131
VCL_REAL v_matchproto_(td_std_random)
132 200
vmod_random(VRT_CTX, VCL_REAL lo, VCL_REAL hi)
133
{
134
        double a;
135
136 200
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
137 200
        a = VRND_RandomTestableDouble();
138 200
        a *= hi - lo;
139 200
        a += lo;
140 200
        return (a);
141
}
142
143
VCL_VOID v_matchproto_(td_std_log)
144 5839
vmod_log(VRT_CTX, VCL_STRANDS s)
145
{
146 5839
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
147
148 5839
        if (ctx->vsl != NULL)
149 4399
                VSLbs(ctx->vsl, SLT_VCL_Log, s);
150
        else
151 1440
                VSLs(SLT_VCL_Log, NO_VXID, s);
152 5839
}
153
154
/* XXX use vsyslog() ? */
155
VCL_VOID v_matchproto_(td_std_syslog)
156 200
vmod_syslog(VRT_CTX, VCL_INT fac, VCL_STRANDS s)
157
{
158
        const char *p;
159
        uintptr_t sn;
160
161 200
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
162 200
        sn = WS_Snapshot(ctx->ws);
163 200
        p = VRT_StrandsWS(ctx->ws, NULL, s);
164 200
        if (p != NULL)
165 160
                syslog((int)fac, "%s", p);
166 200
        WS_Reset(ctx->ws, sn);
167 200
}
168
169
VCL_BOOL v_matchproto_(td_std_file_exists)
170 80
vmod_file_exists(VRT_CTX, VCL_STRING file_name)
171
{
172
        struct stat st;
173
174 80
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
175 80
        return (stat(file_name, &st) == 0);
176
}
177
178
VCL_VOID v_matchproto_(td_std_collect)
179 520
vmod_collect(VRT_CTX, VCL_HEADER hdr, VCL_STRING sep)
180
{
181
        struct http *hp;
182
183 520
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
184 520
        if (hdr == NULL) {
185 0
                VRT_fail(ctx, "std.collect(): header argument is NULL");
186 0
                return;
187
        }
188 520
        hp = VRT_selecthttp(ctx, hdr->where);
189 520
        if (hp == NULL) {
190 40
                VRT_fail(ctx, "std.collect(): header argument "
191
                    "can not be used here");
192 40
                return;
193
        }
194 480
        http_CollectHdrSep(hp, hdr->what, sep);
195 520
}
196
197
VCL_BOOL v_matchproto_(td_std_healthy)
198 1480
vmod_healthy(VRT_CTX, VCL_BACKEND be)
199
{
200 1480
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
201 1480
        CHECK_OBJ_ORNULL(be, DIRECTOR_MAGIC);
202 1480
        return (VRT_Healthy(ctx, be, NULL));
203
}
204
205
VCL_INT v_matchproto_(td_std_port)
206 3000
vmod_port(VRT_CTX, VCL_IP ip)
207
{
208 3000
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
209 3000
        if (ip == NULL)
210 0
                return (0);
211 3000
        return (VSA_Port(ip));
212 3000
}
213
214
VCL_VOID v_matchproto_(td_std_rollback)
215 920
vmod_rollback(VRT_CTX, VCL_HTTP hp)
216
{
217 920
        VRT_Rollback(ctx, hp);
218 920
}
219
220
VCL_VOID v_matchproto_(td_std_timestamp)
221 840
vmod_timestamp(VRT_CTX, VCL_STRING label)
222
{
223
224 840
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
225 840
        if (label == NULL)
226 0
                return;
227 840
        if (*label == '\0')
228 0
                return;
229 840
        if (ctx->bo != NULL && ctx->req == NULL) {
230
                /* Called from backend vcl methods */
231 40
                CHECK_OBJ_NOTNULL(ctx->bo, BUSYOBJ_MAGIC);
232 40
                VSLb_ts_busyobj(ctx->bo, label, VTIM_real());
233 840
        } else if (ctx->req != NULL) {
234
                /* Called from request vcl methods */
235 760
                CHECK_OBJ(ctx->req, REQ_MAGIC);
236 760
                VSLb_ts_req(ctx->req, label, VTIM_real());
237 760
        }
238 840
}
239
240
VCL_BOOL v_matchproto_(td_std_cache_req_body)
241 960
vmod_cache_req_body(VRT_CTX, VCL_BYTES size)
242
{
243 960
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
244 960
        size = vmax_t(VCL_BYTES, size, 0);
245 960
        if (VRT_CacheReqBody(ctx, (size_t)size) < 0)
246 240
                return (0);
247 720
        return (1);
248 960
}
249
250
VCL_STRING v_matchproto_(td_std_strstr)
251 120
vmod_strstr(VRT_CTX, VCL_STRING s1, VCL_STRING s2)
252
{
253 120
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
254 120
        if (s1 == NULL || s2 == NULL)
255 40
                return (NULL);
256 80
        return (strstr(s1, s2));
257 120
}
258
259
VCL_STRING v_matchproto_(td_std_getenv)
260 120
vmod_getenv(VRT_CTX, VCL_STRING name)
261
{
262 120
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
263 120
        if (name == NULL || *name == '\0')
264 40
                return (NULL);
265 80
        return (getenv(name));
266 120
}
267
268
VCL_VOID v_matchproto_(td_std_late_100_continue)
269 200
vmod_late_100_continue(VRT_CTX, VCL_BOOL late)
270
{
271 200
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
272 200
        if (ctx->method != VCL_MET_RECV) {
273 0
                VSLb(ctx->vsl, SLT_VCL_Error,
274
                    "std.late_100_continue() only valid in vcl_recv{}");
275 0
                return;
276
        }
277
278 200
        CHECK_OBJ_NOTNULL(ctx->req, REQ_MAGIC);
279 200
        if (ctx->req->want100cont)
280 200
                ctx->req->late100cont = late;
281 200
}
282
283
VCL_BOOL v_matchproto_(td_std_syntax)
284 240
vmod_syntax(VRT_CTX, VCL_REAL r)
285
{
286
287 240
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
288 240
        assert(ctx->syntax == 40 || ctx->syntax == 41);
289
        /*
290
         * We need to be careful because non-integer numbers have imprecise
291
         * IEE754 representation (4.1 is 0x1.0666666666666p+2 = 4.09999...)
292
         * By scaling up and rounding, this is taken care of.
293
         */
294 240
        return (round(r * 10) <= ctx->syntax);
295
}
296
297
VCL_BOOL v_matchproto_(td_std_fnmatch)
298 2480
vmod_fnmatch(VRT_CTX, VCL_STRING pattern, VCL_STRING subject,
299
             VCL_BOOL pathname, VCL_BOOL noescape, VCL_BOOL period)
300
{
301 2480
        int flags = 0;
302
303 2480
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
304 2480
        if (pattern == NULL) {
305 40
                VRT_fail(ctx, "std.fnmatch(): pattern is NULL");
306 40
                return (0);
307
        }
308 2440
        if (subject == NULL) {
309 40
                VRT_fail(ctx, "std.fnmatch(): subject is NULL");
310 40
                return (0);
311
        }
312
313 2400
        if (pathname)
314 1800
                flags |= FNM_PATHNAME;
315 2400
        if (noescape)
316 600
                flags |= FNM_NOESCAPE;
317 2400
        if (period)
318 600
                flags |= FNM_PERIOD;
319 2400
        return (fnmatch(pattern, subject, flags) != FNM_NOMATCH);
320 2480
}
321
322
static const void * const priv_task_id_ban = &priv_task_id_ban;
323
324
VCL_BOOL v_matchproto_(td_std_ban)
325 880
vmod_ban(VRT_CTX, VCL_STRING s)
326
{
327
        struct vmod_priv *priv_task;
328
        VCL_STRING r;
329
330 880
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
331
332 880
        r = VRT_ban_string(ctx, s);
333 880
        priv_task = VRT_priv_task_get(ctx, priv_task_id_ban);
334
335 880
        if (r == NULL && priv_task == NULL)
336 400
                return (1);
337
338 480
        if (priv_task == NULL)
339 80
                priv_task = VRT_priv_task(ctx, priv_task_id_ban);
340
341 480
        if (priv_task == NULL) {
342 0
                VRT_fail(ctx, "std.ban(): no priv_task (out of workspace?)");
343 0
                return (0);
344
        }
345
346
        /*
347
         * TRUST_ME: the ban error is const. We save it in the un-const priv
348
         * pointer, but promise to only ever return it as a (const) VCL_STRING
349
         */
350 480
        priv_task->priv = TRUST_ME(r);
351
352 480
        return (r == NULL);
353 880
}
354
355
VCL_STRING v_matchproto_(td_std_ban_error)
356 480
vmod_ban_error(VRT_CTX)
357
{
358
        struct vmod_priv *priv_task;
359
        VCL_STRING r;
360
361 480
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
362
363 480
        priv_task = VRT_priv_task_get(ctx, priv_task_id_ban);
364 480
        if (priv_task == NULL)
365 0
                return ("");
366
367 480
        r = priv_task->priv;
368 480
        if (r == NULL)
369 40
                r = "";
370 480
        return (r);
371 480
}
372
373
VCL_TIME v_matchproto_(td_std_now)
374 80
vmod_now(VRT_CTX)
375
{
376
377 80
        (void) ctx;
378 80
        return (VTIM_real());
379
}
380
381
VCL_DURATION v_matchproto_(td_std_timed_call)
382 40
vmod_timed_call(VRT_CTX, VCL_SUB sub)
383
{
384
        vtim_mono b;
385
386 40
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
387 40
        b = VTIM_mono();
388 40
        VRT_call(ctx, sub);
389 40
        return (VTIM_mono() - b);
390
}