Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 1 KB

README.md

File metadata and controls

38 lines (32 loc) · 1 KB
Raw

supercrypt

A lightweight JavaScript library for symmetric encryption

Key features

  • optimized for binary / file encryption
  • uses crypto standard AES on 128b
  • includes HMAC authentication (EtA - Encrypt then Authenticate) for guaranteed message authenticity
  • written in ES5, ensuring high browser compatibility
  • works with node.js, for developing node.js or browser packages

Installation

Node.js:

npm install supercrypt

Usage

Modular include (using Node.js):

var supercrypt = require('supercrypt');

Using the library:

encryptor = new supercrypt({
    fileSize: 100, //bytes
    saveBlock: function(data, callback) {},
    readBlock: function(size, callback) {},
    progressHandler: function(progressPercentage) {},
    finishHandler: function() {}, //called on success
    errorHandler: function(errCode) {}, //called on error
});

var seedList = [1,2,3,4,5,6,7,8,9,0]; //random array of numbers
encryptor.encrypt('key', seedList);

API Documentation coming soon...