CA5404：不要禁用令牌验证检查

项目
11/15/2023

属性	值
规则 ID	CA5404
标题	请勿禁用令牌验证检查
类别	安全性
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	否

原因

将 TokenValidationParameters 属性 RequireExpirationTime、ValidateAudience、ValidateIssuer 或 ValidateLifetime 设置为 false。

规则说明

令牌验证检查确保在验证令牌时分析并验证所有方面。禁用验证会允许不受信任的令牌通过验证，从而可能导致安全漏洞。

有关令牌验证最佳做法的更多详细信息，可参阅库的 Wiki。

如何解决冲突

将 TokenValidationParameters 属性 RequireExpirationTime、ValidateAudience、ValidateIssuer 或 ValidateLifetime 设置为 true。或者，删除对 false 的赋值，因为默认值为 true。

何时禁止显示警告

在大多数情况下，此验证对于确保使用方应用的安全性至关重要。但是，在某些情况下不需要此验证，尤其是在非标准令牌类型中。在禁用此验证之前，请务必充分考虑安全后果。有关利弊的信息，请参阅令牌验证库的 Wiki。

抑制警告

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

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

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

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

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

伪代码示例

using System;
using Microsoft.IdentityModel.Tokens;

class TestClass
{
    public void TestMethod()
    {
        TokenValidationParameters parameters = new TokenValidationParameters();
        parameters.RequireExpirationTime = false;
        parameters.ValidateAudience = false;
        parameters.ValidateIssuer = false;
        parameters.ValidateLifetime = false;
    }
}

解决方案

using System;
using Microsoft.IdentityModel.Tokens;

class TestClass
{
    public void TestMethod()
    {
        TokenValidationParameters parameters = new TokenValidationParameters();
        parameters.RequireExpirationTime = true;
        parameters.ValidateAudience = true;
        parameters.ValidateIssuer = true;
        parameters.ValidateLifetime = true;
    }
}