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.

MessageDecryptor is capable of decrypting encrypted PKCS#7 data stored in EnvelopedData (asymmetric encryption) and EncryptedData (symmetric encryption) subformats. RSA and ECDH key wrapping and all popular symmetric encryption algorithms are supported.

Setting up and using MessageDecryptor is easy:

• Set up your source and destination via InputFile (InputBytes) and OutputFile (OutputBytes) properties.
• For certificate-based (asymmetric) encryption, put the decryption certificate (with its private key included) to the Certificates collection.
• For key-based (symmetric) encryption, assign the symmetric key to Key property. Note: you can find out whether asymmetric or symmetric encryption was used on the input message using the CheckEncryptionType method.
• Call Decrypt to execute the operation.

Note that MessageDecryptor only works with binary PKCS#7-compliant encrypted messages. For processing encrypted S/MIME emails, see MailReader. For decrypting PGP messages, see PGPReader. For raw symmetric encryption, see SymmetricCrypto. For processing XML-ENC messages, see XMLDecryptor. MessageDecryptor decryptor = new MessageDecryptor(); // Select the file which contains the message that will be decrypted decryptor.setInputFile("encryptedMessage.bin"); // Select the file where the decrypted message will be written decryptor.setOutputFile("decryptedMessage.txt"); // Providing the certificate with its private key to decrypt data CertificateList certificateList = new CertificateList(); certificateList.add(new Certificate("cert.pfx","password")); decryptor.setCertificates(certificateList); decryptor.decrypt(); // Decrypt

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.

CertificateIndex Property (MessageDecryptor Class)

The index of certificate that was used to decrypt the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertificateIndex();

Unicode (Windows)
INT GetCertificateIndex();

int secureblackbox_messagedecryptor_getcertificateindex(void* lpObj);

int GetCertificateIndex();

Default Value

-1

Remarks

This property contains the index of certificate (one of those residing in Certificates collection) that was used to decrypt the message.

This property is read-only.

Data Type

Integer

Certificates Property (MessageDecryptor Class)

A collection of certificates that can be used for message decryption.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetCertificates();
int SetCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

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

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

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

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

QByteArray GetCertBytes(int iCertIndex);

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

Remarks

Use this collection to provide certificates that should be attempted to decrypt the message. The certificates can be provided before calling the Decrypt method, or later from RecipientFound event handler.

Note that the certificates need to have a private key associated with them to be usable for decryption.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

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

ExternalCrypto Property (MessageDecryptor Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_messagedecryptor_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_messagedecryptor_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_messagedecryptor_getexternalcryptodata(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_messagedecryptor_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_messagedecryptor_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_messagedecryptor_getexternalcryptokeyid(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_messagedecryptor_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_messagedecryptor_getexternalcryptomethod(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_messagedecryptor_getexternalcryptomode(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_messagedecryptor_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_messagedecryptor_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

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

SignedAttributes Property (MessageDecryptor Class)

Custom signature attributes that are covered by the electronic signature.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxSignatureAttribute>* GetSignedAttributes();

int secureblackbox_messagedecryptor_getsignedattributecount(void* lpObj);

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

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

int GetSignedAttributeCount();

QString GetSignedAttributeOID(int iSignedAttributeIndex);

QByteArray GetSignedAttributeValue(int iSignedAttributeIndex);

Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as signed attributes are covered by the signature.

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

Data Type

SecureBlackboxSignatureAttribute

UnsignedAttributes Property (MessageDecryptor Class)

Custom unsigned attributes included in the electronic signature.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxSignatureAttribute>* GetUnsignedAttributes();

int secureblackbox_messagedecryptor_getunsignedattributecount(void* lpObj);

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

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

int GetUnsignedAttributeCount();

QString GetUnsignedAttributeOID(int iUnsignedAttributeIndex);

QByteArray GetUnsignedAttributeValue(int iUnsignedAttributeIndex);

Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as unsigned attributes are not covered by the signature and can be changed or removed without affecting the signature.

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

Data Type

SecureBlackboxSignatureAttribute

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

Common ActionIDs:

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.

Reset Method (MessageDecryptor Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_messagedecryptor_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

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

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

Certificate()

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

ExternalCrypto()

SignatureAttribute Type

Represents an attribute of a digital PKCS#7/CMS signature.

Syntax

SecureBlackboxSignatureAttribute (declared in secureblackbox.h)

Remarks

Attributes store auxiliary information about the signed message, the signature, or the owner. Each attribute is a OID=Value pair.

Common attributes are signing time, a content type, a policy identifier, and a signature timestamp.

Fields

Constructors

SignatureAttribute()

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the MessageDecryptor class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

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