JAdESSigner Class
Properties Methods Events Config Settings Errors
The JAdESSigner class signs Javascript content electronically.
Syntax
JAdESSigner
Remarks
JAdESSigner supports a range of digital signature formats over Javascript content, including JSON Web Signatures (JWS) and ETSI JSON Advanced Electronic Signatures (JAdES).
Standards and technologies supported
JAdESSigner can create signatures that match the following standards:
- Generic JSON Web Signatures (JWS) (RFC7515)
- JAdES: all profiles are supported (BES, EPES, T, LTV, B-B, B-T, and others) (ETSI TS 119 182-1)
- Timestamps using external TSAs.
- All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).
Configuring the signature spec
JWS and JAdES signatures can come in all sorts of flavours, with the primary factors being the signature format (how exactly the signed data is represented in bytes) and completeness (the extent of the trust information that is included in the signature). You can use the properties of your JAdESSigner object to configure these and other parameters. Typically, the service or software that you need to communicate with will provide you with a list of requirements that your JSON signature needs to satisfy. In some cases, they will also send you an example signature that you may use as a guide.
Typically, you will need to adjust the following categories of settings:
- Level (plain JWS, B, T, LT, or LTA). This can be adjusted with the property.
- Timestamp requirement: provide the address of your online TSA service via TimestampServer property.
- When creating LT/LTA signatures, tune up validation parameters via RevocationCheck, OfflineMode, and IgnoreChainValidationErrors properties.
- Configure the signature representation parameters such as CompactForm, Detached or FlattenedSignature.
The above are the most important settings from each category; you may need to adjust more specific settings, such as EPES policy parameters (such as ) or ContentType, to fine-tune your signature.
Signing certificates
JAdESSigner 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), system stores/keychains, 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 or less interoperable media can be communicated with the external signing feature (see below).
Use CertificateManager and CertificateStorage components to load the signing certificate. Assign the certificate to SigningCertificate property, and optionally provide the remainder of its chain via the SigningChain property.
In the default configuration, JAdESSigner will do its best to collect the trust elements (certificates, CRLs, OCSP responses) required by the chosen signature level automatically. It will use all available sources, including the system stores, the chain validation cache, and the signature itself (when upgrading an existing signature). However, there can be situations where only some (or even none) of the trust elements are available in the public locations. This is particularly the case for internal, experimental, or test PKI environments. In such cases you might need to locate the missing elements manually and provide them to JAdESSigner via the KnownCertificates, KnownCRLs, and KnownOCSPs properties. You can also provide any trust anchors not included in the public Trusted Root directory via the TrustedCertificates collection.
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.
Signing the JSON
Now that you have configured the signature and certificate settings, you can proceed to signing. You can provide the JSON input in one of the following forms: as a file (assign the path to InputFile property), as a stream (assign to InputStream property), as a string (InputString), 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 or OutputString property after the signing.
Having set up the input and output, 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. when creating a B-level signature), or it may involve advanced chain validation routines (LT or LTA). During the latter the component contacts a number of external trust information sources (CA, 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 JAdESSigner may fire events to let your code know of certain conditions. It may fire TLSCertValidate if one of the HTTP endpoints involved during the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate chain to be validated.
External signing and DCAuth
JAdESSigner, like many other components included in 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 scenario best.
Synchronous method: ExternalSign
This is a simpler method that basically lets you infiltrate into 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 included in the hash calculation.
This method is synchronous, meaning SignExternal provides you the results immediately upon its completion.
Asynchronous method: DCAuth
DCAuth is a SecureBlackbox know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way:
- The signing party - such as JAdESSigner - initiates the operation using SignAsyncBegin call. This produces two outcomes: a pre-signed content (a JSON body with a blank signature placeholder), and a request state (an object containing a hash that needs to be signed). At this point the JAdESSigner 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 signing controls, and passes the response state, together with the pre-signed content, to the signer's SignAsyncEnd method. SignAsyncEnd extracts the signature from the response state and incorporates it into the pre-signed object, hereby completing the signature.
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 JSON opened. |
| BlockedCertCount | The number of records in the BlockedCert arrays. |
| BlockedCertBytes | Returns the raw certificate data in DER format. |
| BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CertCount | The number of records in the Cert arrays. |
| CertBytes | Returns the raw certificate data in DER format. |
| CertCA | Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension). |
| CertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| CertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| CertCurve | Specifies the elliptic curve of the EC public key. |
| CertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| CertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| CertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| CertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| CertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| CertKeyBits | Returns the length of the public key. |
| CertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| CertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| CertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| CertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| CertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| CertPublicKeyBytes | Contains the certificate's public key in DER format. |
| CertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| CertSerialNumber | Returns the certificate's serial number. |
| CertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| CertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| CertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| CertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| CertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| CertValidTo | The time point at which the certificate expires, in UTC. |
| CompactForm | Specifies if the JWS compact serialization to be used. |
| ContentType | Specifies payload content type. |
| 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 a payload or an object data to class in the byte array form. |
| DataFile | A path to a file containing a payload or an object data. |
| DataString | Use this property to pass a payload or an object data to class in the string form. |
| Detached | Specifies whether a detached signature should be produced or verified. |
| 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. |
| ExtractPayload | Specifies whether a payload should be extracted. |
| FIPSMode | Reserved. |
| FlattenedSignature | Specifies if the flattened signature to be used. |
| 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 file to be signed. |
| InputString | Use this property to pass the input to class in the string form. |
| 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. |
| 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. |
| NewSigContentType | Specifies payload content type. |
| NewSigCountersigned | Indicates if the signature is countersigned. |
| NewSigHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| NewSigHashAlgorithm | Specifies the hash algorithm to be used. |
| NewSigIssuerRDN | The Relative Distinguished Name of the signing certificate's issuer. |
| NewSigJAdESVersion | Specifies JAdES version. |
| 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. |
| NewSigLevel | Specifies the signature kind and level. |
| NewSigObjectType | Specifies signature object content type. |
| NewSigParentSignatureIndex | Returns the index of the parent signature, if applicable. |
| 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 JSON/JAdES signature. |
| NewSigSignatureValidationResult | The outcome of the cryptographic signature validation. |
| NewSigSignedData | The sigD header parameter in JSON format that was included or to be included into the signature. |
| NewSigSignedDataType | Specifies the type of signed data. |
| 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. |
| 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 | Defines where to save the signature. |
| OutputString | Use this property to read the output the class object has produced. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| ProxyAddress | The IP address of the proxy server. |
| ProxyAuthentication | The authentication type used by the proxy server. |
| ProxyPassword | The password to authenticate to the proxy server. |
| ProxyPort | The port on the proxy server to connect to. |
| ProxyProxyType | The type of the proxy server. |
| ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| ProxyUseProxy | Enables or disables proxy-driven connection. |
| ProxyUsername | Specifies the username credential for proxy authentication. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| SignatureCount | The number of records in the Signature arrays. |
| 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. |
| SignatureContentType | Specifies payload content type. |
| SignatureCountersigned | Indicates if the signature is countersigned. |
| SignatureHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SignatureHashAlgorithm | Specifies the hash algorithm to be used. |
| SignatureIssuerRDN | The Relative Distinguished Name of the signing certificate's issuer. |
| SignatureJAdESVersion | Specifies JAdES version. |
| 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. |
| SignatureLevel | Specifies the signature kind and level. |
| SignatureObjectType | Specifies signature object content type. |
| SignatureParentSignatureIndex | Returns the index of the parent signature, if applicable. |
| 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 JSON/JAdES signature. |
| SignatureSignatureValidationResult | The outcome of the cryptographic signature validation. |
| SignatureSignedData | The sigD header parameter in JSON format that was included or to be included into the signature. |
| SignatureSignedDataType | Specifies the type of signed data. |
| 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. |
| 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. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddSignedHTTPHeaderField | Use this method to add HTTP header field. |
| AddSignedObject | Use this method to add an object. |
| AddSignedObjectHash | Use this method to add an object hash. |
| 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 JWS/JAdES signature. |
| Config | Sets or retrieves a configuration setting. |
| CreateNew | Create a new JSON for signing. |
| DoAction | Performs an additional action. |
| ExtractAsyncData | Extracts user data from the DC signing service response. |
| Open | Opens a JSON for signing or updating. |
| Revalidate | Revalidates a signature in accordance with current settings. |
| Sign | Creates a new JAdES/JWS signature over the provided data. |
| SignAsyncBegin | Initiates the asynchronous signing operation. |
| SignAsyncEnd | Completes the asynchronous signing operation. |
| SignExternal | Signs the data using an external signing facility. |
| Timestamp | Use this method to add timestamp. |
| Upgrade | Upgrades existing JAdES signature to a new level. |
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. |
| Error | Information about errors during signing. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| HTTPHeaderFieldNeeded | This event is fired when HTTP header field value is required. |
| Loaded | This event is fired when the JSON has been loaded into memory. |
| Notification | This event notifies the application about an underlying control flow event. |
| ObjectNeeded | This event is fired when object is required. |
| ObjectValidate | This event is fired when object should be verified by user. |
| 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.
| AddSignedDataTimestamp | Whether to add signed data timestamp during signing. |
| CertThumbprint | Specifies the certificate thumbprint. |
| CertURL | Specifies the certificate URL. |
| DataBase64 | Specifies whether data is Base64-URL-encoded. |
| 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. |
| 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. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
| JAdESOptions | Specifies the JAdES options. |
| KeyId | Specifies Key ID. |
| PolicyDescription | signature policy description. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| ProtectedHeader | Specifies the protected header. |
| SchemeParams | The algorithm scheme parameters to employ. |
| SignerAttrs | Identifies the signer attributes. |
| SignerCommitments | Identifies the signer commitments. |
| SigningCertIncludeIssuerSerial | Specifies whether to include signing certificate issuer and serial number. |
| SigningCertIncludeThumbprint | Specifies whether to include signing certificate thumbprint. |
| SigningCertIncludeValue | Specifies whether to include signing certificate value. |
| SigningChainIncludeThumbprints | Specifies whether to include signing chain thumbprints. |
| SigningChainIncludeValue | Specifies whether to include signing chain values. |
| TempPath | Location where the temporary files are stored. |
| ThumbprintHashAlgorithm | Specifies the thumbprint hash algorithm. |
| TimestampResponse | A base16-encoded timestamp response received from a TSA. |
| 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. |
| UnprotectedHeader | Specifies the unprotected header. |
| 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. |
| 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. |
| 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 (JAdESSigner Class)
Specifies whether class should validate any present signatures when the JSON opened.
Syntax
ANSI (Cross Platform) int GetAutoValidateSignatures();
int SetAutoValidateSignatures(int bAutoValidateSignatures); Unicode (Windows) BOOL GetAutoValidateSignatures();
INT SetAutoValidateSignatures(BOOL bAutoValidateSignatures);
int secureblackbox_jadessigner_getautovalidatesignatures(void* lpObj);
int secureblackbox_jadessigner_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 JSON processing. Even if the JWS/JAdES signature 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 (JAdESSigner 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_jadessigner_getblockedcertcount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_jadessigner_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is not available at design time.
Data Type
Long64
CertCount Property (JAdESSigner Class)
The number of records in the Cert arrays.
Syntax
ANSI (Cross Platform) int GetCertCount(); Unicode (Windows) INT GetCertCount();
int secureblackbox_jadessigner_getcertcount(void* lpObj);
int GetCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- CertBytes
- CertCA
- CertCAKeyID
- CertCRLDistributionPoints
- CertCurve
- CertFingerprint
- CertFriendlyName
- CertHandle
- CertHashAlgorithm
- CertIssuer
- CertIssuerRDN
- CertKeyAlgorithm
- CertKeyBits
- CertKeyFingerprint
- CertKeyUsage
- CertKeyValid
- CertOCSPLocations
- CertPolicyIDs
- CertPublicKeyBytes
- CertSelfSigned
- CertSerialNumber
- CertSigAlgorithm
- CertSubject
- CertSubjectKeyID
- CertSubjectRDN
- CertValidFrom
- CertValidTo
The array indices start at 0 and end at CertCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
CertBytes Property (JAdESSigner Class)
Returns the raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetCertBytes(int iCertIndex, char* &lpCertBytes, int &lenCertBytes); Unicode (Windows) INT GetCertBytes(INT iCertIndex, LPSTR &lpCertBytes, INT &lenCertBytes);
int secureblackbox_jadessigner_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
QByteArray GetCertBytes(int iCertIndex);
Remarks
Returns the raw certificate data in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertCA Property (JAdESSigner Class)
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
Syntax
ANSI (Cross Platform) int GetCertCA(int iCertIndex); Unicode (Windows) BOOL GetCertCA(INT iCertIndex);
int secureblackbox_jadessigner_getcertca(void* lpObj, int certindex);
bool GetCertCA(int iCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertCAKeyID Property (JAdESSigner Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
ANSI (Cross Platform) int GetCertCAKeyID(int iCertIndex, char* &lpCertCAKeyID, int &lenCertCAKeyID); Unicode (Windows) INT GetCertCAKeyID(INT iCertIndex, LPSTR &lpCertCAKeyID, INT &lenCertCAKeyID);
int secureblackbox_jadessigner_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
QByteArray GetCertCAKeyID(int iCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertCRLDistributionPoints Property (JAdESSigner Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
ANSI (Cross Platform) char* GetCertCRLDistributionPoints(int iCertIndex); Unicode (Windows) LPWSTR GetCertCRLDistributionPoints(INT iCertIndex);
char* secureblackbox_jadessigner_getcertcrldistributionpoints(void* lpObj, int certindex);
QString GetCertCRLDistributionPoints(int iCertIndex);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertCurve Property (JAdESSigner Class)
Specifies the elliptic curve of the EC public key.
Syntax
ANSI (Cross Platform) char* GetCertCurve(int iCertIndex); Unicode (Windows) LPWSTR GetCertCurve(INT iCertIndex);
char* secureblackbox_jadessigner_getcertcurve(void* lpObj, int certindex);
QString GetCertCurve(int iCertIndex);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertFingerprint Property (JAdESSigner Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
ANSI (Cross Platform) int GetCertFingerprint(int iCertIndex, char* &lpCertFingerprint, int &lenCertFingerprint); Unicode (Windows) INT GetCertFingerprint(INT iCertIndex, LPSTR &lpCertFingerprint, INT &lenCertFingerprint);
int secureblackbox_jadessigner_getcertfingerprint(void* lpObj, int certindex, char** lpCertFingerprint, int* lenCertFingerprint);
QByteArray GetCertFingerprint(int iCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertFriendlyName Property (JAdESSigner Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
ANSI (Cross Platform) char* GetCertFriendlyName(int iCertIndex); Unicode (Windows) LPWSTR GetCertFriendlyName(INT iCertIndex);
char* secureblackbox_jadessigner_getcertfriendlyname(void* lpObj, int certindex);
QString GetCertFriendlyName(int iCertIndex);
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertHandle Property (JAdESSigner Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetCertHandle(int iCertIndex); Unicode (Windows) LONG64 GetCertHandle(INT iCertIndex);
int64 secureblackbox_jadessigner_getcerthandle(void* lpObj, int certindex);
qint64 GetCertHandle(int iCertIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Long64
CertHashAlgorithm Property (JAdESSigner Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
ANSI (Cross Platform) char* GetCertHashAlgorithm(int iCertIndex); Unicode (Windows) LPWSTR GetCertHashAlgorithm(INT iCertIndex);
char* secureblackbox_jadessigner_getcerthashalgorithm(void* lpObj, int certindex);
QString GetCertHashAlgorithm(int iCertIndex);
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertIssuer Property (JAdESSigner Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetCertIssuer(int iCertIndex); Unicode (Windows) LPWSTR GetCertIssuer(INT iCertIndex);
char* secureblackbox_jadessigner_getcertissuer(void* lpObj, int certindex);
QString GetCertIssuer(int iCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertIssuerRDN Property (JAdESSigner Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
ANSI (Cross Platform) char* GetCertIssuerRDN(int iCertIndex); Unicode (Windows) LPWSTR GetCertIssuerRDN(INT iCertIndex);
char* secureblackbox_jadessigner_getcertissuerrdn(void* lpObj, int certindex);
QString GetCertIssuerRDN(int iCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertKeyAlgorithm Property (JAdESSigner Class)
Specifies the public key algorithm of this certificate.
Syntax
ANSI (Cross Platform) char* GetCertKeyAlgorithm(int iCertIndex); Unicode (Windows) LPWSTR GetCertKeyAlgorithm(INT iCertIndex);
char* secureblackbox_jadessigner_getcertkeyalgorithm(void* lpObj, int certindex);
QString GetCertKeyAlgorithm(int iCertIndex);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertKeyBits Property (JAdESSigner Class)
Returns the length of the public key.
Syntax
ANSI (Cross Platform) int GetCertKeyBits(int iCertIndex); Unicode (Windows) INT GetCertKeyBits(INT iCertIndex);
int secureblackbox_jadessigner_getcertkeybits(void* lpObj, int certindex);
int GetCertKeyBits(int iCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Integer
CertKeyFingerprint Property (JAdESSigner Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
ANSI (Cross Platform) int GetCertKeyFingerprint(int iCertIndex, char* &lpCertKeyFingerprint, int &lenCertKeyFingerprint); Unicode (Windows) INT GetCertKeyFingerprint(INT iCertIndex, LPSTR &lpCertKeyFingerprint, INT &lenCertKeyFingerprint);
int secureblackbox_jadessigner_getcertkeyfingerprint(void* lpObj, int certindex, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);
QByteArray GetCertKeyFingerprint(int iCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertKeyUsage Property (JAdESSigner Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
ANSI (Cross Platform) int GetCertKeyUsage(int iCertIndex); Unicode (Windows) INT GetCertKeyUsage(INT iCertIndex);
int secureblackbox_jadessigner_getcertkeyusage(void* lpObj, int certindex);
int GetCertKeyUsage(int iCertIndex);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Integer
CertKeyValid Property (JAdESSigner Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
ANSI (Cross Platform) int GetCertKeyValid(int iCertIndex); Unicode (Windows) BOOL GetCertKeyValid(INT iCertIndex);
int secureblackbox_jadessigner_getcertkeyvalid(void* lpObj, int certindex);
bool GetCertKeyValid(int iCertIndex);
Default Value
FALSE
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertOCSPLocations Property (JAdESSigner Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
ANSI (Cross Platform) char* GetCertOCSPLocations(int iCertIndex); Unicode (Windows) LPWSTR GetCertOCSPLocations(INT iCertIndex);
char* secureblackbox_jadessigner_getcertocsplocations(void* lpObj, int certindex);
QString GetCertOCSPLocations(int iCertIndex);
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertPolicyIDs Property (JAdESSigner Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
ANSI (Cross Platform) char* GetCertPolicyIDs(int iCertIndex); Unicode (Windows) LPWSTR GetCertPolicyIDs(INT iCertIndex);
char* secureblackbox_jadessigner_getcertpolicyids(void* lpObj, int certindex);
QString GetCertPolicyIDs(int iCertIndex);
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertPublicKeyBytes Property (JAdESSigner Class)
Contains the certificate's public key in DER format.
Syntax
ANSI (Cross Platform) int GetCertPublicKeyBytes(int iCertIndex, char* &lpCertPublicKeyBytes, int &lenCertPublicKeyBytes); Unicode (Windows) INT GetCertPublicKeyBytes(INT iCertIndex, LPSTR &lpCertPublicKeyBytes, INT &lenCertPublicKeyBytes);
int secureblackbox_jadessigner_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
QByteArray GetCertPublicKeyBytes(int iCertIndex);
Remarks
Contains the certificate's public key in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSelfSigned Property (JAdESSigner Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
ANSI (Cross Platform) int GetCertSelfSigned(int iCertIndex); Unicode (Windows) BOOL GetCertSelfSigned(INT iCertIndex);
int secureblackbox_jadessigner_getcertselfsigned(void* lpObj, int certindex);
bool GetCertSelfSigned(int iCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertSerialNumber Property (JAdESSigner Class)
Returns the certificate's serial number.
Syntax
ANSI (Cross Platform) int GetCertSerialNumber(int iCertIndex, char* &lpCertSerialNumber, int &lenCertSerialNumber); Unicode (Windows) INT GetCertSerialNumber(INT iCertIndex, LPSTR &lpCertSerialNumber, INT &lenCertSerialNumber);
int secureblackbox_jadessigner_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
QByteArray GetCertSerialNumber(int iCertIndex);
Remarks
Returns the certificate's serial number.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSigAlgorithm Property (JAdESSigner Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
ANSI (Cross Platform) char* GetCertSigAlgorithm(int iCertIndex); Unicode (Windows) LPWSTR GetCertSigAlgorithm(INT iCertIndex);
char* secureblackbox_jadessigner_getcertsigalgorithm(void* lpObj, int certindex);
QString GetCertSigAlgorithm(int iCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertSubject Property (JAdESSigner Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
ANSI (Cross Platform) char* GetCertSubject(int iCertIndex); Unicode (Windows) LPWSTR GetCertSubject(INT iCertIndex);
char* secureblackbox_jadessigner_getcertsubject(void* lpObj, int certindex);
QString GetCertSubject(int iCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertSubjectKeyID Property (JAdESSigner Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
ANSI (Cross Platform) int GetCertSubjectKeyID(int iCertIndex, char* &lpCertSubjectKeyID, int &lenCertSubjectKeyID); Unicode (Windows) INT GetCertSubjectKeyID(INT iCertIndex, LPSTR &lpCertSubjectKeyID, INT &lenCertSubjectKeyID);
int secureblackbox_jadessigner_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
QByteArray GetCertSubjectKeyID(int iCertIndex);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSubjectRDN Property (JAdESSigner Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
ANSI (Cross Platform) char* GetCertSubjectRDN(int iCertIndex); Unicode (Windows) LPWSTR GetCertSubjectRDN(INT iCertIndex);
char* secureblackbox_jadessigner_getcertsubjectrdn(void* lpObj, int certindex);
QString GetCertSubjectRDN(int iCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertValidFrom Property (JAdESSigner Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
ANSI (Cross Platform) char* GetCertValidFrom(int iCertIndex); Unicode (Windows) LPWSTR GetCertValidFrom(INT iCertIndex);
char* secureblackbox_jadessigner_getcertvalidfrom(void* lpObj, int certindex);
QString GetCertValidFrom(int iCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertValidTo Property (JAdESSigner Class)
The time point at which the certificate expires, in UTC.
Syntax
ANSI (Cross Platform) char* GetCertValidTo(int iCertIndex); Unicode (Windows) LPWSTR GetCertValidTo(INT iCertIndex);
char* secureblackbox_jadessigner_getcertvalidto(void* lpObj, int certindex);
QString GetCertValidTo(int iCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CompactForm Property (JAdESSigner Class)
Specifies if the JWS compact serialization to be used.
Syntax
ANSI (Cross Platform) int GetCompactForm();
int SetCompactForm(int bCompactForm); Unicode (Windows) BOOL GetCompactForm();
INT SetCompactForm(BOOL bCompactForm);
int secureblackbox_jadessigner_getcompactform(void* lpObj);
int secureblackbox_jadessigner_setcompactform(void* lpObj, int bCompactForm);
bool GetCompactForm();
int SetCompactForm(bool bCompactForm);
Default Value
FALSE
Remarks
When this property is set to "true" value, the JAdES component will use the JWS compact serialization format when saving a signature.
The JWS compact serialization format is a compact, Url safe representation of a JWS (JSON Web Signature) or JWE (JSON Web Encryption) object, used for transmitting security tokens.
The JWS compact serialization format supports only one signature without unprotected header (only JWS or JAdES BaselineB signature).
Data Type
Boolean
ContentType Property (JAdESSigner Class)
Specifies payload content type.
Syntax
ANSI (Cross Platform) char* GetContentType();
int SetContentType(const char* lpszContentType); Unicode (Windows) LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);
char* secureblackbox_jadessigner_getcontenttype(void* lpObj);
int secureblackbox_jadessigner_setcontenttype(void* lpObj, const char* lpszContentType);
QString GetContentType();
int SetContentType(QString qsContentType);
Default Value
""
Remarks
Use this property to indicate the content type of the JWS Payload.
This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json".
It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'.
Data Type
String
CRLCount Property (JAdESSigner Class)
The number of records in the CRL arrays.
Syntax
ANSI (Cross Platform) int GetCRLCount(); Unicode (Windows) INT GetCRLCount();
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Use this property to pass a payload or an object 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_jadessigner_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_jadessigner_setdatabytes(void* lpObj, const char* lpDataBytes, int lenDataBytes);
QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);
Remarks
Assign a byte array containing a JWS payload or an object data to be processed to this property.
This property is not available at design time.
Data Type
Byte Array
DataFile Property (JAdESSigner Class)
A path to a file containing a payload or an object data.
Syntax
ANSI (Cross Platform) char* GetDataFile();
int SetDataFile(const char* lpszDataFile); Unicode (Windows) LPWSTR GetDataFile();
INT SetDataFile(LPCWSTR lpszDataFile);
char* secureblackbox_jadessigner_getdatafile(void* lpObj);
int secureblackbox_jadessigner_setdatafile(void* lpObj, const char* lpszDataFile);
QString GetDataFile();
int SetDataFile(QString qsDataFile);
Default Value
""
Remarks
Use this property to provide a JWS payload or an object data to be processed.
Data Type
String
DataString Property (JAdESSigner Class)
Use this property to pass a payload or an object data to class in the string form.
Syntax
ANSI (Cross Platform) char* GetDataString();
int SetDataString(const char* lpszDataString); Unicode (Windows) LPWSTR GetDataString();
INT SetDataString(LPCWSTR lpszDataString);
char* secureblackbox_jadessigner_getdatastring(void* lpObj);
int secureblackbox_jadessigner_setdatastring(void* lpObj, const char* lpszDataString);
QString GetDataString();
int SetDataString(QString qsDataString);
Default Value
""
Remarks
Assign a string containing a JWS payload or an object data to be processed to this property.
This property is not available at design time.
Data Type
String
Detached Property (JAdESSigner Class)
Specifies whether a detached signature should be produced or verified.
Syntax
ANSI (Cross Platform) int GetDetached();
int SetDetached(int bDetached); Unicode (Windows) BOOL GetDetached();
INT SetDetached(BOOL bDetached);
int secureblackbox_jadessigner_getdetached(void* lpObj);
int secureblackbox_jadessigner_setdetached(void* lpObj, int bDetached);
bool GetDetached();
int SetDetached(bool bDetached);
Default Value
FALSE
Remarks
Use this property to specify whether a detached signature should be produced or verified.
When this property is set to "true" value, the JWS payload will be detached from the signature and may either be a single detached object or the result of concatenating multiple detached data objects. In other words, the JWS payload and the signature are stored in separate objects.
If this property is set to "true" value, the user must provide the detached content via the DataFile or DataStream or DataBytes or DataString properties.
When Detached is set to "false" value, the JWS payload is included with the signature as a single object.
Data Type
Boolean
ExternalCryptoAsyncDocumentID Property (JAdESSigner 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_jadessigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptodata(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptomode(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_jadessigner_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
ExtractPayload Property (JAdESSigner Class)
Specifies whether a payload should be extracted.
Syntax
ANSI (Cross Platform) int GetExtractPayload();
int SetExtractPayload(int bExtractPayload); Unicode (Windows) BOOL GetExtractPayload();
INT SetExtractPayload(BOOL bExtractPayload);
int secureblackbox_jadessigner_getextractpayload(void* lpObj);
int secureblackbox_jadessigner_setextractpayload(void* lpObj, int bExtractPayload);
bool GetExtractPayload();
int SetExtractPayload(bool bExtractPayload);
Default Value
FALSE
Remarks
Use this property to specify whether a payload should be extracted when signature loaded. This applies only to non-detached signatures with a payload.
When this property is set to "true" value, the JWS payload will be extracted from the signature.
The user must provide the OutputFile or OutputStream properties with a filename or stream where to save the payload, if none is provided then payload is returned via OutputBytes or OutputString properties.
Data Type
Boolean
FIPSMode Property (JAdESSigner Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_jadessigner_getfipsmode(void* lpObj);
int secureblackbox_jadessigner_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
FlattenedSignature Property (JAdESSigner Class)
Specifies if the flattened signature to be used.
Syntax
ANSI (Cross Platform) int GetFlattenedSignature();
int SetFlattenedSignature(int bFlattenedSignature); Unicode (Windows) BOOL GetFlattenedSignature();
INT SetFlattenedSignature(BOOL bFlattenedSignature);
int secureblackbox_jadessigner_getflattenedsignature(void* lpObj);
int secureblackbox_jadessigner_setflattenedsignature(void* lpObj, int bFlattenedSignature);
bool GetFlattenedSignature();
int SetFlattenedSignature(bool bFlattenedSignature);
Default Value
TRUE
Remarks
This property determines whether to use the flattened JWS JSON serialization format. This format is optimized for the single digital signature case and flattens the general JWS JSON serialization syntax by removing the "signatures" member and instead placing the "protected", "header", and "signature" members at the top-level JSON object (at the same level as the "payload" member).
When the FlattenedSignature property is set to "true" value, the signature will be represented using the flattened JWS JSON serialization format, but it is only applicable when there is a single signature involved.
When the property is set to "false" value, the signature will be represented using the general JWS JSON serialization format.
Data Type
Boolean
IgnoreChainValidationErrors Property (JAdESSigner 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_jadessigner_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_jadessigner_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 (JAdESSigner Class)
The file to be signed.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_jadessigner_getinputfile(void* lpObj);
int secureblackbox_jadessigner_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
Provide the path to the JSON to be signed.
Data Type
String
InputString Property (JAdESSigner Class)
Use this property to pass the input to class in the string form.
Syntax
ANSI (Cross Platform) char* GetInputString();
int SetInputString(const char* lpszInputString); Unicode (Windows) LPWSTR GetInputString();
INT SetInputString(LPCWSTR lpszInputString);
char* secureblackbox_jadessigner_getinputstring(void* lpObj);
int secureblackbox_jadessigner_setinputstring(void* lpObj, const char* lpszInputString);
QString GetInputString();
int SetInputString(QString qsInputString);
Default Value
""
Remarks
Assign a string containing the data to be processed to this property.
This property is not available at design time.
Data Type
String
KnownCertCount Property (JAdESSigner 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_jadessigner_getknowncertcount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getknowncrlcount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getknownocspcount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_jadessigner_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
NewSigCertificateIndex Property (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetNewSigChainValidationDetails(); Unicode (Windows) INT GetNewSigChainValidationDetails();
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getnewsigclaimedsigningtime(void* lpObj);
int secureblackbox_jadessigner_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
NewSigContentType Property (JAdESSigner Class)
Specifies payload content type.
Syntax
ANSI (Cross Platform) char* GetNewSigContentType();
int SetNewSigContentType(const char* lpszNewSigContentType); Unicode (Windows) LPWSTR GetNewSigContentType();
INT SetNewSigContentType(LPCWSTR lpszNewSigContentType);
char* secureblackbox_jadessigner_getnewsigcontenttype(void* lpObj);
int secureblackbox_jadessigner_setnewsigcontenttype(void* lpObj, const char* lpszNewSigContentType);
QString GetNewSigContentType();
int SetNewSigContentType(QString qsNewSigContentType);
Default Value
""
Remarks
Specifies payload content type.
Use this property to indicate the content type of the JWS Payload.
This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json".
It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'.
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
NewSigCountersigned Property (JAdESSigner Class)
Indicates if the signature is countersigned.
Syntax
ANSI (Cross Platform) int GetNewSigCountersigned(); Unicode (Windows) BOOL GetNewSigCountersigned();
int secureblackbox_jadessigner_getnewsigcountersigned(void* lpObj);
bool GetNewSigCountersigned();
Default Value
FALSE
Remarks
Indicates if the signature is countersigned.
Use this property to find out whether the JWS/JAdES signature contains any countersignatures over the main signature(s).
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
NewSigHandle Property (JAdESSigner 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_jadessigner_getnewsighandle(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner Class)
Specifies the hash algorithm to be used.
Syntax
ANSI (Cross Platform) char* GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(const char* lpszNewSigHashAlgorithm); Unicode (Windows) LPWSTR GetNewSigHashAlgorithm();
INT SetNewSigHashAlgorithm(LPCWSTR lpszNewSigHashAlgorithm);
char* secureblackbox_jadessigner_getnewsighashalgorithm(void* lpObj);
int secureblackbox_jadessigner_setnewsighashalgorithm(void* lpObj, const char* lpszNewSigHashAlgorithm);
QString GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(QString qsNewSigHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used.
Supported values:
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| 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 (JAdESSigner Class)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
ANSI (Cross Platform) char* GetNewSigIssuerRDN(); Unicode (Windows) LPWSTR GetNewSigIssuerRDN();
char* secureblackbox_jadessigner_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
NewSigJAdESVersion Property (JAdESSigner Class)
Specifies JAdES version.
Syntax
ANSI (Cross Platform) int GetNewSigJAdESVersion();
int SetNewSigJAdESVersion(int iNewSigJAdESVersion); Unicode (Windows) INT GetNewSigJAdESVersion();
INT SetNewSigJAdESVersion(INT iNewSigJAdESVersion);
Possible Values
JAV_UNKNOWN(0),
JAV_111(1)
int secureblackbox_jadessigner_getnewsigjadesversion(void* lpObj);
int secureblackbox_jadessigner_setnewsigjadesversion(void* lpObj, int iNewSigJAdESVersion);
int GetNewSigJAdESVersion();
int SetNewSigJAdESVersion(int iNewSigJAdESVersion);
Default Value
1
Remarks
Specifies JAdES version.
This property specifies the version of the JAdES specification the signature should comply with.
The supported values are:
| javUnknown | 0 | Unknown |
| jav111 | 1 | JAdES v1.1.1 |
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
NewSigLastArchivalTime Property (JAdESSigner 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_jadessigner_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
NewSigLevel Property (JAdESSigner Class)
Specifies the signature kind and level.
Syntax
ANSI (Cross Platform) int GetNewSigLevel();
int SetNewSigLevel(int iNewSigLevel); Unicode (Windows) INT GetNewSigLevel();
INT SetNewSigLevel(INT iNewSigLevel);
Possible Values
JASL_JWS(0),
JASL_BASELINE_B(1),
JASL_BASELINE_T(2),
JASL_BASELINE_LT(3),
JASL_BASELINE_LTA(4)
int secureblackbox_jadessigner_getnewsiglevel(void* lpObj);
int secureblackbox_jadessigner_setnewsiglevel(void* lpObj, int iNewSigLevel);
int GetNewSigLevel();
int SetNewSigLevel(int iNewSigLevel);
Default Value
1
Remarks
Specifies the signature kind and level.
The supported values are:
| jaslJWS | 0 | JSON Web Signature (JWS) |
| jaslBaselineB | 1 | Baseline B (B-B, basic) |
| jaslBaselineT | 2 | Baseline T (B-T, timestamped) |
| jaslBaselineLT | 3 | Baseline LT (B-LT, long-term) |
| jaslBaselineLTA | 4 | Baseline LTA (B-LTA, long-term with archived 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 not available at design time.
Data Type
Integer
NewSigObjectType Property (JAdESSigner Class)
Specifies signature object content type.
Syntax
ANSI (Cross Platform) char* GetNewSigObjectType();
int SetNewSigObjectType(const char* lpszNewSigObjectType); Unicode (Windows) LPWSTR GetNewSigObjectType();
INT SetNewSigObjectType(LPCWSTR lpszNewSigObjectType);
char* secureblackbox_jadessigner_getnewsigobjecttype(void* lpObj);
int secureblackbox_jadessigner_setnewsigobjecttype(void* lpObj, const char* lpszNewSigObjectType);
QString GetNewSigObjectType();
int SetNewSigObjectType(QString qsNewSigObjectType);
Default Value
"jose+json"
Remarks
Specifies signature object content type.
Use this property to specify the content type of the signature object.
It is used by the application to differentiate between different types of objects that might be present in an application data structure containing a JWS or JAdES.
The default value is "jose+json" which indicates that it is a JWS or JAdES using the JWS JSON Serialization, and "jose" which indicates that the object is a JWS or JAdES using the JWS Compact Serialization. Other type values can also be used by the application.
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
NewSigParentSignatureIndex Property (JAdESSigner Class)
Returns the index of the parent signature, if applicable.
Syntax
ANSI (Cross Platform) int GetNewSigParentSignatureIndex();
int SetNewSigParentSignatureIndex(int iNewSigParentSignatureIndex); Unicode (Windows) INT GetNewSigParentSignatureIndex();
INT SetNewSigParentSignatureIndex(INT iNewSigParentSignatureIndex);
int secureblackbox_jadessigner_getnewsigparentsignatureindex(void* lpObj);
int secureblackbox_jadessigner_setnewsigparentsignatureindex(void* lpObj, int iNewSigParentSignatureIndex);
int GetNewSigParentSignatureIndex();
int SetNewSigParentSignatureIndex(int iNewSigParentSignatureIndex);
Default Value
-1
Remarks
Returns the index of the parent signature, if applicable.
Use this property to establish the index of the associated parent signature object in the signature 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 not available at design time.
Data Type
Integer
NewSigPolicyHash Property (JAdESSigner 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_jadessigner_getnewsigpolicyhash(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getnewsigpolicyhashalgorithm(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getnewsigpolicyid(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getnewsigpolicyuri(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Returns the binary representation of the JSON/JAdES signature.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureBytes(char* &lpNewSigSignatureBytes, int &lenNewSigSignatureBytes); Unicode (Windows) INT GetNewSigSignatureBytes(LPSTR &lpNewSigSignatureBytes, INT &lenNewSigSignatureBytes);
int secureblackbox_jadessigner_getnewsigsignaturebytes(void* lpObj, char** lpNewSigSignatureBytes, int* lenNewSigSignatureBytes);
QByteArray GetNewSigSignatureBytes();
Remarks
Returns the binary representation of the JSON/JAdES 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
NewSigSignatureValidationResult Property (JAdESSigner Class)
The outcome of the cryptographic signature validation.
Syntax
ANSI (Cross Platform) int GetNewSigSignatureValidationResult(); Unicode (Windows) INT GetNewSigSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_jadessigner_getnewsigsignaturevalidationresult(void* lpObj);
int GetNewSigSignatureValidationResult();
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only and not available at design time.
Data Type
Integer
NewSigSignedData Property (JAdESSigner Class)
The sigD header parameter in JSON format that was included or to be included into the signature.
Syntax
ANSI (Cross Platform) char* GetNewSigSignedData();
int SetNewSigSignedData(const char* lpszNewSigSignedData); Unicode (Windows) LPWSTR GetNewSigSignedData();
INT SetNewSigSignedData(LPCWSTR lpszNewSigSignedData);
char* secureblackbox_jadessigner_getnewsigsigneddata(void* lpObj);
int secureblackbox_jadessigner_setnewsigsigneddata(void* lpObj, const char* lpszNewSigSignedData);
QString GetNewSigSignedData();
int SetNewSigSignedData(QString qsNewSigSignedData);
Default Value
""
Remarks
The sigD header parameter in JSON format that was included or to be included into the signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is not available at design time.
Data Type
String
NewSigSignedDataType Property (JAdESSigner Class)
Specifies the type of signed data.
Syntax
ANSI (Cross Platform) int GetNewSigSignedDataType();
int SetNewSigSignedDataType(int iNewSigSignedDataType); Unicode (Windows) INT GetNewSigSignedDataType();
INT SetNewSigSignedDataType(INT iNewSigSignedDataType);
Possible Values
JASDT_PAYLOAD(0),
JASDT_HTTP_HEADERS(1),
JASDT_OBJECT_ID_BY_URI(2),
JASDT_OBJECT_ID_BY_URIHASH(3),
JASDT_CUSTOM(4)
int secureblackbox_jadessigner_getnewsigsigneddatatype(void* lpObj);
int secureblackbox_jadessigner_setnewsigsigneddatatype(void* lpObj, int iNewSigSignedDataType);
int GetNewSigSignedDataType();
int SetNewSigSignedDataType(int iNewSigSignedDataType);
Default Value
0
Remarks
Specifies the type of signed data.
Supported values:
| jasdtPayload | 0 | JWS Payload |
| jasdtHttpHeaders | 1 | HttpHeaders mechanism |
| jasdtObjectIdByURI | 2 | ObjectIdByURI mechanism |
| jasdtObjectIdByURIHash | 3 | ObjectIdByURIHash mechanism |
| jasdtCustom | 4 | Custom mechanism |
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
NewSigSubjectKeyID Property (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Contains information about the person owning the signing certificate.
Syntax
ANSI (Cross Platform) char* GetNewSigSubjectRDN(); Unicode (Windows) LPWSTR GetNewSigSubjectRDN();
char* secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Contains the certified signing time.
Syntax
ANSI (Cross Platform) char* GetNewSigValidatedSigningTime(); Unicode (Windows) LPWSTR GetNewSigValidatedSigningTime();
char* secureblackbox_jadessigner_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 (JAdESSigner Class)
Contains the complete log of the certificate validation routine.
Syntax
ANSI (Cross Platform) char* GetNewSigValidationLog(); Unicode (Windows) LPWSTR GetNewSigValidationLog();
char* secureblackbox_jadessigner_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
OCSPCount Property (JAdESSigner Class)
The number of records in the OCSP arrays.
Syntax
ANSI (Cross Platform) int GetOCSPCount(); Unicode (Windows) INT GetOCSPCount();
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
The location of the OCSP responder.
Syntax
ANSI (Cross Platform) char* GetOCSPLocation(int iOCSPIndex); Unicode (Windows) LPWSTR GetOCSPLocation(INT iOCSPIndex);
char* secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getofflinemode(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Defines where to save the signature.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_jadessigner_getoutputfile(void* lpObj);
int secureblackbox_jadessigner_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
Specifies the path where the JWS/JAdES signature should be saved.
Data Type
String
OutputString Property (JAdESSigner Class)
Use this property to read the output the class object has produced.
Syntax
ANSI (Cross Platform) char* GetOutputString(); Unicode (Windows) LPWSTR GetOutputString();
char* secureblackbox_jadessigner_getoutputstring(void* lpObj);
QString GetOutputString();
Default Value
""
Remarks
Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only and not available at design time.
Data Type
String
Profile Property (JAdESSigner 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_jadessigner_getprofile(void* lpObj);
int secureblackbox_jadessigner_setprofile(void* lpObj, const char* lpszProfile);
QString GetProfile();
int SetProfile(QString qsProfile);
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Data Type
String
ProxyAddress Property (JAdESSigner 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_jadessigner_getproxyaddress(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyauthentication(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxypassword(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyport(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyproxytype(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyrequestheaders(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyresponsebody(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyresponseheaders(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyuseipv6(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyuseproxy(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getproxyusername(void* lpObj);
int secureblackbox_jadessigner_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
RevocationCheck Property (JAdESSigner 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_jadessigner_getrevocationcheck(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner Class)
The number of records in the Signature arrays.
Syntax
ANSI (Cross Platform) int GetSignatureCount(); Unicode (Windows) INT GetSignatureCount();
int secureblackbox_jadessigner_getsignaturecount(void* lpObj);
int GetSignatureCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignatureCertificateIndex
- SignatureChainValidationDetails
- SignatureChainValidationResult
- SignatureClaimedSigningTime
- SignatureContentType
- SignatureCountersigned
- SignatureHandle
- SignatureHashAlgorithm
- SignatureIssuerRDN
- SignatureJAdESVersion
- SignatureLastArchivalTime
- SignatureLevel
- SignatureObjectType
- SignatureParentSignatureIndex
- SignaturePolicyHash
- SignaturePolicyHashAlgorithm
- SignaturePolicyID
- SignaturePolicyURI
- SignatureSerialNumber
- SignatureSignatureBytes
- SignatureSignatureValidationResult
- SignatureSignedData
- SignatureSignedDataType
- SignatureSubjectKeyID
- SignatureSubjectRDN
- SignatureTimestamped
- SignatureValidatedSigningTime
- SignatureValidationLog
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
SignatureCertificateIndex Property (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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
SignatureContentType Property (JAdESSigner Class)
Specifies payload content type.
Syntax
ANSI (Cross Platform) char* GetSignatureContentType(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureContentType(INT iSignatureIndex);
char* secureblackbox_jadessigner_getsignaturecontenttype(void* lpObj, int signatureindex);
QString GetSignatureContentType(int iSignatureIndex);
Default Value
""
Remarks
Specifies payload content type.
Use this property to indicate the content type of the JWS Payload.
This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json".
It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'.
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
SignatureCountersigned Property (JAdESSigner Class)
Indicates if the signature is countersigned.
Syntax
ANSI (Cross Platform) int GetSignatureCountersigned(int iSignatureIndex); Unicode (Windows) BOOL GetSignatureCountersigned(INT iSignatureIndex);
int secureblackbox_jadessigner_getsignaturecountersigned(void* lpObj, int signatureindex);
bool GetSignatureCountersigned(int iSignatureIndex);
Default Value
FALSE
Remarks
Indicates if the signature is countersigned.
Use this property to find out whether the JWS/JAdES signature contains any countersignatures over the main signature(s).
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
SignatureHandle Property (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Specifies the hash algorithm to be used.
Syntax
ANSI (Cross Platform) char* GetSignatureHashAlgorithm(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureHashAlgorithm(INT iSignatureIndex);
char* secureblackbox_jadessigner_getsignaturehashalgorithm(void* lpObj, int signatureindex);
QString GetSignatureHashAlgorithm(int iSignatureIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used.
Supported values:
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| 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 (JAdESSigner 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_jadessigner_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
SignatureJAdESVersion Property (JAdESSigner Class)
Specifies JAdES version.
Syntax
ANSI (Cross Platform) int GetSignatureJAdESVersion(int iSignatureIndex); Unicode (Windows) INT GetSignatureJAdESVersion(INT iSignatureIndex);
Possible Values
JAV_UNKNOWN(0),
JAV_111(1)
int secureblackbox_jadessigner_getsignaturejadesversion(void* lpObj, int signatureindex);
int GetSignatureJAdESVersion(int iSignatureIndex);
Default Value
1
Remarks
Specifies JAdES version.
This property specifies the version of the JAdES specification the signature should comply with.
The supported values are:
| javUnknown | 0 | Unknown |
| jav111 | 1 | JAdES v1.1.1 |
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
SignatureLastArchivalTime Property (JAdESSigner 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_jadessigner_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
SignatureLevel Property (JAdESSigner Class)
Specifies the signature kind and level.
Syntax
ANSI (Cross Platform) int GetSignatureLevel(int iSignatureIndex); Unicode (Windows) INT GetSignatureLevel(INT iSignatureIndex);
Possible Values
JASL_JWS(0),
JASL_BASELINE_B(1),
JASL_BASELINE_T(2),
JASL_BASELINE_LT(3),
JASL_BASELINE_LTA(4)
int secureblackbox_jadessigner_getsignaturelevel(void* lpObj, int signatureindex);
int GetSignatureLevel(int iSignatureIndex);
Default Value
1
Remarks
Specifies the signature kind and level.
The supported values are:
| jaslJWS | 0 | JSON Web Signature (JWS) |
| jaslBaselineB | 1 | Baseline B (B-B, basic) |
| jaslBaselineT | 2 | Baseline T (B-T, timestamped) |
| jaslBaselineLT | 3 | Baseline LT (B-LT, long-term) |
| jaslBaselineLTA | 4 | Baseline LTA (B-LTA, long-term with archived 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
Integer
SignatureObjectType Property (JAdESSigner Class)
Specifies signature object content type.
Syntax
ANSI (Cross Platform) char* GetSignatureObjectType(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureObjectType(INT iSignatureIndex);
char* secureblackbox_jadessigner_getsignatureobjecttype(void* lpObj, int signatureindex);
QString GetSignatureObjectType(int iSignatureIndex);
Default Value
"jose+json"
Remarks
Specifies signature object content type.
Use this property to specify the content type of the signature object.
It is used by the application to differentiate between different types of objects that might be present in an application data structure containing a JWS or JAdES.
The default value is "jose+json" which indicates that it is a JWS or JAdES using the JWS JSON Serialization, and "jose" which indicates that the object is a JWS or JAdES using the JWS Compact Serialization. Other type values can also be used by the application.
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
SignatureParentSignatureIndex Property (JAdESSigner Class)
Returns the index of the parent signature, if applicable.
Syntax
ANSI (Cross Platform) int GetSignatureParentSignatureIndex(int iSignatureIndex); Unicode (Windows) INT GetSignatureParentSignatureIndex(INT iSignatureIndex);
int secureblackbox_jadessigner_getsignatureparentsignatureindex(void* lpObj, int signatureindex);
int GetSignatureParentSignatureIndex(int iSignatureIndex);
Default Value
-1
Remarks
Returns the index of the parent signature, if applicable.
Use this property to establish the index of the associated parent signature object in the signature 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
SignaturePolicyHash Property (JAdESSigner Class)
The signature policy hash value.
Syntax
ANSI (Cross Platform) char* GetSignaturePolicyHash(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignaturePolicyHash(INT iSignatureIndex);
char* secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Returns the binary representation of the JSON/JAdES 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_jadessigner_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);
QByteArray GetSignatureSignatureBytes(int iSignatureIndex);
Remarks
Returns the binary representation of the JSON/JAdES 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
SignatureSignatureValidationResult Property (JAdESSigner Class)
The outcome of the cryptographic signature validation.
Syntax
ANSI (Cross Platform) int GetSignatureSignatureValidationResult(int iSignatureIndex); Unicode (Windows) INT GetSignatureSignatureValidationResult(INT iSignatureIndex);
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_jadessigner_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);
int GetSignatureSignatureValidationResult(int iSignatureIndex);
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureSignedData Property (JAdESSigner Class)
The sigD header parameter in JSON format that was included or to be included into the signature.
Syntax
ANSI (Cross Platform) char* GetSignatureSignedData(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureSignedData(INT iSignatureIndex);
char* secureblackbox_jadessigner_getsignaturesigneddata(void* lpObj, int signatureindex);
QString GetSignatureSignedData(int iSignatureIndex);
Default Value
""
Remarks
The sigD header parameter in JSON format that was included or to be included into the signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureSignedDataType Property (JAdESSigner Class)
Specifies the type of signed data.
Syntax
ANSI (Cross Platform) int GetSignatureSignedDataType(int iSignatureIndex); Unicode (Windows) INT GetSignatureSignedDataType(INT iSignatureIndex);
Possible Values
JASDT_PAYLOAD(0),
JASDT_HTTP_HEADERS(1),
JASDT_OBJECT_ID_BY_URI(2),
JASDT_OBJECT_ID_BY_URIHASH(3),
JASDT_CUSTOM(4)
int secureblackbox_jadessigner_getsignaturesigneddatatype(void* lpObj, int signatureindex);
int GetSignatureSignedDataType(int iSignatureIndex);
Default Value
0
Remarks
Specifies the type of signed data.
Supported values:
| jasdtPayload | 0 | JWS Payload |
| jasdtHttpHeaders | 1 | HttpHeaders mechanism |
| jasdtObjectIdByURI | 2 | ObjectIdByURI mechanism |
| jasdtObjectIdByURIHash | 3 | ObjectIdByURIHash mechanism |
| jasdtCustom | 4 | Custom mechanism |
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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Contains the certified signing time.
Syntax
ANSI (Cross Platform) char* GetSignatureValidatedSigningTime(int iSignatureIndex); Unicode (Windows) LPWSTR GetSignatureValidatedSigningTime(INT iSignatureIndex);
char* secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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
SigningCertBytes Property (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getsigningcerthandle(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsigningchaincount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketdnsmode(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketdnsport(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketdnsservers(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketlocaladdress(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketlocalport(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsockettimeout(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getsocketuseipv6(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner Class)
The number of records in the Timestamp arrays.
Syntax
ANSI (Cross Platform) int GetTimestampCount(); Unicode (Windows) INT GetTimestampCount();
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Returns the timestamp's hash algorithm.
Syntax
ANSI (Cross Platform) char* GetTimestampHashAlgorithm(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampHashAlgorithm(INT iTimestampIndex);
char* secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
The time point incorporated into the timestamp.
Syntax
ANSI (Cross Platform) char* GetTimestampTime(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampTime(INT iTimestampIndex);
char* secureblackbox_jadessigner_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 (JAdESSigner Class)
Returns the type of the timestamp.
Syntax
ANSI (Cross Platform) int GetTimestampTimestampType(int iTimestampIndex); Unicode (Windows) INT GetTimestampTimestampType(INT iTimestampIndex);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner Class)
Contains the TSA certificate chain validation log.
Syntax
ANSI (Cross Platform) char* GetTimestampValidationLog(int iTimestampIndex); Unicode (Windows) LPWSTR GetTimestampValidationLog(INT iTimestampIndex);
char* secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_gettimestampserver(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsclientcertcount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_jadessigner_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 (JAdESSigner Class)
The number of records in the TLSServerCert arrays.
Syntax
ANSI (Cross Platform) int GetTLSServerCertCount(); Unicode (Windows) INT GetTLSServerCertCount();
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsciphersuites(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlseccurves(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsextensions(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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_jadessigner_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsrevocationcheck(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsssloptions(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlstlsmode(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsusesessionresumption(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettlsversions(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_gettrustedcertcount(void* lpObj);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_jadessigner_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 (JAdESSigner 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_jadessigner_getvalidationmoment(void* lpObj);
int secureblackbox_jadessigner_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
AddSignedHTTPHeaderField Method (JAdESSigner Class)
Use this method to add HTTP header field.
Syntax
ANSI (Cross Platform) int AddSignedHTTPHeaderField(const char* lpszFieldName); Unicode (Windows) INT AddSignedHTTPHeaderField(LPCWSTR lpszFieldName);
int secureblackbox_jadessigner_addsignedhttpheaderfield(void* lpObj, const char* lpszFieldName);
int AddSignedHTTPHeaderField(const QString& qsFieldName);
Remarks
This method allows you to add HTTP header field to the list of fields that will be signed. The method takes one parameter: the name of the header field.
This method changes the type of signed data to HttpHeaders mechanism and triggers the HTTPHeaderFieldNeeded event when the value of the HTTP header field is needed.
Use "(request target)" value as a field name to add request method and target URI into the list of fields that will be signed.
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.)
AddSignedObject Method (JAdESSigner Class)
Use this method to add an object.
Syntax
ANSI (Cross Platform) int AddSignedObject(const char* lpszURI, const char* lpszContentType); Unicode (Windows) INT AddSignedObject(LPCWSTR lpszURI, LPCWSTR lpszContentType);
int secureblackbox_jadessigner_addsignedobject(void* lpObj, const char* lpszURI, const char* lpszContentType);
int AddSignedObject(const QString& qsURI, const QString& qsContentType);
Remarks
This method allows you to add an object to the list of objects that will be signed. The signed object is identified by its URI.
This method changes the type of signed data to ObjectByURI mechanism and triggers the ObjectNeeded event when the data of the object is needed.
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.)
AddSignedObjectHash Method (JAdESSigner Class)
Use this method to add an object hash.
Syntax
ANSI (Cross Platform) int AddSignedObjectHash(const char* lpszURI, const char* lpszContentType, const char* lpHash, int lenHash); Unicode (Windows) INT AddSignedObjectHash(LPCWSTR lpszURI, LPCWSTR lpszContentType, LPCSTR lpHash, INT lenHash);
int secureblackbox_jadessigner_addsignedobjecthash(void* lpObj, const char* lpszURI, const char* lpszContentType, const char* lpHash, int lenHash);
int AddSignedObjectHash(const QString& qsURI, const QString& qsContentType, QByteArray qbaHash);
Remarks
This method allows you to add an object hash to the list of objects that will be signed. The signed object is identified by its URI.
This method changes the type of signed data to ObjectByURIHash mechanism and triggers the ObjectValidate event when the object must be validated. Also, it triggers the ObjectNeeded event when the data of the object is needed this could occur while adding/validating SignedData or Archive timestamps.
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.)
AddTimestampValidationData Method (JAdESSigner 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_jadessigner_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.
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 (JAdESSigner 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_jadessigner_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.
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 (JAdESSigner 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_jadessigner_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.
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 (JAdESSigner Class)
Closes an opened JWS/JAdES signature.
Syntax
ANSI (Cross Platform) int Close(int bSaveChanges); Unicode (Windows) INT Close(BOOL bSaveChanges);
int secureblackbox_jadessigner_close(void* lpObj, int bSaveChanges);
int Close(bool bSaveChanges);
Remarks
Use this method to close a previously opened JWS/JAdES signature. 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 (JAdESSigner Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_jadessigner_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.
CreateNew Method (JAdESSigner Class)
Create a new JSON for signing.
Syntax
ANSI (Cross Platform) int CreateNew(); Unicode (Windows) INT CreateNew();
int secureblackbox_jadessigner_createnew(void* lpObj);
int CreateNew();
Remarks
Use this method to create a new JSON for signing. 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.)
DoAction Method (JAdESSigner 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_jadessigner_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 (JAdESSigner 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_jadessigner_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.
Open Method (JAdESSigner Class)
Opens a JSON for signing or updating.
Syntax
ANSI (Cross Platform) int Open(); Unicode (Windows) INT Open();
int secureblackbox_jadessigner_open(void* lpObj);
int Open();
Remarks
Use this method to open a JSON 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 (JAdESSigner Class)
Revalidates a signature in accordance with current settings.
Syntax
ANSI (Cross Platform) int Revalidate(int iSigIndex); Unicode (Windows) INT Revalidate(INT iSigIndex);
int secureblackbox_jadessigner_revalidate(void* lpObj, int iSigIndex);
int Revalidate(int iSigIndex);
Remarks
Use this method to re-validate a signature in the opened JWS/JAdES signature.
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 (JAdESSigner Class)
Creates a new JAdES/JWS signature over the provided data.
Syntax
ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign();
int secureblackbox_jadessigner_sign(void* lpObj);
int Sign();
Remarks
Call this method to produce a new signature over the provided data.
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 (JAdESSigner Class)
Initiates the asynchronous signing operation.
Syntax
ANSI (Cross Platform) char* SignAsyncBegin(); Unicode (Windows) LPWSTR SignAsyncBegin();
char* secureblackbox_jadessigner_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 (JAdESSigner Class)
Completes the asynchronous signing operation.
Syntax
ANSI (Cross Platform) int SignAsyncEnd(const char* lpszAsyncReply); Unicode (Windows) INT SignAsyncEnd(LPCWSTR lpszAsyncReply);
int secureblackbox_jadessigner_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 (JAdESSigner Class)
Signs the data using an external signing facility.
Syntax
ANSI (Cross Platform) int SignExternal(); Unicode (Windows) INT SignExternal();
int secureblackbox_jadessigner_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 (JAdESSigner Class)
Use this method to add timestamp.
Syntax
ANSI (Cross Platform) int Timestamp(int iSigIndex, int iTimestampType); Unicode (Windows) INT Timestamp(INT iSigIndex, INT iTimestampType);
int secureblackbox_jadessigner_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. 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 (JAdESSigner Class)
Upgrades existing JAdES signature to a new level.
Syntax
ANSI (Cross Platform) int Upgrade(int iSigIndex, int iToLevel); Unicode (Windows) INT Upgrade(INT iSigIndex, INT iToLevel);
int secureblackbox_jadessigner_upgrade(void* lpObj, int iSigIndex, int iToLevel);
int Upgrade(int iSigIndex, int iToLevel);
Remarks
Use this method to upgrade JAdES signature to a new level specified by ToLevel. Signatures can normally be upgraded from less sophisticated levels (B, T, LT) to more sophisticated (T, LT, LTA).
Supported levels:
| jaslJWS | 0 | JSON Web Signature (JWS) |
| jaslBaselineB | 1 | Baseline B (B-B, basic) |
| jaslBaselineT | 2 | Baseline T (B-T, timestamped) |
| jaslBaselineLT | 3 | Baseline LT (B-LT, long-term) |
| jaslBaselineLTA | 4 | Baseline LTA (B-LTA, long-term with archived 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.)
ChainElementDownload Event (JAdESSigner Class)
Fires when there is a need to download a chain element from an online source.
Syntax
ANSI (Cross Platform) virtual int FireChainElementDownload(JAdESSignerChainElementDownloadEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN;
const char *Location;
int Action; int reserved; } JAdESSignerChainElementDownloadEventParams;
Unicode (Windows) virtual INT FireChainElementDownload(JAdESSignerChainElementDownloadEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
LPCWSTR Location;
INT Action; INT reserved; } JAdESSignerChainElementDownloadEventParams;
#define EID_JADESSIGNER_CHAINELEMENTDOWNLOAD 1 virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);
class JAdESSignerChainElementDownloadEventParams {
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(JAdESSignerChainElementDownloadEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireChainElementDownload(JAdESSignerChainElementDownloadEventParams *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 (JAdESSigner Class)
Fires when an element required to validate the chain was not located.
Syntax
ANSI (Cross Platform) virtual int FireChainElementNeeded(JAdESSignerChainElementNeededEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN; int reserved; } JAdESSignerChainElementNeededEventParams;
Unicode (Windows) virtual INT FireChainElementNeeded(JAdESSignerChainElementNeededEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN; INT reserved; } JAdESSignerChainElementNeededEventParams;
#define EID_JADESSIGNER_CHAINELEMENTNEEDED 2 virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);
class JAdESSignerChainElementNeededEventParams {
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(JAdESSignerChainElementNeededEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireChainElementNeeded(JAdESSignerChainElementNeededEventParams *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 (JAdESSigner 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(JAdESSignerChainElementStoreEventParams *e);
typedef struct {
int Kind;
const char *Body; int lenBody;
char *URI; int reserved; } JAdESSignerChainElementStoreEventParams;
Unicode (Windows) virtual INT FireChainElementStore(JAdESSignerChainElementStoreEventParams *e);
typedef struct {
INT Kind;
LPCSTR Body; INT lenBody;
LPWSTR URI; INT reserved; } JAdESSignerChainElementStoreEventParams;
#define EID_JADESSIGNER_CHAINELEMENTSTORE 3 virtual INT SECUREBLACKBOX_CALL FireChainElementStore(INT &iKind, LPSTR &lpBody, INT &lenBody, LPSTR &lpszURI);
class JAdESSignerChainElementStoreEventParams {
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(JAdESSignerChainElementStoreEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireChainElementStore(JAdESSignerChainElementStoreEventParams *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 (JAdESSigner Class)
Reports the completion of a certificate chain validation.
Syntax
ANSI (Cross Platform) virtual int FireChainValidated(JAdESSignerChainValidatedEventParams *e);
typedef struct {
int Index;
const char *SubjectRDN;
int ValidationResult;
int ValidationDetails; int reserved; } JAdESSignerChainValidatedEventParams;
Unicode (Windows) virtual INT FireChainValidated(JAdESSignerChainValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR SubjectRDN;
INT ValidationResult;
INT ValidationDetails; INT reserved; } JAdESSignerChainValidatedEventParams;
#define EID_JADESSIGNER_CHAINVALIDATED 4 virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails);
class JAdESSignerChainValidatedEventParams {
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(JAdESSignerChainValidatedEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireChainValidated(JAdESSignerChainValidatedEventParams *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 (JAdESSigner 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(JAdESSignerChainValidationProgressEventParams *e);
typedef struct {
const char *EventKind;
const char *CertRDN;
const char *CACertRDN;
int Action; int reserved; } JAdESSignerChainValidationProgressEventParams;
Unicode (Windows) virtual INT FireChainValidationProgress(JAdESSignerChainValidationProgressEventParams *e);
typedef struct {
LPCWSTR EventKind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
INT Action; INT reserved; } JAdESSignerChainValidationProgressEventParams;
#define EID_JADESSIGNER_CHAINVALIDATIONPROGRESS 5 virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);
class JAdESSignerChainValidationProgressEventParams {
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(JAdESSignerChainValidationProgressEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireChainValidationProgress(JAdESSignerChainValidationProgressEventParams *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 |
Error Event (JAdESSigner Class)
Information about errors during signing.
Syntax
ANSI (Cross Platform) virtual int FireError(JAdESSignerErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } JAdESSignerErrorEventParams;
Unicode (Windows) virtual INT FireError(JAdESSignerErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } JAdESSignerErrorEventParams;
#define EID_JADESSIGNER_ERROR 6 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class JAdESSignerErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(JAdESSignerErrorEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireError(JAdESSignerErrorEventParams *e) {...}
Remarks
This event is fired in case of exceptional conditions during the JSON processing.
ErrorCode contains an error code and Description contains a textual description of the error.
ExternalSign Event (JAdESSigner Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
ANSI (Cross Platform) virtual int FireExternalSign(JAdESSignerExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } JAdESSignerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(JAdESSignerExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } JAdESSignerExternalSignEventParams;
#define EID_JADESSIGNER_EXTERNALSIGN 7 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class JAdESSignerExternalSignEventParams {
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(JAdESSignerExternalSignEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireExternalSign(JAdESSignerExternalSignEventParams *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();
};
HTTPHeaderFieldNeeded Event (JAdESSigner Class)
This event is fired when HTTP header field value is required.
Syntax
ANSI (Cross Platform) virtual int FireHTTPHeaderFieldNeeded(JAdESSignerHTTPHeaderFieldNeededEventParams *e);
typedef struct {
const char *FieldName;
char *FieldValues; int reserved; } JAdESSignerHTTPHeaderFieldNeededEventParams;
Unicode (Windows) virtual INT FireHTTPHeaderFieldNeeded(JAdESSignerHTTPHeaderFieldNeededEventParams *e);
typedef struct {
LPCWSTR FieldName;
LPWSTR FieldValues; INT reserved; } JAdESSignerHTTPHeaderFieldNeededEventParams;
#define EID_JADESSIGNER_HTTPHEADERFIELDNEEDED 8 virtual INT SECUREBLACKBOX_CALL FireHTTPHeaderFieldNeeded(LPSTR &lpszFieldName, LPSTR &lpszFieldValues);
class JAdESSignerHTTPHeaderFieldNeededEventParams {
public:
const QString &FieldName();
const QString &FieldValues();
void SetFieldValues(const QString &qsFieldValues);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void HTTPHeaderFieldNeeded(JAdESSignerHTTPHeaderFieldNeededEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireHTTPHeaderFieldNeeded(JAdESSignerHTTPHeaderFieldNeededEventParams *e) {...}
Remarks
This event is triggered when the type of signed data is HttpHeaders mechanism (jasdtHttpHeaders). It indicates that a HTTP header field value is needed.
For "(request target)" field name value return request method and target URI seperated by space character. For example: "GET https://nsoftware.com/sbb/"
Loaded Event (JAdESSigner Class)
This event is fired when the JSON has been loaded into memory.
Syntax
ANSI (Cross Platform) virtual int FireLoaded(JAdESSignerLoadedEventParams *e);
typedef struct {
int Cancel; int reserved; } JAdESSignerLoadedEventParams;
Unicode (Windows) virtual INT FireLoaded(JAdESSignerLoadedEventParams *e);
typedef struct {
BOOL Cancel; INT reserved; } JAdESSignerLoadedEventParams;
#define EID_JADESSIGNER_LOADED 9 virtual INT SECUREBLACKBOX_CALL FireLoaded(BOOL &bCancel);
class JAdESSignerLoadedEventParams {
public:
bool Cancel();
void SetCancel(bool bCancel);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Loaded(JAdESSignerLoadedEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireLoaded(JAdESSignerLoadedEventParams *e) {...}
Remarks
The handler for this event is a good place to check JWS/JAdES signature properties, which may be useful when preparing the signature.
Set Cancel to true to terminate JSON processing on this stage.
Notification Event (JAdESSigner Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(JAdESSignerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } JAdESSignerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(JAdESSignerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } JAdESSignerNotificationEventParams;
#define EID_JADESSIGNER_NOTIFICATION 10 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class JAdESSignerNotificationEventParams {
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(JAdESSignerNotificationEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireNotification(JAdESSignerNotificationEventParams *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:
| Loaded | Reports the completion of signature processing by the component. Use the event handler to access signature-related information. The EventParam value passed with this EventID is empty. |
| PayloadExtracted | Reports the completion of payload extraction by the component if ExtractPayload property is enabled. Use the event handler to access payload. The EventParam value passed with this EventID is empty. |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
| TimestampRequest | A timestamp is requested from the custom timestamping
authority. This event is only fired if TimestampServer was set to a
virtual:// URI. The EventParam parameter contains the
TSP request (or the plain hash, depending on the value provided to
TimestampServer), in base16, that needs to be sent to the TSA.
Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |
ObjectNeeded Event (JAdESSigner Class)
This event is fired when object is required.
Syntax
ANSI (Cross Platform) virtual int FireObjectNeeded(JAdESSignerObjectNeededEventParams *e);
typedef struct {
const char *URI;
const char *ContentType;
int Base64; int reserved; } JAdESSignerObjectNeededEventParams;
Unicode (Windows) virtual INT FireObjectNeeded(JAdESSignerObjectNeededEventParams *e);
typedef struct {
LPCWSTR URI;
LPCWSTR ContentType;
BOOL Base64; INT reserved; } JAdESSignerObjectNeededEventParams;
#define EID_JADESSIGNER_OBJECTNEEDED 11 virtual INT SECUREBLACKBOX_CALL FireObjectNeeded(LPSTR &lpszURI, LPSTR &lpszContentType, BOOL &bBase64);
class JAdESSignerObjectNeededEventParams {
public:
const QString &URI();
const QString &ContentType();
bool Base64();
void SetBase64(bool bBase64);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ObjectNeeded(JAdESSignerObjectNeededEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireObjectNeeded(JAdESSignerObjectNeededEventParams *e) {...}
Remarks
This event is triggered when the type of signed data is ObjectIdByURI mechanism (jasdtObjectIdByURI). It is fired to request the data to be signed/verified.
The event handler must pass object data to the component via DataFile or DataStream or DataBytes or DataString property.
ObjectValidate Event (JAdESSigner Class)
This event is fired when object should be verified by user.
Syntax
ANSI (Cross Platform) virtual int FireObjectValidate(JAdESSignerObjectValidateEventParams *e);
typedef struct {
const char *URI;
const char *ContentType;
const char *HashAlgorithm;
const char *Hash; int lenHash;
int Base64;
int Valid; int reserved; } JAdESSignerObjectValidateEventParams;
Unicode (Windows) virtual INT FireObjectValidate(JAdESSignerObjectValidateEventParams *e);
typedef struct {
LPCWSTR URI;
LPCWSTR ContentType;
LPCWSTR HashAlgorithm;
LPCSTR Hash; INT lenHash;
BOOL Base64;
BOOL Valid; INT reserved; } JAdESSignerObjectValidateEventParams;
#define EID_JADESSIGNER_OBJECTVALIDATE 12 virtual INT SECUREBLACKBOX_CALL FireObjectValidate(LPSTR &lpszURI, LPSTR &lpszContentType, LPSTR &lpszHashAlgorithm, LPSTR &lpHash, INT &lenHash, BOOL &bBase64, BOOL &bValid);
class JAdESSignerObjectValidateEventParams {
public:
const QString &URI();
const QString &ContentType();
const QString &HashAlgorithm();
const QByteArray &Hash();
bool Base64();
bool Valid();
void SetValid(bool bValid);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ObjectValidate(JAdESSignerObjectValidateEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireObjectValidate(JAdESSignerObjectValidateEventParams *e) {...}
Remarks
This event is triggered when the type of signed data is ObjectIdByURIHash mechanism (jasdtObjectIdByURIHash). It is fired to validate the detached object.
The event handler must pass the object validity to the component via Valid parameter.
SignatureFound Event (JAdESSigner Class)
Signifies the start of signature validation.
Syntax
ANSI (Cross Platform) virtual int FireSignatureFound(JAdESSignerSignatureFoundEventParams *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; } JAdESSignerSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(JAdESSignerSignatureFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateSignature;
BOOL ValidateChain; INT reserved; } JAdESSignerSignatureFoundEventParams;
#define EID_JADESSIGNER_SIGNATUREFOUND 13 virtual INT SECUREBLACKBOX_CALL FireSignatureFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class JAdESSignerSignatureFoundEventParams {
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(JAdESSignerSignatureFoundEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireSignatureFound(JAdESSignerSignatureFoundEventParams *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 (JAdESSigner Class)
Marks the completion of the signature validation routine.
Syntax
ANSI (Cross Platform) virtual int FireSignatureValidated(JAdESSignerSignatureValidatedEventParams *e);
typedef struct {
int Index;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult; int reserved; } JAdESSignerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(JAdESSignerSignatureValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult; INT reserved; } JAdESSignerSignatureValidatedEventParams;
#define EID_JADESSIGNER_SIGNATUREVALIDATED 14 virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);
class JAdESSignerSignatureValidatedEventParams {
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(JAdESSignerSignatureValidatedEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireSignatureValidated(JAdESSignerSignatureValidatedEventParams *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 (JAdESSigner Class)
Signifies the start of a timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampFound(JAdESSignerTimestampFoundEventParams *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; } JAdESSignerTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(JAdESSignerTimestampFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateTimestamp;
BOOL ValidateChain; INT reserved; } JAdESSignerTimestampFoundEventParams;
#define EID_JADESSIGNER_TIMESTAMPFOUND 15 virtual INT SECUREBLACKBOX_CALL FireTimestampFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class JAdESSignerTimestampFoundEventParams {
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(JAdESSignerTimestampFoundEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTimestampFound(JAdESSignerTimestampFoundEventParams *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 (JAdESSigner Class)
Fires when the class is ready to request a timestamp from an external TSA.
Syntax
ANSI (Cross Platform) virtual int FireTimestampRequest(JAdESSignerTimestampRequestEventParams *e);
typedef struct {
const char *TSA;
const char *TimestampRequest;
char *TimestampResponse;
int SuppressDefault; int reserved; } JAdESSignerTimestampRequestEventParams;
Unicode (Windows) virtual INT FireTimestampRequest(JAdESSignerTimestampRequestEventParams *e);
typedef struct {
LPCWSTR TSA;
LPCWSTR TimestampRequest;
LPWSTR TimestampResponse;
BOOL SuppressDefault; INT reserved; } JAdESSignerTimestampRequestEventParams;
#define EID_JADESSIGNER_TIMESTAMPREQUEST 16 virtual INT SECUREBLACKBOX_CALL FireTimestampRequest(LPSTR &lpszTSA, LPSTR &lpszTimestampRequest, LPSTR &lpszTimestampResponse, BOOL &bSuppressDefault);
class JAdESSignerTimestampRequestEventParams {
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(JAdESSignerTimestampRequestEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTimestampRequest(JAdESSignerTimestampRequestEventParams *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 (JAdESSigner Class)
Reports the completion of the timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampValidated(JAdESSignerTimestampValidatedEventParams *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; } JAdESSignerTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(JAdESSignerTimestampValidatedEventParams *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; } JAdESSignerTimestampValidatedEventParams;
#define EID_JADESSIGNER_TIMESTAMPVALIDATED 17 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 JAdESSignerTimestampValidatedEventParams {
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(JAdESSignerTimestampValidatedEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTimestampValidated(JAdESSignerTimestampValidatedEventParams *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 (JAdESSigner Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(JAdESSignerTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } JAdESSignerTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(JAdESSignerTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } JAdESSignerTLSCertNeededEventParams;
#define EID_JADESSIGNER_TLSCERTNEEDED 18 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class JAdESSignerTLSCertNeededEventParams {
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(JAdESSignerTLSCertNeededEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTLSCertNeeded(JAdESSignerTLSCertNeededEventParams *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 (JAdESSigner 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(JAdESSignerTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } JAdESSignerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(JAdESSignerTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } JAdESSignerTLSCertValidateEventParams;
#define EID_JADESSIGNER_TLSCERTVALIDATE 19 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class JAdESSignerTLSCertValidateEventParams {
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(JAdESSignerTLSCertValidateEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTLSCertValidate(JAdESSignerTLSCertValidateEventParams *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 (JAdESSigner Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(JAdESSignerTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } JAdESSignerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(JAdESSignerTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } JAdESSignerTLSEstablishedEventParams;
#define EID_JADESSIGNER_TLSESTABLISHED 20 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class JAdESSignerTLSEstablishedEventParams {
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(JAdESSignerTLSEstablishedEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTLSEstablished(JAdESSignerTLSEstablishedEventParams *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 (JAdESSigner Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(JAdESSignerTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } JAdESSignerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(JAdESSignerTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } JAdESSignerTLSHandshakeEventParams;
#define EID_JADESSIGNER_TLSHANDSHAKE 21 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class JAdESSignerTLSHandshakeEventParams {
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(JAdESSignerTLSHandshakeEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTLSHandshake(JAdESSignerTLSHandshakeEventParams *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 (JAdESSigner Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(JAdESSignerTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } JAdESSignerTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(JAdESSignerTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } JAdESSignerTLSShutdownEventParams;
#define EID_JADESSIGNER_TLSSHUTDOWN 22 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class JAdESSignerTLSShutdownEventParams {
public:
const QString &Host();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TLSShutdown(JAdESSignerTLSShutdownEventParams *e);
// Or, subclass JAdESSigner and override this emitter function.
virtual int FireTLSShutdown(JAdESSignerTLSShutdownEventParams *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 (JAdESSigner 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.JAdESSigner Config Settings
If this property is set to True, the signed data timestamp will be added.
The certificate thumbprint that was included into the signature.
The certificate URL that was included or to be included into the signature.
The certificate URL is the "x5u" (X.509 URL) Header Parameter that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or JAdES.
This property controls the "b64" header parameter and it determines the representation of the JWS payload or object data. Its value must be the same for all signatures if there are multiple of them in the JSON.
If the value is set to "true", the JWS payload will be represented as a Base64-URL-encoded string.
If the value is "false", the JWS payload will be represented without any encoding.
The default value of this property is "true".
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.
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.
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.
Contains a comma-separated list of values that specifies JAdES options.
Supported values are:
| WriteBase64Param | The parameter controls the inclusion of the "b64" header parameter in the signature. When this flag is set, the "b64" header parameter will always be included in the header. Otherwise, the "b64" header parameter will only be included in the header when it is required. | |
| PreferEtsiUClearInstance | The parameter determines whether the EtsiU components should be written as clear JSON instances or as Base64-encoded strings. When this flag is set, EtsiU components will be written as clear JSON instances, if possible. Otherwise, the EtsiU components will be Base64url-encoded strings. |
The Key ID that was included or to be included into the signature.
Key ID is a hint indicating which key was used to secure the JWS or JAdES.
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.
Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.
Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.
The signature production place in JSON format that was included or to be included into the signature.
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.
The protected header that was included or to be included into the signature.
Use this property to specify the parameters of the algorithm scheme if needed.
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.
The signer attributes in JSON format that was included or to be included into the signature.
The signer commitments in JSON format that was included or to be included into the signature.
If this property is set to True, the signing certificate issuer and serial number will be included into the signature.
If this property is set to True, the signing certificate thumbprint will be included into the signature.
If this property is set to True, the signing certificate value will be included into the signature.
If this property is set to True, the signing chain thumbprints will be included into the signature.
If this property is set to True, the signing chain values will be included into the signature.
This setting specifies an absolute path to the location on disk where temporary files are stored.
The certificate thumbprint hash algorithm that was included or to be included into the signature.
When using virtual:// timestamp endpoints, assign this property in your Notification event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).
Contains a comma-separated list of values that specifies which validation data values details to include to the "tstVD" JSON object.
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).
The unprotected header that was included or to be included into the signature.
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.
Contains a comma-separated list of values that specifies which validation data references details to include to the "xRefs", "rRefs", "axRefs" and "arRefs" JSON objects/arrays.
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_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| 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 "xVals", "rVals", "axVals" and "arVals" JSON objects/arrays.
Supported values are:
| certificate | Base64-encoded [X509v3] certificates | |
| crl | Base64-encoded certificate revocation lists (CRL) | |
| ocsp | OCSP responses |
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 (JAdESSigner 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.
JAdESSigner 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) | |
| 53477377 Input file does not exist (SB_ERROR_JADES_INPUTFILE_NOT_EXISTS) |