PDFDecryptor Class

Properties   Methods   Events   Config Settings   Errors  

The PDFDecryptor class decrypts PDF documents.

Syntax

PDFDecryptor

Remarks

PDFDecryptor decrypts PDF documents encrypted with passwords or certificates.

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.

DecryptionCertificateBytes Property (PDFDecryptor Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertificateBytes(char* &lpDecryptionCertificateBytes, int &lenDecryptionCertificateBytes);

Unicode (Windows)
INT GetDecryptionCertificateBytes(LPSTR &lpDecryptionCertificateBytes, INT &lenDecryptionCertificateBytes);

int secureblackbox_pdfdecryptor_getdecryptioncertificatebytes(void* lpObj, char** lpDecryptionCertificateBytes, int* lenDecryptionCertificateBytes);

QByteArray GetDecryptionCertificateBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

DecryptionCertificateHandle Property (PDFDecryptor Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(int64 lDecryptionCertificateHandle);

Unicode (Windows)
LONG64 GetDecryptionCertificateHandle();
INT SetDecryptionCertificateHandle(LONG64 lDecryptionCertificateHandle);

int64 secureblackbox_pdfdecryptor_getdecryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfdecryptor_setdecryptioncertificatehandle(void* lpObj, int64 lDecryptionCertificateHandle);

qint64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(qint64 lDecryptionCertificateHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

DocumentInfoEncryptionAlgorithm Property (PDFDecryptor Class)

The symmetric algorithm used to encrypt the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetDocumentInfoEncryptionAlgorithm();

char* secureblackbox_pdfdecryptor_getdocumentinfoencryptionalgorithm(void* lpObj);

QString GetDocumentInfoEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric algorithm used to encrypt the document.

This property contains the encryption algorithm that was used to encrypt the PDF document.

Supported values:

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

Data Type

String

DocumentInfoEncryptionType Property (PDFDecryptor Class)

The document encryption type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoEncryptionType();

Unicode (Windows)
INT GetDocumentInfoEncryptionType();

PET_NONE(0), 
PET_PASSWORD(1), 
PET_CERTIFICATE(2)

int secureblackbox_pdfdecryptor_getdocumentinfoencryptiontype(void* lpObj);

int GetDocumentInfoEncryptionType();

Default Value

1

Remarks

The document encryption type.

This property indicates the kind of encryption that was used to encrypt the PDF document.

Supported values:

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

Data Type

Integer

DocumentInfoMetadataEncrypted Property (PDFDecryptor Class)

Indicates if the document metadata is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoMetadataEncrypted();

Unicode (Windows)
BOOL GetDocumentInfoMetadataEncrypted();

int secureblackbox_pdfdecryptor_getdocumentinfometadataencrypted(void* lpObj);

bool GetDocumentInfoMetadataEncrypted();

Default Value

TRUE

Remarks

Indicates if the document metadata is encrypted.

Use this property to check if the document metadata is encrypted.

Metadata contains additional information about the document such as its name and author.

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

Data Type

Boolean

DocumentInfoPermissions Property (PDFDecryptor Class)

Contains the document permissions associated with the encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoPermissions();

Unicode (Windows)
INT GetDocumentInfoPermissions();

int secureblackbox_pdfdecryptor_getdocumentinfopermissions(void* lpObj);

int GetDocumentInfoPermissions();

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (PDFDecryptor Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_pdfdecryptor_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (PDFDecryptor Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_pdfdecryptor_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (PDFDecryptor Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_pdfdecryptor_getexternalcryptodata(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (PDFDecryptor Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_pdfdecryptor_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (PDFDecryptor Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_pdfdecryptor_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (PDFDecryptor Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_pdfdecryptor_getexternalcryptokeyid(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (PDFDecryptor Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_pdfdecryptor_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (PDFDecryptor Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_pdfdecryptor_getexternalcryptomethod(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (PDFDecryptor Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_pdfdecryptor_getexternalcryptomode(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (PDFDecryptor Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_pdfdecryptor_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_pdfdecryptor_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (PDFDecryptor Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_pdfdecryptor_getfipsmode(void* lpObj);
int secureblackbox_pdfdecryptor_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (PDFDecryptor Class)

Use this property to pass the input to class in byte array form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_pdfdecryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pdfdecryptor_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFDecryptor Class)

The PDF file to be decrypted.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_pdfdecryptor_getinputfile(void* lpObj);
int secureblackbox_pdfdecryptor_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

Provide the path to the PDF document to be decrypted.

Data Type

String

OutputBytes Property (PDFDecryptor Class)

Use this property to read the output the class object has produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_pdfdecryptor_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (PDFDecryptor Class)

The file to save the decrypted document to.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_pdfdecryptor_getoutputfile(void* lpObj);
int secureblackbox_pdfdecryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

Specifies the path where the decrypted PDF should be saved.

Data Type

String

Password Property (PDFDecryptor Class)

The decryption password.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_pdfdecryptor_getpassword(void* lpObj);
int secureblackbox_pdfdecryptor_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

Use this property to provide the decryption password.

Data Type

String

Config Method (PDFDecryptor 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* secureblackbox_pdfdecryptor_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 (PDFDecryptor Class)

Decrypts a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int secureblackbox_pdfdecryptor_decrypt(void* lpObj);

int Decrypt();

Remarks

Use this method to decrypt a PDF document provided via InputFile (InputStream). The decrypted document will be saved in OutputFile (OutputStream).

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

DoAction Method (PDFDecryptor Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_pdfdecryptor_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

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.

DocumentLoaded Event (PDFDecryptor Class)

This event is fired when the document has been loaded into memory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDocumentLoaded(PDFDecryptorDocumentLoadedEventParams *e);

typedef struct {
  int Cancel;
  int reserved;
} PDFDecryptorDocumentLoadedEventParams;


Unicode (Windows)
virtual INT FireDocumentLoaded(PDFDecryptorDocumentLoadedEventParams *e);

typedef struct {
  BOOL Cancel;
  INT reserved;
} PDFDecryptorDocumentLoadedEventParams;

#define EID_PDFDECRYPTOR_DOCUMENTLOADED 1

virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);

class PDFDecryptorDocumentLoadedEventParams {
public:
  bool Cancel();
  void SetCancel(bool bCancel);

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

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

// Or, subclass PDFDecryptor and override this emitter function.
virtual int FireDocumentLoaded(PDFDecryptorDocumentLoadedEventParams *e) {...}

Remarks

The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the Pages information to find the optimal position for the signature widget.

Set Cancel to true to terminate document processing on this stage.

Encrypted Event (PDFDecryptor Class)

Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEncrypted(PDFDecryptorEncryptedEventParams *e);

typedef struct {
  int CertUsed;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int NeedCredential;
  int SkipThis;
  int reserved;
} PDFDecryptorEncryptedEventParams;


Unicode (Windows)
virtual INT FireEncrypted(PDFDecryptorEncryptedEventParams *e);

typedef struct {
  BOOL CertUsed;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  BOOL NeedCredential;
  BOOL SkipThis;
  INT reserved;
} PDFDecryptorEncryptedEventParams;

#define EID_PDFDECRYPTOR_ENCRYPTED 2

virtual INT SECUREBLACKBOX_CALL FireEncrypted(BOOL &bCertUsed, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bNeedCredential, BOOL &bSkipThis);

class PDFDecryptorEncryptedEventParams {
public:
  bool CertUsed();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool NeedCredential();

  bool SkipThis();
  void SetSkipThis(bool bSkipThis);

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

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

// Or, subclass PDFDecryptor and override this emitter function.
virtual int FireEncrypted(PDFDecryptorEncryptedEventParams *e) {...}

Remarks

The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate or Password property (depending on the encryption method used), or sets SkipThis to true.

The CertUsed parameter specifies the encryption method used. If set to true, it indicates that the document uses asymmetric (certificate-based) encryption. In that case, the IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own Encrypted event loop.

CertUsed set to false indicates that the document uses password encryption. In this case, provide the password via the Password property.

The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the Password property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (PDFDecryptor Class)

Information about errors during signing/validation.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PDFDECRYPTOR_ERROR 3

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

class PDFDecryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The event is fired in case of exceptional conditions during PDF processing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalDecrypt Event (PDFDecryptor Class)

Handles remote or external decryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalDecrypt(PDFDecryptorExternalDecryptEventParams *e);

typedef struct {
  const char *OperationId;
  const char *Algorithm;
  const char *Pars;
  const char *EncryptedData;
  char *Data;
  int reserved;
} PDFDecryptorExternalDecryptEventParams;


Unicode (Windows)
virtual INT FireExternalDecrypt(PDFDecryptorExternalDecryptEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR Algorithm;
  LPCWSTR Pars;
  LPCWSTR EncryptedData;
  LPWSTR Data;
  INT reserved;
} PDFDecryptorExternalDecryptEventParams;

#define EID_PDFDECRYPTOR_EXTERNALDECRYPT 4

virtual INT SECUREBLACKBOX_CALL FireExternalDecrypt(LPSTR &lpszOperationId, LPSTR &lpszAlgorithm, LPSTR &lpszPars, LPSTR &lpszEncryptedData, LPSTR &lpszData);

class PDFDecryptorExternalDecryptEventParams {
public:
  const QString &OperationId();

  const QString &Algorithm();

  const QString &Pars();

  const QString &EncryptedData();

  const QString &Data();
  void SetData(const QString &qsData);

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

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

// Or, subclass PDFDecryptor and override this emitter function.
virtual int FireExternalDecrypt(PDFDecryptorExternalDecryptEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

Notification Event (PDFDecryptor Class)

This event notifies the application about an underlying control flow event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(PDFDecryptorNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} PDFDecryptorNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(PDFDecryptorNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} PDFDecryptorNotificationEventParams;

#define EID_PDFDECRYPTOR_NOTIFICATION 5

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class PDFDecryptorNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

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

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

// Or, subclass PDFDecryptor and override this emitter function.
virtual int FireNotification(PDFDecryptorNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (PDFDecryptor Class)

PDFDecryptor Config Settings

Base Config Settings

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

PDFDecryptor Errors