https://github.com/sandworm-hq/sandworm-guard-js
Easy auditing & sandboxing for your JavaScript dependencies 🪱
https://github.com/sandworm-hq/sandworm-guard-js
audit compartments compliance dependencies dependency-analysis dynamic-analysis hardening intercept lockdown permission permissions sandbox security security-audit security-tools ses supply-chain vulnerability-scanners zero-trust
Last synced: 6 months ago
JSON representation
Easy auditing & sandboxing for your JavaScript dependencies 🪱
- Host: GitHub
- URL: https://github.com/sandworm-hq/sandworm-guard-js
- Owner: sandworm-hq
- License: mit
- Created: 2022-07-19T12:13:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T08:35:12.000Z (over 2 years ago)
- Last Synced: 2024-10-13T14:15:28.657Z (12 months ago)
- Topics: audit, compartments, compliance, dependencies, dependency-analysis, dynamic-analysis, hardening, intercept, lockdown, permission, permissions, sandbox, security, security-audit, security-tools, ses, supply-chain, vulnerability-scanners, zero-trust
- Language: JavaScript
- Homepage: https://sandworm.dev
- Size: 4.63 MB
- Stars: 250
- Watchers: 4
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Â
Easy auditing & sandboxing for your JavaScript dependencies 🪱
---
[![NPM][npm-version-image]][npm-version-url]
[![License][license-image]][license-url]
[![CircleCI][ci-image]][ci-url]
[![Maintainability][cc-image]][cc-url]
[![Test Coverage][coverage-image]][coverage-url]
## TL;DR
* Sandworm Guard intercepts all potentially harmful Node & browser APIs, like arbitrary code execution (`child_process.exec`) or network calls (`fetch`). It knows what packages are responsible for each call.
* Simple obfuscation techniques can confuse static analysis tools, but Sandworm's dynamic analysis will always intercept risky calls at run time.
* You can use Sandworm Guard to:
* [audit your dependencies](https://docs.sandworm.dev/#getting-started), monitor activity and permissions, and see what your code is doing under the hood using the Inspector;
* [generate a security profile](https://docs.sandworm.dev/test-framework-plugins) automatically from your test suite and do snapshot testing against it;
* [secure your app against supply chain attacks](https://docs.sandworm.dev/#enforcing-permissions) by enforcing per-module permissions.
* Install it as an `npm` module in your existing Node or browser app.
* Works in Node v15+ and [modern browsers](https://browsersl.ist/#q=defaults). Beta support for browsers and sourcemaps.
### Getting Started
Add the Sandworm init call as the very first line of your app:
```js
require('@sandworm/guard').init({devMode: true}); // add `permissions: [...]` to enforce
```
Then launch the inspector tool with `npm run sandworm` or `yarn sandworm` to monitor activity and permissions.
### Documentation
> [Read the full docs here](https://docs.sandworm.dev/guard).
### Get Involved
* Have a support question? [Post it here](https://github.com/sandworm-hq/sandworm-guard-js/discussions/categories/q-a).
* Have a feature request? [Post it here](https://github.com/sandworm-hq/sandworm-guard-js/discussions/categories/ideas).
* Did you find a security issue? [See SECURITY.md](contributing/security.md).
* Did you find a bug? [Post an issue](https://github.com/sandworm-hq/sandworm-guard-js/issues/new/choose).
* Want to write some code? See [CONTRIBUTING.md](contributing/).
[npm-version-image]: https://img.shields.io/npm/v/sandworm?style=flat-square
[npm-version-url]: https://www.npmjs.com/package/sandworm
[license-image]: https://img.shields.io/npm/l/sandworm?style=flat-square
[license-url]: https://github.com/sandworm-hq/sandworm-guard-js/blob/main/LICENSE
[ci-image]: https://img.shields.io/circleci/build/github/sandworm-hq/sandworm-guard-js?style=flat-square
[ci-url]: https://app.circleci.com/pipelines/github/sandworm-hq/sandworm-guard-js
[cc-image]: https://api.codeclimate.com/v1/badges/edff60f7f06bb0c589aa/maintainability
[cc-url]: https://codeclimate.com/github/sandworm-hq/sandworm-guard-js/maintainability
[coverage-image]: https://api.codeclimate.com/v1/badges/edff60f7f06bb0c589aa/test_coverage
[coverage-url]: https://codeclimate.com/github/sandworm-hq/sandworm-guard-js/test_coverage