0xSojalSec / xsshunter-go

XSSHunter-go

XSSHunter-go is a self-hosted XSS hunter that allows you to create a custom XSS payload and track when it is triggered. It is a based off the original XSSHunter-express but written in Go.

Table of content

1. Setup
2. Environment Variables
3. Volumes
4. Notifications
5. Using Traefik for SSL

The idea of why I decided to code this in Go is because I wanted this to be a maintained project that is stable. The original is based of Node 12 which is end of life. I also wanted to add some features that I thought would be useful (mostly expanding the notification system).

Setup

version: '3'
services:
  xsshunter-go:
    image: adamjsturge/xsshunter-go:main
    volumes:
      - ./db/:/app/db/
      - ./screenshots/:/app/screenshots/
    ports:
      - "1449:1449"
    environment:
      - CONTROL_PANEL_ENABLED=true
      - NOTIFY=discord://...,slack://...

Environment Variables

Name	Description	Default
CONTROL_PANEL_ENABLED	Enable the control panel	false
NOTIFY	Comma separated list of notification URLs
SCREENSHOTS_REQUIRE_AUTH	Require authentication to view screenshots	false
DOMAIN	Domain put into script	Based off URL (Defaults to HTTPS)
DATABASE_URL	Postgres Database URL	(Uses sqlite if no postgres db is present)

Volumes

Name	Description
/app/db/	Database storage if using SQLite
/app/screenshots/	Screenshot storage

Notifications

For notifications xsshunter-go uses shoutrrr. To make your own notification URL, go to https://containrrr.dev/shoutrrr/v0.8/services/overview/ or see these examples:

Service	URL
Discord	discord://token@id
Slack	slack://[botname@]token-a/token-b/token-c
Telegram	telegram://...

Using Traefik for SSL

version: '3'
services:
    xsshunter-go:
        image: adamjsturge/xsshunter-go:main
        volumes:
            - ./db/:/app/db/
            - ./screenshots/:/app/screenshots/
        environment:
            - CONTROL_PANEL_ENABLED=true
            - NOTIFY=discord://...,slack://...
            - DOMAIN=https://xsshunter.example.com
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.bugcrowd-webhook-manager.entrypoints=web, websecure"
            - "traefik.http.routers.bugcrowd-webhook-manager.rule=Host(`xsshunter.example.com`)"
            - "traefik.http.routers.bugcrowd-webhook-manager.tls.certresolver=myresolver"
            - "traefik.http.routers.bugcrowd-webhook-manager.tls.domains[0].main=xsshunter.example.com"
            - "traefik.http.services.bugcrowd-webhook-manager.loadbalancer.server.port=1449"
    traefik:
        image: "traefik:v2.8"
        container_name: "traefik"
        command:
            - "--providers.docker=true"
            - "--providers.docker.exposedbydefault=false"
            - "--entrypoints.web.address=:80"
            - "--entrypoints.websecure.address=:443"
            - "--certificatesresolvers.myresolver.acme.httpchallenge=true"
            - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web"
            - "--certificatesresolvers.myresolver.acme.email=[e-mail]"
            - "--certificatesresolvers.myresolver.acme.storage=/shared/acme.json"
        ports:
            - "80:80"
            - "443:443"
        volumes:
            - "/var/run/docker.sock:/var/run/docker.sock:ro"
            - "./shared:/shared"