webcrypto-liner

v1.4.3

A WebCrypto polyfill that "smooths out" the rough-edges in existing User Agent implementations. For more information about how to use this package see README

Latest version published 9 months ago

License: MIT

NPM

GitHub

Package Health Score

62 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
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

All Versions

Version				Vulnerabilities	License Risk
1.4.3	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.1	\|	12/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.4	\|	03/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.38	\|	12/2018		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

Small

Weekly Downloads (6,926)

GitHub Stars: 149
Forks: 26
Contributors: -

Direct Usage Popularity

The npm package webcrypto-liner receives a total of 6,926 downloads a week. As such, we scored webcrypto-liner popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package webcrypto-liner, we found that it has been starred 149 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: 0
Funding: No

This project has seen only 10 or less contributors.

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

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 32
Open PR: 5
Last Release: 9 months ago
Last Commit: 9 months ago

Further analysis of the maintenance status of webcrypto-liner based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that webcrypto-liner demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: not defined

Age: 8 years
Dependencies: 11 Direct
Versions: 61
Install Size: 1.52 MB
Dist-tags: 2
# of Files: 12
Maintainers: 2
TS Typings: No

webcrypto-liner 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.

Readme

webcrypto-liner

test

A polyfill for WebCrypto that "smooths out" the rough-edges in existing User Agent implementations.

Though WebCrypto is well supported across browsers, several browsers still have prefixed and buggy implementations. Additionally, they do not always support the same algorithms, for example, Edge does not support SHA1 or ECC while both Firefox and Chrome do.

NOTE: If you are not familiar with how to use the various capabilities of WebCrypto see this great example page.

Browsers support

Edge	Firefox	Chrome	Safari
last 2 versions	last 2 versions	last 2 versions	last 2 versions

Information

webcrypto-liner is a wrapper for WebCrypto designed to address these issues, at the same time it was designed to be modular so that it can also be used for testing the addition of new algorithms to WebCrypto in the future.

Intentionally webcrypto-liner does not implement any cryptography though it does consume libraries that do. We strongly recommend you read "What’s wrong with in-browser cryptography?" before using this library.

The libraries webcrypto-liner relies on include:

Package	Description	Size	Optional
asmcrypto.js	A performant JavaScript implementation of popular cryptographic utilities with performance in mind.	131 KB	Yes
elliptic	Fast Elliptic Curve Cryptography in plain javascript	130 KB	Yes
webcrypto-core	A input validation layer for WebCrypto polyfills ¹	25 KB	No

^{1 This library is compiled into webcrypto-liner.}

webcrypto-liner will always try to use a native implementation of webcrypto, or a prefixed version of webcrypto, before it falls back to a Javascript implementation of a given algorithm. We have no control over the corresponding implementation and what it does, for example, it may not use window.crypto.getRandomValues even if it is available and the mechanism it uses to gather randomness may be both insecure and weak.

We have done no security review or take a position on the security of these third-party libraries. YOU HAVE BEEN WARNED.

To keep webcrypto-liner as small as possible (right now it is ~11kb without dependencies) it was designed to be modular, so if you do not need ECC support, do not include elliptic as a dependency and it will not be loaded.

If you do not load any of the dependencies that provide cryptographic implementations webcrypto-liner will work as an interoperability layer, very similar to webcrypto-shim.

webcrypto-liner supports the following algorithms and key lengths:

Capability	Details
Encryption/Decryption	RSA-OAEP, DES-CBC¹, DES-EDE3-CBC¹, AES-ECB ¹, AES-CBC, AES-ECB and AES-GCM
Sign/Verify	RSA-PSS, RSASSA_PKCS1-v1_5 and ECDSA
Hash	SHA-1, and SHA-256, SHA-512
Derive Key/Bits	ECDH, PBKDF2
Keywrap	AES-GCM, AES-CBC, AES-ECB ¹, DES-CBC¹, DES-EDE3-CBC¹
ECC Curves	P-256, P-384, P-521, and K-256² (secp256k1)
RSA Key Lengths	1024, 2048, 3072, and 4096
AES Key Lengths	128, 192 and 256

¹ 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.

² K-256 (secp256k1) curve is not defined by the WebCrypto specifications.

You can see the webcrypto-liner in use in the pv-webcrypto-tests page.

Using

Dependencies

typescript

npm install typescript --global

Installation

The module has been designed to be useful in ES6 and ES5 projects. The default is ES5 with commonjs, to install and build you would run:

npm install
npm run build

FAQ

Do I need to use a promise library? - No, not if your browser supports promises.
Do I need to include asmcrypto.js? No, not unless you want to use the algorithms it exposes.
Do I need to include elliptic.js? No, not unless you want to use the algorithms it exposes.
How are random numbers generated? We use two libraries for crypto operations in Javascript, asymcrypto and ellipticjs both rely on window.crypto.getRandomValues where available. asymcrypto also has a fallback mechanism where it generates its own random numbers if not present.
How big is the total package? Right now, if you include all optional dependencies (minfied) the package is ~300 KB, if you include only ECC or only RSA support that is lowered to about 180 KB. Additionally you will see GZIP compression provide about 30% savings above and beyond that. If you use webcrypto-liner as just an interopability shim and do not use any of the optional third-party libraries it will be under 44 KB in size.
Will it work in Node? No. It is compiles to pure Javascript but uses the window object so it wont work in Node at this time. With some minor changes it should also be able to work in Node also but you really should be using node-webcrypto-ossl on Node instead.

webcrypto-liner dependencies

@peculiar/asn1-schema @peculiar/json-schema @stablelib/sha3 asmcrypto.js asn1js core-js des.js elliptic pvtsutils tslib webcrypto-core

webcrypto-liner development dependencies

@babel/core @babel/preset-env @peculiar/webcrypto @rollup/plugin-babel @rollup/plugin-commonjs @rollup/plugin-node-resolve @types/mocha @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint babel-preset-minify mocha rimraf rollup rollup-plugin-terser rollup-plugin-typescript2 ts-node typescript

FAQs

What is webcrypto-liner?

A WebCrypto polyfill that "smooths out" the rough-edges in existing User Agent implementations. Visit Snyk Advisor to see a full health score report for webcrypto-liner, including popularity, security, maintenance & community analysis.

Is webcrypto-liner popular?

The npm package webcrypto-liner receives a total of 6,926 weekly downloads. As such, webcrypto-liner popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is webcrypto-liner well maintained?

We found indications that webcrypto-liner maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is webcrypto-liner safe to use?

The npm package webcrypto-liner 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 29 October-2024, at 20:01 (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

webcrypto-liner

A WebCrypto polyfill that "smooths out" the rough-edges in existing User Agent implementations. For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (6,926)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

webcrypto-liner

Browsers support

Information

Using

Dependencies

Installation

FAQ

Related

webcrypto-liner dependencies

webcrypto-liner development dependencies

FAQs

What is webcrypto-liner?

Is webcrypto-liner popular?

Is webcrypto-liner well maintained?

Is webcrypto-liner safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (6,926)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

webcrypto-liner

Browsers support

Information

Using

Dependencies

Installation

FAQ

Related

webcrypto-liner dependencies

webcrypto-liner development dependencies

FAQs

What is webcrypto-liner?

Is webcrypto-liner popular?

Is webcrypto-liner well maintained?

Is webcrypto-liner safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues