ssh_key_switcher 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f59312f44c114b17c557087b6dc0e604fbfe025db9613d06be9bd19753a8c3
-  data.tar.gz: 427d18035620685e542db76f523ef15517d1ade3f3ff9b8adc445e3ad925a4b1
+  metadata.gz: e2ad23e81673482e19d3eae55c0b787ef26f1dfd3f1d1e213a1c10039495478d
+  data.tar.gz: 1f539080d59584e814f18d4732df9e89e1c13c8607b9d5b12de6c30d536b9db4
 SHA512:
-  metadata.gz: dd423e8c3d1d5b009c8baf5d15546e61173f264cacb73541de8ca25f02812a35915f997d1f1a696b789c77a62189cacf8e8f3818c1f92424f184d001bd1f4155
-  data.tar.gz: 3832b8f3f06e805b4922b154e1593092b78d7498894784b257fdb79c36eca9de79c6f53297123bdbc744ccef6ac82e5374c9c3b4cb1448ff911adb2c9c6a8931
+  metadata.gz: e294cfbab8f108aa2138b780636ae58ef0686b8a62554c8d986b3d621379c56e3f03644e1a778616b727e0259e82562fa02810ad0214009f9d2dd3a84c7e45c6
+  data.tar.gz: 96ff45770f8fe42842fa55466e84cfd3f340bc4e14827ee120605d45b6ce6f7e96d56e26e61af3970b73cd3f6a67e024ed639058011f3407f7dba76778a9e2a2

data/README.md

@@ -64,6 +64,15 @@ $ sks -s [--select]
 
 Allows you to interactively select and set an OpenSSH key for your sessions.
 
+### List of OpenSSH Keys
+
+```bash
+$ sks -l [--list]
+
+```
+
+Display a list of OpenSSH keys.
+
 ### List Active OpenSSH Keys
 
 ```bash
@@ -92,10 +101,23 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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.
+**Debug**
 
-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).
+```bash
+bundle exec sks [option]
+```
 
+**Install locally to test**
+
+```bash
+bin/install-local [version]
+```
+
+**Release**
+
+```bash
+bin/release [version]
+```
 
 ## Contributor
 

data/lib/ssh_key_switcher/options/current_agent.rb

@@ -5,24 +5,11 @@ module SshKeySwitcher
     class CurrentAgent
       class << self
         def fetch_results
-          results = []
-          payload = Cmd.exec('ssh-add -l')[0]
-          payload.each_line { |line| results << line.split.last(2).join(' ') }
-          results
+          Helper.current_active_keys
         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
+          Helper.display_current_ssh_keys(prompt)
         end
 
         private

data/lib/ssh_key_switcher/options/delete.rb

@@ -5,9 +5,9 @@ module SshKeySwitcher
     class Delete
       class << self
         def display_select
-          keys = Helper.find_open_ssh_keys
-          if keys.empty?
-            prompt.error('No OpenSSH keys found in ~/.ssh')
+          files = Helper.find_ssh_keys
+          if files.empty?
+            prompt.error("No OpenSSH keys found in #{SSH_DIR}")
             nil
           else
             msg = 'Choose the OpenSSH keys to REMOVE. Press [CTRL+C] to exit.'

data/lib/ssh_key_switcher/options/list.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SshKeySwitcher
+  module Options
+    class List
+      class << self
+        def display
+          ssh_keys = Helper.find_ssh_keys
+          if ssh_keys.empty?
+            prompt.error("No OpenSSH keys found in #{SSH_DIR}")
+            nil
+          else
+            prompt.say('List of OpenSSH keys:')
+            Helper.display_list_keys(prompt, ssh_keys, color: :blue)
+          end
+
+          print "\n"
+          Helper.display_current_ssh_keys(prompt)
+        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/ping.rb

@@ -7,7 +7,10 @@ module SshKeySwitcher
         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)
+          stdout, stderr, status = Cmd.exec("ssh -T #{result}")
+          return prompt.ok(stdout) if status.success?
+
+          prompt.error(stderr)
         end
 
         private

data/lib/ssh_key_switcher/options/remove.rb

@@ -5,7 +5,7 @@ module SshKeySwitcher
     class Remove
       class << self
         def display_select
-          keys = Helper.find_open_ssh_keys
+          keys = Helper.find_ssh_keys
           if keys.empty?
             prompt.error('No OpenSSH keys found in ~/.ssh')
             nil

data/lib/ssh_key_switcher/options/select.rb

@@ -5,23 +5,26 @@ module SshKeySwitcher
     class Select
       class << self
         def display_select
-          ssh_keys = Helper.find_open_ssh_keys
+          ssh_keys = Helper.find_ssh_keys
           if ssh_keys.empty?
-            prompt.error('No OpenSSH keys found in ~/.ssh')
+            prompt.error("No OpenSSH keys found in #{SSH_DIR}")
             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)
+          return if path_open_ssh_key.nil?
+
           SshKeySwitcher::Utils::SshAgent.remove_all
-          SshKeySwitcher::Utils::SshAgent.add(path_open_ssh_key)
-          prompt.ok('OpenSSH key added successfully!')
+          _stdout, stderr, status = SshKeySwitcher::Utils::SshAgent.add(path_open_ssh_key)
+          return prompt.ok('Add OpenSSH key successfully!') if status.success?
+
+          prompt.error(stderr)
         end
 
         private
@@ -44,10 +47,10 @@ module SshKeySwitcher
           }
         end
 
-        def select_choices(menu, keys)
-          keys.each do |value|
-            display_text = value.split('/').last(2).join('/').gsub('.ssh/', '')
-            menu.choice display_text, value
+        def select_choices(menu, ssh_keys)
+          ssh_keys.each do |key|
+            display_text = Helper.filename(key)
+            menu.choice display_text, key
           end
         end
       end

data/lib/ssh_key_switcher/utils/cmd.rb

@@ -7,12 +7,8 @@ module SshKeySwitcher
     module Cmd
       module_function
 
-      def exec(command, opts = {})
+      def exec(command, _opts = {})
         stdout, stderr, status = Open3.capture3(command)
-        if opts[:print]
-          print stderr
-          print stdout
-        end
         [stdout, stderr, status]
       end
     end

data/lib/ssh_key_switcher/utils/contains.rb

@@ -2,7 +2,7 @@
 
 module SshKeySwitcher
   module Contains
-    SSH_DIR = '~/.ssh'
+    SSH_DIR = "#{Dir.home}/.ssh"
     STRING_DETECT_OPENSSH_KEY = 'OPENSSH'
     SERVER_NAMES = %w[github.com gitlab.com bitbucket.org].freeze
   end

data/lib/ssh_key_switcher/utils/helper.rb

@@ -7,20 +7,61 @@ module SshKeySwitcher
 
       module_function
 
-      def find_open_ssh_keys
-        ssh_folder = File.expand_path(SSH_DIR)
+      def find_ssh_keys
+        files  = fetch_private_ssh_keys_via_header
+        files += fetch_private_ssh_keys_via_filename
+        files.flatten.uniq.sort
+      end
+
+      def fetch_private_ssh_keys_via_header
+        ssh_dir = File.expand_path(SSH_DIR)
+        Dir.glob("#{ssh_dir}/**/*").select do |file|
+          next if File.directory?(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
+        end
+      end
+
+      def fetch_private_ssh_keys_via_filename
+        ssh_dir = File.expand_path(SSH_DIR)
+        Dir.glob("#{ssh_dir}/**/*.pub").map { |file| file.gsub('.pub', '') }
+      end
 
-        Dir.glob("#{ssh_folder}/*").select { |file| valid_ssh_key?(file) }.sort
+      def filename(key)
+        key.gsub("#{SSH_DIR}/", '').gsub('.pub', '').strip
+      end
+
+      def current_active_keys
+        results = []
+        payload = Cmd.exec('ssh-add -l')[0]
+        payload.each_line { |line| results << line.split.last(2).join(' ') }
+        results
+      end
+
+      def display_current_ssh_keys(prompt, color: :green)
+        ssh_keys = Helper.current_active_keys
+
+        if ssh_keys[0].include?('no identities')
+          prompt.warn('No active SSH keys')
+        elsif ssh_keys.size == 1
+          prompt.say("Active SSH key: #{ssh_keys[0]}", color: color)
+        else
+          prompt.say('List of active SSH keys:')
+          Helper.display_list_keys(prompt, ssh_keys, color: color)
+        end
       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)
+      def display_list_keys(prompt, ssh_keys, color: :blue)
+        max_space_size = ssh_keys.size.to_s.size
+        ssh_keys.each.with_index(1) do |key, idx|
+          space_size = max_space_size - (idx < 10 ? 0 : idx.to_s.size - 1)
+          filename = Helper.filename(key)
+          prompt.say(format("  %d.%#{space_size}s%s", idx, ' ', filename), color: color)
         end
-      rescue StandardError
-        false
       end
     end
   end

data/lib/ssh_key_switcher/utils/ssh_agent.rb

@@ -3,8 +3,12 @@
 module SshKeySwitcher
   module Utils
     class SshAgent
-      def self.add(key)
-        Cmd.exec("ssh-add #{key}")
+      def self.start_ssh_agent
+        Cmd.exec('eval $(ssh-agent -s)')
+      end
+
+      def self.add(private_key)
+        Cmd.exec("ssh-add #{private_key}")
       end
 
       def self.remove_all
@@ -14,6 +18,11 @@ module SshKeySwitcher
       def self.del(path)
         Cmd.exec("ssh-add -d #{path}")
       end
+
+      def self.start_ssh_agent_if_needed
+        ssh_agent_pid = ENV.fetch('SSH_AGENT_PID', nil)
+        start_ssh_agent if ssh_agent_pid.nil? || !system("ps -p #{ssh_agent_pid} > /dev/null 2>&1")
+      end
     end
   end
 end

data/lib/ssh_key_switcher/version.rb

@@ -1,3 +1,3 @@
 module SshKeySwitcher
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/lib/ssh_key_switcher.rb

@@ -10,6 +10,7 @@ module SshKeySwitcher
   class Error < StandardError; end
 
   class CLI < Thor
+    SshKeySwitcher::Utils::SshAgent.start_ssh_agent_if_needed
     ENV['THOR_SILENCE_DEPRECATION'] = 'true'
 
     desc 'version [-v, --version]', 'Show version'
@@ -31,6 +32,12 @@ module SshKeySwitcher
       SshKeySwitcher::Options::Select.add(path_open_ssh_key)
     end
 
+    desc 'list [-l, --list]', 'List of OpenSSH key files'
+    map %w[-l --list] => :list
+    def list
+      SshKeySwitcher::Options::List.display
+    end
+
     desc 'current [-c, --current]', 'List of active OpenSSH keys'
     map %w[-c --current] => :current
     def current

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssh_key_switcher
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Minh Tang Q.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,7 @@ files:
 - 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/list.rb
 - lib/ssh_key_switcher/options/ping.rb
 - lib/ssh_key_switcher/options/remove.rb
 - lib/ssh_key_switcher/options/select.rb
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: A simple and efficient for managing and switching between OpenSSH keys seamlessly