SSH access is needed if your workspace has no desktop or web-interface. Or if you want to use the scp command to upload and download data to and from your workspace.

You will need a private/public key-pair to use ssh.

A private/public key-pair is created on your local computer an allows you to identify that device to other services and devices.

The private key will always stay on your device, the public key can be put on other devices to prove the identity of your local device.

If you are using more than one local device, you create one key-pair for each device. You can submit multiple public keys for ResearchCloud. ResearchCloud automatically copies your public key to any workspace you are entitled to log in to.


At least one portal-login required

Any user of the collaboration is entitled to log in to a workspace.

However, users must have logged in to the Research Cloud portal at least once.

( https://portal.live.surfresearchcloud.nl/ )

Otherwise their public key will not be present on the machine.


We will explain these three steps that will get you logged in:

  1. Create a private/public key-pair on your local computer - if you don't have one, yet. This is a one-time action.
  2. Add the public key into SRAM. (You only have to do that once, too.)
    This will set your public key into your profile.
  3. Access the workspace with SSH.
    Use your favourite/available own SSH client to connect to your workspace.

1. Create a private/public key-pair

When creating your private/public key-pair, it does not matter much which OS your local computer is running.

If you choose the right terminal-application:

Linux and Mac

When you are working from a Linux machine, the SSH commands are already installed and ready to be used from a terminal.

On a Mac the SSH command is also available by default.

Windows 10 or Windows Server 2019

If your local computer runs Windows 10 or Windows Server 2019, SSH is supported, too.

Use a Powershell terminal to issue ssh commands.


You can generate a private/public keypair with:

ssh-keygen

Just use all the defaults by hitting enter directly, or do enter a passphrase if you wish.

To find the public key file, check the screen output of this command.

The location of the *.pub file is given there.

2. Add public key in SRAM. (only has to be done once for a key)

To SSH login to your workspace you have to add your public SSH key into you account. It needs to be added to the SRAM authentication website.

  1. Open the SRAM page : https://sram.surf.nl/home
  2. In the top right click on the "Login" button to login.
  3. Enter your mail address to be redirected to your SSO login page. (Depending on your institute and identity provider this page can be different for different users)
  4. When you are logged in, click on the downward arrow next to your name in the top right of the page. Select the "Profile" menu item.
  5. In the SSH public key field, you can enter your public key from your local public key file. We recommend to use the file upload button for this in order to prevent copy-paste errors. (See the illustration below.)
  6. Click the "Update" button at the bottom of the page.
  7. The update of the public key can take up to 5 min to take effect in Research Cloud.

Putting your private key in your SRAM-profilePutting your private key in your SRAM-profile

Access the workspace with your SSH-client

There are several ssh clients to access your workspace and you can use the one you like as long as it supports public keys.


As soon as you generate a new key-pair on your local computer using the same name, the public key that you have submitted here and your local key will not match, anymore. Make sure that you update the public key when the key on your local computer has changed.

3. Log in with ssh

In your terminal application (or Powershell window) type:


ssh <ResearchCloud username>@<workspace ip address>

The ResearchCloud username is given on the "Profile"-Tab of the ResearchCloud portal page.

The ip-address of the workspace is displayed on the (extendable) display tile of the workspace in the main ("Dashboard") tab.

If you just submitted a new public key or when the workspace is new, you might have to wait for a few minutes for this to work.


More info on ssh on Windows

If you want to read more on ssh on Windows you can check here:

https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse

https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_keymanagement

You only have to install and configure the SSH client.

(In the case of Research Cloud, the "server" is the workspace you will log in to and SSH is already installed, there.)


  • No labels