SymmetricCrypto Class
Properties Methods Events Config Settings Errors
The SymmetricCrypto class supports encrypting and decrypting messages.
Syntax
SymmetricCrypto
Remarks
SymmetricCrypto allows you to encrypt and decrypt messages.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AssociatedData | Provides Associated Data for AEAD algorithms. |
BlockSize | The block size of the chosen symmetric cipher. |
EncryptionAlgorithm | The encryption algorithm to use for encrypting the data. |
FIPSMode | Reserved. |
HashAlgorithm | The hash algorithm to use during encryption. |
InputEncoding | The encoding to apply to the input data. |
KeyAlgorithm | The algorithm of the cryptographic key. |
KeyBits | The length of the key in bits. |
KeyCurve | This property specifies the name of the curve the EC key is built on. |
KeyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KeyID | Provides access to a storage-specific key identifier. |
KeyIV | The initialization vector (IV) of a symmetric key. |
KeyKey | The byte array representation of the key. |
KeyNonce | A nonce value associated with a key. |
KeyPrivate | Returns True if the object hosts a private key, and False otherwise. |
KeyPublic | Returns True if the object hosts a public key, and False otherwise. |
KeySubject | Returns the key subject. |
KeySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
KeyValid | Returns True if this key is valid. |
KeySize | Returns the cryptographic key size in bytes. |
MACAlgorithm | The (H)MAC algorithm to use during encryption. |
Mode | Specifies the symmetric cipher mode of operation. |
Nonce | Specifies the Nonce value to employ. |
OutputEncoding | The encoding to apply to the output data. |
Padding | The padding type to apply to the encrypted data. |
PayloadSize | Specifies the payload size, in bytes. |
StreamCipher | Returns true if the selected algorithms works as a stream cipher. |
TagSize | Specifies the AEAD tag size, in bytes. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts a buffer. |
DecryptFile | Decrypts a file. |
DecryptFinal | Finalization of decryption by blocks. |
DecryptInit | Initializes a per-block decryption process. |
DecryptStream | Decrypts a stream. |
DecryptUpdate | Decrypts the next block of encrypted data. |
DoAction | Performs an additional action. |
Encrypt | Encrypts a buffer. |
EncryptFile | Encrypts a file. |
EncryptFinal | Finalization of encryption by blocks. |
EncryptInit | Initializes a per-block encryption process. |
EncryptStream | Encrypts a stream. |
EncryptUpdate | Encrypts the next block of data. |
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.
Error | Reports errors during encryption or decryption. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the data encryption/decryption progress. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
Compress | Specifies whether the JSON output should be compressed. |
CTRLittleEndian | Specifies whether the little-endian representation should be employed in CTR mode. |
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
AssociatedData Property (SymmetricCrypto Class)
Provides Associated Data for AEAD algorithms.
Syntax
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
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
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).
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
Data Type
String
FIPSMode Property (SymmetricCrypto Class)
Reserved.
Syntax
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
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.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
String
InputEncoding Property (SymmetricCrypto Class)
The encoding to apply to the input data.
Syntax
ANSI (Cross Platform) int GetInputEncoding();
int SetInputEncoding(int iInputEncoding); Unicode (Windows) INT GetInputEncoding();
INT SetInputEncoding(INT iInputEncoding);
Possible Values
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
cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
cetBinary | 1 | Raw binary encoding (no encoding) |
cetBase64 | 2 | Base64 encoding (armouring) |
cetCompact | 3 | JSON compact encoding |
cetJSON | 4 | JSON standard encoding |
Data Type
Integer
KeyAlgorithm Property (SymmetricCrypto Class)
The algorithm of the cryptographic key.
Syntax
ANSI (Cross Platform) char* GetKeyAlgorithm();
int SetKeyAlgorithm(const char* lpszKeyAlgorithm); Unicode (Windows) LPWSTR GetKeyAlgorithm();
INT SetKeyAlgorithm(LPCWSTR lpszKeyAlgorithm);
char* secureblackbox_symmetriccrypto_getkeyalgorithm(void* lpObj);
int secureblackbox_symmetriccrypto_setkeyalgorithm(void* lpObj, const char* lpszKeyAlgorithm);
QString GetKeyAlgorithm();
int SetKeyAlgorithm(QString qsKeyAlgorithm);
Default Value
""
Remarks
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is not available at design time.
Data Type
String
KeyBits Property (SymmetricCrypto Class)
The length of the key in bits.
Syntax
ANSI (Cross Platform) int GetKeyBits(); Unicode (Windows) INT GetKeyBits();
int secureblackbox_symmetriccrypto_getkeybits(void* lpObj);
int GetKeyBits();
Default Value
0
Remarks
The length of the key in bits.
This property is read-only and not available at design time.
Data Type
Integer
KeyCurve Property (SymmetricCrypto Class)
This property specifies the name of the curve the EC key is built on.
Syntax
ANSI (Cross Platform) char* GetKeyCurve();
int SetKeyCurve(const char* lpszKeyCurve); Unicode (Windows) LPWSTR GetKeyCurve();
INT SetKeyCurve(LPCWSTR lpszKeyCurve);
char* secureblackbox_symmetriccrypto_getkeycurve(void* lpObj);
int secureblackbox_symmetriccrypto_setkeycurve(void* lpObj, const char* lpszKeyCurve);
QString GetKeyCurve();
int SetKeyCurve(QString qsKeyCurve);
Default Value
""
Remarks
This property specifies the name of the curve the EC key is built on.
This property is not available at design time.
Data Type
String
KeyExportable Property (SymmetricCrypto Class)
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
Syntax
ANSI (Cross Platform) int GetKeyExportable(); Unicode (Windows) BOOL GetKeyExportable();
int secureblackbox_symmetriccrypto_getkeyexportable(void* lpObj);
bool GetKeyExportable();
Default Value
FALSE
Remarks
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
KeyHandle Property (SymmetricCrypto Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetKeyHandle();
int SetKeyHandle(int64 lKeyHandle); Unicode (Windows) LONG64 GetKeyHandle();
INT SetKeyHandle(LONG64 lKeyHandle);
int64 secureblackbox_symmetriccrypto_getkeyhandle(void* lpObj);
int secureblackbox_symmetriccrypto_setkeyhandle(void* lpObj, int64 lKeyHandle);
qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
KeyID Property (SymmetricCrypto Class)
Provides access to a storage-specific key identifier.
Syntax
ANSI (Cross Platform) int GetKeyID(char* &lpKeyID, int &lenKeyID);
int SetKeyID(const char* lpKeyID, int lenKeyID); Unicode (Windows) INT GetKeyID(LPSTR &lpKeyID, INT &lenKeyID);
INT SetKeyID(LPCSTR lpKeyID, INT lenKeyID);
int secureblackbox_symmetriccrypto_getkeyid(void* lpObj, char** lpKeyID, int* lenKeyID);
int secureblackbox_symmetriccrypto_setkeyid(void* lpObj, const char* lpKeyID, int lenKeyID);
QByteArray GetKeyID();
int SetKeyID(QByteArray qbaKeyID);
Remarks
Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).
This property is not available at design time.
Data Type
Byte Array
KeyIV Property (SymmetricCrypto Class)
The initialization vector (IV) of a symmetric key.
Syntax
ANSI (Cross Platform) int GetKeyIV(char* &lpKeyIV, int &lenKeyIV);
int SetKeyIV(const char* lpKeyIV, int lenKeyIV); Unicode (Windows) INT GetKeyIV(LPSTR &lpKeyIV, INT &lenKeyIV);
INT SetKeyIV(LPCSTR lpKeyIV, INT lenKeyIV);
int secureblackbox_symmetriccrypto_getkeyiv(void* lpObj, char** lpKeyIV, int* lenKeyIV);
int secureblackbox_symmetriccrypto_setkeyiv(void* lpObj, const char* lpKeyIV, int lenKeyIV);
QByteArray GetKeyIV();
int SetKeyIV(QByteArray qbaKeyIV);
Remarks
The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.
This property is not available at design time.
Data Type
Byte Array
KeyKey Property (SymmetricCrypto Class)
The byte array representation of the key.
Syntax
ANSI (Cross Platform) int GetKeyKey(char* &lpKeyKey, int &lenKeyKey); Unicode (Windows) INT GetKeyKey(LPSTR &lpKeyKey, INT &lenKeyKey);
int secureblackbox_symmetriccrypto_getkeykey(void* lpObj, char** lpKeyKey, int* lenKeyKey);
QByteArray GetKeyKey();
Remarks
The byte array representation of the key. This may not be available for non-KeyExportable keys.
This property is read-only and not available at design time.
Data Type
Byte Array
KeyNonce Property (SymmetricCrypto Class)
A nonce value associated with a key.
Syntax
ANSI (Cross Platform) int GetKeyNonce(char* &lpKeyNonce, int &lenKeyNonce);
int SetKeyNonce(const char* lpKeyNonce, int lenKeyNonce); Unicode (Windows) INT GetKeyNonce(LPSTR &lpKeyNonce, INT &lenKeyNonce);
INT SetKeyNonce(LPCSTR lpKeyNonce, INT lenKeyNonce);
int secureblackbox_symmetriccrypto_getkeynonce(void* lpObj, char** lpKeyNonce, int* lenKeyNonce);
int secureblackbox_symmetriccrypto_setkeynonce(void* lpObj, const char* lpKeyNonce, int lenKeyNonce);
QByteArray GetKeyNonce();
int SetKeyNonce(QByteArray qbaKeyNonce);
Remarks
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
This property is not available at design time.
Data Type
Byte Array
KeyPrivate Property (SymmetricCrypto Class)
Returns True if the object hosts a private key, and False otherwise.
Syntax
ANSI (Cross Platform) int GetKeyPrivate(); Unicode (Windows) BOOL GetKeyPrivate();
int secureblackbox_symmetriccrypto_getkeyprivate(void* lpObj);
bool GetKeyPrivate();
Default Value
FALSE
Remarks
Returns True if the object hosts a private key, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
KeyPublic Property (SymmetricCrypto Class)
Returns True if the object hosts a public key, and False otherwise.
Syntax
ANSI (Cross Platform) int GetKeyPublic(); Unicode (Windows) BOOL GetKeyPublic();
int secureblackbox_symmetriccrypto_getkeypublic(void* lpObj);
bool GetKeyPublic();
Default Value
FALSE
Remarks
Returns True if the object hosts a public key, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
KeySubject Property (SymmetricCrypto Class)
Returns the key subject.
Syntax
ANSI (Cross Platform) int GetKeySubject(char* &lpKeySubject, int &lenKeySubject);
int SetKeySubject(const char* lpKeySubject, int lenKeySubject); Unicode (Windows) INT GetKeySubject(LPSTR &lpKeySubject, INT &lenKeySubject);
INT SetKeySubject(LPCSTR lpKeySubject, INT lenKeySubject);
int secureblackbox_symmetriccrypto_getkeysubject(void* lpObj, char** lpKeySubject, int* lenKeySubject);
int secureblackbox_symmetriccrypto_setkeysubject(void* lpObj, const char* lpKeySubject, int lenKeySubject);
QByteArray GetKeySubject();
int SetKeySubject(QByteArray qbaKeySubject);
Remarks
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.
This property is not available at design time.
Data Type
Byte Array
KeySymmetric Property (SymmetricCrypto Class)
Returns True if the object contains a symmetric key, and False otherwise.
Syntax
ANSI (Cross Platform) int GetKeySymmetric(); Unicode (Windows) BOOL GetKeySymmetric();
int secureblackbox_symmetriccrypto_getkeysymmetric(void* lpObj);
bool GetKeySymmetric();
Default Value
FALSE
Remarks
Returns True if the object contains a symmetric key, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
KeyValid Property (SymmetricCrypto Class)
Returns True if this key is valid.
Syntax
ANSI (Cross Platform) int GetKeyValid(); Unicode (Windows) BOOL GetKeyValid();
int secureblackbox_symmetriccrypto_getkeyvalid(void* lpObj);
bool GetKeyValid();
Default Value
FALSE
Remarks
Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.
This property is read-only and not available at design time.
Data Type
Boolean
KeySize Property (SymmetricCrypto Class)
Returns the cryptographic key size in bytes.
Syntax
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
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.
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
Data Type
String
Mode Property (SymmetricCrypto Class)
Specifies the symmetric cipher mode of operation.
Syntax
ANSI (Cross Platform) int GetMode();
int SetMode(int iMode); Unicode (Windows) INT GetMode();
INT SetMode(INT iMode);
Possible Values
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)
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.
scmDefault | 0 | The default mode in current circumstances. |
scmECB | 1 | ECB (electronic code book) mode. This is insecure, unless you know how to use it right. |
scmCBC | 2 | CBC (cipher block chaining mode) |
scmCTR | 3 | Counter mode |
scmCFB8 | 4 | Cipher feedback mode |
scmGCM | 5 | Galois counter mode |
scmCCM | 6 | CCM mode |
Data Type
Integer
Nonce Property (SymmetricCrypto Class)
Specifies the Nonce value to employ.
Syntax
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
ANSI (Cross Platform) int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding); Unicode (Windows) INT GetOutputEncoding();
INT SetOutputEncoding(INT iOutputEncoding);
Possible Values
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
cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
cetBinary | 1 | Raw binary encoding (no encoding) |
cetBase64 | 2 | Base64 encoding (armouring) |
cetCompact | 3 | JSON compact encoding |
cetJSON | 4 | JSON standard encoding |
Data Type
Integer
Padding Property (SymmetricCrypto Class)
The padding type to apply to the encrypted data.
Syntax
ANSI (Cross Platform) int GetPadding();
int SetPadding(int iPadding); Unicode (Windows) INT GetPadding();
INT SetPadding(INT iPadding);
Possible Values
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.
scpNone | 0 | No padding. You might need to adjust the length of the input data to align it by the encryption block boundary. |
scpPKCS5 | 1 | Standard PKCS5 (sometimes also referred to as PKCS7) padding |
scpANSIX923 | 2 | ANSI X.923 padding |
Data Type
Integer
PayloadSize Property (SymmetricCrypto Class)
Specifies the payload size, in bytes.
Syntax
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
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
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
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
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
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
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
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
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
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
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;....
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
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
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
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
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
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
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.
Error Event (SymmetricCrypto Class)
Reports errors during encryption or decryption.
Syntax
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
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
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.
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.
Config Settings (SymmetricCrypto Class)
The class accepts one or more of the following configuration settings. Configuration 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.SymmetricCrypto Config Settings
Use this configuration setting to specify that the output should be presented in the compressed form.
Use this setting to enable the little-endian representation when encrypting/decrypting in counter mode.
This setting specifies an absolute path to the location on disk where temporary files are stored.
Base Config Settings
This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys.
Set this property to enable or disable cookies caching for the class.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.
This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.
This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3.
Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".
This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.
Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Use this property to provide a path to the log file.
Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
Use this property to set the log flush mode. The following values are defined:
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Use this property to provide the desired debug log level.
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.
The default value of this setting is 100.
Use this property to set the log rotation mode. The following values are defined:
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.
This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.
This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.
Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.
Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.
Use this config property to store any custom data.
Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.
Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).
Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).
Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.
Set this global property to false to make each validation run use its own copy of system certificate stores.
This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store.
Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
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
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |