XMLFactorySAX secure version #87

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- XMLFactorySAX.newInstanceSecure() disabling external entities <https://github.com/fugerit-org/fj-lib/issues/87>
+
 ### Changed
 
 - Added 'ubuntu-24.04-arm' runner to compatibility workdlow

fj-core/src/main/java/org/fugerit/java/core/xml/sax/XMLFactorySAX.java

@@ -29,26 +29,69 @@ public XMLValidator newXMLValidator(EntityResolver er) throws XMLException {
     public static SAXParser makeSAXParser(boolean val, boolean nsa) throws XMLException {
         return (newInstance(val, nsa).newSAXParser());
     }
+
+    public static SAXParser makeSAXParserSecure(boolean val, boolean nsa) throws XMLException {
+        return (newInstanceSecure(val, nsa).newSAXParser());
+    }
 
     public SAXParser newSAXParser() throws XMLException {
     	return SafeFunction.getEx( () -> this.factory.newSAXParser(), XMLException.CONVERT_FUN );
     }
 
     public static XMLFactorySAX newInstance() throws XMLException {
         return newInstance(false, false);
-    }    
+    }
+
+    public static XMLFactorySAX newInstanceSecure() throws XMLException {
+        return newInstanceSecure(false);
+    }
 
     public static XMLFactorySAX newInstance(boolean validating) throws XMLException {
         return newInstance(validating, false);
     }
-
+
+    public static XMLFactorySAX newInstanceSecure(boolean validating) throws XMLException {
+        return newInstanceSecure(validating, false);
+    }
+
+    public static XMLFactorySAX newInstanceSecure(boolean validating, boolean namespaceAware) throws XMLException {
+        return newInstance( validating, namespaceAware, Boolean.TRUE );
+    }
+
     public static XMLFactorySAX newInstance(boolean validating, boolean namespaceAware) throws XMLException {
-    	return XMLException.get( () -> {
-    		SAXParserFactory saxFac = SAXParserFactory.newInstance();
-            saxFac.setValidating(validating);
-            saxFac.setNamespaceAware(namespaceAware);
-            return new XMLFactorySAX(saxFac);
-    	} );
+        return newInstance( validating, namespaceAware, Boolean.FALSE );
+    }
+
+    /**
+     * Creates a new XMLFactorySAX wrapping a javax.xml.parsers.SAXParserFactory
+     *
+     * if the secure flag is set, the external entities will be disabled :
+     *
+         factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
+         factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
+         factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
+         factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
+     *
+     * @param validating        to set the XMLFactorySAX as validating
+     * @param namespaceAware    to set the XMLFactorySAX as namespaceAware
+     * @param secure            to set the XMLFactorySAX as secure (external entities disabled)
+     * @return                  the new configured XMLFactorySAX
+     * @throws XMLException     in case any issue arise
+     */
+    public static XMLFactorySAX newInstance(boolean validating, boolean namespaceAware, boolean secure) throws XMLException {
+        return XMLException.get( () -> {
+            SAXParserFactory factory = SAXParserFactory.newInstance();
+            factory.setValidating(validating);
+            factory.setNamespaceAware(namespaceAware);
+            if ( secure ) {
+                factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
+                factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
+                factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
+                factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
+                factory.setXIncludeAware(false);
+            }
+            return new XMLFactorySAX( factory );
+        } );
     }
 
     public void setValidating(boolean val) {

fj-core/src/test/java/test/org/fugerit/java/core/xml/sax/TestXmlFactorySAX.java

@@ -28,6 +28,14 @@ public void test1() throws XMLException {
 		boolean ok = this.worker( XMLFactorySAX.newInstance() );
 		Assert.assertTrue(ok);
 	}
+
+	@Test
+	public void testSecure() throws XMLException {
+		Assert.assertNotNull( XMLFactorySAX.makeSAXParserSecure( true, true ) );
+		Assert.assertTrue( this.worker( XMLFactorySAX.newInstanceSecure() ) );
+		Assert.assertTrue( this.worker( XMLFactorySAX.newInstanceSecure( true ) ) );
+		Assert.assertTrue( this.worker( XMLFactorySAX.newInstanceSecure( true, true ) ) );
+	}
 
 	@Test
 	public void test2() throws XMLException {