Enigma Sensor Installation Guide for Windows
This guide provides instructions for installing the Enigma traffic analysis sensor on Windows systems. Enigma enables comprehensive network traffic analysis to help identify and mitigate security threats.
System Requirements
- Supported operating systems:
- Windows 10 build 1809 or later, and Windows 11
- Hardware:
- Minimum: 4 CPU cores, 8 GB RAM, 100 GB available disk space. Suitable for links up to 100 Mbps
- Recommended: 8 CPU cores, 16 GB RAM, 500 GB available disk space. Suitable for links up to 1 Gbps
- Faster links need more. Size the sensor to the peak traffic it will inspect, using the sizing guidance in the official repository: https://github.com/EnigmaNetz/Enigma-Sensor
- 2 network interface cards (NICs), one for capture and one for management. The capture NIC must be attached to a switch port analyzer (SPAN) port, a mirror port, or a network test access point (TAP)
- Other:
- Sleep settings disabled
- Antivirus, endpoint detection and response (EDR), and data loss prevention (DLP) software configured to allow packet capture and file creation
Prerequisites
Before installation, ensure you have:
- Local administrator rights, to create and modify Windows services, network settings, and files
- API key from Enigma User Profile
- A network ID for this sensor, which identifies the network it is deployed in. It must be 1 to 64 characters, using letters, numbers, spaces, hyphens, and underscores only, and must start and end with a letter or number. Example:Â
HQ-Firewall-01 - No VPN client running on the Enigma machine
- Corporate firewall, proxy, and DNS allow outbound TCP 443 toÂ
api.enigmaai.net - Outbound access toÂ
https://npcap.com during installation, if you choose the recommended Npcap option - Network switch supports SPAN, or use a network TAP
Installation
- DownloadÂ
enigma-sensor-installer.exe from the latest GitHub release - Right-clickÂ
enigma-sensor-installer.exe and select Run as administrator - When prompted, enter your API key and your network ID
- On the Npcap page, tick “Install Npcap (Recommended)”. The box is unchecked by default. Npcap enables promiscuous mode and captures substantially more traffic than the built-in pktmon tool
- Follow the rest of the wizard to complete setup. If you selected Npcap, its installer runs afterwards; accept its defaults
- After installation, verify the service is posting data:
- OpenÂ
C:\ProgramData\EnigmaSensor\logs\enigma-sensor.log - Look for a successful upload message (search forÂ
Log upload successful.) - If not present after a few minutes, verify:
- The EnigmaSensor Windows service is running
- If issues persist, contact Enigma support
- OpenÂ
How It Works
Once installed, the Enigma sensor will:
- Capture network traffic samples at regular intervals
- Process captured data through the Enigma analysis engine
- Send the resulting analysis to the Enigma cloud platform over an encrypted connection
- Store configuration inÂ
C:\ProgramData\EnigmaSensor\config.json and log activity toÂC:\ProgramData\EnigmaSensor\logs\enigma-sensor.log
Raw captures are held locally only until they have been processed, and are then deleted.
Troubleshooting
Common Issues
- Service not posting data:Â Check the EnigmaSensor Windows service status. ReviewÂ
C:\ProgramData\EnigmaSensor\logs\enigma-sensor.log for errors. - API key issues: Ensure the correct API key is entered. The sensor stops itself if the key is rejected. Contact Enigma if the key is lost.
- Network issues:Â Confirm outbound TCP 443 toÂ
api.enigmaai.net is allowed. Check proxy and firewall settings. - Little or no traffic captured: Confirm Npcap is installed and the capture NIC is attached to the SPAN, mirror, or TAP source. Without Npcap the sensor uses pktmon, which sees only traffic processed by this computer.
- Insufficient resources:Â Verify RAM, disk space, and NIC configuration meet requirements.
- Security software blocking:Â Ensure EDR, DLP, antivirus, and host firewalls are configured to allow:
- Packet capture
- File creation in the installation directory (by defaultÂ
C:\Program Files\EnigmaSensor\) and inÂC:\ProgramData\EnigmaSensor\
Uninstallation
To uninstall the Enigma sensor:
- Open Settings > Apps > Installed apps, or Control Panel > Programs and Features
- Find “Enigma Sensor” in the list of installed programs
- Click Uninstall and follow the prompts
Security Considerations
The Enigma sensor requires:
- Security software (EDR, DLP, antivirus, VPN, proxy, DNS agents) must not block sensor operation
- Read access to network interfaces for packet capture
- Regular outbound connections to Enigma services