als-crypt v4.0.1

als-crypt

Install:

npm install als-crypt

Initialize:

als-crypt provides a straightforward API for encrypting and decrypting data, supporting predefined cryptographic standards. During initialization, if a secret key does not exist, it is automatically generated and stored in a specified file, or by default, in a file named secret located within the package directory.

Customize the initialization by passing an options object, which may include settings for the algorithm, IV length, and the path to the secret key file. The key length is predefined based on the chosen algorithm to ensure security compliance.

const Crypt = require('als-crypt');
const options = {
  algorithm: 'aes-256-cbc', // Default is 'aes-256-cbc'
  ivLength: 16,             // Default is 16, suitable for most AES modes
  secretFilePath: '/path/to/your/secret'  // Default is './secret' within the package directory
};
const crypt = new Crypt(options);

For default settings just use :

const Crypt = require('als-crypt');
const crypt = new Crypt();

Error Handling

If options are invalid, or the existing key does not fit the options, an error will be thrown. Handle these errors to prevent runtime exceptions:

try {
  const crypt = new Crypt(badOptions);
} catch (error) {
  console.error('Failed to initialize Crypt:', error.message);
}

Usage

Encrypting and Data

const secretMessage = 'Hello world!';
const encryptedData = crypt.encrypt(secretMessage);
console.log(encryptedData); // Outputs encrypted data in hex format
const decryptedMessage = crypt.decrypt(encryptedData);
console.log(decryptedMessage); // Output: 'Hello world!'

Security Notes

The security of the encryption depends significantly on the secrecy and integrity of the key file. Ensure this file is stored in a secure location and access is strictly controlled. For environments requiring enhanced security measures, consider integrating more robust key management solutions or storing the key in a hardware security module (HSM).