PDFSign Component

Properties   Methods   Events   Config Settings   Errors  

The PDFSign component signs PDF documents.

Syntax

TispPDFSign

Remarks

The PDFSign component can sign PDF documents in accordance with a selection of PDF and PAdES signature standards, including basic Adobe signatures (ISO 32000) and PAdES signatures (ETSI EN 319 142-1).

Preparing the Signature

To configure PDFSign to produce the desired signature, first provide the input document as a file (InputFile), byte array (InputData), or stream (SetInputStream) and assign your signing certificate to the SigningCert property. Then indicate where to save the output document by setting OutputFile or calling SetOutputStream.

Optionally specify the Signature* properties and the TimestampServer property, and adjust any chain validation parameters as necessary (please see the Chain Validation Setup section for more details). Finally, call the Sign method.

PDFSign also provides means to customize the appearance of the signature widget to be shown on the document page. You can create your very own signatures (e.g., in the form of your company's logo) by adjusting the widget properties available in the SetWidgetProperty method. Alternatively, you can choose not to associate any widget with your signature by setting the Invisible widget property to true.

The Signing Process

Depending on the configuration, the signing process may be as straightforward as calculating the document hash and signing it with the private key, or it may involve the advanced chain validation routine. During the latter, the component may contact external revocation (i.e., CRL and OCSP endpoints) and trust sources to establish the validity of the signing certificate.

If an external TSA server was provided via the TimestampServer property, the component will also contact it to timestamp the new signature.

During signing, PDFSign may fire events to notify your code about certain conditions. For example, if the input document is encrypted but no decryption parameters were found in the Password or DecryptionCert properties, the component will fire either the Password or RecipientInfo event to tell your code that it needs decryption information to be able to continue with the signing. Additionally, the SSLServerAuthentication event will fire if one of the HTTP endpoints involved during the operation (which may be a TSA, CRL, OCSP, or Trusted List service) operates over TLS and needs its certificate to be validated.

Basic Adobe Signatures

A basic (also known as legacy) Adobe signature is an original Adobe Acrobat document signature. This is an outdated form of PDF signature - while PAdES is loosely built on it, this signature type does not support extended features and is not compliant with PAdES. Unless the recipient of your signed documents expects you to specifically use this kind of signature, it is unlikely that you will ever need it.

PAdES Signatures and Profiles

In PAdES, a given signature's profile describes the level of "completeness" of the validation material (i.e., certificates, CRLs, and OCSP responses) included in the signature. For example, signatures compliant with the PAdES B-B or PAdES B-T profiles do not require any validation material at all, whereas signatures compliant with the PAdES B-LTA profile must contain complete validation material.

PAdES B-B

The PAdES B-B profile is the baseline profile that uses the PAdES-BES signature level by default, meaning the signature only contains the signing time and signer information.

Use the following code to create a B-B signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineB; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES-EPES

To instead create a PAdES-EPES signature that includes the signature-policy-identifier attribute, set the PolicyHash, PolicyHashAlgorithm, and PolicyId configuration settings before calling the Sign method.

This profile, in both the BES and EPES settings, creates a basic signature that remains valid as long as the signing certificate has not expired or been revoked. Signatures at this level need not contain any validation material.

PAdES B-T

The PAdES B-T profile extends the basic BES or EPES signature by adding a signature timestamp. This timestamp certifies that the signature was created at a specific moment in time. Similar to the B-B profile, signatures at this level need not contain any validation material.

Use the following code to create a B-T signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES B-LTA

The PAdES B-LTA profile is used to achieve signatures that are equipped with long-term archival (LTA) or long-term validation (LTV) capabilities. It incorporates into the signature all the material required to validate the signature, including signing certificates, timestamping certificates, and revocation information. It also adds a document timestamp, which certifies the integrity of both the document and the complete validation material at a specific moment in time. This guarantees that no relevant certificates were expired or revoked at the signature creation time, and enables the signature to be verified offline.

Creating a B-LTA signature with PDFSign is a two-step process. First Sign the document and add a signature timestamp, setting SignatureProfile appropriately. Then Update the signature to take care of the rest (collect and embed the validation material, and add a document timestamp): pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); // Update the signature to LTV - this will retrieve the necessary revocation // elements, embed them into the document, and add a document timestamp pdfsign.Reset(); pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "updated.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.Update(); Note that validation material "completeness" can be subjective and depends on several factors, including:

• The working environment. For example, your organization may explicitly trust its own self-signed TSA certificate. Signatures timestamped with this certificate will be considered B-LTA by your organization, but for any external bodies, those signatures would be rendered as B-LT or even B-B, as they do not know or trust the custom TSA certificate.
• The time that has passed since the last document timestamp. If an archived (B-LTA) document is not re-timestamped before its last timestamp expires, it will drop back to a lower signature level.

Chain Validation Setup

Chain validation is a sophisticated, multi-faceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to adjust your chain validation parameters to best fit your requirements. A summary of these parameters is given below.

Note that these parameters apply to the Sign and Update methods in PDFSign as well as the Verify method in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled).

Validation Policy

The ValidationPolicy property dictates how thoroughly the chain will be validated. It includes options to control which checks the component will perform, allowing you to tailor the validation process to meet your specific security needs. For example, if it is not essential to check each certificate's revocation status, set this property to vpFullNoRevocation.

Revocation

The revocation aspect of chain validation is controlled by the RevocationCheck property, which allows you to choose between and prioritize revocation origins. Note that OCSP sources are often preferred to CRL endpoints because of their real-time capability and the smaller size of the responses they produce.

Trust

The trust aspect of chain validation is controlled by the TrustSources property, which allows you to specify the locations in which the component will search for trust anchors. Local system stores, your own trusted root certificates (via the TrustedCerts property), and Trusted Lists (via the TrustedLists property) are all supported.

Offline Mode

The OfflineMode property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the component will only use KnownCerts, TrustedCerts, data structures within the document itself, and revocation and Trusted List data that it previously saved to its internal cache when looking for missing validation material.

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.

AttachmentCount Property (PDFSign Component)

The number of records in the Attachment arrays.

Syntax

__property int AttachmentCount = { read=FAttachmentCount, write=FSetAttachmentCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentCreationDate
• AttachmentData
• AttachmentDescription
• AttachmentFileName
• AttachmentModificationDate
• AttachmentName
• AttachmentSize

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

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (PDFSign Component)

The content type of the attachment.

Syntax

__property String AttachmentContentType[int AttachmentIndex] = { read=FAttachmentContentType, write=FSetAttachmentContentType };

Default Value

""

Remarks

The content type of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentCreationDate Property (PDFSign Component)

The creation date of the attachment.

Syntax

__property String AttachmentCreationDate[int AttachmentIndex] = { read=FAttachmentCreationDate, write=FSetAttachmentCreationDate };

Default Value

""

Remarks

The creation date of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentData Property (PDFSign Component)

The raw data of the attachment.

Syntax

__property String AttachmentData[int AttachmentIndex] = { read=FAttachmentData, write=FSetAttachmentData };
__property DynamicArray<Byte> AttachmentDataB[int AttachmentIndex] = { read=FAttachmentDataB, write=FSetAttachmentDataB };

Default Value

""

Remarks

The raw data of the attachment.

If AttachmentOutputStream is not set to a valid stream, the component will write to this property when an empty string is passed to the SaveAttachment method.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Byte Array

AttachmentDescription Property (PDFSign Component)

A textual description of the attachment.

Syntax

__property String AttachmentDescription[int AttachmentIndex] = { read=FAttachmentDescription, write=FSetAttachmentDescription };

Default Value

""

Remarks

A textual description of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentFileName Property (PDFSign Component)

The path and filename of the attachment.

Syntax

__property String AttachmentFileName[int AttachmentIndex] = { read=FAttachmentFileName, write=FSetAttachmentFileName };

Default Value

""

Remarks

The path and filename of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentModificationDate Property (PDFSign Component)

The date and time of the file's last modification.

Syntax

__property String AttachmentModificationDate[int AttachmentIndex] = { read=FAttachmentModificationDate, write=FSetAttachmentModificationDate };

Default Value

""

Remarks

The date and time of the file's last modification.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (PDFSign Component)

The name of the attachment.

Syntax

__property String AttachmentName[int AttachmentIndex] = { read=FAttachmentName, write=FSetAttachmentName };

Default Value

""

Remarks

The name of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentSize Property (PDFSign Component)

The attachment's size in bytes.

Syntax

__property __int64 AttachmentSize[int AttachmentIndex] = { read=FAttachmentSize };

Default Value

0

Remarks

The attachment's size in bytes.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

Long64

BlockedCertCount Property (PDFSign 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:

• BlockedCertEffectiveDate
• BlockedCertEncoded
• BlockedCertExpirationDate
• BlockedCertExtendedKeyUsage
• BlockedCertFingerprint
• BlockedCertFingerprintSHA1
• BlockedCertFingerprintSHA256
• BlockedCertIssuer
• BlockedCertPrivateKey
• BlockedCertPrivateKeyAvailable
• BlockedCertPrivateKeyContainer
• BlockedCertPublicKey
• BlockedCertPublicKeyAlgorithm
• BlockedCertPublicKeyLength
• BlockedCertSerialNumber
• BlockedCertSignatureAlgorithm
• BlockedCertStore
• BlockedCertStorePassword
• BlockedCertStoreType
• BlockedCertSubject
• BlockedCertSubjectAltNames
• BlockedCertThumbprintMD5
• BlockedCertThumbprintSHA1
• BlockedCertThumbprintSHA256
• BlockedCertUsage
• BlockedCertUsageFlags
• BlockedCertVersion

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

This property is not available at design time.

Data Type

Integer

BlockedCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

__property String BlockedCertEffectiveDate[int BlockedCertIndex] = { read=FBlockedCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

String

BlockedCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

__property String BlockedCertExpirationDate[int BlockedCertIndex] = { read=FBlockedCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

String

BlockedCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String BlockedCertExtendedKeyUsage[int BlockedCertIndex] = { read=FBlockedCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

String

BlockedCertFingerprint Property (PDFSign Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String BlockedCertFingerprint[int BlockedCertIndex] = { read=FBlockedCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

String

BlockedCertFingerprintSHA1 Property (PDFSign Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String BlockedCertFingerprintSHA1[int BlockedCertIndex] = { read=FBlockedCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

String

BlockedCertFingerprintSHA256 Property (PDFSign Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String BlockedCertFingerprintSHA256[int BlockedCertIndex] = { read=FBlockedCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

String

BlockedCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

__property String BlockedCertIssuer[int BlockedCertIndex] = { read=FBlockedCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

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

String

BlockedCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

__property String BlockedCertPrivateKey[int BlockedCertIndex] = { read=FBlockedCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The BlockedCertPrivateKey may be available but not exportable. In this case, BlockedCertPrivateKey returns an empty string.

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

String

BlockedCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool BlockedCertPrivateKeyAvailable[int BlockedCertIndex] = { read=FBlockedCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a BlockedCertPrivateKey is available for the selected certificate. If BlockedCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

Boolean

BlockedCertPrivateKeyContainer Property (PDFSign Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String BlockedCertPrivateKeyContainer[int BlockedCertIndex] = { read=FBlockedCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the BlockedCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

String

BlockedCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

__property String BlockedCertPublicKey[int BlockedCertIndex] = { read=FBlockedCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

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

String

BlockedCertPublicKeyAlgorithm Property (PDFSign Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String BlockedCertPublicKeyAlgorithm[int BlockedCertIndex] = { read=FBlockedCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

String

BlockedCertPublicKeyLength Property (PDFSign Component)

The length of the certificate's public key (in bits).

Syntax

__property int BlockedCertPublicKeyLength[int BlockedCertIndex] = { read=FBlockedCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

Integer

BlockedCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

__property String BlockedCertSerialNumber[int BlockedCertIndex] = { read=FBlockedCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

String

BlockedCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

__property String BlockedCertSignatureAlgorithm[int BlockedCertIndex] = { read=FBlockedCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

String

BlockedCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

__property String BlockedCertStore[int BlockedCertIndex] = { read=FBlockedCertStore, write=FSetBlockedCertStore };
__property DynamicArray<Byte> BlockedCertStoreB[int BlockedCertIndex] = { read=FBlockedCertStoreB, write=FSetBlockedCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The BlockedCertStoreType property denotes the type of the certificate store specified by BlockedCertStore. If the store is password-protected, specify the password in BlockedCertStorePassword.

BlockedCertStore is used in conjunction with the BlockedCertSubject property to specify client certificates. If BlockedCertStore has a value, and BlockedCertSubject or BlockedCertEncoded is set, a search for a certificate is initiated. Please see the BlockedCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

Byte Array

BlockedCertStorePassword Property (PDFSign Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String BlockedCertStorePassword[int BlockedCertIndex] = { read=FBlockedCertStorePassword, write=FSetBlockedCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

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

String

BlockedCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFSignBlockedCertStoreTypes BlockedCertStoreType[int BlockedCertIndex] = { read=FBlockedCertStoreType, write=FSetBlockedCertStoreType };

enum TispPDFSignBlockedCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

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

Integer

BlockedCertSubjectAltNames Property (PDFSign Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String BlockedCertSubjectAltNames[int BlockedCertIndex] = { read=FBlockedCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

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

String

BlockedCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

__property String BlockedCertThumbprintMD5[int BlockedCertIndex] = { read=FBlockedCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

BlockedCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

__property String BlockedCertThumbprintSHA1[int BlockedCertIndex] = { read=FBlockedCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

BlockedCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

__property String BlockedCertThumbprintSHA256[int BlockedCertIndex] = { read=FBlockedCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

BlockedCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

__property String BlockedCertUsage[int BlockedCertIndex] = { read=FBlockedCertUsage };

Default Value

""

Remarks

The text description of BlockedCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

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

String

BlockedCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

__property int BlockedCertUsageFlags[int BlockedCertIndex] = { read=FBlockedCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of BlockedCertUsageFlags is a combination of the following flags:

Please see the BlockedCertUsage property for a text representation of BlockedCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

Integer

BlockedCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

__property String BlockedCertVersion[int BlockedCertIndex] = { read=FBlockedCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

String

BlockedCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

__property String BlockedCertSubject[int BlockedCertIndex] = { read=FBlockedCertSubject, write=FSetBlockedCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

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

String

BlockedCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String BlockedCertEncoded[int BlockedCertIndex] = { read=FBlockedCertEncoded, write=FSetBlockedCertEncoded };
__property DynamicArray<Byte> BlockedCertEncodedB[int BlockedCertIndex] = { read=FBlockedCertEncodedB, write=FSetBlockedCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The BlockedCertStore and BlockedCertSubject properties also may be used to specify a certificate.

When BlockedCertEncoded is set, a search is initiated in the current BlockedCertStore for the private key of the certificate. If the key is found, BlockedCertSubject is updated to reflect the full subject of the selected certificate; otherwise, BlockedCertSubject is set to an empty string.

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

Byte Array

DecryptionCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

__property String DecryptionCertEffectiveDate = { read=FDecryptionCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

Data Type

String

DecryptionCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

__property String DecryptionCertExpirationDate = { read=FDecryptionCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

Data Type

String

DecryptionCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String DecryptionCertExtendedKeyUsage = { read=FDecryptionCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

Data Type

String

DecryptionCertFingerprint Property (PDFSign Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String DecryptionCertFingerprint = { read=FDecryptionCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

Data Type

String

DecryptionCertFingerprintSHA1 Property (PDFSign Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String DecryptionCertFingerprintSHA1 = { read=FDecryptionCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

Data Type

String

DecryptionCertFingerprintSHA256 Property (PDFSign Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String DecryptionCertFingerprintSHA256 = { read=FDecryptionCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

Data Type

String

DecryptionCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

__property String DecryptionCertIssuer = { read=FDecryptionCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

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

Data Type

String

DecryptionCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

__property String DecryptionCertPrivateKey = { read=FDecryptionCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The DecryptionCertPrivateKey may be available but not exportable. In this case, DecryptionCertPrivateKey returns an empty string.

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

Data Type

String

DecryptionCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool DecryptionCertPrivateKeyAvailable = { read=FDecryptionCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a DecryptionCertPrivateKey is available for the selected certificate. If DecryptionCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

Data Type

Boolean

DecryptionCertPrivateKeyContainer Property (PDFSign Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String DecryptionCertPrivateKeyContainer = { read=FDecryptionCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the DecryptionCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

Data Type

String

DecryptionCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

__property String DecryptionCertPublicKey = { read=FDecryptionCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

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

Data Type

String

DecryptionCertPublicKeyAlgorithm Property (PDFSign Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String DecryptionCertPublicKeyAlgorithm = { read=FDecryptionCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

Data Type

String

DecryptionCertPublicKeyLength Property (PDFSign Component)

The length of the certificate's public key (in bits).

Syntax

__property int DecryptionCertPublicKeyLength = { read=FDecryptionCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

Data Type

Integer

DecryptionCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

__property String DecryptionCertSerialNumber = { read=FDecryptionCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

Data Type

String

DecryptionCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

__property String DecryptionCertSignatureAlgorithm = { read=FDecryptionCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

Data Type

String

DecryptionCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

__property String DecryptionCertStore = { read=FDecryptionCertStore, write=FSetDecryptionCertStore };
__property DynamicArray<Byte> DecryptionCertStoreB = { read=FDecryptionCertStoreB, write=FSetDecryptionCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The DecryptionCertStoreType property denotes the type of the certificate store specified by DecryptionCertStore. If the store is password-protected, specify the password in DecryptionCertStorePassword.

DecryptionCertStore is used in conjunction with the DecryptionCertSubject property to specify client certificates. If DecryptionCertStore has a value, and DecryptionCertSubject or DecryptionCertEncoded is set, a search for a certificate is initiated. Please see the DecryptionCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is not available at design time.

Data Type

Byte Array

DecryptionCertStorePassword Property (PDFSign Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String DecryptionCertStorePassword = { read=FDecryptionCertStorePassword, write=FSetDecryptionCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is not available at design time.

Data Type

String

DecryptionCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFSignDecryptionCertStoreTypes DecryptionCertStoreType = { read=FDecryptionCertStoreType, write=FSetDecryptionCertStoreType };

enum TispPDFSignDecryptionCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

This property is not available at design time.

Data Type

Integer

DecryptionCertSubjectAltNames Property (PDFSign Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String DecryptionCertSubjectAltNames = { read=FDecryptionCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

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

Data Type

String

DecryptionCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

__property String DecryptionCertThumbprintMD5 = { read=FDecryptionCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

DecryptionCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

__property String DecryptionCertThumbprintSHA1 = { read=FDecryptionCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

DecryptionCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

__property String DecryptionCertThumbprintSHA256 = { read=FDecryptionCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

DecryptionCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

__property String DecryptionCertUsage = { read=FDecryptionCertUsage };

Default Value

""

Remarks

The text description of DecryptionCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

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

Data Type

String

DecryptionCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

__property int DecryptionCertUsageFlags = { read=FDecryptionCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of DecryptionCertUsageFlags is a combination of the following flags:

Please see the DecryptionCertUsage property for a text representation of DecryptionCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

Data Type

Integer

DecryptionCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

__property String DecryptionCertVersion = { read=FDecryptionCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

Data Type

String

DecryptionCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

__property String DecryptionCertSubject = { read=FDecryptionCertSubject, write=FSetDecryptionCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is not available at design time.

Data Type

String

DecryptionCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String DecryptionCertEncoded = { read=FDecryptionCertEncoded, write=FSetDecryptionCertEncoded };
__property DynamicArray<Byte> DecryptionCertEncodedB = { read=FDecryptionCertEncodedB, write=FSetDecryptionCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The DecryptionCertStore and DecryptionCertSubject properties also may be used to specify a certificate.

When DecryptionCertEncoded is set, a search is initiated in the current DecryptionCertStore for the private key of the certificate. If the key is found, DecryptionCertSubject is updated to reflect the full subject of the selected certificate; otherwise, DecryptionCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

DocumentCertCount Property (PDFSign Component)

The number of records in the DocumentCert arrays.

Syntax

__property int DocumentCertCount = { read=FDocumentCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• DocumentCertEffectiveDate
• DocumentCertEncoded
• DocumentCertExpirationDate
• DocumentCertExtendedKeyUsage
• DocumentCertFingerprint
• DocumentCertFingerprintSHA1
• DocumentCertFingerprintSHA256
• DocumentCertIssuer
• DocumentCertPrivateKey
• DocumentCertPrivateKeyAvailable
• DocumentCertPrivateKeyContainer
• DocumentCertPublicKey
• DocumentCertPublicKeyAlgorithm
• DocumentCertPublicKeyLength
• DocumentCertSerialNumber
• DocumentCertSignatureAlgorithm
• DocumentCertStore
• DocumentCertStorePassword
• DocumentCertStoreType
• DocumentCertSubject
• DocumentCertSubjectAltNames
• DocumentCertThumbprintMD5
• DocumentCertThumbprintSHA1
• DocumentCertThumbprintSHA256
• DocumentCertUsage
• DocumentCertUsageFlags
• DocumentCertVersion

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

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

Data Type

Integer

DocumentCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

__property String DocumentCertEffectiveDate[int DocumentCertIndex] = { read=FDocumentCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

__property String DocumentCertExpirationDate[int DocumentCertIndex] = { read=FDocumentCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String DocumentCertExtendedKeyUsage[int DocumentCertIndex] = { read=FDocumentCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertFingerprint Property (PDFSign Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String DocumentCertFingerprint[int DocumentCertIndex] = { read=FDocumentCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertFingerprintSHA1 Property (PDFSign Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String DocumentCertFingerprintSHA1[int DocumentCertIndex] = { read=FDocumentCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertFingerprintSHA256 Property (PDFSign Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String DocumentCertFingerprintSHA256[int DocumentCertIndex] = { read=FDocumentCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

__property String DocumentCertIssuer[int DocumentCertIndex] = { read=FDocumentCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

__property String DocumentCertPrivateKey[int DocumentCertIndex] = { read=FDocumentCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The DocumentCertPrivateKey may be available but not exportable. In this case, DocumentCertPrivateKey returns an empty string.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool DocumentCertPrivateKeyAvailable[int DocumentCertIndex] = { read=FDocumentCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a DocumentCertPrivateKey is available for the selected certificate. If DocumentCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

Boolean

DocumentCertPrivateKeyContainer Property (PDFSign Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String DocumentCertPrivateKeyContainer[int DocumentCertIndex] = { read=FDocumentCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the DocumentCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

__property String DocumentCertPublicKey[int DocumentCertIndex] = { read=FDocumentCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertPublicKeyAlgorithm Property (PDFSign Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String DocumentCertPublicKeyAlgorithm[int DocumentCertIndex] = { read=FDocumentCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertPublicKeyLength Property (PDFSign Component)

The length of the certificate's public key (in bits).

Syntax

__property int DocumentCertPublicKeyLength[int DocumentCertIndex] = { read=FDocumentCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

Integer

DocumentCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

__property String DocumentCertSerialNumber[int DocumentCertIndex] = { read=FDocumentCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

__property String DocumentCertSignatureAlgorithm[int DocumentCertIndex] = { read=FDocumentCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

__property String DocumentCertStore[int DocumentCertIndex] = { read=FDocumentCertStore };
__property DynamicArray<Byte> DocumentCertStoreB[int DocumentCertIndex] = { read=FDocumentCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The DocumentCertStoreType property denotes the type of the certificate store specified by DocumentCertStore. If the store is password-protected, specify the password in DocumentCertStorePassword.

DocumentCertStore is used in conjunction with the DocumentCertSubject property to specify client certificates. If DocumentCertStore has a value, and DocumentCertSubject or DocumentCertEncoded is set, a search for a certificate is initiated. Please see the DocumentCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

Byte Array

DocumentCertStorePassword Property (PDFSign Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String DocumentCertStorePassword[int DocumentCertIndex] = { read=FDocumentCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFSignDocumentCertStoreTypes DocumentCertStoreType[int DocumentCertIndex] = { read=FDocumentCertStoreType };

enum TispPDFSignDocumentCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

Integer

DocumentCertSubjectAltNames Property (PDFSign Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String DocumentCertSubjectAltNames[int DocumentCertIndex] = { read=FDocumentCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

__property String DocumentCertThumbprintMD5[int DocumentCertIndex] = { read=FDocumentCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

__property String DocumentCertThumbprintSHA1[int DocumentCertIndex] = { read=FDocumentCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

__property String DocumentCertThumbprintSHA256[int DocumentCertIndex] = { read=FDocumentCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

__property String DocumentCertUsage[int DocumentCertIndex] = { read=FDocumentCertUsage };

Default Value

""

Remarks

The text description of DocumentCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

__property int DocumentCertUsageFlags[int DocumentCertIndex] = { read=FDocumentCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of DocumentCertUsageFlags is a combination of the following flags:

Please see the DocumentCertUsage property for a text representation of DocumentCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

Integer

DocumentCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

__property String DocumentCertVersion[int DocumentCertIndex] = { read=FDocumentCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

__property String DocumentCertSubject[int DocumentCertIndex] = { read=FDocumentCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

String

DocumentCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String DocumentCertEncoded[int DocumentCertIndex] = { read=FDocumentCertEncoded };
__property DynamicArray<Byte> DocumentCertEncodedB[int DocumentCertIndex] = { read=FDocumentCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The DocumentCertStore and DocumentCertSubject properties also may be used to specify a certificate.

When DocumentCertEncoded is set, a search is initiated in the current DocumentCertStore for the private key of the certificate. If the key is found, DocumentCertSubject is updated to reflect the full subject of the selected certificate; otherwise, DocumentCertSubject is set to an empty string.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

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

Data Type

Byte Array

FirewallAutoDetect Property (PDFSign Component)

Whether to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (PDFSign Component)

The type of firewall to connect through.

Syntax

__property TispPDFSignFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TispPDFSignFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (PDFSign Component)

The name or IP address of the firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (PDFSign Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (PDFSign Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (PDFSign Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

InputData Property (PDFSign Component)

A byte array containing the PDF document to process.

Syntax

__property DynamicArray InputData = { read=FInputData, write=FSetInputData };

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFSign Component)

The PDF file to process.

Syntax

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

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

Data Type

String

KnownCertCount Property (PDFSign 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:

• KnownCertEffectiveDate
• KnownCertEncoded
• KnownCertExpirationDate
• KnownCertExtendedKeyUsage
• KnownCertFingerprint
• KnownCertFingerprintSHA1
• KnownCertFingerprintSHA256
• KnownCertIssuer
• KnownCertPrivateKey
• KnownCertPrivateKeyAvailable
• KnownCertPrivateKeyContainer
• KnownCertPublicKey
• KnownCertPublicKeyAlgorithm
• KnownCertPublicKeyLength
• KnownCertSerialNumber
• KnownCertSignatureAlgorithm
• KnownCertStore
• KnownCertStorePassword
• KnownCertStoreType
• KnownCertSubject
• KnownCertSubjectAltNames
• KnownCertThumbprintMD5
• KnownCertThumbprintSHA1
• KnownCertThumbprintSHA256
• KnownCertUsage
• KnownCertUsageFlags
• KnownCertVersion

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

This property is not available at design time.

Data Type

Integer

KnownCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

__property String KnownCertEffectiveDate[int KnownCertIndex] = { read=FKnownCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

String

KnownCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

__property String KnownCertExpirationDate[int KnownCertIndex] = { read=FKnownCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

String

KnownCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String KnownCertExtendedKeyUsage[int KnownCertIndex] = { read=FKnownCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

String

KnownCertFingerprint Property (PDFSign Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String KnownCertFingerprint[int KnownCertIndex] = { read=FKnownCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

String

KnownCertFingerprintSHA1 Property (PDFSign Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String KnownCertFingerprintSHA1[int KnownCertIndex] = { read=FKnownCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

String

KnownCertFingerprintSHA256 Property (PDFSign Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String KnownCertFingerprintSHA256[int KnownCertIndex] = { read=FKnownCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

String

KnownCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

__property String KnownCertIssuer[int KnownCertIndex] = { read=FKnownCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

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

String

KnownCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

__property String KnownCertPrivateKey[int KnownCertIndex] = { read=FKnownCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The KnownCertPrivateKey may be available but not exportable. In this case, KnownCertPrivateKey returns an empty string.

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

String

KnownCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool KnownCertPrivateKeyAvailable[int KnownCertIndex] = { read=FKnownCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a KnownCertPrivateKey is available for the selected certificate. If KnownCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

Boolean

KnownCertPrivateKeyContainer Property (PDFSign Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String KnownCertPrivateKeyContainer[int KnownCertIndex] = { read=FKnownCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the KnownCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

String

KnownCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

__property String KnownCertPublicKey[int KnownCertIndex] = { read=FKnownCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

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

String

KnownCertPublicKeyAlgorithm Property (PDFSign Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String KnownCertPublicKeyAlgorithm[int KnownCertIndex] = { read=FKnownCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

String

KnownCertPublicKeyLength Property (PDFSign Component)

The length of the certificate's public key (in bits).

Syntax

__property int KnownCertPublicKeyLength[int KnownCertIndex] = { read=FKnownCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

Integer

KnownCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

__property String KnownCertSerialNumber[int KnownCertIndex] = { read=FKnownCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

String

KnownCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

__property String KnownCertSignatureAlgorithm[int KnownCertIndex] = { read=FKnownCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

String

KnownCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

__property String KnownCertStore[int KnownCertIndex] = { read=FKnownCertStore, write=FSetKnownCertStore };
__property DynamicArray<Byte> KnownCertStoreB[int KnownCertIndex] = { read=FKnownCertStoreB, write=FSetKnownCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The KnownCertStoreType property denotes the type of the certificate store specified by KnownCertStore. If the store is password-protected, specify the password in KnownCertStorePassword.

KnownCertStore is used in conjunction with the KnownCertSubject property to specify client certificates. If KnownCertStore has a value, and KnownCertSubject or KnownCertEncoded is set, a search for a certificate is initiated. Please see the KnownCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

Byte Array

KnownCertStorePassword Property (PDFSign Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String KnownCertStorePassword[int KnownCertIndex] = { read=FKnownCertStorePassword, write=FSetKnownCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

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

String

KnownCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFSignKnownCertStoreTypes KnownCertStoreType[int KnownCertIndex] = { read=FKnownCertStoreType, write=FSetKnownCertStoreType };

enum TispPDFSignKnownCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

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

Integer

KnownCertSubjectAltNames Property (PDFSign Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String KnownCertSubjectAltNames[int KnownCertIndex] = { read=FKnownCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

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

String

KnownCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

__property String KnownCertThumbprintMD5[int KnownCertIndex] = { read=FKnownCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

KnownCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

__property String KnownCertThumbprintSHA1[int KnownCertIndex] = { read=FKnownCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

KnownCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

__property String KnownCertThumbprintSHA256[int KnownCertIndex] = { read=FKnownCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

KnownCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

__property String KnownCertUsage[int KnownCertIndex] = { read=FKnownCertUsage };

Default Value

""

Remarks

The text description of KnownCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

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

String

KnownCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

__property int KnownCertUsageFlags[int KnownCertIndex] = { read=FKnownCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of KnownCertUsageFlags is a combination of the following flags:

Please see the KnownCertUsage property for a text representation of KnownCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

Integer

KnownCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

__property String KnownCertVersion[int KnownCertIndex] = { read=FKnownCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

String

KnownCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

__property String KnownCertSubject[int KnownCertIndex] = { read=FKnownCertSubject, write=FSetKnownCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

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

String

KnownCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String KnownCertEncoded[int KnownCertIndex] = { read=FKnownCertEncoded, write=FSetKnownCertEncoded };
__property DynamicArray<Byte> KnownCertEncodedB[int KnownCertIndex] = { read=FKnownCertEncodedB, write=FSetKnownCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The KnownCertStore and KnownCertSubject properties also may be used to specify a certificate.

When KnownCertEncoded is set, a search is initiated in the current KnownCertStore for the private key of the certificate. If the key is found, KnownCertSubject is updated to reflect the full subject of the selected certificate; otherwise, KnownCertSubject is set to an empty string.

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

Byte Array

OfflineMode Property (PDFSign Component)

Whether the component is operating in offline mode.

Syntax

__property bool OfflineMode = { read=FOfflineMode, write=FSetOfflineMode };

Default Value

false

Remarks

This property indicates whether the component should operate in offline mode.

In offline mode, the component restricts itself from accessing online Trusted Lists and revocation information sources such as CRLs or OCSP responders. It may be useful to set this property to true if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCerts.

Data Type

Boolean

OutputData Property (PDFSign Component)

A byte array containing the PDF document after processing.

Syntax

__property DynamicArray OutputData = { read=FOutputData };

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

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

Data Type

Byte Array

OutputFile Property (PDFSign Component)

The path to a local file where the output will be written.

Syntax

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

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

Data Type

String

Overwrite Property (PDFSign Component)

Whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

This property indicates whether or not the component will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to false, an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Data Type

Boolean

Password Property (PDFSign Component)

The password to decrypt the document with.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

ProxyAuthScheme Property (PDFSign Component)

The type of authorization to perform when connecting to the proxy.

Syntax

__property TispPDFSignProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TispPDFSignProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (PDFSign Component)

Whether to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (PDFSign Component)

A password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (PDFSign Component)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (PDFSign Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (PDFSign Component)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TispPDFSignProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TispPDFSignProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (PDFSign Component)

A username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RevocationCheck Property (PDFSign Component)

The kind(s) of revocation check to perform for all chain certificates.

Syntax

__property TispPDFSignRevocationChecks RevocationCheck = { read=FRevocationCheck, write=FSetRevocationCheck };

enum TispPDFSignRevocationChecks {
  rcAllCRL=0,
  rcAllOCSP=1,
  rcAllCRLAndOCSP=2,
  rcAnyCRL=3,
  rcAnyOCSP=4,
  rcAnyCRLOrOCSP=5,
  rcAnyOCSPOrCRL=6
};

Default Value

rcAnyOCSPOrCRL

Remarks

This property is used to specify the revocation sources and preferences the component will use during chain validation. Revocation checking is necessary to ensure the integrity of the chain and to obtain up-to-date certificate validity and trust information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate has not been revoked by the Certificate Authority (CA) at the time of use. Depending on the circumstances and security policy requirements, either one or both of the revocation information source types may be used.

Possible values are:

This property controls the way revocation checks are performed for every certificate in the chain. Typically, certificates come with two types of revocation information sources: CRLs (Certificate Revocation Lists) and OCSP responses. 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 a delay between the time at which a certificate was revoked and the time at which the subsequent CRL mentioning that revocation is published. The benefits of CRLs are 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 property allows the validation course to be adjusted by including or excluding certain types of revocation sources from the validation process. The rcAnyOCSPOrCRL 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 rcAll* 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

SignatureAuthorName Property (PDFSign Component)

The human-readable name of the signer.

Syntax

__property String SignatureAuthorName = { read=FSignatureAuthorName, write=FSetSignatureAuthorName };

Default Value

""

Remarks

This property is used to specify the human-readable name of the signer.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureClaimedSigningTime Property (PDFSign Component)

The signature's creation time.

Syntax

__property String SignatureClaimedSigningTime = { read=FSignatureClaimedSigningTime, write=FSetSignatureClaimedSigningTime };

Default Value

""

Remarks

This property is used to specify the signature creation time from the signer's computer. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureField Property (PDFSign Component)

The index of the empty signature field to sign.

Syntax

__property int SignatureField = { read=FSignatureField, write=FSetSignatureField };

Default Value

-1

Remarks

This property is used to specify the empty signature field that should be signed. If the default value of -1 is assigned to this property, a new signature field will be created.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "emptyfield.pdf"; pdfsign.SignatureType = PDFSignSignatureTypes.stEmptyField; pdfsign.Sign(); // Later pdfsign.Reset(); pdfsign.InputFile = "emptyfield.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureField = 0; // Configure signature properties as desired pdfsign.Sign();

Data Type

Integer

SignatureHashAlgorithm Property (PDFSign Component)

The hash algorithm to be used for signing.

Syntax

__property String SignatureHashAlgorithm = { read=FSignatureHashAlgorithm, write=FSetSignatureHashAlgorithm };

Default Value

"SHA256"

Remarks

This property is used to specify the hash algorithm to be used for signing.

Possible values are:

• SHA1
• SHA224
• SHA256
• SHA384
• SHA512
• MD5

Note: This property only applies when creating a new signature.

Data Type

String

SignatureProfile Property (PDFSign Component)

The PAdES profile to apply when creating the signature.

Syntax

__property TispPDFSignSignatureProfiles SignatureProfile = { read=FSignatureProfile, write=FSetSignatureProfile };

enum TispPDFSignSignatureProfiles {
  pfNone=0,
  pfBaselineB=1,
  pfBaselineT=2,
  pfBaselineLT=3,
  pfBaselineLTA=4
};

Default Value

pfNone

Remarks

This property is used to specify a pre-defined PAdES profile to apply when creating the signature, as defined by ETSI.

Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants. Specifying a profile pre-configures the component to make it produce the signature that matches the configuration corresponding to that profile.

Possible values are:

To apply a custom profile that is not defined by ETSI, set the CustomProfile configuration setting.

Note: This property only applies when creating a new signature.

Data Type

Integer

SignatureReason Property (PDFSign Component)

The reason for signing.

Syntax

__property String SignatureReason = { read=FSignatureReason, write=FSetSignatureReason };

Default Value

""

Remarks

This property is used to specify the reason for signing.

Note: This property only applies when creating a new signature.

Data Type

String

PDFSignatureCount Property (PDFSign Component)

The number of records in the PDFSignature arrays.

Syntax

__property int PDFSignatureCount = { read=FPDFSignatureCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PDFSignatureAuthorName
• PDFSignatureChainValidationDetails
• PDFSignatureChainValidationResult
• PDFSignatureClaimedSigningTime
• PDFSignatureCoverageEndsAt
• PDFSignatureHashAlgorithm
• PDFSignatureProfile
• PDFSignatureReason
• PDFSignatureSignerCertIndex
• PDFSignatureTimestampCertIndex
• PDFSignatureTimestamped
• PDFSignatureType
• PDFSignatureValidatedSigningTime
• PDFSignatureValidationResult
• PDFSignatureWidgetHeight
• PDFSignatureWidgetOffsetX
• PDFSignatureWidgetOffsetY
• PDFSignatureWidgetPages
• PDFSignatureWidgetWidth

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

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

Data Type

Integer

PDFSignatureAuthorName Property (PDFSign Component)

The human-readable name of the signer.

Syntax

__property String PDFSignatureAuthorName[int PDFSignatureIndex] = { read=FPDFSignatureAuthorName };

Default Value

""

Remarks

The human-readable name of the signer.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureChainValidationDetails Property (PDFSign Component)

The details of the certificate chain validation outcome.

Syntax

__property int PDFSignatureChainValidationDetails[int PDFSignatureIndex] = { read=FPDFSignatureChainValidationDetails };

Default Value

0

Remarks

The details of the certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result in PDFSignatureChainValidationResult.

The value of this property is a bitmask of the following flags:

Subscribe to the Log event to access the detailed validation log. This property is also available as a parameter of the SignatureProcessed event.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureChainValidationResult Property (PDFSign Component)

The outcome of the certificate chain validation routine.

Syntax

__property TispPDFSignPDFSignatureChainValidationResults PDFSignatureChainValidationResult[int PDFSignatureIndex] = { read=FPDFSignatureChainValidationResult };

enum TispPDFSignPDFSignatureChainValidationResults {
  cvrUnknown=0,
  cvrValid=1,
  cvrValidButUntrusted=2,
  cvrInvalid=3,
  cvrCantBeEstablished=4
};

Default Value

cvrUnknown

Remarks

The outcome of the certificate chain validation routine.

Possible values are:

Subscribe to the Log event to access the detailed validation log. This property is also available as a parameter of the SignatureProcessed event.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureClaimedSigningTime Property (PDFSign Component)

The signature's creation time in UTC.

Syntax

__property String PDFSignatureClaimedSigningTime[int PDFSignatureIndex] = { read=FPDFSignatureClaimedSigningTime };

Default Value

""

Remarks

The signature's creation time in UTC.

Use this property to get the signature creation time from the signer's computer. Note that the claimed time, unlike PDFSignatureValidatedSigningTime, does not originate from a trusted TSA and may be forfeited or wrong.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureCoverageEndsAt Property (PDFSign Component)

The offset in the PDF file where the signature coverage ends.

Syntax

__property int PDFSignatureCoverageEndsAt[int PDFSignatureIndex] = { read=FPDFSignatureCoverageEndsAt };

Default Value

0

Remarks

The offset in the PDF file where the signature coverage ends.

PDF generators often use incremental updates to make changes in documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes.

Use this property to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document to ensure that the signature covers the entire document. Alternatively, use the GetSignedVersion method to extract the exact revision that was signed.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureHashAlgorithm Property (PDFSign Component)

The hash algorithm that was used for signing.

Syntax

__property String PDFSignatureHashAlgorithm[int PDFSignatureIndex] = { read=FPDFSignatureHashAlgorithm };

Default Value

"SHA256"

Remarks

The hash algorithm that was used for signing.

Possible values are:

• SHA1
• SHA224
• SHA256
• SHA384
• SHA512
• MD5

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureProfile Property (PDFSign Component)

The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI.

Syntax

__property TispPDFSignPDFSignatureProfiles PDFSignatureProfile[int PDFSignatureIndex] = { read=FPDFSignatureProfile };

enum TispPDFSignPDFSignatureProfiles {
  pfNone=0,
  pfBaselineB=1,
  pfBaselineT=2,
  pfBaselineLT=3,
  pfBaselineLTA=4
};

Default Value

pfNone

Remarks

The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI.

Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants.

Possible values are:

Note that when verifying a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and CacheRevocationInfo (set it to false to prevent earlier validations from affecting the current validation).

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureReason Property (PDFSign Component)

The reason for signing.

Syntax

__property String PDFSignatureReason[int PDFSignatureIndex] = { read=FPDFSignatureReason };

Default Value

""

Remarks

The reason for signing.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureType Property (PDFSign Component)

The type of the signature that was created.

Syntax

__property TispPDFSignPDFSignatureTypes PDFSignatureType[int PDFSignatureIndex] = { read=FPDFSignatureType };

enum TispPDFSignPDFSignatureTypes {
  stLegacy=0,
  stAdvanced=1,
  stDTS=2,
  stEmptyField=3
};

Default Value

stLegacy

Remarks

The type of the signature that was created.

Possible values are:

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureSignerCertIndex Property (PDFSign Component)

The index of the signer certificate in the DocumentCerts properties.

Syntax

__property int PDFSignatureSignerCertIndex[int PDFSignatureIndex] = { read=FPDFSignatureSignerCertIndex };

Default Value

-1

Remarks

The index of the signer certificate in the DocumentCerts properties.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureTimestampCertIndex Property (PDFSign Component)

The index of the timestamping certificate in the DocumentCerts properties (if applicable).

Syntax

__property int PDFSignatureTimestampCertIndex[int PDFSignatureIndex] = { read=FPDFSignatureTimestampCertIndex };

Default Value

-1

Remarks

The index of the timestamping certificate in the DocumentCerts properties (if applicable).

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureTimestamped Property (PDFSign Component)

Whether the signature contains an embedded timestamp.

Syntax

__property bool PDFSignatureTimestamped[int PDFSignatureIndex] = { read=FPDFSignatureTimestamped };

Default Value

false

Remarks

Whether the signature contains an embedded timestamp.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Boolean

PDFSignatureValidatedSigningTime Property (PDFSign Component)

The certified signing time in UTC.

Syntax

__property String PDFSignatureValidatedSigningTime[int PDFSignatureIndex] = { read=FPDFSignatureValidatedSigningTime };

Default Value

""

Remarks

The certified signing time in UTC.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only nonempty if there is a valid timestamp included in the signature.

Note that the validated time, unlike PDFSignatureClaimedSigningTime, is the trusted signing time.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureValidationResult Property (PDFSign Component)

The outcome of the cryptographic signature validation.

Syntax

__property TispPDFSignPDFSignatureValidationResults PDFSignatureValidationResult[int PDFSignatureIndex] = { read=FPDFSignatureValidationResult };

enum TispPDFSignPDFSignatureValidationResults {
  svrUnknown=0,
  svrValid=1,
  svrCorrupted=2,
  svrSignerNotFound=3,
  svrFailure=4
};

Default Value

svrUnknown

Remarks

The outcome of the cryptographic signature validation.

Possible values are:

This property is also available as the SignatureValidationResult parameter of the SignatureProcessed event.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

Integer

PDFSignatureWidgetHeight Property (PDFSign Component)

The height of the signature widget in points.

Syntax

__property String PDFSignatureWidgetHeight[int PDFSignatureIndex] = { read=FPDFSignatureWidgetHeight };

Default Value

"70"

Remarks

The height of the signature widget in points. Both integer and decimal values are supported.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureWidgetOffsetX Property (PDFSign Component)

The signature widget offset from the left-hand page border in points.

Syntax

__property String PDFSignatureWidgetOffsetX[int PDFSignatureIndex] = { read=FPDFSignatureWidgetOffsetX };

Default Value

"0"

Remarks

The signature widget offset from the left-hand page border in points. Both integer and decimal values are supported.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureWidgetOffsetY Property (PDFSign Component)

The signature widget offset from the bottom page border in points.

Syntax

__property String PDFSignatureWidgetOffsetY[int PDFSignatureIndex] = { read=FPDFSignatureWidgetOffsetY };

Default Value

"0"

Remarks

The signature widget offset from the bottom page border in points. Both integer and decimal values are supported.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureWidgetPages Property (PDFSign Component)

The pages that the signature and its widget are placed on.

Syntax

__property String PDFSignatureWidgetPages[int PDFSignatureIndex] = { read=FPDFSignatureWidgetPages };

Default Value

""

Remarks

The pages that the signature and its widget are placed on.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

PDFSignatureWidgetWidth Property (PDFSign Component)

The width of the signature widget in points.

Syntax

__property String PDFSignatureWidgetWidth[int PDFSignatureIndex] = { read=FPDFSignatureWidgetWidth };

Default Value

"70"

Remarks

The width of the signature widget in points. Both integer and decimal values are supported.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

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

Data Type

String

SignatureType Property (PDFSign Component)

The type of signature to create.

Syntax

__property TispPDFSignSignatureTypes SignatureType = { read=FSignatureType, write=FSetSignatureType };

enum TispPDFSignSignatureTypes {
  stLegacy=0,
  stAdvanced=1,
  stDTS=2,
  stEmptyField=3
};

Default Value

stLegacy

Remarks

This property is used to specify the type of the signature.

Possible values are:

Note: This property only applies when creating a new signature.

Data Type

Integer

SignatureWidgetHeight Property (PDFSign Component)

The height of the signature widget.

Syntax

__property String SignatureWidgetHeight = { read=FSignatureWidgetHeight, write=FSetSignatureWidgetHeight };

Default Value

"70"

Remarks

This property is used to specify the height of the signature widget in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetOffsetX Property (PDFSign Component)

The signature widget offset from the left-hand page border.

Syntax

__property String SignatureWidgetOffsetX = { read=FSignatureWidgetOffsetX, write=FSetSignatureWidgetOffsetX };

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the left-hand page border in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetOffsetY Property (PDFSign Component)

The signature widget offset from the bottom page border.

Syntax

__property String SignatureWidgetOffsetY = { read=FSignatureWidgetOffsetY, write=FSetSignatureWidgetOffsetY };

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the bottom page border in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetPages Property (PDFSign Component)

The pages to place the signature and its widget on.

Syntax

__property String SignatureWidgetPages = { read=FSignatureWidgetPages, write=FSetSignatureWidgetPages };

Default Value

""

Remarks

This property is used to specify the pages on which the signature and its widget will be placed.

A variety of syntaxes are supported:

• A single page number: 3
• A comma-separated list of page numbers: 1,2,5,7
• The asterisk character (*) indicates that the widget should be placed on all pages in the document.
• The first and last placeholders specify that the signature should be placed on the respective page, independently of its number.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetWidth Property (PDFSign Component)

The width of the signature widget.

Syntax

__property String SignatureWidgetWidth = { read=FSignatureWidgetWidth, write=FSetSignatureWidgetWidth };

Default Value

"70"

Remarks

This property is used to specify the width of the signature widget in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SigningCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

__property String SigningCertEffectiveDate = { read=FSigningCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

Data Type

String

SigningCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

__property String SigningCertExpirationDate = { read=FSigningCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

Data Type

String

SigningCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SigningCertExtendedKeyUsage = { read=FSigningCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

Data Type

String

SigningCertFingerprint Property (PDFSign Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SigningCertFingerprint = { read=FSigningCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

Data Type

String

SigningCertFingerprintSHA1 Property (PDFSign Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SigningCertFingerprintSHA1 = { read=FSigningCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

Data Type

String

SigningCertFingerprintSHA256 Property (PDFSign Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SigningCertFingerprintSHA256 = { read=FSigningCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

Data Type

String

SigningCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

__property String SigningCertIssuer = { read=FSigningCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

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

Data Type

String

SigningCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

__property String SigningCertPrivateKey = { read=FSigningCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SigningCertPrivateKey may be available but not exportable. In this case, SigningCertPrivateKey returns an empty string.

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

Data Type

String

SigningCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SigningCertPrivateKeyAvailable = { read=FSigningCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SigningCertPrivateKey is available for the selected certificate. If SigningCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

Data Type

Boolean

SigningCertPrivateKeyContainer Property (PDFSign Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SigningCertPrivateKeyContainer = { read=FSigningCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SigningCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

Data Type

String

SigningCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

__property String SigningCertPublicKey = { read=FSigningCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

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

Data Type

String

SigningCertPublicKeyAlgorithm Property (PDFSign Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SigningCertPublicKeyAlgorithm = { read=FSigningCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

Data Type

String

SigningCertPublicKeyLength Property (PDFSign Component)

The length of the certificate's public key (in bits).

Syntax

__property int SigningCertPublicKeyLength = { read=FSigningCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

Data Type

Integer

SigningCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SigningCertSerialNumber = { read=FSigningCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

Data Type

String

SigningCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SigningCertSignatureAlgorithm = { read=FSigningCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

Data Type

String

SigningCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

__property String SigningCertStore = { read=FSigningCertStore, write=FSetSigningCertStore };
__property DynamicArray<Byte> SigningCertStoreB = { read=FSigningCertStoreB, write=FSetSigningCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password-protected, specify the password in SigningCertStorePassword.

SigningCertStore is used in conjunction with the SigningCertSubject property to specify client certificates. If SigningCertStore has a value, and SigningCertSubject or SigningCertEncoded is set, a search for a certificate is initiated. Please see the SigningCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is not available at design time.

Data Type

Byte Array

SigningCertStorePassword Property (PDFSign Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SigningCertStorePassword = { read=FSigningCertStorePassword, write=FSetSigningCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is not available at design time.

Data Type

String

SigningCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFSignSigningCertStoreTypes SigningCertStoreType = { read=FSigningCertStoreType, write=FSetSigningCertStoreType };

enum TispPDFSignSigningCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

This property is not available at design time.

Data Type

Integer

SigningCertSubjectAltNames Property (PDFSign Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SigningCertSubjectAltNames = { read=FSigningCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

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

Data Type

String

SigningCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

__property String SigningCertThumbprintMD5 = { read=FSigningCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

SigningCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

__property String SigningCertThumbprintSHA1 = { read=FSigningCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

SigningCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

__property String SigningCertThumbprintSHA256 = { read=FSigningCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

SigningCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

__property String SigningCertUsage = { read=FSigningCertUsage };

Default Value

""

Remarks

The text description of SigningCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

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

Data Type

String

SigningCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

__property int SigningCertUsageFlags = { read=FSigningCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SigningCertUsageFlags is a combination of the following flags:

Please see the SigningCertUsage property for a text representation of SigningCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

Data Type

Integer

SigningCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

__property String SigningCertVersion = { read=FSigningCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

Data Type

String

SigningCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

__property String SigningCertSubject = { read=FSigningCertSubject, write=FSetSigningCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is not available at design time.

Data Type

String

SigningCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SigningCertEncoded = { read=FSigningCertEncoded, write=FSetSigningCertEncoded };
__property DynamicArray<Byte> SigningCertEncodedB = { read=FSigningCertEncodedB, write=FSetSigningCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

When SigningCertEncoded is set, a search is initiated in the current SigningCertStore for the private key of the certificate. If the key is found, SigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SigningCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

TimestampServer Property (PDFSign Component)

The address of the timestamping server.

Syntax

__property String TimestampServer = { read=FTimestampServer, write=FSetTimestampServer };

Default Value

""

Remarks

This property is used to specify the address of the TSA (Timestamping Authority) server to use for timestamping the signature (normal signing) or the document (LTV update).

If the timestamping service enforces credential-based user authentication (basic or digest), the credentials can be provided in the same URL. For example: pdfsign.TimestampServer = "http://user:password@timestamp.server.com/TsaService"; If the TSA requires TLS client authentication, provide the client certificate via the TSATLSClientCertStoreType, TSATLSClientCertStore, TSATLSClientCertSubject, and TSATLSClientCertStorePassword configuration settings.

Data Type

String

TrustedCertCount Property (PDFSign 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:

• TrustedCertEffectiveDate
• TrustedCertEncoded
• TrustedCertExpirationDate
• TrustedCertExtendedKeyUsage
• TrustedCertFingerprint
• TrustedCertFingerprintSHA1
• TrustedCertFingerprintSHA256
• TrustedCertIssuer
• TrustedCertPrivateKey
• TrustedCertPrivateKeyAvailable
• TrustedCertPrivateKeyContainer
• TrustedCertPublicKey
• TrustedCertPublicKeyAlgorithm
• TrustedCertPublicKeyLength
• TrustedCertSerialNumber
• TrustedCertSignatureAlgorithm
• TrustedCertStore
• TrustedCertStorePassword
• TrustedCertStoreType
• TrustedCertSubject
• TrustedCertSubjectAltNames
• TrustedCertThumbprintMD5
• TrustedCertThumbprintSHA1
• TrustedCertThumbprintSHA256
• TrustedCertUsage
• TrustedCertUsageFlags
• TrustedCertVersion

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

This property is not available at design time.

Data Type

Integer

TrustedCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

__property String TrustedCertEffectiveDate[int TrustedCertIndex] = { read=FTrustedCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

String

TrustedCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

__property String TrustedCertExpirationDate[int TrustedCertIndex] = { read=FTrustedCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

String

TrustedCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String TrustedCertExtendedKeyUsage[int TrustedCertIndex] = { read=FTrustedCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

String

TrustedCertFingerprint Property (PDFSign Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String TrustedCertFingerprint[int TrustedCertIndex] = { read=FTrustedCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

String

TrustedCertFingerprintSHA1 Property (PDFSign Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String TrustedCertFingerprintSHA1[int TrustedCertIndex] = { read=FTrustedCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

String

TrustedCertFingerprintSHA256 Property (PDFSign Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String TrustedCertFingerprintSHA256[int TrustedCertIndex] = { read=FTrustedCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

String

TrustedCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

__property String TrustedCertIssuer[int TrustedCertIndex] = { read=FTrustedCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

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

String

TrustedCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

__property String TrustedCertPrivateKey[int TrustedCertIndex] = { read=FTrustedCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The TrustedCertPrivateKey may be available but not exportable. In this case, TrustedCertPrivateKey returns an empty string.

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

String

TrustedCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool TrustedCertPrivateKeyAvailable[int TrustedCertIndex] = { read=FTrustedCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a TrustedCertPrivateKey is available for the selected certificate. If TrustedCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

Boolean

TrustedCertPrivateKeyContainer Property (PDFSign Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String TrustedCertPrivateKeyContainer[int TrustedCertIndex] = { read=FTrustedCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the TrustedCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

String

TrustedCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

__property String TrustedCertPublicKey[int TrustedCertIndex] = { read=FTrustedCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

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

String

TrustedCertPublicKeyAlgorithm Property (PDFSign Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String TrustedCertPublicKeyAlgorithm[int TrustedCertIndex] = { read=FTrustedCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

String

TrustedCertPublicKeyLength Property (PDFSign Component)

The length of the certificate's public key (in bits).

Syntax

__property int TrustedCertPublicKeyLength[int TrustedCertIndex] = { read=FTrustedCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

Integer

TrustedCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

__property String TrustedCertSerialNumber[int TrustedCertIndex] = { read=FTrustedCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

String

TrustedCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

__property String TrustedCertSignatureAlgorithm[int TrustedCertIndex] = { read=FTrustedCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

String

TrustedCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

__property String TrustedCertStore[int TrustedCertIndex] = { read=FTrustedCertStore, write=FSetTrustedCertStore };
__property DynamicArray<Byte> TrustedCertStoreB[int TrustedCertIndex] = { read=FTrustedCertStoreB, write=FSetTrustedCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The TrustedCertStoreType property denotes the type of the certificate store specified by TrustedCertStore. If the store is password-protected, specify the password in TrustedCertStorePassword.

TrustedCertStore is used in conjunction with the TrustedCertSubject property to specify client certificates. If TrustedCertStore has a value, and TrustedCertSubject or TrustedCertEncoded is set, a search for a certificate is initiated. Please see the TrustedCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

Byte Array

TrustedCertStorePassword Property (PDFSign Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String TrustedCertStorePassword[int TrustedCertIndex] = { read=FTrustedCertStorePassword, write=FSetTrustedCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

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

String

TrustedCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFSignTrustedCertStoreTypes TrustedCertStoreType[int TrustedCertIndex] = { read=FTrustedCertStoreType, write=FSetTrustedCertStoreType };

enum TispPDFSignTrustedCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

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

Integer

TrustedCertSubjectAltNames Property (PDFSign Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String TrustedCertSubjectAltNames[int TrustedCertIndex] = { read=FTrustedCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

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

String

TrustedCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

__property String TrustedCertThumbprintMD5[int TrustedCertIndex] = { read=FTrustedCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

TrustedCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

__property String TrustedCertThumbprintSHA1[int TrustedCertIndex] = { read=FTrustedCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

TrustedCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

__property String TrustedCertThumbprintSHA256[int TrustedCertIndex] = { read=FTrustedCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

String

TrustedCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

__property String TrustedCertUsage[int TrustedCertIndex] = { read=FTrustedCertUsage };

Default Value

""

Remarks

The text description of TrustedCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

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

String

TrustedCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

__property int TrustedCertUsageFlags[int TrustedCertIndex] = { read=FTrustedCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of TrustedCertUsageFlags is a combination of the following flags:

Please see the TrustedCertUsage property for a text representation of TrustedCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

Integer

TrustedCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

__property String TrustedCertVersion[int TrustedCertIndex] = { read=FTrustedCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

String

TrustedCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

__property String TrustedCertSubject[int TrustedCertIndex] = { read=FTrustedCertSubject, write=FSetTrustedCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

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

String

TrustedCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String TrustedCertEncoded[int TrustedCertIndex] = { read=FTrustedCertEncoded, write=FSetTrustedCertEncoded };
__property DynamicArray<Byte> TrustedCertEncodedB[int TrustedCertIndex] = { read=FTrustedCertEncodedB, write=FSetTrustedCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The TrustedCertStore and TrustedCertSubject properties also may be used to specify a certificate.

When TrustedCertEncoded is set, a search is initiated in the current TrustedCertStore for the private key of the certificate. If the key is found, TrustedCertSubject is updated to reflect the full subject of the selected certificate; otherwise, TrustedCertSubject is set to an empty string.

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

Byte Array

TrustedLists Property (PDFSign Component)

A list of known Trusted Lists for chain validation.

Syntax

__property String TrustedLists = { read=FTrustedLists, write=FSetTrustedLists };

Default Value

"%EUTL%"

Remarks

This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the component for chain validation.

A Trusted List is an XML document that contains a government-issued list of CAs that have passed regulated compliance checks. When validating the chain, the component will consult the Trusted List to establish certificate trust, ensuring that the CA is legitimate and entitled to issue certificates of the kind being checked.

The default value is the special %EUTL% macro, which, if applicable, instructs the component to check the root certificate against up-to-date versions of the primary EU Trusted Lists from the EU LOTL. Custom values can be appended: component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; Note: The component will cache all Trusted Lists it downloads and uses during chain validation. This cache is shared between component instances within the same process. If this property contains a URL that is also present in the cache, the component will retrieve the cached data and reuse them in the current validation. If the data are invalid, the component will download a fresh Trusted List and add it to the cache.

Data Type

String

TrustSources Property (PDFSign Component)

The trust sources to use during chain validation.

Syntax

__property TispPDFSignTrustSources TrustSources = { read=FTrustSources, write=FSetTrustSources };

enum TispPDFSignTrustSources {
  tsManual=0,
  tsLocal=1,
  tsTrustedLists=2,
  tsLocalAndTrustedLists=3
};

Default Value

tsLocalAndTrustedLists

Remarks

This property is used to specify the sources the component will use to establish certificate trust during chain validation.

Establishing trust for a particular certificate, when either signing or verifying, involves building a chain up to a valid trust anchor. This trust anchor is a root certificate that typically resides on the local system. If the certificate does not eventually chain up to a valid trust anchor, the chain is considered untrusted and therefore invalid.

Possible values are:

Data Type

Integer

ValidationFlags Property (PDFSign Component)

Additional chain validation settings.

Syntax

__property int ValidationFlags = { read=FValidationFlags, write=FSetValidationFlags };

Default Value

0

Remarks

This property is used to specify additional settings that affect the overall flow of the chain validation.

Its value should be provided as a bitmask of the following flags:

Data Type

Integer

ValidationPolicy Property (PDFSign Component)

The level at which to perform chain validation.

Syntax

__property TispPDFSignValidationPolicies ValidationPolicy = { read=FValidationPolicy, write=FSetValidationPolicy };

enum TispPDFSignValidationPolicies {
  vpNone=0,
  vpFull=1,
  vpFullNoTrust=2,
  vpFullNoRevocation=3,
  vpBestEffort=4
};

Default Value

vpFull

Remarks

This property is used to specify the overall validation policy the component will follow.

Possible values are:

Validation Policy Heuristics

The choice of validation policy will depend on the scenario for which the chain is validated.

Creating a new signature:

• For a basic signature with or without a timestamp, chain validation is not required, so it is recommended to use vpNone. This policy may also be used in test environments or on offline systems.
• For an LTV signature, use vpFull or vpFullNoTrust depending on whether trust checks are necessary in the current environment. If the signature is being created in an environment that does not match the prospective validation environment, consider vpFullNoTrust to validate the chain properly and fully without expecting good trust.

Updating or extending an existing signature:

• When updating a basic signature to LTV, similarly use vpFull or vpFullNoTrust as above.
• When extending an LTV signature, similarly use vpFull or vpFullNoTrust as above.

Validating an existing signature:

• For basic signature validation, use vpFullNoRevocation if trust checks, but not revocation checks, are necessary in the current environment. This policy may also be used on offline systems if the trust anchor is already available to the component.
• For archival validation, use vpFull to validate the chain properly and fully. This policy expects the trust anchor and all the revocation material to be available.

Data Type

Integer

ValidationTime Property (PDFSign Component)

The time point at which the signature should be validated.

Syntax

__property String ValidationTime = { read=FValidationTime, write=FSetValidationTime };

Default Value

""

Remarks

This property is used to specify the moment in time at which the signature validity should be established. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Leave this property empty to stick to the default time point. The component will then prioritize:

• The signature creation time if the signature contains a signature timestamp (), or
• The local time included in the signature by the signer ().

Note: 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

AddAttachment Method (PDFSign Component)

Adds an attachment to a PDF document.

Syntax

void __fastcall AddAttachment(String FileName, String Description);

Remarks

This method is used to add an attachment (embedded file) to the document specified in InputFile, InputData, or SetInputStream and to the Attachments properties.

The document containing the newly added attachment will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

The FileName and Description parameters specify the filename and description of the attachment respectively.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "input_with_attachment.pdf"; pdfsign.Open(); pdfsign.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; pdfsign.Attachments.Add(attachment); // Or using one of the constructors: pdfsign.Attachments.Add(new PDFAttachment("foo.txt", "desc")); pdfsign.Close(); The full list of attachments is contained in the Attachments property.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

AddTimestamp Method (PDFSign Component)

Adds a document timestamp to a PDF document.

Syntax

void __fastcall AddTimestamp();

Remarks

This method is used to obtain a document timestamp and embed it into the document specified in InputFile, InputData, or SetInputStream. The document containing the newly added document timestamp will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

A document timestamp is a fully independent signature that is added to the PDF document after the initial signature. Unlike the main signature, the document timestamp is made by a TSA, and its purpose is to preserve the document's long-term validity. Typically, adding a document timestamp is done close to the expiration date of the certificate that produced the last timestamp (which is either embedded in the main signature, or is a previous document timestamp). An LTV document therefore contains a chain of document timestamps updated periodically to keep its long-term status.

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "signed_with_dts.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.AddTimestamp(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Close Method (PDFSign Component)

Closes an opened PDF document.

Syntax

void __fastcall Close();

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. It should always be preceded by a call to the Open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

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

Encrypted Method (PDFSign Component)

Checks whether a PDF document is encrypted.

Syntax

bool __fastcall Encrypted();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

GetPageProperty Method (PDFSign Component)

Retrieves the value of a page property.

Syntax

String __fastcall GetPageProperty(int Page, String PageProperty);

Remarks

This method is used to read general information about the pages of the document specified in InputFile, InputData, or SetInputStream, such as their dimensions and content positioning details.

The Page parameter specifies the page to read information about (with a valid range from 1 to PageCount), and the PageProperty parameter specifies the page property to read. The latter can take one of the following values:

Note: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 1; i <= pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(1, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(1, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

GetWidgetProperty Method (PDFSign Component)

Retrieves the value of a signature widget property.

Syntax

String __fastcall GetWidgetProperty(int SignatureIndex, String WidgetProperty);

Remarks

This method is used to retrieve the value of a signature widget property. Together with SetWidgetProperty, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the component. The list of settings below may be extended in the future.

The SignatureIndex parameter is the index of the signature of interest in the Signatures properties, and the WidgetProperty parameter specifies the widget property to read. The latter can take one of the following values:

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.Open(); bool invisible = bool.Parse(pdfsign.GetWidgetProperty(0, "Invisible")); pdfsign.Close(); Note: Each widget property is only populated after the document has been signed and the signature widget has been generated.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Interrupt Method (PDFSign Component)

Interrupts the current action.

Syntax

void __fastcall Interrupt();

Remarks

This method interrupts the current action. It can be used, for example, within the ChainCert event to abort the chain validation procedure.

If there is no action in progress, this method simply returns, doing nothing.

Open Method (PDFSign Component)

Opens a PDF document for processing.

Syntax

void __fastcall Open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as signing or updating. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Note: This method will populate the Attachments, DocumentCerts, and Signatures collections with any corresponding objects found in the document.

Automatic Decryption Functionality

If this method is called on an encrypted document, the Password or RecipientInfo event will fire (depending on the encryption type) as a notification that the document must be decrypted before processing can continue.

Once the correct decryption material is supplied, the component will then attempt to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use the Decrypt method to save a decrypted copy of the document instead.

RemoveAttachment Method (PDFSign Component)

Removes an attachment from a PDF document.

Syntax

void __fastcall RemoveAttachment(int Index);

Remarks

This method is used to remove an attachment from the document specified in InputFile, InputData, or SetInputStream and from the Attachments properties.

The document without the attachment will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

The Index parameter is the index of the attachment in the Attachments properties to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Reset Method (PDFSign Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

This method is used to reset the component's properties and configuration settings to their default values.

SaveAttachment Method (PDFSign Component)

Saves a PDF attachment to a file.

Syntax

void __fastcall SaveAttachment(int Index, String FileName);

Remarks

This method is used to retrieve the contents of an attachment from the document specified in InputFile, InputData, or SetInputStream and save it to the file specified by FileName. It does not modify the existence of the Attachments properties's contents.

The Index parameter is the index of the attachment in the Attachments properties to be saved.

The FileName parameter specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream property if it's set Note: If the document is not already opened, this method will open it, perform the operation, then close it.

SetWidgetProperty Method (PDFSign Component)

Sets the value of a signature widget property.

Syntax

void __fastcall SetWidgetProperty(String WidgetProperty, String Value);

Remarks

This method is used to adjust the look of the signature widget when creating a signature. Together with GetWidgetProperty, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the component. The list of settings below may be extended in the future.

The WidgetProperty and Value parameters specify the widget property and value to set respectively. The former can take one of the following values:

Example: pdfsign.SetWidgetProperty("Width", "100"); pdfsign.SetWidgetProperty("Height", "100"); pdfsign.SetWidgetProperty("ShowDate", "false"); pdfsign.SetWidgetProperty("SignerInfo", "Hello\r\nworld!"); pdfsign.SetWidgetProperty("TitleFontSize", "11"); pdfsign.Sign();

Sign Method (PDFSign Component)

Signs a PDF document.

Syntax

void __fastcall Sign();

Remarks

This method is used to sign the document specified in InputFile, InputData, or SetInputStream. The document will be signed with SigningCert and saved in OutputFile, OutputData, or the stream set in SetOutputStream.

Use the following properties to adjust new signature settings:

• SignatureAuthorName
• SignatureClaimedSigningTime
• SignatureHashAlgorithm
• SignatureProfile
• SignatureReason
• SignatureType
• SignatureWidgetHeight
• SignatureWidgetOffsetX
• SignatureWidgetOffsetY
• SignatureWidgetPages
• SignatureWidgetWidth

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

During signing, the chain validation log will be available via the Log event if applicable.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Signed Method (PDFSign Component)

Checks whether a PDF document is signed.

Syntax

bool __fastcall Signed();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is signed. It will return false if the document contains only empty signature fields.

Example: pdfverify.InputFile = "input.pdf"; if (pdfverify.Signed()) { // Configure validation-related properties as desired pdfverify.Verify(); } Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Update Method (PDFSign Component)

Updates the most recent signature.

Syntax

void __fastcall Update();

Remarks

This method is used to update the most recent signature by embedding newer or missing revocation information into the signed document specified in InputFile, InputData, or SetInputStream. The updated document will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

Updating a signature starts with its cryptographic validation. Before any new validation material is inserted, the signature's integrity must be validated. If the signature is found to be correct, the component will proceed with chain validation and the retrieval of any missing chain elements. If the signature is cryptographically wrong, the component will throw an exception.

The update approach is typically used to extend the validity of an LTV signature. For LTA signatures, updating is typically accompanied with a document timestamping operation. Set TimestampServer to have the component obtain and embed a document timestamp automatically.

Further validation material and document timestamps may be added to a document over time to maintain its authenticity and integrity.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

Note: To choose a different signature to update, set the UpdateIndex configuration setting.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

ChainCert Event (PDFSign Component)

Fired when the component encounters a chain certificate.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String ValidationTime;
  int ValidationResult;
  int ValidationDetails;
} TispPDFSignChainCertEventParams;
typedef void __fastcall (__closure *TispPDFSignChainCertEvent)(System::TObject* Sender, TispPDFSignChainCertEventParams *e);
__property TispPDFSignChainCertEvent OnChainCert = { read=FOnChainCert, write=FOnChainCert };

Remarks

This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The component will try to retrieve all required chain certificates automatically.

The CertEncoded parameter specifies the PEM (Base64-encoded) public certificate.

The CertSubject and CertIssuer parameters specify the distinguished names of the certificate owner and issuer respectively.

The ValidationTime parameter specifies the time point (in UTC) at which the certificate validity was established.

The ValidationResult parameter reports the outcome of the individual certificate validation and can be one of the following values:

In the case of a failure, the ValidationDetails parameter provides more details on its reasons. Its value is a bitmask of the following flags:

Overridable Chain Validation

While the component will follow the validation rules defined by the X.509 standard to the best of its ability, minor technical issues may arise when validating the chain. The ValidationResult and ValidationDetails parameters can be overridden to relax such requirements on a per-certificate basis.

For example, set ValidationResult to cvrValid and ValidationDetails to 0 in order to:

• Ignore CA or TLS key usage requirements
• Ignore the AuthorityKeyId extension in certificate-issuing CAs (helps with incorrectly renewed certificates)
• Ignore the Basic Constraints or Name Constraints extensions of CA certificates
• Tolerate some weaker algorithms
• Implicitly trust self-signed certificates
• Skip validity period checks for trusted certificates (helps with older devices that have expired root certificates)
• Ignore chain loops (helps with buggy CAs that include subchains that sign themselves)

Based on the adjusted validity of the certificate that is currently being processed, the component will continue or abort the chain validation procedure accordingly as if it had arrived at the chosen validation result itself.

Note: The user code is ultimately responsible for certificate validity decisions made via these two parameters. If their values are modified within this event, the resulting chain validation procedure may deviate from the standard.

DocumentInfo Event (PDFSign Component)

Fired when the document has been loaded into memory.

Syntax

typedef struct {
  int PageCount;
  int SignatureCount;
} TispPDFSignDocumentInfoEventParams;
typedef void __fastcall (__closure *TispPDFSignDocumentInfoEvent)(System::TObject* Sender, TispPDFSignDocumentInfoEventParams *e);
__property TispPDFSignDocumentInfoEvent OnDocumentInfo = { read=FOnDocumentInfo, write=FOnDocumentInfo };

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, the GetPageProperty method can be used to find the optimal position for the signature widget.

The PageCount parameter reports the number of pages in the document.

The SignatureCount parameter reports the number of signatures in the document.

This event is fired when the Open method is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFSign Component)

Fired when information is available about errors during data delivery.

Syntax

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

Log Event (PDFSign Component)

Fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TispPDFSignLogEventParams;
typedef void __fastcall (__closure *TispPDFSignLogEvent)(System::TObject* Sender, TispPDFSignLogEventParams *e);
__property TispPDFSignLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel configuration setting.

The LogLevel parameter indicates the detail level of the message. Possible values are:

The Message parameter is the log message.

The LogType parameter identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFSign Component)

Fired when the component detects that the PDF document is encrypted with a password.

Syntax

typedef struct {
  bool Available;
  bool Cancel;
} TispPDFSignPasswordEventParams;
typedef void __fastcall (__closure *TispPDFSignPasswordEvent)(System::TObject* Sender, TispPDFSignPasswordEventParams *e);
__property TispPDFSignPasswordEvent OnPassword = { read=FOnPassword, write=FOnPassword };

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to the Password property.

The Available parameter indicates whether the decryption password is already available to the component or still needs to be set. If this parameter is set to false, the correct password must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the component will stop firing this event to request a password.

RecipientInfo Event (PDFSign Component)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

typedef struct {
  String Issuer;
  String SerialNumber;
  String SubjectKeyIdentifier;
  bool Available;
  bool Cancel;
} TispPDFSignRecipientInfoEventParams;
typedef void __fastcall (__closure *TispPDFSignRecipientInfoEvent)(System::TObject* Sender, TispPDFSignRecipientInfoEventParams *e);
__property TispPDFSignRecipientInfoEvent OnRecipientInfo = { read=FOnRecipientInfo, write=FOnRecipientInfo };

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

The SubjectKeyIdentifier parameter specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

The Available parameter indicates whether the decryption certificate is already available to the component or still needs to be set. If this parameter is set to false, the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the component will stop firing this event to request a certificate.

Note: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

SignatureInfo Event (PDFSign Component)

Fired when the component finds a signature in the document.

Syntax

typedef struct {
  int SignatureIndex;
  bool ValidateSignature;
  bool ValidateChain;
} TispPDFSignSignatureInfoEventParams;
typedef void __fastcall (__closure *TispPDFSignSignatureInfoEvent)(System::TObject* Sender, TispPDFSignSignatureInfoEventParams *e);
__property TispPDFSignSignatureInfoEvent OnSignatureInfo = { read=FOnSignatureInfo, write=FOnSignatureInfo };

Remarks

This event is fired once for each signature found in the document to report that the signature specified by SignatureIndex is about to be validated.

The SignatureIndex parameter is the index of the signature in the Signatures properties.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. The ValidateSignature and ValidateChain parameters determine whether each stage should be included in the validation. They can be overridden to modify the validation policy on a per-signature basis, allowing signatures to be verified individually instead of all at once (via Verify). To skip validation entirely, set both parameters to false.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

SignatureProcessed Event (PDFSign Component)

Fired after a signature has been processed.

Syntax

typedef struct {
  int SignatureIndex;
  int SignatureValidationResult;
  int ChainValidationResult;
  int ChainValidationDetails;
} TispPDFSignSignatureProcessedEventParams;
typedef void __fastcall (__closure *TispPDFSignSignatureProcessedEvent)(System::TObject* Sender, TispPDFSignSignatureProcessedEventParams *e);
__property TispPDFSignSignatureProcessedEvent OnSignatureProcessed = { read=FOnSignatureProcessed, write=FOnSignatureProcessed };

Remarks

This event is fired once for each signature found in the document to report that the signature specified by SignatureIndex has completed validation. It is fired after SignatureInfo if that event's ValidateSignature parameter is set to true.

The SignatureIndex parameter is the index of the signature in the Signatures properties.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in the SignatureValidationResult and ChainValidationResult parameters.

The former reports the validity of the signature and can be one of the following values:

The latter reports the validity of the chain and can be one of the following values:

In the case of a failure, the ChainValidationDetails parameter provides more details on its reasons. Its value is a bitmask of the following flags:

Note: SignatureValidationResult, ChainValidationResult, and ChainValidationDetails are also available as properties in the PDFSignature type.

SSLServerAuthentication Event (PDFSign Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TispPDFSignSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TispPDFSignSSLServerAuthenticationEvent)(System::TObject* Sender, TispPDFSignSSLServerAuthenticationEventParams *e);
__property TispPDFSignSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the component. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When the Accept parameter is false, the Status parameter shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to true.

SSLStatus Event (PDFSign Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TispPDFSignSSLStatusEventParams;
typedef void __fastcall (__closure *TispPDFSignSSLStatusEvent)(System::TObject* Sender, TispPDFSignSSLStatusEventParams *e);
__property TispPDFSignSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

This event is fired during timestamping or chain validation for informational and logging purposes only. This event tracks the progress of the SSL/TLS connection. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

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

PDFSign Config Settings

Base Config Settings

Trappable Errors (PDFSign Component)

PDFSign Errors

PDF Errors

Parsing Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors