net-ssh 4.2.0 → 7.0.1

data/lib/net/ssh/known_hosts.rb

@@ -1,98 +1,150 @@
 require 'strscan'
 require 'openssl'
 require 'base64'
+require 'delegate'
 require 'net/ssh/buffer'
+require 'net/ssh/authentication/ed25519_loader'
 
-module Net; module SSH
+module Net
+  module SSH
+    module HostKeyEntries
+      # regular public key entry
+      class PubKey < Delegator
+        def initialize(key, comment: nil) # rubocop:disable Lint/MissingSuper
+          @key = key
+          @comment = comment
+        end
 
-  # Represents the result of a search in known hosts
-  # see search_for
-  class HostKeys
-    include Enumerable
-    attr_reader :host
+        def ssh_type
+          @key.ssh_type
+        end
 
-    def initialize(host_keys, host, known_hosts, options = {})
-       @host_keys = host_keys
-       @host = host
-       @known_hosts = known_hosts
-       @options = options
-    end
+        def ssh_types
+          [ssh_type]
+        end
 
-    def add_host_key(key)
-       @known_hosts.add(@host, key, @options)
-       @host_keys.push(key)
-    end
+        def to_blob
+          @key.to_blob
+        end
 
-    def each(&block)
-       @host_keys.each(&block)
-    end
+        def __getobj__
+          Kernel.warn("Calling Net::SSH::Buffer methods on HostKeyEntries PubKey is deprecated")
+          @key
+        end
 
-    def empty?
-      @host_keys.empty?
-    end
-  end
+        def matches_key?(server_key)
+          @key.ssh_type == server_key.ssh_type && @key.to_blob == server_key.to_blob
+        end
+      end
+
+      # @cert-authority entry
+      class CertAuthority
+        def ssh_types
+          %w[
+            ecdsa-sha2-nistp256-cert-v01@openssh.com
+            ecdsa-sha2-nistp384-cert-v01@openssh.com
+            ecdsa-sha2-nistp521-cert-v01@openssh.com
+            ssh-ed25519-cert-v01@openssh.com
+            ssh-rsa-cert-v01@openssh.com
+            ssh-rsa-cert-v00@openssh.com
+          ]
+        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
+        def initialize(key, comment: nil)
+          @key = key
+          @comment = comment
+        end
 
-    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)
+        def matches_key?(server_key)
+          if ssh_types.include?(server_key.ssh_type)
+            server_key.signature_valid? && (server_key.signature_key.to_blob == @key.to_blob)
+          else
+            false
+          end
+        end
+      end
     end
 
+    # Represents the result of a search in known hosts
+    # see search_for
+    class HostKeys
+      include Enumerable
+      attr_reader :host
 
-    class <<self
+      def initialize(host_keys, host, known_hosts, options = {})
+        @host_keys = host_keys
+        @host = host
+        @known_hosts = known_hosts
+        @options = options
+      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)
+      def add_host_key(key)
+        @known_hosts.add(@host, key, @options)
+        @host_keys.push(key)
       end
 
-      # 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
+      def each(&block)
+        @host_keys.each(&block)
       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 = []
+      def empty?
+        @host_keys.empty?
+      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
+      SUPPORTED_TYPE = %w[ssh-rsa ssh-dss
+                          ecdsa-sha2-nistp256
+                          ecdsa-sha2-nistp384
+                          ecdsa-sha2-nistp521]
 
-        if which == :all || which == :user
-          files += Array(options[:user_known_hosts_file] || %w(~/.ssh/known_hosts ~/.ssh/known_hosts2))
+      SUPPORTED_TYPE.push('ssh-ed25519') if Net::SSH::Authentication::ED25519Loader::LOADED
+
+      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, options), host, self, options)
         end
 
-        if which == :all || which == :global
-          files += Array(options[:global_known_hosts_file] || %w(/etc/ssh/ssh_known_hosts /etc/ssh/ssh_known_hosts2))
+        # 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, options = {})
+          files.flat_map { |file| KnownHosts.new(file).keys_for(host, options) }
         end
 
-        return files
-      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 = []
+
+          files += Array(options[:user_known_hosts_file] || %w[~/.ssh/known_hosts ~/.ssh/known_hosts2]) if which == :all || which == :user
+
+          if which == :all || which == :global
+            files += Array(options[:global_known_hosts_file] || %w[/etc/ssh/ssh_known_hosts /etc/ssh/ssh_known_hosts2])
+          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
+          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|
             KnownHosts.new(file).add(host, key)
             return
           rescue SystemCallError
@@ -100,88 +152,114 @@ module Net; module SSH
           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)
+      # 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, options = {})
+        keys = []
+        return keys unless File.readable?(source)
+
+        entries = host.split(/,/)
+        host_name = entries[0]
+        host_ip = entries[1]
 
-      entries = host.split(/,/)
+        File.open(source) do |file|
+          file.each_line do |line|
+            if line.start_with?('@')
+              marker, hosts, type, key_content, comment = line.split(' ')
+            else
+              marker = nil
+              hosts, type, key_content, comment = line.split(' ')
+            end
 
-      File.open(source) do |file|
-        scanner = StringScanner.new("")
-        file.each_line do |line|
-          scanner.string = line
+            # Skip empty line or one that is commented
+            next if hosts.nil? || hosts.start_with?('#')
 
-          scanner.skip(/\s*/)
-          next if scanner.match?(/$|#/)
+            hostlist = hosts.split(',')
 
-          hostlist = scanner.scan(/\S+/).split(/,/)
-          found = entries.all? { |entry| hostlist.include?(entry) } ||
-            known_host_hash?(hostlist, entries, scanner)
-          next unless found
+            next unless SUPPORTED_TYPE.include?(type)
 
-          scanner.skip(/\s*/)
-          type = scanner.scan(/\S+/)
+            found = hostlist.any? { |pattern| match(host_name, pattern) } || known_host_hash?(hostlist, entries)
+            next unless found
 
-          next unless SUPPORTED_TYPE.include?(type)
+            found = hostlist.include?(host_ip) if options[:check_host_ip] && entries.size > 1 && hostlist.size > 1
+            next unless found
 
-          scanner.skip(/\s*/)
-          blob = scanner.rest.unpack("m*").first
-          keys << Net::SSH::Buffer.new(blob).read_key
+            blob = key_content.unpack("m*").first
+            raw_key = Net::SSH::Buffer.new(blob).read_key
+
+            keys <<
+              if marker == "@cert-authority"
+                HostKeyEntries::CertAuthority.new(raw_key, comment: comment)
+              else
+                HostKeyEntries::PubKey.new(raw_key, comment: comment)
+              end
+          end
         end
+
+        keys
       end
 
-      keys
-    end
+      def match(host, pattern)
+        if pattern.include?('*') || pattern.include?('?')
+          # see man 8 sshd for pattern details
+          pattern_regexp = pattern.split('*', -1).map do |x|
+            x.split('?', -1).map do |y|
+              Regexp.escape(y)
+            end.join('.')
+          end.join('.*')
 
-    # 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]
+          host =~ Regexp.new("\\A#{pattern_regexp}\\z")
+        else
+          host == pattern
         end
       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}"
+      # 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
-    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}"
+        end
+      end
+    end
   end
-end; end
+end

data/lib/net/ssh/loggable.rb

@@ -1,61 +1,62 @@
-module Net; module SSH
-
-  # A simple module to make logging easier to deal with. It assumes that the
-  # logger instance (if not nil) quacks like a Logger object (in Ruby's
-  # standard library). Although used primarily internally by Net::SSH, it
-  # can easily be used to add Net::SSH-like logging to your own programs.
-  #
-  #   class MyClass
-  #     include Net::SSH::Loggable
-  #   end
-  #
-  #   Net::SSH.start(...) do |ssh|
-  #     obj = MyClass.new
-  #     obj.logger = ssh.logger
-  #     ...
-  #   end
-  module Loggable
-    # The logger instance that will be used to log messages. If nil, nothing
-    # will be logged.
-    attr_accessor :logger
-
-    # Displays the result of yielding if the log level is Logger::DEBUG or
-    # greater.
-    def debug
-      logger.add(Logger::DEBUG, nil, facility) { yield } if logger && logger.debug?
-    end
+module Net
+  module SSH
+    # A simple module to make logging easier to deal with. It assumes that the
+    # logger instance (if not nil) quacks like a Logger object (in Ruby's
+    # standard library). Although used primarily internally by Net::SSH, it
+    # can easily be used to add Net::SSH-like logging to your own programs.
+    #
+    #   class MyClass
+    #     include Net::SSH::Loggable
+    #   end
+    #
+    #   Net::SSH.start(...) do |ssh|
+    #     obj = MyClass.new
+    #     obj.logger = ssh.logger
+    #     ...
+    #   end
+    module Loggable
+      # The logger instance that will be used to log messages. If nil, nothing
+      # will be logged.
+      attr_accessor :logger
+
+      # Displays the result of yielding if the log level is Logger::DEBUG or
+      # greater.
+      def debug
+        logger.add(Logger::DEBUG, nil, facility) { yield } if logger && logger.debug?
+      end
 
-    # Displays the result of yielding if the log level is Logger::INFO or
-    # greater.
-    def info
-      logger.add(Logger::INFO, nil, facility) { yield } if logger && logger.info?
-    end
+      # Displays the result of yielding if the log level is Logger::INFO or
+      # greater.
+      def info
+        logger.add(Logger::INFO, nil, facility) { yield } if logger && logger.info?
+      end
 
-    # Displays the result of yielding if the log level is Logger::WARN or
-    # greater. (Called lwarn to avoid shadowing with Kernel#warn.)
-    def lwarn
-      logger.add(Logger::WARN, nil, facility) { yield } if logger && logger.warn?
-    end
+      # Displays the result of yielding if the log level is Logger::WARN or
+      # greater. (Called lwarn to avoid shadowing with Kernel#warn.)
+      def lwarn
+        logger.add(Logger::WARN, nil, facility) { yield } if logger && logger.warn?
+      end
 
-    # Displays the result of yielding if the log level is Logger:ERROR or
-    # greater.
-    def error
-      logger.add(Logger::ERROR, nil, facility) { yield } if logger && logger.error?
-    end
+      # Displays the result of yielding if the log level is Logger:ERROR or
+      # greater.
+      def error
+        logger.add(Logger::ERROR, nil, facility) { yield } if logger && logger.error?
+      end
 
-    # Displays the result of yielding if the log level is Logger::FATAL or
-    # greater.
-    def fatal
-      logger.add(Logger::FATAL, nil, facility) { yield } if logger && logger.fatal?
-    end
+      # Displays the result of yielding if the log level is Logger::FATAL or
+      # greater.
+      def fatal
+        logger.add(Logger::FATAL, nil, facility) { yield } if logger && logger.fatal?
+      end
 
-    private
+      private
 
       # Sets the "facility" value, used for reporting where a log message
       # originates. It defaults to the name of class with the object_id
       # appended.
       def facility
-        @facility ||= self.class.name.gsub(/::/, ".").gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase + "[%x]" % object_id
+        @facility ||= self.class.to_s.gsub(/::/, ".").gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase + "[%x]" % object_id
       end
+    end
   end
-end; end
+end