Export (0) Print
Expand All

SslStream.BeginAuthenticateAsClient Method (String, AsyncCallback, Object)

Called by clients to begin an asynchronous operation to authenticate the server and optionally the client.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual IAsyncResult BeginAuthenticateAsClient(
	string targetHost,
	AsyncCallback asyncCallback,
	Object asyncState
)

Parameters

targetHost
Type: System.String
The name of the server that shares this SslStream.
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.

ExceptionCondition
ArgumentNullException

targetHost is null.

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.

This method authenticates using the SslProtocols value set to Default. This value specifies that either Secure Sockets Layer (SSL) 3.0 or Transport Layer Security (TLS) 1.0 are acceptable for secure communications. TLS 1.1 or TLS 1.2 will not be used even if those protocols are enabled on local computer. No client certificates are used in the authentication. The certificate revocation list is not checked during authentication.

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.

NoteNote

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft