ssh-locate 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/README.md

@@ -0,0 +1,43 @@
+ssh-locate
+==========
+  
+  A command line tool that helps you locate and contact a SSH agent launched in a separate session.
+  
+Features
+--------
+  - output is fully compatible with openSSH:
+
+```
+    SSH_AUTH_SOCK=/tmp/ssh-locate-test.15970; export SSH_AUTH_SOCK;
+    SSH_AGENT_PID=12427; export SSH_AGENT_PID;
+    echo Agent pid 12427;
+```
+  
+Installation
+------------
+  
+    gem install ssh-locate
+  
+Usage
+-----
+  
+Launch your SSH agent and tell it to use a specific socket file with the -a option:
+
+    ssh-agent -a /tmp/deployer-38us9f
+
+In a later shell (or any process running for the user owning the agent):
+
+    $ eval ssh-locate
+    Agent pid 13457
+
+Caveat
+------
+
+`ssh-locate` only reports the first agent found in the process table. If you have a scenario where you would like to be more specific, let me known and I can extend the selectivity. I just do not need that right now.
+
+TODO
+----
+As the YAGNI wisdom tells us not to fantasize requirements, here are some potentially useful things that are not implemented yet:
+
+  - Be aware of the agent launched by Ubuntu
+  - Have a more sensible output if no agent was found

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/ssh-locate

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+module Net
+  module SSH
+    module Locate
+      LIB=File.dirname(__FILE__) + '/../lib'
+    end
+  end
+end
+$: << Net::SSH::Locate::LIB unless $:.include?(File.expand_path(Net::SSH::Locate::LIB))
+require "thor"
+require "net/ssh/locate"
+
+begin
+  Net::SSH::Locate::App.start
+rescue ArgumentError
+  exit
+end

data/features/agent-ids.feature

@@ -0,0 +1,45 @@
+Feature: Agent IDs
+  In order to connect to remote services in a secure and efficient manner
+  As a modern sysadmin who values machine resources and human time
+  I want to connect to a single ssh agent, launched a long time ago in a shell far far away
+  
+  Scenario: Locate a running agent
+    Given an ssh agent has been launched without parameters
+    When I run `ssh-locate`
+    Then the output should contain "SSH_AUTH_SOCK="
+    And the output should contain "export SSH_AUTH_SOCK;"
+    And the output should contain "SSH_AGENT_PID="
+    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: No agent is running or localizable
+    Given no agent is running
+    When I run `ssh-locate`
+    Then the output should be empty
+    
+  Scenario: Locate an agent that shows its socket
+    Given an ssh agent has been launched with a specific socket
+    When I run `ssh-locate`
+    Then the output should contain "SSH_AUTH_SOCK="
+    And the output should contain "export SSH_AUTH_SOCK;"
+    And the output should contain "SSH_AGENT_PID="
+    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`
+    Then the output should contain "SSH_AUTH_SOCK="
+    And the output should contain "export SSH_AUTH_SOCK;"
+    And the output should contain "SSH_AGENT_PID="
+    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"

data/features/step_definitions/agent-ids.rb

@@ -0,0 +1,41 @@
+Given /^an ssh agent has been launched without parameters$/ do
+  pending
+end
+
+Given /^an ssh agent has been launched with a specific socket$/ do
+  @agentIO = IO.popen('ssh-agent -a /tmp/ssh-locate-test.15970')
+  @agentOutput = @agentIO.read
+  @agentIO.close
+  @agentPID = @agentOutput[/PID=(\d+)/,1].to_i
+  @agentSocket = @agentOutput[/SOCK=([\w\-._\/]+)/,1]
+  # The agent is shutdown in the 'after' hook
+end
+
+Given /^an SSH agent has been launched in my Ubuntu session$/ do
+  pending
+end
+
+Given /^no agent is running$/ do
+  @agentPID=nil
+  @agentSocket=nil
+end
+
+Given /^an ssh agent is running for another user$/ do
+  pending # express the regexp above with the code you wish you had
+end
+
+Given /^no ssh agent is running for me$/ do
+  pending # express the regexp above with the code you wish you had
+end
+
+Then /^the output should be empty$/ do
+  assert_exact_output('', all_output)
+end
+
+Then /^the output should contain the correct agent PID$/ do
+  assert_partial_output( @agentPID.to_s, all_output )
+end
+
+Then /^the output should contain the correct agent socket$/ do
+  assert_partial_output( @agentSocket.to_s, all_output )
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require "aruba/cucumber"

data/features/support/hooks.rb

@@ -0,0 +1,12 @@
+# This file contains Cucumber hooks.
+# It gets required automatically by Cucumber just because it has a .rb
+# extension and resides under features/
+
+Before do
+end
+
+After do
+   if @agentIO
+     Process.kill("TERM", @agentPID)
+   end
+end

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

@@ -0,0 +1,7 @@
+module Net
+  module SSH
+    module Locate
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/net/ssh/locate.rb

@@ -0,0 +1,35 @@
+require "net/ssh/locate/version"
+require "thor/group"  
+require "sys/proctable"
+
+module Net
+  module SSH
+    module Locate
+      class App < Thor::Group
+        include Thor::Actions
+        
+        def locate_agent
+          procs=Sys::ProcTable.ps.select do 
+            |p|
+            (p.cmdline =~ /ssh-agent/) && !(p.cmdline =~ /--session=ubuntu/) && !(p.state=='Z')
+          end
+          return if procs.empty?
+          p=procs.first
+          p.cmdline =~ /ssh-agent\s-a ([-.a-zA-Z0-9_\/]+)/
+          return if !$~
+          @agentSocket = $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};"
+        end
+      end
+    end
+  end
+end

data/ssh-locate.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("lib", File.dirname(__FILE__))
+require "net/ssh/locate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ssh-locate"
+  s.version     = Net::SSH::Locate::VERSION
+  s.authors     = ["Arnaud Meuret"]
+  s.email       = ["arnaud@meuret.name"]
+  s.homepage    = ""
+  s.summary     = %q{A tool (+ a Ruby lib) to locate a running SSH agent}
+  s.description = %q{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}
+
+  s.rubyforge_project = "ssh-locate"
+  
+  s.add_dependency "sys-proctable"
+  s.add_dependency "thor"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ssh-locate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arnaud Meuret
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: &75522350 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75522350
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &75521890 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75521890
+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
+email:
+- arnaud@meuret.name
+executables:
+- ssh-locate
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/ssh-locate
+- features/agent-ids.feature
+- features/step_definitions/agent-ids.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- lib/net/ssh/locate.rb
+- lib/net/ssh/locate/version.rb
+- ssh-locate.gemspec
+homepage: ''
+licenses: []
+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
+summary: A tool (+ a Ruby lib) to locate a running SSH agent
+test_files: []