Separate submitted and response salts in UI filters #167
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. For additional information regarding | ||
| * copyright in this work, please see the NOTICE file in the top level | ||
| * directory of this distribution. | ||
| */ | ||
|
|
||
| package org.apache.roller.weblogger.ui.core.filters; | ||
|
|
||
| import java.util.Locale; | ||
| import java.util.Objects; | ||
|
|
||
| import javax.servlet.http.HttpServletRequest; | ||
|
|
||
| import org.apache.roller.weblogger.ui.core.RollerSession; | ||
| import org.apache.roller.weblogger.ui.rendering.util.cache.SaltCache; | ||
|
|
||
| /** | ||
| * Shared validation for salts submitted by UI forms. | ||
| */ | ||
| public final class SaltValidator { | ||
|
|
||
| private static final String MULTIPART_FORM_DATA = "multipart/form-data"; | ||
|
|
||
| private SaltValidator() { | ||
| } | ||
|
|
||
| /** | ||
| * Validates and consumes the salt submitted as a request parameter. | ||
| * | ||
| * @param request current request | ||
| * @return true when no Roller session is present or the submitted salt is valid | ||
| */ | ||
| public static boolean consumeSubmittedSalt(HttpServletRequest request) { | ||
| RollerSession rollerSession = RollerSession.getRollerSession(request); | ||
| if (rollerSession == null) { | ||
| return true; | ||
| } | ||
|
|
||
| String userId = rollerSession.getAuthenticatedUser() != null | ||
| ? rollerSession.getAuthenticatedUser().getId() : ""; | ||
| String salt = request.getParameter("salt"); | ||
| if (salt == null) { | ||
| return false; | ||
| } | ||
|
|
||
| SaltCache saltCache = SaltCache.getInstance(); | ||
| synchronized (saltCache) { | ||
| if (!Objects.equals(saltCache.get(salt), userId)) { | ||
| return false; | ||
| } | ||
| saltCache.remove(salt); | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Returns true for a multipart form POST, which Struts parses after the | ||
| * servlet filters have run. | ||
| * | ||
| * @param request current request | ||
| * @return true for multipart/form-data POST requests | ||
| */ | ||
| public static boolean isMultipartFormPost(HttpServletRequest request) { | ||
| if (!"POST".equalsIgnoreCase(request.getMethod())) { | ||
| return false; | ||
| } | ||
|
|
||
| String contentType = request.getContentType(); | ||
| if (contentType == null) { | ||
| return false; | ||
| } | ||
|
|
||
| int parameterStart = contentType.indexOf(';'); | ||
| String mediaType = parameterStart >= 0 | ||
| ? contentType.substring(0, parameterStart) : contentType; | ||
| return MULTIPART_FORM_DATA.equals(mediaType.trim().toLowerCase(Locale.ENGLISH)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. For additional information regarding | ||
| * copyright in this work, please see the NOTICE file in the top level | ||
| * directory of this distribution. | ||
| */ | ||
|
|
||
| package org.apache.roller.weblogger.ui.struts2.util; | ||
|
|
||
| import javax.servlet.ServletException; | ||
| import javax.servlet.http.HttpServletRequest; | ||
|
|
||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.apache.roller.weblogger.ui.core.filters.SaltValidator; | ||
| import org.apache.struts2.StrutsStatics; | ||
|
|
||
| import com.opensymphony.xwork2.ActionContext; | ||
| import com.opensymphony.xwork2.ActionInvocation; | ||
| import com.opensymphony.xwork2.interceptor.AbstractInterceptor; | ||
|
|
||
| /** | ||
| * Validates salts after Struts has parsed a multipart form request. | ||
| */ | ||
| public class ValidateSaltInterceptor extends AbstractInterceptor implements StrutsStatics { | ||
|
|
||
| private static final long serialVersionUID = 2446434402795510394L; | ||
| private static final Log log = LogFactory.getLog(ValidateSaltInterceptor.class); | ||
|
|
||
| @Override | ||
| public String intercept(ActionInvocation invocation) throws Exception { | ||
| ActionContext context = invocation.getInvocationContext(); | ||
| HttpServletRequest request = (HttpServletRequest) context.get(HTTP_REQUEST); | ||
|
|
||
| if (SaltValidator.isMultipartFormPost(request) | ||
|
Contributor
There was a problem hiding this comment. This runs again on every chained invocation of the same request. Related: when Struts can't parse the multipart body (over |
||
| && !SaltValidator.consumeSubmittedSalt(request)) { | ||
| if (log.isDebugEnabled()) { | ||
| log.debug("Valid salt value not found on multipart POST to URL : " | ||
| + request.getServletPath()); | ||
| } | ||
| throw new ServletException("Security Violation"); | ||
| } | ||
|
|
||
| return invocation.invoke(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. For additional information regarding | ||
| * copyright in this work, please see the NOTICE file in the top level | ||
| * directory of this distribution. | ||
| */ | ||
|
|
||
| package org.apache.roller.weblogger.ui.core.filters; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| public class SaltConfigurationTest { | ||
|
|
||
| @Test | ||
| public void testSubmittedSaltIsValidatedBeforeResponseSaltIsLoaded() throws Exception { | ||
| String webXml = Files.readString(Path.of("src/main/webapp/WEB-INF/web.xml")); | ||
|
Contributor
There was a problem hiding this comment. cwd-relative, so this passes only when run from |
||
|
|
||
| int validateMapping = filterMappingPosition(webXml, "ValidateSaltFilter"); | ||
| int loadMapping = filterMappingPosition(webXml, "LoadSaltFilter"); | ||
|
|
||
| assertTrue(validateMapping >= 0, "ValidateSaltFilter mapping is missing"); | ||
| assertTrue(loadMapping >= 0, "LoadSaltFilter mapping is missing"); | ||
| assertTrue(validateMapping < loadMapping, | ||
| "ValidateSaltFilter must run before LoadSaltFilter"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMultipartSaltValidationImmediatelyFollowsUploadInterceptor() throws Exception { | ||
| String strutsXml = readResource("/struts.xml"); | ||
|
|
||
| Pattern adjacentInterceptors = Pattern.compile( | ||
| "<interceptor-ref name=\"fileUpload\"/>\\s*" | ||
| + "<interceptor-ref name=\"ValidateSaltInterceptor\"/>"); | ||
|
|
||
| assertTrue(adjacentInterceptors.matcher(strutsXml).find(), | ||
| "ValidateSaltInterceptor must immediately follow the upload interceptor"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testConfigurableSaltBypassIsRemoved() throws Exception { | ||
| String properties = readResource( | ||
| "/org/apache/roller/weblogger/config/roller.properties"); | ||
|
|
||
| assertFalse(properties.contains("salt.ignored.urls")); | ||
|
Contributor
There was a problem hiding this comment. Asserting the literal |
||
| } | ||
|
|
||
| private int filterMappingPosition(String webXml, String filterName) { | ||
| Pattern pattern = Pattern.compile("<filter-mapping>\\s*<filter-name>" | ||
| + Pattern.quote(filterName) + "</filter-name>"); | ||
| Matcher matcher = pattern.matcher(webXml); | ||
| return matcher.find() ? matcher.start() : -1; | ||
| } | ||
|
|
||
| private String readResource(String path) throws IOException { | ||
| try (InputStream stream = SaltConfigurationTest.class.getResourceAsStream(path)) { | ||
| if (stream == null) { | ||
| throw new IOException("Test resource not found: " + path); | ||
| } | ||
| return new String(stream.readAllBytes(), StandardCharsets.UTF_8); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that this is the only path,
cache.salt.size(5000) andcache.salt.timeout(3600s) are user-visible limits:LoadSaltFiltermints a salt on every/roller-uirequest and on every tiles FORWARD, so entries get evicted quickly on a multi-user site, and a form left open for over an hour is rejected with the entry text lost. Not a blocker, but please call it out in the description; raising the defaults would soften it.