PDFDecrypt Component

Properties   Methods   Events   Config Settings   Errors  

The PDFDecrypt component decrypts PDF documents.

Syntax

nsoftware.SecurePDF.PDFDecrypt

Remarks

The PDFDecrypt component 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 via the Password property (for user passwords) or the OwnerPassword configuration setting (for owner passwords) in order to decrypt the document and get 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 component will decrypt the document all the same. The Available parameter may come in handy in determining whether the component 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 in order to decrypt the document and get 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 component will decrypt the document all the same. Like in the Password event, the Available parameter may come in handy in determining whether the component 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.

DecryptionCertThe decryption certificate.
InputDataA byte array containing the PDF document to process.
InputFileThe PDF file to process.
OutputDataA byte array containing the PDF document after processing.
OutputFileThe path to a local file where the output will be written.
OverwriteWhether or not the component should overwrite files.
PasswordThe password to decrypt the document with.

Method List

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

CloseCloses an opened PDF document.
ConfigSets or retrieves a configuration setting.
DecryptDecrypts a PDF document.
EncryptedChecks whether a PDF document is encrypted.
OpenOpens a PDF document for processing.
ResetResets the component.
SetInputStreamSets the stream containing the PDF document to process.
SetOutputStreamSets the stream to write the processed document to.

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.

ErrorFired when information is available about errors during data delivery.
LogFired once for each log message.
PasswordFired when the component detects that the PDF document is encrypted with a password.
RecipientInfoFired for each recipient certificate of the encrypted PDF document.

Config Settings

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

CloseInputStreamAfterProcessingWhether to close the input stream after processing.
CloseOutputStreamAfterProcessingWhether to close the output stream after processing.
EncryptionAlgorithmThe encryption algorithm used to encrypt the PDF document.
LogLevelThe level of detail that is logged.
OwnerPasswordThe owner password to decrypt the document with.
PermissionsThe document permissions associated with the encryption.
SaveChangesWhether to save changes made to the PDF document.
TempPathThe location where temporary files are stored.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

DecryptionCert Property (PDFDecrypt Component)

The decryption certificate.

Syntax

public Certificate DecryptionCert { get; set; }

Public Property DecryptionCert As Certificate

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

InputData Property (PDFDecrypt Component)

A byte array containing the PDF document to process.

Syntax

public byte[] InputData { get; set; }

Public Property InputData As Byte()

Remarks

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

This property is not available at design time.

InputFile Property (PDFDecrypt Component)

The PDF file to process.

Syntax

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

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

OutputData Property (PDFDecrypt Component)

A byte array containing the PDF document after processing.

Syntax

public byte[] OutputData { get; }

Public ReadOnly Property OutputData As Byte()

Remarks

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

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

OutputFile Property (PDFDecrypt Component)

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

Syntax

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

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

Overwrite Property (PDFDecrypt Component)

Whether or not the component should overwrite files.

Syntax

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

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

Password Property (PDFDecrypt Component)

The password to decrypt the document with.

Syntax

public string Password { get; set; }

Public Property Password As String

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.

Close Method (PDFDecrypt Component)

Closes an opened PDF document.

Syntax

public void Close();

Async Version
public async Task Close();
public async Task Close(CancellationToken cancellationToken);

Public Sub Close()

Async Version
Public Sub Close() As Task
Public Sub Close(cancellationToken As CancellationToken) As Task

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. It should always be preceded by a call to the Open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFDecrypt Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (PDFDecrypt Component)

Decrypts a PDF document.

Syntax

public void Decrypt();

Async Version
public async Task Decrypt();
public async Task Decrypt(CancellationToken cancellationToken);

Public Sub Decrypt()

Async Version
Public Sub Decrypt() As Task
Public Sub Decrypt(cancellationToken As CancellationToken) As Task

Remarks

This method is used to permanently remove encryption from the PDF document specified in InputFile, InputData, or SetInputStream. The document will be decrypted with either Password (for password-based encryption) or DecryptionCert (for certificate-based encryption) and saved in OutputFile, OutputData, or the stream set in SetOutputStream.

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 will automatically remove them from the document. Existing signatures should therefore be verified before calling this method.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Encrypted Method (PDFDecrypt Component)

Checks whether a PDF document is encrypted.

Syntax

public bool Encrypted();

Async Version
public async Task<bool> Encrypted();
public async Task<bool> Encrypted(CancellationToken cancellationToken);

Public Function Encrypted() As Boolean

Async Version
Public Function Encrypted() As Task(Of Boolean)
Public Function Encrypted(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

Example: 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 will open it, perform the operation, then close it.

Open Method (PDFDecrypt Component)

Opens a PDF document for processing.

Syntax

public void Open();

Async Version
public async Task Open();
public async Task Open(CancellationToken cancellationToken);

Public Sub Open()

Async Version
Public Sub Open() As Task
Public Sub Open(cancellationToken As CancellationToken) As Task

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as signing, updating, verifying signatures, or removing signatures. 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 will fire (depending on the encryption type) as a notification that the document must be decrypted before processing can continue.

Once the correct decryption material is supplied, the component will then attempt to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use the Decrypt method to save a decrypted copy of the document instead.

Reset Method (PDFDecrypt Component)

Resets the component.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SetInputStream Method (PDFDecrypt Component)

Sets the stream containing the PDF document to process.

Syntax

public void SetInputStream(System.IO.Stream inputStream);

Async Version
public async Task SetInputStream(System.IO.Stream inputStream);
public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken);

Public Sub SetInputStream(ByVal InputStream As System.IO.Stream)

Async Version
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream) As Task
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method is used to set the stream from which the component will read the PDF document to be processed. If an input stream is set before the component attempts to perform operations on the document, the component will read the data from the input stream instead of from the InputFile or InputData properties.

Note: It may be useful to additionally set the CloseInputStreamAfterProcessing configuration setting to true when using input streams.

SetOutputStream Method (PDFDecrypt Component)

Sets the stream to write the processed document to.

Syntax

public void SetOutputStream(System.IO.Stream outputStream);

Async Version
public async Task SetOutputStream(System.IO.Stream outputStream);
public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken);

Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream) As Task
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method is used to set the stream to which the component will write the resulting PDF document. If an output stream is set before the component attempts to perform operations on the document, the component will write the data to the output stream instead of writing to OutputFile or populating OutputData.

Note: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to true when using output streams.

Error Event (PDFDecrypt Component)

Fired when information is available about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PDFDecryptErrorEventArgs e);

public class PDFDecryptErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PDFDecryptErrorEventArgs)

Public Class PDFDecryptErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

Log Event (PDFDecrypt Component)

Fired once for each log message.

Syntax

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, PDFDecryptLogEventArgs e);

public class PDFDecryptLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As PDFDecryptLogEventArgs)

Public Class PDFDecryptLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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

0 (None) No messages are logged.
1 (Info - default) Informational events such as the basics of the chain validation procedure are logged.
2 (Verbose) Detailed data such as HTTP requests are logged.
3 (Debug) Debug data including the full chain validation procedure are logged.

The Message parameter is the log message.

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

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

Password Event (PDFDecrypt Component)

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

Syntax

public event OnPasswordHandler OnPassword;

public delegate void OnPasswordHandler(object sender, PDFDecryptPasswordEventArgs e);

public class PDFDecryptPasswordEventArgs : EventArgs {
  public bool Available { get; }
  public bool Cancel { get; set; }
}

Public Event OnPassword As OnPasswordHandler

Public Delegate Sub OnPasswordHandler(sender As Object, e As PDFDecryptPasswordEventArgs)

Public Class PDFDecryptPasswordEventArgs Inherits EventArgs
  Public ReadOnly Property Available As Boolean
  Public Property Cancel As Boolean
End Class

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to the Password property.

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

The Cancel parameter determines whether the component will stop firing this event to request a password.

RecipientInfo Event (PDFDecrypt Component)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

public event OnRecipientInfoHandler OnRecipientInfo;

public delegate void OnRecipientInfoHandler(object sender, PDFDecryptRecipientInfoEventArgs e);

public class PDFDecryptRecipientInfoEventArgs : EventArgs {
  public string Issuer { get; }
  public string SerialNumber { get; }
  public string SubjectKeyIdentifier { get; }
  public bool Available { get; }
  public bool Cancel { get; set; }
}

Public Event OnRecipientInfo As OnRecipientInfoHandler

Public Delegate Sub OnRecipientInfoHandler(sender As Object, e As PDFDecryptRecipientInfoEventArgs)

Public Class PDFDecryptRecipientInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property SerialNumber As String
  Public ReadOnly Property SubjectKeyIdentifier As String
  Public ReadOnly Property Available As Boolean
  Public Property Cancel As Boolean
End Class

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

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

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

The Cancel parameter determines whether the component will stop firing this event to request a certificate.

Note: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:
  • EffectiveDate
  • ExpirationDate
  • ExtendedKeyUsage
  • Fingerprint
  • FingerprintSHA1
  • FingerprintSHA256
  • Issuer
  • PrivateKey
  • PrivateKeyAvailable
  • PrivateKeyContainer
  • PublicKey
  • PublicKeyAlgorithm
  • PublicKeyLength
  • SerialNumber
  • SignatureAlgorithm
  • Store
  • StorePassword
  • StoreType
  • SubjectAltNames
  • ThumbprintMD5
  • ThumbprintSHA1
  • ThumbprintSHA256
  • Usage
  • UsageFlags
  • Version
  • Subject
  • Encoded

    • Fields

    EffectiveDate
    string (read-only)
    Default: ""

    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.

    ExpirationDate
    string (read-only)
    Default: ""

    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.

    ExtendedKeyUsage
    string (read-only)
    Default: ""

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

    Fingerprint
    string (read-only)
    Default: ""

    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

    FingerprintSHA1
    string (read-only)
    Default: ""

    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

    FingerprintSHA256
    string (read-only)
    Default: ""

    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

    Issuer
    string (read-only)
    Default: ""

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

    PrivateKey
    string (read-only)
    Default: ""

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

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

    PrivateKeyAvailable
    bool (read-only)
    Default: False

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

    PrivateKeyContainer
    string (read-only)
    Default: ""

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

    PublicKey
    string (read-only)
    Default: ""

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

    PublicKeyAlgorithm
    string (read-only)
    Default: ""

    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.

    PublicKeyLength
    int (read-only)
    Default: 0

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

    SerialNumber
    string (read-only)
    Default: ""

    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.

    SignatureAlgorithm
    string (read-only)
    Default: ""

    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.

    Store
    string
    Default: "MY"

    The name of the certificate store for the client certificate.

    The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

    Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

    Designations of certificate stores are platform dependent.

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

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot certificates.

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

    StoreB
    byte []
    Default: "MY"

    The name of the certificate store for the client certificate.

    The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

    Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

    Designations of certificate stores are platform dependent.

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

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot certificates.

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

    StorePassword
    string
    Default: ""

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

    StoreType
    CertStoreTypes
    Default: 0

    The type of certificate store for this certificate.

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

    0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

    Note: This store type is not available in Java.

    1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

    Note: This store type is not available in Java.

    2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
    3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
    4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

    Note: This store type is only available in Java.

    5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

    Note: This store type is only available in Java.

    6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
    7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
    8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
    9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
    10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
    11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
    12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
    13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
    14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
    15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
    16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
    17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
    18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
    19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
    21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

    Note: This store type is only available in Java and .NET.

    22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

    Note: This store type is only available in Java and .NET.

    23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

    To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

    When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

    Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

    99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

    SubjectAltNames
    string (read-only)
    Default: ""

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

    ThumbprintMD5
    string (read-only)
    Default: ""

    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.

    ThumbprintSHA1
    string (read-only)
    Default: ""

    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.

    ThumbprintSHA256
    string (read-only)
    Default: ""

    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.

    Usage
    string (read-only)
    Default: ""

    The text description of UsageFlags.

    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.

    UsageFlags
    int (read-only)
    Default: 0

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

    0x80Digital Signature
    0x40Non-Repudiation
    0x20Key Encipherment
    0x10Data Encipherment
    0x08Key Agreement
    0x04Certificate Signing
    0x02CRL Signing
    0x01Encipher Only

    Please see the Usage field for a text representation of UsageFlags.

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

    Version
    string (read-only)
    Default: ""

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

    Subject
    string
    Default: ""

    The subject of the certificate used for client authentication.

    This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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

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

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

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

    FieldMeaning
    CNCommon Name. This is commonly a hostname like www.server.com.
    OOrganization
    OUOrganizational Unit
    LLocality
    SState
    CCountry
    EEmail Address

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

    Encoded
    string
    Default: ""

    The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

    EncodedB
    byte []
    Default: ""

    The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

    Constructors

    public Certificate();

    Public Certificate()

    Creates a instance whose properties can be set. This is useful for use with when generating new certificates. 

    public Certificate(string certificateFile);

    Public Certificate(ByVal CertificateFile As String)

    Opens CertificateFile and reads out the contents as an X.509 public key. 

    public Certificate(byte[] encoded);

    Public Certificate(ByVal Encoded As Byte())

    Parses Encoded as an X.509 public key. 

    public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

    Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

    Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

    ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

    Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key. 

    public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

    Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

    Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

    Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

    Config Settings (PDFDecrypt Component)

    The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

    PDFDecrypt Config Settings

    CloseInputStreamAfterProcessing:   Whether to close the input stream after processing.

    This setting determines whether the input stream specified in SetInputStream will be closed after processing is complete. The default value is true.

    CloseOutputStreamAfterProcessing:   Whether to close the output stream after processing.

    This setting determines whether the output stream specified in SetOutputStream will be closed after processing is complete. The default value is true.

    EncryptionAlgorithm:   The encryption algorithm used to encrypt the PDF document.

    This setting returns the encryption algorithm that was used to encrypt the document. This setting is read-only.

    LogLevel:   The level of detail that is logged.

    This setting controls the level of detail that is logged through the Log event. Possible values are:

    0 (None) No messages are logged.
    1 (Info - default) Informational events such as the basics of the chain validation procedure are logged.
    2 (Verbose) Detailed data such as HTTP requests are logged.
    3 (Debug) Debug data including the full chain validation procedure are logged.
    OwnerPassword:   The owner password to decrypt the document with.

    This setting is used to provide the document owner password for decryption. Though it may be different from Password, most implementations use the same value for both.

    Permissions:   The document permissions associated with the encryption.

    This setting returns the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but note that it is a policy-like requirement rather than an enforcement.

    This setting is read-only. Its value is a bitmask of the following flags:

    0x001 (pepAnnotations) Annotating is allowed.
    0x002 (pepAssemble) Assembling a new document on the basis of the processed one is allowed.
    0x004 (pepExtract) Extraction/copying of the pictures and text from the document is allowed.
    0x008 (pepExtractAcc) Content extraction is allowed for accessibility purposes only.
    0x010 (pepFillInForms) Filling in forms is allowed.
    0x020 (pepHighQualityPrint) High quality printing is allowed.
    0x040 (pepLowQualityPrint) Low quality printing is allowed.
    0x080 (pepModify) Modifications are allowed.

    SaveChanges:   Whether to save changes made to the PDF document.

    This setting specifies whether and how changes made to the PDF document will be saved when the Close method is called. Possible values are:

    0 Discard all changes.
    1 Save the document to OutputFile, OutputData, or the stream set in SetOutputStream, even if it has not been modified.
    2 (default) Save the document to OutputFile, OutputData, or the stream set in SetOutputStream, but only if it has been modified.
    TempPath:   The location where temporary files are stored.

    This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage.

    Base Config Settings

    BuildInfo:   Information about the product's build.

    When queried, this setting will return a string containing information about the product's build.

    GUIAvailable:   Whether or not a message loop is available for processing events.

    In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

    In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

    LicenseInfo:   Information about the current license.

    When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

    • Product: The product the license is for.
    • Product Key: The key the license was generated from.
    • License Source: Where the license was found (e.g., RuntimeLicense, License File).
    • License Type: The type of license installed (e.g., Royalty Free, Single Server).
    • Last Valid Build: The last valid build number for which the license will work.
    MaskSensitiveData:   Whether sensitive data is masked in log messages.

    In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

    This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

    UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

    When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

    Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

    On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

    If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

    Note: This setting is static. The value set is applicable to all components used in the application.

    When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

    Trappable Errors (PDFDecrypt Component)

    PDFDecrypt Errors

    860   The document is not encrypted.

    PDF Errors

    804   PDF decompression failed.
    805   Cannot add entry to cross-reference table.
    806   Unsupported field size.
    807   Unsupported Encoding filter.
    808   Unsupported predictor algorithm.
    809   Unsupported document version.
    812   Cannot read PDF file stream.
    813   Cannot write to PDF file stream.
    814   OutputFile already exists and Overwrite is false.
    815   Invalid parameter.
    817   Bad cross-reference entry.
    818   Invalid object or generation number.
    819   Invalid object stream.
    820   Invalid stream dictionary.
    821   Invalid AcroForm entry.
    822   Invalid Root entry.
    823   Invalid annotation.
    824   The input document is empty.
    826   OpenType font error. The error description contains the detailed message.
    828   Invalid CMS data. The error description contains the detailed message.
    835   Cannot change decryption mode for opened document.
    836   Unsupported Date string.
    838   Cryptographic error. The error description contains the detailed message.
    840   No decryption key found.
    841   Encryption failed. The error description contains the detailed message.
    842   No proper certificate for encryption found.
    846   Unsupported revision.
    847   Unsupported security handler SubFilter.
    848   Failed to verify permissions.
    849   Invalid password.
    850   Invalid password information.
    852   Unsupported encryption algorithm.
    859   Cannot encrypt encrypted document.
    864   Cannot modify document after signature update.
    868   Cannot encrypt or decrypt object.
    869   Invalid security handler information.
    870   Invalid encrypted data.
    871   Invalid block cipher padding.
    872   Failed to reload signature.
    873   Object is not encrypted.
    874   Unexpected cipher information.
    877   Invalid document. Bad document catalog.
    878   Invalid document Id.
    880   Invalid document. Invalid requirements dictionary.
    881   Invalid linearization dictionary.
    882   Invalid signature information.
    883   Unsupported document format.
    890   Unsupported feature.
    891   Internal error. The error description contains the detailed message.

    Parsing Errors

    1001   Bad object.
    1002   Bad document trailer.
    1003   Illegal stream dictionary.
    1004   Illegal string.
    1005   Indirect object expected.
    1007   Invalid reference.
    1008   Invalid reference table.
    1009   Invalid stream data.
    1010   Unexpected character.
    1011   Unexpected EOF.
    1012   Unexpected indirect object in cross-reference table.
    1021   Invalid type in Root object list.