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.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AssociatedData Property (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).

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.

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

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.

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.

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

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.

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

Base Config Settings

Trappable Errors (SymmetricCrypto Class)

SymmetricCrypto Errors