SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

SymmetricCrypto Class

Properties   Methods   Events   Configuration Settings   Errors  

The SymmetricCrypto class supports encrypting and decrypting messages.

Syntax

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

AssociatedDataProvides Associated Data for AEAD algorithms.
BlockSizeThe block size of the chosen symmetric cipher.
EncryptionAlgorithmThe encryption algorithm to use for encrypting the data.
HashAlgorithmThe hash algorithm to use during encryption.
InputEncodingThe encoding to apply to the input data.
KeyAlgorithmThe algorithm of the cryptographic key.
KeyBitsThe length of the key in bits.
KeyExportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
KeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyIDProvides access to a storage-specific key identifier.
KeyIVThe initialization vector (IV) of a symmetric key.
KeyKeyThe byte array representation of the key.
KeyNonceA nonce value associated with a key.
KeyPrivateReturns True if the object hosts a private key, and False otherwise.
KeyPublicReturns True if the object hosts a public key, and False otherwise.
KeySubjectReturns the key subject.
KeySymmetricReturns True if the object contains a symmetric key, and False otherwise.
KeyValidReturns True if this key is valid.
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.
EncryptEncrypts a buffer.
EncryptFileEncrypts a file.
EncryptFinalFinalization of encryption by blocks.
EncryptInitInitializes a per-block encryption process.
EncryptUpdateEncrypts 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.

ErrorReports errors during encryption or decryption.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the data encryption/decryption progress.

Configuration Settings


The following is a list of configuration 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.
TempPathPath for storing temporary files.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Node.js Edition - Version 20.0 [Build 8166]