Skip to content

Latest commit

 

History

History
183 lines (128 loc) · 4.72 KB

README.md

File metadata and controls

183 lines (128 loc) · 4.72 KB
Raw

cryptian Build & Test FOSSA Status

MCrypt compatible crypto wrapper for Node.js

Install

Using NPM

npm install --save cryptian

Using Yarn

yarn add cryptian

Basic Usage With Transform Stream Support

Check out the test folder to find out the different ways to use it.

Block Algorithm Encryption

const fs = require('fs');
const {default: {algorithm, mode}, padding, createEncryptStream} = require('cryptian');

const key = Buffer.from('0a0c0e1012141618', 'hex');
const iv = Buffer.from('ca40f5af0b1aeea2', 'hex');

const des = new algorithm.Des();
des.setKey(key);

const cipher = new mode.cbc.Cipher(des, iv);

fs.createReadStream('test.png')
    .pipe(createEncryptStream(cipher, padding.Pkcs5))
    .pipe(fs.createWriteStream('test.png.encrypted'));

Block Algorithm Decryption

const fs = require('fs');
const {default: {algorithm, mode}, padding, createDecryptStream} = require('cryptian');

const key = Buffer.from('0a0c0e1012141618', 'hex');
const iv = Buffer.from('ca40f5af0b1aeea2', 'hex');

const des = new algorithm.Des();
des.setKey(key);

const cipher = new mode.cbc.Decipher(des, iv);

fs.createReadStream('test.png.encrypted')
    .pipe(createDecryptStream(cipher, padding.Pkcs5))
    .pipe(fs.createWriteStream('test-decrypted.png'));

Available Crypto Algorithms

All the following crypto algorithms ported from libmcrypt

Block Cipher

  • Blowfish
  • CAST-128
  • CAST-256
  • DES
  • GOST
  • LOKI97
  • RC2
  • Rijndael-128 (AES-128)
  • Rijndael-192
  • Rijndael-256
  • SAFER
  • SAFER+
  • 3-Way
  • 3DES
  • XTEA

Basic Usage

const assert = require('assert');
const {default: {algorithm}} = require('cryptian');
const des = new algorithm.Des();

des.setKey(Buffer.from('0a0c0e1012141618', 'hex'));

const ciphertext = Buffer.from('a1502d70ba1320c8', 'hex');
const plaintext  = Buffer.from('0001020304050607', 'hex');

assert(ciphertext.equals(des.encrypt(plaintext)), 'encrypted plaintext should equal to ciphertext');
assert(plaintext.equals(des.decrypt(ciphertext)), 'decrypted ciphertext should equal to plaintext');

Stream Cipher

  • RC4 (Arcfour)
  • Enigma
  • WAKE

Basic Usage

const assert = require('assert');
const {default: {algorithm}} = require('cryptian');

const enigma = new algorithm.Enigma();

enigma.setKey(Buffer.from('enadyotr', 'ascii'));

const ciphertext = Buffer.from('f3edda7da20f8975884600f014d32c7a08e59d7b', 'hex');
const plaintext  = Buffer.from('000102030405060708090a0b0c0d0e0f10111213', 'hex');

assert(ciphertext.equals(enigma.encrypt(plaintext)), 'encrypted plaintext should equal to ciphertext');
assert(plaintext.equals(enigma.decrypt(ciphertext)), 'decrypted ciphertext should equal to plaintext');

Available Block Cipher Mode Algorithms

All the following block cipher mode algorithms ported from libmcrypt

  • CBC
  • PCBC
  • CFB (CFB8)
  • CTR
  • ECB
  • NCFB
  • NOFB
  • OFB (OFB8)

Basic Usage

const assert = require('assert');
const {default: {algorithm, mode}} = require('cryptian');

const plaintext  = Buffer.from('88cc3d134aee5660f7623cf475fe9df20f773180bd70b0ef2aae00910ba087a1', 'hex');
const ciphertext = Buffer.from('ace98b99e6803c445b8bb76d937ea1b654fc86ed2e0e11597e52867c25ae96f8', 'hex');

const iv = Buffer.from('2425b68aac6e6a24', 'hex');

// don't use Dummy algorithm in real production environment 
// because this is not an encryption algorithm
const dummy = new algorithm.Dummy(); 

const cipher = new mode.cbc.Cipher(dummy, iv);
assert(ciphertext.equals(cipher.transform(plaintext)), 'transformed plaintext should be equal to ciphertext');

const decipher = new mode.cbc.Decipher(dummy, iv);
assert(plaintext.equals(decipher.transform(ciphertext)), 'transformed ciphertext should be equal to plaintext');

Available Block Cipher Padding Algorithms

  • ANSI-x923
  • ISO-10126
  • ISO-7816
  • NULL bytes
  • PKCS5
  • PKCS7
  • Space character bytes

Basic Usage

const assert = require('assert');
const {padding} = require('cryptian');

const padder = new padding.Pkcs5(8);
const padded = Buffer.from('0575ba559d030303', 'hex');
const unpadded = Buffer.from('0575ba559d', 'hex');

assert(padded.equals(padder.pad(unpadded)));
assert(unpadded.equals(padder.unpad(padded)));

License

FOSSA Status