NegotiateStream.AuthenticateAsClient Method (NetworkCredential, ChannelBinding, String)

 

Called by clients to authenticate the client, and optionally the server, in a client-server connection. The authentication process uses the specified client credential and the channel binding.

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

public virtual void AuthenticateAsClient(
	NetworkCredential credential,
	ChannelBinding binding,
	string targetName
)

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.

Exception Condition
ArgumentNullException

targetName is null.

- or -

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

The impersonation level is Identification, the security level is EncryptAndSign, and mutual authentication is requested. The NegotiateStream class will construct the SPN used for mutual authentication.

The ChannelBinding used for extended protection that is passed to this method in the binding parameter would be retrieved by an application from TransportContext property on the associated SslStream.

When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the NegotiateStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.

.NET Framework
Available since 2.0
Return to top
Show: