IntelMQ Manager

IntelMQ Manager is a graphical interface to manage configurations for IntelMQ. Its goal is to provide an intuitive tool to allow non-programmers to specify the data flow in IntelMQ.

Installation

For the intelmq-manager webinterface any operating system that can serve HTML pages is supported. intelmq-manager can be installed via Python pip or via the operating systems package manager. We provide packages for the intelmq-manager for the same operating systems as we do for the intelmq package itself. For the list of supported distributions, please see the IntelMQ Installation page.

Our repository page gives installation instructions for various operating systems. No additional set-up steps are needed if you use these packages.

To use the intelmq-manager webinterface, you have to have a working intelmq installation which provides access to the IntelMQ API.

When using distribution packages, the webserver configuration (which is also shown below) for Apache will be automatically installed and the HTML files are stored under /usr/share/intelmq-manager/html. The webinterface is then available at http://localhost/intelmq-manager.

Installation using pip

For installation via pip, the situation is more complex. pip3 install intelmq-manager installs the HTML files in ${PREFIX}/usr/share/intelmq-manager/html. The value of ${PREFIX} depends on your environment and is something like /usr/local/lib/pythonX.Y/dist-packages/ (where X.Y is your Python version). You can either move the files to /usr/share/intelmq-manager/html or adapt the path in the webserver configuration, see below.

intelmq-manager ships with a default configuration for the Apache webserver (in ${PREFIX}/etc/intelmq/manager-apache.conf):

Alias /intelmq-manager /usr/share/intelmq_manager/html/

<Directory /usr/share/intelmq_manager/html>
    <IfModule mod_headers.c>
    Header set Content-Security-Policy "script-src 'self'"
    Header set X-Content-Security-Policy "script-src 'self'"
    </IfModule>
</Directory>
This file needs to be placed in the correct place for your Apache 2 installation.
  • On Debian and Ubuntu, move the file to /etc/apache2/conf-available.d/manager-apache.conf and then execute a2enconf manager-apache.

  • On CentOS, RHEL and Fedora, move the file to /etc/httpd/conf.d/.

  • On openSUSE, move the file to /etc/apache2/conf.d/.

Don’t forget to reload your webserver afterwards.

IntelMQ 2.3.1 comes with a tool intelmqsetup which performs these set-up steps automatically. Please note that the tool is very new and may not detect all situations correctly. Please report us any bugs you are observing. The tools is idempotent, you can execute it multiple times.

Security considerations

Never ever run intelmq-manager on a public webserver without SSL and proper authentication!

The way the current version is written, anyone can send a POST request and change intelmq’s configuration files via sending HTTP POST requests. Intelmq-manager will reject non JSON data but nevertheless, we don’t want anyone to be able to reconfigure an intelmq installation.

Therefore you will need authentication and SSL. Authentication can be handled by the IntelMQ API. Please refer to its documentation on how to enable authentication and setup accounts.

Never ever allow unencrypted, unauthenticated access to intelmq-manager!

Configuration

In the file /usr/share/intelmq-manager/html/js/vars.js set ROOT to the URL of your intelmq-api installation- by default that’s on the same host as intelmq-manager.

It is recommended to set these two headers for all requests:

Content-Security-Policy: script-src 'self'
X-Content-Security-Policy: script-src 'self'

Screenshots

This interface lets you visually configure the whole IntelMQ pipeline and the parameters of every single bot. You will be able to see the pipeline in a graph-like visualisation similar to the following screenshot (click to enlarge):

Main Interface

When you add a node or edit one you’ll be presented with a form with the available parameters for a bot. There you can easily change the parameters as shown in the screenshot:

Parameter editing

After editing the bots’ configuration and pipeline, simply click “Save Configuration” to automatically write the changes to the correct files. The configurations are now ready to be deployed.

Note well: if you do not press “Save Configuration” your changes will be lost whenever you reload the web page or move between different tabs within the IntelMQ manager page.

When you save a configuration you can go to the ‘Management’ section to see what bots are running and start/stop the entire botnet, or a single bot.

Botnet Management

You can also monitor the logs of individual bots or see the status of the queues for the entire system or for single bots.

In this next example we can see the number of queued messages for all the queues in the system.

Botnet Monitor

The following example we can see the status information of a single bot. Namely, the number of queued messages in the queues that are related to that bot and also the last 20 log lines of that single bot.

Bot Monitor

Usage

Any underscored letter denotes access key shortcut. The needed shortcut-keyboard is different per Browser:

  • Firefox: <kbd>Alt + Shift + letter</kbd>

  • Chrome & Chromium: <kbd>Alt + letter</kbd>

The IntelMQ Manager queries the configuration file paths and directory names from intelmqctl and therefore any global environment variables (if set) are effective in the Manager too. The interface for this query is intelmqctl debug --get-paths, the result is also shown in the /about.html page of your IntelMQ Manager installation.

For more information on the ability to adapt paths, have a look at the Configuration section.

Named queues / paths

With IntelMQ Manager you can set the name of certain paths by double-clicking on the line which connects two bots:

Enter path

The name is then displayed along the edge:

Show path name