net-ssh 7.2.0 → 8.0.0

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

@@ -1,27 +1,57 @@
-gem 'ed25519', '~> 1.2'
-gem 'bcrypt_pbkdf', '~> 1.0' unless RUBY_PLATFORM == "java"
-
-require 'ed25519'
-
-require 'base64'
-
+require 'openssl'
 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
+        ALGORITHM = "ED25519"
+        KEY_BYTES = 32
+        PRIVATE_KEY_BYTES = 64
+
+        class UnsupportedError < StandardError; end
 
-            super(key)
+        def self.ensure_supported!
+          unless OpenSSL::PKey.respond_to?(:new_raw_public_key) && OpenSSL::PKey.respond_to?(:new_raw_private_key)
+            raise UnsupportedError, "OpenSSL::PKey raw public/private key APIs are unavailable"
           end
+
+          key = new_private_key("\x00" * KEY_BYTES)
+          signature = sign(key, "")
+          public_key = new_public_key(key.raw_public_key)
+          raise UnsupportedError, "OpenSSL Ed25519 signature verification failed" unless verify(public_key, signature, "")
+        rescue OpenSSL::PKey::PKeyError => e
+          raise UnsupportedError, e.message
+        end
+
+        def self.new_public_key(key)
+          validate_key_bytes!(key, "public key", KEY_BYTES)
+          OpenSSL::PKey.new_raw_public_key(ALGORITHM, binary_string(key))
+        end
+
+        def self.new_private_key(key)
+          validate_key_bytes!(key, "private key", KEY_BYTES)
+          OpenSSL::PKey.new_raw_private_key(ALGORITHM, binary_string(key))
+        end
+
+        def self.sign(key, data)
+          key.sign(nil, data)
+        end
+
+        def self.verify(key, signature, data)
+          key.verify(nil, signature, data)
         end
 
+        def self.validate_key_bytes!(key, label, expected_bytes)
+          raise ArgumentError, "invalid Ed25519 #{label}" unless key.respond_to?(:bytesize) && key.bytesize == expected_bytes
+        end
+
+        def self.binary_string(string)
+          string.dup.force_encoding('BINARY')
+        end
+        private_class_method :binary_string
+
         class OpenSSHPrivateKeyLoader
           CipherFactory = Net::SSH::Transport::CipherFactory
 
@@ -29,6 +59,9 @@ module Net
           MEND = "-----END OPENSSH PRIVATE KEY-----"
           MAGIC = "openssh-key-v1"
 
+          # Same limit as OpenSSH; bcrypt_pbkdf with 2**32 rounds would run for months (GHSA-rpq3-v334-f5pm).
+          MAX_KDF_ROUNDS = 1 << 20
+
           class DecryptError < ArgumentError
             def initialize(message, encrypted_key: false)
               super(message)
@@ -41,15 +74,15 @@ module Net
           end
 
           def self.read(datafull, password)
-            datafull = datafull.strip
+            datafull = datafull.strip.encode(universal_newline: true)
             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 = Base64.decode64(datab64)
+            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])
+            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
@@ -65,27 +98,35 @@ module Net
             _pubkey = buffer.read_string
 
             len = buffer.read_long
+            encrypted_private = buffer.read(len)
 
             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))
+              (len < blocksize) || ((blocksize > 0) && (len % blocksize) != 0)
+
+            raise ArgumentError.new("Private key len:#{len} exceeds available data") unless encrypted_private.bytesize == len
+
+            authlen = CipherFactory.auth_length(ciphername)
+            auth_tag = authlen > 0 ? buffer.read(authlen) : nil
 
             if kdfname == 'bcrypt'
               salt = kdfopts.read_string
               rounds = kdfopts.read_long
+              raise ArgumentError.new("Private key bcrypt rounds #{rounds} exceeds #{MAX_KDF_ROUNDS}") if rounds > MAX_KDF_ROUNDS
 
-              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
+              key = bcrypt_pbkdf_key(password, salt, keylen + ivlen, rounds)
             else
-              key = '\x00' * (keylen + ivlen)
+              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 = decrypt_private_key(
+              ciphername,
+              encrypted_private,
+              auth_tag,
+              key: key[0...keylen],
+              iv: key[keylen...(keylen + ivlen)],
+              encrypted_key: kdfname == 'bcrypt'
+            )
 
             decoded = Net::SSH::Buffer.new(decoded)
             check1 = decoded.read_long
@@ -101,15 +142,50 @@ module Net
               decoded.read_private_keyblob(type_name)
             end
           end
+
+          def self.bcrypt_pbkdf_key(password, salt, length, rounds)
+            begin
+              require_bcrypt_pbkdf
+            rescue LoadError
+              raise DecryptError.new("bcrypt_pbkdf is required to decrypt bcrypt-encrypted OpenSSH private keys")
+            end
+            raise DecryptError.new("Passphrase required for encrypted private key", encrypted_key: true) if password.nil? || password.empty?
+
+            key = BCryptPbkdf::key(password, salt, length, rounds)
+            raise DecryptError.new("BCryptPbkdf failed", encrypted_key: true) unless key
+
+            key
+          end
+
+          def self.require_bcrypt_pbkdf
+            require 'bcrypt_pbkdf'
+          end
+
+          def self.decrypt_private_key(ciphername, encrypted_private, auth_tag, options)
+            if auth_tag
+              return CipherFactory.decrypt_private_key(
+                ciphername,
+                encrypted_private,
+                auth_tag,
+                options[:key],
+                options[:iv]
+              )
+            end
+
+            cipher = CipherFactory.get(ciphername, key: options[:key], iv: options[:iv], decrypt: true)
+            decoded = cipher.update(encrypted_private)
+            decoded << cipher.final
+          rescue Net::SSH::Exception, OpenSSL::Cipher::CipherError
+            raise DecryptError.new("Decrypt failed on private key", encrypted_key: options[:encrypted_key])
+          end
         end
 
         class PubKey
           include Net::SSH::Authentication::PubKeyFingerprint
 
-          attr_reader :verify_key
-
           def initialize(data)
-            @verify_key = ::Ed25519::VerifyKey.new(data)
+            ED25519.validate_key_bytes!(data, "public key", KEY_BYTES)
+            @public_key_bytes = data.dup.force_encoding('BINARY')
           end
 
           def self.read_keyblob(buffer)
@@ -117,7 +193,7 @@ module Net
           end
 
           def to_blob
-            Net::SSH::Buffer.from(:mstring, "ssh-ed25519".dup, :string, @verify_key.to_bytes).to_s
+            Net::SSH::Buffer.from(:mstring, "ssh-ed25519".dup, :string, public_key_bytes).to_s
           end
 
           def ssh_type
@@ -129,22 +205,26 @@ module Net
           end
 
           def ssh_do_verify(sig, data, options = {})
-            @verify_key.verify(sig, data)
+            ED25519.verify(verify_key, sig, data)
           end
 
           def to_pem
             # TODO this is not pem
-            ssh_type + Base64.encode64(@verify_key.to_bytes)
+            ssh_type + [public_key_bytes].pack("m")
+          end
+
+          def public_key_bytes
+            @public_key_bytes.dup
+          end
+
+          def verify_key
+            @verify_key ||= ED25519.new_public_key(@public_key_bytes)
           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)
@@ -152,8 +232,17 @@ module Net
             sk = buffer.read_string
             _comment = buffer.read_string
 
-            @pk = pk
-            @sign_key = SigningKeyFromFile.new(pk, sk)
+            ED25519.validate_key_bytes!(pk, "public key", KEY_BYTES)
+            ED25519.validate_key_bytes!(sk, "private key field", PRIVATE_KEY_BYTES)
+
+            private_key_bytes = sk[0, KEY_BYTES]
+            raise ArgumentError, "Ed25519 private key does not include matching public key" unless sk[KEY_BYTES, KEY_BYTES] == pk
+
+            @sign_key = ED25519.new_private_key(private_key_bytes)
+            raise ArgumentError, "Ed25519 public key does not match private key" unless @sign_key.raw_public_key == pk
+
+            @public_key_bytes = pk.dup.force_encoding('BINARY')
+            @private_key_bytes = private_key_bytes.dup.force_encoding('BINARY')
           end
 
           def to_blob
@@ -169,11 +258,23 @@ module Net
           end
 
           def public_key
-            PubKey.new(@pk)
+            PubKey.new(public_key_bytes)
           end
 
           def ssh_do_sign(data, sig_alg = nil)
-            @sign_key.sign(data)
+            ED25519.sign(@sign_key, data)
+          end
+
+          def public_key_bytes
+            @public_key_bytes.dup
+          end
+
+          def private_key_bytes
+            @private_key_bytes.dup
+          end
+
+          def private_key_bytes_for_agent
+            private_key_bytes + public_key_bytes
           end
 
           def self.read(data, password)

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

@@ -1,29 +1,34 @@
 module Net
   module SSH
     module Authentication
-      # Loads ED25519 support which requires optinal dependecies like
-      # ed25519, bcrypt_pbkdf
+      # Loads ED25519 support backed by Ruby OpenSSL raw key APIs.
       module ED25519Loader
         begin
           require 'net/ssh/authentication/ed25519'
+          Net::SSH::Authentication::ED25519.ensure_supported!
           LOADED = true
           ERROR = nil
         rescue LoadError => e
           ERROR = e
           LOADED = false
+        rescue StandardError => e
+          if defined?(Net::SSH::Authentication::ED25519::UnsupportedError) &&
+             e.is_a?(Net::SSH::Authentication::ED25519::UnsupportedError)
+            ERROR = e
+            LOADED = false
+          else
+            raise
+          end
         end
 
         def self.raiseUnlessLoaded(message)
-          description = ERROR.is_a?(LoadError) ? dependenciesRequiredForED25519 : ''
-          description << "#{ERROR.class} : \"#{ERROR.message}\"\n" if ERROR
+          description = LOADED ? '' : ed25519SupportRequired
+          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"
+        def self.ed25519SupportRequired
+          "net-ssh requires openssl >= 3.2.0 and a crypto backend with Ed25519 enabled for ed25519 support.\n"
         end
       end
     end

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

@@ -32,6 +32,9 @@ module Net
         # 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
 
@@ -46,6 +49,7 @@ module Net
           @key_files = []
           @key_data = []
           @keycert_files = []
+          @keycert_data = []
           @use_agent = options[:use_agent] != false
           @known_identities = {}
           @agent = nil
@@ -59,6 +63,7 @@ module Net
         def clear!
           key_files.clear
           key_data.clear
+          keycert_data.clear
           known_identities.clear
           self
         end
@@ -67,12 +72,22 @@ module Net
         def add(key_file)
           key_files.push(File.expand_path(key_file)).uniq!
           self
+        rescue ArgumentError
+          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
+        rescue ArgumentError
+          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.
@@ -109,17 +124,16 @@ module Net
 
           user_identities = load_identities(prepared_identities, false, true)
 
-          if agent
-            agent.identities.each do |key|
-              corresponding_user_identity = user_identities.detect { |identity|
-                identity[:public_key] && identity[:public_key].to_pem == key.to_pem
-              }
-              user_identities.delete(corresponding_user_identity) if corresponding_user_identity
+          agent_identities.each do |key|
+            corresponding_user_identity = user_identities.detect { |identity|
+              identity[:public_key] && identity[:public_key].to_blob == key.to_blob
+            }
+            # By identity: EC::Point#== raises TypeError when compared with other key types.
+            user_identities.reject! { |identity| identity.equal?(corresponding_user_identity) }
 
-              if !options[:keys_only] || corresponding_user_identity
-                known_identities[key] = { from: :agent, identity: key }
-                yield key
-              end
+            if !options[:keys_only] || corresponding_user_identity
+              known_identities[key] = { from: :agent, identity: key }
+              yield key
             end
           end
 
@@ -132,8 +146,8 @@ module Net
           end
 
           known_identity_blobs = known_identities.keys.map(&:to_blob)
-          keycert_files.each do |keycert_file|
-            keycert = KeyFactory.load_public_key(keycert_file)
+
+          keycerts.each do |keycert|
             next if known_identity_blobs.include?(keycert.to_blob)
 
             (_, corresponding_identity) = known_identities.detect { |public_key, _|
@@ -161,7 +175,11 @@ module Net
         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
+          if info[:from] == :pubkey_file_only
+            raise KeyManagerError, "the given identity is a public key only and cannot be used for signing without an agent"
+          end
+
+          if info[:key].nil? && (info[:from] == :file || info[:from] == :pubkey_file)
             begin
               info[:key] = KeyFactory.load_private_key(info[:file], options[:passphrase], !options[:non_interactive], options[:password_prompt])
             rescue OpenSSL::OpenSSLError, Exception => e
@@ -227,14 +245,36 @@ module Net
 
         private
 
+        # Like OpenSSH's pubkey_prepare, an agent that fails to list its keys is
+        # dropped for the session so that key files are still tried.
+        def agent_identities
+          return [] unless agent
+
+          agent.identities
+        rescue AgentError => e
+          error { "could not get identities from agent: #{e.class} (#{e.message})" }
+          self.use_agent = false
+          []
+        end
+
+        # 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|
             if readable_file?(file)
-              identity = {}
+              identity = { privkey_file: file }
               cert_file = file + "-cert.pub"
               public_key_file = file + ".pub"
-              if readable_file?(cert_file)
+              if file.end_with?(".pub")
+                identity[:load_from] = :pubkey_file_only
+                identity[:pubkey_file] = file
+                identity.delete(:privkey_file)
+              elsif readable_file?(cert_file)
                 identity[:load_from] = :pubkey_file
                 identity[:pubkey_file] = cert_file
               elsif readable_file?(public_key_file)
@@ -243,7 +283,7 @@ module Net
               else
                 identity[:load_from] = :privkey_file
               end
-              identity.merge(privkey_file: file)
+              identity
             end
           end.compact
         end
@@ -265,7 +305,10 @@ module Net
             case identity[:load_from]
             when :pubkey_file
               key = KeyFactory.load_public_key(identity[:pubkey_file])
-              { public_key: key, from: :file, file: identity[:privkey_file] }
+              { public_key: key, from: :pubkey_file, file: identity[:privkey_file] }
+            when :pubkey_file_only
+              key = KeyFactory.load_public_key(identity[:pubkey_file])
+              { public_key: key, from: :pubkey_file_only, file: identity[:privkey_file] }
             when :privkey_file
               private_key = KeyFactory.load_private_key(
                 identity[:privkey_file], options[:passphrase], ask_passphrase, options[:password_prompt]
@@ -296,7 +339,7 @@ module Net
 
         def process_identity_loading_error(identity, e)
           case identity[:load_from]
-          when :pubkey_file
+          when :pubkey_file, :pubkey_file_only
             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[:privkey_file]}': #{e.class} (#{e.message})" }

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

@@ -20,9 +20,7 @@ module Net
           # 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.
+          # public key algorithms to be used
           attr_reader :pubkey_algorithms
 
           # Instantiates a new authentication method.
@@ -31,11 +29,7 @@ module Net
             @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]
+            @pubkey_algorithms = session.transport.pubkey_algorithms
             self.logger = session.logger
           end
 

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

@@ -15,6 +15,8 @@ module Net
           def authenticate(next_service, username, password = nil)
             return false unless key_manager
 
+            debug { "pubkey_algorithms: #{pubkey_algorithms.join(', ')}" }
+
             key_manager.each_identity do |identity|
               return true if authenticate_with(identity, next_service, username)
             end
@@ -123,7 +125,7 @@ module Net
                   end
                 end
               end
-            elsif authenticate_with_alg(identity, next_service, username, type)
+            elsif pubkey_algorithms.include?(type) && authenticate_with_alg(identity, next_service, username, type)
               # success
               return true
             end

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

@@ -32,7 +32,7 @@ module Net
           when 'MD5'
             OpenSSL::Digest.hexdigest(algorithm, blob).scan(/../).join(":")
           when 'SHA256'
-            "SHA256:#{Base64.encode64(OpenSSL::Digest.digest(algorithm, blob)).chomp.gsub(/=+\z/, '')}"
+            "SHA256:#{[OpenSSL::Digest.digest(algorithm, blob)].pack('m').chomp.gsub(/=+\z/, '')}"
           else
             raise OpenSSL::Digest::DigestError, "unsupported ssh key digest #{algorithm}"
           end

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

@@ -0,0 +1,71 @@
+require 'net/ssh/errors'
+require 'net/ssh/authentication/pub_key_fingerprint'
+
+module Net
+  module SSH
+    module Authentication
+      # FIDO/U2F security keys held by ssh-agent. The agent does the signing (incl. user
+      # presence); net-ssh only parses and re-serialises the public key blob (see PROTOCOL.u2f).
+      module SecurityKey
+        SK_ECDSA_SHA2_NISTP256 = "sk-ecdsa-sha2-nistp256@openssh.com"
+        SK_SSH_ED25519 = "sk-ssh-ed25519@openssh.com"
+        TYPES = [SK_ECDSA_SHA2_NISTP256, SK_SSH_ED25519].freeze
+
+        def self.understands?(type)
+          TYPES.include?(type)
+        end
+
+        # Public key of an agent-held security key; signing is delegated to the agent.
+        class PubKey
+          include Net::SSH::Authentication::PubKeyFingerprint
+
+          attr_reader :ssh_type, :curve, :public_key_data, :application
+
+          # Wire formats:
+          #   sk-ecdsa-sha2-nistp256@openssh.com: string curve, string Q, string application
+          #   sk-ssh-ed25519@openssh.com:         string public_key, string application
+          def self.read_keyblob(type, buffer)
+            case type
+            when SK_ECDSA_SHA2_NISTP256
+              curve = buffer.read_string
+              public_key_data = buffer.read_string
+              application = buffer.read_string
+              new(type, public_key_data, application, curve: curve)
+            when SK_SSH_ED25519
+              public_key_data = buffer.read_string
+              application = buffer.read_string
+              new(type, public_key_data, application)
+            else
+              raise Net::SSH::UnsupportedKeyType, "unsupported security key type `#{type}'"
+            end
+          end
+
+          def initialize(ssh_type, public_key_data, application, curve: nil)
+            @ssh_type = ssh_type
+            @public_key_data = public_key_data
+            @application = application
+            @curve = curve
+          end
+
+          def to_blob
+            buffer = Net::SSH::Buffer.new
+            buffer.write_string(ssh_type)
+            buffer.write_string(curve) if curve
+            buffer.write_string(public_key_data)
+            buffer.write_string(application)
+            buffer.to_s
+          end
+
+          def ssh_signature_type
+            ssh_type
+          end
+
+          # Only used to de-duplicate identities, so a stable key-specific string suffices.
+          def to_pem
+            "#{ssh_type} #{[to_blob].pack('m0')}"
+          end
+        end
+      end
+    end
+  end
+end