CA5382:在 ASP.NET Core 中使用安全 Cookie

属性 值
规则 ID CA5382
Title 在 ASP.NET Core 中使用安全 Cookie
类别 Security
修复是中断修复还是非中断修复 非中断
在 .NET 10 中默认启用 否
默认在 .NET 11 中启用 否
适用的语言 C# 和 Visual Basic

原因

调用 Microsoft.AspNetCore.Http.CookieOptions.Secure 时,false 属性设置为 Microsoft.AspNetCore.Http.IResponseCookies.Append。 现在,此规则仅查看 Microsoft.AspNetCore.Http.Internal.ResponseCookies 类,这是 IResponseCookies 的其中一个实现。

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

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

规则说明

HTTPS 上可用的应用程序必须使用安全 Cookie,这会向浏览器指示,Cookie 只能使用传输层安全性 (TLS) 进行传输。

如何解决违规

将 Secure 属性设置为 true。

何时禁止显示警告

  • 如果 Cookie 默认配置为安全,例如在 Microsoft.AspNetCore.CookiePolicy.CookiePolicyMiddleware 中使用 Startup.Configure:

    public class Startup
    {
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseCookiePolicy(
                new CookiePolicyOptions
                {
                    Secure = CookieSecurePolicy.Always
                });
        }
    }
    
  • 如果你确定 Cookie 中没有敏感数据。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

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

排除特定符号

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

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

注意

将 XXXX 的 CAXXXX 部分替换为适用规则的 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

注意

将 XXXX 的 CAXXXX 部分替换为适用规则的 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 Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Internal;

class ExampleClass
{
    public void ExampleMethod(string key, string value)
    {
        var cookieOptions = new CookieOptions();
        cookieOptions.Secure = false;
        var responseCookies = new ResponseCookies(null, null);
        responseCookies.Append(key, value, cookieOptions);
    }
}

解决方案:

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Internal;

class ExampleClass
{
    public void ExampleMethod(string key, string value)
    {
        var cookieOptions = new CookieOptions();
        cookieOptions.Secure = true;
        var responseCookies = new ResponseCookies(null, null);
        responseCookies.Append(key, value, cookieOptions);
    }
}