NegotiateStream.BeginAuthenticateAsServer Method (AsyncCallback, Object)

Called by servers to begin an asynchronous operation to authenticate the client, and optionally the server, in a client-server connection. This method does not block.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual IAsyncResult BeginAuthenticateAsServer(
	AsyncCallback asyncCallback,
	Object asyncState
)

Parameters

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

NotSupportedException

Windows 95 and Windows 98 are not supported.

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.

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.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft