diff --git a/pages/instances/how-to/assets/scaleway-putty-ssh.webp b/pages/instances/how-to/assets/scaleway-putty-ssh.webp index 8b0ac2219a..2c958e5dd8 100644 Binary files a/pages/instances/how-to/assets/scaleway-putty-ssh.webp and b/pages/instances/how-to/assets/scaleway-putty-ssh.webp differ diff --git a/pages/instances/how-to/connect-to-instance.mdx b/pages/instances/how-to/connect-to-instance.mdx index 986afa6e39..e4b1b43d03 100644 --- a/pages/instances/how-to/connect-to-instance.mdx +++ b/pages/instances/how-to/connect-to-instance.mdx @@ -64,7 +64,7 @@ This page shows how to connect to your Scaleway Instance via SSH. Thanks to the click **Instances** in the Compute section of the side menu. A list of your Instances and their associated IP addresses will display. - 4. In the side menu, under **Connection**, navigate to the **Auth** sub-category. Do this by expanding **Connection**, then **SSH**, and finally clicking on **Auth**: + 4. In the side menu, expand the **Connection**, **SSH** and **Auth** submenus, then click **Credentials**: 5. Click the **Browse** button and select the private key file you [generated previously](/organizations-and-projects/how-to/create-ssh-key/). 6. Click **Open** at the bottom of the screen to open a connection to the Instance. Upon the first connection, PuTTY asks you to allow the connection to the host. diff --git a/pages/organizations-and-projects/how-to/create-ssh-key.mdx b/pages/organizations-and-projects/how-to/create-ssh-key.mdx index dfd83c6633..f2a1ee8fdb 100644 --- a/pages/organizations-and-projects/how-to/create-ssh-key.mdx +++ b/pages/organizations-and-projects/how-to/create-ssh-key.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to generate an SSH key pair tags: generate key ssh ssh-key create publickey public-key dates: - validation: 2024-12-19 + validation: 2025-04-01 posted: 2021-06-08 categories: - console @@ -20,88 +20,104 @@ categories: You can generate the SSH key pair on your local machine. The process will depend on your operating system. - - -- A Scaleway account logged into the [console](https://console.scaleway.com) -- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - -## How to generate an Ed25519 SSH key pair +We recommend you use either: -### How to generate an Ed25519 SSH key pair on macOS and Linux +- an [Ed25519 SSH key pair](#how-to-generate-an-ed25519-ssh-key-pair), to connect to your Linux-based Instances. -On macOS and Linux, you can generate the SSH key pair directly from the terminal. +- an [RSA SSH key pair](#how-to-generate-a-rsa-ssh-key-pair), to connect to your Windows-based Instances. -1. Open the terminal application by clicking on the corresponding icon. - -2. Type the following command and press **Enter** to generate a new key: - ```bash - ssh-keygen -t ed25519 -C "login@example.com" - ``` - - It is strongly recommended to use [Ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) for increased security and performance. If you cannot use Ed25519 keys, you can create an RSA4096 key as a fallback option: - ```bash - ssh-keygen -o -b 4096 -C "login@example.com" - ``` - -3. When prompted to enter a file path in which to save the key, either specify a path or press **Enter** to accept the default location (`~/.ssh/id_ed25519`). - ``` - Enter file in which to save the key (~/.ssh/id_ed25519): - ``` -4. Enter a passphrase when prompted. This step is optional but recommended for increased security. If you do not want to set a passphrase, press **Enter** directly. - ``` - Enter passphrase (empty for no passphrase): - ``` -5. Confirm the passphrase by entering it again when prompted, and press **Enter**: - ``` - Enter same passphrase again: - ``` + - The key pair will be generated in the specified filepath. The key pair consists of: - - The public key, named `id_ed25519.pub` - - The private key, named `id_ed25519` - - Ensure that the private key file (``) is kept secure. Do not share it with unauthorized parties. You can set appropriate permissions on the file to restrict access using the following command: - ```bash - chmod 600 - ``` - -6. Display the content of the public key with the following command and copy it: - ```bash - cat ~/.ssh/id_ed25519.pub - ``` -7. Copy the content of the public key displayed. You will need this in the next step. It should look something like this: - ``` - ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINPZxtCMs5sIfsMWpq7SHuqFFpBtSTmFqXWOYdf6dX4i login@example.com - ``` +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization -### How to generate an Ed25519 SSH key pair on Windows - -On Windows, you can use the third-party application [PuTTYgen](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) to generate an SSH key pair. - -1. Download and install [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) on your local computer. The **PuTTYgen** application is automatically installed along with the main PuTTY application. - -2. Launch PuTTYgen by double-clicking the application icon. -3. Select **EdDSA** and click the **Generate** button. You can also add a passphrase before generating the key to increase security. - -4. Move the mouse around the blank area as instructed to generate randomness. - - - The public and private key are generated, and the following screen will display: - -5. Complete the steps on the screen to finish: - - Fill in the **Key comment** field with a name to help you identify this key pair. - - Click the **Save public key** button and save it in the folder of your choice. - - Click the **Save private key** button to save it in the same folder. - - Ensure that the private key file (``) is kept secure. Do not share it with unauthorized parties. - - - Select the content of the public key (the sequence of characters under "Public key for pasting into OpenSSH authorized_keys file") and copy it, as you will need this in the next step/ - -## How to generate a RSA SSH key pair - - - - Windows-based Instances require a special type of SSH key known as RSA (Rivest-Shamir-Adleman), a prevalent asymmetric cryptographic algorithm used for secure data transmission. - - It is recommended to use [Ed25519 keys](#how-to-generate-an-ed25519-ssh-key-pair) for SSH connections to your Linux Instances. +## How to generate an SSH key pair + +### How to generate an Ed25519 SSH key pair + +Ed25519 SSH key pairs allow you to connect to your Linux-based Instances from a macOS, Linux or Windows machine. + + + + + On macOS and Linux, you can generate the SSH key pair directly from the terminal. + + 1. Open a terminal. + + 2. Run the following command to generate a new key: + ```bash + ssh-keygen -t ed25519 -C "login@example.com" + ``` + + It is strongly recommended to use [Ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) for increased security and performance. If you cannot use Ed25519 keys, you can create an RSA4096 key as a fallback option: + ```bash + ssh-keygen -o -b 4096 -C "login@example.com" + ``` + + 3. When prompted to enter a file path in which to save the key, either specify a path or press **Enter** to accept the default location (`~/.ssh/id_ed25519`). + ``` + Enter file in which to save the key (~/.ssh/id_ed25519): + ``` + 4. Enter a passphrase when prompted. This step is optional but recommended for increased security. If you do not want to set a passphrase, press **Enter** directly. + ``` + Enter passphrase (empty for no passphrase): + ``` + 5. Confirm the passphrase by entering it again when prompted, and press **Enter**: + ``` + Enter same passphrase again: + ``` + + The key pair will be generated in the specified filepath. The key pair consists of: + - The public key, named `id_ed25519.pub` + - The private key, named `id_ed25519` + + Ensure that the private key file (``) is kept secure. Do not share it with unauthorized parties. You can set appropriate permissions on the file to restrict access using the following command: + ```bash + chmod 600 + ``` + + 6. Display the content of the public key with the following command and copy it: + ```bash + cat ~/.ssh/id_ed25519.pub + ``` + An output similar to the following displays: + ``` + ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINPZxtCMs5sIfsMWpq7SHuqFFpBtSTmFqXWOYdf6dX4i login@example.com + ``` + 7. Copy the content of the public key displayed, as you will need this in the next step. + + + + + On Windows, you can use the third-party application [PuTTYgen](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) to generate an SSH key pair. + + 1. Download and install [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) on your local computer. The **PuTTYgen** application is automatically installed along with the main PuTTY application. + + 2. Launch PuTTYgen by double-clicking the application icon. + 3. Select **EdDSA** and click the **Generate** button. You can also add a passphrase before generating the key to increase security. + + 4. Move the mouse around the blank area as instructed to generate randomness. + + + The public and private key are generated, and the following screen will display: + + 5. Complete the steps on the screen to finish: + - Fill in the **Key comment** field with a name to help you identify this key pair. + - Click the **Save public key** button and save it in the folder of your choice. + - Click the **Save private key** button to save it in the same folder. + + Ensure that the private key file (``) is kept secure. Do not share it with unauthorized parties. + + - Select the content of the public key (the sequence of characters under "Public key for pasting into OpenSSH authorized_keys file") and copy it, as you will need this in the next step. + + + +### How to generate a RSA SSH key pair + +RSA SSH key pairs allow you to connect to your Windows-based Instances from a macOS, Linux or Windows machine. RSA (Rivest-Shamir-Adleman) is a prevalent asymmetric cryptographic algorithm used for secure data transmission. + + +We recommend you use [Ed25519 keys](#how-to-generate-an-ed25519-ssh-key-pair) for SSH connections to your Linux Instances. 1. Open a terminal or command prompt on your local machine. This could be Terminal on macOS/Linux or the Command Prompt/PowerShell on Windows. @@ -127,19 +143,21 @@ On Windows, you can use the third-party application [PuTTYgen](https://www.chiar You must upload the content of the public part of the SSH key pair you just generated to the Scaleway interface. This is then transferred to your Instance during the boot process. You can then connect and authenticate from your local machine, where your private key is stored, to the remote Instance, where the public key can be found. -1. Log into the [Scaleway console](https://console.scaleway.com), and navigate to the [Credentials](/iam/concepts/#api-key) tab of your Project Dashboard: - -2. Scroll down to the **SSH key** section, and click **Add a new SSH key**. - -3. Paste the content of the public key (which you copied in the previous step) into the pop-up box, and optionally add a description. Then click **Add an SSH key**. +1. Log into the [Scaleway console](https://console.scaleway.com). - You will now be able to [connect to your Instances via SSH](/instances/how-to/connect-to-instance/). +2. Click the name of your Organization in the top-right corner, then select **SSH Keys**. - - If you have any difficulties connecting to an Instance after uploading a new public SSH key to your Project, try the following: - - If you cannot connect to your Instance at all via SSH, reboot your Instance from the console and try again. - - If you can connect to your Instance using a previously uploaded SSH key but not the new one, go ahead and connect to your Instance with the old key. Once connected, run the `scw-fetch-ssh-keys --upgrade` command, which launches a script on your Instance to update your SSH keys. You can then check that the new key has been added to the `authorized_keys` file (`~/.ssh/authorized_keys`). Note that this command works only for Instances. - - For further information, refer to the [SSH connection troubleshooting](/instances/troubleshooting/cant-connect-ssh/) documentation. - +2. Click **+ Add SSH key**. A popup displays. + +3. Enter a name for your SSH key, paste the content of the public key copied earlier into the **Public key** box, then click **Add SSH key**. + + You can now [connect to your Instances via SSH](/instances/how-to/connect-to-instance/). + +## Troubleshooting + +If you have any difficulties connecting to an Instance after uploading a new public SSH key to your Project, try the following: + - If you cannot connect to your Instance at all via SSH, reboot your Instance from the console and try again. + - If you can connect to your Instance using a previously uploaded SSH key but not the new one, go ahead and connect to your Instance with the old key. Once connected, run the `scw-fetch-ssh-keys --upgrade` command, which launches a script on your Instance to update your SSH keys. You can then check that the new key has been added to the `authorized_keys` file (`~/.ssh/authorized_keys`). Note that this command works only for Instances. +For further information, refer to the dedicated [SSH connection troubleshooting](/instances/troubleshooting/cant-connect-ssh/) documentation.