AuthenticateAsServerAsync Method (ExtendedProtectionPolicy)

NegotiateStream.AuthenticateAsServerAsync Method (ExtendedProtectionPolicy)

.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 extended protection policy.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual Task AuthenticateAsServerAsync(
	ExtendedProtectionPolicy policy
)

Parameters

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

The ExtendedProtectionPolicy that is used for extended protection.

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.

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.

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.

The authentication uses the server's DefaultCredentials. No Service Principal Name (SPN) is specified for the server. The impersonation level is Identification, and the security level is EncryptAndSign.

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:
© 2016 Microsoft