NegotiateStream.AuthenticateAsClientAsync Method ()

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Called by clients to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation.

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

[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
abstract AuthenticateAsClientAsync : unit -> Task
[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
override AuthenticateAsClientAsync : unit -> Task

Return Value

Type: System.Threading.Tasks.Task

Returns Task

The task object representing the asynchronous operation.

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

The authentication uses the client's DefaultCredentials. No Service Principal Name (SPN) is specified for the server. The impersonation level is Identification, the security level is EncryptAndSign, and mutual authentication is requested. The NegotiateStream class will construct the SPN used for mutual authentication.

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: