-
Notifications
You must be signed in to change notification settings - Fork 975
/
AccessControlListHandler.java
295 lines (255 loc) · 9.59 KB
/
AccessControlListHandler.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
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.undertow.server.handlers;
import io.undertow.UndertowMessages;
import io.undertow.attribute.ExchangeAttribute;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.builder.HandlerBuilder;
import io.undertow.util.StatusCodes;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
/**
* Handler that can accept or reject a request based on an attribute of the remote peer
*
* todo: should we support non-regex values for performance reasons?
* @author Stuart Douglas
* @author Andre Dietisheim
*/
public class AccessControlListHandler implements HttpHandler {
private volatile HttpHandler next;
private volatile boolean defaultAllow = false;
private final ExchangeAttribute attribute;
private final List<AclMatch> acl = new CopyOnWriteArrayList<>();
private final int denyResponseCode;
public AccessControlListHandler(final HttpHandler next, ExchangeAttribute attribute) {
this.next = next;
this.attribute = attribute;
this.denyResponseCode = StatusCodes.FORBIDDEN;
}
public AccessControlListHandler(ExchangeAttribute attribute) {
this.attribute = attribute;
this.next = ResponseCodeHandler.HANDLE_404;
this.denyResponseCode = StatusCodes.FORBIDDEN;
}
public AccessControlListHandler(final HttpHandler next, ExchangeAttribute attribute, final int denyResponseCode) {
this.next = next;
this.attribute = attribute;
if(denyResponseCode == -1) {
this.denyResponseCode = StatusCodes.FORBIDDEN;
} else {
assert denyResponseCode > 399;
assert denyResponseCode < 500;
this.denyResponseCode = denyResponseCode;
}
}
public AccessControlListHandler(ExchangeAttribute attribute, final int denyResponseCode) {
this.attribute = attribute;
this.next = ResponseCodeHandler.HANDLE_404;
if(denyResponseCode == -1) {
this.denyResponseCode = StatusCodes.FORBIDDEN;
} else {
assert denyResponseCode > 399;
assert denyResponseCode < 500;
this.denyResponseCode = denyResponseCode;
}
}
@Override
public void handleRequest(final HttpServerExchange exchange) throws Exception {
String attribute = this.attribute.readAttribute(exchange);
if (isAllowed(attribute)) {
next.handleRequest(exchange);
} else {
exchange.setStatusCode(this.denyResponseCode);
exchange.endExchange();
}
}
//package private for unit tests
boolean isAllowed(String attribute) {
if (attribute != null) {
for (AclMatch rule : acl) {
if (rule.matches(attribute)) {
return !rule.isDeny();
}
}
}
return defaultAllow;
}
public boolean isDefaultAllow() {
return defaultAllow;
}
public AccessControlListHandler setDefaultAllow(final boolean defaultAllow) {
this.defaultAllow = defaultAllow;
return this;
}
public HttpHandler getNext() {
return next;
}
public AccessControlListHandler setNext(final HttpHandler next) {
this.next = next;
return this;
}
/**
* Adds an allowed user agent peer to the ACL list
* <p>
* User agent may be given as regex
*
* @param pattern The pattern to add to the ACL
*/
public AccessControlListHandler addAllow(final String pattern) {
return addRule(pattern, false);
}
/**
* Adds an denied user agent to the ACL list
* <p>
* User agent may be given as regex
*
* @param pattern The user agent to add to the ACL
*/
public AccessControlListHandler addDeny(final String pattern) {
return addRule(pattern, true);
}
public AccessControlListHandler clearRules() {
this.acl.clear();
return this;
}
private AccessControlListHandler addRule(final String userAgent, final boolean deny) {
this.acl.add(new AclMatch(deny, userAgent));
return this;
}
static class AclMatch {
private final boolean deny;
private final Pattern pattern;
protected AclMatch(final boolean deny, final String pattern) {
this.deny = deny;
this.pattern = createPattern(pattern);
}
private Pattern createPattern(final String pattern) {
try {
return Pattern.compile(pattern);
} catch (PatternSyntaxException e) {
throw UndertowMessages.MESSAGES.notAValidRegularExpressionPattern(pattern);
}
}
boolean matches(final String attribute) {
return pattern.matcher(attribute).matches();
}
boolean isDeny() {
return deny;
}
@Override
public String toString() {
return getClass().getSimpleName()
+ "{"
+ "deny=" + deny
+ ", pattern='" + pattern + '\''
+ '}';
}
}
public static class Builder implements HandlerBuilder {
@Override
public String name() {
return "access-control";
}
@Override
public Map<String, Class<?>> parameters() {
Map<String, Class<?>> params = new HashMap<>();
params.put("acl", String[].class);
params.put("default-allow", boolean.class);
params.put("attribute", ExchangeAttribute.class);
params.put("failure-status", int.class);
return params;
}
@Override
public Set<String> requiredParameters() {
final HashSet<String> ret = new HashSet<>();
ret.add("acl");
ret.add("attribute");
return ret;
}
@Override
public String defaultParameter() {
return null;
}
@Override
public HandlerWrapper build(Map<String, Object> config) {
String[] acl = (String[]) config.get("acl");
Boolean defaultAllow = (Boolean) config.get("default-allow");
ExchangeAttribute attribute = (ExchangeAttribute) config.get("attribute");
List<AclMatch> peerMatches = new ArrayList<>();
for(String rule :acl) {
String[] parts = rule.split(" ");
if(parts.length != 2) {
throw UndertowMessages.MESSAGES.invalidAclRule(rule);
}
if(parts[1].trim().equals("allow")) {
peerMatches.add(new AclMatch(false, parts[0].trim()));
} else if(parts[1].trim().equals("deny")) {
peerMatches.add(new AclMatch(true, parts[0].trim()));
} else {
throw UndertowMessages.MESSAGES.invalidAclRule(rule);
}
}
Integer failureStatus = (Integer) config.get("failure-status");
if(failureStatus == null) {
return new Wrapper(peerMatches, defaultAllow == null ? false : defaultAllow, attribute);
} else {
return new Wrapper(peerMatches, defaultAllow == null ? false : defaultAllow, attribute, failureStatus.intValue());
}
}
}
private static class Wrapper implements HandlerWrapper {
private final List<AclMatch> peerMatches;
private final boolean defaultAllow;
private final ExchangeAttribute attribute;
private final int denyResponseCode;
private Wrapper(List<AclMatch> peerMatches, boolean defaultAllow, ExchangeAttribute attribute) {
this.peerMatches = peerMatches;
this.defaultAllow = defaultAllow;
this.attribute = attribute;
this.denyResponseCode = -1;
}
private Wrapper(List<AclMatch> peerMatches, boolean defaultAllow, ExchangeAttribute attribute, final int denyResponseCode) {
this.peerMatches = peerMatches;
this.defaultAllow = defaultAllow;
this.attribute = attribute;
this.denyResponseCode = denyResponseCode;
}
@Override
public HttpHandler wrap(HttpHandler handler) {
AccessControlListHandler res = new AccessControlListHandler(handler, attribute, denyResponseCode);
for(AclMatch match: peerMatches) {
if(match.deny) {
res.addDeny(match.pattern.pattern());
} else {
res.addAllow(match.pattern.pattern());
}
}
res.setDefaultAllow(defaultAllow);
return res;
}
}
}