Skip to content

getting-started.md

Latest commit

 

History

History
121 lines (90 loc) · 3.38 KB

getting-started.md

File metadata and controls

121 lines (90 loc) · 3.38 KB

Getting Started

Requirements

  • Ruby >= 3.2
  • Bundler
  • A system you own or have explicit written permission to test

Install For Development

bundle install
bundle exec ruby bin/asrfacet-rb help
bundle exec ruby bin/asrfacet-rb --version
bundle exec ruby bin/asrfacet-rb about
bundle exec ruby bin/asrfacet-rb --explain scope
bundle exec rake

Install As A Local Application

ASRFacet-Rb ships with platform installers under install/.

  • install/windows.ps1
  • install/linux.sh
  • install/macos.sh

Each installer supports:

  • install
  • test
  • uninstall
  • update

They stage the framework into its own asrfacet-rb application directory, install dependencies into that directory, create launchers, and print the final install and report paths when complete. After installation you can invoke the framework with either asrfacet-rb or the shorter alias asrfrb.

Installer prompt legend is consistent across Linux, macOS, and Windows:

  • [ASRFacet-Rb][INFO] for progress
  • [ASRFacet-Rb][ OK ] for successful milestones
  • [ASRFacet-Rb][WARN] for recoverable issues
  • [ASRFacet-Rb][FAIL] for stopping errors

First Commands

bundle exec ruby bin/asrfacet-rb scan example.com
bundle exec ruby bin/asrfacet-rb passive example.com
bundle exec ruby bin/asrfacet-rb dns example.com
bundle exec ruby bin/asrfacet-rb ports 192.0.2.10 --ports 22,80,443
bundle exec ruby bin/asrfacet-rb lab
bundle exec ruby bin/asrfacet-rb --console
bundle exec ruby bin/asrfacet-rb --web-session

On the first interactive run, ASRFacet-Rb prints a short onboarding guide with safe starter commands, where output is stored, and how to open the built-in help surfaces.

Recommended First Scan

Start with a bounded run:

bundle exec ruby bin/asrfacet-rb scan example.com \
  --scope example.com,*.example.com \
  --exclude dev.example.com \
  --threads 50 \
  --ports top100 \
  --monitor \
  --memory \
  --format html

Why this profile is a good baseline:

  • --scope keeps active validation inside the authorized boundary.
  • --exclude prevents touching known sensitive or inherited hosts.
  • --threads 50 is a stable starting point for mixed discovery.
  • --ports top100 keeps network validation focused for a first pass.
  • --monitor and --memory make repeat scans more useful immediately.
  • --format html creates a shareable offline report bundle.

Where Results Go

By default, every run stores a report bundle under:

~/.asrfacet_rb/output/reports/<target>/<timestamp>/

Typical bundle contents:

  • report.cli.txt
  • report.txt
  • report.html
  • report.json

The pipeline may also write a JSONL event stream under:

~/.asrfacet_rb/output/streams/

Transparency

  • Active commands send real requests to the targets you specify.
  • Passive results can still include third-party or stale infrastructure, so treat them as leads to validate, not automatic in-scope truth.
  • The web session starts a local server on 127.0.0.1:4567 by default and stores drafts under ~/.asrfacet_rb/web_sessions/.
  • Recon memory and report bundles persist under ~/.asrfacet_rb/memory/ and ~/.asrfacet_rb/output/.
  • Findings help prioritize operator review, but they are not guaranteed exploit proof.

Built-In Help

asrfacet-rb help
asrfacet-rb help scan
asrfacet-rb explain scope
asrfacet-rb manual
asrfacet-rb manual workflow
man asrfacet-rb
man asrfrb