net-ssh 5.2.0 → 7.0.1

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

@@ -1,20 +1,12 @@
-require 'net/ssh/buffer'
-require 'net/ssh/errors'
-require 'net/ssh/loggable'
-require 'net/ssh/transport/openssl'
-require 'net/ssh/transport/constants'
+require 'net/ssh/transport/kex/abstract'
 
 module Net
   module SSH
     module Transport
       module Kex
-
         # A key-exchange service implementing the "diffie-hellman-group1-sha1"
         # key-exchange algorithm.
-        class DiffieHellmanGroup1SHA1
-          include Loggable
-          include Constants
-
+        class DiffieHellmanGroup1SHA1 < Abstract
           # The value of 'P', as a string, in hexadecimal
           P_s = "FFFFFFFF" "FFFFFFFF" "C90FDAA2" "2168C234" +
                 "C4C6628B" "80DC1CD1" "29024E08" "8A67CC74" +
@@ -31,67 +23,18 @@ module Net
           # The group constant
           G = 2
 
-          attr_reader :p
-          attr_reader :g
-          attr_reader :digester
-          attr_reader :algorithms
-          attr_reader :connection
-          attr_reader :data
-          attr_reader :dh
-
-          # Create a new instance of the DiffieHellmanGroup1SHA1 algorithm.
-          # The data is a Hash of symbols representing information
-          # required by this algorithm, which was acquired during earlier
-          # processing.
-          def initialize(algorithms, connection, data)
-            @p = get_p
-            @g = get_g
-
-            @digester = OpenSSL::Digest::SHA1
-            @algorithms = algorithms
-            @connection = connection
-
-            @data = data.dup
-            @dh = generate_key
-            @logger = @data.delete(:logger)
-          end
-
-          # Perform the key-exchange for the given session, with the given
-          # data. This method will return a hash consisting of the
-          # following keys:
-          #
-          # * :session_id
-          # * :server_key
-          # * :shared_secret
-          # * :hashing_algorithm
-          #
-          # The caller is expected to be able to understand how to use these
-          # deliverables.
-          def exchange_keys
-            result = send_kexinit
-            verify_server_key(result[:server_key])
-            session_id = verify_signature(result)
-            confirm_newkeys
-
-            return { session_id: session_id,
-                     server_key: result[:server_key],
-                     shared_secret: result[:shared_secret],
-                     hashing_algorithm: digester }
+          def digester
+            OpenSSL::Digest::SHA1
           end
 
           private
 
-          def get_p
-            OpenSSL::BN.new(P_s, P_r)
-          end
-
-          def get_g
-            G
-          end
-
-          # Returns the DH key parameters for the current connection.
+          # Returns the DH key parameters for the current connection. [p, q]
           def get_parameters
-            [p, g]
+            [
+              OpenSSL::BN.new(self.class::P_s, self.class::P_r),
+              self.class::G
+            ]
           end
 
           # Returns the INIT/REPLY constants used by this algorithm.
@@ -116,26 +59,26 @@ module Net
 
           # Generate a DH key with a private key consisting of the given
           # number of bytes.
-          def generate_key #:nodoc:
-            dh = OpenSSL::PKey::DH.new
-
-            if dh.respond_to?(:set_pqg)
-              p, g = get_parameters
-              dh.set_pqg(p, nil, g)
+          def generate_key # :nodoc:
+            p, g = get_parameters
+
+            asn1 = OpenSSL::ASN1::Sequence(
+              [
+                OpenSSL::ASN1::Integer(p),
+                OpenSSL::ASN1::Integer(g)
+              ]
+            )
+
+            dh_params = OpenSSL::PKey::DH.new(asn1.to_der)
+            # XXX No private key size check! In theory the latter call should work but fails on OpenSSL 3.0 as
+            # dh_paramgen_subprime_len is now reserved for DHX algorithm
+            # key = OpenSSL::PKey.generate_key(dh_params, "dh_paramgen_subprime_len" => data[:need_bytes]/8)
+            if OpenSSL::PKey.respond_to?(:generate_key)
+              OpenSSL::PKey.generate_key(dh_params)
             else
-              dh.p, dh.g = get_parameters
-            end
-
-            dh.generate_key!
-            until dh.valid? && dh.priv_key.num_bytes == data[:need_bytes]
-              if dh.respond_to?(:set_key)
-                dh.set_key(nil, OpenSSL::BN.rand(data[:need_bytes] * 8))
-              else
-                dh.priv_key = OpenSSL::BN.rand(data[:need_bytes] * 8)
-              end
-              dh.generate_key!
+              dh_params.generate_key!
+              dh_params
             end
-            dh
           end
 
           # Send the KEXDH_INIT message, and expect the KEXDH_REPLY. Return the
@@ -143,7 +86,7 @@ module Net
           #
           # Parse the buffer from a KEXDH_REPLY message, returning a hash of
           # the extracted values.
-          def send_kexinit #:nodoc:
+          def send_kexinit # :nodoc:
             init, reply = get_message_types
 
             # send the KEXDH_INIT message
@@ -165,66 +108,14 @@ module Net
             sig_type = sig_buffer.read_string
             if sig_type != algorithms.host_key_format
               raise Net::SSH::Exception,
-                "host key algorithm mismatch for signature " +
-                "'#{sig_type}' != '#{algorithms.host_key_format}'"
+                    "host key algorithm mismatch for signature " +
+                    "'#{sig_type}' != '#{algorithms.host_key_format}'"
             end
             result[:server_sig] = sig_buffer.read_string
 
             return result
           end
-
-          # Verify that the given key is of the expected type, and that it
-          # really is the key for the session's host. Raise Net::SSH::Exception
-          # if it is not.
-          def verify_server_key(key) #:nodoc:
-            if key.ssh_type != algorithms.host_key
-              raise Net::SSH::Exception,
-                "host key algorithm mismatch " +
-                "'#{key.ssh_type}' != '#{algorithms.host_key}'"
-            end
-
-            blob, fingerprint = generate_key_fingerprint(key)
-
-            raise Net::SSH::Exception, "host key verification failed" unless connection.host_key_verifier.verify(key: key, key_blob: blob, fingerprint: fingerprint, session: connection)
-          end
-
-          def generate_key_fingerprint(key)
-            blob = Net::SSH::Buffer.from(:key, key).to_s
-
-            fingerprint = Net::SSH::Authentication::PubKeyFingerprint.fingerprint(blob, @connection.options[:fingerprint_hash] || 'SHA256')
-
-            [blob, fingerprint]
-          rescue ::Exception => e
-            [nil, "(could not generate fingerprint: #{e.message})"]
-          end
-
-          # Verify the signature that was received. Raise Net::SSH::Exception
-          # if the signature could not be verified. Otherwise, return the new
-          # session-id.
-          def verify_signature(result) #:nodoc:
-            response = build_signature_buffer(result)
-
-            hash = @digester.digest(response.to_s)
-
-            raise Net::SSH::Exception, "could not verify server signature" unless connection.host_key_verifier.verify_signature { result[:server_key].ssh_do_verify(result[:server_sig], hash) }
-
-            return hash
-          end
-
-          # Send the NEWKEYS message, and expect the NEWKEYS message in
-          # reply.
-          def confirm_newkeys #:nodoc:
-            # send own NEWKEYS message first (the wodSSHServer won't send first)
-            response = Net::SSH::Buffer.new
-            response.write_byte(NEWKEYS)
-            connection.send_message(response)
-
-            # wait for the server's NEWKEYS message
-            buffer = connection.next_message
-            raise Net::SSH::Exception, "expected NEWKEYS" unless buffer.type == NEWKEYS
-          end
         end
-
       end
     end
   end

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

@@ -3,18 +3,12 @@ require 'net/ssh/transport/constants'
 require 'net/ssh/transport/kex/diffie_hellman_group1_sha1'
 
 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
     MAXIMUM_BITS      = 8192
 
-    KEXDH_GEX_GROUP   = 31
-    KEXDH_GEX_INIT    = 32
-    KEXDH_GEX_REPLY   = 33
-    KEXDH_GEX_REQUEST = 34
-
     private
 
     # Compute the number of bits needed for the given number of bytes.
@@ -40,7 +34,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, MAXIMUM_BITS)
       connection.send_message(buffer)
 
       buffer = connection.next_message
@@ -75,5 +69,4 @@ module Net::SSH::Transport::Kex
       response
     end
   end
-
 end

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

@@ -1,15 +1,11 @@
 require 'net/ssh/transport/kex/diffie_hellman_group_exchange_sha1'
 
 module Net::SSH::Transport::Kex
-  if defined?(OpenSSL::Digest::SHA256)
-    # A key-exchange service implementing the
-    # "diffie-hellman-group-exchange-sha256" key-exchange algorithm.
-    class DiffieHellmanGroupExchangeSHA256 < DiffieHellmanGroupExchangeSHA1
-      def initialize(*args)
-        super(*args)
-
-        @digester = OpenSSL::Digest::SHA256
-      end
+  # A key-exchange service implementing the
+  # "diffie-hellman-group-exchange-sha256" key-exchange algorithm.
+  class DiffieHellmanGroupExchangeSHA256 < DiffieHellmanGroupExchangeSHA1
+    def digester
+      OpenSSL::Digest::SHA256
     end
   end
 end

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

@@ -1,97 +1,36 @@
-require 'net/ssh/transport/constants'
-require 'net/ssh/transport/kex/diffie_hellman_group1_sha1'
+require 'net/ssh/transport/kex/abstract5656'
 
-module Net 
-  module SSH 
-    module Transport 
+module Net
+  module SSH
+    module Transport
       module Kex
-
         # A key-exchange service implementing the "ecdh-sha2-nistp256"
         # key-exchange algorithm. (defined in RFC 5656)
-        class EcdhSHA2NistP256 < DiffieHellmanGroup1SHA1
-          include Loggable
-          include Constants
-      
-          attr_reader :ecdh
-      
+        class EcdhSHA2NistP256 < Abstract5656
           def digester
             OpenSSL::Digest::SHA256
           end
-      
+
           def curve_name
             OpenSSL::PKey::EC::CurveNameAlias['nistp256']
           end
-      
-          def initialize(algorithms, connection, data)
-            @algorithms = algorithms
-            @connection = connection
-      
-            @digester = digester
-            @data = data.dup
-            @ecdh = generate_key
-            @logger = @data.delete(:logger)
-          end
-      
+
           private
-      
-          def get_message_types
-            [KEXECDH_INIT, KEXECDH_REPLY]
-          end
-      
-          def build_signature_buffer(result)
-            response = Net::SSH::Buffer.new
-            response.write_string data[:client_version_string],
-                                  data[:server_version_string],
-                                  data[:client_algorithm_packet],
-                                  data[:server_algorithm_packet],
-                                  result[:key_blob],
-                                  ecdh.public_key.to_bn.to_s(2),
-                                  result[:server_ecdh_pubkey]
-            response.write_bignum result[:shared_secret]
-            response
-          end
-      
-          def generate_key #:nodoc:
-            OpenSSL::PKey::EC.new(curve_name).generate_key
+
+          def generate_key # :nodoc:
+            OpenSSL::PKey::EC.generate(curve_name)
           end
-      
-          def send_kexinit #:nodoc:
-            init, reply = get_message_types
-      
-            # send the KEXECDH_INIT message
-            ## byte     SSH_MSG_KEX_ECDH_INIT
-            ## string   Q_C, client's ephemeral public key octet string
-            buffer = Net::SSH::Buffer.from(:byte, init, :mstring, ecdh.public_key.to_bn.to_s(2))
-            connection.send_message(buffer)
-      
-            # expect the following KEXECDH_REPLY message
-            ## byte     SSH_MSG_KEX_ECDH_REPLY
-            ## string   K_S, server's public host key
-            ## string   Q_S, server's ephemeral public key octet string
-            ## string   the signature on the exchange hash
-            buffer = connection.next_message
-            raise Net::SSH::Exception, "expected REPLY" unless buffer.type == reply
-      
-            result = Hash.new
-            result[:key_blob] = buffer.read_string
-            result[:server_key] = Net::SSH::Buffer.new(result[:key_blob]).read_key
-            result[:server_ecdh_pubkey] = buffer.read_string
-      
-            # compute shared secret from server's public key and client's private key
+
+          # compute shared secret from server's public key and client's private key
+          def compute_shared_secret(server_ecdh_pubkey)
             pk = OpenSSL::PKey::EC::Point.new(OpenSSL::PKey::EC.new(curve_name).group,
-                                              OpenSSL::BN.new(result[:server_ecdh_pubkey], 2))
-            result[:shared_secret] = OpenSSL::BN.new(ecdh.dh_compute_key(pk), 2)
-      
-            sig_buffer = Net::SSH::Buffer.new(buffer.read_string)
-            sig_type = sig_buffer.read_string
-            if sig_type != algorithms.host_key_format
-              raise Net::SSH::Exception,
-              "host key algorithm mismatch for signature " +
-                "'#{sig_type}' != '#{algorithms.host_key_format}'"
-            end
-            result[:server_sig] = sig_buffer.read_string
-      
-            return result
+                                              OpenSSL::BN.new(server_ecdh_pubkey, 2))
+            OpenSSL::BN.new(ecdh.dh_compute_key(pk), 2)
+          end
+
+          ## string   Q_C, client's ephemeral public key octet string
+          def ecdh_public_key_bytes
+            ecdh.public_key.to_bn.to_s(2)
           end
         end
       end

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

@@ -1,8 +1,9 @@
-module Net 
-  module SSH 
-    module Transport 
-      module Kex
+require 'net/ssh/transport/kex/ecdh_sha2_nistp256'
 
+module Net
+  module SSH
+    module Transport
+      module Kex
         # A key-exchange service implementing the "ecdh-sha2-nistp256"
         # key-exchange algorithm. (defined in RFC 5656)
         class EcdhSHA2NistP384 < EcdhSHA2NistP256

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

@@ -1,8 +1,9 @@
-module Net 
-  module SSH 
-    module Transport 
-      module Kex
+require 'net/ssh/transport/kex/ecdh_sha2_nistp256'
 
+module Net
+  module SSH
+    module Transport
+      module Kex
         # A key-exchange service implementing the "ecdh-sha2-nistp521"
         # key-exchange algorithm. (defined in RFC 5656)
         class EcdhSHA2NistP521 < EcdhSHA2NistP256

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

@@ -1,26 +1,31 @@
 require 'net/ssh/transport/kex/diffie_hellman_group1_sha1'
 require 'net/ssh/transport/kex/diffie_hellman_group14_sha1'
+require 'net/ssh/transport/kex/diffie_hellman_group14_sha256'
 require 'net/ssh/transport/kex/diffie_hellman_group_exchange_sha1'
 require 'net/ssh/transport/kex/diffie_hellman_group_exchange_sha256'
+require 'net/ssh/transport/kex/ecdh_sha2_nistp256'
+require 'net/ssh/transport/kex/ecdh_sha2_nistp384'
+require 'net/ssh/transport/kex/ecdh_sha2_nistp521'
+require 'net/ssh/transport/kex/curve25519_sha256_loader'
 
 module Net::SSH::Transport
   module Kex
     # Maps the supported key-exchange algorithms as named by the SSH protocol
     # to their corresponding implementors.
     MAP = {
+      'diffie-hellman-group1-sha1' => DiffieHellmanGroup1SHA1,
+      'diffie-hellman-group14-sha1' => DiffieHellmanGroup14SHA1,
+      'diffie-hellman-group14-sha256' => DiffieHellmanGroup14SHA256,
       'diffie-hellman-group-exchange-sha1' => DiffieHellmanGroupExchangeSHA1,
-      'diffie-hellman-group1-sha1'         => DiffieHellmanGroup1SHA1,
-      'diffie-hellman-group14-sha1'        => DiffieHellmanGroup14SHA1
+      'diffie-hellman-group-exchange-sha256' => DiffieHellmanGroupExchangeSHA256,
+      'ecdh-sha2-nistp256' => EcdhSHA2NistP256,
+      'ecdh-sha2-nistp384' => EcdhSHA2NistP384,
+      'ecdh-sha2-nistp521' => EcdhSHA2NistP521
     }
-    MAP['diffie-hellman-group-exchange-sha256'] = DiffieHellmanGroupExchangeSHA256 if defined?(DiffieHellmanGroupExchangeSHA256)
-    if defined?(OpenSSL::PKey::EC)
-      require 'net/ssh/transport/kex/ecdh_sha2_nistp256'
-      require 'net/ssh/transport/kex/ecdh_sha2_nistp384'
-      require 'net/ssh/transport/kex/ecdh_sha2_nistp521'
 
-      MAP['ecdh-sha2-nistp256'] = EcdhSHA2NistP256
-      MAP['ecdh-sha2-nistp384'] = EcdhSHA2NistP384
-      MAP['ecdh-sha2-nistp521'] = EcdhSHA2NistP521
+    if Net::SSH::Transport::Kex::Curve25519Sha256Loader::LOADED
+      MAP['curve25519-sha256'] = Curve25519Sha256
+      MAP['curve25519-sha256@libssh.org'] = Curve25519Sha256
     end
   end
 end

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

@@ -1,28 +1,27 @@
-module Net 
-  module SSH 
+module Net
+  module SSH
     module Transport
       module KeyExpander
-    
         # Generate a key value in accordance with the SSH2 specification.
         # (RFC4253 7.2. "Output from Key Exchange")
-        def self.expand_key(bytes, start, options={})
+        def self.expand_key(bytes, start, options = {})
           if bytes == 0
             return ""
           end
-      
+
           k = start[0, bytes]
           return k if k.length >= bytes
-      
+
           digester = options[:digester] or raise 'No digester supplied'
           shared   = options[:shared] or raise 'No shared secret supplied'
           hash     = options[:hash] or raise 'No hash supplied'
-      
+
           while k.length < bytes
             step = digester.digest(shared + hash + k)
             bytes_needed = bytes - k.length
             k << step[0, bytes_needed]
           end
-      
+
           return k
         end
       end