Package Health Score

83 / 100

security
No known security issues
popularity
Influential project
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.4.6	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.3	\|	03/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.3	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.3	\|	11/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.7	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (3,236,339)

GitHub Stars: 176
Forks: 22
Contributors: 7

Direct Usage Popularity

The npm package @peculiar/webcrypto receives a total of 3,236,339 downloads a week. As such, we scored @peculiar/webcrypto popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package @peculiar/webcrypto, we found that it has been starred 176 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 7
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @peculiar/webcrypto is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 14
Open PR: 0
Last Release: 21 days ago
Last Commit: 21 days ago

Further analysis of the maintenance status of @peculiar/webcrypto based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @peculiar/webcrypto demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10.12.0

Age: 5 years
Dependencies: 5 Direct
Versions: 53
Install Size: 192 kB
Dist-tags: 1
# of Files: 6
Maintainers: 6
TS Typings: Yes

@peculiar/webcrypto has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @peculiar/webcrypto?

To help you get started, we've collected the most common ways that @peculiar/webcrypto is being used within popular public projects.

PeculiarVentures / webcrypto-liner / test / utils / init.ts View on Github

import { Crypto } from "@peculiar/webcrypto";
import { Crypto as WebCrypto, setCrypto } from "../../src";

const crypto = new Crypto();
const nativeGenerateKey = crypto.subtle.generateKey;
const nativeExportKey = crypto.subtle.exportKey;

// asmCrypto doesn't have key generation function and uses native generateKey with RSA-PSS
crypto.subtle.generateKey = async function () {
  if (arguments[0]?.name !== "RSA-PSS") {
    throw new Error("Function is broken for test cases");
  }
  return nativeGenerateKey.apply(this, arguments);
};

// asmCrypto doesn't have key generation function and uses native exportKey with RSA-PSS
crypto.subtle.exportKey = async function () {
  if (!(
    (arguments[0] === "pkcs8"
      || arguments[0] === "spki")

View more ways to use @peculiar/webcrypto

@peculiar/webcrypto

test

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 @peculiar/webcrypto.

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.

Module is based on NodeJS v10 Crypto API. It would work only with Node v10 and higher.

Installing

npm install @peculiar/webcrypto

Supported algorithms

Algorithm name	generateKey	digest	export/import	sign/verify	encrypt/decrypt	wrapKey/unwrapKey	derive
SHA-1		X
SHA-256		X
SHA-384		X
SHA-512		X
HMAC	X		X	X
RSASSA-PKCS1-v1_5	X		X	X
RSAES-PKCS1-v1_5²	X		X		X	X
RSA-PSS	X		X	X
RSA-OAEP	X		X		X	X
AES-CMAC	X		X	X
AES-CBC	X		X		X	X
AES-CTR	X		X		X	X
AES-ECB	X		X		X	X
AES-GCM	X		X		X	X
AES-KW	X		X			X
ECDSA¹	X		X	X
ECDH¹	X		X				X
EdDSA^2,3	X		X	X
ECDH-ES^2,4	X		X				X
HKDF			X				X
PBKDF2			X				X
DES-CBC²	X		X		X	X
DES-EDE3-CBC²	X		X		X	X
shake128²		X
shake256²		X

¹ Mechanism supports extended list of named curves P-256, P-384, P-521, K-256, brainpoolP160r1, brainpoolP160t1, brainpoolP192r1, brainpoolP192t1, brainpoolP224r1, brainpoolP224t1, brainpoolP256r1, brainpoolP256t1, brainpoolP320r1, brainpoolP320t1, brainpoolP384r1, brainpoolP384t1, brainpoolP512r1, and brainpoolP512t1

² Mechanism is not defined by the WebCrypto specifications. Use of mechanism in a safe way is hard, it was added for the purpose of enabling interoperability with an existing system. We recommend against its use unless needed for interoperability.

³ Mechanism supports extended list of named curves Ed25519, and Ed448

⁴ Mechanism supports extended list of named curves X25519, and X448

Using

const { Crypto } = require("@peculiar/webcrypto");

const crypto = new Crypto();

Examples

See WebCrypto Docs for examples

Bug Reporting

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

@peculiar/webcrypto dependencies

@peculiar/asn1-schema @peculiar/json-schema pvtsutils tslib webcrypto-core

@peculiar/webcrypto development dependencies

@peculiar/webcrypto-test @types/mocha @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-plugin-import mocha rimraf rollup rollup-plugin-typescript2 ts-node typescript

FAQs

What is @peculiar/webcrypto?

A WebCrypto Polyfill for NodeJS. Visit Snyk Advisor to see a full health score report for @peculiar/webcrypto, including popularity, security, maintenance & community analysis.

Is @peculiar/webcrypto popular?

The npm package @peculiar/webcrypto receives a total of 3,236,339 weekly downloads. As such, @peculiar/webcrypto popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @peculiar/webcrypto well maintained?

We found that @peculiar/webcrypto demonstrated a healthy version release cadence and project activity. It has a community of 7 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @peculiar/webcrypto safe to use?

The npm package @peculiar/webcrypto was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 18 April-2024, at 08:12 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP