SslStream::AuthenticateAsServer Method (X509Certificate^, Boolean, Boolean)

 

Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificates and requirements, and using the sytem default security protocol.

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

public:
virtual void AuthenticateAsServer(
	X509Certificate^ serverCertificate,
	bool clientCertificateRequired,
	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 is asked for a certificate for authentication. Note that this is only a request -- if no certificate is provided, the server still accepts the connection request.

checkCertificateRevocation
Type: System::Boolean

A Boolean value that specifies whether the certificate revocation list is checked during authentication.

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

.NET Framework
Available since 4.7
Return to top
Show: