OCSPManager Class

Properties   Methods   Events   Config Settings   Errors  

The OCSPManager class enables the import, export, and management of OCSP responses.

Syntax

OCSPManager

Remarks

OCSP is a protocol that allows you to verify a certificate's status in real-time, without using Certificate Revocation Lists (CRL).

An OCSP response is a response of the OCSP server to the client's request. As a minimum, it indicates the processing status of the prior request.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

BlockedCertCount Property (OCSPManager Class)

The number of records in the BlockedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Unicode (Windows)
INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);

int secureblackbox_ocspmanager_getblockedcertcount(void* lpObj);
int secureblackbox_ocspmanager_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

The array indices start at 0 and end at BlockedCertCount - 1.

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes);

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);

int secureblackbox_ocspmanager_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

BlockedCertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle);

Unicode (Windows)
LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);

int64 secureblackbox_ocspmanager_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_ocspmanager_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

CACertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCACertBytes(char* &lpCACertBytes, int &lenCACertBytes);

Unicode (Windows)
INT GetCACertBytes(LPSTR &lpCACertBytes, INT &lenCACertBytes);

int secureblackbox_ocspmanager_getcacertbytes(void* lpObj, char** lpCACertBytes, int* lenCACertBytes);

QByteArray GetCACertBytes();

Remarks

Returns raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

CACertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCACertHandle();
int SetCACertHandle(int64 lCACertHandle);

Unicode (Windows)
LONG64 GetCACertHandle();
INT SetCACertHandle(LONG64 lCACertHandle);

int64 secureblackbox_ocspmanager_getcacerthandle(void* lpObj);
int secureblackbox_ocspmanager_setcacerthandle(void* lpObj, int64 lCACertHandle);

qint64 GetCACertHandle();
int SetCACertHandle(qint64 lCACertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertBytes(char* &lpCertBytes, int &lenCertBytes);

Unicode (Windows)
INT GetCertBytes(LPSTR &lpCertBytes, INT &lenCertBytes);

int secureblackbox_ocspmanager_getcertbytes(void* lpObj, char** lpCertBytes, int* lenCertBytes);

QByteArray GetCertBytes();

Remarks

Returns raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

CertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertHandle();
int SetCertHandle(int64 lCertHandle);

Unicode (Windows)
LONG64 GetCertHandle();
INT SetCertHandle(LONG64 lCertHandle);

int64 secureblackbox_ocspmanager_getcerthandle(void* lpObj);
int secureblackbox_ocspmanager_setcerthandle(void* lpObj, int64 lCertHandle);

qint64 GetCertHandle();
int SetCertHandle(qint64 lCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (OCSPManager Class)

The number of records in the ClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Unicode (Windows)
INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);

int secureblackbox_ocspmanager_getclientcertcount(void* lpObj);
int secureblackbox_ocspmanager_setclientcertcount(void* lpObj, int iClientCertCount);

int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

The array indices start at 0 and end at ClientCertCount - 1.

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertBytes(int iClientCertIndex, char* &lpClientCertBytes, int &lenClientCertBytes);

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);

int secureblackbox_ocspmanager_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);

QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns raw certificate data in DER format.

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ClientCertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, int64 lClientCertHandle);

Unicode (Windows)
LONG64 GetClientCertHandle(INT iClientCertIndex);
INT SetClientCertHandle(INT iClientCertIndex, LONG64 lClientCertHandle);

int64 secureblackbox_ocspmanager_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_ocspmanager_setclientcerthandle(void* lpObj, int clientcertindex, int64 lClientCertHandle);

qint64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, qint64 lClientCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (OCSPManager Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();

int secureblackbox_ocspmanager_getconninfoaeadcipher(void* lpObj);

bool GetConnInfoAEADCipher();

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoChainValidationDetails Property (OCSPManager Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();

int secureblackbox_ocspmanager_getconninfochainvalidationdetails(void* lpObj);

int GetConnInfoChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoChainValidationResult Property (OCSPManager Class)

The outcome of a certificate chain validation routine.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_ocspmanager_getconninfochainvalidationresult(void* lpObj);

int GetConnInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoCiphersuite Property (OCSPManager Class)

The cipher suite employed by this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();

char* secureblackbox_ocspmanager_getconninfociphersuite(void* lpObj);

QString GetConnInfoCiphersuite();

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoClientAuthenticated Property (OCSPManager Class)

Specifies whether client authentication was performed during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();

int secureblackbox_ocspmanager_getconninfoclientauthenticated(void* lpObj);

bool GetConnInfoClientAuthenticated();

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoClientAuthRequested Property (OCSPManager Class)

Specifies whether client authentication was requested during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();

int secureblackbox_ocspmanager_getconninfoclientauthrequested(void* lpObj);

bool GetConnInfoClientAuthRequested();

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoConnectionEstablished Property (OCSPManager Class)

Indicates whether the connection has been established fully.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();

int secureblackbox_ocspmanager_getconninfoconnectionestablished(void* lpObj);

bool GetConnInfoConnectionEstablished();

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoConnectionID Property (OCSPManager Class)

The unique identifier assigned to this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionID(char* &lpConnInfoConnectionID, int &lenConnInfoConnectionID);

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);

int secureblackbox_ocspmanager_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);

QByteArray GetConnInfoConnectionID();

Remarks

The unique identifier assigned to this connection.

This property is read-only and not available at design time.

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (OCSPManager Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();

char* secureblackbox_ocspmanager_getconninfodigestalgorithm(void* lpObj);

QString GetConnInfoDigestAlgorithm();

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoEncryptionAlgorithm Property (OCSPManager Class)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();

char* secureblackbox_ocspmanager_getconninfoencryptionalgorithm(void* lpObj);

QString GetConnInfoEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoExportable Property (OCSPManager Class)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();

int secureblackbox_ocspmanager_getconninfoexportable(void* lpObj);

bool GetConnInfoExportable();

Default Value

FALSE

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (OCSPManager Class)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();

char* secureblackbox_ocspmanager_getconninfokeyexchangealgorithm(void* lpObj);

QString GetConnInfoKeyExchangeAlgorithm();

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoKeyExchangeKeyBits Property (OCSPManager Class)

The length of the key exchange key of a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();

int secureblackbox_ocspmanager_getconninfokeyexchangekeybits(void* lpObj);

int GetConnInfoKeyExchangeKeyBits();

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoNamedECCurve Property (OCSPManager Class)

The elliptic curve used in this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();

char* secureblackbox_ocspmanager_getconninfonamedeccurve(void* lpObj);

QString GetConnInfoNamedECCurve();

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoPFSCipher Property (OCSPManager Class)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();

int secureblackbox_ocspmanager_getconninfopfscipher(void* lpObj);

bool GetConnInfoPFSCipher();

Default Value

FALSE

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (OCSPManager Class)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();

char* secureblackbox_ocspmanager_getconninfopresharedidentityhint(void* lpObj);

QString GetConnInfoPreSharedIdentityHint();

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only and not available at design time.

Data Type

String

ConnInfoPublicKeyBits Property (OCSPManager Class)

The length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();

int secureblackbox_ocspmanager_getconninfopublickeybits(void* lpObj);

int GetConnInfoPublicKeyBits();

Default Value

0

Remarks

The length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoResumedSession Property (OCSPManager Class)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();

int secureblackbox_ocspmanager_getconninforesumedsession(void* lpObj);

bool GetConnInfoResumedSession();

Default Value

FALSE

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoSecureConnection Property (OCSPManager Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();

int secureblackbox_ocspmanager_getconninfosecureconnection(void* lpObj);

bool GetConnInfoSecureConnection();

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoServerAuthenticated Property (OCSPManager Class)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();

int secureblackbox_ocspmanager_getconninfoserverauthenticated(void* lpObj);

bool GetConnInfoServerAuthenticated();

Default Value

FALSE

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (OCSPManager Class)

The signature algorithm used in a TLS handshake.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();

char* secureblackbox_ocspmanager_getconninfosignaturealgorithm(void* lpObj);

QString GetConnInfoSignatureAlgorithm();

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only and not available at design time.

Data Type

String

ConnInfoSymmetricBlockSize Property (OCSPManager Class)

The block size of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();

int secureblackbox_ocspmanager_getconninfosymmetricblocksize(void* lpObj);

int GetConnInfoSymmetricBlockSize();

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoSymmetricKeyBits Property (OCSPManager Class)

The key length of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();

int secureblackbox_ocspmanager_getconninfosymmetrickeybits(void* lpObj);

int GetConnInfoSymmetricKeyBits();

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoTotalBytesReceived Property (OCSPManager Class)

The total number of bytes received over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();

int64 secureblackbox_ocspmanager_getconninfototalbytesreceived(void* lpObj);

qint64 GetConnInfoTotalBytesReceived();

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only and not available at design time.

Data Type

Long64

ConnInfoTotalBytesSent Property (OCSPManager Class)

The total number of bytes sent over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();

int64 secureblackbox_ocspmanager_getconninfototalbytessent(void* lpObj);

qint64 GetConnInfoTotalBytesSent();

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only and not available at design time.

Data Type

Long64

ConnInfoValidationLog Property (OCSPManager Class)

Contains the server certificate's chain validation log.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();

char* secureblackbox_ocspmanager_getconninfovalidationlog(void* lpObj);

QString GetConnInfoValidationLog();

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only and not available at design time.

Data Type

String

ConnInfoVersion Property (OCSPManager Class)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();

char* secureblackbox_ocspmanager_getconninfoversion(void* lpObj);

QString GetConnInfoVersion();

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only and not available at design time.

Data Type

String

EntryCount Property (OCSPManager Class)

The number of records in the Entry arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryCount();
int SetEntryCount(int iEntryCount);

Unicode (Windows)
INT GetEntryCount();
INT SetEntryCount(INT iEntryCount);

int secureblackbox_ocspmanager_getentrycount(void* lpObj);
int secureblackbox_ocspmanager_setentrycount(void* lpObj, int iEntryCount);

int GetEntryCount();
int SetEntryCount(int iEntryCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• EntryHandle

The array indices start at 0 and end at EntryCount - 1.

This property is not available at design time.

Data Type

Integer

EntryHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetEntryHandle(int iEntryIndex);
int SetEntryHandle(int iEntryIndex, int64 lEntryHandle);

Unicode (Windows)
LONG64 GetEntryHandle(INT iEntryIndex);
INT SetEntryHandle(INT iEntryIndex, LONG64 lEntryHandle);

int64 secureblackbox_ocspmanager_getentryhandle(void* lpObj, int entryindex);
int secureblackbox_ocspmanager_setentryhandle(void* lpObj, int entryindex, int64 lEntryHandle);

qint64 GetEntryHandle(int iEntryIndex);
int SetEntryHandle(int iEntryIndex, qint64 lEntryHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Long64

FIPSMode Property (OCSPManager Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_ocspmanager_getfipsmode(void* lpObj);
int secureblackbox_ocspmanager_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

KnownCertCount Property (OCSPManager Class)

The number of records in the KnownCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_ocspmanager_getknowncertcount(void* lpObj);
int secureblackbox_ocspmanager_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_ocspmanager_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_ocspmanager_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_ocspmanager_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (OCSPManager Class)

The number of records in the KnownCRL arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Unicode (Windows)
INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);

int secureblackbox_ocspmanager_getknowncrlcount(void* lpObj);
int secureblackbox_ocspmanager_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

The array indices start at 0 and end at KnownCRLCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (OCSPManager Class)

Returns raw CRL data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes);

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);

int secureblackbox_ocspmanager_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCRLHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle);

Unicode (Windows)
LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);

int64 secureblackbox_ocspmanager_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_ocspmanager_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (OCSPManager Class)

The number of records in the KnownOCSP arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Unicode (Windows)
INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);

int secureblackbox_ocspmanager_getknownocspcount(void* lpObj);
int secureblackbox_ocspmanager_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

The array indices start at 0 and end at KnownOCSPCount - 1.

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (OCSPManager Class)

Buffer containing raw OCSP response data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes);

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);

int secureblackbox_ocspmanager_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

Buffer containing raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownOCSPHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle);

Unicode (Windows)
LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);

int64 secureblackbox_ocspmanager_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_ocspmanager_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

OCSPResponseBytes Property (OCSPManager Class)

Buffer containing raw OCSP response data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOCSPResponseBytes(char* &lpOCSPResponseBytes, int &lenOCSPResponseBytes);

Unicode (Windows)
INT GetOCSPResponseBytes(LPSTR &lpOCSPResponseBytes, INT &lenOCSPResponseBytes);

int secureblackbox_ocspmanager_getocspresponsebytes(void* lpObj, char** lpOCSPResponseBytes, int* lenOCSPResponseBytes);

QByteArray GetOCSPResponseBytes();

Remarks

Buffer containing raw OCSP response data.

This property is read-only and not available at design time.

Data Type

Byte Array

OCSPResponseEntryCount Property (OCSPManager Class)

The number of SingleResponse elements contained in this OCSP response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOCSPResponseEntryCount();

Unicode (Windows)
INT GetOCSPResponseEntryCount();

int secureblackbox_ocspmanager_getocspresponseentrycount(void* lpObj);

int GetOCSPResponseEntryCount();

Default Value

0

Remarks

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

This property is read-only and not available at design time.

Data Type

Integer

OCSPResponseHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetOCSPResponseHandle();
int SetOCSPResponseHandle(int64 lOCSPResponseHandle);

Unicode (Windows)
LONG64 GetOCSPResponseHandle();
INT SetOCSPResponseHandle(LONG64 lOCSPResponseHandle);

int64 secureblackbox_ocspmanager_getocspresponsehandle(void* lpObj);
int secureblackbox_ocspmanager_setocspresponsehandle(void* lpObj, int64 lOCSPResponseHandle);

qint64 GetOCSPResponseHandle();
int SetOCSPResponseHandle(qint64 lOCSPResponseHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

OCSPResponseIssuer Property (OCSPManager Class)

Indicates the issuer of this response (a CA or its authorized representative).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPResponseIssuer();

Unicode (Windows)
LPWSTR GetOCSPResponseIssuer();

char* secureblackbox_ocspmanager_getocspresponseissuer(void* lpObj);

QString GetOCSPResponseIssuer();

Default Value

""

Remarks

Indicates the issuer of this response (a CA or its authorized representative).

This property is read-only and not available at design time.

Data Type

String

OCSPResponseIssuerRDN Property (OCSPManager Class)

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPResponseIssuerRDN();

Unicode (Windows)
LPWSTR GetOCSPResponseIssuerRDN();

char* secureblackbox_ocspmanager_getocspresponseissuerrdn(void* lpObj);

QString GetOCSPResponseIssuerRDN();

Default Value

""

Remarks

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

This property is read-only and not available at design time.

Data Type

String

OCSPResponseLocation Property (OCSPManager Class)

Location of the OCSP responder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPResponseLocation();

Unicode (Windows)
LPWSTR GetOCSPResponseLocation();

char* secureblackbox_ocspmanager_getocspresponselocation(void* lpObj);

QString GetOCSPResponseLocation();

Default Value

""

Remarks

Location of the OCSP responder.

This property is read-only and not available at design time.

Data Type

String

OCSPResponseProducedAt Property (OCSPManager Class)

Specifies the time when the response was produced, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPResponseProducedAt();

Unicode (Windows)
LPWSTR GetOCSPResponseProducedAt();

char* secureblackbox_ocspmanager_getocspresponseproducedat(void* lpObj);

QString GetOCSPResponseProducedAt();

Default Value

""

Remarks

Specifies the time when the response was produced, in UTC.

This property is read-only and not available at design time.

Data Type

String

ProxyAddress Property (OCSPManager Class)

The IP address of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress);

Unicode (Windows)
LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);

char* secureblackbox_ocspmanager_getproxyaddress(void* lpObj);
int secureblackbox_ocspmanager_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (OCSPManager Class)

The authentication type used by the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Unicode (Windows)
INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

int secureblackbox_ocspmanager_getproxyauthentication(void* lpObj);
int secureblackbox_ocspmanager_setproxyauthentication(void* lpObj, int iProxyAuthentication);

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (OCSPManager Class)

The password to authenticate to the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* secureblackbox_ocspmanager_getproxypassword(void* lpObj);
int secureblackbox_ocspmanager_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (OCSPManager Class)

The port on the proxy server to connect to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int secureblackbox_ocspmanager_getproxyport(void* lpObj);
int secureblackbox_ocspmanager_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (OCSPManager Class)

The type of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Unicode (Windows)
INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

int secureblackbox_ocspmanager_getproxyproxytype(void* lpObj);
int secureblackbox_ocspmanager_setproxyproxytype(void* lpObj, int iProxyProxyType);

int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

Data Type

Integer

ProxyRequestHeaders Property (OCSPManager Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders);

Unicode (Windows)
LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);

char* secureblackbox_ocspmanager_getproxyrequestheaders(void* lpObj);
int secureblackbox_ocspmanager_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (OCSPManager Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody);

Unicode (Windows)
LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);

char* secureblackbox_ocspmanager_getproxyresponsebody(void* lpObj);
int secureblackbox_ocspmanager_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (OCSPManager Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders);

Unicode (Windows)
LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);

char* secureblackbox_ocspmanager_getproxyresponseheaders(void* lpObj);
int secureblackbox_ocspmanager_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (OCSPManager Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6);

Unicode (Windows)
BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);

int secureblackbox_ocspmanager_getproxyuseipv6(void* lpObj);
int secureblackbox_ocspmanager_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

FALSE

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (OCSPManager Class)

Enables or disables proxy-driven connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy);

Unicode (Windows)
BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);

int secureblackbox_ocspmanager_getproxyuseproxy(void* lpObj);
int secureblackbox_ocspmanager_setproxyuseproxy(void* lpObj, int bProxyUseProxy);

bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (OCSPManager Class)

Specifies the username credential for proxy authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername);

Unicode (Windows)
LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);

char* secureblackbox_ocspmanager_getproxyusername(void* lpObj);
int secureblackbox_ocspmanager_setproxyusername(void* lpObj, const char* lpszProxyUsername);

QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerCertCount Property (OCSPManager Class)

The number of records in the ServerCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertCount();

Unicode (Windows)
INT GetServerCertCount();

int secureblackbox_ocspmanager_getservercertcount(void* lpObj);

int GetServerCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertCAKeyID
• ServerCertFingerprint
• ServerCertHandle
• ServerCertIssuer
• ServerCertIssuerRDN
• ServerCertKeyAlgorithm
• ServerCertKeyBits
• ServerCertKeyFingerprint
• ServerCertKeyUsage
• ServerCertPublicKeyBytes
• ServerCertSelfSigned
• ServerCertSerialNumber
• ServerCertSigAlgorithm
• ServerCertSubject
• ServerCertSubjectKeyID
• ServerCertSubjectRDN
• ServerCertValidFrom
• ServerCertValidTo

The array indices start at 0 and end at ServerCertCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ServerCertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertBytes(int iServerCertIndex, char* &lpServerCertBytes, int &lenServerCertBytes);

Unicode (Windows)
INT GetServerCertBytes(INT iServerCertIndex, LPSTR &lpServerCertBytes, INT &lenServerCertBytes);

int secureblackbox_ocspmanager_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);

QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns raw certificate data in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertCAKeyID Property (OCSPManager Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertCAKeyID(int iServerCertIndex, char* &lpServerCertCAKeyID, int &lenServerCertCAKeyID);

Unicode (Windows)
INT GetServerCertCAKeyID(INT iServerCertIndex, LPSTR &lpServerCertCAKeyID, INT &lenServerCertCAKeyID);

int secureblackbox_ocspmanager_getservercertcakeyid(void* lpObj, int servercertindex, char** lpServerCertCAKeyID, int* lenServerCertCAKeyID);

QByteArray GetServerCertCAKeyID(int iServerCertIndex);

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertFingerprint Property (OCSPManager Class)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertFingerprint(int iServerCertIndex, char* &lpServerCertFingerprint, int &lenServerCertFingerprint);

Unicode (Windows)
INT GetServerCertFingerprint(INT iServerCertIndex, LPSTR &lpServerCertFingerprint, INT &lenServerCertFingerprint);

int secureblackbox_ocspmanager_getservercertfingerprint(void* lpObj, int servercertindex, char** lpServerCertFingerprint, int* lenServerCertFingerprint);

QByteArray GetServerCertFingerprint(int iServerCertIndex);

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetServerCertHandle(int iServerCertIndex);

Unicode (Windows)
LONG64 GetServerCertHandle(INT iServerCertIndex);

int64 secureblackbox_ocspmanager_getservercerthandle(void* lpObj, int servercertindex);

qint64 GetServerCertHandle(int iServerCertIndex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Long64

ServerCertIssuer Property (OCSPManager Class)

The common name of the certificate issuer (CA), typically a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertIssuer(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertIssuer(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertissuer(void* lpObj, int servercertindex);

QString GetServerCertIssuer(int iServerCertIndex);

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertIssuerRDN Property (OCSPManager Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertIssuerRDN(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertIssuerRDN(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertissuerrdn(void* lpObj, int servercertindex);

QString GetServerCertIssuerRDN(int iServerCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertKeyAlgorithm Property (OCSPManager Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertKeyAlgorithm(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertKeyAlgorithm(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertkeyalgorithm(void* lpObj, int servercertindex);

QString GetServerCertKeyAlgorithm(int iServerCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertKeyBits Property (OCSPManager Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertKeyBits(int iServerCertIndex);

Unicode (Windows)
INT GetServerCertKeyBits(INT iServerCertIndex);

int secureblackbox_ocspmanager_getservercertkeybits(void* lpObj, int servercertindex);

int GetServerCertKeyBits(int iServerCertIndex);

Default Value

0

Remarks

Returns the length of the public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

ServerCertKeyFingerprint Property (OCSPManager Class)

Returns a fingerprint of the public key contained in the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertKeyFingerprint(int iServerCertIndex, char* &lpServerCertKeyFingerprint, int &lenServerCertKeyFingerprint);

Unicode (Windows)
INT GetServerCertKeyFingerprint(INT iServerCertIndex, LPSTR &lpServerCertKeyFingerprint, INT &lenServerCertKeyFingerprint);

int secureblackbox_ocspmanager_getservercertkeyfingerprint(void* lpObj, int servercertindex, char** lpServerCertKeyFingerprint, int* lenServerCertKeyFingerprint);

QByteArray GetServerCertKeyFingerprint(int iServerCertIndex);

Remarks

Returns a fingerprint of the public key contained in the certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertKeyUsage Property (OCSPManager Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertKeyUsage(int iServerCertIndex);

Unicode (Windows)
INT GetServerCertKeyUsage(INT iServerCertIndex);

int secureblackbox_ocspmanager_getservercertkeyusage(void* lpObj, int servercertindex);

int GetServerCertKeyUsage(int iServerCertIndex);

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

ServerCertPublicKeyBytes Property (OCSPManager Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertPublicKeyBytes(int iServerCertIndex, char* &lpServerCertPublicKeyBytes, int &lenServerCertPublicKeyBytes);

Unicode (Windows)
INT GetServerCertPublicKeyBytes(INT iServerCertIndex, LPSTR &lpServerCertPublicKeyBytes, INT &lenServerCertPublicKeyBytes);

int secureblackbox_ocspmanager_getservercertpublickeybytes(void* lpObj, int servercertindex, char** lpServerCertPublicKeyBytes, int* lenServerCertPublicKeyBytes);

QByteArray GetServerCertPublicKeyBytes(int iServerCertIndex);

Remarks

Contains the certificate's public key in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertSelfSigned Property (OCSPManager Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertSelfSigned(int iServerCertIndex);

Unicode (Windows)
BOOL GetServerCertSelfSigned(INT iServerCertIndex);

int secureblackbox_ocspmanager_getservercertselfsigned(void* lpObj, int servercertindex);

bool GetServerCertSelfSigned(int iServerCertIndex);

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ServerCertSerialNumber Property (OCSPManager Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertSerialNumber(int iServerCertIndex, char* &lpServerCertSerialNumber, int &lenServerCertSerialNumber);

Unicode (Windows)
INT GetServerCertSerialNumber(INT iServerCertIndex, LPSTR &lpServerCertSerialNumber, INT &lenServerCertSerialNumber);

int secureblackbox_ocspmanager_getservercertserialnumber(void* lpObj, int servercertindex, char** lpServerCertSerialNumber, int* lenServerCertSerialNumber);

QByteArray GetServerCertSerialNumber(int iServerCertIndex);

Remarks

Returns the certificate's serial number.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertSigAlgorithm Property (OCSPManager Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertSigAlgorithm(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSigAlgorithm(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertsigalgorithm(void* lpObj, int servercertindex);

QString GetServerCertSigAlgorithm(int iServerCertIndex);

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertSubject Property (OCSPManager Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertSubject(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSubject(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertsubject(void* lpObj, int servercertindex);

QString GetServerCertSubject(int iServerCertIndex);

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertSubjectKeyID Property (OCSPManager Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertSubjectKeyID(int iServerCertIndex, char* &lpServerCertSubjectKeyID, int &lenServerCertSubjectKeyID);

Unicode (Windows)
INT GetServerCertSubjectKeyID(INT iServerCertIndex, LPSTR &lpServerCertSubjectKeyID, INT &lenServerCertSubjectKeyID);

int secureblackbox_ocspmanager_getservercertsubjectkeyid(void* lpObj, int servercertindex, char** lpServerCertSubjectKeyID, int* lenServerCertSubjectKeyID);

QByteArray GetServerCertSubjectKeyID(int iServerCertIndex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertSubjectRDN Property (OCSPManager Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertSubjectRDN(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSubjectRDN(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertsubjectrdn(void* lpObj, int servercertindex);

QString GetServerCertSubjectRDN(int iServerCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertValidFrom Property (OCSPManager Class)

The time point at which the certificate becomes valid, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertValidFrom(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertValidFrom(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertvalidfrom(void* lpObj, int servercertindex);

QString GetServerCertValidFrom(int iServerCertIndex);

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertValidTo Property (OCSPManager Class)

The time point at which the certificate expires, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerCertValidTo(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertValidTo(INT iServerCertIndex);

char* secureblackbox_ocspmanager_getservercertvalidto(void* lpObj, int servercertindex);

QString GetServerCertValidTo(int iServerCertIndex);

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

SocketDNSMode Property (OCSPManager Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Unicode (Windows)
INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);

DM_AUTO(0), 
DM_PLATFORM(1), 
DM_OWN(2), 
DM_OWN_SECURE(3)

int secureblackbox_ocspmanager_getsocketdnsmode(void* lpObj);
int secureblackbox_ocspmanager_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (OCSPManager Class)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Unicode (Windows)
INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);

int secureblackbox_ocspmanager_getsocketdnsport(void* lpObj);
int secureblackbox_ocspmanager_setsocketdnsport(void* lpObj, int iSocketDNSPort);

int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (OCSPManager Class)

The timeout (in milliseconds) for each DNS query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Unicode (Windows)
INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);

int secureblackbox_ocspmanager_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_ocspmanager_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketDNSServers Property (OCSPManager Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers);

Unicode (Windows)
LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);

char* secureblackbox_ocspmanager_getsocketdnsservers(void* lpObj);
int secureblackbox_ocspmanager_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (OCSPManager Class)

The timeout (in milliseconds) for the whole resolution process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Unicode (Windows)
INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);

int secureblackbox_ocspmanager_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_ocspmanager_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (OCSPManager Class)

The maximum number of bytes to read from the socket, per second.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Unicode (Windows)
INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);

int secureblackbox_ocspmanager_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_ocspmanager_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (OCSPManager Class)

The local network interface to bind the socket to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress);

Unicode (Windows)
LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);

char* secureblackbox_ocspmanager_getsocketlocaladdress(void* lpObj);
int secureblackbox_ocspmanager_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (OCSPManager Class)

The local port number to bind the socket to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Unicode (Windows)
INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);

int secureblackbox_ocspmanager_getsocketlocalport(void* lpObj);
int secureblackbox_ocspmanager_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (OCSPManager Class)

The maximum number of bytes to write to the socket, per second.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Unicode (Windows)
INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);

int secureblackbox_ocspmanager_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_ocspmanager_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (OCSPManager Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Unicode (Windows)
INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);

int secureblackbox_ocspmanager_getsockettimeout(void* lpObj);
int secureblackbox_ocspmanager_setsockettimeout(void* lpObj, int iSocketTimeout);

int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (OCSPManager Class)

Enables or disables IP protocol version 6.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6);

Unicode (Windows)
BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);

int secureblackbox_ocspmanager_getsocketuseipv6(void* lpObj);
int secureblackbox_ocspmanager_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (OCSPManager Class)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates);

Unicode (Windows)
BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);

int secureblackbox_ocspmanager_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_ocspmanager_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

Default Value

TRUE

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (OCSPManager Class)

Selects the base configuration for the TLS settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Unicode (Windows)
INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1), 
STPC_COMPREHENSIVE_INSECURE(2), 
STPC_HIGHLY_SECURE(3)

int secureblackbox_ocspmanager_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_ocspmanager_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (OCSPManager Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites);

Unicode (Windows)
LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);

char* secureblackbox_ocspmanager_gettlsciphersuites(void* lpObj);
int secureblackbox_ocspmanager_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSECCurves Property (OCSPManager Class)

Defines the elliptic curves to enable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves);

Unicode (Windows)
LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);

char* secureblackbox_ocspmanager_gettlseccurves(void* lpObj);
int secureblackbox_ocspmanager_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (OCSPManager Class)

Provides access to TLS extensions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions);

Unicode (Windows)
LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);

char* secureblackbox_ocspmanager_gettlsextensions(void* lpObj);
int secureblackbox_ocspmanager_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (OCSPManager Class)

Whether to force TLS session resumption when the destination address changes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges);

Unicode (Windows)
BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);

int secureblackbox_ocspmanager_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_ocspmanager_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

Default Value

FALSE

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (OCSPManager Class)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity);

Unicode (Windows)
LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);

char* secureblackbox_ocspmanager_gettlspresharedidentity(void* lpObj);
int secureblackbox_ocspmanager_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (OCSPManager Class)

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey);

Unicode (Windows)
LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);

char* secureblackbox_ocspmanager_gettlspresharedkey(void* lpObj);
int secureblackbox_ocspmanager_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

Default Value

""

Remarks

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (OCSPManager Class)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite);

Unicode (Windows)
LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);

char* secureblackbox_ocspmanager_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_ocspmanager_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (OCSPManager Class)

Selects renegotiation attack prevention mechanism.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Unicode (Windows)
INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1), 
CRAPM_AUTO(2)

int secureblackbox_ocspmanager_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_ocspmanager_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (OCSPManager Class)

Specifies the kind(s) of revocation check to perform.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Unicode (Windows)
INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

CRC_NONE(0), 
CRC_AUTO(1), 
CRC_ALL_CRL(2), 
CRC_ALL_OCSP(3), 
CRC_ALL_CRLAND_OCSP(4), 
CRC_ANY_CRL(5), 
CRC_ANY_OCSP(6), 
CRC_ANY_CRLOR_OCSP(7), 
CRC_ANY_OCSPOR_CRL(8)

int secureblackbox_ocspmanager_gettlsrevocationcheck(void* lpObj);
int secureblackbox_ocspmanager_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (OCSPManager Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Unicode (Windows)
INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);

int secureblackbox_ocspmanager_gettlsssloptions(void* lpObj);
int secureblackbox_ocspmanager_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (OCSPManager Class)

Specifies the TLS mode to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Unicode (Windows)
INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

SM_DEFAULT(0), 
SM_NO_TLS(1), 
SM_EXPLICIT_TLS(2), 
SM_IMPLICIT_TLS(3), 
SM_MIXED_TLS(4)

int secureblackbox_ocspmanager_gettlstlsmode(void* lpObj);
int secureblackbox_ocspmanager_settlstlsmode(void* lpObj, int iTLSTLSMode);

int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (OCSPManager Class)

Enables Extended Master Secret Extension, as defined in RFC 7627.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret);

Unicode (Windows)
BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);

int secureblackbox_ocspmanager_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_ocspmanager_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

Default Value

FALSE

Remarks

Enables Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (OCSPManager Class)

Enables or disables TLS session resumption capability.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption);

Unicode (Windows)
BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);

int secureblackbox_ocspmanager_gettlsusesessionresumption(void* lpObj);
int secureblackbox_ocspmanager_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (OCSPManager Class)

The SSL/TLS versions to enable by default.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Unicode (Windows)
INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);

int secureblackbox_ocspmanager_gettlsversions(void* lpObj);
int secureblackbox_ocspmanager_settlsversions(void* lpObj, int iTLSVersions);

int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (OCSPManager Class)

The number of records in the TrustedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Unicode (Windows)
INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);

int secureblackbox_ocspmanager_gettrustedcertcount(void* lpObj);
int secureblackbox_ocspmanager_settrustedcertcount(void* lpObj, int iTrustedCertCount);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

The array indices start at 0 and end at TrustedCertCount - 1.

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (OCSPManager Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustedCertBytes(int iTrustedCertIndex, char* &lpTrustedCertBytes, int &lenTrustedCertBytes);

Unicode (Windows)
INT GetTrustedCertBytes(INT iTrustedCertIndex, LPSTR &lpTrustedCertBytes, INT &lenTrustedCertBytes);

int secureblackbox_ocspmanager_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);

QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

Remarks

Returns raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

TrustedCertHandle Property (OCSPManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, int64 lTrustedCertHandle);

Unicode (Windows)
LONG64 GetTrustedCertHandle(INT iTrustedCertIndex);
INT SetTrustedCertHandle(INT iTrustedCertIndex, LONG64 lTrustedCertHandle);

int64 secureblackbox_ocspmanager_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_ocspmanager_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);

qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Long64

Config Method (OCSPManager Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_ocspmanager_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (OCSPManager Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_ocspmanager_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetCertEntryIndex Method (OCSPManager Class)

Returns the index of the list item for the given certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEntryIndex(const char* lpSerialNumber, int lenSerialNumber);

Unicode (Windows)
INT GetCertEntryIndex(LPCSTR lpSerialNumber, INT lenSerialNumber);

int secureblackbox_ocspmanager_getcertentryindex(void* lpObj, const char* lpSerialNumber, int lenSerialNumber);

int GetCertEntryIndex(QByteArray qbaSerialNumber);

Remarks

Use this method to get the entry index given certificate's SerialNumber.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

LoadFromBytes Method (OCSPManager Class)

Loads an OCSP response from a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadFromBytes(const char* lpRespBytes, int lenRespBytes);

Unicode (Windows)
INT LoadFromBytes(LPCSTR lpRespBytes, INT lenRespBytes);

int secureblackbox_ocspmanager_loadfrombytes(void* lpObj, const char* lpRespBytes, int lenRespBytes);

int LoadFromBytes(QByteArray qbaRespBytes);

Remarks

Use this method to load an OCSP response from a byte array

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LoadFromStream Method (OCSPManager Class)

Loads an OCSP response from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadFromStream(SecureBlackboxStream* sStream);

Unicode (Windows)
INT LoadFromStream(SecureBlackboxStream* sStream);

int secureblackbox_ocspmanager_loadfromstream(void* lpObj, SecureBlackboxStream* sStream);

int LoadFromStream(SecureBlackboxStream* sStream);

Remarks

Use this method to load an OCSP response from a file.

Use this method to load an OCSP response from a stream.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Request Method (OCSPManager Class)

Requests an OCSP response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Request();

Unicode (Windows)
INT Request();

int secureblackbox_ocspmanager_request(void* lpObj);

bool Request();

Remarks

Use this method to request an OCSP response for a certificate. Assign the certificate to Certificate, and its CA certificate (required) to CACertificate property.

The method returns true if the CA provides OCSP service for this certificate, and false otherwise. If OCSP service is provided, and the request succeeds, the downloaded OCSP response will be available in OCSPResponse. If OCSP service is provided, but the request fails (e.g. due to a network issue), an exception will be thrown.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SaveToBytes Method (OCSPManager Class)

Saves a copy of the OCSP response to a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SaveToBytes(int *lpSize = NULL);

Unicode (Windows)
LPSTR SaveToBytes(LPINT lpSize = NULL);

char* secureblackbox_ocspmanager_savetobytes(void* lpObjint *lpSize);

QByteArray SaveToBytes();

Remarks

Use this method to save a copy of the attached OCSP response to a byte array.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SaveToFile Method (OCSPManager Class)

Saves a copy of the OCSP response to a file.

Syntax

• C++
• C
• Qt