PDFVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The PDFVerifier class verifies signatures over PDF documents.

Syntax

PDFVerifier

Remarks

Use PDFVerifier to validate electronic signatures over PDF documents. Generic and PAdES signatures are supported.

PDFVerifier validates each signature from two perspectives: the integrity and validity of the signature itself (i.e. its correspondence to the document data it covers), and the validity and trustworthiness of the signing certificate chain. These two signature aspects are generally independent of each other: the signature may be valid but the chain may not be trusted, or, the other way round, the chain may be trusted, but the integrity of the signature may be violated. Under normal circumstances both the signature and the chain must be valid for the signature to be considered good.

To initiate the validation, assign the path to the signed PDF file to the InputFile property (alternatively, you can provide it in a memory buffer via InputBytes property), and call Verify method. For every signature located in the document, PDFVerifier will fire the SignatureFound event. This event lets you specify whether you want PDFVerifier to validate the signature, the chain, or both.

Note: it does not mean that any of the two is optional. This API lets you be flexible in how you validate documents in your code in accordance with the specifics of your application and its usage scenarios. For example, if your trust environment relies on certificate pinning, validating the chain by PDFVerifier internally may cause unnecessary burden on the system, in which case it may be reasonable to disable it in the event handler.

Once SignatureFound returns, PDFVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, SignatureValidated event is fired, and the validation results are separately provided via SignatureValidationResult and ChainValidationResult properties of the associated signature object. Other information about the signature can be accessed via the Signatures property.

PDF format uses incremental updates to introduce changes to the document. This implies that a signature may cover not the whole document but, rather, a certain revision of it. Strictly speaking, every signature in a PDF document apart from, perhaps, the last one covers just some part of the document. In most cases that part matches the revision of the document that existed before all the subsequent signatures had been added.

Because of this specifics of PDF format it is crucially important to understand what part of the document is covered by a specific signature. Use the to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte 0 to CoverageEndsAt. Alternatively, you can use the GetSignedVersion method to extract the signed revision to a file.

Useful settings and properties

The following properties of PDFVerifier may be handy when working with this component:

• OfflineMode lets you validate the document without contacting online revocation sources. Paired with switched off system trust settings, it can be used to establish the long-term validity of the document and the completeness of validation material included in it.
• RevocationCheck lets you adjust the revocation checking preferences.
• ValidatedSigningTime returns the signing time as recorded in the embedded signature timestamp. This is in contrast to ClaimedSigningTime, which returns the signing time as specified by the signer.
• ValidationLog is a great way to find out the details of chain validation failures. This property returns a comprehensive validation log that reports all the issues encountered during the validation.
• If the document is encrypted (in addition to being signed), DecryptionInfoNeeded event will fire, asking you for the decryption certificate or password.

By default, PDFVerifier uses the system trust settings to establish certificate chain validity. You can configure it to use your own, custom validation environment by providing the necessary trust elements via KnownCertificates, TrustedCertificates, KnownCRLs, and other similar properties.

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.

AllSignaturesValid Property (PDFVerifier Class)

The cumulative validity of all signatures.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAllSignaturesValid();

Unicode (Windows)
BOOL GetAllSignaturesValid();

int secureblackbox_pdfverifier_getallsignaturesvalid(void* lpObj);

bool GetAllSignaturesValid();

Default Value

FALSE

Remarks

Use this property to check if all the signatures found in the message or document are valid.

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

Data Type

Boolean

AttachedFileCount Property (PDFVerifier Class)

The number of records in the AttachedFiles arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachedFileCount();

Unicode (Windows)
INT GetAttachedFileCount();

int secureblackbox_pdfverifier_getattachedfilecount(void* lpObj);

int GetAttachedFileCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachedFilesContentSubtype
• AttachedFilesContentType
• AttachedFilesCreationDate
• AttachedFilesData
• AttachedFilesDescription
• AttachedFilesFilename
• AttachedFilesHandle
• AttachedFilesID
• AttachedFilesModificationDate
• AttachedFilesReadDate
• AttachedFilesSize

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

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

Data Type

Integer

AttachedFilesContentSubtype Property (PDFVerifier Class)

Contains the content subtype of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesContentSubtype(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesContentSubtype(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilescontentsubtype(void* lpObj, int attachedfileindex);

QString GetAttachedFilesContentSubtype(int iAttachedFileIndex);

Default Value

""

Remarks

Contains the content subtype of the attachment.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesContentType Property (PDFVerifier Class)

Contain the content type of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesContentType(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesContentType(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilescontenttype(void* lpObj, int attachedfileindex);

QString GetAttachedFilesContentType(int iAttachedFileIndex);

Default Value

""

Remarks

Contain the content type of the attachment.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesCreationDate Property (PDFVerifier Class)

The creation date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesCreationDate(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesCreationDate(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilescreationdate(void* lpObj, int attachedfileindex);

QString GetAttachedFilesCreationDate(int iAttachedFileIndex);

Default Value

""

Remarks

The creation date.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesData Property (PDFVerifier Class)

The content of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachedFilesData(int iAttachedFileIndex, char* &lpAttachedFilesData, int &lenAttachedFilesData);

Unicode (Windows)
INT GetAttachedFilesData(INT iAttachedFileIndex, LPSTR &lpAttachedFilesData, INT &lenAttachedFilesData);

int secureblackbox_pdfverifier_getattachedfilesdata(void* lpObj, int attachedfileindex, char** lpAttachedFilesData, int* lenAttachedFilesData);

QByteArray GetAttachedFilesData(int iAttachedFileIndex);

Remarks

The content of the attachment.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

Byte Array

AttachedFilesDescription Property (PDFVerifier Class)

Textual description of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesDescription(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesDescription(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilesdescription(void* lpObj, int attachedfileindex);

QString GetAttachedFilesDescription(int iAttachedFileIndex);

Default Value

""

Remarks

Textual description of the attachment.

This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesFilename Property (PDFVerifier Class)

Specifies the name of the attachment file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesFilename(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesFilename(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilesfilename(void* lpObj, int attachedfileindex);

QString GetAttachedFilesFilename(int iAttachedFileIndex);

Default Value

""

Remarks

Specifies the name of the attachment file.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesHandle Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetAttachedFilesHandle(int iAttachedFileIndex);

Unicode (Windows)
LONG64 GetAttachedFilesHandle(INT iAttachedFileIndex);

int64 secureblackbox_pdfverifier_getattachedfileshandle(void* lpObj, int attachedfileindex);

qint64 GetAttachedFilesHandle(int iAttachedFileIndex);

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 AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

Long64

AttachedFilesID Property (PDFVerifier Class)

Contains the attachment's unique identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesID(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesID(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilesid(void* lpObj, int attachedfileindex);

QString GetAttachedFilesID(int iAttachedFileIndex);

Default Value

""

Remarks

Contains the attachment's unique identifier.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesModificationDate Property (PDFVerifier Class)

Specifies the date and time of the file's last modification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesModificationDate(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesModificationDate(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilesmodificationdate(void* lpObj, int attachedfileindex);

QString GetAttachedFilesModificationDate(int iAttachedFileIndex);

Default Value

""

Remarks

Specifies the date and time of the file's last modification.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesReadDate Property (PDFVerifier Class)

Specifies the file's last read date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFilesReadDate(int iAttachedFileIndex);

Unicode (Windows)
LPWSTR GetAttachedFilesReadDate(INT iAttachedFileIndex);

char* secureblackbox_pdfverifier_getattachedfilesreaddate(void* lpObj, int attachedfileindex);

QString GetAttachedFilesReadDate(int iAttachedFileIndex);

Default Value

""

Remarks

Specifies the file's last read date.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

String

AttachedFilesSize Property (PDFVerifier Class)

Attachment's size in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetAttachedFilesSize(int iAttachedFileIndex);

Unicode (Windows)
LONG64 GetAttachedFilesSize(INT iAttachedFileIndex);

int64 secureblackbox_pdfverifier_getattachedfilessize(void* lpObj, int attachedfileindex);

qint64 GetAttachedFilesSize(int iAttachedFileIndex);

Default Value

0

Remarks

Attachment's size in bytes.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

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

Data Type

Long64

AutoValidateSignatures Property (PDFVerifier Class)

Specifies whether PDFVerifier should validate any present signatures when the document is opened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAutoValidateSignatures();
int SetAutoValidateSignatures(int bAutoValidateSignatures);

Unicode (Windows)
BOOL GetAutoValidateSignatures();
INT SetAutoValidateSignatures(BOOL bAutoValidateSignatures);

int secureblackbox_pdfverifier_getautovalidatesignatures(void* lpObj);
int secureblackbox_pdfverifier_setautovalidatesignatures(void* lpObj, int bAutoValidateSignatures);

bool GetAutoValidateSignatures();
int SetAutoValidateSignatures(bool bAutoValidateSignatures);

Default Value

TRUE

Remarks

This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.

Data Type

Boolean

BlockedCertCount Property (PDFVerifier 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_pdfverifier_getblockedcertcount(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_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 (PDFVerifier 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_pdfverifier_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_pdfverifier_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

CertCount Property (PDFVerifier Class)

The number of records in the Cert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCount();

Unicode (Windows)
INT GetCertCount();

int secureblackbox_pdfverifier_getcertcount(void* lpObj);

int GetCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertCA
• CertCAKeyID
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertPolicyIDs
• CertPublicKeyBytes
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSubject
• CertSubjectKeyID
• CertSubjectRDN
• CertValidFrom
• CertValidTo

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

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

Data Type

Integer

CertBytes Property (PDFVerifier Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_pdfverifier_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);

QByteArray GetCertBytes(int iCertIndex);

Remarks

Returns raw certificate data in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertCA Property (PDFVerifier Class)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCA(int iCertIndex);

Unicode (Windows)
BOOL GetCertCA(INT iCertIndex);

int secureblackbox_pdfverifier_getcertca(void* lpObj, int certindex);

bool GetCertCA(int iCertIndex);

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertCAKeyID Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCAKeyID(int iCertIndex, char* &lpCertCAKeyID, int &lenCertCAKeyID);

Unicode (Windows)
INT GetCertCAKeyID(INT iCertIndex, LPSTR &lpCertCAKeyID, INT &lenCertCAKeyID);

int secureblackbox_pdfverifier_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);

QByteArray GetCertCAKeyID(int iCertIndex);

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertCRLDistributionPoints Property (PDFVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertCRLDistributionPoints(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertCRLDistributionPoints(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertcrldistributionpoints(void* lpObj, int certindex);

QString GetCertCRLDistributionPoints(int iCertIndex);

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertCurve Property (PDFVerifier Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertCurve(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertCurve(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertcurve(void* lpObj, int certindex);

QString GetCertCurve(int iCertIndex);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertFingerprint Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertFingerprint(int iCertIndex, char* &lpCertFingerprint, int &lenCertFingerprint);

Unicode (Windows)
INT GetCertFingerprint(INT iCertIndex, LPSTR &lpCertFingerprint, INT &lenCertFingerprint);

int secureblackbox_pdfverifier_getcertfingerprint(void* lpObj, int certindex, char** lpCertFingerprint, int* lenCertFingerprint);

QByteArray GetCertFingerprint(int iCertIndex);

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertFriendlyName Property (PDFVerifier Class)

Contains an associated alias (friendly name) of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertFriendlyName(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertFriendlyName(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertfriendlyname(void* lpObj, int certindex);

QString GetCertFriendlyName(int iCertIndex);

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertHandle Property (PDFVerifier 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 iCertIndex);

Unicode (Windows)
LONG64 GetCertHandle(INT iCertIndex);

int64 secureblackbox_pdfverifier_getcerthandle(void* lpObj, int certindex);

qint64 GetCertHandle(int iCertIndex);

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Long64

CertHashAlgorithm Property (PDFVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertHashAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertHashAlgorithm(INT iCertIndex);

char* secureblackbox_pdfverifier_getcerthashalgorithm(void* lpObj, int certindex);

QString GetCertHashAlgorithm(int iCertIndex);

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertIssuer Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertIssuer(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertIssuer(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertissuer(void* lpObj, int certindex);

QString GetCertIssuer(int iCertIndex);

Default Value

""

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertIssuerRDN Property (PDFVerifier 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* GetCertIssuerRDN(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertIssuerRDN(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertissuerrdn(void* lpObj, int certindex);

QString GetCertIssuerRDN(int iCertIndex);

Default Value

""

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertKeyAlgorithm Property (PDFVerifier Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertKeyAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertKeyAlgorithm(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertkeyalgorithm(void* lpObj, int certindex);

QString GetCertKeyAlgorithm(int iCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertKeyBits Property (PDFVerifier Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyBits(int iCertIndex);

Unicode (Windows)
INT GetCertKeyBits(INT iCertIndex);

int secureblackbox_pdfverifier_getcertkeybits(void* lpObj, int certindex);

int GetCertKeyBits(int iCertIndex);

Default Value

0

Remarks

Returns the length of the public key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Integer

CertKeyFingerprint Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyFingerprint(int iCertIndex, char* &lpCertKeyFingerprint, int &lenCertKeyFingerprint);

Unicode (Windows)
INT GetCertKeyFingerprint(INT iCertIndex, LPSTR &lpCertKeyFingerprint, INT &lenCertKeyFingerprint);

int secureblackbox_pdfverifier_getcertkeyfingerprint(void* lpObj, int certindex, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);

QByteArray GetCertKeyFingerprint(int iCertIndex);

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertKeyUsage Property (PDFVerifier 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 GetCertKeyUsage(int iCertIndex);

Unicode (Windows)
INT GetCertKeyUsage(INT iCertIndex);

int secureblackbox_pdfverifier_getcertkeyusage(void* lpObj, int certindex);

int GetCertKeyUsage(int iCertIndex);

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Integer

CertKeyValid Property (PDFVerifier Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyValid(int iCertIndex);

Unicode (Windows)
BOOL GetCertKeyValid(INT iCertIndex);

int secureblackbox_pdfverifier_getcertkeyvalid(void* lpObj, int certindex);

bool GetCertKeyValid(int iCertIndex);

Default Value

FALSE

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertOCSPLocations Property (PDFVerifier Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertOCSPLocations(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertOCSPLocations(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertocsplocations(void* lpObj, int certindex);

QString GetCertOCSPLocations(int iCertIndex);

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertPolicyIDs Property (PDFVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertPolicyIDs(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertPolicyIDs(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertpolicyids(void* lpObj, int certindex);

QString GetCertPolicyIDs(int iCertIndex);

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertPublicKeyBytes Property (PDFVerifier Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPublicKeyBytes(int iCertIndex, char* &lpCertPublicKeyBytes, int &lenCertPublicKeyBytes);

Unicode (Windows)
INT GetCertPublicKeyBytes(INT iCertIndex, LPSTR &lpCertPublicKeyBytes, INT &lenCertPublicKeyBytes);

int secureblackbox_pdfverifier_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);

QByteArray GetCertPublicKeyBytes(int iCertIndex);

Remarks

Contains the certificate's public key in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertSelfSigned Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSelfSigned(int iCertIndex);

Unicode (Windows)
BOOL GetCertSelfSigned(INT iCertIndex);

int secureblackbox_pdfverifier_getcertselfsigned(void* lpObj, int certindex);

bool GetCertSelfSigned(int iCertIndex);

Default Value

FALSE

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertSerialNumber Property (PDFVerifier Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSerialNumber(int iCertIndex, char* &lpCertSerialNumber, int &lenCertSerialNumber);

Unicode (Windows)
INT GetCertSerialNumber(INT iCertIndex, LPSTR &lpCertSerialNumber, INT &lenCertSerialNumber);

int secureblackbox_pdfverifier_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);

QByteArray GetCertSerialNumber(int iCertIndex);

Remarks

Returns the certificate's serial number.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertSigAlgorithm Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSigAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSigAlgorithm(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertsigalgorithm(void* lpObj, int certindex);

QString GetCertSigAlgorithm(int iCertIndex);

Default Value

""

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertSubject Property (PDFVerifier 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* GetCertSubject(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSubject(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertsubject(void* lpObj, int certindex);

QString GetCertSubject(int iCertIndex);

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertSubjectKeyID Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSubjectKeyID(int iCertIndex, char* &lpCertSubjectKeyID, int &lenCertSubjectKeyID);

Unicode (Windows)
INT GetCertSubjectKeyID(INT iCertIndex, LPSTR &lpCertSubjectKeyID, INT &lenCertSubjectKeyID);

int secureblackbox_pdfverifier_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);

QByteArray GetCertSubjectKeyID(int iCertIndex);

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertSubjectRDN Property (PDFVerifier 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* GetCertSubjectRDN(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSubjectRDN(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertsubjectrdn(void* lpObj, int certindex);

QString GetCertSubjectRDN(int iCertIndex);

Default Value

""

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertValidFrom Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertValidFrom(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertValidFrom(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertvalidfrom(void* lpObj, int certindex);

QString GetCertValidFrom(int iCertIndex);

Default Value

""

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertValidTo Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertValidTo(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertValidTo(INT iCertIndex);

char* secureblackbox_pdfverifier_getcertvalidto(void* lpObj, int certindex);

QString GetCertValidTo(int iCertIndex);

Default Value

""

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CRLCount Property (PDFVerifier Class)

The number of records in the CRL arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLCount();

Unicode (Windows)
INT GetCRLCount();

int secureblackbox_pdfverifier_getcrlcount(void* lpObj);

int GetCRLCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• CRLBytes
• CRLHandle
• CRLIssuer
• CRLIssuerRDN
• CRLLocation
• CRLNextUpdate
• CRLThisUpdate

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

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

Data Type

Integer

CRLBytes Property (PDFVerifier Class)

Returns raw CRL data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLBytes(int iCRLIndex, char* &lpCRLBytes, int &lenCRLBytes);

Unicode (Windows)
INT GetCRLBytes(INT iCRLIndex, LPSTR &lpCRLBytes, INT &lenCRLBytes);

int secureblackbox_pdfverifier_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);

QByteArray GetCRLBytes(int iCRLIndex);

Remarks

Returns raw CRL data in DER format.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

Byte Array

CRLHandle Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCRLHandle(int iCRLIndex);

Unicode (Windows)
LONG64 GetCRLHandle(INT iCRLIndex);

int64 secureblackbox_pdfverifier_getcrlhandle(void* lpObj, int crlindex);

qint64 GetCRLHandle(int iCRLIndex);

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 CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

Long64

CRLIssuer Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLIssuer(int iCRLIndex);

Unicode (Windows)
LPWSTR GetCRLIssuer(INT iCRLIndex);

char* secureblackbox_pdfverifier_getcrlissuer(void* lpObj, int crlindex);

QString GetCRLIssuer(int iCRLIndex);

Default Value

""

Remarks

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

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

String

CRLIssuerRDN Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLIssuerRDN(int iCRLIndex);

Unicode (Windows)
LPWSTR GetCRLIssuerRDN(INT iCRLIndex);

char* secureblackbox_pdfverifier_getcrlissuerrdn(void* lpObj, int crlindex);

QString GetCRLIssuerRDN(int iCRLIndex);

Default Value

""

Remarks

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

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

String

CRLLocation Property (PDFVerifier Class)

The URL that the CRL was downloaded from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLLocation(int iCRLIndex);

Unicode (Windows)
LPWSTR GetCRLLocation(INT iCRLIndex);

char* secureblackbox_pdfverifier_getcrllocation(void* lpObj, int crlindex);

QString GetCRLLocation(int iCRLIndex);

Default Value

""

Remarks

The URL that the CRL was downloaded from.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

String

CRLNextUpdate Property (PDFVerifier Class)

The planned time and date of the next version of this CRL to be published.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLNextUpdate(int iCRLIndex);

Unicode (Windows)
LPWSTR GetCRLNextUpdate(INT iCRLIndex);

char* secureblackbox_pdfverifier_getcrlnextupdate(void* lpObj, int crlindex);

QString GetCRLNextUpdate(int iCRLIndex);

Default Value

""

Remarks

The planned time and date of the next version of this CRL to be published.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

String

CRLThisUpdate Property (PDFVerifier Class)

The date and time at which this version of the CRL was published.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLThisUpdate(int iCRLIndex);

Unicode (Windows)
LPWSTR GetCRLThisUpdate(INT iCRLIndex);

char* secureblackbox_pdfverifier_getcrlthisupdate(void* lpObj, int crlindex);

QString GetCRLThisUpdate(int iCRLIndex);

Default Value

""

Remarks

The date and time at which this version of the CRL was published.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

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

Data Type

String

DecryptionCertificateBytes Property (PDFVerifier Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertificateBytes(char* &lpDecryptionCertificateBytes, int &lenDecryptionCertificateBytes);

Unicode (Windows)
INT GetDecryptionCertificateBytes(LPSTR &lpDecryptionCertificateBytes, INT &lenDecryptionCertificateBytes);

int secureblackbox_pdfverifier_getdecryptioncertificatebytes(void* lpObj, char** lpDecryptionCertificateBytes, int* lenDecryptionCertificateBytes);

QByteArray GetDecryptionCertificateBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

DecryptionCertificateHandle Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(int64 lDecryptionCertificateHandle);

Unicode (Windows)
LONG64 GetDecryptionCertificateHandle();
INT SetDecryptionCertificateHandle(LONG64 lDecryptionCertificateHandle);

int64 secureblackbox_pdfverifier_getdecryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfverifier_setdecryptioncertificatehandle(void* lpObj, int64 lDecryptionCertificateHandle);

qint64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(qint64 lDecryptionCertificateHandle);

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

DocumentInfoEncryptionAlgorithm Property (PDFVerifier Class)

The symmetric algorithm used to encrypt the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetDocumentInfoEncryptionAlgorithm();

char* secureblackbox_pdfverifier_getdocumentinfoencryptionalgorithm(void* lpObj);

QString GetDocumentInfoEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric algorithm used to encrypt the document.

This property contains the encryption algorithm that was used to encrypt the PDF document.

Supported values:

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

Data Type

String

DocumentInfoEncryptionType Property (PDFVerifier Class)

The document encryption type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoEncryptionType();

Unicode (Windows)
INT GetDocumentInfoEncryptionType();

PET_NONE(0), 
PET_PASSWORD(1), 
PET_CERTIFICATE(2)

int secureblackbox_pdfverifier_getdocumentinfoencryptiontype(void* lpObj);

int GetDocumentInfoEncryptionType();

Default Value

1

Remarks

The document encryption type.

This property indicates the kind of encryption that was used to encrypt the PDF document.

Supported values:

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

Data Type

Integer

DocumentInfoMetadataEncrypted Property (PDFVerifier Class)

Indicates if the document metadata is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoMetadataEncrypted();

Unicode (Windows)
BOOL GetDocumentInfoMetadataEncrypted();

int secureblackbox_pdfverifier_getdocumentinfometadataencrypted(void* lpObj);

bool GetDocumentInfoMetadataEncrypted();

Default Value

TRUE

Remarks

Indicates if the document metadata is encrypted.

Use this property to check if document metadata is encrypted.

Metadata contains additional information about document such as its name and author.

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

Data Type

Boolean

DocumentInfoPermissions Property (PDFVerifier Class)

Contains the document permissions associated with the encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoPermissions();

Unicode (Windows)
INT GetDocumentInfoPermissions();

int secureblackbox_pdfverifier_getdocumentinfopermissions(void* lpObj);

int GetDocumentInfoPermissions();

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

Use this property to check permissions protected by this encryption. PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:

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

Data Type

Integer

FIPSMode Property (PDFVerifier 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_pdfverifier_getfipsmode(void* lpObj);
int secureblackbox_pdfverifier_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

IgnoreChainValidationErrors Property (PDFVerifier 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_pdfverifier_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier Class)

Use this property to pass the input to class in the 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_pdfverifier_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pdfverifier_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 (PDFVerifier Class)

A path to the signed PDF file.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_pdfverifier_getinputfile(void* lpObj);
int secureblackbox_pdfverifier_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

Assign the path to the PDF file to be verified to this property.

Data Type

String

KnownCertCount Property (PDFVerifier 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_pdfverifier_getknowncertcount(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_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 (PDFVerifier 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_pdfverifier_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getknowncrlcount(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_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 (PDFVerifier 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_pdfverifier_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getknownocspcount(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_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 (PDFVerifier 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_pdfverifier_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_pdfverifier_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

OCSPCount Property (PDFVerifier Class)

The number of records in the OCSP arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOCSPCount();

Unicode (Windows)
INT GetOCSPCount();

int secureblackbox_pdfverifier_getocspcount(void* lpObj);

int GetOCSPCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• OCSPBytes
• OCSPHandle
• OCSPIssuer
• OCSPIssuerRDN
• OCSPLocation
• OCSPProducedAt

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

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

Data Type

Integer

OCSPBytes Property (PDFVerifier Class)

Buffer containing raw OCSP response data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOCSPBytes(int iOCSPIndex, char* &lpOCSPBytes, int &lenOCSPBytes);

Unicode (Windows)
INT GetOCSPBytes(INT iOCSPIndex, LPSTR &lpOCSPBytes, INT &lenOCSPBytes);

int secureblackbox_pdfverifier_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);

QByteArray GetOCSPBytes(int iOCSPIndex);

Remarks

Buffer containing raw OCSP response data.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

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

Data Type

Byte Array

OCSPHandle Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetOCSPHandle(int iOCSPIndex);

Unicode (Windows)
LONG64 GetOCSPHandle(INT iOCSPIndex);

int64 secureblackbox_pdfverifier_getocsphandle(void* lpObj, int ocspindex);

qint64 GetOCSPHandle(int iOCSPIndex);

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 OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

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

Data Type

Long64

OCSPIssuer Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPIssuer(int iOCSPIndex);

Unicode (Windows)
LPWSTR GetOCSPIssuer(INT iOCSPIndex);

char* secureblackbox_pdfverifier_getocspissuer(void* lpObj, int ocspindex);

QString GetOCSPIssuer(int iOCSPIndex);

Default Value

""

Remarks

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

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

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

Data Type

String

OCSPIssuerRDN Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPIssuerRDN(int iOCSPIndex);

Unicode (Windows)
LPWSTR GetOCSPIssuerRDN(INT iOCSPIndex);

char* secureblackbox_pdfverifier_getocspissuerrdn(void* lpObj, int ocspindex);

QString GetOCSPIssuerRDN(int iOCSPIndex);

Default Value

""

Remarks

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

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

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

Data Type

String

OCSPLocation Property (PDFVerifier Class)

Location of the OCSP responder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPLocation(int iOCSPIndex);

Unicode (Windows)
LPWSTR GetOCSPLocation(INT iOCSPIndex);

char* secureblackbox_pdfverifier_getocsplocation(void* lpObj, int ocspindex);

QString GetOCSPLocation(int iOCSPIndex);

Default Value

""

Remarks

Location of the OCSP responder.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

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

Data Type

String

OCSPProducedAt Property (PDFVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOCSPProducedAt(int iOCSPIndex);

Unicode (Windows)
LPWSTR GetOCSPProducedAt(INT iOCSPIndex);

char* secureblackbox_pdfverifier_getocspproducedat(void* lpObj, int ocspindex);

QString GetOCSPProducedAt(int iOCSPIndex);

Default Value

""

Remarks

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

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

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

Data Type

String

OfflineMode Property (PDFVerifier Class)

Switches the class to the 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_pdfverifier_getofflinemode(void* lpObj);
int secureblackbox_pdfverifier_setofflinemode(void* lpObj, int bOfflineMode);

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

Default Value

FALSE

Remarks

When working in offline mode, the component 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 validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

OutputBytes Property (PDFVerifier 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_pdfverifier_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if 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 (PDFVerifier Class)

The file to save the signed or updated document 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_pdfverifier_getoutputfile(void* lpObj);
int secureblackbox_pdfverifier_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

Use this property to provide a path where the resulting PDF document should be saved to.

Data Type

String

PageCount Property (PDFVerifier Class)

The number of records in the Page arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageCount();

Unicode (Windows)
INT GetPageCount();

int secureblackbox_pdfverifier_getpagecount(void* lpObj);

int GetPageCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PageCropLLX
• PageCropLLY
• PageCropURX
• PageCropURY
• PageHeight
• PageMediaLLX
• PageMediaLLY
• PageMediaURX
• PageMediaURY
• PageRotate
• PageWidth

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

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

Data Type

Integer

PageCropLLX Property (PDFVerifier Class)

Specifies the lower-left X coordinate of the page crop area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageCropLLX(int iPageIndex);

Unicode (Windows)
INT GetPageCropLLX(INT iPageIndex);

int secureblackbox_pdfverifier_getpagecropllx(void* lpObj, int pageindex);

int GetPageCropLLX(int iPageIndex);

Default Value

0

Remarks

Specifies the lower-left X coordinate of the page crop area.

Specifies the lower-left X coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageCropLLY Property (PDFVerifier Class)

Specifies the lower-left Y coordinate of the page crop area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageCropLLY(int iPageIndex);

Unicode (Windows)
INT GetPageCropLLY(INT iPageIndex);

int secureblackbox_pdfverifier_getpagecroplly(void* lpObj, int pageindex);

int GetPageCropLLY(int iPageIndex);

Default Value

0

Remarks

Specifies the lower-left Y coordinate of the page crop area.

Specifies the lower-left Y coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageCropURX Property (PDFVerifier Class)

Specifies the upper-right X coordinate of the page crop area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageCropURX(int iPageIndex);

Unicode (Windows)
INT GetPageCropURX(INT iPageIndex);

int secureblackbox_pdfverifier_getpagecropurx(void* lpObj, int pageindex);

int GetPageCropURX(int iPageIndex);

Default Value

0

Remarks

Specifies the upper-right X coordinate of the page crop area.

Specifies the upper-right X coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageCropURY Property (PDFVerifier Class)

Specifies the upper-right Y coordinate of the page crop area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageCropURY(int iPageIndex);

Unicode (Windows)
INT GetPageCropURY(INT iPageIndex);

int secureblackbox_pdfverifier_getpagecropury(void* lpObj, int pageindex);

int GetPageCropURY(int iPageIndex);

Default Value

0

Remarks

Specifies the upper-right Y coordinate of the page crop area.

Specifies the upper-right Y coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageHeight Property (PDFVerifier Class)

Specifies the height of the page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageHeight(int iPageIndex);

Unicode (Windows)
INT GetPageHeight(INT iPageIndex);

int secureblackbox_pdfverifier_getpageheight(void* lpObj, int pageindex);

int GetPageHeight(int iPageIndex);

Default Value

0

Remarks

Specifies the height of the page.

Returns the height of the page.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageMediaLLX Property (PDFVerifier Class)

Specifies the lower-left X coordinate of the page media area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageMediaLLX(int iPageIndex);

Unicode (Windows)
INT GetPageMediaLLX(INT iPageIndex);

int secureblackbox_pdfverifier_getpagemediallx(void* lpObj, int pageindex);

int GetPageMediaLLX(int iPageIndex);

Default Value

0

Remarks

Specifies the lower-left X coordinate of the page media area.

Specifies the lower-left X coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageMediaLLY Property (PDFVerifier Class)

Specifies the lower-left Y coordinate of the page media area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageMediaLLY(int iPageIndex);

Unicode (Windows)
INT GetPageMediaLLY(INT iPageIndex);

int secureblackbox_pdfverifier_getpagemedially(void* lpObj, int pageindex);

int GetPageMediaLLY(int iPageIndex);

Default Value

0

Remarks

Specifies the lower-left Y coordinate of the page media area.

Specifies the lower-left Y coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageMediaURX Property (PDFVerifier Class)

Specifies the upper-right X coordinate of the page media area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageMediaURX(int iPageIndex);

Unicode (Windows)
INT GetPageMediaURX(INT iPageIndex);

int secureblackbox_pdfverifier_getpagemediaurx(void* lpObj, int pageindex);

int GetPageMediaURX(int iPageIndex);

Default Value

0

Remarks

Specifies the upper-right X coordinate of the page media area.

Specifies the upper-right X coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageMediaURY Property (PDFVerifier Class)

Specifies the upper-right Y coordinate of the page media area.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageMediaURY(int iPageIndex);

Unicode (Windows)
INT GetPageMediaURY(INT iPageIndex);

int secureblackbox_pdfverifier_getpagemediaury(void* lpObj, int pageindex);

int GetPageMediaURY(int iPageIndex);

Default Value

0

Remarks

Specifies the upper-right Y coordinate of the page media area.

Specifies the upper-right Y coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageRotate Property (PDFVerifier Class)

Specifies the rotation angle of the page in degrees.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageRotate(int iPageIndex);

Unicode (Windows)
INT GetPageRotate(INT iPageIndex);

int secureblackbox_pdfverifier_getpagerotate(void* lpObj, int pageindex);

int GetPageRotate(int iPageIndex);

Default Value

0

Remarks

Specifies the rotation angle of the page in degrees. Values of 0, 90, 180, and 270 are allowed.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

PageWidth Property (PDFVerifier Class)

Specifies the width of the page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPageWidth(int iPageIndex);

Unicode (Windows)
INT GetPageWidth(INT iPageIndex);

int secureblackbox_pdfverifier_getpagewidth(void* lpObj, int pageindex);

int GetPageWidth(int iPageIndex);

Default Value

0

Remarks

Specifies the width of the page.

Returns the width of the page.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

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

Data Type

Integer

Password Property (PDFVerifier Class)

The decryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* secureblackbox_pdfverifier_getpassword(void* lpObj);
int secureblackbox_pdfverifier_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

Use this property to provide the decryption password.

Data Type

String

Profile Property (PDFVerifier 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_pdfverifier_getprofile(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyaddress(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyauthentication(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxypassword(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyport(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyproxytype(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyrequestheaders(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyresponsebody(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyresponseheaders(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyuseipv6(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyuseproxy(void* lpObj);
int secureblackbox_pdfverifier_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 (PDFVerifier 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_pdfverifier_getproxyusername(void* lpObj);
int secureblackbox_pdfverifier_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

RevocationCheck Property (PDFVerifier Class)

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

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_pdfverifier_getrevocationcheck(void* lpObj);
int secureblackbox_pdfverifier_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 (CRL) 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. 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.

Data Type

Integer

SignatureCount Property (PDFVerifier Class)

The number of records in the Signature arrays.

Syntax

• C++
• C
• Qt