How to automate starting the ssh agent and adding my key(s) in WSL2 for Windows 11

If you're using Windows 11 and the Windows Subsystem for Linux 2 (WSL2) to work with SSH, you might find it tedious to manually start the SSH agent and add your key(s) every time you open a new terminal session. Thankfully, there's a way to automate this process and save you time and effort. In this article, we'll guide you through the steps to automate starting the SSH agent and adding your key(s) in WSL2 for Windows 11.

Step 1: Install OpenSSH Client

Before we begin, make sure you have the OpenSSH client installed on your Windows 11 system. If it's not already installed, you can follow these steps to install it:

1. Open the Windows Settings by clicking on the Start menu and selecting the gear icon.
2. In the Settings window, click on "Apps" and then select "Optional features" from the left-hand menu.
3. Click on "Add a feature" and search for "OpenSSH Client" in the list of available features.
4. Click on "Install" to install the OpenSSH client.

Step 2: Configure SSH Keys

Next, you need to configure your SSH keys. If you already have SSH keys generated, you can skip this step. Otherwise, follow these instructions to generate a new SSH key pair:

1. Open a new terminal in WSL2 by clicking on the Start menu, searching for "WSL" and selecting "WSL"
2. In the terminal, run the following command to generate a new SSH key pair:

   ssh-keygen -t rsa -b 4096

   This command will prompt you to enter a file name to save the key pair. You can press Enter to accept the default location, or specify a different file path.
3. Next, you'll be asked to enter a passphrase for your key. It's recommended to set a passphrase for added security. Press Enter if you want to skip setting a passphrase.
4. After generating the key pair, you can view the public key by running the following command:

   cat ~/.ssh/id_rsa.pub

   Make note of the public key as we'll need it in the next step.

Step 3: Automate SSH Agent Startup

Now, let's automate the startup of the SSH agent in WSL2. We'll achieve this by adding a few lines of code to your .bashrc file, which is a script that runs every time you open a new terminal session.

1. Open a terminal in WSL2.
2. Run the following command to open the .bashrc file in a text editor:

   nano ~/.bashrc

3. In the .bashrc file, add the following lines at the end:

   eval $(ssh-agent)
   ssh-add ~/.ssh/id_rsa

   These lines start the SSH agent and add your default SSH key to it. If you have multiple keys, you can add additional ssh-add commands for each key.
4. Save the file by pressing Ctrl + O, then exit the text editor by pressing Ctrl + X.

Step 4: Test the Automation

To ensure that the automation is working correctly, open a new terminal session in WSL2 and check if the SSH agent is started and your key(s) are added automatically.

1. Open a new terminal in WSL2.
2. Run the following command to check if the SSH agent is running:

   ssh-add -l

   If you see a list of your SSH keys, it means the SSH agent is running and your key(s) are added automatically.

That's it! You have successfully automated the process of starting the SSH agent and adding your key(s) in WSL2 for Windows 11. Now, every time you open a new terminal session, the SSH agent will be started automatically and your key(s) will be added without any manual intervention.

Conclusion

Automating the startup of the SSH agent and adding your key(s) in WSL2 can greatly simplify your workflow and save you time. By following the steps outlined in this article, you can ensure that the SSH agent starts automatically and your key(s) are added without any manual effort. Enjoy a seamless SSH experience in WSL2 on Windows 11!

References