This documentation is archived and is not being maintained.

SslStream Constructor (Stream, Boolean, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)

Initializes a new instance of the SslStream class using the specified Stream, stream closure behavior, certificate validation delegate and certificate selection delegate.

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

public SslStream(
	Stream innerStream,
	bool leaveInnerStreamOpen,
	RemoteCertificateValidationCallback userCertificateValidationCallback,
	LocalCertificateSelectionCallback userCertificateSelectionCallback
)

Parameters

innerStream
Type: System.IO.Stream

Initializes a new instance of the SslStream class using the specified Stream and stream closure behavior.

leaveInnerStreamOpen
Type: System.Boolean

Initializes a new instance of the SslStream class using the specified Stream and stream closure behavior.

userCertificateValidationCallback
Type: System.Net.Security.RemoteCertificateValidationCallback

A RemoteCertificateValidationCallback delegate responsible for validating the certificate supplied by the remote party.

userCertificateSelectionCallback
Type: System.Net.Security.LocalCertificateSelectionCallback

A LocalCertificateSelectionCallback delegate responsible for selecting the certificate used for authentication.

ExceptionCondition
ArgumentException

innerStream is not readable.

-or-

innerStream is not writable.

ArgumentNullException

innerStream is null.

-or-

innerStream is equal to Null.

When you specify true for the leaveStreamOpen parameter, closing the SslStream has no effect on the innerStream stream; you must explicitly close innerStream when you no longer need it.

The userCertificateValidationCallback delegate's certificateErrors argument contains any Windows error codes returned by the channel Security Support Provider Interface (SSPI). The return value of the method invoked by the userCertificateValidationCallback delegate determines whether authentication succeeds.

The security protocol and cryptographic algorithms are already selected when the userCertificateValidationCallback delegate's method is invoked. You can use the method to determine whether the selected cryptographic algorithms and strengths are sufficient for your application. If not, the method should return false to prevent the SslStream from being created.

The userCertificateSelectionCallback delegate is useful when your application has multiple certificates and must dynamically choose a certificate. Certificates in the "MY" store are passed to the method invoked by the delegate.

NoteNote:

The Framework caches SSL sessions as they are created and attempts to reuse a cached session for a new request, if possible. When attempting to reuse an SSL session, the Framework uses the first element of P:System.Net.HttpWebRequest.ClientCertificates (if there is one), or tries to reuse an anonymous sessions if P:System.Net.HttpWebRequest.ClientCertificates is empty.

Windows 95, Windows 98, Windows 98 Second Edition, Windows Millennium Edition Platform Note: The Framework attempts to reuse an SSL session only if a client certificate is not required.

The following code example demonstrates calling this constructor. This example is part of a larger example provided for the SslStream class.

// Server name must match the host name and the name on the host's certificate. 
serverName = args[0];
// Create a TCP/IP client socket.
TcpClient client = new TcpClient(serverName,80);
Console.WriteLine("Client connected.");
// Create an SSL stream that will close the client's stream.
SslStream sslStream = new SslStream(
    client.GetStream(), 
    false, 
    new RemoteCertificateValidationCallback (ValidateServerCertificate), 
    new LocalCertificateSelectionCallback(SelectLocalCertificate)
    );
// Server name must match the host name and the name on the host's certificate. 
serverName = args[1];
// Create a TCP/IP client socket.
TcpClient* client = new TcpClient(serverName,8080);
Console::WriteLine(S"Client connected.");
// Create an SSL stream that will close the client's stream.
SslStream* sslStream = new SslStream(
    client->GetStream(), 
    false, 
    new RemoteCertValidationCallback (ValidateServerCertificate), 
    new LocalCertSelectionCallback(SelectLocalCertificate)
    );

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: