ssh-locate 0.0.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 784e22cc6152ba4f53793125ac7c02f1ce31601aa839578fa293efdd7e7a7acc
+  data.tar.gz: ab574c8e2d68d9b7259ce0ec9c893cda059b8582bee7af4151210e6130482f5b
+SHA512:
+  metadata.gz: f22628c4de53289d4cc1ebe340150f249f78186667e266b12a70ddaab46ee2bd72868554c40441c539de3de0cfbdb5df708a558290291cb7f6ba7887d2aac16c
+  data.tar.gz: c279c4578506b0aae500f9914c3642b1a61d1bf6ffcc0bbcf8f86edec8a1160545d35ae353254c07a4dfbb0cfbb2cc5c505eeba94f9d666f5ba7765c4ea067a1

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 2.6.9
+  - 2.7.5
+  - 3.1.1

data/Gemfile

@@ -1,13 +1,16 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
 group :dev do
+  gem "rake"
   gem "guard"
   gem "rb-inotify"
   gem "libnotify"
   gem "cucumber"
-  gem "aruba", git: "git@github.com:ameuret/aruba.git"
+  gem "aruba"
   gem "guard-cucumber"
+  gem "rspec-expectations"
+  gem "solargraph"
 end
 

data/README.md

@@ -1,18 +1,45 @@
 ssh-locate
 ==========
-  
-  A command line tool that helps you locate and contact a SSH agent launched in a separate session.
-  
+[![Build Status](https://secure.travis-ci.org/ameuret/ssh-locate.png)](http://travis-ci.org/ameuret/ssh-locate)
+![Gem](https://img.shields.io/gem/dt/ssh-locate?label=RubygemsDL&logo=ruby&logoColor=red)
+
+  A command line tool that helps you locate and contact a SSH agent launched in a separate shell.
+
+
+### Wait, what ⁉️
+
+This tool fills a gap in the OpenSSH suite of tools.
+
+  * No way of knowing the PID of a running SSH Agent
+  * No way of knowing the authentication socket of a running SSH Agent
+  * `ssh-agent` only supports Bourne and C shells
+
 Features
 --------
   - output is fully compatible with openSSH:
 
-```
+``` bash
     SSH_AUTH_SOCK=/tmp/ssh-locate-test.15970; export SSH_AUTH_SOCK;
     SSH_AGENT_PID=12427; export SSH_AGENT_PID;
     echo Agent pid 12427;
 ```
+
+  - supports the Fish shell
+
+``` fish
+set -x SSH_AUTH_SOCK ssh-agent -a /tmp/zed
+set -x SSH_AGENT_PID 1517651
+```
+
+(See also Fish Startup below)
+
+  - shows EMACS Lisp to activate agent:
   
+``` emacs-lisp
+(setenv "SSH_AUTH_SOCK" "/tmp/zed")
+(setenv "SSH_AGENT_PID" "3216002")
+```
+
 Installation
 ------------
   
@@ -25,10 +52,32 @@ Launch your SSH agent and tell it to use a specific socket file with the -a opti
 
     ssh-agent -a /tmp/deployer-38us9f
 
-In a later shell (or any process running for the user owning the agent):
+In a later shell (or any process running for the user who owns the agent):
+
+### Bash
 
-    $ eval ssh-locate
+    $ eval `ssh-locate`
     Agent pid 13457
+    
+### Fish
+
+    > ssh-locate | source
+
+### EMACS
+
+Using the `--emacs` option will output the lisp code to set the necessary environment variables in EMACS.
+Just paste this anywhere (in a scratch buffer for example) and execute `eval-last-sexp` (usually bound to C-x C-e)
+with the cursor positionned at the end of each line.
+    
+    ssh-locate --emacs
+
+Fish startup
+------------
+
+You can launch and activate an agent at startup by adding this to your config.fish:
+
+    ssh-agent -a /tmp/arnaud
+    ssh-locate | source
 
 Caveat
 ------

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require "cucumber/rake/task"
+
+task :default => [:test]
+  
+Cucumber::Rake::Task.new(:test) do |task|
+  task.cucumber_opts = ["features"]
+end

data/features/agent-ids.feature

@@ -5,6 +5,7 @@ Feature: Agent IDs
   
   Scenario: Locate a running agent
     Given an ssh agent has been launched without parameters
+    Given the user's shell is Bash
     When I run `ssh-locate`
     Then the output should contain "SSH_AUTH_SOCK="
     And the output should contain "export SSH_AUTH_SOCK;"
@@ -13,13 +14,15 @@ Feature: Agent IDs
     And the output should contain the correct agent PID
     And the output should contain the correct agent socket
     
-  Scenario: No agent is running or localizable
+  Scenario: No agent is running or locatable
     Given no agent is running
     When I run `ssh-locate`
     Then the output should be empty
     
-  Scenario: Locate an agent that shows its socket
+@focus
+  Scenario: Locate an agent that shows its socket in the command line
     Given an ssh agent has been launched with a specific socket
+    Given the user's shell is Bash
     When I run `ssh-locate`
     Then the output should contain "SSH_AUTH_SOCK="
     And the output should contain "export SSH_AUTH_SOCK;"
@@ -27,7 +30,7 @@ Feature: Agent IDs
     And the output should contain "export SSH_AGENT_PID;"
     And the output should contain the correct agent PID
     And the output should contain the correct agent socket
-    
+
   Scenario: Recognize and honor the agent managed by Ubuntu
     Given an ssh agent has been launched in my Ubuntu session
     When I run `ssh-locate`
@@ -37,9 +40,26 @@ Feature: Agent IDs
     And the output should contain "export SSH_AGENT_PID;"
     And the output should contain the correct agent PID
     And the output should contain the correct agent socket
-    
+
   Scenario: Ignore agents run by someone else
     Given an ssh agent is running for another user
     And no ssh agent is running for me
     When I run `ssh-locate`
     Then the output should contain "no agent found"
+
+  Scenario: Support Fish
+    Given an ssh agent has been launched with a specific socket
+    Given the user's shell is Fish
+    When I run `ssh-locate`
+    Then the output should contain "set -x SSH_AUTH_SOCK"
+    And the output should contain "set -x SSH_AGENT_PID"
+    And the output should contain the correct agent PID
+    And the output should contain the correct agent socket
+
+   Scenario: Support EMACS
+    Given an ssh agent has been launched with a specific socket
+    When I run `ssh-locate --emacs`
+    Then the output should contain "(setenv \"SSH_AUTH_SOCK"
+    And the output should contain "(setenv \"SSH_AGENT_PID"
+    And the output should contain the correct agent PID
+    And the output should contain the correct agent socket

data/features/step_definitions/agent-ids.rb

@@ -29,13 +29,22 @@ Given /^no ssh agent is running for me$/ do
 end
 
 Then /^the output should be empty$/ do
-  assert_exact_output('', all_output)
+  expect(all_output).to be_empty
 end
 
 Then /^the output should contain the correct agent PID$/ do
-  assert_partial_output( @agentPID.to_s, all_output )
+  expect(all_output).to include @agentPID.to_s
 end
 
 Then /^the output should contain the correct agent socket$/ do
-  assert_partial_output( @agentSocket.to_s, all_output )
+  expect(all_output).to  include @agentSocket.to_s
 end
+
+Given("the user's shell is Fish") do
+  set_environment_variable('SHELL', 'fish')
+end
+
+Given("the user's shell is Bash") do
+  set_environment_variable('SHELL', 'bash')
+end
+

data/lib/net/ssh/locate/version.rb

@@ -1,7 +1,8 @@
 module Net
   module SSH
     module Locate
-      VERSION = "0.0.1"
+      # Honoring http://semver.org/
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/net/ssh/locate.rb

@@ -1,35 +1,109 @@
-require "net/ssh/locate/version"
-require "thor/group"  
-require "sys/proctable"
+require 'net/ssh/locate/version'
+require 'thor/group'
+require 'sys/proctable'
+require 'English'
 
 module Net
   module SSH
     module Locate
       class App < Thor::Group
         include Thor::Actions
-        
+        def self.banner
+          <<-LONGDESC
+ssh-locate will search for a running ssh-agent and output the environment
+  variables needed to contact it.
+
+  To make sure that you're selecting the agent you launched and not the agent
+  launched by your Desktop Environment, you must use the -a option to specify
+  a socket path:
+
+  $ ssh-agent -a /tmp/zed
+  SSH_AUTH_SOCK=/tmp/zed; export SSH_AUTH_SOCK;
+  SSH_AGENT_PID=1908155; export SSH_AGENT_PID;
+  echo Agent pid 1908155;
+
+  Then later in another shell instance:
+
+  $ ssh-locate
+  SSH_AUTH_SOCK=/tmp/zed; export SSH_AUTH_SOCK;
+  SSH_AGENT_PID=1908155; export SSH_AGENT_PID;
+  echo Agent pid 1908155;
+          LONGDESC
+        end
+
+        class_option :emacs, type: :boolean, desc: 'Output EMACS LISP to execute in EMACS'
+
         def locate_agent
-          procs=Sys::ProcTable.ps.select do 
+          @scanner = Scanner.new
+          @scanner.scan
+        end
+
+        def print_shell_commands
+          return unless @scanner.found?
+
+          if options[:emacs]
+            emacsOutput
+          elsif usingFish?
+            fishOutput
+          else
+            bashOutput
+          end
+        end
+
+        private
+
+        def usingFish?
+          # TODO: This is far from perfect. Launching a secondary shell e.g. zsh from fish would
+          # still show the SHELL env var as /usr/bin/fish
+          ENV['SHELL'] =~ /fish/
+        end
+
+        def bashOutput
+          print "SSH_AUTH_SOCK=#{@scanner.agentSocket};"
+          puts "export SSH_AUTH_SOCK;"
+          print "SSH_AGENT_PID=#{@scanner.agentPID};"
+          puts "export SSH_AGENT_PID;"
+          puts "echo Agent pid #{@scanner.agentPID};"
+        end
+
+        def fishOutput
+          puts "set -x SSH_AUTH_SOCK #{@scanner.agentSocket}"
+          puts "set -x SSH_AGENT_PID #{@scanner.agentPID}"
+        end
+
+        def emacsOutput
+          puts "(setenv \"SSH_AUTH_SOCK\" \"#{@scanner.agentSocket}\")"
+          puts "(setenv \"SSH_AGENT_PID\" \"#{@scanner.agentPID}\")"
+        end
+      end
+
+      class Scanner
+        attr_reader :agentSocket, :agentPID, :found
+
+        def scan
+          @found = false
+          procs = Sys::ProcTable.ps(smaps: false, cgroup: false).select do
             |p|
-            (p.cmdline =~ /ssh-agent/) && !(p.cmdline =~ /--session=ubuntu/) && !(p.state=='Z')
+            res = p.cmdline =~ /ssh-agent/ && p.cmdline !~ /--session=ubuntu/ && p.state != 'Z'
+            res
           end
           return if procs.empty?
-          p=procs.first
+
+          p = procs.first
           p.cmdline =~ /ssh-agent\s-a ([-.a-zA-Z0-9_\/]+)/
-          return if !$~
-          @agentSocket = $1
+          return unless $LAST_MATCH_INFO
+
+          @found = true
+          @agentSocket = $LAST_MATCH_INFO[1]
           @agentPID = p.pid
         end
-        
-        def print_shell_commands
-          return if (!@agentPID || !@agentSocket)
-          print "SSH_AUTH_SOCK=#{@agentSocket}; "
-          puts "export SSH_AUTH_SOCK;"
-          print "SSH_AGENT_PID=#{@agentPID}; "
-          puts "export SSH_AGENT_PID;"
-          puts "echo Agent pid #{@agentPID};"
+
+        def found?
+          @found
         end
+
       end
+
     end
   end
 end

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ssh-locate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Arnaud Meuret
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
-  requirement: &75522350 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75522350
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &75521890 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75521890
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A CLI tool and its associated Ruby library that help you locate and reconnect
   to a running SSH agent. Useful in automation scenarios where multiple processes
   must repeatedly open SSH connections leveraging a one-time authentication pass
@@ -43,7 +48,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - README.md
@@ -58,26 +65,28 @@ files:
 - ssh-locate.gemspec
 homepage: ''
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ssh-locate
-rubygems_version: 1.8.11
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
 summary: A tool (+ a Ruby lib) to locate a running SSH agent
-test_files: []
+test_files:
+- features/agent-ids.feature
+- features/step_definitions/agent-ids.rb
+- features/support/env.rb
+- features/support/hooks.rb