AuthenticodeSigner Class

Properties   Methods   Events   Config Settings   Errors  

The AuthenticodeSigner class signs executable files (EXE) and dynamically linked libraries (DLL).

Syntax

AuthenticodeSigner

Remarks

Use this component to sign your binaries and optionally timestamp them.

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 (AuthenticodeSigner 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_authenticodesigner_getblockedcertcount(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner Class)

Returns the 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_authenticodesigner_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns the 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 (AuthenticodeSigner 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_authenticodesigner_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_authenticodesigner_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.

 
 Copy
  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

ClaimedSigningTime Property (AuthenticodeSigner Class)

The signing time from the signer's computer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimedSigningTime();
int SetClaimedSigningTime(const char* lpszClaimedSigningTime);

Unicode (Windows)
LPWSTR GetClaimedSigningTime();
INT SetClaimedSigningTime(LPCWSTR lpszClaimedSigningTime);

char* secureblackbox_authenticodesigner_getclaimedsigningtime(void* lpObj);
int secureblackbox_authenticodesigner_setclaimedsigningtime(void* lpObj, const char* lpszClaimedSigningTime);

QString GetClaimedSigningTime();
int SetClaimedSigningTime(QString qsClaimedSigningTime);

Default Value

""

Remarks

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

Data Type

String

CustomSignedAttrCount Property (AuthenticodeSigner Class)

The number of records in the CustomSignedAttr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomSignedAttrCount();

Unicode (Windows)
INT GetCustomSignedAttrCount();

int secureblackbox_authenticodesigner_getcustomsignedattrcount(void* lpObj);

int GetCustomSignedAttrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• CustomSignedAttrCategory
• CustomSignedAttrFormat
• CustomSignedAttrName
• CustomSignedAttrValue

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

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

Data Type

Integer

CustomSignedAttrCategory Property (AuthenticodeSigner Class)

Specifies the string category of the contained value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomSignedAttrCategory(int iCustomSignedAttrIndex);

Unicode (Windows)
LPWSTR GetCustomSignedAttrCategory(INT iCustomSignedAttrIndex);

char* secureblackbox_authenticodesigner_getcustomsignedattrcategory(void* lpObj, int customsignedattrindex);

QString GetCustomSignedAttrCategory(int iCustomSignedAttrIndex);

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The CustomSignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomSignedAttrCount property.

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

Data Type

String

CustomSignedAttrFormat Property (AuthenticodeSigner Class)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomSignedAttrFormat(int iCustomSignedAttrIndex);

Unicode (Windows)
INT GetCustomSignedAttrFormat(INT iCustomSignedAttrIndex);

int secureblackbox_authenticodesigner_getcustomsignedattrformat(void* lpObj, int customsignedattrindex);

int GetCustomSignedAttrFormat(int iCustomSignedAttrIndex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the CustomSignedAttrValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting:

 
 Copy
  utils.NameValuePairs[0].Name = "key";
  utils.NameValuePairs[0].Format = svfBinary;
  utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The CustomSignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomSignedAttrCount property.

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

Data Type

Integer

CustomSignedAttrName Property (AuthenticodeSigner Class)

The name element in a (name, value) pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomSignedAttrName(int iCustomSignedAttrIndex);

Unicode (Windows)
LPWSTR GetCustomSignedAttrName(INT iCustomSignedAttrIndex);

char* secureblackbox_authenticodesigner_getcustomsignedattrname(void* lpObj, int customsignedattrindex);

QString GetCustomSignedAttrName(int iCustomSignedAttrIndex);

Default Value

""

Remarks

The name element in a (name, value) pair.

The CustomSignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomSignedAttrCount property.

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

Data Type

String

CustomSignedAttrValue Property (AuthenticodeSigner Class)

The value element in a (name, value) pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomSignedAttrValue(int iCustomSignedAttrIndex);

Unicode (Windows)
LPWSTR GetCustomSignedAttrValue(INT iCustomSignedAttrIndex);

char* secureblackbox_authenticodesigner_getcustomsignedattrvalue(void* lpObj, int customsignedattrindex);

QString GetCustomSignedAttrValue(int iCustomSignedAttrIndex);

Default Value

""

Remarks

The value element in a (name, value) pair.

The CustomSignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomSignedAttrCount property.

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

Data Type

String

CustomUnsignedAttrCount Property (AuthenticodeSigner Class)

The number of records in the CustomUnsignedAttr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomUnsignedAttrCount();

Unicode (Windows)
INT GetCustomUnsignedAttrCount();

int secureblackbox_authenticodesigner_getcustomunsignedattrcount(void* lpObj);

int GetCustomUnsignedAttrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• CustomUnsignedAttrCategory
• CustomUnsignedAttrFormat
• CustomUnsignedAttrName
• CustomUnsignedAttrValue

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

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

Data Type

Integer

CustomUnsignedAttrCategory Property (AuthenticodeSigner Class)

Specifies the string category of the contained value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomUnsignedAttrCategory(int iCustomUnsignedAttrIndex);

Unicode (Windows)
LPWSTR GetCustomUnsignedAttrCategory(INT iCustomUnsignedAttrIndex);

char* secureblackbox_authenticodesigner_getcustomunsignedattrcategory(void* lpObj, int customunsignedattrindex);

QString GetCustomUnsignedAttrCategory(int iCustomUnsignedAttrIndex);

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The CustomUnsignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomUnsignedAttrCount property.

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

Data Type

String

CustomUnsignedAttrFormat Property (AuthenticodeSigner Class)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomUnsignedAttrFormat(int iCustomUnsignedAttrIndex);

Unicode (Windows)
INT GetCustomUnsignedAttrFormat(INT iCustomUnsignedAttrIndex);

int secureblackbox_authenticodesigner_getcustomunsignedattrformat(void* lpObj, int customunsignedattrindex);

int GetCustomUnsignedAttrFormat(int iCustomUnsignedAttrIndex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the CustomUnsignedAttrValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting:

 
 Copy
  utils.NameValuePairs[0].Name = "key";
  utils.NameValuePairs[0].Format = svfBinary;
  utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The CustomUnsignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomUnsignedAttrCount property.

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

Data Type

Integer

CustomUnsignedAttrName Property (AuthenticodeSigner Class)

The name element in a (name, value) pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomUnsignedAttrName(int iCustomUnsignedAttrIndex);

Unicode (Windows)
LPWSTR GetCustomUnsignedAttrName(INT iCustomUnsignedAttrIndex);

char* secureblackbox_authenticodesigner_getcustomunsignedattrname(void* lpObj, int customunsignedattrindex);

QString GetCustomUnsignedAttrName(int iCustomUnsignedAttrIndex);

Default Value

""

Remarks

The name element in a (name, value) pair.

The CustomUnsignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomUnsignedAttrCount property.

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

Data Type

String

CustomUnsignedAttrValue Property (AuthenticodeSigner Class)

The value element in a (name, value) pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomUnsignedAttrValue(int iCustomUnsignedAttrIndex);

Unicode (Windows)
LPWSTR GetCustomUnsignedAttrValue(INT iCustomUnsignedAttrIndex);

char* secureblackbox_authenticodesigner_getcustomunsignedattrvalue(void* lpObj, int customunsignedattrindex);

QString GetCustomUnsignedAttrValue(int iCustomUnsignedAttrIndex);

Default Value

""

Remarks

The value element in a (name, value) pair.

The CustomUnsignedAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomUnsignedAttrCount property.

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

Data Type

String

ExternalCryptoAsyncDocumentID Property (AuthenticodeSigner Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_authenticodesigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (AuthenticodeSigner Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_authenticodesigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (AuthenticodeSigner Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_authenticodesigner_getexternalcryptodata(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (AuthenticodeSigner Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_authenticodesigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (AuthenticodeSigner Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_authenticodesigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (AuthenticodeSigner Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_authenticodesigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (AuthenticodeSigner Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_authenticodesigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (AuthenticodeSigner Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_authenticodesigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (AuthenticodeSigner Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_authenticodesigner_getexternalcryptomode(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (AuthenticodeSigner Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_authenticodesigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_authenticodesigner_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (AuthenticodeSigner 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_authenticodesigner_getfipsmode(void* lpObj);
int secureblackbox_authenticodesigner_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

HashAlgorithm Property (AuthenticodeSigner Class)

The hash algorithm to be used for signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_authenticodesigner_gethashalgorithm(void* lpObj);
int secureblackbox_authenticodesigner_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

"SHA256"

Remarks

The following algorithms are supported: MD5, SHA1, SHA224, SHA256, SHA384, SHA512, SHA3_224, SHA3_256, SHA3_384, SHA3_512.

Data Type

String

IgnoreChainValidationErrors Property (AuthenticodeSigner Class)

Makes the class tolerant to chain validation errors.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(int bIgnoreChainValidationErrors);

Unicode (Windows)
BOOL GetIgnoreChainValidationErrors();
INT SetIgnoreChainValidationErrors(BOOL bIgnoreChainValidationErrors);

int secureblackbox_authenticodesigner_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_authenticodesigner_setignorechainvalidationerrors(void* lpObj, int bIgnoreChainValidationErrors);

bool GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(bool bIgnoreChainValidationErrors);

Default Value

FALSE

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

Data Type

Boolean

InputBytes Property (AuthenticodeSigner Class)

Use this property to pass the input to class in byte array form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_authenticodesigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_authenticodesigner_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (AuthenticodeSigner Class)

A path to the executable to be signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_authenticodesigner_getinputfile(void* lpObj);
int secureblackbox_authenticodesigner_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

A path to the file containing the executable to be signed. The input can alternatively be provided via InputStream.

Data Type

String

KnownCertCount Property (AuthenticodeSigner 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_authenticodesigner_getknowncertcount(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner Class)

Returns the 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_authenticodesigner_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the 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 (AuthenticodeSigner 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_authenticodesigner_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_authenticodesigner_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.

 
 Copy
  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 (AuthenticodeSigner 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_authenticodesigner_getknowncrlcount(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner Class)

Returns the 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_authenticodesigner_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns the 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 (AuthenticodeSigner 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_authenticodesigner_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_authenticodesigner_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.

 
 Copy
  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 (AuthenticodeSigner 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_authenticodesigner_getknownocspcount(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner Class)

A buffer containing the 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_authenticodesigner_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

A buffer containing the 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 (AuthenticodeSigner 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_authenticodesigner_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_authenticodesigner_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.

 
 Copy
  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

OfflineMode Property (AuthenticodeSigner Class)

Switches the class to offline mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOfflineMode();
int SetOfflineMode(int bOfflineMode);

Unicode (Windows)
BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);

int secureblackbox_authenticodesigner_getofflinemode(void* lpObj);
int secureblackbox_authenticodesigner_setofflinemode(void* lpObj, int bOfflineMode);

bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);

Default Value

FALSE

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

OutputBytes Property (AuthenticodeSigner Class)

Use this property to read the output the class object has produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_authenticodesigner_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (AuthenticodeSigner Class)

The file to save the signed executable to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_authenticodesigner_getoutputfile(void* lpObj);
int secureblackbox_authenticodesigner_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

A path to the file where the class should save the signed executable file. Use OutputStream to save the signed file to a stream instead.

Data Type

String

Profile Property (AuthenticodeSigner Class)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProfile();
int SetProfile(const char* lpszProfile);

Unicode (Windows)
LPWSTR GetProfile();
INT SetProfile(LPCWSTR lpszProfile);

char* secureblackbox_authenticodesigner_getprofile(void* lpObj);
int secureblackbox_authenticodesigner_setprofile(void* lpObj, const char* lpszProfile);

QString GetProfile();
int SetProfile(QString qsProfile);

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

ProxyAddress Property (AuthenticodeSigner 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_authenticodesigner_getproxyaddress(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyauthentication(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxypassword(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyport(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyproxytype(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyrequestheaders(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyresponsebody(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyresponseheaders(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyuseipv6(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyuseproxy(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getproxyusername(void* lpObj);
int secureblackbox_authenticodesigner_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

RemoveExistingSignatures Property (AuthenticodeSigner Class)

Specifies whether to remove any existing signatures before signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemoveExistingSignatures();
int SetRemoveExistingSignatures(int bRemoveExistingSignatures);

Unicode (Windows)
BOOL GetRemoveExistingSignatures();
INT SetRemoveExistingSignatures(BOOL bRemoveExistingSignatures);

int secureblackbox_authenticodesigner_getremoveexistingsignatures(void* lpObj);
int secureblackbox_authenticodesigner_setremoveexistingsignatures(void* lpObj, int bRemoveExistingSignatures);

bool GetRemoveExistingSignatures();
int SetRemoveExistingSignatures(bool bRemoveExistingSignatures);

Default Value

FALSE

Remarks

If this property is set to True, all the existing Authenticode signatures will be removed from the executable before adding the new one. If this property is False, the new signature will be added on top of the existing ones.

Data Type

Boolean

RevocationCheck Property (AuthenticodeSigner Class)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);

Unicode (Windows)
INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);

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_authenticodesigner_getrevocationcheck(void* lpObj);
int secureblackbox_authenticodesigner_setrevocationcheck(void* lpObj, int iRevocationCheck);

int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);

Default Value

1

Remarks

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

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

Integer

SignatureDescription Property (AuthenticodeSigner Class)

Sets human-readable signature description.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureDescription();
int SetSignatureDescription(const char* lpszSignatureDescription);

Unicode (Windows)
LPWSTR GetSignatureDescription();
INT SetSignatureDescription(LPCWSTR lpszSignatureDescription);

char* secureblackbox_authenticodesigner_getsignaturedescription(void* lpObj);
int secureblackbox_authenticodesigner_setsignaturedescription(void* lpObj, const char* lpszSignatureDescription);

QString GetSignatureDescription();
int SetSignatureDescription(QString qsSignatureDescription);

Default Value

""

Remarks

Use this property to provide description for the new signature. This is optional.

Data Type

String

SignatureIndex Property (AuthenticodeSigner Class)

The index of the signature to timstamp or update.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureIndex();
int SetSignatureIndex(int iSignatureIndex);

Unicode (Windows)
INT GetSignatureIndex();
INT SetSignatureIndex(INT iSignatureIndex);

int secureblackbox_authenticodesigner_getsignatureindex(void* lpObj);
int secureblackbox_authenticodesigner_setsignatureindex(void* lpObj, int iSignatureIndex);

int GetSignatureIndex();
int SetSignatureIndex(int iSignatureIndex);

Default Value

-1

Remarks

Use this property to specify the index of the existing signature before timestamping or adding custom unsigned attributes. -1 means all the existing signatures.

Data Type

Integer

SignatureURL Property (AuthenticodeSigner Class)

Sets the URL to include in the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureURL();
int SetSignatureURL(const char* lpszSignatureURL);

Unicode (Windows)
LPWSTR GetSignatureURL();
INT SetSignatureURL(LPCWSTR lpszSignatureURL);

char* secureblackbox_authenticodesigner_getsignatureurl(void* lpObj);
int secureblackbox_authenticodesigner_setsignatureurl(void* lpObj, const char* lpszSignatureURL);

QString GetSignatureURL();
int SetSignatureURL(QString qsSignatureURL);

Default Value

""

Remarks

Use this property to provide a custom URL with the signature. This is optional.

Data Type

String

SigningCertBytes Property (AuthenticodeSigner Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertBytes(char* &lpSigningCertBytes, int &lenSigningCertBytes);

Unicode (Windows)
INT GetSigningCertBytes(LPSTR &lpSigningCertBytes, INT &lenSigningCertBytes);

int secureblackbox_authenticodesigner_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

QByteArray GetSigningCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (AuthenticodeSigner Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSigningCertHandle();
int SetSigningCertHandle(int64 lSigningCertHandle);

Unicode (Windows)
LONG64 GetSigningCertHandle();
INT SetSigningCertHandle(LONG64 lSigningCertHandle);

int64 secureblackbox_authenticodesigner_getsigningcerthandle(void* lpObj);
int secureblackbox_authenticodesigner_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);

qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (AuthenticodeSigner Class)

The number of records in the SigningChain arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

Unicode (Windows)
INT GetSigningChainCount();
INT SetSigningChainCount(INT iSigningChainCount);

int secureblackbox_authenticodesigner_getsigningchaincount(void* lpObj);
int secureblackbox_authenticodesigner_setsigningchaincount(void* lpObj, int iSigningChainCount);

int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (AuthenticodeSigner Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningChainBytes(int iSigningChainIndex, char* &lpSigningChainBytes, int &lenSigningChainBytes);

Unicode (Windows)
INT GetSigningChainBytes(INT iSigningChainIndex, LPSTR &lpSigningChainBytes, INT &lenSigningChainBytes);

int secureblackbox_authenticodesigner_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);

QByteArray GetSigningChainBytes(int iSigningChainIndex);

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (AuthenticodeSigner Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, int64 lSigningChainHandle);

Unicode (Windows)
LONG64 GetSigningChainHandle(INT iSigningChainIndex);
INT SetSigningChainHandle(INT iSigningChainIndex, LONG64 lSigningChainHandle);

int64 secureblackbox_authenticodesigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_authenticodesigner_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);

qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SocketDNSMode Property (AuthenticodeSigner 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_authenticodesigner_getsocketdnsmode(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketdnsport(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_authenticodesigner_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 an infinite timeout.

Data Type

Integer

SocketDNSServers Property (AuthenticodeSigner 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_authenticodesigner_getsocketdnsservers(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_authenticodesigner_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 an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (AuthenticodeSigner 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_authenticodesigner_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketlocaladdress(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketlocalport(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsockettimeout(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_getsocketuseipv6(void* lpObj);
int secureblackbox_authenticodesigner_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

StatementType Property (AuthenticodeSigner Class)

Sets the signature statement type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetStatementType();
int SetStatementType(int iStatementType);

Unicode (Windows)
INT GetStatementType();
INT SetStatementType(INT iStatementType);

ACS_UNKNOWN(0), 
ACS_INDIVIDUAL(1), 
ACS_COMMERCIAL(2)

int secureblackbox_authenticodesigner_getstatementtype(void* lpObj);
int secureblackbox_authenticodesigner_setstatementtype(void* lpObj, int iStatementType);

int GetStatementType();
int SetStatementType(int iStatementType);

Default Value

1

Remarks

Use this property to specify the signature statement type.

Data Type

Integer

TimestampServer Property (AuthenticodeSigner Class)

The address of the timestamping server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimestampServer();
int SetTimestampServer(const char* lpszTimestampServer);

Unicode (Windows)
LPWSTR GetTimestampServer();
INT SetTimestampServer(LPCWSTR lpszTimestampServer);

char* secureblackbox_authenticodesigner_gettimestampserver(void* lpObj);
int secureblackbox_authenticodesigner_settimestampserver(void* lpObj, const char* lpszTimestampServer);

QString GetTimestampServer();
int SetTimestampServer(QString qsTimestampServer);

Default Value

""

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256

Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

All the parameters are optional.

Data Type

String

TimestampType Property (AuthenticodeSigner Class)

Sets the signature timestamp type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimestampType();
int SetTimestampType(int iTimestampType);

Unicode (Windows)
INT GetTimestampType();
INT SetTimestampType(INT iTimestampType);

ACT_UNKNOWN(0), 
ACT_LEGACY(1), 
ACT_TRUSTED(2)

int secureblackbox_authenticodesigner_gettimestamptype(void* lpObj);
int secureblackbox_authenticodesigner_settimestamptype(void* lpObj, int iTimestampType);

int GetTimestampType();
int SetTimestampType(int iTimestampType);

Default Value

2

Remarks

Use this property to specify the signature timestamp type. This can either be a "trusted" timestamp (a weird name applied by the Authenticode specification to a standard RFC 3161 timestamp), or a "legacy" timestamp (an older variant of the base64-encoded TSP protocol).

Data Type

Integer

TLSClientCertCount Property (AuthenticodeSigner Class)

The number of records in the TLSClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);

Unicode (Windows)
INT GetTLSClientCertCount();
INT SetTLSClientCertCount(INT iTLSClientCertCount);

int secureblackbox_authenticodesigner_gettlsclientcertcount(void* lpObj);
int secureblackbox_authenticodesigner_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);

int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (AuthenticodeSigner Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSClientCertBytes(int iTLSClientCertIndex, char* &lpTLSClientCertBytes, int &lenTLSClientCertBytes);

Unicode (Windows)
INT GetTLSClientCertBytes(INT iTLSClientCertIndex, LPSTR &lpTLSClientCertBytes, INT &lenTLSClientCertBytes);

int secureblackbox_authenticodesigner_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);

QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

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

Data Type

Byte Array

TLSClientCertHandle Property (AuthenticodeSigner Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, int64 lTLSClientCertHandle);

Unicode (Windows)
LONG64 GetTLSClientCertHandle(INT iTLSClientCertIndex);
INT SetTLSClientCertHandle(INT iTLSClientCertIndex, LONG64 lTLSClientCertHandle);

int64 secureblackbox_authenticodesigner_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_authenticodesigner_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);

qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (AuthenticodeSigner Class)

The number of records in the TLSServerCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSServerCertCount();

Unicode (Windows)
INT GetTLSServerCertCount();

int secureblackbox_authenticodesigner_gettlsservercertcount(void* lpObj);

int GetTLSServerCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

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

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

Data Type

Integer

TLSServerCertBytes Property (AuthenticodeSigner Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSServerCertBytes(int iTLSServerCertIndex, char* &lpTLSServerCertBytes, int &lenTLSServerCertBytes);

Unicode (Windows)
INT GetTLSServerCertBytes(INT iTLSServerCertIndex, LPSTR &lpTLSServerCertBytes, INT &lenTLSServerCertBytes);

int secureblackbox_authenticodesigner_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertHandle Property (AuthenticodeSigner Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTLSServerCertHandle(int iTLSServerCertIndex);

Unicode (Windows)
LONG64 GetTLSServerCertHandle(INT iTLSServerCertIndex);

int64 secureblackbox_authenticodesigner_gettlsservercerthandle(void* lpObj, int tlsservercertindex);

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Long64

TLSAutoValidateCertificates Property (AuthenticodeSigner 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_authenticodesigner_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_authenticodesigner_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 (AuthenticodeSigner 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_authenticodesigner_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_authenticodesigner_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 offered and tuned up for different purposes, such as high security or higher compatibility.