Export (0) Print
Expand All

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

.NET Framework 4.5

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)

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Overridable Function AuthenticateAsServerAsync ( _
	credential As NetworkCredential, _
	policy As ExtendedProtectionPolicy, _
	requiredProtectionLevel As ProtectionLevel, _
	requiredImpersonationLevel As TokenImpersonationLevel _
) As 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.

ExceptionCondition
ArgumentException

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

ArgumentNullException

credential is Nothing.

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 Nothing, 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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.6, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft