Skip to content
SPECIFICTION
Get listed

Heralding

github.com

Free plan LinuxSelf-hosted
Visit github.com
Spec score 7.5 #12 of 21 in Honeypot Software

What it is

Heralding is a free, self-hosted network honeypot that collects credentials. It runs on Linux and supports FTP, Telnet, SSH, HTTP, HTTPS, POP3, POP3S, IMAP, IMAPS, SMTP, VNC, PostgreSQL and SOCKS5. When a protocol makes them available, its authentication log records usernames and plaintext passwords. It also writes authentication attempts, session summaries and full session data to CSV and JSON Lines files. Session details can include timestamps, duration, source and destination IP addresses and ports, protocol, authentication attempts and protocol-specific auxiliary data. Session log entries are written after sessions end; authentication entries appear once a password has been transmitted. The README describes pip installation on Debian-based systems and Docker deployment using port mapping. Python 3.7.0 or higher is required. For separate packet captures per session, the README points to Curisoum and says it must be enabled in Heralding.yml. GitHub identifies the project as GPL-3.0 licensed.

Spec sheet

Purpose
Heralding is a simple honeypot that collects credentials.Read 3 Oct 2026 · github.com
Intended users
The project describes itself as a honeypot for users who want to collect credentials.Read 3 Oct 2026 · github.com
License
GitHub identifies the project as GPL-3.0 licensed.Read 3 Oct 2026 · github.com
Authentication capture
The auth log records usernames and plaintext passwords when the protocol makes them available.Read 3 Oct 2026 · github.com
Container deployment
The project README describes building a Docker image and running it with a port mapping.Read 3 Oct 2026 · github.com
Installation
The README gives pip installation instructions and describes running Heralding on a Debian-based system.Read 3 Oct 2026 · github.com
Log timing
Session log entries are written after a session ends, while auth log entries appear when a password has been transmitted.Read 3 Oct 2026 · github.com
Packet capture
The README points to Curisoum for creating a separate PCAP for each Heralding session and says to enable it in Heralding.yml.Read 3 Oct 2026 · github.com
Protocols
It supports FTP, Telnet, SSH, HTTP, HTTPS, POP3, POP3S, IMAP, IMAPS, SMTP, VNC, PostgreSQL and SOCKS5.Read 3 Oct 2026 · github.com
Requirements
The README states that Python 3.7.0 or higher is required.Read 3 Oct 2026 · github.com
Session details
Session data can include timestamps, duration, source and destination IP and port, protocol, authentication attempts and protocol-specific auxiliary data.Read 3 Oct 2026 · github.com
Session logs
It writes authentication attempts, session summaries and complete session data to CSV and JSON Lines files.Read 3 Oct 2026 · github.com

Plans and prices

Heralding Free GPL-3.0 licensed open-source honeypot Read 3 Oct 2026 · github.com

Every Heralding plan and price →

Strong points and limits

Strong points

  • Free and GPL-3.0 licensed.
  • Supports 13 listed network protocols.
  • Writes session data to CSV and JSON Lines.
  • Offers pip and Docker deployment options.

Limits

  • Plaintext passwords appear only when protocols make them available.
  • Session logs are written after sessions end.
  • Requires Python 3.7.0 or higher.

Who it suits

Heralding suits users who want a self-hosted network decoy to collect credentials and record session details. It requires Linux and Python 3.7.0 or higher.

Verdict

Heralding offers broad protocol coverage and structured authentication and session logs for a Linux honeypot. Keep in mind when logs appear and that password capture depends on protocol behavior.

Where Specifiction places it

Alternatives to HeraldingAll alternatives →