SslStream.AuthenticateAsClientAsync メソッド

定義

名前空間:

System.Net.Security

アセンブリ:

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 のレジストリを編集して強力な暗号化を無効にしていない場合に限ります)。

認証が成功したら、 プロパティと IsSigned プロパティをチェックIsEncryptedして、 によって使用されるセキュリティ サービスを決定するSslStream必要があります。 プロパティを IsMutuallyAuthenticated 調べて、相互認証が行われたかどうかを確認します。

認証が失敗した場合は、 を AuthenticationException受け取り、これは SslStream 使用できなくなります。 ガベージ コレクターが収集できるように、このオブジェクトを閉じて、そのオブジェクトへのすべての参照を削除する必要があります。

Note

クライアント証明書は、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 のレジストリを編集して強力な暗号化を無効にしていない場合に限ります)。

認証が成功したら、 プロパティと IsSigned プロパティをチェックIsEncryptedして、 によって使用されるセキュリティ サービスを決定するSslStream必要があります。 プロパティを IsMutuallyAuthenticated 調べて、相互認証が行われたかどうかを確認します。

認証が失敗した場合は、 を AuthenticationException受け取り、これは SslStream 使用できなくなります。 ガベージ コレクターが収集できるように、このオブジェクトを閉じて、そのオブジェクトへのすべての参照を削除する必要があります。

Note

クライアント証明書は、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 指定する値は、サーバーの証明書の名前と一致する必要があります。

認証が成功したら、 プロパティと IsSigned プロパティをチェックIsEncryptedして、 によって使用されるセキュリティ サービスを決定する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

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

認証が成功したら、 プロパティと IsSigned プロパティをチェックIsEncryptedして、 によって使用されるセキュリティ サービスを決定するSslStream必要があります。 プロパティを IsMutuallyAuthenticated 調べて、相互認証が行われたかどうかを確認します。

認証が失敗した場合は、 を AuthenticationException受け取り、これは SslStream 使用できなくなります。 ガベージ コレクターが収集できるように、このオブジェクトを閉じ、そのオブジェクトへのすべての参照を削除する必要があります。

このメソッドは、メソッドの同期的な例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクの待機時にスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって AuthenticateAsClient(SslClientAuthenticationOptions)スローされる例外に関するページを参照してください。