CA3004：查看信息泄露漏洞的代码

值

规则 ID

CA3004

类别

安全性

修复是中断修复还是非中断修复

非中断

原因

异常消息、堆栈跟踪或字符串表示形式访问 Web 输出。

默认情况下，此规则会分析整个代码库，但这是可配置的。

规则说明

泄漏异常信息可让攻击者深入了解应用程序的内部机制，从而帮助攻击者找到其他漏洞并利用这些漏洞。

此规则试图查找输出到 HTTP 响应的异常消息、堆栈跟踪或字符串表示形式。

备注

此规则无法跨程序集跟踪数据。 例如，如果一个程序集捕获一个异常，然后将其传递给会输出该异常的另一个程序集，则此规则不会产生警告。

备注

对于此规则跨方法调用分析数据流的深入程度存在限制，此限制是可配置的。 若要了解如何在 EditorConfig 文件中配置此限制，请参阅分析器配置。

如何解决冲突

不要将异常信息输出到 HTTP 响应。 相反，提供一个一般的错误信息。 有关详细信息，请参阅 OWASP 的“以不当方式处理错误”页面。

何时禁止显示警告

如果你确定 Web 输出在应用程序的信任边界内并且从未在外部公开，则可以禁止显示此警告。 这种情况很罕见。 请注意，应用程序的信任边界和数据流可能会随时间发生变化。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

排除特定符号

排除特定类型及其派生类型

你可以仅为此规则、为所有规则或为此类别（安全性）中的所有规则配置这些选项。 有关详细信息，请参阅代码质量规则配置选项。

排除特定符号

可以从分析中排除特定符号，如类型和方法。 例如，若要指定规则不应针对名为 MyType 的类型中的任何代码运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

选项值中允许的符号名称格式（用 | 分隔）：

仅符号名称（包括具有相应名称的所有符号，不考虑包含的类型或命名空间）。

完全限定的名称，使用符号的文档 ID 格式。 每个符号名称都需要带有一个符号类型前缀，例如表示方法的 M:、表示类型的 T:，以及表示命名空间的 N:。

.ctor 表示构造函数，.cctor 表示静态构造函数。

示例：

选项值

总结

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

匹配名为 MyType 的所有符号。

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1|MyType2

匹配名为 MyType1 或 MyType2 的所有符号。

dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)

匹配带有指定的完全限定签名的特定方法 MyMethod。

dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)|M:NS2.MyType2.MyMethod2(ParamType)

匹配带有各自的完全限定签名的特定方法 MyMethod1 和 MyMethod2。

排除特定类型及其派生类型

可以从分析中排除特定类型及其派生类型。 例如，若要指定规则不应针对名为 MyType 的类型及其派生类型中的任何代码运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

选项值中允许的符号名称格式（用 | 分隔）：

仅类型名称（包括具有相应名称的所有类型，不考虑包含的类型或命名空间）。

完全限定的名称，使用符号的文档 ID 格式，前缀为 T:（可选）。

示例：

选项值

总结

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

匹配名为 MyType 的所有类型及其所有派生类型。

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2

匹配名为 MyType1 或 MyType2 的所有类型及其所有派生类型。

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType

匹配带有给定的完全限定名称的特定类型 MyType 及其所有派生类型。

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1|M:NS2.MyType2

匹配带有各自的完全限定名称的特定类型 MyType1 和 MyType2 及其所有派生类型。

伪代码示例

冲突

using System;

public partial class WebForm : System.Web.UI.Page

{

protected void Page_Load(object sender, EventArgs eventArgs)

{

try

{

object o = null;

o.ToString();

}

catch (Exception e)

{

this.Response.Write(e.ToString());

}

}

}

Imports System

Partial Public Class WebForm

Inherits System.Web.UI.Page

Protected Sub Page_Load(sender As Object, eventArgs As EventArgs)

Try

Dim o As Object = Nothing

o.ToString()

Catch e As Exception

Me.Response.Write(e.ToString())

End Try

End Sub

End Class

解决方案

using System;

public partial class WebForm : System.Web.UI.Page

{

protected void Page_Load(object sender, EventArgs eventArgs)

{

try

{

object o = null;

o.ToString();

}

catch (Exception e)

{

this.Response.Write("An error occurred. Please try again later.");

}

}

}

Imports System

Partial Public Class WebForm

Inherits System.Web.UI.Page

Protected Sub Page_Load(sender As Object, eventArgs As EventArgs)

Try

Dim o As Object = Nothing

o.ToString()

Catch e As Exception

Me.Response.Write("An error occurred. Please try again later.")

End Try

End Sub

End Class