sshman 0.3.3 → 0.4.0

data/README.md

@@ -0,0 +1,93 @@
+[![Gem Version](https://img.shields.io/gem/v/sshman)](https://rubygems.org/gems/sshman)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+# 🚀 sshman: A Simple and Secure SSH Manager
+![sshmangif](images/sshman.gif)
+**Sshman** is a *terminal-based* SSH manager built with Ruby that simplifies managing your SSH connections. It enables you to easily add, edit, delete, and connect to servers with just a few commands. The tool supports SSH keys and passwords and secures your configuration with restricted file permissions.
+
+## ✨ Features
+
+- Add SSH server configurations
+- List all saved servers in a neatly formatted table
+- Edit existing server configurations
+- Delete server entries by alias
+- Connect to servers via SSH in a single command
+- Security: Restricts file permissions to protect SSH keys
+- User-friendly CLI: Interactive, colorized terminal-based interface with built-in help
+- SSH-key generation: Easy fool proof ssh-key generation
+
+## 📦 Installation
+
+### Using RubyGems
+Install the gem locally or globally:
+
+```shell
+gem install sshman
+```
+###From Source
+
+Clone the repository:
+
+```shell
+git clone https://github.com/subnetmasked/sshman.git
+cd sshman
+```
+Build and install the gem:
+
+```shell
+gem build sshman.gemspec
+gem install ./sshman-X.X.X.gem --user-install
+```
+## 🚀 Quick Start
+After installing the gem, you can use the sshman command to manage your SSH servers.
+
+Inline Commands
+You can now run commands directly:
+
+- **sshman list** - List all saved servers
+- **shman add** - Add a new server configuration
+- **sshman edit** - Edit an existing server
+- **sshman delete** -  Delete a server by its alias
+- **sshman connect** -  Connect to a server by its alias
+- **sshman help** - Display help information
+
+## Interactive Mode
+Simply run:
+```shell
+sshman
+```
+
+This will launch the interactive menu where you can add, edit, delete, or connect to servers interactively.
+
+# sshman Roadmap
+
+- Add SSH server configurations✅
+- List all saved servers in a neatly formatted table✅
+- Edit existing server configurations✅
+- Delete server entries by alias✅
+- Connect to servers via SSH in a single command✅
+- Security: Restricts file permissions to protect SSH keys✅
+- User-friendly CLI: Interactive, colorized terminal-based interface with built-in help✅
+- Session logging and replay✅
+- SSH key generation✅
+- Remote script execution⏳
+- Multi-factor authentication (MFA) support⏳
+- Automated server health checks⏳
+- Dashboard for server status⏳
+- Customizable connection profiles⏳
+- Import/export server configurations⏳
+- Batch operations on multiple servers⏳
+
+## 🤝 Contributing
+Contributions, issues, and feature requests are welcome! Feel free to check the issues page to report bugs or request features.
+
+- Fork the project
+- Create your feature branch: git checkout -b my-new-feature
+- Commit your changes: git commit -m 'Add some feature'
+- Push to the branch: git push origin my-new-feature
+- Submit a pull request
+
+## 📄 License
+This project is licensed under the GNU General Public License (GPL-3.0) - see the LICENSE file for details.
+
+## 💬 Questions?
+If you have any questions or need further clarification, feel free to open an issue or reach out to me at subnetmasked@cock.li.

data/exe/sshman

@@ -1,10 +1,8 @@
 #!/usr/bin/env ruby
-require_relative "../lib/sshman/sshman"
-# Check if any arguments are passed (i.e., inline commands)
+require 'sshman'
+
 if ARGV.empty?
-  # No arguments passed, start the interactive mode
-  Sshman::CLI.start_interactive
+  SSHMan::TUI.new.start
 else
-  # Pass command-line arguments for inline commands (e.g., `sshman list`)
-  Sshman::CLI.start(ARGV)
+  SSHMan::CLI.start(ARGV)
 end

data/lib/sshman/cli.rb

@@ -1,103 +1,80 @@
-require 'logger'
-require_relative 'constants'
-require_relative 'version'
-require_relative 'server_manager'
-require_relative 'utils'
-require_relative 'key_manager'
+require 'thor'
+require 'tty-table'
+require 'tty-prompt'
+require_relative 'manager'
 
-module Sshman
-  class CLI
-    LOGGER = Logger.new(File.expand_path('~/.sshman.log'))
+module SSHMan
+  class CLI < Thor
+    desc "list", "List all SSH connections"
+    def list
+      connections = Manager.list_connections
+      table = TTY::Table.new(
+        header: ['Name', 'Host', 'User', 'Port', 'Auth Type'],
+        rows: connections.map { |c| [c.name, c.host, c.user, c.port, c.auth_type] }
+      )
+      puts table.render(:unicode, padding: [0, 1])
+    end
 
-    def self.start(argv)
-      case argv[0]
-      when 'list'
-        new.list_servers
-      when 'add'
-        new.add_server
-      when 'edit'
-        new.edit_server
-      when 'delete'
-        new.delete_server
-      when 'connect'
-        new.connect_to_server(argv[1])
-      when 'generate_key'
-        KeyManager.generate_key
-      when 'help'
-        new.display_help
-      when 'version'
-        new.version
+    desc "add", "Add a new SSH connection"
+    def add
+      prompt = TTY::Prompt.new
+      name = prompt.ask("Enter connection name:")
+      host = prompt.ask("Enter host:")
+      user = prompt.ask("Enter username:")
+      port = prompt.ask("Enter port:", default: "22")
+      auth_type = prompt.select("Choose authentication type:", %w(Password SSH\ Key))
+      
+      if auth_type == "SSH Key"
+        ssh_key = prompt.ask("Enter path to SSH key (relative to ~/.ssh/):")
       else
-        puts "Unknown command: #{argv[0]}. Use 'sshman help' for a list of commands."
+        ssh_key = nil
       end
-    end
-
-    def version
-      puts "sshman version #{Sshman::VERSION}"
-    end
 
-    def self.start_interactive
-      new.main
+      connection = Connection.new(name, host, user, port, auth_type, ssh_key)
+      Manager.add_connection(connection)
+      puts "Connection added successfully!"
     end
 
-    def main
-      ensure_csv_file
+    desc "edit NAME", "Edit an existing SSH connection"
+    def edit(name)
+      connection = Manager.find_connection(name)
+      return puts "Connection not found." unless connection
 
-      loop do
-        puts "\n#{YELLOW}Options:#{RESET_COLOR} (1)list, (2)add, (3)edit, (4)delete, (5)connect, (6)generate_key, (7)help, (q)quit"
-        print "#{CYAN}Choose an option: #{RESET_COLOR}"
-        option = gets.chomp.downcase.strip
-
-        case option
-        when 'list', 'ls', '1'
-          list_servers
-        when 'add', '2'
-          add_server
-        when 'edit', '3'
-          edit_server
-        when 'delete', '4'
-          delete_server
-        when 'connect', '5'
-          connect_to_server
-        when 'generate_key', '6'
-          KeyManager.generate_key
-        when 'help', '7'
-          display_help
-        when 'quit', 'q'
-          puts "#{GREEN}Goodbye!#{RESET_COLOR}"
-          break
-        else
-          puts "#{RED}Unknown option '#{option}'. Type 'help' for usage instructions.#{RESET_COLOR}"
-        end
+      prompt = TTY::Prompt.new
+      connection.host = prompt.ask("Enter new host:", default: connection.host)
+      connection.user = prompt.ask("Enter new username:", default: connection.user)
+      connection.port = prompt.ask("Enter new port:", default: connection.port)
+      connection.auth_type = prompt.select("Choose new authentication type:", %w(Password SSH\ Key), default: connection.auth_type)
+      
+      if connection.auth_type == "SSH Key"
+        connection.ssh_key = prompt.ask("Enter new path to SSH key (relative to ~/.ssh/):", default: connection.ssh_key)
+      else
+        connection.ssh_key = nil
       end
-    end
-
-    def ensure_csv_file
-      Sshman::Utils.ensure_csv_file
-    end
-
-    def display_help
-      Sshman::Utils.display_help
-    end
-
-    def list_servers
-      Sshman::ServerManager.list_servers
-    end
 
-    def add_server
-      Sshman::ServerManager.add_server
+      Manager.update_connection(connection)
+      puts "Connection updated successfully!"
     end
 
-    def edit_server
-      Sshman::ServerManager.edit_server
+    desc "delete NAME", "Delete an SSH connection"
+    def delete(name)
+      if Manager.delete_connection(name)
+        puts "Connection deleted successfully!"
+      else
+        puts "Connection not found."
+      end
     end
 
-    def delete_server
-      Sshman::ServerManager.delete_server
-    end
+    desc "connect NAME", "Connect to a saved SSH connection"
+    def connect(name)
+      connection = Manager.find_connection(name)
+      return puts "Connection not found." unless connection
 
-    def connect_to_server(alias_name = nil)
-      Sshman::ServerManager.connect_to_server(alias_name)
+      cmd = "ssh #{connection.user}@#{connection.host} -p #{connection.port}"
+      cmd += " -i ~/.ssh/#{connection.ssh_key}" if connection.auth_type == "SSH Key"
+      
+      puts "Connecting to #{connection.name}..."
+      exec(cmd)
     end
   end
 end

data/lib/sshman/connection.rb

@@ -0,0 +1,30 @@
+# lib/sshman/connection.rb
+module SSHMan
+  class Connection
+    attr_accessor :name, :host, :user, :port, :auth_type, :ssh_key
+
+    def initialize(name, host, user, port, auth_type, ssh_key = nil)
+      @name = name
+      @host = host
+      @user = user
+      @port = port
+      @auth_type = auth_type
+      @ssh_key = ssh_key
+    end
+
+    def to_h
+      {
+        name: @name,
+        host: @host,
+        user: @user,
+        port: @port,
+        auth_type: @auth_type,
+        ssh_key: @ssh_key
+      }
+    end
+
+    def self.from_h(hash)
+      new(hash[:name], hash[:host], hash[:user], hash[:port], hash[:auth_type], hash[:ssh_key])
+    end
+  end
+end

data/lib/sshman/manager.rb

@@ -0,0 +1,52 @@
+# lib/sshman/manager.rb
+require 'yaml'
+require_relative 'connection'
+
+module SSHMan
+  class Manager
+    CONFIG_FILE = File.expand_path('~/.sshman.yml')
+
+    class << self
+      def list_connections
+        load_connections
+      end
+
+      def add_connection(connection)
+        connections = load_connections
+        connections << connection
+        save_connections(connections)
+      end
+
+      def update_connection(updated_connection)
+        connections = load_connections
+        index = connections.index { |c| c.name == updated_connection.name }
+        connections[index] = updated_connection if index
+        save_connections(connections)
+      end
+
+      def delete_connection(name)
+        connections = load_connections
+        initial_count = connections.count
+        connections.reject! { |c| c.name == name }
+        save_connections(connections)
+        initial_count != connections.count
+      end
+
+      def find_connection(name)
+        load_connections.find { |c| c.name == name }
+      end
+
+      private
+
+      def load_connections
+        return [] unless File.exist?(CONFIG_FILE)
+
+        YAML.load_file(CONFIG_FILE).map { |hash| Connection.from_h(hash) }
+      end
+
+      def save_connections(connections)
+        File.write(CONFIG_FILE, connections.map(&:to_h).to_yaml)
+      end
+    end
+  end
+end

data/lib/sshman/tui.rb

@@ -0,0 +1,136 @@
+# lib/sshman/tui.rb
+require 'tty-prompt'
+require_relative 'manager'
+require_relative 'connection'
+
+module SSHMan
+  class TUI
+    def initialize
+      @prompt = TTY::Prompt.new
+    end
+
+    def start
+      loop do
+        case main_menu
+        when 'List Connections'
+          list_connections
+        when 'Add Connection'
+          add_connection
+        when 'Edit Connection'
+          edit_connection
+        when 'Delete Connection'
+          delete_connection
+        when 'Connect'
+          connect
+        when 'Exit'
+          break
+        end
+      end
+    end
+
+    private
+
+    def main_menu
+      @prompt.select("SSHMan - Main Menu") do |menu|
+        menu.choice 'List Connections'
+        menu.choice 'Add Connection'
+        menu.choice 'Edit Connection'
+        menu.choice 'Delete Connection'
+        menu.choice 'Connect'
+        menu.choice 'Exit'
+      end
+    end
+
+    def list_connections
+      connections = Manager.list_connections
+      if connections.empty?
+        puts "No connections found."
+      else
+        table = TTY::Table.new(
+          header: ['Name', 'Host', 'User', 'Port', 'Auth Type'],
+          rows: connections.map { |c| [c.name, c.host, c.user, c.port, c.auth_type] }
+        )
+        puts table.render(:unicode, padding: [0, 1])
+      end
+      @prompt.keypress("Press any key to continue")
+    end
+
+    def add_connection
+      name = @prompt.ask("Enter connection name:")
+      host = @prompt.ask("Enter host:")
+      user = @prompt.ask("Enter username:")
+      port = @prompt.ask("Enter port:", default: "22")
+      auth_type = @prompt.select("Choose authentication type:", %w(Password SSH\ Key))
+      
+      if auth_type == "SSH Key"
+        ssh_key = @prompt.ask("Enter path to SSH key (relative to ~/.ssh/):")
+      else
+        ssh_key = nil
+      end
+
+      connection = Connection.new(name, host, user, port, auth_type, ssh_key)
+      Manager.add_connection(connection)
+      puts "Connection added successfully!"
+      @prompt.keypress("Press any key to continue")
+    end
+
+    def edit_connection
+      connections = Manager.list_connections
+      if connections.empty?
+        puts "No connections found."
+        return
+      end
+
+      name = @prompt.select("Select connection to edit:", connections.map(&:name))
+      connection = Manager.find_connection(name)
+
+      connection.host = @prompt.ask("Enter new host:", default: connection.host)
+      connection.user = @prompt.ask("Enter new username:", default: connection.user)
+      connection.port = @prompt.ask("Enter new port:", default: connection.port)
+      connection.auth_type = @prompt.select("Choose new authentication type:", %w(Password SSH\ Key), default: connection.auth_type)
+      
+      if connection.auth_type == "SSH Key"
+        connection.ssh_key = @prompt.ask("Enter new path to SSH key (relative to ~/.ssh/):", default: connection.ssh_key)
+      else
+        connection.ssh_key = nil
+      end
+
+      Manager.update_connection(connection)
+      puts "Connection updated successfully!"
+      @prompt.keypress("Press any key to continue")
+    end
+
+    def delete_connection
+      connections = Manager.list_connections
+      if connections.empty?
+        puts "No connections found."
+        return
+      end
+
+      name = @prompt.select("Select connection to delete:", connections.map(&:name))
+      if Manager.delete_connection(name)
+        puts "Connection deleted successfully!"
+      else
+        puts "Failed to delete connection."
+      end
+      @prompt.keypress("Press any key to continue")
+    end
+
+    def connect
+      connections = Manager.list_connections
+      if connections.empty?
+        puts "No connections found."
+        return
+      end
+
+      name = @prompt.select("Select connection to connect:", connections.map(&:name))
+      connection = Manager.find_connection(name)
+
+      cmd = "ssh #{connection.user}@#{connection.host} -p #{connection.port}"
+      cmd += " -i ~/.ssh/#{connection.ssh_key}" if connection.auth_type == "SSH Key"
+      
+      puts "Connecting to #{connection.name}..."
+      system(cmd)
+    end
+  end
+end

data/lib/sshman/version.rb

@@ -1,5 +1,5 @@
 # lib/sshman/version.rb
 
-module Sshman
-  VERSION = "0.3.3"
+module SSHMan
+  VERSION = "0.4.0"
 end

data/lib/sshman.rb

@@ -0,0 +1,9 @@
+require_relative "sshman/version"
+require_relative "sshman/cli"
+require_relative "sshman/connection"
+require_relative "sshman/manager"
+require_relative "sshman/tui"
+
+module SSHMan
+  # This is the main module for SSHMan
+end

data/sshman.gemspec

@@ -0,0 +1,31 @@
+# sshman.gemspec
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sshman/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sshman"
+  spec.version       = SSHMan::VERSION
+  spec.authors       = ["Subnetmasked"]
+  spec.email         = ["subnetmasked@cock.li"]
+
+  spec.summary       = %q{A fancy SSH connection manager with TUI}
+  spec.description   = %q{SSHMan is a command-line tool for managing SSH connections with a user-friendly interface and a Text-based User Interface (TUI).}
+  spec.homepage      = "https://github.com/subnetmasked/sshman"
+  spec.license       = "GPL-3.0-OR-LATER"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 1.2"
+  spec.add_dependency "tty-table", "~> 0.12"
+  spec.add_dependency "tty-prompt", "~> 0.23"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end