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.
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 property (Note: when creating EPES signatures you need to provide the signature and 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 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 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.
AttachedFileCount | The number of records in the AttachedFiles arrays. |
AttachedFilesContentSubtype | Contains the content subtype of the attachment. |
AttachedFilesContentType | Contains the content type of the attachment. |
AttachedFilesCreationDate | The creation date. |
AttachedFilesData | The content of the attachment. |
AttachedFilesDescription | Textual description of the attachment. |
AttachedFilesFilename | Specifies the name of the attachment file. |
AttachedFilesHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
AttachedFilesID | Contains the attachment's unique identifier. |
AttachedFilesModificationDate | Specifies the date and time of the file's last modification. |
AttachedFilesReadDate | Specifies the file's last read date. |
AttachedFilesSize | The attachment's size in bytes. |
AutoValidateSignatures | Specifies whether PDFSigner should validate any present signatures when the document is opened. |
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns the raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertCount | The number of records in the Cert arrays. |
CertBytes | Returns the raw certificate data in DER format. |
CertCA | Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension). |
CertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CertCurve | Specifies the elliptic curve of the EC public key. |
CertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
CertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CertKeyBits | Returns the length of the public key. |
CertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CertPublicKeyBytes | Contains the certificate's public key in DER format. |
CertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CertSerialNumber | Returns the certificate's serial number. |
CertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CertValidTo | The time point at which the certificate expires, in UTC. |
CRLCount | The number of records in the CRL arrays. |
CRLBytes | Returns the raw CRL data in DER format. |
CRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CRLIssuer | The common name of the CRL issuer (CA), typically a company name. |
CRLIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
CRLLocation | The URL that the CRL was downloaded from. |
CRLNextUpdate | The planned time and date of the next version of this CRL to be published. |
CRLThisUpdate | The date and time at which this version of the CRL was published. |
DecryptionCertificateBytes | Returns the raw certificate data in DER format. |
DecryptionCertificateHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
DocumentInfoEncryptionAlgorithm | The symmetric algorithm used to encrypt the document. |
DocumentInfoEncryptionType | The document encryption type. |
DocumentInfoMetadataEncrypted | Indicates if the document metadata is encrypted. |
DocumentInfoPermissions | Contains the document permissions associated with the encryption. |
EmptyFieldIndex | Specifies the index of the empty signature field to sign. |
ExternalCryptoAsyncDocumentID | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
FIPSMode | Reserved. |
IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
InputBytes | Use this property to pass the input to class in byte array form. |
InputFile | The PDF file to be signed or updated. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns the raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns the raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | A buffer containing the raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
NewSigAllowedChanges | The changes to the document allowed by the signature. |
NewSigAuthorName | A human-readable signer name. |
NewSigCertificateIndex | Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection. |
NewSigCertification | Specifies whether this is a Certification (MDP) signature. |
NewSigChainValidationDetails | The details of a certificate chain validation outcome. |
NewSigChainValidationResult | The outcome of a certificate chain validation routine. |
NewSigClaimedSigningTime | Returns or sets the signature's creation time. |
NewSigContactInfo | Contains the signer's contact information. |
NewSigCoverageEndsAt | Indicates the offset in the PDF file where signature coverage ends. |
NewSigCustomData | Uninterpreted custom data to save with the signature. |
NewSigEmptyField | Indicates whether or not the signature created/read is an empty property (a signature placeholder). |
NewSigFilterName | The signature filter name. |
NewSigFullSignatureName | Specifies the full name of the signature property. |
NewSigHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
NewSigHashAlgorithm | Specifies the hash algorithm to be used for signing. |
NewSigHeight | Specifies the height of the signature widget. |
NewSigLevel | Specifies the signature kind and level. |
NewSigLocation | Specifies the host name or the physical location of the signing entity. |
NewSigOffsetX | Specifies the signature widget offset from the left-hand page border. |
NewSigOffsetY | Specifies the signature widget offset from the bottom page border. |
NewSigPage | Indicates the index of the page on which the signature is placed. |
NewSigPolicyHash | The signature policy hash value for EPES signatures. |
NewSigPolicyHashAlgorithm | The algorithm that was used to calculate the signature policy hash. |
NewSigPolicyID | The policy ID to be included into the signature. |
NewSigReason | Specifies the reason for signing. |
NewSigSignatureBytes | Returns the binary representation of the underlying PKCS7 signature blob. |
NewSigSignatureName | Specifies the unique signature identifier to use. |
NewSigSignatureValidationResult | The outcome of the cryptographic signature validation. |
NewSigSubjectRDN | Contains the RDN of the owner of the signing certificate. |
NewSigTimestamped | Use this property to establish whether the signature contains an embedded timestamp. |
NewSigValidatedSigningTime | Contains the certified signing time. |
NewSigValidationLog | Contains the signing certificate's chain validation log. |
NewSigWidth | Specifies the width of the signature widget. |
OCSPCount | The number of records in the OCSP arrays. |
OCSPBytes | A buffer containing the raw OCSP response data. |
OCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
OCSPIssuer | Indicates the issuer of this response (a CA or its authorized representative). |
OCSPIssuerRDN | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
OCSPLocation | The location of the OCSP responder. |
OCSPProducedAt | Specifies the time when the response was produced, in UTC. |
OfflineMode | Switches the class to offline mode. |
OutputBytes | Use this property to read the output the class object has produced. |
OutputFile | The file to save the signed or updated document to. |
PageCount | The number of records in the Page arrays. |
PageCropLLX | Specifies the lower-left X coordinate of the page crop area. |
PageCropLLY | Specifies the lower-left Y coordinate of the page crop area. |
PageCropURX | Specifies the upper-right X coordinate of the page crop area. |
PageCropURY | Specifies the upper-right Y coordinate of the page crop area. |
PageHeight | Specifies the height of the page. |
PageMediaLLX | Specifies the lower-left X coordinate of the page media area. |
PageMediaLLY | Specifies the lower-left Y coordinate of the page media area. |
PageMediaURX | Specifies the upper-right X coordinate of the page media area. |
PageMediaURY | Specifies the upper-right Y coordinate of the page media area. |
PageRotate | Specifies the rotation angle of the page in degrees. |
PageWidth | Specifies the width of the page. |
Password | The decryption password. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
SignatureCount | The number of records in the Signature arrays. |
SignatureAllowedChanges | The changes to the document allowed by the signature. |
SignatureAuthorName | A human-readable signer name. |
SignatureCertificateIndex | Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection. |
SignatureCertification | Specifies whether this is a Certification (MDP) signature. |
SignatureChainValidationDetails | The details of a certificate chain validation outcome. |
SignatureChainValidationResult | The outcome of a certificate chain validation routine. |
SignatureClaimedSigningTime | Returns or sets the signature's creation time. |
SignatureContactInfo | Contains the signer's contact information. |
SignatureCoverageEndsAt | Indicates the offset in the PDF file where signature coverage ends. |
SignatureCustomData | Uninterpreted custom data to save with the signature. |
SignatureEmptyField | Indicates whether or not the signature created/read is an empty property (a signature placeholder). |
SignatureFilterName | The signature filter name. |
SignatureFullSignatureName | Specifies the full name of the signature property. |
SignatureHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SignatureHashAlgorithm | Specifies the hash algorithm to be used for signing. |
SignatureHeight | Specifies the height of the signature widget. |
SignatureLevel | Specifies the signature kind and level. |
SignatureLocation | Specifies the host name or the physical location of the signing entity. |
SignatureOffsetX | Specifies the signature widget offset from the left-hand page border. |
SignatureOffsetY | Specifies the signature widget offset from the bottom page border. |
SignaturePage | Indicates the index of the page on which the signature is placed. |
SignaturePolicyHash | The signature policy hash value for EPES signatures. |
SignaturePolicyHashAlgorithm | The algorithm that was used to calculate the signature policy hash. |
SignaturePolicyID | The policy ID to be included into the signature. |
SignatureReason | Specifies the reason for signing. |
SignatureSignatureBytes | Returns the binary representation of the underlying PKCS7 signature blob. |
SignatureSignatureName | Specifies the unique signature identifier to use. |
SignatureSignatureValidationResult | The outcome of the cryptographic signature validation. |
SignatureSubjectRDN | Contains the RDN of the owner of the signing certificate. |
SignatureTimestamped | Use this property to establish whether the signature contains an embedded timestamp. |
SignatureValidatedSigningTime | Contains the certified signing time. |
SignatureValidationLog | Contains the signing certificate's chain validation log. |
SignatureWidth | Specifies the width of the signature widget. |
SigningCertBytes | Returns the raw certificate data in DER format. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningChainCount | The number of records in the SigningChain arrays. |
SigningChainBytes | Returns the raw certificate data in DER format. |
SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
TimestampCount | The number of records in the Timestamp arrays. |
TimestampAccuracy | This property indicates the accuracy of the included time mark, in microseconds. |
TimestampBytes | Returns the raw timestamp data in DER format. |
TimestampCertificateIndex | Returns the index of the TSA certificate in the Certificates collection. |
TimestampChainValidationDetails | The details of a certificate chain validation outcome. |
TimestampChainValidationResult | The outcome of a certificate chain validation routine. |
TimestampHashAlgorithm | Returns the timestamp's hash algorithm. |
TimestampSerialNumber | Returns the timestamp's serial number. |
TimestampSignatureIndex | Returns the index of the owner signature, if applicable. |
TimestampTime | The time point incorporated into the timestamp. |
TimestampTimestampType | Returns the type of the timestamp. |
TimestampTSAName | This value uniquely identifies the Timestamp Authority (TSA). |
TimestampValidationLog | Contains the TSA certificate chain validation log. |
TimestampValidationResult | Contains the timestamp validation outcome. |
TimestampServer | The address of the timestamping server. |
TLSClientCertCount | The number of records in the TLSClientCert arrays. |
TLSClientCertBytes | Returns the raw certificate data in DER format. |
TLSClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns the raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects the renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables the TLS session resumption capability. |
TLSVersions | The SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns the raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ValidationMoment | The time point at which signature validity is to be established. |
WidgetAlgorithmCaption | The caption of the signature widget property with information about the signature algorithm. |
WidgetAlgorithmInfo | Information about the algorithm to be shown on the signature widget. |
WidgetBackgroundData | Contains/takes the data of the signature widget background bitmap. |
WidgetBackgroundHeight | Use this property to manually adjust the size of the stretched background picture in the vertical direction. |
WidgetBackgroundImageHeight | The height of the background image in pixels. |
WidgetBackgroundImageType | The type of the image contained in BackgroundData . |
WidgetBackgroundImageWidth | The width of the background image in pixels. |
WidgetBackgroundMask | Contains the background image mask. |
WidgetBackgroundPosition | The position of the widget background. |
WidgetBackgroundStyle | The style of the signature widget background. |
WidgetBackgroundWidth | Use this property to manually adjust the horizontal size of the stretched background picture. |
WidgetCompressWidgetData | Whether the signature widget data should be compressed before saving. |
WidgetCustomAppearance | Contains a custom widget description in raw PDF graphic operators format. |
WidgetCustomBackgroundContentStream | Specifies a custom background content stream for the pwbsCustom BackgroundStyle . |
WidgetCustomVisualStatusMatrix | Defines the custom visual status matrix. |
WidgetDateFormat | The format string used to display the signing date and time in the signature widget. |
WidgetFontName | Specifies the font name for the signature text. |
WidgetHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
WidgetHeader | Specifies the header text to put on the signature widget. |
WidgetHideDefaultText | Switches off the generation of any headers for the signature widget. |
WidgetIgnoreExistingAppearance | Tells the class to discard any existing widget parameters when signing empty signature properties. |
WidgetInvertMask | Specifies whether BackgroundMask should be inverted. |
WidgetInvisible | Controls whether the signature widget is visible on the page. |
WidgetPagesToPlaceOn | The page numbers on which the signature is shown. |
WidgetPositionAnchor | The anchor to bind the position of the widget to. |
WidgetRenderOptions | This setting is a container for a selection of rendering options. |
WidgetRotate | Specifies the rotation angle of the signature widget in degrees. |
WidgetShowDate | Whether to display the signing date and time details on the widget. |
WidgetShowVisualStatus | Specifies whether to show the signature's status icon. |
WidgetSignerCaption | Specifies the caption for the signer section on the signature widget. |
WidgetSignerInfo | Provides custom signer information to put on the signature widget. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddWidgetCustomData | Adds a custom data to the signature widget. |
AddWidgetText | Adds a text block to the signature widget. |
AddWidgetTextEx | Adds a text block to the signature widget. |
AttachBytes | Adds an attachment to the PDF document. |
AttachFile | Adds an attachment to the PDF document. |
AttachStream | Adds an attachment to the PDF document. |
Close | Closes an opened document. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
ExtractAsyncData | Extracts user data from the DC signing service response. |
GetAttachedBytes | Saves a PDF attachment to a byte array. |
GetAttachedFile | Saves a PDF attachment to a file. |
GetAttachedStream | Saves a PDF attachment to a stream. |
Open | Opens a document for signing or updating. |
Revalidate | Revalidates a signature in accordance with current settings. |
Sign | Signs a PDF document. |
SignAsyncBegin | Initiates the asynchronous signing operation. |
SignAsyncEnd | Completes the asynchronous signing operation. |
SignExternal | Signs the document using an external signing facility. |
Update | Updates 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.
ChainElementDownload | Fires when there is a need to download a chain element from an online source. |
ChainElementNeeded | Fires when an element required to validate the chain was not located. |
ChainValidated | Reports the completion of a certificate chain validation. |
ChainValidationProgress | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
DocumentLoaded | This event is fired when the document has been loaded into memory. |
Encrypted | Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document. |
Error | Information about errors during signing/validation. |
ExternalDecrypt | Handles remote or external decryption. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
Notification | This event notifies the application about an underlying control flow event. |
PreRenderWidget | Fires when a signature widget is ready to be written to the document. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Marks the completion of the signature validation routine. |
TimestampFound | Signifies the start of a timestamp validation routine. |
TimestampRequest | Fires when the class is ready to request a timestamp from an external TSA. |
TimestampValidated | Reports the completion of the timestamp validation routine. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSShutdown | Reports 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.
AddOutputIntents | Specifies output intents to be added to the document. |
AssemblyOptions | Specifies the assembly options. |
AutoCollectRevocationInfo | Whether revocation info should be collected automatically. |
AutoReshapeArabicSymbols | Specifies whether to auto-reshape Arabic symbols. |
AutoReverseRTLText | Specifies whether to auto reverse RTL text. |
AutoRotateSignature | Specifies whether to auto-rotate the signature widget. |
BackgroundImageBitsPerComponent | Specifies the number of bits per color class. |
BackgroundImageColorSpace | Specifies the background image color space. |
BackgroundImageInterpolate | Specifies the background image interpolation flag. |
BuildApplicationName | Specifies the application name used to create the signature. |
BuildApplicationVersion | Specifies the application version used to create the signature. |
BuildProperties | Specifies the build properties of the signature. |
CollectRevInfoForTimestamps | Whether revocation info for timestamps should be collected automatically. |
CustomTextCount | The 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. |
DateFontSize | The font size of the date/time text on the signature widget. |
DeepValidation | Whether a complete validation should be performed. |
DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
EmptyFullFieldName | Specifies 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. |
EmptySignatureFieldCount | The 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. |
EncryptionHandlerName | Specifies the custom security handler PDF-name. |
ExtensionIdentifierMode | Specifies the extension identifier mode. |
ExtraSpace | Allows for the allocation of extra zero character space in the document behind the signature. |
FontPaths | Specifies font search paths. |
ForceCompleteChainValidation | Whether to check issuer (CA) certificates when the signing certificate is invalid. |
ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
GracePeriod | Specifies a grace period to apply during revocation information checks. |
HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
IgnoreChainLoops | Whether chain loops should be ignored. |
IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
IgnoreTimestampFailure | Whether to ignore timestamping failures during signing. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info into the signature. |
IncludeRevocationInfoToAdbeAttribute | Whether to save revocation info in PDF-compliant form. |
LastSignatureWidget | Specifies that it is the last signature widget to be added. |
PAdESOptions | Specifies the PAdES options. |
PageInfoCount | The 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. |
PolicyExplicitText | The explicit text of the user notice. |
PolicyUNNumbers | The noticeNumbers part of the NoticeReference PAdES-EPES attribute. |
PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
PolicyURI | The URI of the signature policy. |
PredefinedSignatureSize | User-defined size of the signature. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
RC4KeyBits | Specifies the number of key bits used for the RC4 algorithm. |
ReassembleMode | Specifies the document reassemble mode. |
SchemeParams | The algorithm scheme parameters to employ. |
SectionTextFontSize | The font size of general text on the signature widget. |
SectionTitleFontSize | The font size of the section title on the signature widget. |
SignatureCount | The number of signatures. |
SignatureHeight[Index] | The Height of the signature widget. |
SignatureInvisible[Index] | The visibility status of the signature. |
SignatureName[Index] | Textual signature name. |
SignatureOffsetX[Index] | The siganture widget's offset from the left page border. |
SignatureOffsetY[Index] | The signature widget's offset from the bottom page border. |
SignatureOptions | Specifies the signature options. |
SignaturePage[Index] | The index of the signature widget's page in the document. |
SignatureSizeEstimationStrategy | Which mechanism to use to estimate the size of a PAdES signature. |
SignatureWidth[Index] | The Width of the signature widget. |
TempPath | Location where the temporary files are stored. |
TextObjEncoding | The encoding to apply to string objects stored with the signature. |
TitleFontSize | The font size of the main title on the signature widget. |
TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
TLSValidationLog | Contains the log of the TLS server certificate validation. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
TspAttemptCount | Specifies the number of timestamping request attempts. |
TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
UpdateKind | Adjusts the scope of modifications that are made to the signature with the Update method. |
UseLegacyVisualStyle | Specifies whether to use the legacy signature visual style. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UsePSS | Whether to use the RSASSA-PSS algorithm. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
WidgetHeight | Specifies the height of the signature widget. |
WidgetOffsetX | Specifies the signature widget offset from the left-hand page border. |
WidgetOffsetY | Specifies the signature widget offset from the bottom page border. |
WidgetWidth | Specifies the width of the signature widget. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
AttachedFileCount Property (PDFSigner Class)
The number of records in the AttachedFiles arrays.
Syntax
ANSI (Cross Platform) int GetAttachedFileCount(); Unicode (Windows) INT GetAttachedFileCount();
int secureblackbox_pdfsigner_getattachedfilecount(void* lpObj);
int GetAttachedFileCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- AttachedFilesContentSubtype
- AttachedFilesContentType
- AttachedFilesCreationDate
- AttachedFilesData
- AttachedFilesDescription
- AttachedFilesFilename
- AttachedFilesHandle
- AttachedFilesID
- AttachedFilesModificationDate
- AttachedFilesReadDate
- AttachedFilesSize
The array indices start at 0 and end at AttachedFileCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
AttachedFilesContentSubtype Property (PDFSigner Class)
Contains the content subtype of the attachment.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesContentSubtype(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesContentSubtype(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilescontentsubtype(void* lpObj, int attachedfileindex);
QString GetAttachedFilesContentSubtype(int iAttachedFileIndex);
Default Value
""
Remarks
Contains the content subtype of the attachment.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesContentType Property (PDFSigner Class)
Contains the content type of the attachment.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesContentType(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesContentType(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilescontenttype(void* lpObj, int attachedfileindex);
QString GetAttachedFilesContentType(int iAttachedFileIndex);
Default Value
""
Remarks
Contains the content type of the attachment.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesCreationDate Property (PDFSigner Class)
The creation date.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesCreationDate(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesCreationDate(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilescreationdate(void* lpObj, int attachedfileindex);
QString GetAttachedFilesCreationDate(int iAttachedFileIndex);
Default Value
""
Remarks
The creation date.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesData Property (PDFSigner Class)
The content of the attachment.
Syntax
ANSI (Cross Platform) int GetAttachedFilesData(int iAttachedFileIndex, char* &lpAttachedFilesData, int &lenAttachedFilesData); Unicode (Windows) INT GetAttachedFilesData(INT iAttachedFileIndex, LPSTR &lpAttachedFilesData, INT &lenAttachedFilesData);
int secureblackbox_pdfsigner_getattachedfilesdata(void* lpObj, int attachedfileindex, char** lpAttachedFilesData, int* lenAttachedFilesData);
QByteArray GetAttachedFilesData(int iAttachedFileIndex);
Remarks
The content of the attachment.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
AttachedFilesDescription Property (PDFSigner Class)
Textual description of the attachment.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesDescription(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesDescription(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilesdescription(void* lpObj, int attachedfileindex);
QString GetAttachedFilesDescription(int iAttachedFileIndex);
Default Value
""
Remarks
Textual description of the attachment.
This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesFilename Property (PDFSigner Class)
Specifies the name of the attachment file.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesFilename(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesFilename(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilesfilename(void* lpObj, int attachedfileindex);
QString GetAttachedFilesFilename(int iAttachedFileIndex);
Default Value
""
Remarks
Specifies the name of the attachment file.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetAttachedFilesHandle(int iAttachedFileIndex); Unicode (Windows) LONG64 GetAttachedFilesHandle(INT iAttachedFileIndex);
int64 secureblackbox_pdfsigner_getattachedfileshandle(void* lpObj, int attachedfileindex);
qint64 GetAttachedFilesHandle(int iAttachedFileIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
Long64
AttachedFilesID Property (PDFSigner Class)
Contains the attachment's unique identifier.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesID(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesID(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilesid(void* lpObj, int attachedfileindex);
QString GetAttachedFilesID(int iAttachedFileIndex);
Default Value
""
Remarks
Contains the attachment's unique identifier.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesModificationDate Property (PDFSigner Class)
Specifies the date and time of the file's last modification.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesModificationDate(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesModificationDate(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilesmodificationdate(void* lpObj, int attachedfileindex);
QString GetAttachedFilesModificationDate(int iAttachedFileIndex);
Default Value
""
Remarks
Specifies the date and time of the file's last modification.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesReadDate Property (PDFSigner Class)
Specifies the file's last read date.
Syntax
ANSI (Cross Platform) char* GetAttachedFilesReadDate(int iAttachedFileIndex); Unicode (Windows) LPWSTR GetAttachedFilesReadDate(INT iAttachedFileIndex);
char* secureblackbox_pdfsigner_getattachedfilesreaddate(void* lpObj, int attachedfileindex);
QString GetAttachedFilesReadDate(int iAttachedFileIndex);
Default Value
""
Remarks
Specifies the file's last read date.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
String
AttachedFilesSize Property (PDFSigner Class)
The attachment's size in bytes.
Syntax
ANSI (Cross Platform) int64 GetAttachedFilesSize(int iAttachedFileIndex); Unicode (Windows) LONG64 GetAttachedFilesSize(INT iAttachedFileIndex);
int64 secureblackbox_pdfsigner_getattachedfilessize(void* lpObj, int attachedfileindex);
qint64 GetAttachedFilesSize(int iAttachedFileIndex);
Default Value
0
Remarks
The attachment's size in bytes.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only and not available at design time.
Data Type
Long64
AutoValidateSignatures Property (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
BlockedCertCount Property (PDFSigner Class)
The number of records in the BlockedCert arrays.
Syntax
ANSI (Cross Platform) int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); Unicode (Windows) INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);
int secureblackbox_pdfsigner_getblockedcertcount(void* lpObj);
int secureblackbox_pdfsigner_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at BlockedCertCount - 1.
This property is not available at design time.
Data Type
Integer
BlockedCertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes); Unicode (Windows) INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);
int secureblackbox_pdfsigner_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);
Remarks
Returns the raw certificate data in DER format.
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
BlockedCertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle); Unicode (Windows) LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);
int64 secureblackbox_pdfsigner_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_pdfsigner_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is not available at design time.
Data Type
Long64
CertCount Property (PDFSigner Class)
The number of records in the Cert arrays.
Syntax
ANSI (Cross Platform) int GetCertCount(); Unicode (Windows) INT GetCertCount();
int secureblackbox_pdfsigner_getcertcount(void* lpObj);
int GetCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- CertBytes
- CertCA
- CertCAKeyID
- CertCRLDistributionPoints
- CertCurve
- CertFingerprint
- CertFriendlyName
- CertHandle
- CertHashAlgorithm
- CertIssuer
- CertIssuerRDN
- CertKeyAlgorithm
- CertKeyBits
- CertKeyFingerprint
- CertKeyUsage
- CertKeyValid
- CertOCSPLocations
- CertPolicyIDs
- CertPublicKeyBytes
- CertSelfSigned
- CertSerialNumber
- CertSigAlgorithm
- CertSubject
- CertSubjectKeyID
- CertSubjectRDN
- CertValidFrom
- CertValidTo
The array indices start at 0 and end at CertCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
CertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetCertBytes(int iCertIndex, char* &lpCertBytes, int &lenCertBytes); Unicode (Windows) INT GetCertBytes(INT iCertIndex, LPSTR &lpCertBytes, INT &lenCertBytes);
int secureblackbox_pdfsigner_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
QByteArray GetCertBytes(int iCertIndex);
Remarks
Returns the raw certificate data in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertCA Property (PDFSigner Class)
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
Syntax
ANSI (Cross Platform) int GetCertCA(int iCertIndex); Unicode (Windows) BOOL GetCertCA(INT iCertIndex);
int secureblackbox_pdfsigner_getcertca(void* lpObj, int certindex);
bool GetCertCA(int iCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertCAKeyID Property (PDFSigner Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
ANSI (Cross Platform) int GetCertCAKeyID(int iCertIndex, char* &lpCertCAKeyID, int &lenCertCAKeyID); Unicode (Windows) INT GetCertCAKeyID(INT iCertIndex, LPSTR &lpCertCAKeyID, INT &lenCertCAKeyID);
int secureblackbox_pdfsigner_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
QByteArray GetCertCAKeyID(int iCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertCRLDistributionPoints Property (PDFSigner Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
ANSI (Cross Platform) char* GetCertCRLDistributionPoints(int iCertIndex); Unicode (Windows) LPWSTR GetCertCRLDistributionPoints(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertcrldistributionpoints(void* lpObj, int certindex);
QString GetCertCRLDistributionPoints(int iCertIndex);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertCurve Property (PDFSigner Class)
Specifies the elliptic curve of the EC public key.
Syntax
ANSI (Cross Platform) char* GetCertCurve(int iCertIndex); Unicode (Windows) LPWSTR GetCertCurve(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertcurve(void* lpObj, int certindex);
QString GetCertCurve(int iCertIndex);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertFingerprint Property (PDFSigner Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
ANSI (Cross Platform) int GetCertFingerprint(int iCertIndex, char* &lpCertFingerprint, int &lenCertFingerprint); Unicode (Windows) INT GetCertFingerprint(INT iCertIndex, LPSTR &lpCertFingerprint, INT &lenCertFingerprint);
int secureblackbox_pdfsigner_getcertfingerprint(void* lpObj, int certindex, char** lpCertFingerprint, int* lenCertFingerprint);
QByteArray GetCertFingerprint(int iCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertFriendlyName Property (PDFSigner Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
ANSI (Cross Platform) char* GetCertFriendlyName(int iCertIndex); Unicode (Windows) LPWSTR GetCertFriendlyName(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertfriendlyname(void* lpObj, int certindex);
QString GetCertFriendlyName(int iCertIndex);
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetCertHandle(int iCertIndex); Unicode (Windows) LONG64 GetCertHandle(INT iCertIndex);
int64 secureblackbox_pdfsigner_getcerthandle(void* lpObj, int certindex);
qint64 GetCertHandle(int iCertIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Long64
CertHashAlgorithm Property (PDFSigner Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
ANSI (Cross Platform) char* GetCertHashAlgorithm(int iCertIndex); Unicode (Windows) LPWSTR GetCertHashAlgorithm(INT iCertIndex);
char* secureblackbox_pdfsigner_getcerthashalgorithm(void* lpObj, int certindex);
QString GetCertHashAlgorithm(int iCertIndex);
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertIssuer Property (PDFSigner Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetCertIssuer(int iCertIndex); Unicode (Windows) LPWSTR GetCertIssuer(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertissuer(void* lpObj, int certindex);
QString GetCertIssuer(int iCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertIssuerRDN Property (PDFSigner Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
ANSI (Cross Platform) char* GetCertIssuerRDN(int iCertIndex); Unicode (Windows) LPWSTR GetCertIssuerRDN(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertissuerrdn(void* lpObj, int certindex);
QString GetCertIssuerRDN(int iCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertKeyAlgorithm Property (PDFSigner Class)
Specifies the public key algorithm of this certificate.
Syntax
ANSI (Cross Platform) char* GetCertKeyAlgorithm(int iCertIndex); Unicode (Windows) LPWSTR GetCertKeyAlgorithm(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertkeyalgorithm(void* lpObj, int certindex);
QString GetCertKeyAlgorithm(int iCertIndex);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertKeyBits Property (PDFSigner Class)
Returns the length of the public key.
Syntax
ANSI (Cross Platform) int GetCertKeyBits(int iCertIndex); Unicode (Windows) INT GetCertKeyBits(INT iCertIndex);
int secureblackbox_pdfsigner_getcertkeybits(void* lpObj, int certindex);
int GetCertKeyBits(int iCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Integer
CertKeyFingerprint Property (PDFSigner Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
ANSI (Cross Platform) int GetCertKeyFingerprint(int iCertIndex, char* &lpCertKeyFingerprint, int &lenCertKeyFingerprint); Unicode (Windows) INT GetCertKeyFingerprint(INT iCertIndex, LPSTR &lpCertKeyFingerprint, INT &lenCertKeyFingerprint);
int secureblackbox_pdfsigner_getcertkeyfingerprint(void* lpObj, int certindex, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);
QByteArray GetCertKeyFingerprint(int iCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertKeyUsage Property (PDFSigner Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
ANSI (Cross Platform) int GetCertKeyUsage(int iCertIndex); Unicode (Windows) INT GetCertKeyUsage(INT iCertIndex);
int secureblackbox_pdfsigner_getcertkeyusage(void* lpObj, int certindex);
int GetCertKeyUsage(int iCertIndex);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Integer
CertKeyValid Property (PDFSigner Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
ANSI (Cross Platform) int GetCertKeyValid(int iCertIndex); Unicode (Windows) BOOL GetCertKeyValid(INT iCertIndex);
int secureblackbox_pdfsigner_getcertkeyvalid(void* lpObj, int certindex);
bool GetCertKeyValid(int iCertIndex);
Default Value
FALSE
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertOCSPLocations Property (PDFSigner Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
ANSI (Cross Platform) char* GetCertOCSPLocations(int iCertIndex); Unicode (Windows) LPWSTR GetCertOCSPLocations(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertocsplocations(void* lpObj, int certindex);
QString GetCertOCSPLocations(int iCertIndex);
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertPolicyIDs Property (PDFSigner Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
ANSI (Cross Platform) char* GetCertPolicyIDs(int iCertIndex); Unicode (Windows) LPWSTR GetCertPolicyIDs(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertpolicyids(void* lpObj, int certindex);
QString GetCertPolicyIDs(int iCertIndex);
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertPublicKeyBytes Property (PDFSigner Class)
Contains the certificate's public key in DER format.
Syntax
ANSI (Cross Platform) int GetCertPublicKeyBytes(int iCertIndex, char* &lpCertPublicKeyBytes, int &lenCertPublicKeyBytes); Unicode (Windows) INT GetCertPublicKeyBytes(INT iCertIndex, LPSTR &lpCertPublicKeyBytes, INT &lenCertPublicKeyBytes);
int secureblackbox_pdfsigner_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
QByteArray GetCertPublicKeyBytes(int iCertIndex);
Remarks
Contains the certificate's public key in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSelfSigned Property (PDFSigner Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
ANSI (Cross Platform) int GetCertSelfSigned(int iCertIndex); Unicode (Windows) BOOL GetCertSelfSigned(INT iCertIndex);
int secureblackbox_pdfsigner_getcertselfsigned(void* lpObj, int certindex);
bool GetCertSelfSigned(int iCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertSerialNumber Property (PDFSigner Class)
Returns the certificate's serial number.
Syntax
ANSI (Cross Platform) int GetCertSerialNumber(int iCertIndex, char* &lpCertSerialNumber, int &lenCertSerialNumber); Unicode (Windows) INT GetCertSerialNumber(INT iCertIndex, LPSTR &lpCertSerialNumber, INT &lenCertSerialNumber);
int secureblackbox_pdfsigner_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
QByteArray GetCertSerialNumber(int iCertIndex);
Remarks
Returns the certificate's serial number.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSigAlgorithm Property (PDFSigner Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
ANSI (Cross Platform) char* GetCertSigAlgorithm(int iCertIndex); Unicode (Windows) LPWSTR GetCertSigAlgorithm(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertsigalgorithm(void* lpObj, int certindex);
QString GetCertSigAlgorithm(int iCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertSubject Property (PDFSigner Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
ANSI (Cross Platform) char* GetCertSubject(int iCertIndex); Unicode (Windows) LPWSTR GetCertSubject(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertsubject(void* lpObj, int certindex);
QString GetCertSubject(int iCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertSubjectKeyID Property (PDFSigner Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
ANSI (Cross Platform) int GetCertSubjectKeyID(int iCertIndex, char* &lpCertSubjectKeyID, int &lenCertSubjectKeyID); Unicode (Windows) INT GetCertSubjectKeyID(INT iCertIndex, LPSTR &lpCertSubjectKeyID, INT &lenCertSubjectKeyID);
int secureblackbox_pdfsigner_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
QByteArray GetCertSubjectKeyID(int iCertIndex);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSubjectRDN Property (PDFSigner Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
ANSI (Cross Platform) char* GetCertSubjectRDN(int iCertIndex); Unicode (Windows) LPWSTR GetCertSubjectRDN(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertsubjectrdn(void* lpObj, int certindex);
QString GetCertSubjectRDN(int iCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertValidFrom Property (PDFSigner Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
ANSI (Cross Platform) char* GetCertValidFrom(int iCertIndex); Unicode (Windows) LPWSTR GetCertValidFrom(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertvalidfrom(void* lpObj, int certindex);
QString GetCertValidFrom(int iCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertValidTo Property (PDFSigner Class)
The time point at which the certificate expires, in UTC.
Syntax
ANSI (Cross Platform) char* GetCertValidTo(int iCertIndex); Unicode (Windows) LPWSTR GetCertValidTo(INT iCertIndex);
char* secureblackbox_pdfsigner_getcertvalidto(void* lpObj, int certindex);
QString GetCertValidTo(int iCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CRLCount Property (PDFSigner Class)
The number of records in the CRL arrays.
Syntax
ANSI (Cross Platform) int GetCRLCount(); Unicode (Windows) INT GetCRLCount();
int secureblackbox_pdfsigner_getcrlcount(void* lpObj);
int GetCRLCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at CRLCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
CRLBytes Property (PDFSigner Class)
Returns the raw CRL data in DER format.
Syntax
ANSI (Cross Platform) int GetCRLBytes(int iCRLIndex, char* &lpCRLBytes, int &lenCRLBytes); Unicode (Windows) INT GetCRLBytes(INT iCRLIndex, LPSTR &lpCRLBytes, INT &lenCRLBytes);
int secureblackbox_pdfsigner_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);
QByteArray GetCRLBytes(int iCRLIndex);
Remarks
Returns the raw CRL data in DER format.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CRLHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetCRLHandle(int iCRLIndex); Unicode (Windows) LONG64 GetCRLHandle(INT iCRLIndex);
int64 secureblackbox_pdfsigner_getcrlhandle(void* lpObj, int crlindex);
qint64 GetCRLHandle(int iCRLIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
Long64
CRLIssuer Property (PDFSigner Class)
The common name of the CRL issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetCRLIssuer(int iCRLIndex); Unicode (Windows) LPWSTR GetCRLIssuer(INT iCRLIndex);
char* secureblackbox_pdfsigner_getcrlissuer(void* lpObj, int crlindex);
QString GetCRLIssuer(int iCRLIndex);
Default Value
""
Remarks
The common name of the CRL issuer (CA), typically a company name.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLIssuerRDN Property (PDFSigner Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
ANSI (Cross Platform) char* GetCRLIssuerRDN(int iCRLIndex); Unicode (Windows) LPWSTR GetCRLIssuerRDN(INT iCRLIndex);
char* secureblackbox_pdfsigner_getcrlissuerrdn(void* lpObj, int crlindex);
QString GetCRLIssuerRDN(int iCRLIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLLocation Property (PDFSigner Class)
The URL that the CRL was downloaded from.
Syntax
ANSI (Cross Platform) char* GetCRLLocation(int iCRLIndex); Unicode (Windows) LPWSTR GetCRLLocation(INT iCRLIndex);
char* secureblackbox_pdfsigner_getcrllocation(void* lpObj, int crlindex);
QString GetCRLLocation(int iCRLIndex);
Default Value
""
Remarks
The URL that the CRL was downloaded from.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLNextUpdate Property (PDFSigner Class)
The planned time and date of the next version of this CRL to be published.
Syntax
ANSI (Cross Platform) char* GetCRLNextUpdate(int iCRLIndex); Unicode (Windows) LPWSTR GetCRLNextUpdate(INT iCRLIndex);
char* secureblackbox_pdfsigner_getcrlnextupdate(void* lpObj, int crlindex);
QString GetCRLNextUpdate(int iCRLIndex);
Default Value
""
Remarks
The planned time and date of the next version of this CRL to be published.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLThisUpdate Property (PDFSigner Class)
The date and time at which this version of the CRL was published.
Syntax
ANSI (Cross Platform) char* GetCRLThisUpdate(int iCRLIndex); Unicode (Windows) LPWSTR GetCRLThisUpdate(INT iCRLIndex);
char* secureblackbox_pdfsigner_getcrlthisupdate(void* lpObj, int crlindex);
QString GetCRLThisUpdate(int iCRLIndex);
Default Value
""
Remarks
The date and time at which this version of the CRL was published.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
DecryptionCertificateBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetDecryptionCertificateBytes(char* &lpDecryptionCertificateBytes, int &lenDecryptionCertificateBytes); Unicode (Windows) INT GetDecryptionCertificateBytes(LPSTR &lpDecryptionCertificateBytes, INT &lenDecryptionCertificateBytes);
int secureblackbox_pdfsigner_getdecryptioncertificatebytes(void* lpObj, char** lpDecryptionCertificateBytes, int* lenDecryptionCertificateBytes);
QByteArray GetDecryptionCertificateBytes();
Remarks
Returns the raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
DecryptionCertificateHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(int64 lDecryptionCertificateHandle); Unicode (Windows) LONG64 GetDecryptionCertificateHandle();
INT SetDecryptionCertificateHandle(LONG64 lDecryptionCertificateHandle);
int64 secureblackbox_pdfsigner_getdecryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfsigner_setdecryptioncertificatehandle(void* lpObj, int64 lDecryptionCertificateHandle);
qint64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(qint64 lDecryptionCertificateHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
DocumentInfoEncryptionAlgorithm Property (PDFSigner Class)
The symmetric algorithm used to encrypt the document.
Syntax
ANSI (Cross Platform) char* GetDocumentInfoEncryptionAlgorithm(); Unicode (Windows) LPWSTR GetDocumentInfoEncryptionAlgorithm();
char* secureblackbox_pdfsigner_getdocumentinfoencryptionalgorithm(void* lpObj);
QString GetDocumentInfoEncryptionAlgorithm();
Default Value
""
Remarks
The symmetric algorithm used to encrypt the document.
This property contains the encryption algorithm that was used to encrypt the PDF document.
Supported values:
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
This property is read-only and not available at design time.
Data Type
String
DocumentInfoEncryptionType Property (PDFSigner Class)
The document encryption type.
Syntax
ANSI (Cross Platform) int GetDocumentInfoEncryptionType(); Unicode (Windows) INT GetDocumentInfoEncryptionType();
Possible Values
PET_NONE(0),
PET_PASSWORD(1),
PET_CERTIFICATE(2)
int secureblackbox_pdfsigner_getdocumentinfoencryptiontype(void* lpObj);
int GetDocumentInfoEncryptionType();
Default Value
1
Remarks
The document encryption type.
This property indicates the kind of encryption that was used to encrypt the PDF document.
Supported values:
petPassword | 1 | The document is encrypted with a password. |
petCertificate | 2 | The document is encrypted with a certificate (or many certificates). |
This property is read-only and not available at design time.
Data Type
Integer
DocumentInfoMetadataEncrypted Property (PDFSigner Class)
Indicates if the document metadata is encrypted.
Syntax
ANSI (Cross Platform) int GetDocumentInfoMetadataEncrypted(); Unicode (Windows) BOOL GetDocumentInfoMetadataEncrypted();
int secureblackbox_pdfsigner_getdocumentinfometadataencrypted(void* lpObj);
bool GetDocumentInfoMetadataEncrypted();
Default Value
TRUE
Remarks
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.
This property is read-only and not available at design time.
Data Type
Boolean
DocumentInfoPermissions Property (PDFSigner Class)
Contains the document permissions associated with the encryption.
Syntax
ANSI (Cross Platform) int GetDocumentInfoPermissions(); Unicode (Windows) INT GetDocumentInfoPermissions();
int secureblackbox_pdfsigner_getdocumentinfopermissions(void* lpObj);
int GetDocumentInfoPermissions();
Default Value
0
Remarks
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:
pepAnnotations | 0x0001 | Annotating is allowed |
pepAssemble | 0x0002 | Assembling a new document on the basis of the processed one is allowed |
pepExtract | 0x0004 | Extraction/copying of the pictures and text from the document is allowed |
pepExtractAcc | 0x0008 | Content extraction is allowed for accessibility purposes only |
pepFillInForms | 0x0010 | Filling forms in is allowed |
pepHighQualityPrint | 0x0020 | High quality printing is allowed |
pepLowQualityPrint | 0x0040 | Low quality printing is allowed |
pepModify | 0x0080 | Modifications are allowed |
This property is read-only and not available at design time.
Data Type
Integer
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
ExternalCryptoAsyncDocumentID Property (PDFSigner Class)
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID); Unicode (Windows) LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_pdfsigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (PDFSigner Class)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
ANSI (Cross Platform) char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams); Unicode (Windows) LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);
char* secureblackbox_pdfsigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
This property is not available at design time.
Data Type
String
ExternalCryptoData Property (PDFSigner Class)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData); Unicode (Windows) LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);
char* secureblackbox_pdfsigner_getexternalcryptodata(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor.
This property is not available at design time.
Data Type
String
ExternalCryptoExternalHashCalculation Property (PDFSigner Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
ANSI (Cross Platform) int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation); Unicode (Windows) BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);
int secureblackbox_pdfsigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);
Default Value
FALSE
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (PDFSigner Class)
Specifies the request's signature hash algorithm.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm); Unicode (Windows) LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);
char* secureblackbox_pdfsigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
String
ExternalCryptoKeyID Property (PDFSigner Class)
The ID of the pre-shared key used for DC request authentication.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID); Unicode (Windows) LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);
char* secureblackbox_pdfsigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
String
ExternalCryptoKeySecret Property (PDFSigner Class)
The pre-shared key used for DC request authentication.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret); Unicode (Windows) LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);
char* secureblackbox_pdfsigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
String
ExternalCryptoMethod Property (PDFSigner Class)
Specifies the asynchronous signing method.
Syntax
ANSI (Cross Platform) int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); Unicode (Windows) INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
int secureblackbox_pdfsigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (PDFSigner Class)
Specifies the external cryptography mode.
Syntax
ANSI (Cross Platform) int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); Unicode (Windows) INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
int secureblackbox_pdfsigner_getexternalcryptomode(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (PDFSigner Class)
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm); Unicode (Windows) LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);
char* secureblackbox_pdfsigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Default Value
""
Remarks
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Data Type
String
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
KnownCertCount Property (PDFSigner Class)
The number of records in the KnownCert arrays.
Syntax
ANSI (Cross Platform) int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); Unicode (Windows) INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);
int secureblackbox_pdfsigner_getknowncertcount(void* lpObj);
int secureblackbox_pdfsigner_setknowncertcount(void* lpObj, int iKnownCertCount);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCertCount - 1.
This property is not available at design time.
Data Type
Integer
KnownCertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes); Unicode (Windows) INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);
int secureblackbox_pdfsigner_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
QByteArray GetKnownCertBytes(int iKnownCertIndex);
Remarks
Returns the raw certificate data in DER format.
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle); Unicode (Windows) LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);
int64 secureblackbox_pdfsigner_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_pdfsigner_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is not available at design time.
Data Type
Long64
KnownCRLCount Property (PDFSigner Class)
The number of records in the KnownCRL arrays.
Syntax
ANSI (Cross Platform) int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); Unicode (Windows) INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);
int secureblackbox_pdfsigner_getknowncrlcount(void* lpObj);
int secureblackbox_pdfsigner_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCRLCount - 1.
This property is not available at design time.
Data Type
Integer
KnownCRLBytes Property (PDFSigner Class)
Returns the raw CRL data in DER format.
Syntax
ANSI (Cross Platform) int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes); Unicode (Windows) INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);
int secureblackbox_pdfsigner_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);
Remarks
Returns the raw CRL data in DER format.
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCRLHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle); Unicode (Windows) LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);
int64 secureblackbox_pdfsigner_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_pdfsigner_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is not available at design time.
Data Type
Long64
KnownOCSPCount Property (PDFSigner Class)
The number of records in the KnownOCSP arrays.
Syntax
ANSI (Cross Platform) int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); Unicode (Windows) INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);
int secureblackbox_pdfsigner_getknownocspcount(void* lpObj);
int secureblackbox_pdfsigner_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownOCSPCount - 1.
This property is not available at design time.
Data Type
Integer
KnownOCSPBytes Property (PDFSigner Class)
A buffer containing the raw OCSP response data.
Syntax
ANSI (Cross Platform) int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes); Unicode (Windows) INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);
int secureblackbox_pdfsigner_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);
Remarks
A buffer containing the raw OCSP response data.
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownOCSPHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle); Unicode (Windows) LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);
int64 secureblackbox_pdfsigner_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_pdfsigner_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is not available at design time.
Data Type
Long64
NewSigAllowedChanges Property (PDFSigner Class)
The changes to the document allowed by the signature.
Syntax
ANSI (Cross Platform) int GetNewSigAllowedChanges();
int SetNewSigAllowedChanges(int iNewSigAllowedChanges); Unicode (Windows) INT GetNewSigAllowedChanges();
INT SetNewSigAllowedChanges(INT iNewSigAllowedChanges);
Possible Values
PSAC_NONE(0),
PSAC_FILL_IN_FORMS(1),
PSAC_COMMENT(2),
PSAC_ALL(3)
int secureblackbox_pdfsigner_getnewsigallowedchanges(void* lpObj);
int secureblackbox_pdfsigner_setnewsigallowedchanges(void* lpObj, int iNewSigAllowedChanges);
int GetNewSigAllowedChanges();
int SetNewSigAllowedChanges(int iNewSigAllowedChanges);
Default Value
0
Remarks
The changes to the document allowed by the signature.
This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).
psacNone | 0 | No changes are allowed by the signature |
psacFillInForms | 1 | Only form fill-in is allowed |
psacComment | 2 | Commenting is allowed |
psacAll | 3 | Form fill-in and commenting are allowed |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Integer
NewSigAuthorName Property (PDFSigner Class)
A human-readable signer name.
Syntax
ANSI (Cross Platform) char* GetNewSigAuthorName();
int SetNewSigAuthorName(const char* lpszNewSigAuthorName); Unicode (Windows) LPWSTR GetNewSigAuthorName();
INT SetNewSigAuthorName(LPCWSTR lpszNewSigAuthorName);
char* secureblackbox_pdfsigner_getnewsigauthorname(void* lpObj);
int secureblackbox_pdfsigner_setnewsigauthorname(void* lpObj, const char* lpszNewSigAuthorName);
QString GetNewSigAuthorName();
int SetNewSigAuthorName(QString qsNewSigAuthorName);
Default Value
""
Remarks
A human-readable signer name. This is a PDF document property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigCertificateIndex Property (PDFSigner Class)
Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection.
Syntax
ANSI (Cross Platform) int GetNewSigCertificateIndex(); Unicode (Windows) INT GetNewSigCertificateIndex();
int secureblackbox_pdfsigner_getnewsigcertificateindex(void* lpObj);
int GetNewSigCertificateIndex();
Default Value
-1
Remarks
Returns the index of the signing certificate in the Certificates collection
Use this property to look up the signing certificate in the Certificates collection.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigCertification Property (PDFSigner Class)
Specifies whether this is a Certification (MDP) signature.
Syntax
ANSI (Cross Platform) int GetNewSigCertification();
int SetNewSigCertification(int bNewSigCertification); Unicode (Windows) BOOL GetNewSigCertification();
INT SetNewSigCertification(BOOL bNewSigCertification);
int secureblackbox_pdfsigner_getnewsigcertification(void* lpObj);
int secureblackbox_pdfsigner_setnewsigcertification(void* lpObj, int bNewSigCertification);
bool GetNewSigCertification();
int SetNewSigCertification(bool bNewSigCertification);
Default Value
FALSE
Remarks
Specifies whether this is a Certification (MDP) signature.
Certification signatures are a feature used by earlier Acrobat versions. They have little use these days.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Boolean
NewSigChainValidationDetails Property (PDFSigner Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetNewSigChainValidationDetails(); Unicode (Windows) INT GetNewSigChainValidationDetails();
int secureblackbox_pdfsigner_getnewsigchainvalidationdetails(void* lpObj);
int GetNewSigChainValidationDetails();
Default Value
0
Remarks
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:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigChainValidationResult Property (PDFSigner Class)
The outcome of a certificate chain validation routine.
Syntax
ANSI (Cross Platform) int GetNewSigChainValidationResult(); Unicode (Windows) INT GetNewSigChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_pdfsigner_getnewsigchainvalidationresult(void* lpObj);
int GetNewSigChainValidationResult();
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The 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.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigClaimedSigningTime Property (PDFSigner Class)
Returns or sets the signature's creation time.
Syntax
ANSI (Cross Platform) char* GetNewSigClaimedSigningTime();
int SetNewSigClaimedSigningTime(const char* lpszNewSigClaimedSigningTime); Unicode (Windows) LPWSTR GetNewSigClaimedSigningTime();
INT SetNewSigClaimedSigningTime(LPCWSTR lpszNewSigClaimedSigningTime);
char* secureblackbox_pdfsigner_getnewsigclaimedsigningtime(void* lpObj);
int secureblackbox_pdfsigner_setnewsigclaimedsigningtime(void* lpObj, const char* lpszNewSigClaimedSigningTime);
QString GetNewSigClaimedSigningTime();
int SetNewSigClaimedSigningTime(QString qsNewSigClaimedSigningTime);
Default Value
""
Remarks
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 NewSigValidatedSigningTime, does not originate from a trusted TSA and may be forfeited or wrong.
The time is provided in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigContactInfo Property (PDFSigner Class)
Contains the signer's contact information.
Syntax
ANSI (Cross Platform) char* GetNewSigContactInfo();
int SetNewSigContactInfo(const char* lpszNewSigContactInfo); Unicode (Windows) LPWSTR GetNewSigContactInfo();
INT SetNewSigContactInfo(LPCWSTR lpszNewSigContactInfo);
char* secureblackbox_pdfsigner_getnewsigcontactinfo(void* lpObj);
int secureblackbox_pdfsigner_setnewsigcontactinfo(void* lpObj, const char* lpszNewSigContactInfo);
QString GetNewSigContactInfo();
int SetNewSigContactInfo(QString qsNewSigContactInfo);
Default Value
""
Remarks
Contains the signer's contact information. This is a PDF document property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigCoverageEndsAt Property (PDFSigner Class)
Indicates the offset in the PDF file where signature coverage ends.
Syntax
ANSI (Cross Platform) int GetNewSigCoverageEndsAt(); Unicode (Windows) INT GetNewSigCoverageEndsAt();
int secureblackbox_pdfsigner_getnewsigcoverageendsat(void* lpObj);
int GetNewSigCoverageEndsAt();
Default Value
0
Remarks
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.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigCustomData Property (PDFSigner Class)
Uninterpreted custom data to save with the signature.
Syntax
ANSI (Cross Platform) int GetNewSigCustomData(char* &lpNewSigCustomData, int &lenNewSigCustomData);
int SetNewSigCustomData(const char* lpNewSigCustomData, int lenNewSigCustomData); Unicode (Windows) INT GetNewSigCustomData(LPSTR &lpNewSigCustomData, INT &lenNewSigCustomData);
INT SetNewSigCustomData(LPCSTR lpNewSigCustomData, INT lenNewSigCustomData);
int secureblackbox_pdfsigner_getnewsigcustomdata(void* lpObj, char** lpNewSigCustomData, int* lenNewSigCustomData);
int secureblackbox_pdfsigner_setnewsigcustomdata(void* lpObj, const char* lpNewSigCustomData, int lenNewSigCustomData);
QByteArray GetNewSigCustomData();
int SetNewSigCustomData(QByteArray qbaNewSigCustomData);
Remarks
Uninterpreted custom data to save with the signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Byte Array
NewSigEmptyField Property (PDFSigner Class)
Indicates whether or not the signature created/read is an empty property (a signature placeholder).
Syntax
ANSI (Cross Platform) int GetNewSigEmptyField();
int SetNewSigEmptyField(int bNewSigEmptyField); Unicode (Windows) BOOL GetNewSigEmptyField();
INT SetNewSigEmptyField(BOOL bNewSigEmptyField);
int secureblackbox_pdfsigner_getnewsigemptyfield(void* lpObj);
int secureblackbox_pdfsigner_setnewsigemptyfield(void* lpObj, int bNewSigEmptyField);
bool GetNewSigEmptyField();
int SetNewSigEmptyField(bool bNewSigEmptyField);
Default Value
FALSE
Remarks
Indicates whether or not the signature created/read is an empty field (a signature placeholder).
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Boolean
NewSigFilterName Property (PDFSigner Class)
The signature filter name.
Syntax
ANSI (Cross Platform) char* GetNewSigFilterName();
int SetNewSigFilterName(const char* lpszNewSigFilterName); Unicode (Windows) LPWSTR GetNewSigFilterName();
INT SetNewSigFilterName(LPCWSTR lpszNewSigFilterName);
char* secureblackbox_pdfsigner_getnewsigfiltername(void* lpObj);
int secureblackbox_pdfsigner_setnewsigfiltername(void* lpObj, const char* lpszNewSigFilterName);
QString GetNewSigFilterName();
int SetNewSigFilterName(QString qsNewSigFilterName);
Default Value
""
Remarks
The signature filter name.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigFullSignatureName Property (PDFSigner Class)
Specifies the full name of the signature property.
Syntax
ANSI (Cross Platform) char* GetNewSigFullSignatureName(); Unicode (Windows) LPWSTR GetNewSigFullSignatureName();
char* secureblackbox_pdfsigner_getnewsigfullsignaturename(void* lpObj);
QString GetNewSigFullSignatureName();
Default Value
""
Remarks
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.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
String
NewSigHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetNewSigHandle();
int SetNewSigHandle(int64 lNewSigHandle); Unicode (Windows) LONG64 GetNewSigHandle();
INT SetNewSigHandle(LONG64 lNewSigHandle);
int64 secureblackbox_pdfsigner_getnewsighandle(void* lpObj);
int secureblackbox_pdfsigner_setnewsighandle(void* lpObj, int64 lNewSigHandle);
qint64 GetNewSigHandle();
int SetNewSigHandle(qint64 lNewSigHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Long64
NewSigHashAlgorithm Property (PDFSigner Class)
Specifies the hash algorithm to be used for signing.
Syntax
ANSI (Cross Platform) char* GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(const char* lpszNewSigHashAlgorithm); Unicode (Windows) LPWSTR GetNewSigHashAlgorithm();
INT SetNewSigHashAlgorithm(LPCWSTR lpszNewSigHashAlgorithm);
char* secureblackbox_pdfsigner_getnewsighashalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setnewsighashalgorithm(void* lpObj, const char* lpszNewSigHashAlgorithm);
QString GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(QString qsNewSigHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used for signing.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigHeight Property (PDFSigner Class)
Specifies the height of the signature widget.
Syntax
ANSI (Cross Platform) int GetNewSigHeight();
int SetNewSigHeight(int iNewSigHeight); Unicode (Windows) INT GetNewSigHeight();
INT SetNewSigHeight(INT iNewSigHeight);
int secureblackbox_pdfsigner_getnewsigheight(void* lpObj);
int secureblackbox_pdfsigner_setnewsigheight(void* lpObj, int iNewSigHeight);
int GetNewSigHeight();
int SetNewSigHeight(int iNewSigHeight);
Default Value
0
Remarks
Specifies the height of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Integer
NewSigLevel Property (PDFSigner Class)
Specifies the signature kind and level.
Syntax
ANSI (Cross Platform) int GetNewSigLevel();
int SetNewSigLevel(int iNewSigLevel); Unicode (Windows) INT GetNewSigLevel();
INT SetNewSigLevel(INT iNewSigLevel);
Possible Values
PSL_LEGACY(0),
PSL_BES(1),
PSL_EPES(2),
PSL_LTV(3),
PSL_DOCUMENT_TIMESTAMP(4)
int secureblackbox_pdfsigner_getnewsiglevel(void* lpObj);
int secureblackbox_pdfsigner_setnewsiglevel(void* lpObj, int iNewSigLevel);
int GetNewSigLevel();
int SetNewSigLevel(int iNewSigLevel);
Default Value
0
Remarks
Specifies the signature kind and level.
pslLegacy | 0 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
pslBES | 1 | PAdES-BES signature (ETSI.CAdES.detached) |
pslEPES | 2 | PAdES-EPES signature (ETSI.CAdES.detached + embedded policy) |
pslLTV | 3 | PAdES-LTV signature (ETSI.CAdES.detached + revocation info) |
pslDocumentTimestamp | 4 | Document timestamp (ETSI.RFC3161) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Integer
NewSigLocation Property (PDFSigner Class)
Specifies the host name or the physical location of the signing entity.
Syntax
ANSI (Cross Platform) char* GetNewSigLocation();
int SetNewSigLocation(const char* lpszNewSigLocation); Unicode (Windows) LPWSTR GetNewSigLocation();
INT SetNewSigLocation(LPCWSTR lpszNewSigLocation);
char* secureblackbox_pdfsigner_getnewsiglocation(void* lpObj);
int secureblackbox_pdfsigner_setnewsiglocation(void* lpObj, const char* lpszNewSigLocation);
QString GetNewSigLocation();
int SetNewSigLocation(QString qsNewSigLocation);
Default Value
""
Remarks
Specifies the host name or the physical location of the signing entity. This is a PDF property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigOffsetX Property (PDFSigner Class)
Specifies the signature widget offset from the left-hand page border.
Syntax
ANSI (Cross Platform) int GetNewSigOffsetX();
int SetNewSigOffsetX(int iNewSigOffsetX); Unicode (Windows) INT GetNewSigOffsetX();
INT SetNewSigOffsetX(INT iNewSigOffsetX);
int secureblackbox_pdfsigner_getnewsigoffsetx(void* lpObj);
int secureblackbox_pdfsigner_setnewsigoffsetx(void* lpObj, int iNewSigOffsetX);
int GetNewSigOffsetX();
int SetNewSigOffsetX(int iNewSigOffsetX);
Default Value
0
Remarks
Specifies the signature widget offset from the left-hand page border.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Integer
NewSigOffsetY Property (PDFSigner Class)
Specifies the signature widget offset from the bottom page border.
Syntax
ANSI (Cross Platform) int GetNewSigOffsetY();
int SetNewSigOffsetY(int iNewSigOffsetY); Unicode (Windows) INT GetNewSigOffsetY();
INT SetNewSigOffsetY(INT iNewSigOffsetY);
int secureblackbox_pdfsigner_getnewsigoffsety(void* lpObj);
int secureblackbox_pdfsigner_setnewsigoffsety(void* lpObj, int iNewSigOffsetY);
int GetNewSigOffsetY();
int SetNewSigOffsetY(int iNewSigOffsetY);
Default Value
0
Remarks
Specifies the signature widget offset from the bottom page border.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Integer
NewSigPage Property (PDFSigner Class)
Indicates the index of the page on which the signature is placed.
Syntax
ANSI (Cross Platform) int GetNewSigPage(); Unicode (Windows) INT GetNewSigPage();
int secureblackbox_pdfsigner_getnewsigpage(void* lpObj);
int GetNewSigPage();
Default Value
-1
Remarks
Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigPolicyHash Property (PDFSigner Class)
The signature policy hash value for EPES signatures.
Syntax
ANSI (Cross Platform) char* GetNewSigPolicyHash();
int SetNewSigPolicyHash(const char* lpszNewSigPolicyHash); Unicode (Windows) LPWSTR GetNewSigPolicyHash();
INT SetNewSigPolicyHash(LPCWSTR lpszNewSigPolicyHash);
char* secureblackbox_pdfsigner_getnewsigpolicyhash(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyhash(void* lpObj, const char* lpszNewSigPolicyHash);
QString GetNewSigPolicyHash();
int SetNewSigPolicyHash(QString qsNewSigPolicyHash);
Default Value
""
Remarks
The signature policy hash value for EPES signatures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigPolicyHashAlgorithm Property (PDFSigner Class)
The algorithm that was used to calculate the signature policy hash.
Syntax
ANSI (Cross Platform) char* GetNewSigPolicyHashAlgorithm();
int SetNewSigPolicyHashAlgorithm(const char* lpszNewSigPolicyHashAlgorithm); Unicode (Windows) LPWSTR GetNewSigPolicyHashAlgorithm();
INT SetNewSigPolicyHashAlgorithm(LPCWSTR lpszNewSigPolicyHashAlgorithm);
char* secureblackbox_pdfsigner_getnewsigpolicyhashalgorithm(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyhashalgorithm(void* lpObj, const char* lpszNewSigPolicyHashAlgorithm);
QString GetNewSigPolicyHashAlgorithm();
int SetNewSigPolicyHashAlgorithm(QString qsNewSigPolicyHashAlgorithm);
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigPolicyID Property (PDFSigner Class)
The policy ID to be included into the signature.
Syntax
ANSI (Cross Platform) char* GetNewSigPolicyID();
int SetNewSigPolicyID(const char* lpszNewSigPolicyID); Unicode (Windows) LPWSTR GetNewSigPolicyID();
INT SetNewSigPolicyID(LPCWSTR lpszNewSigPolicyID);
char* secureblackbox_pdfsigner_getnewsigpolicyid(void* lpObj);
int secureblackbox_pdfsigner_setnewsigpolicyid(void* lpObj, const char* lpszNewSigPolicyID);
QString GetNewSigPolicyID();
int SetNewSigPolicyID(QString qsNewSigPolicyID);
Default Value
""
Remarks
The policy ID to be included into the signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigReason Property (PDFSigner Class)
Specifies the reason for signing.
Syntax
ANSI (Cross Platform) char* GetNewSigReason();
int SetNewSigReason(const char* lpszNewSigReason); Unicode (Windows) LPWSTR GetNewSigReason();
INT SetNewSigReason(LPCWSTR lpszNewSigReason);
char* secureblackbox_pdfsigner_getnewsigreason(void* lpObj);
int secureblackbox_pdfsigner_setnewsigreason(void* lpObj, const char* lpszNewSigReason);
QString GetNewSigReason();
int SetNewSigReason(QString qsNewSigReason);
Default Value
""
Remarks
Specifies the reason for signing. This is a PDF document property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigSignatureBytes Property (PDFSigner Class)
Returns the binary representation of the underlying PKCS7 signature blob.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureBytes(char* &lpNewSigSignatureBytes, int &lenNewSigSignatureBytes); Unicode (Windows) INT GetNewSigSignatureBytes(LPSTR &lpNewSigSignatureBytes, INT &lenNewSigSignatureBytes);
int secureblackbox_pdfsigner_getnewsigsignaturebytes(void* lpObj, char** lpNewSigSignatureBytes, int* lenNewSigSignatureBytes);
QByteArray GetNewSigSignatureBytes();
Remarks
Returns the binary representation of the underlying PKCS7 signature blob.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
NewSigSignatureName Property (PDFSigner Class)
Specifies the unique signature identifier to use.
Syntax
ANSI (Cross Platform) char* GetNewSigSignatureName();
int SetNewSigSignatureName(const char* lpszNewSigSignatureName); Unicode (Windows) LPWSTR GetNewSigSignatureName();
INT SetNewSigSignatureName(LPCWSTR lpszNewSigSignatureName);
char* secureblackbox_pdfsigner_getnewsigsignaturename(void* lpObj);
int secureblackbox_pdfsigner_setnewsigsignaturename(void* lpObj, const char* lpszNewSigSignatureName);
QString GetNewSigSignatureName();
int SetNewSigSignatureName(QString qsNewSigSignatureName);
Default Value
""
Remarks
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.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigSignatureValidationResult Property (PDFSigner Class)
The outcome of the cryptographic signature validation.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureValidationResult(); Unicode (Windows) INT GetNewSigSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_pdfsigner_getnewsigsignaturevalidationresult(void* lpObj);
int GetNewSigSignatureValidationResult();
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigSubjectRDN Property (PDFSigner Class)
Contains the RDN of the owner of the signing certificate.
Syntax
ANSI (Cross Platform) char* GetNewSigSubjectRDN(); Unicode (Windows) LPWSTR GetNewSigSubjectRDN();
char* secureblackbox_pdfsigner_getnewsigsubjectrdn(void* lpObj);
QString GetNewSigSubjectRDN();
Default Value
""
Remarks
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.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
String
NewSigTimestamped Property (PDFSigner Class)
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
ANSI (Cross Platform) int GetNewSigTimestamped(); Unicode (Windows) BOOL GetNewSigTimestamped();
int secureblackbox_pdfsigner_getnewsigtimestamped(void* lpObj);
bool GetNewSigTimestamped();
Default Value
FALSE
Remarks
Use this property to establish whether the signature contains an embedded timestamp.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Boolean
NewSigValidatedSigningTime Property (PDFSigner Class)
Contains the certified signing time.
Syntax
ANSI (Cross Platform) char* GetNewSigValidatedSigningTime(); Unicode (Windows) LPWSTR GetNewSigValidatedSigningTime();
char* secureblackbox_pdfsigner_getnewsigvalidatedsigningtime(void* lpObj);
QString GetNewSigValidatedSigningTime();
Default Value
""
Remarks
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.
NewSigClaimedSigningTime returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
String
NewSigValidationLog Property (PDFSigner Class)
Contains the signing certificate's chain validation log.
Syntax
ANSI (Cross Platform) char* GetNewSigValidationLog(); Unicode (Windows) LPWSTR GetNewSigValidationLog();
char* secureblackbox_pdfsigner_getnewsigvalidationlog(void* lpObj);
QString GetNewSigValidationLog();
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
String
NewSigWidth Property (PDFSigner Class)
Specifies the width of the signature widget.
Syntax
ANSI (Cross Platform) int GetNewSigWidth();
int SetNewSigWidth(int iNewSigWidth); Unicode (Windows) INT GetNewSigWidth();
INT SetNewSigWidth(INT iNewSigWidth);
int secureblackbox_pdfsigner_getnewsigwidth(void* lpObj);
int secureblackbox_pdfsigner_setnewsigwidth(void* lpObj, int iNewSigWidth);
int GetNewSigWidth();
int SetNewSigWidth(int iNewSigWidth);
Default Value
0
Remarks
Specifies the width of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
Integer
OCSPCount Property (PDFSigner Class)
The number of records in the OCSP arrays.
Syntax
ANSI (Cross Platform) int GetOCSPCount(); Unicode (Windows) INT GetOCSPCount();
int secureblackbox_pdfsigner_getocspcount(void* lpObj);
int GetOCSPCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at OCSPCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
OCSPBytes Property (PDFSigner Class)
A buffer containing the raw OCSP response data.
Syntax
ANSI (Cross Platform) int GetOCSPBytes(int iOCSPIndex, char* &lpOCSPBytes, int &lenOCSPBytes); Unicode (Windows) INT GetOCSPBytes(INT iOCSPIndex, LPSTR &lpOCSPBytes, INT &lenOCSPBytes);
int secureblackbox_pdfsigner_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);
QByteArray GetOCSPBytes(int iOCSPIndex);
Remarks
A buffer containing the raw OCSP response data.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
OCSPHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetOCSPHandle(int iOCSPIndex); Unicode (Windows) LONG64 GetOCSPHandle(INT iOCSPIndex);
int64 secureblackbox_pdfsigner_getocsphandle(void* lpObj, int ocspindex);
qint64 GetOCSPHandle(int iOCSPIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
Long64
OCSPIssuer Property (PDFSigner Class)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
ANSI (Cross Platform) char* GetOCSPIssuer(int iOCSPIndex); Unicode (Windows) LPWSTR GetOCSPIssuer(INT iOCSPIndex);
char* secureblackbox_pdfsigner_getocspissuer(void* lpObj, int ocspindex);
QString GetOCSPIssuer(int iOCSPIndex);
Default Value
""
Remarks
Indicates the issuer of this response (a CA or its authorized representative).
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OCSPIssuerRDN Property (PDFSigner Class)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
ANSI (Cross Platform) char* GetOCSPIssuerRDN(int iOCSPIndex); Unicode (Windows) LPWSTR GetOCSPIssuerRDN(INT iOCSPIndex);
char* secureblackbox_pdfsigner_getocspissuerrdn(void* lpObj, int ocspindex);
QString GetOCSPIssuerRDN(int iOCSPIndex);
Default Value
""
Remarks
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OCSPLocation Property (PDFSigner Class)
The location of the OCSP responder.
Syntax
ANSI (Cross Platform) char* GetOCSPLocation(int iOCSPIndex); Unicode (Windows) LPWSTR GetOCSPLocation(INT iOCSPIndex);
char* secureblackbox_pdfsigner_getocsplocation(void* lpObj, int ocspindex);
QString GetOCSPLocation(int iOCSPIndex);
Default Value
""
Remarks
The location of the OCSP responder.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OCSPProducedAt Property (PDFSigner Class)
Specifies the time when the response was produced, in UTC.
Syntax
ANSI (Cross Platform) char* GetOCSPProducedAt(int iOCSPIndex); Unicode (Windows) LPWSTR GetOCSPProducedAt(INT iOCSPIndex);
char* secureblackbox_pdfsigner_getocspproducedat(void* lpObj, int ocspindex);
QString GetOCSPProducedAt(int iOCSPIndex);
Default Value
""
Remarks
Specifies the time when the response was produced, in UTC.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OfflineMode Property (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
PageCount Property (PDFSigner Class)
The number of records in the Page arrays.
Syntax
ANSI (Cross Platform) int GetPageCount(); Unicode (Windows) INT GetPageCount();
int secureblackbox_pdfsigner_getpagecount(void* lpObj);
int GetPageCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PageCropLLX
- PageCropLLY
- PageCropURX
- PageCropURY
- PageHeight
- PageMediaLLX
- PageMediaLLY
- PageMediaURX
- PageMediaURY
- PageRotate
- PageWidth
The array indices start at 0 and end at PageCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
PageCropLLX Property (PDFSigner Class)
Specifies the lower-left X coordinate of the page crop area.
Syntax
ANSI (Cross Platform) int GetPageCropLLX(int iPageIndex); Unicode (Windows) INT GetPageCropLLX(INT iPageIndex);
int secureblackbox_pdfsigner_getpagecropllx(void* lpObj, int pageindex);
int GetPageCropLLX(int iPageIndex);
Default Value
0
Remarks
Specifies the lower-left X coordinate of the page crop area.
Specifies the lower-left X coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageCropLLY Property (PDFSigner Class)
Specifies the lower-left Y coordinate of the page crop area.
Syntax
ANSI (Cross Platform) int GetPageCropLLY(int iPageIndex); Unicode (Windows) INT GetPageCropLLY(INT iPageIndex);
int secureblackbox_pdfsigner_getpagecroplly(void* lpObj, int pageindex);
int GetPageCropLLY(int iPageIndex);
Default Value
0
Remarks
Specifies the lower-left Y coordinate of the page crop area.
Specifies the lower-left Y coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageCropURX Property (PDFSigner Class)
Specifies the upper-right X coordinate of the page crop area.
Syntax
ANSI (Cross Platform) int GetPageCropURX(int iPageIndex); Unicode (Windows) INT GetPageCropURX(INT iPageIndex);
int secureblackbox_pdfsigner_getpagecropurx(void* lpObj, int pageindex);
int GetPageCropURX(int iPageIndex);
Default Value
0
Remarks
Specifies the upper-right X coordinate of the page crop area.
Specifies the upper-right X coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageCropURY Property (PDFSigner Class)
Specifies the upper-right Y coordinate of the page crop area.
Syntax
ANSI (Cross Platform) int GetPageCropURY(int iPageIndex); Unicode (Windows) INT GetPageCropURY(INT iPageIndex);
int secureblackbox_pdfsigner_getpagecropury(void* lpObj, int pageindex);
int GetPageCropURY(int iPageIndex);
Default Value
0
Remarks
Specifies the upper-right Y coordinate of the page crop area.
Specifies the upper-right Y coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageHeight Property (PDFSigner Class)
Specifies the height of the page.
Syntax
ANSI (Cross Platform) int GetPageHeight(int iPageIndex); Unicode (Windows) INT GetPageHeight(INT iPageIndex);
int secureblackbox_pdfsigner_getpageheight(void* lpObj, int pageindex);
int GetPageHeight(int iPageIndex);
Default Value
0
Remarks
Specifies the height of the page.
Returns the height of the page.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageMediaLLX Property (PDFSigner Class)
Specifies the lower-left X coordinate of the page media area.
Syntax
ANSI (Cross Platform) int GetPageMediaLLX(int iPageIndex); Unicode (Windows) INT GetPageMediaLLX(INT iPageIndex);
int secureblackbox_pdfsigner_getpagemediallx(void* lpObj, int pageindex);
int GetPageMediaLLX(int iPageIndex);
Default Value
0
Remarks
Specifies the lower-left X coordinate of the page media area.
Specifies the lower-left X coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageMediaLLY Property (PDFSigner Class)
Specifies the lower-left Y coordinate of the page media area.
Syntax
ANSI (Cross Platform) int GetPageMediaLLY(int iPageIndex); Unicode (Windows) INT GetPageMediaLLY(INT iPageIndex);
int secureblackbox_pdfsigner_getpagemedially(void* lpObj, int pageindex);
int GetPageMediaLLY(int iPageIndex);
Default Value
0
Remarks
Specifies the lower-left Y coordinate of the page media area.
Specifies the lower-left Y coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageMediaURX Property (PDFSigner Class)
Specifies the upper-right X coordinate of the page media area.
Syntax
ANSI (Cross Platform) int GetPageMediaURX(int iPageIndex); Unicode (Windows) INT GetPageMediaURX(INT iPageIndex);
int secureblackbox_pdfsigner_getpagemediaurx(void* lpObj, int pageindex);
int GetPageMediaURX(int iPageIndex);
Default Value
0
Remarks
Specifies the upper-right X coordinate of the page media area.
Specifies the upper-right X coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageMediaURY Property (PDFSigner Class)
Specifies the upper-right Y coordinate of the page media area.
Syntax
ANSI (Cross Platform) int GetPageMediaURY(int iPageIndex); Unicode (Windows) INT GetPageMediaURY(INT iPageIndex);
int secureblackbox_pdfsigner_getpagemediaury(void* lpObj, int pageindex);
int GetPageMediaURY(int iPageIndex);
Default Value
0
Remarks
Specifies the upper-right Y coordinate of the page media area.
Specifies the upper-right Y coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageRotate Property (PDFSigner Class)
Specifies the rotation angle of the page in degrees.
Syntax
ANSI (Cross Platform) int GetPageRotate(int iPageIndex); Unicode (Windows) INT GetPageRotate(INT iPageIndex);
int secureblackbox_pdfsigner_getpagerotate(void* lpObj, int pageindex);
int GetPageRotate(int iPageIndex);
Default Value
0
Remarks
Specifies the rotation angle of the page in degrees. Values of 0, 90, 180, and 270 are allowed.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
PageWidth Property (PDFSigner Class)
Specifies the width of the page.
Syntax
ANSI (Cross Platform) int GetPageWidth(int iPageIndex); Unicode (Windows) INT GetPageWidth(INT iPageIndex);
int secureblackbox_pdfsigner_getpagewidth(void* lpObj, int pageindex);
int GetPageWidth(int iPageIndex);
Default Value
0
Remarks
Specifies the width of the page.
Returns the width of the page.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only and not available at design time.
Data Type
Integer
Password Property (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 | |
"PAdES.BASELINE-B" | PAdES B-B level (ETSI TS 103 172 v2.1.1 Baseline Profile) | |
"PAdES.BASELINE-T" | PAdES B-T level | |
"PAdES.BASELINE-LT.Update" | PAdES B-LT level | |
"PAdES.BASELINE-LTA.Update" | PAdES B-LTA level |
The "PAdES.BASELINE-B" profile is equivalent to the following settings:
Signer.NewSignature.Level = PDFSignatureLevels.pslBES;
Signer.Config("AutoCollectRevocationInfo=false");
This code uses the PAdES-BES form (a signature that does not incorporate the signature-policy-identifier).
Alternatively, you can use the PAdES-EPES form (a signature that does incorporate the signature-policy-identifier) with the following code modification:
Signer.NewSignature.Level = PDFSignatureLevels.pslEPES;
The "PAdES.BASELINE-T" profile extends the "PAdES.BASELINE-B" profile with the following settings:
Signer.TimestampServer = "https://freetsa.org/tsr";
The "PAdES.BASELINE-LT.Update" profile is applied in the Update method. It extends the signature created using the PAdES B-T level ("PAdES.BASELINE-T" profile).
Signer.Config("AutoCollectRevocationInfo=true");
The "PAdES.BASELINE-LTA.Update" profile is applied in the Update method. It extends the signature created using the PAdES B-T level ("PAdES.BASELINE-T" profile).
Signer.Config("AutoCollectRevocationInfo=true");
Signer.TimestampServer = "https://freetsa.org/tsr";
Data Type
String
ProxyAddress Property (PDFSigner Class)
The IP address of the proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress); Unicode (Windows) LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);
char* secureblackbox_pdfsigner_getproxyaddress(void* lpObj);
int secureblackbox_pdfsigner_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (PDFSigner Class)
The authentication type used by the proxy server.
Syntax
ANSI (Cross Platform) int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); Unicode (Windows) INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);
Possible Values
PAT_NO_AUTHENTICATION(0),
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
int secureblackbox_pdfsigner_getproxyauthentication(void* lpObj);
int secureblackbox_pdfsigner_setproxyauthentication(void* lpObj, int iProxyAuthentication);
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);
Default Value
0
Remarks
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Data Type
Integer
ProxyPassword Property (PDFSigner Class)
The password to authenticate to the proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* secureblackbox_pdfsigner_getproxypassword(void* lpObj);
int secureblackbox_pdfsigner_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (PDFSigner Class)
The port on the proxy server to connect to.
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int secureblackbox_pdfsigner_getproxyport(void* lpObj);
int secureblackbox_pdfsigner_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (PDFSigner Class)
The type of the proxy server.
Syntax
ANSI (Cross Platform) int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); Unicode (Windows) INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);
Possible Values
CPT_NONE(0),
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
int secureblackbox_pdfsigner_getproxyproxytype(void* lpObj);
int secureblackbox_pdfsigner_setproxyproxytype(void* lpObj, int iProxyProxyType);
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);
Default Value
0
Remarks
The type of the proxy server.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
Data Type
Integer
ProxyRequestHeaders Property (PDFSigner Class)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
ANSI (Cross Platform) char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders); Unicode (Windows) LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);
char* secureblackbox_pdfsigner_getproxyrequestheaders(void* lpObj);
int secureblackbox_pdfsigner_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (PDFSigner Class)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
ANSI (Cross Platform) char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody); Unicode (Windows) LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);
char* secureblackbox_pdfsigner_getproxyresponsebody(void* lpObj);
int secureblackbox_pdfsigner_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (PDFSigner Class)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders); Unicode (Windows) LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);
char* secureblackbox_pdfsigner_getproxyresponseheaders(void* lpObj);
int secureblackbox_pdfsigner_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (PDFSigner Class)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
ANSI (Cross Platform) int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6); Unicode (Windows) BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);
int secureblackbox_pdfsigner_getproxyuseipv6(void* lpObj);
int secureblackbox_pdfsigner_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);
Default Value
FALSE
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (PDFSigner Class)
Enables or disables proxy-driven connection.
Syntax
ANSI (Cross Platform) int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy); Unicode (Windows) BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);
int secureblackbox_pdfsigner_getproxyuseproxy(void* lpObj);
int secureblackbox_pdfsigner_setproxyuseproxy(void* lpObj, int bProxyUseProxy);
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);
Default Value
FALSE
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (PDFSigner Class)
Specifies the username credential for proxy authentication.
Syntax
ANSI (Cross Platform) char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername); Unicode (Windows) LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);
char* secureblackbox_pdfsigner_getproxyusername(void* lpObj);
int secureblackbox_pdfsigner_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
RevocationCheck Property (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.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All 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
SignatureCount Property (PDFSigner Class)
The number of records in the Signature arrays.
Syntax
ANSI (Cross Platform) int GetSignatureCount(); Unicode (Windows) INT GetSignatureCount();
int secureblackbox_pdfsigner_getsignaturecount(void* lpObj);
int GetSignatureCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignatureAllowedChanges
- SignatureAuthorName
- SignatureCertificateIndex
- SignatureCertification
- SignatureChainValidationDetails
- SignatureChainValidationResult
- SignatureClaimedSigningTime
- SignatureContactInfo
- SignatureCoverageEndsAt
- SignatureCustomData
- SignatureEmptyField
- SignatureFilterName
- SignatureFullSignatureName
- SignatureHandle
- SignatureHashAlgorithm
- SignatureHeight
- SignatureLevel
- SignatureLocation
- SignatureOffsetX
- SignatureOffsetY
- SignaturePage
- SignaturePolicyHash
- SignaturePolicyHashAlgorithm
- SignaturePolicyID
- SignatureReason
- SignatureSignatureBytes
- SignatureSignatureName
- SignatureSignatureValidationResult
- SignatureSubjectRDN
- SignatureTimestamped
- SignatureValidatedSigningTime
- SignatureValidationLog
- SignatureWidth
The array indices start at 0 and end at SignatureCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
SignatureAllowedChanges Property (PDFSigner Class)
The changes to the document allowed by the signature.
Syntax
ANSI (Cross Platform) int GetSignatureAllowedChanges(int iSignatureIndex); Unicode (Windows) INT GetSignatureAllowedChanges(INT iSignatureIndex);
Possible Values
PSAC_NONE(0),
PSAC_FILL_IN_FORMS(1),
PSAC_COMMENT(2),
PSAC_ALL(3)
int secureblackbox_pdfsigner_getsignatureallowedchanges(void* lpObj, int signatureindex);
int GetSignatureAllowedChanges(int iSignatureIndex);
Default Value
0
Remarks
The changes to the document allowed by the signature.
This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).
psacNone | 0 | No changes are allowed by the signature |
psacFillInForms | 1 | Only form fill-in is allowed |
psacComment | 2 | Commenting is allowed |
psacAll | 3 | Form fill-in and commenting are allowed |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureAuthorName Property (PDFSigner Class)
A human-readable signer name.
Syntax
ANSI (Cross Platform) char* GetSignatureAuthorName(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureAuthorName(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignatureauthorname(void* lpObj, int signatureindex);
QString GetSignatureAuthorName(int iSignatureIndex);
Default Value
""
Remarks
A human-readable signer name. This is a PDF document property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureCertificateIndex Property (PDFSigner Class)
Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection.
Syntax
ANSI (Cross Platform) int GetSignatureCertificateIndex(int iSignatureIndex); Unicode (Windows) INT GetSignatureCertificateIndex(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturecertificateindex(void* lpObj, int signatureindex);
int GetSignatureCertificateIndex(int iSignatureIndex);
Default Value
-1
Remarks
Returns the index of the signing certificate in the Certificates collection
Use this property to look up the signing certificate in the Certificates collection.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureCertification Property (PDFSigner Class)
Specifies whether this is a Certification (MDP) signature.
Syntax
ANSI (Cross Platform) int GetSignatureCertification(int iSignatureIndex); Unicode (Windows) BOOL GetSignatureCertification(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturecertification(void* lpObj, int signatureindex);
bool GetSignatureCertification(int iSignatureIndex);
Default Value
FALSE
Remarks
Specifies whether this is a Certification (MDP) signature.
Certification signatures are a feature used by earlier Acrobat versions. They have little use these days.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureChainValidationDetails Property (PDFSigner Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetSignatureChainValidationDetails(int iSignatureIndex); Unicode (Windows) INT GetSignatureChainValidationDetails(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturechainvalidationdetails(void* lpObj, int signatureindex);
int GetSignatureChainValidationDetails(int iSignatureIndex);
Default Value
0
Remarks
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:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureChainValidationResult Property (PDFSigner Class)
The outcome of a certificate chain validation routine.
Syntax
ANSI (Cross Platform) int GetSignatureChainValidationResult(int iSignatureIndex); Unicode (Windows) INT GetSignatureChainValidationResult(INT iSignatureIndex);
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_pdfsigner_getsignaturechainvalidationresult(void* lpObj, int signatureindex);
int GetSignatureChainValidationResult(int iSignatureIndex);
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The 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.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureClaimedSigningTime Property (PDFSigner Class)
Returns or sets the signature's creation time.
Syntax
ANSI (Cross Platform) char* GetSignatureClaimedSigningTime(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureClaimedSigningTime(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignatureclaimedsigningtime(void* lpObj, int signatureindex);
QString GetSignatureClaimedSigningTime(int iSignatureIndex);
Default Value
""
Remarks
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 SignatureValidatedSigningTime, does not originate from a trusted TSA and may be forfeited or wrong.
The time is provided in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureContactInfo Property (PDFSigner Class)
Contains the signer's contact information.
Syntax
ANSI (Cross Platform) char* GetSignatureContactInfo(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureContactInfo(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturecontactinfo(void* lpObj, int signatureindex);
QString GetSignatureContactInfo(int iSignatureIndex);
Default Value
""
Remarks
Contains the signer's contact information. This is a PDF document property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureCoverageEndsAt Property (PDFSigner Class)
Indicates the offset in the PDF file where signature coverage ends.
Syntax
ANSI (Cross Platform) int GetSignatureCoverageEndsAt(int iSignatureIndex); Unicode (Windows) INT GetSignatureCoverageEndsAt(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturecoverageendsat(void* lpObj, int signatureindex);
int GetSignatureCoverageEndsAt(int iSignatureIndex);
Default Value
0
Remarks
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.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureCustomData Property (PDFSigner Class)
Uninterpreted custom data to save with the signature.
Syntax
ANSI (Cross Platform) int GetSignatureCustomData(int iSignatureIndex, char* &lpSignatureCustomData, int &lenSignatureCustomData); Unicode (Windows) INT GetSignatureCustomData(INT iSignatureIndex, LPSTR &lpSignatureCustomData, INT &lenSignatureCustomData);
int secureblackbox_pdfsigner_getsignaturecustomdata(void* lpObj, int signatureindex, char** lpSignatureCustomData, int* lenSignatureCustomData);
QByteArray GetSignatureCustomData(int iSignatureIndex);
Remarks
Uninterpreted custom data to save with the signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
SignatureEmptyField Property (PDFSigner Class)
Indicates whether or not the signature created/read is an empty property (a signature placeholder).
Syntax
ANSI (Cross Platform) int GetSignatureEmptyField(int iSignatureIndex); Unicode (Windows) BOOL GetSignatureEmptyField(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignatureemptyfield(void* lpObj, int signatureindex);
bool GetSignatureEmptyField(int iSignatureIndex);
Default Value
FALSE
Remarks
Indicates whether or not the signature created/read is an empty field (a signature placeholder).
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureFilterName Property (PDFSigner Class)
The signature filter name.
Syntax
ANSI (Cross Platform) char* GetSignatureFilterName(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureFilterName(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturefiltername(void* lpObj, int signatureindex);
QString GetSignatureFilterName(int iSignatureIndex);
Default Value
""
Remarks
The signature filter name.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureFullSignatureName Property (PDFSigner Class)
Specifies the full name of the signature property.
Syntax
ANSI (Cross Platform) char* GetSignatureFullSignatureName(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureFullSignatureName(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturefullsignaturename(void* lpObj, int signatureindex);
QString GetSignatureFullSignatureName(int iSignatureIndex);
Default Value
""
Remarks
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.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetSignatureHandle(int iSignatureIndex); Unicode (Windows) LONG64 GetSignatureHandle(INT iSignatureIndex);
int64 secureblackbox_pdfsigner_getsignaturehandle(void* lpObj, int signatureindex);
qint64 GetSignatureHandle(int iSignatureIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Long64
SignatureHashAlgorithm Property (PDFSigner Class)
Specifies the hash algorithm to be used for signing.
Syntax
ANSI (Cross Platform) char* GetSignatureHashAlgorithm(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureHashAlgorithm(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturehashalgorithm(void* lpObj, int signatureindex);
QString GetSignatureHashAlgorithm(int iSignatureIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used for signing.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureHeight Property (PDFSigner Class)
Specifies the height of the signature widget.
Syntax
ANSI (Cross Platform) int GetSignatureHeight(int iSignatureIndex); Unicode (Windows) INT GetSignatureHeight(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignatureheight(void* lpObj, int signatureindex);
int GetSignatureHeight(int iSignatureIndex);
Default Value
0
Remarks
Specifies the height of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureLevel Property (PDFSigner Class)
Specifies the signature kind and level.
Syntax
ANSI (Cross Platform) int GetSignatureLevel(int iSignatureIndex); Unicode (Windows) INT GetSignatureLevel(INT iSignatureIndex);
Possible Values
PSL_LEGACY(0),
PSL_BES(1),
PSL_EPES(2),
PSL_LTV(3),
PSL_DOCUMENT_TIMESTAMP(4)
int secureblackbox_pdfsigner_getsignaturelevel(void* lpObj, int signatureindex);
int GetSignatureLevel(int iSignatureIndex);
Default Value
0
Remarks
Specifies the signature kind and level.
pslLegacy | 0 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
pslBES | 1 | PAdES-BES signature (ETSI.CAdES.detached) |
pslEPES | 2 | PAdES-EPES signature (ETSI.CAdES.detached + embedded policy) |
pslLTV | 3 | PAdES-LTV signature (ETSI.CAdES.detached + revocation info) |
pslDocumentTimestamp | 4 | Document timestamp (ETSI.RFC3161) |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureLocation Property (PDFSigner Class)
Specifies the host name or the physical location of the signing entity.
Syntax
ANSI (Cross Platform) char* GetSignatureLocation(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureLocation(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturelocation(void* lpObj, int signatureindex);
QString GetSignatureLocation(int iSignatureIndex);
Default Value
""
Remarks
Specifies the host name or the physical location of the signing entity. This is a PDF property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureOffsetX Property (PDFSigner Class)
Specifies the signature widget offset from the left-hand page border.
Syntax
ANSI (Cross Platform) int GetSignatureOffsetX(int iSignatureIndex); Unicode (Windows) INT GetSignatureOffsetX(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignatureoffsetx(void* lpObj, int signatureindex);
int GetSignatureOffsetX(int iSignatureIndex);
Default Value
0
Remarks
Specifies the signature widget offset from the left-hand page border.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureOffsetY Property (PDFSigner Class)
Specifies the signature widget offset from the bottom page border.
Syntax
ANSI (Cross Platform) int GetSignatureOffsetY(int iSignatureIndex); Unicode (Windows) INT GetSignatureOffsetY(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignatureoffsety(void* lpObj, int signatureindex);
int GetSignatureOffsetY(int iSignatureIndex);
Default Value
0
Remarks
Specifies the signature widget offset from the bottom page border.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignaturePage Property (PDFSigner Class)
Indicates the index of the page on which the signature is placed.
Syntax
ANSI (Cross Platform) int GetSignaturePage(int iSignatureIndex); Unicode (Windows) INT GetSignaturePage(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturepage(void* lpObj, int signatureindex);
int GetSignaturePage(int iSignatureIndex);
Default Value
-1
Remarks
Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignaturePolicyHash Property (PDFSigner Class)
The signature policy hash value for EPES signatures.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyHash(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyHash(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturepolicyhash(void* lpObj, int signatureindex);
QString GetSignaturePolicyHash(int iSignatureIndex);
Default Value
""
Remarks
The signature policy hash value for EPES signatures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignaturePolicyHashAlgorithm Property (PDFSigner Class)
The algorithm that was used to calculate the signature policy hash.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyHashAlgorithm(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyHashAlgorithm(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturepolicyhashalgorithm(void* lpObj, int signatureindex);
QString GetSignaturePolicyHashAlgorithm(int iSignatureIndex);
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignaturePolicyID Property (PDFSigner Class)
The policy ID to be included into the signature.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyID(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyID(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturepolicyid(void* lpObj, int signatureindex);
QString GetSignaturePolicyID(int iSignatureIndex);
Default Value
""
Remarks
The policy ID to be included into the signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureReason Property (PDFSigner Class)
Specifies the reason for signing.
Syntax
ANSI (Cross Platform) char* GetSignatureReason(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureReason(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturereason(void* lpObj, int signatureindex);
QString GetSignatureReason(int iSignatureIndex);
Default Value
""
Remarks
Specifies the reason for signing. This is a PDF document property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureSignatureBytes Property (PDFSigner Class)
Returns the binary representation of the underlying PKCS7 signature blob.
Syntax
ANSI (Cross Platform) int GetSignatureSignatureBytes(int iSignatureIndex, char* &lpSignatureSignatureBytes, int &lenSignatureSignatureBytes); Unicode (Windows) INT GetSignatureSignatureBytes(INT iSignatureIndex, LPSTR &lpSignatureSignatureBytes, INT &lenSignatureSignatureBytes);
int secureblackbox_pdfsigner_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);
QByteArray GetSignatureSignatureBytes(int iSignatureIndex);
Remarks
Returns the binary representation of the underlying PKCS7 signature blob.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
SignatureSignatureName Property (PDFSigner Class)
Specifies the unique signature identifier to use.
Syntax
ANSI (Cross Platform) char* GetSignatureSignatureName(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureSignatureName(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturesignaturename(void* lpObj, int signatureindex);
QString GetSignatureSignatureName(int iSignatureIndex);
Default Value
""
Remarks
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.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureSignatureValidationResult Property (PDFSigner Class)
The outcome of the cryptographic signature validation.
Syntax
ANSI (Cross Platform) int GetSignatureSignatureValidationResult(int iSignatureIndex); Unicode (Windows) INT GetSignatureSignatureValidationResult(INT iSignatureIndex);
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_pdfsigner_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);
int GetSignatureSignatureValidationResult(int iSignatureIndex);
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureSubjectRDN Property (PDFSigner Class)
Contains the RDN of the owner of the signing certificate.
Syntax
ANSI (Cross Platform) char* GetSignatureSubjectRDN(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureSubjectRDN(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturesubjectrdn(void* lpObj, int signatureindex);
QString GetSignatureSubjectRDN(int iSignatureIndex);
Default Value
""
Remarks
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.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureTimestamped Property (PDFSigner Class)
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
ANSI (Cross Platform) int GetSignatureTimestamped(int iSignatureIndex); Unicode (Windows) BOOL GetSignatureTimestamped(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturetimestamped(void* lpObj, int signatureindex);
bool GetSignatureTimestamped(int iSignatureIndex);
Default Value
FALSE
Remarks
Use this property to establish whether the signature contains an embedded timestamp.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureValidatedSigningTime Property (PDFSigner Class)
Contains the certified signing time.
Syntax
ANSI (Cross Platform) char* GetSignatureValidatedSigningTime(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureValidatedSigningTime(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturevalidatedsigningtime(void* lpObj, int signatureindex);
QString GetSignatureValidatedSigningTime(int iSignatureIndex);
Default Value
""
Remarks
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.
SignatureClaimedSigningTime returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureValidationLog Property (PDFSigner Class)
Contains the signing certificate's chain validation log.
Syntax
ANSI (Cross Platform) char* GetSignatureValidationLog(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureValidationLog(INT iSignatureIndex);
char* secureblackbox_pdfsigner_getsignaturevalidationlog(void* lpObj, int signatureindex);
QString GetSignatureValidationLog(int iSignatureIndex);
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureWidth Property (PDFSigner Class)
Specifies the width of the signature widget.
Syntax
ANSI (Cross Platform) int GetSignatureWidth(int iSignatureIndex); Unicode (Windows) INT GetSignatureWidth(INT iSignatureIndex);
int secureblackbox_pdfsigner_getsignaturewidth(void* lpObj, int signatureindex);
int GetSignatureWidth(int iSignatureIndex);
Default Value
0
Remarks
Specifies the width of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SigningCertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetSigningCertBytes(char* &lpSigningCertBytes, int &lenSigningCertBytes); Unicode (Windows) INT GetSigningCertBytes(LPSTR &lpSigningCertBytes, INT &lenSigningCertBytes);
int secureblackbox_pdfsigner_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
QByteArray GetSigningCertBytes();
Remarks
Returns the raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetSigningCertHandle();
int SetSigningCertHandle(int64 lSigningCertHandle); Unicode (Windows) LONG64 GetSigningCertHandle();
INT SetSigningCertHandle(LONG64 lSigningCertHandle);
int64 secureblackbox_pdfsigner_getsigningcerthandle(void* lpObj);
int secureblackbox_pdfsigner_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);
qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
SigningChainCount Property (PDFSigner Class)
The number of records in the SigningChain arrays.
Syntax
ANSI (Cross Platform) int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount); Unicode (Windows) INT GetSigningChainCount();
INT SetSigningChainCount(INT iSigningChainCount);
int secureblackbox_pdfsigner_getsigningchaincount(void* lpObj);
int secureblackbox_pdfsigner_setsigningchaincount(void* lpObj, int iSigningChainCount);
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SigningChainCount - 1.
This property is not available at design time.
Data Type
Integer
SigningChainBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetSigningChainBytes(int iSigningChainIndex, char* &lpSigningChainBytes, int &lenSigningChainBytes); Unicode (Windows) INT GetSigningChainBytes(INT iSigningChainIndex, LPSTR &lpSigningChainBytes, INT &lenSigningChainBytes);
int secureblackbox_pdfsigner_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);
QByteArray GetSigningChainBytes(int iSigningChainIndex);
Remarks
Returns the raw certificate data in DER format.
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningChainHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, int64 lSigningChainHandle); Unicode (Windows) LONG64 GetSigningChainHandle(INT iSigningChainIndex);
INT SetSigningChainHandle(INT iSigningChainIndex, LONG64 lSigningChainHandle);
int64 secureblackbox_pdfsigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_pdfsigner_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);
qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is not available at design time.
Data Type
Long64
SocketDNSMode Property (PDFSigner Class)
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
ANSI (Cross Platform) int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); Unicode (Windows) INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);
Possible Values
DM_AUTO(0),
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
int secureblackbox_pdfsigner_getsocketdnsmode(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
Data Type
Integer
SocketDNSPort Property (PDFSigner Class)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
ANSI (Cross Platform) int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); Unicode (Windows) INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);
int secureblackbox_pdfsigner_getsocketdnsport(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (PDFSigner Class)
The timeout (in milliseconds) for each DNS query.
Syntax
ANSI (Cross Platform) int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); Unicode (Windows) INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);
int secureblackbox_pdfsigner_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
Data Type
Integer
SocketDNSServers Property (PDFSigner Class)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
ANSI (Cross Platform) char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers); Unicode (Windows) LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);
char* secureblackbox_pdfsigner_getsocketdnsservers(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (PDFSigner Class)
The timeout (in milliseconds) for the whole resolution process.
Syntax
ANSI (Cross Platform) int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); Unicode (Windows) INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);
int secureblackbox_pdfsigner_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_pdfsigner_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
Data Type
Integer
SocketIncomingSpeedLimit Property (PDFSigner Class)
The maximum number of bytes to read from the socket, per second.
Syntax
ANSI (Cross Platform) int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); Unicode (Windows) INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);
int secureblackbox_pdfsigner_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_pdfsigner_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (PDFSigner Class)
The local network interface to bind the socket to.
Syntax
ANSI (Cross Platform) char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress); Unicode (Windows) LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);
char* secureblackbox_pdfsigner_getsocketlocaladdress(void* lpObj);
int secureblackbox_pdfsigner_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (PDFSigner Class)
The local port number to bind the socket to.
Syntax
ANSI (Cross Platform) int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); Unicode (Windows) INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);
int secureblackbox_pdfsigner_getsocketlocalport(void* lpObj);
int secureblackbox_pdfsigner_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (PDFSigner Class)
The maximum number of bytes to write to the socket, per second.
Syntax
ANSI (Cross Platform) int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); Unicode (Windows) INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);
int secureblackbox_pdfsigner_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_pdfsigner_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (PDFSigner Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
ANSI (Cross Platform) int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); Unicode (Windows) INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);
int secureblackbox_pdfsigner_getsockettimeout(void* lpObj);
int secureblackbox_pdfsigner_setsockettimeout(void* lpObj, int iSocketTimeout);
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (PDFSigner Class)
Enables or disables IP protocol version 6.
Syntax
ANSI (Cross Platform) int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6); Unicode (Windows) BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);
int secureblackbox_pdfsigner_getsocketuseipv6(void* lpObj);
int secureblackbox_pdfsigner_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
FALSE
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TimestampCount Property (PDFSigner Class)
The number of records in the Timestamp arrays.
Syntax
ANSI (Cross Platform) int GetTimestampCount(); Unicode (Windows) INT GetTimestampCount();
int secureblackbox_pdfsigner_gettimestampcount(void* lpObj);
int GetTimestampCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- TimestampAccuracy
- TimestampBytes
- TimestampCertificateIndex
- TimestampChainValidationDetails
- TimestampChainValidationResult
- TimestampHashAlgorithm
- TimestampSerialNumber
- TimestampSignatureIndex
- TimestampTime
- TimestampTimestampType
- TimestampTSAName
- TimestampValidationLog
- TimestampValidationResult
The array indices start at 0 and end at TimestampCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
TimestampAccuracy Property (PDFSigner Class)
This property indicates the accuracy of the included time mark, in microseconds.
Syntax
ANSI (Cross Platform) int64 GetTimestampAccuracy(int iTimestampIndex); Unicode (Windows) LONG64 GetTimestampAccuracy(INT iTimestampIndex);
int64 secureblackbox_pdfsigner_gettimestampaccuracy(void* lpObj, int timestampindex);
qint64 GetTimestampAccuracy(int iTimestampIndex);
Default Value
0
Remarks
This field indicates the accuracy of the included time mark, in microseconds.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Long64
TimestampBytes Property (PDFSigner Class)
Returns the raw timestamp data in DER format.
Syntax
ANSI (Cross Platform) int GetTimestampBytes(int iTimestampIndex, char* &lpTimestampBytes, int &lenTimestampBytes); Unicode (Windows) INT GetTimestampBytes(INT iTimestampIndex, LPSTR &lpTimestampBytes, INT &lenTimestampBytes);
int secureblackbox_pdfsigner_gettimestampbytes(void* lpObj, int timestampindex, char** lpTimestampBytes, int* lenTimestampBytes);
QByteArray GetTimestampBytes(int iTimestampIndex);
Remarks
Returns the raw timestamp data in DER format.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TimestampCertificateIndex Property (PDFSigner Class)
Returns the index of the TSA certificate in the Certificates collection.
Syntax
ANSI (Cross Platform) int GetTimestampCertificateIndex(int iTimestampIndex); Unicode (Windows) INT GetTimestampCertificateIndex(INT iTimestampIndex);
int secureblackbox_pdfsigner_gettimestampcertificateindex(void* lpObj, int timestampindex);
int GetTimestampCertificateIndex(int iTimestampIndex);
Default Value
-1
Remarks
Returns the index of the TSA certificate in the Certificates collection.
Use this property to look up the TSA certificate in the Certificates collection.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Integer
TimestampChainValidationDetails Property (PDFSigner Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetTimestampChainValidationDetails(int iTimestampIndex); Unicode (Windows) INT GetTimestampChainValidationDetails(INT iTimestampIndex);
int secureblackbox_pdfsigner_gettimestampchainvalidationdetails(void* lpObj, int timestampindex);
int GetTimestampChainValidationDetails(int iTimestampIndex);
Default Value
0
Remarks
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:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Integer
TimestampChainValidationResult Property (PDFSigner Class)
The outcome of a certificate chain validation routine.
Syntax
ANSI (Cross Platform) int GetTimestampChainValidationResult(int iTimestampIndex); Unicode (Windows) INT GetTimestampChainValidationResult(INT iTimestampIndex);
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_pdfsigner_gettimestampchainvalidationresult(void* lpObj, int timestampindex);
int GetTimestampChainValidationResult(int iTimestampIndex);
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The 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.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Integer
TimestampHashAlgorithm Property (PDFSigner Class)
Returns the timestamp's hash algorithm.
Syntax
ANSI (Cross Platform) char* GetTimestampHashAlgorithm(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampHashAlgorithm(INT iTimestampIndex);
char* secureblackbox_pdfsigner_gettimestamphashalgorithm(void* lpObj, int timestampindex);
QString GetTimestampHashAlgorithm(int iTimestampIndex);
Default Value
""
Remarks
Returns the timestamp's hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
String
TimestampSerialNumber Property (PDFSigner Class)
Returns the timestamp's serial number.
Syntax
ANSI (Cross Platform) int GetTimestampSerialNumber(int iTimestampIndex, char* &lpTimestampSerialNumber, int &lenTimestampSerialNumber); Unicode (Windows) INT GetTimestampSerialNumber(INT iTimestampIndex, LPSTR &lpTimestampSerialNumber, INT &lenTimestampSerialNumber);
int secureblackbox_pdfsigner_gettimestampserialnumber(void* lpObj, int timestampindex, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);
QByteArray GetTimestampSerialNumber(int iTimestampIndex);
Remarks
Returns the timestamp's serial number.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TimestampSignatureIndex Property (PDFSigner Class)
Returns the index of the owner signature, if applicable.
Syntax
ANSI (Cross Platform) int GetTimestampSignatureIndex(int iTimestampIndex); Unicode (Windows) INT GetTimestampSignatureIndex(INT iTimestampIndex);
int secureblackbox_pdfsigner_gettimestampsignatureindex(void* lpObj, int timestampindex);
int GetTimestampSignatureIndex(int iTimestampIndex);
Default Value
-1
Remarks
Returns the index of the owner signature, if applicable.
Use this property to establish the index of the associated signature object in the signature collection.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Integer
TimestampTime Property (PDFSigner Class)
The time point incorporated into the timestamp.
Syntax
ANSI (Cross Platform) char* GetTimestampTime(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampTime(INT iTimestampIndex);
char* secureblackbox_pdfsigner_gettimestamptime(void* lpObj, int timestampindex);
QString GetTimestampTime(int iTimestampIndex);
Default Value
""
Remarks
The time point incorporated into the timestamp.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
String
TimestampTimestampType Property (PDFSigner Class)
Returns the type of the timestamp.
Syntax
ANSI (Cross Platform) int GetTimestampTimestampType(int iTimestampIndex); Unicode (Windows) INT GetTimestampTimestampType(INT iTimestampIndex);
int secureblackbox_pdfsigner_gettimestamptimestamptype(void* lpObj, int timestampindex);
int GetTimestampTimestampType(int iTimestampIndex);
Default Value
0
Remarks
Returns the type of the timestamp.
Available options:
tstUnknown | 0 | |
tstLegacy | 1 | Supported by: Authenticode components |
tstTrusted | 2 | Supported by: Authenticode components |
tstGeneric | 3 | Supported by: CAdES components |
tstESC | 4 | Supported by: CAdES components |
tstContent | 5 | Supported by: CAdES components |
tstCertsAndCRLs | 6 | Supported by: CAdES components |
tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
tstIndividualDataObjects | 10 | Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components |
tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
tstArchive141 | 16 | Archive 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).
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Integer
TimestampTSAName Property (PDFSigner Class)
This value uniquely identifies the Timestamp Authority (TSA).
Syntax
ANSI (Cross Platform) char* GetTimestampTSAName(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampTSAName(INT iTimestampIndex);
char* secureblackbox_pdfsigner_gettimestamptsaname(void* lpObj, int timestampindex);
QString GetTimestampTSAName(int iTimestampIndex);
Default Value
""
Remarks
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
String
TimestampValidationLog Property (PDFSigner Class)
Contains the TSA certificate chain validation log.
Syntax
ANSI (Cross Platform) char* GetTimestampValidationLog(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampValidationLog(INT iTimestampIndex);
char* secureblackbox_pdfsigner_gettimestampvalidationlog(void* lpObj, int timestampindex);
QString GetTimestampValidationLog(int iTimestampIndex);
Default Value
""
Remarks
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
String
TimestampValidationResult Property (PDFSigner Class)
Contains the timestamp validation outcome.
Syntax
ANSI (Cross Platform) int GetTimestampValidationResult(int iTimestampIndex); Unicode (Windows) INT GetTimestampValidationResult(INT iTimestampIndex);
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_pdfsigner_gettimestampvalidationresult(void* lpObj, int timestampindex);
int GetTimestampValidationResult(int iTimestampIndex);
Default Value
0
Remarks
Contains the timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only and not available at design time.
Data Type
Integer
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 set the address of the TSA (Time Stamping Authority) server to use for timestamping the signature (normal signing) or the document (LTV update).
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.
Data Type
String
TLSClientCertCount Property (PDFSigner Class)
The number of records in the TLSClientCert arrays.
Syntax
ANSI (Cross Platform) int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); Unicode (Windows) INT GetTLSClientCertCount();
INT SetTLSClientCertCount(INT iTLSClientCertCount);
int secureblackbox_pdfsigner_gettlsclientcertcount(void* lpObj);
int secureblackbox_pdfsigner_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSClientCertCount - 1.
This property is not available at design time.
Data Type
Integer
TLSClientCertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetTLSClientCertBytes(int iTLSClientCertIndex, char* &lpTLSClientCertBytes, int &lenTLSClientCertBytes); Unicode (Windows) INT GetTLSClientCertBytes(INT iTLSClientCertIndex, LPSTR &lpTLSClientCertBytes, INT &lenTLSClientCertBytes);
int secureblackbox_pdfsigner_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);
Remarks
Returns the raw certificate data in DER format.
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSClientCertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, int64 lTLSClientCertHandle); Unicode (Windows) LONG64 GetTLSClientCertHandle(INT iTLSClientCertIndex);
INT SetTLSClientCertHandle(INT iTLSClientCertIndex, LONG64 lTLSClientCertHandle);
int64 secureblackbox_pdfsigner_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_pdfsigner_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is not available at design time.
Data Type
Long64
TLSServerCertCount Property (PDFSigner Class)
The number of records in the TLSServerCert arrays.
Syntax
ANSI (Cross Platform) int GetTLSServerCertCount(); Unicode (Windows) INT GetTLSServerCertCount();
int secureblackbox_pdfsigner_gettlsservercertcount(void* lpObj);
int GetTLSServerCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
TLSServerCertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetTLSServerCertBytes(int iTLSServerCertIndex, char* &lpTLSServerCertBytes, int &lenTLSServerCertBytes); Unicode (Windows) INT GetTLSServerCertBytes(INT iTLSServerCertIndex, LPSTR &lpTLSServerCertBytes, INT &lenTLSServerCertBytes);
int secureblackbox_pdfsigner_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);
Remarks
Returns the raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSServerCertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetTLSServerCertHandle(int iTLSServerCertIndex); Unicode (Windows) LONG64 GetTLSServerCertHandle(INT iTLSServerCertIndex);
int64 secureblackbox_pdfsigner_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
TLSAutoValidateCertificates Property (PDFSigner Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
ANSI (Cross Platform) int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates); Unicode (Windows) BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);
int secureblackbox_pdfsigner_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_pdfsigner_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
TRUE
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (PDFSigner Class)
Selects the base configuration for the TLS settings.
Syntax
ANSI (Cross Platform) int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); Unicode (Windows) INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
int secureblackbox_pdfsigner_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_pdfsigner_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (PDFSigner Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
ANSI (Cross Platform) char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites); Unicode (Windows) LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);
char* secureblackbox_pdfsigner_gettlsciphersuites(void* lpObj);
int secureblackbox_pdfsigner_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, 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 TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSECCurves Property (PDFSigner Class)
Defines the elliptic curves to enable.
Syntax
ANSI (Cross Platform) char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves); Unicode (Windows) LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);
char* secureblackbox_pdfsigner_gettlseccurves(void* lpObj);
int secureblackbox_pdfsigner_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (PDFSigner Class)
Provides access to TLS extensions.
Syntax
ANSI (Cross Platform) char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions); Unicode (Windows) LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);
char* secureblackbox_pdfsigner_gettlsextensions(void* lpObj);
int secureblackbox_pdfsigner_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (PDFSigner Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
ANSI (Cross Platform) int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges); Unicode (Windows) BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);
int secureblackbox_pdfsigner_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_pdfsigner_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
FALSE
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (PDFSigner Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (PDFSigner Class)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (PDFSigner Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (PDFSigner Class)
Selects the renegotiation attack prevention mechanism.
Syntax
ANSI (Cross Platform) int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); Unicode (Windows) INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
int secureblackbox_pdfsigner_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_pdfsigner_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Default Value
0
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (PDFSigner Class)
Specifies the kind(s) of revocation check to perform.
Syntax
ANSI (Cross Platform) int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); Unicode (Windows) INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);
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_gettlsrevocationcheck(void* lpObj);
int secureblackbox_pdfsigner_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All 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.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (PDFSigner Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
ANSI (Cross Platform) int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); Unicode (Windows) INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);
int secureblackbox_pdfsigner_gettlsssloptions(void* lpObj);
int secureblackbox_pdfsigner_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (PDFSigner Class)
Specifies the TLS mode to use.
Syntax
ANSI (Cross Platform) int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); Unicode (Windows) INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
int secureblackbox_pdfsigner_gettlstlsmode(void* lpObj);
int secureblackbox_pdfsigner_settlstlsmode(void* lpObj, int iTLSTLSMode);
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Default Value
0
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (PDFSigner Class)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
ANSI (Cross Platform) int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret); Unicode (Windows) BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);
int secureblackbox_pdfsigner_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_pdfsigner_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
FALSE
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (PDFSigner Class)
Enables or disables the TLS session resumption capability.
Syntax
ANSI (Cross Platform) int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption); Unicode (Windows) BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);
int secureblackbox_pdfsigner_gettlsusesessionresumption(void* lpObj);
int secureblackbox_pdfsigner_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
FALSE
Remarks
Enables or disables the TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (PDFSigner Class)
The SSL/TLS versions to enable by default.
Syntax
ANSI (Cross Platform) int GetTLSVersions();
int SetTLSVersions(int iTLSVersions); Unicode (Windows) INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);
int secureblackbox_pdfsigner_gettlsversions(void* lpObj);
int secureblackbox_pdfsigner_settlsversions(void* lpObj, int iTLSVersions);
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
TrustedCertCount Property (PDFSigner Class)
The number of records in the TrustedCert arrays.
Syntax
ANSI (Cross Platform) int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); Unicode (Windows) INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);
int secureblackbox_pdfsigner_gettrustedcertcount(void* lpObj);
int secureblackbox_pdfsigner_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TrustedCertCount - 1.
This property is not available at design time.
Data Type
Integer
TrustedCertBytes Property (PDFSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetTrustedCertBytes(int iTrustedCertIndex, char* &lpTrustedCertBytes, int &lenTrustedCertBytes); Unicode (Windows) INT GetTrustedCertBytes(INT iTrustedCertIndex, LPSTR &lpTrustedCertBytes, INT &lenTrustedCertBytes);
int secureblackbox_pdfsigner_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);
Remarks
Returns the raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TrustedCertHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, int64 lTrustedCertHandle); Unicode (Windows) LONG64 GetTrustedCertHandle(INT iTrustedCertIndex);
INT SetTrustedCertHandle(INT iTrustedCertIndex, LONG64 lTrustedCertHandle);
int64 secureblackbox_pdfsigner_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_pdfsigner_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is not available at design time.
Data Type
Long64
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
WidgetAlgorithmCaption Property (PDFSigner Class)
The caption of the signature widget property with information about the signature algorithm.
Syntax
ANSI (Cross Platform) char* GetWidgetAlgorithmCaption();
int SetWidgetAlgorithmCaption(const char* lpszWidgetAlgorithmCaption); Unicode (Windows) LPWSTR GetWidgetAlgorithmCaption();
INT SetWidgetAlgorithmCaption(LPCWSTR lpszWidgetAlgorithmCaption);
char* secureblackbox_pdfsigner_getwidgetalgorithmcaption(void* lpObj);
int secureblackbox_pdfsigner_setwidgetalgorithmcaption(void* lpObj, const char* lpszWidgetAlgorithmCaption);
QString GetWidgetAlgorithmCaption();
int SetWidgetAlgorithmCaption(QString qsWidgetAlgorithmCaption);
Default Value
"#auto"
Remarks
The caption of the signature widget field with information about the signature algorithm.
This property is not available at design time.
Data Type
String
WidgetAlgorithmInfo Property (PDFSigner Class)
Information about the algorithm to be shown on the signature widget.
Syntax
ANSI (Cross Platform) char* GetWidgetAlgorithmInfo();
int SetWidgetAlgorithmInfo(const char* lpszWidgetAlgorithmInfo); Unicode (Windows) LPWSTR GetWidgetAlgorithmInfo();
INT SetWidgetAlgorithmInfo(LPCWSTR lpszWidgetAlgorithmInfo);
char* secureblackbox_pdfsigner_getwidgetalgorithminfo(void* lpObj);
int secureblackbox_pdfsigner_setwidgetalgorithminfo(void* lpObj, const char* lpszWidgetAlgorithmInfo);
QString GetWidgetAlgorithmInfo();
int SetWidgetAlgorithmInfo(QString qsWidgetAlgorithmInfo);
Default Value
"#auto"
Remarks
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".
This property is not available at design time.
Data Type
String
WidgetBackgroundData Property (PDFSigner Class)
Contains/takes the data of the signature widget background bitmap.
Syntax
ANSI (Cross Platform) int GetWidgetBackgroundData(char* &lpWidgetBackgroundData, int &lenWidgetBackgroundData);
int SetWidgetBackgroundData(const char* lpWidgetBackgroundData, int lenWidgetBackgroundData); Unicode (Windows) INT GetWidgetBackgroundData(LPSTR &lpWidgetBackgroundData, INT &lenWidgetBackgroundData);
INT SetWidgetBackgroundData(LPCSTR lpWidgetBackgroundData, INT lenWidgetBackgroundData);
int secureblackbox_pdfsigner_getwidgetbackgrounddata(void* lpObj, char** lpWidgetBackgroundData, int* lenWidgetBackgroundData);
int secureblackbox_pdfsigner_setwidgetbackgrounddata(void* lpObj, const char* lpWidgetBackgroundData, int lenWidgetBackgroundData);
QByteArray GetWidgetBackgroundData();
int SetWidgetBackgroundData(QByteArray qbaWidgetBackgroundData);
Remarks
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.
This property is not available at design time.
Data Type
Byte Array
WidgetBackgroundHeight Property (PDFSigner Class)
Use this property to manually adjust the size of the stretched background picture in the vertical direction.
Syntax
ANSI (Cross Platform) char* GetWidgetBackgroundHeight();
int SetWidgetBackgroundHeight(const char* lpszWidgetBackgroundHeight); Unicode (Windows) LPWSTR GetWidgetBackgroundHeight();
INT SetWidgetBackgroundHeight(LPCWSTR lpszWidgetBackgroundHeight);
char* secureblackbox_pdfsigner_getwidgetbackgroundheight(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundheight(void* lpObj, const char* lpszWidgetBackgroundHeight);
QString GetWidgetBackgroundHeight();
int SetWidgetBackgroundHeight(QString qsWidgetBackgroundHeight);
Default Value
"0"
Remarks
Use this property to manually adjust the size of the stretched background picture in the vertical direction.
This property is not available at design time.
Data Type
String
WidgetBackgroundImageHeight Property (PDFSigner Class)
The height of the background image in pixels.
Syntax
ANSI (Cross Platform) int GetWidgetBackgroundImageHeight();
int SetWidgetBackgroundImageHeight(int iWidgetBackgroundImageHeight); Unicode (Windows) INT GetWidgetBackgroundImageHeight();
INT SetWidgetBackgroundImageHeight(INT iWidgetBackgroundImageHeight);
int secureblackbox_pdfsigner_getwidgetbackgroundimageheight(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundimageheight(void* lpObj, int iWidgetBackgroundImageHeight);
int GetWidgetBackgroundImageHeight();
int SetWidgetBackgroundImageHeight(int iWidgetBackgroundImageHeight);
Default Value
0
Remarks
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.
This property is not available at design time.
Data Type
Integer
WidgetBackgroundImageType Property (PDFSigner Class)
The type of the image contained in BackgroundData .
Syntax
ANSI (Cross Platform) int GetWidgetBackgroundImageType();
int SetWidgetBackgroundImageType(int iWidgetBackgroundImageType); Unicode (Windows) INT GetWidgetBackgroundImageType();
INT SetWidgetBackgroundImageType(INT iWidgetBackgroundImageType);
Possible Values
PWIT_JPEG2000(0),
PWIT_JPEG(1),
PWIT_CUSTOM(2)
int secureblackbox_pdfsigner_getwidgetbackgroundimagetype(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundimagetype(void* lpObj, int iWidgetBackgroundImageType);
int GetWidgetBackgroundImageType();
int SetWidgetBackgroundImageType(int iWidgetBackgroundImageType);
Default Value
0
Remarks
The type of the image contained in WidgetBackgroundData. The JPEG and JPEG2000 formats are currently supported.
pwitJPEG2000 | 0 | JPEG 2000 format (supports transparency) |
pwitJPEG | 1 | standard JPEG format (does not support transparency) |
pwitCustom | 2 | Custom background format |
This property is not available at design time.
Data Type
Integer
WidgetBackgroundImageWidth Property (PDFSigner Class)
The width of the background image in pixels.
Syntax
ANSI (Cross Platform) int GetWidgetBackgroundImageWidth();
int SetWidgetBackgroundImageWidth(int iWidgetBackgroundImageWidth); Unicode (Windows) INT GetWidgetBackgroundImageWidth();
INT SetWidgetBackgroundImageWidth(INT iWidgetBackgroundImageWidth);
int secureblackbox_pdfsigner_getwidgetbackgroundimagewidth(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundimagewidth(void* lpObj, int iWidgetBackgroundImageWidth);
int GetWidgetBackgroundImageWidth();
int SetWidgetBackgroundImageWidth(int iWidgetBackgroundImageWidth);
Default Value
0
Remarks
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.
This property is not available at design time.
Data Type
Integer
WidgetBackgroundMask Property (PDFSigner Class)
Contains the background image mask.
Syntax
ANSI (Cross Platform) int GetWidgetBackgroundMask(char* &lpWidgetBackgroundMask, int &lenWidgetBackgroundMask);
int SetWidgetBackgroundMask(const char* lpWidgetBackgroundMask, int lenWidgetBackgroundMask); Unicode (Windows) INT GetWidgetBackgroundMask(LPSTR &lpWidgetBackgroundMask, INT &lenWidgetBackgroundMask);
INT SetWidgetBackgroundMask(LPCSTR lpWidgetBackgroundMask, INT lenWidgetBackgroundMask);
int secureblackbox_pdfsigner_getwidgetbackgroundmask(void* lpObj, char** lpWidgetBackgroundMask, int* lenWidgetBackgroundMask);
int secureblackbox_pdfsigner_setwidgetbackgroundmask(void* lpObj, const char* lpWidgetBackgroundMask, int lenWidgetBackgroundMask);
QByteArray GetWidgetBackgroundMask();
int SetWidgetBackgroundMask(QByteArray qbaWidgetBackgroundMask);
Remarks
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.
This property is not available at design time.
Data Type
Byte Array
WidgetBackgroundPosition Property (PDFSigner Class)
The position of the widget background.
Syntax
ANSI (Cross Platform) char* GetWidgetBackgroundPosition();
int SetWidgetBackgroundPosition(const char* lpszWidgetBackgroundPosition); Unicode (Windows) LPWSTR GetWidgetBackgroundPosition();
INT SetWidgetBackgroundPosition(LPCWSTR lpszWidgetBackgroundPosition);
char* secureblackbox_pdfsigner_getwidgetbackgroundposition(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundposition(void* lpObj, const char* lpszWidgetBackgroundPosition);
QString GetWidgetBackgroundPosition();
int SetWidgetBackgroundPosition(QString qsWidgetBackgroundPosition);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
WidgetBackgroundStyle Property (PDFSigner Class)
The style of the signature widget background.
Syntax
ANSI (Cross Platform) int GetWidgetBackgroundStyle();
int SetWidgetBackgroundStyle(int iWidgetBackgroundStyle); Unicode (Windows) INT GetWidgetBackgroundStyle();
INT SetWidgetBackgroundStyle(INT iWidgetBackgroundStyle);
Possible Values
PWBS_DEFAULT(0),
PWBS_NO_BACKGROUND(1),
PWBS_CUSTOM(2)
int secureblackbox_pdfsigner_getwidgetbackgroundstyle(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundstyle(void* lpObj, int iWidgetBackgroundStyle);
int GetWidgetBackgroundStyle();
int SetWidgetBackgroundStyle(int iWidgetBackgroundStyle);
Default Value
0
Remarks
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.
pwbsDefault | 0 | The default widget background |
pwbsNoBackground | 1 | No (empty) background |
pwbsCustom | 2 | Custom background (picture or vector) |
This property is not available at design time.
Data Type
Integer
WidgetBackgroundWidth Property (PDFSigner Class)
Use this property to manually adjust the horizontal size of the stretched background picture.
Syntax
ANSI (Cross Platform) char* GetWidgetBackgroundWidth();
int SetWidgetBackgroundWidth(const char* lpszWidgetBackgroundWidth); Unicode (Windows) LPWSTR GetWidgetBackgroundWidth();
INT SetWidgetBackgroundWidth(LPCWSTR lpszWidgetBackgroundWidth);
char* secureblackbox_pdfsigner_getwidgetbackgroundwidth(void* lpObj);
int secureblackbox_pdfsigner_setwidgetbackgroundwidth(void* lpObj, const char* lpszWidgetBackgroundWidth);
QString GetWidgetBackgroundWidth();
int SetWidgetBackgroundWidth(QString qsWidgetBackgroundWidth);
Default Value
"0"
Remarks
Use this property to manually adjust the horizontal size of the stretched background picture.
This property is not available at design time.
Data Type
String
WidgetCompressWidgetData Property (PDFSigner Class)
Whether the signature widget data should be compressed before saving.
Syntax
ANSI (Cross Platform) int GetWidgetCompressWidgetData();
int SetWidgetCompressWidgetData(int bWidgetCompressWidgetData); Unicode (Windows) BOOL GetWidgetCompressWidgetData();
INT SetWidgetCompressWidgetData(BOOL bWidgetCompressWidgetData);
int secureblackbox_pdfsigner_getwidgetcompresswidgetdata(void* lpObj);
int secureblackbox_pdfsigner_setwidgetcompresswidgetdata(void* lpObj, int bWidgetCompressWidgetData);
bool GetWidgetCompressWidgetData();
int SetWidgetCompressWidgetData(bool bWidgetCompressWidgetData);
Default Value
FALSE
Remarks
Whether the signature widget data should be compressed before saving.
This property is not available at design time.
Data Type
Boolean
WidgetCustomAppearance Property (PDFSigner Class)
Contains a custom widget description in raw PDF graphic operators format.
Syntax
ANSI (Cross Platform) int GetWidgetCustomAppearance(char* &lpWidgetCustomAppearance, int &lenWidgetCustomAppearance);
int SetWidgetCustomAppearance(const char* lpWidgetCustomAppearance, int lenWidgetCustomAppearance); Unicode (Windows) INT GetWidgetCustomAppearance(LPSTR &lpWidgetCustomAppearance, INT &lenWidgetCustomAppearance);
INT SetWidgetCustomAppearance(LPCSTR lpWidgetCustomAppearance, INT lenWidgetCustomAppearance);
int secureblackbox_pdfsigner_getwidgetcustomappearance(void* lpObj, char** lpWidgetCustomAppearance, int* lenWidgetCustomAppearance);
int secureblackbox_pdfsigner_setwidgetcustomappearance(void* lpObj, const char* lpWidgetCustomAppearance, int lenWidgetCustomAppearance);
QByteArray GetWidgetCustomAppearance();
int SetWidgetCustomAppearance(QByteArray qbaWidgetCustomAppearance);
Remarks
Contains a custom widget description in raw PDF graphic operators format.
Use this property to provide a PDF stream describing the widget appearance.
This property is not available at design time.
Data Type
Byte Array
WidgetCustomBackgroundContentStream Property (PDFSigner Class)
Specifies a custom background content stream for the pwbsCustom BackgroundStyle .
Syntax
ANSI (Cross Platform) char* GetWidgetCustomBackgroundContentStream();
int SetWidgetCustomBackgroundContentStream(const char* lpszWidgetCustomBackgroundContentStream); Unicode (Windows) LPWSTR GetWidgetCustomBackgroundContentStream();
INT SetWidgetCustomBackgroundContentStream(LPCWSTR lpszWidgetCustomBackgroundContentStream);
char* secureblackbox_pdfsigner_getwidgetcustombackgroundcontentstream(void* lpObj);
int secureblackbox_pdfsigner_setwidgetcustombackgroundcontentstream(void* lpObj, const char* lpszWidgetCustomBackgroundContentStream);
QString GetWidgetCustomBackgroundContentStream();
int SetWidgetCustomBackgroundContentStream(QString qsWidgetCustomBackgroundContentStream);
Default Value
""
Remarks
Specifies a custom background content stream for the pwbsCustom WidgetBackgroundStyle.
This property is not available at design time.
Data Type
String
WidgetCustomVisualStatusMatrix Property (PDFSigner Class)
Defines the custom visual status matrix.
Syntax
ANSI (Cross Platform) char* GetWidgetCustomVisualStatusMatrix();
int SetWidgetCustomVisualStatusMatrix(const char* lpszWidgetCustomVisualStatusMatrix); Unicode (Windows) LPWSTR GetWidgetCustomVisualStatusMatrix();
INT SetWidgetCustomVisualStatusMatrix(LPCWSTR lpszWidgetCustomVisualStatusMatrix);
char* secureblackbox_pdfsigner_getwidgetcustomvisualstatusmatrix(void* lpObj);
int secureblackbox_pdfsigner_setwidgetcustomvisualstatusmatrix(void* lpObj, const char* lpszWidgetCustomVisualStatusMatrix);
QString GetWidgetCustomVisualStatusMatrix();
int SetWidgetCustomVisualStatusMatrix(QString qsWidgetCustomVisualStatusMatrix);
Default Value
""
Remarks
Defines the custom visual status matrix.
Use of this property makes sense only if a visual status icon is displayed over the signature (WidgetShowVisualStatus). 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.
This property is not available at design time.
Data Type
String
WidgetDateFormat Property (PDFSigner Class)
The format string used to display the signing date and time in the signature widget.
Syntax
ANSI (Cross Platform) char* GetWidgetDateFormat();
int SetWidgetDateFormat(const char* lpszWidgetDateFormat); Unicode (Windows) LPWSTR GetWidgetDateFormat();
INT SetWidgetDateFormat(LPCWSTR lpszWidgetDateFormat);
char* secureblackbox_pdfsigner_getwidgetdateformat(void* lpObj);
int secureblackbox_pdfsigner_setwidgetdateformat(void* lpObj, const char* lpszWidgetDateFormat);
QString GetWidgetDateFormat();
int SetWidgetDateFormat(QString qsWidgetDateFormat);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
WidgetFontName Property (PDFSigner Class)
Specifies the font name for the signature text.
Syntax
ANSI (Cross Platform) char* GetWidgetFontName();
int SetWidgetFontName(const char* lpszWidgetFontName); Unicode (Windows) LPWSTR GetWidgetFontName();
INT SetWidgetFontName(LPCWSTR lpszWidgetFontName);
char* secureblackbox_pdfsigner_getwidgetfontname(void* lpObj);
int secureblackbox_pdfsigner_setwidgetfontname(void* lpObj, const char* lpszWidgetFontName);
QString GetWidgetFontName();
int SetWidgetFontName(QString qsWidgetFontName);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
WidgetHandle Property (PDFSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetWidgetHandle();
int SetWidgetHandle(int64 lWidgetHandle); Unicode (Windows) LONG64 GetWidgetHandle();
INT SetWidgetHandle(LONG64 lWidgetHandle);
int64 secureblackbox_pdfsigner_getwidgethandle(void* lpObj);
int secureblackbox_pdfsigner_setwidgethandle(void* lpObj, int64 lWidgetHandle);
qint64 GetWidgetHandle();
int SetWidgetHandle(qint64 lWidgetHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
WidgetHeader Property (PDFSigner Class)
Specifies the header text to put on the signature widget.
Syntax
ANSI (Cross Platform) char* GetWidgetHeader();
int SetWidgetHeader(const char* lpszWidgetHeader); Unicode (Windows) LPWSTR GetWidgetHeader();
INT SetWidgetHeader(LPCWSTR lpszWidgetHeader);
char* secureblackbox_pdfsigner_getwidgetheader(void* lpObj);
int secureblackbox_pdfsigner_setwidgetheader(void* lpObj, const char* lpszWidgetHeader);
QString GetWidgetHeader();
int SetWidgetHeader(QString qsWidgetHeader);
Default Value
"#auto"
Remarks
Specifies the header text to put on the signature widget. Keep this property set to #auto to make the component generate the header automatically.
This property is not available at design time.
Data Type
String
WidgetHideDefaultText Property (PDFSigner Class)
Switches off the generation of any headers for the signature widget.
Syntax
ANSI (Cross Platform) int GetWidgetHideDefaultText();
int SetWidgetHideDefaultText(int bWidgetHideDefaultText); Unicode (Windows) BOOL GetWidgetHideDefaultText();
INT SetWidgetHideDefaultText(BOOL bWidgetHideDefaultText);
int secureblackbox_pdfsigner_getwidgethidedefaulttext(void* lpObj);
int secureblackbox_pdfsigner_setwidgethidedefaulttext(void* lpObj, int bWidgetHideDefaultText);
bool GetWidgetHideDefaultText();
int SetWidgetHideDefaultText(bool bWidgetHideDefaultText);
Default Value
FALSE
Remarks
Switches off the generation of any headers for the signature widget.
This property is not available at design time.
Data Type
Boolean
WidgetIgnoreExistingAppearance Property (PDFSigner Class)
Tells the class to discard any existing widget parameters when signing empty signature properties.
Syntax
ANSI (Cross Platform) int GetWidgetIgnoreExistingAppearance();
int SetWidgetIgnoreExistingAppearance(int bWidgetIgnoreExistingAppearance); Unicode (Windows) BOOL GetWidgetIgnoreExistingAppearance();
INT SetWidgetIgnoreExistingAppearance(BOOL bWidgetIgnoreExistingAppearance);
int secureblackbox_pdfsigner_getwidgetignoreexistingappearance(void* lpObj);
int secureblackbox_pdfsigner_setwidgetignoreexistingappearance(void* lpObj, int bWidgetIgnoreExistingAppearance);
bool GetWidgetIgnoreExistingAppearance();
int SetWidgetIgnoreExistingAppearance(bool bWidgetIgnoreExistingAppearance);
Default Value
FALSE
Remarks
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.
This property is not available at design time.
Data Type
Boolean
WidgetInvertMask Property (PDFSigner Class)
Specifies whether BackgroundMask should be inverted.
Syntax
ANSI (Cross Platform) int GetWidgetInvertMask();
int SetWidgetInvertMask(int bWidgetInvertMask); Unicode (Windows) BOOL GetWidgetInvertMask();
INT SetWidgetInvertMask(BOOL bWidgetInvertMask);
int secureblackbox_pdfsigner_getwidgetinvertmask(void* lpObj);
int secureblackbox_pdfsigner_setwidgetinvertmask(void* lpObj, int bWidgetInvertMask);
bool GetWidgetInvertMask();
int SetWidgetInvertMask(bool bWidgetInvertMask);
Default Value
FALSE
Remarks
Specifies whether WidgetBackgroundMask 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.
This property is not available at design time.
Data Type
Boolean
WidgetInvisible Property (PDFSigner Class)
Controls whether the signature widget is visible on the page.
Syntax
ANSI (Cross Platform) int GetWidgetInvisible();
int SetWidgetInvisible(int bWidgetInvisible); Unicode (Windows) BOOL GetWidgetInvisible();
INT SetWidgetInvisible(BOOL bWidgetInvisible);
int secureblackbox_pdfsigner_getwidgetinvisible(void* lpObj);
int secureblackbox_pdfsigner_setwidgetinvisible(void* lpObj, int bWidgetInvisible);
bool GetWidgetInvisible();
int SetWidgetInvisible(bool bWidgetInvisible);
Default Value
FALSE
Remarks
Controls whether the signature widget is visible on the page.
This property is not available at design time.
Data Type
Boolean
WidgetPagesToPlaceOn Property (PDFSigner Class)
The page numbers on which the signature is shown.
Syntax
ANSI (Cross Platform) char* GetWidgetPagesToPlaceOn();
int SetWidgetPagesToPlaceOn(const char* lpszWidgetPagesToPlaceOn); Unicode (Windows) LPWSTR GetWidgetPagesToPlaceOn();
INT SetWidgetPagesToPlaceOn(LPCWSTR lpszWidgetPagesToPlaceOn);
char* secureblackbox_pdfsigner_getwidgetpagestoplaceon(void* lpObj);
int secureblackbox_pdfsigner_setwidgetpagestoplaceon(void* lpObj, const char* lpszWidgetPagesToPlaceOn);
QString GetWidgetPagesToPlaceOn();
int SetWidgetPagesToPlaceOn(QString qsWidgetPagesToPlaceOn);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
WidgetPositionAnchor Property (PDFSigner Class)
The anchor to bind the position of the widget to.
Syntax
ANSI (Cross Platform) int GetWidgetPositionAnchor();
int SetWidgetPositionAnchor(int iWidgetPositionAnchor); Unicode (Windows) INT GetWidgetPositionAnchor();
INT SetWidgetPositionAnchor(INT iWidgetPositionAnchor);
Possible Values
PPA_DEFAULT(0),
PPA_BOTTOM_LEFT(1),
PPA_BOTTOM_RIGHT(2),
PPA_TOP_LEFT(3),
PPA_TOP_RIGHT(4),
PPA_CENTER(5)
int secureblackbox_pdfsigner_getwidgetpositionanchor(void* lpObj);
int secureblackbox_pdfsigner_setwidgetpositionanchor(void* lpObj, int iWidgetPositionAnchor);
int GetWidgetPositionAnchor();
int SetWidgetPositionAnchor(int iWidgetPositionAnchor);
Default Value
0
Remarks
The anchor to bind the position of the widget to.
Supported values are:
ppaDefault | 0 | The 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). |
ppaBottomLeft | 1 | The 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). |
ppaBottomRight | 2 | The 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). |
ppaTopLeft | 3 | The 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). |
ppaTopRight | 4 | The 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). |
ppaCenter | 5 | The 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. |
This property is not available at design time.
Data Type
Integer
WidgetRenderOptions Property (PDFSigner Class)
This setting is a container for a selection of rendering options.
Syntax
ANSI (Cross Platform) int GetWidgetRenderOptions();
int SetWidgetRenderOptions(int iWidgetRenderOptions); Unicode (Windows) INT GetWidgetRenderOptions();
INT SetWidgetRenderOptions(INT iWidgetRenderOptions);
int secureblackbox_pdfsigner_getwidgetrenderoptions(void* lpObj);
int secureblackbox_pdfsigner_setwidgetrenderoptions(void* lpObj, int iWidgetRenderOptions);
int GetWidgetRenderOptions();
int SetWidgetRenderOptions(int iWidgetRenderOptions);
Default Value
8
Remarks
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.
wroUnknown | 0x00000 | Unknown, unsupported, or uninitialized set of options |
wroNoRotate | 0x00001 | Enabling this option prevents the signature widget from being rotated when the containing document is rotated in a viewing app. |
wroNoView | 0x00002 | Enabling this option prevents the widget from being displayed when the document is viewed in an app (the widget will still be printed, if configured). |
wroNoZoom | 0x00004 | Keeps the widget at the same size when the document is zoomed in or out. |
wroPrint | 0x00008 | Makes the widget printable. |
wroReadOnly | 0x00010 | Controls the ReadOnly flag of the widget object. |
wroToggleNoView | 0x00020 | If set, the signature widget will only be displayed when the viewer hovers a mouse pointer over it. |
This property is not available at design time.
Data Type
Integer
WidgetRotate Property (PDFSigner Class)
Specifies the rotation angle of the signature widget in degrees.
Syntax
ANSI (Cross Platform) int GetWidgetRotate();
int SetWidgetRotate(int iWidgetRotate); Unicode (Windows) INT GetWidgetRotate();
INT SetWidgetRotate(INT iWidgetRotate);
int secureblackbox_pdfsigner_getwidgetrotate(void* lpObj);
int secureblackbox_pdfsigner_setwidgetrotate(void* lpObj, int iWidgetRotate);
int GetWidgetRotate();
int SetWidgetRotate(int iWidgetRotate);
Default Value
0
Remarks
Specifies the rotation angle of the signature widget in degrees. Values of 0, 90, 180, and 270 are allowed.
This property is not available at design time.
Data Type
Integer
WidgetShowDate Property (PDFSigner Class)
Whether to display the signing date and time details on the widget.
Syntax
ANSI (Cross Platform) int GetWidgetShowDate();
int SetWidgetShowDate(int bWidgetShowDate); Unicode (Windows) BOOL GetWidgetShowDate();
INT SetWidgetShowDate(BOOL bWidgetShowDate);
int secureblackbox_pdfsigner_getwidgetshowdate(void* lpObj);
int secureblackbox_pdfsigner_setwidgetshowdate(void* lpObj, int bWidgetShowDate);
bool GetWidgetShowDate();
int SetWidgetShowDate(bool bWidgetShowDate);
Default Value
TRUE
Remarks
Whether to display the signing date and time details on the widget.
This property is not available at design time.
Data Type
Boolean
WidgetShowVisualStatus Property (PDFSigner Class)
Specifies whether to show the signature's status icon.
Syntax
ANSI (Cross Platform) int GetWidgetShowVisualStatus();
int SetWidgetShowVisualStatus(int bWidgetShowVisualStatus); Unicode (Windows) BOOL GetWidgetShowVisualStatus();
INT SetWidgetShowVisualStatus(BOOL bWidgetShowVisualStatus);
int secureblackbox_pdfsigner_getwidgetshowvisualstatus(void* lpObj);
int secureblackbox_pdfsigner_setwidgetshowvisualstatus(void* lpObj, int bWidgetShowVisualStatus);
bool GetWidgetShowVisualStatus();
int SetWidgetShowVisualStatus(bool bWidgetShowVisualStatus);
Default Value
FALSE
Remarks
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."
This property is not available at design time.
Data Type
Boolean
WidgetSignerCaption Property (PDFSigner Class)
Specifies the caption for the signer section on the signature widget.
Syntax
ANSI (Cross Platform) char* GetWidgetSignerCaption();
int SetWidgetSignerCaption(const char* lpszWidgetSignerCaption); Unicode (Windows) LPWSTR GetWidgetSignerCaption();
INT SetWidgetSignerCaption(LPCWSTR lpszWidgetSignerCaption);
char* secureblackbox_pdfsigner_getwidgetsignercaption(void* lpObj);
int secureblackbox_pdfsigner_setwidgetsignercaption(void* lpObj, const char* lpszWidgetSignerCaption);
QString GetWidgetSignerCaption();
int SetWidgetSignerCaption(QString qsWidgetSignerCaption);
Default Value
"#auto"
Remarks
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: ".
This property is not available at design time.
Data Type
String
WidgetSignerInfo Property (PDFSigner Class)
Provides custom signer information to put on the signature widget.
Syntax
ANSI (Cross Platform) char* GetWidgetSignerInfo();
int SetWidgetSignerInfo(const char* lpszWidgetSignerInfo); Unicode (Windows) LPWSTR GetWidgetSignerInfo();
INT SetWidgetSignerInfo(LPCWSTR lpszWidgetSignerInfo);
char* secureblackbox_pdfsigner_getwidgetsignerinfo(void* lpObj);
int secureblackbox_pdfsigner_setwidgetsignerinfo(void* lpObj, const char* lpszWidgetSignerInfo);
QString GetWidgetSignerInfo();
int SetWidgetSignerInfo(QString qsWidgetSignerInfo);
Default Value
"#auto"
Remarks
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.
This property is not available at design time.
Data Type
String
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;....
Supported ActionIDs:
"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.)
Revalidate Method (PDFSigner Class)
Revalidates a signature in accordance with current settings.
Syntax
ANSI (Cross Platform) int Revalidate(int iIndex); Unicode (Windows) INT Revalidate(INT iIndex);
int secureblackbox_pdfsigner_revalidate(void* lpObj, int iIndex);
int Revalidate(int iIndex);
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.)
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 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(int iSigIndex); Unicode (Windows) INT Update(INT iSigIndex);
int secureblackbox_pdfsigner_update(void* lpObj, int iSigIndex);
int Update(int iSigIndex);
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 SigIndex to the index 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.
veaAuto | 0 | Handle the action automatically (the default behaviour) |
veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
veaAcceptNow | 3 | Accept the validated certificate immediately |
veaAbortNow | 4 | Abort the validation, reject the certificate |
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.
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 *SubjectRDN;
int ValidationResult;
int ValidationDetails; int reserved; } PDFSignerChainValidatedEventParams;
Unicode (Windows) virtual INT FireChainValidated(PDFSignerChainValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR SubjectRDN;
INT ValidationResult;
INT ValidationDetails; INT reserved; } PDFSignerChainValidatedEventParams;
#define EID_PDFSIGNER_CHAINVALIDATED 3 virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails);
class PDFSignerChainValidatedEventParams { public: int Index(); const QString &SubjectRDN(); int ValidationResult(); int ValidationDetails(); 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.
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The 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.
veaAuto | 0 | Handle the action automatically (the default behaviour) |
veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
veaAcceptNow | 3 | Accept the validated certificate immediately |
veaAbortNow | 4 | Abort 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:
DocumentLoaded | Reports 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. |
BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
TimestampRequest | A 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. |
SignatureWidgetPrepare | Another 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. |
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 *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 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 &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class PDFSignerSignatureFoundEventParams { public: int Index(); 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 and 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 *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult; int reserved; } PDFSignerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(PDFSignerSignatureValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult; INT reserved; } PDFSignerSignatureValidatedEventParams;
#define EID_PDFSIGNER_SIGNATUREVALIDATED 13 virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);
class PDFSignerSignatureValidatedEventParams { public: int Index(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); int ValidationResult(); 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.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
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 *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 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 &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class PDFSignerTimestampFoundEventParams { public: int Index(); 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 and 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 *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *Time;
int ValidationResult;
int ChainValidationResult;
int ChainValidationDetails; int reserved; } PDFSignerTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(PDFSignerTimestampValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR Time;
INT ValidationResult;
INT ChainValidationResult;
INT ChainValidationDetails; INT reserved; } PDFSignerTimestampValidatedEventParams;
#define EID_PDFSIGNER_TIMESTAMPVALIDATED 16 virtual INT SECUREBLACKBOX_CALL FireTimestampValidated(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszTime, INT &iValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails);
class PDFSignerTimestampValidatedEventParams { public: int Index(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); const QString &Time(); int ValidationResult(); int ChainValidationResult(); int ChainValidationDetails(); 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.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
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.
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.
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
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.sRGB | GTS_PDFA1 corresponding to the PDF/A standard as defined by ISO 19005. sRGB IEC61966-2.1 is a standard color space. | |
GTS_PDFX.sRGB | GTS_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.
Contains a comma-separated list of values that specify the assembly options of the PDF document.
Supported values are:
AcrobatFriendlyAcroForm | Acrobat reader friendly form | |
AdjustTimesToUTC | Asserts that all the time properties are set in local time and should be adjusted to UTC when writing to the document |
Specifies whether revocation info should be collected automatically.
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.
Set this property to True to automatically detect and reverse RTL text to ensure proper visual presentation in the signature widget.
Set this property to True to auto-rotate the signature widget based on the page rotation.
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 property.
Specifies the background image color space.
Supported values are:
Specifies whether background image interpolation shall be performed by a conforming reader.
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.
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.
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
}
}
Specifies whether revocation info for timestamps should be collected automatically.
Use this property to set or get the number of custom text blocks on the signature widget.
This indexed setting specifies the font resource name to use for the custom text block.
This indexed setting provides access to the horizontal compound of the custom text font size.
This indexed setting provides access to the vertical compound of the custom text font size.
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.
This indexed setting provides access to the horizontal offset of the custom text block on the widget.
This indexed setting provides access to the vertical offset of the custom text block on the widget.
Use this property to specify the font size to be used for the date/time text on the signature widget.
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.
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).
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.
This property contains True if the viewing application should check the signing certificate revocation info and include the revocation information within the signature value.
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.
Returns the number of empty signature form fields available.
This property contains the empty signature form field flags ("Ff" entry in the signature field dictionary).
This property contains the height of the empty signature form field.
This property contains True if the empty signature form field is visible.
This property contains the legal attestations that are associated with the signature.
This property contains the name to be used when exporting form field data from the document.
This property contains the empty signature field name.
This property contains the horizontal offset of the empty signature form field.
This property contains the vertical offset of the empty signature form field.
This property contains the index of the empty signature form field's page in the document.
This property contains the changes that are allowed to the document when the signature field is signed.
This property contains the required SVD constraints. If a certain bit in RequiredConstraints is switched on, the corresponding data item is constrained.
This property contains the list of the digest algorithms used for signature generation.
This property contains the required filter (name of the preferred signature handler) to use for signature generation.
This property contains a set of form fields that shall be locked when the current signature field is signed.
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.
This property contains the required reasons used for signature generation.
This property contains the list of subfilters required by the signature. A subfilter represents the encoding to use when signing the PDF form.
This property contains True if the signature should be timestamped.
This property contains the TSP server URL.
This property contains the width of the empty signature form field.
Specifies the custom security handler PDF-name for the encryption handler.
Specifies the extension modifier mode that controls which Extension Level should be added to the PDF document while signing.
Supported values are:
none | No extensions | |
ESIC | ESIC Extension Level 2 | |
ADBE | Adobe Extension Level 8 | |
ADBEIfNotPresent | Adobe Extension Level 8 if not present | |
Both | Both (ESIC and Adobe) extensions |
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.
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.
Specifies whether to check issuer (CA) certificates when the signing certificate is invalid.
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.
Use this property to specify a grace period (in seconds). The 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.
Specifies if hardened Key generation should be used when the AES-256 encryption algorithm and password encryption are used.
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.
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.
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.
Specifies whether to ignore timestamping failures during signing.
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.
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.
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.
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.
Contains a comma-separated list of values that specify the PAdES options.
Supported values are:
UseSigningCertificateV2 | When this flag is set, the signing certificate V2 attribute will be used. | |
IncludeAllRevInfoToDSS | When this flag is set, the full set of revocation information will be included in the DSS dictionary. | |
CreateVRIDictionaries | When 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. | |
UseUndefBEREncoding | When this flag is set, ASN.1 tags with undefined sizes are allowed in the signature. | |
TolerateMissingSigningCertificate | When this flag is set, a missing signing certificate attribute will be tolerated. | |
CompressDSS | When this flag is set, content in DSS dictionary will be compressed. | |
CreatePBADCompatibleSignature | When this flag is set, the PBAD.PAdES compatible signature is created. | |
EnforcePDFACompliance | When 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. |
Returns the number of pages available.
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.
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.
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.
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.
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.
This property contains the page height value.
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.
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.
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.
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.
This property contains the page rotation angle.
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).
This property contains the page width value.
Use this property to specify the explicit text of the user notice to be displayed when the PAdES-EPES signature is verified.
Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for PAdES-EPES.
Defines the "organization" part of the NoticeReference signature policy qualifier for PAdES-EPES.
Specifies the web URI pointing to the signature policy.
User-defined size of the signature.
Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.
Specifies the number of key bits used for the RC4 encryption algorithm.
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. |
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.
Use this property to specify the font size to be used for general text on the signature widget.
Use this property to specify the font size to be used for the section title text on the signature widget.
Returns the number of signatures available.
This property contains the height of the signature widget.
This property contains True if the signature widget is visible.
This property contains the signature name.
This property contains the horizontal offset of the signature widget.
This property contains the vertical offset of the signature widget.
Contains a comma-separated list of values that specify signature options.
Supported values are:
SuppressEmptyAuthorName | When this flag is not set, the author name in the signature is set to "Not specified". | |
AddAnnotationForInvisibleSignature | When this flag is set, the annotation object is added for invisible signatures. |
This property contains the index of the signature widget's page in the document.
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.
This property contains the width of the signature widget.
This setting specifies an absolute path to the location on disk where temporary files are stored.
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.
Use this property to specify the font size to be used for the main title on the signature widget.
Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.
Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.
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.
Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server.
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
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).
In its default configuration, PDFSigner uses the same hash algorithm for the main signature and any associated timestamps. Use this property to specify a different hash algorithm for the timestamp.
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).
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.
Set this property to False to use the new signature visual style.
Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.
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.
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.
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.
Use this property to set the height of the signature widget in points. Integer and float values are supported.
This property extends the NewSigHeight property to allow the height of the signature widget to be specified in fractional points.
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 NewSigOffsetX property to allow the offset of the signature widget to be specified in fractional points.
Use this property to set the signature widget offset from the bottom page border. Integer and float values are supported.
This property extends the NewSigOffsetY property to allow the offset of the signature widget to be specified in fractional points.
Use this property to set the width of the signature widget in points. Integer and float values are supported.
This property extends the NewSigWidth property to allow the width of the signature widget to be specified in fractional points.
Base Config Settings
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.
Set this property to enable or disable cookies caching for the class.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.
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.
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.
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".
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.
Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Use this property to provide a path to the log file.
Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
Use this property to set the log flush mode. The following values are defined:
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Use this property to provide the desired debug log level.
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
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.
Use this property to set the log rotation mode. The following values are defined:
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
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.
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.
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.
Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
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.
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.
Use this config property to store any custom data.
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.
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).
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).
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.
Set this global property to false to make each validation run use its own copy of system certificate stores.
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.
Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
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 value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
26214401 Input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS) | |
26214402 Document is encrypted (SB_ERROR_PDF_ENCRYPTED) | |
26214403 Document not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED) | |
26214404 Unknown certificate type (SB_ERROR_PDF_UNKNOWN_ENCRYPTION_TYPE) | |
26214405 Invalid password (SB_ERROR_PDF_INVALID_PASSWORD) | |
26214406 Decryption failed (SB_ERROR_PDF_DECRYPTION_FAILED) | |
26214407 Document is signed (SB_ERROR_PDF_SIGNED) | |
26214408 Document is not signed (SB_ERROR_PDF_NOT_SIGNED) | |
26214409 Inappropriate signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE) | |
26214410 Not supported (SB_ERROR_PDF_NOT_SUPPORTED) |