JAdESVerifier Component
Properties Methods Events Config Settings Errors
The JAdESVerifier component verifies signatures over JSON objects.
Syntax
TsbxJAdESVerifier
Remarks
Use JAdESVerifier to validate electronic signatures over JSON structures. Generic (JWS) and JAdES (JSON Advanced Electronic Signatures) are supported.
JAdESVerifier validates each signature from two perspectives: the integrity and validity of the signature itself (i.e. its correspondence to the JSON data it covers), and the validity and trustworthiness of the signing certificate chain. These two signature aspects are generally independent of each other: the signature may be valid but the chain may not be trusted, or, the other way round, the chain may be trusted, but the integrity of the signature may be violated. Under normal circumstances both the signature and the chain must be valid for the signature to be considered good.
To initiate the validation, assign the path to the signed JSON file to the InputFile property (alternatively, you can provide it in a memory buffer via InputBytes or InputString property), and call Verify method. For every signature located in the document, JAdESVerifier will fire the SignatureFound event. This event lets you specify whether you want JAdESVerifier to validate the signature, the chain, or both.
Note: it does not mean that any of the two is optional. This API lets you be flexible in how you validate documents in your code, to allow for a variety of validation scenarios. For example, if your trust environment relies on certificate pinning, validating the chain by JAdESVerifier internally may cause unnecessary burden on the system, in which case (but not in others!) it may be reasonable to disable it in the event handler.
Once SignatureFound returns, JAdESVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, SignatureValidated event is fired, and the validation results are separately provided via SignatureValidationResult and ChainValidationResult properties of the relevant signature object. Other information about the signature can be accessed via the Signatures property.
Useful settings and properties
The following properties of JAdESVerifier may be handy when working with this component:
- OfflineMode lets you validate the JSON object without contacting online revocation sources. Paired with switched off system trust settings, it can be used to establish the long-term validity of the signed object and the completeness of validation material included in it.
- RevocationCheck lets you adjust the revocation checking preferences.
- ValidatedSigningTime returns the signing time as recorded in the embedded signature timestamp. This is in contrast to ClaimedSigningTime, which returns the signing time as specified by the signer.
- ValidationLog is a great way to find out the details of chain validation failures. This property returns a comprehensive validation log that reports all the issues encountered during the validation.
By default, JAdESVerifier uses the system trust settings to establish certificate chain validity. You can configure it to use your own, custom validation environment by providing the necessary trust elements via KnownCertificates, TrustedCertificates, KnownCRLs, and other similar properties.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AllSignaturesValid | The cumulative validity of all signatures. |
AutoValidateSignatures | Specifies whether component should validate any present signatures when the JWS/JAdES signature is opened. |
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns the raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertCount | The number of records in the Cert arrays. |
CertBytes | Returns the raw certificate data in DER format. |
CertCA | Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension). |
CertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CertCurve | Specifies the elliptic curve of the EC public key. |
CertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
CertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CertKeyBits | Returns the length of the public key. |
CertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CertPublicKeyBytes | Contains the certificate's public key in DER format. |
CertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CertSerialNumber | Returns the certificate's serial number. |
CertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CertValidTo | The time point at which the certificate expires, in UTC. |
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 component 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 component in the string form. |
Detached | Specifies whether a detached signature should be produced or verified. |
ExtractPayload | Specifies whether a payload should be extracted. |
FIPSMode | Reserved. |
FlattenedSignature | Specifies if the flattened signature to be used. |
IgnoreChainValidationErrors | Makes the component tolerant to chain validation errors. |
InputBytes | Use this property to pass the input to component in byte array form. |
InputFile | The file to be signed. |
InputString | Use this property to pass the input to component 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. |
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 component to offline mode. |
OutputBytes | Use this property to read the output the component object has produced. |
OutputFile | Defines where to save the signature. |
OutputString | Use this property to read the output the component 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. |
SocketDNSMode | Selects the DNS resolver to use: the component'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. |
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 component with short descriptions. Click on the links for further details.
Close | Closes an opened JWS/JAdES signature. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
Open | Opens a JSON for verifying or removing signatures. |
Revalidate | Revalidates a signature in accordance with current settings. |
Unsign | Deletes a signature from the JWS/JAdES signature. |
Verify | Verifies the JWS/JAdES signature. |
Event List
The following is the full list of the events fired by the component 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. |
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. |
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 component with short descriptions. Click on the links for further details.
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. |
IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
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. |
PSSUsed | Whether RSASSA-PSS mode was used. |
SignerAttrs | Identifies the signer attributes. |
SignerCommitments | Identifies the signer commitments. |
ThumbprintHashAlgorithm | Specifies the thumbprint hash algorithm. |
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. |
UnprotectedHeader | Specifies the unprotected header. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
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 component. |
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 components 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. |
AllSignaturesValid Property (JAdESVerifier Component)
The cumulative validity of all signatures.
Syntax
__property bool AllSignaturesValid = { read=FAllSignaturesValid };
Default Value
false
Remarks
Use this property to check if all the signatures found in the message or document are valid.
This property is read-only and not available at design time.
Data Type
Boolean
AutoValidateSignatures Property (JAdESVerifier Component)
Specifies whether component should validate any present signatures when the JWS/JAdES signature is opened.
Syntax
__property bool AutoValidateSignatures = { read=FAutoValidateSignatures, write=FSetAutoValidateSignatures };
Default Value
true
Remarks
This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.
Data Type
Boolean
BlockedCertCount Property (JAdESVerifier Component)
The number of records in the BlockedCert arrays.
Syntax
__property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount };
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 (JAdESVerifier Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayBlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle };
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 (JAdESVerifier Component)
The number of records in the Cert arrays.
Syntax
__property int CertCount = { read=FCertCount };
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
This property is read-only and not available at design time.
Data Type
Integer
CertBytes Property (JAdESVerifier Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayCertBytes[int CertIndex] = { read=FCertBytes };
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 (JAdESVerifier Component)
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
Syntax
__property bool CertCA[int CertIndex] = { read=FCertCA };
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 (JAdESVerifier Component)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
__property DynamicArrayCertCAKeyID[int CertIndex] = { read=FCertCAKeyID };
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 (JAdESVerifier Component)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
__property String CertCRLDistributionPoints[int CertIndex] = { read=FCertCRLDistributionPoints };
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 (JAdESVerifier Component)
Specifies the elliptic curve of the EC public key.
Syntax
__property String CertCurve[int CertIndex] = { read=FCertCurve };
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 (JAdESVerifier Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
__property DynamicArrayCertFingerprint[int CertIndex] = { read=FCertFingerprint };
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 (JAdESVerifier Component)
Contains an associated alias (friendly name) of the certificate.
Syntax
__property String CertFriendlyName[int CertIndex] = { read=FCertFriendlyName };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 CertHandle[int CertIndex] = { read=FCertHandle };
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 (JAdESVerifier Component)
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
__property String CertHashAlgorithm[int CertIndex] = { read=FCertHashAlgorithm };
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 (JAdESVerifier Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
__property String CertIssuer[int CertIndex] = { read=FCertIssuer };
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 (JAdESVerifier Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
__property String CertIssuerRDN[int CertIndex] = { read=FCertIssuerRDN };
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 (JAdESVerifier Component)
Specifies the public key algorithm of this certificate.
Syntax
__property String CertKeyAlgorithm[int CertIndex] = { read=FCertKeyAlgorithm };
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 (JAdESVerifier Component)
Returns the length of the public key.
Syntax
__property int CertKeyBits[int CertIndex] = { read=FCertKeyBits };
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 (JAdESVerifier Component)
Returns a fingerprint of the public key contained in the certificate.
Syntax
__property DynamicArrayCertKeyFingerprint[int CertIndex] = { read=FCertKeyFingerprint };
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 (JAdESVerifier Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
__property int CertKeyUsage[int CertIndex] = { read=FCertKeyUsage };
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 (JAdESVerifier Component)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
__property bool CertKeyValid[int CertIndex] = { read=FCertKeyValid };
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 (JAdESVerifier Component)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
__property String CertOCSPLocations[int CertIndex] = { read=FCertOCSPLocations };
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 (JAdESVerifier Component)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
__property String CertPolicyIDs[int CertIndex] = { read=FCertPolicyIDs };
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 (JAdESVerifier Component)
Contains the certificate's public key in DER format.
Syntax
__property DynamicArrayCertPublicKeyBytes[int CertIndex] = { read=FCertPublicKeyBytes };
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 (JAdESVerifier Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
__property bool CertSelfSigned[int CertIndex] = { read=FCertSelfSigned };
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 (JAdESVerifier Component)
Returns the certificate's serial number.
Syntax
__property DynamicArrayCertSerialNumber[int CertIndex] = { read=FCertSerialNumber };
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 (JAdESVerifier Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
__property String CertSigAlgorithm[int CertIndex] = { read=FCertSigAlgorithm };
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 (JAdESVerifier Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
__property String CertSubject[int CertIndex] = { read=FCertSubject };
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 (JAdESVerifier Component)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
__property DynamicArrayCertSubjectKeyID[int CertIndex] = { read=FCertSubjectKeyID };
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 (JAdESVerifier Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
__property String CertSubjectRDN[int CertIndex] = { read=FCertSubjectRDN };
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 (JAdESVerifier Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
__property String CertValidFrom[int CertIndex] = { read=FCertValidFrom };
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 (JAdESVerifier Component)
The time point at which the certificate expires, in UTC.
Syntax
__property String CertValidTo[int CertIndex] = { read=FCertValidTo };
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 (JAdESVerifier Component)
Specifies if the JWS compact serialization to be used.
Syntax
__property bool CompactForm = { read=FCompactForm, write=FSetCompactForm };
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 (JAdESVerifier Component)
Specifies payload content type.
Syntax
__property String ContentType = { read=FContentType };
Default Value
""
Remarks
Use this property to read the content type of the payload.
This property is read-only and not available at design time.
Data Type
String
CRLCount Property (JAdESVerifier Component)
The number of records in the CRL arrays.
Syntax
__property int CRLCount = { read=FCRLCount };
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 (JAdESVerifier Component)
Returns the raw CRL data in DER format.
Syntax
__property DynamicArrayCRLBytes[int CRLIndex] = { read=FCRLBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 CRLHandle[int CRLIndex] = { read=FCRLHandle };
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 (JAdESVerifier Component)
The common name of the CRL issuer (CA), typically a company name.
Syntax
__property String CRLIssuer[int CRLIndex] = { read=FCRLIssuer };
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 (JAdESVerifier Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
__property String CRLIssuerRDN[int CRLIndex] = { read=FCRLIssuerRDN };
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 (JAdESVerifier Component)
The URL that the CRL was downloaded from.
Syntax
__property String CRLLocation[int CRLIndex] = { read=FCRLLocation };
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 (JAdESVerifier Component)
The planned time and date of the next version of this CRL to be published.
Syntax
__property String CRLNextUpdate[int CRLIndex] = { read=FCRLNextUpdate };
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 (JAdESVerifier Component)
The date and time at which this version of the CRL was published.
Syntax
__property String CRLThisUpdate[int CRLIndex] = { read=FCRLThisUpdate };
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 (JAdESVerifier Component)
Use this property to pass a payload or an object data to component in the byte array form.
Syntax
__property DynamicArrayDataBytes = { read=FDataBytes, write=FSetDataBytes };
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 (JAdESVerifier Component)
A path to a file containing a payload or an object data.
Syntax
__property String DataFile = { read=FDataFile, write=FSetDataFile };
Default Value
""
Remarks
Use this property to provide a JWS payload or an object data to be processed.
Data Type
String
DataString Property (JAdESVerifier Component)
Use this property to pass a payload or an object data to component in the string form.
Syntax
__property String DataString = { read=FDataString, write=FSetDataString };
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 (JAdESVerifier Component)
Specifies whether a detached signature should be produced or verified.
Syntax
__property bool Detached = { read=FDetached, write=FSetDetached };
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
ExtractPayload Property (JAdESVerifier Component)
Specifies whether a payload should be extracted.
Syntax
__property bool ExtractPayload = { read=FExtractPayload, write=FSetExtractPayload };
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 (JAdESVerifier Component)
Reserved.
Syntax
__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
FlattenedSignature Property (JAdESVerifier Component)
Specifies if the flattened signature to be used.
Syntax
__property bool FlattenedSignature = { read=FFlattenedSignature, write=FSetFlattenedSignature };
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 (JAdESVerifier Component)
Makes the component tolerant to chain validation errors.
Syntax
__property bool IgnoreChainValidationErrors = { read=FIgnoreChainValidationErrors, write=FSetIgnoreChainValidationErrors };
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 (JAdESVerifier Component)
Use this property to pass the input to component in byte array form.
Syntax
__property DynamicArrayInputBytes = { read=FInputBytes, write=FSetInputBytes };
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 (JAdESVerifier Component)
The file to be signed.
Syntax
__property String InputFile = { read=FInputFile, write=FSetInputFile };
Default Value
""
Remarks
Provide the path to the JSON to be signed.
Data Type
String
InputString Property (JAdESVerifier Component)
Use this property to pass the input to component in the string form.
Syntax
__property String InputString = { read=FInputString, write=FSetInputString };
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 (JAdESVerifier Component)
The number of records in the KnownCert arrays.
Syntax
__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };
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 (JAdESVerifier Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayKnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };
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 (JAdESVerifier Component)
The number of records in the KnownCRL arrays.
Syntax
__property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount };
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 (JAdESVerifier Component)
Returns the raw CRL data in DER format.
Syntax
__property DynamicArrayKnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle };
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 (JAdESVerifier Component)
The number of records in the KnownOCSP arrays.
Syntax
__property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount };
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 (JAdESVerifier Component)
A buffer containing the raw OCSP response data.
Syntax
__property DynamicArrayKnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle };
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
OCSPCount Property (JAdESVerifier Component)
The number of records in the OCSP arrays.
Syntax
__property int OCSPCount = { read=FOCSPCount };
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 (JAdESVerifier Component)
A buffer containing the raw OCSP response data.
Syntax
__property DynamicArrayOCSPBytes[int OCSPIndex] = { read=FOCSPBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 OCSPHandle[int OCSPIndex] = { read=FOCSPHandle };
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 (JAdESVerifier Component)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
__property String OCSPIssuer[int OCSPIndex] = { read=FOCSPIssuer };
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 (JAdESVerifier Component)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
__property String OCSPIssuerRDN[int OCSPIndex] = { read=FOCSPIssuerRDN };
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 (JAdESVerifier Component)
The location of the OCSP responder.
Syntax
__property String OCSPLocation[int OCSPIndex] = { read=FOCSPLocation };
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 (JAdESVerifier Component)
Specifies the time when the response was produced, in UTC.
Syntax
__property String OCSPProducedAt[int OCSPIndex] = { read=FOCSPProducedAt };
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 (JAdESVerifier Component)
Switches the component to offline mode.
Syntax
__property bool OfflineMode = { read=FOfflineMode, write=FSetOfflineMode };
Default Value
false
Remarks
When working in offline mode, the component 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 (JAdESVerifier Component)
Use this property to read the output the component object has produced.
Syntax
__property DynamicArrayOutputBytes = { read=FOutputBytes };
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 (JAdESVerifier Component)
Defines where to save the signature.
Syntax
__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };
Default Value
""
Remarks
Specifies the path where the JWS/JAdES signature should be saved.
Data Type
String
OutputString Property (JAdESVerifier Component)
Use this property to read the output the component object has produced.
Syntax
__property String OutputString = { read=FOutputString };
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 (JAdESVerifier Component)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
__property String Profile = { read=FProfile, write=FSetProfile };
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 (JAdESVerifier Component)
The IP address of the proxy server.
Syntax
__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (JAdESVerifier Component)
The authentication type used by the proxy server.
Syntax
__property TsbxJAdESVerifierProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };
enum TsbxJAdESVerifierProxyAuthentications { patNoAuthentication=0, patBasic=1, patDigest=2, patNTLM=3 };
Default Value
patNoAuthentication
Remarks
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Data Type
Integer
ProxyPassword Property (JAdESVerifier Component)
The password to authenticate to the proxy server.
Syntax
__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (JAdESVerifier Component)
The port on the proxy server to connect to.
Syntax
__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (JAdESVerifier Component)
The type of the proxy server.
Syntax
__property TsbxJAdESVerifierProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };
enum TsbxJAdESVerifierProxyProxyTypes { cptNone=0, cptSocks4=1, cptSocks5=2, cptWebTunnel=3, cptHTTP=4 };
Default Value
cptNone
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 (JAdESVerifier Component)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (JAdESVerifier Component)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (JAdESVerifier Component)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (JAdESVerifier Component)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (JAdESVerifier Component)
Enables or disables proxy-driven connection.
Syntax
__property bool ProxyUseProxy = { read=FProxyUseProxy, write=FSetProxyUseProxy };
Default Value
false
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (JAdESVerifier Component)
Specifies the username credential for proxy authentication.
Syntax
__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
RevocationCheck Property (JAdESVerifier Component)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
__property TsbxJAdESVerifierRevocationChecks RevocationCheck = { read=FRevocationCheck, write=FSetRevocationCheck };
enum TsbxJAdESVerifierRevocationChecks { crcNone=0, crcAuto=1, crcAllCRL=2, crcAllOCSP=3, crcAllCRLAndOCSP=4, crcAnyCRL=5, crcAnyOCSP=6, crcAnyCRLOrOCSP=7, crcAnyOCSPOrCRL=8 };
Default Value
crcAuto
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 (JAdESVerifier Component)
The number of records in the Signature arrays.
Syntax
__property int SignatureCount = { read=FSignatureCount };
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
This property is read-only and not available at design time.
Data Type
Integer
SignatureCertificateIndex Property (JAdESVerifier Component)
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
__property int SignatureCertificateIndex[int SignatureIndex] = { read=FSignatureCertificateIndex };
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 (JAdESVerifier Component)
The details of a certificate chain validation outcome.
Syntax
__property int SignatureChainValidationDetails[int SignatureIndex] = { read=FSignatureChainValidationDetails };
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 (JAdESVerifier Component)
The outcome of a certificate chain validation routine.
Syntax
__property TsbxJAdESVerifierSignatureChainValidationResults SignatureChainValidationResult[int SignatureIndex] = { read=FSignatureChainValidationResult };
enum TsbxJAdESVerifierSignatureChainValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 };
Default Value
cvtValid
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 (JAdESVerifier Component)
The signing time from the signer's computer.
Syntax
__property String SignatureClaimedSigningTime[int SignatureIndex] = { read=FSignatureClaimedSigningTime };
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 (JAdESVerifier Component)
Specifies payload content type.
Syntax
__property String SignatureContentType[int SignatureIndex] = { read=FSignatureContentType };
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 (JAdESVerifier Component)
Indicates if the signature is countersigned.
Syntax
__property bool SignatureCountersigned[int SignatureIndex] = { read=FSignatureCountersigned };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 SignatureHandle[int SignatureIndex] = { read=FSignatureHandle };
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 (JAdESVerifier Component)
Specifies the hash algorithm to be used.
Syntax
__property String SignatureHashAlgorithm[int SignatureIndex] = { read=FSignatureHashAlgorithm };
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 (JAdESVerifier Component)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
__property String SignatureIssuerRDN[int SignatureIndex] = { read=FSignatureIssuerRDN };
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 (JAdESVerifier Component)
Specifies JAdES version.
Syntax
__property TsbxJAdESVerifierSignatureJAdESVersions SignatureJAdESVersion[int SignatureIndex] = { read=FSignatureJAdESVersion };
enum TsbxJAdESVerifierSignatureJAdESVersions { javUnknown=0, jav111=1 };
Default Value
jav111
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 (JAdESVerifier Component)
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
__property String SignatureLastArchivalTime[int SignatureIndex] = { read=FSignatureLastArchivalTime };
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 (JAdESVerifier Component)
Specifies the signature kind and level.
Syntax
__property TsbxJAdESVerifierSignatureLevels SignatureLevel[int SignatureIndex] = { read=FSignatureLevel };
enum TsbxJAdESVerifierSignatureLevels { jaslJWS=0, jaslBaselineB=1, jaslBaselineT=2, jaslBaselineLT=3, jaslBaselineLTA=4 };
Default Value
jaslBaselineB
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 (JAdESVerifier Component)
Specifies signature object content type.
Syntax
__property String SignatureObjectType[int SignatureIndex] = { read=FSignatureObjectType };
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 (JAdESVerifier Component)
Returns the index of the parent signature, if applicable.
Syntax
__property int SignatureParentSignatureIndex[int SignatureIndex] = { read=FSignatureParentSignatureIndex };
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 (JAdESVerifier Component)
The signature policy hash value.
Syntax
__property String SignaturePolicyHash[int SignatureIndex] = { read=FSignaturePolicyHash };
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 (JAdESVerifier Component)
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
__property String SignaturePolicyHashAlgorithm[int SignatureIndex] = { read=FSignaturePolicyHashAlgorithm };
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 (JAdESVerifier Component)
The policy ID that was included or to be included into the signature.
Syntax
__property String SignaturePolicyID[int SignatureIndex] = { read=FSignaturePolicyID };
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 (JAdESVerifier Component)
The signature policy URI that was included in the signature.
Syntax
__property String SignaturePolicyURI[int SignatureIndex] = { read=FSignaturePolicyURI };
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 (JAdESVerifier Component)
The serial number of the timestamp.
Syntax
__property DynamicArraySignatureSerialNumber[int SignatureIndex] = { read=FSignatureSerialNumber };
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 (JAdESVerifier Component)
Returns the binary representation of the JSON/JAdES signature.
Syntax
__property DynamicArraySignatureSignatureBytes[int SignatureIndex] = { read=FSignatureSignatureBytes };
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 (JAdESVerifier Component)
The outcome of the cryptographic signature validation.
Syntax
__property TsbxJAdESVerifierSignatureSignatureValidationResults SignatureSignatureValidationResult[int SignatureIndex] = { read=FSignatureSignatureValidationResult };
enum TsbxJAdESVerifierSignatureSignatureValidationResults { svtValid=0, svtUnknown=1, svtCorrupted=2, svtSignerNotFound=3, svtFailure=4 };
Default Value
svtValid
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 (JAdESVerifier Component)
The sigD header parameter in JSON format that was included or to be included into the signature.
Syntax
__property String SignatureSignedData[int SignatureIndex] = { read=FSignatureSignedData };
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 (JAdESVerifier Component)
Specifies the type of signed data.
Syntax
__property TsbxJAdESVerifierSignatureSignedDataTypes SignatureSignedDataType[int SignatureIndex] = { read=FSignatureSignedDataType };
enum TsbxJAdESVerifierSignatureSignedDataTypes { jasdtPayload=0, jasdtHttpHeaders=1, jasdtObjectIdByURI=2, jasdtObjectIdByURIHash=3, jasdtCustom=4 };
Default Value
jasdtPayload
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 (JAdESVerifier Component)
Contains the subject key identifier of the signing certificate.
Syntax
__property DynamicArraySignatureSubjectKeyID[int SignatureIndex] = { read=FSignatureSubjectKeyID };
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 (JAdESVerifier Component)
Contains information about the person owning the signing certificate.
Syntax
__property String SignatureSubjectRDN[int SignatureIndex] = { read=FSignatureSubjectRDN };
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 (JAdESVerifier Component)
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
__property bool SignatureTimestamped[int SignatureIndex] = { read=FSignatureTimestamped };
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 (JAdESVerifier Component)
Contains the certified signing time.
Syntax
__property String SignatureValidatedSigningTime[int SignatureIndex] = { read=FSignatureValidatedSigningTime };
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 (JAdESVerifier Component)
Contains the complete log of the certificate validation routine.
Syntax
__property String SignatureValidationLog[int SignatureIndex] = { read=FSignatureValidationLog };
Default Value
""
Remarks
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the component. 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
SocketDNSMode Property (JAdESVerifier Component)
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
Syntax
__property TsbxJAdESVerifierSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };
enum TsbxJAdESVerifierSocketDNSModes { dmAuto=0, dmPlatform=1, dmOwn=2, dmOwnSecure=3 };
Default Value
dmAuto
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 (JAdESVerifier Component)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (JAdESVerifier Component)
The timeout (in milliseconds) for each DNS query.
Syntax
__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };
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 (JAdESVerifier Component)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (JAdESVerifier Component)
The timeout (in milliseconds) for the whole resolution process.
Syntax
__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };
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 (JAdESVerifier Component)
The maximum number of bytes to read from the socket, per second.
Syntax
__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (JAdESVerifier Component)
The local network interface to bind the socket to.
Syntax
__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (JAdESVerifier Component)
The local port number to bind the socket to.
Syntax
__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (JAdESVerifier Component)
The maximum number of bytes to write to the socket, per second.
Syntax
__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (JAdESVerifier Component)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };
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 (JAdESVerifier Component)
Enables or disables IP protocol version 6.
Syntax
__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TimestampCount Property (JAdESVerifier Component)
The number of records in the Timestamp arrays.
Syntax
__property int TimestampCount = { read=FTimestampCount };
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
This property is read-only and not available at design time.
Data Type
Integer
TimestampAccuracy Property (JAdESVerifier Component)
This property indicates the accuracy of the included time mark, in microseconds.
Syntax
__property __int64 TimestampAccuracy[int TimestampIndex] = { read=FTimestampAccuracy };
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 (JAdESVerifier Component)
Returns the raw timestamp data in DER format.
Syntax
__property DynamicArrayTimestampBytes[int TimestampIndex] = { read=FTimestampBytes };
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 (JAdESVerifier Component)
Returns the index of the TSA certificate in the Certificates collection.
Syntax
__property int TimestampCertificateIndex[int TimestampIndex] = { read=FTimestampCertificateIndex };
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 (JAdESVerifier Component)
The details of a certificate chain validation outcome.
Syntax
__property int TimestampChainValidationDetails[int TimestampIndex] = { read=FTimestampChainValidationDetails };
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 (JAdESVerifier Component)
The outcome of a certificate chain validation routine.
Syntax
__property TsbxJAdESVerifierTimestampChainValidationResults TimestampChainValidationResult[int TimestampIndex] = { read=FTimestampChainValidationResult };
enum TsbxJAdESVerifierTimestampChainValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 };
Default Value
cvtValid
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 (JAdESVerifier Component)
Returns the timestamp's hash algorithm.
Syntax
__property String TimestampHashAlgorithm[int TimestampIndex] = { read=FTimestampHashAlgorithm };
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 (JAdESVerifier Component)
Returns the timestamp's serial number.
Syntax
__property DynamicArrayTimestampSerialNumber[int TimestampIndex] = { read=FTimestampSerialNumber };
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 (JAdESVerifier Component)
Returns the index of the owner signature, if applicable.
Syntax
__property int TimestampSignatureIndex[int TimestampIndex] = { read=FTimestampSignatureIndex };
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 (JAdESVerifier Component)
The time point incorporated into the timestamp.
Syntax
__property String TimestampTime[int TimestampIndex] = { read=FTimestampTime };
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 (JAdESVerifier Component)
Returns the type of the timestamp.
Syntax
__property int TimestampTimestampType[int TimestampIndex] = { read=FTimestampTimestampType };
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 (JAdESVerifier Component)
This value uniquely identifies the Timestamp Authority (TSA).
Syntax
__property String TimestampTSAName[int TimestampIndex] = { read=FTimestampTSAName };
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 (JAdESVerifier Component)
Contains the TSA certificate chain validation log.
Syntax
__property String TimestampValidationLog[int TimestampIndex] = { read=FTimestampValidationLog };
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 (JAdESVerifier Component)
Contains the timestamp validation outcome.
Syntax
__property TsbxJAdESVerifierTimestampValidationResults TimestampValidationResult[int TimestampIndex] = { read=FTimestampValidationResult };
enum TsbxJAdESVerifierTimestampValidationResults { svtValid=0, svtUnknown=1, svtCorrupted=2, svtSignerNotFound=3, svtFailure=4 };
Default Value
svtValid
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
TLSClientCertCount Property (JAdESVerifier Component)
The number of records in the TLSClientCert arrays.
Syntax
__property int TLSClientCertCount = { read=FTLSClientCertCount, write=FSetTLSClientCertCount };
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 (JAdESVerifier Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTLSClientCertBytes[int TLSClientCertIndex] = { read=FTLSClientCertBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 TLSClientCertHandle[int TLSClientCertIndex] = { read=FTLSClientCertHandle, write=FSetTLSClientCertHandle };
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 (JAdESVerifier Component)
The number of records in the TLSServerCert arrays.
Syntax
__property int TLSServerCertCount = { read=FTLSServerCertCount };
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 (JAdESVerifier Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle };
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 (JAdESVerifier Component)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (JAdESVerifier Component)
Selects the base configuration for the TLS settings.
Syntax
__property TsbxJAdESVerifierTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };
enum TsbxJAdESVerifierTLSBaseConfigurations { stpcDefault=0, stpcCompatible=1, stpcComprehensiveInsecure=2, stpcHighlySecure=3 };
Default Value
stpcDefault
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 (JAdESVerifier Component)
A list of ciphersuites separated with commas or semicolons.
Syntax
__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };
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 (JAdESVerifier Component)
Defines the elliptic curves to enable.
Syntax
__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (JAdESVerifier Component)
Provides access to TLS extensions.
Syntax
__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (JAdESVerifier Component)
Whether to force TLS session resumption when the destination address changes.
Syntax
__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (JAdESVerifier Component)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };
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 (JAdESVerifier Component)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };
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 (JAdESVerifier Component)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (JAdESVerifier Component)
Selects the renegotiation attack prevention mechanism.
Syntax
__property TsbxJAdESVerifierTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };
enum TsbxJAdESVerifierTLSRenegotiationAttackPreventionModes { crapmCompatible=0, crapmStrict=1, crapmAuto=2 };
Default Value
crapmCompatible
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 (JAdESVerifier Component)
Specifies the kind(s) of revocation check to perform.
Syntax
__property TsbxJAdESVerifierTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };
enum TsbxJAdESVerifierTLSRevocationChecks { crcNone=0, crcAuto=1, crcAllCRL=2, crcAllOCSP=3, crcAllCRLAndOCSP=4, crcAnyCRL=5, crcAnyOCSP=6, crcAnyCRLOrOCSP=7, crcAnyOCSPOrCRL=8 };
Default Value
crcAuto
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 (JAdESVerifier Component)
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
__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };
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 (JAdESVerifier Component)
Specifies the TLS mode to use.
Syntax
__property TsbxJAdESVerifierTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };
enum TsbxJAdESVerifierTLSTLSModes { smDefault=0, smNoTLS=1, smExplicitTLS=2, smImplicitTLS=3, smMixedTLS=4 };
Default Value
smDefault
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 (JAdESVerifier Component)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };
Default Value
false
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (JAdESVerifier Component)
Enables or disables the TLS session resumption capability.
Syntax
__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (JAdESVerifier Component)
The SSL/TLS versions to enable by default.
Syntax
__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };
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 (JAdESVerifier Component)
The number of records in the TrustedCert arrays.
Syntax
__property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount };
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 (JAdESVerifier Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes };
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 (JAdESVerifier Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle };
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 (JAdESVerifier Component)
The time point at which signature validity is to be established.
Syntax
__property String ValidationMoment = { read=FValidationMoment, write=FSetValidationMoment };
Default Value
""
Remarks
Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).
The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.
Data Type
String
Close Method (JAdESVerifier Component)
Closes an opened JWS/JAdES signature.
Syntax
void __fastcall Close(bool SaveChanges);
Remarks
Use this method to close a previously opened JWS/JAdES signature. Set SaveChanges to true to apply any changes made.
Config Method (JAdESVerifier Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
DoAction Method (JAdESVerifier Component)
Performs an additional action.
Syntax
String __fastcall DoAction(String ActionID, String ActionParams);
Remarks
DoAction is a generic method available in every component. 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;....
Open Method (JAdESVerifier Component)
Opens a JSON for verifying or removing signatures.
Syntax
void __fastcall Open();
Remarks
Use this method to open a JSON for verifying or removing signatures. When finished, call Close to complete or discard the operation.
Revalidate Method (JAdESVerifier Component)
Revalidates a signature in accordance with current settings.
Syntax
void __fastcall Revalidate(int SigIndex);
Remarks
Use this method to re-validate a signature in the opened JWS/JAdES signature.
Unsign Method (JAdESVerifier Component)
Deletes a signature from the JWS/JAdES signature.
Syntax
void __fastcall Unsign(int SigIndex);
Remarks
Use this method to delete an existing signature from the JWS/JAdES signature. Use SigIndex parameter to specify the signature to be removed.
Verify Method (JAdESVerifier Component)
Verifies the JWS/JAdES signature.
Syntax
void __fastcall Verify();
Remarks
Use this method to verify the JWS/JAdES signature.
ChainElementDownload Event (JAdESVerifier Component)
Fires when there is a need to download a chain element from an online source.
Syntax
typedef struct { int Kind; String CertRDN; String CACertRDN; String Location; int Action; } TsbxJAdESVerifierChainElementDownloadEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierChainElementDownloadEvent)(System::TObject* Sender, TsbxJAdESVerifierChainElementDownloadEventParams *e); __property TsbxJAdESVerifierChainElementDownloadEvent OnChainElementDownload = { read=FOnChainElementDownload, write=FOnChainElementDownload };
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 (JAdESVerifier Component)
Fires when an element required to validate the chain was not located.
Syntax
typedef struct { int Kind; String CertRDN; String CACertRDN; } TsbxJAdESVerifierChainElementNeededEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierChainElementNeededEvent)(System::TObject* Sender, TsbxJAdESVerifierChainElementNeededEventParams *e); __property TsbxJAdESVerifierChainElementNeededEvent OnChainElementNeeded = { read=FOnChainElementNeeded, write=FOnChainElementNeeded };
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 (JAdESVerifier Component)
This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
Syntax
typedef struct { int Kind; DynamicArrayBody; String URI; } TsbxJAdESVerifierChainElementStoreEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierChainElementStoreEvent)(System::TObject* Sender, TsbxJAdESVerifierChainElementStoreEventParams *e); __property TsbxJAdESVerifierChainElementStoreEvent OnChainElementStore = { read=FOnChainElementStore, write=FOnChainElementStore };
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 (JAdESVerifier Component)
Reports the completion of a certificate chain validation.
Syntax
typedef struct { int Index; String SubjectRDN; int ValidationResult; int ValidationDetails; } TsbxJAdESVerifierChainValidatedEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierChainValidatedEvent)(System::TObject* Sender, TsbxJAdESVerifierChainValidatedEventParams *e); __property TsbxJAdESVerifierChainValidatedEvent OnChainValidated = { read=FOnChainValidated, write=FOnChainValidated };
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 (JAdESVerifier Component)
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
typedef struct { String EventKind; String CertRDN; String CACertRDN; int Action; } TsbxJAdESVerifierChainValidationProgressEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierChainValidationProgressEvent)(System::TObject* Sender, TsbxJAdESVerifierChainValidationProgressEventParams *e); __property TsbxJAdESVerifierChainValidationProgressEvent OnChainValidationProgress = { read=FOnChainValidationProgress, write=FOnChainValidationProgress };
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 (JAdESVerifier Component)
Information about errors during signing.
Syntax
typedef struct { int ErrorCode; String Description; } TsbxJAdESVerifierErrorEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierErrorEvent)(System::TObject* Sender, TsbxJAdESVerifierErrorEventParams *e); __property TsbxJAdESVerifierErrorEvent OnError = { read=FOnError, write=FOnError };
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.
HTTPHeaderFieldNeeded Event (JAdESVerifier Component)
This event is fired when HTTP header field value is required.
Syntax
typedef struct { String FieldName; String FieldValues; } TsbxJAdESVerifierHTTPHeaderFieldNeededEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierHTTPHeaderFieldNeededEvent)(System::TObject* Sender, TsbxJAdESVerifierHTTPHeaderFieldNeededEventParams *e); __property TsbxJAdESVerifierHTTPHeaderFieldNeededEvent OnHTTPHeaderFieldNeeded = { read=FOnHTTPHeaderFieldNeeded, write=FOnHTTPHeaderFieldNeeded };
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 (JAdESVerifier Component)
This event is fired when the JSON has been loaded into memory.
Syntax
typedef struct { bool Cancel; } TsbxJAdESVerifierLoadedEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierLoadedEvent)(System::TObject* Sender, TsbxJAdESVerifierLoadedEventParams *e); __property TsbxJAdESVerifierLoadedEvent OnLoaded = { read=FOnLoaded, write=FOnLoaded };
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 (JAdESVerifier Component)
This event notifies the application about an underlying control flow event.
Syntax
typedef struct { String EventID; String EventParam; } TsbxJAdESVerifierNotificationEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierNotificationEvent)(System::TObject* Sender, TsbxJAdESVerifierNotificationEventParams *e); __property TsbxJAdESVerifierNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.
This component 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. |
ObjectNeeded Event (JAdESVerifier Component)
This event is fired when object is required.
Syntax
typedef struct { String URI; String ContentType; bool Base64; } TsbxJAdESVerifierObjectNeededEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierObjectNeededEvent)(System::TObject* Sender, TsbxJAdESVerifierObjectNeededEventParams *e); __property TsbxJAdESVerifierObjectNeededEvent OnObjectNeeded = { read=FOnObjectNeeded, write=FOnObjectNeeded };
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 (JAdESVerifier Component)
This event is fired when object should be verified by user.
Syntax
typedef struct { String URI; String ContentType; String HashAlgorithm; DynamicArrayHash; bool Base64; bool Valid; } TsbxJAdESVerifierObjectValidateEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierObjectValidateEvent)(System::TObject* Sender, TsbxJAdESVerifierObjectValidateEventParams *e); __property TsbxJAdESVerifierObjectValidateEvent OnObjectValidate = { read=FOnObjectValidate, write=FOnObjectValidate };
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 (JAdESVerifier Component)
Signifies the start of signature validation.
Syntax
typedef struct { int Index; String IssuerRDN; DynamicArraySerialNumber; DynamicArray SubjectKeyID; bool CertFound; bool ValidateSignature; bool ValidateChain; } TsbxJAdESVerifierSignatureFoundEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierSignatureFoundEvent)(System::TObject* Sender, TsbxJAdESVerifierSignatureFoundEventParams *e); __property TsbxJAdESVerifierSignatureFoundEvent OnSignatureFound = { read=FOnSignatureFound, write=FOnSignatureFound };
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 component 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 (JAdESVerifier Component)
Marks the completion of the signature validation routine.
Syntax
typedef struct { int Index; String IssuerRDN; DynamicArraySerialNumber; DynamicArray SubjectKeyID; int ValidationResult; } TsbxJAdESVerifierSignatureValidatedEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierSignatureValidatedEvent)(System::TObject* Sender, TsbxJAdESVerifierSignatureValidatedEventParams *e); __property TsbxJAdESVerifierSignatureValidatedEvent OnSignatureValidated = { read=FOnSignatureValidated, write=FOnSignatureValidated };
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 (JAdESVerifier Component)
Signifies the start of a timestamp validation routine.
Syntax
typedef struct { int Index; String IssuerRDN; DynamicArraySerialNumber; DynamicArray SubjectKeyID; bool CertFound; bool ValidateTimestamp; bool ValidateChain; } TsbxJAdESVerifierTimestampFoundEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTimestampFoundEvent)(System::TObject* Sender, TsbxJAdESVerifierTimestampFoundEventParams *e); __property TsbxJAdESVerifierTimestampFoundEvent OnTimestampFound = { read=FOnTimestampFound, write=FOnTimestampFound };
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 component 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.
TimestampValidated Event (JAdESVerifier Component)
Reports the completion of the timestamp validation routine.
Syntax
typedef struct { int Index; String IssuerRDN; DynamicArraySerialNumber; DynamicArray SubjectKeyID; String Time; int ValidationResult; int ChainValidationResult; int ChainValidationDetails; } TsbxJAdESVerifierTimestampValidatedEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTimestampValidatedEvent)(System::TObject* Sender, TsbxJAdESVerifierTimestampValidatedEventParams *e); __property TsbxJAdESVerifierTimestampValidatedEvent OnTimestampValidated = { read=FOnTimestampValidated, write=FOnTimestampValidated };
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 (JAdESVerifier Component)
Fires when a remote TLS party requests a client certificate.
Syntax
typedef struct { String Host; String CANames; } TsbxJAdESVerifierTLSCertNeededEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTLSCertNeededEvent)(System::TObject* Sender, TsbxJAdESVerifierTLSCertNeededEventParams *e); __property TsbxJAdESVerifierTLSCertNeededEvent OnTLSCertNeeded = { read=FOnTLSCertNeeded, write=FOnTLSCertNeeded };
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 (JAdESVerifier Component)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
typedef struct { String ServerHost; String ServerIP; bool Accept; } TsbxJAdESVerifierTLSCertValidateEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTLSCertValidateEvent)(System::TObject* Sender, TsbxJAdESVerifierTLSCertValidateEventParams *e); __property TsbxJAdESVerifierTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };
Remarks
This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, components 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 component, and can be adjusted if needed.
TLSEstablished Event (JAdESVerifier Component)
Fires when a TLS handshake with Host successfully completes.
Syntax
typedef struct { String Host; String Version; String Ciphersuite; DynamicArrayConnectionId; bool Abort; } TsbxJAdESVerifierTLSEstablishedEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTLSEstablishedEvent)(System::TObject* Sender, TsbxJAdESVerifierTLSEstablishedEventParams *e); __property TsbxJAdESVerifierTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };
Remarks
The component 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 (JAdESVerifier Component)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
typedef struct { String Host; bool Abort; } TsbxJAdESVerifierTLSHandshakeEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTLSHandshakeEvent)(System::TObject* Sender, TsbxJAdESVerifierTLSHandshakeEventParams *e); __property TsbxJAdESVerifierTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };
Remarks
The component 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 (JAdESVerifier Component)
Reports the graceful closure of a TLS connection.
Syntax
typedef struct { String Host; } TsbxJAdESVerifierTLSShutdownEventParams; typedef void __fastcall (__closure *TsbxJAdESVerifierTLSShutdownEvent)(System::TObject* Sender, TsbxJAdESVerifierTLSShutdownEventParams *e); __property TsbxJAdESVerifierTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };
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 (JAdESVerifier Component)
The component 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 component, access to these internal properties is provided through the Config method.JAdESVerifier Config Settings
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.
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".
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.
Key ID is a hint indicating which key was used to secure the JWS or JAdES.
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
- 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
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
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) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (JAdESVerifier Component)
JAdESVerifier Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Component 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) |