crypto-lib
crypto-lib
npm i crypto-lib
crypto-lib

crypto-lib

A high level crypto module for node.js and the browser.

by whiteout-io

0.2.7 (see all)TypeScript:Not Found
npm i crypto-lib
Readme

crypto-lib Build Status

A high level crypto module for node.js and the browser. This library exposes a basic high level api, which combines the following low level operations:

  • UTF-8 plaintext encoding
  • item-key generation
  • initialization-vector generation
  • AES-GCM item encryption
  • Base64 ciphertext encoding

Checkout the Demo

Getting started - Node.js

Install and Test

npm install crypto-lib
cd node_modules/crypto-lib/
npm test

Example Code

var lib = require('crypto-lib');

var key = lib.util.random(128);
var iv = lib.util.random(128);

var ciphertext = lib.aes.encrypt('Hello, World!', key, iv);
var decrypted = lib.aes.decrypt(ciphertext, key, iv);

Getting started - HTML5:

  • To get started, check out the mocha browser tests. There is currently no require.js build for the client yet so you'll have to include the individual scripts by hands.
  • Has been tested to work on iOS, Chrome, Firefox, Safari and Internet Explorer 10.
  • For browsers that don't support window.crypto.getRandomValues(), forge's fortuna algorithm is used to generate pseudo random numbers.
  • The crypto operations should be done inside of a Web Worker thread to not block the main UI thread.
  • This video also gives some good pointers on how to secure your HTML5 app using Content Security Policy (CSP), sandboxed iframes and CORS in order to protect against XSS and other attacks.

License

licensed under the MIT license:

Copyright © 2013 Whiteout Networks GmbH.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The Library's uses crypto primitives from Forge by Digital Bazaar, Inc. which is licensed under BSD and GPL.

Downloads/wk

39

GitHub Stars

16

LAST COMMIT

7yrs ago

MAINTAINERS

2

CONTRIBUTORS

2

OPEN ISSUES

1

OPEN PRs

0
VersionTagPublished
0.2.7
latest
7yrs ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate