MessageTimestampVerifier Component

Properties   Methods   Events   Config Settings   Errors  

The MessageTimestampVerifier component verifies message timestamps.

Syntax

TsbxMessageTimestampVerifier

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS. MessageTimestampVerifier timestampVerifier = new MessageTimestampVerifier(); // Select the file which contains the message that is timestamped timestampVerifier.setInputFile("timestampedMessage.bin"); // Select the file where the output will be written timestampVerifier.setOutputFile("verifiedTimestamp.txt"); timestampVerifier.verify(); // verify System.out.println("Validation result: " + timestampVerifier.getSignatureValidationResult() + "\n" + "Signing time: " + timestampVerifier.getValidatedSigningTime() + "\n" + "TSA certificate: " + timestampVerifier.getSigningCertificate().getSubjectRDN()); // Output: // Validation result: 0 // 0 == svtValid // Signing time: 2024-05-16 14:54:33 // TSA certificate: /C=US/O=Big Little Timestamping Service/CN=Big Little Timestamper

Property List

---

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

Method List

---

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

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.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

CertCount Property (MessageTimestampVerifier 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
• CertCertType
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertOCSPNoCheck
• CertOrigin
• CertPolicyIDs
• CertPrivateKeyBytes
• CertPrivateKeyExists
• CertPrivateKeyExtractable
• CertPublicKeyBytes
• CertQualified
• CertQualifiedStatements
• CertQualifiers
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSource
• CertSubject
• CertSubjectAlternativeName
• CertSubjectKeyID
• CertSubjectRDN
• CertValid
• CertValidFrom
• CertValidTo

The array indices start at 0 and end at CertCount - 1.

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

Data Type

Integer

CertBytes Property (MessageTimestampVerifier Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CertBytes[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 (MessageTimestampVerifier Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool CertCA[int CertIndex] = { read=FCertCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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 (MessageTimestampVerifier Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

__property DynamicArray CertCAKeyID[int CertIndex] = { read=FCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID 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

Byte Array

CertCertType Property (MessageTimestampVerifier Component)

Returns the type of the entity contained in the Certificate object.

Syntax

__property TsbxMessageTimestampVerifierCertCertTypes CertCertType[int CertIndex] = { read=FCertCertType };

enum TsbxMessageTimestampVerifierCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager component to load or create new certificate and certificate requests objects.

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

CertCRLDistributionPoints Property (MessageTimestampVerifier Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String CertCRLDistributionPoints[int CertIndex] = { read=FCertCRLDistributionPoints };

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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 (MessageTimestampVerifier Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String CertCurve[int CertIndex] = { read=FCertCurve };

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC 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

String

CertFingerprint Property (MessageTimestampVerifier Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property String CertFingerprint[int CertIndex] = { read=FCertFingerprint };

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

CertFriendlyName Property (MessageTimestampVerifier 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 friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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 (MessageTimestampVerifier 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 (MessageTimestampVerifier Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String CertHashAlgorithm[int CertIndex] = { read=FCertHashAlgorithm };

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use CertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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 (MessageTimestampVerifier 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. This is part of a larger set of credentials available via CertIssuerRDN.

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 (MessageTimestampVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String CertIssuerRDN[int CertIndex] = { read=FCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

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 (MessageTimestampVerifier 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.

Use the CertKeyBits, CertCurve, and CertPublicKeyBytes properties to get more details about the key the certificate contains.

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 (MessageTimestampVerifier Component)

Returns the length of the public key in bits.

Syntax

__property int CertKeyBits[int CertIndex] = { read=FCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the CertPublicKeyBytes or CertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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 (MessageTimestampVerifier Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

__property String CertKeyFingerprint[int CertIndex] = { read=FCertKeyFingerprint };

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the CertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same 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

String

CertKeyUsage Property (MessageTimestampVerifier 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:

Set this property before generating the certificate to propagate the key usage flags to the new 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

Integer

CertKeyValid Property (MessageTimestampVerifier 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 (MessageTimestampVerifier Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

__property String CertOCSPLocations[int CertIndex] = { read=FCertOCSPLocations };

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

CertOCSPNoCheck Property (MessageTimestampVerifier Component)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

__property bool CertOCSPNoCheck[int CertIndex] = { read=FCertOCSPNoCheck };

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check 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

CertOrigin Property (MessageTimestampVerifier Component)

Returns the location that the certificate was taken or loaded from.

Syntax

__property int CertOrigin[int CertIndex] = { read=FCertOrigin };

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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

CertPolicyIDs Property (MessageTimestampVerifier 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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

CertPrivateKeyBytes Property (MessageTimestampVerifier Component)

Returns the certificate's private key in DER-encoded format.

Syntax

__property DynamicArray CertPrivateKeyBytes[int CertIndex] = { read=FCertPrivateKeyBytes };

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

CertPrivateKeyExists Property (MessageTimestampVerifier Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

__property bool CertPrivateKeyExists[int CertIndex] = { read=FCertPrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from CertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

CertPrivateKeyExtractable Property (MessageTimestampVerifier Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool CertPrivateKeyExtractable[int CertIndex] = { read=FCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

CertPublicKeyBytes Property (MessageTimestampVerifier Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray CertPublicKeyBytes[int CertIndex] = { read=FCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

CertQualified Property (MessageTimestampVerifier Component)

Indicates whether the certificate is qualified.

Syntax

__property bool CertQualified[int CertIndex] = { read=FCertQualified };

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

CertQualifiedStatements Property (MessageTimestampVerifier Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxMessageTimestampVerifierCertQualifiedStatements CertQualifiedStatements[int CertIndex] = { read=FCertQualifiedStatements };

enum TsbxMessageTimestampVerifierCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns a simplified qualified status 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

Integer

CertQualifiers Property (MessageTimestampVerifier Component)

A list of qualifiers.

Syntax

__property String CertQualifiers[int CertIndex] = { read=FCertQualifiers };

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

CertSelfSigned Property (MessageTimestampVerifier 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 (MessageTimestampVerifier Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray CertSerialNumber[int CertIndex] = { read=FCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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 (MessageTimestampVerifier 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.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

CertSource Property (MessageTimestampVerifier Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

__property TsbxMessageTimestampVerifierCertSources CertSource[int CertIndex] = { read=FCertSource };

enum TsbxMessageTimestampVerifierCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

CertSubject Property (MessageTimestampVerifier 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. This is part of a larger set of credentials available via CertSubjectRDN.

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

CertSubjectAlternativeName Property (MessageTimestampVerifier Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

__property String CertSubjectAlternativeName[int CertIndex] = { read=FCertSubjectAlternativeName };

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main CertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

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 (MessageTimestampVerifier Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

__property DynamicArray CertSubjectKeyID[int CertIndex] = { read=FCertSubjectKeyID };

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The CertSubjectKeyID and CertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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 (MessageTimestampVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String CertSubjectRDN[int CertIndex] = { read=FCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

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

CertValid Property (MessageTimestampVerifier Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

__property bool CertValid[int CertIndex] = { read=FCertValid };

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

CertValidFrom Property (MessageTimestampVerifier 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 (MessageTimestampVerifier 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

DataBytes Property (MessageTimestampVerifier Component)

Use this property to pass the timestamped data to component in the byte array form.

Syntax

__property DynamicArray DataBytes = { read=FDataBytes, write=FSetDataBytes };

Remarks

Assign a byte array containing the original timestamped data to this property.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (MessageTimestampVerifier Component)

The name of the file containing the originally timestamped data.

Syntax

__property String DataFile = { read=FDataFile, write=FSetDataFile };

Default Value

""

Remarks

Use this property to provide the original data when validating detached timestamps with VerifyDetached.

Data Type

String

DataFileName Property (MessageTimestampVerifier Component)

Returns the data filename as recorded in the timestamp.

Syntax

__property String DataFileName = { read=FDataFileName };

Default Value

""

Remarks

This read-only property returns the file name of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

Data Type

String

DataURI Property (MessageTimestampVerifier Component)

Returns the data URI as recorded in the timestamp.

Syntax

__property String DataURI = { read=FDataURI };

Default Value

""

Remarks

This read-only property returns the URI of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

Data Type

String

FIPSMode Property (MessageTimestampVerifier Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (MessageTimestampVerifier Component)

Use this property to pass the input to component in byte array form.

Syntax

__property DynamicArray InputBytes = { 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 (MessageTimestampVerifier Component)

Path to the file containing the timestamped message.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

Use this property to provide a file containing the timestamped data, either enveloping or detached.

Data Type

String

OutputBytes Property (MessageTimestampVerifier Component)

Use this property to read the output the component object has produced.

Syntax

__property DynamicArray OutputBytes = { 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 (MessageTimestampVerifier Component)

Path to the file to save the extracted data to.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

Use this property when validating enveloping timestamps to specify the output file where the extracted message should be saved.

Data Type

String

SignatureValidationResult Property (MessageTimestampVerifier Component)

The signature validation result.

Syntax

__property TsbxMessageTimestampVerifierSignatureValidationResults SignatureValidationResult = { read=FSignatureValidationResult };

enum TsbxMessageTimestampVerifierSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

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

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

Data Type

Integer

SigningCertBytes Property (MessageTimestampVerifier Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertCA Property (MessageTimestampVerifier Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool SigningCertCA = { read=FSigningCertCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

Data Type

Boolean

SigningCertCAKeyID Property (MessageTimestampVerifier Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

__property DynamicArray SigningCertCAKeyID = { read=FSigningCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SigningCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

Data Type

Byte Array

SigningCertCertType Property (MessageTimestampVerifier Component)

Returns the type of the entity contained in the Certificate object.

Syntax

__property TsbxMessageTimestampVerifierSigningCertCertTypes SigningCertCertType = { read=FSigningCertCertType };

enum TsbxMessageTimestampVerifierSigningCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager component to load or create new certificate and certificate requests objects.

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

Data Type

Integer

SigningCertCRLDistributionPoints Property (MessageTimestampVerifier Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String SigningCertCRLDistributionPoints = { read=FSigningCertCRLDistributionPoints };

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

SigningCertCurve Property (MessageTimestampVerifier Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String SigningCertCurve = { read=FSigningCertCurve };

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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

Data Type

String

SigningCertFingerprint Property (MessageTimestampVerifier Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property String SigningCertFingerprint = { read=FSigningCertFingerprint };

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Data Type

String

SigningCertFriendlyName Property (MessageTimestampVerifier Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

__property String SigningCertFriendlyName = { read=FSigningCertFriendlyName };

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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

Data Type

String

SigningCertHandle Property (MessageTimestampVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

SigningCertHashAlgorithm Property (MessageTimestampVerifier Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String SigningCertHashAlgorithm = { read=FSigningCertHashAlgorithm };

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigningCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

Data Type

String

SigningCertIssuer Property (MessageTimestampVerifier Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String SigningCertIssuer = { read=FSigningCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via SigningCertIssuerRDN.

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

Data Type

String

SigningCertIssuerRDN Property (MessageTimestampVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String SigningCertIssuerRDN = { read=FSigningCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

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

Data Type

String

SigningCertKeyAlgorithm Property (MessageTimestampVerifier Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String SigningCertKeyAlgorithm = { read=FSigningCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the SigningCertKeyBits, SigningCertCurve, and SigningCertPublicKeyBytes properties to get more details about the key the certificate contains.

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

Data Type

String

SigningCertKeyBits Property (MessageTimestampVerifier Component)

Returns the length of the public key in bits.

Syntax

__property int SigningCertKeyBits = { read=FSigningCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the SigningCertPublicKeyBytes or SigningCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

Data Type

Integer

SigningCertKeyFingerprint Property (MessageTimestampVerifier Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

__property String SigningCertKeyFingerprint = { read=FSigningCertKeyFingerprint };

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the SigningCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

Data Type

String

SigningCertKeyUsage Property (MessageTimestampVerifier Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int SigningCertKeyUsage = { read=FSigningCertKeyUsage };

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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

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

Data Type

Integer

SigningCertKeyValid Property (MessageTimestampVerifier Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

__property bool SigningCertKeyValid = { read=FSigningCertKeyValid };

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

SigningCertOCSPLocations Property (MessageTimestampVerifier Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

__property String SigningCertOCSPLocations = { read=FSigningCertOCSPLocations };

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

SigningCertOCSPNoCheck Property (MessageTimestampVerifier Component)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

__property bool SigningCertOCSPNoCheck = { read=FSigningCertOCSPNoCheck };

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

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

Data Type

Boolean

SigningCertOrigin Property (MessageTimestampVerifier Component)

Returns the location that the certificate was taken or loaded from.

Syntax

__property int SigningCertOrigin = { read=FSigningCertOrigin };

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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

Data Type

Integer

SigningCertPolicyIDs Property (MessageTimestampVerifier Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String SigningCertPolicyIDs = { read=FSigningCertPolicyIDs };

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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

Data Type

String

SigningCertPrivateKeyBytes Property (MessageTimestampVerifier Component)

Returns the certificate's private key in DER-encoded format.

Syntax

__property DynamicArray SigningCertPrivateKeyBytes = { read=FSigningCertPrivateKeyBytes };

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

Data Type

Byte Array

SigningCertPrivateKeyExists Property (MessageTimestampVerifier Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

__property bool SigningCertPrivateKeyExists = { read=FSigningCertPrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from SigningCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Data Type

Boolean

SigningCertPrivateKeyExtractable Property (MessageTimestampVerifier Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool SigningCertPrivateKeyExtractable = { read=FSigningCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

Data Type

Boolean

SigningCertPublicKeyBytes Property (MessageTimestampVerifier Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray SigningCertPublicKeyBytes = { read=FSigningCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Data Type

Byte Array

SigningCertQualified Property (MessageTimestampVerifier Component)

Indicates whether the certificate is qualified.

Syntax

__property bool SigningCertQualified = { read=FSigningCertQualified };

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

Data Type

Boolean

SigningCertQualifiedStatements Property (MessageTimestampVerifier Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxMessageTimestampVerifierSigningCertQualifiedStatements SigningCertQualifiedStatements = { read=FSigningCertQualifiedStatements };

enum TsbxMessageTimestampVerifierSigningCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns a simplified qualified status of the certificate.

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

Data Type

Integer

SigningCertQualifiers Property (MessageTimestampVerifier Component)

A list of qualifiers.

Syntax

__property String SigningCertQualifiers = { read=FSigningCertQualifiers };

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

Data Type

String

SigningCertSelfSigned Property (MessageTimestampVerifier Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool SigningCertSelfSigned = { read=FSigningCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

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

Data Type

Boolean

SigningCertSerialNumber Property (MessageTimestampVerifier Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray SigningCertSerialNumber = { read=FSigningCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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

Data Type

Byte Array

SigningCertSigAlgorithm Property (MessageTimestampVerifier Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String SigningCertSigAlgorithm = { read=FSigningCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

Data Type

String

SigningCertSource Property (MessageTimestampVerifier Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

__property TsbxMessageTimestampVerifierSigningCertSources SigningCertSource = { read=FSigningCertSource };

enum TsbxMessageTimestampVerifierSigningCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

Data Type

Integer

SigningCertSubject Property (MessageTimestampVerifier 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 SigningCertSubject = { read=FSigningCertSubject };

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. This is part of a larger set of credentials available via SigningCertSubjectRDN.

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

Data Type

String

SigningCertSubjectAlternativeName Property (MessageTimestampVerifier Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

__property String SigningCertSubjectAlternativeName = { read=FSigningCertSubjectAlternativeName };

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main SigningCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

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

Data Type

String

SigningCertSubjectKeyID Property (MessageTimestampVerifier Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

__property DynamicArray SigningCertSubjectKeyID = { read=FSigningCertSubjectKeyID };

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SigningCertSubjectKeyID and SigningCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

Data Type

Byte Array

SigningCertSubjectRDN Property (MessageTimestampVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String SigningCertSubjectRDN = { read=FSigningCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

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

Data Type

String

SigningCertValid Property (MessageTimestampVerifier Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

__property bool SigningCertValid = { read=FSigningCertValid };

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

Data Type

Boolean

SigningCertValidFrom Property (MessageTimestampVerifier Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String SigningCertValidFrom = { read=FSigningCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

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

Data Type

String

SigningCertValidTo Property (MessageTimestampVerifier Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String SigningCertValidTo = { read=FSigningCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

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

Data Type

String

TimestampFormat Property (MessageTimestampVerifier Component)

Returns the format of the processed timestamp.

Syntax

__property TsbxMessageTimestampVerifierTimestampFormats TimestampFormat = { read=FTimestampFormat };

enum TsbxMessageTimestampVerifierTimestampFormats {
  mtfUnknown=0,
  mtfRFC5544=1,
  mtfCMS=2,
  mtfTSPReply=3
};

Default Value

mtfUnknown

Remarks

Use this property to check the format of the processed timestamp blob.

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

Data Type

Integer

ValidatedSigningTime Property (MessageTimestampVerifier Component)

Contains the certified signing time.

Syntax

__property String ValidatedSigningTime = { read=FValidatedSigningTime };

Default Value

""

Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

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

Data Type

String

Config Method (MessageTimestampVerifier 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 (MessageTimestampVerifier 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;....

Reset Method (MessageTimestampVerifier Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Verify Method (MessageTimestampVerifier Component)

Verifies a timestamped message.

Syntax

void __fastcall Verify();

Remarks

Use this method to verify the enveloping timestamped message provided via InputFile (or InputStream). The original message will be extracted and saved to OutputFile (OutputStream).

Use VerifyDetached to verify detached timestamps.

VerifyDetached Method (MessageTimestampVerifier Component)

Verifies a detached timestamped message.

Syntax

void __fastcall VerifyDetached();

Remarks

Use this method to verify the detached timestamped message provided via InputFile (or InputStream). Please provide the original data via DataFile or DataStream property. You do not need to provide OutputFile and OutputStream, as no data is extracted during this call.

Use Verify to verify enveloping timestamps.

Error Event (MessageTimestampVerifier Component)

Information about errors during PKCS#7 message encryption.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxMessageTimestampVerifierErrorEventParams;
typedef void __fastcall (__closure *TsbxMessageTimestampVerifierErrorEvent)(System::TObject* Sender, TsbxMessageTimestampVerifierErrorEventParams *e);
__property TsbxMessageTimestampVerifierErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Messages section.

Notification Event (MessageTimestampVerifier Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxMessageTimestampVerifierNotificationEventParams;
typedef void __fastcall (__closure *TsbxMessageTimestampVerifierNotificationEvent)(System::TObject* Sender, TsbxMessageTimestampVerifierNotificationEventParams *e);
__property TsbxMessageTimestampVerifierNotificationEvent 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.

Config Settings (MessageTimestampVerifier 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.

MessageTimestampVerifier Config Settings

Base Config Settings

Trappable Errors (MessageTimestampVerifier Component)

MessageTimestampVerifier Errors