@cyberok-org/amass
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

@cyberok-org/amass

The JavaScript wrapper around OWASP Amass

Highlights

  • TypeScript support.
  • ESM modules only.
  • Node.js >=14 support.

Install

$ yarn add @cyberok-org/amass
# or
$ npm install @cyberok-org/amass

Configuration

The package provides 2 ways to configure amss binary path:

  1. Environment variable $PATH. It works out of box.
  2. Environment variable $AMASS_BIN_PATH. You should provide absolute path to amass.

Usage

Basic

  • The wrapper supports following amass modes:
    • intel – discover targets for enumerations.
    • enum – perform enumerations and network mapping.
  • A command parameters are chained.
import Amass from '@cyberok/amass'

// Intel
const domains = await Amass.intel()
  .domain('cyberok.ru')
  .execute()

// Enum
const results = await Amass.enum()
  .active()
  .domain('cyberok.ru')
  .execute()

// OR: conditional usage of enum parameters
const command = Amass.enum().domain('cyberok.ru')
if (shouldBeActive) command.active()
const results = command.execute()

AbortSignal

A command can be aborted. For that purpose the wrapper supports AbortSignal.

const abortController = new AbortController()

const results = await Amass.enum()
  .active()
  .domain('cyberok.ru')
  .execute({ signal: abortController.signal })

Readme

Keywords

none

Package Sidebar

Install

npm i @cyberok-org/amass

Weekly Downloads

0

Version

1.0.0

License

none

Unpacked Size

14.6 kB

Total Files

4

Last publish

Collaborators

  • khmm12
  • cyberok