EBS: SFTP Access Guide & FAQ

lock-solid.svg

Topic:

SFTP Access Guide & FAQ.

Description

This document explains how to set up SFTP access followed by FAQ. The examples in this article use WinSCP, but you may use any SFTP software as noted above.

NOTE: SFTP may be setup at either the Account or Organization level.

Preparation

  1. Download PuTTYgen Tool

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

  1. Download Your SFTP Software

For example, to download WinSCP, go to http://winscp.net/eng/index.php

Account Level Setup

Authenticating Using a Public Key Pair

If you want to use a Public Key and need to generate your own keys, you can do so using PuttyGen. Else skip to the section entitled "Authenticating Using a Private Key".

User-added image

Be sure to save both the public and private keys in PuttyGen. It is easy to overlook this.

Once you have your keys, you will need to follow the steps below:

Add Your Public Key(s) in Everbridge

  1. Log in to the Everbridge Manager Portal
  2. Select Settings > Security > Secure FTP
  3. Click the pencil icon
  4. In the Everbridge interface, change the SFTP Key type to Public Key

User-added image

  1. Enter the SFTP Key Name and SFTP Public Key.

User-added image

  1. Click Add

NOTE: If you have decided to authenticate using a Public Key, skip to step 4 in the "Authenticating Using a Private Key" section, next, and proceed through the rest of the steps.

Authenticating Using a Private Key

  1. Download the Everbridge Soft Key.
    1. Log in to the Everbridge Manager Portal
    2. Select Settings > Security > Secure FTP
    3. Select Private Key and click Generate if Download is grayed out.
    4. Choose 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.

  1. 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.

Conversion Menu and Import Key

  1. 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.
  1. Review these details in Everbridge (you will need these in the following steps):
    1. Log in to the Everbridge Manager Portal
    2. Select Settings > Security > Secure FTP
    3. Take note of the Account ID and the SFTP Host Name (each account's ID is unique and your Host Name may be different than the one shown below).

sftp20.png

Set Up the Connection using your SFTP Software. In this example, WinSCP is being used:

  1. Open WinSCP. This creates a session.
  2. In WinSCP, add the host name from your review, above, in the Host name section.
  3. Set the port to 22.
  4. Set the User Name to your Account ID from your review, above. (The password is not needed.)
  5. Select the Advanced drop-down option.

User-added image  

  1. In either public or private key authentication methods, select Authentication, then navigate to the private key file and load it.

User-added image

  1. Click OK.
  2. On the home screen for WinSCP, choose Login.
  3. Transfer the desired CSV file to the appropriate target Everbridge SFTP folder. For information on the target SFTP folders, please see knowledge base article EBS: Target Destination Folders for SFTP Contact Upload Files. This information is also included in the EBS: Account Administrator Guide and the EBS: Organization Administrator Guide.

NOTE: The file name cannot contain spaces.

Organization Level Setup

Authenticating Using a Public Key Pair

If you want to use a Public Key and need to generate your own keys, you can do so using PuttyGen. Else skip to the section entitled "Authenticating Using a Private Key".

User-added image

Be sure to save both the public and private keys in PuttyGen. It is easy to overlook this.

Once you have your keys, you will need to follow the steps below:

Add Your Public Key(s) in Everbridge

  1. Log in to the Everbridge Manager Portal and select your organization
  2. Select Settings > Organization > Contacts/Assets > Upload Options
  3. In the Everbridge interface, change the SFTP Key type to Public Key  

sftp23.png

  1. Enter the SFTP Key Name and SFTP Public Key

User-added image

  1. Click Add.

NOTE: If you have decided to authenticate using a Public Key, skip to step 4 in the "Authenticating Using a Private Key" section, next, and proceed through the rest of the steps.

Authenticating Using a Private Key 

  1. Download the Everbridge Soft Key.
    1. Log in to the Everbridge Manager Portal
    2. Select Settings > Organization > Contacts/Assets > Upload Options
    3. Select Private Key and click Generate if Download is grayed out.
    4. Choose 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.

  1. 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.

Conversion Menu and Import Key

  1. 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. 
  1. Review these details in Everbridge (you will need these in the following steps):
    1. Log in to the Everbridge Manager Portal
    2. Select Settings > Organization > Contacts/Assets > Upload Options
    3. Take note of the Organization ID and the SFTP Host Name (each organization's ID is unique and your Host Name may be different than the one shown below).

sftp22.png

Set Up the Connection using your SFTP Software. In this example, WinSCP is being used:

  1. Open WinSCP. This creates a session.
  2. In WinSCP, add the host name from your review, above, in the Host name section.
  3. Set the port to 22.
  4. Set the User Name to your Organization ID from your review above. (The password is not needed.)
  5. Select the Advanced drop-down option.

User-added image  

  1. In either public or private key authentication methods, select Authentication, then navigate to the private key file and load it.

User-added image

  1. Click OK.
  2. On the home screen for WinSCP, choose Login.
  3. Transfer the desired CSV file to the appropriate target Everbridge SFTP folder. For information on the target SFTP folders, please see knowledge base article EBS: Target Destination Folders for SFTP Contact Upload Files. This information is also included in the EBS: Account Administrator Guide and the EBS: Organization Administrator Guide.

NOTE: The file name cannot contain spaces.

FAQ

Can I Use Public Keys?

Account and Organization Administrators can add their own Public Keys for SFTP uploads. Up to ten different keys can be configured for your Account or Organization. Please see knowledge base article EBS: Supported Public Key Formats for Connecting to Everbridge Suite via SFTP for more information.

Why should we automate our contact or asset upload process?

Automating the upload process helps to ensure that the Everbridge platform is continuously up-to-date with the most accurate contact or asset information without relying on an end-user to remember to upload a new data file into the system or manually log in to the platform to update or add any new contacts or assets.

How often should we schedule the data transfers?

This depends on how often your contact or asset data changes. For example, many clients who have high employee turnover or dynamic pieces of data will schedule a file to be read into the Everbridge system every night; and others run a file twice per day. Clients with less frequent turnover or who have more static data may only schedule a file transfer once a week, or even once a month.

Who should be involved in setting up the data transfer?

You will want to include your IT team, since they will be responsible for scheduling the transfers. You will also want to include someone who is familiar with the system that the data is being extracted from (HR, EBRP, Access Database, Active Directory, etc.) to assist the IT team with putting the data into the proper upload template. The primary administrator of your Everbridge system for your account or organization should also be involved to make sure the files are being scripted to the proper folder.

How can I be sure that any data manually entered into the system is not overwritten?

This will depend on your specific system setup. During the implementation of your Everbridge system, your implementation consultant will discuss the specific ways your account or organization can automate the data uploads while ensuring that certain information does not get overwritten.

Can I provide Everbridge our public PGP key that we generate to be used?

Not at this time, as our system is not built to accept a key that is generated by our clients.

We use the Amazon EC2 model for our SFTP. Click the following link for more detail: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

Was this article helpful?
0 out of 1 found this helpful

Comments

0 comments

Article is closed for comments.