Code Monkey home page Code Monkey logo

node-nscrypto's Introduction

node-nscrypto

Wrapper around nscrypto-cpp.

Build Status

PREREQUISITES

  • A relatively recent Node or io.js version (tested with [email protected][02] and io.js@latest).
  • A C++11 compiler.
  • A recent OpenSSL library. If you're on Mac OS X: Apple has deprecated OpenSSL in favor of its own TLS and crypto libraries, and you should look at Homebrew to install a recent OpenSSL version.

INSTALLATION

From the NPM repository:

$ npm install nscrypto

From Github (don't rely on this for stability):

$ npm install nowsecure/node-nscrypto

Or clone the repository and build it directly:

$ git clone https://github.com/nowsecure/node-nscrypto.git
$ cd node-nscrypto
$ npm install

For installations on Mac OS X, the default assumption is that you use a Homebrew-installed OpenSSL library that is installed in /usr/local/opt/openssl/. If you have OpenSSL installed somewhere else, you can override the library and include paths:

$ env OPENSSL_INCLUDE_DIR=/path/to/include/dir OPENSSL_LIB_DIR=/path/to/lib/dir npm install nscrypto

API

All API calls require the nscrypto module to be loaded:

var nscrypto = require('nscrypto');

Key generation (ref)

nscrypto.generateKeyPair() : Object

The returned object has two properties of type Buffer:

  • public: the generated public key
  • private: the generated private key

Encryption (ref)

nscrypto.{client,server}.encrypt(
  sPriv     : Buffer,
  rPub      : Buffer,
  sId       : String,
  rId       : String,
  plaintext : Buffer
) : Object

Returned object has two properties:

  • enc: the encrypted data
  • eph: the ephemeral key

Decryption (ref)

nscrypto.{client,server}.decrypt(
  rPriv     : Buffer,
  sPub      : Buffer,
  sId       : String,
  rId       : String,
  encrypted : Object
) : Buffer

message is an object as the one returned by the encryption functions, having enc and eph properties.

The returned Buffer is the decrypted plaintext.

CHANGELOG

  • 1.1.0 : Make OpenSSL library/include paths overridable on Mac OS X
  • 1.0.0 : Initial release

SEE ALSO

nscrypto-cpp

AUTHOR

Robert Klep <[email protected]>

LICENCE

See LICENSE.md.

node-nscrypto's People

Contributors

robertklep avatar

Stargazers

David Weinstein avatar Matt Dorn avatar Joseph Crosland avatar Chris Allen Lane avatar Andrey Belenko avatar Pau Oliva avatar Dean Landolt avatar Andrew Hoog avatar  avatar heapwolf avatar Julian Gruber avatar

Watchers

heapwolf avatar James Cloos avatar  avatar Andrew Hoog avatar Russel Waters avatar Nora The Narwhal avatar  avatar

Forkers

pkdevboxy

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.