PDFDecrypt Component

Properties   Methods   Events   Config Settings   Errors  

The PDFDecrypt class decrypts PDF documents.

Syntax

securepdf.PDFDecrypt

Remarks

The PDFDecrypt struct supports decryption of both password-encrypted and certificate-encrypted PDF documents. To determine the document's encryption type before decrypting it, subscribe to the Password and RecipientInfo events and open the document. For example: pdfdecrypt.InputFile = "encrypted.pdf"; pdfdecrypt.OnPassword += (s, e) => { Console.WriteLine("The PDF document is encrypted with a password."); }; pdfdecrypt.OnRecipientInfo += (s, e) => { Console.WriteLine("The PDF document is encrypted with a certificate."); }; pdfdecrypt.Open(); pdfdecrypt.Close();

Password-Based Decryption

If you have determined that the PDF is encrypted with a password (or know that fact beforehand), you must provide the correct decryption password using the Password property (for user passwords) or the OwnerPassword configuration setting (for owner passwords) to decrypt the document and gain access to its contents.

The following code shows how to decrypt a password-encrypted PDF document: pdfdecrypt.InputFile = "password_encrypted.pdf"; pdfdecrypt.OutputFile = "decrypted.pdf"; pdfdecrypt.Password = "password"; pdfdecrypt.Decrypt(); Alternatively, set the decryption password within your Password event handler, and the struct will decrypt the document all the same. The Available parameter may come in handy in determining whether the struct already possesses the necessary decryption password.

Certificate-Based Decryption

If you have determined that the PDF is encrypted with a certificate (or know that fact beforehand), you must provide the decryption certificate containing the correct private key to decrypt the document and gain access to its contents.

The following code shows how to decrypt a certificate-encrypted PDF document: pdfdecrypt.InputFile = "cert_encrypted.pdf"; pdfdecrypt.OutputFile = "decrypted.pdf"; pdfdecrypt.DecryptionCert = new Certificate(CertStoreTypes.cstPFXFile, "C:/MyCerts/cert.pfx", "cert_pass", "*"); pdfdecrypt.Decrypt(); Alternatively, set the decryption certificate within your RecipientInfo event handler, and the struct will decrypt the document all the same. Like in the Password event, the Available parameter may come in handy when determining whether the struct already possesses the necessary decryption certificate. The information published by the other parameters in the event (i.e., Issuer, SerialNumber, and SubjectKeyIdentifier) may also be useful for determining which decryption certificate should be used.

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.

DecryptionCertEffectiveDate Property (PDFDecrypt Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The date on which the certificate expires.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The issuer of the certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The public key of the certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFDecrypt) DecryptionCertStore() ([]byte, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt 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 *PDFDecrypt) DecryptionCertStorePassword() (string, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFDecrypt) DecryptionCertStoreType() (int32, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The text description of UsageFlags .

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The certificate's version number.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFDecrypt) DecryptionCertSubject() (string, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFDecrypt) DecryptionCertEncoded() ([]byte, error)
func (obj *PDFDecrypt) 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

InputData Property (PDFDecrypt Component)

A byte array containing the PDF document to process.

Syntax

func (obj *PDFDecrypt) InputData() ([]byte, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The PDF file to process.

Syntax

func (obj *PDFDecrypt) InputFile() (string, error)
func (obj *PDFDecrypt) 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

OutputData Property (PDFDecrypt Component)

A byte array containing the PDF document after processing.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

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

Syntax

func (obj *PDFDecrypt) OutputFile() (string, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

Whether the class should overwrite files.

Syntax

func (obj *PDFDecrypt) Overwrite() (bool, error)
func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

The password to decrypt the document with.

Syntax

func (obj *PDFDecrypt) Password() (string, error)
func (obj *PDFDecrypt) 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

Close Method (PDFDecrypt Component)

Closes the opened document.

Syntax

func (obj *PDFDecrypt) 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 (PDFDecrypt Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *PDFDecrypt) 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.

Decrypt Method (PDFDecrypt Component)

Decrypts the document.

Syntax

func (obj *PDFDecrypt) Decrypt() error

Remarks

This method is used to permanently remove encryption from the document. The document is decrypted with either Password (for password-based encryption) or DecryptionCert (for certificate-based encryption).

Example: pdfdecrypt.InputFile = "encrypted.pdf"; pdfdecrypt.OutputFile = "decrypted.pdf"; // Set decryption material (Password or DecryptionCert) here pdfdecrypt.Decrypt(); NOTE: Since full decryption invalidates all signatures, this method automatically removes them from the document. Existing signatures should therefore be verified before calling this method.

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

Encrypted Method (PDFDecrypt Component)

Checks whether the document is encrypted.

Syntax

func (obj *PDFDecrypt) 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: pdfdecrypt.InputFile = "input.pdf"; if (pdfdecrypt.Encrypted()) { pdfdecrypt.OutputFile = "decrypted.pdf"; // Set Password or DecryptionCert pdfdecrypt.Decrypt(); } NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Open Method (PDFDecrypt Component)

Opens the document for processing.

Syntax

func (obj *PDFDecrypt) 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 decryption. 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.

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.

Reset Method (PDFDecrypt Component)

Resets the class.

Syntax

func (obj *PDFDecrypt) Reset() error

Remarks

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

Error Event (PDFDecrypt Component)

Fired when information is available about errors during data delivery.

Syntax

// PDFDecryptErrorEventArgs carries the PDFDecrypt Error event's parameters.
type PDFDecryptErrorEventArgs struct {...}

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

func (obj *PDFDecrypt) GetOnErrorHandler() PDFDecryptErrorEvent
func (obj *PDFDecrypt) SetOnErrorHandler(handlerFunc PDFDecryptErrorEvent)

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

Fired once for each log message.

Syntax

// PDFDecryptLogEventArgs carries the PDFDecrypt Log event's parameters.
type PDFDecryptLogEventArgs struct {...}

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

func (obj *PDFDecrypt) GetOnLogHandler() PDFDecryptLogEvent
func (obj *PDFDecrypt) SetOnLogHandler(handlerFunc PDFDecryptLogEvent)

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

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

Syntax

// PDFDecryptPasswordEventArgs carries the PDFDecrypt Password event's parameters.
type PDFDecryptPasswordEventArgs struct {...}

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

// PDFDecryptPasswordEvent defines the signature of the PDFDecrypt Password event's handler function.
type PDFDecryptPasswordEvent func(sender *PDFDecrypt, args *PDFDecryptPasswordEventArgs)

func (obj *PDFDecrypt) GetOnPasswordHandler() PDFDecryptPasswordEvent
func (obj *PDFDecrypt) SetOnPasswordHandler(handlerFunc PDFDecryptPasswordEvent)

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

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFDecryptRecipientInfoEventArgs carries the PDFDecrypt RecipientInfo event's parameters.
type PDFDecryptRecipientInfoEventArgs struct {...}

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

// PDFDecryptRecipientInfoEvent defines the signature of the PDFDecrypt RecipientInfo event's handler function.
type PDFDecryptRecipientInfoEvent func(sender *PDFDecrypt, args *PDFDecryptRecipientInfoEventArgs)

func (obj *PDFDecrypt) GetOnRecipientInfoHandler() PDFDecryptRecipientInfoEvent
func (obj *PDFDecrypt) SetOnRecipientInfoHandler(handlerFunc PDFDecryptRecipientInfoEvent)

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.

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

PDFDecrypt Config Settings

Base Config Settings

Trappable Errors (PDFDecrypt Component)

PDFDecrypt Errors

PDF Errors

Parsing Errors