ClientCredentials.ServiceCertificate Property

Definition

Namespace:

System.ServiceModel.Description

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

ClientCredentials.cs

Gets an object used to specify a service's X.509 certificate.

public:
 property System::ServiceModel::Security::X509CertificateRecipientClientCredential ^ ServiceCertificate { System::ServiceModel::Security::X509CertificateRecipientClientCredential ^ get(); };

public System.ServiceModel.Security.X509CertificateRecipientClientCredential ServiceCertificate { get; }

member this.ServiceCertificate : System.ServiceModel.Security.X509CertificateRecipientClientCredential

Public ReadOnly Property ServiceCertificate As X509CertificateRecipientClientCredential

Property Value

X509CertificateRecipientClientCredential

An X509CertificateRecipientClientCredential that represents the certificate to use for a particular service.

Examples

This code shows how to use this property to get the service's certificate and set its properties.

X509CertificateRecipientClientCredential rcc =
    client.ClientCredentials.ServiceCertificate;

X509Certificate2 cert = new X509Certificate2();
rcc.ScopedCertificates.Add(new Uri("http://fabrikam.com/sts"), cert);

Remarks

You can use the object returned by this property to configure the certificate's properties by calling its members.

You can specify a single default certificate as well as a different certificate to be used when communicating with a particular URI.

Through this class, you also control the authentication settings for service certificates negotiated through SSL/TLS negotiation performed at the message level.

This property does not always have to be specified. Whether it is required depends on the authentication mode and negotiation options set on the binding that is used to communicate with the service. Some relevant classes that control this behavior are MessageSecurityOverHttp and MessageSecurityOverTcp.

You can also set this value using the <certificate> element in a client application configuration file.