net-ssh 2.5.0 → 2.5.1

data/CHANGELOG.rdoc

@@ -1,4 +1,8 @@
 
+=== 2.5.1 / 24 May 2012
+
+* Added missing file to manifest [Marco Sandrini]
+
 === 2.5.0 / 24 May 2012
 
 * Implement many algorithms [Ryosuke Yamazaki]

data/lib/net/ssh/authentication/agent/java_pageant.rb

@@ -0,0 +1,85 @@
+require 'jruby_pageant'
+
+module Net; module SSH; module Authentication
+
+  # This class implements an agent for JRuby + Pageant.
+  #
+  # Written by Artūras Šlajus <arturas.slajus@gmail.com>
+  class Agent
+    include Loggable
+    include JRubyPageant
+
+    # A simple module for extending keys, to allow blobs and comments to be
+    # specified for them.
+    module Key
+      # :blob is used by OpenSSL::PKey::RSA#to_blob
+      attr_accessor :java_blob
+      attr_accessor :comment
+    end
+
+    # Instantiates a new agent object, connects to a running SSH agent,
+    # negotiates the agent protocol version, and returns the agent object.
+    def self.connect(logger=nil)
+      agent = new(logger)
+      agent.connect!
+      agent
+    end
+
+    # Creates a new Agent object, using the optional logger instance to
+    # report status.
+    def initialize(logger=nil)
+      self.logger = logger
+    end
+
+    # Connect to the agent process using the socket factory and socket name
+    # given by the attribute writers. If the agent on the other end of the
+    # socket reports that it is an SSH2-compatible agent, this will fail
+    # (it only supports the ssh-agent distributed by OpenSSH).
+    def connect!
+      debug { "connecting to Pageant ssh-agent (via java connector)" }
+      @agent_proxy = JRubyPageant.create
+      unless @agent_proxy.is_running
+        raise AgentNotAvailable, "Pageant is not running!"
+      end
+      debug { "connection to Pageant ssh-agent (via java connector) succeeded" }
+    rescue AgentProxyException => e
+      error { "could not connect to Pageant ssh-agent (via java connector)" }
+      raise AgentNotAvailable, e.message, e.backtrace
+    end
+
+    # Return an array of all identities (public keys) known to the agent.
+    # Each key returned is augmented with a +comment+ property which is set
+    # to the comment returned by the agent for that key.
+    def identities
+      debug { "getting identities from Pageant" }
+      @agent_proxy.get_identities.map do |identity|
+        blob = identity.get_blob
+        key = Buffer.new(String.from_java_bytes(blob)).read_key
+        key.extend(Key)
+        key.java_blob = blob
+        key.comment = String.from_java_bytes(identity.get_comment)
+        key
+      end
+    rescue AgentProxyException => e
+      raise AgentError, "Cannot get identities: #{e.message}", e.backtrace
+    end
+
+    # Simulate agent close. This agent reference is no longer able to
+    # query the agent.
+    def close
+      @agent_proxy = nil
+    end
+
+    # Using the agent and the given public key, sign the given data. The
+    # signature is returned in SSH2 format.
+    def sign(key, data)
+      signed = @agent_proxy.sign(key.java_blob, data.to_java_bytes)
+      String.from_java_bytes(signed)
+    rescue AgentProxyException => e
+      raise AgentError,
+        "agent could not sign data with requested identity: #{e.message}",
+        e.backtrace
+    end
+  end
+
+end; end; end

data/lib/net/ssh/authentication/agent/socket.rb

@@ -0,0 +1,170 @@
+require 'net/ssh/transport/server_version'
+
+# Only load pageant on Windows
+if Net::SSH::Authentication::PLATFORM == :win32
+  require 'net/ssh/authentication/pageant'
+end
+
+module Net; module SSH; module Authentication
+
+  # This class implements a simple client for the ssh-agent protocol. It
+  # does not implement any specific protocol, but instead copies the
+  # behavior of the ssh-agent functions in the OpenSSH library (3.8).
+  #
+  # This means that although it behaves like a SSH1 client, it also has
+  # some SSH2 functionality (like signing data).
+  class Agent
+    include Loggable
+
+    # A simple module for extending keys, to allow comments to be specified
+    # for them.
+    module Comment
+      attr_accessor :comment
+    end
+
+    SSH2_AGENT_REQUEST_VERSION    = 1
+    SSH2_AGENT_REQUEST_IDENTITIES = 11
+    SSH2_AGENT_IDENTITIES_ANSWER  = 12
+    SSH2_AGENT_SIGN_REQUEST       = 13
+    SSH2_AGENT_SIGN_RESPONSE      = 14
+    SSH2_AGENT_FAILURE            = 30
+    SSH2_AGENT_VERSION_RESPONSE   = 103
+
+    SSH_COM_AGENT2_FAILURE        = 102
+
+    SSH_AGENT_REQUEST_RSA_IDENTITIES = 1
+    SSH_AGENT_RSA_IDENTITIES_ANSWER1 = 2
+    SSH_AGENT_RSA_IDENTITIES_ANSWER2 = 5
+    SSH_AGENT_FAILURE                = 5
+
+    # The underlying socket being used to communicate with the SSH agent.
+    attr_reader :socket
+
+    # Instantiates a new agent object, connects to a running SSH agent,
+    # negotiates the agent protocol version, and returns the agent object.
+    def self.connect(logger=nil)
+      agent = new(logger)
+      agent.connect!
+      agent.negotiate!
+      agent
+    end
+
+    # Creates a new Agent object, using the optional logger instance to
+    # report status.
+    def initialize(logger=nil)
+      self.logger = logger
+    end
+
+    # Connect to the agent process using the socket factory and socket name
+    # given by the attribute writers. If the agent on the other end of the
+    # socket reports that it is an SSH2-compatible agent, this will fail
+    # (it only supports the ssh-agent distributed by OpenSSH).
+    def connect!
+      begin
+        debug { "connecting to ssh-agent" }
+        @socket = agent_socket_factory.open(ENV['SSH_AUTH_SOCK'])
+      rescue
+        error { "could not connect to ssh-agent" }
+        raise AgentNotAvailable, $!.message
+      end
+    end
+
+    # Attempts to negotiate the SSH agent protocol version. Raises an error
+    # if the version could not be negotiated successfully.
+    def negotiate!
+      # determine what type of agent we're communicating with
+      type, body = send_and_wait(SSH2_AGENT_REQUEST_VERSION, :string, Transport::ServerVersion::PROTO_VERSION)
+
+      if type == SSH2_AGENT_VERSION_RESPONSE
+        raise NotImplementedError, "SSH2 agents are not yet supported"
+      elsif type != SSH_AGENT_RSA_IDENTITIES_ANSWER1 && type != SSH_AGENT_RSA_IDENTITIES_ANSWER2
+        raise AgentError, "unknown response from agent: #{type}, #{body.to_s.inspect}"
+      end
+    end
+
+    # Return an array of all identities (public keys) known to the agent.
+    # Each key returned is augmented with a +comment+ property which is set
+    # to the comment returned by the agent for that key.
+    def identities
+      type, body = send_and_wait(SSH2_AGENT_REQUEST_IDENTITIES)
+      raise AgentError, "could not get identity count" if agent_failed(type)
+      raise AgentError, "bad authentication reply: #{type}" if type != SSH2_AGENT_IDENTITIES_ANSWER
+
+      identities = []
+      body.read_long.times do
+        key = Buffer.new(body.read_string).read_key
+        key.extend(Comment)
+        key.comment = body.read_string
+        identities.push key
+      end
+
+      return identities
+    end
+
+    # Closes this socket. This agent reference is no longer able to
+    # query the agent.
+    def close
+      @socket.close
+    end
+
+    # Using the agent and the given public key, sign the given data. The
+    # signature is returned in SSH2 format.
+    def sign(key, data)
+      type, reply = send_and_wait(SSH2_AGENT_SIGN_REQUEST, :string, Buffer.from(:key, key), :string, data, :long, 0)
+
+      if agent_failed(type)
+        raise AgentError, "agent could not sign data with requested identity"
+      elsif type != SSH2_AGENT_SIGN_RESPONSE
+        raise AgentError, "bad authentication response #{type}"
+      end
+
+      return reply.read_string
+    end
+
+    private
+
+    # Returns the agent socket factory to use.
+    def agent_socket_factory
+      if Net::SSH::Authentication::PLATFORM == :win32
+        Pageant::socket_factory
+      else
+        UNIXSocket
+      end
+    end
+
+    # Send a new packet of the given type, with the associated data.
+    def send_packet(type, *args)
+      buffer = Buffer.from(*args)
+      data = [buffer.length + 1, type.to_i, buffer.to_s].pack("NCA*")
+      debug { "sending agent request #{type} len #{buffer.length}" }
+      @socket.send data, 0
+    end
+
+    # Read the next packet from the agent. This will return a two-part
+    # tuple consisting of the packet type, and the packet's body (which
+    # is returned as a Net::SSH::Buffer).
+    def read_packet
+      buffer = Net::SSH::Buffer.new(@socket.read(4))
+      buffer.append(@socket.read(buffer.read_long))
+      type = buffer.read_byte
+      debug { "received agent packet #{type} len #{buffer.length-4}" }
+      return type, buffer
+    end
+
+    # Send the given packet and return the subsequent reply from the agent.
+    # (See #send_packet and #read_packet).
+    def send_and_wait(type, *args)
+      send_packet(type, *args)
+      read_packet
+    end
+
+    # Returns +true+ if the parameter indicates a "failure" response from
+    # the agent, and +false+ otherwise.
+    def agent_failed(type)
+      type == SSH_AGENT_FAILURE ||
+        type == SSH2_AGENT_FAILURE ||
+        type == SSH_COM_AGENT2_FAILURE
+    end
+  end
+
+end; end; end

data/lib/net/ssh/version.rb

@@ -51,7 +51,7 @@ module Net; module SSH
     MINOR = 5
 
     # The tiny component of this version of the Net::SSH library
-    TINY  = 0
+    TINY  = 1
 
     # The current version of the Net::SSH library as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

data/net-ssh.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "net-ssh"
   s.rubyforge_project = 'net-ssh'
-  s.version = "2.5.0"
+  s.version = "2.5.1"
   s.summary = "Net::SSH: a pure-Ruby implementation of the SSH2 client protocol."
   s.description = s.summary + " It allows you to write programs that invoke and interact with processes on remote servers, via SSH2."
   s.authors = ["Jamis Buck", "Delano Mandelbaum"]
@@ -40,6 +40,8 @@
   lib/net/ssh/authentication/methods/publickey.rb
   lib/net/ssh/authentication/pageant.rb
   lib/net/ssh/authentication/session.rb
+  lib/net/ssh/authentication/agent/java_pageant.rb
+  lib/net/ssh/authentication/agent/socket.rb
   lib/net/ssh/buffer.rb
   lib/net/ssh/buffered_io.rb
   lib/net/ssh/config.rb

metadata

@@ -2,7 +2,7 @@
 name: net-ssh
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors: 
 - Jamis Buck
@@ -53,6 +53,8 @@ files:
 - lib/net/ssh/authentication/methods/publickey.rb
 - lib/net/ssh/authentication/pageant.rb
 - lib/net/ssh/authentication/session.rb
+- lib/net/ssh/authentication/agent/java_pageant.rb
+- lib/net/ssh/authentication/agent/socket.rb
 - lib/net/ssh/buffer.rb
 - lib/net/ssh/buffered_io.rb
 - lib/net/ssh/config.rb