SslStream.AuthenticateAsClientAsync Metoda

Definicja

Przestrzeń nazw:

System.Net.Security

Zestaw:

System.Net.Security.dll

Uwierzytelnij stronę klienta połączenia klienta-serwera jako operację asynchroniczną.

Przeciążenia

AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)	Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna. W procesie uwierzytelniania jest używana określona kolekcja certyfikatów i protokół SSL.
AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)	Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna. Proces uwierzytelniania używa określonej kolekcji certyfikatów i domyślnego protokołu SSL systemu.
AuthenticateAsClientAsync(String)	Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna.
AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)	Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna. Proces uwierzytelniania używa informacji określonych w torbie sslClientAuthenticationOptions właściwości.

AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)

Źródło:

SslStream.cs

Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna. W procesie uwierzytelniania jest używana określona kolekcja certyfikatów i protokół SSL.

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

Parametry

targetHost

String

Nazwa serwera, który będzie współużytkowyć ten element SslStream.

clientCertificates

X509CertificateCollection

Element X509CertificateCollection zawierający certyfikaty klienta.

enabledSslProtocols

SslProtocols

SslProtocols Wartość reprezentująca protokoły używane do uwierzytelniania.

checkCertificateRevocation

Boolean

Boolean Wartość określająca, czy lista odwołania certyfikatów jest sprawdzana podczas uwierzytelniania.

Zwraca

Task

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

AuthenticationException

Uwierzytelnianie nie powiodło się i pozostawiono ten obiekt w stanie bezużytecznym.

InvalidOperationException

Uwierzytelnianie już wystąpiło.

-lub-

Wcześniej próbowano użyć uwierzytelniania SslStream serwera.

-lub-

Uwierzytelnianie jest już w toku.

ObjectDisposedException

Ten obiekt został zamknięty.

Uwagi

Począwszy od .NET Framework 4.7, ta metoda uwierzytelnia się przy użyciu metody None, która umożliwia systemowi operacyjnemu wybór najlepszego protokołu do użycia oraz blokowanie protokołów, które nie są bezpieczne. W .NET Framework 4.6 (i .NET Framework 4.5 z zainstalowanymi najnowszymi poprawkami zabezpieczeń), dozwolone wersje protokołów TLS/SSL to 1.2, 1.1 i 1.0 (chyba że wyłączysz silną kryptografię przez edytowanie rejestru systemu Windows).

Po pomyślnym uwierzytelnieniu należy sprawdzić IsEncrypted właściwości i IsSigned , aby określić, które usługi zabezpieczeń są używane przez usługę SslStream. Sprawdź właściwość , IsMutuallyAuthenticated aby określić, czy wystąpiło wzajemne uwierzytelnianie.

Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie wyświetlony komunikat AuthenticationException, który SslStream nie jest już możliwy do użycia. Należy zamknąć ten obiekt i usunąć wszystkie odwołania do niego, aby można było go zebrać przez moduł odśmiecający pamięci.

Uwaga

Certyfikaty klienta nie są obsługiwane w protokole SSL w wersji 2.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez AuthenticateAsClient(String, X509CertificateCollection, SslProtocols, Boolean)usługę .

AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)

Źródło:

SslStream.cs

Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna. Proces uwierzytelniania używa określonej kolekcji certyfikatów i domyślnego protokołu SSL systemu.

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

Parametry

targetHost

String

Nazwa serwera, który będzie współużytkowyć ten element SslStream.

clientCertificates

X509CertificateCollection

Element X509CertificateCollection zawierający certyfikaty klienta.

checkCertificateRevocation

Boolean

Boolean Wartość określająca, czy lista odwołania certyfikatów jest sprawdzana podczas uwierzytelniania.

Zwraca

Task

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

AuthenticationException

Uwierzytelnianie nie powiodło się i pozostawiono ten obiekt w stanie bezużytecznym.

InvalidOperationException

Uwierzytelnianie już wystąpiło.

-lub-

Wcześniej próbowano użyć uwierzytelniania SslStream serwera.

-lub-

Uwierzytelnianie jest już w toku.

ObjectDisposedException

Ten obiekt został zamknięty.

Uwagi

Począwszy od .NET Framework 4.7, ta metoda uwierzytelnia się przy użyciu metody None, która umożliwia systemowi operacyjnemu wybór najlepszego protokołu do użycia oraz blokowanie protokołów, które nie są bezpieczne. W .NET Framework 4.6 (i .NET Framework 4.5 z zainstalowanymi najnowszymi poprawkami zabezpieczeń), dozwolone wersje protokołów TLS/SSL to 1.2, 1.1 i 1.0 (chyba że wyłączysz silną kryptografię przez edytowanie rejestru systemu Windows).

Po pomyślnym uwierzytelnieniu należy sprawdzić IsEncrypted właściwości i IsSigned , aby określić, które usługi zabezpieczeń są używane przez usługę SslStream. Sprawdź właściwość , IsMutuallyAuthenticated aby określić, czy wystąpiło wzajemne uwierzytelnianie.

Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie wyświetlony komunikat AuthenticationException, który SslStream nie jest już możliwy do użycia. Należy zamknąć ten obiekt i usunąć wszystkie odwołania do niego, aby można było go zebrać przez moduł odśmiecający pamięci.

Uwaga

Certyfikaty klienta nie są obsługiwane w protokole SSL w wersji 2.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez AuthenticateAsClient(String, X509CertificateCollection, Boolean)usługę .

AuthenticateAsClientAsync(String)

Źródło:

SslStream.cs

Wywoływane przez klientów w celu uwierzytelniania serwera i opcjonalnie klienta w połączeniu klient-serwer jako operacja asynchroniczna.

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

Parametry

targetHost

String

Nazwa serwera, który współudzieli ten element SslStream.

Zwraca

Task

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

ArgumentNullException

targetHost to null.

AuthenticationException

Uwierzytelnianie nie powiodło się i pozostawiono ten obiekt w stanie bezużytecznym.

InvalidOperationException

Uwierzytelnianie już wystąpiło.

-lub-

Wcześniej próbowano użyć uwierzytelniania SslStream serwera.

-lub-

Uwierzytelnianie jest już w toku.

ObjectDisposedException

Ten obiekt został zamknięty.

Uwagi

Począwszy od .NET Framework 4.7, ta metoda uwierzytelnia się przy użyciu metody None, która umożliwia systemowi operacyjnemu wybór najlepszego protokołu do użycia oraz blokowanie protokołów, które nie są bezpieczne. W .NET Framework 4.6 (i .NET Framework 4.5 z zainstalowanymi najnowszymi poprawkami zabezpieczeń), dozwolone wersje protokołów TLS/SSL to 1.2, 1.1 i 1.0 (chyba że wyłączysz silną kryptografię przez edytowanie rejestru systemu Windows). W uwierzytelnianiu nie są używane żadne certyfikaty klienta. Lista odwołania certyfikatów nie jest sprawdzana podczas uwierzytelniania. Wartość określona dla targetHost musi być zgodna z nazwą certyfikatu serwera.

Po pomyślnym uwierzytelnieniu należy sprawdzić IsEncrypted właściwości i IsSigned , aby określić, które usługi zabezpieczeń są używane przez usługę SslStream. Sprawdź właściwość , IsMutuallyAuthenticated aby określić, czy wystąpiło wzajemne uwierzytelnianie.

Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie wyświetlony komunikat AuthenticationException, który SslStream nie jest już możliwy do użycia. Należy zamknąć ten obiekt i usunąć wszystkie odwołania do niego, aby można było go zebrać przez moduł odśmiecający pamięci.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez AuthenticateAsClient(String)usługę .

AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)

Źródło:

SslStream.cs

Wywoływane przez klientów w celu uwierzytelnienia serwera i opcjonalnie klienta w połączeniu klienta-serwera jako operacji asynchronicznej. Proces uwierzytelniania używa informacji określonych w torbie sslClientAuthenticationOptions właściwości.

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

Parametry

sslClientAuthenticationOptions

SslClientAuthenticationOptions

Torba właściwości dla połączenia SSL.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania.

Zwraca

Task

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

ArgumentNullException

sslClientAuthenticationOptions to null.

AuthenticationException

Uwierzytelnianie nie powiodło się i pozostawiono ten obiekt w stanie bezużytecznym.

InvalidOperationException

Uwierzytelnianie już wystąpiło.

-lub-

Wcześniej próbowano użyć uwierzytelniania SslStream serwera.

-lub-

Uwierzytelnianie jest już w toku.

ObjectDisposedException

Ten obiekt został zamknięty.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwróconym zadaniu.

Uwagi

Po pomyślnym uwierzytelnieniu należy sprawdzić IsEncrypted właściwości i IsSigned , aby określić, jakie usługi zabezpieczeń są używane przez usługę SslStream. Sprawdź właściwość, IsMutuallyAuthenticated aby określić, czy doszło do wzajemnego uwierzytelniania.

Jeśli uwierzytelnianie zakończy się niepowodzeniem, otrzymasz element AuthenticationException, a to SslStream nie jest już możliwe do użycia. Należy zamknąć ten obiekt i usunąć wszystkie odwołania do niego, aby można było je zebrać przez moduł odśmieceń pamięci.

Ta metoda przechowuje w zadaniu wszystkie wyjątki inne niż użycie, które mogą zgłaszać synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony po oczekiwaniu na zadanie. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. Aby uzyskać informacje o przechowywanych wyjątkach, zobacz wyjątki zgłaszane przez AuthenticateAsClient(SslClientAuthenticationOptions)usługę .