Using Passbolt CE AWS AMI

Passbolt Amazon Machine Image (AMI) provides a ready to use passbolt image that you can use for free on your Amazon Web Services infrastructure. The AMI includes the following software:

• Debian 11
• Nginx
• Php-fpm
• Mariadb
• Passbolt CE preinstalled
• certbot

This AMI does not provide an email server preinstalled so users can manually install it or leverage on third party email providers.

1. Getting started with passbolt CE AMI

You can subscribe to passbolt CE on the following AWS marketplace listing. Just click on “continue to subscribe” button on the listing page.

fig. Subscribe to passbolt marketplace

The EULA for the passbolt CE is the AGPL license you have to accept that in order to use this image by just clicking on the “Accept terms” button.

fig. Accept AMI terms

Once the terms are accepted you can click on “Continue to configuration” button. In the next screen you will be able to select which version of the AMI you want to use as well as in which AWS region you want the instance to be launched. Once you have selected your desired configuration just click on “Continue to Launch” button.

fig. Configure instance region and version

On the launch screen you will be able to select:

• How to launch the instance
• Instance type
• VPC
• Subnet settings
• Security group settings
• Key pair settings

If you do not know what this fields mean just rely on the defaults making sure that they key pair is available on your local machine so you can connect through SSH to the instance. If all the values are good just click on “Launch” button.

fig. Launch instance

1.1. Setup HTTPS (optional, but highly recommended):

If you are planning to use this AWS instance in production, it is highly recommended to setup SSL. There are two main methods described below:

• Auto (Using Let’s Encrypt)
• Manual (Using user-provided SSL certificates)

2. Configure passbolt

Before you can use the application, you need to configure it. Point your browser to the hostname / ip where passbolt can be reached. You will reach a getting started page.

fig. passbolt welcome page before configuration

2.1. Healthcheck

The first page of the wizard will tell you if your environment is ready for passbolt. Solve issues if any and click on “Start configuration” when ready.

fig. wizard - healthcheck

2.2. Database

Passbolt AWS AMI comes with a preinstalled mariadb database. The credentials for this database are randomly generated on the first boot and the webinstaller autofills those credentials for you. The autogenerated database credentials will be available for later use by administrators in /etc/passbolt/passbolt.php file.

If you decide to use the autogenerated credentials you can click the “Next” button and move to the next step on this tutorial.

fig. wizard - database

Optional: in case you do not want to use the autogenerated mariadb credentials you could connect through ssh to your instance and use the mariadb root credentials to create a new user, password and database for passbolt to use:

ssh [email protected]<your_domain|instance_ip>

You can find the root database credentials in /root/.mysql_credentials file:

sudo cat /root/.mysql_credentials

Once you have the root database credentials you can connect to the local mariadb and create any database and user you want to use to install passbolt.

2.2. GPG key

In this section you can either generate or import a GPG key pair. This key pair will be used by passbolt API to authenticate itself during the login handshake process.

Generate a key if you don’t have one.

fig. wizard - generate a key pair

Optional: Import a key if you already have one and you want your server to use it.

To create a new GnuPG key without passphrase:

gpg --batch --no-tty --gen-key <<EOF
  Key-Type: default
  Key-Length: 2048
  Subkey-Type: default
  Subkey-Length: 2048
  Name-Real: John Doe
  Name-Email: [email protected]
  Expire-Date: 0
  %no-protection
  %commit
EOF

Feel free to replace Name-Real and Name-Email with your own.

To display your new key:

gpg --armor --export-secret-keys [email protected]

fig. wizard - import a key pair

2.3. Mail server (SMTP)

At this stage, the wizard will ask you to enter the details of your SMTP server.

fig. wizard - smtp mail server details

You can also test that your configuration is correct by using the test email feature at the right of your screen. Enter the email address at which you want the wizard to send you a test email and click on “Send test email”.

fig. wizard - test smtp settings

2.4. Preferences

The wizard will then ask you what preferences you prefer for your instance of passbolt. The recommended defaults are already pre-populated but you can also change them if you know what you are doing.

fig. wizard - preferences

2.5. First user creation

You need to create the first admin user account. This first admin user is probably you, so enter your details and click on next.

fig. wizard - first user

2.6. Installation

That’s it. The wizard has now enough information to proceed with the configuration of passbolt. Sit back and relax for a few seconds while the configuration process is going on.

fig. wizard - installation

Your user account is now created. You will see a redirection page for a few second and then will be redirected to the user setup process so that you can configure your user account.

fig. wizard - completion and redirection

3. Configure your administrator account

3.1. Download the plugin

Before continuing passbolt will require you to download its plugin. If you already have it installed you can go to the next step.

fig. download the browser extension

3.2. Create a new key

Passbolt will ask you to create or import a key that will be later use to identify you and encrypt your passwords. Your key needs to be protected by a password. Choose it wisely, it will be the gatekeeper to all your other passwords.

fig. generate a key

3.3. Download your recovery kit

This step is essential. Your key is the only way to access your account and passwords. If you lose this key (by breaking or losing your computer and not having a backup for example), your encrypted data will be lost even if you remember your passphrase.

fig. download the recovery kit

3.4. Define your security token

Choosing a color and a three characters token is a secondary security mechanism that helps you to mitigate phishing attacks. Each time you are performing a sensitive operation on passbolt, you should see this token.

fig. define your security token

3.5. That’s it!

Your administrator account is configured. You will be redirected to the login page of passbolt. Enjoy!