SslStream.AuthenticateAsClientAsync Метод

Определение

Пространство имен:

System.Net.Security

Сборки:

netstandard.dll, System.Net.Security.dll

Проверка подлинности клиентской стороны подключения к серверу клиента в качестве асинхронной операции.

Перегрузки

Имя	Описание
AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)	Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции. Процесс проверки подлинности использует указанную коллекцию сертификатов и протокол SSL.
AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)	Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции. Процесс проверки подлинности использует указанную коллекцию сертификатов и протокол SSL по умолчанию по умолчанию.
AuthenticateAsClientAsync(String)	Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции.
AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)	Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции. В процессе проверки подлинности используются сведения, указанные в контейнере sslClientAuthenticationOptions свойств.

AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)

Исходный код:

SslStream.cs

Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции. Процесс проверки подлинности использует указанную коллекцию сертификатов и протокол 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

Параметры

targetHost

String

Имя сервера, который будет делиться этим SslStream.

clientCertificates

X509CertificateCollection

Объект X509CertificateCollection , содержащий сертификаты клиента.

enabledSslProtocols

SslProtocols

Значение SslProtocols , представляющее протоколы, используемые для проверки подлинности.

checkCertificateRevocation

Boolean

Значение Boolean , указывающее, проверяется ли список отзыва сертификата во время проверки подлинности.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

AuthenticationException

Сбой проверки подлинности и оставил этот объект в неиспользуемом состоянии.

InvalidOperationException

Проверка подлинности уже произошла.

–или–

Проверка подлинности сервера, используемая SslStream ранее.

–или–

Проверка подлинности уже выполняется.

ObjectDisposedException

Этот объект был закрыт.

Комментарии

Начиная с .NET Framework 4.7 этот метод проходит проверку подлинности, Noneчто позволяет операционной системе выбирать лучший протокол для использования и блокировать протоколы, которые не защищены. В .NET Framework 4.6 (и .NET Framework 4.5 с установленными последними исправлениями безопасности) допустимые версии протоколов TLS/SSL : 1.2, 1.1 и 1.0 (если только не отключить строгую криптографию, изменив реестр Windows).

При успешной проверке подлинности необходимо проверить IsEncrypted и IsSigned свойства, чтобы определить, какие службы безопасности используются SslStream. IsMutuallyAuthenticated Проверьте свойство, чтобы определить, произошла ли взаимная проверка подлинности.

Если проверка подлинности завершается ошибкой AuthenticationException, вы получите сообщение и больше SslStream не используется. Необходимо закрыть этот объект и удалить все ссылки на него, чтобы его можно было собрать сборщиком мусора.

Замечание

Сертификаты клиента не поддерживаются в протоколе SSL версии 2.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых AuthenticateAsClient(String, X509CertificateCollection, SslProtocols, Boolean).

AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)

Исходный код:

SslStream.cs

Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции. Процесс проверки подлинности использует указанную коллекцию сертификатов и протокол SSL по умолчанию по умолчанию.

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

Параметры

targetHost

String

Имя сервера, который будет делиться этим SslStream.

clientCertificates

X509CertificateCollection

Объект X509CertificateCollection , содержащий сертификаты клиента.

checkCertificateRevocation

Boolean

Значение Boolean , указывающее, проверяется ли список отзыва сертификата во время проверки подлинности.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

AuthenticationException

Сбой проверки подлинности и оставил этот объект в неиспользуемом состоянии.

InvalidOperationException

Проверка подлинности уже произошла.

–или–

Проверка подлинности сервера, используемая SslStream ранее.

–или–

Проверка подлинности уже выполняется.

ObjectDisposedException

Этот объект был закрыт.

Комментарии

Начиная с .NET Framework 4.7 этот метод проходит проверку подлинности, Noneчто позволяет операционной системе выбирать лучший протокол для использования и блокировать протоколы, которые не защищены. В .NET Framework 4.6 (и .NET Framework 4.5 с установленными последними исправлениями безопасности) допустимые версии протоколов TLS/SSL : 1.2, 1.1 и 1.0 (если только не отключить строгую криптографию, изменив реестр Windows).

При успешной проверке подлинности необходимо проверить IsEncrypted и IsSigned свойства, чтобы определить, какие службы безопасности используются SslStream. IsMutuallyAuthenticated Проверьте свойство, чтобы определить, произошла ли взаимная проверка подлинности.

Если проверка подлинности завершается ошибкой AuthenticationException, вы получите сообщение и больше SslStream не используется. Необходимо закрыть этот объект и удалить все ссылки на него, чтобы его можно было собрать сборщиком мусора.

Замечание

Сертификаты клиента не поддерживаются в протоколе SSL версии 2.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых AuthenticateAsClient(String, X509CertificateCollection, Boolean).

AuthenticateAsClientAsync(String)

Исходный код:

SslStream.cs

Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции.

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

Параметры

targetHost

String

Имя сервера, который использует этот SslStreamпараметр.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

ArgumentNullException

targetHost равно null.

AuthenticationException

Сбой проверки подлинности и оставил этот объект в неиспользуемом состоянии.

InvalidOperationException

Проверка подлинности уже произошла.

–или–

Проверка подлинности сервера, используемая SslStream ранее.

–или–

Проверка подлинности уже выполняется.

ObjectDisposedException

Этот объект был закрыт.

Комментарии

Начиная с .NET Framework 4.7 этот метод проходит проверку подлинности, Noneчто позволяет операционной системе выбирать лучший протокол для использования и блокировать протоколы, которые не защищены. В .NET Framework 4.6 (и .NET Framework 4.5 с установленными последними исправлениями безопасности) допустимые версии протоколов TLS/SSL : 1.2, 1.1 и 1.0 (если только не отключить строгую криптографию, изменив реестр Windows). В проверке подлинности сертификаты клиента не используются. Список отзыва сертификатов не проверяется во время проверки подлинности. Указанное значение targetHost должно соответствовать имени сертификата сервера.

При успешной проверке подлинности необходимо проверить IsEncrypted и IsSigned свойства, чтобы определить, какие службы безопасности используются SslStream. IsMutuallyAuthenticated Проверьте свойство, чтобы определить, произошла ли взаимная проверка подлинности.

Если проверка подлинности завершается ошибкой AuthenticationException, вы получите сообщение и больше SslStream не используется. Необходимо закрыть этот объект и удалить все ссылки на него, чтобы его можно было собрать сборщиком мусора.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых AuthenticateAsClient(String).

AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)

Исходный код:

SslStream.cs

Вызывается клиентами для проверки подлинности сервера и при необходимости клиента в подключении к клиентскому серверу в качестве асинхронной операции. В процессе проверки подлинности используются сведения, указанные в контейнере sslClientAuthenticationOptions свойств.

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

Параметры

sslClientAuthenticationOptions

SslClientAuthenticationOptions

Контейнер свойств для SSL-подключения.

cancellationToken

CancellationToken

Маркер для отслеживания запросов на отмену.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

ArgumentNullException

sslClientAuthenticationOptions равно null.

AuthenticationException

Сбой проверки подлинности и оставил этот объект в неиспользуемом состоянии.

InvalidOperationException

Проверка подлинности уже произошла.

–или–

Проверка подлинности сервера, используемая SslStream ранее.

–или–

Проверка подлинности уже выполняется.

ObjectDisposedException

Этот объект был закрыт.

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

При успешной проверке подлинности необходимо проверить IsEncrypted и IsSigned свойства, чтобы определить, какие службы безопасности используются SslStream. IsMutuallyAuthenticated Проверьте свойство, чтобы определить, произошла ли взаимная проверка подлинности.

Если проверка подлинности завершается ошибкой AuthenticationException, вы получите сообщение и больше SslStream не используется. Необходимо закрыть этот объект и удалить все ссылки на него, чтобы его можно было собрать сборщиком мусора.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых AuthenticateAsClient(SslClientAuthenticationOptions).