SymmetricCrypto Class

Properties   Methods   Events   Config Settings   Errors  

The SymmetricCrypto class provides capabilities of encrypting and decrypting binary data.

Syntax

SymmetricCrypto

Remarks

SymmetricCrypto allows you to encrypt and decrypt uninterpreted binary data with a symmetric block encryption cipher.

SymmetricCrypto is one of the low-level cryptography classes (alongside PublicKeyCrypto and HashFunction) offered by SecureBlackbox. It allows to encrypt pools of binary data with a chosen symmetric encryption cipher. It can be used as a standalone encryption mechanism (for example, for encrypting database data or setting files), or as part of a larger security system (such as PKCS#7 or PGP).

Encryption and decryption with SymmetricCrypto broadly consists of three steps: configuring the encryption parameters, setting up the key material, and actually encrypting or decrypting the data.

Configuring encryption parameters

When preparing SymmetricCrypto for action, you need to fine-tune several cryptographic encryption parameters. Normally these would be given to you by the party that expects you to encrypt or decrypt their data (for example: 'AES128-CBC, with the IV of all zeroes').

As a rule, the following parameters need to be selected/adjusted:

• EncryptionAlgorithm, such as AES128, 3DES, or Blowfish.
• Encryption Mode, such as CBC, CTR, GCM or CCM.
• Block Padding for data lengths that are not multiples of the cipher's block size (none, PKCS5, or ANXI X9.23).
• TagSize (for AEAD algorithms only).
• HashAlgorithm and MACAlgorithm (for algorithms that require them).

Setting up the key material

Symmetric algorithms use short (typically, 16-32 bytes) encryption keys. The exact key length depends on the encryption algorithm used (for example, 16 bytes for AES128). You can use the KeySize property to learn the expected key length for the chosen EncryptionAlgorithm.

In addition to keys, many encryption modes require additional data. These are typically represented by an Initialization Vector (IV) and a Nonce. The IV is a randomized public part of the encryption key, which is used to avoid re-use of the same encryption key for different data. Nonce is similar in meaning to the initialization vector, but applies to the algorithm and not the key.

Any key material that you assign to SymmetricCrypto should be first loaded into the CryptoKeyManager object. Once you have done that, simply assign the key object returned by the CryptoKeyManager to the Key property. Note that while the IV needs to be provided to the CryptoKeyManager, the Nonce needs to be assigned directly to Nonce property of the SymmetricCrypto object.

Note that CryptoKeyManager lets you to form the encryption key in a few ways: by loading it from memory or file, generating a new random key, or deriving it from a password. Use the method that is the most appropriate in your circumstances.

Encrypting and decrypting data

Now that the component has been set up, you can proceed to the actual encryption or decryption operation. There are a few options you can use here:

• Encrypt (or decrypt) a buffer to a buffer using Encrypt (Decrypt).
• Encrypt a file to a file using EncryptFile.
• Encrypt a stream to a stream using EncryptStream.
• Encrypt longer data chunk by chunk using a sequence of EncryptInit, EncryptUpdate, EncryptUpdate, ..., EncryptUpdate, EncryptFinal calls.

If you are using an authenticated encryption algorithm that can take additional associated data (AEAD), you can provide that via the AssociatedData property.

Please find an example of using SymmetricCrypto to encrypt and decrypt a file below: //encrypting a file SymmetricCrypto symmetricCrypto = new SymmetricCrypto(); symmetricCrypto.setEncryptionAlgorithm("RC4"); // default AES256 // generating a key from a password CryptoKeyManager keyManager = new CryptoKeyManager(); keyManager.deriveKey(256, "MyPassword",""); keyManager.getKey().setIV(new byte[16]); symmetricCrypto.setKey(keyManager.getKey()); // the encoding to apply to the output data, default cetDefault which depends on // the operation and type of key being used symmetricCrypto.setOutputEncoding(SymmetricCrypto.cetBinary); // first parameter is the path of the file you want to encrypt and the second is the path // of where the encrypted file will be saved symmetricCrypto.encryptFile("./message.txt","encryptedFile.bin"); // decrypting a file symmetricCrypto.reset(); symmetricCrypto.setKey(keyManager.getKey()); // first parameter is the path of the file you want to decrypt and the second is the path // of where the decrypted file will be saved symmetricCrypto.decryptFile("encryptedFile.bin","decryptedFile.bin");

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.

AssociatedData Property (SymmetricCrypto Class)

Provides Associated Data for AEAD algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssociatedData(char* &lpAssociatedData, int &lenAssociatedData);
int SetAssociatedData(const char* lpAssociatedData, int lenAssociatedData);

Unicode (Windows)
INT GetAssociatedData(LPSTR &lpAssociatedData, INT &lenAssociatedData);
INT SetAssociatedData(LPCSTR lpAssociatedData, INT lenAssociatedData);

int secureblackbox_symmetriccrypto_getassociateddata(void* lpObj, char** lpAssociatedData, int* lenAssociatedData);
int secureblackbox_symmetriccrypto_setassociateddata(void* lpObj, const char* lpAssociatedData, int lenAssociatedData);

QByteArray GetAssociatedData();
int SetAssociatedData(QByteArray qbaAssociatedData);

Remarks

Use this property to set up Associated Data for AEAD encryption algorithms.

This property is not available at design time.

Data Type

Byte Array

BlockSize Property (SymmetricCrypto Class)

The block size of the chosen symmetric cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockSize();

Unicode (Windows)
INT GetBlockSize();

int secureblackbox_symmetriccrypto_getblocksize(void* lpObj);

int GetBlockSize();

Default Value

0

Remarks

This property returns the block size of the chosen symmetric cipher.

Modern symmetric algorithms typically use blocks of 16 bytes. Some older algorithms, such as DES or Blowfish, use 8-byte blocks.

This property is read-only.

Data Type

Integer

EncryptionAlgorithm Property (SymmetricCrypto Class)

The encryption algorithm to use for encrypting the data.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_symmetriccrypto_getencryptionalgorithm(void* lpObj);
int secureblackbox_symmetriccrypto_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

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

Default Value

"AES256"

Remarks

This property specifies the base symmetric algorithm to use (e.g. AES128). Use it in conjunction with Mode to set up the complete encryption scheme (such as AES128-CBC or AES128-GCM).

Data Type

String

FIPSMode Property (SymmetricCrypto 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_symmetriccrypto_getfipsmode(void* lpObj);
int secureblackbox_symmetriccrypto_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

HashAlgorithm Property (SymmetricCrypto Class)

The hash algorithm to use during encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_symmetriccrypto_gethashalgorithm(void* lpObj);
int secureblackbox_symmetriccrypto_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

"SHA256"

Remarks

Use this property to provide the hash algorithm to be used with the encryption operation. This only applies to certain encryption algorithms/modes.

Data Type

String

InputEncoding Property (SymmetricCrypto Class)

The encoding to apply to the input data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputEncoding();
int SetInputEncoding(int iInputEncoding);

Unicode (Windows)
INT GetInputEncoding();
INT SetInputEncoding(INT iInputEncoding);

CET_DEFAULT(0), 
CET_BINARY(1), 
CET_BASE_64(2), 
CET_COMPACT(3), 
CET_JSON(4)

int secureblackbox_symmetriccrypto_getinputencoding(void* lpObj);
int secureblackbox_symmetriccrypto_setinputencoding(void* lpObj, int iInputEncoding);

int GetInputEncoding();
int SetInputEncoding(int iInputEncoding);

Default Value

0

Remarks

Data Type

Integer

Key Property (SymmetricCrypto Class)

The key to use for the cryptographic operation.

Syntax

• C++
• C
• Qt

SecureBlackboxCryptoKey* GetKey();
int SetKey(SecureBlackboxCryptoKey* val);

int64 secureblackbox_symmetriccrypto_getkeyhandle(void* lpObj);
int secureblackbox_symmetriccrypto_setkeyhandle(void* lpObj, int64 lKeyHandle);

int secureblackbox_symmetriccrypto_getkeykey(void* lpObj, char** lpKeyKey, int* lenKeyKey);

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

QByteArray GetKeyKey();

Remarks

Use this property to provide the symmetric key to use for the cryptographic operation. Remember that this key should be of appropriate type and length, and any required additional settings (such as IV or Nonce) should be adjusted where appropriate.

This property is not available at design time.

Data Type

SecureBlackboxCryptoKey

KeySize Property (SymmetricCrypto Class)

Returns the cryptographic key size in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeySize();

Unicode (Windows)
INT GetKeySize();

int secureblackbox_symmetriccrypto_getkeysize(void* lpObj);

int GetKeySize();

Default Value

0

Remarks

Use this property to read the cryptographic key size. For the majority of the symmetric algorithms this is hard-coded in the algorithm itself (such as 16 bytes for AES128), but may be variable for certain exceptions, such as Blowfish or RC4.

This property is read-only.

Data Type

Integer

MACAlgorithm Property (SymmetricCrypto Class)

The (H)MAC algorithm to use during encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMACAlgorithm();
int SetMACAlgorithm(const char* lpszMACAlgorithm);

Unicode (Windows)
LPWSTR GetMACAlgorithm();
INT SetMACAlgorithm(LPCWSTR lpszMACAlgorithm);

char* secureblackbox_symmetriccrypto_getmacalgorithm(void* lpObj);
int secureblackbox_symmetriccrypto_setmacalgorithm(void* lpObj, const char* lpszMACAlgorithm);

QString GetMACAlgorithm();
int SetMACAlgorithm(QString qsMACAlgorithm);

Default Value

""

Remarks

Use this property to configure the HMAC algorithm to use with the encryption operation. This only applies to a small subset of algorithms/modes.

Data Type

String

Mode Property (SymmetricCrypto Class)

Specifies the symmetric cipher mode of operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMode();
int SetMode(int iMode);

Unicode (Windows)
INT GetMode();
INT SetMode(INT iMode);

SCM_DEFAULT(0), 
SCM_ECB(1), 
SCM_CBC(2), 
SCM_CTR(3), 
SCM_CFB8(4), 
SCM_GCM(5), 
SCM_CCM(6), 
SCM_POLY_1305(7), 
SCM_OCB(8)

int secureblackbox_symmetriccrypto_getmode(void* lpObj);
int secureblackbox_symmetriccrypto_setmode(void* lpObj, int iMode);

int GetMode();
int SetMode(int iMode);

Default Value

0

Remarks

Use this property to specify the mode of operation as required by your environment. The default setting is CBC.

Data Type

Integer

Nonce Property (SymmetricCrypto Class)

Specifies the Nonce value to employ.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNonce(char* &lpNonce, int &lenNonce);
int SetNonce(const char* lpNonce, int lenNonce);

Unicode (Windows)
INT GetNonce(LPSTR &lpNonce, INT &lenNonce);
INT SetNonce(LPCSTR lpNonce, INT lenNonce);

int secureblackbox_symmetriccrypto_getnonce(void* lpObj, char** lpNonce, int* lenNonce);
int secureblackbox_symmetriccrypto_setnonce(void* lpObj, const char* lpNonce, int lenNonce);

QByteArray GetNonce();
int SetNonce(QByteArray qbaNonce);

Remarks

Use this property to specify the Nonce value for the symmetric operation. Not every algorithm or mode uses nonce.

This property is not available at design time.

Data Type

Byte Array

OutputEncoding Property (SymmetricCrypto Class)

The encoding to apply to the output data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);

Unicode (Windows)
INT GetOutputEncoding();
INT SetOutputEncoding(INT iOutputEncoding);

CET_DEFAULT(0), 
CET_BINARY(1), 
CET_BASE_64(2), 
CET_COMPACT(3), 
CET_JSON(4)

int secureblackbox_symmetriccrypto_getoutputencoding(void* lpObj);
int secureblackbox_symmetriccrypto_setoutputencoding(void* lpObj, int iOutputEncoding);

int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);

Default Value

0

Remarks

Data Type

Integer

Padding Property (SymmetricCrypto Class)

The padding type to apply to the encrypted data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPadding();
int SetPadding(int iPadding);

Unicode (Windows)
INT GetPadding();
INT SetPadding(INT iPadding);

SCP_NONE(0), 
SCP_PKCS5(1), 
SCP_ANSIX923(2)

int secureblackbox_symmetriccrypto_getpadding(void* lpObj);
int secureblackbox_symmetriccrypto_setpadding(void* lpObj, int iPadding);

int GetPadding();
int SetPadding(int iPadding);

Default Value

1

Remarks

Use this property to specify the padding type to use with the encrypted data. A padding type commonly used in modern security environments is PKCS#5.

Data Type

Integer

PayloadSize Property (SymmetricCrypto Class)

Specifies the payload size, in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPayloadSize();
int SetPayloadSize(int iPayloadSize);

Unicode (Windows)
INT GetPayloadSize();
INT SetPayloadSize(INT iPayloadSize);

int secureblackbox_symmetriccrypto_getpayloadsize(void* lpObj);
int secureblackbox_symmetriccrypto_setpayloadsize(void* lpObj, int iPayloadSize);

int GetPayloadSize();
int SetPayloadSize(int iPayloadSize);

Default Value

0

Remarks

Use this property to specify the size of the input data in bytes. This is only used by a subset of algorithms/modes, such as CCM.

Data Type

Integer

StreamCipher Property (SymmetricCrypto Class)

Returns true if the selected algorithms works as a stream cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetStreamCipher();

Unicode (Windows)
BOOL GetStreamCipher();

int secureblackbox_symmetriccrypto_getstreamcipher(void* lpObj);

bool GetStreamCipher();

Default Value

FALSE

Remarks

This property returns true if the selected algorithm processes data as a stream (byte-by-byte), rather than block-by-block. This affects the need to use a proper padding settings.

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

Data Type

Boolean

TagSize Property (SymmetricCrypto Class)

Specifies the AEAD tag size, in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTagSize();
int SetTagSize(int iTagSize);

Unicode (Windows)
INT GetTagSize();
INT SetTagSize(INT iTagSize);

int secureblackbox_symmetriccrypto_gettagsize(void* lpObj);
int secureblackbox_symmetriccrypto_settagsize(void* lpObj, int iTagSize);

int GetTagSize();
int SetTagSize(int iTagSize);

Default Value

16

Remarks

Use this property to specify/customize the tag size for AEAD encryption.

Data Type

Integer

Config Method (SymmetricCrypto 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_symmetriccrypto_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 (SymmetricCrypto Class)

Decrypts a buffer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Decrypt(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR Decrypt(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_symmetriccrypto_decrypt(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray Decrypt(QByteArray qbaBuffer);

Remarks

Use this method to decrypt a byte array and get the encrypted message in another byte array.

Specify the decryption key in Key property.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

DecryptFile Method (SymmetricCrypto Class)

Decrypts a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptFile(const char* lpszSourceFile, const char* lpszDestFile);

Unicode (Windows)
INT DecryptFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);

int secureblackbox_symmetriccrypto_decryptfile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);

int DecryptFile(const QString& qsSourceFile, const QString& qsDestFile);

Remarks

Use this method to decrypt an encrypted file and save the decrypted data to another file.

Specify the decryption key in Key property before calling this method.

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

DecryptFinal Method (SymmetricCrypto Class)

Finalization of decryption by blocks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecryptFinal(int *lpSize = NULL);

Unicode (Windows)
LPSTR DecryptFinal(LPINT lpSize = NULL);

char* secureblackbox_symmetriccrypto_decryptfinal(void* lpObjint *lpSize);

QByteArray DecryptFinal();

Remarks

Use this method to finalize of decryption by blocks.

Specify decryption key in Key property.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

DecryptInit Method (SymmetricCrypto Class)

Initializes a per-block decryption process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptInit();

Unicode (Windows)
INT DecryptInit();

int secureblackbox_symmetriccrypto_decryptinit(void* lpObj);

int DecryptInit();

Remarks

Use this method to start a block-by-block decryption process.

Specify the decryption key in Key property before starting the decryption.

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

DecryptStream Method (SymmetricCrypto Class)

Decrypts a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Unicode (Windows)
INT DecryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int secureblackbox_symmetriccrypto_decryptstream(void* lpObj, SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int DecryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Remarks

Use this method to decrypt a stream and save the decrypted message to another stream.

Specify the decryption key in Key property before commencing the decryption.

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

DecryptUpdate Method (SymmetricCrypto Class)

Decrypts the next block of encrypted data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecryptUpdate(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecryptUpdate(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_symmetriccrypto_decryptupdate(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray DecryptUpdate(QByteArray qbaBuffer);

Remarks

When using block-by-block decryption, pass every subsequent block of the encrypted message to this method until the entire message is processed. For each encrypted block the method returns a piece of decrypted data.

Please note that in general case there is no direct correspondence between the data actually contained in the encrypted block with the output of this method. The component may choose to cache a piece of the provided buffer internally if it doesn't constitute a full block of encrypted data.

Remember to call DecryptInit before calling this method to prepare the control for the decryption process.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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 (SymmetricCrypto 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_symmetriccrypto_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 (SymmetricCrypto Class)

Encrypts a buffer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Encrypt(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR Encrypt(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_symmetriccrypto_encrypt(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray Encrypt(QByteArray qbaBuffer);

Remarks

Use this method to encrypt a byte array and get the protected message in another byte array.

Specify the encryption key in Key property before calling this method.

This is a one-off encryption method. Don't use it with granular per-block methods (EncryptInit, EncryptUpdate, EncryptFinal).

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

EncryptFile Method (SymmetricCrypto Class)

Encrypts a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncryptFile(const char* lpszSourceFile, const char* lpszDestFile);

Unicode (Windows)
INT EncryptFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);

int secureblackbox_symmetriccrypto_encryptfile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);

int EncryptFile(const QString& qsSourceFile, const QString& qsDestFile);

Remarks

Use this method to encrypt a file and save the protected message in another file.

Specify the encryption key in Key property before commencing encryption.

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

EncryptFinal Method (SymmetricCrypto Class)

Finalization of encryption by blocks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* EncryptFinal(int *lpSize = NULL);

Unicode (Windows)
LPSTR EncryptFinal(LPINT lpSize = NULL);

char* secureblackbox_symmetriccrypto_encryptfinal(void* lpObjint *lpSize);

QByteArray EncryptFinal();

Remarks

Use this method to finalize of encryption by blocks.

Specify encryption key in Key property.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

EncryptInit Method (SymmetricCrypto Class)

Initializes a per-block encryption process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncryptInit();

Unicode (Windows)
INT EncryptInit();

int secureblackbox_symmetriccrypto_encryptinit(void* lpObj);

int EncryptInit();

Remarks

Use this method to initialize a block-by-block encryption process. Follow it with calls to EncryptUpdate (as many as needed), and complete the encryption with an EncryptFinal call.

Specify the encryption key in Key property before calling this method.

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

EncryptStream Method (SymmetricCrypto Class)

Encrypts a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Unicode (Windows)
INT EncryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int secureblackbox_symmetriccrypto_encryptstream(void* lpObj, SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int EncryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Remarks

Use this method to encrypt a stream and save the protected message into another stream.

Specify the encryption key in the Key property before calling this method.

This is a one-off encryption method. Don't use it together with granular per-block encryption methods such as EncryptInit, EncryptUpdate, and EncryptFinal.

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

EncryptUpdate Method (SymmetricCrypto Class)

Encrypts the next block of data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* EncryptUpdate(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR EncryptUpdate(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_symmetriccrypto_encryptupdate(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray EncryptUpdate(QByteArray qbaBuffer);

Remarks

Use this method to encrypt the next block of data contained in Buffer.

Call this method after calling EncryptInit for as many times as needed, until the whole volume of data is processed. Having done that, call EncryptFinal to complete the encryption and get the terminating encrypted trailer.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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 (SymmetricCrypto Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_symmetriccrypto_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 (SymmetricCrypto Class)

Reports errors during encryption or decryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SYMMETRICCRYPTO_ERROR 1

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

class SymmetricCryptoErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

class fires this event in case of exceptional conditions during a cryptographic operation.

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

Notification Event (SymmetricCrypto Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SYMMETRICCRYPTO_NOTIFICATION 2

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

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

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

Progress Event (SymmetricCrypto Class)

Reports the data encryption/decryption progress.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(SymmetricCryptoProgressEventParams *e);

typedef struct {
  int64 Total;
  int64 Current;
  int Cancel;
  int reserved;
} SymmetricCryptoProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(SymmetricCryptoProgressEventParams *e);

typedef struct {
  LONG64 Total;
  LONG64 Current;
  BOOL Cancel;
  INT reserved;
} SymmetricCryptoProgressEventParams;

#define EID_SYMMETRICCRYPTO_PROGRESS 3

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);

class SymmetricCryptoProgressEventParams {
public:
  qint64 Total();

  qint64 Current();

  bool Cancel();
  void SetCancel(bool bCancel);

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

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

// Or, subclass SymmetricCrypto and override this emitter function.
virtual int FireProgress(SymmetricCryptoProgressEventParams *e) {...}

Remarks

This event fires periodically during a file encrypt/decrypt operation to report its progress.

Use the Cancel parameter to terminate the encryption/decryption if needed.

CryptoKey Type

This container represents a cryptographic key.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

CryptoKey()

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The SymmetricCrypto class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the SymmetricCrypto class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (SymmetricCrypto Class)

SymmetricCrypto Config Settings

Base Config Settings

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

SymmetricCrypto Errors