net-ssh 7.3.6 → 8.0.0

data/lib/net/ssh/transport/gcm_cipher.rb

@@ -5,7 +5,11 @@ module Net
     module Transport
       ## Extension module for aes(128|256)gcm ciphers
       module GCMCipher
-        # rubocop:disable Metrics/AbcSize
+        BLOCK_SIZE = 16
+        IV_BYTES = 12
+        AUTH_TAG_BYTES = 16
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         def self.extended(orig)
           # rubocop:disable Metrics/BlockLength
           orig.class_eval do
@@ -100,15 +104,32 @@ module Net
             end
 
             def mac_length
-              16
+              GCMCipher::AUTH_TAG_BYTES
             end
 
             def block_size
-              16
+              GCMCipher::BLOCK_SIZE
             end
 
             def self.block_size
-              16
+              GCMCipher::BLOCK_SIZE
+            end
+
+            def self.iv_len
+              GCMCipher::IV_BYTES
+            end
+
+            def self.auth_length
+              GCMCipher::AUTH_TAG_BYTES
+            end
+
+            def self.decrypt_private_key(ciphertext, auth_tag, key, initialization_vector)
+              cipher = new(encrypt: false, key: key)
+
+              cipher.nonce = initialization_vector
+              cipher.cipher.auth_tag = auth_tag.to_s
+              cipher.cipher.auth_data = ''
+              cipher.cipher.update(ciphertext.to_s) << cipher.cipher.final
             end
 
             #
@@ -117,7 +138,7 @@ module Net
             # N_MAX       maximum nonce (IV) length        12 octets
             #
             def iv_len
-              12
+              GCMCipher::IV_BYTES
             end
 
             #
@@ -201,7 +222,7 @@ module Net
         end
         # rubocop:enable Metrics/BlockLength
       end
-      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
     end
   end
 end

data/lib/net/ssh/transport/hmac/sha1_etm.rb

@@ -0,0 +1,12 @@
+require 'net/ssh/transport/hmac/abstract'
+
+module Net::SSH::Transport::HMAC
+  # The SHA1 Encrypt-Then-Mac HMAC algorithm. This has a mac and
+  # key length of 20, and uses the SHA1 digest algorithm.
+  class SHA1_Etm < Abstract
+    etm          true
+    mac_length   20
+    key_length   20
+    digest_class OpenSSL::Digest::SHA1
+  end
+end

data/lib/net/ssh/transport/hmac.rb

@@ -9,6 +9,7 @@ require 'net/ssh/transport/hmac/sha2_512'
 require 'net/ssh/transport/hmac/sha2_512_96'
 require 'net/ssh/transport/hmac/sha2_256_etm'
 require 'net/ssh/transport/hmac/sha2_512_etm'
+require 'net/ssh/transport/hmac/sha1_etm'
 require 'net/ssh/transport/hmac/ripemd160'
 require 'net/ssh/transport/hmac/none'
 
@@ -27,6 +28,7 @@ module Net::SSH::Transport::HMAC
     'hmac-sha2-512-96' => SHA2_512_96,
     'hmac-sha2-256-etm@openssh.com' => SHA2_256_Etm,
     'hmac-sha2-512-etm@openssh.com' => SHA2_512_Etm,
+    'hmac-sha1-etm@openssh.com' => SHA1_Etm,
     'hmac-ripemd160' => RIPEMD160,
     'hmac-ripemd160@openssh.com' => RIPEMD160,
     'none' => None

data/lib/net/ssh/transport/kex/curve25519_sha256.rb

@@ -1,7 +1,4 @@
-gem 'x25519' # raise if the gem x25519 is not installed
-
-require 'x25519'
-
+require 'openssl'
 require 'net/ssh/transport/constants'
 require 'net/ssh/transport/kex/abstract5656'
 
@@ -12,25 +9,60 @@ module Net
         # A key-exchange service implementing the "curve25519-sha256@libssh.org"
         # key-exchange algorithm. (defined in https://tools.ietf.org/html/draft-ietf-curdle-ssh-curves-06)
         class Curve25519Sha256 < Abstract5656
+          ALGORITHM = "X25519"
+          KEY_BYTES = 32
+
+          class UnsupportedError < StandardError; end
+
+          def self.ensure_supported!
+            unless OpenSSL::PKey.respond_to?(:generate_key) && OpenSSL::PKey.respond_to?(:new_raw_public_key)
+              raise UnsupportedError, "OpenSSL::PKey raw public key APIs are unavailable"
+            end
+
+            key = generate_x25519_key
+            public_key = new_raw_public_key(key.raw_public_key)
+            validate_key_bytes!(key.derive(public_key), "shared secret", KEY_BYTES)
+          rescue OpenSSL::PKey::PKeyError => e
+            raise UnsupportedError, e.message
+          end
+
+          def self.generate_x25519_key
+            OpenSSL::PKey.generate_key(ALGORITHM)
+          end
+
+          def self.new_raw_public_key(key)
+            validate_key_bytes!(key, "public key", KEY_BYTES)
+            OpenSSL::PKey.new_raw_public_key(ALGORITHM, binary_string(key))
+          end
+
+          def self.validate_key_bytes!(key, label, expected_bytes)
+            raise ArgumentError, "invalid X25519 #{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
+
           def digester
             OpenSSL::Digest::SHA256
           end
 
           private
 
-          def generate_key # :nodoc:
-            ::X25519::Scalar.generate
+          def generate_key
+            self.class.generate_x25519_key
           end
 
           ## string   Q_C, client's ephemeral public key octet string
           def ecdh_public_key_bytes
-            ecdh.public_key.to_bytes
+            ecdh.raw_public_key
           end
 
           # compute shared secret from server's public key and client's private key
           def compute_shared_secret(server_ecdh_pubkey)
-            pk = ::X25519::MontgomeryU.new(server_ecdh_pubkey)
-            OpenSSL::BN.new(ecdh.diffie_hellman(pk).to_bytes, 2)
+            pk = self.class.new_raw_public_key(server_ecdh_pubkey)
+            OpenSSL::BN.new(ecdh.derive(pk), 2)
           end
         end
       end

data/lib/net/ssh/transport/kex/curve25519_sha256_loader.rb

@@ -2,26 +2,34 @@ module Net
   module SSH
     module Transport
       module Kex
-        # Loads Curve25519Sha256 support which requires optinal dependencies
+        # Loads Curve25519Sha256 support backed by Ruby OpenSSL X25519 APIs.
         module Curve25519Sha256Loader
           begin
             require 'net/ssh/transport/kex/curve25519_sha256'
+            Net::SSH::Transport::Kex::Curve25519Sha256.ensure_supported!
             LOADED = true
             ERROR = nil
           rescue LoadError => e
             ERROR = e
             LOADED = false
+          rescue StandardError => e
+            if defined?(Net::SSH::Transport::Kex::Curve25519Sha256::UnsupportedError) &&
+               e.is_a?(Net::SSH::Transport::Kex::Curve25519Sha256::UnsupportedError)
+              ERROR = e
+              LOADED = false
+            else
+              raise
+            end
           end
 
           def self.raiseUnlessLoaded(message)
-            description = ERROR.is_a?(LoadError) ? dependenciesRequiredForX25519 : ''
-            description << "#{ERROR.class} : \"#{ERROR.message}\"\n" if ERROR
+            description = LOADED ? '' : x25519SupportRequired
+            description += "#{ERROR.class} : \"#{ERROR.message}\"\n" if ERROR
             raise NotImplementedError, "#{message}\n#{description}" unless LOADED
           end
 
-          def self.dependenciesRequiredForX25519
-            result = "net-ssh requires the following gems for x25519 support:\n"
-            result << " * x25519\n"
+          def self.x25519SupportRequired
+            "net-ssh requires openssl >= 3.2.0 and a crypto backend with X25519 enabled for curve25519-sha256 support.\n"
           end
         end
       end

data/lib/net/ssh/transport/kex/diffie_hellman_group1_sha1.rb

@@ -102,6 +102,7 @@ module Net
             result[:key_blob] = buffer.read_string
             result[:server_key] = Net::SSH::Buffer.new(result[:key_blob]).read_key
             result[:server_dh_pubkey] = buffer.read_bignum
+            validate_server_dh_pubkey(result[:server_dh_pubkey])
             result[:shared_secret] = OpenSSL::BN.new(dh.compute_key(result[:server_dh_pubkey]), 2)
 
             sig_buffer = Net::SSH::Buffer.new(buffer.read_string)
@@ -115,6 +116,13 @@ module Net
 
             return result
           end
+
+          # Rejects degenerate values that would let the server force a
+          # predictable shared secret, as OpenSSH's dh_pub_is_valid.
+          def validate_server_dh_pubkey(pub)
+            valid = pub > 1 && pub < dh.p - 1 && pub.to_i.to_s(2).count("1") >= 4
+            raise Net::SSH::Exception, "server's DH public value is invalid" unless valid
+          end
         end
       end
     end

data/lib/net/ssh/transport/kex/diffie_hellman_group_exchange_sha1.rb

@@ -6,26 +6,43 @@ module Net::SSH::Transport::Kex
   # A key-exchange service implementing the
   # "diffie-hellman-group-exchange-sha1" key-exchange algorithm.
   class DiffieHellmanGroupExchangeSHA1 < DiffieHellmanGroup1SHA1
-    MINIMUM_BITS      = 1024
+    MINIMUM_BITS      = 2048
     MAXIMUM_BITS      = 8192
+    CISCO_MAXIMUM_NEED_BITS = 4096
 
     private
 
-    # Compute the number of bits needed for the given number of bytes.
+    # Computes the minimum, preferred and maximum group sizes to request,
+    # like OpenSSH's kexgex_client.
     def compute_need_bits
-      # for Compatibility: OpenSSH requires (need_bits * 2 + 1) length of parameter
-      need_bits = data[:need_bytes] * 8 * 2 + 1
-
       data[:minimum_dh_bits] ||= MINIMUM_BITS
+      data[:maximum_dh_bits] = [MAXIMUM_BITS, data[:minimum_dh_bits]].max
+      data[:need_bits] = estimate_group_bits(data[:need_bytes] * 8).clamp(data[:minimum_dh_bits], maximum_need_bits)
+    end
 
-      if need_bits < data[:minimum_dh_bits]
-        need_bits = data[:minimum_dh_bits]
-      elsif need_bits > MAXIMUM_BITS
-        need_bits = MAXIMUM_BITS
-      end
+    # Some Cisco servers fail instead of returning their 4096-bit group when asked for more (OpenSSH bz#2209).
+    def maximum_need_bits
+      return data[:maximum_dh_bits] unless cisco_server?
+
+      [CISCO_MAXIMUM_NEED_BITS, data[:minimum_dh_bits]].max
+    end
+
+    def cisco_server?
+      data[:server_version_string].to_s.match?(/\ASSH-[\d.]+-Cisco-1\./)
+    end
 
-      data[:need_bits] = need_bits
-      data[:need_bytes] = need_bits / 8
+    # Group size giving at least the given bits of security (NIST SP 800-57),
+    # as OpenSSH's dh_estimate.
+    def estimate_group_bits(security_bits)
+      if security_bits <= 112
+        2048
+      elsif security_bits <= 128
+        3072
+      elsif security_bits <= 192
+        7680
+      else
+        8192
+      end
     end
 
     # Returns the DH key parameters for the given session.
@@ -34,7 +51,7 @@ module Net::SSH::Transport::Kex
 
       # request the DH key parameters for the given number of bits.
       buffer = Net::SSH::Buffer.from(:byte, KEXDH_GEX_REQUEST, :long, data[:minimum_dh_bits],
-                                     :long, data[:need_bits], :long, MAXIMUM_BITS)
+                                     :long, data[:need_bits], :long, data[:maximum_dh_bits])
       connection.send_message(buffer)
 
       buffer = connection.next_message
@@ -43,9 +60,22 @@ module Net::SSH::Transport::Kex
       p = buffer.read_bignum
       g = buffer.read_bignum
 
+      validate_group(p, g)
+
       [p, g]
     end
 
+    def validate_group(prime, generator)
+      bits = prime.num_bits
+      if bits < data[:minimum_dh_bits]
+        raise Net::SSH::Exception,
+              "server's DH group is #{bits} bits, below the minimum of #{data[:minimum_dh_bits]}; " \
+              "pass minimum_dh_bits: #{bits} to allow it"
+      end
+      raise Net::SSH::Exception, "server's DH group is #{bits} bits, above the maximum of #{data[:maximum_dh_bits]}" if bits > data[:maximum_dh_bits]
+      raise Net::SSH::Exception, "server's DH group generator is invalid" unless generator > 1 && generator < prime - 1
+    end
+
     # Returns the INIT/REPLY constants used by this algorithm.
     def get_message_types
       [KEXDH_GEX_INIT, KEXDH_GEX_REPLY]
@@ -60,9 +90,9 @@ module Net::SSH::Transport::Kex
                             data[:client_algorithm_packet],
                             data[:server_algorithm_packet],
                             result[:key_blob]
-      response.write_long MINIMUM_BITS,
+      response.write_long data[:minimum_dh_bits],
                           data[:need_bits],
-                          MAXIMUM_BITS
+                          data[:maximum_dh_bits]
       response.write_bignum dh.p, dh.g, dh.pub_key,
                             result[:server_dh_pubkey],
                             result[:shared_secret]

data/lib/net/ssh/transport/openssl.rb

@@ -1,4 +1,5 @@
 require 'openssl'
+require 'net/ssh/errors'
 require 'net/ssh/authentication/pub_key_fingerprint'
 
 module OpenSSL
@@ -178,7 +179,7 @@ module OpenSSL
 
           return key
         rescue OpenSSL::PKey::ECError
-          raise NotImplementedError, "unsupported key type `#{type}'"
+          raise Net::SSH::UnsupportedKeyType, "unsupported key type `ecdsa-sha2-#{curve_name_in_type}'"
         end
       end
 

data/lib/net/ssh/transport/packet_stream.rb

@@ -190,6 +190,7 @@ module Net
         def cleanup
           client.cleanup
           server.cleanup
+          hang_up_proxy_command
         end
 
         # If the IO object requires a rekey operation (as indicated by either its
@@ -205,6 +206,17 @@ module Net
 
         protected
 
+        # Like OpenSSH, hang up a ProxyCommand child: tunnels such as EC2 Instance
+        # Connect don't exit on their own, and IO#close waits for them.
+        def hang_up_proxy_command
+          return unless respond_to?(:pid)
+
+          child = pid
+          Process.kill('HUP', child) if child
+        rescue IOError, Errno::ESRCH
+          # already closed, or the child has already been reaped
+        end
+
         # Called when this module is used to extend an object. It initializes
         # the states and generally prepares the object for use as a packet stream.
         def initialize_ssh

data/lib/net/ssh/transport/session.rb

@@ -66,6 +66,7 @@ module Net
           @port = options[:port] || DEFAULT_PORT
           @bind_address = options[:bind_address] || nil
           @options = options
+          @host_key_verifier = select_host_key_verifier(options[:verify_host_key])
 
           @socket =
             if (factory = options[:proxy])
@@ -79,21 +80,24 @@ module Net
 
           @socket.extend(PacketStream)
           @socket.logger = @logger
+          set_no_delay unless options[:no_delay] == false
 
           debug { "connection established" }
 
           @queue = []
           @queued_bytes = 0
 
-          @host_key_verifier = select_host_key_verifier(options[:verify_host_key])
-
           @server_version = ServerVersion.new(socket, logger, options[:timeout])
 
           @algorithms = Algorithms.new(self, options)
           @algorithms.start
           wait { algorithms.initialized? }
         rescue Errno::ETIMEDOUT
+          @socket&.close
           raise Net::SSH::ConnectionTimeout
+        rescue StandardError
+          @socket&.close
+          raise
         end
 
         def host_keys
@@ -103,6 +107,10 @@ module Net
           end
         end
 
+        def pubkey_algorithms
+          algorithms[:pubkey_algorithms]
+        end
+
         # Returns the host (and possibly IP address) in a format compatible with
         # SSH known-host files.
         def host_as_string
@@ -211,6 +219,10 @@ module Net
             when DEBUG
               send(packet[:always_display] ? :fatal : :debug) { packet[:message] }
 
+            # We don't advertise ext-info-c, but some servers send EXT_INFO anyway (#955).
+            when EXT_INFO
+              debug { "ignoring EXT_INFO packet" }
+
             when KEXINIT
               algorithms.accept_kexinit(packet)
 
@@ -293,23 +305,25 @@ module Net
           packet
         end
 
-        # Compatibility verifier which allows users to keep using
-        # custom verifier code without adding new :verify_signature
-        # method.
-        class CompatibleVerifier
-          def initialize(verifier)
-            @verifier = verifier
-          end
+        # Turns Nagle's algorithm off on the socket, so that a packet written
+        # while the previous one is still unacknowledged goes out right away
+        # instead of waiting for the server's ACK. A ProxyCommand hands the
+        # transport a pipe rather than a socket, and the command on its other
+        # end owns the TCP connection, so there is nothing to set in that case.
+        def set_no_delay
+          return unless socket.respond_to?(:setsockopt)
 
-          def verify(arguments)
-            @verifier.verify(arguments)
-          end
-
-          def verify_signature(&block)
-            yield
-          end
+          debug { "setting TCP_NODELAY" }
+          socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
         end
 
+        REMOVED_VERIFY_HOST_KEY_VALUES = {
+          false => :never,
+          true => :accept_new_or_local_tunnel,
+          very: :accept_new,
+          secure: :always
+        }.freeze
+
         # Instantiates a new host-key verification class, based on the value of
         # the parameter.
         #
@@ -323,46 +337,29 @@ module Net
         #
         # If the argument happens to respond to :verify and :verify_signature,
         # it is returned directly. Otherwise, an exception is raised.
-        #
-        # Values false, true, and :very were deprecated in
-        # [#595](https://github.com/net-ssh/net-ssh/pull/595)
         def select_host_key_verifier(verifier)
           case verifier
-          when false
-            Kernel.warn('verify_host_key: false is deprecated, use :never')
-            Net::SSH::Verifiers::Never.new
           when :never then
             Net::SSH::Verifiers::Never.new
-          when true
-            Kernel.warn('verify_host_key: true is deprecated, use :accept_new_or_local_tunnel')
-            Net::SSH::Verifiers::AcceptNewOrLocalTunnel.new
           when :accept_new_or_local_tunnel, nil then
             Net::SSH::Verifiers::AcceptNewOrLocalTunnel.new
-          when :very
-            Kernel.warn('verify_host_key: :very is deprecated, use :accept_new')
-            Net::SSH::Verifiers::AcceptNew.new
           when :accept_new then
             Net::SSH::Verifiers::AcceptNew.new
-          when :secure then
-            Kernel.warn('verify_host_key: :secure is deprecated, use :always')
-            Net::SSH::Verifiers::Always.new
           when :always then
             Net::SSH::Verifiers::Always.new
+          when *REMOVED_VERIFY_HOST_KEY_VALUES.keys
+            raise ArgumentError,
+                  "verify_host_key: #{verifier.inspect} has been removed, use #{REMOVED_VERIFY_HOST_KEY_VALUES[verifier].inspect}"
           else
-            if verifier.respond_to?(:verify)
-              if verifier.respond_to?(:verify_signature)
-                verifier
-              else
-                Kernel.warn("Warning: verifier without :verify_signature is deprecated")
-                CompatibleVerifier.new(verifier)
-              end
-            else
-              raise(
-                ArgumentError,
-                "Invalid argument to :verify_host_key (or deprecated " \
-                ":paranoid): #{verifier.inspect}"
-              )
+            raise ArgumentError, "Invalid argument to :verify_host_key: #{verifier.inspect}" unless verifier.respond_to?(:verify)
+
+            unless verifier.respond_to?(:verify_signature)
+              raise ArgumentError,
+                    "verify_host_key verifier #{verifier.inspect} must implement verify_signature(&block): " \
+                    "yield to the block, which checks the server's host key signature, and return its result"
             end
+
+            verifier
           end
         end
       end

data/lib/net/ssh/verifiers/always.rb

@@ -51,9 +51,6 @@ module Net
         # implement them (Net::SSH::HostKeyEntries::CertAuthority). Non-certificate
         # entries do not respond to these predicates and are left untouched.
         def verify_certificate!(entry, host_keys, arguments)
-          # Plain keys carry no certificate constraints, and respond_to? on this delegator prints a deprecation warning (#1026).
-          return if entry.is_a?(Net::SSH::HostKeyEntries::PubKey)
-
           cert = arguments[:key]
 
           if entry.respond_to?(:matches_validity?) && !entry.matches_validity?(cert)

data/lib/net/ssh/version.rb

@@ -46,13 +46,13 @@ module Net
       end
 
       # The major component of this version of the Net::SSH library
-      MAJOR = 7
+      MAJOR = 8
 
       # The minor component of this version of the Net::SSH library
-      MINOR = 3
+      MINOR = 0
 
       # The tiny component of this version of the Net::SSH library
-      TINY  = 6
+      TINY  = 0
 
       # The prerelease component of this version of the Net::SSH library
       # nil allowed