nodejs / webcrypto Goto Github PK

This repository has been archived. The WebCrypto API has been implemented in recent versions of Node.js and does not require additional packages.

JavaScript 100.00%

webcrypto's Introduction

WebCrypto Prototype for Node.js

This is a partial and experimental WebCrypto implementation for the Node.js platform.

Asynchonicity

The WebCrypto specification requires almost all operations to be completed asynchronously, however, Node.js implements very few operations asynchronously. Usually, this is not a problem, since most cryptographic functions are incredibly fast compared to the overhead that comes with asynchronicity, and because Node.js implements most cryptographic features through efficient streaming interfaces. WebCrypto has no streaming interfaces but only one-shot APIs. Encrypting, hashing, signing or verifying large amounts of data is thus difficult in WebCrypto without underlying asynchronous APIs.

Development

Structure

The main export of this package is implemented in lib/index.js and represents the Crypto interface as defined in section 10 of the WebCrypto specification. It contains two members:

The subtle attribute is implemented in lib/subtle.js, including all methods described in section 14.3 of the WebCrypto specification. These methods usually delegate work to one or more cryptographic operations that are listed in section 18.2.2 and implemented in lib/algorithms/.
The getRandomValues function is implemented in lib/random.js.

Tests

The test directory contains a small number of unit tests. All of these tests are required to pass after each commit. You can run unit tests using npm test.

A coverage report can be generated using the command npm run coverage.

A subset of web-platform-tests can also be used for testing. The test/wpt/wpt submodule must be initialized in order to use them. You can run the WPTs using npm run wpt. Proposed changes do not need to pass all WPTs, but they should not break tests that passed without the changes.

Linting

This repository uses ESLint. Use npm run lint to check the code.

webcrypto's People

Contributors

Stargazers

Watchers

Forkers

tniessen palem1988 jrots akayy2020 bukinoshita helpse evolv-ai dominykas isabella232 nirvananimbusa 0xo0o0 global-localhost global19 global19-atlassian-net cleancoindev lesmemes

webcrypto's Issues

Add support for RSA-PKCS1-v1_5

Specified in section 20.

feature request: exposing crypto interface directly

I wrote a simple test that erred:

const crypto = require("webcrypto");
var iv = crypto.getRandomValues(new Uint8Array(16))
console.log(iv)

turns out I should do this:

const crypto = require("webcrypto");
var iv = crypto.crypto.getRandomValues(new Uint8Array(16))
console.log(iv)

compared to the straightforward interface provided by trust-webcrypto

const crypto = require("@trust/webcrypto");
var iv = crypto.getRandomValues(new Uint8Array(16))
console.log(iv)

I think it's more intuitive to provide crypto object directly.

Add support for RSA-PSS

Specified in section 21.

Use WPT tests

There is a sizable test suite for WebCrypto in https://github.com/web-platform-tests/wpt/tree/master/WebCryptoAPI.

We have some infrastructure for running WPT in https://github.com/nodejs/node/tree/master/test/wpt and https://github.com/nodejs/node/blob/master/test/common/wpt.js

Tracking issue: Bugs in web-platform-tests

List of web-platform-tests that seem to fail due to bugs in web-platform-tests:

derive_bits_keys/hkdf.js: Tests that illegal hash function names throw a NotSupportedError, but seems to miss the required BufferSource info, leading to a TypeError instead of a NotSupportedError according to WebIDL.
derive_bits_keys/hkdf.js: Tests that passing null as the length throws a TypeError, but WebIDL allows passing null and interprets it as 0, so it should likely be an OperationError instead.

How to install this package?

It seems like this package doesn't publish on the npm. When I try to install via git, yarn add git://github.com/nodejs/webcrypto --ignore-scripts -D, it reports error Can't add undefined: invalid package version undefined.

JWK support for ecdsa

In ecdsa.js, it seems like importKey is ignoring the JWK parameter and import the key as a buffer therefore throw an error

Imported RSA keys should have modulusLength and publicExponent

Generated RSA keys correctly set key.algorithm to an object with modulusLength and publicExponent properties. However, imported RSA keys are missing these properties since there is no easy way to determine them based on a KeyObject.

This could also be solved via nodejs/node#26854.

Add JWK support to RSA

This won't be possible (without manually parsing DER) as long as node does not provide an API to extract relevant fields from keys and to construct keys from said fields.

Previous discussion in nodejs/node#26854.

Add support for HMAC

Specified in section 29.

Add support for ECDSA

Specified in section 23.

RSA needs to distinguish between RSA keys with different OIDs and parameters

WebCrypto requires implementations to be able to distinguish between the OIDs rsaEncryption, sha1WithRSAEncryption, sha256WithRSAEncryption, sha384WithRSAEncryption, sha512WithRSAEncryption, id-RSAES-OAEP and id-RSASSA-PSS, and for the last two, we even need access to the ASN.1 parameters.

This is currently not possible using the KeyObject API.