This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
/
RestLimitingSynchronousDispatcher.java
178 lines (159 loc) · 7.08 KB
/
RestLimitingSynchronousDispatcher.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
/*
* Copyright 2015, Red Hat, Inc. and individual contributors as indicated by the
* @author tags. See the copyright.txt file in the distribution for a full
* listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this software; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
* site: http://www.fsf.org.
*/
package org.zanata.rest;
import java.io.IOException;
import javax.annotation.Nonnull;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.Response;
import org.apache.commons.lang.StringUtils;
import org.jboss.resteasy.core.SynchronousDispatcher;
import org.jboss.resteasy.spi.HttpRequest;
import org.jboss.resteasy.spi.HttpResponse;
import org.jboss.resteasy.spi.ResteasyProviderFactory;
import org.jboss.resteasy.spi.UnhandledException;
import org.jboss.seam.resteasy.SeamResteasyProviderFactory;
import org.jboss.seam.security.management.JpaIdentityStore;
import org.jboss.seam.web.ServletContexts;
import org.zanata.dao.AccountDAO;
import org.zanata.limits.RateLimitingProcessor;
import org.zanata.model.HAccount;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.common.base.Throwables;
import lombok.extern.slf4j.Slf4j;
import org.zanata.security.SecurityFunctions;
import org.zanata.util.HttpUtil;
import org.zanata.util.ServiceLocator;
/**
* This class extends RESTEasy's SynchronousDispatcher to limit API calls per
* API key (via RateLimitingProcessor and RateLimitManager) before dispatching
* requests.
*
* @author Patrick Huang <a
* href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
*/
@Slf4j
class RestLimitingSynchronousDispatcher extends SynchronousDispatcher {
static final String API_KEY_ABSENCE_WARNING =
"You must have a valid API key. You can create one by logging in to Zanata and visiting the settings page.";
private final RateLimitingProcessor processor;
public RestLimitingSynchronousDispatcher(
SeamResteasyProviderFactory providerFactory) {
super(providerFactory);
processor = new RateLimitingProcessor();
}
@VisibleForTesting
RestLimitingSynchronousDispatcher(ResteasyProviderFactory providerFactory,
RateLimitingProcessor processor) {
super(providerFactory);
this.processor = processor;
}
HttpServletRequest getServletRequest() {
return ServletContexts.instance().getRequest();
}
@Override
public void invoke(final HttpRequest request, final HttpResponse response) {
/**
* This is only non-null if request came from same browser which
* user used to logged into Zanata.
*/
HAccount authenticatedUser = getAuthenticatedUser();
/**
* If apiKey is empty, request is from anonymous user,
* If apiKey is not empty, it must be an authenticated
* user from pre-process in ZanataRestSecurityInterceptor.
*/
String apiKey = HttpUtil.getApiKey(request);
try {
// Get user account with apiKey if request is from client
if(authenticatedUser == null && StringUtils.isNotEmpty(apiKey)) {
authenticatedUser = getUser(apiKey);
}
if(!SecurityFunctions.canAccessRestPath(authenticatedUser,
request.getHttpMethod(), request.getPreprocessedPath())) {
/**
* Not using response.sendError because the app server will generate
* an HTML page which includes the message. We want to return
* the message string as is.
*/
response.setStatus(Response.Status.UNAUTHORIZED.getStatusCode());
response.getOutputStream().write(InvalidApiKeyUtil.getMessage(
API_KEY_ABSENCE_WARNING).getBytes());
return;
}
Runnable taskToRun = new Runnable() {
@Override
public void run() {
RestLimitingSynchronousDispatcher.super.invoke(request,
response);
}
};
//authenticatedUser can be from browser or client request
if(authenticatedUser == null) {
/**
* Process anonymous request for rate limiting
* Note: clientIP might be a proxy server IP address, due to
* different implementation of each proxy server. This will put
* all the requests from same proxy server into a single queue.
*/
String clientIP = HttpUtil.getClientIp(getServletRequest());
processor.processForAnonymousIP(clientIP, response, taskToRun);
} else {
if (!Strings.isNullOrEmpty(authenticatedUser.getApiKey())) {
processor.processForApiKey(authenticatedUser.getApiKey(),
response, taskToRun);
} else {
processor.processForUser(authenticatedUser.getUsername(),
response, taskToRun);
}
}
} catch (UnhandledException e) {
Throwable cause = e.getCause();
log.error("Failed to process REST request", cause);
try {
// see https://issues.jboss.org/browse/RESTEASY-411
if (cause instanceof IllegalArgumentException
&& cause.getMessage().contains(
"Failure parsing MediaType")) {
response.sendError(Response.Status.UNSUPPORTED_MEDIA_TYPE
.getStatusCode(), cause.getMessage());
} else {
response.sendError(Response.Status.INTERNAL_SERVER_ERROR
.getStatusCode(), "Error processing Request");
}
} catch (IOException ioe) {
log.error("Failed to send error on failed REST request", ioe);
}
} catch (Exception e) {
log.error("error processing request", e);
throw Throwables.propagate(e);
}
}
@VisibleForTesting
protected HAccount getAuthenticatedUser() {
return ServiceLocator.instance().getInstance(
JpaIdentityStore.AUTHENTICATED_USER, HAccount.class);
}
protected HAccount getUser(@Nonnull String apiKey) {
return ServiceLocator.instance().getInstance(AccountDAO.class)
.getByApiKey(apiKey);
}
}