HaloPSA

HaloPSA Guides

Documentation to assist with the setup and configuration of the HaloPSA platform

Guides > SFTP guide - including SSH Key pair generation and Public key transfer

SFTP guide - including SSH Key pair generation and Public key transfer

Generating SSH keys

Why?

To use any Halo SFTP Service you will need to generate an SSH Key pair, the private part of this pair will be retained by you and will act as a password when connecting. The public key should be of the form in the Notes Section1 and passed through one of our team members for validation and assignment to a user.

How to generate a key pair

The ssh-keygen command is available on all UNIX and MacOS operating systems, and Windows OS versions newer than Windows 10. This should be used to generate key pairs as it will output in OpenSSH format which is preferable to us.

ssh-keygen

For an explanation on how to generate an SSH key pair please see this guide.

How to access the SFTP Server

Once we receive the public key a credential set is created and a connection information block will be passed back to you in one of two forms2 and this is to be used by yourselves in an SFTP client of your choice. Two great choices are Putty or FileZilla however accessing SFTP can be done using SSH on command line.

Example

Here the user haloguides has requested an SFTP connection.

They generate an SSH Key pair as follows:

ssh-keygen

The public key is then passed to the team at Halo and connection details are returned to you.

A: Connection Details Server: SFTP.haloservicedesk.com Port: 22 Username: haloguides Password: your private key

Using the Key Pair in FileZilla

To use the key pair in FileZilla you should set up a new server connection using the details above. In file> Site Manager> New Site and instead of a password you will select Key File as 'Logon Type' then navigate to your private key.

FileZilla connection

Notes

ssh-rsa 
AAAAB3NzaC1yc2EAAAADAQABAAABAQCba21UHE+VbDTpmYYFZUOV+OQ8AngOCdjROsPC0KiEfMvEaEM3NQl58u6QL7G7QsErKViiNPm9OTFo6HF5JijfWzK7haHFuRMEsgI4VwIYyhvqlJDfw/wt0AiVvSmoMfEQn1p1aiaO4V/RJSE3Vw/uz2bxiT22uSkSqOyShyfYE6dMHnuoBkzr4jvSifT+INmbv6Nyo4+AAMCZtYeHLrsFeSTjLL9jMPjI4ZkVdlw2n3Xn9NbltF3/8Ao8dQfElqw+LIQWqU0oFHYNIP4ttfl5ObMKHaKSvBMyNruZR0El/ZsrcHLkAHRCLj07KRQJ81l5CUTPtQ02P1Eamz/nT4I3

A:
Connection Details
Server: *SFTP Server Address*
Port: 22
Username: *username*
Password: *your private key*

B:
{ 
    "Connection Details":[
        {
            "Server": "*SFTP Server Address*",
            "Port": 22,
            "Username": "*username*",
            "Password": "*your private key*"
        }
    ]
}

  1. ↩

  2. ↩

Popular Guides