java - Sonar : Disable XML external entity (XXE) processing

Question

我正在使用 javax.xml.validation.Validator 来验证我的 xml，如下所示

        private final Validator validator;
        ...

        SchemaFactory factory = SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema");
        factory.setProperty(XMLConstants.ACCESS_EXTERNAL_DTD, "");
        factory.setProperty(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
        Schema schema = factory.newSchema(new File(getResource(path)));
        validator = schema.newValidator();
        validator.setProperty(XMLConstants.ACCESS_EXTERNAL_DTD, "");
        validator.setProperty(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");

知道 Sonar 为什么说此代码不合规吗？

Answer 1

您必须将 XMLConstants.ACCESS_EXTERNAL_DTD 和 XMLConstants.ACCESS_EXTERNAL_SCHEMA 设置为“”。

以下代码不会违反 SonarLint 和 SonarQube。

private Validator validator;
...
    
SchemaFactory factory = SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema");
Schema schema = factory.newSchema(new File(getResource(path)));
validator = schema.newValidator();
validator.setProperty(XMLConstants.ACCESS_EXTERNAL_DTD, "");
validator.setProperty(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");

然后，在您验证它的地方阻止外部实体。例如，如果您使用的是 STAX 解析器。然后将 XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES 和 XMLInputFactory.SUPPORT_DTD 设置为 False。

XMLInputFactory factory = XMLInputFactory.newInstance();
factory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.FALSE);
factory.setProperty(XMLInputFactory.SUPPORT_DTD, Boolean.FALSE);
validator.validate(new StAXSource(factory.createXMLStreamReader(inputStream)));

如果您使用的是 sonarLint，则通过删除项目的目标文件夹来清理缓存。

更多信息: https://rules.sonarsource.com/java/RSPEC-2755