PDFEncrypt Class

Properties   Methods   Events   Config Settings   Errors  

The PDFEncrypt class encrypts PDF documents.

Syntax

PDFEncrypt

Remarks

As with signing, PDF encryption is part of the PDF format itself. 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 will need to be able to decrypt such documents, but it can always reach the metadata (information about the document) and document structure.

Password-Based Encryption

The following code shows how to encrypt a PDF document with a user password: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "password_encrypted.pdf"; pdfencrypt.Password = "password"; pdfencrypt.Encrypt(); Owner passwords are also supported. Compared to user passwords, these passwords are used to protect the permissions (set via the Permissions property) that will be 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 configuration setting before calling the Encrypt method.

Certificate-Based Encryption

The following code shows how to encrypt a PDF document with a certificate: 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 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 via the EncryptMetadata and Permissions 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.

Method List

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

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.

Config Settings

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

EncryptionAlgorithm Property (PDFEncrypt Class)

The encryption algorithm to encrypt the PDF document with.

Syntax

• C++
• C
• Qt

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

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

char* securepdf_pdfencrypt_getencryptionalgorithm(void* lpObj);
int securepdf_pdfencrypt_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);

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

The encryption certificate.

Syntax

• C++
• C
• Qt

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

char* securepdf_pdfencrypt_getencryptioncerteffectivedate(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertexpirationdate(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertextendedkeyusage(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertfingerprint(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertfingerprintsha1(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertfingerprintsha256(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertissuer(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertprivatekey(void* lpObj);

int securepdf_pdfencrypt_getencryptioncertprivatekeyavailable(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertprivatekeycontainer(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertpublickey(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertpublickeyalgorithm(void* lpObj);

int securepdf_pdfencrypt_getencryptioncertpublickeylength(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertserialnumber(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertsignaturealgorithm(void* lpObj);

int securepdf_pdfencrypt_getencryptioncertstore(void* lpObj, char** lpEncryptionCertStore, int* lenEncryptionCertStore);
int securepdf_pdfencrypt_setencryptioncertstore(void* lpObj, const char* lpEncryptionCertStore, int lenEncryptionCertStore);

char* securepdf_pdfencrypt_getencryptioncertstorepassword(void* lpObj);
int securepdf_pdfencrypt_setencryptioncertstorepassword(void* lpObj, const char* lpszEncryptionCertStorePassword);

int securepdf_pdfencrypt_getencryptioncertstoretype(void* lpObj);
int securepdf_pdfencrypt_setencryptioncertstoretype(void* lpObj, int iEncryptionCertStoreType);

char* securepdf_pdfencrypt_getencryptioncertsubjectaltnames(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertthumbprintmd5(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertthumbprintsha1(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertthumbprintsha256(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertusage(void* lpObj);

int securepdf_pdfencrypt_getencryptioncertusageflags(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertversion(void* lpObj);

char* securepdf_pdfencrypt_getencryptioncertsubject(void* lpObj);
int securepdf_pdfencrypt_setencryptioncertsubject(void* lpObj, const char* lpszEncryptionCertSubject);

int securepdf_pdfencrypt_getencryptioncertencoded(void* lpObj, char** lpEncryptionCertEncoded, int* lenEncryptionCertEncoded);
int securepdf_pdfencrypt_setencryptioncertencoded(void* lpObj, const char* lpEncryptionCertEncoded, int lenEncryptionCertEncoded);

QString GetEncryptionCertEffectiveDate();

QString GetEncryptionCertExpirationDate();

QString GetEncryptionCertExtendedKeyUsage();

QString GetEncryptionCertFingerprint();

QString GetEncryptionCertFingerprintSHA1();

QString GetEncryptionCertFingerprintSHA256();

QString GetEncryptionCertIssuer();

QString GetEncryptionCertPrivateKey();

bool GetEncryptionCertPrivateKeyAvailable();

QString GetEncryptionCertPrivateKeyContainer();

QString GetEncryptionCertPublicKey();

QString GetEncryptionCertPublicKeyAlgorithm();

int GetEncryptionCertPublicKeyLength();

QString GetEncryptionCertSerialNumber();

QString GetEncryptionCertSignatureAlgorithm();

QByteArray GetEncryptionCertStore();
int SetEncryptionCertStore(QByteArray qbaEncryptionCertStore);

QString GetEncryptionCertStorePassword();
int SetEncryptionCertStorePassword(QString qsEncryptionCertStorePassword);

int GetEncryptionCertStoreType();
int SetEncryptionCertStoreType(int iEncryptionCertStoreType);

QString GetEncryptionCertSubjectAltNames();

QString GetEncryptionCertThumbprintMD5();

QString GetEncryptionCertThumbprintSHA1();

QString GetEncryptionCertThumbprintSHA256();

QString GetEncryptionCertUsage();

int GetEncryptionCertUsageFlags();

QString GetEncryptionCertVersion();

QString GetEncryptionCertSubject();
int SetEncryptionCertSubject(QString qsEncryptionCertSubject);

QByteArray GetEncryptionCertEncoded();
int SetEncryptionCertEncoded(QByteArray qbaEncryptionCertEncoded);

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

EncryptMetadata Property (PDFEncrypt Class)

Whether to encrypt the document metadata.

Syntax

• C++
• C
• Qt

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

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

int securepdf_pdfencrypt_getencryptmetadata(void* lpObj);
int securepdf_pdfencrypt_setencryptmetadata(void* lpObj, int bEncryptMetadata);

bool GetEncryptMetadata();
int SetEncryptMetadata(bool bEncryptMetadata);

Default Value

TRUE

Remarks

This property indicates whether the document metadata will be encrypted when the Encrypt method is called. Metadata contains additional information about the document, such as its name and author.

Data Type

Boolean

InputData Property (PDFEncrypt Class)

A byte array containing the PDF document to process.

Syntax

• C++
• C
• Qt

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

int securepdf_pdfencrypt_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int securepdf_pdfencrypt_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);

QByteArray GetInputData();
int SetInputData(QByteArray qbaInputData);

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

The PDF file to process.

Syntax

• C++
• C
• Qt

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

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

char* securepdf_pdfencrypt_getinputfile(void* lpObj);
int securepdf_pdfencrypt_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

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

Data Type

String

OutputData Property (PDFEncrypt Class)

A byte array containing the PDF document after processing.

Syntax

• C++
• C
• Qt

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

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

int securepdf_pdfencrypt_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);

QByteArray GetOutputData();

Remarks

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

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

Data Type

Byte Array

OutputFile Property (PDFEncrypt Class)

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

Syntax

• C++
• C
• Qt

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

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

char* securepdf_pdfencrypt_getoutputfile(void* lpObj);
int securepdf_pdfencrypt_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

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

Data Type

String

Overwrite Property (PDFEncrypt Class)

Whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

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

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

int securepdf_pdfencrypt_getoverwrite(void* lpObj);
int securepdf_pdfencrypt_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

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

Data Type

Boolean

Password Property (PDFEncrypt Class)

The password to encrypt the document with.

Syntax

• C++
• C
• Qt

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

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

char* securepdf_pdfencrypt_getpassword(void* lpObj);
int securepdf_pdfencrypt_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

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

Data Type

String

Permissions Property (PDFEncrypt Class)

The document permissions associated with the encryption.

Syntax

• C++
• C
• Qt

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

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

int securepdf_pdfencrypt_getpermissions(void* lpObj);
int securepdf_pdfencrypt_setpermissions(void* lpObj, int iPermissions);

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:

This property is not available at design time.

Data Type

Integer

Close Method (PDFEncrypt Class)

Closes an opened PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int securepdf_pdfencrypt_close(void* lpObj);

int Close();

Remarks

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

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

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

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* securepdf_pdfencrypt_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, 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 Class)

Encrypts a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int securepdf_pdfencrypt_encrypt(void* lpObj);

int Encrypt();

Remarks

This method is used to encrypt the PDF document specified in InputFile, InputData, or SetInputStream. The document will be encrypted using EncryptionAlgorithm and either Password (for password-based encryption) or EncryptionCert (for certificate-based encryption), then saved in OutputFile, OutputData, or the stream set in SetOutputStream.

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

Checks whether a PDF document is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();

bool securepdf_pdfencrypt_encrypted(void* lpObj);

bool Encrypted();

Remarks

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

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

Opens a PDF document for processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int securepdf_pdfencrypt_open(void* lpObj);

int Open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as encryption. 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

Once the correct decryption material is supplied, the class 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.

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

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int securepdf_pdfencrypt_reset(void* lpObj);

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

Sets the stream containing the PDF document to process.

Syntax

• C++
• C
• Qt

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

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

int securepdf_pdfencrypt_setinputstream(void* lpObj, SecurePDFStream* sInputStream);

int SetInputStream(SecurePDFStream* sInputStream);

Remarks

This method is used to set the stream from which the class will read the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class 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.

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

Sets the stream to write the processed document to.

Syntax

• C++
• C
• Qt

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

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

int securepdf_pdfencrypt_setoutputstream(void* lpObj, SecurePDFStream* sOutputStream);

int SetOutputStream(SecurePDFStream* sOutputStream);

Remarks

This method is used to set the stream to which the class will write the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class 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 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 Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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;

#define EID_PDFENCRYPT_ERROR 1

virtual INT SECUREPDF_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PDFEncryptErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PDFEncryptErrorEventParams *e);

// Or, subclass PDFEncrypt and override this emitter function.
virtual int FireError(PDFEncryptErrorEventParams *e) {...}

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

Log Event (PDFEncrypt Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

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;

#define EID_PDFENCRYPT_LOG 2

virtual INT SECUREPDF_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class PDFEncryptLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(PDFEncryptLogEventParams *e);

// Or, subclass PDFEncrypt and override this emitter function.
virtual int FireLog(PDFEncryptLogEventParams *e) {...}

Remarks

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

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

The Message parameter is the log message.

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

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

Password Event (PDFEncrypt Class)

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

Syntax

• C++
• C
• Qt

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;

#define EID_PDFENCRYPT_PASSWORD 3

virtual INT SECUREPDF_CALL FirePassword(BOOL &bAvailable, BOOL &bCancel);

class PDFEncryptPasswordEventParams {
public:
  bool Available();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Password(PDFEncryptPasswordEventParams *e);

// Or, subclass PDFEncrypt and override this emitter function.
virtual int FirePassword(PDFEncryptPasswordEventParams *e) {...}

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 class 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 class will stop firing this event to request a password.

RecipientInfo Event (PDFEncrypt Class)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

• C++
• C
• Qt

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;

#define EID_PDFENCRYPT_RECIPIENTINFO 4

virtual INT SECUREPDF_CALL FireRecipientInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, BOOL &bAvailable, BOOL &bCancel);

class PDFEncryptRecipientInfoEventParams {
public:
  const QString &Issuer();

  const QString &SerialNumber();

  const QString &SubjectKeyIdentifier();

  bool Available();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RecipientInfo(PDFEncryptRecipientInfoEventParams *e);

// Or, subclass PDFEncrypt and override this emitter function.
virtual int FireRecipientInfo(PDFEncryptRecipientInfoEventParams *e) {...}

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 class 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 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 will cause 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.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

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

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.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

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

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

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

Config Settings (PDFEncrypt Class)

PDFEncrypt Config Settings

Base Config Settings

Trappable Errors (PDFEncrypt 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

PDF Errors

Parsing Errors