Cryptor - AES Blob
Class Name |
AesBlob |
|---|---|
Implements |
|
Extends |
|
Source |
|
Examples |
The AES Blob cryptor encodes and decodes content with aes-cbc.
constructor
new AesBlob(options);
Creates a new AesBlob instance.
Parameters
options-AesBlobOptions: options for AesBlob constructor.dfs-DfsInterface:DfsInterfaceinstancelog-Function(optional): function to use for logging:(message, level) => {...}logLevel-LogLevel(optional): messages with this level will be logged withloglogLog-LogLogInterface(optional): container for collecting log messageslogLogLevel-LogLevel(optional): messages with this level will be pushed tologLog
Returns
AesBlob instance
Example
const aesBlob = new AesBlob({
dfs
});
getCryptoInfo
cryptor.getCryptoInfo(originator);
create new crypto info for this cryptor
Parameters
originator-string: originator or context of the encryption
Returns
CryptoInfo: details about encryption for originator with this cryptor.
Example
const cryptor = new AesBlob();
const cryptoInfo = cryptor.getCryptoInfo('0x123');
generateKey
cryptor.generateKey();
generate key for cryptor/decryption
Returns
Promise resolves to string: key used for encryption.
Example
const cryptor = new AesBlob();
const cryptoInfo = cryptor.generateKey();
encrypt
cryptor.encrypt(message, options);
‘encrypt’ a message (serializes message)
Parameters
message-string: message which should be encryptedoptions-any: cryptor optionskey-string: key used for encryption
Returns
Promise resolves to string: encrypted message.
Example
const cryptor = new AesBlob();
const cryptoInfo = cryptor.encrypt('Hello World', { key: '0x12345' });
decrypt
cryptor.decrypt(message, options);
‘decrypt’ a message (deserializes message)
Parameters
message-Buffer: message which should be decryptedoptions-any: cryptor optionskey-string: key used for encryption
Returns
Promise resolves to any: decrypted message.
Example
const cryptor = new AesBlob();
const cryptoInfo = cryptor.decrypt('afeweq41f1e61e3f', { key: '0x12345' });