SslStream.AuthenticateAsServerAsync Method (X509Certificate)

.NET Framework (current version)
 

Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificate as an asynchronous operation.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual Task AuthenticateAsServerAsync(
	X509Certificate serverCertificate
)

Parameters

serverCertificate
Type: System.Security.Cryptography.X509Certificates.X509Certificate

The certificate used to authenticate the server.

Return Value

Type: System.Threading.Tasks.Task

Returns Task

The task object representing the asynchronous operation.

Exception Condition
ArgumentNullException

serverCertificate is null.

AuthenticationException

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

InvalidOperationException

Authentication has already occurred.

-or-

Client authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

PlatformNotSupportedException

The AuthenticateAsServerAsync method is not supported on Windows 95, Windows 98, or Windows Millennium.

This method authenticates using Default. The certificate revocation list is not checked during authentication. The client is not required to provide a certificate for authentication.

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: