XAdESSigner Class
Properties Methods Events Config Settings Errors
The XAdESSigner class creates XAdES-compliant signature files.
Syntax
XAdESSigner
Remarks
XAdESSigner can sign XML documents in accordance with XAdES standard. Originally developed and adopted in the European Union, XAdES has quickly become a recognized international standard for signing XML documents. XAdES provides a convenient framework for creating short-lived and long-term signatures over any kind of XML documents, and is now used by governments, healthcare providers, banks, and independent service providers all across the globe.
Standards and technologies supported
XAdESSigner offers the following signing capabilities:
- Create and upgrade XAdES signatures in accordance with the most recent XAdES specification (ETSI EN 319 132). Earlier versions are also supported.
- All profiles are supported (BES, EPES, T, C, X, XL, A, including the Extended variants).
- Timestamping using external TSAs.
- All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).
Configuring the signature parameters
Configuring XAdESSigner to make it produce a signature of the right type is the main task you would need to perform in your code. Normally the service or software you will be communicating your XML 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:
- The signature Form, sometimes referred to as Level (such BES, T, XL, A, or Extended-XLong). This can be adjusted with the XAdESForm property.
- Whether the signature should be detached, enveloped, or enveloping: adjust via SignatureType property.
- When creating a timestamped signature (such as T or A), provide the address of your online TSA service via TimestampServer property.
- When creating long-term signatures that include the signing chain and validation material, tune up validation parameters via RevocationCheck, OfflineMode, and IgnoreChainValidationErrors properties.
In some circumstances you will also need to adjust the following lower-level settings:
- Choose a specific XAdES version between 1.4.1, 1.3.2, 1.2.2, and 1.1.1, and assign it to XAdESVersion property.
- Specify the needed canonicalization method using the CanonicalizationMethod property.
- Provide the hash algorithm via the HashAlgorithm property.
Signing certificates
XAdESSigner 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 CertificateManager and CertificateStorage components to access the signing certificate. Assign the certificate to SigningCertificate property, and optionally provide the remainder of its chain via 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 component 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 timestamping and upgrading signatures, since this type of operation does not involve the signing private key.
Signing the document
Now that you have set up all signature properties and attached the signing certificate, it is time to proceed to signing. You can provide the input document in one of the following forms: as a file (assign the path to InputFile property), as a stream (assign to 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 completes.
Having set up the input and output (unless using OutputBytes, which should be read later), call the component'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 XAdES-BES variant), or it may involve advanced chain validation routines (XAdES-XL or -A). During the latter the component 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 component will contact it too to timestamp the new signature.
During the signing XAdESSigner may fire events to let your code know of certain conditions. It may fire TLSCertValidate if one of the HTTP endpoints involved in the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate to be validated. It may also fire FormatElement and FormatText to let your code apply custom formatting to XML document elements. If XAdESSigner fails to resolve one of the references in the signature, it will fire ResolveReference to let your code help with resolving it.
When the signing operation completes, the output file, stream, or byte array will contain the signature of the requested kind. Note that while nveloped and enveloping signatures contain the signed content within them, detached signatures assume that you supply the original content separately.
Apart from signing, XAdESSigner can perform operations on signatures of other kinds. Use Upgrade method to upgrade an existing XAdES signature to a higher level (e.g. BES to XL). Use Timestamp to add a generic or validation timestamp to an existing signature.
External signing and DCAuth
XAdESSigner, like many other components 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 component 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 ExternalSign event. Your event handler needs to sign the hash with the private key and return the created signature back to the component - 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-own 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 XAdESSigner - initiates the operation using 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 XAdESSigner 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, 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 controls, 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.
AutoValidateSignatures | Specifies whether class 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. |
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. |
DataBytes | Use this property to pass the external data to class in the byte array form. |
DataFile | A file containing the external data covered by a detached signature. |
DataType | Specifies the external data type. |
DataURI | Specifies a detached data resource URI. |
Encoding | Specifies XML encoding. |
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 XML document to sign. |
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. |
NewSigCanonicalizationMethod | The XML canonicalization method that was used for signing. |
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. |
NewSigChainValidationDetails | The details of a certificate chain validation outcome. |
NewSigChainValidationResult | The outcome of a certificate chain validation routine. |
NewSigClaimedSigningTime | The signing time from the signer's computer. |
NewSigHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
NewSigHashAlgorithm | The hash algorithm used for signing. |
NewSigIssuerRDN | The Relative Distinguished Name of the signing certificate's issuer. |
NewSigLastArchivalTime | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. |
NewSigPolicyHash | The signature policy hash value. |
NewSigPolicyHashAlgorithm | The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. |
NewSigPolicyID | The policy ID that was included or to be included into the signature. |
NewSigPolicyURI | The signature policy URI that was included in the signature. |
NewSigSerialNumber | The serial number of the timestamp. |
NewSigSignatureBytes | Returns the binary representation of the XML-DSig/XAdES signature. |
NewSigSignatureType | The signature type to employ when signing the document. |
NewSigSignatureValidationResult | Contains the signature validation result. |
NewSigSubjectKeyID | Contains the subject key identifier of the signing certificate. |
NewSigSubjectRDN | Contains information about the person owning 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 complete log of the certificate validation routine. |
NewSigXAdES | Specifies whether the document contains an advanced signature (XAdES). |
NewSigXAdESForm | Specifies which form of XAdES should be produced. |
NewSigXAdESVersion | Specifies XAdES version. |
NewSigXMLElement | Specifies the XML element where to save the signature or containing the signature. |
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 | Specifies the file where the signed document will be saved. |
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. |
ReferenceCount | The number of records in the Reference arrays. |
ReferenceAutoGenerateElementId | Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. |
ReferenceCanonicalizationMethod | Use this property to specify the canonicalization method for the transform of the reference. |
ReferenceCustomElementId | Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. |
ReferenceDigestValue | Use this property to get or set the value of the digest calculated over the referenced data. |
ReferenceHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ReferenceHashAlgorithm | Specifies the hash algorithm to be used. |
ReferenceHasURI | Specifies whether the URI is set (even when it is empty). |
ReferenceID | A user-defined identifier (ID) attribute of this Reference element. |
ReferenceInclusiveNamespacesPrefixList | Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. |
ReferenceReferenceType | The Reference's type attribute as defined in XMLDSIG specification. |
ReferenceSignatureIndex | Returns the index of the owner signature, if applicable. |
ReferenceTargetData | Contains the referenced external data when the digest value is not explicitly specified. |
ReferenceTargetType | The reference's target type to use. |
ReferenceTargetXMLElement | This property specifies the referenced XML element. |
ReferenceURI | Use this property to get or set the URL which references the data. |
ReferenceUseBase64Transform | Specifies whether Base64 transform is included in transform chain. |
ReferenceUseEnvelopedSignatureTransform | Specifies whether enveloped signature transform is included in transform chain. |
ReferenceUseXPathFilter2Transform | Specifies whether XPath Filter 2. |
ReferenceUseXPathTransform | Specifies whether XPath transform is included in transform chain. |
ReferenceXPathExpression | Use this property to specify XPath expression for XPath transform of the reference. |
ReferenceXPathFilter2Expressions | Use this property to specify XPointer expression(s) for XPath Filter 2. |
ReferenceXPathFilter2Filters | Use this property to specify XPointer filter(s) for XPath Filter 2. |
ReferenceXPathFilter2PrefixList | Use this property to specify a prefix list for XPath Filter 2. |
ReferenceXPathPrefixList | Use this property to specify a prefix list for XPath transform of the reference. |
RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
SignatureCount | The number of records in the Signature arrays. |
SignatureCanonicalizationMethod | The XML canonicalization method that was used for signing. |
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. |
SignatureChainValidationDetails | The details of a certificate chain validation outcome. |
SignatureChainValidationResult | The outcome of a certificate chain validation routine. |
SignatureClaimedSigningTime | The signing time from the signer's computer. |
SignatureHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SignatureHashAlgorithm | The hash algorithm used for signing. |
SignatureIssuerRDN | The Relative Distinguished Name of the signing certificate's issuer. |
SignatureLastArchivalTime | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. |
SignaturePolicyHash | The signature policy hash value. |
SignaturePolicyHashAlgorithm | The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. |
SignaturePolicyID | The policy ID that was included or to be included into the signature. |
SignaturePolicyURI | The signature policy URI that was included in the signature. |
SignatureSerialNumber | The serial number of the timestamp. |
SignatureSignatureBytes | Returns the binary representation of the XML-DSig/XAdES signature. |
SignatureSignatureType | The signature type to employ when signing the document. |
SignatureSignatureValidationResult | Contains the signature validation result. |
SignatureSubjectKeyID | Contains the subject key identifier of the signing certificate. |
SignatureSubjectRDN | Contains information about the person owning 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 complete log of the certificate validation routine. |
SignatureXAdES | Specifies whether the document contains an advanced signature (XAdES). |
SignatureXAdESForm | Specifies which form of XAdES should be produced. |
SignatureXAdESVersion | Specifies XAdES version. |
SignatureXMLElement | Specifies the XML element where to save the signature or containing the signature. |
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. |
NamespaceCount | The number of records in the Namespace arrays. |
NamespacePrefix | A user-defined prefix value of a namespace. |
NamespaceURI | A user-defined URI value of a namespace. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddDataReference | Creates a new XML reference to the specified data. |
AddReference | Creates a new XML reference to the specified XML element. |
AddTimestampValidationData | Use this method to add timestamp validation data to the signature. |
AddValidationDataRefs | Use this method to add signature validation references to the signature. |
AddValidationDataValues | Use this method to add signature validation values to the signature. |
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. |
GetInnerXML | Get the inner XML content of the selected XML element. |
GetOuterXML | Get the outer XML content of the selected XML element. |
GetTextContent | Get the text content of the selected XML element. |
Open | Opens a document for signing or updating. |
Revalidate | Revalidates a signature in accordance with current settings. |
SetInnerXML | Set the inner XML content of the selected XML element. |
SetTextContent | Set the text content of the selected XML element. |
Sign | Signs an XML document. |
SignAsyncBegin | Initiates the asynchronous signing operation. |
SignAsyncEnd | Completes the asynchronous signing operation. |
SignExternal | Signs the document using an external signing facility. |
Timestamp | Use this method to add an timestamp. |
Upgrade | Upgrades existing XAdES signature to a new form. |
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. |
ChainElementStore | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. |
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. |
Error | Information about errors during signing. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
FormatElement | Reports the XML element that is currently being processed. |
FormatText | Reports XML text that is currently being processed. |
Notification | This event notifies the application about an underlying control flow event. |
ReferenceValidated | Marks the end of a reference validation. |
ResolveReference | Asks the application to resolve a reference. |
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.
AddAllDataObjectsTimestamp | Whether to add all data objects timestamp during signing. |
ClaimedRoleText | The text of the claimed role. |
ClaimedRoleXML | The XML content of the claimed roles. |
CommitmentTypeIndicationAllSignedDataObjects[Index] | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
CommitmentTypeIndicationCount | The number of the CommitmentTypeIndication elements. |
CommitmentTypeIndicationIdentifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
CommitmentTypeIndicationIdentifierDescription[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
CommitmentTypeIndicationIdentifierDocumentationReferences[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
CommitmentTypeIndicationIdentifierQualifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
CommitmentTypeIndicationObjectReference[Index] | Specifies the CommitmentTypeIndication's ObjectReference. |
CommitmentTypeIndicationQualifiersXML[Index] | The XML content of the CommitmentTypeIndication's Qualifiers. |
DataObjectFormatCount | The number of the DataObjectFormat elements. |
DataObjectFormatDescription[Index] | Specifies the DataObjectFormat's Description. |
DataObjectFormatEncoding[Index] | Specifies the DataObjectFormat's Encoding. |
DataObjectFormatMimeType[Index] | Specifies the DataObjectFormat's MimeType. |
DataObjectFormatObjectIdentifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Identifier. |
DataObjectFormatObjectIdentifierDescription[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Description. |
DataObjectFormatObjectIdentifierDocumentationReferences[Index] | Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences. |
DataObjectFormatObjectIdentifierQualifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier. |
DataObjectFormatObjectReference[Index] | Specifies the DataObjectFormat's ObjectReference. |
DetachedResourceURI | Specifies a detached resource URI. |
DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
EnvelopingObjectEncoding | Specifies the enveloping object encoding. |
EnvelopingObjectID | Specifies the enveloping object identifier. |
EnvelopingObjectMimeType | Specifies the enveloping object MIME type. |
ExclusiveCanonicalizationPrefix | Specifies the exclusive canonicalization prefix. |
ForceCompleteChainValidation | Whether to check the 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. |
HMACKey | The key value for HMAC. |
HMACOutputLength | Sets the length of the HMAC output. |
IDAttributeName | Specifies the custom name of ID attribute. |
IDAttributeNamespaceURI | Specifies the custom namespace URI of ID attribute. |
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 time-stamping failure during signing. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
IncludeKey | Specifies whether to include the signing key to the signature. |
IncludeKeyValue | Specifies whether the key value must be included to the signature. |
IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
InclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList. |
InputType | Specifies the Input type. |
InsertBeforeXMLElement | Defines the reference XML element for signature insertion. |
KeyInfoCustomXML | The custom XML content for KeyInfo element. |
KeyInfoDetails | Specifies the signing key info details to include to the signature. |
KeyInfoID | Specifies the ID for KeyInfo element. |
KeyName | Contains information about the key used for signing. |
ManifestCount | The number of the manifest elements. |
ManifestID[Index] | The ID of the manifest element. |
ManifestObjectIndex[Index] | The object element index to which the manifest element belongs. |
ManifestXML[Index] | The XML content of the manifest element. |
ObjectCount | The number of the object elements. |
ObjectEncoding[Index] | The Encoding of the object element. |
ObjectID[Index] | The ID of the object element. |
ObjectMimeType[Index] | The MIME type of the object element. |
ObjectSignaturePropertiesCount | The number of the signature properties elements. |
ObjectSignaturePropertiesID[Index] | The ID of the signature properties element. |
ObjectSignaturePropertiesObjectIndex[Index] | The object element index to which the signature properties element belongs. |
ObjectSignaturePropertiesXML[Index] | The XML content of the signature properties element. |
ObjectSignaturePropertyCount | The number of the signature property elements. |
ObjectSignaturePropertyID[Index] | The ID of the signature properties element. |
ObjectSignaturePropertyPropertiesIndex[Index] | The signature properties element index to which the signature property element belongs. |
ObjectSignaturePropertyTarget[Index] | The Target of the signature properties element. |
ObjectSignaturePropertyXML[Index] | The XML content of the signature property element. |
ObjectXML[Index] | The XML content of the object element. |
ProductionPlace | Identifies the place of the signature production. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
QualifyingPropertiesID | Specifies the ID for QualifyingProperties element. |
QualifyingPropertiesObjectID | Specifies the ID for object with QualifyingProperties element. |
QualifyingPropertiesReferenceCount | The number of the QualifyingPropertiesReference elements. |
QualifyingPropertiesReferenceID[Index] | Specifies the QualifyingPropertiesReference's ID. |
QualifyingPropertiesReferenceURI[Index] | Specifies the QualifyingPropertiesReference's URI. |
RefsTimestampType | Specifies references timestamp type to include to the signature. |
SignatureCompliance | Specifies the signature compliance mode. |
SignatureID | Specifies the ID for Signature element. |
SignaturePrefix | Specifies the signature prefix. |
SignatureValue | Contains the SignatureValue. |
SignatureValueID | Specifies the ID for SignatureValue element. |
SignedInfoID | Specifies the ID for SignedInfo element. |
SignedPropertiesID | Specifies the ID for SignedProperties element. |
SignedPropertiesReferenceCanonicalizationMethod | Specifies the canonicalization method used in SignedProperties reference. |
SignedPropertiesReferenceHashAlgorithm | Specifies the hash algorithm used in SignedProperties reference. |
SignedPropertiesReferenceID | Specifies the ID for Reference element that points to SignedProperties element. |
SignedPropertiesReferenceInclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference. |
SignedPropertiesReferenceIndex | Specifies the index of SignedProperties reference. |
SignedSignaturePropertiesID | Specifies the ID for SignedSignatureProperties element. |
SigningCertificatesHashAlgorithm | Specifies the hash algorithm used for SigningCertificates. |
SigPolicyDescription | signature policy description. |
SigPolicyExplicitText | The explicit text of the user notice. |
SigPolicyHash | The hash value of the signature policy. |
SigPolicyHashAlgorithm | Specifies the hash algorithm used to compute the signature policy hash. |
SigPolicyID | Identifies the signature policy. |
SigPolicyNoticeNumbers | Contains user notice numbers. |
SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
SigPolicyURI | Signature policy URI. |
TempPath | Location where the temporary files are stored. |
TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
TimestampValidationDataDetails | Specifies timestamp validation data details to include to the signature. |
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. |
UseHMACSigning | Whether to use HMAC signing. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UsePSS | Whether to use 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. |
ValidationDataRefsDetails | Specifies validation data references details to include to the signature. |
ValidationDataRefsHashAlgorithm | Specifies the hash algorithm used in validation data references. |
ValidationDataValuesDetails | Specifies validation data values details to include to the signature. |
WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
XAdESPrefix | Specifies the XAdES prefix. |
XAdESv141Prefix | Specifies the XAdES v1.4.1 prefix. |
XMLFormatting | Specifies the signature XML formatting. |
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. |
AutoValidateSignatures Property (XAdESSigner Class)
Specifies whether class 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_xadessigner_getautovalidatesignatures(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getblockedcertcount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_xadessigner_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
CRLCount Property (XAdESSigner Class)
The number of records in the CRL arrays.
Syntax
ANSI (Cross Platform) int GetCRLCount(); Unicode (Windows) INT GetCRLCount();
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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
DataBytes Property (XAdESSigner Class)
Use this property to pass the external data to class in the byte array form.
Syntax
ANSI (Cross Platform) int GetDataBytes(char* &lpDataBytes, int &lenDataBytes);
int SetDataBytes(const char* lpDataBytes, int lenDataBytes); Unicode (Windows) INT GetDataBytes(LPSTR &lpDataBytes, INT &lenDataBytes);
INT SetDataBytes(LPCSTR lpDataBytes, INT lenDataBytes);
int secureblackbox_xadessigner_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_xadessigner_setdatabytes(void* lpObj, const char* lpDataBytes, int lenDataBytes);
QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);
Remarks
Assign a byte array containing the external data to be processed to this property.
This property is not available at design time.
Data Type
Byte Array
DataFile Property (XAdESSigner Class)
A file containing the external data covered by a detached signature.
Syntax
ANSI (Cross Platform) char* GetDataFile();
int SetDataFile(const char* lpszDataFile); Unicode (Windows) LPWSTR GetDataFile();
INT SetDataFile(LPCWSTR lpszDataFile);
char* secureblackbox_xadessigner_getdatafile(void* lpObj);
int secureblackbox_xadessigner_setdatafile(void* lpObj, const char* lpszDataFile);
QString GetDataFile();
int SetDataFile(QString qsDataFile);
Default Value
""
Remarks
In the case of a detached signature, use this property to provide the external data to the class from a file. Alternatively, provide the data via DataStream.
Data Type
String
DataType Property (XAdESSigner Class)
Specifies the external data type.
Syntax
ANSI (Cross Platform) int GetDataType();
int SetDataType(int iDataType); Unicode (Windows) INT GetDataType();
INT SetDataType(INT iDataType);
Possible Values
CXDT_XML(0),
CXDT_BINARY(1),
CXDT_BASE_64(2)
int secureblackbox_xadessigner_getdatatype(void* lpObj);
int secureblackbox_xadessigner_setdatatype(void* lpObj, int iDataType);
int GetDataType();
int SetDataType(int iDataType);
Default Value
0
Remarks
Use this property to specify the type of the external data (either DataFile, DataStream or DataBytes properties) for class.
Data Type
Integer
DataURI Property (XAdESSigner Class)
Specifies a detached data resource URI.
Syntax
ANSI (Cross Platform) char* GetDataURI();
int SetDataURI(const char* lpszDataURI); Unicode (Windows) LPWSTR GetDataURI();
INT SetDataURI(LPCWSTR lpszDataURI);
char* secureblackbox_xadessigner_getdatauri(void* lpObj);
int secureblackbox_xadessigner_setdatauri(void* lpObj, const char* lpszDataURI);
QString GetDataURI();
int SetDataURI(QString qsDataURI);
Default Value
""
Remarks
Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.
Data Type
String
Encoding Property (XAdESSigner Class)
Specifies XML encoding.
Syntax
ANSI (Cross Platform) char* GetEncoding();
int SetEncoding(const char* lpszEncoding); Unicode (Windows) LPWSTR GetEncoding();
INT SetEncoding(LPCWSTR lpszEncoding);
char* secureblackbox_xadessigner_getencoding(void* lpObj);
int secureblackbox_xadessigner_setencoding(void* lpObj, const char* lpszEncoding);
QString GetEncoding();
int SetEncoding(QString qsEncoding);
Default Value
""
Remarks
Use this property to specify the encoding to apply to the XML documents.
Data Type
String
ExternalCryptoAsyncDocumentID Property (XAdESSigner 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_xadessigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptodata(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptomode(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_xadessigner_getfipsmode(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
The XML document to sign.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_xadessigner_getinputfile(void* lpObj);
int secureblackbox_xadessigner_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
Provide a path to the XML file to sign.
Data Type
String
KnownCertCount Property (XAdESSigner 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_xadessigner_getknowncertcount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getknowncrlcount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getknownocspcount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_xadessigner_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
NewSigCanonicalizationMethod Property (XAdESSigner Class)
The XML canonicalization method that was used for signing.
Syntax
ANSI (Cross Platform) int GetNewSigCanonicalizationMethod();
int SetNewSigCanonicalizationMethod(int iNewSigCanonicalizationMethod); Unicode (Windows) INT GetNewSigCanonicalizationMethod();
INT SetNewSigCanonicalizationMethod(INT iNewSigCanonicalizationMethod);
Possible Values
CXCM_NONE(0),
CXCM_CANON(1),
CXCM_CANON_COMMENT(2),
CXCM_EXCL_CANON(3),
CXCM_EXCL_CANON_COMMENT(4),
CXCM_MIN_CANON(5),
CXCM_CANON_V_1_1(6),
CXCM_CANON_COMMENT_V_1_1(7)
int secureblackbox_xadessigner_getnewsigcanonicalizationmethod(void* lpObj);
int secureblackbox_xadessigner_setnewsigcanonicalizationmethod(void* lpObj, int iNewSigCanonicalizationMethod);
int GetNewSigCanonicalizationMethod();
int SetNewSigCanonicalizationMethod(int iNewSigCanonicalizationMethod);
Default Value
0
Remarks
The XML canonicalization method that was used for signing.
Supported canonicalization methods:
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
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
NewSigCertificateIndex Property (XAdESSigner 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_xadessigner_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
NewSigChainValidationDetails Property (XAdESSigner Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetNewSigChainValidationDetails(); Unicode (Windows) INT GetNewSigChainValidationDetails();
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
The signing time from the signer's computer.
Syntax
ANSI (Cross Platform) char* GetNewSigClaimedSigningTime();
int SetNewSigClaimedSigningTime(const char* lpszNewSigClaimedSigningTime); Unicode (Windows) LPWSTR GetNewSigClaimedSigningTime();
INT SetNewSigClaimedSigningTime(LPCWSTR lpszNewSigClaimedSigningTime);
char* secureblackbox_xadessigner_getnewsigclaimedsigningtime(void* lpObj);
int secureblackbox_xadessigner_setnewsigclaimedsigningtime(void* lpObj, const char* lpszNewSigClaimedSigningTime);
QString GetNewSigClaimedSigningTime();
int SetNewSigClaimedSigningTime(QString qsNewSigClaimedSigningTime);
Default Value
""
Remarks
The signing time from the signer's computer.
Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.
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
NewSigHandle Property (XAdESSigner 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_xadessigner_getnewsighandle(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
The hash algorithm used for signing.
Syntax
ANSI (Cross Platform) char* GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(const char* lpszNewSigHashAlgorithm); Unicode (Windows) LPWSTR GetNewSigHashAlgorithm();
INT SetNewSigHashAlgorithm(LPCWSTR lpszNewSigHashAlgorithm);
char* secureblackbox_xadessigner_getnewsighashalgorithm(void* lpObj);
int secureblackbox_xadessigner_setnewsighashalgorithm(void* lpObj, const char* lpszNewSigHashAlgorithm);
QString GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(QString qsNewSigHashAlgorithm);
Default Value
"Unknown"
Remarks
The hash algorithm used for signing.
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
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
NewSigIssuerRDN Property (XAdESSigner Class)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
ANSI (Cross Platform) char* GetNewSigIssuerRDN(); Unicode (Windows) LPWSTR GetNewSigIssuerRDN();
char* secureblackbox_xadessigner_getnewsigissuerrdn(void* lpObj);
QString GetNewSigIssuerRDN();
Default Value
""
Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
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
NewSigLastArchivalTime Property (XAdESSigner Class)
Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.
Syntax
ANSI (Cross Platform) char* GetNewSigLastArchivalTime(); Unicode (Windows) LPWSTR GetNewSigLastArchivalTime();
char* secureblackbox_xadessigner_getnewsiglastarchivaltime(void* lpObj);
QString GetNewSigLastArchivalTime();
Default Value
""
Remarks
Indicates the most recent archival time of an archived signature
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is 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
NewSigPolicyHash Property (XAdESSigner Class)
The signature policy hash value.
Syntax
ANSI (Cross Platform) char* GetNewSigPolicyHash();
int SetNewSigPolicyHash(const char* lpszNewSigPolicyHash); Unicode (Windows) LPWSTR GetNewSigPolicyHash();
INT SetNewSigPolicyHash(LPCWSTR lpszNewSigPolicyHash);
char* secureblackbox_xadessigner_getnewsigpolicyhash(void* lpObj);
int secureblackbox_xadessigner_setnewsigpolicyhash(void* lpObj, const char* lpszNewSigPolicyHash);
QString GetNewSigPolicyHash();
int SetNewSigPolicyHash(QString qsNewSigPolicyHash);
Default Value
""
Remarks
The signature policy hash value.
Use this property to get the signature policy hash from 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 (XAdESSigner Class)
The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm 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_xadessigner_getnewsigpolicyhashalgorithm(void* lpObj);
int secureblackbox_xadessigner_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
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from NewSigPolicyHash.
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
NewSigPolicyID Property (XAdESSigner Class)
The policy ID that was included or 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_xadessigner_getnewsigpolicyid(void* lpObj);
int secureblackbox_xadessigner_setnewsigpolicyid(void* lpObj, const char* lpszNewSigPolicyID);
QString GetNewSigPolicyID();
int SetNewSigPolicyID(QString qsNewSigPolicyID);
Default Value
""
Remarks
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier from 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
NewSigPolicyURI Property (XAdESSigner Class)
The signature policy URI that was included in the signature.
Syntax
ANSI (Cross Platform) char* GetNewSigPolicyURI();
int SetNewSigPolicyURI(const char* lpszNewSigPolicyURI); Unicode (Windows) LPWSTR GetNewSigPolicyURI();
INT SetNewSigPolicyURI(LPCWSTR lpszNewSigPolicyURI);
char* secureblackbox_xadessigner_getnewsigpolicyuri(void* lpObj);
int secureblackbox_xadessigner_setnewsigpolicyuri(void* lpObj, const char* lpszNewSigPolicyURI);
QString GetNewSigPolicyURI();
int SetNewSigPolicyURI(QString qsNewSigPolicyURI);
Default Value
""
Remarks
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
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
NewSigSerialNumber Property (XAdESSigner Class)
The serial number of the timestamp.
Syntax
ANSI (Cross Platform) int GetNewSigSerialNumber(char* &lpNewSigSerialNumber, int &lenNewSigSerialNumber); Unicode (Windows) INT GetNewSigSerialNumber(LPSTR &lpNewSigSerialNumber, INT &lenNewSigSerialNumber);
int secureblackbox_xadessigner_getnewsigserialnumber(void* lpObj, char** lpNewSigSerialNumber, int* lenNewSigSerialNumber);
QByteArray GetNewSigSerialNumber();
Remarks
The serial number of the 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
Byte Array
NewSigSignatureBytes Property (XAdESSigner Class)
Returns the binary representation of the XML-DSig/XAdES signature.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureBytes(char* &lpNewSigSignatureBytes, int &lenNewSigSignatureBytes); Unicode (Windows) INT GetNewSigSignatureBytes(LPSTR &lpNewSigSignatureBytes, INT &lenNewSigSignatureBytes);
int secureblackbox_xadessigner_getnewsigsignaturebytes(void* lpObj, char** lpNewSigSignatureBytes, int* lenNewSigSignatureBytes);
QByteArray GetNewSigSignatureBytes();
Remarks
Returns the binary representation of the XML-DSig/XAdES 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
Byte Array
NewSigSignatureType Property (XAdESSigner Class)
The signature type to employ when signing the document.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureType();
int SetNewSigSignatureType(int iNewSigSignatureType); Unicode (Windows) INT GetNewSigSignatureType();
INT SetNewSigSignatureType(INT iNewSigSignatureType);
Possible Values
CXST_DETACHED(1),
CXST_ENVELOPING(2),
CXST_ENVELOPED(4)
int secureblackbox_xadessigner_getnewsigsignaturetype(void* lpObj);
int secureblackbox_xadessigner_setnewsigsignaturetype(void* lpObj, int iNewSigSignatureType);
int GetNewSigSignatureType();
int SetNewSigSignatureType(int iNewSigSignatureType);
Default Value
4
Remarks
The signature type to employ when signing the document.
This property specifies the signature type to be used when signing the document.
Supported values:
cxstDetached | 1 | Specifies whether a detached signature should be produced. I.e., a signature which is kept separately from the signed document. |
cxstEnveloping | 2 | Specifies whether an enveloping signature should be produced. |
cxstEnveloped | 4 | Specifies whether an enveloped signature should be produced. |
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
NewSigSignatureValidationResult Property (XAdESSigner Class)
Contains the signature validation result.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureValidationResult(); Unicode (Windows) INT GetNewSigSignatureValidationResult();
Possible Values
XSV_VALID(0),
XSV_UNKNOWN(1),
XSV_CORRUPTED(2),
XSV_SIGNER_NOT_FOUND(3),
XSV_FAILURE(4),
XSV_REFERENCE_CORRUPTED(5)
int secureblackbox_xadessigner_getnewsigsignaturevalidationresult(void* lpObj);
int GetNewSigSignatureValidationResult();
Default Value
0
Remarks
Contains the signature validation result.
Use this property to check the result of the most recent XML signature validation.
xsvValid | 0 | |
xsvUnknown | 1 | |
xsvCorrupted | 2 | |
xsvSignerNotFound | 3 | |
xsvFailure | 4 | |
xsvReferenceCorrupted | 5 |
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
NewSigSubjectKeyID Property (XAdESSigner Class)
Contains the subject key identifier of the signing certificate.
Syntax
ANSI (Cross Platform) int GetNewSigSubjectKeyID(char* &lpNewSigSubjectKeyID, int &lenNewSigSubjectKeyID); Unicode (Windows) INT GetNewSigSubjectKeyID(LPSTR &lpNewSigSubjectKeyID, INT &lenNewSigSubjectKeyID);
int secureblackbox_xadessigner_getnewsigsubjectkeyid(void* lpObj, char** lpNewSigSubjectKeyID, int* lenNewSigSubjectKeyID);
QByteArray GetNewSigSubjectKeyID();
Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
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
NewSigSubjectRDN Property (XAdESSigner Class)
Contains information about the person owning the signing certificate.
Syntax
ANSI (Cross Platform) char* GetNewSigSubjectRDN(); Unicode (Windows) LPWSTR GetNewSigSubjectRDN();
char* secureblackbox_xadessigner_getnewsigsubjectrdn(void* lpObj);
QString GetNewSigSubjectRDN();
Default Value
""
Remarks
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
Contains the certified signing time.
Syntax
ANSI (Cross Platform) char* GetNewSigValidatedSigningTime(); Unicode (Windows) LPWSTR GetNewSigValidatedSigningTime();
char* secureblackbox_xadessigner_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 (XAdESSigner Class)
Contains the complete log of the certificate validation routine.
Syntax
ANSI (Cross Platform) char* GetNewSigValidationLog(); Unicode (Windows) LPWSTR GetNewSigValidationLog();
char* secureblackbox_xadessigner_getnewsigvalidationlog(void* lpObj);
QString GetNewSigValidationLog();
Default Value
""
Remarks
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
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
NewSigXAdES Property (XAdESSigner Class)
Specifies whether the document contains an advanced signature (XAdES).
Syntax
ANSI (Cross Platform) int GetNewSigXAdES();
int SetNewSigXAdES(int bNewSigXAdES); Unicode (Windows) BOOL GetNewSigXAdES();
INT SetNewSigXAdES(BOOL bNewSigXAdES);
int secureblackbox_xadessigner_getnewsigxades(void* lpObj);
int secureblackbox_xadessigner_setnewsigxades(void* lpObj, int bNewSigXAdES);
bool GetNewSigXAdES();
int SetNewSigXAdES(bool bNewSigXAdES);
Default Value
TRUE
Remarks
Specifies whether the document contains an advanced signature (XAdES).
Use this property to check whether the document is signed with XAdES or XML-DSIG only.
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
NewSigXAdESForm Property (XAdESSigner Class)
Specifies which form of XAdES should be produced.
Syntax
ANSI (Cross Platform) int GetNewSigXAdESForm();
int SetNewSigXAdESForm(int iNewSigXAdESForm); Unicode (Windows) INT GetNewSigXAdESForm();
INT SetNewSigXAdESForm(INT iNewSigXAdESForm);
Possible Values
XAF_NONE(0),
XAF_BASIC(1),
XAF_BES(2),
XAF_EPES(3),
XAF_T(4),
XAF_C(5),
XAF_X(6),
XAF_XL(7),
XAF_A(8),
XAF_EXTENDED_BES(9),
XAF_EXTENDED_EPES(10),
XAF_EXTENDED_T(11),
XAF_EXTENDED_C(12),
XAF_EXTENDED_X(13),
XAF_EXTENDED_XLONG(14),
XAF_EXTENDED_XL(15),
XAF_EXTENDED_A(16)
int secureblackbox_xadessigner_getnewsigxadesform(void* lpObj);
int secureblackbox_xadessigner_setnewsigxadesform(void* lpObj, int iNewSigXAdESForm);
int GetNewSigXAdESForm();
int SetNewSigXAdESForm(int iNewSigXAdESForm);
Default Value
0
Remarks
Specifies which form of XAdES should be produced.
Use this property to specify the form (level) of advanced electronic signature to be produced.
The supported forms are:
xafNone | 0 | None |
xafBasic | 1 | XAdES form, supported by XAdES v1.1.1 |
xafBES | 2 | XAdES-BES form, supported starting from XAdES v1.2.2 |
xafEPES | 3 | XAdES-EPES form, supported starting from XAdES v1.2.2 |
xafT | 4 | XAdES-T form |
xafC | 5 | XAdES-C form |
xafX | 6 | XAdES-X form |
xafXL | 7 | XAdES-X-L form |
xafA | 8 | XAdES-A form |
xafExtendedBES | 9 | XAdES-E-BES form |
xafExtendedEPES | 10 | XAdES-E-EPES form |
xafExtendedT | 11 | XAdES-E-T form |
xafExtendedC | 12 | XAdES-E-C form |
xafExtendedX | 13 | XAdES-E-X form |
xafExtendedXLong | 14 | XAdES-E-X-Long form (type 1) |
xafExtendedXL | 15 | XAdES-E-X-L form (type 2) |
xafExtendedA | 16 | XAdES-E-A form |
* XAdES-E-* forms are supported starting from XAdES v1.3.2
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
NewSigXAdESVersion Property (XAdESSigner Class)
Specifies XAdES version.
Syntax
ANSI (Cross Platform) int GetNewSigXAdESVersion();
int SetNewSigXAdESVersion(int iNewSigXAdESVersion); Unicode (Windows) INT GetNewSigXAdESVersion();
INT SetNewSigXAdESVersion(INT iNewSigXAdESVersion);
Possible Values
XAV_UNKNOWN(0),
XAV_111(1),
XAV_122(2),
XAV_132(3),
XAV_141(4)
int secureblackbox_xadessigner_getnewsigxadesversion(void* lpObj);
int secureblackbox_xadessigner_setnewsigxadesversion(void* lpObj, int iNewSigXAdESVersion);
int GetNewSigXAdESVersion();
int SetNewSigXAdESVersion(int iNewSigXAdESVersion);
Default Value
3
Remarks
Specifies XAdES version.
This property specifies the version of the XAdES specification the signature should comply with. For the form of XAdES, use XAdESForm.
The supported vesions are:
xavUnknown | 0 | Unknown |
xav111 | 1 | XAdES v1.1.1 |
xav122 | 2 | XAdES v1.2.2 |
xav132 | 3 | XAdES v1.3.2 |
xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |
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
NewSigXMLElement Property (XAdESSigner Class)
Specifies the XML element where to save the signature or containing the signature.
Syntax
ANSI (Cross Platform) char* GetNewSigXMLElement();
int SetNewSigXMLElement(const char* lpszNewSigXMLElement); Unicode (Windows) LPWSTR GetNewSigXMLElement();
INT SetNewSigXMLElement(LPCWSTR lpszNewSigXMLElement);
char* secureblackbox_xadessigner_getnewsigxmlelement(void* lpObj);
int secureblackbox_xadessigner_setnewsigxmlelement(void* lpObj, const char* lpszNewSigXMLElement);
QString GetNewSigXMLElement();
int SetNewSigXMLElement(QString qsNewSigXMLElement);
Default Value
""
Remarks
Specifies the XML element where to save the signature or containing the signature.
This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.
Supported values are:
"" | an empty string indicates the Document element |
"#id" | indicates an XML element with specified Id |
XPath expression | indicates an XML element selected using XPath expression. Use XPathNamespaces property to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined in XPathNamespaces property |
Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
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
OCSPCount Property (XAdESSigner Class)
The number of records in the OCSP arrays.
Syntax
ANSI (Cross Platform) int GetOCSPCount(); Unicode (Windows) INT GetOCSPCount();
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
The location of the OCSP responder.
Syntax
ANSI (Cross Platform) char* GetOCSPLocation(int iOCSPIndex); Unicode (Windows) LPWSTR GetOCSPLocation(INT iOCSPIndex);
char* secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getofflinemode(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
Specifies the file where the signed document will be saved.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_xadessigner_getoutputfile(void* lpObj);
int secureblackbox_xadessigner_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
Provide the full path to the file where the signed document should be saved.
Data Type
String
Profile Property (XAdESSigner 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_xadessigner_getprofile(void* lpObj);
int secureblackbox_xadessigner_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:
"ES.Factura" | Spanish Factura Electronica | |
"BR.AD_RB_v2_3" | Brazilian signature with Basic Reference (AD-RB) version 2.3 | |
"BR.AD_RB_v2_4" | Brazilian signature with Basic Reference (AD-RB) version 2.4 | |
"BR.AD_RT_v2_3" | Brazilian signature with Time Reference (AD-RT) version 2.3 | |
"BR.AD_RT_v2_4" | Brazilian signature with Time Reference (AD-RT) version 2.4 | |
"BR.AD_RV_v2_3" | Brazilian signature with References for Validation (AD-RV) version 2.3 | |
"BR.AD_RV_v2_4" | Brazilian signature with References for Validation (AD-RV) version 2.4 | |
"BR.AD_RC_v2_3" | Brazilian signature with Complete References (AD-RC) version 2.3 | |
"BR.AD_RC_v2_4" | Brazilian signature with Complete References (AD-RC) version 2.4 | |
"BR.AD_RA_v2_3" | Brazilian signature with References for Archiving (AD-RA) version 2.3 | |
"BR.AD_RA_v2_4" | Brazilian signature with References for Archiving (AD-RA) version 2.4 | |
"XAdES.BASELINE-B" | XAdES B-B level (ETSI TS 103 171 v2.1.1 Baseline Profile) | |
"XAdES.BASELINE-T" | XAdES B-T level | |
"XAdES.BASELINE-LT" | XAdES B-LT level | |
"XAdES.BASELINE-LTA" | XAdES B-LTA level | |
"XAdES.BASELINE-E-B" | Extended XAdES B-B level (ETSI EN 319 132-1 v1.1.1 Building Blocks and Baseline, ETSI EN 319 132-2 v1.1.1 extended XAdES) | |
"XAdES.BASELINE-E-T" | Extended XAdES B-T level | |
"XAdES.BASELINE-E-LT" | Extended XAdES B-LT level | |
"XAdES.BASELINE-E-LTA" | Extended XAdES B-LTA level | |
"XAdES.CounterSignature" | Adds XAdES countersignature (supported in XML and XAdES signer control) |
"ES.Factura" profile equivalent to the following settings:
using (XMLReference Ref = new XMLReference())
{
Ref.ID = "Reference-1";
Ref.TargetXMLElement = "";
Ref.UseEnvelopedSignatureTransform = true;
XAdESSigner.References.Add(Ref);
}
using (XMLReference Ref = new XMLReference())
{
Ref.URI = "#KeyInfo-1";
XAdESSigner.References.Add(Ref);
}
XAdESSigner.NewSignature.XAdESVersion = XAdESVersions.xav132;
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafEPES;
XAdESSigner.Config("KeyInfoDetails=certificate");
XAdESSigner.Config("KeyInfoID=KeyInfo-1");
XAdESSigner.Config("ClaimedRoleText=emisor");
XAdESSigner.Config("SigPolicyId=http://www.facturae.es/politica_de_firma_formato_facturae/politica_de_firma_formato_facturae_v3_1.pdf");
XAdESSigner.Config("SigPolicyDescription=Pol" + "\u00ED" + "tica de Firma FacturaE v3.1");
XAdESSigner.Config("SigPolicyHash=3a18b197aba90fa6aff0dee912f0c006110bea13");
XAdESSigner.Config("SigPolicyHashAlgorithm=SHA1");
XAdESSigner.Config("DataObjectFormatObjectReference=#Reference-1");
XAdESSigner.Config("DataObjectFormatMimeType=text/xml");
XAdESSigner.Config("DataObjectFormatDescription=Factura electr" + "\u00F3" + "nica");
"XAdES.BASELINE-B" profile equivalent to the following settings:
using (XMLReference Ref = new XMLReference())
{
Ref.ID = "Reference-1";
Ref.TargetXMLElement = "";
Ref.UseEnvelopedSignatureTransform = true;
XAdESSigner.References.Add(Ref);
}
XAdESSigner.NewSignature.XAdESVersion = XAdESVersions.xav141;
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafBES;
XAdESSigner.Config("DataObjectFormatObjectReference=#Reference-1");
XAdESSigner.Config("DataObjectFormatMimeType=text/xml");
"XAdES.BASELINE-T" profile extends "XAdES.BASELINE-B" profile with the following settings:
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafT;
XAdESSigner.TimestampServer = "https://freetsa.org/tsr";
"XAdES.BASELINE-LT" profile extends "XAdES.BASELINE-T" profile with the following settings:
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafXL;
XAdESSigner.Config("RefsTimestampType=none");
XAdESSigner.Config("ValidationDataRefsDetails=none");
"XAdES.BASELINE-LTA" profile extends "XAdES.BASELINE-LT" profile with the following settings:
XAdESSigner.XAdESForm = XadessignerXAdESForms.xafA;
"XAdES.BASELINE-E-B" profile equivalent to the following settings:
using (XMLReference Ref = new XMLReference())
{
Ref.ID = "Reference-1";
Ref.TargetXMLElement = "";
Ref.UseEnvelopedSignatureTransform = true;
XAdESSigner.References.Add(Ref);
}
XAdESSigner.NewSignature.XAdESVersion = XAdESVersions.xav141;
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafExtendedBES;
XAdESSigner.Config("DataObjectFormatObjectReference=#Reference-1");
XAdESSigner.Config("DataObjectFormatMimeType=text/xml");
"XAdES.BASELINE-E-T" profile extends "XAdES.BASELINE-E-B" profile with the following settings:
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafExtendedT;
XAdESSigner.TimestampServer = "https://freetsa.org/tsr";
"XAdES.BASELINE-E-LT" profile extends "XAdES.BASELINE-E-T" profile with the following settings:
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafExtendedXL;
XAdESSigner.Config("RefsTimestampType=none");
XAdESSigner.Config("ValidationDataRefsDetails=none");
"XAdES.BASELINE-E-LTA" profile extends "XAdES.BASELINE-E-LT" profile with the following settings:
XAdESSigner.NewSignature.XAdESForm = XAdESForms.xafExtendedA;
"XAdES.CounterSignature" profile allows to add XAdES countersignature to the existent XAdES-BES or EPES signature. Use XMLElement property to specify existent XAdES signature. Sample code:
XAdESSigner.Profile = "XAdES.CounterSignature";
XAdESSigner.NewSignature.XAdES = false;
Data Type
String
ProxyAddress Property (XAdESSigner 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_xadessigner_getproxyaddress(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyauthentication(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxypassword(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyport(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyproxytype(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyrequestheaders(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyresponsebody(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyresponseheaders(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyuseipv6(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyuseproxy(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getproxyusername(void* lpObj);
int secureblackbox_xadessigner_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
ReferenceCount Property (XAdESSigner Class)
The number of records in the Reference arrays.
Syntax
ANSI (Cross Platform) int GetReferenceCount();
int SetReferenceCount(int iReferenceCount); Unicode (Windows) INT GetReferenceCount();
INT SetReferenceCount(INT iReferenceCount);
int secureblackbox_xadessigner_getreferencecount(void* lpObj);
int secureblackbox_xadessigner_setreferencecount(void* lpObj, int iReferenceCount);
int GetReferenceCount();
int SetReferenceCount(int iReferenceCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- ReferenceAutoGenerateElementId
- ReferenceCanonicalizationMethod
- ReferenceCustomElementId
- ReferenceDigestValue
- ReferenceHandle
- ReferenceHashAlgorithm
- ReferenceHasURI
- ReferenceID
- ReferenceInclusiveNamespacesPrefixList
- ReferenceReferenceType
- ReferenceSignatureIndex
- ReferenceTargetData
- ReferenceTargetType
- ReferenceTargetXMLElement
- ReferenceURI
- ReferenceUseBase64Transform
- ReferenceUseEnvelopedSignatureTransform
- ReferenceUseXPathFilter2Transform
- ReferenceUseXPathTransform
- ReferenceXPathExpression
- ReferenceXPathFilter2Expressions
- ReferenceXPathFilter2Filters
- ReferenceXPathFilter2PrefixList
- ReferenceXPathPrefixList
The array indices start at 0 and end at ReferenceCount - 1.
This property is not available at design time.
Data Type
Integer
ReferenceAutoGenerateElementId Property (XAdESSigner Class)
Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.
Syntax
ANSI (Cross Platform) int GetReferenceAutoGenerateElementId(int iReferenceIndex);
int SetReferenceAutoGenerateElementId(int iReferenceIndex, int bReferenceAutoGenerateElementId); Unicode (Windows) BOOL GetReferenceAutoGenerateElementId(INT iReferenceIndex);
INT SetReferenceAutoGenerateElementId(INT iReferenceIndex, BOOL bReferenceAutoGenerateElementId);
int secureblackbox_xadessigner_getreferenceautogenerateelementid(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceautogenerateelementid(void* lpObj, int referenceindex, int bReferenceAutoGenerateElementId);
bool GetReferenceAutoGenerateElementId(int iReferenceIndex);
int SetReferenceAutoGenerateElementId(int iReferenceIndex, bool bReferenceAutoGenerateElementId);
Default Value
FALSE
Remarks
Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Boolean
ReferenceCanonicalizationMethod Property (XAdESSigner Class)
Use this property to specify the canonicalization method for the transform of the reference.
Syntax
ANSI (Cross Platform) int GetReferenceCanonicalizationMethod(int iReferenceIndex);
int SetReferenceCanonicalizationMethod(int iReferenceIndex, int iReferenceCanonicalizationMethod); Unicode (Windows) INT GetReferenceCanonicalizationMethod(INT iReferenceIndex);
INT SetReferenceCanonicalizationMethod(INT iReferenceIndex, INT iReferenceCanonicalizationMethod);
Possible Values
CXCM_NONE(0),
CXCM_CANON(1),
CXCM_CANON_COMMENT(2),
CXCM_EXCL_CANON(3),
CXCM_EXCL_CANON_COMMENT(4),
CXCM_MIN_CANON(5),
CXCM_CANON_V_1_1(6),
CXCM_CANON_COMMENT_V_1_1(7)
int secureblackbox_xadessigner_getreferencecanonicalizationmethod(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencecanonicalizationmethod(void* lpObj, int referenceindex, int iReferenceCanonicalizationMethod);
int GetReferenceCanonicalizationMethod(int iReferenceIndex);
int SetReferenceCanonicalizationMethod(int iReferenceIndex, int iReferenceCanonicalizationMethod);
Default Value
0
Remarks
Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Integer
ReferenceCustomElementId Property (XAdESSigner Class)
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
Syntax
ANSI (Cross Platform) char* GetReferenceCustomElementId(int iReferenceIndex);
int SetReferenceCustomElementId(int iReferenceIndex, const char* lpszReferenceCustomElementId); Unicode (Windows) LPWSTR GetReferenceCustomElementId(INT iReferenceIndex);
INT SetReferenceCustomElementId(INT iReferenceIndex, LPCWSTR lpszReferenceCustomElementId);
char* secureblackbox_xadessigner_getreferencecustomelementid(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencecustomelementid(void* lpObj, int referenceindex, const char* lpszReferenceCustomElementId);
QString GetReferenceCustomElementId(int iReferenceIndex);
int SetReferenceCustomElementId(int iReferenceIndex, QString qsReferenceCustomElementId);
Default Value
""
Remarks
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceDigestValue Property (XAdESSigner Class)
Use this property to get or set the value of the digest calculated over the referenced data.
Syntax
ANSI (Cross Platform) int GetReferenceDigestValue(int iReferenceIndex, char* &lpReferenceDigestValue, int &lenReferenceDigestValue);
int SetReferenceDigestValue(int iReferenceIndex, const char* lpReferenceDigestValue, int lenReferenceDigestValue); Unicode (Windows) INT GetReferenceDigestValue(INT iReferenceIndex, LPSTR &lpReferenceDigestValue, INT &lenReferenceDigestValue);
INT SetReferenceDigestValue(INT iReferenceIndex, LPCSTR lpReferenceDigestValue, INT lenReferenceDigestValue);
int secureblackbox_xadessigner_getreferencedigestvalue(void* lpObj, int referenceindex, char** lpReferenceDigestValue, int* lenReferenceDigestValue);
int secureblackbox_xadessigner_setreferencedigestvalue(void* lpObj, int referenceindex, const char* lpReferenceDigestValue, int lenReferenceDigestValue);
QByteArray GetReferenceDigestValue(int iReferenceIndex);
int SetReferenceDigestValue(int iReferenceIndex, QByteArray qbaReferenceDigestValue);
Remarks
Use this property to get or set the value of the digest calculated over the referenced data.
This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Byte Array
ReferenceHandle Property (XAdESSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetReferenceHandle(int iReferenceIndex);
int SetReferenceHandle(int iReferenceIndex, int64 lReferenceHandle); Unicode (Windows) LONG64 GetReferenceHandle(INT iReferenceIndex);
INT SetReferenceHandle(INT iReferenceIndex, LONG64 lReferenceHandle);
int64 secureblackbox_xadessigner_getreferencehandle(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencehandle(void* lpObj, int referenceindex, int64 lReferenceHandle);
qint64 GetReferenceHandle(int iReferenceIndex);
int SetReferenceHandle(int iReferenceIndex, qint64 lReferenceHandle);
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 ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Long64
ReferenceHashAlgorithm Property (XAdESSigner Class)
Specifies the hash algorithm to be used.
Syntax
ANSI (Cross Platform) char* GetReferenceHashAlgorithm(int iReferenceIndex);
int SetReferenceHashAlgorithm(int iReferenceIndex, const char* lpszReferenceHashAlgorithm); Unicode (Windows) LPWSTR GetReferenceHashAlgorithm(INT iReferenceIndex);
INT SetReferenceHashAlgorithm(INT iReferenceIndex, LPCWSTR lpszReferenceHashAlgorithm);
char* secureblackbox_xadessigner_getreferencehashalgorithm(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencehashalgorithm(void* lpObj, int referenceindex, const char* lpszReferenceHashAlgorithm);
QString GetReferenceHashAlgorithm(int iReferenceIndex);
int SetReferenceHashAlgorithm(int iReferenceIndex, QString qsReferenceHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceHasURI Property (XAdESSigner Class)
Specifies whether the URI is set (even when it is empty).
Syntax
ANSI (Cross Platform) int GetReferenceHasURI(int iReferenceIndex);
int SetReferenceHasURI(int iReferenceIndex, int bReferenceHasURI); Unicode (Windows) BOOL GetReferenceHasURI(INT iReferenceIndex);
INT SetReferenceHasURI(INT iReferenceIndex, BOOL bReferenceHasURI);
int secureblackbox_xadessigner_getreferencehasuri(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencehasuri(void* lpObj, int referenceindex, int bReferenceHasURI);
bool GetReferenceHasURI(int iReferenceIndex);
int SetReferenceHasURI(int iReferenceIndex, bool bReferenceHasURI);
Default Value
TRUE
Remarks
Specifies whether the URI is set (even when it is empty).
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Boolean
ReferenceID Property (XAdESSigner Class)
A user-defined identifier (ID) attribute of this Reference element.
Syntax
ANSI (Cross Platform) char* GetReferenceID(int iReferenceIndex);
int SetReferenceID(int iReferenceIndex, const char* lpszReferenceID); Unicode (Windows) LPWSTR GetReferenceID(INT iReferenceIndex);
INT SetReferenceID(INT iReferenceIndex, LPCWSTR lpszReferenceID);
char* secureblackbox_xadessigner_getreferenceid(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceid(void* lpObj, int referenceindex, const char* lpszReferenceID);
QString GetReferenceID(int iReferenceIndex);
int SetReferenceID(int iReferenceIndex, QString qsReferenceID);
Default Value
""
Remarks
A user-defined identifier (ID) attribute of this Reference element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceInclusiveNamespacesPrefixList Property (XAdESSigner Class)
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
Syntax
ANSI (Cross Platform) char* GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);
int SetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex, const char* lpszReferenceInclusiveNamespacesPrefixList); Unicode (Windows) LPWSTR GetReferenceInclusiveNamespacesPrefixList(INT iReferenceIndex);
INT SetReferenceInclusiveNamespacesPrefixList(INT iReferenceIndex, LPCWSTR lpszReferenceInclusiveNamespacesPrefixList);
char* secureblackbox_xadessigner_getreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex, const char* lpszReferenceInclusiveNamespacesPrefixList);
QString GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);
int SetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex, QString qsReferenceInclusiveNamespacesPrefixList);
Default Value
""
Remarks
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceReferenceType Property (XAdESSigner Class)
The Reference's type attribute as defined in XMLDSIG specification.
Syntax
ANSI (Cross Platform) char* GetReferenceReferenceType(int iReferenceIndex);
int SetReferenceReferenceType(int iReferenceIndex, const char* lpszReferenceReferenceType); Unicode (Windows) LPWSTR GetReferenceReferenceType(INT iReferenceIndex);
INT SetReferenceReferenceType(INT iReferenceIndex, LPCWSTR lpszReferenceReferenceType);
char* secureblackbox_xadessigner_getreferencereferencetype(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencereferencetype(void* lpObj, int referenceindex, const char* lpszReferenceReferenceType);
QString GetReferenceReferenceType(int iReferenceIndex);
int SetReferenceReferenceType(int iReferenceIndex, QString qsReferenceReferenceType);
Default Value
""
Remarks
The Reference's type attribute as defined in XMLDSIG specification.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceSignatureIndex Property (XAdESSigner Class)
Returns the index of the owner signature, if applicable.
Syntax
ANSI (Cross Platform) int GetReferenceSignatureIndex(int iReferenceIndex); Unicode (Windows) INT GetReferenceSignatureIndex(INT iReferenceIndex);
int secureblackbox_xadessigner_getreferencesignatureindex(void* lpObj, int referenceindex);
int GetReferenceSignatureIndex(int iReferenceIndex);
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 ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is read-only and not available at design time.
Data Type
Integer
ReferenceTargetData Property (XAdESSigner Class)
Contains the referenced external data when the digest value is not explicitly specified.
Syntax
ANSI (Cross Platform) int GetReferenceTargetData(int iReferenceIndex, char* &lpReferenceTargetData, int &lenReferenceTargetData);
int SetReferenceTargetData(int iReferenceIndex, const char* lpReferenceTargetData, int lenReferenceTargetData); Unicode (Windows) INT GetReferenceTargetData(INT iReferenceIndex, LPSTR &lpReferenceTargetData, INT &lenReferenceTargetData);
INT SetReferenceTargetData(INT iReferenceIndex, LPCSTR lpReferenceTargetData, INT lenReferenceTargetData);
int secureblackbox_xadessigner_getreferencetargetdata(void* lpObj, int referenceindex, char** lpReferenceTargetData, int* lenReferenceTargetData);
int secureblackbox_xadessigner_setreferencetargetdata(void* lpObj, int referenceindex, const char* lpReferenceTargetData, int lenReferenceTargetData);
QByteArray GetReferenceTargetData(int iReferenceIndex);
int SetReferenceTargetData(int iReferenceIndex, QByteArray qbaReferenceTargetData);
Remarks
Contains the referenced external data when the digest value is not explicitly specified.
This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Byte Array
ReferenceTargetType Property (XAdESSigner Class)
The reference's target type to use.
Syntax
ANSI (Cross Platform) int GetReferenceTargetType(int iReferenceIndex);
int SetReferenceTargetType(int iReferenceIndex, int iReferenceTargetType); Unicode (Windows) INT GetReferenceTargetType(INT iReferenceIndex);
INT SetReferenceTargetType(INT iReferenceIndex, INT iReferenceTargetType);
Possible Values
RTT_AUTO(0),
RTT_XMLELEMENT(1),
RTT_DATA(2),
RTT_URI(3)
int secureblackbox_xadessigner_getreferencetargettype(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencetargettype(void* lpObj, int referenceindex, int iReferenceTargetType);
int GetReferenceTargetType(int iReferenceIndex);
int SetReferenceTargetType(int iReferenceIndex, int iReferenceTargetType);
Default Value
0
Remarks
The reference's target type to use.
Use this property to specify the reference's target type to use when forming the signature.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Integer
ReferenceTargetXMLElement Property (XAdESSigner Class)
This property specifies the referenced XML element.
Syntax
ANSI (Cross Platform) char* GetReferenceTargetXMLElement(int iReferenceIndex);
int SetReferenceTargetXMLElement(int iReferenceIndex, const char* lpszReferenceTargetXMLElement); Unicode (Windows) LPWSTR GetReferenceTargetXMLElement(INT iReferenceIndex);
INT SetReferenceTargetXMLElement(INT iReferenceIndex, LPCWSTR lpszReferenceTargetXMLElement);
char* secureblackbox_xadessigner_getreferencetargetxmlelement(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencetargetxmlelement(void* lpObj, int referenceindex, const char* lpszReferenceTargetXMLElement);
QString GetReferenceTargetXMLElement(int iReferenceIndex);
int SetReferenceTargetXMLElement(int iReferenceIndex, QString qsReferenceTargetXMLElement);
Default Value
""
Remarks
This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.
Supported values are:
"" | an empty string indicates the Document element. |
"#id" | indicates an XML element with specified Id. |
XPointer expression | indicates an XML element selected using XPointer expression. Use the XPathNamespaces property to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined in XPathNamespaces property |
Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceURI Property (XAdESSigner Class)
Use this property to get or set the URL which references the data.
Syntax
ANSI (Cross Platform) char* GetReferenceURI(int iReferenceIndex);
int SetReferenceURI(int iReferenceIndex, const char* lpszReferenceURI); Unicode (Windows) LPWSTR GetReferenceURI(INT iReferenceIndex);
INT SetReferenceURI(INT iReferenceIndex, LPCWSTR lpszReferenceURI);
char* secureblackbox_xadessigner_getreferenceuri(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceuri(void* lpObj, int referenceindex, const char* lpszReferenceURI);
QString GetReferenceURI(int iReferenceIndex);
int SetReferenceURI(int iReferenceIndex, QString qsReferenceURI);
Default Value
""
Remarks
Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceUseBase64Transform Property (XAdESSigner Class)
Specifies whether Base64 transform is included in transform chain.
Syntax
ANSI (Cross Platform) int GetReferenceUseBase64Transform(int iReferenceIndex);
int SetReferenceUseBase64Transform(int iReferenceIndex, int bReferenceUseBase64Transform); Unicode (Windows) BOOL GetReferenceUseBase64Transform(INT iReferenceIndex);
INT SetReferenceUseBase64Transform(INT iReferenceIndex, BOOL bReferenceUseBase64Transform);
int secureblackbox_xadessigner_getreferenceusebase64transform(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceusebase64transform(void* lpObj, int referenceindex, int bReferenceUseBase64Transform);
bool GetReferenceUseBase64Transform(int iReferenceIndex);
int SetReferenceUseBase64Transform(int iReferenceIndex, bool bReferenceUseBase64Transform);
Default Value
FALSE
Remarks
Specifies whether Base64 transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Boolean
ReferenceUseEnvelopedSignatureTransform Property (XAdESSigner Class)
Specifies whether enveloped signature transform is included in transform chain.
Syntax
ANSI (Cross Platform) int GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);
int SetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex, int bReferenceUseEnvelopedSignatureTransform); Unicode (Windows) BOOL GetReferenceUseEnvelopedSignatureTransform(INT iReferenceIndex);
INT SetReferenceUseEnvelopedSignatureTransform(INT iReferenceIndex, BOOL bReferenceUseEnvelopedSignatureTransform);
int secureblackbox_xadessigner_getreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex, int bReferenceUseEnvelopedSignatureTransform);
bool GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);
int SetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex, bool bReferenceUseEnvelopedSignatureTransform);
Default Value
FALSE
Remarks
Specifies whether enveloped signature transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Boolean
ReferenceUseXPathFilter2Transform Property (XAdESSigner Class)
Specifies whether XPath Filter 2.
Syntax
ANSI (Cross Platform) int GetReferenceUseXPathFilter2Transform(int iReferenceIndex);
int SetReferenceUseXPathFilter2Transform(int iReferenceIndex, int bReferenceUseXPathFilter2Transform); Unicode (Windows) BOOL GetReferenceUseXPathFilter2Transform(INT iReferenceIndex);
INT SetReferenceUseXPathFilter2Transform(INT iReferenceIndex, BOOL bReferenceUseXPathFilter2Transform);
int secureblackbox_xadessigner_getreferenceusexpathfilter2transform(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceusexpathfilter2transform(void* lpObj, int referenceindex, int bReferenceUseXPathFilter2Transform);
bool GetReferenceUseXPathFilter2Transform(int iReferenceIndex);
int SetReferenceUseXPathFilter2Transform(int iReferenceIndex, bool bReferenceUseXPathFilter2Transform);
Default Value
FALSE
Remarks
Specifies whether XPath Filter 2.0 transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Boolean
ReferenceUseXPathTransform Property (XAdESSigner Class)
Specifies whether XPath transform is included in transform chain.
Syntax
ANSI (Cross Platform) int GetReferenceUseXPathTransform(int iReferenceIndex);
int SetReferenceUseXPathTransform(int iReferenceIndex, int bReferenceUseXPathTransform); Unicode (Windows) BOOL GetReferenceUseXPathTransform(INT iReferenceIndex);
INT SetReferenceUseXPathTransform(INT iReferenceIndex, BOOL bReferenceUseXPathTransform);
int secureblackbox_xadessigner_getreferenceusexpathtransform(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferenceusexpathtransform(void* lpObj, int referenceindex, int bReferenceUseXPathTransform);
bool GetReferenceUseXPathTransform(int iReferenceIndex);
int SetReferenceUseXPathTransform(int iReferenceIndex, bool bReferenceUseXPathTransform);
Default Value
FALSE
Remarks
Specifies whether XPath transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
Boolean
ReferenceXPathExpression Property (XAdESSigner Class)
Use this property to specify XPath expression for XPath transform of the reference.
Syntax
ANSI (Cross Platform) char* GetReferenceXPathExpression(int iReferenceIndex);
int SetReferenceXPathExpression(int iReferenceIndex, const char* lpszReferenceXPathExpression); Unicode (Windows) LPWSTR GetReferenceXPathExpression(INT iReferenceIndex);
INT SetReferenceXPathExpression(INT iReferenceIndex, LPCWSTR lpszReferenceXPathExpression);
char* secureblackbox_xadessigner_getreferencexpathexpression(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencexpathexpression(void* lpObj, int referenceindex, const char* lpszReferenceXPathExpression);
QString GetReferenceXPathExpression(int iReferenceIndex);
int SetReferenceXPathExpression(int iReferenceIndex, QString qsReferenceXPathExpression);
Default Value
""
Remarks
Use this property to specify XPath expression for XPath transform of the reference.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceXPathFilter2Expressions Property (XAdESSigner Class)
Use this property to specify XPointer expression(s) for XPath Filter 2.
Syntax
ANSI (Cross Platform) char* GetReferenceXPathFilter2Expressions(int iReferenceIndex);
int SetReferenceXPathFilter2Expressions(int iReferenceIndex, const char* lpszReferenceXPathFilter2Expressions); Unicode (Windows) LPWSTR GetReferenceXPathFilter2Expressions(INT iReferenceIndex);
INT SetReferenceXPathFilter2Expressions(INT iReferenceIndex, LPCWSTR lpszReferenceXPathFilter2Expressions);
char* secureblackbox_xadessigner_getreferencexpathfilter2expressions(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencexpathfilter2expressions(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2Expressions);
QString GetReferenceXPathFilter2Expressions(int iReferenceIndex);
int SetReferenceXPathFilter2Expressions(int iReferenceIndex, QString qsReferenceXPathFilter2Expressions);
Default Value
""
Remarks
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceXPathFilter2Filters Property (XAdESSigner Class)
Use this property to specify XPointer filter(s) for XPath Filter 2.
Syntax
ANSI (Cross Platform) char* GetReferenceXPathFilter2Filters(int iReferenceIndex);
int SetReferenceXPathFilter2Filters(int iReferenceIndex, const char* lpszReferenceXPathFilter2Filters); Unicode (Windows) LPWSTR GetReferenceXPathFilter2Filters(INT iReferenceIndex);
INT SetReferenceXPathFilter2Filters(INT iReferenceIndex, LPCWSTR lpszReferenceXPathFilter2Filters);
char* secureblackbox_xadessigner_getreferencexpathfilter2filters(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencexpathfilter2filters(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2Filters);
QString GetReferenceXPathFilter2Filters(int iReferenceIndex);
int SetReferenceXPathFilter2Filters(int iReferenceIndex, QString qsReferenceXPathFilter2Filters);
Default Value
""
Remarks
Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.
Supported values:
"intersect" | Intersect filter computes the intersection of the selected subtrees with the filter node-set. |
"subtract" | Subtract filter computes the subtraction of the selected subtrees with the filter node-set. |
"union" | Union filter computes the union of the selected subtrees with the filter node-set. |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceXPathFilter2PrefixList Property (XAdESSigner Class)
Use this property to specify a prefix list for XPath Filter 2.
Syntax
ANSI (Cross Platform) char* GetReferenceXPathFilter2PrefixList(int iReferenceIndex);
int SetReferenceXPathFilter2PrefixList(int iReferenceIndex, const char* lpszReferenceXPathFilter2PrefixList); Unicode (Windows) LPWSTR GetReferenceXPathFilter2PrefixList(INT iReferenceIndex);
INT SetReferenceXPathFilter2PrefixList(INT iReferenceIndex, LPCWSTR lpszReferenceXPathFilter2PrefixList);
char* secureblackbox_xadessigner_getreferencexpathfilter2prefixlist(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencexpathfilter2prefixlist(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2PrefixList);
QString GetReferenceXPathFilter2PrefixList(int iReferenceIndex);
int SetReferenceXPathFilter2PrefixList(int iReferenceIndex, QString qsReferenceXPathFilter2PrefixList);
Default Value
""
Remarks
Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
ReferenceXPathPrefixList Property (XAdESSigner Class)
Use this property to specify a prefix list for XPath transform of the reference.
Syntax
ANSI (Cross Platform) char* GetReferenceXPathPrefixList(int iReferenceIndex);
int SetReferenceXPathPrefixList(int iReferenceIndex, const char* lpszReferenceXPathPrefixList); Unicode (Windows) LPWSTR GetReferenceXPathPrefixList(INT iReferenceIndex);
INT SetReferenceXPathPrefixList(INT iReferenceIndex, LPCWSTR lpszReferenceXPathPrefixList);
char* secureblackbox_xadessigner_getreferencexpathprefixlist(void* lpObj, int referenceindex);
int secureblackbox_xadessigner_setreferencexpathprefixlist(void* lpObj, int referenceindex, const char* lpszReferenceXPathPrefixList);
QString GetReferenceXPathPrefixList(int iReferenceIndex);
int SetReferenceXPathPrefixList(int iReferenceIndex, QString qsReferenceXPathPrefixList);
Default Value
""
Remarks
Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is not available at design time.
Data Type
String
RevocationCheck Property (XAdESSigner 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_xadessigner_getrevocationcheck(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
The number of records in the Signature arrays.
Syntax
ANSI (Cross Platform) int GetSignatureCount(); Unicode (Windows) INT GetSignatureCount();
int secureblackbox_xadessigner_getsignaturecount(void* lpObj);
int GetSignatureCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignatureCanonicalizationMethod
- SignatureCertificateIndex
- SignatureChainValidationDetails
- SignatureChainValidationResult
- SignatureClaimedSigningTime
- SignatureHandle
- SignatureHashAlgorithm
- SignatureIssuerRDN
- SignatureLastArchivalTime
- SignaturePolicyHash
- SignaturePolicyHashAlgorithm
- SignaturePolicyID
- SignaturePolicyURI
- SignatureSerialNumber
- SignatureSignatureBytes
- SignatureSignatureType
- SignatureSignatureValidationResult
- SignatureSubjectKeyID
- SignatureSubjectRDN
- SignatureTimestamped
- SignatureValidatedSigningTime
- SignatureValidationLog
- SignatureXAdES
- SignatureXAdESForm
- SignatureXAdESVersion
- SignatureXMLElement
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
SignatureCanonicalizationMethod Property (XAdESSigner Class)
The XML canonicalization method that was used for signing.
Syntax
ANSI (Cross Platform) int GetSignatureCanonicalizationMethod(int iSignatureIndex); Unicode (Windows) INT GetSignatureCanonicalizationMethod(INT iSignatureIndex);
Possible Values
CXCM_NONE(0),
CXCM_CANON(1),
CXCM_CANON_COMMENT(2),
CXCM_EXCL_CANON(3),
CXCM_EXCL_CANON_COMMENT(4),
CXCM_MIN_CANON(5),
CXCM_CANON_V_1_1(6),
CXCM_CANON_COMMENT_V_1_1(7)
int secureblackbox_xadessigner_getsignaturecanonicalizationmethod(void* lpObj, int signatureindex);
int GetSignatureCanonicalizationMethod(int iSignatureIndex);
Default Value
0
Remarks
The XML canonicalization method that was used for signing.
Supported canonicalization methods:
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
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
SignatureCertificateIndex Property (XAdESSigner 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_xadessigner_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
SignatureChainValidationDetails Property (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
The signing time from the signer's computer.
Syntax
ANSI (Cross Platform) char* GetSignatureClaimedSigningTime(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureClaimedSigningTime(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignatureclaimedsigningtime(void* lpObj, int signatureindex);
QString GetSignatureClaimedSigningTime(int iSignatureIndex);
Default Value
""
Remarks
The signing time from the signer's computer.
Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.
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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
The hash algorithm used for signing.
Syntax
ANSI (Cross Platform) char* GetSignatureHashAlgorithm(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureHashAlgorithm(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturehashalgorithm(void* lpObj, int signatureindex);
QString GetSignatureHashAlgorithm(int iSignatureIndex);
Default Value
"Unknown"
Remarks
The hash algorithm used for signing.
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
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
SignatureIssuerRDN Property (XAdESSigner Class)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
ANSI (Cross Platform) char* GetSignatureIssuerRDN(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureIssuerRDN(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignatureissuerrdn(void* lpObj, int signatureindex);
QString GetSignatureIssuerRDN(int iSignatureIndex);
Default Value
""
Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
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
SignatureLastArchivalTime Property (XAdESSigner Class)
Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.
Syntax
ANSI (Cross Platform) char* GetSignatureLastArchivalTime(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureLastArchivalTime(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturelastarchivaltime(void* lpObj, int signatureindex);
QString GetSignatureLastArchivalTime(int iSignatureIndex);
Default Value
""
Remarks
Indicates the most recent archival time of an archived signature
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is 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
SignaturePolicyHash Property (XAdESSigner Class)
The signature policy hash value.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyHash(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyHash(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturepolicyhash(void* lpObj, int signatureindex);
QString GetSignaturePolicyHash(int iSignatureIndex);
Default Value
""
Remarks
The signature policy hash value.
Use this property to get the signature policy hash from 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 (XAdESSigner Class)
The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyHashAlgorithm(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyHashAlgorithm(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturepolicyhashalgorithm(void* lpObj, int signatureindex);
QString GetSignaturePolicyHashAlgorithm(int iSignatureIndex);
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from SignaturePolicyHash.
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
SignaturePolicyID Property (XAdESSigner Class)
The policy ID that was included or to be included into the signature.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyID(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyID(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturepolicyid(void* lpObj, int signatureindex);
QString GetSignaturePolicyID(int iSignatureIndex);
Default Value
""
Remarks
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier from 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
SignaturePolicyURI Property (XAdESSigner Class)
The signature policy URI that was included in the signature.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyURI(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyURI(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturepolicyuri(void* lpObj, int signatureindex);
QString GetSignaturePolicyURI(int iSignatureIndex);
Default Value
""
Remarks
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
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
SignatureSerialNumber Property (XAdESSigner Class)
The serial number of the timestamp.
Syntax
ANSI (Cross Platform) int GetSignatureSerialNumber(int iSignatureIndex, char* &lpSignatureSerialNumber, int &lenSignatureSerialNumber); Unicode (Windows) INT GetSignatureSerialNumber(INT iSignatureIndex, LPSTR &lpSignatureSerialNumber, INT &lenSignatureSerialNumber);
int secureblackbox_xadessigner_getsignatureserialnumber(void* lpObj, int signatureindex, char** lpSignatureSerialNumber, int* lenSignatureSerialNumber);
QByteArray GetSignatureSerialNumber(int iSignatureIndex);
Remarks
The serial number of the 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
Byte Array
SignatureSignatureBytes Property (XAdESSigner Class)
Returns the binary representation of the XML-DSig/XAdES signature.
Syntax
ANSI (Cross Platform) int GetSignatureSignatureBytes(int iSignatureIndex, char* &lpSignatureSignatureBytes, int &lenSignatureSignatureBytes); Unicode (Windows) INT GetSignatureSignatureBytes(INT iSignatureIndex, LPSTR &lpSignatureSignatureBytes, INT &lenSignatureSignatureBytes);
int secureblackbox_xadessigner_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);
QByteArray GetSignatureSignatureBytes(int iSignatureIndex);
Remarks
Returns the binary representation of the XML-DSig/XAdES 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
SignatureSignatureType Property (XAdESSigner Class)
The signature type to employ when signing the document.
Syntax
ANSI (Cross Platform) int GetSignatureSignatureType(int iSignatureIndex); Unicode (Windows) INT GetSignatureSignatureType(INT iSignatureIndex);
Possible Values
CXST_DETACHED(1),
CXST_ENVELOPING(2),
CXST_ENVELOPED(4)
int secureblackbox_xadessigner_getsignaturesignaturetype(void* lpObj, int signatureindex);
int GetSignatureSignatureType(int iSignatureIndex);
Default Value
4
Remarks
The signature type to employ when signing the document.
This property specifies the signature type to be used when signing the document.
Supported values:
cxstDetached | 1 | Specifies whether a detached signature should be produced. I.e., a signature which is kept separately from the signed document. |
cxstEnveloping | 2 | Specifies whether an enveloping signature should be produced. |
cxstEnveloped | 4 | Specifies whether an enveloped signature should be produced. |
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
SignatureSignatureValidationResult Property (XAdESSigner Class)
Contains the signature validation result.
Syntax
ANSI (Cross Platform) int GetSignatureSignatureValidationResult(int iSignatureIndex); Unicode (Windows) INT GetSignatureSignatureValidationResult(INT iSignatureIndex);
Possible Values
XSV_VALID(0),
XSV_UNKNOWN(1),
XSV_CORRUPTED(2),
XSV_SIGNER_NOT_FOUND(3),
XSV_FAILURE(4),
XSV_REFERENCE_CORRUPTED(5)
int secureblackbox_xadessigner_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);
int GetSignatureSignatureValidationResult(int iSignatureIndex);
Default Value
0
Remarks
Contains the signature validation result.
Use this property to check the result of the most recent XML signature validation.
xsvValid | 0 | |
xsvUnknown | 1 | |
xsvCorrupted | 2 | |
xsvSignerNotFound | 3 | |
xsvFailure | 4 | |
xsvReferenceCorrupted | 5 |
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
SignatureSubjectKeyID Property (XAdESSigner Class)
Contains the subject key identifier of the signing certificate.
Syntax
ANSI (Cross Platform) int GetSignatureSubjectKeyID(int iSignatureIndex, char* &lpSignatureSubjectKeyID, int &lenSignatureSubjectKeyID); Unicode (Windows) INT GetSignatureSubjectKeyID(INT iSignatureIndex, LPSTR &lpSignatureSubjectKeyID, INT &lenSignatureSubjectKeyID);
int secureblackbox_xadessigner_getsignaturesubjectkeyid(void* lpObj, int signatureindex, char** lpSignatureSubjectKeyID, int* lenSignatureSubjectKeyID);
QByteArray GetSignatureSubjectKeyID(int iSignatureIndex);
Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
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
SignatureSubjectRDN Property (XAdESSigner Class)
Contains information about the person owning the signing certificate.
Syntax
ANSI (Cross Platform) char* GetSignatureSubjectRDN(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureSubjectRDN(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturesubjectrdn(void* lpObj, int signatureindex);
QString GetSignatureSubjectRDN(int iSignatureIndex);
Default Value
""
Remarks
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
Contains the certified signing time.
Syntax
ANSI (Cross Platform) char* GetSignatureValidatedSigningTime(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureValidatedSigningTime(INT iSignatureIndex);
char* secureblackbox_xadessigner_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 (XAdESSigner Class)
Contains the complete log of the certificate validation routine.
Syntax
ANSI (Cross Platform) char* GetSignatureValidationLog(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureValidationLog(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturevalidationlog(void* lpObj, int signatureindex);
QString GetSignatureValidationLog(int iSignatureIndex);
Default Value
""
Remarks
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
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
SignatureXAdES Property (XAdESSigner Class)
Specifies whether the document contains an advanced signature (XAdES).
Syntax
ANSI (Cross Platform) int GetSignatureXAdES(int iSignatureIndex); Unicode (Windows) BOOL GetSignatureXAdES(INT iSignatureIndex);
int secureblackbox_xadessigner_getsignaturexades(void* lpObj, int signatureindex);
bool GetSignatureXAdES(int iSignatureIndex);
Default Value
TRUE
Remarks
Specifies whether the document contains an advanced signature (XAdES).
Use this property to check whether the document is signed with XAdES or XML-DSIG only.
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
SignatureXAdESForm Property (XAdESSigner Class)
Specifies which form of XAdES should be produced.
Syntax
ANSI (Cross Platform) int GetSignatureXAdESForm(int iSignatureIndex); Unicode (Windows) INT GetSignatureXAdESForm(INT iSignatureIndex);
Possible Values
XAF_NONE(0),
XAF_BASIC(1),
XAF_BES(2),
XAF_EPES(3),
XAF_T(4),
XAF_C(5),
XAF_X(6),
XAF_XL(7),
XAF_A(8),
XAF_EXTENDED_BES(9),
XAF_EXTENDED_EPES(10),
XAF_EXTENDED_T(11),
XAF_EXTENDED_C(12),
XAF_EXTENDED_X(13),
XAF_EXTENDED_XLONG(14),
XAF_EXTENDED_XL(15),
XAF_EXTENDED_A(16)
int secureblackbox_xadessigner_getsignaturexadesform(void* lpObj, int signatureindex);
int GetSignatureXAdESForm(int iSignatureIndex);
Default Value
0
Remarks
Specifies which form of XAdES should be produced.
Use this property to specify the form (level) of advanced electronic signature to be produced.
The supported forms are:
xafNone | 0 | None |
xafBasic | 1 | XAdES form, supported by XAdES v1.1.1 |
xafBES | 2 | XAdES-BES form, supported starting from XAdES v1.2.2 |
xafEPES | 3 | XAdES-EPES form, supported starting from XAdES v1.2.2 |
xafT | 4 | XAdES-T form |
xafC | 5 | XAdES-C form |
xafX | 6 | XAdES-X form |
xafXL | 7 | XAdES-X-L form |
xafA | 8 | XAdES-A form |
xafExtendedBES | 9 | XAdES-E-BES form |
xafExtendedEPES | 10 | XAdES-E-EPES form |
xafExtendedT | 11 | XAdES-E-T form |
xafExtendedC | 12 | XAdES-E-C form |
xafExtendedX | 13 | XAdES-E-X form |
xafExtendedXLong | 14 | XAdES-E-X-Long form (type 1) |
xafExtendedXL | 15 | XAdES-E-X-L form (type 2) |
xafExtendedA | 16 | XAdES-E-A form |
* XAdES-E-* forms are supported starting from XAdES v1.3.2
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
SignatureXAdESVersion Property (XAdESSigner Class)
Specifies XAdES version.
Syntax
ANSI (Cross Platform) int GetSignatureXAdESVersion(int iSignatureIndex); Unicode (Windows) INT GetSignatureXAdESVersion(INT iSignatureIndex);
Possible Values
XAV_UNKNOWN(0),
XAV_111(1),
XAV_122(2),
XAV_132(3),
XAV_141(4)
int secureblackbox_xadessigner_getsignaturexadesversion(void* lpObj, int signatureindex);
int GetSignatureXAdESVersion(int iSignatureIndex);
Default Value
3
Remarks
Specifies XAdES version.
This property specifies the version of the XAdES specification the signature should comply with. For the form of XAdES, use XAdESForm.
The supported vesions are:
xavUnknown | 0 | Unknown |
xav111 | 1 | XAdES v1.1.1 |
xav122 | 2 | XAdES v1.2.2 |
xav132 | 3 | XAdES v1.3.2 |
xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |
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
SignatureXMLElement Property (XAdESSigner Class)
Specifies the XML element where to save the signature or containing the signature.
Syntax
ANSI (Cross Platform) char* GetSignatureXMLElement(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureXMLElement(INT iSignatureIndex);
char* secureblackbox_xadessigner_getsignaturexmlelement(void* lpObj, int signatureindex);
QString GetSignatureXMLElement(int iSignatureIndex);
Default Value
""
Remarks
Specifies the XML element where to save the signature or containing the signature.
This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.
Supported values are:
"" | an empty string indicates the Document element |
"#id" | indicates an XML element with specified Id |
XPath expression | indicates an XML element selected using XPath expression. Use XPathNamespaces property to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined in XPathNamespaces property |
Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
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
SigningCertBytes Property (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getsigningcerthandle(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsigningchaincount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketdnsmode(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketdnsport(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketdnsservers(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketlocaladdress(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketlocalport(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsockettimeout(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getsocketuseipv6(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
The number of records in the Timestamp arrays.
Syntax
ANSI (Cross Platform) int GetTimestampCount(); Unicode (Windows) INT GetTimestampCount();
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
Returns the timestamp's hash algorithm.
Syntax
ANSI (Cross Platform) char* GetTimestampHashAlgorithm(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampHashAlgorithm(INT iTimestampIndex);
char* secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
The time point incorporated into the timestamp.
Syntax
ANSI (Cross Platform) char* GetTimestampTime(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampTime(INT iTimestampIndex);
char* secureblackbox_xadessigner_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 (XAdESSigner Class)
Returns the type of the timestamp.
Syntax
ANSI (Cross Platform) int GetTimestampTimestampType(int iTimestampIndex); Unicode (Windows) INT GetTimestampTimestampType(INT iTimestampIndex);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner Class)
Contains the TSA certificate chain validation log.
Syntax
ANSI (Cross Platform) char* GetTimestampValidationLog(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampValidationLog(INT iTimestampIndex);
char* secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_gettimestampserver(void* lpObj);
int secureblackbox_xadessigner_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 which should be used for timestamping the signature.
Data Type
String
TLSClientCertCount Property (XAdESSigner 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_xadessigner_gettlsclientcertcount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
The number of records in the TLSServerCert arrays.
Syntax
ANSI (Cross Platform) int GetTLSServerCertCount(); Unicode (Windows) INT GetTLSServerCertCount();
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsciphersuites(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlseccurves(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsextensions(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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 (XAdESSigner 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 (XAdESSigner 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 (XAdESSigner 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_xadessigner_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsrevocationcheck(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsssloptions(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlstlsmode(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsusesessionresumption(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettlsversions(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_gettrustedcertcount(void* lpObj);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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 (XAdESSigner 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_xadessigner_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_getvalidationmoment(void* lpObj);
int secureblackbox_xadessigner_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
NamespaceCount Property (XAdESSigner Class)
The number of records in the Namespace arrays.
Syntax
ANSI (Cross Platform) int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount); Unicode (Windows) INT GetNamespaceCount();
INT SetNamespaceCount(INT iNamespaceCount);
int secureblackbox_xadessigner_getnamespacecount(void* lpObj);
int secureblackbox_xadessigner_setnamespacecount(void* lpObj, int iNamespaceCount);
int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at NamespaceCount - 1.
This property is not available at design time.
Data Type
Integer
NamespacePrefix Property (XAdESSigner Class)
A user-defined prefix value of a namespace.
Syntax
ANSI (Cross Platform) char* GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, const char* lpszNamespacePrefix); Unicode (Windows) LPWSTR GetNamespacePrefix(INT iNamespaceIndex);
INT SetNamespacePrefix(INT iNamespaceIndex, LPCWSTR lpszNamespacePrefix);
char* secureblackbox_xadessigner_getnamespaceprefix(void* lpObj, int namespaceindex);
int secureblackbox_xadessigner_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);
QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);
Default Value
""
Remarks
A user-defined prefix value of a namespace.
The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.
This property is not available at design time.
Data Type
String
NamespaceURI Property (XAdESSigner Class)
A user-defined URI value of a namespace.
Syntax
ANSI (Cross Platform) char* GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, const char* lpszNamespaceURI); Unicode (Windows) LPWSTR GetNamespaceURI(INT iNamespaceIndex);
INT SetNamespaceURI(INT iNamespaceIndex, LPCWSTR lpszNamespaceURI);
char* secureblackbox_xadessigner_getnamespaceuri(void* lpObj, int namespaceindex);
int secureblackbox_xadessigner_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);
QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);
Default Value
""
Remarks
A user-defined URI value of a namespace.
The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.
This property is not available at design time.
Data Type
String
AddDataReference Method (XAdESSigner Class)
Creates a new XML reference to the specified data.
Syntax
ANSI (Cross Platform) int AddDataReference(const char* lpszDataURI, const char* lpData, int lenData); Unicode (Windows) INT AddDataReference(LPCWSTR lpszDataURI, LPCSTR lpData, INT lenData);
int secureblackbox_xadessigner_adddatareference(void* lpObj, const char* lpszDataURI, const char* lpData, int lenData);
int AddDataReference(const QString& qsDataURI, QByteArray qbaData);
Remarks
Use this method to add a reference to the custom data. Pass the reference's URI via DataURI parameter.
This method uses HashAlgorithm property to specify the hash algorithm of the reference.
The method returns the index of the new reference entry in the References collection.
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.
AddReference Method (XAdESSigner Class)
Creates a new XML reference to the specified XML element.
Syntax
ANSI (Cross Platform) int AddReference(const char* lpszTargetXmlElement, const char* lpszCustomId, int bAutoGenerateId); Unicode (Windows) INT AddReference(LPCWSTR lpszTargetXmlElement, LPCWSTR lpszCustomId, BOOL bAutoGenerateId);
int secureblackbox_xadessigner_addreference(void* lpObj, const char* lpszTargetXmlElement, const char* lpszCustomId, int bAutoGenerateId);
int AddReference(const QString& qsTargetXmlElement, const QString& qsCustomId, bool bAutoGenerateId);
Remarks
Use this method to add a reference to a particular XML element.
The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.
This method uses CanonicalizationMethod and HashAlgorithm properties to specify the canonicalization method and hash algorithm of the reference.
The method returns the index of the new reference entry in the References collection.
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.
AddTimestampValidationData Method (XAdESSigner Class)
Use this method to add timestamp validation data to the signature.
Syntax
ANSI (Cross Platform) int AddTimestampValidationData(int iSigIndex); Unicode (Windows) INT AddTimestampValidationData(INT iSigIndex);
int secureblackbox_xadessigner_addtimestampvalidationdata(void* lpObj, int iSigIndex);
int AddTimestampValidationData(int iSigIndex);
Remarks
Call this method to add certificates and revocation information used to validate timestamp's signer certificates at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.
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.)
AddValidationDataRefs Method (XAdESSigner Class)
Use this method to add signature validation references to the signature.
Syntax
ANSI (Cross Platform) int AddValidationDataRefs(int iSigIndex); Unicode (Windows) INT AddValidationDataRefs(INT iSigIndex);
int secureblackbox_xadessigner_addvalidationdatarefs(void* lpObj, int iSigIndex);
int AddValidationDataRefs(int iSigIndex);
Remarks
Call this method to add references to certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.
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.)
AddValidationDataValues Method (XAdESSigner Class)
Use this method to add signature validation values to the signature.
Syntax
ANSI (Cross Platform) int AddValidationDataValues(int iSigIndex); Unicode (Windows) INT AddValidationDataValues(INT iSigIndex);
int secureblackbox_xadessigner_addvalidationdatavalues(void* lpObj, int iSigIndex);
int AddValidationDataValues(int iSigIndex);
Remarks
Call this method to add certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.
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 (XAdESSigner Class)
Closes an opened document.
Syntax
ANSI (Cross Platform) int Close(int bSaveChanges); Unicode (Windows) INT Close(BOOL bSaveChanges);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_xadessigner_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 (XAdESSigner 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_xadessigner_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;....
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 (XAdESSigner 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_xadessigner_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.
GetInnerXML Method (XAdESSigner Class)
Get the inner XML content of the selected XML element.
Syntax
ANSI (Cross Platform) char* GetInnerXML(const char* lpszXPath); Unicode (Windows) LPWSTR GetInnerXML(LPCWSTR lpszXPath);
char* secureblackbox_xadessigner_getinnerxml(void* lpObj, const char* lpszXPath);
QString GetInnerXML(const QString& qsXPath);
Remarks
Call this method to get the inner XML content of the selected XML element.
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.
GetOuterXML Method (XAdESSigner Class)
Get the outer XML content of the selected XML element.
Syntax
ANSI (Cross Platform) char* GetOuterXML(const char* lpszXPath); Unicode (Windows) LPWSTR GetOuterXML(LPCWSTR lpszXPath);
char* secureblackbox_xadessigner_getouterxml(void* lpObj, const char* lpszXPath);
QString GetOuterXML(const QString& qsXPath);
Remarks
Call this method to get the outer XML content of the selected XML element.
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.
GetTextContent Method (XAdESSigner Class)
Get the text content of the selected XML element.
Syntax
ANSI (Cross Platform) char* GetTextContent(const char* lpszXPath); Unicode (Windows) LPWSTR GetTextContent(LPCWSTR lpszXPath);
char* secureblackbox_xadessigner_gettextcontent(void* lpObj, const char* lpszXPath);
QString GetTextContent(const QString& qsXPath);
Remarks
Call this method to get the text content of the selected XML element.
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.
Open Method (XAdESSigner Class)
Opens a document for signing or updating.
Syntax
ANSI (Cross Platform) int Open(); Unicode (Windows) INT Open();
int secureblackbox_xadessigner_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 (XAdESSigner Class)
Revalidates a signature in accordance with current settings.
Syntax
ANSI (Cross Platform) int Revalidate(int iIndex, int bDetached); Unicode (Windows) INT Revalidate(INT iIndex, BOOL bDetached);
int secureblackbox_xadessigner_revalidate(void* lpObj, int iIndex, int bDetached);
int Revalidate(int iIndex, bool bDetached);
Remarks
Use this method to re-validate a signature in the opened XML 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.)
SetInnerXML Method (XAdESSigner Class)
Set the inner XML content of the selected XML element.
Syntax
ANSI (Cross Platform) int SetInnerXML(const char* lpszXPath, const char* lpszValue); Unicode (Windows) INT SetInnerXML(LPCWSTR lpszXPath, LPCWSTR lpszValue);
int secureblackbox_xadessigner_setinnerxml(void* lpObj, const char* lpszXPath, const char* lpszValue);
int SetInnerXML(const QString& qsXPath, const QString& qsValue);
Remarks
Call this method to set the inner XML content of the selected XML element.
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.)
SetTextContent Method (XAdESSigner Class)
Set the text content of the selected XML element.
Syntax
ANSI (Cross Platform) int SetTextContent(const char* lpszXPath, const char* lpszValue); Unicode (Windows) INT SetTextContent(LPCWSTR lpszXPath, LPCWSTR lpszValue);
int secureblackbox_xadessigner_settextcontent(void* lpObj, const char* lpszXPath, const char* lpszValue);
int SetTextContent(const QString& qsXPath, const QString& qsValue);
Remarks
Call this method to set the text content of the selected XML element.
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 (XAdESSigner Class)
Signs an XML document.
Syntax
ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign();
int secureblackbox_xadessigner_sign(void* lpObj);
int Sign();
Remarks
Call this method to generate a signature over an XML 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.)
SignAsyncBegin Method (XAdESSigner Class)
Initiates the asynchronous signing operation.
Syntax
ANSI (Cross Platform) char* SignAsyncBegin(); Unicode (Windows) LPWSTR SignAsyncBegin();
char* secureblackbox_xadessigner_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.
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 (XAdESSigner Class)
Completes the asynchronous signing operation.
Syntax
ANSI (Cross Platform) int SignAsyncEnd(const char* lpszAsyncReply); Unicode (Windows) INT SignAsyncEnd(LPCWSTR lpszAsyncReply);
int secureblackbox_xadessigner_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 (XAdESSigner Class)
Signs the document using an external signing facility.
Syntax
ANSI (Cross Platform) int SignExternal(); Unicode (Windows) INT SignExternal();
int secureblackbox_xadessigner_signexternal(void* lpObj);
int SignExternal();
Remarks
Call this method to delegate 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 hash is computed, the class fires ExternalSign event which allows to pass the hash value 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.)
Timestamp Method (XAdESSigner Class)
Use this method to add an timestamp.
Syntax
ANSI (Cross Platform) int Timestamp(int iSigIndex, int iTimestampType); Unicode (Windows) INT Timestamp(INT iSigIndex, INT iTimestampType);
int secureblackbox_xadessigner_timestamp(void* lpObj, int iSigIndex, int iTimestampType);
int Timestamp(int iSigIndex, int iTimestampType);
Remarks
Call this method to timestamp the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. This method could be called separately or in SignatureValidated event handler after successful signature validation. Use the TimestampType parameter to specify the type of timestamp to create
Supported timestamp types:
tstSignature | 12 | Signature timestamp |
tstRefsOnly | 13 | RefsOnly timestamp |
tstSigAndRefs | 14 | SigAndRefs timestamp |
tstArchive | 7 | Archive timestamp |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Upgrade Method (XAdESSigner Class)
Upgrades existing XAdES signature to a new form.
Syntax
ANSI (Cross Platform) int Upgrade(int iSigIndex, int iToForm); Unicode (Windows) INT Upgrade(INT iSigIndex, INT iToForm);
int secureblackbox_xadessigner_upgrade(void* lpObj, int iSigIndex, int iToForm);
int Upgrade(int iSigIndex, int iToForm);
Remarks
XAdES standard defines a number of different 'forms' of signatures which can be used for different purposes. Use this method to upgrade XAdES signature to a new form specified by ToForm. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, C, X, X-L, A).
The supported forms are:
xafNone | 0 | None |
xafBasic | 1 | XAdES form, supported by XAdES v1.1.1 |
xafBES | 2 | XAdES-BES form, supported starting from XAdES v1.2.2 |
xafEPES | 3 | XAdES-EPES form, supported starting from XAdES v1.2.2 |
xafT | 4 | XAdES-T form |
xafC | 5 | XAdES-C form |
xafX | 6 | XAdES-X form |
xafXL | 7 | XAdES-X-L form |
xafA | 8 | XAdES-A form |
xafExtendedBES | 9 | XAdES-E-BES form |
xafExtendedEPES | 10 | XAdES-E-EPES form |
xafExtendedT | 11 | XAdES-E-T form |
xafExtendedC | 12 | XAdES-E-C form |
xafExtendedX | 13 | XAdES-E-X form |
xafExtendedXLong | 14 | XAdES-E-X-Long form (type 1) |
xafExtendedXL | 15 | XAdES-E-X-L form (type 2) |
xafExtendedA | 16 | XAdES-E-A form |
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 (XAdESSigner Class)
Fires when there is a need to download a chain element from an online source.
Syntax
ANSI (Cross Platform) virtual int FireChainElementDownload(XAdESSignerChainElementDownloadEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN;
const char *Location;
int Action; int reserved; } XAdESSignerChainElementDownloadEventParams;
Unicode (Windows) virtual INT FireChainElementDownload(XAdESSignerChainElementDownloadEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
LPCWSTR Location;
INT Action; INT reserved; } XAdESSignerChainElementDownloadEventParams;
#define EID_XADESSIGNER_CHAINELEMENTDOWNLOAD 1 virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);
class XAdESSignerChainElementDownloadEventParams { 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(XAdESSignerChainElementDownloadEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireChainElementDownload(XAdESSignerChainElementDownloadEventParams *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 (XAdESSigner Class)
Fires when an element required to validate the chain was not located.
Syntax
ANSI (Cross Platform) virtual int FireChainElementNeeded(XAdESSignerChainElementNeededEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN; int reserved; } XAdESSignerChainElementNeededEventParams;
Unicode (Windows) virtual INT FireChainElementNeeded(XAdESSignerChainElementNeededEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN; INT reserved; } XAdESSignerChainElementNeededEventParams;
#define EID_XADESSIGNER_CHAINELEMENTNEEDED 2 virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);
class XAdESSignerChainElementNeededEventParams { 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(XAdESSignerChainElementNeededEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireChainElementNeeded(XAdESSignerChainElementNeededEventParams *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.
ChainElementStore Event (XAdESSigner Class)
This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
Syntax
ANSI (Cross Platform) virtual int FireChainElementStore(XAdESSignerChainElementStoreEventParams *e);
typedef struct {
int Kind;
const char *Body; int lenBody;
char *URI; int reserved; } XAdESSignerChainElementStoreEventParams;
Unicode (Windows) virtual INT FireChainElementStore(XAdESSignerChainElementStoreEventParams *e);
typedef struct {
INT Kind;
LPCSTR Body; INT lenBody;
LPWSTR URI; INT reserved; } XAdESSignerChainElementStoreEventParams;
#define EID_XADESSIGNER_CHAINELEMENTSTORE 3 virtual INT SECUREBLACKBOX_CALL FireChainElementStore(INT &iKind, LPSTR &lpBody, INT &lenBody, LPSTR &lpszURI);
class XAdESSignerChainElementStoreEventParams { public: int Kind(); const QByteArray &Body(); const QString &URI(); void SetURI(const QString &qsURI); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainElementStore(XAdESSignerChainElementStoreEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireChainElementStore(XAdESSignerChainElementStoreEventParams *e) {...}
Remarks
This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.
ChainValidated Event (XAdESSigner Class)
Reports the completion of a certificate chain validation.
Syntax
ANSI (Cross Platform) virtual int FireChainValidated(XAdESSignerChainValidatedEventParams *e);
typedef struct {
int Index;
const char *SubjectRDN;
int ValidationResult;
int ValidationDetails; int reserved; } XAdESSignerChainValidatedEventParams;
Unicode (Windows) virtual INT FireChainValidated(XAdESSignerChainValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR SubjectRDN;
INT ValidationResult;
INT ValidationDetails; INT reserved; } XAdESSignerChainValidatedEventParams;
#define EID_XADESSIGNER_CHAINVALIDATED 4 virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails);
class XAdESSignerChainValidatedEventParams { 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(XAdESSignerChainValidatedEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireChainValidated(XAdESSignerChainValidatedEventParams *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 (XAdESSigner 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(XAdESSignerChainValidationProgressEventParams *e);
typedef struct {
const char *EventKind;
const char *CertRDN;
const char *CACertRDN;
int Action; int reserved; } XAdESSignerChainValidationProgressEventParams;
Unicode (Windows) virtual INT FireChainValidationProgress(XAdESSignerChainValidationProgressEventParams *e);
typedef struct {
LPCWSTR EventKind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
INT Action; INT reserved; } XAdESSignerChainValidationProgressEventParams;
#define EID_XADESSIGNER_CHAINVALIDATIONPROGRESS 5 virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);
class XAdESSignerChainValidationProgressEventParams { 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(XAdESSignerChainValidationProgressEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireChainValidationProgress(XAdESSignerChainValidationProgressEventParams *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 (XAdESSigner Class)
This event is fired when the document has been loaded into memory.
Syntax
ANSI (Cross Platform) virtual int FireDocumentLoaded(XAdESSignerDocumentLoadedEventParams *e);
typedef struct {
int Cancel; int reserved; } XAdESSignerDocumentLoadedEventParams;
Unicode (Windows) virtual INT FireDocumentLoaded(XAdESSignerDocumentLoadedEventParams *e);
typedef struct {
BOOL Cancel; INT reserved; } XAdESSignerDocumentLoadedEventParams;
#define EID_XADESSIGNER_DOCUMENTLOADED 6 virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);
class XAdESSignerDocumentLoadedEventParams { 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(XAdESSignerDocumentLoadedEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireDocumentLoaded(XAdESSignerDocumentLoadedEventParams *e) {...}
Remarks
The handler for this event is a good place to check document properties, which may be useful when preparing the signature, for example, the document format.
Set Cancel to true to terminate document processing on this stage.
Error Event (XAdESSigner Class)
Information about errors during signing.
Syntax
ANSI (Cross Platform) virtual int FireError(XAdESSignerErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } XAdESSignerErrorEventParams;
Unicode (Windows) virtual INT FireError(XAdESSignerErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } XAdESSignerErrorEventParams;
#define EID_XADESSIGNER_ERROR 7 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class XAdESSignerErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(XAdESSignerErrorEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireError(XAdESSignerErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during signing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to XML.
ExternalSign Event (XAdESSigner Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
ANSI (Cross Platform) virtual int FireExternalSign(XAdESSignerExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } XAdESSignerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(XAdESSignerExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } XAdESSignerExternalSignEventParams;
#define EID_XADESSIGNER_EXTERNALSIGN 8 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class XAdESSignerExternalSignEventParams { 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(XAdESSignerExternalSignEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireExternalSign(XAdESSignerExternalSignEventParams *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();
};
FormatElement Event (XAdESSigner Class)
Reports the XML element that is currently being processed.
Syntax
ANSI (Cross Platform) virtual int FireFormatElement(XAdESSignerFormatElementEventParams *e);
typedef struct {
char *StartTagWhitespace;
char *EndTagWhitespace;
int Level;
const char *Path;
int HasChildElements; int reserved; } XAdESSignerFormatElementEventParams;
Unicode (Windows) virtual INT FireFormatElement(XAdESSignerFormatElementEventParams *e);
typedef struct {
LPWSTR StartTagWhitespace;
LPWSTR EndTagWhitespace;
INT Level;
LPCWSTR Path;
BOOL HasChildElements; INT reserved; } XAdESSignerFormatElementEventParams;
#define EID_XADESSIGNER_FORMATELEMENT 9 virtual INT SECUREBLACKBOX_CALL FireFormatElement(LPSTR &lpszStartTagWhitespace, LPSTR &lpszEndTagWhitespace, INT &iLevel, LPSTR &lpszPath, BOOL &bHasChildElements);
class XAdESSignerFormatElementEventParams { public: const QString &StartTagWhitespace(); void SetStartTagWhitespace(const QString &qsStartTagWhitespace); const QString &EndTagWhitespace(); void SetEndTagWhitespace(const QString &qsEndTagWhitespace); int Level(); const QString &Path(); bool HasChildElements(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FormatElement(XAdESSignerFormatElementEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireFormatElement(XAdESSignerFormatElementEventParams *e) {...}
Remarks
Path and Level specify the path to the XML element being processed and its nesting level, respectively.
HasChildElements specify if processed XML element has child elements.
Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.
FormatText Event (XAdESSigner Class)
Reports XML text that is currently being processed.
Syntax
ANSI (Cross Platform) virtual int FireFormatText(XAdESSignerFormatTextEventParams *e);
typedef struct {
char *Text;
int TextType;
int Level;
const char *Path; int reserved; } XAdESSignerFormatTextEventParams;
Unicode (Windows) virtual INT FireFormatText(XAdESSignerFormatTextEventParams *e);
typedef struct {
LPWSTR Text;
INT TextType;
INT Level;
LPCWSTR Path; INT reserved; } XAdESSignerFormatTextEventParams;
#define EID_XADESSIGNER_FORMATTEXT 10 virtual INT SECUREBLACKBOX_CALL FireFormatText(LPSTR &lpszText, INT &iTextType, INT &iLevel, LPSTR &lpszPath);
class XAdESSignerFormatTextEventParams { public: const QString &Text(); void SetText(const QString &qsText); int TextType(); int Level(); const QString &Path(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FormatText(XAdESSignerFormatTextEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireFormatText(XAdESSignerFormatTextEventParams *e) {...}
Remarks
TextType parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; Path and Level specify the path to the XML element and its nesting level.
Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.
Notification Event (XAdESSigner Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(XAdESSignerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } XAdESSignerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(XAdESSignerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } XAdESSignerNotificationEventParams;
#define EID_XADESSIGNER_NOTIFICATION 11 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class XAdESSignerNotificationEventParams { 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(XAdESSignerNotificationEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireNotification(XAdESSignerNotificationEventParams *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:
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. |
ReferenceValidated Event (XAdESSigner Class)
Marks the end of a reference validation.
Syntax
ANSI (Cross Platform) virtual int FireReferenceValidated(XAdESSignerReferenceValidatedEventParams *e);
typedef struct {
int ReferenceIndex;
const char *ID;
const char *URI;
const char *RefType;
int DigestValid; int reserved; } XAdESSignerReferenceValidatedEventParams;
Unicode (Windows) virtual INT FireReferenceValidated(XAdESSignerReferenceValidatedEventParams *e);
typedef struct {
INT ReferenceIndex;
LPCWSTR ID;
LPCWSTR URI;
LPCWSTR RefType;
BOOL DigestValid; INT reserved; } XAdESSignerReferenceValidatedEventParams;
#define EID_XADESSIGNER_REFERENCEVALIDATED 12 virtual INT SECUREBLACKBOX_CALL FireReferenceValidated(INT &iReferenceIndex, LPSTR &lpszID, LPSTR &lpszURI, LPSTR &lpszRefType, BOOL &bDigestValid);
class XAdESSignerReferenceValidatedEventParams { public: int ReferenceIndex(); const QString &ID(); const QString &URI(); const QString &RefType(); bool DigestValid(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReferenceValidated(XAdESSignerReferenceValidatedEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireReferenceValidated(XAdESSignerReferenceValidatedEventParams *e) {...}
Remarks
The class fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.
ResolveReference Event (XAdESSigner Class)
Asks the application to resolve a reference.
Syntax
ANSI (Cross Platform) virtual int FireResolveReference(XAdESSignerResolveReferenceEventParams *e);
typedef struct {
int ReferenceIndex;
const char *URI; int reserved; } XAdESSignerResolveReferenceEventParams;
Unicode (Windows) virtual INT FireResolveReference(XAdESSignerResolveReferenceEventParams *e);
typedef struct {
INT ReferenceIndex;
LPCWSTR URI; INT reserved; } XAdESSignerResolveReferenceEventParams;
#define EID_XADESSIGNER_RESOLVEREFERENCE 13 virtual INT SECUREBLACKBOX_CALL FireResolveReference(INT &iReferenceIndex, LPSTR &lpszURI);
class XAdESSignerResolveReferenceEventParams { public: int ReferenceIndex(); const QString &URI(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResolveReference(XAdESSignerResolveReferenceEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireResolveReference(XAdESSignerResolveReferenceEventParams *e) {...}
Remarks
This event is fired when the control could not automatically resolve a reference and requires custom treatment.
URI contains a reference to the data.
ReferenceIndex specifies the index of the reference to process.
Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.
SignatureFound Event (XAdESSigner Class)
Signifies the start of signature validation.
Syntax
ANSI (Cross Platform) virtual int FireSignatureFound(XAdESSignerSignatureFoundEventParams *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; } XAdESSignerSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(XAdESSignerSignatureFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateSignature;
BOOL ValidateChain; INT reserved; } XAdESSignerSignatureFoundEventParams;
#define EID_XADESSIGNER_SIGNATUREFOUND 14 virtual INT SECUREBLACKBOX_CALL FireSignatureFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class XAdESSignerSignatureFoundEventParams { 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(XAdESSignerSignatureFoundEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireSignatureFound(XAdESSignerSignatureFoundEventParams *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 (XAdESSigner Class)
Marks the completion of the signature validation routine.
Syntax
ANSI (Cross Platform) virtual int FireSignatureValidated(XAdESSignerSignatureValidatedEventParams *e);
typedef struct {
int Index;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult; int reserved; } XAdESSignerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(XAdESSignerSignatureValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult; INT reserved; } XAdESSignerSignatureValidatedEventParams;
#define EID_XADESSIGNER_SIGNATUREVALIDATED 15 virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);
class XAdESSignerSignatureValidatedEventParams { 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(XAdESSignerSignatureValidatedEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireSignatureValidated(XAdESSignerSignatureValidatedEventParams *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 (XAdESSigner Class)
Signifies the start of a timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampFound(XAdESSignerTimestampFoundEventParams *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; } XAdESSignerTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(XAdESSignerTimestampFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateTimestamp;
BOOL ValidateChain; INT reserved; } XAdESSignerTimestampFoundEventParams;
#define EID_XADESSIGNER_TIMESTAMPFOUND 16 virtual INT SECUREBLACKBOX_CALL FireTimestampFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class XAdESSignerTimestampFoundEventParams { 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(XAdESSignerTimestampFoundEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTimestampFound(XAdESSignerTimestampFoundEventParams *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 (XAdESSigner Class)
Fires when the class is ready to request a timestamp from an external TSA.
Syntax
ANSI (Cross Platform) virtual int FireTimestampRequest(XAdESSignerTimestampRequestEventParams *e);
typedef struct {
const char *TSA;
const char *TimestampRequest;
char *TimestampResponse;
int SuppressDefault; int reserved; } XAdESSignerTimestampRequestEventParams;
Unicode (Windows) virtual INT FireTimestampRequest(XAdESSignerTimestampRequestEventParams *e);
typedef struct {
LPCWSTR TSA;
LPCWSTR TimestampRequest;
LPWSTR TimestampResponse;
BOOL SuppressDefault; INT reserved; } XAdESSignerTimestampRequestEventParams;
#define EID_XADESSIGNER_TIMESTAMPREQUEST 17 virtual INT SECUREBLACKBOX_CALL FireTimestampRequest(LPSTR &lpszTSA, LPSTR &lpszTimestampRequest, LPSTR &lpszTimestampResponse, BOOL &bSuppressDefault);
class XAdESSignerTimestampRequestEventParams { 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(XAdESSignerTimestampRequestEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTimestampRequest(XAdESSignerTimestampRequestEventParams *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 (XAdESSigner Class)
Reports the completion of the timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampValidated(XAdESSignerTimestampValidatedEventParams *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; } XAdESSignerTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(XAdESSignerTimestampValidatedEventParams *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; } XAdESSignerTimestampValidatedEventParams;
#define EID_XADESSIGNER_TIMESTAMPVALIDATED 18 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 XAdESSignerTimestampValidatedEventParams { 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(XAdESSignerTimestampValidatedEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTimestampValidated(XAdESSignerTimestampValidatedEventParams *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 (XAdESSigner Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(XAdESSignerTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } XAdESSignerTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(XAdESSignerTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } XAdESSignerTLSCertNeededEventParams;
#define EID_XADESSIGNER_TLSCERTNEEDED 19 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class XAdESSignerTLSCertNeededEventParams { 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(XAdESSignerTLSCertNeededEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTLSCertNeeded(XAdESSignerTLSCertNeededEventParams *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 (XAdESSigner 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(XAdESSignerTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } XAdESSignerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(XAdESSignerTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } XAdESSignerTLSCertValidateEventParams;
#define EID_XADESSIGNER_TLSCERTVALIDATE 20 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class XAdESSignerTLSCertValidateEventParams { 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(XAdESSignerTLSCertValidateEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTLSCertValidate(XAdESSignerTLSCertValidateEventParams *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 (XAdESSigner Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(XAdESSignerTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } XAdESSignerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(XAdESSignerTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } XAdESSignerTLSEstablishedEventParams;
#define EID_XADESSIGNER_TLSESTABLISHED 21 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class XAdESSignerTLSEstablishedEventParams { 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(XAdESSignerTLSEstablishedEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTLSEstablished(XAdESSignerTLSEstablishedEventParams *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 (XAdESSigner Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(XAdESSignerTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } XAdESSignerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(XAdESSignerTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } XAdESSignerTLSHandshakeEventParams;
#define EID_XADESSIGNER_TLSHANDSHAKE 22 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class XAdESSignerTLSHandshakeEventParams { 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(XAdESSignerTLSHandshakeEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTLSHandshake(XAdESSignerTLSHandshakeEventParams *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 (XAdESSigner Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(XAdESSignerTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } XAdESSignerTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(XAdESSignerTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } XAdESSignerTLSShutdownEventParams;
#define EID_XADESSIGNER_TLSSHUTDOWN 23 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class XAdESSignerTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(XAdESSignerTLSShutdownEventParams *e);
// Or, subclass XAdESSigner and override this emitter function. virtual int FireTLSShutdown(XAdESSignerTLSShutdownEventParams *e) {...}
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
Config Settings (XAdESSigner 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.XAdESSigner Config Settings
If this property is set to True, the all data objects timestamp (xades:AllDataObjectsTimeStamp element) will be added.
Use this property to specify the text of the first claimed role.
Use this property to specify the XML content of the claimed roles element.
This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.
Returns the number of the xades:CommitmentTypeIndication elements available.
This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.
This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.
This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.
This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.
This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.
This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.
Returns the number of the xades:DataObjectFormat elements available.
This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element.
This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element.
This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element.
This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element.
This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element.
This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element.
This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element.
This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.
For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.
Index value could be omitted for the first DataObjectFormat element.
Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.
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).
In case of enveloping signature, this property contains the Encoding attribute of the enveloped object.
In case of enveloping signature, this property contains the identifier (ID) attribute of the enveloped object.
In case of enveloping signature, this property contains the MIME type attribute of the enveloped object.
Specifies the prefix for the ec:InclusiveNamespaces element for the exclusive canonicalization.
Default value is "ec". In this case "ec:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain 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). 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.
Sets the HMAC key. The component uses base16 (hex) encoding for this configuration value.
Use this property to configure the length of the HMAC output, in bytes.
This property contains the custom name of identifier (ID) attribute. Used to identify the target XML element when reference URI has "#id_name" value or when ID attribute should be auto-generated for a target XML element.
This property contains the custom namespace URI of identifier (ID) attribute. Used to identify the target XML element when reference URI has "#id_name" value or when ID attribute should be auto-generated for a target XML element.
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.
If this property is set to True, any failure during time-stamping process will be ignored.
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.
Set this property to True to include the public part of the signing key to the signature.
Set this property to True if the key value (its public part) should be included to the signature.
This property specifies whether revocation pieces provided via 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.
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.
Use this property to specify the type of the input (either InputFile, InputStream or InputBytes properties) for class. The following input types are supported:
"" or "XML" | an XML document (by default). | |
"data" | a binary data. | |
"base64" | Base64 encoded binary data (input data will be encoded in Base64 and will be placed in ds:Object for Enveloping signature type) |
Enveloped signature type supports only an XML document as the input. | |
Enveloping signature type supports all types of the input. | |
Detached signature type supports an XML document and a binary data as the input. |
Use this property to specify XML element before which the signature should be inserted.
Supported values are:
"" | an empty string indicates the Document element |
"#id" | indicates an XML element with specified Id |
XPath expression | indicates an XML element selected using XPath expression. Use XPathNamespaces property to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined in XPathNamespaces property |
Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
Use this property to specify the custom XML content of the ds:KeyInfo element.
The empty elements in the custom XML content act as a placeholder for auto-generated elements.
For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>"
Contains a comma-separated list of values that specifies which signing key info details to include to the signature.
Supported values are:
certificate | Base64-encoded [X509v3] certificate is placed to the signature | |
issuerserial | X.509 issuer distinguished name/serial number pair are placed to the signature | |
subjectname | X.509 subject distinguished name is placed to the signature | |
ski | Base64 encoded plain (i.e. non-DER-encoded) value of a X509 V.3 SubjectKeyIdentifier extension is placed to the signature | |
crl | Base64-encoded certificate revocation list (CRL) is placed to the signature |
This property contains the identifier (ID) attribute of the ds:KeyInfo element.
The KeyName element contains a string value (with significant whitespaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.
Returns the number of the ds:Manifest elements available.
Use this property to specify the identifier (ID) attribute of the ds:Manifest element. Index value could be omitted for the first manifest.
Use this property to specify the ds:Object element index to which the ds:Manifest element belongs. Index value could be omitted for the first signature properties.
Use this property to specify the XML content of the ds:Manifest element. Index value could be omitted for the first manifest.
Returns the number of the additional ds:Object elements available.
Use this property to specify the Encoding attribute of the ds:Object element. Index value could be omitted for the first object.
Use this property to specify the identifier (ID) attribute of the ds:Object element. Index value could be omitted for the first object.
Use this property to specify the MIME type attribute of the ds:Object element. Index value could be omitted for the first object.
Returns the number of the ds:SignatureProperties elements available.
Use this property to specify the identifier (ID) attribute of the ds:SignatureProperties element. Index value could be omitted for the first signature properties.
Use this property to specify the ds:Object element index to which the ds:SignatureProperties element belongs. Index value could be omitted for the first signature properties.
Use this property to specify the XML content of the ds:SignatureProperties element. Index value could be omitted for the first signature properties.
Returns the number of the ds:SignatureProperty elements available.
Use this property to specify the identifier (ID) attribute of the ds:SignatureProperty element. Index value could be omitted for the first signature property.
Use this property to specify the ds:SignatureProperties element index to which the ds:SignatureProperty element belongs. Index value could be omitted for the first signature property.
Use this property to specify the Target attribute of the ds:SignatureProperty element. Index value could be omitted for the first signature property.
Use this property to specify the XML content of the ds:SignatureProperty element. Index value could be omitted for the first signature property.
Use this property to specify the XML content of the ds:Object element. Index value could be omitted for the first object.
Use this property to specify the signature production place.
Sample value: "CITY=Test City, ST=Test State, POSTALCODE=Test Code, C=Test Country"
Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.
This property contains the identifier (ID) attribute of the xades:QualifyingProperties element.
This property contains the identifier (ID) attribute of the ds:Object element that contains xades:QualifyingProperties element.
Returns the number of the xades:QualifyingPropertiesReference elements available.
This property contains an identifier (ID) attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.
This property contains an URI attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.
Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.
Supported values are:
SigAndRefs | SigAndRefs timestamp | |
RefsOnly | RefsOnly timestamp |
Use this property to specify whether the signature is W3C's XMLDSig, or Electronic Banking Internet Communication Standard (EBICS) compliant.
Supported values are:
"" | The same as "XML-DSig". | |
XML-DSig | The W3C's XMLDSig-compliant signature (by default). | |
EBICS | Electronic Banking Internet Communication Standard (EBICS) compliant signature. On signing the version is autodetected based on the document element. | |
EBICS_H3 | Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H3. | |
EBICS_H4 | Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H4. | |
EBICS_H5 | Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H5. |
This property contains the identifier (ID) attribute of the ds:Signature element.
Specifies the prefix for the Signature elements.
Default value is "ds". In this case "ds:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
This property contains the text content of the ds:SignatureValue element.
This property contains the identifier (ID) attribute of the ds:SignatureValue element.
This property contains the identifier (ID) attribute of the ds:SignedInfo element.
This property contains the identifier (ID) attribute of the xades:SignedProperties element.
Use this property to specify the canonicalization method for the canonicalization transform of the ds:Reference element that points to xades:SignedProperties element. Use cxcmNone value to not to include canonicalization transform in transform chain.
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
Use this property to specify the hash algorithm to be used for the ds:Reference element that points to xades:SignedProperties element.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
This property contains the identifier (ID) attribute of the ds:Reference element that points to xades:SignedProperties element.
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the ds:Reference element that points to xades:SignedProperties element.
Use this property to specify the reference's index for the ds:Reference element that points to xades:SignedProperties element.
This property contains the identifier (ID) attribute of the xades:SignedSignatureProperties element.
Use this property to specify the hash algorithm to be used for xades:SigningCertificates element.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
This property specifies the Description of the signature policy.
Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.
This property contains the hash value of the signature policy.
Use this property to specify the algorithm used to compute the signature policy hash.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
This property contains an identifier that uniquely identifies a specific version of the signature policy.
This property provides an access to the list of notice numbers, by which the explicit signature policy notice texts could be retrieved.
Use this property to specify the "organization" part of the NoticeReference signature policy qualifier for XAdES-EPES form.
This property specifies the URI of the signature policy.
This setting specifies an absolute path to the location on disk where temporary files are stored.
Use this property to specify the canonicalization method used in timestamp.
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.
Supported values are:
certificate | Base64-encoded [X509v3] certificates | |
crl | Base64-encoded certificate revocation lists (CRL) | |
ocsp | OCSP responses |
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 default configuration class uses the 'SHA256' hash algorithm. 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).
Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.
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.
Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.
Supported values are:
certificate | References to X.509 certificates | |
crl | References to certificate revocation lists (CRL) | |
ocsp | References to OCSP responses |
Use this property to specify the hash algorithm used to compute hashes for validation data references.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
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_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.
Supported values are:
certificate | Base64-encoded [X509v3] certificates | |
crl | Base64-encoded certificate revocation lists (CRL) | |
ocsp | OCSP responses |
Set this property to False to disable writing byte-order mark (BOM) when saving the XML document in Unicode encoding.
Specifies the prefix for the XAdES elements.
Default value is "xades". In this case "xades:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Specifies the prefix for the XAdES v1.4.1 elements.
Default value is "xadesv141". In this case "xadesv141:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Use this property to specify how the signature should be formatted.
Supported values:
"" or "none" | no formatting (by default). | |
"auto" | enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node" |
indent | specifies indentation level (default is 1) | |
indent-char | specifies indentation character: "space" or "tab" (default) | |
base64-max-length | specifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64) | |
starting-level | specifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node"). | |
indent-before-main | specifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no" |
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 (XAdESSigner 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.
XAdESSigner 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) | |
39845889 Input file does not exist (SB_ERROR_XML_INPUTFILE_NOT_EXISTS) | |
39845890 Data file does not exist (SB_ERROR_XML_DATAFILE_NOT_EXISTS) | |
39845891 Unsupported signature method type (SB_ERROR_XML_UNSUPPORTED_SIGNATURE_METHOD_TYPE) | |
39845892 Unsupported has algorithm (SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM) | |
39845893 Unsupported key type (SB_ERROR_XML_UNSUPPORTED_KEY_TYPE) | |
39845894 Invalid key type (SB_ERROR_XML_INVALID_KEY_TYPE) | |
39845895 Invalid encryption method (SB_ERROR_XML_INVALID_ENCRYPTION_METHOD) | |
39845896 Not found (SB_ERROR_XML_NOT_FOUND) | |
39845897 No element ID (SB_ERROR_XML_NO_ELEMENT_ID) |