<style>p { margin: 0 0 10px; }h1, h2, h3 { margin: 20px 0 10px; }h4, h5, h6 { margin: 10px 0 10px; }</style><p>A short guide on generating and using SSH keys for use with Halo SFTP</p>

<style>p { margin: 0 0 10px; }h1, h2, h3 { margin: 20px 0 10px; }h4, h5, h6 { margin: 10px 0 10px; }</style><h1 id="generating-ssh-keys">Generating SSH keys</h1> <h2 id="why">Why?</h2> <p>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 <a href="#Notes">Notes Section</a>[^1] and passed through one of our team members for validation and assignment to a user.</p> <h2 id="how-to-generate-a-key-pair">How to generate a key pair</h2> <p>The <code>ssh-keygen</code> 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.</p> <p><img src="https://s3.haloservicedesk.com/CustomerImages/halo/InfraGuides/ssh-keygen-usage.png" alt="ssh-keygen" /></p> <p>For an explanation on how to generate an SSH key pair please see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/key-management.html" target="_blank"><b>this guide</b></a>.</p> <h2 id="how-to-access-the-sftp-server">How to access the SFTP Server</h2> <p>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 forms[^2] and this is to be used by yourselves in an SFTP client of your choice. Two great choices are <a href="https://www.putty.org/">Putty</a> or <a href="https://filezilla-project.org/">FileZilla</a> however accessing SFTP can be done using SSH on command line.</p> <h3 id="example">Example</h3> <p>Here the user <code>haloguides</code> has requested an SFTP connection.</p> <p>They generate an SSH Key pair as follows:</p> <p><img src="https://s3.haloservicedesk.com/CustomerImages/halo/InfraGuides/ssh-keygen.png" alt="ssh-keygen" /></p> <p>The public key is then passed to the team at Halo and connection details are returned to you.</p> <p>Connection Details</p> <p>Server: SFTP.haloservicedesk.com</p> <p>Port: 22</p> <p>Username: haloguides</p> <p>Password: <em>your private key</em></p> <h3 id="using-the-key-pair-in-filezilla">Using the Key Pair in FileZilla</h3> <p>To use the key pair in FileZilla you should set up a new server connection using the details above. In file&gt; Site Manager&gt; New Site and instead of a password you will select Key File as 'Logon Type' then navigate to your private key.</p> <p><img src="https://s3.haloservicedesk.com/CustomerImages/halo/InfraGuides/Filezilla.png" alt="FileZilla connection" /></p>