MessageEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The MessageEncryptor class encrypts data and stores it in the PKCS#7 format.

Syntax

MessageEncryptor

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.

MessageEncryptor can encrypt binary data into PKCS#7 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 MessageEncryptor is easy:

• Set up your source and destination via InputFile (InputBytes) and OutputFile (OutputBytes) properties.
• Set EncryptionType as per the desired encryption type (asymmetric, symmetric, asymmetric with authentication).
• Set EncryptionAlgorithm and, optionally, BitsInKey (if the encryption algorithm uses variable key lengths).
• For certificate-based (asymmetric) encryption, put the encryption certificate (or all of them, if there are more than one) to the EncryptionCertificates collection.
• For key-based (symmetric) encryption, assign the symmetric key to Key property.
• Call Encrypt to execute the operation.

Note that MessageEncryptor always produces binary PKCS#7-compliant encrypted messages. For S/MIME email encryption, see MailWriter. For PGP encryption, see PGPWriter. For raw symmetric encryption, see SymmetricCrypto. For XML-ENC encryption, see XMLEncryptor. MessageEncryptor encryptor = new MessageEncryptor(); // Set the encryption algorithm (default AES128) encryptor.setEncryptionAlgorithm("3DES"); // Select the file which contains the message that will be encrypted encryptor.setInputFile("decryptedMessage.txt"); // Select the file where the encrypted message will be written encryptor.setOutputFile("encryptedMessage.bin"); // We are using the public part of the certificate to encrypt data encryptor.setEncryptionCertificate(new Certificate("cert.cer")); encryptor.encrypt(); // Encrypt

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.

BitsInKey Property (MessageEncryptor Class)

The length of the encryption key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBitsInKey();
int SetBitsInKey(int iBitsInKey);

Unicode (Windows)
INT GetBitsInKey();
INT SetBitsInKey(INT iBitsInKey);

int secureblackbox_messageencryptor_getbitsinkey(void* lpObj);
int secureblackbox_messageencryptor_setbitsinkey(void* lpObj, int iBitsInKey);

int GetBitsInKey();
int SetBitsInKey(int iBitsInKey);

Default Value

0

Remarks

When using a variable-key encryption algorithm (typical examples are RC4, RC2, and Blowfish), provide the desired key length via this property.

This value is ignored if a fixed-key algorithm (such as AES128 or 3DES) is used.

Data Type

Integer

EncryptionAlgorithm Property (MessageEncryptor Class)

The symmetric key algorithm to use for encryption.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_messageencryptor_getencryptionalgorithm(void* lpObj);
int secureblackbox_messageencryptor_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

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

Default Value

"AES128"

Remarks

Use this property to specify the symmetric algorithm to encrypt the data with.

Data Type

String

EncryptionCertificates Property (MessageEncryptor Class)

The recipients' encryption certificates.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetEncryptionCertificates();
int SetEncryptionCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_messageencryptor_getencryptioncertcount(void* lpObj);
int secureblackbox_messageencryptor_setencryptioncertcount(void* lpObj, int iEncryptionCertCount);

int secureblackbox_messageencryptor_getencryptioncertbytes(void* lpObj, int encryptioncertindex, char** lpEncryptionCertBytes, int* lenEncryptionCertBytes);

int64 secureblackbox_messageencryptor_getencryptioncerthandle(void* lpObj, int encryptioncertindex);
int secureblackbox_messageencryptor_setencryptioncerthandle(void* lpObj, int encryptioncertindex, int64 lEncryptionCertHandle);

int GetEncryptionCertCount();
int SetEncryptionCertCount(int iEncryptionCertCount);

QByteArray GetEncryptionCertBytes(int iEncryptionCertIndex);

qint64 GetEncryptionCertHandle(int iEncryptionCertIndex);
int SetEncryptionCertHandle(int iEncryptionCertIndex, qint64 lEncryptionCertHandle);

Remarks

Use this property to provide certificates to be used for message encryption.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

EncryptionType Property (MessageEncryptor Class)

Specifies the kind of encrypted message to create.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionType();
int SetEncryptionType(int iEncryptionType);

Unicode (Windows)
INT GetEncryptionType();
INT SetEncryptionType(INT iEncryptionType);

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

int secureblackbox_messageencryptor_getencryptiontype(void* lpObj);
int secureblackbox_messageencryptor_setencryptiontype(void* lpObj, int iEncryptionType);

int GetEncryptionType();
int SetEncryptionType(int iEncryptionType);

Default Value

1

Remarks

Possible values:

Data Type

Integer

FIPSMode Property (MessageEncryptor 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_messageencryptor_getfipsmode(void* lpObj);
int secureblackbox_messageencryptor_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 (MessageEncryptor 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_messageencryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_messageencryptor_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 (MessageEncryptor Class)

A path to the source file.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_messageencryptor_getinputfile(void* lpObj);
int secureblackbox_messageencryptor_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

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

Data Type

String

Key Property (MessageEncryptor Class)

The symmetric key to use for encryption.

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_messageencryptor_getkey(void* lpObj, char** lpKey, int* lenKey);
int secureblackbox_messageencryptor_setkey(void* lpObj, const char* lpKey, int lenKey);

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

Remarks

Use this property to provide a symmetric key to use for encryption. If the symmetric key is provided, an output message of EncryptedData type will be formed. The recipient of this message will need to have the same key to decrypt it.

This property is not available at design time.

Data Type

Byte Array

OutputBytes Property (MessageEncryptor 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_messageencryptor_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 (MessageEncryptor Class)

A path to the output file.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_messageencryptor_getoutputfile(void* lpObj);
int secureblackbox_messageencryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

Use this property to specify the file to save the encrypted message to.

Data Type

String

SignedAttributes Property (MessageEncryptor Class)

Custom signature attributes to be covered by the electronic signature.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxSignatureAttribute>* GetSignedAttributes();

int secureblackbox_messageencryptor_getsignedattributecount(void* lpObj);
int secureblackbox_messageencryptor_setsignedattributecount(void* lpObj, int iSignedAttributeCount);

char* secureblackbox_messageencryptor_getsignedattributeoid(void* lpObj, int signedattributeindex);
int secureblackbox_messageencryptor_setsignedattributeoid(void* lpObj, int signedattributeindex, const char* lpszSignedAttributeOID);

int secureblackbox_messageencryptor_getsignedattributevalue(void* lpObj, int signedattributeindex, char** lpSignedAttributeValue, int* lenSignedAttributeValue);
int secureblackbox_messageencryptor_setsignedattributevalue(void* lpObj, int signedattributeindex, const char* lpSignedAttributeValue, int lenSignedAttributeValue);

int GetSignedAttributeCount();
int SetSignedAttributeCount(int iSignedAttributeCount);

QString GetSignedAttributeOID(int iSignedAttributeIndex);
int SetSignedAttributeOID(int iSignedAttributeIndex, QString qsSignedAttributeOID);

QByteArray GetSignedAttributeValue(int iSignedAttributeIndex);
int SetSignedAttributeValue(int iSignedAttributeIndex, QByteArray qbaSignedAttributeValue);

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

Custom unsigned attributes to be included in the electronic signature.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxSignatureAttribute>* GetUnsignedAttributes();

int secureblackbox_messageencryptor_getunsignedattributecount(void* lpObj);
int secureblackbox_messageencryptor_setunsignedattributecount(void* lpObj, int iUnsignedAttributeCount);

char* secureblackbox_messageencryptor_getunsignedattributeoid(void* lpObj, int unsignedattributeindex);
int secureblackbox_messageencryptor_setunsignedattributeoid(void* lpObj, int unsignedattributeindex, const char* lpszUnsignedAttributeOID);

int secureblackbox_messageencryptor_getunsignedattributevalue(void* lpObj, int unsignedattributeindex, char** lpUnsignedAttributeValue, int* lenUnsignedAttributeValue);
int secureblackbox_messageencryptor_setunsignedattributevalue(void* lpObj, int unsignedattributeindex, const char* lpUnsignedAttributeValue, int lenUnsignedAttributeValue);

int GetUnsignedAttributeCount();
int SetUnsignedAttributeCount(int iUnsignedAttributeCount);

QString GetUnsignedAttributeOID(int iUnsignedAttributeIndex);
int SetUnsignedAttributeOID(int iUnsignedAttributeIndex, QString qsUnsignedAttributeOID);

QByteArray GetUnsignedAttributeValue(int iUnsignedAttributeIndex);
int SetUnsignedAttributeValue(int iUnsignedAttributeIndex, QByteArray qbaUnsignedAttributeValue);

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

AddAttribute Method (MessageEncryptor Class)

Adds an attribute to the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddAttribute(const char* lpszOID, const char* lpValue, int lenValue, int bSignedAttribute);

Unicode (Windows)
INT AddAttribute(LPCWSTR lpszOID, LPCSTR lpValue, INT lenValue, BOOL bSignedAttribute);

int secureblackbox_messageencryptor_addattribute(void* lpObj, const char* lpszOID, const char* lpValue, int lenValue, int bSignedAttribute);

int AddAttribute(const QString& qsOID, QByteArray qbaValue, bool bSignedAttribute);

Remarks

Use this method to add a signed or unsigned attribute to the collection of attributes included in the new signature.

Note that CAdESSigner creates certain mandatory and/or widely used attributes automatically in accordance with requirements for a specific signing profile. For example, attributes such as SigningCertificateV2 or SigningTime are always added. Policy attributes are added if specified via the PolicyID or PolicyURI properties of the signature object.

Use the OID parameter to provide the object identifier of the attribute, in string form. For example, the OID for the SigningCertificateV2 attribute is 1.2.840.113549.1.9.16.2.47. The Value parameter should contain a well-formed, DER-encoded representation of the attribute value, in accordance with its specification.

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

DoAction Method (MessageEncryptor 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_messageencryptor_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.

Encrypt Method (MessageEncryptor Class)

Encrypts data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int secureblackbox_messageencryptor_encrypt(void* lpObj);

int Encrypt();

Remarks

This method encrypts the data provided via InputFile or InputStream in accordance with PKCS#7 standard.

If encrypted with an EncryptionCertificate a message of EnvelopedData subtype is created. The private key that corresponds to the certificate is needed to decrypt the data.

If encrypted with Key, a message of EncryptedData subtype is formed. The receiving party needs the same key as provided in Key to decrypt the message.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (MessageEncryptor Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_messageencryptor_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 (MessageEncryptor Class)

Information about errors during PKCS#7 message encryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGEENCRYPTOR_ERROR 1

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

class MessageEncryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass MessageEncryptor and override this emitter function.
virtual int FireError(MessageEncryptorErrorEventParams *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.

Notification Event (MessageEncryptor Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGEENCRYPTOR_NOTIFICATION 2

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

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

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

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

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 MessageEncryptor class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

Config Settings (MessageEncryptor Class)

MessageEncryptor Config Settings

Base Config Settings

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

MessageEncryptor Errors