Skip to content

The Unified and Autonomous Development Platform

fix: Block parameter bean resolution from Wicket URLs

Robin Shenf0dc394edb50
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java b/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java
index 4785f7851f..b014fcedde 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java
@@ -40,7 +40,7 @@ public class ParamUtils {
private static final Logger logger = LoggerFactory.getLogger(ParamInstances.class);
- private static final String PARAM_BEAN_CLASS_NAME_PREFIX = "BuildParamBean";
+ public static final String PARAM_BEAN_CLASS_NAME_PREFIX = "BuildParamBean";
public static void validateParamValues(List<List<String>> values) {
if (values.isEmpty())
diff --git a/server-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractComponentMapper.java b/server-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractComponentMapper.java
new file mode 100644
index 0000000000..705301abf6
--- /dev/null
+++ b/server-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractComponentMapper.java
@@ -0,0 +1,137 @@
+/*
+ * 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.
+ */
+package org.apache.wicket.core.request.mapper;
+
+import org.apache.wicket.Application;
+import org.apache.wicket.core.util.lang.WicketObjects;
+import org.apache.wicket.request.IRequestMapper;
+import org.apache.wicket.request.Url;
+import org.apache.wicket.request.Url.QueryParameter;
+import org.apache.wicket.request.component.IRequestablePage;
+import org.apache.wicket.request.mapper.AbstractMapper;
+import org.apache.wicket.request.mapper.info.PageComponentInfo;
+import org.apache.wicket.util.lang.Args;
+import org.apache.wicket.util.string.Strings;
+
+import io.onedev.server.buildspec.param.ParamUtils;
+
+/**
+ * Convenience class for implementing page/components related encoders.
+ *
+ * @author Matej Knopp
+ */
+public abstract class AbstractComponentMapper extends AbstractMapper implements IRequestMapper
+{
+ /**
+ * Construct.
+ */
+ public AbstractComponentMapper()
+ {
+ }
+
+ protected IMapperContext getContext()
+ {
+ return Application.get().getMapperContext();
+ }
+
+ /**
+ * Extracts the {@link PageComponentInfo} from the URL. The {@link PageComponentInfo} is encoded
+ * as the very first query parameter and the parameter consists of name only (no value).
+ *
+ * @param url
+ *
+ * @return PageComponentInfo instance if one was encoded in URL, <code>null</code> otherwise.
+ */
+ protected PageComponentInfo getPageComponentInfo(final Url url)
+ {
+ return MapperUtils.getPageComponentInfo(url);
+ }
+
+ /**
+ * Encodes the {@link PageComponentInfo} instance as the first query string parameter to the
+ * URL.
+ *
+ * @param url
+ * @param info
+ */
+ protected void encodePageComponentInfo(Url url, PageComponentInfo info)
+ {
+ Args.notNull(url, "url");
+
+ if (info != null)
+ {
+ String s = info.toString();
+ if (!Strings.isEmpty(s))
+ {
+ QueryParameter parameter = new QueryParameter(s, "");
+ url.getQueryParameters().add(parameter);
+ }
+ }
+ }
+
+ /**
+ * Loads page class with given name.
+ *
+ * @param name
+ * @return class
+ */
+ protected Class<? extends IRequestablePage> getPageClass(String name)
+ {
+ String cleanedClassName = cleanClassName(name);
+ // Resolving parameter bean classes deserializes data embedded in their names.
+ // Page URLs are untrusted and must never trigger this deserialization.
+ if (cleanedClassName.startsWith(ParamUtils.PARAM_BEAN_CLASS_NAME_PREFIX))
+ return null;
+ return WicketObjects.resolveClass(cleanedClassName);
+ }
+
+ /**
+ * Cleans the class name from any extra information that may be there.
+ *
+ * @param className
+ * The raw class name parsed from the url
+ * @return The cleaned class name
+ */
+ protected String cleanClassName(String className)
+ {
+ Args.notEmpty(className, "className");
+
+ if (Strings.indexOf(className, ';') > -1)
+ {
+ // remove any path parameters set manually by the user. WICKET-5500
+ className = Strings.beforeFirst(className, ';');
+ }
+
+ return className;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Removes the first query parameter only if {@link PageComponentInfo#parse(String)} returns
+ * non-null instance
+ */
+ @Override
+ protected void removeMetaParameter(final Url urlCopy)
+ {
+ if (MapperUtils.parsePageComponentInfoParameter(urlCopy.getQueryParameters().get(0)) != null)
+ {
+ urlCopy.getQueryParameters().remove(0);
+ }
+ }
+
+}
diff --git a/server-core/src/main/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapper.java b/server-core/src/main/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapper.java
index 32970a4cdc..83b9fcee02 100644
--- a/server-core/src/main/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapper.java
+++ b/server-core/src/main/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapper.java
@@ -40,6 +40,8 @@ import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.lang.Checks;
import org.apache.wicket.util.string.Strings;
+import io.onedev.server.buildspec.param.ParamUtils;
+
/**
* Generic {@link ResourceReference} encoder that encodes and decodes non-mounted
* {@link ResourceReference}s.
@@ -162,6 +164,10 @@ public class BasicResourceReferenceMapper extends AbstractResourceReferenceMappe
protected Class<?> resolveClass(String name)
{
+ // Resolving parameter bean classes deserializes data embedded in their names.
+ // Resource URLs are untrusted and must never trigger this deserialization.
+ if (name.startsWith(ParamUtils.PARAM_BEAN_CLASS_NAME_PREFIX))
+ return null;
return WicketObjects.resolveClass(name);
}
diff --git a/server-core/src/test/java/org/apache/wicket/core/request/mapper/AbstractComponentMapperTest.java b/server-core/src/test/java/org/apache/wicket/core/request/mapper/AbstractComponentMapperTest.java
new file mode 100644
index 0000000000..6933d1ce48
--- /dev/null
+++ b/server-core/src/test/java/org/apache/wicket/core/request/mapper/AbstractComponentMapperTest.java
@@ -0,0 +1,86 @@
+package org.apache.wicket.core.request.mapper;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.Serializable;
+
+import org.apache.commons.codec.binary.Hex;
+import org.apache.commons.lang3.SerializationUtils;
+import org.apache.wicket.core.request.handler.BookmarkablePageRequestHandler;
+import org.apache.wicket.core.request.handler.PageProvider;
+import org.apache.wicket.core.request.handler.RenderPageRequestHandler;
+import org.apache.wicket.markup.html.WebPage;
+import org.apache.wicket.mock.MockWebRequest;
+import org.apache.wicket.request.Url;
+import org.apache.wicket.util.tester.WicketTester;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import io.onedev.server.buildspec.param.ParamUtils;
+
+public class AbstractComponentMapperTest {
+
+ private WicketTester tester;
+
+ @BeforeEach
+ public void setUp() {
+ tester = new WicketTester();
+ }
+
+ @AfterEach
+ public void tearDown() {
+ tester.destroy();
+ }
+
+ @Test
+ public void bookmarkableUrlsCannotDeserializeParameterBeanClassNames() {
+ var serialized = Hex.encodeHexString(SerializationUtils.serialize(new DeserializationProbe()));
+ var className = ParamUtils.PARAM_BEAN_CLASS_NAME_PREFIX + "_" + serialized;
+ var mapper = tester.getApplication().getRootRequestMapper();
+ for (var prefix : new String[] {"wicket/bookmarkable/", "bookmarkable/"}) {
+ for (var suffix : new String[] {"", ";ignored", "?0"}) {
+ DeserializationProbe.deserialized = false;
+ assertNull(mapper.mapRequest(new MockWebRequest(Url.parse(prefix + className + suffix))));
+ assertFalse(DeserializationProbe.deserialized);
+ }
+ }
+ }
+
+ @Test
+ public void malformedParameterBeanClassNamesAreRejectedBeforeDecoding() {
+ var mapper = tester.getApplication().getRootRequestMapper();
+ for (var suffix : new String[] {"", "_", "_not-hex", ";ignored"}) {
+ var className = ParamUtils.PARAM_BEAN_CLASS_NAME_PREFIX + suffix;
+ assertNull(mapper.mapRequest(new MockWebRequest(Url.parse("wicket/bookmarkable/" + className))));
+ }
+ }
+
+ @Test
+ public void ordinaryBookmarkableUrlsStillResolvePages() {
+ var mapper = new BookmarkableMapper();
+ var url = mapper.mapHandler(new BookmarkablePageRequestHandler(new PageProvider(WebPage.class)));
+ for (var suffix : new String[] {"", ";ignored"}) {
+ var mapped = assertInstanceOf(RenderPageRequestHandler.class,
+ mapper.mapRequest(new MockWebRequest(Url.parse(url.toString() + suffix))));
+ assertSame(WebPage.class, mapped.getPageClass());
+ }
+ }
+
+ private static class DeserializationProbe implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private static boolean deserialized;
+
+ private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
+ input.defaultReadObject();
+ deserialized = true;
+ }
+ }
+}
diff --git a/server-core/src/test/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapperTest.java b/server-core/src/test/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapperTest.java
new file mode 100644
index 0000000000..89ba5b9126
--- /dev/null
+++ b/server-core/src/test/java/org/apache/wicket/core/request/mapper/BasicResourceReferenceMapperTest.java
@@ -0,0 +1,81 @@
+package org.apache.wicket.core.request.mapper;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.Serializable;
+
+import org.apache.commons.codec.binary.Hex;
+import org.apache.commons.lang3.SerializationUtils;
+import org.apache.wicket.mock.MockWebRequest;
+import org.apache.wicket.request.Url;
+import org.apache.wicket.request.handler.resource.ResourceReferenceRequestHandler;
+import org.apache.wicket.request.mapper.parameter.PageParametersEncoder;
+import org.apache.wicket.resource.JQueryResourceReference;
+import org.apache.wicket.util.tester.WicketTester;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import io.onedev.server.buildspec.param.ParamUtils;
+
+public class BasicResourceReferenceMapperTest {
+
+ private WicketTester tester;
+
+ private BasicResourceReferenceMapper mapper;
+
+ @BeforeEach
+ public void setUp() {
+ tester = new WicketTester();
+ mapper = new BasicResourceReferenceMapper(new PageParametersEncoder(),
+ () -> tester.getApplication().getResourceSettings().getCachingStrategy());
+ }
+
+ @AfterEach
+ public void tearDown() {
+ tester.destroy();
+ }
+
+ @Test
+ public void resourceUrlsCannotDeserializeParameterBeanClassNames() {
+ DeserializationProbe.deserialized = false;
+ var serialized = Hex.encodeHexString(SerializationUtils.serialize(new DeserializationProbe()));
+ var className = ParamUtils.PARAM_BEAN_CLASS_NAME_PREFIX + "_" + serialized;
+ assertNull(mapper.mapRequest(new MockWebRequest(Url.parse("wicket/resource/" + className + "/test.js"))));
+ assertFalse(DeserializationProbe.deserialized);
+ }
+
+ @Test
+ public void malformedParameterBeanClassNamesAreRejectedBeforeDecoding() {
+ for (var suffix : new String[] {"", "_", "_not-hex"}) {
+ var className = ParamUtils.PARAM_BEAN_CLASS_NAME_PREFIX + suffix;
+ assertNull(mapper.mapRequest(new MockWebRequest(Url.parse("wicket/resource/" + className + "/test.js"))));
+ }
+ }
+
+ @Test
+ public void ordinaryResourceUrlsStillRoundTrip() {
+ var reference = JQueryResourceReference.getV3();
+ var url = mapper.mapHandler(new ResourceReferenceRequestHandler(reference));
+ var mapped = assertInstanceOf(ResourceReferenceRequestHandler.class,
+ mapper.mapRequest(new MockWebRequest(url)));
+ assertSame(reference, mapped.getResourceReference());
+ }
+
+ private static class DeserializationProbe implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private static boolean deserialized;
+
+ private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
+ input.defaultReadObject();
+ deserialized = true;
+ }
+ }
+}