BeginAuthenticateAsClient Method (NetworkCredential, ChannelBinding, String, AsyncCallback, Object)

NegotiateStream.BeginAuthenticateAsClient Method (NetworkCredential, ChannelBinding, String, AsyncCallback, Object)

 

Called by clients to begin an asynchronous operation to authenticate the client, and optionally the server, in a client-server connection. The authentication process uses the specified credentials and channel binding. This method does not block.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual IAsyncResult BeginAuthenticateAsClient(
	NetworkCredential credential,
	ChannelBinding binding,
	string targetName,
	AsyncCallback asyncCallback,
	object asyncState
)

Parameters

credential
Type: System.Net.NetworkCredential

The NetworkCredential that is used to establish the identity of the client.

binding
Type: System.Security.Authentication.ExtendedProtection.ChannelBinding

The ChannelBinding that is used for extended protection.

targetName
Type: System.String

The Service Principal Name (SPN) that uniquely identifies the server to authenticate.

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 containing information about the write operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

Type: System.IAsyncResult

An IAsyncResult object indicating the status of the asynchronous operation.

Exception Condition
ArgumentNullException

credential is null.

- or -

targetName is null.

AuthenticationException

The authentication failed. You can use this object to retry the authentication.

InvalidCredentialException

The authentication failed. You can use this object to retry the authentication.

InvalidOperationException

Authentication has already occurred.

- or -

This stream was used previously to attempt authentication as the server. You cannot use the stream to retry authentication as the client.

ObjectDisposedException

This object has been closed.

This method is asynchronous and does not block while the operation completes. To block until the operation completes, use one of the AuthenticateAsClient method overloads.

The asynchronous authentication operation must be completed by calling the EndAuthenticateAsClient method. Typically, the method is invoked by the asyncCallback delegate. For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

If the authentication fails, you receive an AuthenticationException or an InvalidCredentialException. In this case, you can retry the authentication with a different credential.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft