Skip to content

CLI tool for filtering URLs/IPs with automatically-updated Bug Bounty program scope rules.

License

Notifications You must be signed in to change notification settings

ItsIgnacioPortal/Hacker-Scoper

Hacker-Scoper icon

Golang icon Link to the latest version Badge depicting the proyect license, the aGPLv3 OpenSSF best practices badge.


Hacker-Scoper is a GoLang tool designed to assist cybersecurity professionals in bug bounty programs. It identifies and excludes URLs and IP addresses that fall outside a program's scope by comparing input targets (URLs/IPs) against a locally cached FireBounty database of scraped scope data. Users may also supply a custom scope list for validation.

🌟 Features

  • Automatic scope detection: Hacker-Scoper maintains an automatically-updated cached database of public program scopes. This means you don't need to manually specify the program scope unless the bug bounty program is private. You just need to supply the company name (-c company-name-here).
  • Easy customization: You can load the scope of any private program scopes into files named .inscope and .noscope for inscope assets, and out-of-scope assets respectively.
  • Match any asset: Hacker-Scoper works with IPv4, IPv6, and any URL format (including non-conventional ones like sql:// or redis://).
  • Wildcard support: Hacker-Scoper supports wildcards in any part of your scope, allowing you to use filters like amzn*.example.com and dev.*.example.com.
  • Automation friendly: Use the -ch/--chain-mode argument to disable the fancy text decorations and output only the in-scope assets.
  • Compatible: Hacker-Scoper is compatible with Windows, Linux, MacOS and Android in all architectures.
  • Flexible: For any companies with vaguely defined scopes, you can enable or disable scope wildcard parsing using the command-line argument -e/--explicit-level.
  • Misconfiguration detection: Using TLD-Based detection, hacker-scoper can automatically detect misconfigurations in bug-bounty program scopes. For example: Sometimes bug bounty programs set APK package names such as com.my.businness.gatewayportal as web_application resources instead of as android_application resources in their program scope, causing trouble for anyone using automatic tools. Hacker-Scoper automatically detects these errors and notifies the user.

πŸ“¦ Installation

Using Chocolatey

choco install hacker-scoper

Using go install

go install github.com/ItsIgnacioPortal/hacker-scoper

From the releases page

Download a pre-built binary from the releases page


πŸŽ₯ Demos

Demo with company lookup

asciicast



Demo with custom scopes file

asciicast

🏭 Company scope matching

  • Q: How does the "company" scope matching actually work?
  • A: It works by looking for company-name matches in a cached copy of the firebounty database. The company name that you specify will be lowercase'd, and then the tool will check if any company name in the database contains that string. Once it finds a name match, it will filter your supplied targets according to the scopes that firebounty detected for that company. You can test how this would perform by just searching some name in the firebounty website.

πŸ€” Usage

Usage: hacker-scoper --file /path/to/targets [--company company | --custom-inscopes-file /path/to/inscopes [--custom-outofcopes-file /path/to/outofscopes]] [--explicit-level INT] [--reuse Y/N] [--chain-mode] [--database /path/to/firebounty.json] [--include-unsure] [--output /path/to/outputfile] [--hostnames-only]

Usage examples:

  • Example: Cat a file, and lookup scopes on firebounty
    cat recon-targets.txt | hacker-scoper -c google

  • Example: Cat a file, and use the .inscope & .noscope files
    cat recon-targets.txt | hacker-scoper

  • Example: Manually pick a file, lookup scopes on firebounty, and set explicit-level
    hacker-scoper -f recon-targets.txt -c google -e 2

  • Example: Manually pick a file, use custom scopes and out-of-scope files, and set explicit-level
    hacker-scoper -f recon-targets.txt -ins inscope -oos noscope.txt -e 2

Usage notes: If no company and no inscope file are specified, hacker-scoper will look for ".inscope" and ".noscope" files in the current or in parent directories.

Table of all possible arguments:

Short Long Description
-c --company Specify the company name to lookup.
-f --file Path to your file containing URLs
-ins --inscope-file Path to a custom plaintext file containing scopes
-oos --outofcope-file Path to a custom plaintext file containing scopes exclusions
-e --explicit-level int How explicit we expect the scopes to be:
1 (default): Include subdomains in the scope even if there's not a wildcard in the scope
2: Include subdomains in the scope only if there's a wildcard in the scope
3: Include subdomains in the scope only if they are explicitly within the scope
-ch --chain-mode In "chain-mode" we only output the important information. No decorations.. Default: false
--database Custom path to the cached firebounty database
-iu --include-unsure Include "unsure" URLs in the output. An unsure URL is a URL that's not in scope, but is also not out of scope. Very probably unrelated to the bug bounty program.
-o --output Save the inscope urls to a file
-ho --hostnames-only Output only hostnames instead of the full URLs
--version Show the installed version
_______________ ___________________ _____________________________________

list example:

example.com
dev.example.com
1.dev.example.com
2.dev.example.com
ads.example.com
192.168.1.10
192.168.2.10
192.168.2.8

Custom .inscope file example:

*.example.com
*.sub.domain.example.com
amzn*.domain.example.com
192.168.1.10
FE80:0000:0000:0000:0202:B3FF:FE1E:8329
FE80::0202:B3FF:FE1E:8329

Custom .noscope file example:

community.example.com
thirdparty.example.com
*.thirdparty.example.com
dev.*.example.com
192.168.2.254
FE80::0202:B3FF:FE1E:8330

❀️ Special thank you

This project was inspired by the yeswehack_vdp_finder

πŸ“„ License

All of the code on this repository is licensed under the GNU Affero General Public License v3. A copy can be seen as LICENSE on this repository.

The library golang.org/x/net/publicsuffix, used within this project is licensed with BSD-3-Clause.

Sponsor this project

 

Packages

No packages published