Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

node-webcrypto-ossl

Package Overview
Dependencies
Maintainers
2
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

node-webcrypto-ossl

A WebCrypto Polyfill for Node in TypeScript built on OpenSSL

  • 1.0.21
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
728
decreased by-20.7%
Maintainers
2
Weekly downloads
 
Created
Source

node-webcrypto-ossl

License Build Status Coverage Status NPM version

NPM

We wanted to be able to write Javascript that used crypto on both the client and the server but we did not want to rely on Javascript implementations of crypto. The only native cryptography available in browser is Web Crypto, this resulted in us creating a node-webcrypto-ossl a native polyfill for WebCrypto based on OpenSSL.

Table Of Contents

WARNING

At this time this solution should be considered suitable for research and experimentation, further code and security review is needed before utilization in a production application.

Installation

npm

npm install node-webcrypto-ossl;

Clone Repo

git clone https://github.com/PeculiarVentures/node-webcrypto-ossl
cd node-webcrypto-ossl

Install

npm install

Test

mocha

Supported algorithms

Algorithm namegenerateKeydigestexport/importsign/verifyencrypt/decryptwrapKey/unwrapKeyderive
SHA-1X
SHA-256X
SHA-384X
SHA-512X
RSASSA-PKCS1-v1_5XXX
RSA-PSSXXX
RSA-OAEPXXXX
AES-CBCXXXX
AES-GCMXXXX
AES-KWXXX
ECDSAXXX
ECDHXXX
HMACXXX
PBKDF2XX

Using

var WebCrypto = require("node-webcrypto-ossl");

var webcrypto = new WebCrypto();

KeyStorage

To use KeyStorage you should init WebCrypto with directory option. If directory option is missing then keyStorage is null

var WebCrypto = require("node-webcrypto-ossl");

var webcrypto = new WebCrypto({
  directory: "key_storage"
})

KeyStorage implements interface of W3 Storage

var keyStorage = webcrypto.keyStorage;

// generating RSA key
webcrypto.subtle.generateKey({
    name: "RSASSA-PKCS1-v1_5",
    modulusLength: 1024,
    publicExponent: new Uint8Array([1, 0, 1]),
    hash: {
      name: "SHA-1"
    }
  },
    false,
    ["sign", "verify"]
  )
  .then(function(keyPairs){
    /** 
     * saving private RSA key to KeyStorage
     * creates file ./key_storage/prvRSA-1024.json
     */
    keyStorage.setItem("prvRSA-1024", keyPairs.privateKey);
  })

To get key from KeyStorage

var rsaKey = webcrypto.getItem("prvRSA-1024");

Threat Model

The threat model is defined in terms of what each possible attacker can achieve.

Assumptions

TODO: ADD ASSUMPTIONS

Threats From A node-webcrypto-ossl Defect

TODO: ADD THREATS FROM NODE-WEBCRYPTO-OSSL DEFECT

Threats From Weak Cryptography

TODO: ADD THREATS FROM WEAK CRYPTOGRAPHY

Threats From Improper Use Of Cryptography

TODO: ADD THREATS FOR IMPROPER USE OF CRYPTOGRAPHY

Bug Reporting

Please report bugs either as pull requests or as issues in the issue tracker. node-webcrypto-ossl has a full disclosure vulnerability policy. Please do NOT attempt to report any security vulnerability in this code privately to anybody.

Keywords

FAQs

Package last updated on 14 Mar 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc