CA5399:启用 HttpClient 证书吊销列表检查

属性 值
规则 ID CA5399
Title 启用 HttpClient 证书吊销列表检查
类别 Security
修复是中断修复还是非中断修复 非破坏性
在 .NET 10 中默认启用 否
默认在 .NET 11 中启用 否
适用的语言 C# 和 Visual Basic

原因

使用 System.Net.Http.HttpClient 的同时提供其 CheckCertificateRevocationList 属性未设置为 true 的平台特定处理程序(System.Net.Http.WinHttpHandler 或 System.Net.Http.HttpClientHandler),将允许 HttpClient 将已撤销的证书视为有效而接受。

此规则类似于 CA5400,但分析可以确定 CheckCertificateRevocationList 属性是否一定为 false 或未设置。

规则说明

撤销的证书不再受信任。 它可能被攻击者用来传递某些恶意数据或窃取 HTTPS 通信中的敏感数据。

如何修复违规问题

将 System.Net.Http.HttpClientHandler.CheckCertificateRevocationList 属性显式设置为 true。 如果 CheckCertificateRevocationList 属性不可用,则需要升级目标框架。

何时抑制警告

请勿禁止显示此规则的警告。

配置代码以进行分析

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

你可以仅针对此规则、针对适用的所有规则或针对此类别(安全)中适用的所有规则配置这些选项。 有关详细信息,请参阅代码质量规则配置选项。

排除特定符号

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

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

注意

将 CAXXXX 中的 XXXX 部分替换为适用规则的 ID。

选项值中允许的符号名称格式(用 | 分隔):

  • 仅符号名称(包括具有相应名称的所有符号,不考虑包含的类型或命名空间)。
  • 完全限定的名称,使用符号的文档 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。

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

你可以通过设置 excluded_type_names_with_derived_types 选项从分析中排除特定类型及其派生类型。 例如,若要指定规则不应针对名为 MyType 的类型及其派生类型中的任何方法运行,请将以下键值对添加到项目中的 .editorconfig 文件:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

注意

将 CAXXXX 中的 XXXX 部分替换为适用规则的 ID。

选项值中允许的符号名称格式(用 | 分隔):

  • 仅类型名称(包括具有相应名称的所有类型,不考虑包含的类型或命名空间)。
  • 完全限定的名称,使用符号的文档 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.Net.Http;

class ExampleClass
{
    void ExampleMethod()
    {
        WinHttpHandler winHttpHandler = new WinHttpHandler();
        winHttpHandler.CheckCertificateRevocationList = false;
        HttpClient httpClient = new HttpClient(winHttpHandler);
    }
}

解决方案

using System.Net.Http;

class ExampleClass
{
    void ExampleMethod()
    {
        WinHttpHandler winHttpHandler = new WinHttpHandler();
        winHttpHandler.CheckCertificateRevocationList = true;
        HttpClient httpClient = new HttpClient(winHttpHandler);
    }
}