/ssh-agent-add-id

A wrapper for ssh-add that checks whether a key has already been added to the SSH agent.

Primary LanguagePythonMIT LicenseMIT

ssh-agent-add-id

PyPI version Python versions

A wrapper for ssh-add that checks whether a key has already been added to the SSH agent rather than prompting for the passphrase every time.


Description

ssh-agent-add-id was primarily created to address a pending issue in the VS Code WSL extension when authenticating with an SSH key that requires a passphrase, such as for a remote Git repository. If this key has not been previously added to the SSH agent accessible from the WSL extension, VS Code does not prompt for the passphrase, causing operations like pushing to the remote repository to get stuck.

ssh-agent-add-id serves as a wrapper for the ssh-add command. However, unlike the latter, it does not prompt again for the passphrase and exits quietly if the key has already been added to the SSH agent. It can thus be easily executed in a VS Code task when a project is opened.

And beyond remote Git repositories and WSL, ssh-agent-add-id can be also be used with cloud services that rely on SSH key authentication and thus reduce the number of times you need to enter your passphrases.


Requirements

SSH agent

  • ssh-add and ssh-agent must be installed and running.
  • SSH_AUTH_SOCK environment variable needs be set and accessible from VS Code environment.
  • For Linux/WSL, in order to share a single ssh-agent process for all your shells, it is highly recommended to either run ssh-agent as an user-level systemd service or to install and setup Keychain.

ssh-agent-add-id

  • Requires Python 3.8+.
  • It should run smoothly on macOS and all Linux distributions. However, on Windows, it only runs within WSL.

Installation

ssh-agent-add-id can be installed using pip:

pip install ssh-agent-add-id

VS Code task

Add a task to your VS Code project (in .vscode/tasks.json). Do not forget to update the "args" value with the actual path of your private key file:

    {
      "label": "Add Git SSH key to agent",
      "type": "shell",
      "command": "ssh-agent-add-id",
      "args": ["${userHome}/.ssh/<PRIVATE_KEY_FILE>"],
      "presentation": {
        "panel": "new",
        "revealProblems": "onProblem",
        "close": true
      },
      "runOptions": {
        "runOn": "folderOpen"
      },
      "problemMatcher": []
    }

Thanks to "runOptions"/"runOn": "folderOpen", this task runs every time your project is opened, launching a new dedicated terminal. If the identity/key was already added to the SSH agent, this terminal closes immediately. Otherwise, it prompts for the key passphrase.


Command line usage

usage: ssh-agent-add-id [-h] [--version] priv_key_path [pub_key_path]

positional arguments:
  priv_key_path  the path of the private key file
  pub_key_path   the path of the public key file in case its filename is not <priv_key_path>.pub

optional arguments:
  -h, --help     show this help message and exit
  --verbose      print some extra info
  --version      show program's version number and exit

License

This project is licensed under the terms of the MIT license.