SslStream::BeginAuthenticateAsClient Method (String^, X509CertificateCollection^, SslProtocols, Boolean, AsyncCallback^, Object^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Called by clients to begin an asynchronous operation to authenticate the server and optionally the client using the specified certificates and security protocol.

Namespace:   System.Net.Security
Assembly:  System (in System.dll)

public:
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
virtual IAsyncResult^ BeginAuthenticateAsClient(
	String^ targetHost,
	X509CertificateCollection^ clientCertificates,
	SslProtocols enabledSslProtocols,
	bool checkCertificateRevocation,
	AsyncCallback^ asyncCallback,
	Object^ asyncState
)

Parameters

targetHost
Type: System::String^

The name of the server that shares this SslStream.

clientCertificates
Type: System.Security.Cryptography.X509Certificates::X509CertificateCollection^

The X509CertificateCollection containing client certificates.

enabledSslProtocols
Type: System.Security.Authentication::SslProtocols

The SslProtocols value that represents the protocol used for authentication.

checkCertificateRevocation
Type: System::Boolean

A Boolean value that specifies whether the certificate revocation list is checked during authentication.

asyncCallback
Type: System::AsyncCallback^

An AsyncCallback delegate that references the method to invoke when the authentication is complete.

asyncState
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.

Return Value

Type: System::IAsyncResult^

An IAsyncResult object that indicates the status of the asynchronous operation.

Exception Condition
ArgumentNullException

targetHost is null.

ArgumentException

enabledSslProtocols is not a valid SslProtocols value.

AuthenticationException

The authentication failed and left this object in an unusable state.

InvalidOperationException

Authentication has already occurred.

-or-

Server authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

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

If you receive a AuthenticationException, 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.

System_CAPS_noteNote

Client certificates are not supported in the SSL version 2 protocol.

.NET Framework
Available since 2.0
Return to top
Show: