js-x-ray @nodesecure/[email protected]
JavaScript & Node.js open-source SAST scanner. A static analyser for detecting most common malicious patterns π¬.
JS-X-Ray is a JavaScript & TypeScript SAST for identifying malicious patterns, security vulnerabilities, and code anomalies. Think of it as ESLint, but dedicated to security analysis. Originally created for NodeSecure CLI, JS-X-Ray has become an independent and serious option for supply chain protection.
π How It Works
JS-X-Ray parses JS or TS code into an Abstract Syntax Tree (AST) with no extensive usage of RegEx or Semgrep rules. This enables variable tracing, dynamic import resolution, and detection of sophisticated obfuscation that pattern-matching tools miss. The tradeoff is that JS-X-Ray is purely dedicated to the JavaScript/TypeScript ecosystem.
π‘ Features
- Track
require(),import, and dynamic imports with full variable tracing - Detect obfuscated code and identify the tool used (jsfuck, jjencode, obfuscator.io, and more)
- Flag malicious patterns: data exfiltration,
process.envserialization, unsafe shell commands - Detect vulnerable code:
eval(),Function()constructor, ReDoS-prone regexes, SQL injection - Flag weak cryptographic algorithms (MD5, SHA1, etc.)
- Extract infrastructure indicators: URLs, IPs, hostnames, emails
- Configurable sensitivity modes (conservative/aggressive) and extensible probe system
- Supports both JavaScript and TypeScript
π Getting Started
These packages are available in the Node package repository and can be easily installed with npm or yarn.
$ npm i @nodesecure/js-x-ray
# or
$ yarn add @nodesecure/js-x-ray
π Usage
import { AstAnalyser } from "@nodesecure/js-x-ray";
const scanner = new AstAnalyser();
const { warnings, dependencies } = await scanner.analyseFile("./file.js");
console.log(dependencies);
console.dir(warnings, { depth: null });
For the full API documentation, warning catalog, and advanced usage, see the @nodesecure/js-x-ray package README.
Workspaces
π₯ Contributors guide
If you are a developer looking to contribute to the project, you must first read the CONTRIBUTING guide.
Once you have finished your development, check that the tests (and linter) are still good by running the following script:
$ npm run check
[!CAUTION] In case you introduce a new feature or fix a bug, make sure to include tests for it as well.
Internal APIs
For contributors working on the JS-X-Ray internals, the following resources document low-level utilities and AST manipulation patterns:
- ESTree utilities - Low-level helpers to manipulate ESTree AST nodes
- ESTree assignment and declaration patterns (french) - Reference guide for JavaScript assignment and declaration patterns in AST form
Benchmarks
The performance of js-x-ray is measured and tracked using mitata.
To run the benchmarks:
- Navigate to
workspaces/js-x-ray. - Run
npm run bench.
The benchmark results are stored in workspaces/js-x-ray/benchmark/report.json. Do not edit this file manually; it is automatically updated on every pull request.
Contributors β¨
Thanks goes to these wonderful people (emoji key):
License
MIT