This documentation is archived and is not being maintained.
LocalCertificateSelectionCallback Delegate
Visual Studio 2010
Selects the local Secure Sockets Layer (SSL) certificate used for authentication.
Assembly: System (in System.dll)
public delegate X509Certificate^ LocalCertificateSelectionCallback( Object^ sender, String^ targetHost, X509CertificateCollection^ localCertificates, X509Certificate^ remoteCertificate, array<String^>^ acceptableIssuers )
Parameters
- sender
- Type: System::Object
An object that contains state information for this validation.
- targetHost
- Type: System::String
The host server specified by the client.
- localCertificates
- Type: System.Security.Cryptography.X509Certificates::X509CertificateCollection
An X509CertificateCollection containing local certificates.
- remoteCertificate
- Type: System.Security.Cryptography.X509Certificates::X509Certificate
The certificate used to authenticate the remote party.
- acceptableIssuers
- Type: array<System::String>
A String array of certificate issuers acceptable to the remote party.
Return Value
Type: System.Security.Cryptography.X509Certificates::X509CertificateAn X509Certificate used for establishing an SSL connection.
The following code example demonstrates a method implementation for this delegate.
static X509Certificate^ SelectLocalCertificate(
Object^ sender,
String^ targetHost,
X509CertificateCollection^ localCertificates,
X509Certificate^ remoteCertificate,
array<String^>^ acceptableIssuers
)
{
Console::WriteLine("Client is selecting a local certificate.");
if (acceptableIssuers != nullptr &&
acceptableIssuers->Length > 0 &&
localCertificates != nullptr &&
localCertificates->Count > 0)
{
// Use the first certificate that is from an acceptable issuer.
IEnumerator^ myEnum1 = localCertificates->GetEnumerator();
while ( myEnum1->MoveNext() )
{
X509Certificate^ certificate = safe_cast<X509Certificate^>(myEnum1->Current);
String^ issuer = certificate->Issuer;
if ( Array::IndexOf( acceptableIssuers, issuer ) != -1 )
return certificate;
}
}
if (localCertificates != nullptr &&
localCertificates->Count > 0)
return localCertificates[0];
return nullptr;
}
The following code example demonstrates creating an instance of this delegate.
// 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 = gcnew TcpClient( serverName,80 ); Console::WriteLine( L"Client connected." ); // Create an SSL stream that will close the client's stream. SslStream^ sslStream = gcnew SslStream( client->GetStream(), false, gcnew RemoteCertificateValidationCallback( ValidateServerCertificate ), gcnew LocalCertificateSelectionCallback( SelectLocalCertificate ) );
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: