Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.75 KB

README.md

File metadata and controls

41 lines (32 loc) · 1.75 KB
Raw

nano-aes

Simple & lightweight AES (Advanced Encryption Standard) module. Wrapper for Node.js crypto module.

Features:

  • Supports CBC, CTR, and GCM mode.
  • Supports 128, 192, and 256 key sizes/length.
  • Uses a secure randomized IV from a cryptographically strong pseudorandom data
  • Lightweight with no dependencies (With only ~9.9kB of unpacked size!)
  • Easy to use
  • Supported both from ESM and CommonJS (We bundle for both)
  • Backwards compatible down to Node.js v14 and even v12! *1

Example

const { NanoAES } = require("nano-aes");
// or with ESM
import { NanoAES } from "nano-aes";

// In this case, the key is a string, so it's 24 bytes long (192 bits)
const AESCipher = new NanoAES({ key: "abcdefghijklmnopqrstuvwx", mode: "ctr" });
// Or you can a random key generate from the static method
const AESCipher = new NanoAES({ key: NanoAES.generateKey(192), mode: "ctr" });
// Or use a Buffer
const AESCipher = new NanoAES({ key: Buffer.from("6162636465666768696a6b6c6d6e6f707172737475767778", "hex"), mode: "ctr"})
// Or use a KeyObject directly
const AESCipher = new NanoAES({ key: crypto.createSecretKey("abcdefghijklmnopqrstuvwx", "utf8"), mode: "ctr" });

const encrypted = AESCipher.encrypt("Hello World!").toString("hex");
const decrypted = AESCipher.decrypt(Buffer.from(encrypted, "hex")).toString("utf8");

console.log(encrypted); // [Some Encrypted Data]
console.log(decrypted); // Hello World!

Footnote

*1 The officially supported Node.js version is from v14, but you can still use this module in Node.js v12. But it is not recommended.

Node.js v12 are EOL and doesn't receive OpenSSL updates, which what node:crypto module used, which means no security updates.

See what OpenSSL version your Node.js is linked to with process.versions.openssl