varnish-cache/vmod/vmod_blob_url.c
0
/*-
1
 * Copyright 2015-2016 UPLEX - Nils Goroll Systemoptimierung
2
 * All rights reserved.
3
 *
4
 * Authors: Nils Goroll <nils.goroll@uplex.de>
5
 *          Geoffrey Simmons <geoffrey.simmons@uplex.de>
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 are met:
11
 * 1. Redistributions of source code must retain the above copyright notice,
12
 *    this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright notice,
14
 *    this list of conditions and the following disclaimer in the documentation
15
 *    and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
18
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20
 * DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY
21
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 *
28
 */
29
30
#include "config.h"
31
32
#include "vdef.h"
33
#include "vrt.h"
34
#include "vas.h"
35
36
#include "vmod_blob.h"
37
38
/* Decoder states */
39
enum state_e {
40
        NORMAL,
41
        PERCENT,  /* just read '%' */
42
        FIRSTNIB, /* just read the first nibble after '%' */
43
};
44
45
size_t
46 56
url_encode_l(size_t l)
47
{
48 56
        return ((l * 3) + 1);
49
}
50
51
size_t
52 268
url_decode_l(size_t l)
53
{
54 268
        return (l);
55
}
56
57
/*
58
 * Bitmap of unreserved characters according to RFC 3986 section 2.3
59
 * (locale-independent and cacheline friendly)
60
 */
61
static const uint8_t unreserved[] = {
62
        0x00, 0x00, 0x00, 0x00, 0x00, 0x60, 0xff, 0x03,
63
        0xfe, 0xff, 0xff, 0x87, 0xfe, 0xff, 0xff, 0x47,
64
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
65
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
66
};
67
68
static inline int
69 38404
isunreserved(const uint8_t c)
70
{
71 38404
        return (unreserved[c >> 3] & (1 << (c & 7)));
72
}
73
74
static inline int
75 52912
isoutofrange(const uint8_t c)
76
{
77 52912
        return (c < '0' || c > 'f');
78
}
79
80
ssize_t
81 372
url_encode(const enum encoding enc, const enum case_e kase,
82
    blob_dest_t buf, blob_len_t buflen,
83
    blob_src_t in, blob_len_t inlen)
84
{
85 372
        char *p = buf;
86 372
        const char * const end = buf + buflen;
87 372
        const char *alphabet = hex_alphabet[0];
88
        size_t i;
89
90 372
        AN(buf);
91 372
        assert(enc == URL);
92 372
        if (in == NULL || inlen == 0)
93 12
                return (0);
94
95 360
        if (kase == UPPER)
96 128
                alphabet = hex_alphabet[1];
97
98 38764
        for (i = 0; i < inlen; i++) {
99 38404
                if (isunreserved(in[i])) {
100 13064
                        if (p == end)
101 0
                                return (-1);
102 13064
                        *p++ = in[i];
103 13064
                }
104
                else {
105 25340
                        if (p + 3 > end)
106 0
                                return (-1);
107 25340
                        *p++ = '%';
108 25340
                        *p++ = alphabet[(in[i] & 0xf0) >> 4];
109 25340
                        *p++ = alphabet[in[i] & 0x0f];
110
                }
111 38404
        }
112
113 360
        return (p - buf);
114 372
}
115
116
ssize_t
117 468
url_decode(const enum encoding dec, blob_dest_t buf,
118
    blob_len_t buflen, ssize_t n, VCL_STRANDS strings)
119
{
120 468
        char *dest = buf;
121 468
        const char * const end = buf + buflen;
122
        const char *s;
123 468
        size_t len = SIZE_MAX;
124 468
        uint8_t nib = 0, nib2;
125 468
        enum state_e state = NORMAL;
126
        int i;
127
128 468
        AN(buf);
129 468
        AN(strings);
130 468
        assert(dec == URL);
131
132 468
        if (n >= 0)
133 212
                len = n;
134
135 1072
        for (i = 0; len > 0 && i < strings->n; i++) {
136 632
                s = strings->p[i];
137
138 632
                if (s == NULL || *s == '\0')
139 128
                        continue;
140 93748
                while (*s && len) {
141 93272
                        switch (state) {
142
                        case NORMAL:
143 40360
                                if (*s == '%')
144 26492
                                        state = PERCENT;
145
                                else {
146 13868
                                        if (dest == end) {
147 4
                                                errno = ENOMEM;
148 4
                                                return (-1);
149
                                        }
150 13864
                                        *dest++ = *s;
151
                                }
152 40356
                                break;
153
                        case PERCENT:
154 26472
                                if (isoutofrange(*s) ||
155 26460
                                    (nib = hex_nibble[*s - '0']) == ILL) {
156 12
                                        errno = EINVAL;
157 12
                                        return (-1);
158
                                }
159 26460
                                state = FIRSTNIB;
160 26460
                                break;
161
                        case FIRSTNIB:
162 26440
                                if (dest == end) {
163 0
                                        errno = ENOMEM;
164 0
                                        return (-1);
165
                                }
166 26440
                                if (isoutofrange(*s) ||
167 26428
                                    (nib2 = hex_nibble[*s - '0']) == ILL) {
168 12
                                        errno = EINVAL;
169 12
                                        return (-1);
170
                                }
171 26428
                                *dest++ = (nib << 4) | nib2;
172 26428
                                nib = 0;
173 26428
                                state = NORMAL;
174 26428
                                break;
175
                        default:
176 0
                                WRONG("illegal URL decode state");
177 0
                        }
178 93244
                        s++;
179 93244
                        len--;
180
                }
181 476
        }
182 440
        if (state != NORMAL) {
183 40
                errno = EINVAL;
184 40
                return (-1);
185
        }
186 400
        assert(dest <= end);
187 400
        return (dest - buf);
188 468
}