PDFSigner Class

Properties   Methods   Events   Config Settings   Errors  

The PDFSigner class signs PDF documents digitally.

Syntax

PDFSigner

Remarks

PDFSigner can sign PDF documents in accordance with a selection of PDF and PAdES signature standards. PDFSigner signer = new PDFSigner(); // Set the PDF document that you want to sign signer.setInputFile("MyDocument.pdf"); // Set the path where you want the signed document to be saved signer.setOutputFile("Signed.pdf"); // The certificate which the document will be signed with signer.setSigningCertificate(new Certificate("Cert.pfx","password")); // The signature level signer.getNewSignature().setLevel(PDFSignature.paslBaselineT); signer.getNewSignature().setHashAlgorithm("SHA512"); // Hashing algorithm used for signing, default SHA256 signer.setTimestampServer("https://..."); // The address of the timestamping server signer.sign();

Standards and technologies supported

PDFSigner can create PDF signatures that match the following baseline standards:

  • Generic PDF signatures (ISO 32000)
  • PAdES: all profiles are supported (BES, EPES, T, LTV, B-B, B-T, and others) (ETSI EN 319 142-1 and others)
  • Signature and document timestamps using external TSAs.
  • All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).

Configuring the signature spec

Configuring PDFSigner to produce signatures of the right type is one of the most important questions you need to address. Normally the service or software you will be communicating your PDF documents to will provide you with the list of requirements that your signatures should match.

Typically, those will dictate the following key aspects of the signatures:

  • Level (BES, T, or LTV). This can be adjusted with the Level property (Note: when creating EPES signatures you need to provide the signature PolicyID and PolicyHash properties).
  • Timestamp requirement: provide the address of your online TSA service via the TimestampServer property.
  • When creating LTV signatures, tune up validation parameters via the RevocationCheck, OfflineMode, and IgnoreChainValidationErrors properties.
  • To create a document timestamp, sign your document first, and then sign the result again with Level set to pslDocumentTimestamp and TimestampServer pointing to the TSA URL.

Signing certificates

PDFSigner can use certificates residing on different media. Besides generic certificates stored in PFX or PEM files (A1), it can operate with non-exportable certificates residing on hardware media (A3) or in the cloud.

Non-exportable certificates can be accessed transparently via a Windows CSP or a PKCS#11 driver, if supplied by the certificate issuer. Proprietary interfaces can be plugged in with the external signing feature (see below).

You can use the CertificateManager and CertificateStorage classes to load the signing certificate. Assign the certificate to the SigningCertificate property, and optionally provide the remainder of its chain via the SigningChain property.

Note: If signing with a non-exportable key (such as residing on a hardware device or in the cloud), please make sure you keep the original CertificateStorage object open until the signing is completed. This is because the storage class provides a 'bridge' to the private key. If the storage is closed prematurely, this bridge is destroyed, and the private key can't be used.

You don't need to provide a signing certificate or chain when creating document timestamp signatures, since this type of signature is done with a TSA's certificate.

Widget adjustment

PDFSigner provides means to customize the look of the signature widget to be shown on the document page. Create your very own signatures in the form of your company's logo, a handwritten signature, or a wet seal.

Alternatively, you can choose not to associate any widget with your signature by setting Invisible to true.

Please check out this self-describing PDF document for good guidance on widget positioning, background styles, and text formatting.

Signing the document

Now that you have set up all signature, certificate, and widget properties, it is time to sign. You can provide the input document in one of the following forms: as a file (assign the path to the InputFile property), as a stream (assign to the InputStream property), or as a byte array (assign to InputBytes). Similarly, the output can be collected in one of the same forms, either by passing the destination path or stream via OutputFile and OutputStream respectively, or by reading the resulting document bytes from the OutputBytes property after the signing.

Having set up the input and output, call the class's Sign method. This will initiate the signing process. Depending on the settings, the signing may be as straightforward as calculating the document hash and signing it with the private key (e.g. in the PAdES-BES signing variant), or it may involve advanced chain validation routines (PAdES-LTV). During the latter, the class may contact a number of external revocation information sources (CRL and OCSP servers) to establish the validity of the signing certificate.

If a TSA server was provided via the TimestampServer property, the class will contact it too to timestamp the new signature.

During the signing, PDFSigner may fire events to let your code know of certain conditions. If the input document is encrypted but no decryption parameters were found in the Password and DecryptionCertificate properties, the class will fire the Encrypted event to tell your code that it needs decryption information to be able to continue with the signing. It may fire TLSCertValidate if one of the HTTP endpoints involved during the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate to be validated.

External signing and DCAuth

PDFSigner, like many other classes offered by the product, supports two methods of signing with external keys. These methods are fully independent of each other: you can choose the one that suits your usage scenario best.

Synchronous method: ExternalSign

This is a simpler method that basically lets you infiltrate into the heart of the signing routine by taking care of the hash signing operation. The class does the rest of the job (hash calculation, preparation of signature objects, CRL/OCSP retrieval).

To initiate this method, call SignExternal instead of Sign. When the hash is ready, it will be passed back to your code with the ExternalSign event. Your event handler needs to sign the hash with the private key and return the created signature back to the class - which will embed it into the document.

You don't need your signing certificate to contain an associated private key when using this method. The certificate itself (its public copy) may be needed though, as it is often included in the hash calculation.

This method is synchronous, meaning SignExternal provides you the results immediately upon its completion.

Asynchronous method: DCAuth

DCAuth is a SecureBlackbox know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way:

  • The signing party - such as PDFSigner - initiates the operation using a SignAsyncBegin call. This produces two outcomes: a pre-signed document (a document with a blank signature placeholder), and a request state (an object containing a hash that needs to be signed). At this point the PDFSigner instance can be released, and the process itself terminated (which may be useful when run as part of a web page).
  • The request state is passed to the private key holder party. The private key holder passes the request state to a DCAuth object, which parses the request state, extracts the hash, and signs it. The output of DCAuth processing is another object, a response state, which contains the signature. The private key holder then sends the response state back to the signing party.
  • The signing party re-creates the classes and passes the response state, together with the pre-signed version of the document, to the signer's SignAsyncEnd method. SignAsyncEnd extracts the signature from the response state and incorporates it into the pre-signed document.

This method is asynchronous in that sense that from the signing party's viewpoint, it splits the signing operation into the pre-signing and completion stages which can be performed independently from each other and in different execution contexts. This makes this method particularly helpful for use in web pages and other scenarios where the signing key is not available in real time.

Fine-grained chain validation setup

Chain validation is a sophisticated, multi-faceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to tune up your chain validation parameters so they fit them best. A summary of such parameters is given below.

  • RevocationCheck lets you choose between and/or prioritize revocation origins. OCSP sources are often preferred to CRL because of their real-time capability and the smaller size of validation tokens they produce.
  • OfflineMode is a master switch that stops the class from looking for any validation tokens online. If this property is switched on, the class will only use the KnownCertificates, TrustedCertificates, KnownCRLs, and KnownOCSPs collections to look for the missing validation material.
  • IgnoreChainValidationErrors makes the class ignore any major validation issues it encounters (such us an untrusted chain or missing CRL). This option is handy for debugging and for creating signatures in the environments where the signing certificate is not trusted.
  • KnownCertificates, KnownCRLs, and KnownOCSPs let you provide your own validation material. This may be useful when working in OfflineMode, where the signer has no access to the validation sources, or where the validation material has already been collected.
  • TrustedCertificates lets you provide a list of trust anchors, either as a complement to the system's or as an alternative to it.
  • BlockedCertificates lets you provide a list of blocked/distrusted certificates. Any CA certificate contained in it will be deemed untrusted/invalid.

The following parameters are not directly related to chain validation, but may have an implicit effect on it.

  • Proxy, SocketSettings, and TLSSettings let you tune up the connectivity and TLS options in accordance with local preferences.
  • TLSClientChain lets you provide the client certificate and its chain for TLS client authentication.
  • Subscribe to TLSCertValidate to validate any TLS certificates of the services involved in chain validation.

The results of the chain validation procedure, upon its completion, are published in the following properties:

  • ChainValidationResult contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined.
  • ChainValidationDetails provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate.
  • ValidationLog contains the detailed chain validation log. The log can often be very helpful in nailing down various validation issues.

Property List


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

AttachedFilesProvides details of all attached files found in the PDF document.
AutoValidateSignaturesSpecifies whether PDFSigner 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.
EmptyFieldIndexSpecifies the index of the empty signature field to sign.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
IgnoreChainValidationErrorsMakes the class tolerant to chain validation errors.
InputBytesUse this property to pass the input to class in byte array form.
InputFileThe PDF file to be signed or updated.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
NewSignatureProvides access to new signature properties.
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 and empty fields found in the PDF document.
SigningCertificateThe certificate to be used for signing.
SigningChainThe signing certificate chain.
SocketSettingsManages network connection settings.
TimestampsContains a collection of timestamps for the processed document.
TimestampServerThe address of the timestamping server.
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.
WidgetProvides access to signature widget properties.

Method List


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

AddWidgetCustomDataAdds a custom data to the signature widget.
AddWidgetTextAdds a text block to the signature widget.
AddWidgetTextExAdds a text block to the signature widget.
AttachBytesAdds an attachment to the PDF document.
AttachFileAdds an attachment to the PDF document.
AttachStreamAdds an attachment to the PDF document.
CloseCloses an opened document.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
ExtractAsyncDataExtracts user data from the DC signing service response.
GetAttachedBytesSaves a PDF attachment to a byte array.
GetAttachedFileSaves a PDF attachment to a file.
GetAttachedStreamSaves a PDF attachment to a stream.
OpenOpens a document for signing or updating.
ResetResets the class settings.
RevalidateRevalidates a signature in accordance with current settings.
SelectInfoSelect signature information for a specific entity.
SignSigns a PDF document.
SignAsyncBeginInitiates the asynchronous signing operation.
SignAsyncEndCompletes the asynchronous signing operation.
SignExternalSigns the document using an external signing facility.
UpdateUpdates a signature.

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.
ExternalDecryptHandles remote or external decryption.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
NotificationThis event notifies the application about an underlying control flow event.
PreRenderWidgetFires when a signature widget is ready to be written to the document.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedMarks the completion of the signature validation routine.
TimestampFoundSignifies the start of a timestamp validation routine.
TimestampRequestFires when the class is ready to request a timestamp from an external TSA.
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.

AddOutputIntentsSpecifies output intents to be added to the document.
AlternateNameTBD.
AssemblyOptionsSpecifies the assembly options.
AsyncDocumentIDSpecifies the document ID for SignAsyncEnd() call.
AutoCollectRevocationInfoWhether revocation info should be collected automatically.
AutoReshapeArabicSymbolsSpecifies whether to auto-reshape Arabic symbols.
AutoReverseRTLTextSpecifies whether to auto reverse RTL text.
AutoRotateSignatureSpecifies whether to auto-rotate the signature widget.
BackgroundImageBitsPerComponentSpecifies the number of bits per color class.
BackgroundImageColorSpaceSpecifies the background image color space.
BackgroundImageInterpolateSpecifies the background image interpolation flag.
BackgroundMaskImageBitsPerComponentTBD.
BackgroundMaskImageColorSpaceTBD.
BackgroundMaskImageInterpolateTBD.
BackgroundPositionTBD.
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.
CollectRevInfoForTimestampsWhether revocation info for timestamps should be collected automatically.
CommitmentsTBD.
ConfigPreferLegacyLevelsIndicates whether legacy signature levels should be preferred.
CustomSignedAttributesTBD.
CustomTextCountThe number of custom text blocks on the signature widget.
CustomTextFontResourceName[Index]The font resource name to use for the custom text block.
CustomTextFontSizeX[Index]The horizontal font size scale.
CustomTextFontSizeY[Index]The vertical font size scale.
CustomTextText[Index]A text to show on a custom signature widget text block.
CustomTextX[Index]The horizontal offset of the text block.
CustomTextY[Index]The vertical offset of the text block.
CustomTrustedListsSpecifies the custom TrustedLists.
CustomTSLsSpecifies the custom TrustedLists.
CustomUnsignedAttributesTBD.
DateFontSizeThe font size of the date/time text on the signature widget.
DeepValidationWhether a complete validation should be performed.
DislikeOpenEndedOCSPsTells the class to discourage OCSP responses without an explicit NextUpdate parameter.
DocumentVersionThe document version from the PDF document header.
DTSAccuracyTBD.
DTSSerialNumberTBD.
DTSTimeTBD.
DTSTSANameTBD.
EmptyFullFieldNameSpecifies the full name of the empty signature field to sign.
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.
ExtensionIdentifierModeSpecifies the extension identifier mode.
ExtraSpaceAllows for the allocation of extra zero character space in the document behind the signature.
FontPathsSpecifies font search paths.
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.
IgnoreTimestampFailureWhether to ignore timestamping failures during signing.
ImplicitlyTrustSelfSignedCertificatesWhether to trust self-signed certificates.
IncludeKnownRevInfoToSignatureWhether to include custom revocation info into the signature.
IncludeKnownRevocationInfoToSignatureWhether to include custom revocation info into the signature.
IncludeRevocationInfoWhether to include custom revocation info into the signature.
IncludeRevocationInfoToAdbeAttributeWhether to save revocation info in PDF-compliant form.
LastSignatureWidgetSpecifies that it is the last signature widget to be added.
LockedTBD.
LockedContentsTBD.
MappingNameTBD.
MDPHashAlgorithmSpecifies the MDP hash algorithm.
NewCustomSignedAttributesTBD.
NewCustomUnsignedAttributesTBD.
PAdESOptionsSpecifies the PAdES options.
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.
PredefinedSignatureSizeUser-defined size of the signature.
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.
SectionTextFontSizeThe font size of general text on the signature widget.
SectionTitleFontSizeThe font size of the section title on the signature widget.
SignatureOptionsSpecifies the signature options.
SignatureSizeEstimationStrategyWhich mechanism to use to estimate the size of a PAdES signature.
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.
TextObjEncodingThe encoding to apply to string objects stored with the signature.
TimestampResponseA base16-encoded timestamp response received from a TSA.
TitleFontSizeThe font size of the main title on the signature widget.
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.
TransparentColorTBD.
TransparentColorDeltaTBD.
TransparentColorXTBD.
TransparentColorYTBD.
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.
UpdateKindAdjusts the scope of modifications that are made to the signature with the Update method.
UseDefaultTrustedListsEnables or disables the use of the default TrustedLists.
UseDefaultTSLsEnables or disables the use of the default TrustedLists.
UseLegacyVisualStyleSpecifies whether to use the legacy signature visual style.
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.

AttachedFiles Property (PDFSigner Class)

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

Syntax

int secureblackbox_pdfsigner_getattachedfilecount(void* lpObj);
char* secureblackbox_pdfsigner_getattachedfilescontentsubtype(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfsigner_getattachedfilescontenttype(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfsigner_getattachedfilescreationdate(void* lpObj, int attachedfileindex);
int secureblackbox_pdfsigner_getattachedfilesdata(void* lpObj, int attachedfileindex, char** lpAttachedFilesData, int* lenAttachedFilesData);
char* secureblackbox_pdfsigner_getattachedfilesdescription(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfsigner_getattachedfilesfilename(void* lpObj, int attachedfileindex);
int64 secureblackbox_pdfsigner_getattachedfileshandle(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfsigner_getattachedfilesid(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfsigner_getattachedfilesmodificationdate(void* lpObj, int attachedfileindex);
char* secureblackbox_pdfsigner_getattachedfilesreaddate(void* lpObj, int attachedfileindex);
int64 secureblackbox_pdfsigner_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 (PDFSigner Class)

Specifies whether PDFSigner 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_pdfsigner_getautovalidatesignatures(void* lpObj);
int secureblackbox_pdfsigner_setautovalidatesignatures(void* lpObj, int bAutoValidateSignatures);
bool GetAutoValidateSignatures();
int SetAutoValidateSignatures(bool bAutoValidateSignatures);

Default Value

FALSE

Remarks

This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the Revalidate method.

Data Type

Boolean

BlockedCertificates Property (PDFSigner Class)

The certificates that must be rejected as trust anchors.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates();
int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfsigner_getblockedcertcount(void* lpObj);
int secureblackbox_pdfsigner_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_pdfsigner_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_pdfsigner_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

A collection of certificates included in the electronic signature.

Syntax

int secureblackbox_pdfsigner_getcertcount(void* lpObj);
int secureblackbox_pdfsigner_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
int secureblackbox_pdfsigner_getcertca(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
int secureblackbox_pdfsigner_getcertcerttype(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertcrldistributionpoints(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertcurve(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertfingerprint(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertfriendlyname(void* lpObj, int certindex);
int64 secureblackbox_pdfsigner_getcerthandle(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcerthashalgorithm(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertissuer(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertissuerrdn(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertkeyalgorithm(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertkeybits(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertkeyfingerprint(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertkeyusage(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertkeyvalid(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertocsplocations(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertocspnocheck(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertorigin(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertpolicyids(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertprivatekeybytes(void* lpObj, int certindex, char** lpCertPrivateKeyBytes, int* lenCertPrivateKeyBytes);
int secureblackbox_pdfsigner_getcertprivatekeyexists(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertprivatekeyextractable(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
int secureblackbox_pdfsigner_getcertqualified(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertqualifiedstatements(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertqualifiers(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertselfsigned(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
char* secureblackbox_pdfsigner_getcertsigalgorithm(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertsource(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertsubject(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertsubjectalternativename(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
char* secureblackbox_pdfsigner_getcertsubjectrdn(void* lpObj, int certindex);
int secureblackbox_pdfsigner_getcertvalid(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_getcertvalidfrom(void* lpObj, int certindex);
char* secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getchecktrustedlists(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

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

Syntax

int secureblackbox_pdfsigner_getcrlcount(void* lpObj);
int secureblackbox_pdfsigner_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);
int secureblackbox_pdfsigner_getcrlcakeyid(void* lpObj, int crlindex, char** lpCRLCAKeyID, int* lenCRLCAKeyID);
int secureblackbox_pdfsigner_getcrlentrycount(void* lpObj, int crlindex);
int64 secureblackbox_pdfsigner_getcrlhandle(void* lpObj, int crlindex);
char* secureblackbox_pdfsigner_getcrlissuer(void* lpObj, int crlindex);
char* secureblackbox_pdfsigner_getcrlissuerrdn(void* lpObj, int crlindex);
char* secureblackbox_pdfsigner_getcrllocation(void* lpObj, int crlindex);
char* secureblackbox_pdfsigner_getcrlnextupdate(void* lpObj, int crlindex);
char* secureblackbox_pdfsigner_getcrlsigalgorithm(void* lpObj, int crlindex);
int secureblackbox_pdfsigner_getcrlsource(void* lpObj, int crlindex);
int secureblackbox_pdfsigner_getcrltbs(void* lpObj, int crlindex, char** lpCRLTBS, int* lenCRLTBS);
char* secureblackbox_pdfsigner_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 (PDFSigner Class)

A decryption certificate.

Syntax

SecureBlackboxCertificate* GetDecryptionCertificate();
int SetDecryptionCertificate(SecureBlackboxCertificate* val);
int secureblackbox_pdfsigner_getdecryptioncertificatebytes(void* lpObj, char** lpDecryptionCertificateBytes, int* lenDecryptionCertificateBytes);
int64 secureblackbox_pdfsigner_getdecryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

Contains information about the document properties.

Syntax

SecureBlackboxPDFDocumentInfo* GetDocumentInfo();

char* secureblackbox_pdfsigner_getdocumentinfoencryptionalgorithm(void* lpObj);
int secureblackbox_pdfsigner_getdocumentinfoencryptiontype(void* lpObj);
int secureblackbox_pdfsigner_getdocumentinfometadataencrypted(void* lpObj);
int secureblackbox_pdfsigner_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

EmptyFieldIndex Property (PDFSigner Class)

Specifies the index of the empty signature field to sign.

Syntax

ANSI (Cross Platform)
int GetEmptyFieldIndex();
int SetEmptyFieldIndex(int iEmptyFieldIndex); Unicode (Windows) INT GetEmptyFieldIndex();
INT SetEmptyFieldIndex(INT iEmptyFieldIndex);
int secureblackbox_pdfsigner_getemptyfieldindex(void* lpObj);
int secureblackbox_pdfsigner_setemptyfieldindex(void* lpObj, int iEmptyFieldIndex);
int GetEmptyFieldIndex();
int SetEmptyFieldIndex(int iEmptyFieldIndex);

Default Value

-1

Remarks

Use this property to specify the empty form field that should be signed. If the default value of -1 is assigned to this property, a new signature field will be created.

Data Type

Integer

ExternalCrypto Property (PDFSigner Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_pdfsigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_pdfsigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_pdfsigner_getexternalcryptodata(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_pdfsigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_pdfsigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_pdfsigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_pdfsigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_pdfsigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_pdfsigner_getexternalcryptomode(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_pdfsigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (PDFSigner Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_pdfsigner_getfipsmode(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

The PDF file to be signed or updated.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_pdfsigner_getinputfile(void* lpObj);
int secureblackbox_pdfsigner_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Use this property to provide a path to the PDF document to be signed or updated, or to the pre-signed copy expected by SignAsyncEnd.

Data Type

String

KnownCertificates Property (PDFSigner Class)

Additional certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfsigner_getknowncertcount(void* lpObj);
int secureblackbox_pdfsigner_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_pdfsigner_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_pdfsigner_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

Additional CRLs for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs();
int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_pdfsigner_getknowncrlcount(void* lpObj);
int secureblackbox_pdfsigner_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_pdfsigner_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_pdfsigner_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

Additional OCSP responses for chain validation.

Syntax

int secureblackbox_pdfsigner_getknownocspcount(void* lpObj);
int secureblackbox_pdfsigner_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_pdfsigner_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_pdfsigner_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_pdfsigner_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

NewSignature Property (PDFSigner Class)

Provides access to new signature properties.

Syntax

SecureBlackboxPDFSignature* GetNewSignature();

int secureblackbox_pdfsigner_getnewsigallowedchanges(void* lpObj);
int secureblackbox_pdfsigner_setnewsigallowedchanges(void* lpObj, int iNewSigAllowedChanges);
char* secureblackbox_pdfsigner_getnewsigauthorname(void* lpObj);
int secureblackbox_pdfsigner_setnewsigauthorname(void* lpObj, const char* lpszNewSigAuthorName);
int secureblackbox_pdfsigner_getnewsigcertification(void* lpObj);
int secureblackbox_pdfsigner_setnewsigcertification(void* lpObj, int bNewSigCertification);
int secureblackbox_pdfsigner_getnewsigchainvalidationdetails(void* lpObj);
int secureblackbox_pdfsigner_getnewsigchainvalidationresult(void* lpObj);
char* secureblackbox_pdfsigner_getnewsigclaimedsigningtime(void* lpObj);
int secureblackbox_pdfsigner_setnewsigclaimedsigningtime(void* lpObj, const char* lpszNewSigClaimedSigningTime);
int secureblackbox_pdfsigner_getnewsigcompatibilityerrors(void* lpObj);
char* secureblackbox_pdfsigner_getnewsigcontactinfo(void* lpObj);
int secureblackbox_pdfsigner_setnewsigcontactinfo(void* lpObj, const char* lpszNewSigContactInfo);
int secureblackbox_pdfsigner_getnewsigcontainslongterminfo(void* lpObj);
int secureblackbox_pdfsigner_getnewsigcoverageendsat(void* lpObj);
int secureblackbox_pdfsigner_getnewsigcustomdata(void* lpObj, char** lpNewSigCustomData, int* lenNewSigCustomData);
int secureblackbox_pdfsigner_setnewsigcustomdata(void* lpObj, const char* lpNewSigCustomData, int lenNewSigCustomData);
int secureblackbox_pdfsigner_getnewsigemptyfield(void* lpObj);
int secureblackbox_pdfsigner_setnewsigemptyfield(void* lpObj, int bNewSigEmptyField);
char* secureblackbox_pdfsigner_getnewsigentitylabel(void* lpObj);
char* secureblackbox_pdfsigner_getnewsigfiltername(void* lpObj);
int secureblackbox_pdfsigner_setnewsigfiltername(void* lpObj, const char* lpszNewSigFilterName);
char* secureblackbox_pdfsigner_getnewsigfullsignaturename(void* lpObj);
int64 secureblackbox_pdfsigner_getnewsighandle(void* lpObj);
int secureblackbox_pdfsigner_setnewsighandle(void* lpObj, int64 lNewSigHandle);
char* secureblackbox_pdfsigner_getnewsighashalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setnewsighashalgorithm(void* lpObj, const char* lpszNewSigHashAlgorithm);
int secureblackbox_pdfsigner_getnewsigheight(void* lpObj);
int secureblackbox_pdfsigner_setnewsigheight(void* lpObj, int iNewSigHeight);
char* secureblackbox_pdfsigner_getnewsigissuerrdn(void* lpObj);
int secureblackbox_pdfsigner_getnewsiglevel(void* lpObj);
int secureblackbox_pdfsigner_setnewsiglevel(void* lpObj, int iNewSigLevel);
char* secureblackbox_pdfsigner_getnewsiglocation(void* lpObj);
int secureblackbox_pdfsigner_setnewsiglocation(void* lpObj, const char* lpszNewSigLocation);
int secureblackbox_pdfsigner_getnewsigoffsetx(void* lpObj);
int secureblackbox_pdfsigner_setnewsigoffsetx(void* lpObj, int iNewSigOffsetX);
int secureblackbox_pdfsigner_getnewsigoffsety(void* lpObj);
int secureblackbox_pdfsigner_setnewsigoffsety(void* lpObj, int iNewSigOffsetY);
int secureblackbox_pdfsigner_getnewsigpage(void* lpObj);
char* secureblackbox_pdfsigner_getnewsigpolicyhash(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyhash(void* lpObj, const char* lpszNewSigPolicyHash);
char* secureblackbox_pdfsigner_getnewsigpolicyhashalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyhashalgorithm(void* lpObj, const char* lpszNewSigPolicyHashAlgorithm);
char* secureblackbox_pdfsigner_getnewsigpolicyid(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyid(void* lpObj, const char* lpszNewSigPolicyID);
char* secureblackbox_pdfsigner_getnewsigpolicyuri(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyuri(void* lpObj, const char* lpszNewSigPolicyURI);
char* secureblackbox_pdfsigner_getnewsigreason(void* lpObj);
int secureblackbox_pdfsigner_setnewsigreason(void* lpObj, const char* lpszNewSigReason);
int secureblackbox_pdfsigner_getnewsigserialnumber(void* lpObj, char** lpNewSigSerialNumber, int* lenNewSigSerialNumber);
int secureblackbox_pdfsigner_getnewsigsignaturebytes(void* lpObj, char** lpNewSigSignatureBytes, int* lenNewSigSignatureBytes);
char* secureblackbox_pdfsigner_getnewsigsignaturename(void* lpObj);
int secureblackbox_pdfsigner_setnewsigsignaturename(void* lpObj, const char* lpszNewSigSignatureName);
int secureblackbox_pdfsigner_getnewsigsignaturetype(void* lpObj);
int secureblackbox_pdfsigner_setnewsigsignaturetype(void* lpObj, int iNewSigSignatureType);
int secureblackbox_pdfsigner_getnewsigsignaturevalidationresult(void* lpObj);
int secureblackbox_pdfsigner_getnewsigsubjectkeyid(void* lpObj, char** lpNewSigSubjectKeyID, int* lenNewSigSubjectKeyID);
char* secureblackbox_pdfsigner_getnewsigsubjectrdn(void* lpObj);
int secureblackbox_pdfsigner_getnewsigtimestamped(void* lpObj);
char* secureblackbox_pdfsigner_getnewsigvalidatedsigningtime(void* lpObj);
char* secureblackbox_pdfsigner_getnewsigvalidationlog(void* lpObj);
int secureblackbox_pdfsigner_getnewsigwidth(void* lpObj);
int secureblackbox_pdfsigner_setnewsigwidth(void* lpObj, int iNewSigWidth);
int GetNewSigAllowedChanges();
int SetNewSigAllowedChanges(int iNewSigAllowedChanges); QString GetNewSigAuthorName();
int SetNewSigAuthorName(QString qsNewSigAuthorName); bool GetNewSigCertification();
int SetNewSigCertification(bool bNewSigCertification); int GetNewSigChainValidationDetails(); int GetNewSigChainValidationResult(); QString GetNewSigClaimedSigningTime();
int SetNewSigClaimedSigningTime(QString qsNewSigClaimedSigningTime); int GetNewSigCompatibilityErrors(); QString GetNewSigContactInfo();
int SetNewSigContactInfo(QString qsNewSigContactInfo); bool GetNewSigContainsLongTermInfo(); int GetNewSigCoverageEndsAt(); QByteArray GetNewSigCustomData();
int SetNewSigCustomData(QByteArray qbaNewSigCustomData); bool GetNewSigEmptyField();
int SetNewSigEmptyField(bool bNewSigEmptyField); QString GetNewSigEntityLabel(); QString GetNewSigFilterName();
int SetNewSigFilterName(QString qsNewSigFilterName); QString GetNewSigFullSignatureName(); qint64 GetNewSigHandle();
int SetNewSigHandle(qint64 lNewSigHandle); QString GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(QString qsNewSigHashAlgorithm); int GetNewSigHeight();
int SetNewSigHeight(int iNewSigHeight); QString GetNewSigIssuerRDN(); int GetNewSigLevel();
int SetNewSigLevel(int iNewSigLevel); QString GetNewSigLocation();
int SetNewSigLocation(QString qsNewSigLocation); int GetNewSigOffsetX();
int SetNewSigOffsetX(int iNewSigOffsetX); int GetNewSigOffsetY();
int SetNewSigOffsetY(int iNewSigOffsetY); int GetNewSigPage(); QString GetNewSigPolicyHash();
int SetNewSigPolicyHash(QString qsNewSigPolicyHash); QString GetNewSigPolicyHashAlgorithm();
int SetNewSigPolicyHashAlgorithm(QString qsNewSigPolicyHashAlgorithm); QString GetNewSigPolicyID();
int SetNewSigPolicyID(QString qsNewSigPolicyID); QString GetNewSigPolicyURI();
int SetNewSigPolicyURI(QString qsNewSigPolicyURI); QString GetNewSigReason();
int SetNewSigReason(QString qsNewSigReason); QByteArray GetNewSigSerialNumber(); QByteArray GetNewSigSignatureBytes(); QString GetNewSigSignatureName();
int SetNewSigSignatureName(QString qsNewSigSignatureName); int GetNewSigSignatureType();
int SetNewSigSignatureType(int iNewSigSignatureType); int GetNewSigSignatureValidationResult(); QByteArray GetNewSigSubjectKeyID(); QString GetNewSigSubjectRDN(); bool GetNewSigTimestamped(); QString GetNewSigValidatedSigningTime(); QString GetNewSigValidationLog(); int GetNewSigWidth();
int SetNewSigWidth(int iNewSigWidth);

Remarks

Use this property to tune-up signature properties. Use the Widget object to tune up visual parameters of the signature widget.

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

Data Type

SecureBlackboxPDFSignature

OCSPs Property (PDFSigner Class)

A collection of OCSP responses embedded into the signature.

Syntax

int secureblackbox_pdfsigner_getocspcount(void* lpObj);
int secureblackbox_pdfsigner_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);
int secureblackbox_pdfsigner_getocspentrycount(void* lpObj, int ocspindex);
int64 secureblackbox_pdfsigner_getocsphandle(void* lpObj, int ocspindex);
char* secureblackbox_pdfsigner_getocspissuer(void* lpObj, int ocspindex);
char* secureblackbox_pdfsigner_getocspissuerrdn(void* lpObj, int ocspindex);
char* secureblackbox_pdfsigner_getocsplocation(void* lpObj, int ocspindex);
char* secureblackbox_pdfsigner_getocspproducedat(void* lpObj, int ocspindex);
char* secureblackbox_pdfsigner_getocspsigalgorithm(void* lpObj, int ocspindex);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getofflinemode(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_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 (PDFSigner 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_pdfsigner_getoutputfile(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

A list of pages contained in the document.

Syntax

int secureblackbox_pdfsigner_getpagecount(void* lpObj);
int secureblackbox_pdfsigner_getpagecropllx(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagecroplly(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagecropurx(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagecropury(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpageheight(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagemediallx(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagemedially(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagemediaurx(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagemediaury(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_getpagerotate(void* lpObj, int pageindex);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getpassword(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getprofile(void* lpObj);
int secureblackbox_pdfsigner_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.

Supported profiles:

"BR.AD_RB_v1_0"Brazilian signature with Basic Reference (AD-RB) version 1.0
"BR.AD_RB_v1_1"Brazilian signature with Basic Reference (AD-RB) version 1.1
"BR.AD_RT_v1_0"Brazilian signature with Time Reference (AD-RT) version 1.0
"BR.AD_RT_v1_1"Brazilian signature with Time Reference (AD-RT) version 1.1
"BR.AD_RC_v1_1"Brazilian signature with Complete References (AD-RC) version 1.1
"BR.AD_RC_v1_2"Brazilian signature with Complete References (AD-RC) version 1.2
"BR.AD_RA_v1_1"Brazilian signature with References for Archiving (AD-RA) version 1.1
"BR.AD_RA_v1_2"Brazilian signature with References for Archiving (AD-RA) version 1.2

Data Type

String

Proxy Property (PDFSigner Class)

The proxy server settings.

Syntax

char* secureblackbox_pdfsigner_getproxyaddress(void* lpObj);
int secureblackbox_pdfsigner_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_pdfsigner_getproxyauthentication(void* lpObj);
int secureblackbox_pdfsigner_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_pdfsigner_getproxypassword(void* lpObj);
int secureblackbox_pdfsigner_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_pdfsigner_getproxyport(void* lpObj);
int secureblackbox_pdfsigner_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_pdfsigner_getproxyproxytype(void* lpObj);
int secureblackbox_pdfsigner_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_pdfsigner_getproxyrequestheaders(void* lpObj);
int secureblackbox_pdfsigner_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_pdfsigner_getproxyresponsebody(void* lpObj);
int secureblackbox_pdfsigner_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_pdfsigner_getproxyresponseheaders(void* lpObj);
int secureblackbox_pdfsigner_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_pdfsigner_getproxyuseipv6(void* lpObj);
int secureblackbox_pdfsigner_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_pdfsigner_getproxyusername(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getrevocationcheck(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

Provides details of all signatures and empty fields found in the PDF document.

Syntax

int secureblackbox_pdfsigner_getsignaturecount(void* lpObj);
int secureblackbox_pdfsigner_getsignatureallowedchanges(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignatureauthorname(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturecertification(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturechainvalidationdetails(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturechainvalidationresult(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignatureclaimedsigningtime(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturecompatibilityerrors(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturecontactinfo(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturecontainslongterminfo(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturecoverageendsat(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturecustomdata(void* lpObj, int signatureindex, char** lpSignatureCustomData, int* lenSignatureCustomData);
int secureblackbox_pdfsigner_getsignatureemptyfield(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignatureentitylabel(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturefiltername(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturefullsignaturename(void* lpObj, int signatureindex);
int64 secureblackbox_pdfsigner_getsignaturehandle(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturehashalgorithm(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignatureheight(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignatureissuerrdn(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturelevel(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturelocation(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignatureoffsetx(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignatureoffsety(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturepage(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturepolicyhash(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturepolicyhashalgorithm(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturepolicyid(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturepolicyuri(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturereason(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignatureserialnumber(void* lpObj, int signatureindex, char** lpSignatureSerialNumber, int* lenSignatureSerialNumber);
int secureblackbox_pdfsigner_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);
char* secureblackbox_pdfsigner_getsignaturesignaturename(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturesignaturetype(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturesubjectkeyid(void* lpObj, int signatureindex, char** lpSignatureSubjectKeyID, int* lenSignatureSubjectKeyID);
char* secureblackbox_pdfsigner_getsignaturesubjectrdn(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_getsignaturetimestamped(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturevalidatedsigningtime(void* lpObj, int signatureindex);
char* secureblackbox_pdfsigner_getsignaturevalidationlog(void* lpObj, int signatureindex);
int secureblackbox_pdfsigner_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

Use this property to get the details of all the signatures and empty signature fields identified in the document.

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

Data Type

SecureBlackboxPDFSignature

SigningCertificate Property (PDFSigner Class)

The certificate to be used for signing.

Syntax

SecureBlackboxCertificate* GetSigningCertificate();
int SetSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_pdfsigner_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int64 secureblackbox_pdfsigner_getsigningcerthandle(void* lpObj);
int secureblackbox_pdfsigner_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);
QByteArray GetSigningCertBytes();

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

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SigningChain Property (PDFSigner Class)

The signing certificate chain.

Syntax

int secureblackbox_pdfsigner_getsigningchaincount(void* lpObj);
int secureblackbox_pdfsigner_setsigningchaincount(void* lpObj, int iSigningChainCount);
int secureblackbox_pdfsigner_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);
int64 secureblackbox_pdfsigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_pdfsigner_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount); QByteArray GetSigningChainBytes(int iSigningChainIndex); qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SocketSettings Property (PDFSigner Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_pdfsigner_getsocketdnsmode(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_pdfsigner_getsocketdnsport(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_pdfsigner_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_pdfsigner_getsocketdnsservers(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_pdfsigner_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_pdfsigner_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_pdfsigner_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_pdfsigner_getsocketlocaladdress(void* lpObj);
int secureblackbox_pdfsigner_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_pdfsigner_getsocketlocalport(void* lpObj);
int secureblackbox_pdfsigner_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_pdfsigner_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_pdfsigner_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_pdfsigner_getsockettimeout(void* lpObj);
int secureblackbox_pdfsigner_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_pdfsigner_getsocketuseipv6(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

Contains a collection of timestamps for the processed document.

Syntax

int secureblackbox_pdfsigner_gettimestampcount(void* lpObj);
int64 secureblackbox_pdfsigner_gettimestampaccuracy(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_gettimestampbytes(void* lpObj, int timestampindex, char** lpTimestampBytes, int* lenTimestampBytes);
int secureblackbox_pdfsigner_gettimestampcertificateindex(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_gettimestampchainvalidationdetails(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_gettimestampchainvalidationresult(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_gettimestampcontainslongterminfo(void* lpObj, int timestampindex);
char* secureblackbox_pdfsigner_gettimestampentitylabel(void* lpObj, int timestampindex);
char* secureblackbox_pdfsigner_gettimestamphashalgorithm(void* lpObj, int timestampindex);
char* secureblackbox_pdfsigner_gettimestampparententity(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_gettimestampserialnumber(void* lpObj, int timestampindex, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);
char* secureblackbox_pdfsigner_gettimestamptime(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_gettimestamptimestamptype(void* lpObj, int timestampindex);
char* secureblackbox_pdfsigner_gettimestamptsaname(void* lpObj, int timestampindex);
char* secureblackbox_pdfsigner_gettimestampvalidationlog(void* lpObj, int timestampindex);
int secureblackbox_pdfsigner_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

TimestampServer Property (PDFSigner Class)

The address of the timestamping server.

Syntax

ANSI (Cross Platform)
char* GetTimestampServer();
int SetTimestampServer(const char* lpszTimestampServer); Unicode (Windows) LPWSTR GetTimestampServer();
INT SetTimestampServer(LPCWSTR lpszTimestampServer);
char* secureblackbox_pdfsigner_gettimestampserver(void* lpObj);
int secureblackbox_pdfsigner_settimestampserver(void* lpObj, const char* lpszTimestampServer);
QString GetTimestampServer();
int SetTimestampServer(QString qsTimestampServer);

Default Value

""

Remarks

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

Data Type

String

TLSClientChain Property (PDFSigner Class)

The TLS client certificate chain.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain();
int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfsigner_gettlsclientcertcount(void* lpObj);
int secureblackbox_pdfsigner_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_pdfsigner_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_pdfsigner_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

The TLS server's certificate chain.

Syntax

int secureblackbox_pdfsigner_gettlsservercertcount(void* lpObj);
int secureblackbox_pdfsigner_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_pdfsigner_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_pdfsigner_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfsigner_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfsigner_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfsigner_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_pdfsigner_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_pdfsigner_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_pdfsigner_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 (PDFSigner Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_pdfsigner_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_pdfsigner_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_pdfsigner_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_pdfsigner_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_pdfsigner_gettlsciphersuites(void* lpObj);
int secureblackbox_pdfsigner_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_pdfsigner_gettlsclientauth(void* lpObj);
int secureblackbox_pdfsigner_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_pdfsigner_gettlseccurves(void* lpObj);
int secureblackbox_pdfsigner_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_pdfsigner_gettlsextensions(void* lpObj);
int secureblackbox_pdfsigner_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_pdfsigner_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_pdfsigner_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_pdfsigner_gettlspresharedidentity(void* lpObj);
int secureblackbox_pdfsigner_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_pdfsigner_gettlspresharedkey(void* lpObj);
int secureblackbox_pdfsigner_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_pdfsigner_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_pdfsigner_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_pdfsigner_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_pdfsigner_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_pdfsigner_gettlsrevocationcheck(void* lpObj);
int secureblackbox_pdfsigner_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_pdfsigner_gettlsssloptions(void* lpObj);
int secureblackbox_pdfsigner_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_pdfsigner_gettlstlsmode(void* lpObj);
int secureblackbox_pdfsigner_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_pdfsigner_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_pdfsigner_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_pdfsigner_gettlsusesessionresumption(void* lpObj);
int secureblackbox_pdfsigner_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_pdfsigner_gettlsversions(void* lpObj);
int secureblackbox_pdfsigner_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 (PDFSigner Class)

A list of trusted certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates();
int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_pdfsigner_gettrustedcertcount(void* lpObj);
int secureblackbox_pdfsigner_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_pdfsigner_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_pdfsigner_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_getvalidationmoment(void* lpObj);
int secureblackbox_pdfsigner_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

Widget Property (PDFSigner Class)

Provides access to signature widget properties.

Syntax

SecureBlackboxPDFWidget* GetWidget();

char* secureblackbox_pdfsigner_getwidgetalgorithmcaption(void* lpObj);
int secureblackbox_pdfsigner_setwidgetalgorithmcaption(void* lpObj, const char* lpszWidgetAlgorithmCaption);
char* secureblackbox_pdfsigner_getwidgetalgorithminfo(void* lpObj);
int secureblackbox_pdfsigner_setwidgetalgorithminfo(void* lpObj, const char* lpszWidgetAlgorithmInfo);
int secureblackbox_pdfsigner_getwidgetbackgrounddata(void* lpObj, char** lpWidgetBackgroundData, int* lenWidgetBackgroundData);
int secureblackbox_pdfsigner_setwidgetbackgrounddata(void* lpObj, const char* lpWidgetBackgroundData, int lenWidgetBackgroundData);
char* secureblackbox_pdfsigner_getwidgetbackgroundheight(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundheight(void* lpObj, const char* lpszWidgetBackgroundHeight);
int secureblackbox_pdfsigner_getwidgetbackgroundimageheight(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundimageheight(void* lpObj, int iWidgetBackgroundImageHeight);
int secureblackbox_pdfsigner_getwidgetbackgroundimagetype(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundimagetype(void* lpObj, int iWidgetBackgroundImageType);
int secureblackbox_pdfsigner_getwidgetbackgroundimagewidth(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundimagewidth(void* lpObj, int iWidgetBackgroundImageWidth);
int secureblackbox_pdfsigner_getwidgetbackgroundmask(void* lpObj, char** lpWidgetBackgroundMask, int* lenWidgetBackgroundMask);
int secureblackbox_pdfsigner_setwidgetbackgroundmask(void* lpObj, const char* lpWidgetBackgroundMask, int lenWidgetBackgroundMask);
char* secureblackbox_pdfsigner_getwidgetbackgroundposition(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundposition(void* lpObj, const char* lpszWidgetBackgroundPosition);
int secureblackbox_pdfsigner_getwidgetbackgroundstyle(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundstyle(void* lpObj, int iWidgetBackgroundStyle);
char* secureblackbox_pdfsigner_getwidgetbackgroundwidth(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundwidth(void* lpObj, const char* lpszWidgetBackgroundWidth);
int secureblackbox_pdfsigner_getwidgetcompresswidgetdata(void* lpObj);
int secureblackbox_pdfsigner_setwidgetcompresswidgetdata(void* lpObj, int bWidgetCompressWidgetData);
int secureblackbox_pdfsigner_getwidgetcustomappearance(void* lpObj, char** lpWidgetCustomAppearance, int* lenWidgetCustomAppearance);
int secureblackbox_pdfsigner_setwidgetcustomappearance(void* lpObj, const char* lpWidgetCustomAppearance, int lenWidgetCustomAppearance);
char* secureblackbox_pdfsigner_getwidgetcustombackgroundcontentstream(void* lpObj);
int secureblackbox_pdfsigner_setwidgetcustombackgroundcontentstream(void* lpObj, const char* lpszWidgetCustomBackgroundContentStream);
char* secureblackbox_pdfsigner_getwidgetcustomvisualstatusmatrix(void* lpObj);
int secureblackbox_pdfsigner_setwidgetcustomvisualstatusmatrix(void* lpObj, const char* lpszWidgetCustomVisualStatusMatrix);
char* secureblackbox_pdfsigner_getwidgetdateformat(void* lpObj);
int secureblackbox_pdfsigner_setwidgetdateformat(void* lpObj, const char* lpszWidgetDateFormat);
char* secureblackbox_pdfsigner_getwidgetfontname(void* lpObj);
int secureblackbox_pdfsigner_setwidgetfontname(void* lpObj, const char* lpszWidgetFontName);
int64 secureblackbox_pdfsigner_getwidgethandle(void* lpObj);
int secureblackbox_pdfsigner_setwidgethandle(void* lpObj, int64 lWidgetHandle);
char* secureblackbox_pdfsigner_getwidgetheader(void* lpObj);
int secureblackbox_pdfsigner_setwidgetheader(void* lpObj, const char* lpszWidgetHeader);
int secureblackbox_pdfsigner_getwidgethidedefaulttext(void* lpObj);
int secureblackbox_pdfsigner_setwidgethidedefaulttext(void* lpObj, int bWidgetHideDefaultText);
int secureblackbox_pdfsigner_getwidgetignoreexistingappearance(void* lpObj);
int secureblackbox_pdfsigner_setwidgetignoreexistingappearance(void* lpObj, int bWidgetIgnoreExistingAppearance);
int secureblackbox_pdfsigner_getwidgetinvertmask(void* lpObj);
int secureblackbox_pdfsigner_setwidgetinvertmask(void* lpObj, int bWidgetInvertMask);
int secureblackbox_pdfsigner_getwidgetinvisible(void* lpObj);
int secureblackbox_pdfsigner_setwidgetinvisible(void* lpObj, int bWidgetInvisible);
char* secureblackbox_pdfsigner_getwidgetpagestoplaceon(void* lpObj);
int secureblackbox_pdfsigner_setwidgetpagestoplaceon(void* lpObj, const char* lpszWidgetPagesToPlaceOn);
int secureblackbox_pdfsigner_getwidgetpositionanchor(void* lpObj);
int secureblackbox_pdfsigner_setwidgetpositionanchor(void* lpObj, int iWidgetPositionAnchor);
int secureblackbox_pdfsigner_getwidgetrenderoptions(void* lpObj);
int secureblackbox_pdfsigner_setwidgetrenderoptions(void* lpObj, int iWidgetRenderOptions);
int secureblackbox_pdfsigner_getwidgetrotate(void* lpObj);
int secureblackbox_pdfsigner_setwidgetrotate(void* lpObj, int iWidgetRotate);
int secureblackbox_pdfsigner_getwidgetshowdate(void* lpObj);
int secureblackbox_pdfsigner_setwidgetshowdate(void* lpObj, int bWidgetShowDate);
int secureblackbox_pdfsigner_getwidgetshowvisualstatus(void* lpObj);
int secureblackbox_pdfsigner_setwidgetshowvisualstatus(void* lpObj, int bWidgetShowVisualStatus);
char* secureblackbox_pdfsigner_getwidgetsignercaption(void* lpObj);
int secureblackbox_pdfsigner_setwidgetsignercaption(void* lpObj, const char* lpszWidgetSignerCaption);
char* secureblackbox_pdfsigner_getwidgetsignerinfo(void* lpObj);
int secureblackbox_pdfsigner_setwidgetsignerinfo(void* lpObj, const char* lpszWidgetSignerInfo);
QString GetWidgetAlgorithmCaption();
int SetWidgetAlgorithmCaption(QString qsWidgetAlgorithmCaption); QString GetWidgetAlgorithmInfo();
int SetWidgetAlgorithmInfo(QString qsWidgetAlgorithmInfo); QByteArray GetWidgetBackgroundData();
int SetWidgetBackgroundData(QByteArray qbaWidgetBackgroundData); QString GetWidgetBackgroundHeight();
int SetWidgetBackgroundHeight(QString qsWidgetBackgroundHeight); int GetWidgetBackgroundImageHeight();
int SetWidgetBackgroundImageHeight(int iWidgetBackgroundImageHeight); int GetWidgetBackgroundImageType();
int SetWidgetBackgroundImageType(int iWidgetBackgroundImageType); int GetWidgetBackgroundImageWidth();
int SetWidgetBackgroundImageWidth(int iWidgetBackgroundImageWidth); QByteArray GetWidgetBackgroundMask();
int SetWidgetBackgroundMask(QByteArray qbaWidgetBackgroundMask); QString GetWidgetBackgroundPosition();
int SetWidgetBackgroundPosition(QString qsWidgetBackgroundPosition); int GetWidgetBackgroundStyle();
int SetWidgetBackgroundStyle(int iWidgetBackgroundStyle); QString GetWidgetBackgroundWidth();
int SetWidgetBackgroundWidth(QString qsWidgetBackgroundWidth); bool GetWidgetCompressWidgetData();
int SetWidgetCompressWidgetData(bool bWidgetCompressWidgetData); QByteArray GetWidgetCustomAppearance();
int SetWidgetCustomAppearance(QByteArray qbaWidgetCustomAppearance); QString GetWidgetCustomBackgroundContentStream();
int SetWidgetCustomBackgroundContentStream(QString qsWidgetCustomBackgroundContentStream); QString GetWidgetCustomVisualStatusMatrix();
int SetWidgetCustomVisualStatusMatrix(QString qsWidgetCustomVisualStatusMatrix); QString GetWidgetDateFormat();
int SetWidgetDateFormat(QString qsWidgetDateFormat); QString GetWidgetFontName();
int SetWidgetFontName(QString qsWidgetFontName); qint64 GetWidgetHandle();
int SetWidgetHandle(qint64 lWidgetHandle); QString GetWidgetHeader();
int SetWidgetHeader(QString qsWidgetHeader); bool GetWidgetHideDefaultText();
int SetWidgetHideDefaultText(bool bWidgetHideDefaultText); bool GetWidgetIgnoreExistingAppearance();
int SetWidgetIgnoreExistingAppearance(bool bWidgetIgnoreExistingAppearance); bool GetWidgetInvertMask();
int SetWidgetInvertMask(bool bWidgetInvertMask); bool GetWidgetInvisible();
int SetWidgetInvisible(bool bWidgetInvisible); QString GetWidgetPagesToPlaceOn();
int SetWidgetPagesToPlaceOn(QString qsWidgetPagesToPlaceOn); int GetWidgetPositionAnchor();
int SetWidgetPositionAnchor(int iWidgetPositionAnchor); int GetWidgetRenderOptions();
int SetWidgetRenderOptions(int iWidgetRenderOptions); int GetWidgetRotate();
int SetWidgetRotate(int iWidgetRotate); bool GetWidgetShowDate();
int SetWidgetShowDate(bool bWidgetShowDate); bool GetWidgetShowVisualStatus();
int SetWidgetShowVisualStatus(bool bWidgetShowVisualStatus); QString GetWidgetSignerCaption();
int SetWidgetSignerCaption(QString qsWidgetSignerCaption); QString GetWidgetSignerInfo();
int SetWidgetSignerInfo(QString qsWidgetSignerInfo);

Remarks

Use this property to adjust the signature widget appearance parameters, such as background or texts.

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

Data Type

SecureBlackboxPDFWidget

AddWidgetCustomData Method (PDFSigner Class)

Adds a custom data to the signature widget.

Syntax

ANSI (Cross Platform)
int AddWidgetCustomData(const char* lpszCustomData);

Unicode (Windows)
INT AddWidgetCustomData(LPCWSTR lpszCustomData);
int secureblackbox_pdfsigner_addwidgetcustomdata(void* lpObj, const char* lpszCustomData);
int AddWidgetCustomData(const QString& qsCustomData);

Remarks

Use this method to quickly add a custom data block that contains PDF graphics operators to your signature widget.

The method returns the index of the new custom text in the CustomText collection (accessed via Config).

Error Handling (C++)

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

AddWidgetText Method (PDFSigner Class)

Adds a text block to the signature widget.

Syntax

ANSI (Cross Platform)
int AddWidgetText(const char* lpszText, int iX, int iY, const char* lpszFontSize);

Unicode (Windows)
INT AddWidgetText(LPCWSTR lpszText, INT iX, INT iY, LPCWSTR lpszFontSize);
int secureblackbox_pdfsigner_addwidgettext(void* lpObj, const char* lpszText, int iX, int iY, const char* lpszFontSize);
int AddWidgetText(const QString& qsText, int iX, int iY, const QString& qsFontSize);

Remarks

Use this method to quickly add a custom text block to your signature widget.

The method returns the index of the new custom text in the CustomText collection (accessed via Config).

Error Handling (C++)

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

AddWidgetTextEx Method (PDFSigner Class)

Adds a text block to the signature widget.

Syntax

ANSI (Cross Platform)
int AddWidgetTextEx(const char* lpszText, const char* lpszSettings);

Unicode (Windows)
INT AddWidgetTextEx(LPCWSTR lpszText, LPCWSTR lpszSettings);
int secureblackbox_pdfsigner_addwidgettextex(void* lpObj, const char* lpszText, const char* lpszSettings);
int AddWidgetTextEx(const QString& qsText, const QString& qsSettings);

Remarks

Use this method to add a custom text block to your signature widget.

Text represents the text string to add. Settings contains a list of parameters in the form of PARAM1=VALUE1;PARAM2=VALUE2;... or in JSON format.

The following parameters are supported:

"X"The text offset from the left-hand signature widget border.
"Y"The text offset from the bottom signature widget border.
"FontSize"The font size of the text (single value, or two values separated with a space character that represent horizontal and vertical font sizes).
"FontSizeX"The horizontal font size of the text.
"FontSizeY"The vertical font size of the text.
"FontName"The font name or TrueType filename. It supports the same values as the Widget.FontName property.

The method returns the index of the new custom text in the CustomText collection (accessed via Config).

Error Handling (C++)

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

AttachBytes Method (PDFSigner Class)

Adds an attachment to the PDF document.

Syntax

ANSI (Cross Platform)
int AttachBytes(const char* lpData, int lenData, const char* lpszObjName, const char* lpszFileName, const char* lpszDescription, const char* lpszSubType, const char* lpszCDate, const char* lpszMDate);

Unicode (Windows)
INT AttachBytes(LPCSTR lpData, INT lenData, LPCWSTR lpszObjName, LPCWSTR lpszFileName, LPCWSTR lpszDescription, LPCWSTR lpszSubType, LPCWSTR lpszCDate, LPCWSTR lpszMDate);
int secureblackbox_pdfsigner_attachbytes(void* lpObj, const char* lpData, int lenData, const char* lpszObjName, const char* lpszFileName, const char* lpszDescription, const char* lpszSubType, const char* lpszCDate, const char* lpszMDate);
int AttachBytes(QByteArray qbaData, const QString& qsObjName, const QString& qsFileName, const QString& qsDescription, const QString& qsSubType, const QString& qsCDate, const QString& qsMDate);

Remarks

Use this method to add an attachment (embedded file) to a 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.)

AttachFile Method (PDFSigner Class)

Adds an attachment to the PDF document.

Syntax

ANSI (Cross Platform)
int AttachFile(const char* lpszPath, const char* lpszObjName, const char* lpszFileName, const char* lpszDescription, const char* lpszSubType, const char* lpszCDate, const char* lpszMDate);

Unicode (Windows)
INT AttachFile(LPCWSTR lpszPath, LPCWSTR lpszObjName, LPCWSTR lpszFileName, LPCWSTR lpszDescription, LPCWSTR lpszSubType, LPCWSTR lpszCDate, LPCWSTR lpszMDate);
int secureblackbox_pdfsigner_attachfile(void* lpObj, const char* lpszPath, const char* lpszObjName, const char* lpszFileName, const char* lpszDescription, const char* lpszSubType, const char* lpszCDate, const char* lpszMDate);
int AttachFile(const QString& qsPath, const QString& qsObjName, const QString& qsFileName, const QString& qsDescription, const QString& qsSubType, const QString& qsCDate, const QString& qsMDate);

Remarks

Use this method to add an attachment (embedded file) to a 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.)

AttachStream Method (PDFSigner Class)

Adds an attachment to the PDF document.

Syntax

ANSI (Cross Platform)
int AttachStream(SecureBlackboxStream* sStream, const char* lpszObjName, const char* lpszFileName, const char* lpszDescription, const char* lpszSubType, const char* lpszCDate, const char* lpszMDate);

Unicode (Windows)
INT AttachStream(SecureBlackboxStream* sStream, LPCWSTR lpszObjName, LPCWSTR lpszFileName, LPCWSTR lpszDescription, LPCWSTR lpszSubType, LPCWSTR lpszCDate, LPCWSTR lpszMDate);
int secureblackbox_pdfsigner_attachstream(void* lpObj, SecureBlackboxStream* sStream, const char* lpszObjName, const char* lpszFileName, const char* lpszDescription, const char* lpszSubType, const char* lpszCDate, const char* lpszMDate);
int AttachStream(SecureBlackboxStream* sStream, const QString& qsObjName, const QString& qsFileName, const QString& qsDescription, const QString& qsSubType, const QString& qsCDate, const QString& qsMDate);

Remarks

Use this method to add an attachment (embedded file) to a 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.)

Close Method (PDFSigner Class)

Closes an opened document.

Syntax

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

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

Remarks

Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.

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 (PDFSigner Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_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.

The PDFSigner class ActionIDs:

ActionDescription
"AddImage"Adds an image to the foreground layer.
"GetTextWidth"Calculates the width of the given text for a specific font.
"GetSystemFontNames"Gets the list of system font names.
"IsAllGlyphsAvailable"Checks if all glyphs from the given text are available for a specific font.

Use "AddImage" action to add an image to the foreground layer. The following parameters are supported:

"ImageData"The image data in hex or base64 encoding. To use base64 encoding prepend an encoded data with "base64:" prefix.
"ImageWidth"The width of the image in pixels.
"ImageHeight"The height of the image in pixels.
"ImageType"The type of the image contained in ImageData parameter. Supported values: "jpeg", "jpeg2000", "custom".
"ImageBitsPerComponent"The number of bits per color space component for the image.
"ImageColorSpace"The image color space. Supported values: "RGB", "CMYK" and "Gray".
"ImageInterpolate"Specifies whether an image interpolation shall be performed by a conforming reader.
"X"The image offset from the left-hand signature widget border.
"Y"The image offset from the bottom signature widget border.
"Width"The width of the image in points.
"Height"The height of the image in points.

Parameters ImageData, ImageWidth, ImageHeight, ImageType, X, Y, Width and Height are required.

Sample code to add a JPEG image of size 100px x 100px and place it in position (10, 10) with an image size (30, 30): Signer.DoAction("AddImage", "ImageData=" + Utils.HexEncode(BinaryImageData) + "; ImageWidth=100; ImageHeight=100; ImageType=jpeg; X=10; Y=10; Width=30; Height=30");

Use "GetTextWidth" action to calculate the width of the given text for a specific font. The following parameters are supported:

"Text"Represent the text string for which you want to determine the width.
"FontName"The font name or TrueType filename. It supports the same values as Widget.FontName property.
"FontSize"The horizontal font size of the text. If omitted, the width of the text returned in units, and the width for a specific font size could be calculated by the formula: (Width / 1000) * FontSize

Sample code: Signer.DoAction("GetTextWidth", "Text=Lorem Ipsum; FontSize=10; FontName=Arial Bold Italic");

Use "GetSystemFontNames" action to get a CRLF-separated list of system TrueType font names that the component supports.

Use "IsAllGlyphsAvailable" action to check if all glyphs that correspond to the given text are available for a specific font. The following parameters are required:

"Text"Represent the text string that you want to check.
"FontName"The font name or TrueType filename. It supports the same values as Widget.FontName property.

For standard Type 1 fonts this action always returns a "true" value.

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.

ExtractAsyncData Method (PDFSigner Class)

Extracts user data from the DC signing service response.

Syntax

ANSI (Cross Platform)
char* ExtractAsyncData(const char* lpszAsyncReply);

Unicode (Windows)
LPWSTR ExtractAsyncData(LPCWSTR lpszAsyncReply);
char* secureblackbox_pdfsigner_extractasyncdata(void* lpObj, const char* lpszAsyncReply);
QString ExtractAsyncData(const QString& qsAsyncReply);

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

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 (PDFSigner 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_pdfsigner_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 (PDFSigner 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_pdfsigner_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 (PDFSigner 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_pdfsigner_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.)

Open Method (PDFSigner Class)

Opens a document for signing or updating.

Syntax

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();
int secureblackbox_pdfsigner_open(void* lpObj);
int Open();

Remarks

Use this method to open a document for signing or updating. When finished, call Close to complete or discard the operation.

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 (PDFSigner Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int secureblackbox_pdfsigner_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 (PDFSigner 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_pdfsigner_revalidate(void* lpObj, const char* lpszSigLabel);
int Revalidate(const QString& qsSigLabel);

Remarks

Use this method to re-validate 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 (PDFSigner 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_pdfsigner_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.)

Sign Method (PDFSigner Class)

Signs a PDF document.

Syntax

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();
int secureblackbox_pdfsigner_sign(void* lpObj);
int Sign();

Remarks

Call this method to sign the document referenced by the InputFile (or InputStream) property. The document will be signed with SigningCertificate as configured in NewSignature, and saved in OutputFile (OutputStream).

Use TrustedCertificates, KnownCertificates, RevocationCheck, OfflineMode and other properties of the class to adjust chain validation parameters. After the signing, the chain validation log will be available in the ValidationLog property.

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.)

SignAsyncBegin Method (PDFSigner Class)

Initiates the asynchronous signing operation.

Syntax

ANSI (Cross Platform)
char* SignAsyncBegin();

Unicode (Windows)
LPWSTR SignAsyncBegin();
char* secureblackbox_pdfsigner_signasyncbegin(void* lpObj);
QString SignAsyncBegin();

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

There are some conditions that should be met when signing PDF documents asynchronously. The advanced PDF signature levels, specifically BES, EPES, and LTV, require that the 'signingCertificate' attribute is included in the signature. This can only be satisfied if either ExternalCrypto is configured to use the asmdPKCS7 method, or the public copy of the signing certificate is provided on the pre-signing stage.

Please note that you will still be able to sign a document with the asmdPKCS1 method and no public copy of the certificate provided (resulting in the omission of the 'signingCertificate' attribute from the signature); however, most modern PDF processors will reject such signatures as invalid or non-compliant.

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.

SignAsyncEnd Method (PDFSigner Class)

Completes the asynchronous signing operation.

Syntax

ANSI (Cross Platform)
int SignAsyncEnd(const char* lpszAsyncReply);

Unicode (Windows)
INT SignAsyncEnd(LPCWSTR lpszAsyncReply);
int secureblackbox_pdfsigner_signasyncend(void* lpObj, const char* lpszAsyncReply);
int SignAsyncEnd(const QString& qsAsyncReply);

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

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.)

SignExternal Method (PDFSigner Class)

Signs the document using an external signing facility.

Syntax

ANSI (Cross Platform)
int SignExternal();

Unicode (Windows)
INT SignExternal();
int secureblackbox_pdfsigner_signexternal(void* lpObj);
int SignExternal();

Remarks

Use this method to create a PDF signature using an external signing facility for the cryptographic computations. SignExternal delegates the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and the hash is computed, the class fires the ExternalSign event which allows the hash value to be passed for signing.

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.)

Update Method (PDFSigner Class)

Updates a signature.

Syntax

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

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

Remarks

PDF signatures may be updated from time to time by embedding newer/missing revocation information. The update approach is typically used to extend the validity of an LTV signature. Set SigLabel to the label of the signature field to update.

Updating is typically accompanied with a document timestamping operation. Set TimestampServer to have the class obtain and embed a document timestamp for you.

Before calling this method, provide the signed document via the InputFile (or InputStream) property. The updated document will be saved to OutputFile (or OutputStream).

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 (PDFSigner Class)

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

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);
class PDFSignerChainElementDownloadEventParams {
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(PDFSignerChainElementDownloadEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireChainElementDownload(PDFSignerChainElementDownloadEventParams *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 (PDFSigner Class)

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

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);
class PDFSignerChainElementNeededEventParams {
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(PDFSignerChainElementNeededEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireChainElementNeeded(PDFSignerChainElementNeededEventParams *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 (PDFSigner Class)

Reports the completion of a certificate chain validation.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails, BOOL &bCancel);
class PDFSignerChainValidatedEventParams {
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(PDFSignerChainValidatedEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireChainValidated(PDFSignerChainValidatedEventParams *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 (PDFSigner 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(PDFSignerChainValidationProgressEventParams *e);
typedef struct {
const char *EventKind;
const char *CertRDN;
const char *CACertRDN;
int Action; int reserved; } PDFSignerChainValidationProgressEventParams;
Unicode (Windows) virtual INT FireChainValidationProgress(PDFSignerChainValidationProgressEventParams *e);
typedef struct {
LPCWSTR EventKind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
INT Action; INT reserved; } PDFSignerChainValidationProgressEventParams;
#define EID_PDFSIGNER_CHAINVALIDATIONPROGRESS 4

virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);
class PDFSignerChainValidationProgressEventParams {
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(PDFSignerChainValidationProgressEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireChainValidationProgress(PDFSignerChainValidationProgressEventParams *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 (PDFSigner Class)

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

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);
class PDFSignerDocumentLoadedEventParams {
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(PDFSignerDocumentLoadedEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireDocumentLoaded(PDFSignerDocumentLoadedEventParams *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 (PDFSigner 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(PDFSignerEncryptedEventParams *e);
typedef struct {
int CertUsed;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int NeedCredential;
int SkipThis; int reserved; } PDFSignerEncryptedEventParams;
Unicode (Windows) virtual INT FireEncrypted(PDFSignerEncryptedEventParams *e);
typedef struct {
BOOL CertUsed;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL NeedCredential;
BOOL SkipThis; INT reserved; } PDFSignerEncryptedEventParams;
#define EID_PDFSIGNER_ENCRYPTED 6

virtual INT SECUREBLACKBOX_CALL FireEncrypted(BOOL &bCertUsed, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bNeedCredential, BOOL &bSkipThis);
class PDFSignerEncryptedEventParams {
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(PDFSignerEncryptedEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireEncrypted(PDFSignerEncryptedEventParams *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 (PDFSigner Class)

Information about errors during signing/validation.

Syntax

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

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

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(PDFSignerErrorEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireError(PDFSignerErrorEventParams *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.

ExternalDecrypt Event (PDFSigner Class)

Handles remote or external decryption.

Syntax

ANSI (Cross Platform)
virtual int FireExternalDecrypt(PDFSignerExternalDecryptEventParams *e);
typedef struct {
const char *OperationId;
const char *Algorithm;
const char *Pars;
const char *EncryptedData;
char *Data; int reserved; } PDFSignerExternalDecryptEventParams;
Unicode (Windows) virtual INT FireExternalDecrypt(PDFSignerExternalDecryptEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR Algorithm;
LPCWSTR Pars;
LPCWSTR EncryptedData;
LPWSTR Data; INT reserved; } PDFSignerExternalDecryptEventParams;
#define EID_PDFSIGNER_EXTERNALDECRYPT 8

virtual INT SECUREBLACKBOX_CALL FireExternalDecrypt(LPSTR &lpszOperationId, LPSTR &lpszAlgorithm, LPSTR &lpszPars, LPSTR &lpszEncryptedData, LPSTR &lpszData);
class PDFSignerExternalDecryptEventParams {
public:
  const QString &OperationId();

  const QString &Algorithm();

  const QString &Pars();

  const QString &EncryptedData();

  const QString &Data();
  void SetData(const QString &qsData);

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

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

ExternalSign Event (PDFSigner Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

ANSI (Cross Platform)
virtual int FireExternalSign(PDFSignerExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } PDFSignerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(PDFSignerExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } PDFSignerExternalSignEventParams;
#define EID_PDFSIGNER_EXTERNALSIGN 9

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class PDFSignerExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

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

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

Notification Event (PDFSigner Class)

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

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class PDFSignerNotificationEventParams {
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(PDFSignerNotificationEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireNotification(PDFSignerNotificationEventParams *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:

DocumentLoadedReports the completion of PDF document processing by the component. Use the event handler to access document-related information, such as page number and document file details. The EventParam value passed with this EventID is empty.
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.

BeforeDocumentTimestampThis event is fired before adding document timestamp. Use the event handler to modify signature settings.
SignatureWidgetPrepareAnother copy of the signature widget needs to be configured. Use the event handler to configure individual widgets when creating multi-widget signatures. The Notification event with this event ID will be fired repeatedly until the LastSignatureWidget configuration setting is set to true.

The EventParam value passed with this EventID is empty.

SignaturesLoadedNotifies the application that the component has finished loading signatures.

PreRenderWidget Event (PDFSigner Class)

Fires when a signature widget is ready to be written to the document.

Syntax

ANSI (Cross Platform)
virtual int FirePreRenderWidget(PDFSignerPreRenderWidgetEventParams *e);
typedef struct {
int AddAnother;
int ResetAnother; int reserved; } PDFSignerPreRenderWidgetEventParams;
Unicode (Windows) virtual INT FirePreRenderWidget(PDFSignerPreRenderWidgetEventParams *e);
typedef struct {
BOOL AddAnother;
BOOL ResetAnother; INT reserved; } PDFSignerPreRenderWidgetEventParams;
#define EID_PDFSIGNER_PRERENDERWIDGET 11

virtual INT SECUREBLACKBOX_CALL FirePreRenderWidget(BOOL &bAddAnother, BOOL &bResetAnother);
class PDFSignerPreRenderWidgetEventParams {
public:
  bool AddAnother();
  void SetAddAnother(bool bAddAnother);

  bool ResetAnother();
  void SetResetAnother(bool bResetAnother);

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

Remarks

The class fires this event when it is ready to insert a new instance of the signature widget to the document. This event is fired repeatedly until the event handler sets the AddAnother parameter to false, allowing your application to create as many copies of the signature widget as required.

You can use this event handler to adjust the look of each widget copy. Set the ResetAnother parameter to true to automatically clean up all the existing widget settings after the current widget is saved. Setting ResetAnother to true will let you start every new widget from scratch. Keeping it set to false would result in every new widget looking the same as the previous one.

SignatureFound Event (PDFSigner Class)

Signifies the start of signature validation.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureFound(PDFSignerSignatureFoundEventParams *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; } PDFSignerSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(PDFSignerSignatureFoundEventParams *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; } PDFSignerSignatureFoundEventParams;
#define EID_PDFSIGNER_SIGNATUREFOUND 12

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 PDFSignerSignatureFoundEventParams {
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(PDFSignerSignatureFoundEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireSignatureFound(PDFSignerSignatureFoundEventParams *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 (PDFSigner Class)

Marks the completion of the signature validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureValidated(PDFSignerSignatureValidatedEventParams *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; } PDFSignerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(PDFSignerSignatureValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult;
BOOL Cancel; INT reserved; } PDFSignerSignatureValidatedEventParams;
#define EID_PDFSIGNER_SIGNATUREVALIDATED 13

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult, BOOL &bCancel);
class PDFSignerSignatureValidatedEventParams {
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(PDFSignerSignatureValidatedEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireSignatureValidated(PDFSignerSignatureValidatedEventParams *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 (PDFSigner Class)

Signifies the start of a timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampFound(PDFSignerTimestampFoundEventParams *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; } PDFSignerTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(PDFSignerTimestampFoundEventParams *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; } PDFSignerTimestampFoundEventParams;
#define EID_PDFSIGNER_TIMESTAMPFOUND 14

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 PDFSignerTimestampFoundEventParams {
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(PDFSignerTimestampFoundEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTimestampFound(PDFSignerTimestampFoundEventParams *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.

TimestampRequest Event (PDFSigner Class)

Fires when the class is ready to request a timestamp from an external TSA.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampRequest(PDFSignerTimestampRequestEventParams *e);
typedef struct {
const char *TSA;
const char *TimestampRequest;
char *TimestampResponse;
int SuppressDefault; int reserved; } PDFSignerTimestampRequestEventParams;
Unicode (Windows) virtual INT FireTimestampRequest(PDFSignerTimestampRequestEventParams *e);
typedef struct {
LPCWSTR TSA;
LPCWSTR TimestampRequest;
LPWSTR TimestampResponse;
BOOL SuppressDefault; INT reserved; } PDFSignerTimestampRequestEventParams;
#define EID_PDFSIGNER_TIMESTAMPREQUEST 15

virtual INT SECUREBLACKBOX_CALL FireTimestampRequest(LPSTR &lpszTSA, LPSTR &lpszTimestampRequest, LPSTR &lpszTimestampResponse, BOOL &bSuppressDefault);
class PDFSignerTimestampRequestEventParams {
public:
  const QString &TSA();

  const QString &TimestampRequest();

  const QString &TimestampResponse();
  void SetTimestampResponse(const QString &qsTimestampResponse);

  bool SuppressDefault();
  void SetSuppressDefault(bool bSuppressDefault);

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

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

TimestampValidated Event (PDFSigner Class)

Reports the completion of the timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampValidated(PDFSignerTimestampValidatedEventParams *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; } PDFSignerTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(PDFSignerTimestampValidatedEventParams *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; } PDFSignerTimestampValidatedEventParams;
#define EID_PDFSIGNER_TIMESTAMPVALIDATED 16

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 PDFSignerTimestampValidatedEventParams {
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(PDFSignerTimestampValidatedEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTimestampValidated(PDFSignerTimestampValidatedEventParams *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 (PDFSigner Class)

Fires when a remote TLS party requests a client certificate.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class PDFSignerTLSCertNeededEventParams {
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(PDFSignerTLSCertNeededEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTLSCertNeeded(PDFSignerTLSCertNeededEventParams *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 (PDFSigner 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(PDFSignerTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } PDFSignerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(PDFSignerTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } PDFSignerTLSCertValidateEventParams;
#define EID_PDFSIGNER_TLSCERTVALIDATE 18

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class PDFSignerTLSCertValidateEventParams {
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(PDFSignerTLSCertValidateEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTLSCertValidate(PDFSignerTLSCertValidateEventParams *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 (PDFSigner Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class PDFSignerTLSEstablishedEventParams {
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(PDFSignerTLSEstablishedEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTLSEstablished(PDFSignerTLSEstablishedEventParams *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 (PDFSigner Class)

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

Syntax

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

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class PDFSignerTLSHandshakeEventParams {
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(PDFSignerTLSHandshakeEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTLSHandshake(PDFSignerTLSHandshakeEventParams *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 (PDFSigner Class)

Reports the graceful closure of a TLS connection.

Syntax

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

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSShutdown(PDFSignerTLSShutdownEventParams *e);
// Or, subclass PDFSigner and override this emitter function. virtual int FireTLSShutdown(PDFSignerTLSShutdownEventParams *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.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

Fields

AsyncDocumentID
char*

Default Value: ""

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

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

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

CustomParams
char*

Default Value: ""

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

Data
char*

Default Value: ""

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

ExternalHashCalculation
int

Default Value: FALSE

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

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

HashAlgorithm
char*

Default Value: "SHA256"

Specifies the request's signature hash algorithm.

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

KeyID
char*

Default Value: ""

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

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

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

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

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
char*

Default Value: ""

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

Read more about configuring authentication in the KeyID topic.

Method
int

Default Value: 0

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

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Default Value: 0

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
char*

Default Value: ""

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

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

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

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.

PDFWidget Type

This component is a container for the signature widget parameters.

Syntax

SecureBlackboxPDFWidget (declared in secureblackbox.h)

Remarks

Use it to adjust the look of the signature widget when creating a signature.

The following fields are available:

Fields

AlgorithmCaption
char*

Default Value: "#auto"

The caption of the signature widget field with information about the signature algorithm.

AlgorithmInfo
char*

Default Value: "#auto"

Information about the algorithm to be shown on the signature widget.

This property contains information about the algorithm to be displayed in the signature widget. Keep this property set to #auto to make the component generate the algorithm text automatically, in the form of "Algorithm/Key size", e.g. "RSA/1024 bits".

BackgroundData
char*

Default Value:

Contains/takes the data of the signature widget background bitmap.

Assign the widget background data (in the form of JPEG or JPEG2000 bytes) to this property.

BackgroundHeight
char*

Default Value: "0"

Use this field to manually adjust the size of the stretched background picture in the vertical direction.

BackgroundImageHeight
int

Default Value: 0

The height of the background image in pixels.

It is important that this property matches the exact size of the image when a custom background is used. The width and height of the background image have no direct relation to the dimensions of the signature widget on the document page, and are only used to indicate the parameters of the image to the PDF processor. Big images will ultimately be squeezed to fit in the widget, and smaller ones stretched.

BackgroundImageType
int

Default Value: 0

The type of the image contained in BackgroundData. The JPEG and JPEG2000 formats are currently supported.

pwitJPEG20000JPEG 2000 format (supports transparency)
pwitJPEG1standard JPEG format (does not support transparency)
pwitCustom2Custom background format

BackgroundImageWidth
int

Default Value: 0

The width of the background image in pixels.

It is important that this property matches the exact size of the image when a custom background is used. The width and height of the background image have no direct relation to the dimensions of the signature widget on the document page, and are only used to indicate the parameters of the image to the PDF processor. Big images will ultimately be squeezed to fit in the widget, and smaller ones stretched.

BackgroundMask
char*

Default Value:

Contains the background image mask.

Masks provide a means for marking transparent areas on your signature widgets. Specifically, a transparency mask tells PDF viewing apps which pixels of the signature widget should be kept visible and which should be rendered transparent instead.

In most cases, you will need a unique mask that is tailored for your signature widget image. This is something that you will need to create yourself based on your preferences and the actual image design.

A mask is effectively a matrix of bits, with each bit corresponding to a pixel on your background bitmap. A bit is set to 1 if the corresponding pixel needs to be made transparent, or to 0 if it needs to be opaque.

To create the mask that can be passed to BackgroundMask, please follow the below procedure:

Go through your signature widget bitmap row by row, processing each row of pixels from left to right. For each row,

1. Start with an empty bit string.

2. For every pixel in a row, add a '1' bit if you want it to be transparent, or a '0' bit if you want it to be opaque.

3. Upon reaching the end of the row, append '0' bits to your bit string until the number of bits in it is a multiple of 8. This is because each row of pixels needs to be represented with a whole number of bytes.

4. Convert the bit string to a byte array by grouping every 8 bits into a byte.

Do the same for every row of pixels, and then concatenate the received byte arrays together. Pass the created byte array to BackgroundMask.

A small example. Imagine your image is 19 pixels wide and 3 pixels tall. Imagine you want to make it 'semi-transparent' by using a 'mesh' pattern. The mask will therefore look like this:

10101010 10101010 10100000 // first row

01010101 01010101 01000000 // second row

10101010 10101010 10100000 // third row

Note that the last 5 bits of each row are padding '0' bits and are ignored: you only need them to make each row contain a whole number of bytes. When converted to a byte string, this would look like

0xAA 0xAA 0xA0

0x55 0x55 0x40

0xAA 0xAA 0xA0

, or, if written as a byte array, (0xAA, 0xAA, 0xA0, 0x55, 0x55, 0x40, 0xAA, 0xAA, 0xA0): this is what you need to pass to BackgroundMask.

BackgroundPosition
char*

Default Value: ""

The position of the widget background.

Specifies the position of the background image.

The value may be:

The keyword value "center", which centers the image.

A pair of coordinates ("10 5.5"), in which one value defines X and the other defines Y starting from the bottom-left corner.

BackgroundStyle
int

Default Value: 0

The style of the signature widget background.

pwbsDefault uses the default image, pwbsNoBackground doesn't use a background image at all, and pwbsCustom expects the application to provide a custom background image.

pwbsDefault0The default widget background
pwbsNoBackground1No (empty) background
pwbsCustom2Custom background (picture or vector)

BackgroundWidth
char*

Default Value: "0"

Use this field to manually adjust the horizontal size of the stretched background picture.

CompressWidgetData
int

Default Value: FALSE

Whether the signature widget data should be compressed before saving.

CustomAppearance
char*

Default Value:

Contains a custom widget description in raw PDF graphic operators format.

Use this property to provide a PDF stream describing the widget appearance.

CustomBackgroundContentStream
char*

Default Value: ""

Specifies a custom background content stream for the pwbsCustom BackgroundStyle.

CustomVisualStatusMatrix
char*

Default Value: ""

Defines the custom visual status matrix.

Use of this property makes sense only if a visual status icon is displayed over the signature (ShowVisualStatus). Prior to Acrobat 6, a signature's visual appearance was modified with a status icon, e.g., "valid" or "invalid". The visual status matrix is used to position the icon in the signature widget. If CustomVisualStatusMatrix is empty, the value of '0.25 0 0 0.25 0 0' is used.

DateFormat
char*

Default Value: ""

The format string used to display the signing date and time in the signature widget.

Leave this property empty (default value) to use the default formatting.

Use the "L" value to convert UTC time to local time using the default formatting, or use the "L:" prefix with a custom date time formatting string.

FontName
char*

Default Value: ""

Specifies the font name for the signature text.

Use this property to specify a Type 1 or TrueType font name for the signature text.

The PDF format supports 14 standard Type 1 fonts, specifically: "Times-Roman", "Helvetica", "Courier", "Symbol", "Times-Bold", "Helvetica-Bold", "Courier-Bold", "ZapfDingbats", "Times-Italic", "Helvetica-Oblique", "Courier-Oblique", "Times-BoldItalic", "Helvetica-BoldOblique", "Courier-BoldOblique".

For TrueType font names, the component supports a full font name (e.g. "Times New Roman", "Arial Bold Italic"), its filename (e.g. "times.ttf", "arialbi.ttf"), or a full file name.

If a TrueType font is used, then a font subset is embedded into the PDF document.

The list of system TrueType font names that the component supports could be obtained using the DoAction method with the "GetSystemFontNames" action ID.

Use the FontPaths configuration setting (accessed via Config) to specify font search paths in case the TrueType font filename is provided.

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

Header
char*

Default Value: "#auto"

Specifies the header text to put on the signature widget. Keep this property set to #auto to make the component generate the header automatically.

HideDefaultText
int

Default Value: FALSE

Switches off the generation of any headers for the signature widget.

IgnoreExistingAppearance
int

Default Value: FALSE

Tells the component to discard any existing widget parameters when signing empty signature fields.

IgnoreExistingAppearance only makes sense for signatures created by signing existing empty signature fields with pre-defined widget descriptions.

InvertMask
int

Default Value: FALSE

Specifies whether BackgroundMask should be inverted.

Set this property to flip all the bits in the mask, by making opaque all the bits declared by the mask as transparent, and making transparent all the bits declared as opaque.

Invisible
int

Default Value: FALSE

Controls whether the signature widget is visible on the page.

PagesToPlaceOn
char*

Default Value: ""

The page numbers on which the signature is shown. This field supports a variety of syntaxes:

  • A single page number: 3
  • A comma-separated list of page numbers: 1,2,5,7
  • The star character (*) indicates that the widget should be placed on all pages in the document
  • The first and last placeholders specify that the signature should be placed on the respective page, independently of its number.

PositionAnchor
int

Default Value: 0

The anchor to bind the position of the widget to.

Supported values are:

ppaDefault0The signature's OffsetX and OffsetY properties specify the position of the bottom left widget corner starting from the page's physical bottom left corner (doesn't take into account page rotation).
ppaBottomLeft1The signature's OffsetX and OffsetY properties specify the position of the bottom left widget corner starting from the page's bottom left corner according to the viewer's perspective (take into account page rotation).
ppaBottomRight2The signature's OffsetX and OffsetY properties specify the position of the bottom right widget corner starting from the page's bottom right corner according to the viewer's perspective (take into account page rotation).
ppaTopLeft3The signature's OffsetX and OffsetY properties specify the position of the top left widget corner starting from the page's top left corner according to the viewer's perspective (take into account page rotation).
ppaTopRight4The signature's OffsetX and OffsetY properties specify the position of the top right widget corner starting from the page's top right corner according to the viewer's perspective (take into account page rotation).
ppaCenter5The signature's OffsetX and OffsetY properties specify the position of the widget center starting from the page's center according to the viewer's perspective.

RenderOptions
int

Default Value: 8

This setting is a container for a selection of rendering options. OR or NOT an option to include or exclude it from the bit mask.

wroUnknown0x00000Unknown, unsupported, or uninitialized set of options

wroNoRotate0x00001Enabling this option prevents the signature widget from being rotated when the containing document is rotated in a viewing app.

wroNoView0x00002Enabling this option prevents the widget from being displayed when the document is viewed in an app (the widget will still be printed, if configured).

wroNoZoom0x00004Keeps the widget at the same size when the document is zoomed in or out.

wroPrint0x00008Makes the widget printable.

wroReadOnly0x00010Controls the ReadOnly flag of the widget object.

wroToggleNoView0x00020If set, the signature widget will only be displayed when the viewer hovers a mouse pointer over it.

Rotate
int

Default Value: 0

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

ShowDate
int

Default Value: TRUE

Whether to display the signing date and time details on the widget.

ShowVisualStatus
int

Default Value: FALSE

Specifies whether to show the signature's status icon.

It is a good idea to avoid using the visual status icon, as described below:

According to the Digital Signature Appearances Adobe Acrobat SDK (May 2015), "Prior to Acrobat 6.0, signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. The manipulated portions of the signature appearance were contained in layers n1, n3 and n4. Beginning with version 6, Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of layers n1, n3, and n4 is not recommended."

SignerCaption
char*

Default Value: "#auto"

Specifies the caption for the signer section on the signature widget.

The default value, which is used if the property is set to #auto, is "Signer: ".

SignerInfo
char*

Default Value: "#auto"

Provides custom signer information to put on the signature widget.

The standard signature widget allows for several short strings separated by CRLF. Keep this property set to #auto to make the component generate the signer text automatically.

Constructors

PDFWidget()

Creates a new PDF widget 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.

Timeout
int

Default Value: 60000

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

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

UseIPv6
int

Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

TimestampInfo Type

A container for timestamp information.

Syntax

SecureBlackboxTimestampInfo (declared in secureblackbox.h)

Remarks

The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.

The following fields are available:

Fields

Accuracy
int64 (read-only)

Default Value: 0

This field indicates the accuracy of the included time mark, in microseconds.

Bytes
char* (read-only)

Default Value:

Returns the raw timestamp data in DER format.

CertificateIndex
int (read-only)

Default Value: -1

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

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.

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).

EntityLabel
char* (read-only)

Default Value: ""

Use this property to get the timestamp entity label.

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

HashAlgorithm
char* (read-only)

Default Value: ""

Returns the timestamp's hash algorithm.

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

ParentEntity
char* (read-only)

Default Value: ""

Use this property to get the label of the timestamp's parent entity.

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

SerialNumber
char* (read-only)

Default Value:

Returns the timestamp's serial number.

Time
char* (read-only)

Default Value: ""

The time point incorporated into the timestamp.

TimestampType
int (read-only)

Default Value: 0

Returns the type of the timestamp.

Available options:

tstUnknown0
tstLegacy1Supported by: Authenticode components

tstTrusted2Supported by: Authenticode components

tstGeneric3Supported by: CAdES components

tstESC4Supported by: CAdES components

tstContent5Supported by: CAdES components

tstCertsAndCRLs6Supported by: CAdES components

tstArchive7Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components

tstArchive28Archive v2 timestamp. Supported by: ASiC, CAdES components

tstArchive39Archive v3 timestamp. Supported by: ASiC, CAdES components

tstIndividualDataObjects10Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components

tstAllDataObjects11All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components

tstSignature12Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstRefsOnly13RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstSigAndRefs14SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstSignedData15SignedData timestamp. Supported by: JAdES components

tstArchive14116Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

TSAName
char* (read-only)

Default Value: ""

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

ValidationLog
char* (read-only)

Default Value: ""

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

ValidationResult
int (read-only)

Default Value: 0

Contains the timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

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)

Constructors

TimestampInfo()

Creates a new TimestampInfo object with default field values.

TLSSettings Type

A container for TLS connection settings.

Syntax

SecureBlackboxTLSSettings (declared in secureblackbox.h)

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

Fields

AutoValidateCertificates
int

Default Value: TRUE

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

BaseConfiguration
int

Default Value: 0

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

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Ciphersuites
char*

Default Value: ""

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

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

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

ClientAuth
int

Default Value: 0

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

ccatNoAuth0
ccatRequestCert1
ccatRequireCert2

ECCurves
char*

Default Value: ""

Defines the elliptic curves to enable.

Extensions
char*

Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
int

Default Value: FALSE

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

PreSharedIdentity
char*

Default Value: ""

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

PreSharedKey
char*

Default Value: ""

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

PreSharedKeyCiphersuite
char*

Default Value: ""

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

RenegotiationAttackPreventionMode
int

Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
int

Default Value: 1

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

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

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.

SSLOptions
int

Default Value: 16

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

TLSMode
int

Default Value: 0

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

UseExtendedMasterSecret
int

Default Value: FALSE

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

UseSessionResumption
int

Default Value: FALSE

Enables or disables the TLS session resumption capability.

Versions
int

Default Value: 16

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Constructors

TLSSettings()

Creates a new TLSSettings object.

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the PDFSigner class.

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

T* Set(int index, T* value) {}

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The PDFSigner class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the PDFSigner class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

Properties

CanRead Whether the stream supports reading.

bool CanRead() { return true; }
CanSeek Whether the stream supports seeking.

bool CanSeek() { return true; }
CanWrite Whether the stream supports writing.

bool CanWrite() { return true; }
Length Gets the length of the stream, in bytes.

int64 GetLength() = 0;

Methods

Close Closes the stream, releasing all resources currently allocated for it.

void Close() {}

This method is called automatically when a SecureBlackboxStream object is deleted.

Flush Forces all data held by the stream's buffers to be written out to storage.

int Flush() { return 0; }

Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0.

Read Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.

int Read(void* buffer, int count) = 0;

Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream.

Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed.

Seek Sets the current position within the stream based on a particular point of origin.

int64 Seek(int64 offset, int seekOrigin) = 0;

Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:

  • 0: Seek from beginning.
  • 1: Seek from current position.
  • 2: Seek from end.

Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged.

Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported.

Write Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.

int Write(const void* buffer, int count) = 0;

Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream.

Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (PDFSigner Class)

The class accepts one or more of the following configuration settings. Configuration 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.

PDFSigner Config Settings

AddOutputIntents:   Specifies output intents to be added to the document.

Contains a comma-separated list of values that specify output intents that should be added to the document if they are not present.

Supported values are:

GTS_PDFA1.sRGBGTS_PDFA1 corresponding to the PDF/A standard as defined by ISO 19005. sRGB IEC61966-2.1 is a standard color space.
GTS_PDFX.sRGBGTS_PDFX corresponding to the PDF/X format standard specified in ISO 15930. sRGB IEC61966-2.1 is a standard color space.

Output intents describe the final destination device you will use to reproduce the color in the PDF, such as the separations printing device. Output intents override working spaces during viewing and printing, but they do not convert the colors in the PDF.

AlternateName:   TBD.

TBD

AssemblyOptions:   Specifies the assembly options.

Contains a comma-separated list of values that specify the assembly options of the PDF document.

Supported values are:

AcrobatFriendlyAcroFormAcrobat reader friendly form
AdjustTimesToUTCAsserts that all the time properties are set in local time and should be adjusted to UTC when writing to the document

AsyncDocumentID:   Specifies the document ID for SignAsyncEnd() call.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

AutoCollectRevocationInfo:   Whether revocation info should be collected automatically.

Specifies whether revocation info should be collected automatically.

Note: This property ignored and always disabled for PAdES levels BES/EPES/BaselineB/BaselineT. For PAdES levels LTV/BaselineLT/BaselineLTA this property is also ignored and always enabled if IncludeKnownRevocationInfoToSignature property is disabled.

AutoReshapeArabicSymbols:   Specifies whether to auto-reshape Arabic symbols.

Set this property to True to auto-reshape Arabic symbols in the signature widget. In this case, the appearance of a symbol can change depending on its position and the symbols around it. When disabled, the Arabic symbols are written in isolated form.

AutoReverseRTLText:   Specifies whether to auto reverse RTL text.

Set this property to True to automatically detect and reverse RTL text to ensure proper visual presentation in the signature widget.

AutoRotateSignature:   Specifies whether to auto-rotate the signature widget.

Set this property to True to auto-rotate the signature widget based on the page rotation.

BackgroundImageBitsPerComponent:   Specifies the number of bits per color component.

Specifies the number of bits per color space component for the background image.

The default value is 0, which means that BitsPerComponent is set automatically according to the widget's BackgroundImageType field.

BackgroundImageColorSpace:   Specifies the background image color space.

Specifies the background image color space.

Supported values are:

""The default value is empty string or "none". If the widget's BackgroundImageType field is JPEG or Custom, then the default value is "RGB".
RGBDeviceRGB (3-component) color space that controls the intensities of red, green, and blue light, the three additive primary colors used in displays.
CMYKDeviceCMYK (4-component) color space that controls the concentrations of cyan, magenta, yellow, and black inks, the four subtractive process colors used in printing.
GrayDeviceGray (1-component) color space that controls the intensity of achromatic light, on a scale from black to white.

BackgroundImageInterpolate:   Specifies the background image interpolation flag.

Specifies whether background image interpolation shall be performed by a conforming reader.

BackgroundPosition:   TBD.

TBD

BuildApplicationName:   Specifies the application name used to create the signature.

Use this property to set the application name used to create the signature.

For advanced settings of the build properties, use the BuildProperties configuration setting.

BuildApplicationVersion:   Specifies the application version used to create the signature.

Use this property to set the application version used to create the signature.

For advanced settings of the build properties, use the BuildProperties configuration setting.

BuildProperties:   Specifies the build properties of the signature.

Use this property to set the build properties of the signature in JSON format. Names of JSON fields correspond to the entry names in Adobe's Digital Signature Build Dictionary Specification.

Sample value: { "App":{ "Name":"TestApp", "REx":"8.0.0" } }

The above value sets the application name and version used to create the signature. The same result could be achieved using the BuildApplicationName and BuildApplicationVersion configuration settings.

Sample value 2: { "App":{ "Name":"TestApp", "REx":"8.0.0", "R":524288, "Date":"2023-01-01 00:01", "OS":[ "Win" ], "TrustedMode":true }, "Filter":{ "Name":"TestFilter", "R":131101, "Date":"2023-01-01 00:02", "PreRelease":true }, "PubSec":{ "R":13102, "Date":"2023-01-01 00:03", "PreRelease":true, "NonEFontNoWarn":true } }

CachedCRLOverlapTime:   Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.

Use this property to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

CachedOCSPResponseOverlapTime:   Specifies the time period before a cached OCSP Response's NextUpdate when it is considered stale and must be refreshed.

Use this property to specify the number of seconds before the NextUpdate time at which the cached OCSP Response should be disregarded, and a new OCSP Response should be fetched.

ChainCurrentCACert:   Returns the current CA certificate.

This property returns the CA certificate that is used on the current step.

ChainCurrentCert:   Returns the certificate that is currently being validated.

Use this property to obtain the body of the certificate that is currently being validated.

ChainCurrentCRL:   Returns the current CRL.

Returns the CRL object that is currently being processed.

ChainCurrentCRLSize:   Returns the size of the current CRL.

This property returns the size of the CRL object that is currently being processed.

ChainCurrentOCSP:   Returns the current OCSP response.

Returns the OCSP object that is currently being processed.

ChainCurrentOCSPSigner:   Returns the signer of the current OCSP object.

Returns the signer/CA that has issued the OCSP response that is currently being processed.

ChainInterimDetails:   Returns the current interim validation details.

This property returns the interim chain validation details.

ChainInterimResult:   Returns the current interim validation result.

Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.

CheckValidityPeriodForTrusted:   Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

CollectRevInfoForTimestamps:   Whether revocation info for timestamps should be collected automatically.

Specifies whether revocation info for timestamps should be collected automatically.

This property enables collection of revocation info for any new ("fresh") timestamps, that are created during the current operation, such as signing or updating a signature with a document timestamp.

Note that revocation info for existing timestamps is always collected when updating the signature that contains them, regardless of this setting.

Commitments:   TBD.

TBD

ConfigPreferLegacyLevels:   Indicates whether legacy signature levels should be preferred.

Set this property to True to instruct the validation engine to prioritize legacy PAdES signature levels (BES, EPES, LTV) over Baseline levels (B-B, B-T, B-LT, B-LTA) when a signature can be determined as multiple levels.

TBD

CustomTextCount:   The number of custom text blocks on the signature widget.

Use this property to set or get the number of custom text blocks on the signature widget.

CustomTextFontResourceName[Index]:   The font resource name to use for the custom text block.

This indexed setting specifies the font resource name to use for the custom text block.

CustomTextFontSizeX[Index]:   The horizontal font size scale.

This indexed setting provides access to the horizontal compound of the custom text font size.

CustomTextFontSizeY[Index]:   The vertical font size scale.

This indexed setting provides access to the vertical compound of the custom text font size.

CustomTextText[Index]:   A text to show on a custom signature widget text block.

This indexed setting provides access to the text to be placed on a specific signature widget text block. CustomTextText[0] specifies the text on the first block, CustomTextText[1] on the second block, and so on. Use the CustomTextCount property to get or set the number of custom text blocks.

CustomTextX[Index]:   The horizontal offset of the text block.

This indexed setting provides access to the horizontal offset of the custom text block on the widget.

CustomTextY[Index]:   The vertical offset of the text block.

This indexed setting provides access to the vertical offset of the custom text block on the widget.

CustomTrustedLists:   Specifies the custom TrustedLists.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

CustomTSLs:   Specifies the custom TrustedLists.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

DateFontSize:   The font size of the date/time text on the signature widget.

Use this property to specify the font size to be used for the date/time text on the signature widget.

DeepValidation:   Whether a complete validation should be performed.

If this property is switched on, a "deep" signature validation is performed, i.e., all certificate chains are validated, and all revocation checks are performed.

DislikeOpenEndedOCSPs:   Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.

When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

DocumentVersion:   The document version from the PDF document header.

This property contains the PDF document version provided in the document header. The version is returned in the form "Major.Minor": for example, PDF-1.7 will be returned as "1.7", and PDF-2.0 as "2.0".

DTSAccuracy:   TBD.

TBD

DTSSerialNumber:   TBD.

TBD

DTSTime:   TBD.

TBD

DTSTSAName:   TBD.

TBD

EmptyFullFieldName:   Specifies the full name of the empty signature field to sign.

Use this property to specify the empty form field that should be signed. If the default value of "" is assigned to this property or the default value of -1 is assigned to the EmptyFieldIndex property, then a new signature field will be created.

EmptySignatureFieldAddRevInfo[Index]:   Specifies if revocation checking should be performed.

This property contains True if the viewing application should check the signing certificate revocation info and include the revocation information within the signature value.

EmptySignatureFieldAlternateName[Index]:   Contains an alternate field name.

This property contains an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface.

EmptySignatureFieldCount:   The number of empty signature form fields.

Returns the number of empty signature form fields available.

EmptySignatureFieldFlags[Index]:   The field flags of the signature form field.

This property contains the empty signature form field flags ("Ff" entry in the signature field dictionary).

EmptySignatureFieldHeight[Index]:   The Height of the empty signature form field.

This property contains the height of the empty signature form field.

EmptySignatureFieldInvisible[Index]:   The visibility status of the field.

This property contains True if the empty signature form field is visible.

EmptySignatureFieldLegalAttestations[Index]:   Specifies the legal attestations that are associated with the signature.

This property contains 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.

This property contains the name to be used when exporting form field data from the document.

EmptySignatureFieldName[Index]:   Textual field name.

This property contains the empty signature field name.

EmptySignatureFieldOffsetX[Index]:   The field's offset from the left page border.

This property contains the horizontal offset of the empty signature form field.

EmptySignatureFieldOffsetY[Index]:   The field's offset from the bottom page border.

This property contains the vertical offset of the empty signature form field.

EmptySignatureFieldPage[Index]:   The index of the form field's page in the document.

This property contains the index of the empty signature form field's page in the document.

EmptySignatureFieldRequiredAllowedChanges[Index]:   Specifies the changes allowed by the signature.

This property contains the changes that are allowed to the document when the signature field is signed.

EmptySignatureFieldRequiredConstraints[Index]:   Specifies the required Seed Value Dictionary (SVD) constraints.

This property contains the required SVD constraints. If a certain bit in RequiredConstraints is switched on, the corresponding data item is constrained.

EmptySignatureFieldRequiredDigestAlgorithms[Index]:   Specifies the required digest algorithms.

This property contains the list of the digest algorithms used for signature generation.

EmptySignatureFieldRequiredFilter[Index]:   Specifies the required filter.

This property contains the required filter (name of the preferred signature handler) to use for signature generation.

EmptySignatureFieldRequiredLockAction[Index]:   Indicates which set of fields shall be locked.

This property contains a set of form fields that shall be locked when the current signature field is signed.

EmptySignatureFieldRequiredLockFields[Index]:   Indicates the fields that shall be locked on signing.

This property contains the list of form field names that shall be locked when the current signature field is signed. Whether this list shall be included or excluded is defined by the EmptySignatureFieldRequiredLockAction[Index] property.

EmptySignatureFieldRequiredReasons[Index]:   Specifies the required reasons.

This property contains the required reasons used for signature generation.

EmptySignatureFieldRequiredSubfilters[Index]:   Specifies the required subfilters.

This property contains the list of subfilters required by the signature. A subfilter represents the encoding to use when signing the PDF form.

EmptySignatureFieldTimestampRequired[Index]:   Specifies if the signature should be timestamped.

This property contains True if the signature should be timestamped.

EmptySignatureFieldTSPURL[Index]:   URL for a TSP server.

This property contains the TSP server URL.

EmptySignatureFieldWidth[Index]:   The Width of the empty signature form field.

This property contains the width of the empty signature form field.

EnableOldSignatures:   Enables support for prehistoric adbe.x509.sha1 signatures.

Set this property to true to enable support for adbe.x509.sha1 signatures (based on raw PKCS#1 signing). Signatures of this kind are very old, insecure, and extremely rarely used. It is reasonable to only enable this setting if you are know what you are doing.

EncryptionHandlerName:   Specifies the custom security handler PDF-name.

Specifies the custom security handler PDF-name for the encryption handler.

ExtensionIdentifierMode:   Specifies the extension identifier mode.

Specifies the extension modifier mode that controls which Extension Level should be added to the PDF document while signing.

Supported values are:

noneNo extensions
ESICESIC Extension Level 2
ADBEAdobe Extension Level 8
ADBEIfNotPresentAdobe Extension Level 8 if not present
BothBoth (ESIC and Adobe) extensions

ExtraSpace:   Allows for the allocation of extra zero character space in the document behind the signature.

Use this property to allocate extra zero character space in the document behind the signature. The allocated space can be used in the future to place a timestamp.

FontPaths:   Specifies font search paths.

Use this property to provide a CRLF-separated list of paths where TrueType font files should be searched. The default value is the system font search paths.

ForceCompleteChainValidation:   Whether to check the CA certificates when the signing certificate is invalid.

Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.

ForceCompleteChainValidationForTrusted:   Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

GracePeriod:   Specifies a grace period to apply during revocation information checks.

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

HardenedKeyGeneration:   Specifies if hardened Key generation should be used.

Specifies if hardened Key generation should be used when the AES-256 encryption algorithm and password encryption are used.

IgnoreChainLoops:   Whether chain loops should be ignored.

Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

IgnoreChainValidationErrors:   Whether to ignore any certificate chain validation issues.

Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment.

IgnoreOCSPNoCheckExtension:   Whether the OCSP NoCheck extension should be ignored.

Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

IgnoreTimestampChainValidityForLevelDetection:   Specify whether timestamp chain validity should be ignored during signature level detection.

Set this property to True to instruct the validation engine to disregard the validity of the timestamp signer certificate chain when determining the signature level.

TBD

IgnoreTimestampFailure:   Whether to ignore timestamping failures during signing.

Specifies whether to ignore timestamping failures during signing.

ImplicitlyTrustSelfSignedCertificates:   Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings.

IncludeKnownRevInfoToSignature:   Whether to include custom revocation info into the signature.

This property specifies whether revocation pieces provided via the KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

Note: it makes sense to disable AutoCollectRevocationInfo property when using this property. TBD equals to IncludeKnownRevocationInfoToSignature

IncludeKnownRevocationInfoToSignature:   Whether to include custom revocation info into the signature.

This property specifies whether revocation pieces provided via the KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

Note: it makes sense to disable AutoCollectRevocationInfo property when using this property.

IncludeRevocationInfo:   Whether to include custom revocation info into the signature.

This property specifies whether revocation pieces provided via the KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

Note: it makes sense to disable AutoCollectRevocationInfo property when using this property. TBD equals to IncludeKnownRevocationInfoToSignature

IncludeRevocationInfoToAdbeAttribute:   Whether to save revocation info in PDF-compliant form.

The format of revocation info in AdES signatures does not comply with PDF standards. If this property is switched on, the revocation info will be saved in PDF-compliant form.

LastSignatureWidget:   Specifies that it is the last signature widget to be added.

Set this property to False to add one more signature widget along with the signature.

This setting is used by the Notification event when the EventID parameter is "SignatureWidgetPrepare" to allow support for multi-widget signatures.

Locked:   TBD.

TBD

LockedContents:   TBD.

TBD

MappingName:   TBD.

TBD

MDPHashAlgorithm:   Specifies the MDP hash algorithm.

Use this property to control the hash algorithm's signature references (DocMDP, FieldMDP transforms).

The following values are supported:

"auto"Default value. The class automatically select the hash algorithm based on the PDF document version. For version 1.6 and higher it uses "none" value, for the other versions it uses MD5 hash algorithm.
"MD5"The class uses MD5 hash algorithm.
"SHA1"The class uses SHA1 hash algorithm.
"none"The class will not calculate a digest and will not include DigestLocation, DigestMethod, and DigestValue keys of the Signature References dictionary.

PAdESOptions:   Specifies the PAdES options.

Contains a comma-separated list of values that specify the PAdES options.

Supported values are:

UseSigningCertificateV2When this flag is set, the signing certificate V2 attribute will be used.
IncludeAllRevInfoToDSSWhen this flag is set, the full set of revocation information will be included in the DSS dictionary.
CreateVRIDictionariesWhen this flag is set, VRI dictionaries will be created. A VRI dictionary references all the validation data that has been used for validating one specific signature.
UseUndefBEREncodingWhen this flag is set, ASN.1 tags with undefined sizes are allowed in the signature.
TolerateMissingSigningCertificateWhen this flag is set, a missing signing certificate attribute will be tolerated.
CompressDSSWhen this flag is set, content in DSS dictionary will be compressed.
CreatePBADCompatibleSignatureWhen this flag is set, the PBAD.PAdES compatible signature is created.
EnforcePDFAComplianceWhen this flag is set, the component will enforce PDF/A compliance during signing. In rare cases this may lead to exceptions being thrown if the signing chain is too heavy to fit into the PDF/A restrictions.

PageInfoCount:   The number of pages.

Returns the number of pages available.

PageInfoCropBoxEmpty[Index]:   Check if the page's crop box is empty or not.

This property contains True if the crop box is empty, and False otherwise. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

PageInfoCropLLX[Index]:   Defines the X coordinate of the lower left corner of the crop box.

This property contains the X coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

PageInfoCropLLY[Index]:   Defines the Y coordinate of the lower left corner of the crop box.

This property contains the Y coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

PageInfoCropURX[Index]:   Defines the X coordinate of the upper right corner of the crop box.

This property contains the X coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

PageInfoCropURY[Index]:   Defines the Y coordinate of the upper right corner of the crop box.

This property contains the Y coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

PageInfoHeight[Index]:   The Height of the page.

This property contains the page height value.

PageInfoMediaLLX[Index]:   Defines the X coordinate of the lower left corner of the media box.

This property contains the X coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.

PageInfoMediaLLY[Index]:   Defines the Y coordinate of the lower left corner of the media box.

This property contains the Y coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.

PageInfoMediaURX[Index]:   Defines the X coordinate of the upper right corner of the media box.

This property contains the X coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.

PageInfoMediaURY[Index]:   Defines the Y coordinate of the upper right corner of the media box.

This property contains the Y coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.

PageInfoRotate[Index]:   The Rotate value of the page.

This property contains the page rotation angle.

PageInfoUserUnit[Index]:   Defines the size of default user space units.

This property contains a positive number that shall give the size of default user space units, in multiples of 1/72 inch. The default value is 1.0 (user space unit is 1/72 inch).

PageInfoWidth[Index]:   The Width of the page.

This property contains the page width value.

PolicyDescription:   signature policy description.

This property specifies the Description of the signature policy.

PolicyExplicitText:   The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.

PolicyUNNumbers:   The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

PolicyUNOrganization:   The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.

PredefinedSignatureSize:   User-defined size of the signature.

User-defined size of the signature.

ProductionPlace:   Identifies the place of the signature production.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

PromoteLongOCSPResponses:   Whether long OCSP responses are requested.

Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

PSSUsed:   Whether to use RSASSA-PSS algorithm.

Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for UsePSS.

RC4KeyBits:   Specifies the number of key bits used for the RC4 algorithm.

Specifies the number of key bits used for the RC4 encryption algorithm.

ReassembleMode:   Specifies the document reassemble mode.

Use this property to control if the PDF document should be reassembled before signing/saving it. This property doesn't have any effect on PDF documents that have already been signed.

The following values are supported:

"auto"Default value. The class automatically reassembles PDF documents in case they contain errors that may invalidate new signatures.
"disabled"The class never reassembles PDF documents. This value is not recommended.
"enabled"The class always reassembles PDF documents.
"hybrid"The class reassembles PDF documents in the same cases as in "auto" mode and additionally reassembles hybrid PDF documents - documents that contain cross-reference tables and cross-reference streams.

SchemeParams:   The algorithm scheme parameters to employ.

Use this property to specify the parameters of the algorithm scheme if needed.

This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.

SectionTextFontSize:   The font size of general text on the signature widget.

Use this property to specify the font size to be used for general text on the signature widget.

SectionTitleFontSize:   The font size of the section title on the signature widget.

Use this property to specify the font size to be used for the section title text on the signature widget.

SignatureOptions:   Specifies the signature options.

Contains a comma-separated list of values that specify signature options.

Supported values are:

SuppressEmptyAuthorNameWhen this flag is not set, the author name in the signature is set to "Not specified".
AddAnnotationForInvisibleSignatureWhen this flag is set, the annotation object is added for invisible signatures.

SignatureSizeEstimationStrategy:   Which mechanism to use to estimate the size of a PAdES signature.

What mechanism should be used to estimate the size of a PAdES signature. Possible values: 0 - a very rough estimate: 16384 bytes for the signature, plus an extra 16384 bytes if the adbe-revInfoArchival attribute is included; 1 - sum the sizes of the certificate, revocation information, signer info and adds 8192 bytes for a timestamp; 2 - in addition to the sizes of the certificate and revocation data, estimate the exact size of the timestamp; 3 - user-defined size.

SigPolicyDescription:   signature policy description.

This property specifies the Description of the signature policy (an alias for PolicyDescription).

SigPolicyExplicitText:   The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

SigPolicyHash:   The EPES policy hash.

Use this configuration setting to provide the EPES policy hash.

SigPolicyHashAlgorithm:   The hash algorithm that was used to generate the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash.

SigPolicyID:   The EPES policy ID.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

SigPolicyNoticeNumbers:   The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

SigPolicyNoticeOrganization:   The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

SigPolicyURI:   The EPES policy URI.

Assign the EPES policy URI to this setting.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TextObjEncoding:   The encoding to apply to string objects stored with the signature.

This property controls the way the string elements of the signature are encoded. The following values are supported: 0 (default), 1 (binary), 2 (hexadecimal). Non-ASCII elements often require the hexadecimal encoding to be used.

TimestampResponse:   A base16-encoded timestamp response received from a TSA.

When using virtual:// timestamp endpoints, assign this property in your Notification event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).

TitleFontSize:   The font size of the main title on the signature widget.

Use this property to specify the font size to be used for the main title on the signature widget.

TLSChainValidationDetails:   Contains the advanced details of the TLS server certificate validation.

Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.

TLSChainValidationResult:   Contains the result of the TLS server certificate validation.

Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.

TLSClientAuthRequested:   Indicates whether the TLS server requests client authentication.

Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the class may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

TLSValidationLog:   Contains the log of the TLS server certificate validation.

Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server.

TolerateMinorChainIssues:   Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

  • CA, revocation source, TLS key usage requirements are not mandated
  • Violation of OCSP issuer requirements are ignored
  • The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
  • Basic constraints and name constraints of CA certificates are ignored
  • Some weaker algorithms are tolerated
TransparentColor:   TBD.

TBD

TransparentColorDelta:   TBD.

TBD

TransparentColorX:   TBD.

TBD

TransparentColorY:   TBD.

TBD

TspAttemptCount:   Specifies the number of timestamping request attempts.

Use this property to specify a number of timestamping request attempts.

In case of a timestamping failure, provide new TSA and HTTP settings inside the Notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).

TspHashAlgorithm:   Sets a specific hash algorithm for use with the timestamping service.

In default configuration class uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

Note: Unlike other classs, PDFSigner class uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.

TspReqPolicy:   Sets a request policy ID to include in the timestamping request.

Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).

UpdateKind:   Adjusts the scope of modifications that are made to the signature with the Update method.

This property adjusts the kind of modifications to the document that an Update() call makes.

With this property set to the default setting (default), Update() refreshes the validation details included in the signature using any available revocation information sources. It also seals the added elements with a Document Timestamp if the TSA is provided through the TimestampServer property.

The only alternative setting is TimestampOnly, which instructs Update() to only timestamp the updated non-timestamped signature with a signature timestamp. No validation information collection is performed and no Document Timestamp is added. The TimestampOnly variant requires the TimestampServer property to be set.

UseDefaultTrustedLists:   Enables or disables the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

UseDefaultTSLs:   Enables or disables the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

UseLegacyVisualStyle:   Specifies whether to use the legacy signature visual style.

Set this property to False to use the new signature visual style.

UseMicrosoftCTL:   Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UsePSS:   Whether to use RSASSA-PSS algorithm.

Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations.

UseSystemCertificates:   Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

UseValidationCache:   Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start.

UseValidatorSettingsForTLSValidation:   Whether to employ the primary chain validator setup for auxiliary TLS chain validations.

Use this property to specify whether you would like to use the primary (AdES) chain validator component to validate TLS chains for any connections involved (OCSP, CRL).

WidgetHeight:   Specifies the height of the signature widget.

Use this property to set the height of the signature widget in points. Integer and float values are supported.

This property extends the Height field to allow the height of the signature widget to be specified in fractional points.

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

Use this property to set the signature widget offset from the left-hand page border. Integer and float values are supported.

This property extends the OffsetX field to allow the offset of the signature widget to be specified in fractional points.

WidgetOffsetY:   Specifies the signature widget offset from the bottom page border.

Use this property to set the signature widget offset from the bottom page border. Integer and float values are supported.

This property extends the OffsetY field to allow the offset of the signature widget to be specified in fractional points.

WidgetWidth:   Specifies the width of the signature widget.

Use this property to set the width of the signature widget in points. Integer and float values are supported.

This property extends the Width field to allow the width of the signature widget to be specified in fractional points.

XMPMetadataContent:   The XMP metadata content.

Use this config property to read or set the XMP metadata content.

Base Config Settings

ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter:   The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

certificateEnables caching of certificates.
crlEnables caching of Certificate Revocation Lists (CRLs).
ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath:   Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion:   Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (PDFSigner Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PDFSigner Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)
26214401   The input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS)
26214402   Cannot encrypt already encrypted file (SB_ERROR_PDF_ENCRYPTED)
26214403   The file is not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED)
26214405   Invalid password (SB_ERROR_PDF_INVALID_PASSWORD)
26214406   Failed to decrypt the file (SB_ERROR_PDF_DECRYPTION_FAILED)
26214407   The document is signed (SB_ERROR_PDF_SIGNED)
26214408   The document is not signed (SB_ERROR_PDF_NOT_SIGNED)
26214409   Cannot update this type of signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE)
26214410   Unsupported feature or operation (SB_ERROR_PDF_NOT_SUPPORTED)
26214411   No timestamp server specified (SB_ERROR_PDF_NO_TIMESTAMP_SERVER)
26214412   The component is not in edit mode (SB_ERROR_PDF_READONLY)