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 verifier = new PDFVerifier(); // Set the signed PDF document that you want to verify verifier.setInputFile("signed.pdf"); verifier.verify(); // Verification information for (int idx = 0; idx < verifier.getSignatures().size(); idx++) { System.out.println("Signature " + (idx + 1)); System.out.println(" Timestamp: " + verifier.getSignatures().item(idx).getValidatedSigningTime()); System.out.print(" Validation Result: " + verifier.getSignatures().item(idx).getSignatureValidationResult() + ", "); switch (verifier.getSignatures().item(idx).getSignatureValidationResult()) { case svtValid: System.out.println("The signature is valid."); break; case svtUnknown: System.out.println("Signature validity is unknown."); break; case svtCorrupted: System.out.println("The signature is corrupted."); break; case svtSignerNotFound: System.out.println("Failed to acquire the signing certificate. The signature cannot be validated."); break; case svtFailure: System.out.println("General failure."); break; default: System.out.println("Signature validity is unknown."); break; } }

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 around, 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 the InputBytes property), and call the 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, the SignatureValidated event is fired, and the validation results are separately provided via the SignatureValidationResult and ChainValidationResult fields of the associated signature object. Other information about the signature can be accessed via the Signatures property.

The 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 these specifics of the PDF format, it is crucially important to understand which part of the document is covered by a specific signature. Use the CoverageEndsAt field 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 class:

  • 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 the 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), the Encrypted 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.

AllSignaturesValidThe cumulative validity of all signatures.
AttachedFilesProvides details of all attached files found in the PDF document.
AutoValidateSignaturesSpecifies whether PDFVerifier should validate any present signatures when the document is opened.
BlockedCertificatesThe certificates that must be rejected as trust anchors.
CertificatesA collection of certificates included in the electronic signature.
CheckTrustedListsSpecifies whether the class should attempt to validate chain trust via a known Trusted List.
CRLsA collection of certificate revocation lists embedded into the signature by the signer.
DecryptionCertificateA decryption certificate.
DocumentInfoContains information about the document properties.
FIPSModeReserved.
IgnoreChainValidationErrorsMakes the class tolerant to chain validation errors.
InputBytesUse this property to pass the input to class in byte array form.
InputFileA path to the signed PDF file.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
OCSPsA collection of OCSP responses embedded into the signature.
OfflineModeSwitches the class to offline mode.
OutputBytesUse this property to read the output the class object has produced.
OutputFileThe file to save the signed or updated document to.
PagesA list of pages contained in the document.
PasswordThe decryption password.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
ProxyThe proxy server settings.
RevocationCheckSpecifies the kind(s) of revocation check to perform for all chain certificates.
SignaturesProvides details of all signatures found in the PDF document.
SocketSettingsManages network connection settings.
TimestampsContains a collection of timestamps for the processed document.
TLSClientChainThe TLS client certificate chain.
TLSServerChainThe TLS server's certificate chain.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
ValidationMomentThe time point at which signature validity is to be established.

Method List


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

CloseCloses an opened document.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
GetAttachedBytesSaves a PDF attachment to a byte array.
GetAttachedFileSaves a PDF attachment to a file.
GetAttachedStreamSaves a PDF attachment to a stream.
GetSignedVersionReturns the part of the document that is covered by the signature.
OpenOpens a document for verifying or removing signatures.
ResetResets the class settings.
RevalidateRevalidates a signature in accordance with current settings.
SelectInfoSelect signature information for a specific entity.
UnsignDeletes a signature from the document.
VerifyVerifies a signed PDF document.

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.

ChainElementDownloadFires when there is a need to download a chain element from an online source.
ChainElementNeededFires when an element required to validate the chain was not located.
ChainValidatedReports the completion of a certificate chain validation.
ChainValidationProgressThis event is fired multiple times during chain validation to report various stages of the validation procedure.
DocumentLoadedThis event is fired when the document has been loaded into memory.
EncryptedNotifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.
ErrorInformation about errors during signing/validation.
NotificationThis event notifies the application about an underlying control flow event.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedMarks the completion of the signature validation routine.
TimestampFoundSignifies the start of a timestamp validation routine.
TimestampValidatedReports the completion of the timestamp validation routine.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSShutdownReports the graceful closure of a TLS connection.

Config Settings


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

AlternateNameTBD.
AsyncDocumentIDSpecifies the document ID for SignAsyncEnd() call.
BuildApplicationNameSpecifies the application name used to create the signature.
BuildApplicationVersionSpecifies the application version used to create the signature.
BuildPropertiesSpecifies the build properties of the signature.
CachedCRLOverlapTimeSpecifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.
CachedOCSPResponseOverlapTimeSpecifies the time period before a cached OCSP Response's NextUpdate when it is considered stale and must be refreshed.
ChainCurrentCACertReturns the current CA certificate.
ChainCurrentCertReturns the certificate that is currently being validated.
ChainCurrentCRLReturns the current CRL.
ChainCurrentCRLSizeReturns the size of the current CRL.
ChainCurrentOCSPReturns the current OCSP response.
ChainCurrentOCSPSignerReturns the signer of the current OCSP object.
ChainInterimDetailsReturns the current interim validation details.
ChainInterimResultReturns the current interim validation result.
CheckValidityPeriodForTrustedWhether to check validity period for trusted certificates.
ConfigPreferLegacyLevelsIndicates whether legacy signature levels should be preferred.
CustomSignedAttributesTBD.
CustomTrustedListsSpecifies the custom TrustedLists.
CustomTSLsSpecifies the custom TrustedLists.
CustomUnsignedAttributesTBD.
DislikeOpenEndedOCSPsTells the class to discourage OCSP responses without an explicit NextUpdate parameter.
DocumentVersionThe document version from the PDF document header.
DTSAccuracyTBD.
DTSSerialNumberTBD.
DTSTimeTBD.
DTSTSANameTBD.
EmptySignatureFieldAddRevInfo[Index]Specifies if revocation checking should be performed.
EmptySignatureFieldAlternateName[Index]Contains an alternate field name.
EmptySignatureFieldCountThe number of empty signature form fields.
EmptySignatureFieldFlags[Index]The field flags of the signature form field.
EmptySignatureFieldHeight[Index]The Height of the empty signature form field.
EmptySignatureFieldInvisible[Index]The visibility status of the field.
EmptySignatureFieldLegalAttestations[Index]Specifies the legal attestations that are associated with the signature.
EmptySignatureFieldMappingName[Index]The mapping name to be used when exporting form field data from the document.
EmptySignatureFieldName[Index]Textual field name.
EmptySignatureFieldOffsetX[Index]The field's offset from the left page border.
EmptySignatureFieldOffsetY[Index]The field's offset from the bottom page border.
EmptySignatureFieldPage[Index]The index of the form field's page in the document.
EmptySignatureFieldRequiredAllowedChanges[Index]Specifies the changes allowed by the signature.
EmptySignatureFieldRequiredConstraints[Index]Specifies the required Seed Value Dictionary (SVD) constraints.
EmptySignatureFieldRequiredDigestAlgorithms[Index]Specifies the required digest algorithms.
EmptySignatureFieldRequiredFilter[Index]Specifies the required filter.
EmptySignatureFieldRequiredLockAction[Index]Indicates which set of fields shall be locked.
EmptySignatureFieldRequiredLockFields[Index]Indicates the fields that shall be locked on signing.
EmptySignatureFieldRequiredReasons[Index]Specifies the required reasons.
EmptySignatureFieldRequiredSubfilters[Index]Specifies the required subfilters.
EmptySignatureFieldTimestampRequired[Index]Specifies if the signature should be timestamped.
EmptySignatureFieldTSPURL[Index]URL for a TSP server.
EmptySignatureFieldWidth[Index]The Width of the empty signature form field.
EnableOldSignaturesEnables support for prehistoric adbe.x509.sha1 signatures.
EncryptionHandlerNameSpecifies the custom security handler PDF-name.
ForceCompleteChainValidationWhether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrustedWhether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GracePeriodSpecifies a grace period to apply during revocation information checks.
HardenedKeyGenerationSpecifies if hardened Key generation should be used.
IgnoreChainLoopsWhether chain loops should be ignored.
IgnoreChainValidationErrorsWhether to ignore any certificate chain validation issues.
IgnoreOCSPNoCheckExtensionWhether the OCSP NoCheck extension should be ignored.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
IgnoreTimestampChainValidityForLevelDetectionSpecify whether timestamp chain validity should be ignored during signature level detection.
ImplicitlyTrustSelfSignedCertificatesWhether to trust self-signed certificates.
MappingNameTBD.
MDPHashAlgorithmSpecifies the MDP hash algorithm.
PageInfoCountThe number of pages.
PageInfoCropBoxEmpty[Index]Check if the page's crop box is empty or not.
PageInfoCropLLX[Index]Defines the X coordinate of the lower left corner of the crop box.
PageInfoCropLLY[Index]Defines the Y coordinate of the lower left corner of the crop box.
PageInfoCropURX[Index]Defines the X coordinate of the upper right corner of the crop box.
PageInfoCropURY[Index]Defines the Y coordinate of the upper right corner of the crop box.
PageInfoHeight[Index]The Height of the page.
PageInfoMediaLLX[Index]Defines the X coordinate of the lower left corner of the media box.
PageInfoMediaLLY[Index]Defines the Y coordinate of the lower left corner of the media box.
PageInfoMediaURX[Index]Defines the X coordinate of the upper right corner of the media box.
PageInfoMediaURY[Index]Defines the Y coordinate of the upper right corner of the media box.
PageInfoRotate[Index]The Rotate value of the page.
PageInfoUserUnit[Index]Defines the size of default user space units.
PageInfoWidth[Index]The Width of the page.
PolicyDescriptionsignature policy description.
PolicyExplicitTextThe explicit text of the user notice.
PolicyUNNumbersThe noticeNumbers part of the NoticeReference CAdES attribute.
PolicyUNOrganizationThe organization part of the NoticeReference qualifier.
ProductionPlaceIdentifies the place of the signature production.
PromoteLongOCSPResponsesWhether long OCSP responses are requested.
PSSUsedWhether to use RSASSA-PSS algorithm.
RC4KeyBitsSpecifies the number of key bits used for the RC4 algorithm.
ReassembleModeSpecifies the document reassemble mode.
SchemeParamsThe algorithm scheme parameters to employ.
SigPolicyDescriptionsignature policy description.
SigPolicyExplicitTextThe explicit text of the user notice.
SigPolicyHashThe EPES policy hash.
SigPolicyHashAlgorithmThe hash algorithm that was used to generate the EPES policy hash.
SigPolicyIDThe EPES policy ID.
SigPolicyNoticeNumbersThe noticeNumbers part of the NoticeReference CAdES attribute.
SigPolicyNoticeOrganizationThe organization part of the NoticeReference qualifier.
SigPolicyURIThe EPES policy URI.
TempPathPath for storing temporary files.
TimestampResponseA base16-encoded timestamp response received from a TSA.
TLSChainValidationDetailsContains the advanced details of the TLS server certificate validation.
TLSChainValidationResultContains the result of the TLS server certificate validation.
TLSClientAuthRequestedIndicates whether the TLS server requests client authentication.
TLSValidationLogContains the log of the TLS server certificate validation.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
TspAttemptCountSpecifies the number of timestamping request attempts.
TspHashAlgorithmSets a specific hash algorithm for use with the timestamping service.
TspReqPolicySets a request policy ID to include in the timestamping request.
UseDefaultTrustedListsEnables or disables the use of the default TrustedLists.
UseDefaultTSLsEnables or disables the use of the default TrustedLists.
UseMicrosoftCTLEnables or disables the automatic use of the Microsoft online certificate trust list.
UsePSSWhether to use RSASSA-PSS algorithm.
UseSystemCertificatesEnables or disables the use of the system certificates.
UseValidationCacheEnables or disable the use of the product-wide certificate chain validation cache.
UseValidatorSettingsForTLSValidationWhether to employ the primary chain validator setup for auxiliary TLS chain validations.
WidgetHeightSpecifies the height of the signature widget.
WidgetOffsetXSpecifies the signature widget offset from the left-hand page border.
WidgetOffsetYSpecifies the signature widget offset from the bottom page border.
WidgetWidthSpecifies the width of the signature widget.
XMPMetadataContentThe XMP metadata content.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

AllSignaturesValid Property (PDFVerifier Class)

The cumulative validity of all signatures.

Syntax

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

AttachedFiles Property (PDFVerifier Class)

Provides details of all attached files found in the PDF document.

Syntax

int secureblackbox_pdfverifier_getattachedfilecount(void* lpObj);
char* secureblackbox_pdfverifier_getattachedfilescontentsubtype(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfverifier_getattachedfilescontenttype(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfverifier_getattachedfilescreationdate(void* lpObj, int attachedfileindex);
int secureblackbox_pdfverifier_getattachedfilesdata(void* lpObj, int attachedfileindex, char** lpAttachedFilesData, int* lenAttachedFilesData);
char* secureblackbox_pdfverifier_getattachedfilesdescription(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfverifier_getattachedfilesfilename(void* lpObj, int attachedfileindex);
int64 secureblackbox_pdfverifier_getattachedfileshandle(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfverifier_getattachedfilesid(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfverifier_getattachedfilesmodificationdate(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfverifier_getattachedfilesreaddate(void* lpObj, int attachedfileindex);
int64 secureblackbox_pdfverifier_getattachedfilessize(void* lpObj, int attachedfileindex);
int GetAttachedFileCount();

QString GetAttachedFilesContentSubtype(int iAttachedFileIndex);

QString GetAttachedFilesContentType(int iAttachedFileIndex);

QString GetAttachedFilesCreationDate(int iAttachedFileIndex);

QByteArray GetAttachedFilesData(int iAttachedFileIndex);

QString GetAttachedFilesDescription(int iAttachedFileIndex);

QString GetAttachedFilesFileName(int iAttachedFileIndex);

qint64 GetAttachedFilesHandle(int iAttachedFileIndex);

QString GetAttachedFilesID(int iAttachedFileIndex);

QString GetAttachedFilesModificationDate(int iAttachedFileIndex);

QString GetAttachedFilesReadDate(int iAttachedFileIndex);

qint64 GetAttachedFilesSize(int iAttachedFileIndex);

Remarks

Use this property to get the details of all the attached files identified in the document.

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

Data Type

SecureBlackboxMailAttachment

AutoValidateSignatures Property (PDFVerifier Class)

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

Syntax

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

BlockedCertificates Property (PDFVerifier Class)

The certificates that must be rejected as trust anchors.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates();
int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfverifier_getblockedcertcount(void* lpObj);
int secureblackbox_pdfverifier_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_pdfverifier_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_pdfverifier_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_pdfverifier_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); QByteArray GetBlockedCertBytes(int iBlockedCertIndex); qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

Certificates Property (PDFVerifier Class)

A collection of certificates included in the electronic signature.

Syntax

int secureblackbox_pdfverifier_getcertcount(void* lpObj);
int secureblackbox_pdfverifier_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
int secureblackbox_pdfverifier_getcertca(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
int secureblackbox_pdfverifier_getcertcerttype(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertcrldistributionpoints(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertcurve(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertfingerprint(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertfriendlyname(void* lpObj, int certindex);
int64 secureblackbox_pdfverifier_getcerthandle(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcerthashalgorithm(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertissuer(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertissuerrdn(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertkeyalgorithm(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertkeybits(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertkeyfingerprint(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertkeyusage(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertkeyvalid(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertocsplocations(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertocspnocheck(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertorigin(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertpolicyids(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertprivatekeybytes(void* lpObj, int certindex, char** lpCertPrivateKeyBytes, int* lenCertPrivateKeyBytes);
int secureblackbox_pdfverifier_getcertprivatekeyexists(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertprivatekeyextractable(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
int secureblackbox_pdfverifier_getcertqualified(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertqualifiedstatements(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertqualifiers(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertselfsigned(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
char* secureblackbox_pdfverifier_getcertsigalgorithm(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertsource(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertsubject(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertsubjectalternativename(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
char* secureblackbox_pdfverifier_getcertsubjectrdn(void* lpObj, int certindex);
int secureblackbox_pdfverifier_getcertvalid(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertvalidfrom(void* lpObj, int certindex);
char* secureblackbox_pdfverifier_getcertvalidto(void* lpObj, int certindex);
int GetCertCount();

QByteArray GetCertBytes(int iCertIndex);

bool GetCertCA(int iCertIndex);

QByteArray GetCertCAKeyID(int iCertIndex);

int GetCertCertType(int iCertIndex);

QString GetCertCRLDistributionPoints(int iCertIndex);

QString GetCertCurve(int iCertIndex);

QString GetCertFingerprint(int iCertIndex);

QString GetCertFriendlyName(int iCertIndex);

qint64 GetCertHandle(int iCertIndex);

QString GetCertHashAlgorithm(int iCertIndex);

QString GetCertIssuer(int iCertIndex);

QString GetCertIssuerRDN(int iCertIndex);

QString GetCertKeyAlgorithm(int iCertIndex);

int GetCertKeyBits(int iCertIndex);

QString GetCertKeyFingerprint(int iCertIndex);

int GetCertKeyUsage(int iCertIndex);

bool GetCertKeyValid(int iCertIndex);

QString GetCertOCSPLocations(int iCertIndex);

bool GetCertOCSPNoCheck(int iCertIndex);

int GetCertOrigin(int iCertIndex);

QString GetCertPolicyIDs(int iCertIndex);

QByteArray GetCertPrivateKeyBytes(int iCertIndex);

bool GetCertPrivateKeyExists(int iCertIndex);

bool GetCertPrivateKeyExtractable(int iCertIndex);

QByteArray GetCertPublicKeyBytes(int iCertIndex);

bool GetCertQualified(int iCertIndex);

int GetCertQualifiedStatements(int iCertIndex);

QString GetCertQualifiers(int iCertIndex);

bool GetCertSelfSigned(int iCertIndex);

QByteArray GetCertSerialNumber(int iCertIndex);

QString GetCertSigAlgorithm(int iCertIndex);

int GetCertSource(int iCertIndex);

QString GetCertSubject(int iCertIndex);

QString GetCertSubjectAlternativeName(int iCertIndex);

QByteArray GetCertSubjectKeyID(int iCertIndex);

QString GetCertSubjectRDN(int iCertIndex);

bool GetCertValid(int iCertIndex);

QString GetCertValidFrom(int iCertIndex);

QString GetCertValidTo(int iCertIndex);

Remarks

This property includes a collection of certificates of the currently selected info.

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

Data Type

SecureBlackboxCertificate

CheckTrustedLists Property (PDFVerifier Class)

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

Syntax

ANSI (Cross Platform)
int GetCheckTrustedLists();
int SetCheckTrustedLists(int bCheckTrustedLists); Unicode (Windows) BOOL GetCheckTrustedLists();
INT SetCheckTrustedLists(BOOL bCheckTrustedLists);
int secureblackbox_pdfverifier_getchecktrustedlists(void* lpObj);
int secureblackbox_pdfverifier_setchecktrustedlists(void* lpObj, int bCheckTrustedLists);
bool GetCheckTrustedLists();
int SetCheckTrustedLists(bool bCheckTrustedLists);

Default Value

FALSE

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

Data Type

Boolean

CRLs Property (PDFVerifier Class)

A collection of certificate revocation lists embedded into the signature by the signer.

Syntax

int secureblackbox_pdfverifier_getcrlcount(void* lpObj);
int secureblackbox_pdfverifier_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);
int secureblackbox_pdfverifier_getcrlcakeyid(void* lpObj, int crlindex, char** lpCRLCAKeyID, int* lenCRLCAKeyID);
int secureblackbox_pdfverifier_getcrlentrycount(void* lpObj, int crlindex);
int64 secureblackbox_pdfverifier_getcrlhandle(void* lpObj, int crlindex);
char* secureblackbox_pdfverifier_getcrlissuer(void* lpObj, int crlindex);
char* secureblackbox_pdfverifier_getcrlissuerrdn(void* lpObj, int crlindex);
char* secureblackbox_pdfverifier_getcrllocation(void* lpObj, int crlindex);
char* secureblackbox_pdfverifier_getcrlnextupdate(void* lpObj, int crlindex);
char* secureblackbox_pdfverifier_getcrlsigalgorithm(void* lpObj, int crlindex);
int secureblackbox_pdfverifier_getcrlsource(void* lpObj, int crlindex);
int secureblackbox_pdfverifier_getcrltbs(void* lpObj, int crlindex, char** lpCRLTBS, int* lenCRLTBS);
char* secureblackbox_pdfverifier_getcrlthisupdate(void* lpObj, int crlindex);
int GetCRLCount();

QByteArray GetCRLBytes(int iCRLIndex);

QByteArray GetCRLCAKeyID(int iCRLIndex);

int GetCRLEntryCount(int iCRLIndex);

qint64 GetCRLHandle(int iCRLIndex);

QString GetCRLIssuer(int iCRLIndex);

QString GetCRLIssuerRDN(int iCRLIndex);

QString GetCRLLocation(int iCRLIndex);

QString GetCRLNextUpdate(int iCRLIndex);

QString GetCRLSigAlgorithm(int iCRLIndex);

int GetCRLSource(int iCRLIndex);

QByteArray GetCRLTBS(int iCRLIndex);

QString GetCRLThisUpdate(int iCRLIndex);

Remarks

Use this property to access the CRLs embedded into the signature by the signer.

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

Data Type

SecureBlackboxCRL

DecryptionCertificate Property (PDFVerifier Class)

A decryption certificate.

Syntax

SecureBlackboxCertificate* GetDecryptionCertificate();
int SetDecryptionCertificate(SecureBlackboxCertificate* val);
int secureblackbox_pdfverifier_getdecryptioncertificatebytes(void* lpObj, char** lpDecryptionCertificateBytes, int* lenDecryptionCertificateBytes);
int64 secureblackbox_pdfverifier_getdecryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfverifier_setdecryptioncertificatehandle(void* lpObj, int64 lDecryptionCertificateHandle);
QByteArray GetDecryptionCertificateBytes();

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

Remarks

Use this property to provide the decryption certificate. The certificate should have a private key associated with it.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

DocumentInfo Property (PDFVerifier Class)

Contains information about the document properties.

Syntax

SecureBlackboxPDFDocumentInfo* GetDocumentInfo();

char* secureblackbox_pdfverifier_getdocumentinfoencryptionalgorithm(void* lpObj);
int secureblackbox_pdfverifier_getdocumentinfoencryptiontype(void* lpObj);
int secureblackbox_pdfverifier_getdocumentinfometadataencrypted(void* lpObj);
int secureblackbox_pdfverifier_getdocumentinfopermissions(void* lpObj);
QString GetDocumentInfoEncryptionAlgorithm();

int GetDocumentInfoEncryptionType();

bool GetDocumentInfoMetadataEncrypted();

int GetDocumentInfoPermissions();

Remarks

Use this property to access general parameters of the document being processed. A good place to check this property is in the handler of the DocumentLoaded event.

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

Data Type

SecureBlackboxPDFDocumentInfo

FIPSMode Property (PDFVerifier Class)

Reserved.

Syntax

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

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 byte array form.

Syntax

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

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

KnownCertificates Property (PDFVerifier Class)

Additional certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfverifier_getknowncertcount(void* lpObj);
int secureblackbox_pdfverifier_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_pdfverifier_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_pdfverifier_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_pdfverifier_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

KnownCRLs Property (PDFVerifier Class)

Additional CRLs for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs();
int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_pdfverifier_getknowncrlcount(void* lpObj);
int secureblackbox_pdfverifier_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_pdfverifier_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_pdfverifier_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_pdfverifier_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); QByteArray GetKnownCRLBytes(int iKnownCRLIndex); qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

Data Type

SecureBlackboxCRL

KnownOCSPs Property (PDFVerifier Class)

Additional OCSP responses for chain validation.

Syntax

int secureblackbox_pdfverifier_getknownocspcount(void* lpObj);
int secureblackbox_pdfverifier_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_pdfverifier_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_pdfverifier_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_pdfverifier_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex); qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

Data Type

SecureBlackboxOCSPResponse

OCSPs Property (PDFVerifier Class)

A collection of OCSP responses embedded into the signature.

Syntax

int secureblackbox_pdfverifier_getocspcount(void* lpObj);
int secureblackbox_pdfverifier_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);
int secureblackbox_pdfverifier_getocspentrycount(void* lpObj, int ocspindex);
int64 secureblackbox_pdfverifier_getocsphandle(void* lpObj, int ocspindex);
char* secureblackbox_pdfverifier_getocspissuer(void* lpObj, int ocspindex);
char* secureblackbox_pdfverifier_getocspissuerrdn(void* lpObj, int ocspindex);
char* secureblackbox_pdfverifier_getocsplocation(void* lpObj, int ocspindex);
char* secureblackbox_pdfverifier_getocspproducedat(void* lpObj, int ocspindex);
char* secureblackbox_pdfverifier_getocspsigalgorithm(void* lpObj, int ocspindex);
int secureblackbox_pdfverifier_getocspsource(void* lpObj, int ocspindex);
int GetOCSPCount();

QByteArray GetOCSPBytes(int iOCSPIndex);

int GetOCSPEntryCount(int iOCSPIndex);

qint64 GetOCSPHandle(int iOCSPIndex);

QString GetOCSPIssuer(int iOCSPIndex);

QString GetOCSPIssuerRDN(int iOCSPIndex);

QString GetOCSPLocation(int iOCSPIndex);

QString GetOCSPProducedAt(int iOCSPIndex);

QString GetOCSPSigAlgorithm(int iOCSPIndex);

int GetOCSPSource(int iOCSPIndex);

Remarks

Use this property to access the OCSP responses embedded into the signature by its creator.

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

Data Type

SecureBlackboxOCSPResponse

OfflineMode Property (PDFVerifier Class)

Switches the class to offline mode.

Syntax

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 class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

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

Data Type

Boolean

OutputBytes Property (PDFVerifier Class)

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

Syntax

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 has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (PDFVerifier Class)

The file to save the signed or updated document to.

Syntax

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

Pages Property (PDFVerifier Class)

A list of pages contained in the document.

Syntax

int secureblackbox_pdfverifier_getpagecount(void* lpObj);
int secureblackbox_pdfverifier_getpagecropllx(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagecroplly(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagecropurx(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagecropury(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpageheight(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagemediallx(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagemedially(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagemediaurx(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagemediaury(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagerotate(void* lpObj, int pageindex);
int secureblackbox_pdfverifier_getpagewidth(void* lpObj, int pageindex);
int GetPageCount();

int GetPageCropLLX(int iPageIndex);

int GetPageCropLLY(int iPageIndex);

int GetPageCropURX(int iPageIndex);

int GetPageCropURY(int iPageIndex);

int GetPageHeight(int iPageIndex);

int GetPageMediaLLX(int iPageIndex);

int GetPageMediaLLY(int iPageIndex);

int GetPageMediaURX(int iPageIndex);

int GetPageMediaURY(int iPageIndex);

int GetPageRotate(int iPageIndex);

int GetPageWidth(int iPageIndex);

Remarks

Use this property to read document page information. This property is initialized when the DocumentLoaded event fires.

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

Data Type

SecureBlackboxPDFPage

Password Property (PDFVerifier Class)

The decryption password.

Syntax

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

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

Proxy Property (PDFVerifier Class)

The proxy server settings.

Syntax

char* secureblackbox_pdfverifier_getproxyaddress(void* lpObj);
int secureblackbox_pdfverifier_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_pdfverifier_getproxyauthentication(void* lpObj);
int secureblackbox_pdfverifier_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_pdfverifier_getproxypassword(void* lpObj);
int secureblackbox_pdfverifier_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_pdfverifier_getproxyport(void* lpObj);
int secureblackbox_pdfverifier_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_pdfverifier_getproxyproxytype(void* lpObj);
int secureblackbox_pdfverifier_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_pdfverifier_getproxyrequestheaders(void* lpObj);
int secureblackbox_pdfverifier_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_pdfverifier_getproxyresponsebody(void* lpObj);
int secureblackbox_pdfverifier_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_pdfverifier_getproxyresponseheaders(void* lpObj);
int secureblackbox_pdfverifier_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_pdfverifier_getproxyuseipv6(void* lpObj);
int secureblackbox_pdfverifier_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_pdfverifier_getproxyusername(void* lpObj);
int secureblackbox_pdfverifier_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Data Type

SecureBlackboxProxySettings

RevocationCheck Property (PDFVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck); Unicode (Windows) INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);

Possible Values

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

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

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

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

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

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

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

Data Type

Integer

Signatures Property (PDFVerifier Class)

Provides details of all signatures found in the PDF document.

Syntax

int secureblackbox_pdfverifier_getsignaturecount(void* lpObj);
int secureblackbox_pdfverifier_getsignatureallowedchanges(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignatureauthorname(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturecertification(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturechainvalidationdetails(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturechainvalidationresult(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignatureclaimedsigningtime(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturecompatibilityerrors(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturecontactinfo(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturecontainslongterminfo(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturecoverageendsat(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturecustomdata(void* lpObj, int signatureindex, char** lpSignatureCustomData, int* lenSignatureCustomData);
int secureblackbox_pdfverifier_getsignatureemptyfield(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignatureentitylabel(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturefiltername(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturefullsignaturename(void* lpObj, int signatureindex);
int64 secureblackbox_pdfverifier_getsignaturehandle(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturehashalgorithm(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignatureheight(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignatureissuerrdn(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturelevel(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturelocation(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignatureoffsetx(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignatureoffsety(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturepage(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturepolicyhash(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturepolicyhashalgorithm(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturepolicyid(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturepolicyuri(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturereason(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignatureserialnumber(void* lpObj, int signatureindex, char** lpSignatureSerialNumber, int* lenSignatureSerialNumber);
int secureblackbox_pdfverifier_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);
char* secureblackbox_pdfverifier_getsignaturesignaturename(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturesignaturetype(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturesubjectkeyid(void* lpObj, int signatureindex, char** lpSignatureSubjectKeyID, int* lenSignatureSubjectKeyID);
char* secureblackbox_pdfverifier_getsignaturesubjectrdn(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturetimestamped(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturevalidatedsigningtime(void* lpObj, int signatureindex);
char* secureblackbox_pdfverifier_getsignaturevalidationlog(void* lpObj, int signatureindex);
int secureblackbox_pdfverifier_getsignaturewidth(void* lpObj, int signatureindex);
int GetSignatureCount();

int GetSignatureAllowedChanges(int iSignatureIndex);

QString GetSignatureAuthorName(int iSignatureIndex);

bool GetSignatureCertification(int iSignatureIndex);

int GetSignatureChainValidationDetails(int iSignatureIndex);

int GetSignatureChainValidationResult(int iSignatureIndex);

QString GetSignatureClaimedSigningTime(int iSignatureIndex);

int GetSignatureCompatibilityErrors(int iSignatureIndex);

QString GetSignatureContactInfo(int iSignatureIndex);

bool GetSignatureContainsLongTermInfo(int iSignatureIndex);

int GetSignatureCoverageEndsAt(int iSignatureIndex);

QByteArray GetSignatureCustomData(int iSignatureIndex);

bool GetSignatureEmptyField(int iSignatureIndex);

QString GetSignatureEntityLabel(int iSignatureIndex);

QString GetSignatureFilterName(int iSignatureIndex);

QString GetSignatureFullSignatureName(int iSignatureIndex);

qint64 GetSignatureHandle(int iSignatureIndex);

QString GetSignatureHashAlgorithm(int iSignatureIndex);

int GetSignatureHeight(int iSignatureIndex);

QString GetSignatureIssuerRDN(int iSignatureIndex);

int GetSignatureLevel(int iSignatureIndex);

QString GetSignatureLocation(int iSignatureIndex);

int GetSignatureOffsetX(int iSignatureIndex);

int GetSignatureOffsetY(int iSignatureIndex);

int GetSignaturePage(int iSignatureIndex);

QString GetSignaturePolicyHash(int iSignatureIndex);

QString GetSignaturePolicyHashAlgorithm(int iSignatureIndex);

QString GetSignaturePolicyID(int iSignatureIndex);

QString GetSignaturePolicyURI(int iSignatureIndex);

QString GetSignatureReason(int iSignatureIndex);

QByteArray GetSignatureSerialNumber(int iSignatureIndex);

QByteArray GetSignatureSignatureBytes(int iSignatureIndex);

QString GetSignatureSignatureName(int iSignatureIndex);

int GetSignatureSignatureType(int iSignatureIndex);

int GetSignatureSignatureValidationResult(int iSignatureIndex);

QByteArray GetSignatureSubjectKeyID(int iSignatureIndex);

QString GetSignatureSubjectRDN(int iSignatureIndex);

bool GetSignatureTimestamped(int iSignatureIndex);

QString GetSignatureValidatedSigningTime(int iSignatureIndex);

QString GetSignatureValidationLog(int iSignatureIndex);

int GetSignatureWidth(int iSignatureIndex);

Remarks

Upon completion of the validation process conducted by the Verify method, all the signature details are populated in this property.

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

Data Type

SecureBlackboxPDFSignature

SocketSettings Property (PDFVerifier Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_pdfverifier_getsocketdnsmode(void* lpObj);
int secureblackbox_pdfverifier_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_pdfverifier_getsocketdnsport(void* lpObj);
int secureblackbox_pdfverifier_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_pdfverifier_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_pdfverifier_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_pdfverifier_getsocketdnsservers(void* lpObj);
int secureblackbox_pdfverifier_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_pdfverifier_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_pdfverifier_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_pdfverifier_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_pdfverifier_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_pdfverifier_getsocketlocaladdress(void* lpObj);
int secureblackbox_pdfverifier_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_pdfverifier_getsocketlocalport(void* lpObj);
int secureblackbox_pdfverifier_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_pdfverifier_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_pdfverifier_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_pdfverifier_getsockettimeout(void* lpObj);
int secureblackbox_pdfverifier_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_pdfverifier_getsocketuseipv6(void* lpObj);
int secureblackbox_pdfverifier_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers); int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

Timestamps Property (PDFVerifier Class)

Contains a collection of timestamps for the processed document.

Syntax

int secureblackbox_pdfverifier_gettimestampcount(void* lpObj);
int64 secureblackbox_pdfverifier_gettimestampaccuracy(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestampbytes(void* lpObj, int timestampindex, char** lpTimestampBytes, int* lenTimestampBytes);
int secureblackbox_pdfverifier_gettimestampcertificateindex(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestampchainvalidationdetails(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestampchainvalidationresult(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestampcontainslongterminfo(void* lpObj, int timestampindex);
char* secureblackbox_pdfverifier_gettimestampentitylabel(void* lpObj, int timestampindex);
char* secureblackbox_pdfverifier_gettimestamphashalgorithm(void* lpObj, int timestampindex);
char* secureblackbox_pdfverifier_gettimestampparententity(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestampserialnumber(void* lpObj, int timestampindex, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);
char* secureblackbox_pdfverifier_gettimestamptime(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestamptimestamptype(void* lpObj, int timestampindex);
char* secureblackbox_pdfverifier_gettimestamptsaname(void* lpObj, int timestampindex);
char* secureblackbox_pdfverifier_gettimestampvalidationlog(void* lpObj, int timestampindex);
int secureblackbox_pdfverifier_gettimestampvalidationresult(void* lpObj, int timestampindex);
int GetTimestampCount();

qint64 GetTimestampAccuracy(int iTimestampIndex);

QByteArray GetTimestampBytes(int iTimestampIndex);

int GetTimestampCertificateIndex(int iTimestampIndex);

int GetTimestampChainValidationDetails(int iTimestampIndex);

int GetTimestampChainValidationResult(int iTimestampIndex);

bool GetTimestampContainsLongTermInfo(int iTimestampIndex);

QString GetTimestampEntityLabel(int iTimestampIndex);

QString GetTimestampHashAlgorithm(int iTimestampIndex);

QString GetTimestampParentEntity(int iTimestampIndex);

QByteArray GetTimestampSerialNumber(int iTimestampIndex);

QString GetTimestampTime(int iTimestampIndex);

int GetTimestampTimestampType(int iTimestampIndex);

QString GetTimestampTSAName(int iTimestampIndex);

QString GetTimestampValidationLog(int iTimestampIndex);

int GetTimestampValidationResult(int iTimestampIndex);

Remarks

Use this property to access the timestamps included in the processed document.

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

Data Type

SecureBlackboxTimestampInfo

TLSClientChain Property (PDFVerifier Class)

The TLS client certificate chain.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain();
int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfverifier_gettlsclientcertcount(void* lpObj);
int secureblackbox_pdfverifier_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_pdfverifier_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_pdfverifier_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_pdfverifier_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex); qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

TLSServerChain Property (PDFVerifier Class)

The TLS server's certificate chain.

Syntax

int secureblackbox_pdfverifier_gettlsservercertcount(void* lpObj);
int secureblackbox_pdfverifier_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_pdfverifier_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_pdfverifier_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfverifier_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfverifier_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfverifier_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfverifier_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_pdfverifier_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfverifier_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount();

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

QString GetTLSServerCertFingerprint(int iTLSServerCertIndex);

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);

QString GetTLSServerCertIssuer(int iTLSServerCertIndex);

QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex);

QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex);

int GetTLSServerCertKeyBits(int iTLSServerCertIndex);

int GetTLSServerCertKeyUsage(int iTLSServerCertIndex);

bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex);

QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex);

QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex);

QString GetTLSServerCertSubject(int iTLSServerCertIndex);

QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex);

QString GetTLSServerCertValidFrom(int iTLSServerCertIndex);

QString GetTLSServerCertValidTo(int iTLSServerCertIndex);

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

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

Data Type

SecureBlackboxCertificate

TLSSettings Property (PDFVerifier Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_pdfverifier_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_pdfverifier_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_pdfverifier_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_pdfverifier_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_pdfverifier_gettlsciphersuites(void* lpObj);
int secureblackbox_pdfverifier_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_pdfverifier_gettlsclientauth(void* lpObj);
int secureblackbox_pdfverifier_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_pdfverifier_gettlseccurves(void* lpObj);
int secureblackbox_pdfverifier_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_pdfverifier_gettlsextensions(void* lpObj);
int secureblackbox_pdfverifier_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_pdfverifier_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_pdfverifier_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_pdfverifier_gettlspresharedidentity(void* lpObj);
int secureblackbox_pdfverifier_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_pdfverifier_gettlspresharedkey(void* lpObj);
int secureblackbox_pdfverifier_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_pdfverifier_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_pdfverifier_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_pdfverifier_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_pdfverifier_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_pdfverifier_gettlsrevocationcheck(void* lpObj);
int secureblackbox_pdfverifier_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_pdfverifier_gettlsssloptions(void* lpObj);
int secureblackbox_pdfverifier_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_pdfverifier_gettlstlsmode(void* lpObj);
int secureblackbox_pdfverifier_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_pdfverifier_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_pdfverifier_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_pdfverifier_gettlsusesessionresumption(void* lpObj);
int secureblackbox_pdfverifier_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_pdfverifier_gettlsversions(void* lpObj);
int secureblackbox_pdfverifier_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Data Type

SecureBlackboxTLSSettings

TrustedCertificates Property (PDFVerifier Class)

A list of trusted certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates();
int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfverifier_gettrustedcertcount(void* lpObj);
int secureblackbox_pdfverifier_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_pdfverifier_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_pdfverifier_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_pdfverifier_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); QByteArray GetTrustedCertBytes(int iTrustedCertIndex); qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

ValidationMoment Property (PDFVerifier Class)

The time point at which signature validity is to be established.

Syntax

ANSI (Cross Platform)
char* GetValidationMoment();
int SetValidationMoment(const char* lpszValidationMoment); Unicode (Windows) LPWSTR GetValidationMoment();
INT SetValidationMoment(LPCWSTR lpszValidationMoment);
char* secureblackbox_pdfverifier_getvalidationmoment(void* lpObj);
int secureblackbox_pdfverifier_setvalidationmoment(void* lpObj, const char* lpszValidationMoment);
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);

Default Value

""

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Data Type

String

Close Method (PDFVerifier Class)

Closes an opened document.

Syntax

ANSI (Cross Platform)
int Close(int bSaveChanges);

Unicode (Windows)
INT Close(BOOL bSaveChanges);
int secureblackbox_pdfverifier_close(void* lpObj, int bSaveChanges);
int Close(bool bSaveChanges);

Remarks

Use this method to close a previously opened document. The SaveChanges parameter is only taken into account if the document was opened in edit mode.

Error Handling (C++)

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

Config Method (PDFVerifier Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_pdfverifier_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

DoAction Method (PDFVerifier Class)

Performs an additional action.

Syntax

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

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_pdfverifier_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

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

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

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

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

Error Handling (C++)

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

GetAttachedBytes Method (PDFVerifier Class)

Saves a PDF attachment to a byte array.

Syntax

ANSI (Cross Platform)
char* GetAttachedBytes(int iIndex, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetAttachedBytes(INT iIndex, LPINT lpSize = NULL);
char* secureblackbox_pdfverifier_getattachedbytes(void* lpObj, int iIndex, int *lpSize);
QByteArray GetAttachedBytes(int iIndex);

Remarks

Use this method to retrieve the contents of an attached file as a byte array.

Error Handling (C++)

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

GetAttachedFile Method (PDFVerifier Class)

Saves a PDF attachment to a file.

Syntax

ANSI (Cross Platform)
int GetAttachedFile(int iIndex, const char* lpszPath);

Unicode (Windows)
INT GetAttachedFile(INT iIndex, LPCWSTR lpszPath);
int secureblackbox_pdfverifier_getattachedfile(void* lpObj, int iIndex, const char* lpszPath);
int GetAttachedFile(int iIndex, const QString& qsPath);

Remarks

Use this method to retrieve the contents of an attached file and save it to a file.

Error Handling (C++)

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

GetAttachedStream Method (PDFVerifier Class)

Saves a PDF attachment to a stream.

Syntax

ANSI (Cross Platform)
int GetAttachedStream(int iIndex, SecureBlackboxStream* sStream);

Unicode (Windows)
INT GetAttachedStream(INT iIndex, SecureBlackboxStream* sStream);
int secureblackbox_pdfverifier_getattachedstream(void* lpObj, int iIndex, SecureBlackboxStream* sStream);
int GetAttachedStream(int iIndex, SecureBlackboxStream* sStream);

Remarks

Use this method to retrieve the contents of an attached file and save it to a stream.

Error Handling (C++)

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

GetSignedVersion Method (PDFVerifier Class)

Returns the part of the document that is covered by the signature.

Syntax

ANSI (Cross Platform)
int GetSignedVersion(const char* lpszSigLabel);

Unicode (Windows)
INT GetSignedVersion(LPCWSTR lpszSigLabel);
int secureblackbox_pdfverifier_getsignedversion(void* lpObj, const char* lpszSigLabel);
int GetSignedVersion(const QString& qsSigLabel);

Remarks

Use this method to retrieve the revision of the document that is covered by the SigLabel signature.

PDF documents often use the incremental updates approach, with any changes being appended to the document without altering the existing revision. This may lead to situations where a signature only covers a part of the document (one of the past revisions), but not the subsequent changes. This method provides means to extract the revision that is actually certified by the signature.

It is recommended that you use this method when validating signatures to make sure the signature covers what you expect it to cover.

An alternative to this method is to check the CoverageEndsAt field of the signature object and match it to the document length.

Error Handling (C++)

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

Open Method (PDFVerifier Class)

Opens a document for verifying or removing signatures.

Syntax

ANSI (Cross Platform)
int Open(int bEditMode);

Unicode (Windows)
INT Open(BOOL bEditMode);
int secureblackbox_pdfverifier_open(void* lpObj, int bEditMode);
int Open(bool bEditMode);

Remarks

Use this method to open a document for verifying or removing signatures, or for extracting signed content. When finished, call Close to complete the operation and release any allocated resources.

Set EditMode to true to open the document in edit mode (only useful if you intend to remove signatures).

Error Handling (C++)

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

Reset Method (PDFVerifier Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int secureblackbox_pdfverifier_reset(void* lpObj);
int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

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

Revalidate Method (PDFVerifier Class)

Revalidates a signature in accordance with current settings.

Syntax

ANSI (Cross Platform)
int Revalidate(const char* lpszSigLabel);

Unicode (Windows)
INT Revalidate(LPCWSTR lpszSigLabel);
int secureblackbox_pdfverifier_revalidate(void* lpObj, const char* lpszSigLabel);
int Revalidate(const QString& qsSigLabel);

Remarks

Use this method to revalidate a signature in the opened PDF document.

Error Handling (C++)

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

SelectInfo Method (PDFVerifier Class)

Select signature information for a specific entity.

Syntax

ANSI (Cross Platform)
int SelectInfo(const char* lpszEntityLabel, int iInfoType, int bClearSelection);

Unicode (Windows)
INT SelectInfo(LPCWSTR lpszEntityLabel, INT iInfoType, BOOL bClearSelection);
int secureblackbox_pdfverifier_selectinfo(void* lpObj, const char* lpszEntityLabel, int iInfoType, int bClearSelection);
int SelectInfo(const QString& qsEntityLabel, int iInfoType, bool bClearSelection);

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

sitEntity1Select the current entity

sitParentEntity2Select the parent entity of the current entity

sitTimestamps4Select all timestamps covering the current entity

sitSignatures8Select all signatures covering the current entity

sitSigningChain16Select the signing chain of the current entity

sitEmbeddedCertificates256Select all certificates embedded in the current entity

sitEmbeddedCRLs512Select all CRLs embedded in the current entity

sitEmbeddedOCSPs1024Select all OCSP responses embedded in the current entity

sitEmbeddedRevInfo1792Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs)

sitUsedCertificates4096Select all the certificates used to validate this entity's chain

sitUsedCRLs8192Select all the CRLs used to validate this entity's chain

sitUsedOCSPs16384Select all the OCSP responses used to validate this entity's chain

sitUsedRevInfo28672Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses)

sitAttributes65536Select this entity's CMS attributes

sitReferences131072Select this entity's XML references

sitSignedParts262144Select this entity's signed parts

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

Error Handling (C++)

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

Unsign Method (PDFVerifier Class)

Deletes a signature from the document.

Syntax

ANSI (Cross Platform)
int Unsign(const char* lpszSigLabel, int iUnsignKind);

Unicode (Windows)
INT Unsign(LPCWSTR lpszSigLabel, INT iUnsignKind);
int secureblackbox_pdfverifier_unsign(void* lpObj, const char* lpszSigLabel, int iUnsignKind);
int Unsign(const QString& qsSigLabel, int iUnsignKind);

Remarks

Use this method to delete an existing signature from the document. Use the SigLabel parameter to specify the signature to be removed.

Unsigning is different from GetSignedVersion. The latter returns the revision of the document including the mentioned signature (thus removing anything added after that signature was created). Unsign removes the signature completely by carving it out of the document.

The following unsign kinds are currently supported:

uskDefault (0)The default option.
uskFull (1)Remove the signature fully. This is also the default option.
uskKeepField (2)Only remove the signature, but keep the form field it is in.
uskKeepAppearance (3)Remove the signature, but keep the form field and its widget.

Note: SigLabel set to "" removes all signatures in the document.

Error Handling (C++)

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

Verify Method (PDFVerifier Class)

Verifies a signed PDF document.

Syntax

ANSI (Cross Platform)
int Verify();

Unicode (Windows)
INT Verify();
int secureblackbox_pdfverifier_verify(void* lpObj);
int Verify();

Remarks

Use this method to validate all signatures in a PDF document.

This method walks through a signed document and reports every signature via the SignatureFound event. Subscribe to the event to be notified about the signatures and adjust validation settings on the fly.

Upon completion of this method, the signature details will be published in the Signatures property.

This method only validates the signatures, but does not check their coverage. It is a good idea to use mechanisms such as GetSignedVersion or CoverageEndsAt to ensure that the signature covers the expected document revision.

Error Handling (C++)

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

ChainElementDownload Event (PDFVerifier Class)

Fires when there is a need to download a chain element from an online source.

Syntax

ANSI (Cross Platform)
virtual int FireChainElementDownload(PDFVerifierChainElementDownloadEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN;
const char *Location;
int Action; int reserved; } PDFVerifierChainElementDownloadEventParams;
Unicode (Windows) virtual INT FireChainElementDownload(PDFVerifierChainElementDownloadEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
LPCWSTR Location;
INT Action; INT reserved; } PDFVerifierChainElementDownloadEventParams;
#define EID_PDFVERIFIER_CHAINELEMENTDOWNLOAD 1

virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);
class PDFVerifierChainElementDownloadEventParams {
public:
  int Kind();

  const QString &CertRDN();

  const QString &CACertRDN();

  const QString &Location();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ChainElementDownload(PDFVerifierChainElementDownloadEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireChainElementDownload(PDFVerifierChainElementDownloadEventParams *e) {...}

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

veaAuto0Handle the action automatically (the default behaviour)

veaContinue1Accept the request implied by the event (accept the certificate, allow the object retrieval)

veaReject2Reject the request implied by the event (reject the certificate, disallow the object retrieval)

veaAcceptNow3Accept the validated certificate immediately

veaAbortNow4Abort the validation, reject the certificate

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainElementNeeded Event (PDFVerifier Class)

Fires when an element required to validate the chain was not located.

Syntax

ANSI (Cross Platform)
virtual int FireChainElementNeeded(PDFVerifierChainElementNeededEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN; int reserved; } PDFVerifierChainElementNeededEventParams;
Unicode (Windows) virtual INT FireChainElementNeeded(PDFVerifierChainElementNeededEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN; INT reserved; } PDFVerifierChainElementNeededEventParams;
#define EID_PDFVERIFIER_CHAINELEMENTNEEDED 2

virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);
class PDFVerifierChainElementNeededEventParams {
public:
  int Kind();

  const QString &CertRDN();

  const QString &CACertRDN();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ChainElementNeeded(PDFVerifierChainElementNeededEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireChainElementNeeded(PDFVerifierChainElementNeededEventParams *e) {...}

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainValidated Event (PDFVerifier Class)

Reports the completion of a certificate chain validation.

Syntax

ANSI (Cross Platform)
virtual int FireChainValidated(PDFVerifierChainValidatedEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *SubjectRDN;
int ValidationResult;
int ValidationDetails;
int Cancel; int reserved; } PDFVerifierChainValidatedEventParams;
Unicode (Windows) virtual INT FireChainValidated(PDFVerifierChainValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR SubjectRDN;
INT ValidationResult;
INT ValidationDetails;
BOOL Cancel; INT reserved; } PDFVerifierChainValidatedEventParams;
#define EID_PDFVERIFIER_CHAINVALIDATED 3

virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails, BOOL &bCancel);
class PDFVerifierChainValidatedEventParams {
public:
  int Index();

  const QString &EntityLabel();

  const QString &SubjectRDN();

  int ValidationResult();

  int ValidationDetails();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ChainValidated(PDFVerifierChainValidatedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireChainValidated(PDFVerifierChainValidatedEventParams *e) {...}

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Any other value reports a failure, and ValidationDetails provides more details on its reasons.
cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationProgress Event (PDFVerifier Class)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

ANSI (Cross Platform)
virtual int FireChainValidationProgress(PDFVerifierChainValidationProgressEventParams *e);
typedef struct {
const char *EventKind;
const char *CertRDN;
const char *CACertRDN;
int Action; int reserved; } PDFVerifierChainValidationProgressEventParams;
Unicode (Windows) virtual INT FireChainValidationProgress(PDFVerifierChainValidationProgressEventParams *e);
typedef struct {
LPCWSTR EventKind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
INT Action; INT reserved; } PDFVerifierChainValidationProgressEventParams;
#define EID_PDFVERIFIER_CHAINVALIDATIONPROGRESS 4

virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);
class PDFVerifierChainValidationProgressEventParams {
public:
  const QString &EventKind();

  const QString &CertRDN();

  const QString &CACertRDN();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ChainValidationProgress(PDFVerifierChainValidationProgressEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireChainValidationProgress(PDFVerifierChainValidationProgressEventParams *e) {...}

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.

veaAuto0Handle the action automatically (the default behaviour)

veaContinue1Accept the request implied by the event (accept the certificate, allow the object retrieval)

veaReject2Reject the request implied by the event (reject the certificate, disallow the object retrieval)

veaAcceptNow3Accept the validated certificate immediately

veaAbortNow4Abort the validation, reject the certificate

DocumentLoaded Event (PDFVerifier Class)

This event is fired when the document has been loaded into memory.

Syntax

ANSI (Cross Platform)
virtual int FireDocumentLoaded(PDFVerifierDocumentLoadedEventParams *e);
typedef struct {
int Cancel; int reserved; } PDFVerifierDocumentLoadedEventParams;
Unicode (Windows) virtual INT FireDocumentLoaded(PDFVerifierDocumentLoadedEventParams *e);
typedef struct {
BOOL Cancel; INT reserved; } PDFVerifierDocumentLoadedEventParams;
#define EID_PDFVERIFIER_DOCUMENTLOADED 5

virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);
class PDFVerifierDocumentLoadedEventParams {
public:
  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DocumentLoaded(PDFVerifierDocumentLoadedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireDocumentLoaded(PDFVerifierDocumentLoadedEventParams *e) {...}

Remarks

The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the Pages information to find the optimal position for the signature widget.

Set Cancel to true to terminate document processing on this stage.

Encrypted Event (PDFVerifier Class)

Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.

Syntax

ANSI (Cross Platform)
virtual int FireEncrypted(PDFVerifierEncryptedEventParams *e);
typedef struct {
int CertUsed;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int NeedCredential;
int SkipThis; int reserved; } PDFVerifierEncryptedEventParams;
Unicode (Windows) virtual INT FireEncrypted(PDFVerifierEncryptedEventParams *e);
typedef struct {
BOOL CertUsed;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL NeedCredential;
BOOL SkipThis; INT reserved; } PDFVerifierEncryptedEventParams;
#define EID_PDFVERIFIER_ENCRYPTED 6

virtual INT SECUREBLACKBOX_CALL FireEncrypted(BOOL &bCertUsed, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bNeedCredential, BOOL &bSkipThis);
class PDFVerifierEncryptedEventParams {
public:
  bool CertUsed();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool NeedCredential();

  bool SkipThis();
  void SetSkipThis(bool bSkipThis);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Encrypted(PDFVerifierEncryptedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireEncrypted(PDFVerifierEncryptedEventParams *e) {...}

Remarks

The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate or Password property (depending on the encryption method used), or sets SkipThis to true.

The CertUsed parameter specifies the encryption method used. If set to true, it indicates that the document uses asymmetric (certificate-based) encryption. In that case, the IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own Encrypted event loop.

CertUsed set to false indicates that the document uses password encryption. In this case, provide the password via the Password property.

The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the Password property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (PDFVerifier Class)

Information about errors during signing/validation.

Syntax

ANSI (Cross Platform)
virtual int FireError(PDFVerifierErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } PDFVerifierErrorEventParams;
Unicode (Windows) virtual INT FireError(PDFVerifierErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } PDFVerifierErrorEventParams;
#define EID_PDFVERIFIER_ERROR 7

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class PDFVerifierErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(PDFVerifierErrorEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireError(PDFVerifierErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during PDF processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (PDFVerifier Class)

This event notifies the application about an underlying control flow event.

Syntax

ANSI (Cross Platform)
virtual int FireNotification(PDFVerifierNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } PDFVerifierNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(PDFVerifierNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } PDFVerifierNotificationEventParams;
#define EID_PDFVERIFIER_NOTIFICATION 8

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class PDFVerifierNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(PDFVerifierNotificationEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireNotification(PDFVerifierNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

DocumentLoadedNotifies the application that the document has been loaded. This is a backward-compatibility-only notification. Use OnDocumentLoaded event instead.
SignaturesLoadedNotifies the application that the component has finished loading signatures.
BeforeTimestampThis event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings.
TimestampErrorThis event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info.
TimestampRequestA timestamp is requested from the custom timestamping authority. This event is only fired if TimestampServer was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to TimestampServer), in base16, that needs to be sent to the TSA.

Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property.

SignatureFound Event (PDFVerifier Class)

Signifies the start of signature validation.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureFound(PDFVerifierSignatureFoundEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateSignature;
int ValidateChain; int reserved; } PDFVerifierSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(PDFVerifierSignatureFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateSignature;
BOOL ValidateChain; INT reserved; } PDFVerifierSignatureFoundEventParams;
#define EID_PDFVERIFIER_SIGNATUREFOUND 9

virtual INT SECUREBLACKBOX_CALL FireSignatureFound(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class PDFVerifierSignatureFoundEventParams {
public:
  int Index();

  const QString &EntityLabel();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SignatureFound(PDFVerifierSignatureFoundEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireSignatureFound(PDFVerifierSignatureFoundEventParams *e) {...}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (PDFVerifier Class)

Marks the completion of the signature validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureValidated(PDFVerifierSignatureValidatedEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult;
int Cancel; int reserved; } PDFVerifierSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(PDFVerifierSignatureValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult;
BOOL Cancel; INT reserved; } PDFVerifierSignatureValidatedEventParams;
#define EID_PDFVERIFIER_SIGNATUREVALIDATED 10

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult, BOOL &bCancel);
class PDFVerifierSignatureValidatedEventParams {
public:
  int Index();

  const QString &EntityLabel();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  int ValidationResult();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SignatureValidated(PDFVerifierSignatureValidatedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireSignatureValidated(PDFVerifierSignatureValidatedEventParams *e) {...}

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TimestampFound Event (PDFVerifier Class)

Signifies the start of a timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampFound(PDFVerifierTimestampFoundEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateTimestamp;
int ValidateChain; int reserved; } PDFVerifierTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(PDFVerifierTimestampFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateTimestamp;
BOOL ValidateChain; INT reserved; } PDFVerifierTimestampFoundEventParams;
#define EID_PDFVERIFIER_TIMESTAMPFOUND 11

virtual INT SECUREBLACKBOX_CALL FireTimestampFound(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class PDFVerifierTimestampFoundEventParams {
public:
  int Index();

  const QString &EntityLabel();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateTimestamp();
  void SetValidateTimestamp(bool bValidateTimestamp);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TimestampFound(PDFVerifierTimestampFoundEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTimestampFound(PDFVerifierTimestampFoundEventParams *e) {...}

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the ValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (PDFVerifier Class)

Reports the completion of the timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampValidated(PDFVerifierTimestampValidatedEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *Time;
int ValidationResult;
int ChainValidationResult;
int ChainValidationDetails;
int Cancel; int reserved; } PDFVerifierTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(PDFVerifierTimestampValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR Time;
INT ValidationResult;
INT ChainValidationResult;
INT ChainValidationDetails;
BOOL Cancel; INT reserved; } PDFVerifierTimestampValidatedEventParams;
#define EID_PDFVERIFIER_TIMESTAMPVALIDATED 12

virtual INT SECUREBLACKBOX_CALL FireTimestampValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszTime, INT &iValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails, BOOL &bCancel);
class PDFVerifierTimestampValidatedEventParams {
public:
  int Index();

  const QString &EntityLabel();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  const QString &Time();

  int ValidationResult();

  int ChainValidationResult();

  int ChainValidationDetails();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TimestampValidated(PDFVerifierTimestampValidatedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTimestampValidated(PDFVerifierTimestampValidatedEventParams *e) {...}

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TLSCertNeeded Event (PDFVerifier Class)

Fires when a remote TLS party requests a client certificate.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertNeeded(PDFVerifierTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } PDFVerifierTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(PDFVerifierTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } PDFVerifierTLSCertNeededEventParams;
#define EID_PDFVERIFIER_TLSCERTNEEDED 13

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class PDFVerifierTLSCertNeededEventParams {
public:
  const QString &Host();

  const QString &CANames();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertNeeded(PDFVerifierTLSCertNeededEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTLSCertNeeded(PDFVerifierTLSCertNeededEventParams *e) {...}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (PDFVerifier Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertValidate(PDFVerifierTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } PDFVerifierTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(PDFVerifierTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } PDFVerifierTLSCertValidateEventParams;
#define EID_PDFVERIFIER_TLSCERTVALIDATE 14

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class PDFVerifierTLSCertValidateEventParams {
public:
  const QString &ServerHost();

  const QString &ServerIP();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertValidate(PDFVerifierTLSCertValidateEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTLSCertValidate(PDFVerifierTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (PDFVerifier Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(PDFVerifierTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } PDFVerifierTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(PDFVerifierTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } PDFVerifierTLSEstablishedEventParams;
#define EID_PDFVERIFIER_TLSESTABLISHED 15

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class PDFVerifierTLSEstablishedEventParams {
public:
  const QString &Host();

  const QString &Version();

  const QString &Ciphersuite();

  const QByteArray &ConnectionId();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSEstablished(PDFVerifierTLSEstablishedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTLSEstablished(PDFVerifierTLSEstablishedEventParams *e) {...}

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (PDFVerifier Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(PDFVerifierTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } PDFVerifierTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(PDFVerifierTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } PDFVerifierTLSHandshakeEventParams;
#define EID_PDFVERIFIER_TLSHANDSHAKE 16

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class PDFVerifierTLSHandshakeEventParams {
public:
  const QString &Host();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSHandshake(PDFVerifierTLSHandshakeEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTLSHandshake(PDFVerifierTLSHandshakeEventParams *e) {...}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (PDFVerifier Class)

Reports the graceful closure of a TLS connection.

Syntax

ANSI (Cross Platform)
virtual int FireTLSShutdown(PDFVerifierTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } PDFVerifierTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(PDFVerifierTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } PDFVerifierTLSShutdownEventParams;
#define EID_PDFVERIFIER_TLSSHUTDOWN 17

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class PDFVerifierTLSShutdownEventParams {
public:
  const QString &Host();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSShutdown(PDFVerifierTLSShutdownEventParams *e);
// Or, subclass PDFVerifier and override this emitter function. virtual int FireTLSShutdown(PDFVerifierTLSShutdownEventParams *e) {...}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
char* (read-only)

Default Value:

Returns the raw certificate data in DER format.

CA
int

Default Value: FALSE

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
char* (read-only)

Default Value:

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

CertType
int (read-only)

Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*

Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
char*

Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

Fingerprint
char* (read-only)

Default Value: ""

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

FriendlyName
char* (read-only)

Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
int64

Default Value: 0

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());

HashAlgorithm
char*

Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Issuer
char* (read-only)

Default Value: ""

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.

IssuerRDN
char*

Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

KeyAlgorithm
char*

Default Value: "0"

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)

Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.

KeyFingerprint
char* (read-only)

Default Value: ""

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
int

Default Value: 0

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
int (read-only)

Default Value: FALSE

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

OCSPLocations
char*

Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
int

Default Value: FALSE

Accessor to the value of the certificate's ocsp-no-check extension.

Origin
int (read-only)

Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
char*

Default Value: ""

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.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
char* (read-only)

Default Value:

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
int (read-only)

Default Value: FALSE

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
int (read-only)

Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)

Default Value:

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

Qualified
int (read-only)

Default Value: FALSE

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
int

Default Value: 0

Returns a simplified qualified status of the certificate.

Qualifiers
char* (read-only)

Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
int (read-only)

Default Value: FALSE

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

SerialNumber
char*

Default Value:

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

SigAlgorithm
char* (read-only)

Default Value: ""

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

Source
int (read-only)

Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Subject
char* (read-only)

Default Value: ""

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.

SubjectAlternativeName
char*

Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
char*

Default Value:

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
char*

Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

Valid
int (read-only)

Default Value: FALSE

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
char*

Default Value: ""

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

ValidTo
char*

Default Value: ""

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

Constructors

Certificate()

Creates a new object with default field values.

CRL Type

Represents a Certificate Revocation List.

Syntax

SecureBlackboxCRL (declared in secureblackbox.h)

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

The following fields are available:

Fields

Bytes
char* (read-only)

Default Value:

Returns the raw CRL data in DER format.

CAKeyID
char*

Default Value:

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

EntryCount
int (read-only)

Default Value: 0

Returns the number of certificate status entries in the CRL.

Handle
int64

Default Value: 0

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());

Issuer
char* (read-only)

Default Value: ""

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

IssuerRDN
char* (read-only)

Default Value: ""

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

Location
char* (read-only)

Default Value: ""

The URL that the CRL was downloaded from.

NextUpdate
char*

Default Value: ""

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

SigAlgorithm
char*

Default Value: "0"

The public key algorithm that was used by the CA to sign this CRL.

Source
int (read-only)

Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

TBS
char* (read-only)

Default Value:

The to-be-signed part of the CRL (the CRL without the signature part).

ThisUpdate
char*

Default Value: ""

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

Constructors

CRL()

Creates an empty CRL object.

MailAttachment Type

Represents an attachment to an e-mail message.

Syntax

SecureBlackboxMailAttachment (declared in secureblackbox.h)

Remarks

This object is a container for message attachments.

The following fields are available:

Fields

ContentSubtype
char*

Default Value: ""

Contains the content subtype of the attachment.

ContentType
char*

Default Value: ""

Contains the content type of the attachment.

CreationDate
char*

Default Value: ""

The creation date.

Data
char*

Default Value:

The content of the attachment.

Description
char*

Default Value: ""

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.

FileName
char*

Default Value: ""

Specifies the name of the attachment file.

Handle
int64

Default Value: 0

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());

ID
char*

Default Value: ""

Contains the attachment's unique identifier.

ModificationDate
char*

Default Value: ""

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

ReadDate
char*

Default Value: ""

Specifies the file's last read date.

Size
int64

Default Value: 0

The attachment's size in bytes.

Constructors

MailAttachment(const char* lpszContentType)

Creates an empty mail attachment object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Syntax

SecureBlackboxOCSPResponse (declared in secureblackbox.h)

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

The following fields are available:

Fields

Bytes
char* (read-only)

Default Value:

A buffer containing the raw OCSP response data.

EntryCount
int (read-only)

Default Value: 0

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

Handle
int64

Default Value: 0

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());

Issuer
char* (read-only)

Default Value: ""

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

IssuerRDN
char* (read-only)

Default Value: ""

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

Location
char* (read-only)

Default Value: ""

The location of the OCSP responder.

ProducedAt
char*

Default Value: ""

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

SigAlgorithm
char*

Default Value: "0"

The public key algorithm that was used by the CA to sign this OCSP response.

Source
int (read-only)

Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Constructors

OCSPResponse()

Creates an empty OCSP response object.

PDFDocumentInfo Type

Contains document security information.

Syntax

SecureBlackboxPDFDocumentInfo (declared in secureblackbox.h)

Remarks

This type provides an overview of the document security parameters, including the encryption method (if used) and signature count. This information is available early into the signing/validation process and lets you prepare for the subsequent signature validation.

The following fields are available:

Fields

EncryptionAlgorithm
char* (read-only)

Default Value: ""

The symmetric algorithm used to encrypt the document.

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

Supported values:

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES256AES256

EncryptionType
int (read-only)

Default Value: 1

The document encryption type.

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

Supported values:

petPassword1The document is encrypted with a password.
petCertificate2The document is encrypted with a certificate (or many certificates).

MetadataEncrypted
int (read-only)

Default Value: TRUE

Indicates if the document metadata is encrypted.

Use this property to check if the document metadata is encrypted.

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

Permissions
int (read-only)

Default Value: 0

Contains the document permissions associated with the encryption.

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

pepAnnotations0x0001Annotating is allowed

pepAssemble0x0002Assembling a new document on the basis of the processed one is allowed

pepExtract0x0004Extraction/copying of the pictures and text from the document is allowed

pepExtractAcc0x0008Content extraction is allowed for accessibility purposes only

pepFillInForms0x0010Filling forms in is allowed

pepHighQualityPrint0x0020High quality printing is allowed

pepLowQualityPrint0x0040Low quality printing is allowed

pepModify0x0080Modifications are allowed

Constructors

PDFDocumentInfo()

Initializes an instance of PDFDocumentInfo class.

PDFPage Type

This component is a container for PDF page details.

Syntax

SecureBlackboxPDFPage (declared in secureblackbox.h)

Remarks

Use this object to read general information about a document page, such as its dimensions and content positioning details.

The following fields are available:

Fields

CropLLX
int (read-only)

Default Value: 0

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

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

CropLLY
int (read-only)

Default Value: 0

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

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

CropURX
int (read-only)

Default Value: 0

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

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

CropURY
int (read-only)

Default Value: 0

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

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

Height
int (read-only)

Default Value: 0

Specifies the height of the page.

Returns the height of the page.

MediaLLX
int (read-only)

Default Value: 0

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

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

MediaLLY
int (read-only)

Default Value: 0

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

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

MediaURX
int (read-only)

Default Value: 0

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

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

MediaURY
int (read-only)

Default Value: 0

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

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

Rotate
int (read-only)

Default Value: 0

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

Width
int (read-only)

Default Value: 0

Specifies the width of the page.

Returns the width of the page.

Constructors

PDFPage()

Creates a new PDF page object.

PDFSignature Type

This component is a container for PDF signature details.

Syntax

SecureBlackboxPDFSignature (declared in secureblackbox.h)

Remarks

Use it to tune up signature properties and widget appearance when creating a signature, or to read the signature information when processing it.

The following fields are available:

Fields

AllowedChanges
int

Default Value: 0

The changes to the document allowed by the signature.

This field is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).

psacNone0No changes are allowed by the signature
psacFillInForms1Only form fill-in is allowed
psacComment2Commenting is allowed
psacAll3Form fill-in and commenting are allowed

AuthorName
char*

Default Value: ""

A human-readable signer name. This is a PDF document property.

Certification
int

Default Value: FALSE

Specifies whether this is a Certification (MDP) signature.

Certification signatures are a feature used by earlier Acrobat versions. They have little use these days.

ChainValidationDetails
int (read-only)

Default Value: 0

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

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationResult
int (read-only)

Default Value: 0

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

ClaimedSigningTime
char*

Default Value: ""

Returns or sets the signature's creation time.

Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike ValidatedSigningTime, does not originate from a trusted TSA and may be forfeited or wrong.

The time is provided in UTC.

CompatibilityErrors
int (read-only)

Default Value: 0

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

ContactInfo
char*

Default Value: ""

Contains the signer's contact information. This is a PDF document property.

ContainsLongTermInfo
int (read-only)

Default Value: FALSE

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

CoverageEndsAt
int (read-only)

Default Value: 0

Indicates the offset in the PDF file where signature coverage ends.

PDF generators often use incremental updates to make changes in the documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes.

Use this property to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document. Alternatively, use the GetSignedVersion method of the PDFVerifier class to extract the exact revision that was signed.

CustomData
char*

Default Value:

Uninterpreted custom data to save with the signature.

EmptyField
int

Default Value: FALSE

Indicates whether or not the signature created/read is an empty field (a signature placeholder).

EntityLabel
char* (read-only)

Default Value: ""

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

FilterName
char*

Default Value: ""

The signature filter name.

FullSignatureName
char* (read-only)

Default Value: ""

Specifies the full name of the signature field.

This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.

Handle
int64

Default Value: 0

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());

HashAlgorithm
char*

Default Value: "SHA256"

Specifies the hash algorithm to be used for signing.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Height
int

Default Value: 0

Specifies the height of the signature widget.

Note that the dimensions of the widget are provided in document-specific points, not pixels.

IssuerRDN
char* (read-only)

Default Value: ""

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

Level
int

Default Value: 2

Specifies the PAdES signature level.

PAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.

Note that when validating a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and certificate caching (switch it off to stop earlier validations from affecting the current validation).

The supported levels are:

paslUnknown0Unknown signature level

paslGeneric1Generic signature: Legacy Adobe signature (adbe.pkcs7.detached), corresponds to pstLegacy signature type

paslBaselineB2Baseline B (B-B, basic)

paslBaselineT3Baseline T (B-T, timestamped)

paslBaselineLT4Baseline LT (B-LT, long-term)

paslBaselineLTA5Baseline LTA (B-LTA, long-term with archived timestamp)

paslBES6BES (Basic Electronic Signature)

paslEPES7EPES (Electronic Signature with an Explicit Policy)

paslLTV8LTV (Electronic Signature with with revocation info)

Location
char*

Default Value: ""

Specifies the host name or the physical location of the signing entity. This is a PDF property.

OffsetX
int

Default Value: 0

Specifies the signature widget offset from the left-hand page border.

OffsetY
int

Default Value: 0

Specifies the signature widget offset from the bottom page border.

Page
int (read-only)

Default Value: -1

Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.

PolicyHash
char*

Default Value: ""

The signature policy hash value for EPES signatures.

PolicyHashAlgorithm
char*

Default Value: ""

The algorithm that was used to calculate the signature policy hash.

PolicyID
char*

Default Value: ""

The policy ID to be included into the signature.

PolicyURI
char*

Default Value: ""

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

Reason
char*

Default Value: ""

Specifies the reason for signing. This is a PDF document property.

SerialNumber
char* (read-only)

Default Value:

The serial number of the signing certificate.

SignatureBytes
char* (read-only)

Default Value:

Returns the binary representation of the underlying PKCS7 signature blob.

SignatureName
char*

Default Value: ""

Specifies the unique signature identifier to use.

This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.

SignatureType
int

Default Value: 2

The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.

The supported values are:

pstUnknown0Unknown signature type

pstLegacy1Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1)

pstPAdES2PAdES signature (ETSI.CAdES.detached), use Level field for detailed info

pstDocumentTimestamp3Document timestamp (ETSI.RFC3161)

SignatureValidationResult
int (read-only)

Default Value: 0

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

SubjectKeyID
char* (read-only)

Default Value:

Contains the subject key identifier of the signing certificate.

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 by a SHA-1 hash of the bit string of the subject public key.

SubjectRDN
char* (read-only)

Default Value: ""

Contains the RDN of the owner of the signing certificate.

RDN is a number of OID=Value pairs declared in the certificate that provide the owner's details.

Timestamped
int (read-only)

Default Value: FALSE

Use this property to establish whether the signature contains an embedded timestamp.

ValidatedSigningTime
char* (read-only)

Default Value: ""

Contains the certified signing time.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.

ClaimedSigningTime returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

ValidationLog
char* (read-only)

Default Value: ""

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

Width
int

Default Value: 0

Specifies the width of the signature widget.

Note that the dimensions of the widget are provided in document-specific points, not pixels.

Constructors

PDFSignature()

Creates a new PDF signature object.

ProxySettings Type

A container for proxy server settings.

Syntax

SecureBlackboxProxySettings (declared in secureblackbox.h)

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

The following fields are available:

Fields

Address
char*

Default Value: ""

The IP address of the proxy server.

Authentication
int

Default Value: 0

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Password
char*

Default Value: ""

The password to authenticate to the proxy server.

Port
int

Default Value: 0

The port on the proxy server to connect to.

ProxyType
int

Default Value: 0

The type of the proxy server.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

RequestHeaders
char*

Default Value: ""

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
char*

Default Value: ""

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

ResponseHeaders
char*

Default Value: ""

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

UseIPv6
int

Default Value: FALSE

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

Username
char*

Default Value: ""

Specifies the username credential for proxy authentication.

Constructors

ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int

Default Value: 0

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

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
int

Default Value: 0

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

DNSQueryTimeout
int

Default Value: 0

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

DNSServers
char*

Default Value: ""

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

DNSTotalTimeout
int

Default Value: 0

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

IncomingSpeedLimit
int

Default Value: 0

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

LocalAddress
char*

Default Value: ""

The local network interface to bind the socket to.

LocalPort
int

Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int

Default Value: 0

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