NegotiateStream.AuthenticateAsServerAsync Method (NetworkCredential, ExtendedProtectionPolicy, ProtectionLevel, TokenImpersonationLevel)

.NET Framework (current version)
 

Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified server credentials, authentication options, and extended protection policy.

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

[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
abstract AuthenticateAsServerAsync : 
        credential:NetworkCredential *
        policy:ExtendedProtectionPolicy *
        requiredProtectionLevel:ProtectionLevel *
        requiredImpersonationLevel:TokenImpersonationLevel -> Task
[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
override AuthenticateAsServerAsync : 
        credential:NetworkCredential *
        policy:ExtendedProtectionPolicy *
        requiredProtectionLevel:ProtectionLevel *
        requiredImpersonationLevel:TokenImpersonationLevel -> Task

Parameters

credential
Type: System.Net.NetworkCredential

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

policy
Type: System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy

The ExtendedProtectionPolicy that is used for extended protection.

requiredProtectionLevel
Type: System.Net.Security.ProtectionLevel

One of the ProtectionLevel values, indicating the security services for the stream.

requiredImpersonationLevel
Type: System.Security.Principal.TokenImpersonationLevel

One of the TokenImpersonationLevel values, indicating how the server can use the client's credentials to access resources.

Return Value

Type: System.Threading.Tasks.Task

Returns Task

The task object representing the asynchronous operation.

Exception Condition
ArgumentException

The CustomChannelBinding and CustomServiceNames on the extended protection policy passed in the policy parameter are both null.

ArgumentNullException

credential is null.

ArgumentOutOfRangeException

requiredImpersonationLevel must be Identification, Impersonation, or Delegation,

AuthenticationException

The authentication failed. You can use this object to try to r-authenticate.

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 client. You cannot use the stream to retry authentication as the server.

NotSupportedException

Windows 95 and Windows 98 are not supported.

ObjectDisposedException

This object has been closed.

PlatformNotSupportedException

The policy parameter was set to Always on a platform that does not support extended protection.

If the policy parameter is null, then an extended protection policy is used that has PolicyEnforcement set to Never.

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.

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 4.5
Return to top
Show: