net-ssh 2.7.0 → 7.3.0

data/lib/net/ssh/authentication/ed25519.rb

@@ -0,0 +1,184 @@
+gem 'ed25519', '~> 1.2'
+gem 'bcrypt_pbkdf', '~> 1.0' unless RUBY_PLATFORM == "java"
+
+require 'ed25519'
+
+require 'net/ssh/transport/cipher_factory'
+require 'net/ssh/authentication/pub_key_fingerprint'
+require 'bcrypt_pbkdf' unless RUBY_PLATFORM == "java"
+
+module Net
+  module SSH
+    module Authentication
+      module ED25519
+        class SigningKeyFromFile < SimpleDelegator
+          def initialize(pk, sk)
+            key = ::Ed25519::SigningKey.from_keypair(sk)
+            raise ArgumentError, "pk does not match sk" unless pk == key.verify_key.to_bytes
+
+            super(key)
+          end
+        end
+
+        class OpenSSHPrivateKeyLoader
+          CipherFactory = Net::SSH::Transport::CipherFactory
+
+          MBEGIN = "-----BEGIN OPENSSH PRIVATE KEY-----\n"
+          MEND = "-----END OPENSSH PRIVATE KEY-----"
+          MAGIC = "openssh-key-v1"
+
+          class DecryptError < ArgumentError
+            def initialize(message, encrypted_key: false)
+              super(message)
+              @encrypted_key = encrypted_key
+            end
+
+            def encrypted_key?
+              return @encrypted_key
+            end
+          end
+
+          def self.read(datafull, password)
+            datafull = datafull.strip
+            raise ArgumentError.new("Expected #{MBEGIN} at start of private key") unless datafull.start_with?(MBEGIN)
+            raise ArgumentError.new("Expected #{MEND} at end of private key") unless datafull.end_with?(MEND)
+
+            datab64 = datafull[MBEGIN.size...-MEND.size]
+            data = datab64.unpack1("m")
+            raise ArgumentError.new("Expected #{MAGIC} at start of decoded private key") unless data.start_with?(MAGIC)
+
+            buffer = Net::SSH::Buffer.new(data[MAGIC.size + 1..-1])
+
+            ciphername = buffer.read_string
+            raise ArgumentError.new("#{ciphername} in private key is not supported") unless
+              CipherFactory.supported?(ciphername)
+
+            kdfname = buffer.read_string
+            raise ArgumentError.new("Expected #{kdfname} to be or none or bcrypt") unless %w[none bcrypt].include?(kdfname)
+
+            kdfopts = Net::SSH::Buffer.new(buffer.read_string)
+            num_keys = buffer.read_long
+            raise ArgumentError.new("Only 1 key is supported in ssh keys #{num_keys} was in private key") unless num_keys == 1
+
+            _pubkey = buffer.read_string
+
+            len = buffer.read_long
+
+            keylen, blocksize, ivlen = CipherFactory.get_lengths(ciphername, iv_len: true)
+            raise ArgumentError.new("Private key len:#{len} is not a multiple of #{blocksize}") if
+              ((len < blocksize) || ((blocksize > 0) && (len % blocksize) != 0))
+
+            if kdfname == 'bcrypt'
+              salt = kdfopts.read_string
+              rounds = kdfopts.read_long
+
+              raise "BCryptPbkdf is not implemented for jruby" if RUBY_PLATFORM == "java"
+
+              key = BCryptPbkdf::key(password, salt, keylen + ivlen, rounds)
+              raise DecryptError.new("BCyryptPbkdf failed", encrypted_key: true) unless key
+            else
+              key = '\x00' * (keylen + ivlen)
+            end
+
+            cipher = CipherFactory.get(ciphername, key: key[0...keylen], iv: key[keylen...keylen + ivlen], decrypt: true)
+
+            decoded = cipher.update(buffer.remainder_as_buffer.to_s)
+            decoded << cipher.final
+
+            decoded = Net::SSH::Buffer.new(decoded)
+            check1 = decoded.read_long
+            check2 = decoded.read_long
+
+            raise DecryptError.new("Decrypt failed on private key", encrypted_key: kdfname == 'bcrypt') if (check1 != check2)
+
+            type_name = decoded.read_string
+            case type_name
+            when "ssh-ed25519"
+              PrivKey.new(decoded)
+            else
+              decoded.read_private_keyblob(type_name)
+            end
+          end
+        end
+
+        class PubKey
+          include Net::SSH::Authentication::PubKeyFingerprint
+
+          attr_reader :verify_key
+
+          def initialize(data)
+            @verify_key = ::Ed25519::VerifyKey.new(data)
+          end
+
+          def self.read_keyblob(buffer)
+            PubKey.new(buffer.read_string)
+          end
+
+          def to_blob
+            Net::SSH::Buffer.from(:mstring, "ssh-ed25519".dup, :string, @verify_key.to_bytes).to_s
+          end
+
+          def ssh_type
+            "ssh-ed25519"
+          end
+
+          def ssh_signature_type
+            ssh_type
+          end
+
+          def ssh_do_verify(sig, data, options = {})
+            @verify_key.verify(sig, data)
+          end
+
+          def to_pem
+            # TODO this is not pem
+            ssh_type + [@verify_key.to_bytes].pack("m")
+          end
+        end
+
+        class PrivKey
+          CipherFactory = Net::SSH::Transport::CipherFactory
+
+          MBEGIN = "-----BEGIN OPENSSH PRIVATE KEY-----\n"
+          MEND = "-----END OPENSSH PRIVATE KEY-----\n"
+          MAGIC = "openssh-key-v1"
+
+          attr_reader :sign_key
+
+          def initialize(buffer)
+            pk = buffer.read_string
+            sk = buffer.read_string
+            _comment = buffer.read_string
+
+            @pk = pk
+            @sign_key = SigningKeyFromFile.new(pk, sk)
+          end
+
+          def to_blob
+            public_key.to_blob
+          end
+
+          def ssh_type
+            "ssh-ed25519"
+          end
+
+          def ssh_signature_type
+            ssh_type
+          end
+
+          def public_key
+            PubKey.new(@pk)
+          end
+
+          def ssh_do_sign(data, sig_alg = nil)
+            @sign_key.sign(data)
+          end
+
+          def self.read(data, password)
+            OpenSSHPrivateKeyLoader.read(data, password)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/authentication/ed25519_loader.rb

@@ -0,0 +1,31 @@
+module Net
+  module SSH
+    module Authentication
+      # Loads ED25519 support which requires optinal dependecies like
+      # ed25519, bcrypt_pbkdf
+      module ED25519Loader
+        begin
+          require 'net/ssh/authentication/ed25519'
+          LOADED = true
+          ERROR = nil
+        rescue LoadError => e
+          ERROR = e
+          LOADED = false
+        end
+
+        def self.raiseUnlessLoaded(message)
+          description = ERROR.is_a?(LoadError) ? dependenciesRequiredForED25519 : ''
+          description << "#{ERROR.class} : \"#{ERROR.message}\"\n" if ERROR
+          raise NotImplementedError, "#{message}\n#{description}" unless LOADED
+        end
+
+        def self.dependenciesRequiredForED25519
+          result = "net-ssh requires the following gems for ed25519 support:\n"
+          result << " * ed25519 (>= 1.2, < 2.0)\n"
+          result << " * bcrypt_pbkdf (>= 1.0, < 2.0)\n" unless RUBY_PLATFORM == "java"
+          result << "See https://github.com/net-ssh/net-ssh/issues/565 for more information\n"
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/authentication/key_manager.rb

@@ -6,13 +6,12 @@ require 'net/ssh/authentication/agent'
 module Net
   module SSH
     module Authentication
-
       # A trivial exception class used to report errors in the key manager.
       class KeyManagerError < Net::SSH::Exception; end
 
       # This class encapsulates all operations done by clients on a user's
       # private keys. In practice, the client should never need a reference
-      # to a private key; instead, they grab a list of "identities" (public 
+      # to a private key; instead, they grab a list of "identities" (public
       # keys) that are available from the KeyManager, and then use
       # the KeyManager to do various private key operations using those
       # identities.
@@ -30,6 +29,12 @@ module Net
         # The list of user key data that will be examined
         attr_reader :key_data
 
+        # The list of user key certificate files that will be examined
+        attr_reader :keycert_files
+
+        # The list of user key certificate data that will be examined
+        attr_reader :keycert_data
+
         # The map of loaded identities
         attr_reader :known_identities
 
@@ -37,12 +42,15 @@ module Net
         attr_reader :options
 
         # Create a new KeyManager. By default, the manager will
-        # use the ssh-agent (if it is running).
-        def initialize(logger, options={})
+        # use the ssh-agent if it is running and the `:use_agent` option
+        # is not false.
+        def initialize(logger, options = {})
           self.logger = logger
           @key_files = []
           @key_data = []
-          @use_agent = true
+          @keycert_files = []
+          @keycert_data = []
+          @use_agent = options[:use_agent] != false
           @known_identities = {}
           @agent = nil
           @options = options
@@ -55,6 +63,7 @@ module Net
         def clear!
           key_files.clear
           key_data.clear
+          keycert_data.clear
           known_identities.clear
           self
         end
@@ -65,6 +74,18 @@ module Net
           self
         end
 
+        # Add the given keycert_file to the list of keycert files that will be used.
+        def add_keycert(keycert_file)
+          keycert_files.push(File.expand_path(keycert_file)).uniq!
+          self
+        end
+
+        # Add the given keycert_data to the list of keycerts that will be used.
+        def add_keycert_data(keycert_data_)
+          keycert_data.push(keycert_data_).uniq!
+          self
+        end
+
         # Add the given key_file to the list of keys that will be used.
         def add_key_data(key_data_)
           key_data.push(key_data_).uniq!
@@ -97,7 +118,7 @@ module Net
         def each_identity
           prepared_identities = prepare_identities_from_files + prepare_identities_from_data
 
-          user_identities = load_identities(prepared_identities, false)
+          user_identities = load_identities(prepared_identities, false, true)
 
           if agent
             agent.identities.each do |key|
@@ -107,13 +128,13 @@ module Net
               user_identities.delete(corresponding_user_identity) if corresponding_user_identity
 
               if !options[:keys_only] || corresponding_user_identity
-                known_identities[key] = { :from => :agent }
+                known_identities[key] = { from: :agent, identity: key }
                 yield key
               end
             end
           end
 
-          user_identities = load_identities(user_identities, true)
+          user_identities = load_identities(user_identities, !options[:non_interactive], false)
 
           user_identities.each do |identity|
             key = identity.delete(:public_key)
@@ -121,6 +142,21 @@ module Net
             yield key
           end
 
+          known_identity_blobs = known_identities.keys.map(&:to_blob)
+
+          keycerts.each do |keycert|
+            next if known_identity_blobs.include?(keycert.to_blob)
+
+            (_, corresponding_identity) = known_identities.detect { |public_key, _|
+              public_key.to_pem == keycert.to_pem
+            }
+
+            if corresponding_identity
+              known_identities[keycert] = corresponding_identity
+              yield keycert
+            end
+          end
+
           self
         end
 
@@ -133,25 +169,39 @@ module Net
         # Regardless of the identity's origin or who does the signing, this
         # will always return the signature in an SSH2-specified "signature
         # blob" format.
-        def sign(identity, data)
+        def sign(identity, data, sig_alg = nil)
           info = known_identities[identity] or raise KeyManagerError, "the given identity is unknown to the key manager"
 
           if info[:key].nil? && info[:from] == :file
             begin
-              info[:key] = KeyFactory.load_private_key(info[:file], options[:passphrase], true)
-            rescue Exception, OpenSSL::OpenSSLError => e 
+              info[:key] = KeyFactory.load_private_key(info[:file], options[:passphrase], !options[:non_interactive], options[:password_prompt])
+            rescue OpenSSL::OpenSSLError, Exception => e
               raise KeyManagerError, "the given identity is known, but the private key could not be loaded: #{e.class} (#{e.message})"
             end
           end
 
           if info[:key]
-            return Net::SSH::Buffer.from(:string, identity.ssh_type,
-              :string, info[:key].ssh_do_sign(data.to_s)).to_s
+            if sig_alg.nil?
+              signed = info[:key].ssh_do_sign(data.to_s)
+              sig_alg = identity.ssh_signature_type
+            else
+              signed = info[:key].ssh_do_sign(data.to_s, sig_alg)
+            end
+            return Net::SSH::Buffer.from(:string, sig_alg,
+                                         :mstring, signed).to_s
           end
 
           if info[:from] == :agent
             raise KeyManagerError, "the agent is no longer available" unless agent
-            return agent.sign(identity, data.to_s)
+
+            case sig_alg
+            when "rsa-sha2-512"
+              return agent.sign(info[:identity], data.to_s, Net::SSH::Authentication::Agent::SSH_AGENT_RSA_SHA2_512)
+            when "rsa-sha2-256"
+              return agent.sign(info[:identity], data.to_s, Net::SSH::Authentication::Agent::SSH_AGENT_RSA_SHA2_256)
+            else
+              return agent.sign(info[:identity], data.to_s)
+            end
           end
 
           raise KeyManagerError, "[BUG] can't determine identity origin (#{info.inspect})"
@@ -175,81 +225,102 @@ module Net
         # or if the agent is otherwise not available.
         def agent
           return unless use_agent?
-          @agent ||= Agent.connect(logger)
+
+          @agent ||= Agent.connect(logger, options[:agent_socket_factory], options[:identity_agent])
         rescue AgentNotAvailable
           @use_agent = false
           nil
         end
 
+        def no_keys?
+          key_files.empty? && key_data.empty?
+        end
+
         private
 
+        # Load keycerts from files and data.
+        def keycerts
+          keycert_files.map { |keycert_file| KeyFactory.load_public_key(keycert_file) } +
+            keycert_data.map { |data| KeyFactory.load_data_public_key(data) }
+        end
+
         # Prepares identities from user key_files for loading, preserving their order and sources.
         def prepare_identities_from_files
           key_files.map do |file|
-            public_key_file = file + ".pub"
-            if File.readable?(public_key_file)
-              { :load_from => :pubkey_file, :file => file }
-            elsif File.readable?(file)
-              { :load_from => :privkey_file, :file => file }
+            if readable_file?(file)
+              identity = {}
+              cert_file = file + "-cert.pub"
+              public_key_file = file + ".pub"
+              if readable_file?(cert_file)
+                identity[:load_from] = :pubkey_file
+                identity[:pubkey_file] = cert_file
+              elsif readable_file?(public_key_file)
+                identity[:load_from] = :pubkey_file
+                identity[:pubkey_file] = public_key_file
+              else
+                identity[:load_from] = :privkey_file
+              end
+              identity.merge(privkey_file: file)
             end
           end.compact
         end
 
+        def readable_file?(path)
+          File.file?(path) && File.readable?(path)
+        end
+
         # Prepared identities from user key_data, preserving their order and sources.
         def prepare_identities_from_data
           key_data.map do |data|
-            { :load_from => :data, :data => data }
+            { load_from: :data, data: data }
           end
         end
 
-        # Load prepared identities. Private key decryption errors ignored if passphrase was not prompted.
-        def load_identities(identities, ask_passphrase)
+        # Load prepared identities. Private key decryption errors ignored if ignore_decryption_errors
+        def load_identities(identities, ask_passphrase, ignore_decryption_errors)
           identities.map do |identity|
-            begin
-              case identity[:load_from]
-              when :pubkey_file
-                key = KeyFactory.load_public_key(identity[:file] + ".pub")
-                { :public_key => key, :from => :file, :file => identity[:file] }
-              when :privkey_file
-                private_key = KeyFactory.load_private_key(identity[:file], options[:passphrase], ask_passphrase)
-                key = private_key.send(:public_key)
-                { :public_key => key, :from => :file, :file => identity[:file], :key => private_key }
-              when :data
-                private_key = KeyFactory.load_data_private_key(identity[:data], options[:passphrase], ask_passphrase)
-                key = private_key.send(:public_key)
-                { :public_key => key, :from => :key_data, :data => identity[:data], :key => private_key }
-              else
-                identity
-              end
-
-            rescue OpenSSL::PKey::RSAError, OpenSSL::PKey::DSAError, OpenSSL::PKey::ECError => e
-              if ask_passphrase
-                process_identity_loading_error(identity, e)
-                nil
-              else
-                identity
-              end
-            rescue ArgumentError => e
-              process_identity_loading_error(identity, e)
-              nil
-            rescue Exception => e
+            case identity[:load_from]
+            when :pubkey_file
+              key = KeyFactory.load_public_key(identity[:pubkey_file])
+              { public_key: key, from: :file, file: identity[:privkey_file] }
+            when :privkey_file
+              private_key = KeyFactory.load_private_key(
+                identity[:privkey_file], options[:passphrase], ask_passphrase, options[:password_prompt]
+              )
+              key = private_key.send(:public_key)
+              { public_key: key, from: :file, file: identity[:privkey_file], key: private_key }
+            when :data
+              private_key = KeyFactory.load_data_private_key(
+                identity[:data], options[:passphrase], ask_passphrase, "<key in memory>", options[:password_prompt]
+              )
+              key = private_key.send(:public_key)
+              { public_key: key, from: :key_data, data: identity[:data], key: private_key }
+            else
+              identity
+            end
+          rescue OpenSSL::PKey::RSAError, OpenSSL::PKey::DSAError, OpenSSL::PKey::ECError, OpenSSL::PKey::PKeyError, ArgumentError => e
+            if ignore_decryption_errors
+              identity
+            else
               process_identity_loading_error(identity, e)
               nil
             end
+          rescue Exception => e
+            process_identity_loading_error(identity, e)
+            nil
           end.compact
         end
 
         def process_identity_loading_error(identity, e)
           case identity[:load_from]
           when :pubkey_file
-            error { "could not load public key file `#{identity[:file]}': #{e.class} (#{e.message})" }
+            error { "could not load public key file `#{identity[:pubkey_file]}': #{e.class} (#{e.message})" }
           when :privkey_file
-            error { "could not load private key file `#{identity[:file]}': #{e.class} (#{e.message})" }
+            error { "could not load private key file `#{identity[:privkey_file]}': #{e.class} (#{e.message})" }
           else
             raise e
           end
         end
-
       end
     end
   end

data/lib/net/ssh/authentication/methods/abstract.rb

@@ -3,58 +3,77 @@ require 'net/ssh/errors'
 require 'net/ssh/loggable'
 require 'net/ssh/authentication/constants'
 
-module Net; module SSH; module Authentication; module Methods
-
-  # The base class of all user authentication methods. It provides a few
-  # bits of common functionality.
-  class Abstract
-    include Constants, Loggable
-
-    # The authentication session object
-    attr_reader :session
-
-    # The key manager object. Not all authentication methods will require
-    # this.
-    attr_reader :key_manager
-
-    # Instantiates a new authentication method.
-    def initialize(session, options={})
-      @session = session
-      @key_manager = options[:key_manager]
-      @options = options
-      self.logger = session.logger
-    end
+module Net
+  module SSH
+    module Authentication
+      module Methods
+        # The base class of all user authentication methods. It provides a few
+        # bits of common functionality.
+        class Abstract
+          include Loggable
+          include Constants
 
-    # Returns the session-id, as generated during the first key exchange of
-    # an SSH connection.
-    def session_id
-      session.transport.algorithms.session_id
-    end
+          # The authentication session object
+          attr_reader :session
 
-    # Sends a message via the underlying transport layer abstraction. This
-    # will block until the message is completely sent.
-    def send_message(msg)
-      session.transport.send_message(msg)
-    end
+          # The key manager object. Not all authentication methods will require
+          # this.
+          attr_reader :key_manager
+
+          # So far only affects algorithms used for rsa keys, but can be
+          # extended to other keys, e.g after reading of
+          # PubkeyAcceptedAlgorithms option from ssh_config file is implemented.
+          attr_reader :pubkey_algorithms
+
+          # Instantiates a new authentication method.
+          def initialize(session, options = {})
+            @session = session
+            @key_manager = options[:key_manager]
+            @options = options
+            @prompt = options[:password_prompt]
+            @pubkey_algorithms = options[:pubkey_algorithms] \
+              || %w[rsa-sha2-256-cert-v01@openssh.com
+                    ssh-rsa-cert-v01@openssh.com
+                    rsa-sha2-256
+                    ssh-rsa]
+            self.logger = session.logger
+          end
+
+          # Returns the session-id, as generated during the first key exchange of
+          # an SSH connection.
+          def session_id
+            session.transport.algorithms.session_id
+          end
+
+          # Sends a message via the underlying transport layer abstraction. This
+          # will block until the message is completely sent.
+          def send_message(msg)
+            session.transport.send_message(msg)
+          end
 
-    # Creates a new USERAUTH_REQUEST packet. The extra arguments on the end
-    # must be either boolean values or strings, and are tacked onto the end
-    # of the packet. The new packet is returned, ready for sending.
-    def userauth_request(username, next_service, auth_method, *others)
-      buffer = Net::SSH::Buffer.from(:byte, USERAUTH_REQUEST,
-        :string, username, :string, next_service, :string, auth_method)
-
-      others.each do |value|
-        case value
-        when true, false then buffer.write_bool(value)
-        when String      then buffer.write_string(value)
-        else raise ArgumentError, "don't know how to write #{value.inspect}"
+          # Creates a new USERAUTH_REQUEST packet. The extra arguments on the end
+          # must be either boolean values or strings, and are tacked onto the end
+          # of the packet. The new packet is returned, ready for sending.
+          def userauth_request(username, next_service, auth_method, *others)
+            buffer = Net::SSH::Buffer.from(:byte, USERAUTH_REQUEST,
+                                           :string, username, :string, next_service, :string, auth_method)
+
+            others.each do |value|
+              case value
+              when true, false then buffer.write_bool(value)
+              when String      then buffer.write_string(value)
+              else raise ArgumentError, "don't know how to write #{value.inspect}"
+              end
+            end
+
+            buffer
+          end
+
+          private
+
+          attr_reader :prompt
         end
       end
-
-      buffer
     end
-
   end
-
-end; end; end; end
+end