NegotiateStream.BeginAuthenticateAsServer Method (ExtendedProtectionPolicy, AsyncCallback, Object)

Called by servers to begin an asynchronous operation to authenticate the client, and optionally the server, in a client-server connection. The authentication process uses the specified extended protection policy. This method does not block.

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

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Overridable Function BeginAuthenticateAsServer ( _
	policy As ExtendedProtectionPolicy, _
	asyncCallback As AsyncCallback, _
	asyncState As Object _
) As IAsyncResult

Parameters

policy
Type: System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy
The ExtendedProtectionPolicy that is used for extended protection.
asyncCallback
Type: System.AsyncCallback
An AsyncCallback delegate that references the method to invoke when the authentication is complete.
asyncState
Type: System.Object
A user-defined object containing information about the write operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

Type: System.IAsyncResult
An IAsyncResult object indicating the status of the asynchronous operation.

ExceptionCondition
ArgumentException

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

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, the security level is EncryptAndSign.

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.

To block until the operation completes, use one of the AuthenticateAsServer method overloads.

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

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

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