Notorious Penguin Magicians

    ezcryption

    1.0.4 • Public • Published

    A text encryption library that has two functions currently:

    1. Easy encryption (makes letter "a" to letter "f".)
    2. Encryption with a password(AES) (Requires node.js version 15.0.0 and up.)

    Installation

    npm install ezcryption
    

    Usage

    Easy encryption

    import Spoiler from "ezcryption/dist/spoiler";
    
    Spoiler.encrypt("This is a secret message"); // Ymnx%25nx%25f%25xjhwjy%25rjxxflj
    Spoiler.decrypt("Ymnx%25nx%25f%25xjhwjy%25rjxxflj"); // This is a secret message

    Encryption with a password(AES)

    Returns a promise.

    import Aes from "ezcryption/dist/aes";
    
    async function myFunction() {
      const encrypted = await Aes.encrypt("This is a secret message", "password");
      // 163e231e179e74e123e207e37e34e112e154e33e98e82e216e36e56e211e181e173e232e238e10e81e134e207e99e68e193e98e215e248e166
    
      const decrypted = Aes.decrypt(
        "163e231e179e74e123e207e37e34e112e154e33e98e82e216e36e56e211e181e173e232e238e10e81e134e207e99e68e193e98e215e248e166",
        "password"
      ); // This is a secret message
    }

    Optional

    These options are not required but for more flexibility.

    Encryption with a password(AES) options:

    Add an object as a third parameter {options:{iv: customIv, salt: customSalt}}

    • iv: Initialization vector for Aes. An array that contains 16 integer between 0 to 255 value range
    • salt: A string for PBKDF2(key derivation function)

    Example:

    import Aes from "ezcryption/dist/aes";
    
    const customIv = new Uint8Array([
      4, 214, 15, 14, 139, 254, 2, 1, 28, 19, 204, 14, 15, 0, 5, 6,
    ]);
    const customSalt = "custom salt";
    
    async function myFunction() {
      const encrypted = await Aes.encrypt("This is a secret message", "password", {
        options: { iv: customIv, salt: customSalt },
      }); // 78e173e11e207e148e208e76e35e47e68e75e19e93e55e76e57e111e136e150e77e44e89e69e104e110e131e196e154e32e22e39e220
    
      const decrypted = await Aes.decrypt(
        "78e173e11e207e148e208e76e35e47e68e75e19e93e55e76e57e111e136e150e77e44e89e69e104e110e131e196e154e32e22e39e220",
        "password",
        {
          options: { iv: customIv, salt: customSalt },
        }
      ); // This is a secret message
    }

    Install

    npm i ezcryption

    DownloadsWeekly Downloads

    9

    Version

    1.0.4

    License

    GPL-3.0-or-later

    Unpacked Size

    31.8 kB

    Total Files

    12

    Last publish

    Collaborators

    • enesklmc