Skip to main content

Keep all ssh connection next to you

Project description

ssh_manager

TOML Python

Master Status PyPI - Version

- Keep all ssh connection next to you

And don't distract on password prompts

ssh_manager: 

usage: ssh_m [-h] [-n] [-R] [-C]

optional arguments:
  -h, --help  show this help message and exit
  -n          Proceed new SSH connection to storage Executed by default if storage is empty.
  -R          Acts same as $SSH_M_R Prevents renaming TMUX window on SSH connection.
  -C          Acts same as $SSH_M_C Prevents closing of TMUX after SSH is disconnected.
Since 0.2.0 ssh_manager works both on Windows and *NIX, thanks to InquirerPy

1. Environment

General:
  • python3 - is an interpreted, interactive, object-oriented, open-source programming language.
  • ssh - OpenSSH-compatible client

Password connections:
  • sshpass - Non-interactive ssh password authentication
  • Define user-specific environment variable
    • Unix-like:
      myserver_root=$(cat ~/SuperSecretPasswordForRoot)
      
    • Windows:
      $env:myserver_root=$(cat ~/SuperSecretPasswordForRoot)
      

SSH-key connections:
  • IdentityFile - Private key for remote machine, could be placed anywhere

2. Install dependencies

(Optional, required for password-based SSH connections)

Using APT:

sudo apt install sshpass

Homebrew:

brew install sshpass

Other *NIX:

1. Download .tar.gz source code

2. Extract archive and enter directory: tar -xf sshpass*.tar.gz && rm sshpass*.tar.gz && cd sshpass*

3. Run as following:

./configure
make
sudo make install
Or installation without sudo-access setting the --prefix

Windows (experimental):

1. Download sshpass-win32

2. [Optional] Check your PATH environment variable

  • [Win + R] -> SystemPropertiesAdvanced.exe
  • Environment variables -> Path -> Edit

3. Drop sshpass.exe to one of present folder in Path

Verify everything is installed properly

  • sshpass -V (Check, that sshpass is installed and operable)

  • echo $myserver_root
        -----
    # Here goes the password
    

3. ssh_manager Installation

As simple as:

pip install ssh-m.py

4. Usage

  • Remote selection:
    • Simply run ssh_m
      > ssh_m
      ssh_manager v0.x.y:
      
      Select SSH user:
      >me@some.example.com
        milk@simplifymilk.local
      
      
  • Add new remote
    • ssh_m -n
    • Or press "n" key at ssh_m menu
    ssh_manager v0.x.y:
    
     Hostname: google.com
     Remote user: root
     ? Select connection type: Env
     Environment variable prefix: mygoogle
    
     -----
    
    > root@google.com
      milk@simplifymilk.local
      me@some.example.com
    
    Example configuration for new server google.com, with environment variable for it $mygoogle_root
  • Additional controls
    • [n] key - Create new entry in list while in menu
    • [d] key - Delete hovered entry
    • [q] or [Ctrl-C] or [Ctrl-D] - Close ssh_manager

Configuration

The default storage is JSON file type, that placing in home location:

~/.ssh_manager_store

Remember, the storage contains NO any sensitive information. It just a mapping for environment variable names and paths to key files.

Also, as mentioned before ssh_manager aims to rename TMUX active window and close pane at session disconnect. There's a few options how to configure that behavior:

Launch arguments

@ ssh_m -R - [R]ename - will prevent ssh_manager renaming active TMUX window

  • Is alternative to $SSH_M_R environment variable.

@ ssh_m -C - [C]lose - will prevent ssh_manager closing pane after SSH terminated

  • Is alternative to $SSH_M_C.

Important notes

  • Keep in mind that for password-based logins environment variable $servernickname_user is REQUIRED, otherwise use key-based entry

  • You can specify any port for SSH using : delimeter after hostname, or specify explicitly -p flag

  • ssh_manager by default is checking whether running inside TMUX, and applies those actions to it

    • Renaming current window to active ssh session
    • Termination shell on ssh disconnect

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ssh_m_py-0.3.2-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file ssh_m_py-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: ssh_m_py-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ssh_m_py-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e968b1db63389d25f6e20c684adb5c621dc9c05fc90954bd23d4a6de34a32fc8
MD5 e92d73b10086cf005e0dc5dc64c55ee8
BLAKE2b-256 ec24394344cfd8271388f8126e52b1038f192621582245860deed8a5b262ecb9

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssh_m_py-0.3.2-py3-none-any.whl:

Publisher: create_release.yml on LoliPain/ssh_manager

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page