Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JENKINS-73687] Make deserialization of Map fields in XML files more robust #9653

Merged
merged 2 commits into from
Sep 13, 2024
Merged

[JENKINS-73687] Make deserialization of Map fields in XML files more robust #9653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2a80d3
Improve resilience against malformed XML files during deserialization
dwnusbaum Aug 23, 2024
41433d8
Improve error message
dwnusbaum Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions core/src/main/java/hudson/util/RobustMapConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
package hudson.util;

import com.thoughtworks.xstream.XStreamException;
import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.converters.UnmarshallingContext;
import com.thoughtworks.xstream.converters.collections.MapConverter;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;
Expand Down Expand Up @@ -64,6 +65,12 @@ final class RobustMapConverter extends MapConverter {
}

private Object read(HierarchicalStreamReader reader, UnmarshallingContext context, Map map) {
if (!reader.hasMoreChildren()) {
var exception = new ConversionException("Invalid map entry");
reader.appendErrors(exception);
RobustReflectionConverter.addErrorInContext(context, exception);
return ERROR;
}
reader.moveDown();
try {
return readBareItem(reader, context, map);
Expand Down
45 changes: 45 additions & 0 deletions core/src/test/java/hudson/util/RobustMapConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
package hudson.util;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThrows;
Expand Down Expand Up @@ -142,4 +143,48 @@ private Map<Object, Object> preparePayload() {
}
return map;
}

@Test
public void robustAgainstInvalidEntry() {
XStream2 xstream2 = new XStream2();
String xml =
"""
<hudson.util.RobustMapConverterTest_-Data>
<map>
<string>key1</string>
<entry>
<string>key2</string>
<string>value2</string>
</entry>
</map>
</hudson.util.RobustMapConverterTest_-Data>
""";
Data data = (Data) xstream2.fromXML(xml);
assertThat(data.map, equalTo(Map.of("key2", "value2")));
}

@Test
public void robustAgainstInvalidEntryWithNoValue() {
XStream2 xstream2 = new XStream2();
String xml =
"""
<hudson.util.RobustMapConverterTest_-Data>
<map>
<entry>
<string>key1</string>
</entry>
<entry>
<string>key2</string>
<string>value2</string>
</entry>
</map>
</hudson.util.RobustMapConverterTest_-Data>
""";
Data data = (Data) xstream2.fromXML(xml);
assertThat(data.map, equalTo(Map.of("key2", "value2")));
}

private static final class Data {
Map<String, String> map;
}
}
Loading