Home
Softono
afrog

afrog

Open source MIT Go
GitHub
4.3K
Stars
469
Forks
104
Issues
43
Watchers
2 weeks
Last Commit
Vulnerability Scanning

About afrog

A Security Tool for Bug Bounty, Pentest and Red Teaming.

Platforms

Web Self-hosted

Languages

Go

Links

Source Code
z
Published by
zan8in
Visit View Profile

README.md

View on GitHub

afrog

A Security Tool for Bug Bounty, Pentest and Red Teaming

English • 中文

Download • Wiki • Afrog PoC 规则编写权威指南

PoC Contributors

What is afrog

afrog is a high-performance vulnerability scanner that is fast and stable. It supports user-defined PoC and comes with several built-in types, such as CVE, CNVD, default passwords, information disclosure, fingerprint identification, unauthorized access, arbitrary file reading, and command execution. With afrog, network security professionals can quickly validate and remediate vulnerabilities, which helps to enhance their security defense capabilities.

Features

  • [x] Open source
  • [x] Fast, stable, with low false positives
  • [x] Detailed HTML vulnerability reports
  • [x] Customizable and stably updatable PoCs
  • [x] Port pre-scan (PortScan) for open port discovery
  • [x] Active community exchange group

Installation

Prerequisites

  • Go version 1.24 or higher.

you can install it with:

Binary

$ https://github.com/zan8in/afrog/releases/latest

Github

$ git clone https://github.com/zan8in/afrog.git
$ cd afrog
$ go build cmd/afrog/main.go
$ ./afrog -h

Go

$ go install -v github.com/zan8in/afrog/v3/cmd/afrog@latest

# Confirm Go’s bin path is in your environment
$ ls ~/go/bin/afrog

# Make it runnable from anywhere (add ~/go/bin to PATH)
# Permanently (Bash — add to ~/.bashrc):
$ echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
$ source ~/.bashrc

# If you use Zsh:
$ echo 'export PATH=$PATH:~/go/bin' >> ~/.zshrc
$ source ~/.zshrc

Running afrog

By default, afrog scans all built-in PoCs, and if it finds any vulnerabilities, it automatically creates an HTML report with the date of the scan as the filename.

afrog -t https://example.com

Warning occurs when running afrog

If you see an error message saying:

[ERR] ceye reverse service not set: /home/afrog/.config/afrog/afrog-config.yaml

it means you need to modify the configuration file.

To execute a custom PoC directory, you can use the following command:

afrog -t https://example.com -P mypocs/

Use the command -s keyword to perform a fuzzy search on all PoCs and scan the search results. Multiple keywords can be used, separated by commas. For example: -s weblogic,jboss.

afrog -t https://example.com -s weblogic,jboss

Use the command -S keyword to scan vulnerabilities based on their severity level. Severity levels include: info, low, medium, high, and critical. For example, to only scan high and critical vulnerabilities, use the command -S high,critical.

afrog -t https://example.com -S high,critical

You can scan multiple URLs at the same time as well.

afrog -T urls.txt

Port Pre-scan (PortScan)

PortScan runs before PoC scanning to discover open ports. Discovered ports will be appended to the scan target set (as host:port), and subsequent PoCs will run against the updated targets.

# Single-target full port scan
afrog -t 1.2.3.4 -ps -p all

# Network segment scan (host discovery + common port scan)
afrog -t 1.2.3.4/24 -ps

# Skip host discovery (assume target is reachable)
afrog -T targets.txt -ps -Pn

# Scan only specified ports
afrog -t example.com -ps -p 80,443,8080

Common flags:

  • -ps / --portscan: enable port pre-scan
  • -p / --ports: ports definition (e.g. top, full, all, 80,443, 1-1024)
  • -Pn / --ps-skip-discovery: skip host discovery
  • -prate / --ps-rate: portscan rate limit
  • -ptimeout / --ps-timeout-ms: portscan timeout (ms)
  • -ptries / --ps-retries: portscan retries
  • --ps-s4-chunk: chunk size when ports=full

-web Command

The -web command allows for persistently storing vulnerabilities scanned by afrog into an SQLite3 database. Accessing http://x.x.x.x:16868 via a browser provides access to the vulnerability report webpage, where users can conduct simple keyword searches and filter results by vulnerability severity.

afrog -web

Configuration file

The first time you start afrog, it will automatically create a configuration file called afrog-config.yaml, which will be saved in the current user directory under $HOME/.config/afrog/afrog-config.yaml.

Here is an example config file:

curated:
  enabled: "auto"         # auto|on|off
  endpoint: ""            # curated service endpoint, leave empty to disable online update
  auto_update: true       # automatically check for curated updates
  timeout_sec: 10         # mount/update timeout in seconds
  channel: "stable"       # curated channel, e.g. stable/beta
  license_key: ""         # your curated license key (if you have one)

reverse:
  ceye:
    api-key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    domain: "xxxxxx.cey2e.io"
  dnslogcn:
    domain: dnslog.cn
  alphalog:
    domain: dnslogxx.sh
    api_url: "http://dnslogxx.sh/"
  xray:
    x_token: "xraytest"
    domain: dnslogxx.sh
    api_url: "http://x.x.0.x:8777"
  revsuit:
    token: "xx"
    dns_domain: "log.xx.com"
    http_url: "http://x.x.x.x/log/"
    api_url: "http://x.x.x.x/helplog"

Curated PoCs

Curated PoCs are an additional encrypted PoC set that can be mounted and updated automatically before scanning.

  • When curated.enabled is auto or on, afrog tries to mount curated PoCs on startup.
  • If a valid endpoint and license_key are configured, afrog will:
    • Log in to the curated service
    • Periodically check and download the latest curated PoCs
    • Decrypt and store them under ~/.config/afrog/pocs-curated
  • PoC loading priority is:
    • curated > my > append > local > builtin so curated PoCs override other sources with the same PoC id.

If curated.enabled is off, or endpoint is empty, afrog will not connect to any curated service and will only use local/builtin PoCs.

For advanced users, you can override the curated PoC directory with the environment variable AFROG_POCS_CURATED_DIR.

reverse is a reverse connection platform used to verify command execution vulnerabilities that cannot be echoed back. Currently, only ceye can be used for verification.

Ceye Configuration

  • Go to the ceye.io website and register an account.
  • Log in and go to the personal settings page.
  • Copy the domain and api-key and correctly configure them in the afrog-config.yaml file.

Dnslogcn

No configuration required, but unstable dnslog.cn

Alphalog

Need to build services alphalog

Xray

Need to build services xray

Revsuit

Need to build services Revsuit、 Tutorial

Json Output (For developers)

Json

Optional command: -json -j, Save the scan results to a JSON file. The JSON file includes the following contents by default: target, fulltarget, id, and info. The info field includes the following sub-fields: name, author, severity, description, and reference. If you want to save both request and response contents, please use the -json-all command parameter.

afrog  -t https://example.com -json result.json
afrog  -t https://example.com -j result.json

Warning

The content of the JSON file is updated in real time. However, there is an important note to keep in mind: before the scan is completed, if developers want to parse the file content, they need to add a ']' symbol to the end of the file by themselves, otherwise it will cause parsing errors. Of course, if you wait for the scan to complete before parsing the file, this issue will not occur.

JsonAll

Optional command: -json-all -ja, The only difference between the -json-all and -json commands is that -json-all writes all vulnerability results, including request and response, to a JSON file.

afrog -t https://example.com -json-all result.json
afrog -t https://example.com -ja result.json

Screenshot

As Library

Simple Example

For comprehensive SDK documentation:

More Examples & Documentation

Discussion group

To join the afrog communication group on WeChat, please first add the afrog personal account and mark it as afrog. Then, you will be added to the group by the administrator.

404Starlink

afrog has joined 404Starlink

Disclaimer

This tool is intended only for legally authorized enterprise security construction purposes. If you want to test the functionality of this tool, you should build a target environment by yourself.

To prevent malicious use, all PoCs included in this project are theoretical assessments of vulnerabilities. The tool does not exploit vulnerabilities, launch real attacks or exploits on targets.

When using this tool for vulnerability scanning, it is important to ensure that your behavior complies with local laws and regulations, and that you have obtained sufficient authorization. Do not scan unauthorized targets.

If you engage in any illegal behavior while using this tool, you will be solely responsible for any corresponding consequences, and we will not bear any legal or joint responsibility.

Before installing and using this tool, please read each clause carefully and thoroughly. Restrictions, disclaimers, or other clauses that may significantly affect your rights and interests may be highlighted in bold or underlined to draw your attention. Unless you have fully read, fully understood, and agreed to all the terms of this agreement, do not install or use this tool. Your use of the tool or your acceptance of this agreement in any other express or implied manner will be deemed as your acknowledgment and agreement to be bound by this agreement.