SymmetricCrypto Class

Properties   Methods   Events   Config Settings   Errors  

The SymmetricCrypto class supports encrypting and decrypting messages.

Class Name

SecureBlackbox_SymmetricCrypto

Procedural Interface

 secureblackbox_symmetriccrypto_open();
 secureblackbox_symmetriccrypto_close($res);
 secureblackbox_symmetriccrypto_register_callback($res, $id, $function);
 secureblackbox_symmetriccrypto_get_last_error($res);
 secureblackbox_symmetriccrypto_get_last_error_code($res);
 secureblackbox_symmetriccrypto_set($res, $id, $index, $value);
 secureblackbox_symmetriccrypto_get($res, $id, $index);
 secureblackbox_symmetriccrypto_do_config($res, $configurationstring);
 secureblackbox_symmetriccrypto_do_decrypt($res, $buffer);
 secureblackbox_symmetriccrypto_do_decryptfile($res, $sourcefile, $destfile);
 secureblackbox_symmetriccrypto_do_decryptfinal($res);
 secureblackbox_symmetriccrypto_do_decryptinit($res);
 secureblackbox_symmetriccrypto_do_decryptupdate($res, $buffer);
 secureblackbox_symmetriccrypto_do_doaction($res, $actionid, $actionparams);
 secureblackbox_symmetriccrypto_do_encrypt($res, $buffer);
 secureblackbox_symmetriccrypto_do_encryptfile($res, $sourcefile, $destfile);
 secureblackbox_symmetriccrypto_do_encryptfinal($res);
 secureblackbox_symmetriccrypto_do_encryptinit($res);
 secureblackbox_symmetriccrypto_do_encryptupdate($res, $buffer);
 secureblackbox_symmetriccrypto_do_reset($res);

Remarks

SymmetricCrypto allows you to encrypt and decrypt messages. //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.

AssociatedDataProvides Associated Data for AEAD algorithms.
BlockSizeThe block size of the chosen symmetric cipher.
EncryptionAlgorithmThe encryption algorithm to use for encrypting the data.
FIPSModeReserved.
HashAlgorithmThe hash algorithm to use during encryption.
InputEncodingThe encoding to apply to the input data.
KeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyKeyThe byte array representation of the key.
KeySizeReturns the cryptographic key size in bytes.
MACAlgorithmThe (H)MAC algorithm to use during encryption.
ModeSpecifies the symmetric cipher mode of operation.
NonceSpecifies the Nonce value to employ.
OutputEncodingThe encoding to apply to the output data.
PaddingThe padding type to apply to the encrypted data.
PayloadSizeSpecifies the payload size, in bytes.
StreamCipherReturns true if the selected algorithms works as a stream cipher.
TagSizeSpecifies 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.

ConfigSets or retrieves a configuration setting.
DecryptDecrypts a buffer.
DecryptFileDecrypts a file.
DecryptFinalFinalization of decryption by blocks.
DecryptInitInitializes a per-block decryption process.
DecryptUpdateDecrypts the next block of encrypted data.
DoActionPerforms an additional action.
EncryptEncrypts a buffer.
EncryptFileEncrypts a file.
EncryptFinalFinalization of encryption by blocks.
EncryptInitInitializes a per-block encryption process.
EncryptUpdateEncrypts the next block of data.
ResetResets the class settings.

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.

ErrorReports errors during encryption or decryption.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports 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.

CompressSpecifies whether the JSON output should be compressed.
CTRLittleEndianSpecifies whether the little-endian representation should be employed in CTR mode.
KeyAlgorithmGets or sets a JWE key algorithm.
TempPathPath for storing temporary files.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AssociatedData Property (SecureBlackbox_SymmetricCrypto Class)

Provides Associated Data for AEAD algorithms.

Object Oriented Interface


public function getAssociatedData();


public function setAssociatedData($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 1 );


secureblackbox_symmetriccrypto_set($res, 1, $value );

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

The block size of the chosen symmetric cipher.

Object Oriented Interface


public function getBlockSize();


Procedural Interface


secureblackbox_symmetriccrypto_get($res, 2 );


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

The encryption algorithm to use for encrypting the data.

Object Oriented Interface


public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 3 );


secureblackbox_symmetriccrypto_set($res, 3, $value );

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_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20

Data Type

String

FIPSMode Property (SecureBlackbox_SymmetricCrypto Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 4 );


secureblackbox_symmetriccrypto_set($res, 4, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_SymmetricCrypto Class)

The hash algorithm to use during encryption.

Object Oriented Interface


public function getHashAlgorithm();


public function setHashAlgorithm($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 5 );


secureblackbox_symmetriccrypto_set($res, 5, $value );

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_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Data Type

String

InputEncoding Property (SecureBlackbox_SymmetricCrypto Class)

The encoding to apply to the input data.

Object Oriented Interface


public function getInputEncoding();


public function setInputEncoding($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 6 );


secureblackbox_symmetriccrypto_set($res, 6, $value );

Default Value

0

Remarks

cetDefault0The default encoding type in current circumstances. This depends on the operation and the type of the key being used.

cetBinary1Raw binary encoding (no encoding)

cetBase642Base64 encoding (armouring)

cetCompact3JSON compact encoding

cetJSON4JSON standard encoding

Data Type

Integer

KeyHandle Property (SecureBlackbox_SymmetricCrypto Class)

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

Object Oriented Interface


public function getKeyHandle();


public function setKeyHandle($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 12 );


secureblackbox_symmetriccrypto_set($res, 12, $value );

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

KeyKey Property (SecureBlackbox_SymmetricCrypto Class)

The byte array representation of the key.

Object Oriented Interface


public function getKeyKey();


Procedural Interface


secureblackbox_symmetriccrypto_get($res, 15 );


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

KeySize Property (SecureBlackbox_SymmetricCrypto Class)

Returns the cryptographic key size in bytes.

Object Oriented Interface


public function getKeySize();


Procedural Interface


secureblackbox_symmetriccrypto_get($res, 22 );


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

The (H)MAC algorithm to use during encryption.

Object Oriented Interface


public function getMACAlgorithm();


public function setMACAlgorithm($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 23 );


secureblackbox_symmetriccrypto_set($res, 23, $value );

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_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

Data Type

String

Mode Property (SecureBlackbox_SymmetricCrypto Class)

Specifies the symmetric cipher mode of operation.

Object Oriented Interface


public function getMode();


public function setMode($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 24 );


secureblackbox_symmetriccrypto_set($res, 24, $value );

Default Value

0

Remarks

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

scmDefault0The default mode in current circumstances.

scmECB1ECB (electronic code book) mode. This is insecure, unless you know how to use it right.

scmCBC2CBC (cipher block chaining mode)

scmCTR3Counter mode

scmCFB84Cipher feedback mode

scmGCM5Galois counter mode

scmCCM6CCM mode

scmPoly13057Poly1305 mode (only to be used with ChaCha20 algorithm)

scmOCB8OCB mode

Data Type

Integer

Nonce Property (SecureBlackbox_SymmetricCrypto Class)

Specifies the Nonce value to employ.

Object Oriented Interface


public function getNonce();


public function setNonce($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 25 );


secureblackbox_symmetriccrypto_set($res, 25, $value );

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

The encoding to apply to the output data.

Object Oriented Interface


public function getOutputEncoding();


public function setOutputEncoding($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 26 );


secureblackbox_symmetriccrypto_set($res, 26, $value );

Default Value

0

Remarks

cetDefault0The default encoding type in current circumstances. This depends on the operation and the type of the key being used.

cetBinary1Raw binary encoding (no encoding)

cetBase642Base64 encoding (armouring)

cetCompact3JSON compact encoding

cetJSON4JSON standard encoding

Data Type

Integer

Padding Property (SecureBlackbox_SymmetricCrypto Class)

The padding type to apply to the encrypted data.

Object Oriented Interface


public function getPadding();


public function setPadding($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 27 );


secureblackbox_symmetriccrypto_set($res, 27, $value );

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.

scpNone0No padding. You might need to adjust the length of the input data to align it by the encryption block boundary.

scpPKCS51Standard PKCS5 (sometimes also referred to as PKCS7) padding

scpANSIX9232ANSI X.923 padding

Data Type

Integer

PayloadSize Property (SecureBlackbox_SymmetricCrypto Class)

Specifies the payload size, in bytes.

Object Oriented Interface


public function getPayloadSize();


public function setPayloadSize($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 28 );


secureblackbox_symmetriccrypto_set($res, 28, $value );

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

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

Object Oriented Interface


public function getStreamCipher();


Procedural Interface


secureblackbox_symmetriccrypto_get($res, 29 );


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

Specifies the AEAD tag size, in bytes.

Object Oriented Interface


public function getTagSize();


public function setTagSize($value);

Procedural Interface


secureblackbox_symmetriccrypto_get($res, 30 );


secureblackbox_symmetriccrypto_set($res, 30, $value );

Default Value

16

Remarks

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

Data Type

Integer

Config Method (SecureBlackbox_SymmetricCrypto Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_symmetriccrypto_do_config($res, $configurationstring);

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.

Decrypt Method (SecureBlackbox_SymmetricCrypto Class)

Decrypts a buffer.

Object Oriented Interface

public function doDecrypt($buffer);

Procedural Interface

secureblackbox_symmetriccrypto_do_decrypt($res, $buffer);

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.

DecryptFile Method (SecureBlackbox_SymmetricCrypto Class)

Decrypts a file.

Object Oriented Interface

public function doDecryptFile($sourcefile, $destfile);

Procedural Interface

secureblackbox_symmetriccrypto_do_decryptfile($res, $sourcefile, $destfile);

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.

DecryptFinal Method (SecureBlackbox_SymmetricCrypto Class)

Finalization of decryption by blocks.

Object Oriented Interface

public function doDecryptFinal();

Procedural Interface

secureblackbox_symmetriccrypto_do_decryptfinal($res);

Remarks

Use this method to finalize of decryption by blocks.

Specify decryption key in Key property.

DecryptInit Method (SecureBlackbox_SymmetricCrypto Class)

Initializes a per-block decryption process.

Object Oriented Interface

public function doDecryptInit();

Procedural Interface

secureblackbox_symmetriccrypto_do_decryptinit($res);

Remarks

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

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

DecryptUpdate Method (SecureBlackbox_SymmetricCrypto Class)

Decrypts the next block of encrypted data.

Object Oriented Interface

public function doDecryptUpdate($buffer);

Procedural Interface

secureblackbox_symmetriccrypto_do_decryptupdate($res, $buffer);

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.

DoAction Method (SecureBlackbox_SymmetricCrypto Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_symmetriccrypto_do_doaction($res, $actionid, $actionparams);

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

Encrypt Method (SecureBlackbox_SymmetricCrypto Class)

Encrypts a buffer.

Object Oriented Interface

public function doEncrypt($buffer);

Procedural Interface

secureblackbox_symmetriccrypto_do_encrypt($res, $buffer);

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

EncryptFile Method (SecureBlackbox_SymmetricCrypto Class)

Encrypts a file.

Object Oriented Interface

public function doEncryptFile($sourcefile, $destfile);

Procedural Interface

secureblackbox_symmetriccrypto_do_encryptfile($res, $sourcefile, $destfile);

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.

EncryptFinal Method (SecureBlackbox_SymmetricCrypto Class)

Finalization of encryption by blocks.

Object Oriented Interface

public function doEncryptFinal();

Procedural Interface

secureblackbox_symmetriccrypto_do_encryptfinal($res);

Remarks

Use this method to finalize of encryption by blocks.

Specify encryption key in Key property.

EncryptInit Method (SecureBlackbox_SymmetricCrypto Class)

Initializes a per-block encryption process.

Object Oriented Interface

public function doEncryptInit();

Procedural Interface

secureblackbox_symmetriccrypto_do_encryptinit($res);

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.

EncryptUpdate Method (SecureBlackbox_SymmetricCrypto Class)

Encrypts the next block of data.

Object Oriented Interface

public function doEncryptUpdate($buffer);

Procedural Interface

secureblackbox_symmetriccrypto_do_encryptupdate($res, $buffer);

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.

Reset Method (SecureBlackbox_SymmetricCrypto Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_symmetriccrypto_do_reset($res);

Remarks

Reset is a generic method available in every class.

Error Event (SecureBlackbox_SymmetricCrypto Class)

Reports errors during encryption or decryption.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_symmetriccrypto_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

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

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_symmetriccrypto_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
'eventparam'

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

Reports the data encryption/decryption progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_symmetriccrypto_register_callback($res, 3, array($this, 'fireProgress'));

Parameter List

 'total'
'current'
'cancel'

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.

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

Compress:   Specifies whether the JSON output should be compressed.

Use this configuration setting to specify that the output should be presented in the compressed form.

CTRLittleEndian:   Specifies whether the little-endian representation should be employed in CTR mode.

Use this setting to enable the little-endian representation when encrypting/decrypting in counter mode.

KeyAlgorithm:   Gets or sets a JWE key algorithm.

Use this property to retrieve or set the key algorithm to be used with JWE. The following algorithms are supported:

  • dir ("direct")
  • RSA1_5
  • RSA-OAEP
  • RSA-OAEP-256
  • A128KW
  • A192KW
  • A256KW
  • ECDH-ES
  • ECDH-ES+A128KW
  • ECDH-ES+A192KW
  • ECDH-ES+A256KW
  • A128GCMKW
  • A192GCMKW
  • A256GCMKW
  • PBES2-HS256+A128KW
  • PBES2-HS384+A192KW
  • PBES2-HS512+A256KW
TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

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.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

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.

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

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.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

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

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

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.

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter:   The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

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.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

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.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

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.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

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.

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion:   Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

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.

StaticIPAddresses:   Gets or sets all the static DNS rules.

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.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

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.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

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

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

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

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

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.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

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.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SymmetricCrypto Class)

SymmetricCrypto Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)