PDFSign Component

Properties   Methods   Events   Config Settings   Errors  

The PDFSign class signs PDF documents.

Syntax

securepdf.PDFSign

Remarks

The PDFSign struct 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 Sign.

PDFSign also provides means to customize the appearance of the signature widget to be shown on the document page. You can create your 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. Please see this article for more details about customizing the signature widget.

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 process, the struct 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 by the TimestampServer property, the struct also contacts 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 struct fires 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 fires 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.

Remote Signing

PDFSign can also be configured to sign with external keys. In such scenarios, the struct handles every aspect of the signing routine except the actual signing operation - including the document hash calculation, preparation of signature objects, and CRL/OCSP retrieval. Instead of calculating the signature by itself, the struct requests it from your code and later incorporates it into the document.

To enable this mode, set the RemoteSignatureMethod property to either rsmPKCS1 or rsmPKCS7 and call Sign. The struct outputs a "pre-signed" document, which encapsulates any signature and widget settings, and populates the RemoteSignatureDigest property with the raw data to be signed.

Which remote signing method to use depends on the specifics of your remote signing engine. With PKCS#1, the public copy of the signing certificate is needed on the first step because it is included in the PKCS#7 structure prepared by the struct. With PKCS#7 on the other hand, only the document hash is calculated, which does not require the certificate.

Once your remote signing engine signs the hashed data with the private key, pass the resulting signed data back to the struct via the RemoteSignatureData property to embed it into the document.

The following code shows the full PKCS#1 remote signing process: // Step 1: Pre-sign pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "presigned.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPublicKeyFile, "cert.cer", "", "*"); // Configure signature and/or widget properties as desired pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmPKCS1; pdfsign.Sign(); string toBeSigned = pdfsign.RemoteSignatureDigest; // Step 2: Pass to remote signing engine byte[] signedData = SignData(toBeSigned); // Step 3: Finalize pdfsign.Reset(); pdfsign.InputFile = "presigned.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.RemoteSignatureData = HexEncode(signedData); pdfsign.Sign(); In the PKCS#7 method, the struct can additionally act as the remote signer. To implement this side of the scheme, provide a binary hash of the PDF as input and set RemoteSignatureMethod to rsmDigest. After Sign completes, the output will contain a signed binary PKCS#7 structure over the hash that can then be embedded into the pre-signed document.

The following code shows the full PKCS#7 remote signing process using PDFSign on both sides: // Step 1: Pre-sign pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "presigned.pdf"; // Configure signature and/or widget properties as desired pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmPKCS7; pdfsign.Sign(); string toBeSigned = pdfsign.RemoteSignatureDigest; // Step 2: Sign the hash pdfsign.Reset(); pdfsign.InputData = HexDecode(toBeSigned); pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmDigest; pdfsign.Sign(); byte[] signedData = pdfsign.OutputData; // Step 3: Finalize pdfsign.Reset(); pdfsign.InputFile = "presigned.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.RemoteSignatureData = HexEncode(signedData); pdfsign.Sign();

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; although 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 contains only 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 Sign.

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 retrieves the necessary revocation // elements, embeds them into the document, and adds a document timestamp pdfsign.Reset(); pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "updated.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.Update(); Validation material "completeness" can be subjective and depends on several factors, including the following:

• 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, multifaceted 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: These parameters apply to Sign and Update in PDFSign as well as Verify 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 is validated. It includes options to control which checks the struct performs, 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: 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 struct searches for trust anchors. Local system stores, your own trusted root certificates (through the TrustedCerts property), and Trusted Lists (through 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 struct only uses KnownCerts, TrustedCerts, data structures within the document, 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

func (obj *PDFSign) AttachmentCount() (int32, error)
func (obj *PDFSign) SetAttachmentCount(value int32) error

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.

Data Type

int32

AttachmentContentType Property (PDFSign Component)

The content type of the attachment.

Syntax

func (obj *PDFSign) AttachmentContentType(AttachmentIndex int32) (string, error)
func (obj *PDFSign) SetAttachmentContentType(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentCreationDate Property (PDFSign Component)

The creation date of the attachment.

Syntax

func (obj *PDFSign) AttachmentCreationDate(AttachmentIndex int32) (string, error)
func (obj *PDFSign) SetAttachmentCreationDate(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentData Property (PDFSign Component)

The raw data of the attachment.

Syntax

func (obj *PDFSign) AttachmentData(AttachmentIndex int32) ([]byte, error)
func (obj *PDFSign) SetAttachmentData(AttachmentIndex int32, value []byte) error

Default Value

""

Remarks

The raw data of the attachment.

If AttachmentOutputStream is not set to a valid stream, the struct writes to this property when an empty string is passed to SaveAttachment.

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

Data Type

[]byte

AttachmentDescription Property (PDFSign Component)

A textual description of the attachment.

Syntax

func (obj *PDFSign) AttachmentDescription(AttachmentIndex int32) (string, error)
func (obj *PDFSign) SetAttachmentDescription(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentFileName Property (PDFSign Component)

The path and filename of the attachment.

Syntax

func (obj *PDFSign) AttachmentFileName(AttachmentIndex int32) (string, error)
func (obj *PDFSign) SetAttachmentFileName(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentModificationDate Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) AttachmentModificationDate(AttachmentIndex int32) (string, error)
func (obj *PDFSign) SetAttachmentModificationDate(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentName Property (PDFSign Component)

The name of the attachment.

Syntax

func (obj *PDFSign) AttachmentName(AttachmentIndex int32) (string, error)
func (obj *PDFSign) SetAttachmentName(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentSize Property (PDFSign Component)

The attachment's size in bytes.

Syntax

func (obj *PDFSign) AttachmentSize(AttachmentIndex int32) (int64, error)

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.

Data Type

int64

BlockedCertCount Property (PDFSign Component)

The number of records in the BlockedCert arrays.

Syntax

func (obj *PDFSign) BlockedCertCount() (int32, error)
func (obj *PDFSign) SetBlockedCertCount(value int32) error

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.

Data Type

int32

BlockedCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFSign) BlockedCertEffectiveDate(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

func (obj *PDFSign) BlockedCertExpirationDate(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFSign) BlockedCertExtendedKeyUsage(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertFingerprint Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertFingerprint(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertFingerprintSHA1 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertFingerprintSHA1(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertFingerprintSHA256 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertFingerprintSHA256(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

func (obj *PDFSign) BlockedCertIssuer(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFSign) BlockedCertPrivateKey(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFSign) BlockedCertPrivateKeyAvailable(BlockedCertIndex int32) (bool, error)

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.

Data Type

bool

BlockedCertPrivateKeyContainer Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertPrivateKeyContainer(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

func (obj *PDFSign) BlockedCertPublicKey(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertPublicKeyAlgorithm Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertPublicKeyAlgorithm(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertPublicKeyLength Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertPublicKeyLength(BlockedCertIndex int32) (int32, error)

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.

Data Type

int32

BlockedCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFSign) BlockedCertSerialNumber(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFSign) BlockedCertSignatureAlgorithm(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFSign) BlockedCertStore(BlockedCertIndex int32) ([]byte, error)
func (obj *PDFSign) SetBlockedCertStore(BlockedCertIndex int32, value []byte) error

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.

Data Type

[]byte

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

func (obj *PDFSign) BlockedCertStorePassword(BlockedCertIndex int32) (string, error)
func (obj *PDFSign) SetBlockedCertStorePassword(BlockedCertIndex int32, value string) error

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.

Data Type

string

BlockedCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFSign) BlockedCertStoreType(BlockedCertIndex int32) (int32, error)
func (obj *PDFSign) SetBlockedCertStoreType(BlockedCertIndex int32, value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct 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.

Data Type

int32

BlockedCertSubjectAltNames Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) BlockedCertSubjectAltNames(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFSign) BlockedCertThumbprintMD5(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFSign) BlockedCertThumbprintSHA1(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFSign) BlockedCertThumbprintSHA256(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

func (obj *PDFSign) BlockedCertUsage(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFSign) BlockedCertUsageFlags(BlockedCertIndex int32) (int32, error)

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.

Data Type

int32

BlockedCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

func (obj *PDFSign) BlockedCertVersion(BlockedCertIndex int32) (string, error)

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.

Data Type

string

BlockedCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFSign) BlockedCertSubject(BlockedCertIndex int32) (string, error)
func (obj *PDFSign) SetBlockedCertSubject(BlockedCertIndex int32, value string) error

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=example@email.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.

Data Type

string

BlockedCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFSign) BlockedCertEncoded(BlockedCertIndex int32) ([]byte, error)
func (obj *PDFSign) SetBlockedCertEncoded(BlockedCertIndex int32, value []byte) error

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.

Data Type

[]byte

DecryptionCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFSign) DecryptionCertEffectiveDate() (string, error)

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.

Data Type

string

DecryptionCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

func (obj *PDFSign) DecryptionCertExpirationDate() (string, error)

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.

Data Type

string

DecryptionCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFSign) DecryptionCertExtendedKeyUsage() (string, error)

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.

Data Type

string

DecryptionCertFingerprint Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertFingerprint() (string, error)

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.

Data Type

string

DecryptionCertFingerprintSHA1 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertFingerprintSHA1() (string, error)

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.

Data Type

string

DecryptionCertFingerprintSHA256 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertFingerprintSHA256() (string, error)

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.

Data Type

string

DecryptionCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

func (obj *PDFSign) DecryptionCertIssuer() (string, error)

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.

Data Type

string

DecryptionCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFSign) DecryptionCertPrivateKey() (string, error)

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.

Data Type

string

DecryptionCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFSign) DecryptionCertPrivateKeyAvailable() (bool, error)

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.

Data Type

bool

DecryptionCertPrivateKeyContainer Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertPrivateKeyContainer() (string, error)

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.

Data Type

string

DecryptionCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

func (obj *PDFSign) DecryptionCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

DecryptionCertPublicKeyAlgorithm Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertPublicKeyAlgorithm() (string, error)

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.

Data Type

string

DecryptionCertPublicKeyLength Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertPublicKeyLength() (int32, error)

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.

Data Type

int32

DecryptionCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFSign) DecryptionCertSerialNumber() (string, error)

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.

Data Type

string

DecryptionCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFSign) DecryptionCertSignatureAlgorithm() (string, error)

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.

Data Type

string

DecryptionCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFSign) DecryptionCertStore() ([]byte, error)
func (obj *PDFSign) SetDecryptionCertStore(value []byte) error

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).

Data Type

[]byte

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

func (obj *PDFSign) DecryptionCertStorePassword() (string, error)
func (obj *PDFSign) SetDecryptionCertStorePassword(value string) error

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.

Data Type

string

DecryptionCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFSign) DecryptionCertStoreType() (int32, error)
func (obj *PDFSign) SetDecryptionCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

DecryptionCertSubjectAltNames Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DecryptionCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

DecryptionCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFSign) DecryptionCertThumbprintMD5() (string, error)

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.

Data Type

string

DecryptionCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFSign) DecryptionCertThumbprintSHA1() (string, error)

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.

Data Type

string

DecryptionCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFSign) DecryptionCertThumbprintSHA256() (string, error)

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.

Data Type

string

DecryptionCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

func (obj *PDFSign) DecryptionCertUsage() (string, error)

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.

Data Type

string

DecryptionCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFSign) DecryptionCertUsageFlags() (int32, error)

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.

Data Type

int32

DecryptionCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

func (obj *PDFSign) DecryptionCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

DecryptionCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFSign) DecryptionCertSubject() (string, error)
func (obj *PDFSign) SetDecryptionCertSubject(value string) error

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

string

DecryptionCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFSign) DecryptionCertEncoded() ([]byte, error)
func (obj *PDFSign) SetDecryptionCertEncoded(value []byte) error

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.

Data Type

[]byte

DocumentCertCount Property (PDFSign Component)

The number of records in the DocumentCert arrays.

Syntax

func (obj *PDFSign) DocumentCertCount() (int32, error)

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.

Data Type

int32

DocumentCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFSign) DocumentCertEffectiveDate(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

func (obj *PDFSign) DocumentCertExpirationDate(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFSign) DocumentCertExtendedKeyUsage(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertFingerprint Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertFingerprint(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertFingerprintSHA1 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertFingerprintSHA1(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertFingerprintSHA256 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertFingerprintSHA256(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

func (obj *PDFSign) DocumentCertIssuer(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFSign) DocumentCertPrivateKey(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFSign) DocumentCertPrivateKeyAvailable(DocumentCertIndex int32) (bool, error)

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.

Data Type

bool

DocumentCertPrivateKeyContainer Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertPrivateKeyContainer(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

func (obj *PDFSign) DocumentCertPublicKey(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertPublicKeyAlgorithm Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertPublicKeyAlgorithm(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertPublicKeyLength Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertPublicKeyLength(DocumentCertIndex int32) (int32, error)

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.

Data Type

int32

DocumentCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFSign) DocumentCertSerialNumber(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFSign) DocumentCertSignatureAlgorithm(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFSign) DocumentCertStore(DocumentCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

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

func (obj *PDFSign) DocumentCertStorePassword(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFSign) DocumentCertStoreType(DocumentCertIndex int32) (int32, error)

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct 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.

Data Type

int32

DocumentCertSubjectAltNames Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) DocumentCertSubjectAltNames(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFSign) DocumentCertThumbprintMD5(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFSign) DocumentCertThumbprintSHA1(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFSign) DocumentCertThumbprintSHA256(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

func (obj *PDFSign) DocumentCertUsage(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFSign) DocumentCertUsageFlags(DocumentCertIndex int32) (int32, error)

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.

Data Type

int32

DocumentCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

func (obj *PDFSign) DocumentCertVersion(DocumentCertIndex int32) (string, error)

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.

Data Type

string

DocumentCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFSign) DocumentCertSubject(DocumentCertIndex int32) (string, error)

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=example@email.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.

Data Type

string

DocumentCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFSign) DocumentCertEncoded(DocumentCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

FirewallAutoDetect Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) FirewallAutoDetect() (bool, error)
func (obj *PDFSign) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

FirewallType Property (PDFSign Component)

The type of firewall to connect through.

Syntax

func (obj *PDFSign) FirewallType() (int32, error)
func (obj *PDFSign) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

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

Data Type

int32

FirewallHost Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) FirewallHost() (string, error)
func (obj *PDFSign) SetFirewallHost(value string) error

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 struct fails with an error.

Data Type

string

FirewallPassword Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) FirewallPassword() (string, error)
func (obj *PDFSign) SetFirewallPassword(value string) error

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 struct fails with an error.

Data Type

string

FirewallPort Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) FirewallPort() (int32, error)
func (obj *PDFSign) SetFirewallPort(value int32) error

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

int32

FirewallUser Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) FirewallUser() (string, error)
func (obj *PDFSign) SetFirewallUser(value string) error

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 struct fails with an error.

Data Type

string

InputData Property (PDFSign Component)

A byte array containing the PDF document to process.

Syntax

func (obj *PDFSign) InputData() ([]byte, error)
func (obj *PDFSign) SetInputData(value []byte) error

Remarks

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

Data Type

[]byte

InputFile Property (PDFSign Component)

The PDF file to process.

Syntax

func (obj *PDFSign) InputFile() (string, error)
func (obj *PDFSign) SetInputFile(value string) error

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

func (obj *PDFSign) KnownCertCount() (int32, error)
func (obj *PDFSign) SetKnownCertCount(value int32) error

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.

Data Type

int32

KnownCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFSign) KnownCertEffectiveDate(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

func (obj *PDFSign) KnownCertExpirationDate(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFSign) KnownCertExtendedKeyUsage(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertFingerprint Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertFingerprint(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertFingerprintSHA1 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertFingerprintSHA1(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertFingerprintSHA256 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertFingerprintSHA256(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

func (obj *PDFSign) KnownCertIssuer(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFSign) KnownCertPrivateKey(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFSign) KnownCertPrivateKeyAvailable(KnownCertIndex int32) (bool, error)

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.

Data Type

bool

KnownCertPrivateKeyContainer Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertPrivateKeyContainer(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

func (obj *PDFSign) KnownCertPublicKey(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertPublicKeyAlgorithm Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertPublicKeyAlgorithm(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertPublicKeyLength Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertPublicKeyLength(KnownCertIndex int32) (int32, error)

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.

Data Type

int32

KnownCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFSign) KnownCertSerialNumber(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFSign) KnownCertSignatureAlgorithm(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFSign) KnownCertStore(KnownCertIndex int32) ([]byte, error)
func (obj *PDFSign) SetKnownCertStore(KnownCertIndex int32, value []byte) error

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.

Data Type

[]byte

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

func (obj *PDFSign) KnownCertStorePassword(KnownCertIndex int32) (string, error)
func (obj *PDFSign) SetKnownCertStorePassword(KnownCertIndex int32, value string) error

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.

Data Type

string

KnownCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFSign) KnownCertStoreType(KnownCertIndex int32) (int32, error)
func (obj *PDFSign) SetKnownCertStoreType(KnownCertIndex int32, value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct 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.

Data Type

int32

KnownCertSubjectAltNames Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) KnownCertSubjectAltNames(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFSign) KnownCertThumbprintMD5(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFSign) KnownCertThumbprintSHA1(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFSign) KnownCertThumbprintSHA256(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

func (obj *PDFSign) KnownCertUsage(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFSign) KnownCertUsageFlags(KnownCertIndex int32) (int32, error)

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.

Data Type

int32

KnownCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

func (obj *PDFSign) KnownCertVersion(KnownCertIndex int32) (string, error)

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.

Data Type

string

KnownCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFSign) KnownCertSubject(KnownCertIndex int32) (string, error)
func (obj *PDFSign) SetKnownCertSubject(KnownCertIndex int32, value string) error

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=example@email.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.

Data Type

string

KnownCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFSign) KnownCertEncoded(KnownCertIndex int32) ([]byte, error)
func (obj *PDFSign) SetKnownCertEncoded(KnownCertIndex int32, value []byte) error

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.

Data Type

[]byte

OfflineMode Property (PDFSign Component)

Whether the class is operating in offline mode.

Syntax

func (obj *PDFSign) OfflineMode() (bool, error)
func (obj *PDFSign) SetOfflineMode(value bool) error

Default Value

false

Remarks

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

In offline mode, the struct 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

bool

OutputData Property (PDFSign Component)

A byte array containing the PDF document after processing.

Syntax

func (obj *PDFSign) OutputData() ([]byte, error)

Remarks

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

This property is read-only.

Data Type

[]byte

OutputFile Property (PDFSign Component)

The path to a local file where the output is written.

Syntax

func (obj *PDFSign) OutputFile() (string, error)
func (obj *PDFSign) SetOutputFile(value string) error

Default Value

""

Remarks

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

Data Type

string

Overwrite Property (PDFSign Component)

Whether the class should overwrite files.

Syntax

func (obj *PDFSign) Overwrite() (bool, error)
func (obj *PDFSign) SetOverwrite(value bool) error

Default Value

false

Remarks

This property indicates whether the struct overwrites OutputFile. If set to false, an error is thrown whenever OutputFile exists before an operation.

Data Type

bool

Password Property (PDFSign Component)

The password to decrypt the document with.

Syntax

func (obj *PDFSign) Password() (string, error)
func (obj *PDFSign) SetPassword(value string) error

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

func (obj *PDFSign) ProxyAuthScheme() (int32, error)
func (obj *PDFSign) SetProxyAuthScheme(value int32) error

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

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 struct 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 struct. Look at the configuration file for the struct 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

int32

ProxyAutoDetect Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) ProxyAutoDetect() (bool, error)
func (obj *PDFSign) SetProxyAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

ProxyPassword Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) ProxyPassword() (string, error)
func (obj *PDFSign) SetProxyPassword(value string) error

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

func (obj *PDFSign) ProxyPort() (int32, error)
func (obj *PDFSign) SetProxyPort(value int32) error

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

int32

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

func (obj *PDFSign) ProxyServer() (string, error)
func (obj *PDFSign) SetProxyServer(value string) error

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

func (obj *PDFSign) ProxySSL() (int32, error)
func (obj *PDFSign) SetProxySSL(value int32) error

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

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

Data Type

int32

ProxyUser Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) ProxyUser() (string, error)
func (obj *PDFSign) SetProxyUser(value string) error

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

RemoteSignatureData Property (PDFSign Component)

The signature data obtained from a remote signer.

Syntax

func (obj *PDFSign) RemoteSignatureData() (string, error)
func (obj *PDFSign) SetRemoteSignatureData(value string) error

Default Value

""

Remarks

This property is used to specify the hex-encoded signature data obtained from a remote signer. Use it to pass the RemoteSignatureDigest back to the struct (after it has been processed appropriately and signed) to complete the signature.

Data Type

string

RemoteSignatureDigest Property (PDFSign Component)

The digest to be signed remotely.

Syntax

func (obj *PDFSign) RemoteSignatureDigest() (string, error)

Default Value

""

Remarks

This property is used to read the hex-encoded digest that should be passed to a remote signer to be signed. Note that in the PKCS#1 method, this value is the raw data of the PKCS#7 signed-attributes field, whereas in the PKCS#7 method, it is the document hash.

This property is read-only.

Data Type

string

RemoteSignatureMethod Property (PDFSign Component)

The remote signing method.

Syntax

func (obj *PDFSign) RemoteSignatureMethod() (int32, error)
func (obj *PDFSign) SetRemoteSignatureMethod(value int32) error

Possible Values

0   // None
1   // PKCS1
2   // PKCS7
3   // Digest
4   // Blob

Default Value

0

Remarks

This property is used to specify whether and how the new signature is intended to be created remotely. If set to rsmPKCS1, rsmPKCS7, or rsmBlob before Sign is called, the struct does not perform the low-level signing operation itself but instead delegates it to an external or remote signer.

Possible values are:

Data Type

int32

RevocationCheck Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) RevocationCheck() (int32, error)
func (obj *PDFSign) SetRevocationCheck(value int32) error

Possible Values

0   // AllCRL
1   // AllOCSP
2   // AllCRLAndOCSP
3   // AnyCRL
4   // AnyOCSP
5   // AnyCRLOrOCSP
6   // AnyOCSPOrCRL

Default Value

6

Remarks

This property is used to specify the revocation sources and preferences the struct uses 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 is 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

int32

SignatureAuthorName Property (PDFSign Component)

The human-readable name of the signer.

Syntax

func (obj *PDFSign) SignatureAuthorName() (string, error)
func (obj *PDFSign) SetSignatureAuthorName(value string) error

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

func (obj *PDFSign) SignatureClaimedSigningTime() (string, error)
func (obj *PDFSign) SetSignatureClaimedSigningTime(value string) error

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.

If this property is empty when a new signature is created, the struct uses the current UTC time.

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

func (obj *PDFSign) SignatureField() (int32, error)
func (obj *PDFSign) SetSignatureField(value int32) error

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 is 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

int32

SignatureHashAlgorithm Property (PDFSign Component)

The hash algorithm to be used for signing.

Syntax

func (obj *PDFSign) SignatureHashAlgorithm() (string, error)
func (obj *PDFSign) SetSignatureHashAlgorithm(value string) error

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

func (obj *PDFSign) SignatureProfile() (int32, error)
func (obj *PDFSign) SetSignatureProfile(value int32) error

Possible Values

0   // None
1   // BaselineB
2   // BaselineT
3   // BaselineLT
4   // BaselineLTA

Default Value

0

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 struct 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 CustomProfile.

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

Data Type

int32

SignatureReason Property (PDFSign Component)

The reason for signing.

Syntax

func (obj *PDFSign) SignatureReason() (string, error)
func (obj *PDFSign) SetSignatureReason(value string) error

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

func (obj *PDFSign) PDFSignatureCount() (int32, error)

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.

Data Type

int32

PDFSignatureAuthorName Property (PDFSign Component)

The human-readable name of the signer.

Syntax

func (obj *PDFSign) PDFSignatureAuthorName(PDFSignatureIndex int32) (string, error)

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.

Data Type

string

PDFSignatureChainValidationDetails Property (PDFSign Component)

The details of the certificate chain validation outcome.

Syntax

func (obj *PDFSign) PDFSignatureChainValidationDetails(PDFSignatureIndex int32) (int32, error)

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.

Data Type

int32

PDFSignatureChainValidationResult Property (PDFSign Component)

The outcome of the certificate chain validation routine.

Syntax

func (obj *PDFSign) PDFSignatureChainValidationResult(PDFSignatureIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Valid
2   // ValidButUntrusted
3   // Invalid
4   // CantBeEstablished

Default Value

0

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.

Data Type

int32

PDFSignatureClaimedSigningTime Property (PDFSign Component)

The signature's creation time in UTC.

Syntax

func (obj *PDFSign) PDFSignatureClaimedSigningTime(PDFSignatureIndex int32) (string, error)

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 forged 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.

Data Type

string

PDFSignatureCoverageEndsAt Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) PDFSignatureCoverageEndsAt(PDFSignatureIndex int32) (int32, error)

Default Value

0

Remarks

The byte 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 GetSignedVersion to extract the exact revision that was signed.

A value of 0 indicates that the struct could not determine the coverage offset.

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.

Data Type

int32

PDFSignatureHashAlgorithm Property (PDFSign Component)

The hash algorithm that was used for signing.

Syntax

func (obj *PDFSign) PDFSignatureHashAlgorithm(PDFSignatureIndex int32) (string, error)

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.

Data Type

string

PDFSignatureProfile Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) PDFSignatureProfile(PDFSignatureIndex int32) (int32, error)

Possible Values

0   // None
1   // BaselineB
2   // BaselineT
3   // BaselineLT
4   // BaselineLTA

Default Value

0

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.

Data Type

int32

PDFSignatureReason Property (PDFSign Component)

The reason for signing.

Syntax

func (obj *PDFSign) PDFSignatureReason(PDFSignatureIndex int32) (string, error)

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.

Data Type

string

PDFSignatureType Property (PDFSign Component)

The type of the signature that was created.

Syntax

func (obj *PDFSign) PDFSignatureType(PDFSignatureIndex int32) (int32, error)

Possible Values

0   // Legacy
1   // Advanced
2   // DTS
3   // EmptyField

Default Value

0

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.

Data Type

int32

PDFSignatureSignerCertIndex Property (PDFSign Component)

The index of the signer certificate in the DocumentCerts collection.

Syntax

func (obj *PDFSign) PDFSignatureSignerCertIndex(PDFSignatureIndex int32) (int32, error)

Default Value

-1

Remarks

The index of the signer certificate in the DocumentCerts collection.

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.

Data Type

int32

PDFSignatureTimestampCertIndex Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) PDFSignatureTimestampCertIndex(PDFSignatureIndex int32) (int32, error)

Default Value

-1

Remarks

The index of the timestamping certificate in the DocumentCerts collection (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.

Data Type

int32

PDFSignatureTimestamped Property (PDFSign Component)

Whether the signature contains an embedded timestamp.

Syntax

func (obj *PDFSign) PDFSignatureTimestamped(PDFSignatureIndex int32) (bool, error)

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.

Data Type

bool

PDFSignatureValidatedSigningTime Property (PDFSign Component)

The certified signing time in UTC.

Syntax

func (obj *PDFSign) PDFSignatureValidatedSigningTime(PDFSignatureIndex int32) (string, error)

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 non-empty 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.

Data Type

string

PDFSignatureValidationResult Property (PDFSign Component)

The outcome of the cryptographic signature validation.

Syntax

func (obj *PDFSign) PDFSignatureValidationResult(PDFSignatureIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Valid
2   // Corrupted
3   // SignerNotFound
4   // Failure

Default Value

0

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.

Data Type

int32

PDFSignatureWidgetHeight Property (PDFSign Component)

The height of the signature widget in points.

Syntax

func (obj *PDFSign) PDFSignatureWidgetHeight(PDFSignatureIndex int32) (string, error)

Default Value

"70"

Remarks

The height of the signature widget in points.

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.

Data Type

string

PDFSignatureWidgetOffsetX Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) PDFSignatureWidgetOffsetX(PDFSignatureIndex int32) (string, error)

Default Value

"0"

Remarks

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

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.

Data Type

string

PDFSignatureWidgetOffsetY Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) PDFSignatureWidgetOffsetY(PDFSignatureIndex int32) (string, error)

Default Value

"0"

Remarks

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

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.

Data Type

string

PDFSignatureWidgetPages Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) PDFSignatureWidgetPages(PDFSignatureIndex int32) (string, error)

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.

Data Type

string

PDFSignatureWidgetWidth Property (PDFSign Component)

The width of the signature widget in points.

Syntax

func (obj *PDFSign) PDFSignatureWidgetWidth(PDFSignatureIndex int32) (string, error)

Default Value

"70"

Remarks

The width of the signature widget in points.

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.

Data Type

string

SignatureType Property (PDFSign Component)

The type of signature to create.

Syntax

func (obj *PDFSign) SignatureType() (int32, error)
func (obj *PDFSign) SetSignatureType(value int32) error

Possible Values

0   // Legacy
1   // Advanced
2   // DTS
3   // EmptyField

Default Value

0

Remarks

This property is used to specify the type of the signature. For PAdES signatures, use SignatureProfile to specify the PAdES profile.

Possible values are:

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

Data Type

int32

SignatureWidgetHeight Property (PDFSign Component)

The height of the signature widget.

Syntax

func (obj *PDFSign) SignatureWidgetHeight() (string, error)
func (obj *PDFSign) SetSignatureWidgetHeight(value string) error

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

func (obj *PDFSign) SignatureWidgetOffsetX() (string, error)
func (obj *PDFSign) SetSignatureWidgetOffsetX(value string) error

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

func (obj *PDFSign) SignatureWidgetOffsetY() (string, error)
func (obj *PDFSign) SetSignatureWidgetOffsetY(value string) error

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

func (obj *PDFSign) SignatureWidgetPages() (string, error)
func (obj *PDFSign) SetSignatureWidgetPages(value string) error

Default Value

""

Remarks

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

A variety of syntaxes are supported:

• A single page index (zero-based): 3
• A comma-separated list of page indices (zero-based): 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: If no valid pages are specified, the struct places the widget on the first page by default.

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

Data Type

string

SignatureWidgetWidth Property (PDFSign Component)

The width of the signature widget.

Syntax

func (obj *PDFSign) SignatureWidgetWidth() (string, error)
func (obj *PDFSign) SetSignatureWidgetWidth(value string) error

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

func (obj *PDFSign) SigningCertEffectiveDate() (string, error)

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.

Data Type

string

SigningCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

func (obj *PDFSign) SigningCertExpirationDate() (string, error)

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.

Data Type

string

SigningCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFSign) SigningCertExtendedKeyUsage() (string, error)

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.

Data Type

string

SigningCertFingerprint Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertFingerprint() (string, error)

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.

Data Type

string

SigningCertFingerprintSHA1 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertFingerprintSHA1() (string, error)

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.

Data Type

string

SigningCertFingerprintSHA256 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertFingerprintSHA256() (string, error)

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.

Data Type

string

SigningCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

func (obj *PDFSign) SigningCertIssuer() (string, error)

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.

Data Type

string

SigningCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFSign) SigningCertPrivateKey() (string, error)

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.

Data Type

string

SigningCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFSign) SigningCertPrivateKeyAvailable() (bool, error)

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.

Data Type

bool

SigningCertPrivateKeyContainer Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertPrivateKeyContainer() (string, error)

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.

Data Type

string

SigningCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

func (obj *PDFSign) SigningCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SigningCertPublicKeyAlgorithm Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertPublicKeyAlgorithm() (string, error)

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.

Data Type

string

SigningCertPublicKeyLength Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertPublicKeyLength() (int32, error)

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.

Data Type

int32

SigningCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFSign) SigningCertSerialNumber() (string, error)

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.

Data Type

string

SigningCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFSign) SigningCertSignatureAlgorithm() (string, error)

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.

Data Type

string

SigningCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFSign) SigningCertStore() ([]byte, error)
func (obj *PDFSign) SetSigningCertStore(value []byte) error

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).

Data Type

[]byte

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

func (obj *PDFSign) SigningCertStorePassword() (string, error)
func (obj *PDFSign) SetSigningCertStorePassword(value string) error

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.

Data Type

string

SigningCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFSign) SigningCertStoreType() (int32, error)
func (obj *PDFSign) SetSigningCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

SigningCertSubjectAltNames Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) SigningCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SigningCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFSign) SigningCertThumbprintMD5() (string, error)

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.

Data Type

string

SigningCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFSign) SigningCertThumbprintSHA1() (string, error)

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.

Data Type

string

SigningCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFSign) SigningCertThumbprintSHA256() (string, error)

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.

Data Type

string

SigningCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

func (obj *PDFSign) SigningCertUsage() (string, error)

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.

Data Type

string

SigningCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFSign) SigningCertUsageFlags() (int32, error)

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.

Data Type

int32

SigningCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

func (obj *PDFSign) SigningCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SigningCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFSign) SigningCertSubject() (string, error)
func (obj *PDFSign) SetSigningCertSubject(value string) error

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

string

SigningCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFSign) SigningCertEncoded() ([]byte, error)
func (obj *PDFSign) SetSigningCertEncoded(value []byte) error

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.

Data Type

[]byte

TimestampServer Property (PDFSign Component)

The address of the timestamping server.

Syntax

func (obj *PDFSign) TimestampServer() (string, error)
func (obj *PDFSign) SetTimestampServer(value string) error

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 TSATLSClientCertStoreType, TSATLSClientCertStore, TSATLSClientCertStorePassword, and TSATLSClientCertSubject.

Data Type

string

TrustedCertCount Property (PDFSign Component)

The number of records in the TrustedCert arrays.

Syntax

func (obj *PDFSign) TrustedCertCount() (int32, error)
func (obj *PDFSign) SetTrustedCertCount(value int32) error

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.

Data Type

int32

TrustedCertEffectiveDate Property (PDFSign Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFSign) TrustedCertEffectiveDate(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertExpirationDate Property (PDFSign Component)

The date on which the certificate expires.

Syntax

func (obj *PDFSign) TrustedCertExpirationDate(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertExtendedKeyUsage Property (PDFSign Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFSign) TrustedCertExtendedKeyUsage(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertFingerprint Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertFingerprint(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertFingerprintSHA1 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertFingerprintSHA1(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertFingerprintSHA256 Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertFingerprintSHA256(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertIssuer Property (PDFSign Component)

The issuer of the certificate.

Syntax

func (obj *PDFSign) TrustedCertIssuer(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertPrivateKey Property (PDFSign Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFSign) TrustedCertPrivateKey(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertPrivateKeyAvailable Property (PDFSign Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFSign) TrustedCertPrivateKeyAvailable(TrustedCertIndex int32) (bool, error)

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.

Data Type

bool

TrustedCertPrivateKeyContainer Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertPrivateKeyContainer(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertPublicKey Property (PDFSign Component)

The public key of the certificate.

Syntax

func (obj *PDFSign) TrustedCertPublicKey(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertPublicKeyAlgorithm Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertPublicKeyAlgorithm(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertPublicKeyLength Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertPublicKeyLength(TrustedCertIndex int32) (int32, error)

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.

Data Type

int32

TrustedCertSerialNumber Property (PDFSign Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFSign) TrustedCertSerialNumber(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertSignatureAlgorithm Property (PDFSign Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFSign) TrustedCertSignatureAlgorithm(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertStore Property (PDFSign Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFSign) TrustedCertStore(TrustedCertIndex int32) ([]byte, error)
func (obj *PDFSign) SetTrustedCertStore(TrustedCertIndex int32, value []byte) error

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.

Data Type

[]byte

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

func (obj *PDFSign) TrustedCertStorePassword(TrustedCertIndex int32) (string, error)
func (obj *PDFSign) SetTrustedCertStorePassword(TrustedCertIndex int32, value string) error

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.

Data Type

string

TrustedCertStoreType Property (PDFSign Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFSign) TrustedCertStoreType(TrustedCertIndex int32) (int32, error)
func (obj *PDFSign) SetTrustedCertStoreType(TrustedCertIndex int32, value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct 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.

Data Type

int32

TrustedCertSubjectAltNames Property (PDFSign Component)

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

Syntax

func (obj *PDFSign) TrustedCertSubjectAltNames(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertThumbprintMD5 Property (PDFSign Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFSign) TrustedCertThumbprintMD5(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertThumbprintSHA1 Property (PDFSign Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFSign) TrustedCertThumbprintSHA1(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertThumbprintSHA256 Property (PDFSign Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFSign) TrustedCertThumbprintSHA256(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertUsage Property (PDFSign Component)

The text description of UsageFlags .

Syntax

func (obj *PDFSign) TrustedCertUsage(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertUsageFlags Property (PDFSign Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFSign) TrustedCertUsageFlags(TrustedCertIndex int32) (int32, error)

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.

Data Type

int32

TrustedCertVersion Property (PDFSign Component)

The certificate's version number.

Syntax

func (obj *PDFSign) TrustedCertVersion(TrustedCertIndex int32) (string, error)

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.

Data Type

string

TrustedCertSubject Property (PDFSign Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFSign) TrustedCertSubject(TrustedCertIndex int32) (string, error)
func (obj *PDFSign) SetTrustedCertSubject(TrustedCertIndex int32, value string) error

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=example@email.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.

Data Type

string

TrustedCertEncoded Property (PDFSign Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFSign) TrustedCertEncoded(TrustedCertIndex int32) ([]byte, error)
func (obj *PDFSign) SetTrustedCertEncoded(TrustedCertIndex int32, value []byte) error

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.

Data Type

[]byte

TrustedLists Property (PDFSign Component)

A list of known Trusted Lists for chain validation.

Syntax

func (obj *PDFSign) TrustedLists() (string, error)
func (obj *PDFSign) SetTrustedLists(value string) error

Default Value

"%EUTL%"

Remarks

This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the struct 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 struct consults 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 struct 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 struct caches all Trusted Lists it downloads and uses during chain validation. This cache is shared between struct instances within the same process. If this property contains a URL that is also present in the cache, the struct retrieves the cached data and reuses it in the current validation. If the data is invalid, the struct downloads a fresh Trusted List and adds it to the cache.

Data Type

string

TrustSources Property (PDFSign Component)

The trust sources to use during chain validation.

Syntax

func (obj *PDFSign) TrustSources() (int32, error)
func (obj *PDFSign) SetTrustSources(value int32) error

Possible Values

0   // Manual
1   // Local
2   // TrustedLists
3   // LocalAndTrustedLists

Default Value

3

Remarks

This property is used to specify the sources the struct uses 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

int32

ValidationFlags Property (PDFSign Component)

Additional chain validation settings.

Syntax

func (obj *PDFSign) ValidationFlags() (int32, error)
func (obj *PDFSign) SetValidationFlags(value int32) error

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

int32

ValidationPolicy Property (PDFSign Component)

The level at which to perform chain validation.

Syntax

func (obj *PDFSign) ValidationPolicy() (int32, error)
func (obj *PDFSign) SetValidationPolicy(value int32) error

Possible Values

0   // None
1   // Full
2   // FullNoTrust
3   // FullNoRevocation
4   // BestEffort

Default Value

1

Remarks

This property is used to specify the overall validation policy the struct follows.

Possible values are:

Validation Policy Heuristics

The choice of validation policy depends 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 struct.
• 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

int32

ValidationTime Property (PDFSign Component)

The time point at which the signature should be validated.

Syntax

func (obj *PDFSign) ValidationTime() (string, error)
func (obj *PDFSign) SetValidationTime(value string) error

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 struct then prioritizes:

• 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 the document.

Syntax

func (obj *PDFSign) AddAttachment(FileName string, Description string) error

Remarks

This method is used to add an attachment (embedded file) to the document and to the Attachments properties.

FileName and Description specify the filename and description of the attachment respectively.

Example: component.InputFile = "input.pdf"; component.OutputFile = "input_with_attachment.pdf"; component.Open(); component.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"; component.Attachments.Add(attachment); // Or using one of the constructors: component.Attachments.Add(new PDFAttachment("foo.txt", "desc")); component.Close(); The full list of attachments is contained in the Attachments properties.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

AddTimestamp Method (PDFSign Component)

Adds a document timestamp to the document.

Syntax

func (obj *PDFSign) AddTimestamp() error

Remarks

This method is used to obtain a document timestamp and embed it into the document.

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 opens it, performs the operation, then closes it.

Close Method (PDFSign Component)

Closes the opened document.

Syntax

func (obj *PDFSign) Close() error

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to Open.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they are saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set SaveChanges.

Config Method (PDFSign Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *PDFSign) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 the document is encrypted.

Syntax

func (obj *PDFSign) Encrypted() (bool, error)

Remarks

This method is used to determine whether the document is encrypted. It returns 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 opens it, performs the operation, then closes it.

GetPageProperty Method (PDFSign Component)

Returns the value of a page property.

Syntax

func (obj *PDFSign) GetPageProperty(PageIndex int32, PageProperty string) (string, error)

Remarks

This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details.

PageIndex specifies the page to read information about (with a valid range from 0 to PageCount - 1), and PageProperty specifies the page property to read. Possible values are:

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; 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(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); NOTE: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetWidgetProperty Method (PDFSign Component)

Returns the value of a signature widget property.

Syntax

func (obj *PDFSign) GetWidgetProperty(SignatureIndex int32, WidgetProperty string) (string, error)

Remarks

This method is used to obtain 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 struct. The list of settings below may be extended in the future.

SignatureIndex is the index of the signature of interest in the Signatures collection, and WidgetProperty specifies the widget property to read. Possible values are:

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 opens it, performs the operation, then closes it.

Interrupt Method (PDFSign Component)

Interrupts the current action.

Syntax

func (obj *PDFSign) Interrupt() error

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 the document for processing.

Syntax

func (obj *PDFSign) Open() error

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 populates 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 fires (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 struct then attempts 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 Decrypt to save a decrypted copy of the document instead.

RemoveAttachment Method (PDFSign Component)

Removes an attachment from the document.

Syntax

func (obj *PDFSign) RemoveAttachment(Index int32) error

Remarks

This method is used to remove an attachment from the document and from the Attachments collection.

Index is the index of the attachment in the Attachments collection 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 opens it, performs the operation, then closes it.

Reset Method (PDFSign Component)

Resets the class.

Syntax

func (obj *PDFSign) Reset() error

Remarks

This method is used to reset the struct's properties and configuration settings to their default values.

SaveAttachment Method (PDFSign Component)

Saves a PDF attachment to a file.

Syntax

func (obj *PDFSign) SaveAttachment(Index int32, FileName string) error

Remarks

This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the Attachments collection.

Index is the index of the attachment in the Attachments collection to be saved.

FileName 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 opens it, performs the operation, then closes it.

SetWidgetProperty Method (PDFSign Component)

Sets the value of a signature widget property.

Syntax

func (obj *PDFSign) SetWidgetProperty(WidgetProperty string, Value string) error

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 struct. The list of settings below may be extended in the future.

WidgetProperty and Value specify the widget property and value to set respectively. Possible values for the former are:

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 the data.

Syntax

func (obj *PDFSign) Sign() error

Remarks

This method is used to sign the document or its hash. If RemoteSignatureMethod is set to rsmNone or rsmDigest, the input data is signed directly with SigningCert. Otherwise, if it is set to rsmPKCS1 or rsmPKCS7, the document is "pre-signed" with the configured signature settings and RemoteSignatureDigest is populated with the data to be signed remotely.

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 is available via the Log event if applicable.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Signed Method (PDFSign Component)

Checks whether the document is signed.

Syntax

func (obj *PDFSign) Signed() (bool, error)

Remarks

This method is used to determine whether the document is signed. It returns false if the document contains only empty signature fields.

Example: pdfsign.InputFile = "input.pdf"; if (!pdfsign.Signed()) { pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); // Configure signature-related properties as desired pdfsign.Sign(); } NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Update Method (PDFSign Component)

Updates the most recent signature.

Syntax

func (obj *PDFSign) Update() error

Remarks

This method is used to update the most recent signature by embedding newer or missing revocation information into the signed document.

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 struct proceeds with chain validation and the retrieval of any missing chain elements. If the signature is cryptographically wrong, the struct throws 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 struct 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 UpdateIndex.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

ChainCert Event (PDFSign Component)

Fired when the class encounters a chain certificate.

Syntax

// PDFSignChainCertEventArgs carries the PDFSign ChainCert event's parameters.
type PDFSignChainCertEventArgs struct {...}

func (args *PDFSignChainCertEventArgs) CertEncoded() []byte
func (args *PDFSignChainCertEventArgs) CertSubject() string
func (args *PDFSignChainCertEventArgs) CertIssuer() string
func (args *PDFSignChainCertEventArgs) ValidationTime() string
func (args *PDFSignChainCertEventArgs) ValidationResult() int32
func (args *PDFSignChainCertEventArgs) SetValidationResult(value int32)

func (args *PDFSignChainCertEventArgs) ValidationDetails() int32
func (args *PDFSignChainCertEventArgs) SetValidationDetails(value int32)

// PDFSignChainCertEvent defines the signature of the PDFSign ChainCert event's handler function.
type PDFSignChainCertEvent func(sender *PDFSign, args *PDFSignChainCertEventArgs)

func (obj *PDFSign) GetOnChainCertHandler() PDFSignChainCertEvent
func (obj *PDFSign) SetOnChainCertHandler(handlerFunc PDFSignChainCertEvent)

Remarks

This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The struct tries to retrieve all required chain certificates automatically.

CertEncoded specifies the PEM (Base64-encoded) public certificate.

CertSubject and CertIssuer specify the distinguished names of the certificate owner and issuer respectively.

ValidationTime specifies the time point (in UTC) at which the certificate validity was established.

ValidationResult reports the outcome of the individual certificate validation and can be one of the following values:

In the case of a failure, ValidationDetails provides more details on its reasons. Its value is a bitmask of the following flags:

Overridable Chain Validation

While the struct follows 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 struct continues or aborts 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

// PDFSignDocumentInfoEventArgs carries the PDFSign DocumentInfo event's parameters.
type PDFSignDocumentInfoEventArgs struct {...}

func (args *PDFSignDocumentInfoEventArgs) PageCount() int32
func (args *PDFSignDocumentInfoEventArgs) SignatureCount() int32
// PDFSignDocumentInfoEvent defines the signature of the PDFSign DocumentInfo event's handler function.
type PDFSignDocumentInfoEvent func(sender *PDFSign, args *PDFSignDocumentInfoEventArgs)

func (obj *PDFSign) GetOnDocumentInfoHandler() PDFSignDocumentInfoEvent
func (obj *PDFSign) SetOnDocumentInfoHandler(handlerFunc PDFSignDocumentInfoEvent)

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, GetPageProperty can be used to find the optimal position for the signature widget.

PageCount reports the number of pages in the document.

SignatureCount reports the number of signatures in the document.

This event is fired when Open 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

// PDFSignErrorEventArgs carries the PDFSign Error event's parameters.
type PDFSignErrorEventArgs struct {...}

func (args *PDFSignErrorEventArgs) ErrorCode() int32
func (args *PDFSignErrorEventArgs) Description() string
// PDFSignErrorEvent defines the signature of the PDFSign Error event's handler function.
type PDFSignErrorEvent func(sender *PDFSign, args *PDFSignErrorEventArgs)

func (obj *PDFSign) GetOnErrorHandler() PDFSignErrorEvent
func (obj *PDFSign) SetOnErrorHandler(handlerFunc PDFSignErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

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

// PDFSignLogEventArgs carries the PDFSign Log event's parameters.
type PDFSignLogEventArgs struct {...}

func (args *PDFSignLogEventArgs) LogLevel() int32
func (args *PDFSignLogEventArgs) Message() string
func (args *PDFSignLogEventArgs) LogType() string
// PDFSignLogEvent defines the signature of the PDFSign Log event's handler function.
type PDFSignLogEvent func(sender *PDFSign, args *PDFSignLogEventArgs)

func (obj *PDFSign) GetOnLogHandler() PDFSignLogEvent
func (obj *PDFSign) SetOnLogHandler(handlerFunc PDFSignLogEvent)

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFSign Component)

Fired when the class detects that the document is encrypted with a password.

Syntax

// PDFSignPasswordEventArgs carries the PDFSign Password event's parameters.
type PDFSignPasswordEventArgs struct {...}

func (args *PDFSignPasswordEventArgs) Available() bool
func (args *PDFSignPasswordEventArgs) Cancel() bool
func (args *PDFSignPasswordEventArgs) SetCancel(value bool)

// PDFSignPasswordEvent defines the signature of the PDFSign Password event's handler function.
type PDFSignPasswordEvent func(sender *PDFSign, args *PDFSignPasswordEventArgs)

func (obj *PDFSign) GetOnPasswordHandler() PDFSignPasswordEvent
func (obj *PDFSign) SetOnPasswordHandler(handlerFunc PDFSignPasswordEvent)

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 Password.

Available indicates whether the decryption password is already available to the struct or still needs to be set. If this parameter is false, the correct password must be provided for the decryption attempt to succeed.

Cancel determines whether the struct will stop firing this event to request a password.

RecipientInfo Event (PDFSign Component)

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFSignRecipientInfoEventArgs carries the PDFSign RecipientInfo event's parameters.
type PDFSignRecipientInfoEventArgs struct {...}

func (args *PDFSignRecipientInfoEventArgs) Issuer() string
func (args *PDFSignRecipientInfoEventArgs) SerialNumber() string
func (args *PDFSignRecipientInfoEventArgs) SubjectKeyIdentifier() string
func (args *PDFSignRecipientInfoEventArgs) Available() bool
func (args *PDFSignRecipientInfoEventArgs) Cancel() bool
func (args *PDFSignRecipientInfoEventArgs) SetCancel(value bool)

// PDFSignRecipientInfoEvent defines the signature of the PDFSign RecipientInfo event's handler function.
type PDFSignRecipientInfoEvent func(sender *PDFSign, args *PDFSignRecipientInfoEventArgs)

func (obj *PDFSign) GetOnRecipientInfoHandler() PDFSignRecipientInfoEvent
func (obj *PDFSign) SetOnRecipientInfoHandler(handlerFunc PDFSignRecipientInfoEvent)

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 DecryptionCert.

Issuer specifies the subject of the issuer certificate.

SerialNumber specifies the serial number of the encryption certificate.

SubjectKeyIdentifier specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

Available indicates whether the decryption certificate is already available to the struct or still needs to be set. If this parameter is false, the correct certificate must be provided for the decryption attempt to succeed.

Cancel determines whether the struct 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 causes its own invocation of this event.

SignatureInfo Event (PDFSign Component)

Fired when the class finds a signature in the document.

Syntax

// PDFSignSignatureInfoEventArgs carries the PDFSign SignatureInfo event's parameters.
type PDFSignSignatureInfoEventArgs struct {...}

func (args *PDFSignSignatureInfoEventArgs) SignatureIndex() int32
func (args *PDFSignSignatureInfoEventArgs) ValidateSignature() bool
func (args *PDFSignSignatureInfoEventArgs) SetValidateSignature(value bool)

func (args *PDFSignSignatureInfoEventArgs) ValidateChain() bool
func (args *PDFSignSignatureInfoEventArgs) SetValidateChain(value bool)

// PDFSignSignatureInfoEvent defines the signature of the PDFSign SignatureInfo event's handler function.
type PDFSignSignatureInfoEvent func(sender *PDFSign, args *PDFSignSignatureInfoEventArgs)

func (obj *PDFSign) GetOnSignatureInfoHandler() PDFSignSignatureInfoEvent
func (obj *PDFSign) SetOnSignatureInfoHandler(handlerFunc PDFSignSignatureInfoEvent)

Remarks

This event is fired once for each signature found in the document to report that it is about to be validated.

SignatureIndex is the index of the signature in the Signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. ValidateSignature and ValidateChain 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

// PDFSignSignatureProcessedEventArgs carries the PDFSign SignatureProcessed event's parameters.
type PDFSignSignatureProcessedEventArgs struct {...}

func (args *PDFSignSignatureProcessedEventArgs) SignatureIndex() int32
func (args *PDFSignSignatureProcessedEventArgs) SignatureValidationResult() int32
func (args *PDFSignSignatureProcessedEventArgs) ChainValidationResult() int32
func (args *PDFSignSignatureProcessedEventArgs) ChainValidationDetails() int32
// PDFSignSignatureProcessedEvent defines the signature of the PDFSign SignatureProcessed event's handler function.
type PDFSignSignatureProcessedEvent func(sender *PDFSign, args *PDFSignSignatureProcessedEventArgs)

func (obj *PDFSign) GetOnSignatureProcessedHandler() PDFSignSignatureProcessedEvent
func (obj *PDFSign) SetOnSignatureProcessedHandler(handlerFunc PDFSignSignatureProcessedEvent)

Remarks

This event is fired once for each signature found in the document to report that it has completed validation. It is fired after SignatureInfo if that event's ValidateSignature parameter is set to true.

SignatureIndex is the index of the signature in the Signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in SignatureValidationResult and ChainValidationResult.

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, ChainValidationDetails 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

// PDFSignSSLServerAuthenticationEventArgs carries the PDFSign SSLServerAuthentication event's parameters.
type PDFSignSSLServerAuthenticationEventArgs struct {...}

func (args *PDFSignSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *PDFSignSSLServerAuthenticationEventArgs) CertSubject() string
func (args *PDFSignSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *PDFSignSSLServerAuthenticationEventArgs) Status() string
func (args *PDFSignSSLServerAuthenticationEventArgs) Accept() bool
func (args *PDFSignSSLServerAuthenticationEventArgs) SetAccept(value bool)

// PDFSignSSLServerAuthenticationEvent defines the signature of the PDFSign SSLServerAuthentication event's handler function.
type PDFSignSSLServerAuthenticationEvent func(sender *PDFSign, args *PDFSignSSLServerAuthenticationEventArgs)

func (obj *PDFSign) GetOnSSLServerAuthenticationHandler() PDFSignSSLServerAuthenticationEvent
func (obj *PDFSign) SetOnSSLServerAuthenticationHandler(handlerFunc PDFSignSSLServerAuthenticationEvent)

Remarks

This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the struct. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

During this event, the client can decide whether to continue with the connection process. Accept 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 to continue.

When Accept is false, Status 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 Accept to true.

SSLStatus Event (PDFSign Component)

Fired when secure connection progress messages are available.

Syntax

// PDFSignSSLStatusEventArgs carries the PDFSign SSLStatus event's parameters.
type PDFSignSSLStatusEventArgs struct {...}

func (args *PDFSignSSLStatusEventArgs) Message() string
// PDFSignSSLStatusEvent defines the signature of the PDFSign SSLStatus event's handler function.
type PDFSignSSLStatusEvent func(sender *PDFSign, args *PDFSignSSLStatusEventArgs)

func (obj *PDFSign) GetOnSSLStatusHandler() PDFSignSSLStatusEvent
func (obj *PDFSign) SetOnSSLStatusHandler(handlerFunc PDFSignSSLStatusEvent)

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 struct 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 struct, 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 class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors