SecureDrop uses the Ansible automation tool for installation and maintenance.
To install Ansible on the Admin Workstation, first update the
package manager’s package lists to make sure you get the latest and
greatest version of Ansible. This usually takes a few minutes over
Tor. Once that’s done, you can install Ansible:
$ sudo apt-get update $ sudo apt-get install ansible
Configure the Installation¶
Make sure you have the following information and files before continuing:
- The App Server IP address
- The Monitor Server IP address
- The SecureDrop Submission Key (from the Transfer Device)
- The SecureDrop Submission Key fingerprint
- The email address that will receive alerts from OSSEC
- The GPG public key and fingerprint for the email address that will receive the alerts
- Connection information for the SMTP relay that handles OSSEC alerts. For more information, see the OSSEC Alerts Guide.
- The first username of a journalist who will be using SecureDrop (you can add more later)
- The username of the system administrator
- (Optional) An image to replace the SecureDrop logo on the Source
Interface and Journalist Interface
- Recommended size:
500px x 450px
- Recommended format: PNG
- Recommended size:
From the base of the SecureDrop repo, change into the
$ cd install_files/ansible-base
You will have to copy the following required files to
- SecureDrop Submission Key public key file
- Admin GPG public key file (for encrypting OSSEC alerts)
- (Optional) Custom header image file
The SecureDrop Submission Key should be located on your Transfer Device from earlier. It will depend on the location where the USB stick is mounted, but for example, if you are already in the ansible-base directory, you can just run:
$ cp /media/[USB folder]/SecureDrop.asc .
Or you may use the copy and paste capabilities of the file manager. Repeat this step for the Admin GPG key and custom header image.
Now you must edit a couple configuration files. You can do so using gedit, vim, or nano. Double-clicking will suffice to open them.
Edit the inventory file,
inventory, and update the default IP
addresses with the ones you chose for app and mon. When you’re done,
save the file.
Edit the file
prod-specific.yml and fill it out with values that
match your environment. At a minimum, you will need to provide the
- User allowed to connect to both servers with SSH:
- IP address of the Monitor Server:
- Hostname of the Monitor Server:
- Hostname of the Application Server:
- IP address of the Application Server:
- The SecureDrop Submission Key public key file:
- The SecureDrop Submission Key fingerprint:
- GPG public key used when encrypting OSSEC alerts:
- Fingerprint for key used when encrypting OSSEC alerts:
- The email address that will receive alerts from OSSEC:
- The reachable hostname of your SMTP relay:
- The secure SMTP port of your SMTP relay:
smtp_relay_port(typically 25, 587, or 465. Must support TLS encryption)
- Email username to authenticate to the SMTP relay:
- Domain name of the email used to send OSSEC alerts:
- Password of the email used to send OSSEC alerts:
- The fingerprint of your SMTP relay (optional):
Optionally, you can also have custom notification text be displayed on the source interface. The source interface with a custom notification message is shown here (the custom notification appears after the bolded “Note:”):
This custom notification can be configured by providing the desired message in
prod-specific.yml. For example, this can be
used to notify potential sources that an instance is for testing purposes only.
When you’re done, save the file and quit the editor.
Run the Ansible playbook¶
Now you are ready to run the playbook! This will automatically configure
the servers and install SecureDrop and all of its dependencies.
<username> below is the user you created during the Ubuntu
installation, and should be the same user you copied the SSH public keys
$ ansible-playbook -i inventory -u <username> -K --sudo securedrop-prod.yml
You will be prompted to enter the sudo password for the app and monitor servers (which should be the same).
The Ansible playbook will run, installing SecureDrop plus configuring and hardening the servers. This will take some time, and it will return the terminal to you when it is complete. If an error occurs while running the playbook, please submit a detailed GitHub issue or send an email to email@example.com.
Once the installation is complete, the addresses for each Tor Hidden
Service will be available in the following files in
app-source-ths: This is the .onion address of the Source Interface
app-journalist-aths: This is the
HidServAuthconfiguration line for the Journalist Interface. During a later step, this will be automatically added to your Tor configuration file in order to exclusively connect to the hidden service.
app-ssh-aths: Same as above, for SSH access to the Application Server.
mon-ssh-aths: Same as above, for SSH access to the Monitor Server.
Update the inventory, replacing the IP addresses with the corresponding
onion addresses from
mon-ssh-aths. This will
allow you to re-run the Ansible playbooks in the future, even though
part of SecureDrop’s hardening restricts SSH to only being over the
specific authenticated Tor Hidden Services.