SslStream.AuthenticateAsClientAsync Método

Definição

Namespace:

System.Net.Security

Assemblies:

netstandard.dll, System.Net.Security.dll

Autentique o lado do cliente de uma conexão cliente-servidor como uma operação assíncrona.

Sobrecargas

Nome	Description
AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)	Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona. O processo de autenticação usa a coleção de certificados e o protocolo SSL especificados.
AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)	Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona. O processo de autenticação usa a coleção de certificados especificada e o protocolo SSL padrão do sistema.
AuthenticateAsClientAsync(String)	Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona.
AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)	Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona. O processo de autenticação usa informações especificadas no recipiente de sslClientAuthenticationOptions propriedades.

AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)

Origem:

SslStream.cs

Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona. O processo de autenticação usa a coleção de certificados e o protocolo SSL especificados.

public:
 virtual System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::String ^ targetHost, System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ clientCertificates, System::Security::Authentication::SslProtocols enabledSslProtocols, bool checkCertificateRevocation);

public virtual System.Threading.Tasks.Task AuthenticateAsClientAsync(string targetHost, System.Security.Cryptography.X509Certificates.X509CertificateCollection? clientCertificates, System.Security.Authentication.SslProtocols enabledSslProtocols, bool checkCertificateRevocation);

abstract member AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * System.Security.Authentication.SslProtocols * bool -> System.Threading.Tasks.Task
override this.AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * System.Security.Authentication.SslProtocols * bool -> System.Threading.Tasks.Task

Public Overridable Function AuthenticateAsClientAsync (targetHost As String, clientCertificates As X509CertificateCollection, enabledSslProtocols As SslProtocols, checkCertificateRevocation As Boolean) As Task

Parâmetros

targetHost

String

O nome do servidor que compartilhará isso SslStream.

clientCertificates

X509CertificateCollection

O X509CertificateCollection que contém certificados de cliente.

enabledSslProtocols

SslProtocols

O SslProtocols valor que representa os protocolos usados para autenticação.

checkCertificateRevocation

Boolean

Um Boolean valor que especifica se a lista de revogação de certificados é verificada durante a autenticação.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

AuthenticationException

A autenticação falhou e deixou esse objeto em um estado inutilizável.

InvalidOperationException

A autenticação já ocorreu.

- ou -

A autenticação do servidor usando isso SslStream foi tentada anteriormente.

- ou -

A autenticação já está em andamento.

ObjectDisposedException

Este objeto foi fechado.

Comentários

A partir do .NET Framework 4.7, esse método é autenticado usando None, o que permite ao sistema operacional escolher o melhor protocolo a ser usado e bloquear protocolos que não são seguros. No .NET Framework 4.6 (e no .NET Framework 4.5 com os patches de segurança mais recentes instalados), as versões de protocolos TLS/SSL permitidas são 1.2, 1.1 e 1.0 (a menos que você desabilite criptografia forte editando o Registro do Windows).

Quando a autenticação for bem-sucedida, você deverá verificar as IsEncrypted propriedades e IsSigned as propriedades para determinar quais serviços de segurança são usados pelo SslStream. Verifique a IsMutuallyAuthenticated propriedade para determinar se a autenticação mútua ocorreu.

Se a autenticação falhar, você receberá um AuthenticationExceptione isso SslStream não será mais utilizável. Você deve fechar esse objeto e remover todas as referências a ele para que ele possa ser coletado pelo coletor de lixo.

Observação

Não há suporte para certificados de cliente no protocolo SSL versão 2.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por AuthenticateAsClient(String, X509CertificateCollection, SslProtocols, Boolean).

AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)

Origem:

SslStream.cs

Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona. O processo de autenticação usa a coleção de certificados especificada e o protocolo SSL padrão do sistema.

public:
 virtual System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::String ^ targetHost, System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ clientCertificates, bool checkCertificateRevocation);

public virtual System.Threading.Tasks.Task AuthenticateAsClientAsync(string targetHost, System.Security.Cryptography.X509Certificates.X509CertificateCollection? clientCertificates, bool checkCertificateRevocation);

abstract member AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * bool -> System.Threading.Tasks.Task
override this.AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * bool -> System.Threading.Tasks.Task

Public Overridable Function AuthenticateAsClientAsync (targetHost As String, clientCertificates As X509CertificateCollection, checkCertificateRevocation As Boolean) As Task

Parâmetros

targetHost

String

O nome do servidor que compartilhará isso SslStream.

clientCertificates

X509CertificateCollection

O X509CertificateCollection que contém certificados de cliente.

checkCertificateRevocation

Boolean

Um Boolean valor que especifica se a lista de revogação de certificados é verificada durante a autenticação.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

AuthenticationException

A autenticação falhou e deixou esse objeto em um estado inutilizável.

InvalidOperationException

A autenticação já ocorreu.

- ou -

A autenticação do servidor usando isso SslStream foi tentada anteriormente.

- ou -

A autenticação já está em andamento.

ObjectDisposedException

Este objeto foi fechado.

Comentários

A partir do .NET Framework 4.7, esse método é autenticado usando None, o que permite ao sistema operacional escolher o melhor protocolo a ser usado e bloquear protocolos que não são seguros. No .NET Framework 4.6 (e no .NET Framework 4.5 com os patches de segurança mais recentes instalados), as versões de protocolos TLS/SSL permitidas são 1.2, 1.1 e 1.0 (a menos que você desabilite criptografia forte editando o Registro do Windows).

Quando a autenticação for bem-sucedida, você deverá verificar as IsEncrypted propriedades e IsSigned as propriedades para determinar quais serviços de segurança são usados pelo SslStream. Verifique a IsMutuallyAuthenticated propriedade para determinar se a autenticação mútua ocorreu.

Se a autenticação falhar, você receberá um AuthenticationExceptione isso SslStream não será mais utilizável. Você deve fechar esse objeto e remover todas as referências a ele para que ele possa ser coletado pelo coletor de lixo.

Observação

Não há suporte para certificados de cliente no protocolo SSL versão 2.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por AuthenticateAsClient(String, X509CertificateCollection, Boolean).

AuthenticateAsClientAsync(String)

Origem:

SslStream.cs

Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona.

public:
 virtual System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::String ^ targetHost);

public virtual System.Threading.Tasks.Task AuthenticateAsClientAsync(string targetHost);

abstract member AuthenticateAsClientAsync : string -> System.Threading.Tasks.Task
override this.AuthenticateAsClientAsync : string -> System.Threading.Tasks.Task

Public Overridable Function AuthenticateAsClientAsync (targetHost As String) As Task

Parâmetros

targetHost

String

O nome do servidor que compartilha isso SslStream.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

ArgumentNullException

targetHost é null.

AuthenticationException

A autenticação falhou e deixou esse objeto em um estado inutilizável.

InvalidOperationException

A autenticação já ocorreu.

- ou -

A autenticação do servidor usando isso SslStream foi tentada anteriormente.

- ou -

A autenticação já está em andamento.

ObjectDisposedException

Este objeto foi fechado.

Comentários

A partir do .NET Framework 4.7, esse método é autenticado usando None, o que permite ao sistema operacional escolher o melhor protocolo a ser usado e bloquear protocolos que não são seguros. No .NET Framework 4.6 (e no .NET Framework 4.5 com os patches de segurança mais recentes instalados), as versões de protocolos TLS/SSL permitidas são 1.2, 1.1 e 1.0 (a menos que você desabilite criptografia forte editando o Registro do Windows). Nenhum certificado de cliente é usado na autenticação. A lista de revogação de certificados não é verificada durante a autenticação. O valor especificado deve targetHost corresponder ao nome no certificado do servidor.

Quando a autenticação for bem-sucedida, você deverá verificar as IsEncrypted propriedades e IsSigned as propriedades para determinar quais serviços de segurança são usados pelo SslStream. Verifique a IsMutuallyAuthenticated propriedade para determinar se a autenticação mútua ocorreu.

Se a autenticação falhar, você receberá um AuthenticationExceptione isso SslStream não será mais utilizável. Você deve fechar esse objeto e remover todas as referências a ele para que ele possa ser coletado pelo coletor de lixo.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por AuthenticateAsClient(String).

AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)

Origem:

SslStream.cs

Chamado pelos clientes para autenticar o servidor e, opcionalmente, o cliente em uma conexão cliente-servidor como uma operação assíncrona. O processo de autenticação usa informações especificadas no recipiente de sslClientAuthenticationOptions propriedades.

public:
 System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::Net::Security::SslClientAuthenticationOptions ^ sslClientAuthenticationOptions, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task AuthenticateAsClientAsync(System.Net.Security.SslClientAuthenticationOptions sslClientAuthenticationOptions, System.Threading.CancellationToken cancellationToken = default);

member this.AuthenticateAsClientAsync : System.Net.Security.SslClientAuthenticationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function AuthenticateAsClientAsync (sslClientAuthenticationOptions As SslClientAuthenticationOptions, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

sslClientAuthenticationOptions

SslClientAuthenticationOptions

O recipiente de propriedades para a conexão SSL.

cancellationToken

CancellationToken

O token a ser monitorado para solicitações de cancelamento.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

ArgumentNullException

sslClientAuthenticationOptions é null.

AuthenticationException

A autenticação falhou e deixou esse objeto em um estado inutilizável.

InvalidOperationException

A autenticação já ocorreu.

- ou -

A autenticação do servidor usando isso SslStream foi tentada anteriormente.

- ou -

A autenticação já está em andamento.

ObjectDisposedException

Este objeto foi fechado.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Quando a autenticação for bem-sucedida, você deverá verificar as IsEncrypted propriedades e IsSigned as propriedades para determinar quais serviços de segurança são usados pelo SslStream. Verifique a IsMutuallyAuthenticated propriedade para determinar se a autenticação mútua ocorreu.

Se a autenticação falhar, você receberá um AuthenticationExceptione isso SslStream não será mais utilizável. Você deve fechar esse objeto e remover todas as referências a ele para que ele possa ser coletado pelo coletor de lixo.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por AuthenticateAsClient(SslClientAuthenticationOptions).