NegotiateStream.BeginAuthenticateAsServer Method (NetworkCredential, ProtectionLevel, TokenImpersonationLevel, 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 server credentials and authentication options. This method does not block.

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

public virtual IAsyncResult BeginAuthenticateAsServer (
	NetworkCredential credential,
	ProtectionLevel requiredProtectionLevel,
	TokenImpersonationLevel requiredImpersonationLevel,
	AsyncCallback asyncCallback,
	Object asyncState
)
public IAsyncResult BeginAuthenticateAsServer (
	NetworkCredential credential, 
	ProtectionLevel requiredProtectionLevel, 
	TokenImpersonationLevel requiredImpersonationLevel, 
	AsyncCallback asyncCallback, 
	Object asyncState
)
public function BeginAuthenticateAsServer (
	credential : NetworkCredential, 
	requiredProtectionLevel : ProtectionLevel, 
	requiredImpersonationLevel : TokenImpersonationLevel, 
	asyncCallback : AsyncCallback, 
	asyncState : Object
) : IAsyncResult
Not applicable.

Parameters

credential

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

requiredProtectionLevel

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

requiredImpersonationLevel

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

asyncCallback

An AsyncCallback delegate that references the method to invoke when the authentication is complete.

asyncState

A user-defined object containing information about the operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

An IAsyncResult object indicating the status of the asynchronous operation.

Exception typeCondition

ArgumentNullException

credential is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

requiredImpersonationLevel must be Identification, Impersonation, or Delegation,

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

NotSupportedException

Windows 95 and Windows 98 are not supported.

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.

This method is asynchronous and does not block while the operation completes. To block until the operation completes, use one of the AuthenticateAsServer method overloads.

The asynchronous authentication operation must be completed by calling the EndAuthenticateAsServer method. Typically, the method is invoked by the asyncCallback delegate. For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

If the authentication fails, you receive an AuthenticationException or an InvalidCredentialException. In this case, you can retry the authentication with a different credential.

Windows 95, Windows 98, Windows 98 Second Edition, Windows Millennium Edition Platform Note: The AuthenticateAsServer method is not supported.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: