Skip to content
This repository has been archived by the owner on Jan 14, 2019. It is now read-only.

shiny/egg-cipher

Repository files navigation

egg-cipher

Cipher for egg.

Install

npm i egg-cipher --save

Edit config/plugin.js

exports.cipher = {
  enable: true,
  package: 'egg-cipher',
};

Examples

const letter = "Across the Great Wall we can reach every corner in the world.";
const encryptedLetter = this.app.cipher.encrypt(letter);
const decryptedLetter = this.app.cipher.decrypt(letter);
console.log(letter, encryptedLetter, decryptedLetter);

TTL for encrypted data: expire after one hour

const letter = "Across the Great Wall we can reach every corner in the world.";
const encryptedLetter = this.app.cipher.encrypt({ data: letter, ttl: 3600 });
const decryptedLetter = this.app.cipher.decrypt(letter);
console.log(letter, encryptedLetter, decryptedLetter);

config

config/config.default.js

config.cipher = {
  client: {
    // required, passphrase is the encoding key
    passphrase: 'nKJzOSeabeaOsIV4cK3H0lEO07U4DzGf',
    // default bf-cbc
    cipher: 'bf-cbc',
    // default input encoding: utf-8
    inputEncoding: 'utf8',
    // default output encoding: hex
    outputEncoding: 'hex',
    // default ttl:0, means never expires.
    defaultTTL: 0,
    // default iv length 8 for bf-cbc 
    ivLength: 8
  },
};

License

MIT

About

Cipher for egg

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published