CA5370：将 XmlReader 用于验证读取器

  • 项目
属性 值
规则 ID CA5370
标题 将 XmlReader 用于验证读取器
类别 安全性
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 否

原因

验证具有未使用 XmlReader 对象实例化的 XmlValidatingReader 类的不受信任 XML 输入可能会导致拒绝服务、信息泄露和服务器端请求伪造。 不受信任的 DTD 和 XML 架构处理使这些攻击成为可能，这使攻击者能在 XML 中包含 XML 炸弹和恶意的外部实体。 只有使用 XmlReader 才可以禁用 DTD。 从 .NET Framework 版本 4.0 开始，作为 XmlReader 的内联 XML 架构处理会默认将 ProhibitDtd 和 ProcessInlineSchema 属性设置为 false。

规则说明

处理不受信任的 DTD 和 XML 架构时可能会加载危险的外部引用。 可以通过将 XmlReader 与安全解析程序结合使用，或者禁用 DTD 和 XML 内联架构处理来限制这种危险加载行为。 此规则检测使用 XmlValidatingReader 类但不接受 XmlReader 作为构造函数参数的代码。

如何解决冲突

  • 将 XmlValidatingReader(XmlReader) 和 ProhibitDtd 一起使用，并将 ProcessInlineSchema 属性设置为 false。
  • 从 .NET Framework 2.0 开始，XmlValidatingReader 被视为已过时。 可以使用 XmlReader.Create 实例化验证读取器。

何时禁止显示警告

如果始终将 XmlValidatingReader 用于验证来自受信任源的 XML，并且因此无法对其进行篡改，则可禁止显示此警告。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable CA5370
// The code that's violating the rule is on this line.
#pragma warning restore CA5370

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

[*.{cs,vb}]
dotnet_diagnostic.CA5370.severity = none

有关详细信息，请参阅如何禁止显示代码分析警告。

伪代码示例

冲突

下面的伪代码示例演示了此规则可检测的情况。 XmlValidatingReader.XmlValidatingReader() 的第一个参数的类型不是 XmlReader。

using System;
using System.IO;
using System.Xml;
...
public void TestMethod(Stream xmlFragment, XmlNodeType fragType, XmlParserContext context)
{
    var obj = new XmlValidatingReader(xmlFragment, fragType, context);
}

解决方案

using System;
using System.Xml;
...
public void TestMethod(XmlReader xmlReader)
{
    var obj = new XmlValidatingReader(xmlReader);
}