Topic

Authenticating using a private key for SFTP in Everbridge Suite.

Description

When configuring SFTP for contact and/or asset uploads, you have the choice of authenticating with a private key or a public key. This article explains how to authenticate using an Everbridge private key also known as an Everbridge soft key. For information on authenticating using an Everbridge public key, please see knowledge base article EBS: Authenticating Using a Public Key for SFTP in Everbridge Suite.

***Please note: NEVER, EVER, EVER, send an org’s private key over an unencrypted communication channel such as email. Doing so breaks the “chain of custody” so to speak and most clients would consider that key compromised.***

Before You Begin

Download the PuTTYgen Tool

Go to http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

Download/Generate the Private Key

Account Level

1. Log in to the Everbridge Manager Portal as an Account Administrator
2. Select Settings > Security > Secure FTP
3. Select Private Key
4. If Download is grayed out, click Generate a New Key 

5. Once the Download button is available, select Download to save the Soft Key to your local machine.

The downloaded key file name should be in the format of [AccountName], where [AccountName] is the name of your account.

NOTE: The file name cannot contain spaces.

Organization Level

1. Log in to the Everbridge Manager Portal and select your Organization
2. Select Settings > Organization > Contacts/Assets > Upload Options
3. Select Private Key
4. If Download is grayed out, click Generate a New Key

5. Once the Download button is available, select Download to save the Soft Key to your local machine.

The downloaded key file name should be in the format of [OrganizationName].key, where [OrganizationName] is the name of your organization.

NOTE: The file name cannot contain spaces.

Convert the Key

The key you download from the manager portal is already in the correct format for any Unix/Linux clients as well as Filezilla. If you are using WinSCP, the key needs to be converted by following the steps below:

Convert the PKCS1 key to a Putty Compatible Key. PuttyGen creates the key in a .ppk format. This is the format that WinSCP requires.

1. Run PuTTYgen
2. Select Conversions from the top menu
3. Select Import Key from the drop-down menu

4. Toggle the Private key button

• • There is no need for a passphrase
  • The system will default to create an RSA key, which is fine for use with the Everbridge system
  • Save the key to a .pgb file.