ITlsSocket Interface Reference

import "sfFTPLib.idl";

Properties
VARIANT_BOOL	Enabled [get]
VARIANT	ClientCertThumbprint [get, set]
	The thumbprint of the client certificate to be used.
BSTR	ClientCertStore [get, set]
	The certificate store name where the client certificate can be found.
long	ClientCertStoreLocation [get, set]
	The certificate store location where the client certificate can be found.
ISecurityConnectionInfo	ConnectionInfo [get]
	Retrieves information about the negotiated security parameters of the active connection.
VARIANT	RemoteCert [get]
	Contains a the encoded remote certificate.
long	DisabledProtocols [get, set]
	A mask of disabled protocols.

Property Documentation

ClientCertStore

BSTR ITlsSocket::ClientCertStore

getsetproperty

The certificate store name where the client certificate can be found.

Default: my Find more information at: CertOpenStore function.

ClientCertStoreLocation

long ITlsSocket::ClientCertStoreLocation

getsetproperty

The certificate store location where the client certificate can be found.

Default: 1 (Current User)

This value is passed as the high-word portion of the dwFlags argument of the WINAPI CertOpenStore function.

ClientCertThumbprint

VARIANT ITlsSocket::ClientCertThumbprint

getsetproperty

The thumbprint of the client certificate to be used.

Default: empty

To get the thumbprint of a certificate: ::CertGetCertificateContextProperty(pCertContext, CERT_HASH_PROP_ID, ...)

ConnectionInfo

ISecurityConnectionInfo ITlsSocket::ConnectionInfo

getproperty

Retrieves information about the negotiated security parameters of the active connection.

This property returns the ISecurityConnectionInfo interface, which contains the specific cryptographic algorithms and protocol versions currently in use.

Parameters

[out]

retval

Receives the ISecurityConnectionInfo interface pointer.

DisabledProtocols

long ITlsSocket::DisabledProtocols

getsetproperty

A mask of disabled protocols.

To disable TLS 1.3, set the property to SP_PROT_TLS1_3_CLIENT (0x00002000).

Enabled

VARIANT_BOOL ITlsSocket::Enabled

getproperty

RemoteCert

VARIANT ITlsSocket::RemoteCert

getproperty

Contains a the encoded remote certificate.

Refer to the C++ sample.

---

The documentation for this interface was generated from the following file:

• sfFTPLib.idl