Using your own SSL Certificate

Many customers would like to replace our server certificates with their own certificates issued with the correct common name and using their company or commercial Certificate Authority (CA).

There are two methods of achieving this which are both explained below.

Method 1: Permanent Solution (Recommended)

The paths for the files that you need to overwrite are as defined in /etc/apache2/default-ssl.conf within the itdsphp docker container:

1. /etc/ssl/private/server.crt
2. /etc/ssl/private/server.key

You should be able to overwrite the above files in the Docker containers in order to change the certificate that is being used, however, by changing the files inside the Docker container, you will need to repeat this action every time the Docker images change when an update is released because the changes will be lost every time a new container is created.

There is a long-term solution though; ideally we would like to make use of the Docker workflow to change the certificates but also achieve additional objectives:

1. Document what changes we are making to the Docker containers
2. Have the changes persist between updates

Building a custom Docker image that is based on our original image will allow us to achieve this. The following example will demonstrate the changes required for the iTDS server. The example will assume that you are in a directory containing the following files:

1. Dockerfile: new Dockerfile created
2. itds-custom.yml: additional Docker-compose file to customize Docker setup
3. internal_cert.crt: Your certificate you want to use with the iTDS
4. internal_cert.key: Your certificate's key file

First we need to build a new Docker image that is based off of our image and contains the custom certificate and its key.

We can do this by creating the following Dockerfile:

FROM registry.paterva.com/itdsphp:latest 
COPY ./internal_cert.crt /etc/ssl/private/server.crt 
COPY ./internal_cert.key /etc/ssl/private/server.key

This will create a new Docker image that is based off our server image, but has new certificate and its key copied from a local directory into the container.

Next we need to change our Docker-compose file to reference the local Dockerfile, rather than using our images directly. We will make changes to our compose file, whilst following the guidelines outlined here.

We can create a new Docker-compose file with the filename “itds-custom.yml”. The file should have the following contents:

version: '3'
services:
  itdsphp:
    build: .

The above contents tells Docker to build an image using the Dockerfile from the local directory, rather than running our image directly.

We can then run the server using our new certificate with the command:

docker-compose -f itds.yml -f itds-custom.yml up -d

This will build and start a new server using the your certificate and its key for HTTPS connections.

Method 2: Temporary Solution

If rebuilding containers won’t be an option for you, you can replace the SSL certificates inside the container.

Warning: This is a temporary solution that won’t survive an update. You need to repeat these instructions in the future.

Log into the Server or VM that hosts the iTDS Docker Containers.

Prepare new certificate

Prepare a new certificate as per the requirements of your organization.

Log into the iTDS PHP container terminal

Start by obtaining the Container ID or Container Name.

docker ps

CONTAINER ID IMAGE ... NAMES
d0b626f099e1 registry.paterva.com/itdsphp:latest ... maltego_itdsphp_1
c1c462fe7319 registry.paterva.com/itdsdb:latest ... maltego_itdsdb_1

sudo docker exec -it d0b626f099e1 bash

root@d0b626f099e1:/#

cd /etc/ssl/private/
ll

drwx------ 1 root root 4096 Oct 19 2018 ./
drwxr-xr-x 1 root root 4096 Oct 19 2018 ../
-rw-r--r-- 1 root root 1724 Oct 19 2018 CA.crt
-rw-r--r-- 1 root root 1196 Oct 19 2018 server.crt
-rw-r--r-- 1 root root 1704 Oct 19 2018 server.key

mv server.crt server.crt.bck
mv server.key server.key.bck
ll

drwx------ 1 root root 4096 Jul 9 07:19 ./
drwxr-xr-x 1 root root 4096 Oct 19 2018 ../
-rw-r--r-- 1 root root 1724 Oct 19 2018 CA.crt
-rw-r--r-- 1 root root 1196 Oct 19 2018 server.crt.bck
-rw-r--r-- 1 root root 1704 Oct 19 2018 server.key.bck

exit

Copy the custom SSL certificates to the iTDS PHP container

Use the same Docker Container ID or Container Name used previously to log into the iTDS PHP container to copy the new certificates into the container.

sudo docker cp new_ssl.crt d0b626f099e1:/etc/ssl/private/server.crt
sudo docker cp new_ssl.key d0b626f099e1:/etc/ssl/private/server.key

Restart the iTDS PHP Container.

Use the same Docker Container ID or Container Name used previously to log into the iTDS PHP container.

sudo docker restart d0b626f099e1