This is an automated email from the ASF dual-hosted git repository.
pjfanning pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/poi-xmlbeans.git
The following commit(s) were added to refs/heads/trunk by this push:
new 9d892c9d Close the .xsb stream when XsbDumper fails part-way through a
file (#109)
9d892c9d is described below
commit 9d892c9dfcf484a9c5f77ede7157e7f4529c1e3b
Author: PJ Fanning <[email protected]>
AuthorDate: Mon Sep 7 12:56:10 2026 +0100
Close the .xsb stream when XsbDumper fails part-way through a file (#109)
XsbDumper owns the stream it is handed - dumpAll() closes it via readEnd()
on
the way out. But every read goes through error(), which throws
IllegalStateException, so a truncated or corrupt .xsb aborts the dump with
the
stream still open.
That matters for the directory and jar walks: dump(File) recurses over a
whole
tree, and dumpZip's try-with-resources catches only IOException, so an
IllegalStateException from one bad entry escapes with that entry's stream
leaked.
Run the dispatch in a try/finally so readEnd() always runs, and null-guard
readEnd() since dumpIndexData() already calls it on its own success path.
Co-authored-by: Claude Opus 5 (1M context) <[email protected]>
---
.../org/apache/xmlbeans/impl/tool/XsbDumper.java | 57 ++++++++------
.../xmlbeans/impl/tool/XsbDumperStreamTest.java | 89 ++++++++++++++++++++++
2 files changed, 121 insertions(+), 25 deletions(-)
diff --git a/src/main/java/org/apache/xmlbeans/impl/tool/XsbDumper.java
b/src/main/java/org/apache/xmlbeans/impl/tool/XsbDumper.java
index 2a1a8e04..856326b9 100644
--- a/src/main/java/org/apache/xmlbeans/impl/tool/XsbDumper.java
+++ b/src/main/java/org/apache/xmlbeans/impl/tool/XsbDumper.java
@@ -353,31 +353,36 @@ public class XsbDumper {
}
void dumpAll() {
- int filetype = dumpHeader();
- switch (filetype) {
- case FILETYPE_SCHEMAINDEX:
- dumpIndexData();
- return;
- case FILETYPE_SCHEMATYPE:
- dumpTypeFileData();
- break;
- case FILETYPE_SCHEMAELEMENT:
- dumpParticleData(true);
- break;
- case FILETYPE_SCHEMAATTRIBUTE:
- dumpAttributeData(true);
- break;
- case FILETYPE_SCHEMAPOINTER:
- dumpPointerData();
- break;
- case FILETYPE_SCHEMAMODELGROUP:
- dumpModelGroupData();
- break;
- case FILETYPE_SCHEMAATTRIBUTEGROUP:
- dumpAttributeGroupData();
- break;
+ try {
+ int filetype = dumpHeader();
+ switch (filetype) {
+ case FILETYPE_SCHEMAINDEX:
+ dumpIndexData();
+ break;
+ case FILETYPE_SCHEMATYPE:
+ dumpTypeFileData();
+ break;
+ case FILETYPE_SCHEMAELEMENT:
+ dumpParticleData(true);
+ break;
+ case FILETYPE_SCHEMAATTRIBUTE:
+ dumpAttributeData(true);
+ break;
+ case FILETYPE_SCHEMAPOINTER:
+ dumpPointerData();
+ break;
+ case FILETYPE_SCHEMAMODELGROUP:
+ dumpModelGroupData();
+ break;
+ case FILETYPE_SCHEMAATTRIBUTEGROUP:
+ dumpAttributeGroupData();
+ break;
+ }
+ } finally {
+ // the dumper owns the stream it was handed, and error() throws
part-way
+ // through a truncated file
+ readEnd();
}
- readEnd();
}
static String hex32String(int i) {
@@ -627,7 +632,9 @@ public class XsbDumper {
void readEnd() {
try {
- _input.close();
+ if (_input != null) {
+ _input.close();
+ }
} catch (IOException e) {
// oh, well.
}
diff --git
a/src/test/java/org/apache/xmlbeans/impl/tool/XsbDumperStreamTest.java
b/src/test/java/org/apache/xmlbeans/impl/tool/XsbDumperStreamTest.java
new file mode 100644
index 00000000..9ec6373c
--- /dev/null
+++ b/src/test/java/org/apache/xmlbeans/impl/tool/XsbDumperStreamTest.java
@@ -0,0 +1,89 @@
+/* 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.xmlbeans.impl.tool;
+
+import org.junit.jupiter.api.Test;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.PrintStream;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class XsbDumperStreamTest {
+
+ private static class TrackingInputStream extends ByteArrayInputStream {
+ private boolean closed;
+
+ TrackingInputStream(byte[] bytes) {
+ super(bytes);
+ }
+
+ @Override
+ public void close() throws IOException {
+ closed = true;
+ super.close();
+ }
+ }
+
+ private static final PrintStream SINK = new PrintStream(new OutputStream()
{
+ @Override
+ public void write(int b) {
+ }
+ });
+
+ // A readable .xsb header of the given type, followed by an empty string
pool and
+ // nothing else - the body dump then runs off the end of the file.
+ private static byte[] truncated(int filetype) throws IOException {
+ ByteArrayOutputStream bos = new ByteArrayOutputStream();
+ DataOutputStream dos = new DataOutputStream(bos);
+ dos.writeInt(XsbDumper.DATA_BABE);
+ dos.writeShort(XsbDumper.MAJOR_VERSION);
+ dos.writeShort(XsbDumper.MINOR_VERSION);
+ dos.writeShort(0); // release number
+ dos.writeShort(filetype);
+ dos.writeShort(1); // string pool holding no entries
+ dos.flush();
+ return bos.toByteArray();
+ }
+
+ private static void assertClosedAfterFailedDump(int filetype) throws
IOException {
+ TrackingInputStream stream = new
TrackingInputStream(truncated(filetype));
+
+ assertThrows(IllegalStateException.class, () -> XsbDumper.dump(stream,
"", SINK));
+ assertTrue(stream.closed, "the dumped .xsb stream should have been
closed");
+ }
+
+ @Test
+ void closesStreamOnTruncatedIndex() throws IOException {
+ assertClosedAfterFailedDump(XsbDumper.FILETYPE_SCHEMAINDEX);
+ }
+
+ @Test
+ void closesStreamOnTruncatedType() throws IOException {
+ assertClosedAfterFailedDump(XsbDumper.FILETYPE_SCHEMATYPE);
+ }
+
+ @Test
+ void closesStreamOnTruncatedPointer() throws IOException {
+ assertClosedAfterFailedDump(XsbDumper.FILETYPE_SCHEMAPOINTER);
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]