Package Exports
- secure-flow
- secure-flow/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (secure-flow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
SecureFlow
The secure-flow provides the functionality for encrypting and decrypting text using the Node.js crypto module, with configurations loaded from a specified source.
Installation
npm install -g secure-flow
# or
yarn global add secure-flowUsage
A file named secureflow.config.ts or secureflow.config.cjs is created with the following content:
module.exports = {
encryptionAlgorithm: "aes-256-cbc",
encryptionKey: "your-32-character-encryption-key",
iv: Buffer.from("your-16-character-iv"),
};And you can import the encrypt or decrypt methods:
import { encrypt, decrypt } from "secure-flow";Example usage with Express
app.get("/encrypt", async (req, res) => {
const data = await JSON.stringify({ data: "Hello, World!" });
res.status(200).json(encrypt(data));
});
app.get("/decrypt", async (req, res) => {
const data = await req.body;
res.status(200).json(decrypt(data));
});Configuration
encryptionAlgorithm: The encryption algorithm used by SecureFlow. Default is 'aes-256-cbc'. encryptionKey: A 32-character string used as the encryption key. Replace 'your-32-character-encryption-key' with your actual encryption key. iv: Initialization Vector (IV) used for encryption. Should be a 16-character Buffer. Replace 'your-16-character-iv' with your actual IV.
License
This package is licensed under the MIT License.
Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request.
Bug Reports
If you find any issues with the package, please report them on the GitHub issues page.
Author
Adarsh M
GitHub: [Profile](https://github.com/adarshm07/)