PDFDecrypt Class

Properties   Methods   Events   Config Settings   Errors  

The PDFDecrypt class decrypts PDF documents.

Syntax

PDFDecrypt

Remarks

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

Password-Based Decryption

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

Certificate-Based Decryption

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

Property List

The following is the full list of the properties of the 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.

DecryptionCert Property (PDFDecrypt Class)

The decryption certificate.

Syntax

• C++
• C
• Qt

SecurePDFCertificate* GetDecryptionCert();
int SetDecryptionCert(SecurePDFCertificate* val);

char* securepdf_pdfdecrypt_getdecryptioncerteffectivedate(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertexpirationdate(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertextendedkeyusage(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertfingerprint(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertfingerprintsha1(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertfingerprintsha256(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertissuer(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertprivatekey(void* lpObj);

int securepdf_pdfdecrypt_getdecryptioncertprivatekeyavailable(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertprivatekeycontainer(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertpublickey(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertpublickeyalgorithm(void* lpObj);

int securepdf_pdfdecrypt_getdecryptioncertpublickeylength(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertserialnumber(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertsignaturealgorithm(void* lpObj);

int securepdf_pdfdecrypt_getdecryptioncertstore(void* lpObj, char** lpDecryptionCertStore, int* lenDecryptionCertStore);
int securepdf_pdfdecrypt_setdecryptioncertstore(void* lpObj, const char* lpDecryptionCertStore, int lenDecryptionCertStore);

char* securepdf_pdfdecrypt_getdecryptioncertstorepassword(void* lpObj);
int securepdf_pdfdecrypt_setdecryptioncertstorepassword(void* lpObj, const char* lpszDecryptionCertStorePassword);

int securepdf_pdfdecrypt_getdecryptioncertstoretype(void* lpObj);
int securepdf_pdfdecrypt_setdecryptioncertstoretype(void* lpObj, int iDecryptionCertStoreType);

char* securepdf_pdfdecrypt_getdecryptioncertsubjectaltnames(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertthumbprintmd5(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertthumbprintsha1(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertthumbprintsha256(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertusage(void* lpObj);

int securepdf_pdfdecrypt_getdecryptioncertusageflags(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertversion(void* lpObj);

char* securepdf_pdfdecrypt_getdecryptioncertsubject(void* lpObj);
int securepdf_pdfdecrypt_setdecryptioncertsubject(void* lpObj, const char* lpszDecryptionCertSubject);

int securepdf_pdfdecrypt_getdecryptioncertencoded(void* lpObj, char** lpDecryptionCertEncoded, int* lenDecryptionCertEncoded);
int securepdf_pdfdecrypt_setdecryptioncertencoded(void* lpObj, const char* lpDecryptionCertEncoded, int lenDecryptionCertEncoded);

QString GetDecryptionCertEffectiveDate();

QString GetDecryptionCertExpirationDate();

QString GetDecryptionCertExtendedKeyUsage();

QString GetDecryptionCertFingerprint();

QString GetDecryptionCertFingerprintSHA1();

QString GetDecryptionCertFingerprintSHA256();

QString GetDecryptionCertIssuer();

QString GetDecryptionCertPrivateKey();

bool GetDecryptionCertPrivateKeyAvailable();

QString GetDecryptionCertPrivateKeyContainer();

QString GetDecryptionCertPublicKey();

QString GetDecryptionCertPublicKeyAlgorithm();

int GetDecryptionCertPublicKeyLength();

QString GetDecryptionCertSerialNumber();

QString GetDecryptionCertSignatureAlgorithm();

QByteArray GetDecryptionCertStore();
int SetDecryptionCertStore(QByteArray qbaDecryptionCertStore);

QString GetDecryptionCertStorePassword();
int SetDecryptionCertStorePassword(QString qsDecryptionCertStorePassword);

int GetDecryptionCertStoreType();
int SetDecryptionCertStoreType(int iDecryptionCertStoreType);

QString GetDecryptionCertSubjectAltNames();

QString GetDecryptionCertThumbprintMD5();

QString GetDecryptionCertThumbprintSHA1();

QString GetDecryptionCertThumbprintSHA256();

QString GetDecryptionCertUsage();

int GetDecryptionCertUsageFlags();

QString GetDecryptionCertVersion();

QString GetDecryptionCertSubject();
int SetDecryptionCertSubject(QString qsDecryptionCertSubject);

QByteArray GetDecryptionCertEncoded();
int SetDecryptionCertEncoded(QByteArray qbaDecryptionCertEncoded);

Remarks

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

This property is not available at design time.

Data Type

SecurePDFCertificate

InputData Property (PDFDecrypt 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_pdfdecrypt_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int securepdf_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_getinputfile(void* lpObj);
int securepdf_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_getoutputfile(void* lpObj);
int securepdf_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_getoverwrite(void* lpObj);
int securepdf_pdfdecrypt_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 (PDFDecrypt Class)

The password to decrypt 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_pdfdecrypt_getpassword(void* lpObj);
int securepdf_pdfdecrypt_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 decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

Close Method (PDFDecrypt Class)

Closes an opened PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int securepdf_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_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.

Decrypt Method (PDFDecrypt Class)

Decrypts a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int securepdf_pdfdecrypt_decrypt(void* lpObj);

int Decrypt();

Remarks

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

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

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

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

Checks whether a PDF document is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();

bool securepdf_pdfdecrypt_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: pdfdecrypt.InputFile = "input.pdf"; if (pdfdecrypt.Encrypted()) { pdfdecrypt.OutputFile = "decrypted.pdf"; // Set Password or DecryptionCert pdfdecrypt.Decrypt(); } Note: If the document is not already opened, this method will open it, perform the operation, then close it.

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

Opens a PDF document for processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int securepdf_pdfdecrypt_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 decryption. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Automatic Decryption Functionality

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

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int securepdf_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_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 (PDFDecrypt 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_pdfdecrypt_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 (PDFDecrypt Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PDFDecryptErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PDFDecryptErrorEventParams;


Unicode (Windows)
virtual INT FireError(PDFDecryptErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PDFDecryptErrorEventParams;

#define EID_PDFDECRYPT_ERROR 1

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

class PDFDecryptErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass PDFDecrypt and override this emitter function.
virtual int FireError(PDFDecryptErrorEventParams *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 (PDFDecrypt Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(PDFDecryptLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} PDFDecryptLogEventParams;


Unicode (Windows)
virtual INT FireLog(PDFDecryptLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} PDFDecryptLogEventParams;

#define EID_PDFDECRYPT_LOG 2

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

class PDFDecryptLogEventParams {
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(PDFDecryptLogEventParams *e);

// Or, subclass PDFDecrypt and override this emitter function.
virtual int FireLog(PDFDecryptLogEventParams *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 (PDFDecrypt 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(PDFDecryptPasswordEventParams *e);

typedef struct {
  int Available;
  int Cancel;
  int reserved;
} PDFDecryptPasswordEventParams;


Unicode (Windows)
virtual INT FirePassword(PDFDecryptPasswordEventParams *e);

typedef struct {
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFDecryptPasswordEventParams;

#define EID_PDFDECRYPT_PASSWORD 3

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

class PDFDecryptPasswordEventParams {
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(PDFDecryptPasswordEventParams *e);

// Or, subclass PDFDecrypt and override this emitter function.
virtual int FirePassword(PDFDecryptPasswordEventParams *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 (PDFDecrypt Class)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientInfo(PDFDecryptRecipientInfoEventParams *e);

typedef struct {
  const char *Issuer;
  const char *SerialNumber;
  const char *SubjectKeyIdentifier;
  int Available;
  int Cancel;
  int reserved;
} PDFDecryptRecipientInfoEventParams;


Unicode (Windows)
virtual INT FireRecipientInfo(PDFDecryptRecipientInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFDecryptRecipientInfoEventParams;

#define EID_PDFDECRYPT_RECIPIENTINFO 4

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

class PDFDecryptRecipientInfoEventParams {
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(PDFDecryptRecipientInfoEventParams *e);

// Or, subclass PDFDecrypt and override this emitter function.
virtual int FireRecipientInfo(PDFDecryptRecipientInfoEventParams *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 PDFDecrypt 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 PDFDecrypt 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 (PDFDecrypt Class)

PDFDecrypt Config Settings

Base Config Settings

Trappable Errors (PDFDecrypt 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.

PDFDecrypt Errors

PDF Errors

Parsing Errors