sshtmux 0.1.2

Powerful SSH terminal manager

SSHTMux - Powerful SSH Terminal Manager

Links

• About
• Why? And who is it for?
• Features
• Requirements
• Installation
  • Install Package
  • Shell autocompletion
  • Upgrade Package
  • Uninstall Package
• SSH Config structure
  • Comment blocks and metadata
• SSH Config demo
• SSHTmux Config
  • SSHTMUX Config Session
  • SSH Config Session
  • Tmux Config Session
• Usage
  • CLI
    • Manager Hosts
    • Manager Groups
    • Manager Identities
    • Manager Snippets
  • TUI
    • Keybinds
  • Tmux
    • Tmux Navegation
    • Keybinds
• License

About

This project is a fork from SSHClick. Thanks karlot!

Inspired by the idea of ​​a terminal connection manager and powerful software such as MRemoteNG, SSHTMux brings several new features integrating with Tmux

SSHTmux (sshm) is just a tool designed to work with existing SSH configuration files on your Linux/Windows/WSL terminal environment.
It parses your SSH config, and can provide easy commands to list, filter, modify or view specific Host entries. Trough additional "metadata" comments it can add abstractions such as "groups" and various information that is both readable in the configuration file, and can be parsed and printed while using the tool.

Integrated with custom Tmux for better experience.

Separates from your machine's native Tmux socket. Each user will have their own independently. it means all settings in this project are separate from the native Tmux on your machine.

⚠️ Backup your SSH config files before using, and test how it works! SSHTMux can be used with "show" and "list" commands for hosts, without modifying your SSH Config in any way!

Only commands that modify configuration will edit and rewrite/restructure your SSH Config file. In that case, any added comment or infos that are not in form that SSHTmux understand will be discarded, and configuration will be re-formatted to match SSHTmux style

Why? And who is it for?

• SSH config is very feature-full with all options SSH client support, why inventing extra layer?
• Who need something that works fast and great in terminal, and does not require complex setup.
• Who need quick way to search, group and visualize all hosts inside SSH configuration (especially since it can grow huge)
• Who need access a lot of SSH or SFTP connections and need a tool to organize and manage them.
• Who love terminal tools

Features

SSHTMux has a CLI to manage SSH config File and TUI interface for interacting with SSH Connections.

• List hosts and groups details.
• Create hosts with SSH parameters validations.
• Create Identities (It means save password to used as you need).
• Create Snippets/Playbooks (Organize many routine commands to execute on one or many hosts).
• Fast open a SFTP connection from active SSH Conection.
• Fast Connections (Open not registered host. Maybe you want to execute some snippet or open it with an identity).
• Multi Commands (Execute an comand in all host in the same session).
• Open a connection in Fast Session mode (it helpful to execute a snippet in host from different groups).

Requirements

• Tmux 2.4+
• Python3.8.1+

Installation

It is preferable to not use system python version, try it on virtual venv first.

Install package:

• from PyPI using pip

  pip install sshtmux
  

• (OR) from source using pip

  git clone https://github.com/karlot/sshtmux
  cd sshtmux
  pip install .
  

Now sshm command should be available to access SSHTmux application

Shell autocompletion

TAB-TAB auto-completes on commands, options, groups, hosts and parameters

• Bash:

  echo 'eval "$(_SSHM_COMPLETE=bash_source sshm)"' >> ~/.profile && source ~/.profile
  

• Zsh:

  echo 'eval "$(_SSHM_COMPLETE=bash_source sshm)"' >> ~/.zshrc && source ~/.zshrc
  

• Fish:

  echo 'eval "$(_SSHM_COMPLETE=bash_source sshm)"' >> ~/.config/fish/config.fish && source ~/.config/fish/config.fish
  

Upgrade Package

• Upgrade from new PyPI release:

  pip install --upgrade sshtmux
  

• Upgrade from source: Assuming installation is already done, and previous version is cloned in some local folder

  cd sshtmux     # cd into existing previously cloned repo folder
  git pull
  pip install --upgrade .
  

Uninstall Package

Simply run:

pip uninstall sshtmux

In case you have installed from cloned source code, you can delete locally cloned repo.

rm -r sshtmux

SSH Config structure, and important note about comments

SSHTmux when editing and writing to SSH config file must use specific style, and is internally using comments to "organize" configuration itself. This means comments outside of what sshtmux is handling are unsupported and will be lost when SSHTmux modifies a file.)

Comment blocks and metadata in SSH Config

SSHTmux uses comments to add extra information which it can use to add concept of grouping and extra information to hosts. Special "metadata" lines start with #@ followed by some of meta-tags like group, desc, info. This are all considered group metadata tags, as they apply on the group level. Note that line separations above and below "group header" are added only for visual aid, they are ignored at parsing, but are included when modifying/generating SSH config file.

This "headers" can be added manually also in SSH config, or sshtmux can add them and move hosts under specific group, using sshm cli tool

Normally start of the "GROUP HEADER" inside SSH Config would look like below.

• #@group: is KEY metadata tag, that during "parsing" defines that all hosts configured below this "tag" belong to this group
• #@desc: is optional tag that adds "description" to defined group, and will display in usual group display commands
• #@info: is optional tag that can appear multiple times, adding extra information lines tied to the group.

Additionally each "host" definition can have optional meta info:

• #@host: is optional tag that can appear multiple times, that can hold some information about the host, this meta info when defined applies to next "host" definition that will appear. If this key is added after "host" keyword, it will be applied to next host, for that reason, keep this host meta info above the actual host definition.

Following is sample how group header is rendered by SSHTmux:

#-------------------------------------------------------------------------------
#@group: <GROUP-NAME>       [MANDATORY]   <-- This line starts new group
#@desc: <GROUP-DESCRIPTION> [OPTIONAL, SINGLE]
#@info: <GROUP-INFO-LINES>  [OPTIONAL,MULTIPLE]
#-------------------------------------------------------------------------------
Host ...    <-- this hosts definitions are part of the defined group
    param1 value1
    param2 value2

#@host: <HOST-INFO-LINES>   [OPTIONAL,MULTIPLE] <-- Adds info to following host
Host ...

<ANOTHER GROUP HEADER>

If there are no groups defined, then all hosts are considered to be part of "default" group. SSHTmux can be used to move hosts between groups and handle keeping SSH config "tidy" and with consistent format.

SSH Config demo

This is config sample file as input (located in ~/.ssh/config):

#<<<<< SSH Config file managed by sshtmux >>>>>

#-------------------------------------------------------------------------------
#@group: network
#@desc: Network devices in my lab
#@info: user='admin' password='password'
#@info: Not really, but for demo its ok :)
#-------------------------------------------------------------------------------
Host net-switch1
    hostname 10.1.1.1

Host net-switch2
    hostname 10.1.1.2

Host net-switch3
    hostname 10.1.1.3

Host net-*
    user admin


#-------------------------------------------------------------------------------
#@group: jumphost
#@desc: Edge-server / SSH bastion
#@info: Used for jump-proxy from intnet to internal lab servers
#-------------------------------------------------------------------------------
#@host: This host can be used as proxyjump to reach LAB servers
Host jumper1
    hostname 123.123.123.123
    user master
    port 1234


#-------------------------------------------------------------------------------
#@group: lab-servers
#@desc: Testing/Support servers
#@info: Some [red]important[/] detail here!
#@info: We can have color markups in descriptions and info lines
#-------------------------------------------------------------------------------
#@host: This server is [red]not[/] reachable directly, only via [green]jumper1[/]
Host lab-serv1
    hostname 10.10.0.1
    user admin

#@host: This server is [red]not[/] reachable directly, only via [green]jumper1[/]
Host lab-serv2
    hostname 10.10.0.2

#@host: This server is [red]not[/] reachable directly, only via [green]lab-serv1[/]
#@host: SSHTmux can represent how end-to-end tunels will be established
Host server-behind-lab
    hostname 10.30.0.1
    user testuser
    port 1234
    proxyjump lab-serv1
    localforward 7630 127.0.0.1:7630

#@host: This pattern applies to all hosts starting with 'lab-'
#@host: setting 'user' and 'proxyjump' property
Host lab-*
    user user123
    proxyjump jumper1

SSHTmux Config

All app configs and files are save on ~/.config/sshtmux/

• config.toml (All App, Identity, Snippets, SSH, SFTP and Tmux settings)
• identity.json (All passwords/Identities encrypted)
• identity.key (The Key to decrypted identity.json. This Key can be removed from config and set on env var SSHTMUX_IDENTITY_KEY)
• snippets (Dir to save all your snippets. Can be a simple text file with your saved commands)
• tmux.config (A Custom Tmux config for the best experience with this project. Include keybinds and custom commands)

Config.toml file

This is the main file config that SSHTmux use.

[sshtmux]
SSHTMUX_IDENTITY_KEY_FILE = "~/.config/sshtmux/identity.key"
SSHTMUX_IDENTITY_PASSWORDS_FILE = "~/.config/sshtmux/identity.json"
SSHTMUX_SNIPPETS_PATH = "~/.config/sshtmux/snippets"
SSHTMUX_HOST_STYLE = "panels"

[ssh]
SSH_CONFIG_FILE = "~/.ssh/config"
SSH_COMMAND = "ssh -o ConnectTimeout=10 -o StrictHostKeyChecking=no ${hostname}"
SFTP_COMMAND = "sftp -o ConnectTimeout=10 -o StrictHostKeyChecking=no ${hostname}"
SSH_CUSTOM_COMMAND = false

[tmux]
TMUX_CONFIG_FILE = "~/.config/sshtmux/tmux.config"
TMUX_SOCKET_NAME = "sshtmux_local_user"
TMUX_TIMEOUT_COMMANDS = 10

SSHTMUX Config Session

SSHTMUX_IDENTITY_KEY_FILE -> File with a key (Fernet key - 32 url-safe) to decrypted passwords. SSHTMUX_IDENTITY_PASSWORDS_FILE -> File with all passwords encrypted in json format. SSHTMUX_SNIPPETS_PATH -> Directory where SSHTmux will search for files and open in snippets mode. SSHTMUX_HOST_STYLE = Style used for group or host show commands.

Style	Description
panels	Display data in several panels
card	Add data to single "card"
simple	Simple output with minimal decorations
table	Flat table with 3 columns
table2	Nested table with separated host SSH params
json	JSON output, useful for binding with other tools

For security reasons, you can delete the SSHTMUX_IDENTITY_KEY_FILE and use SSHTMUX_IDENTITY_KEY env var with the key

SSH Config Session

SSH_CONFIG_FILE -> Your SSH config file. SSH_COMMAND -> The command used when open a new SSH connection. SFTP_COMMAND -> The command used when open a new SFTP connection. SSH_CUSTOM_COMMAND -> SSHTMUX do some internal negotiations to open connections. If you want to use only the flow of this project and use your own way to connect, SSHTmux will not do anything anymore.

Tmux Config Session

TMUX_CONFIG_FILE -> Your Tmux config file. NOTE: This file is optimized for this project, but you can change if you want TMUX_SOCKET_NAME -> Socket used by Tmux. Separates from your machine's native socket, so each user will have their own independently TMUX_TIMEOUT_COMMANDS -> Timeout to execute each command

Usage

CLI

Manager Hosts

Manager Groups

Manager Identities

Manager Snippets

TUI

TUI Keybinds

Action	Keybind
Move down	j
Move up	k
Collapse	h
Expand	l
Search hosts	/
Search groups	?
Open Tmux	t
Connect SSH	c
Connect SSH Detached (open many connections before open Tmux)	d
Connect SFTP	s
Open SSH in Fast Connection (write user and hostname)	f
Open SSH in Fast Session (hosts from different groups for multi-command)	F

Tmux

SSHTmux uses Tmux to manager connections.

So it means that:

Tmux Session -> Group of hosts Tmux Window -> Host connection

⚠️ Do not rename Tmux Sessions. Internally, it used to manage commands and key binds.

Tmux Keybinds

Action	Keybind
Open Session	Tmux host key (Ctrl + b) + Shift + S
Open SFTP connection	Tmux host key (Ctrl + b) + Shift + F
Open Identity	Tmux host key (Ctrl + b) + Shift + I
Open Multi Session Commands	Tmux host key (Ctrl + b) + Shift + M
Jump to tab index connection	Alt + (0-9)
Jump to next and preview tab	Alt + q, Alt + w
Jump to next and preview session	Alt + e, Alt + r or Alt + o, Alt + p
Move tab index	Alt + n, Alt + m

Tmux Navegation

License

MIT License

Copyright (c) 2024 Jorge Silva

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.