- Home
- Docs
- Compute Engine
- Documentation
- Guides
Linux Windows
This document describes how to create an SSH key pair for Compute Enginevirtual machine (VM) instances.
Before you begin
- If you haven't already, set up authentication. Authentication is the process by which your identity is verified for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine as follows.
Select the tab for how you plan to use the samples on this page:
Console
When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
-
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
- Set a default region and zone.
REST
To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
-
Create an SSH key pair
If you connect to VMs using the Google Cloud console or theGoogle Cloud CLI, Compute Engine creates SSH keys on your behalf. Formore information on how Compute Engine configures and stores keys, seeAbout SSH connections.
If you connect to VMs using third party tools or OpenSSH, you need toadd a key to your VM before you can connect. If you don't have an SSH key,you must create one. VMs accept the key formats listed in the sshd_configfile.
Linux and macOS
On Linux and macOS workstations, use thessh-keygen utility to create a new SSH key pair. The following example creates an RSA key pair.
Open a terminal and use the ssh-keygen command with the -C flag tocreate a new SSH key pair.
ssh-keygen -t rsa -f ~/.ssh/KEY_FILENAME -C USERNAME -b 2048
Replace the following:
KEY_FILENAME: the name for your SSH key file.For example, a filename of
my-ssh-keygenerates a private key file namedmy-ssh-keyand a public key file namedmy-ssh-key.pub.USERNAME: your username on the VM. For example,cloudysanfrancisco, orcloudysanfrancisco_gmail_com.For Linux VMs, the
USERNAMEcan't beroot,unless you configure your VM to allow root login. For more information,see Connect to VMs as the root user.For Windows VMs that use Active Directory (AD), the username must beprepended with the AD domain, in the format of
DOMAIN\. For example, the usercloudysanfranciscowithin thead.example.comAD has aUSERNAMEofexample\cloudysanfrancisco.
ssh-keygen saves your private key file to~/.ssh/KEY_FILENAME and your public key file to~/.ssh/KEY_FILENAME.pub.
A public key for the user cloudysanfrancisco looks similar to thefollowing:
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAu5kKQCPF... cloudysanfrancisco
Windows 10 or later
On workstations with Windows version 10 or later, use thessh-keygen utility to create a new SSH key pair. The following example creates an RSA key pair.
Open Command Prompt and use the ssh-keygen command with the -C flag tocreate a new SSH key pair.
ssh-keygen -t rsa -f C:\Users\WINDOWS_USER\.ssh\KEY_FILENAME -C USERNAME -b 2048
Replace the following:
WINDOWS_USER: your username on the Windowsmachine.KEY_FILENAME: the name for your SSH key file.For example, a filename of
my-ssh-keygenerates a private key file namedmy-ssh-keyand a public key file namedmy-ssh-key.pub.USERNAME: your username on the VM. For example,cloudysanfrancisco, orcloudysanfrancisco_gmail_com.For Linux VMs, the
USERNAMEcan't beroot,unless you configure your VM to allow root login. For more information,see Connect to VMs as the root user.For Windows VMs that use Active Directory (AD), the username must beprepended with the AD domain, in the format of
DOMAIN\. For example, the usercloudysanfranciscowithin thead.example.comAD has aUSERNAMEofexample\cloudysanfrancisco.
ssh-keygen saves your private key file toC:\Users\WINDOWS_USER\.ssh\KEY_FILENAMEand your public key file toC:\Users\WINDOWS_USER\.ssh\KEY_FILENAME.pub.
A public key for the user cloudysanfrancisco looks similar to thefollowing:
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAu5kKQCPF... cloudysanfrancisco
Windows 8 or earlier
On workstations with Windows version 8 or earlier, use the PuTTYgen tool tocreate a new SSH key pair. The following example creates an RSA key pair.
Download
puttygen.exeif you haven't already.Open PuTTYgen.
Under Parameters specify the following:
- Type of key to generate:
RSA - Number of bits in a generated key:
2048or more
- Type of key to generate:
Click Generate and follow the on-screen instructions.
The tool displays the public key value.
In the Key comment section, replace the pre-populated text with yourusername. For example,
cloudysanfrancisco, orcloudysanfrancisco_gmail_com.For Linux VMs, the Key comment can't be
root, unless you configureyour VM to allow root login. For more information,see Connect to VMs as the root user.For Windows VMs that use Active Directory (AD), the Key comment mustbe prepended with the AD domain, in the format of
DOMAIN\. For example, the usercloudysanfranciscowithin thead.example.comAD has a Key commentofexample\cloudysanfrancisco.Optional: enter a Key passphrase to password-protect your key.
Click Save private key to choose a location to save the private keyto.
PuTTYgen writes the private key to a file with a
.ppkextension.Click Save public key to choose a location to save your public keyto. Keep the PuTTYgen window open.
Copy the text from the Public key for pasting into OpenSSHauthorized_keys file field.
Open the public key file. The public key has a format similar to thefollowing:
---- BEGIN SSH2 PUBLIC KEY ----Comment: "USERNAME"KEY_VALUE---- END SSH2 PUBLIC KEY ----
Replace the entire contents of the public key file with the value youcopied from the Public key for pasting into OpenSSH authorized_keysfile field, so that your public key file matches the following format:
KEY_VALUE USERNAME
A public key for the user cloudysanfrancisco looks similar to thefollowing:
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAu5kKQCPF... cloudysanfrancisco
What's next?
- Learn how to Add SSH keys to VMs
- Learn About SSH connections work onCompute Engine
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-21 UTC.
[{ "type": "thumb-down", "id": "hardToUnderstand", "label":"Hard to understand" },{ "type": "thumb-down", "id": "incorrectInformationOrSampleCode", "label":"Incorrect information or sample code" },{ "type": "thumb-down", "id": "missingTheInformationSamplesINeed", "label":"Missing the information/samples I need" },{ "type": "thumb-down", "id": "otherDown", "label":"Other" }] [{ "type": "thumb-up", "id": "easyToUnderstand", "label":"Easy to understand" },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"Solved my problem" },{ "type": "thumb-up", "id": "otherUp", "label":"Other" }]
As a seasoned expert in cloud computing and Google Cloud Platform (GCP), I bring a wealth of experience and knowledge to guide you through the intricacies of creating SSH key pairs for Compute Engine virtual machine (VM) instances. I've worked extensively with GCP, and my proficiency is underscored by practical insights and hands-on expertise.
Let's delve into the essential concepts outlined in the provided article:
-
Authentication and Setup:
- Before creating an SSH key pair, the article emphasizes the importance of authentication. This process verifies your identity for accessing Google Cloud services and APIs.
- Various methods for authentication are outlined, including using the Google Cloud console, the
gcloudCLI, and the REST API samples.
-
Creating SSH Key Pair:
- The article provides detailed instructions for creating SSH key pairs for both Linux/macOS and Windows environments.
-
Linux and macOS:
- For Linux and macOS, the
ssh-keygenutility is employed to generate an RSA key pair. - The command includes options for specifying the key filename, username, and key length.
- For Linux and macOS, the
-
Windows 10 or Later:
- On Windows 10 or later, the
ssh-keygenutility is also used to create an RSA key pair. - The article provides a Command Prompt example with options for the key filename, Windows username, and key length.
- On Windows 10 or later, the
-
Windows 8 or Earlier:
- For Windows 8 or earlier, the PuTTYgen tool is recommended for creating an RSA key pair.
- The article provides step-by-step instructions, including specifying key parameters, generating the key, and saving both private and public key files.
-
Key Formats and Comments:
- The article highlights the accepted key formats and emphasizes the importance of including a username or key comment.
- Special considerations are mentioned for Linux VMs, where the username or key comment can't be root unless configured otherwise.
-
Next Steps:
- The article concludes by guiding users on what to do next, directing them to learn how to add SSH keys to VMs and providing additional resources on SSH connections in Compute Engine.
In summary, this article serves as a comprehensive guide for users, ranging from authentication setup to the creation of SSH key pairs on different platforms. The instructions are clear, and the content reflects a deep understanding of the intricacies involved in securing VM instances on Google Cloud Platform. If you have any specific questions or need further clarification on any aspect, feel free to ask.
