Honeypot Store

The Honeypot Store is a centralized repository that allows you to discover, download, and install new honeypot configurations developed by the STINGAR team. This feature provides access to additional honeypot types beyond the default honeypots available in the Deploy Honeypot page.

Accessing the Honeypot Store

To access the Honeypot Store, click Honeypot Store in the left menu sidebar. The Honeypot Store page displays available honeypots that can be downloaded and installed into your STINGAR instance.

Note: The Honeypot Store feature must be enabled in your STINGAR configuration. See the Environment Variables Settings page to enable the HP App Store connection.

HP App Store Badge

When the HP App Store is enabled, you'll see a red badge on the Honeypot Store menu item in the sidebar. This badge displays the number of available honeypots in the store:

  • Number - Shows the count of available honeypots (e.g., "5", "12", "99+")
  • ? - Appears while the count is being loaded
  • ! - Appears if there's an error connecting to the HP App Store

The badge only appears when: * The HP App Store is enabled (REMOTE_STORE_ENABLED is set to true) * Your STINGAR instance has successfully registered with the HP App Store * An API key has been received and configured

Auto-Registration

When you first enable the HP App Store in your settings, STINGAR will automatically attempt to register your instance with the HP App Store. This process:

  1. Generates a unique identifier for your STINGAR instance
  2. Sends registration information to the HP App Store (including institution name and contact email)
  3. Receives an API key that is automatically stored in your configuration
  4. Enables access to browse and download honeypots from the store

The registration process happens automatically in the background and does not require any user interaction. If registration fails (e.g., due to network issues), STINGAR will retry periodically until successful.

Note: Auto-registration requires that INSTITUTION_NAME and CONTACT_EMAIL are configured in your environment variables. These can be set on the Environment Variables Settings page.

Available Honeypots

The main Honeypot Store page shows a collection of honeypots that are ready to download and install. Each honeypot card displays:

  • Honeypot Name - The name of the honeypot type
  • Description - A brief description of what the honeypot does
  • Category - The category classification (e.g., Network, Web, Industrial)
  • Rating - User rating for the honeypot
  • Download Count - Number of times the honeypot has been downloaded
  • Tags - Keywords associated with the honeypot

Installing a Honeypot Configuration

To install a honeypot configuration from the store:

  1. Browse the available honeypots on the Honeypot Store page
  2. Click on a honeypot card to view its details
  3. Review the honeypot description, requirements, and configuration options
  4. Click the [Install Configuration] button on the honeypot card
  5. The honeypot configuration will be downloaded and installed into your STINGAR library

After successful installation, a dialog will appear offering you two options:

  • Go to Deploy Page - Navigate directly to the Deploy Honeypot page to deploy the newly installed honeypot
  • Download Another Honeypot - Stay on the Honeypot Store page to browse and install additional honeypots
Note: Installing a honeypot configuration from the store adds it to your local STINGAR library. You must still deploy the honeypot to a host server using the Deploy Honeypot page before it will begin collecting attack data.

Searching and Filtering

The Honeypot Store includes search and filter capabilities to help you find specific honeypots:

  • Search Bar - Enter keywords to search honeypot names, descriptions, or tags
  • Category Filter - Filter honeypots by category (Network, Web, Industrial, etc.)
  • Tag Filter - Filter by specific tags associated with honeypots
  • Status Filter - Filter by honeypot status (available, in development, etc.)

Requesting New Honeypots

If you need a honeypot type that is not currently available in the store, you can submit a request for the STINGAR team to develop it. The Request New Honeypot feature allows you to specify detailed technical requirements including ports, protocols, CVEs, and other specifications.

Submitting a Honeypot Request

To request a new honeypot:

  1. Navigate to the Honeypot Store page
  2. Click the [Request New Honeypot] button (located at the top of the page or in the navigation)
  3. Fill out the honeypot request form with the following information:

Contact Information: * Your Name (required) - Your full name * Email Address (required) - A valid email address where the STINGAR team can contact you * Organization (required) - Your organization or university name

Honeypot Details: * Honeypot Name (required) - The name you'd like to propose for the honeypot * Description (required) - A detailed description of what the honeypot should do and what it should emulate * Category - Select the category that best fits your honeypot (e.g., Network, Web, Industrial, etc.) * Use Case - Explain why you need this honeypot and how you plan to use it

Technical Requirements: * Required Ports - Add specific ports that the honeypot should listen on (e.g., 22, 80, 443, 8080) * Supported Protocols - Specify protocols the honeypot should support (e.g., SSH, HTTP, HTTPS, FTP, Telnet) * IP Protocol Support - Select IPv4, IPv6, or both * CVEs - Add specific CVE numbers that the honeypot should emulate (e.g., CVE-2021-44228) * Additional Requirements - Any other technical specifications or requirements

Optional Information: * Tags - Add tags to help categorize your request (e.g., "ssh", "web", "vulnerability") * Expected Behavior - Describe how you expect the honeypot to behave when attacked * Security Considerations - Any security-related notes or concerns

  1. Review your request to ensure all information is accurate
  2. Click [Submit Request] to send your request to the STINGAR team
Note: The honeypot request feature is a free service currently under beta trial. The STINGAR team will review your request and may contact you with follow-up questions via the email address you provide.

Request Form Tips

  • Be Specific: The more detailed your technical requirements, the better the STINGAR team can understand what you need
  • Include CVEs: If you know specific CVEs you want to emulate, include them - this helps ensure the honeypot matches your security research needs
  • Port Numbers: Specify exact port numbers if you need the honeypot to listen on non-standard ports
  • Protocol Details: Mention any protocol-specific requirements (e.g., SSH version, HTTP methods, TLS versions)
  • Use Cases: Explain your research or security goals - this helps prioritize requests

After Submitting a Request

Once you submit a request:

  1. Your request will be assigned a unique request ID
  2. The request status will be set to Pending (awaiting review)
  3. Other STINGAR users can view and vote on your request
  4. The STINGAR team will review your request and may contact you via email
  5. You can track the status of your request on the Requested Honeypots page

For detailed information about request statuses and lifecycle stages, see the Honeypot Request Stages documentation.

Viewing and Voting on Requests

You can view all submitted honeypot requests on the Requested Honeypots page:

  1. Click [Request New Honeypot] from the Honeypot Store page to navigate to the Requested Honeypots page
  2. Browse the list of pending and in-review requests
  3. Upvote requests you'd like to see prioritized by clicking the upvote button
  4. View request details including description, technical requirements, and current vote count

Request statuses include:

  • Pending - Newly submitted requests awaiting review
  • In Review - Requests being evaluated by the STINGAR team
  • Approved - Requests approved for development
  • Completed - Requests that have been developed and are now available in the store

Integration with Deploy Honeypot

Honeypots installed from the Honeypot Store become available on the Deploy Honeypot page alongside the default honeypot types. Once installed, you can deploy them to your host servers using the same deployment process as default honeypots.

For instructions on deploying honeypots, see the Deploy Honeypot documentation.