共用方式為

CA5386:避免將 SecurityProtocolType 值寫入程式碼

  • 發行項
屬性 值
規則識別碼 CA5386
職稱 避免將 SecurityProtocolType 值寫入程式碼
類別 安全性
修正程式是中斷或非中斷 不中斷
預設在 .NET 9 中啟用 No

原因

當符合下列任一條件時，就會引發此規則：

安全值為：

  • Tls12
  • Tls13

檔案描述

傳輸層安全性 (TLS) 最常使用超文字傳輸通訊協定安全 (HTTPS) 保護電腦之間的通訊。 通訊協定版本 TLS 1.0 和 TLS 1.1 已遭取代，而 TLS 1.2 和 TLS 1.3 是最新版本。 在未來，TLS 1.2 和 TLS 1.3 可能已遭取代。 為了確保您的應用程式保持安全，請避免硬式編碼通訊協定版本，並至少以 .NET Framework v4.7.1 為目標。 如需詳細資訊，請參閱 使用 .NET Framework 的傳輸層安全性 （TLS） 最佳做法。

如何修正違規

請勿硬式編碼 TLS 通訊協定版本。

隱藏警告的時機

如果您的應用程式以 .NET Framework v4.6.2 或更早版本為目標，而且可能會在具有不安全預設值的計算機上執行，您可以隱藏此警告。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

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

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

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

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

虛擬程式代碼範例

列舉名稱違規

using System;
using System.Net;

public class ExampleClass
{
    public void ExampleMethod()
    {
        // CA5386 violation
        ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
    }
}

Imports System
Imports System.Net

Public Class TestClass
    Public Sub ExampleMethod()
        ' CA5386 violation
        ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12
    End Sub
End Class

整數值違規

using System;
using System.Net;

public class ExampleClass
{
    public void ExampleMethod()
    {
        // CA5386 violation
        ServicePointManager.SecurityProtocol = (SecurityProtocolType) 3072;    // TLS 1.2
    }
}

Imports System
Imports System.Net

Public Class TestClass
    Public Sub ExampleMethod()
        ' CA5386 violation
        ServicePointManager.SecurityProtocol = CType(3072, SecurityProtocolType)   ' TLS 1.2
    End Sub
End Class

解決方案

using System;
using System.Net;

public class TestClass
{
    public void TestMethod()
    {
        // Let the operating system decide what TLS protocol version to use.
        // See https://learn.microsoft.com/dotnet/framework/network-programming/tls
    }
}

Imports System
Imports System.Net

Public Class TestClass
    Public Sub ExampleMethod()
        ' Let the operating system decide what TLS protocol version to use.
        ' See https://learn.microsoft.com/dotnet/framework/network-programming/tls
    End Sub
End Class

CA5364:請勿使用已取代的安全性通訊協定

CA5397：請勿使用已過時的 SslProtocols 通訊協定

CA5398：避免以硬式編碼方式寫入 SslProtocols 值