net-ssh 5.0.0.beta1 → 5.0.0.beta2

data/lib/net/ssh/key_factory.rb

@@ -3,130 +3,130 @@ require 'net/ssh/prompt'
 
 require 'net/ssh/authentication/ed25519_loader'
 
-module Net; module SSH
-
-  # A factory class for returning new Key classes. It is used for obtaining
-  # OpenSSL key instances via their SSH names, and for loading both public and
-  # private keys. It used used primarily by Net::SSH itself, internally, and
-  # will rarely (if ever) be directly used by consumers of the library.
-  #
-  #   klass = Net::SSH::KeyFactory.get("rsa")
-  #   assert klass.is_a?(OpenSSL::PKey::RSA)
-  #
-  #   key = Net::SSH::KeyFactory.load_public_key("~/.ssh/id_dsa.pub")
-  class KeyFactory
-    # Specifies the mapping of SSH names to OpenSSL key classes.
-    MAP = {
-      "dh"  => OpenSSL::PKey::DH,
-      "rsa" => OpenSSL::PKey::RSA,
-      "dsa" => OpenSSL::PKey::DSA,
-    }
-    if defined?(OpenSSL::PKey::EC)
-      MAP["ecdsa"] = OpenSSL::PKey::EC
-      MAP["ed25519"] = Net::SSH::Authentication::ED25519::PrivKey if defined? Net::SSH::Authentication::ED25519
-    end
-
-    class <<self
-      # Fetch an OpenSSL key instance by its SSH name. It will be a new,
-      # empty key of the given type.
-      def get(name)
-        MAP.fetch(name).new
-      end
-
-      # Loads a private key from a file. It will correctly determine
-      # whether the file describes an RSA or DSA key, and will load it
-      # appropriately. The new key is returned. If the key itself is
-      # encrypted (requiring a passphrase to use), the user will be
-      # prompted to enter their password unless passphrase works.
-      def load_private_key(filename, passphrase=nil, ask_passphrase=true, prompt=Prompt.default)
-        data = File.read(File.expand_path(filename))
-        load_data_private_key(data, passphrase, ask_passphrase, filename, prompt)
+module Net
+  module SSH
+
+    # A factory class for returning new Key classes. It is used for obtaining
+    # OpenSSL key instances via their SSH names, and for loading both public and
+    # private keys. It used used primarily by Net::SSH itself, internally, and
+    # will rarely (if ever) be directly used by consumers of the library.
+    #
+    #   klass = Net::SSH::KeyFactory.get("rsa")
+    #   assert klass.is_a?(OpenSSL::PKey::RSA)
+    #
+    #   key = Net::SSH::KeyFactory.load_public_key("~/.ssh/id_dsa.pub")
+    class KeyFactory
+      # Specifies the mapping of SSH names to OpenSSL key classes.
+      MAP = {
+        "dh"  => OpenSSL::PKey::DH,
+        "rsa" => OpenSSL::PKey::RSA,
+        "dsa" => OpenSSL::PKey::DSA
+      }
+      if defined?(OpenSSL::PKey::EC)
+        MAP["ecdsa"] = OpenSSL::PKey::EC
+        MAP["ed25519"] = Net::SSH::Authentication::ED25519::PrivKey if defined? Net::SSH::Authentication::ED25519
       end
 
-      # Loads a private key. It will correctly determine
-      # whether the file describes an RSA or DSA key, and will load it
-      # appropriately. The new key is returned. If the key itself is
-      # encrypted (requiring a passphrase to use), the user will be
-      # prompted to enter their password unless passphrase works.
-      def load_data_private_key(data, passphrase=nil, ask_passphrase=true, filename="", prompt=Prompt.default)
-        key_read, error_classes = classify_key(data, filename)
+      class <<self
+        # Fetch an OpenSSL key instance by its SSH name. It will be a new,
+        # empty key of the given type.
+        def get(name)
+          MAP.fetch(name).new
+        end
 
-        encrypted_key = data.match(/ENCRYPTED/)
-        tries = 0
+        # Loads a private key from a file. It will correctly determine
+        # whether the file describes an RSA or DSA key, and will load it
+        # appropriately. The new key is returned. If the key itself is
+        # encrypted (requiring a passphrase to use), the user will be
+        # prompted to enter their password unless passphrase works.
+        def load_private_key(filename, passphrase=nil, ask_passphrase=true, prompt=Prompt.default)
+          data = File.read(File.expand_path(filename))
+          load_data_private_key(data, passphrase, ask_passphrase, filename, prompt)
+        end
 
-        prompter = nil
-        result =
-          begin
-            key_read[data, passphrase || 'invalid']
-          rescue *error_classes
-            if encrypted_key && ask_passphrase
-              tries += 1
-              if tries <= 3
-                prompter ||= prompt.start(type: 'private_key', filename: filename, sha: Digest::SHA256.digest(data))
-                passphrase = prompter.ask("Enter passphrase for #{filename}:", false)
-                retry
+        # Loads a private key. It will correctly determine
+        # whether the file describes an RSA or DSA key, and will load it
+        # appropriately. The new key is returned. If the key itself is
+        # encrypted (requiring a passphrase to use), the user will be
+        # prompted to enter their password unless passphrase works.
+        def load_data_private_key(data, passphrase=nil, ask_passphrase=true, filename="", prompt=Prompt.default)
+          key_read, error_classes = classify_key(data, filename)
+
+          encrypted_key = data.match(/ENCRYPTED/)
+          tries = 0
+
+          prompter = nil
+          result =
+            begin
+              key_read[data, passphrase || 'invalid']
+            rescue *error_classes
+              if encrypted_key && ask_passphrase
+                tries += 1
+                if tries <= 3
+                  prompter ||= prompt.start(type: 'private_key', filename: filename, sha: Digest::SHA256.digest(data))
+                  passphrase = prompter.ask("Enter passphrase for #{filename}:", false)
+                  retry
+                else
+                  raise
+                end
               else
                 raise
               end
-            else
-              raise
             end
-          end
-        prompter.success if prompter
-        result
-      end
+          prompter.success if prompter
+          result
+        end
 
-      # Loads a public key from a file. It will correctly determine whether
-      # the file describes an RSA or DSA key, and will load it
-      # appropriately. The new public key is returned.
-      def load_public_key(filename)
-        data = File.read(File.expand_path(filename))
-        load_data_public_key(data, filename)
-      end
+        # Loads a public key from a file. It will correctly determine whether
+        # the file describes an RSA or DSA key, and will load it
+        # appropriately. The new public key is returned.
+        def load_public_key(filename)
+          data = File.read(File.expand_path(filename))
+          load_data_public_key(data, filename)
+        end
 
-      # Loads a public key. It will correctly determine whether
-      # the file describes an RSA or DSA key, and will load it
-      # appropriately. The new public key is returned.
-      def load_data_public_key(data, filename="")
-        fields = data.split(/ /)
+        # Loads a public key. It will correctly determine whether
+        # the file describes an RSA or DSA key, and will load it
+        # appropriately. The new public key is returned.
+        def load_data_public_key(data, filename="")
+          fields = data.split(/ /)
 
-        blob = nil
-        begin
+          blob = nil
+          begin
+            blob = fields.shift
+          end while !blob.nil? && !/^(ssh-(rsa|dss|ed25519)|ecdsa-sha2-nistp\d+)(-cert-v01@openssh\.com)?$/.match(blob)
           blob = fields.shift
-        end while !blob.nil? && !/^(ssh-(rsa|dss|ed25519)|ecdsa-sha2-nistp\d+)(-cert-v01@openssh\.com)?$/.match(blob)
-        blob = fields.shift
-
-        raise Net::SSH::Exception, "public key at #{filename} is not valid" if blob.nil?
 
-        blob = blob.unpack("m*").first
-        reader = Net::SSH::Buffer.new(blob)
-        reader.read_key or raise OpenSSL::PKey::PKeyError, "not a public key #{filename.inspect}"
-      end
+          raise Net::SSH::Exception, "public key at #{filename} is not valid" if blob.nil?
 
-      private
+          blob = blob.unpack("m*").first
+          reader = Net::SSH::Buffer.new(blob)
+          reader.read_key or raise OpenSSL::PKey::PKeyError, "not a public key #{filename.inspect}"
+        end
 
-      # Determine whether the file describes an RSA or DSA key, and return how load it
-      # appropriately.
-      def classify_key(data, filename)
-        if data.match(/-----BEGIN OPENSSH PRIVATE KEY-----/)
-          Net::SSH::Authentication::ED25519Loader.raiseUnlessLoaded("OpenSSH keys only supported if ED25519 is available")
-          return ->(key_data, passphrase) { Net::SSH::Authentication::ED25519::PrivKey.read(key_data, passphrase) }, [ArgumentError]
-        elsif OpenSSL::PKey.respond_to?(:read)
-          return ->(key_data, passphrase) { OpenSSL::PKey.read(key_data, passphrase) }, [ArgumentError, OpenSSL::PKey::PKeyError]
-        elsif data.match(/-----BEGIN DSA PRIVATE KEY-----/)
-          return ->(key_data, passphrase) { OpenSSL::PKey::DSA.new(key_data, passphrase) }, [OpenSSL::PKey::DSAError]
-        elsif data.match(/-----BEGIN RSA PRIVATE KEY-----/)
-          return ->(key_data, passphrase) { OpenSSL::PKey::RSA.new(key_data, passphrase) }, [OpenSSL::PKey::RSAError]
-        elsif data.match(/-----BEGIN EC PRIVATE KEY-----/) && defined?(OpenSSL::PKey::EC)
-          return ->(key_data, passphrase) { OpenSSL::PKey::EC.new(key_data, passphrase) }, [OpenSSL::PKey::ECError]
-        elsif data.match(/-----BEGIN (.+) PRIVATE KEY-----/)
-          raise OpenSSL::PKey::PKeyError, "not a supported key type '#{$1}'"
-        else
-          raise OpenSSL::PKey::PKeyError, "not a private key (#{filename})"
+        private
+
+        # Determine whether the file describes an RSA or DSA key, and return how load it
+        # appropriately.
+        def classify_key(data, filename)
+          if data.match(/-----BEGIN OPENSSH PRIVATE KEY-----/)
+            Net::SSH::Authentication::ED25519Loader.raiseUnlessLoaded("OpenSSH keys only supported if ED25519 is available")
+            return ->(key_data, passphrase) { Net::SSH::Authentication::ED25519::PrivKey.read(key_data, passphrase) }, [ArgumentError]
+          elsif OpenSSL::PKey.respond_to?(:read)
+            return ->(key_data, passphrase) { OpenSSL::PKey.read(key_data, passphrase) }, [ArgumentError, OpenSSL::PKey::PKeyError]
+          elsif data.match(/-----BEGIN DSA PRIVATE KEY-----/)
+            return ->(key_data, passphrase) { OpenSSL::PKey::DSA.new(key_data, passphrase) }, [OpenSSL::PKey::DSAError]
+          elsif data.match(/-----BEGIN RSA PRIVATE KEY-----/)
+            return ->(key_data, passphrase) { OpenSSL::PKey::RSA.new(key_data, passphrase) }, [OpenSSL::PKey::RSAError]
+          elsif data.match(/-----BEGIN EC PRIVATE KEY-----/) && defined?(OpenSSL::PKey::EC)
+            return ->(key_data, passphrase) { OpenSSL::PKey::EC.new(key_data, passphrase) }, [OpenSSL::PKey::ECError]
+          elsif data.match(/-----BEGIN (.+) PRIVATE KEY-----/)
+            raise OpenSSL::PKey::PKeyError, "not a supported key type '#{$1}'"
+          else
+            raise OpenSSL::PKey::PKeyError, "not a private key (#{filename})"
+          end
         end
       end
     end
-
   end
-
-end; end
+end

data/lib/net/ssh/known_hosts.rb

@@ -3,185 +3,179 @@ require 'openssl'
 require 'base64'
 require 'net/ssh/buffer'
 
-module Net; module SSH
-
-  # Represents the result of a search in known hosts
-  # see search_for
-  class HostKeys
-    include Enumerable
-    attr_reader :host
-
-    def initialize(host_keys, host, known_hosts, options = {})
-       @host_keys = host_keys
-       @host = host
-       @known_hosts = known_hosts
-       @options = options
-    end
+module Net
+  module SSH
+
+    # Represents the result of a search in known hosts
+    # see search_for
+    class HostKeys
+      include Enumerable
+      attr_reader :host
+
+      def initialize(host_keys, host, known_hosts, options = {})
+        @host_keys = host_keys
+        @host = host
+        @known_hosts = known_hosts
+        @options = options
+      end
 
-    def add_host_key(key)
-       @known_hosts.add(@host, key, @options)
-       @host_keys.push(key)
-    end
+      def add_host_key(key)
+        @known_hosts.add(@host, key, @options)
+        @host_keys.push(key)
+      end
 
-    def each(&block)
-       @host_keys.each(&block)
-    end
+      def each(&block)
+        @host_keys.each(&block)
+      end
 
-    def empty?
-      @host_keys.empty?
+      def empty?
+        @host_keys.empty?
+      end
     end
-  end
 
-  # Searches an OpenSSH-style known-host file for a given host, and returns all
-  # matching keys. This is used to implement host-key verification, as well as
-  # to determine what key a user prefers to use for a given host.
-  #
-  # This is used internally by Net::SSH, and will never need to be used directly
-  # by consumers of the library.
-  class KnownHosts
-
-    if defined?(OpenSSL::PKey::EC)
-      SUPPORTED_TYPE = %w(ssh-rsa ssh-dss
-                          ecdsa-sha2-nistp256
-                          ecdsa-sha2-nistp384
-                          ecdsa-sha2-nistp521)
-    else
-      SUPPORTED_TYPE = %w(ssh-rsa ssh-dss)
-    end
+    # Searches an OpenSSH-style known-host file for a given host, and returns all
+    # matching keys. This is used to implement host-key verification, as well as
+    # to determine what key a user prefers to use for a given host.
+    #
+    # This is used internally by Net::SSH, and will never need to be used directly
+    # by consumers of the library.
+    class KnownHosts
+      if defined?(OpenSSL::PKey::EC)
+        SUPPORTED_TYPE = %w[ssh-rsa ssh-dss
+                            ecdsa-sha2-nistp256
+                            ecdsa-sha2-nistp384
+                            ecdsa-sha2-nistp521]
+      else
+        SUPPORTED_TYPE = %w[ssh-rsa ssh-dss]
+      end
 
+      class <<self
+        # Searches all known host files (see KnownHosts.hostfiles) for all keys
+        # of the given host. Returns an enumerable of keys found.
+        def search_for(host, options={})
+          HostKeys.new(search_in(hostfiles(options), host), host, self, options)
+        end
 
-    class <<self
+        # Search for all known keys for the given host, in every file given in
+        # the +files+ array. Returns the list of keys.
+        def search_in(files, host)
+          files.flat_map { |file| KnownHosts.new(file).keys_for(host) }
+        end
 
-      # Searches all known host files (see KnownHosts.hostfiles) for all keys
-      # of the given host. Returns an enumerable of keys found.
-      def search_for(host, options={})
-        HostKeys.new(search_in(hostfiles(options), host), host, self, options)
-      end
+        # Looks in the given +options+ hash for the :user_known_hosts_file and
+        # :global_known_hosts_file keys, and returns an array of all known
+        # hosts files. If the :user_known_hosts_file key is not set, the
+        # default is returned (~/.ssh/known_hosts and ~/.ssh/known_hosts2). If
+        # :global_known_hosts_file is not set, the default is used
+        # (/etc/ssh/ssh_known_hosts and /etc/ssh/ssh_known_hosts2).
+        #
+        # If you only want the user known host files, you can pass :user as
+        # the second option.
+        def hostfiles(options, which=:all)
+          files = []
 
-      # Search for all known keys for the given host, in every file given in
-      # the +files+ array. Returns the list of keys.
-      def search_in(files, host)
-        files.map { |file| KnownHosts.new(file).keys_for(host) }.flatten
-      end
+          files += Array(options[:user_known_hosts_file] || %w[~/.ssh/known_hosts ~/.ssh/known_hosts2]) if which == :all || which == :user
 
-      # Looks in the given +options+ hash for the :user_known_hosts_file and
-      # :global_known_hosts_file keys, and returns an array of all known
-      # hosts files. If the :user_known_hosts_file key is not set, the
-      # default is returned (~/.ssh/known_hosts and ~/.ssh/known_hosts2). If
-      # :global_known_hosts_file is not set, the default is used
-      # (/etc/ssh/ssh_known_hosts and /etc/ssh/ssh_known_hosts2).
-      #
-      # If you only want the user known host files, you can pass :user as
-      # the second option.
-      def hostfiles(options, which=:all)
-        files = []
+          files += Array(options[:global_known_hosts_file] || %w[/etc/ssh/ssh_known_hosts /etc/ssh/ssh_known_hosts2]) if which == :all || which == :global
 
-        if which == :all || which == :user
-          files += Array(options[:user_known_hosts_file] || %w(~/.ssh/known_hosts ~/.ssh/known_hosts2))
+          return files
         end
 
-        if which == :all || which == :global
-          files += Array(options[:global_known_hosts_file] || %w(/etc/ssh/ssh_known_hosts /etc/ssh/ssh_known_hosts2))
-        end
-
-        return files
-      end
-
-      # Looks in all user known host files (see KnownHosts.hostfiles) and tries to
-      # add an entry for the given host and key to the first file it is able
-      # to.
-      def add(host, key, options={})
-        hostfiles(options, :user).each do |file|
-          begin
-            KnownHosts.new(file).add(host, key)
-            return
-          rescue SystemCallError
-            # try the next hostfile
+        # Looks in all user known host files (see KnownHosts.hostfiles) and tries to
+        # add an entry for the given host and key to the first file it is able
+        # to.
+        def add(host, key, options={})
+          hostfiles(options, :user).each do |file|
+            begin
+              KnownHosts.new(file).add(host, key)
+              return
+            rescue SystemCallError
+              # try the next hostfile
+            end
           end
         end
       end
-    end
 
-    # The host-key file name that this KnownHosts instance will use to search
-    # for keys.
-    attr_reader :source
+      # The host-key file name that this KnownHosts instance will use to search
+      # for keys.
+      attr_reader :source
 
-    # Instantiate a new KnownHosts instance that will search the given known-hosts
-    # file. The path is expanded file File.expand_path.
-    def initialize(source)
-      @source = File.expand_path(source)
-    end
+      # Instantiate a new KnownHosts instance that will search the given known-hosts
+      # file. The path is expanded file File.expand_path.
+      def initialize(source)
+        @source = File.expand_path(source)
+      end
 
-    # Returns an array of all keys that are known to be associatd with the
-    # given host. The +host+ parameter is either the domain name or ip address
-    # of the host, or both (comma-separated). Additionally, if a non-standard
-    # port is being used, it may be specified by putting the host (or ip, or
-    # both) in square brackets, and appending the port outside the brackets
-    # after a colon. Possible formats for +host+, then, are;
-    #
-    #   "net.ssh.test"
-    #   "1.2.3.4"
-    #   "net.ssh.test,1.2.3.4"
-    #   "[net.ssh.test]:5555"
-    #   "[1,2,3,4]:5555"
-    #   "[net.ssh.test]:5555,[1.2.3.4]:5555
-    def keys_for(host)
-      keys = []
-      return keys unless File.readable?(source)
-
-      entries = host.split(/,/)
-
-      File.open(source) do |file|
-        scanner = StringScanner.new("")
-        file.each_line do |line|
-          scanner.string = line
-
-          scanner.skip(/\s*/)
-          next if scanner.match?(/$|#/)
-
-          hostlist = scanner.scan(/\S+/).split(/,/)
-          found = entries.all? { |entry| hostlist.include?(entry) } ||
-            known_host_hash?(hostlist, entries, scanner)
-          next unless found
-
-          scanner.skip(/\s*/)
-          type = scanner.scan(/\S+/)
-
-          next unless SUPPORTED_TYPE.include?(type)
-
-          scanner.skip(/\s*/)
-          blob = scanner.rest.unpack("m*").first
-          keys << Net::SSH::Buffer.new(blob).read_key
+      # Returns an array of all keys that are known to be associatd with the
+      # given host. The +host+ parameter is either the domain name or ip address
+      # of the host, or both (comma-separated). Additionally, if a non-standard
+      # port is being used, it may be specified by putting the host (or ip, or
+      # both) in square brackets, and appending the port outside the brackets
+      # after a colon. Possible formats for +host+, then, are;
+      #
+      #   "net.ssh.test"
+      #   "1.2.3.4"
+      #   "net.ssh.test,1.2.3.4"
+      #   "[net.ssh.test]:5555"
+      #   "[1,2,3,4]:5555"
+      #   "[net.ssh.test]:5555,[1.2.3.4]:5555
+      def keys_for(host)
+        keys = []
+        return keys unless File.readable?(source)
+
+        entries = host.split(/,/)
+
+        File.open(source) do |file|
+          scanner = StringScanner.new("")
+          file.each_line do |line|
+            scanner.string = line
+
+            scanner.skip(/\s*/)
+            next if scanner.match?(/$|#/)
+
+            hostlist = scanner.scan(/\S+/).split(/,/)
+            found = entries.all? { |entry| hostlist.include?(entry) } ||
+              known_host_hash?(hostlist, entries)
+            next unless found
+
+            scanner.skip(/\s*/)
+            type = scanner.scan(/\S+/)
+
+            next unless SUPPORTED_TYPE.include?(type)
+
+            scanner.skip(/\s*/)
+            blob = scanner.rest.unpack("m*").first
+            keys << Net::SSH::Buffer.new(blob).read_key
+          end
         end
-      end
 
-      keys
-    end
+        keys
+      end
 
-    # Indicates whether one of the entries matches an hostname that has been
-    # stored as a HMAC-SHA1 hash in the known hosts.
-    def known_host_hash?(hostlist, entries, scanner)
-      if hostlist.size == 1 && hostlist.first =~ /\A\|1(\|.+){2}\z/
-        chunks = hostlist.first.split(/\|/)
-        salt = Base64.decode64(chunks[2])
-        digest = OpenSSL::Digest.new('sha1')
-        entries.each do |entry|
-          hmac = OpenSSL::HMAC.digest(digest, salt, entry)
-          return true if Base64.encode64(hmac).chomp == chunks[3]
+      # Indicates whether one of the entries matches an hostname that has been
+      # stored as a HMAC-SHA1 hash in the known hosts.
+      def known_host_hash?(hostlist, entries)
+        if hostlist.size == 1 && hostlist.first =~ /\A\|1(\|.+){2}\z/
+          chunks = hostlist.first.split(/\|/)
+          salt = Base64.decode64(chunks[2])
+          digest = OpenSSL::Digest.new('sha1')
+          entries.each do |entry|
+            hmac = OpenSSL::HMAC.digest(digest, salt, entry)
+            return true if Base64.encode64(hmac).chomp == chunks[3]
+          end
         end
+        false
       end
-      false
-    end
 
-    # Tries to append an entry to the current source file for the given host
-    # and key. If it is unable to (because the file is not writable, for
-    # instance), an exception will be raised.
-    def add(host, key)
-      File.open(source, "a") do |file|
-        blob = [Net::SSH::Buffer.from(:key, key).to_s].pack("m*").gsub(/\s/, "")
-        file.puts "#{host} #{key.ssh_type} #{blob}"
+      # Tries to append an entry to the current source file for the given host
+      # and key. If it is unable to (because the file is not writable, for
+      # instance), an exception will be raised.
+      def add(host, key)
+        File.open(source, "a") do |file|
+          blob = [Net::SSH::Buffer.from(:key, key).to_s].pack("m*").gsub(/\s/, "")
+          file.puts "#{host} #{key.ssh_type} #{blob}"
+        end
       end
     end
-
   end
-end; end
+end