NegotiateStream.AuthenticateAsClient Method (NetworkCredential, String, ProtectionLevel, TokenImpersonationLevel)

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

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

public virtual void AuthenticateAsClient(
	NetworkCredential credential,
	string targetName,
	ProtectionLevel requiredProtectionLevel,
	TokenImpersonationLevel allowedImpersonationLevel
)

Parameters

credential
Type: System.Net.NetworkCredential
The NetworkCredential that is used to establish the identity of the client.
targetName
Type: System.String
The Service Principal Name (SPN) that uniquely identifies the server to authenticate.
requiredProtectionLevel
Type: System.Net.Security.ProtectionLevel
One of the ProtectionLevel values, indicating the security services for the stream.
allowedImpersonationLevel
Type: System.Security.Principal.TokenImpersonationLevel
One of the TokenImpersonationLevel values, indicating how the server can use the client's credentials to access resources.

ExceptionCondition
ArgumentOutOfRangeException

allowedImpersonationLevel is not a valid value.

ArgumentNullException

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.

ObjectDisposedException

This object has been closed.

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.

Use the requiredProtectionLevel parameter to request security services for data transmitted using the authenticated stream. For example, to have the data encrypted and signed, specify the EncryptAndSign value. Successful authentication does not guarantee that the requested ProtectionLevel has been granted. You must check the IsEncrypted and IsSigned properties to determine what security services are used by the NegotiateStream.

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

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft