SslStream.BeginAuthenticateAsClient Method (String, X509CertificateCollection, SslProtocols, Boolean, AsyncCallback, Object)
Called by clients to begin an asynchronous operation to authenticate the server and optionally the client using the specified certificates and security protocol.
Assembly: System (in System.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)] public virtual IAsyncResult BeginAuthenticateAsClient( string targetHost, X509CertificateCollection clientCertificates, SslProtocols enabledSslProtocols, bool checkCertificateRevocation, AsyncCallback asyncCallback, Object asyncState )
- Type: System.Security.Cryptography.X509Certificates.X509CertificateCollection
The X509CertificateCollection containing client certificates.
- Type: System.Security.Authentication.SslProtocols
The SslProtocols value that represents the protocol used for authentication.
- Type: System.Boolean
A Boolean value that specifies whether the certificate revocation list is checked during authentication.
- Type: System.AsyncCallback
An AsyncCallback delegate that references the method to invoke when the authentication is complete.
- Type: System.Object
A user-defined object that contains information about the operation. This object is passed to the asyncCallback delegate when the operation completes.
targetHost is null.
enabledSslProtocols is not a valid SslProtocols value.
The authentication failed and left this object in an unusable state.
Authentication has already occurred.
Server authentication using this SslStream was tried previously.
Authentication is already in progress.
This object has been closed.
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.
The value specified for targetHost must match the name on the server's certificate.
The asynchronous authentication operation must be completed by calling the EndAuthenticateAsClient method. Typically, the method is invoked by the asyncCallback delegate.
This method does not block while the operation completes. To block until the operation completes, use one of the AuthenticateAsClient method overloads.
For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously
Client certificates are not supported in the SSL version 2 protocol.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.