CA5397: Não use valores SslProtocols preteridos

Motivo

Esta regra é acionada quando uma das seguintes condições é atendida:

• Um valor preterido System.Security.Authentication.SslProtocols foi referenciado.
• Um valor inteiro que representa um valor preterido foi atribuído a uma SslProtocols variável, usado como um SslProtocols valor de retorno ou usado como um SslProtocols argumento.

Os valores preteridos são:

• Ssl2
• Ssl3
• Tls
• TLS10
• TLS11

Descrição da regra

Transport Layer Security (TLS) protege a comunicação entre computadores, mais comumente com HTTPS (Hypertext Transfer Protocol Secure). As versões de protocolo mais antigas do TLS são menos seguras do que o TLS 1.2 e o TLS 1.3 e são mais propensas a ter novas vulnerabilidades. Evite versões de protocolo mais antigas para minimizar o risco. Para obter orientação sobre como identificar e remover versões de protocolo obsoletas, consulte Resolvendo o problema do TLS 1.0, 2ª edição.

Como corrigir violações

Não use versões preteridas do protocolo TLS.

Quando suprimir avisos

Pode suprimir este aviso se:

• A referência à versão de protocolo preterida não está sendo usada para habilitar uma versão preterida.
• Você precisa se conectar a um serviço herdado que não pode ser atualizado para usar configurações TLS seguras.

Suprimir um aviso

Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.

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

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

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

Para obter mais informações, consulte Como suprimir avisos de análise de código.

Exemplos de pseudocódigo

Violação de nome de enumeração

using System;
using System.Security.Authentication;

public class ExampleClass
{
    public void ExampleMethod()
    {
        // CA5397 violation for using Tls11
        SslProtocols protocols = SslProtocols.Tls11 | SslProtocols.Tls12;
    }
}

Imports System
Imports System.Security.Authentication

Public Class TestClass
    Public Sub ExampleMethod()
        ' CA5397 violation for using Tls11
        Dim sslProtocols As SslProtocols = SslProtocols.Tls11 Or SslProtocols.Tls12
    End Sub
End Class

Violação de valor inteiro

using System;
using System.Security.Authentication;

public class ExampleClass
{
    public void ExampleMethod()
    {
        // CA5397 violation
        SslProtocols sslProtocols = (SslProtocols) 768;    // TLS 1.1
    }
}

Imports System
Imports System.Security.Authentication

Public Class TestClass
    Public Sub ExampleMethod()
        ' CA5397 violation
        Dim sslProtocols As SslProtocols = CType(768, SslProtocols)   ' TLS 1.1
    End Sub
End Class

Solução

using System;
using System.Security.Authentication;

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

Imports System
Imports System.Security.Authentication

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
        Dim sslProtocols As SslProtocols = SslProtocols.None
    End Sub
End Class

Regras conexas

CA5364: Não use protocolos de segurança preteridos

CA5386: Evite codificar o valor SecurityProtocolType

CA5398: Evite valores SslProtocols codificados