public class SslOption

Summary

Represents a configurable SSL option, used in setting up an SSL connection.

Property Summary

Flags Type Name Summary
public SslPolicyErrors AcceptablePolicyErrors (rw)

Retrieve or set the set of ssl policy errors that are deemed acceptable

public LocalCertificateSelectionCallback CertificateSelectionCallback (rw)

An optional client specified SSL certificate selection callback. If this is not specified, the first valid certificate found will be used.

public RemoteCertificateValidationCallback CertificateValidationCallback (rw)

An optional client specified SSL certificate validation callback. If this is not specified, the default callback will be used in conjunction with the AcceptablePolicyErrors property to determine if the remote server certificate is valid.

public string CertPassphrase (rw)

Retrieve or set the path to client certificate.

public string CertPath (rw)

Retrieve or set the path to client certificate.

public X509CertificateCollection Certs (rw)

Retrieve or set the X509CertificateCollection containing the client certificate. If no collection is set, the client will attempt to load one from the specified CertPath.

public bool Enabled (rw)

Flag specifying if Ssl should indeed be used

public string ServerName (rw)

Retrieve or set server's Canonical Name. This MUST match the CN on the Certificate else the SSL connection will fail

public SslProtocols Version (rw)

Retrieve or set the Ssl protocol version

Constructor Summary

Flags Name Summary
public SslOption()

Construct an SslOption with no parameters set

public SslOption(string serverName)

Construct an SslOption with just the server cannonical name. The Certificate path is set to an empty string

public SslOption(string serverName, string certPath, bool enabled)

Construct an SslOption specifying both the server cannonical name and the client's certificate path.

Property Detail

public SslPolicyErrors AcceptablePolicyErrors (rw)

Summary

Retrieve or set the set of ssl policy errors that are deemed acceptable

public LocalCertificateSelectionCallback CertificateSelectionCallback (rw)

Summary

An optional client specified SSL certificate selection callback. If this is not specified, the first valid certificate found will be used.

public RemoteCertificateValidationCallback CertificateValidationCallback (rw)

Summary

An optional client specified SSL certificate validation callback. If this is not specified, the default callback will be used in conjunction with the AcceptablePolicyErrors property to determine if the remote server certificate is valid.

public string CertPassphrase (rw)

Summary

Retrieve or set the path to client certificate.

public string CertPath (rw)

Summary

Retrieve or set the path to client certificate.

public X509CertificateCollection Certs (rw)

Summary

Retrieve or set the X509CertificateCollection containing the client certificate. If no collection is set, the client will attempt to load one from the specified CertPath.

public bool Enabled (rw)

Summary

Flag specifying if Ssl should indeed be used

public string ServerName (rw)

Summary

Retrieve or set server's Canonical Name. This MUST match the CN on the Certificate else the SSL connection will fail

public SslProtocols Version (rw)

Summary

Retrieve or set the Ssl protocol version

Constructor Detail

SslOption

public SslOption()

Summary

Construct an SslOption with no parameters set

SslOption

public SslOption(string serverName)

Parameters
Name Type
serverName string

Summary

Construct an SslOption with just the server cannonical name. The Certificate path is set to an empty string

SslOption

public SslOption(string serverName, string certPath, bool enabled)

Parameters
Name Type
serverName string
certPath string
enabled bool

Summary

Construct an SslOption specifying both the server cannonical name and the client's certificate path.