@makenowjust-labo/recheck

v3.1.0

A vulnerable RegExp (ReDoS) checker for JavaScript (ECMA-262) RegExp. For more information about how to use this package see README

Latest version published 4 years ago

License: MIT

NPM

GitHub

Package Health Score

55 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

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
3.1.0	\|	05/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.0	\|	02/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	02/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

Limited

Weekly Downloads (546)

GitHub Stars: 251
Forks: 12
Contributors: -

Direct Usage Popularity

The npm package @makenowjust-labo/recheck receives a total of 546 downloads a week. As such, we scored @makenowjust-labo/recheck popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @makenowjust-labo/recheck, we found that it has been starred 251 times.

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

Community

Sustainable

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 @makenowjust-labo/recheck is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 7
Open PR: 26
Last Release: 4 years ago
Last Commit: 2 months ago

Further analysis of the maintenance status of @makenowjust-labo/recheck based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @makenowjust-labo/recheck is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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

Age: 4 years
Dependencies: 0 Direct
Versions: 7
Install Size: 15.6 MB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: Yes

@makenowjust-labo/recheck 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

`@makenowjust-labo/recheck`

> A vulnerable RegExp (ReDoS) checker for JavaScript (ECMA-262) RegExp.

Installation

Uses the following command to install this library:

$ npm install @makenowjust-labo/recheck

Usage

This library exports only the API called check. It takes a RegExp pattern source and flags to be checked (and a configuration optionally), then it returns the analysis result.

const { check } = require("@makenowjust-labo/recheck");

console.log(check("^(a|a)*$", ""));
// {
//   status: 'vulnerable',
//   checker: 'automaton',
//   attack: {
//     pumps: [ { prefix: 'a', pump: 'a', bias: 0 } ],
//     suffix: '\x00',
//     base: 17,
//     string: 'aaaaaaaaaaaaaaaaaa\x00',
//     pattern: "'a' 'a'¹⁷ '\\x00'"
//   },
//   complexity: { type: 'exponential', summary: 'exponential', isFuzz: false }
// }

Configuration

A configuration parameter specifies as the 3rd argument of the check function.

console.log(check("^(a|a)*$", "", { timeout: 1000, checker: "fuzz" }));

The following parameters are available.

`timeout`

An integer value of timeout duration milliseconds. (default: undefined)

When undefined is specified, it means there is no timeout.

`checker`

A checker name to use. (default: 'hybrid')

There are three checkers:

'automaton': A checker which works based on automaton theory. It can analyze a ReDoS vulnerability of the RegExp without false positives, however, it needs some minutes against some RegExps and it does not support some syntax.
'fuzz': A checker based on fuzzing. It can detect a ReDoS vulnerability against all RegExp syntax including back-references and look-around assertions. However, it needs some seconds on average and it may cause false negatives.
'hybrid': A checker which combines the automaton based checker and the fuzz checker. If the RegExp is supported by the automaton based checker and some thresholds are passed, it uses the automaton based checker. Otherwise, it falls back to the fuzz checker.

The hybrid checker performs better than others in many cases.

Other parameters to specify detailed behavior

And, there are other parameters to specify detailed behavior. They are set to perform better as the default, so it is rare to specify them and it needs to know the checkers in depth to set the correct value.

`maxAttackSize`

An integer value of a maximum length of an attack string. (default: 4_000)

The checker finds a vulnerable string not to exceed this length.

`attackLimit`

An integer value of a limit of VM execution steps. (default: 100_000)

The checker assumes the RegExp is vulnerable when a string exists against which steps exceed the limit.

`randomSeed`

An integer value of seed for pseudo-random number generator in fuzzing. (default: undefined)

When undefined is specified, it uses a system default seed.

`seedLimit`

An integer value of a limit of VM execution steps on the seeding phase. (default: 1_000)

`incubationLimit`

An integer value of a limit of VM execution steps on the incubation phase. (default: 10_000)

`crossSize`

An integer value of the number of crossings on one generation. (default: 25)

`mutateSize`

An integer value of the number of mutations on one generation. (default: 50)

`maxSeedSize`

An integer value of a maximum size of a seed set. (default: 50)

`maxGenerationSize`

An integer value of a maximum size of a living population on one generation. (default: 100)

`maxIteration`

An integer value of a number of iterations on the incubation phase. (default: 30)

`maxDegree`

An integer value of a maximum degree to attempt on building an attack string. (default: 4)

`heatRate`

A rate of a hotspot steps by the maximum steps. (default: 0.001)

`usesAcceleration`

Whether to use acceleration or not on fuzzing. (default: true)

`maxRepeatCount`

An integer value of a limit of repetition count in the RegExp. (default: 20)

If the RegExp exceeds this limit on the hybrid checker, it switches to use the fuzz checker to analyze instead of the automaton based checker.

`maxNFASize`

An integer value of a maximum size of the transition function of NFA. (default: 40000)

If the NFA's transition function exceeds this limit on the hybrid checker, it switches to use fuzz checker to analyze instead of the automaton based checker.

`maxPatternSize`

An integer value of maximum size of the pattern. (default: 1500)

If the pattern size exceeds this limit on the hybrid checker, it switches to use fuzz checker to analyze instead of the automaton based checker.

License

MIT License.

2020-2021 (C) TSUYUSATO "MakeNowJust" Kitsune

FAQs

What is @makenowjust-labo/recheck?

A vulnerable RegExp (ReDoS) checker for JavaScript (ECMA-262) RegExp. Visit Snyk Advisor to see a full health score report for @makenowjust-labo/recheck, including popularity, security, maintenance & community analysis.

Is @makenowjust-labo/recheck popular?

The npm package @makenowjust-labo/recheck receives a total of 546 weekly downloads. As such, @makenowjust-labo/recheck popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @makenowjust-labo/recheck well maintained?

We found indications that @makenowjust-labo/recheck is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @makenowjust-labo/recheck safe to use?

The npm package @makenowjust-labo/recheck 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 21 November-2024, at 19:20 (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

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (546)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@makenowjust-labo/recheck

Installation

Usage

Configuration

timeout

checker

maxAttackSize

attackLimit

randomSeed

seedLimit

incubationLimit

crossSize

mutateSize

maxSeedSize

maxGenerationSize

maxIteration

maxDegree

heatRate

usesAcceleration

maxRepeatCount

maxNFASize

maxPatternSize

License

FAQs

What is @makenowjust-labo/recheck?

Is @makenowjust-labo/recheck popular?

Is @makenowjust-labo/recheck well maintained?

Is @makenowjust-labo/recheck 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

`@makenowjust-labo/recheck`

`timeout`

`checker`

`maxAttackSize`

`attackLimit`

`randomSeed`

`seedLimit`

`incubationLimit`

`crossSize`

`mutateSize`

`maxSeedSize`

`maxGenerationSize`

`maxIteration`

`maxDegree`

`heatRate`

`usesAcceleration`

`maxRepeatCount`

`maxNFASize`

`maxPatternSize`