Export (0) Print
Expand All

SslStream.AuthenticateAsClient Method (String, X509CertificateCollection, SslProtocols, Boolean)

Called by clients to authenticate the server and optionally the client in a client-server connection. The authentication process uses the specified certificate collection and SSL protocol.

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

public virtual void AuthenticateAsClient(
	string targetHost,
	X509CertificateCollection clientCertificates,
	SslProtocols enabledSslProtocols,
	bool checkCertificateRevocation
)

Parameters

targetHost
Type: System.String

The name of the server that will share this SslStream.

clientCertificates
Type: System.Security.Cryptography.X509Certificates.X509CertificateCollection

The X509CertificateCollection that contains client certificates.

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.

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.

NoteNote

Client certificates are not supported in the SSL version 2 protocol.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft