You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@roller.apache.org by "snoopdave (via GitHub)" <gi...@apache.org> on 2026/08/29 21:10:16 UTC
[PR] Disable vendor extension types on the XML-RPC servlet [roller]
snoopdave opened a new pull request, #171:
URL: https://github.com/apache/roller/pull/171
The XML-RPC servlet is configured to accept the library's non-standard vendor
extension types, which Roller does not use, and its mapped endpoint answers
requests even when the XML-RPC feature is switched off. This change turns the
extensions off and makes the disabled-by-default toggle close the endpoint.
## What changed
- Disable vendor extension types (`enabledForExtensions=false`, or drop the
enabling servlet init-param), since Roller uses only the standard XML-RPC
value types.
- Gate the mapped endpoint on `webservices.enableXmlRpc`, so a disabled API is
closed at the endpoint instead of relying on per-handler checks.
- Preserve ordinary XML-RPC values and calls when the feature is enabled.
## Tests
- With the toggle off, both ordinary and extension-type requests are rejected at
the endpoint.
- With the toggle on, an extension-type value is rejected while an ordinary
XML-RPC call reaches its handler.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@roller.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Disable vendor extension types on the XML-RPC servlet [roller]
Posted by "mraible (via GitHub)" <gi...@apache.org>.
mraible commented on code in PR #171:
URL: https://github.com/apache/roller/pull/171#discussion_r3891439511
##########
app/src/main/java/org/apache/roller/weblogger/ui/core/filters/XmlRpcEnabledFilter.java:
##########
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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 javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.roller.weblogger.config.WebloggerRuntimeConfig;
+
+/**
+ * Gates the XML-RPC endpoint on <code>webservices.enableXmlRpc</code>, ahead of
+ * the servlet, so a disabled service is not reachable.
+ */
+public class XmlRpcEnabledFilter implements Filter {
+
+ private static final Log LOG = LogFactory.getLog(XmlRpcEnabledFilter.class);
+
+ @Override
+ public void init(FilterConfig filterConfig) {
+ // nothing to configure
+ }
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response,
+ FilterChain chain) throws IOException, ServletException {
+
+ if (!WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc")) {
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("XML-RPC service is disabled; rejecting request");
+ }
+ ((HttpServletResponse) response).sendError(HttpServletResponse.SC_NOT_FOUND);
Review Comment:
`sendError(404)` gets routed to `/roller-ui/errors/404.jsp`, so a disabled endpoint now answers a desktop client's POST with an HTML page instead of the XML-RPC fault `BLOGGERAPI_DISABLED_MSG` that `BaseAPIHandler` still produces (line 152) but can no longer reach. Clients like MarsEdit will show a generic "invalid response". Consider writing a small XML-RPC fault with `text/xml` here, or at least `setStatus(404)` with a plain-text body so the error JSP isn't rendered.
##########
app/src/main/webapp/WEB-INF/web.xml:
##########
@@ -154,6 +159,11 @@
</filter-mapping>
<!-- Request mapping, this is what allows the urls to work -->
+ <filter-mapping>
Review Comment:
Nit: no `<dispatcher>` so this applies to REQUEST only; nothing forwards to `/roller-services/xmlrpc` today, but adding `FORWARD` / `INCLUDE` makes the gate match what the javadoc claims.
##########
app/src/main/java/org/apache/roller/weblogger/ui/core/filters/XmlRpcEnabledFilter.java:
##########
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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 javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.roller.weblogger.config.WebloggerRuntimeConfig;
+
+/**
+ * Gates the XML-RPC endpoint on <code>webservices.enableXmlRpc</code>, ahead of
+ * the servlet, so a disabled service is not reachable.
+ */
+public class XmlRpcEnabledFilter implements Filter {
+
+ private static final Log LOG = LogFactory.getLog(XmlRpcEnabledFilter.class);
+
+ @Override
+ public void init(FilterConfig filterConfig) {
+ // nothing to configure
+ }
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response,
+ FilterChain chain) throws IOException, ServletException {
+
+ if (!WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc")) {
Review Comment:
`getBooleanProperty` swallows exceptions and returns false, so a DB hiccup or a request before bootstrap answers 404 rather than an error. A `LOG.warn` when refusing would make that diagnosable; debug is easy to miss.
##########
app/src/test/java/org/apache/roller/weblogger/webservices/xmlrpc/XmlRpcExtensionTypeTest.java:
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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.webservices.xmlrpc;
+
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.apache.xmlrpc.parser.XmlRpcRequestParser;
+import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl;
+import org.apache.xmlrpc.common.TypeFactoryImpl;
+import org.apache.xmlrpc.common.XmlRpcController;
+import org.apache.xmlrpc.server.XmlRpcServer;
+import org.junit.jupiter.api.Test;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+/**
+ * Covers how the XML-RPC endpoint treats vendor extension types.
+ *
+ * <p>Roller's XML-RPC API uses only the standard value types, so the library's
+ * vendor extension types are switched off in <code>web.xml</code> and the
+ * endpoint is closed entirely while the service is disabled.
+ */
+public class XmlRpcExtensionTypeTest {
+
+ private static final Path WEB_XML =
+ Paths.get("src", "main", "webapp", "WEB-INF", "web.xml");
+
+ private String parseRequest(String xml, boolean extensionsEnabled) throws Exception {
+ XmlRpcServer server = new XmlRpcServer();
+ XmlRpcHttpRequestConfigImpl config = new XmlRpcHttpRequestConfigImpl();
+ config.setEnabledForExtensions(extensionsEnabled);
+
+ XmlRpcRequestParser parser = new XmlRpcRequestParser(
+ config, new TypeFactoryImpl((XmlRpcController) server));
+ XMLReader reader = XMLReaderFactory.createXMLReader();
+ reader.setContentHandler(parser);
+ reader.parse(new InputSource(
+ new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8))));
+ return parser.getMethodName();
+ }
+
+ private static final String ORDINARY_REQUEST =
+ "<?xml version=\"1.0\"?><methodCall>"
+ + "<methodName>blogger.getUsersBlogs</methodName>"
+ + "<params><param><value><string>hello</string></value></param></params>"
+ + "</methodCall>";
+
+ /** The shipped configuration must not enable the extension types. */
+ @Test
+ public void shippedConfigurationDisablesExtensionTypes() throws Exception {
+ String webXml = new String(Files.readAllBytes(WEB_XML), StandardCharsets.UTF_8);
+ int idx = webXml.indexOf("enabledForExtensions");
+ assertTrue(idx > 0, "enabledForExtensions param not found in web.xml");
+ String tail = webXml.substring(idx, Math.min(idx + 300, webXml.length()));
+ assertTrue(tail.contains("<param-value>false</param-value>"),
+ "the XML-RPC servlet must not enable vendor extension types:\n" + tail);
+ }
+
+ /** The endpoint is closed by a filter while the service is switched off. */
+ @Test
+ public void endpointIsGatedWhileTheServiceIsDisabled() throws Exception {
+ String webXml = new String(Files.readAllBytes(WEB_XML), StandardCharsets.UTF_8);
+ assertTrue(webXml.contains("XmlRpcEnabledFilter"),
+ "a filter must gate the XML-RPC endpoint");
+ int mapping = webXml.indexOf("<filter-name>XmlRpcEnabledFilter</filter-name>",
+ webXml.indexOf("<filter-mapping>"));
+ assertTrue(mapping > 0, "the gating filter must be mapped");
Review Comment:
`indexOf("/roller-services/xmlrpc", mapping) > 0` is also satisfied by the later `<servlet-mapping>` for `XmlRpcServlet`, so a typo in the filter's `url-pattern` still passes. Parse the `<filter-mapping>` element and compare its `url-pattern` directly.
##########
app/src/test/java/org/apache/roller/weblogger/webservices/xmlrpc/XmlRpcExtensionTypeTest.java:
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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.webservices.xmlrpc;
+
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.apache.xmlrpc.parser.XmlRpcRequestParser;
+import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl;
+import org.apache.xmlrpc.common.TypeFactoryImpl;
+import org.apache.xmlrpc.common.XmlRpcController;
+import org.apache.xmlrpc.server.XmlRpcServer;
+import org.junit.jupiter.api.Test;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+/**
+ * Covers how the XML-RPC endpoint treats vendor extension types.
+ *
+ * <p>Roller's XML-RPC API uses only the standard value types, so the library's
+ * vendor extension types are switched off in <code>web.xml</code> and the
+ * endpoint is closed entirely while the service is disabled.
+ */
+public class XmlRpcExtensionTypeTest {
+
+ private static final Path WEB_XML =
+ Paths.get("src", "main", "webapp", "WEB-INF", "web.xml");
+
+ private String parseRequest(String xml, boolean extensionsEnabled) throws Exception {
+ XmlRpcServer server = new XmlRpcServer();
Review Comment:
Nit: `extensionsEnabled` is only ever `false`, the `(XmlRpcController)` cast is a no-op, and `XMLReaderFactory` has been deprecated since Java 9 (`SAXParserFactory.newInstance().newSAXParser().getXMLReader()`).
##########
app/src/test/java/org/apache/roller/weblogger/webservices/xmlrpc/XmlRpcExtensionTypeTest.java:
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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.webservices.xmlrpc;
+
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.apache.xmlrpc.parser.XmlRpcRequestParser;
+import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl;
+import org.apache.xmlrpc.common.TypeFactoryImpl;
+import org.apache.xmlrpc.common.XmlRpcController;
+import org.apache.xmlrpc.server.XmlRpcServer;
+import org.junit.jupiter.api.Test;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+/**
+ * Covers how the XML-RPC endpoint treats vendor extension types.
+ *
+ * <p>Roller's XML-RPC API uses only the standard value types, so the library's
+ * vendor extension types are switched off in <code>web.xml</code> and the
+ * endpoint is closed entirely while the service is disabled.
+ */
+public class XmlRpcExtensionTypeTest {
+
+ private static final Path WEB_XML =
+ Paths.get("src", "main", "webapp", "WEB-INF", "web.xml");
+
+ private String parseRequest(String xml, boolean extensionsEnabled) throws Exception {
+ XmlRpcServer server = new XmlRpcServer();
+ XmlRpcHttpRequestConfigImpl config = new XmlRpcHttpRequestConfigImpl();
+ config.setEnabledForExtensions(extensionsEnabled);
+
+ XmlRpcRequestParser parser = new XmlRpcRequestParser(
+ config, new TypeFactoryImpl((XmlRpcController) server));
+ XMLReader reader = XMLReaderFactory.createXMLReader();
+ reader.setContentHandler(parser);
+ reader.parse(new InputSource(
+ new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8))));
+ return parser.getMethodName();
+ }
+
+ private static final String ORDINARY_REQUEST =
+ "<?xml version=\"1.0\"?><methodCall>"
+ + "<methodName>blogger.getUsersBlogs</methodName>"
+ + "<params><param><value><string>hello</string></value></param></params>"
+ + "</methodCall>";
+
+ /** The shipped configuration must not enable the extension types. */
+ @Test
+ public void shippedConfigurationDisablesExtensionTypes() throws Exception {
+ String webXml = new String(Files.readAllBytes(WEB_XML), StandardCharsets.UTF_8);
+ int idx = webXml.indexOf("enabledForExtensions");
+ assertTrue(idx > 0, "enabledForExtensions param not found in web.xml");
+ String tail = webXml.substring(idx, Math.min(idx + 300, webXml.length()));
+ assertTrue(tail.contains("<param-value>false</param-value>"),
+ "the XML-RPC servlet must not enable vendor extension types:\n" + tail);
+ }
+
+ /** The endpoint is closed by a filter while the service is switched off. */
+ @Test
+ public void endpointIsGatedWhileTheServiceIsDisabled() throws Exception {
+ String webXml = new String(Files.readAllBytes(WEB_XML), StandardCharsets.UTF_8);
+ assertTrue(webXml.contains("XmlRpcEnabledFilter"),
+ "a filter must gate the XML-RPC endpoint");
+ int mapping = webXml.indexOf("<filter-name>XmlRpcEnabledFilter</filter-name>",
+ webXml.indexOf("<filter-mapping>"));
+ assertTrue(mapping > 0, "the gating filter must be mapped");
+ assertTrue(webXml.indexOf("/roller-services/xmlrpc", mapping) > 0,
+ "the gating filter must be mapped to the XML-RPC endpoint");
+ }
+
+ /** Ordinary XML-RPC calls must still parse with extensions disabled. */
Review Comment:
The description says extension types are rejected and the filter is tested, but this class only parses an ordinary call. A request containing `<ex:serializable>` (or `<ex:nil/>`) asserted to fail with extensions disabled, plus an `XmlRpcEnabledFilter` test with a mocked `sendError`, would actually pin the security property this PR introduces.
##########
app/src/test/java/org/apache/roller/weblogger/webservices/xmlrpc/XmlRpcExtensionTypeTest.java:
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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.webservices.xmlrpc;
+
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.apache.xmlrpc.parser.XmlRpcRequestParser;
+import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl;
+import org.apache.xmlrpc.common.TypeFactoryImpl;
+import org.apache.xmlrpc.common.XmlRpcController;
+import org.apache.xmlrpc.server.XmlRpcServer;
+import org.junit.jupiter.api.Test;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+/**
+ * Covers how the XML-RPC endpoint treats vendor extension types.
+ *
+ * <p>Roller's XML-RPC API uses only the standard value types, so the library's
+ * vendor extension types are switched off in <code>web.xml</code> and the
+ * endpoint is closed entirely while the service is disabled.
+ */
+public class XmlRpcExtensionTypeTest {
+
+ private static final Path WEB_XML =
+ Paths.get("src", "main", "webapp", "WEB-INF", "web.xml");
Review Comment:
cwd-relative; surefire sets `project.build.directory` for this module and `ApplicationResourcesTest` / `SQLScriptRunnerTest` derive their paths from it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@roller.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Disable vendor extension types on the XML-RPC servlet [roller]
Posted by "mraible (via GitHub)" <gi...@apache.org>.
mraible commented on code in PR #171:
URL: https://github.com/apache/roller/pull/171#discussion_r3891439538
##########
app/src/test/java/org/apache/roller/weblogger/webservices/xmlrpc/XmlRpcExtensionTypeTest.java:
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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.webservices.xmlrpc;
+
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.apache.xmlrpc.parser.XmlRpcRequestParser;
+import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl;
+import org.apache.xmlrpc.common.TypeFactoryImpl;
+import org.apache.xmlrpc.common.XmlRpcController;
+import org.apache.xmlrpc.server.XmlRpcServer;
+import org.junit.jupiter.api.Test;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+/**
+ * Covers how the XML-RPC endpoint treats vendor extension types.
+ *
+ * <p>Roller's XML-RPC API uses only the standard value types, so the library's
+ * vendor extension types are switched off in <code>web.xml</code> and the
+ * endpoint is closed entirely while the service is disabled.
+ */
+public class XmlRpcExtensionTypeTest {
+
+ private static final Path WEB_XML =
+ Paths.get("src", "main", "webapp", "WEB-INF", "web.xml");
+
+ private String parseRequest(String xml, boolean extensionsEnabled) throws Exception {
+ XmlRpcServer server = new XmlRpcServer();
+ XmlRpcHttpRequestConfigImpl config = new XmlRpcHttpRequestConfigImpl();
+ config.setEnabledForExtensions(extensionsEnabled);
+
+ XmlRpcRequestParser parser = new XmlRpcRequestParser(
+ config, new TypeFactoryImpl((XmlRpcController) server));
+ XMLReader reader = XMLReaderFactory.createXMLReader();
+ reader.setContentHandler(parser);
+ reader.parse(new InputSource(
+ new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8))));
+ return parser.getMethodName();
+ }
+
+ private static final String ORDINARY_REQUEST =
+ "<?xml version=\"1.0\"?><methodCall>"
+ + "<methodName>blogger.getUsersBlogs</methodName>"
+ + "<params><param><value><string>hello</string></value></param></params>"
+ + "</methodCall>";
+
+ /** The shipped configuration must not enable the extension types. */
+ @Test
+ public void shippedConfigurationDisablesExtensionTypes() throws Exception {
+ String webXml = new String(Files.readAllBytes(WEB_XML), StandardCharsets.UTF_8);
+ int idx = webXml.indexOf("enabledForExtensions");
+ assertTrue(idx > 0, "enabledForExtensions param not found in web.xml");
+ String tail = webXml.substring(idx, Math.min(idx + 300, webXml.length()));
+ assertTrue(tail.contains("<param-value>false</param-value>"),
+ "the XML-RPC servlet must not enable vendor extension types:\n" + tail);
+ }
+
+ /** The endpoint is closed by a filter while the service is switched off. */
+ @Test
+ public void endpointIsGatedWhileTheServiceIsDisabled() throws Exception {
+ String webXml = new String(Files.readAllBytes(WEB_XML), StandardCharsets.UTF_8);
+ assertTrue(webXml.contains("XmlRpcEnabledFilter"),
+ "a filter must gate the XML-RPC endpoint");
+ int mapping = webXml.indexOf("<filter-name>XmlRpcEnabledFilter</filter-name>",
+ webXml.indexOf("<filter-mapping>"));
+ assertTrue(mapping > 0, "the gating filter must be mapped");
+ assertTrue(webXml.indexOf("/roller-services/xmlrpc", mapping) > 0,
+ "the gating filter must be mapped to the XML-RPC endpoint");
+ }
+
+ /** Ordinary XML-RPC calls must still parse with extensions disabled. */
Review Comment:
The description says extension types are rejected and the filter is tested, but this class only parses an ordinary call. A request containing `<ex:serializable>` (or `<ex:nil/>`) asserted to fail with extensions disabled, plus an `XmlRpcEnabledFilter` test with a mocked `sendError`, would actually pin the security property this PR introduces.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@roller.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Disable vendor extension types on the XML-RPC servlet [roller]
Posted by "mraible (via GitHub)" <gi...@apache.org>.
mraible commented on code in PR #171:
URL: https://github.com/apache/roller/pull/171#discussion_r3891439511
##########
app/src/main/java/org/apache/roller/weblogger/ui/core/filters/XmlRpcEnabledFilter.java:
##########
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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 javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.roller.weblogger.config.WebloggerRuntimeConfig;
+
+/**
+ * Gates the XML-RPC endpoint on <code>webservices.enableXmlRpc</code>, ahead of
+ * the servlet, so a disabled service is not reachable.
+ */
+public class XmlRpcEnabledFilter implements Filter {
+
+ private static final Log LOG = LogFactory.getLog(XmlRpcEnabledFilter.class);
+
+ @Override
+ public void init(FilterConfig filterConfig) {
+ // nothing to configure
+ }
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response,
+ FilterChain chain) throws IOException, ServletException {
+
+ if (!WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc")) {
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("XML-RPC service is disabled; rejecting request");
+ }
+ ((HttpServletResponse) response).sendError(HttpServletResponse.SC_NOT_FOUND);
Review Comment:
`sendError(404)` gets routed to `/roller-ui/errors/404.jsp`, so a disabled endpoint now answers a desktop client's POST with an HTML page instead of the XML-RPC fault `BLOGGERAPI_DISABLED_MSG` that `BaseAPIHandler` still produces (line 152) but can no longer reach. Clients like MarsEdit will show a generic "invalid response". Consider writing a small XML-RPC fault with `text/xml` here, or at least `setStatus(404)` with a plain-text body so the error JSP isn't rendered.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@roller.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Disable vendor extension types on the XML-RPC servlet [roller]
Posted by "snoopdave (via GitHub)" <gi...@apache.org>.
snoopdave merged PR #171:
URL: https://github.com/apache/roller/pull/171
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@roller.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Disable vendor extension types on the XML-RPC servlet [roller]
Posted by "mraible (via GitHub)" <gi...@apache.org>.
mraible commented on code in PR #171:
URL: https://github.com/apache/roller/pull/171#discussion_r3891439511
##########
app/src/main/java/org/apache/roller/weblogger/ui/core/filters/XmlRpcEnabledFilter.java:
##########
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. 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 javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.roller.weblogger.config.WebloggerRuntimeConfig;
+
+/**
+ * Gates the XML-RPC endpoint on <code>webservices.enableXmlRpc</code>, ahead of
+ * the servlet, so a disabled service is not reachable.
+ */
+public class XmlRpcEnabledFilter implements Filter {
+
+ private static final Log LOG = LogFactory.getLog(XmlRpcEnabledFilter.class);
+
+ @Override
+ public void init(FilterConfig filterConfig) {
+ // nothing to configure
+ }
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response,
+ FilterChain chain) throws IOException, ServletException {
+
+ if (!WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc")) {
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("XML-RPC service is disabled; rejecting request");
+ }
+ ((HttpServletResponse) response).sendError(HttpServletResponse.SC_NOT_FOUND);
Review Comment:
`sendError(404)` gets routed to `/roller-ui/errors/404.jsp`, so a disabled endpoint now answers a desktop client's POST with an HTML page instead of the XML-RPC fault `BLOGGERAPI_DISABLED_MSG` that `BaseAPIHandler` still produces (line 152) but can no longer reach. Clients like `MarsEdit` will show a generic "invalid response". Consider writing a small XML-RPC fault with `text/xml` here, or at least `setStatus(404)` with a plain-text body so the error JSP isn't rendered.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@roller.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org