HASH (HTTP-agnostischer Software-Honeypot)

HASH ist ein Framework zum Erstellen und Betreiben von wenig interaktiven Honeypots.

🌟 Warum HASH?

Die Hauptphilosophie von HASH ist es, einfach konfigurierbar und flexibel zu sein, um jede Software nachzuahmen, die auf HTTP/HTTPs läuft. Mit dem geringstmöglichen Fußabdruck, um nicht als Honeypot erkannt zu werden.

⚡ Funktionen

• Einheitliches Framework zur Bereitstellung von HTTP/HTTPs-basierten Honeypots
• Einfach über YAML-Dateien konfigurierbar
• Integrierte Honeytraps
• Leistungsstarke Randomisierung basierend auf fakerjs, um Honeypot-Erkennung zu vermeiden
• Optional Integration mit Datadog zum Erfassen und Analysieren von Honeypot-Logs und HTTP-Anfragen über APM

🚀 Erste Schritte

HASH wurde mit Node.js entwickelt, kann aber jede webbasierte Sprache / jeden Server basierend auf der Konfiguration nachahmen. Lesen Sie die vollständige Dokumentation unten.

Installation

Sie können es über NPM installieren

npm install -g hash-honeypot

Oder Sie können es direkt über Docker verwenden

docker run --rm ghcr.io/datadog/hash help

Verwendung

Honeypot-Profil generieren

HASH verwendet YAML-Dateien, um zu konfigurieren, wie die gewünschte Software simuliert wird. Die typische Struktur des Profilordners ist wie folgt

|____templates
|     |____resources
|     |     |____index.html
|     |     |____style.css
|     |     |____favicon.ico
|     |____404.yaml
|     |____default.yaml
|____init.yaml

Sie können es selbst erstellen oder mit dem Befehl generate generieren

Usage: HASH generate [options] <folder>

Generate honeypot profile

Arguments:
  folder                         path/to the app

Options:
  -t --template <template_name>  base template (default: "default")
  -n --name <honeypot_name>      Honeypot name
  -s --swagger <swagger_file>    Path to swagger file to convert
  -h, --help                     display help for command

Beispiel

hash-honeypot generate myhoneypot --name my-honey-pot --template default

Sie können auch Swagger-Dateien direkt über den Befehl generate in Honeypots umwandeln

Beispiel: Konvertieren von Swagger-Datei(en) in Honeypot

hash-honeypot generate sample-swagger2 -n sample -s ./test-swagger/test-swagger.yaml

Honeypot ausführen

Usage: HASH run [options] <folder>

Run HASH

Arguments:
  folder                     path/to the template folder

Options:
  -l, --log <transport>      logging transport (default: "console,file,datadog")
  -f, --log_file <filename>  logging filename (default: "hash.log")
  -h, --help                 display help for command

Beispiel

hash-honeypot my-honeypot-profile -l file -f ./logs/hash.log

Wenn Sie Datadog für Logs verwenden, stellen Sie sicher, dass Sie den Datadog-API-Key exportieren: export DD_API_KEY=<your-api-key>

Anpassung und Konfiguration

Sie können Ihr Honeypot-Profil nach Ihren Wünschen anpassen

Beispiel-Anforderungsvorlage:

id: sqli-error
info:
    title: 'SQL error honeytrap'
requests:
    - isTrap: false
      expect:
          method: GET
          path: '/author/:Id([0-9]+)'
      reply:
          status: 200
          headers:
              content-type: 'text/html'
          body:
              view: 'author.html'
    - isTrap: true
      expect:
          method: GET
          path: '/author/:Id'
      reply:
          status: 500
          headers:
              content-type: 'text/html'
          body:
              contents: "You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '' at line 2"

Lesen Sie die Konfigurationsreferenz hier oder sehen Sie sich die Beispiele hier an.

Zukünftige Arbeiten

• Beispiele-Ordner erstellen, um HASH-Funktionen zu zeigen
• Fähigkeit, API-Dokumentationsformate (Swagger usw.) zu importieren
• HASH als Modul paketieren für einfachere Verteilung
• Fähigkeiten für mittlere Interaktionen hinzufügen
• Beliebte Honeytraps hinzufügen
• Unit- und Integrationstests hinzufügen

Lizenz und Beitrag

Veröffentlicht unter der Apache-2.0-Lizenz, Beiträge sind willkommen!

Kontakt

Zögern Sie nicht, ein Issue zu eröffnen oder uns unter [email protected] zu kontaktieren.