This documentation is archived and is not being maintained.

SslStream.AuthenticateAsServer Method (X509Certificate, Boolean, SslProtocols, Boolean)

Called by servers to begin an asynchronous operation to authenticate the server and optionally the client using the specified certificates, requirements and security protocol.

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

public virtual void AuthenticateAsServer(
	X509Certificate serverCertificate,
	bool clientCertificateRequired,
	SslProtocols enabledSslProtocols,
	bool checkCertificateRevocation
)

Parameters

serverCertificate
Type: System.Security.Cryptography.X509Certificates.X509Certificate
The X509Certificate used to authenticate the server.
clientCertificateRequired
Type: System.Boolean
A Boolean value that specifies whether the client must supply a certificate for authentication.
enabledSslProtocols
Type: System.Security.Authentication.SslProtocols
The SslProtocols value that represents the protocol used for authentication.
checkCertificateRevocation
Type: System.Boolean
A Boolean value that specifies whether the certificate revocation list is checked during authentication.

ExceptionCondition
ArgumentNullException

serverCertificate is null.

ArgumentException

enabledSslProtocols is not a valid SslProtocols value.

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 AuthenticateAsServer method is not supported on Windows 95, Windows 98, or Windows Millennium.

This method blocks until the operation completes. To prevent blocking until the operation completes, use one of the BeginAuthenticateAsServer method overloads.

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.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: