SslStream::AuthenticateAsClientAsync Method (String^, X509CertificateCollection^, Boolean)
Called by clients to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses the specified certificate collection and the system default SSL protocol.
Assembly: System (in System.dll)
public: [HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)] virtual Task^ AuthenticateAsClientAsync( String^ targetHost, X509CertificateCollection^ clientCertificates, bool checkCertificateRevocation )
Parameters
- targetHost
-
Type:
System::String^
The name of the server that will share this SslStream.
- clientCertificates
-
Type:
System.Security.Cryptography.X509Certificates::X509CertificateCollection^
The X509CertificateCollection that contains client certificates.
- checkCertificateRevocation
-
Type:
System::Boolean
A Boolean value that specifies whether the certificate revocation list is checked during authentication.
Return Value
Type: System.Threading.Tasks::Task^The task object representing the asynchronous operation.
When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the SslStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.
If the authentication fails, you receive a AuthenticationException, and this SslStream is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector.
Note |
|---|
Client certificates are not supported in the SSL version 2 protocol. |
Available since 4.7
