Skip to content

Latest commit

 

History

History
339 lines (246 loc) · 20.1 KB

README.md

File metadata and controls

339 lines (246 loc) · 20.1 KB
Raw

MISP airgap

MISP airgap

MISP airgap is a project that facilitates the deployment and maintenance of MISP, in air-gapped environments. It utilizes LXD, a popular Linux containerization platform, to create and manage isolated containers for MISP and its associated databases. Additionally, this approach is adaptable for standard networked environments, allowing for the deployment of MISP in LXD in a broader range of operational contexts.

Key Features

  • Automated setup and configuration of MISP in a secure, isolated environment.
  • Containerized approach using LXD for easy management and isolation.
  • Support for both interactive and non-interactive installation modes.
  • Comprehensive validation and security checks, ensuring secure deployment.
  • Modular setup allowing for easy updates and maintenance.

Requirements

Before setting up your environment, ensure that you meet the following prerequisites on your host system:

Hardware Requirements

To run all containers set up by the installation script, the following hardware specifications are recommended:

  • CPU:

    • Minimum: 4 cores
    • Recommended for optimal performance: 4 or more cores

  • Memory (RAM):

    • Minimum: 8 GB
    • Recommended: 16 GB or more for better performance

  • Storage:

    • Minimum: 50 GB
    • Recommended: 100 GB or more, SSD preferred for better performance

Installation

First, install LXD on your air-gapped host system. Additionally, install the additional software needed.

After installation, proceed with the following steps:

  1. Download Images

    You can download the images from the MISP images page. It is recommended to use the latest version of the images. For a minimal air-gapped setup, you need the following images:

    • MISP
    • MySQL
    • Redis

    If you want to use MISP Modules, you also need the Modules image.

  2. Verify Signature

    Download the signature file for the images you want to use. You can find the signature files in the same directory as the images. Verify the signature using GPG:

    You can find the public key for verifying the images on CIRCL's PGP key server.

    Import the MISP-airgap public key:

    gpg --import /path/to/misp-airgap.asc

    Verify the signature using GPG:

    gpg --verify /path/to/file.sig /path/to/file

  3. Transfer images and repo to air-gapped system:

    Transfer the exported images and the whole repo to your air gapped system.

Interactive Mode

Run the INSTALL.sh script with the --interactive flag to enter the interactive mode, which guides you through the configuration process:

bash INSTALL.sh --interactive

Non-Interactive Mode

For a non-interactive setup, use command-line arguments to set configurations:

Example:

bash INSTALL.sh --misp-image <path-to-image> --mysql-image <path-to-image> --redis-image <path-to-image> --no-modules

Below is the table summarizing the script flags and variables:

Variable Default Value Flag Description
INTERACTIVE_MODE N/A -i, --interactive Activates an interactive installation process.
PROJECT_NAME misp-project-<creation_time> --project <project_name> Name of the LXD project used to organize and run the containers.
MISP_IMAGE <none> --misp-image <image_file> The exported image file containing the configuration and setup of the MISP instance.
MISP_CONTAINER misp-<creation_time> --misp-name <container_name> The name of the container responsible for running the MISP application.
MYSQL_IMAGE <none> --mysql-image <image_file> The exported image file of a MariaDB instance, containing the necessary configurations.
MYSQL_CONTAINER mysql-<creation_time> --mysql-name <container_name> The name of the container running the MariaDB database for MISP.
MYSQL_DATABASE misp --mysql-db <database_name> The name of the database used by the MISP application.
MYSQL_USER misp --mysql-user <user_name> The database user for MISP to interact with the MariaDB database.
MYSQL_PASSWORD misp --mysql-pwd <password> The password associated with the MISP database user.
MYSQL_ROOT_PASSWORD misp --mysql-root-pwd <password> The root user password for MariaDB.
REDIS_IMAGE <none> --redis-image <image_file> The exported image file for the Redis instance, including necessary configurations.
REDIS_CONTAINER redis-<creation_time> --redis-name <container_name> The name of the container running the Redis server for MISP.
MODULES yes --no-modules If set, a container with MISP Modules gets set up.
MODULES_IMAGE <none> --modules-image <image_file> The exported image file of a MISP Modules instance, containing the necessary configurations.
MODULES_CONTAINER modules-<creation_time> --modules-name <container_name> The name of the container running MISP Modules.
APP_PARTITION <none> --app-partition <partition> Dedicated partition for the storage of the MISP container.
DB_PARTITION <none> --db-partition <partition> Dedicated partition for the storage of the database container(s).
PROD no -p, --production If set to true, the MISP application runs in production mode, activating the islive option and adjusting settings accordingly.

Note: It is crucial to modify all default credentials when using this installation in a production environment. Specifically, if the PROD variable is set to true, the installer will not accept default values.

After completing these steps, MISP should be up and running. Access the MISP web interface by navigating to the IP address displayed in the terminal after the installation process is finished. Alternatively, you can identify the IP addresses of all running containers within the project by executing the command lxc list.

Update

  1. Download Images

    You need to dowload the images for the components you want to update. You can download the images from the MISP images page. It is recommended to use the latest version of the images.

  2. Verify Signature

    Download the signature file for the images you want to use. You can find the signature files in the same directory as the images. Verify the signature using GPG:

    You can find the public key for verifying the images on CIRCL's PGP key server.

    Import the MISP-airgap public key:

    gpg --import /path/to/misp-airgap.asc

    Verify the signature using GPG:

    gpg --verify /path/to/file.sig /path/to/file

  3. Transfer images to air-gapped system:

    Transfer the exported images to your air gapped system.

Interactive Mode

Run the UPDATE.sh script with the --interactive flag to enter the interactive mode, which guides you through the configuration process:

bash UPDATE.sh --interactive

Note: It is recommende to use new names for the newly created containers. However if you want to keep the current container names, you can enter the same name for the new container as the current one. Please refer to the Container Naming Conventions section for more information.

Non-Interactive Mode

For a non-interactive setup, use command-line arguments to set configurations:

Example:

bash UPDATE.sh --current-misp <current-misp-container> --update-misp -p <mysql-root-pwd> --misp-image <path-to-image>

Below is the table summarizing the script flags and variables:

Variable Default Value Flag Description
INTERACTIVE_MODE N/A -i, --interactive Activates an interactive installation process.
MYSQL_ROOT_PASSWORD User Input Required -p, --passwd <password> Set the MySQL root password.
MISP no --update-misp Update MISP container.
MISP_IMAGE <none> --misp-image <image> Specify the MISP image.
CURRENT_MISP <none> --current-misp <name> Specify the current MISP container name (Mandatory).
NEW_MISP misp-<creation_time> --new-misp <name> Specify the new MISP container name.
Multiple N/A -a, --all Apply updates to all components.
MYSQL no --update-mysql Update MySQL container.
MYSQL_IMAGE <none> --mysql-image <image> Specify the MySQL image.
NEW_MYSQL mysql-<creation_time> --new-mysql <name> Specify the new MySQL container name.
REDIS no --update-redis Update Redis container.
REDIS_IMAGE <none> --redis-image <image> Specify the Redis image.
NEW_REDIS redis-<creation_time> --new-redis <name> Specify the new Redis container name.
MODULES no --update-modules Update modules container.
MODULES_IMAGE <none> --modules-image <image> Specify the modules image.
NEW_MODULES modules-<creation_time> --new-modules <name> Specify the new modules container name.

Container Naming Conventions

In LXD container names are used to identify containers for various operations including networking. Therefore, it is important to use a consistent naming convention for containers.

As LXD does not allow containers with the same name, the script will automatically rename the old container if the new container name is the same as the old one. In iteractive mode the script will ask you if you are sure you want to rename the container. In non-interactive mode the script will automatically rename the container.

The script will use the following naming convention for renamed containers:

updated-<container_name>-<creation_time>

All changes made by the script will be logged in the naming.log file in the logs/ directory.

Container Management

Installing and updating MISP using the MISP airgap project creates and manages containers using LXD. The following commands can be used to manage the containers created by the installation script. If you are not familiar with LXD, you can find more information in the LXD documentation.

Command Description
lxc list List all containers in the current project.
lxc start <container_name> Start a container.
lxc stop <container_name> Stop a container.
lxc project list List all projects.
lxc project switch <project> Switch to a different project.
lxc snapshot <container> <snapshot_name> Create a snapshot of a container.
lxc restore <container> <snapshot_name> Restore a container to a snapshot.

Build

If you want to build the images yourself, you can use the build.sh script in the build/ directory. This is completely optional, as the images are already built and available for download.

Requirements:

  • jq 1.6
  • curl 7.81.0
  • gpg (GnuPG) 2.2.27

You can build the images using the build script:

bash build.sh [OPTIONS]

Below is the table summarizing the script options:

Variable Default Value Flag Description
MISP false --misp Create a MISP image.
MYSQL false --mysql Create a MySQL image.
REDIS false --redis Create a Redis image.
MODULES false --modules Create a Modules image.
MISP_IMAGE MISP --misp-name <name> Specify a custom name for the MISP image.
MYSQL_IMAGE MySQL --mysql-name <name> Specify a custom name for the MySQL image.
REDIS_IMAGE Redis --redis-name <name> Specify a custom name for the Redis image.
MODULES_IMAGE Modules --modules-name <name> Specify a custom name for the Modules image.
REDIS_VERSION N/A --redis-version <version> Specify a Redis version to build.
MYSQL_VERSION N/A --mysql-version <version> Specify a MySQL version to build.
OUTPUTDIR N/A -o, --outputdir <dir> Specify the output directory for created images.
SIGN false -s, --sign Sign the created images.

Signing

When the -s or --sign flag is used, the build.sh script will sign the created images using GPG. To utilize this feature, first configure your signing keys in the /conf/sign.json file. You can use the provided template file as a starting point:

cd ./build/conf
cp sign.json.template sign.json

If no key with the specified ID is found in your GPG keyring, the script will automatically generate a new key.

Running Image Creation with systemd

This section describes how to run the image creation process as a systemd service on a Linux system. The service is designed to periodically check for updates in specified GitHub repositories and execute an image creation process using the build.sh script if new updates are found.

Prerequisites

  • Ubuntu 22.04 system with systemd.
  • Python 3 and the requests module installed.
  • Access to GitHub repositories (internet connection required).

Config

Edit the tracker.json configuration file in build/conf/ to specify the GitHub repositories to track, the build arguments, and the check interval. You can use the provided template file as a starting point:

cd ./build/conf
cp tracker.json.template tracker.json

If your build process requires GPG signing, edit the sign.json configuration file in build/conf/ by copying the template and modifying the default values:

cd ./build/conf
cp sign.json.template sign.json

Setup

To setup the service run the setup.sh script in the systemd/ directory. This script performs several tasks:

  • Creates a dedicated user for the service.
  • Copies necessary files to appropriate locations.
  • Sets required permissions.
  • Automatically configures and enables the systemd service.

To run the script, execute:

cd build/systemd 
sudo bash setup.sh

Monitoring

To check the status of the service, use:

systemctl status updatetracker.service

For debugging or monitoring, access the service logs with:

journalctl -u updatetracker.service

Modifying

If you need to modify the service (e.g., changing the repositories to track or the check interval), update the tracker.json file in /opt/misp_airgap/build/conf/ and restart the service:

systemctl restart updatetracker.service

Alternatively, you can use the update.sh script in the systemd/ directory to automatically update the service configuration and restart the service:

sudo bash update.sh

This can be helpfull if there are changes to the scripts used by the service such as build.sh or updatetracker.py.

Alternative Method Using update.sh Script:

If your modifications include changes to the service's operational scripts (like build.sh or updatetracker.py), it's recommended to use the update.sh script. This script ensures that the service configuration is updated and the service is restarted to reflect the changes.

To use the update.sh script:

cd /path/to/systemd/
sudo bash update.sh

Note: Using the update.sh script is especially useful for comprehensive updates, as it automates the process of applying configuration changes and restarting the service.

Maintenance

A few useful commands to manage the LXC images.

  • Open a shell on the MISP image:
lxc exec misp-<image_date> bash
  • reset the password of the MISP user:
sudo -u www-data /var/www/MISP/app/Console/cake user change_pw admin@admin.test Password1234