npmpackage.info

Gathering detailed insights and metrics for bigint-crypto-utils

bigint-crypto-utils

Utils for working with cryptography using native JS implementation of BigInt. It includes arbitrary precision modular arithmetics, cryptographically secure random numbers and strong probable prime generation/testing. It works with Node.js, and native JS, including React and Angular

3.3.0

MIT

JavaScript

3.02 kB

14,485,999 2.8

Installations

npm install bigint-crypto-utils

Pull Requests

Open

1

Total

9

Closed

5

Merged

3

Issues

Open

1

Total

10

Closed

9

Releases

Unable to fetch releases

Developer

juanelas

Developer Guide

BETA

Module System

ESM, UMD

Min. Node Version

>=14.0.0

Typescript Support

Yes

Node Version

18.16.1

NPM Version

9.5.1 Statistics

37 Stars

259 Commits

3 Forks

4 Watching

3 Branches

4 Contributors

Updated on 01 Jun 2024

Bundle Size

8.44 kB

Minified

3.02 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (55.69%)

TypeScript (44.31%)

Total Downloads

Cumulative downloads

Total Downloads

14,485,999

Last day

47.8%

21,339

Compared to previous day

Last week

39.2%

109,734

Compared to previous week

Last month

4.7%

440,483

Compared to previous month

Last year

-21.1%

5,966,369

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

bigint-crypto-utils

Arbitrary precision modular arithmetic, cryptographically secure random numbers and strong probable prime generation/testing.

It relies on the native JS implementation of (BigInt). It can be used by any Web Browser or webview supporting BigInt and with Node.js (>=10.4.0). The bundles can be imported directly by the browser or in Angular projects, React apps, Node.js, etc.

Secure random numbers are generated using the native crypto implementation of the browsers (Web Cryptography API) or Node.js Crypto. Strong probable prime generation and testing use Miller-Rabin primality tests and are automatically sped up using parallel workers both in browsers and Node.js.

The operations supported on BigInts are not constant time. BigInt can be therefore unsuitable for use in cryptography. Many platforms provide native support for cryptography, such as Web Cryptography API or Node.js Crypto.

Usage

bigint-crypto-utils can be imported to your project with npm:

1npm install bigint-crypto-utils

Then either require (Node.js CJS):

1const bigintCryptoUtils = require('bigint-crypto-utils')

or import (JavaScript ES module):

1import * as bigintCryptoUtils from 'bigint-crypto-utils'

The appropriate version for browser or node is automatically exported.

bigint-crypto-utils uses ES2020 BigInt, so take into account that:

If you experience issues using webpack/babel to create your production bundles, you may edit the supported browsers list and leave only supported browsers and versions. The browsers list is usually located in your project's package.json or the .browserslistrc file.

In order to use bigint-crypto-utils with TypeScript you need to set target, and lib and module if in use, to ES2020 in your project's tsconfig.json.

You can also download the IIFE bundle, the ESM bundle or the UMD bundle and manually add it to your project, or, if you have already installed bigint-crypto-utils in your project, just get the bundles from node_modules/bigint-crypto-utils/dist/bundles/.

An example of usage could be (complete examples can be found in the examples directory):

1/* A BigInt with value 666 can be declared calling the bigint constructor as
2BigInt('666') or with the shorter 666n.
3Notice that you can also pass a number to the constructor, e.g. BigInt(666).
4However, it is not recommended since values over 2**53 - 1 won't be safe but
5no warning will be raised.
6*/
7const a = BigInt('5')
8const b = BigInt('2')
9const n = 19n
10
11console.log(bigintCryptoUtils.modPow(a, b, n)) // prints 6
12
13console.log(bigintCryptoUtils.modInv(2n, 5n)) // prints 3
14
15console.log(bigintCryptoUtils.modInv(BigInt('3'), BigInt('5'))) // prints 2
16
17console.log(bigintCryptoUtils.randBetween(2n ** 256n)) // prints a cryptographically secure random number between 1 and 2**256 (both included).
18
19async function primeTesting (): void {
20  // Let us print out a probable prime of 2048 bits
21  console.log(await bigintCryptoUtils.prime(2048))
22
23  // Testing if number is a probable prime (Miller-Rabin)
24  const number = 27n
25  const isPrime = await bigintCryptoUtils.isProbablyPrime(number)
26  if (isPrime === true) {
27    console.log(`${number} is prime`)
28  } else {
29    console.log(`${number} is composite`)
30  }
31}
32
33primeTesting()
34

API reference documentation

Check the API

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:94: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:109: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/juanelas/bigint-crypto-utils/build-and-test.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/build-and-test.yml:53
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 3 out of 4 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

bigint-crypto-utils

Installations

Pull Requests

1

9

5

3

Issues

1

10

9

Releases

Unable to fetch releases

Developer

juanelas

Developer Guide

ESM, UMD

>=14.0.0

Yes

18.16.1

9.5.1

Statistics

Bundle Size

8.44 kB

3.02 kB

Languages

Total Downloads

14,485,999

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

bigint-crypto-utils

Usage

API reference documentation

10

10

10

4

0

0

0

0

0

0

0

0

0

2.8

/10