ssh_key_switcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f533df5b3d9d76377ed35a3267899f82d5a7603a80c29894de402e854710f1d9
+  data.tar.gz: 2f077163c2255fc4498b7f8f9c1e6828387706fc669f1ad7f8e8d6fdcf89adf0
+SHA512:
+  metadata.gz: b721f9d2f12001dce27f73847a54ad3be8aff4d24cc865c234d986ffa69ebefb8198eba89e6104f8507d96a1fa3bf69fd48634a6af8c49bc8aaee8b02645e980
+  data.tar.gz: fbd9c084f585f68be76dd671f251100640ca3551f479107d35db48f70d706188129d0a689b04e490dced827dbbe9726d4c29dd1d2c05c1b8966a182161c443c9

data/README.md

@@ -0,0 +1,94 @@
+# SSH Key Switcher
+
+A simple and efficient Ruby gem for managing and switching between OpenSSH keys seamlessly
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssh_key_switcher'
+
+```
+
+And then execute:
+
+```bash
+$ bundle install
+
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install ssh_key_switcher
+
+```
+
+## Usage
+
+### Show Help
+
+```bash
+$ sks -h [--help]
+
+```
+
+### Show Version
+
+```bash
+$ sks -v [--version]
+
+```
+
+Displays the current version of SSH Key Switcher.
+
+### Ping Server
+
+```bash
+$ sks -p [--ping]
+
+```
+
+Tests the connection to servers listed in **`SshKeySwitcher::Contains::SERVER_NAMES`**.
+
+### Select OpenSSH Key
+
+```bash
+$ sks -s [--select]
+
+```
+
+Allows you to interactively select and set an OpenSSH key for your sessions.
+
+### List Active OpenSSH Keys
+
+```bash
+$ sks -c [--current]
+
+```
+
+Displays a list of currently active SSH keys.
+
+### Remove OpenSSH Key
+
+```bash
+$ sks --rm [--remove]
+
+```
+
+Interactive prompt to remove an OpenSSH key from the list of managed keys.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [SSH Key Switcher](https://github.com/TOMOSIA-VIETNAM/ssh_key_switcher).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/bin/sks

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require_relative '../lib/ssh_key_switcher'
+
+SshKeySwitcher::CLI.start

data/lib/ssh_key_switcher/options/current_agent.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Options
+    class CurrentAgent
+      class << self
+        def fetch_results
+          results = []
+          payload = Cmd.exec('ssh-add -l')[0]
+          payload.each_line { |line| results << line.split[-2..].join(' ') }
+          results
+        end
+
+        def display
+          if fetch_results[0].include?('no identities')
+            prompt.warn('No active SSH keys')
+          elsif fetch_results.size == 1
+            prompt.say('Active SSH key: ')
+            prompt.ok(fetch_results[0])
+          else
+            prompt.say('List of active SSH keys:')
+            fetch_results.each.with_index(1) do |result, index|
+              prompt.ok("  #{index}) #{result}")
+            end
+          end
+        end
+
+        private
+
+        include SshKeySwitcher::Utils
+
+        def prompt
+          @prompt ||= TTY::Prompt.new
+        end
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/options/delete.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Options
+    class Delete
+      class << self
+        def display_select
+          keys = Helper.find_open_ssh_keys
+          if keys.empty?
+            prompt.error('No OpenSSH keys found in ~/.ssh')
+            nil
+          else
+            msg = 'Choose the OpenSSH keys to REMOVE. Press [CTRL+C] to exit.'
+            prompt.multi_select(msg, select_options) do |menu|
+              menu.enum '.'
+              select_choices(menu, keys)
+            end
+          end
+        end
+
+        def del(path_open_ssh_keys)
+          is_no = prompt.no?('Are you sure you want to delete it permanently?')
+
+          if is_no
+            prompt.say('Cancelled!')
+          else
+            path_open_ssh_keys.each do |path|
+              SshKeySwitcher::Utils::SshAgent.del(path)
+              Cmd.exec("rm #{path}")
+              Cmd.exec("rm #{path}.pub")
+            end
+            prompt.ok('OpenSSH key removed successfully!')
+          end
+        end
+
+        private
+
+        include SshKeySwitcher::Contains
+        include SshKeySwitcher::Utils
+
+        def prompt
+          @prompt ||= TTY::Prompt.new(interrupt: :exit)
+        end
+
+        def select_options
+          {
+            cycle: true,
+            symbols: { marker: '●' },
+            per_page: 100,
+            filter: true,
+            help: 'Use ↑/↓ arrow keys, and letter keys to filter',
+            show_help: :always
+          }
+        end
+
+        def select_choices(menu, keys)
+          keys.each do |value|
+            display_text = value.split('/')[-2..].join('/').gsub('.ssh/', '')
+            menu.choice display_text, value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/options/ping.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Options
+    class Ping
+      class << self
+        def pong
+          server_names = SERVER_NAMES.map { |server| "git@#{server}" }
+          result = prompt.select('Connect to', server_names, default: 'git@github.com')
+          Cmd.exec("ssh -T #{result}", print: true)
+        end
+
+        private
+
+        include SshKeySwitcher::Contains
+        include SshKeySwitcher::Utils
+
+        def prompt
+          @prompt ||= TTY::Prompt.new(interrupt: :exit)
+        end
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/options/remove.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Options
+    class Remove
+      class << self
+        def display_select
+          keys = Helper.find_open_ssh_keys
+          if keys.empty?
+            prompt.error('No OpenSSH keys found in ~/.ssh')
+            nil
+          else
+            prompt.multi_select('Choose the OpenSSH keys to delete. Press [CTRL+C] to exit.',
+                                select_options) do |menu|
+              menu.enum '.'
+              select_choices(menu, keys)
+            end
+
+          end
+        end
+
+        def del(path_open_ssh_keys)
+          is_no = prompt.no?('Are you sure you want to remove these keys?')
+
+          if is_no
+            prompt.say('Cancelled!')
+          else
+            path_open_ssh_keys.each do |path|
+              SshKeySwitcher::Utils::SshAgent.del(path)
+              Cmd.exec("rm #{path}")
+              Cmd.exec("rm #{path}.pub")
+            end
+            prompt.ok('OpenSSH key removed successfully!')
+          end
+        end
+
+        private
+
+        include SshKeySwitcher::Contains
+        include SshKeySwitcher::Utils
+
+        def prompt
+          @prompt ||= TTY::Prompt.new(interrupt: :exit)
+        end
+
+        def select_options
+          {
+            cycle: true,
+            symbols: { marker: '●' },
+            per_page: 100,
+            filter: true,
+            help: 'Use ↑/↓ arrow keys, and letter keys to filter',
+            show_help: :always
+          }
+        end
+
+        def select_choices(menu, keys)
+          keys.each do |value|
+            display_text = value.split('/')[-2..].join('/').gsub('.ssh/', '')
+            menu.choice display_text, value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/options/select.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Options
+    class Select
+      class << self
+        def display_select
+          ssh_keys = Helper.find_open_ssh_keys
+          if ssh_keys.empty?
+            prompt.error('No OpenSSH keys found in ~/.ssh')
+            nil
+          else
+            prompt.select('Select an OpenSSH key:', select_options) do |menu|
+              menu.enum '.'
+              select_choices(menu, ssh_keys)
+            end
+
+          end
+        end
+
+        def add(path_open_ssh_key)
+          SshKeySwitcher::Utils::SshAgent.remove_all
+          SshKeySwitcher::Utils::SshAgent.add(path_open_ssh_key)
+          prompt.ok('OpenSSH key added successfully!')
+        end
+
+        private
+
+        include SshKeySwitcher::Contains
+        include SshKeySwitcher::Utils
+
+        def prompt
+          @prompt ||= TTY::Prompt.new(interrupt: :exit)
+        end
+
+        def select_options
+          {
+            cycle: true,
+            symbols: { marker: '➜' },
+            per_page: 20,
+            filter: true,
+            help: 'Use ↑/↓ arrow keys, and letter keys to filter',
+            show_help: :always
+          }
+        end
+
+        def select_choices(menu, keys)
+          keys.each do |value|
+            display_text = value.split('/')[-2..].join('/').gsub('.ssh/', '')
+            menu.choice display_text, value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/utils/cmd.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module SshKeySwitcher
+  module Utils
+    module Cmd
+      module_function
+
+      def exec(command, opts = {})
+        stdout, stderr, status = Open3.capture3(command)
+        if opts[:print]
+          print stderr
+          print stdout
+        end
+        [stdout, stderr, status]
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/utils/contains.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Contains
+    SSH_DIR = '~/.ssh'
+    STRING_DETECT_OPENSSH_KEY = 'OPENSSH'
+    SERVER_NAMES = %w[github.com gitlab.com bitbucket.org].freeze
+  end
+end

data/lib/ssh_key_switcher/utils/helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Utils
+    module Helper
+      include SshKeySwitcher::Contains
+
+      module_function
+
+      def find_open_ssh_keys
+        ssh_folder = File.expand_path(SSH_DIR)
+
+        Dir.glob("#{ssh_folder}/*").select { |file| valid_ssh_key?(file) }.sort
+      end
+
+      def valid_ssh_key?(file)
+        File.open(file, 'rb') do |f|
+          # Read the first 20 bytes from the file
+          header = f.read(20)
+          header.include?(STRING_DETECT_OPENSSH_KEY)
+        end
+      rescue StandardError
+        false
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/utils/ssh_agent.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Utils
+    class SshAgent
+      def self.add(key)
+        Cmd.exec("ssh-add #{key}")
+      end
+
+      def self.remove_all
+        Cmd.exec('ssh-add -D')
+      end
+
+      def self.del(path)
+        Cmd.exec("ssh-add -d #{path}")
+      end
+    end
+  end
+end

data/lib/ssh_key_switcher/version.rb

@@ -0,0 +1,3 @@
+module SshKeySwitcher
+  VERSION = "1.0.0"
+end

data/lib/ssh_key_switcher.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require 'thor'
+require_relative 'ssh_key_switcher/version'
+Dir.glob("#{__dir__}/ssh_key_switcher/utils/*.rb").sort.each { |file| require_relative(file) }
+Dir.glob("#{__dir__}/ssh_key_switcher/options/*.rb").sort.each { |file| require_relative(file) }
+
+module SshKeySwitcher
+  class Error < StandardError; end
+
+  class CLI < Thor
+    desc 'version [-v, --version]', 'Show version'
+    map %w[-v --version] => :version
+    def version
+      TTY::Prompt.new.say("SSHKeySwitcher version #{VERSION}")
+    end
+
+    desc 'ping [-p, --ping]', "Connect to servers #{SshKeySwitcher::Contains::SERVER_NAMES}"
+    map %w[-p --ping] => :ping
+    def ping
+      SshKeySwitcher::Options::Ping.pong
+    end
+
+    desc 'select [-s, --select]', 'Select an OpenSSH key'
+    map %w[-s --select] => :select
+    def select
+      path_open_ssh_key = SshKeySwitcher::Options::Select.display_select
+      SshKeySwitcher::Options::Select.add(path_open_ssh_key)
+    end
+
+    desc 'current [-c, --current]', 'List of active OpenSSH keys'
+    map %w[-c --current] => :current
+    def current
+      SshKeySwitcher::Options::CurrentAgent.display
+    end
+
+    desc 'remove [-rm, --remove]', 'Remove an OpenSSH key'
+    map %w[-rm --remove] => :remove
+    def remove
+      path_open_ssh_key = SshKeySwitcher::Options::Remove.display_select
+      SshKeySwitcher::Options::Remove.del(path_open_ssh_key)
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ssh_key_switcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Minh Tang Q.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+description: Simple and efficient for managing and switching between OpenSSH keys
+  seamlessly
+email:
+- minh.tang1@tomosia.com
+- vhquocminhit@gmail.com
+executables:
+- sks
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/sks
+- lib/ssh_key_switcher.rb
+- lib/ssh_key_switcher/options/current_agent.rb
+- lib/ssh_key_switcher/options/delete.rb
+- lib/ssh_key_switcher/options/ping.rb
+- lib/ssh_key_switcher/options/remove.rb
+- lib/ssh_key_switcher/options/select.rb
+- lib/ssh_key_switcher/utils/cmd.rb
+- lib/ssh_key_switcher/utils/contains.rb
+- lib/ssh_key_switcher/utils/helper.rb
+- lib/ssh_key_switcher/utils/ssh_agent.rb
+- lib/ssh_key_switcher/version.rb
+homepage: https://github.com
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.20
+signing_key:
+specification_version: 4
+summary: Simple and efficient for managing and switching between OpenSSH keys seamlessly
+test_files: []