MessageDecryptor Class

Properties   Methods   Events   Config Settings   Errors  

The MessageDecryptor class decrypts data that is stored in the PKCS#7 format.

Syntax

MessageDecryptor

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

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.

CertificateBytes Property (MessageDecryptor Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertificateBytes(char* &lpCertificateBytes, int &lenCertificateBytes);

Unicode (Windows)
INT GetCertificateBytes(LPSTR &lpCertificateBytes, INT &lenCertificateBytes);

int secureblackbox_messagedecryptor_getcertificatebytes(void* lpObj, char** lpCertificateBytes, int* lenCertificateBytes);

QByteArray GetCertificateBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CertificateHandle Property (MessageDecryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertificateHandle();

Unicode (Windows)
LONG64 GetCertificateHandle();

int64 secureblackbox_messagedecryptor_getcertificatehandle(void* lpObj);

qint64 GetCertificateHandle();

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 read-only and not available at design time.

Data Type

Long64

CertificateIssuer Property (MessageDecryptor Class)

The common name of the certificate issuer (CA), typically a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertificateIssuer();

Unicode (Windows)
LPWSTR GetCertificateIssuer();

char* secureblackbox_messagedecryptor_getcertificateissuer(void* lpObj);

QString GetCertificateIssuer();

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

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

Data Type

String

CertificateIssuerRDN Property (MessageDecryptor Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertificateIssuerRDN();

Unicode (Windows)
LPWSTR GetCertificateIssuerRDN();

char* secureblackbox_messagedecryptor_getcertificateissuerrdn(void* lpObj);

QString GetCertificateIssuerRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

Data Type

String

CertificateSerialNumber Property (MessageDecryptor Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertificateSerialNumber(char* &lpCertificateSerialNumber, int &lenCertificateSerialNumber);

Unicode (Windows)
INT GetCertificateSerialNumber(LPSTR &lpCertificateSerialNumber, INT &lenCertificateSerialNumber);

int secureblackbox_messagedecryptor_getcertificateserialnumber(void* lpObj, char** lpCertificateSerialNumber, int* lenCertificateSerialNumber);

QByteArray GetCertificateSerialNumber();

Remarks

Returns the certificate's serial number.

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

Data Type

Byte Array

CertificateSubject Property (MessageDecryptor Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertificateSubject();

Unicode (Windows)
LPWSTR GetCertificateSubject();

char* secureblackbox_messagedecryptor_getcertificatesubject(void* lpObj);

QString GetCertificateSubject();

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

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

Data Type

String

CertificateSubjectRDN Property (MessageDecryptor Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertificateSubjectRDN();

Unicode (Windows)
LPWSTR GetCertificateSubjectRDN();

char* secureblackbox_messagedecryptor_getcertificatesubjectrdn(void* lpObj);

QString GetCertificateSubjectRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

Data Type

String

CertCount Property (MessageDecryptor Class)

The number of records in the Cert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCount();
int SetCertCount(int iCertCount);

Unicode (Windows)
INT GetCertCount();
INT SetCertCount(INT iCertCount);

int secureblackbox_messagedecryptor_getcertcount(void* lpObj);
int secureblackbox_messagedecryptor_setcertcount(void* lpObj, int iCertCount);

int GetCertCount();
int SetCertCount(int iCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertHandle
• CertificateBytes
• CertificateHandle
• CertificateIssuer
• CertificateIssuerRDN
• CertificateSerialNumber
• CertificateSubject
• CertificateSubjectRDN

The array indices start at 0 and end at CertCount - 1.

This property is not available at design time.

Data Type

Integer

CertBytes Property (MessageDecryptor Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertBytes(int iCertIndex, char* &lpCertBytes, int &lenCertBytes);

Unicode (Windows)
INT GetCertBytes(INT iCertIndex, LPSTR &lpCertBytes, INT &lenCertBytes);

int secureblackbox_messagedecryptor_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);

QByteArray GetCertBytes(int iCertIndex);

Remarks

Returns the raw certificate data in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertHandle Property (MessageDecryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertHandle(int iCertIndex);
int SetCertHandle(int iCertIndex, int64 lCertHandle);

Unicode (Windows)
LONG64 GetCertHandle(INT iCertIndex);
INT SetCertHandle(INT iCertIndex, LONG64 lCertHandle);

int64 secureblackbox_messagedecryptor_getcerthandle(void* lpObj, int certindex);
int secureblackbox_messagedecryptor_setcerthandle(void* lpObj, int certindex, int64 lCertHandle);

qint64 GetCertHandle(int iCertIndex);
int SetCertHandle(int iCertIndex, qint64 lCertHandle);

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

Data Type

Long64

EncryptionAlgorithm Property (MessageDecryptor Class)

The symmetric cipher that was used to encrypt the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();

char* secureblackbox_messagedecryptor_getencryptionalgorithm(void* lpObj);

QString GetEncryptionAlgorithm();

Default Value

""

Remarks

This property contains the symmetric algorithm that the creator had used to encrypt the message.

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

Data Type

String

EncryptionType Property (MessageDecryptor Class)

Specifies the kind of encrypted message to create.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionType();

Unicode (Windows)
INT GetEncryptionType();

MET_UNKNOWN(0), 
MET_CERT_ENCRYPTED(1), 
MET_KEY_ENCRYPTED(2), 
MET_CERT_ENCRYPTED_AND_AUTHENTICATED(3)

int secureblackbox_messagedecryptor_getencryptiontype(void* lpObj);

int GetEncryptionType();

Default Value

0

Remarks

Possible values:

This property is read-only.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (MessageDecryptor 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_messagedecryptor_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptodata(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptokeyid(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptomethod(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptomode(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getfipsmode(void* lpObj);
int secureblackbox_messagedecryptor_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 (MessageDecryptor 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_messagedecryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_messagedecryptor_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 (MessageDecryptor Class)

Path to the file containing the encrypted message.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_messagedecryptor_getinputfile(void* lpObj);
int secureblackbox_messagedecryptor_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

Use this property to provide a file containing the encrypted data.

Data Type

String

Key Property (MessageDecryptor Class)

The symmetric key to use for decryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);

int secureblackbox_messagedecryptor_getkey(void* lpObj, char** lpKey, int* lenKey);
int secureblackbox_messagedecryptor_setkey(void* lpObj, const char* lpKey, int lenKey);

QByteArray GetKey();
int SetKey(QByteArray qbaKey);

Remarks

Use this property to provide the symmetric key to decrypt the data. This property is only applicable for processing data of EncryptedData subtype.

Assign this property before calling Decrypt.

This property is not available at design time.

Data Type

Byte Array

OutputBytes Property (MessageDecryptor 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_messagedecryptor_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 (MessageDecryptor Class)

Path to the file to save the decrypted data 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_messagedecryptor_getoutputfile(void* lpObj);
int secureblackbox_messagedecryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

Use this property to specify the output file where the decrypted message should be saved.

Data Type

String

SignedAttributeCount Property (MessageDecryptor Class)

The number of records in the SignedAttribute arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignedAttributeCount();

Unicode (Windows)
INT GetSignedAttributeCount();

int secureblackbox_messagedecryptor_getsignedattributecount(void* lpObj);

int GetSignedAttributeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignedAttributeOID
• SignedAttributeValue

The array indices start at 0 and end at SignedAttributeCount - 1.

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

Data Type

Integer

SignedAttributeOID Property (MessageDecryptor Class)

The object identifier of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignedAttributeOID(int iSignedAttributeIndex);

Unicode (Windows)
LPWSTR GetSignedAttributeOID(INT iSignedAttributeIndex);

char* secureblackbox_messagedecryptor_getsignedattributeoid(void* lpObj, int signedattributeindex);

QString GetSignedAttributeOID(int iSignedAttributeIndex);

Default Value

""

Remarks

The object identifier of the attribute.

The SignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

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

Data Type

String

SignedAttributeValue Property (MessageDecryptor Class)

The value of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignedAttributeValue(int iSignedAttributeIndex, char* &lpSignedAttributeValue, int &lenSignedAttributeValue);

Unicode (Windows)
INT GetSignedAttributeValue(INT iSignedAttributeIndex, LPSTR &lpSignedAttributeValue, INT &lenSignedAttributeValue);

int secureblackbox_messagedecryptor_getsignedattributevalue(void* lpObj, int signedattributeindex, char** lpSignedAttributeValue, int* lenSignedAttributeValue);

QByteArray GetSignedAttributeValue(int iSignedAttributeIndex);

Remarks

The value of the attribute.

The SignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

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

Data Type

Byte Array

UnsignedAttributeCount Property (MessageDecryptor Class)

The number of records in the UnsignedAttribute arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUnsignedAttributeCount();

Unicode (Windows)
INT GetUnsignedAttributeCount();

int secureblackbox_messagedecryptor_getunsignedattributecount(void* lpObj);

int GetUnsignedAttributeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• UnsignedAttributeOID
• UnsignedAttributeValue

The array indices start at 0 and end at UnsignedAttributeCount - 1.

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

Data Type

Integer

UnsignedAttributeOID Property (MessageDecryptor Class)

The object identifier of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUnsignedAttributeOID(int iUnsignedAttributeIndex);

Unicode (Windows)
LPWSTR GetUnsignedAttributeOID(INT iUnsignedAttributeIndex);

char* secureblackbox_messagedecryptor_getunsignedattributeoid(void* lpObj, int unsignedattributeindex);

QString GetUnsignedAttributeOID(int iUnsignedAttributeIndex);

Default Value

""

Remarks

The object identifier of the attribute.

The UnsignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

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

Data Type

String

UnsignedAttributeValue Property (MessageDecryptor Class)

The value of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUnsignedAttributeValue(int iUnsignedAttributeIndex, char* &lpUnsignedAttributeValue, int &lenUnsignedAttributeValue);

Unicode (Windows)
INT GetUnsignedAttributeValue(INT iUnsignedAttributeIndex, LPSTR &lpUnsignedAttributeValue, INT &lenUnsignedAttributeValue);

int secureblackbox_messagedecryptor_getunsignedattributevalue(void* lpObj, int unsignedattributeindex, char** lpUnsignedAttributeValue, int* lenUnsignedAttributeValue);

QByteArray GetUnsignedAttributeValue(int iUnsignedAttributeIndex);

Remarks

The value of the attribute.

The UnsignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

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

Data Type

Byte Array

CheckEncryptionType Method (MessageDecryptor Class)

Determines the type of encrypted message in the supplied file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckEncryptionType();

Unicode (Windows)
INT CheckEncryptionType();

int secureblackbox_messagedecryptor_checkencryptiontype(void* lpObj);

int CheckEncryptionType();

Remarks

Use this method to determine the kind of the signature stored in InputFile (InputStream).

Error Handling (C++)

This method returns an Integer 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.

Config Method (MessageDecryptor 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_messagedecryptor_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 (MessageDecryptor Class)

Attempts to decrypt an encrypted PKCS#7 message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int secureblackbox_messagedecryptor_decrypt(void* lpObj);

int Decrypt();

Remarks

Call this method to attempt to decrypt the PKCS#7 encrypted data. This call supports EnvelopedData and EncryptedData subtypes on input.

Use InputFile or InputStream property to provide the data, and either Certificates or Key to supply the decryption key material.

When processing enveloped data, the class may fire RecipientFound event to report recipient information.

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 (MessageDecryptor 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_messagedecryptor_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.

Error Event (MessageDecryptor Class)

Information about errors during PKCS#7 message decryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGEDECRYPTOR_ERROR 1

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

class MessageDecryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

ExternalDecrypt Event (MessageDecryptor Class)

Handles remote or external decryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGEDECRYPTOR_EXTERNALDECRYPT 2

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

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

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGEDECRYPTOR_NOTIFICATION 3

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

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

// Or, subclass MessageDecryptor and override this emitter function.
virtual int FireNotification(MessageDecryptorNotificationEventParams *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.

RecipientFound Event (MessageDecryptor Class)

Fires to report a message addressee parameters.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientFound(MessageDecryptorRecipientFoundEventParams *e);

typedef struct {
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int CertFound;
  int reserved;
} MessageDecryptorRecipientFoundEventParams;


Unicode (Windows)
virtual INT FireRecipientFound(MessageDecryptorRecipientFoundEventParams *e);

typedef struct {
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  BOOL CertFound;
  INT reserved;
} MessageDecryptorRecipientFoundEventParams;

#define EID_MESSAGEDECRYPTOR_RECIPIENTFOUND 4

virtual INT SECUREBLACKBOX_CALL FireRecipientFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound);

class MessageDecryptorRecipientFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

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

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

// Or, subclass MessageDecryptor and override this emitter function.
virtual int FireRecipientFound(MessageDecryptorRecipientFoundEventParams *e) {...}

Remarks

This event is fired for each addressee the message is encrypted for. It may fire several times in a row if the message is encrypted for more than one recipient.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters to identify the recipient's certificate. CertFound indicates if the specified certificate has been located in Certificates collection. If it wasn't, you might want to look up the certificate manually, and add it to the collection inside the event handler.

Config Settings (MessageDecryptor Class)

MessageDecryptor Config Settings

Base Config Settings

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

MessageDecryptor Errors