forked from actframework/actframework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCSRF.java
More file actions
243 lines (213 loc) · 7.92 KB
/
CSRF.java
File metadata and controls
243 lines (213 loc) · 7.92 KB
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
package act.security;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* 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.
* #L%
*/
import act.Act;
import act.app.ActionContext;
import act.app.App;
import act.conf.AppConfig;
import act.util.MissingAuthenticationHandler;
import org.osgl.exception.UnexpectedException;
import org.osgl.http.H;
import org.osgl.inject.BeanSpec;
import org.osgl.util.S;
import java.lang.annotation.*;
import java.lang.reflect.Method;
import java.lang.reflect.Type;
public class CSRF {
/**
* Mark a controller class or action handler method that
* requires the CSRF protection. This can be used
* to construct the whitelist of CSRF protection resources
* when the global {@link act.conf.AppConfigKey#CSRF} is
* disabled
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Enable {
}
/**
* Mark a controller class or action handler method that
* is not subject to CSRF protection. This can be used
* to construct the blacklist of CSRF protection resources
* when the global {@link act.conf.AppConfigKey#CSRF} is
* enabled
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Disable {
}
public static String token(ActionContext ctx) {
String paramName = ctx.config().csrfParamName();
return ctx.renderArg(paramName);
}
public static String formField(ActionContext ctx) {
String paramName = ctx.config().csrfParamName();
return S.newBuffer("<input type='hidden' name='").a(paramName)
.a("' value='").a(ctx.renderArg(paramName)).a("'>").toString();
}
public static Spec spec(Class controller) {
return spec(BeanSpec.of(controller, Act.injector()));
}
public static Spec spec(Method action) {
Type type = Method.class;
Annotation[] annotations = action.getDeclaredAnnotations();
return spec(BeanSpec.of(type, annotations, Act.injector()));
}
private static Spec spec(BeanSpec beanSpec) {
if (null != beanSpec.getAnnotation(Enable.class)) {
return new Spec(true);
} else if (null != beanSpec.getAnnotation(Disable.class)) {
return new Spec(false);
}
return Spec.DEFAULT;
}
public static class Spec {
// The dumb spec does nothing
public static final Spec DUMB = new Spec() {
@Override
public void preCheck(ActionContext context) {
// do nothing implementation
}
@Override
public void check(ActionContext context, H.Session session) {
// do nothing implementation
}
@Override
public void setCookieAndRenderArgs(ActionContext context) {
// do nothing implementation
}
};
// The default spec delegate to global App configuration
public static final Spec DEFAULT = new Spec();
private App app;
private Boolean enabled;
private String paramName;
private String headerName;
private String cookieName;
private String cookieDomain;
private CSRFProtector csrfProtector;
private Spec() {this(null);}
private Spec(Boolean enabled) {
this.app = Act.app();
AppConfig config = app.config();
boolean globalEnabled = config.csrfEnabled();
this.enabled = null == enabled ? globalEnabled : enabled;
if (!this.enabled) {
return;
}
this.paramName = config.csrfParamName();
this.headerName = config.csrfHeaderName();
this.cookieName = config.csrfCookieName();
this.cookieDomain = config.cookieDomain();
this.csrfProtector = config.csrfProtector();
}
private boolean effective() {
return DUMB != this && DEFAULT != this;
}
/**
* Do sanity check to see if CSRF token is present. This method
* is called before session resolved
*
* @param context the current context
*/
public void preCheck(ActionContext context) {
if (!enabled) {
return;
}
H.Method method = context.req().method();
if (method.safe()) {
return;
}
String token = retrieveCsrfToken(context);
if (S.blank(token)) {
raiseCsrfNotVerified(context);
}
}
/**
* Check CSRF token after session resolved
* @param context the current context
*/
public void check(ActionContext context, H.Session session) {
if (!enabled) {
return;
}
String token = context.csrfPrefetched();
try {
if (!csrfProtector.verifyToken(token, session, app)) {
context.clearCsrfPrefetched();
raiseCsrfNotVerified(context);
}
} catch (UnexpectedException e) {
Act.LOGGER.warn(e, "Error checking CSRF token");
raiseCsrfNotVerified(context);
}
}
public CSRF.Spec chain(final Spec next) {
return effective() ? this : next;
}
public void setCookieAndRenderArgs(ActionContext context) {
if (!enabled) {
return;
}
String token = retrieveCsrfToken(context);
if (S.blank(token)) {
// this branch is for safe methods
H.Session session = context.session();
token = csrfProtector.retrieveToken(session, cookieName, app);
}
if (S.blank(token) || justLoggedIn(context)) {
H.Session session = context.session();
csrfProtector.clearExistingToken(session, cookieName);
token = app.encrypt(csrfProtector.generateToken(session, app));
H.Cookie cookie = new H.Cookie(cookieName, token);
cookie.secure(context.config().sessionSecure());
cookie.domain(cookieDomain);
cookie.path("/");
context.resp().addCookie(cookie);
csrfProtector.outputToken(token, cookieName, cookieDomain, context);
}
context.renderArg(paramName, token);
}
private String retrieveCsrfToken(ActionContext context) {
String token = context.csrfPrefetched();
if (S.blank(token)) {
token = context.req().header(headerName);
}
if (S.blank(token)) {
token = context.paramVal(paramName);
}
if (S.notBlank(token)) {
context.setCsrfPrefetched(token);
}
return token;
}
private static boolean justLoggedIn(ActionContext context) {
boolean wasUnauthenticated = context.wasUnauthenticated();
return wasUnauthenticated && context.isLoggedIn();
}
private static void raiseCsrfNotVerified(ActionContext context) {
context.clearCsrfPrefetched();
MissingAuthenticationHandler handler = context.csrfFailureHandler();
handler.handle(context);
}
}
}