# PDFEncrypt Class

The PDFEncrypt class encrypts PDF documents.

## Syntax

```text
PDFEncrypt
```

## Remarks

As with signing, PDF encryption is part of the PDF format. It is used to prevent unauthorized access to documents and is performed using either an encryption password (known as password-based or symmetric encryption) or the intended document recipient's public X.509 certificate (known as certificate-based or asymmetric encryption). The PDFEncrypt class supports both encryption types.

The benefit of this encryption scheme as defined in the standard is that encrypted PDF documents are still valid PDF documents and can be handled by almost any PDF reader. Of course, this software needs to be able to decrypt such documents, but it can always reach the metadata (information about the document) and document structure.

### Password-Based Encryption

 In password-based encryption, the publishers and intended users of the document must know some secret key (a password), which is used both to protect the document and access the protected data. Once the document has been protected (encrypted), the password is required to gain access to the document's contents. Although this method is straightforward and widely used for protecting PDF documents, the password must be passed from the publisher to the intended users, which presents a significant disadvantage.

The following code shows how to encrypt a PDF document with a user password:

```csharp
pdfencrypt.InputFile = "input.pdf";
pdfencrypt.OutputFile = "password_encrypted.pdf";
pdfencrypt.Password = "password";
pdfencrypt.Encrypt();
```

 Owner passwords are also supported. Compared with user passwords, these passwords are used to protect the permissions (set using the [Permissions](#permissions-property-pdfencrypt-class) property) that are embedded into the document. For example, you may want to prevent the recipient from printing or editing the document. You can encrypt the document with an owner password by specifying the [OwnerPassword](#OwnerPassword) configuration setting before calling [Encrypt](#encrypt-method-pdfencrypt-class).

### Certificate-Based Encryption

 Certificate-based encryption uses X.509 digital certificates to encrypt data. This encryption type provides a higher level of security than password-based encryption, because it relies on cryptographic key pairs, making it more difficult for unauthorized users to gain access. It is often used in environments in which secure and authenticated document exchange is critical. Encrypting with a certificate (as opposed to a password) ensures that only the intended recipient who possesses the corresponding private key can decrypt the PDF document.

The following code shows how to encrypt a PDF document with a certificate:

```csharp
pdfencrypt.InputFile = "input.pdf";
pdfencrypt.OutputFile = "cert_encrypted.pdf";
pdfencrypt.EncryptionCert = new Certificate(CertStoreTypes.cstPublicKeyFile, "C:/MyCerts/cert.cer", "", "*");
pdfencrypt.Encrypt();
```

 When encrypting using either a password or certificate, set the [EncryptionAlgorithm](#encryptionalgorithm-property-pdfencrypt-class) property to the desired encryption algorithm. As additional encryption options, you can also decide whether the document metadata will be encrypted and embed permissions into the document using the [EncryptMetadata](#encryptmetadata-property-pdfencrypt-class) and [Permissions](#permissions-property-pdfencrypt-class) properties, respectively.

## Property List

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

|  |  |
| --- | --- |
| [EncryptionAlgorithm](#encryptionalgorithm-property-pdfencrypt-class) | The encryption algorithm to encrypt the document with. |
| [EncryptionCert](#encryptioncert-property-pdfencrypt-class) | The encryption certificate. |
| [EncryptMetadata](#encryptmetadata-property-pdfencrypt-class) | Whether to encrypt the document metadata. |
| [InputData](#inputdata-property-pdfencrypt-class) | A byte array containing the PDF document to process. |
| [InputFile](#inputfile-property-pdfencrypt-class) | The PDF file to process. |
| [OutputData](#outputdata-property-pdfencrypt-class) | A byte array containing the PDF document after processing. |
| [OutputFile](#outputfile-property-pdfencrypt-class) | The path to a local file where the output is written. |
| [Overwrite](#overwrite-property-pdfencrypt-class) | Whether the class should overwrite files. |
| [Password](#password-property-pdfencrypt-class) | The password to encrypt the document with. |
| [Permissions](#permissions-property-pdfencrypt-class) | The document permissions associated with the encryption. |

## Method List

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

|  |  |
| --- | --- |
| [Close](#close-method-pdfencrypt-class) | Closes the opened document. |
| [Config](#config-method-pdfencrypt-class) | Sets or retrieves a configuration setting. |
| [Encrypt](#encrypt-method-pdfencrypt-class) | Encrypts the document. |
| [Encrypted](#encrypted-method-pdfencrypt-class) | Checks whether the document is encrypted. |
| [Open](#open-method-pdfencrypt-class) | Opens the document for processing. |
| [Reset](#reset-method-pdfencrypt-class) | Resets the class. |
| [SetInputStream](#setinputstream-method-pdfencrypt-class) | Sets the stream containing the PDF document to process. |
| [SetOutputStream](#setoutputstream-method-pdfencrypt-class) | Sets the stream to write the processed document to. |

## Event List

*The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Error](#error-event-pdfencrypt-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-pdfencrypt-class) | Fired once for each log message. |
| [Password](#password-event-pdfencrypt-class) | Fired when the class detects that the document is encrypted with a password. |
| [RecipientInfo](#recipientinfo-event-pdfencrypt-class) | Fired for each recipient certificate of the encrypted document. |

## Config Settings

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

|  |  |
| --- | --- |
| [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. |
| [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether to close the output stream after processing. |
| [CompressStreams](#CompressStreams) | Whether to compress stream objects. |
| [HardenedKeyGeneration](#HardenedKeyGeneration) | Whether to use hardened key generation. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used with OAEP. |
| [OAEPParams](#OAEPParams) | The hex-encoded OAEP parameters. |
| [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used with OAEP. |
| [OwnerPassword](#OwnerPassword) | The owner password to encrypt the document with. |
| [RC4KeyBits](#RC4KeyBits) | The number of key bits used for the RC4 algorithm. |
| [SaveChanges](#SaveChanges) | Whether to save changes made to the document. |
| [TempPath](#TempPath) | The location where temporary files are stored. |
| [UseOAEP](#UseOAEP) | Whether to use Optimal Asymmetric Encryption Padding (OAEP) during encryption and decryption. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# EncryptionAlgorithm Property ([PDFEncrypt](#pdfencrypt-class) Class)

The encryption algorithm to encrypt the document with.

## Syntax

```text
ANSI (Cross Platform)
char* GetEncryptionAlgorithm();int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);
```

## Default Value

"AES256"

## Remarks

This property is used to specify the encryption algorithm to encrypt the document with.

Possible values are:

- RC4
- AES128
- AES256

## Data Type

String

# EncryptionCert Property ([PDFEncrypt](#pdfencrypt-class) Class)

The encryption certificate.

## Syntax

```text
SecurePDFCertificate* GetEncryptionCert();
int SetEncryptionCert(SecurePDFCertificate* val);
```

## Remarks

This property is used to provide the certificate used for encryption. Note that this certificate need not have a private key associated with it, but the intended recipient of the encrypted document does.

NOTE: Encryption for multiple recipients is currently unsupported.

This property is not available at design time.

## Data Type

[SecurePDFCertificate](#certificate-type)

# EncryptMetadata Property ([PDFEncrypt](#pdfencrypt-class) Class)

Whether to encrypt the document metadata.

## Syntax

```text
ANSI (Cross Platform)
int GetEncryptMetadata();int SetEncryptMetadata(int bEncryptMetadata);

Unicode (Windows)
BOOL GetEncryptMetadata();INT SetEncryptMetadata(BOOL bEncryptMetadata);
```

## Default Value

TRUE

## Remarks

This property indicates whether the document metadata is encrypted when [Encrypt](#encrypt-method-pdfencrypt-class) is called. Metadata contains additional information about the document, such as its name and author.

## Data Type

Boolean

# InputData Property ([PDFEncrypt](#pdfencrypt-class) Class)

A byte array containing the PDF document to process.

## Syntax

```text
ANSI (Cross Platform)
int GetInputData(char* &lpInputData, int &lenInputData);int SetInputData(const char* lpInputData, int lenInputData);

Unicode (Windows)
INT GetInputData(LPSTR &lpInputData, INT &lenInputData);INT SetInputData(LPCSTR lpInputData, INT lenInputData);
```

## Remarks

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

This property is not available at design time.

## Data Type

Byte Array

# InputFile Property ([PDFEncrypt](#pdfencrypt-class) Class)

The PDF file to process.

## Syntax

```text
ANSI (Cross Platform)
char* GetInputFile();int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();INT SetInputFile(LPCWSTR lpszInputFile);
```

## Default Value

""

## Remarks

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

## Data Type

String

# OutputData Property ([PDFEncrypt](#pdfencrypt-class) Class)

A byte array containing the PDF document after processing.

## Syntax

```text
ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);
```

## 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](#outputfile-property-pdfencrypt-class) and [SetOutputStream](#setoutputstream-method-pdfencrypt-class) respectively.

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

## Data Type

Byte Array

# OutputFile Property ([PDFEncrypt](#pdfencrypt-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetOutputFile();int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();INT SetOutputFile(LPCWSTR lpszOutputFile);
```

## 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 ([PDFEncrypt](#pdfencrypt-class) Class)

Whether the class should overwrite files.

## Syntax

```text
ANSI (Cross Platform)
int GetOverwrite();int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();INT SetOverwrite(BOOL bOverwrite);
```

## Default Value

FALSE

## Remarks

This property indicates whether the class overwrites [OutputFile](#outputfile-property-pdfencrypt-class). If set to *false*, an error is thrown whenever [OutputFile](#outputfile-property-pdfencrypt-class) exists before an operation.

## Data Type

Boolean

# Password Property ([PDFEncrypt](#pdfencrypt-class) Class)

The password to encrypt the document with.

## Syntax

```text
ANSI (Cross Platform)
char* GetPassword();int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();INT SetPassword(LPCWSTR lpszPassword);
```

## Default Value

""

## Remarks

This property is used to provide the user password for encryption. Though it may be different from [OwnerPassword](#OwnerPassword), most implementations use the same value for both.

## Data Type

String

# Permissions Property ([PDFEncrypt](#pdfencrypt-class) Class)

The document permissions associated with the encryption.

## Syntax

```text
ANSI (Cross Platform)
int GetPermissions();int SetPermissions(int iPermissions);

Unicode (Windows)
INT GetPermissions();INT SetPermissions(INT iPermissions);
```

## Default Value

0

## Remarks

This property is used to specify 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.

Its value should be provided as 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. |

This property is not available at design time.

## Data Type

Integer

# Close Method ([PDFEncrypt](#pdfencrypt-class) Class)

Closes the opened document.

## Syntax

```text
ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();
```

## Remarks

This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-pdfencrypt-class).

**Example:**

```csharp
component.InputFile = "input.pdf";
component.Open();
// Some operation
component.Close();
```

 If any changes are made to the document, they are saved automatically to [OutputFile](#outputfile-property-pdfencrypt-class), [OutputData](#outputdata-property-pdfencrypt-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfencrypt-class) when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Config Method ([PDFEncrypt](#pdfencrypt-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pdfencrypt-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-pdfencrypt-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Encrypt Method ([PDFEncrypt](#pdfencrypt-class) Class)

Encrypts the document.

## Syntax

```text
ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();
```

## Remarks

This method is used to encrypt the document. The document is encrypted using [EncryptionAlgorithm](#encryptionalgorithm-property-pdfencrypt-class) and either [Password](#password-property-pdfencrypt-class) (for password-based encryption) or [EncryptionCert](#encryptioncert-property-pdfencrypt-class) (for certificate-based encryption).

**Example:**

```csharp
pdfencrypt.InputFile = "input.pdf";
pdfencrypt.OutputFile = "encrypted.pdf";
pdfencrypt.Password = "password";
pdfencrypt.EncryptionAlgorithm = "AES256";
pdfencrypt.Encrypt();
```

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Encrypted Method ([PDFEncrypt](#pdfencrypt-class) Class)

Checks whether the document is encrypted.

## Syntax

```text
ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();
```

## 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:**

```csharp
pdfencrypt.InputFile = "input.pdf";
if (!pdfencrypt.Encrypted())
{
  pdfencrypt.OutputFile = "encrypted.pdf";
  // Set Password or EncryptionCert
  pdfencrypt.Encrypt();
}
```

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

## Error Handling (C++)

This method returns a Boolean value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Open Method ([PDFEncrypt](#pdfencrypt-class) Class)

Opens the document for processing.

## Syntax

```text
ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();
```

## Remarks

This method is used to open the document specified in [InputFile](#inputfile-property-pdfencrypt-class), [InputData](#inputdata-property-pdfencrypt-class), or [SetInputStream](#setinputstream-method-pdfencrypt-class) before performing some operation on it, such as encryption. When finished, call [Close](#close-method-pdfencrypt-class) to complete or discard the operation.

It is recommended to use this method (alongside [Close](#close-method-pdfencrypt-class)) when performing multiple operations on the document at once.

### Automatic Decryption Functionality

 If this method is called on an encrypted document, the [Password](#password-event-pdfencrypt-class) or [RecipientInfo](#recipientinfo-event-pdfencrypt-class) 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 class 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](PDFDecrypt.md#PDFDecrypt_m_Decrypt) to save a decrypted copy of the document instead.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Reset Method ([PDFEncrypt](#pdfencrypt-class) Class)

Resets the class.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetInputStream Method ([PDFEncrypt](#pdfencrypt-class) Class)

Sets the stream containing the PDF document to process.

## Syntax

```text
ANSI (Cross Platform)
int SetInputStream(SecurePDFStream* sInputStream);

Unicode (Windows)
INT SetInputStream(SecurePDFStream* sInputStream);
```

## Remarks

This method is used to set the stream from which the class reads the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class reads the data from the input stream instead of from the [InputFile](#inputfile-property-pdfencrypt-class) or [InputData](#inputdata-property-pdfencrypt-class) properties.

NOTE: It may be useful to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) to *true* when using input streams.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetOutputStream Method ([PDFEncrypt](#pdfencrypt-class) Class)

Sets the stream to write the processed document to.

## Syntax

```text
ANSI (Cross Platform)
int SetOutputStream(SecurePDFStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(SecurePDFStream* sOutputStream);
```

## Remarks

This method is used to set the stream to which the class writes the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class writes the data to the output stream instead of writing to [OutputFile](#outputfile-property-pdfencrypt-class) or populating [OutputData](#outputdata-property-pdfencrypt-class).

NOTE: It may be useful to additionally set [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) to *true* when using output streams.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Error Event ([PDFEncrypt](#pdfencrypt-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(PDFEncryptErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} PDFEncryptErrorEventParams;

Unicode (Windows)
virtual INT FireError(PDFEncryptErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} PDFEncryptErrorEventParams;
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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](#trappable-errors-pdfencrypt-class) section.

# Log Event ([PDFEncrypt](#pdfencrypt-class) Class)

Fired once for each log message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLog(PDFEncryptLogEventParams *e);
typedef struct {  int LogLevel;  const char *Message;  const char *LogType;
  int reserved;
} PDFEncryptLogEventParams;

Unicode (Windows)
virtual INT FireLog(PDFEncryptLogEventParams *e);
typedef struct {  INT LogLevel;  LPCWSTR Message;  LPCWSTR LogType;
  INT reserved;
} PDFEncryptLogEventParams;
```

## Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) configuration setting.

*LogLevel* 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. |

*Message* is the log message.

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

- CertValidator
- Font
- HTTP
- PDFInvalidSignature
- PDFRevocationInfo
- Timestamp
- TSL

# Password Event ([PDFEncrypt](#pdfencrypt-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FirePassword(PDFEncryptPasswordEventParams *e);
typedef struct {  int Available;  int Cancel;
  int reserved;
} PDFEncryptPasswordEventParams;

Unicode (Windows)
virtual INT FirePassword(PDFEncryptPasswordEventParams *e);
typedef struct {  BOOL Available;  BOOL Cancel;
  INT reserved;
} PDFEncryptPasswordEventParams;
```

## 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](#password-property-pdfencrypt-class).

*Available* indicates whether the decryption password is already available to the class 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 class will stop firing this event to request a password.

# RecipientInfo Event ([PDFEncrypt](#pdfencrypt-class) Class)

Fired for each recipient certificate of the encrypted document.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRecipientInfo(PDFEncryptRecipientInfoEventParams *e);
typedef struct {  const char *Issuer;  const char *SerialNumber;  const char *SubjectKeyIdentifier;  int Available;  int Cancel;
  int reserved;
} PDFEncryptRecipientInfoEventParams;

Unicode (Windows)
virtual INT FireRecipientInfo(PDFEncryptRecipientInfoEventParams *e);
typedef struct {  LPCWSTR Issuer;  LPCWSTR SerialNumber;  LPCWSTR SubjectKeyIdentifier;  BOOL Available;  BOOL Cancel;
  INT reserved;
} PDFEncryptRecipientInfoEventParams;
```

## 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 class 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 class 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.

# Certificate Type

This is the digital certificate being used.

## Syntax

 *SecurePDFCertificate* (declared in *securepdf.h*)

## 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](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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

 **Fingerprint** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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

 **PrivateKey** *char* (read-only)*
*Default Value: ""*

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

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *int (read-only)*
*Default Value: FALSE*

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

 **PrivateKeyContainer** *char* (read-only)*
*Default Value: ""*

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

 **PublicKey** *char* (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *char* (read-only)*
*Default Value: ""*

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 Value: 0*

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

 **SerialNumber** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char**
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root 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** *char**
*Default Value: ""*

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

 **StoreType** *int*
*Default Value: 0*

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
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);
```

|  |  |
| --- | --- |
| 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, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_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 Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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

 **Version** *char* (read-only)*
*Default Value: ""*

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

 **Subject** *char**
*Default Value: ""*

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 field 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:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *char**
*Default Value: ""*

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

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

## Constructors

```text
Certificate()
```

 Creates a instance whose properties can be set.

```text
Certificate(const char* lpEncoded, int lenEncoded)
```

 Parses * Encoded * as an X.509 public key.

```text
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
```

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

# SecurePDFStream Type

## Syntax

 *SecurePDFStream* (declared in *securepdf.h*)

## Remarks

 The PDFEncrypt class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecurePDFStream interface and pass the PDFEncrypt class an instance of that concrete class.

 When implementing the SecurePDFStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecurePDFStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([PDFEncrypt](#pdfencrypt-class) Class)

 The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-pdfencrypt-class) method.

### PDFEncrypt Config Settings

**CloseInputStreamAfterProcessing**: Whether to close the input stream after processing.This setting determines whether the input stream specified in [SetInputStream](#setinputstream-method-pdfencrypt-class) 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](#setoutputstream-method-pdfencrypt-class) will be closed after processing is complete. The default value is *true*.

**CompressStreams**: Whether to compress stream objects.This setting specifies whether the bytes in the document's stream objects are compressed when [Encrypt](#encrypt-method-pdfencrypt-class) is called. The default value is *false*.

**HardenedKeyGeneration**: Whether to use hardened key generation.This setting specifies whether hardened key generation is used when the AES-256 encryption algorithm and password encryption are used. The default value is *true*.

**LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-pdfencrypt-class) 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. |

**OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This setting specifies the MGF1 hash algorithm used when [UseOAEP](#UseOAEP) is set to *true*. Possible values are:

- SHA1
- SHA224
- SHA256 (default)
- SHA384
- SHA512
- RIPEMD160
- MD2
- MD5
- MD5SHA1

NOTE: This setting is not applicable when [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is set to *true* or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) and [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) values. In this case, the [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is also used for MGF1.

**OAEPParams**: The hex-encoded OAEP parameters.This setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [UseOAEP](#UseOAEP) is set to *true*. The specified value should be hex encoded.

**OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This setting specifies the RSA hash algorithm used when [UseOAEP](#UseOAEP) is set to *true*. Possible values are:

- SHA1
- SHA224
- SHA256 (default)
- SHA384
- SHA512
- RIPEMD160
- MD2
- MD5
- MD5SHA1

**OwnerPassword**: The owner password to encrypt the document with.This setting is used to provide the document owner password for encryption. Though it may be different from [Password](#password-property-pdfencrypt-class), most implementations use the same value for both.

**RC4KeyBits**: The number of key bits used for the RC4 algorithm.This setting specifies the number of key bits used for the RC4 algorithm. The default value is *128*.

**SaveChanges**: Whether to save changes made to the document.This setting specifies whether and how changes made to the PDF document are saved when [Close](#close-method-pdfencrypt-class) is called. Possible values are:

|  |  |
| --- | --- |
| 0 | Discard all changes. |
| 1 | Save the document to [OutputFile](#outputfile-property-pdfencrypt-class), [OutputData](#outputdata-property-pdfencrypt-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfencrypt-class), even if it has not been modified. |
| 2 (default) | Save the document to [OutputFile](#outputfile-property-pdfencrypt-class), [OutputData](#outputdata-property-pdfencrypt-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfencrypt-class), 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.

**UseOAEP**: Whether to use Optimal Asymmetric Encryption Padding (OAEP) during encryption and decryption.This setting specifies whether Optimal Asymmetric Encryption Padding (OAEP) is used during encryption and decryption. The default value is *false*, meaning the class uses PKCS#1.

To specify non-default OAEP options, please see [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm), [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm), and [OAEPParams](#OAEPParams).

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

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class 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*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class 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.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([PDFEncrypt](#pdfencrypt-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### PDFEncrypt Errors

|  |  |
| --- | --- |
| 861 | Cannot encrypt signed document. |

### 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](#outputfile-property-pdfencrypt-class) already exists and [Overwrite](#overwrite-property-pdfencrypt-class) 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 | DecryptionCert error. The error description contains the detailed message. |
| 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. |
| 892 | Unsupported color. |
| 893 | This operation is not supported for this PDF/A level. |
| 894 | Interactive features ([Action](#PDFField_f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [Action](#PDFField_f_Action) property of the field. |
| 895 | Font file not found. |

### 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. |
| 1013 | RDF object not found. |
| 1014 | Invalid RDF object. |
| 1015 | Cannot create element with unknown prefix. |
| 1021 | Invalid type in Root object list. |