UHP Honeypot

WARNING: This honeypot is currently in ALPHA support for CHN and is not likely suitable for production use at this time

The CommunityHoneyNetwork UHP Honeypot is an implementation of @MattCarothers's UHP, configured to report logged attacks to the CommunityHoneyNetwork management server.

"UHP is a medium interaction honeypot that allows defenders to quickly implement line-based TCP protocols with a simple JSON configuration."


The default deployment model uses Docker and Docker Compose to deploy containers for the project's tools, and so, require the following:

  • Docker >= 1.13.1
  • Docker Compose >= 1.15.0

Please ensure the user on the system installing the honeypot is in the local docker group

Please see your system documentation for adding a user to the docker group.

Important Note!

The env files, as well as the docker-compose.yml files below are intended to help you understand the various options. While they may serve as a basis for users with advanced deployment needs, most users should default to the configuration files provided by the deployment scripts in the CHN web interface.

Example uhp docker-compose.yml

version: '3'
        image: stingar/uhp:1.9.1
        restart: always
            - configs:/etc/uhp
            - "25:2525"
            - uhp.env

Example uhp.env file

Prior to starting, UHP will parse some options from /etc/default/uhp for Debian-based containers. The following is an example config file:

# This can be modified to change the default setup of the unattended installation


# IP Address of the honeypot
# Leaving this blank will default to the docker container IP

# CHN Server api to register to

# Server to stream data to

# Deploy key from the FEEDS_SERVER administrator
# This is a REQUIRED value

# Registration information file
# If running in a container, this needs to persist

# Defaults include auto-config-gen.json, avtech-devices.json, generic-listener.json,
# hajime.json, http-log-headers.json, http.json, pop3.json, and smtp.json


# Comma separated tags for honeypot

Configuration Options

The following options are supported in the /etc/default/uhp file:

  • DEBUG: (boolean) Enable more verbose output to the console
  • IP_ADDRESS: IP address of the host running the honeypot container
  • CHN_SERVER: (string) The URL of the CHN Server used to register honeypot.
  • FEEDS_SERVER: (string) The hostname or IP address of the HPFeeds server to send logged events. This is likely going to be the CHN management server.
  • FEEDS_SERVER_PORT: (integer) The HPFeeds port. Default is 10000.
  • DEPLOY_KEY: (string; REQUIRED) The deploy key provided by the feeds server administration for registration during the first startup. This key is required for registration.
  • UHP_JSON: (string) The location to store the registration information returned from the HPFeeds server.
  • UHP_CONFIG: (string) The filename for the UHP JSON honeypot configuration
  • UHP_LISTEN_PORT: (integer) The port for the UHP daemon to listen on for connections. In containerized applications, this is inside the container, and the port can still be mapped to a different port on the host.
  • TAGS: (string) Comma delimited string for honeypot-specific tags. Tags must be separated by a comma to be parsed properly. TAGS string must be enclosed in double quotes if string contains spaces.


CommunityHoneyNetwork UHP container is an adaptation of [@MattCarothers's UHP UHP software and Threatstream's Modern Honey Network UHP & HPFeeds work, among other contributors and collaborators.


The ThreatStream implementation of UHP with HPFeeds, upon which CommunityHoneyNetwork is based is licensed under the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1

The CommunityHoneyNetwork UHP deployment model and code is therefore also licensed under the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1