AuthenticateAsClientAsync Method (String)

SslStream.AuthenticateAsClientAsync Method (String)

.NET Framework (current version)
 

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

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual Task AuthenticateAsClientAsync(
	string targetHost
)

Parameters

targetHost
Type: System.String

The name of the server that shares this SslStream.

Return Value

Type: System.Threading.Tasks.Task

Returns Task

The task object representing the asynchronous operation.

Exception Condition
ArgumentNullException

targetHost is null.

AuthenticationException

The authentication failed and left this object in an unusable state.

InvalidOperationException

Authentication has already occurred.

-or-

Server authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

This method authenticates using Default. No client certificates are used in the authentication. The certificate revocation list is not checked during authentication. The value specified for targetHost must match the name on the server's certificate.

When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the SslStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.

If the authentication fails, you receive a AuthenticationException, and this SslStream is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector.

.NET Framework
Available since 4.5
Return to top
Show:
© 2016 Microsoft