-
Notifications
You must be signed in to change notification settings - Fork 79
/
CanonicalUriPathTest.java
329 lines (301 loc) · 14.5 KB
/
CanonicalUriPathTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/*
* Copyright (c) 2023 Contributors to the Eclipse Foundation.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.servlet.http;
import java.io.ByteArrayOutputStream;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.CodingErrorAction;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;
import java.util.Set;
import java.util.TreeMap;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;
import java.util.stream.Stream;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
public class CanonicalUriPathTest {
private static final Set<String> ENCODED_DOT_SEGMENT;
static {
Set<String> set = Collections.newSetFromMap(new TreeMap<>(String.CASE_INSENSITIVE_ORDER));
set.add("%2e");
set.add("%2e%2e");
set.add("%2e.");
set.add(".%2e");
ENCODED_DOT_SEGMENT = Collections.unmodifiableSet(set);
}
public static String canonicalUriPath(String uriPath, Consumer<String> rejection) {
// The code presented here is a non-normative implementation of the algorithm
// from section 3.5 of the specification.
if (uriPath == null)
throw new IllegalArgumentException("null path");
String path = uriPath;
// Remember start/end conditions
boolean fragment = false;
boolean startsWithSlash;
boolean dotSegmentWithParam;
boolean encodedDotSegment;
boolean emptyNonLastSegmentWithParam;
boolean emptySegmentBeforeDotDot = false;
boolean decodeError = false;
// Discard fragment.
if (path.contains("#")) {
path = path.substring(0, path.indexOf('#'));
fragment = true;
}
// Separation of path and query.
if (path.contains("?"))
path = path.substring(0, path.indexOf('?'));
// This needs to be checked after removal of path and query
startsWithSlash = path.startsWith("/");
// Split path into segments.
List<String> segments = new ArrayList<>(Arrays.asList(path.substring(startsWithSlash ? 1 : 0).split("/", -1)));
// Remove path parameters.
emptyNonLastSegmentWithParam = segments.stream().limit(segments.size() - 1).anyMatch(s -> s.startsWith(";"));
dotSegmentWithParam = segments.stream().anyMatch(s -> s.startsWith(".;") || s.startsWith("..;"));
segments.replaceAll(s -> (s.contains(";")) ? s.substring(0, s.indexOf(';')) : s);
// Decode characters
encodedDotSegment = segments.stream().anyMatch(ENCODED_DOT_SEGMENT::contains);
try {
segments.replaceAll(CanonicalUriPathTest::decode);
} catch (Exception e) {
decodeError = true;
}
// Remove Empty Segments other than the last
AtomicInteger last = new AtomicInteger(segments.size());
segments.removeIf(s -> last.decrementAndGet() != 0 && s.length() == 0);
// Remove dot-segments
int count = 0;
for (ListIterator<String> s = segments.listIterator(); s.hasNext();) {
String segment = s.next();
if (segment.equals(".")) {
s.remove();
} else if (segment.equals("..")) {
if (count > 0) {
s.remove();
String prev = s.previous();
s.remove();
count--;
emptySegmentBeforeDotDot |= prev.length() == 0;
}
} else {
count++;
}
}
// Concatenate segments
if (segments.size() == 0)
path = "/";
else {
StringBuilder buf = new StringBuilder();
if (!decodeError && uriPath.toLowerCase().contains("%2f")) {
segments.replaceAll(CanonicalUriPathTest::encode);
}
segments.forEach(s -> buf.append("/").append(s));
path = buf.toString();
}
// Rejecting Errors and Suspicious Sequences
if (fragment)
rejection.accept("fragment");
if (decodeError)
rejection.accept("decode error");
// Any path not starting with the `"/"` character
if (!startsWithSlash)
rejection.accept("must start with /");
// Any path starting with an initial segment of `".."`
if (!segments.isEmpty() && segments.get(0).equals(".."))
rejection.accept("leading dot-dot-segment");
// The encoded `"/"` character
if (uriPath.toLowerCase().contains("%2f"))
rejection.accept("encoded /");
// Any `"."` or `".."` segment that had a path parameter
if (dotSegmentWithParam)
rejection.accept("dot segment with parameter");
// Any `"."` or `".."` segment with any encoded characters
if (encodedDotSegment)
rejection.accept("encoded dot segment");
// Any `".."` segment preceded by an empty segment
if (emptySegmentBeforeDotDot)
rejection.accept("empty segment before dot dot");
// Any empty segment with parameters
if (emptyNonLastSegmentWithParam)
rejection.accept("empty segment with parameters");
// The `"\"` character encoded or not.
if (path.contains("\\"))
rejection.accept("backslash character");
// Any control characters either encoded or not.
for (char c : path.toCharArray()) {
if (c < 0x20 || c == 0x7f) {
rejection.accept("control character");
break;
}
}
return path;
}
private static String decode(String segment) {
if (segment.contains("%")) {
StringBuilder buf = new StringBuilder();
ByteArrayOutputStream utf8 = new ByteArrayOutputStream();
for (int i = 0; i < segment.length(); i++) {
char c = segment.charAt(i);
if (c == '%') {
int b = Integer.parseInt(segment.substring(i + 1, i + 3), 16);
if (b < 0)
throw new IllegalArgumentException("negative encoding");
utf8.write(b);
i += 2;
} else {
if (utf8.size() > 0) {
buf.append(fromUtf8(utf8.toByteArray()));
utf8.reset();
}
buf.append(c);
}
}
if (utf8.size() > 0) {
buf.append(fromUtf8(utf8.toByteArray()));
utf8.reset();
}
segment = buf.toString();
}
return segment;
}
private static String encode(String segment) {
if (segment.contains("%") || segment.contains("/")) {
segment = segment.replace("%", "%25");
segment = segment.replace("/", "%2F");
}
return segment;
}
private static CharBuffer fromUtf8(byte[] bytes) {
try {
return StandardCharsets.UTF_8.newDecoder().onMalformedInput(CodingErrorAction.REPORT).decode(ByteBuffer.wrap(bytes));
} catch (CharacterCodingException e) {
throw new IllegalArgumentException(e);
}
}
private static Stream<Arguments> data() {
List<Object[]> data = new ArrayList<>();
data.add(new Object[] { "foo/bar", "/foo/bar", true });
data.add(new Object[] { "/foo/bar", "/foo/bar", false });
data.add(new Object[] { "/foo/bar;jsessionid=1234", "/foo/bar", false });
data.add(new Object[] { "/foo/bar/", "/foo/bar/", false });
data.add(new Object[] { "/foo/bar/;jsessionid=1234", "/foo/bar/", false });
data.add(new Object[] { "/foo;/bar;", "/foo/bar", false });
data.add(new Object[] { "/foo;/bar;/;", "/foo/bar/", false });
data.add(new Object[] { "/foo%00/bar/", "/foo\000/bar/", true });
data.add(new Object[] { "/foo%7Fbar", "/foo\177bar", true });
data.add(new Object[] { "/foo%2Fbar", "/foo%2Fbar", true });
data.add(new Object[] { "/foo%2Fb%25r", "/foo%2Fb%25r", true });
data.add(new Object[] { "/foo/b%25r", "/foo/b%r", false });
data.add(new Object[] { "/foo\\bar", "/foo\\bar", true });
data.add(new Object[] { "/foo%5Cbar", "/foo\\bar", true });
data.add(new Object[] { "/foo;%2F/bar", "/foo/bar", true });
data.add(new Object[] { "/foo/./bar", "/foo/bar", false });
data.add(new Object[] { "/foo/././bar", "/foo/bar", false });
data.add(new Object[] { "/./foo/bar", "/foo/bar", false });
data.add(new Object[] { "/foo/%2e/bar", "/foo/bar", true });
data.add(new Object[] { "/foo/.;/bar", "/foo/bar", true });
data.add(new Object[] { "/foo/%2e;/bar", "/foo/bar", true });
data.add(new Object[] { "/foo/.%2Fbar", "/foo/.%2Fbar", true });
data.add(new Object[] { "/foo/.%5Cbar", "/foo/.\\bar", true });
data.add(new Object[] { "/foo/bar/.", "/foo/bar", false });
data.add(new Object[] { "/foo/bar/./", "/foo/bar/", false });
data.add(new Object[] { "/foo/bar/.;", "/foo/bar", true });
data.add(new Object[] { "/foo/bar/./;", "/foo/bar/", false });
data.add(new Object[] { "/foo/.bar", "/foo/.bar", false });
data.add(new Object[] { "/foo/../bar", "/bar", false });
data.add(new Object[] { "/foo/../../bar", "/../bar", true });
data.add(new Object[] { "/../foo/bar", "/../foo/bar", true });
data.add(new Object[] { "/foo/%2e%2E/bar", "/bar", true });
data.add(new Object[] { "/foo/%2e%2e/%2E%2E/bar", "/../bar", true });
data.add(new Object[] { "/foo/./../bar", "/bar", false });
data.add(new Object[] { "/foo/..;/bar", "/bar", true });
data.add(new Object[] { "/foo/%2e%2E;/bar", "/bar", true });
data.add(new Object[] { "/foo/..%2Fbar", "/foo/..%2Fbar", true });
data.add(new Object[] { "/foo/..%5Cbar", "/foo/..\\bar", true });
data.add(new Object[] { "/foo/bar/..", "/foo", false });
data.add(new Object[] { "/foo/bar/../", "/foo/", false });
data.add(new Object[] { "/foo/bar/..;", "/foo", true });
data.add(new Object[] { "/foo/bar/../;", "/foo/", false });
data.add(new Object[] { "/foo/..bar", "/foo/..bar", false });
data.add(new Object[] { "/foo/.../bar", "/foo/.../bar", false });
data.add(new Object[] { "/foo//bar", "/foo/bar", false });
data.add(new Object[] { "//foo//bar//", "/foo/bar/", false });
data.add(new Object[] { "/;/foo;/;/bar/;/;", "/foo/bar/", true });
data.add(new Object[] { "/foo//../bar", "/bar", false });
data.add(new Object[] { "/foo/;/../bar", "/bar", true });
data.add(new Object[] { "/foo%E2%82%ACbar", "/foo€bar", false });
data.add(new Object[] { "/foo%20bar", "/foo bar", false });
data.add(new Object[] { "/foo%E2%82", "/foo%E2%82", true });
data.add(new Object[] { "/foo%E2%82bar", "/foo%E2%82bar", true });
data.add(new Object[] { "/foo%-1/bar", "/foo%-1/bar", true });
data.add(new Object[] { "/foo%XX/bar", "/foo%XX/bar", true });
data.add(new Object[] { "/foo%/bar", "/foo%/bar", true });
data.add(new Object[] { "/foo/bar%0", "/foo/bar%0", true });
data.add(new Object[] { "/good%20/bad%/%20mix%", "/good /bad%/%20mix%", true });
data.add(new Object[] { "/foo/bar?q", "/foo/bar", false });
data.add(new Object[] { "/foo/bar#f", "/foo/bar", true });
data.add(new Object[] { "/foo/bar?q#f", "/foo/bar", true });
data.add(new Object[] { "/foo/bar/?q", "/foo/bar/", false });
data.add(new Object[] { "/foo/bar/#f", "/foo/bar/", true });
data.add(new Object[] { "/foo/bar/?q#f", "/foo/bar/", true });
data.add(new Object[] { "/foo/bar;?q", "/foo/bar", false });
data.add(new Object[] { "/foo/bar;#f", "/foo/bar", true });
data.add(new Object[] { "/foo/bar;?q#f", "/foo/bar", true });
data.add(new Object[] { "/", "/", false });
data.add(new Object[] { "//", "/", false });
data.add(new Object[] { "/;/", "/", true });
data.add(new Object[] { "/.", "/", false });
data.add(new Object[] { "/..", "/..", true });
data.add(new Object[] { "/./", "/", false });
data.add(new Object[] { "/../", "/../", true });
data.add(new Object[] { "foo/bar/", "/foo/bar/", true });
data.add(new Object[] { "./foo/bar/", "/foo/bar/", true });
data.add(new Object[] { "%2e/foo/bar/", "/foo/bar/", true });
data.add(new Object[] { "../foo/bar/", "/../foo/bar/", true });
data.add(new Object[] { ".%2e/foo/bar/", "/../foo/bar/", true });
data.add(new Object[] { ";/foo/bar/", "/foo/bar/", true });
data.add(new Object[] { "/#f", "/", true });
data.add(new Object[] { "#f", "/", true });
data.add(new Object[] { "/?q", "/", false });
data.add(new Object[] { "?q", "/", true });
return data.stream().map(Arguments::of);
}
@ParameterizedTest
@MethodSource("data")
public void testCanonicalUriPath(String path, String expected, boolean rejected) {
List<String> rejections = new ArrayList<>();
String canonical = canonicalUriPath(path, rejections::add);
Assertions.assertEquals(expected, canonical);
Assertions.assertEquals(rejected, !rejections.isEmpty());
// print for inclusion in adoc
System.err.printf("| `%s` | `%s` | ", path, canonical);
if (!rejections.isEmpty()) {
for (int i = 0; i < rejections.size(); i++) {
System.err.print(i == 0 ? "400 " : " & ");
System.err.print(rejections.get(i));
}
}
System.err.println();
}
}