net-ssh 1.1.4 → 2.0.0

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

@@ -0,0 +1,72 @@
+require 'openssl'
+require 'net/ssh/transport/identity_cipher'
+
+module Net; module SSH; module Transport
+
+  # Implements a factory of OpenSSL cipher algorithms.
+  class CipherFactory
+    # Maps the SSH name of a cipher to it's corresponding OpenSSL name
+    SSH_TO_OSSL = {
+      "3des-cbc"                    => "des-ede3-cbc",
+      "blowfish-cbc"                => "bf-cbc",
+      "aes256-cbc"                  => "aes-256-cbc",
+      "aes192-cbc"                  => "aes-192-cbc",
+      "aes128-cbc"                  => "aes-128-cbc",
+      "idea-cbc"                    => "idea-cbc",
+      "cast128-cbc"                 => "cast-cbc",
+      "rijndael-cbc@lysator.liu.se" => "aes-256-cbc",
+      "none"                        => "none"
+    }
+
+    # Retrieves a new instance of the named algorithm. The new instance
+    # will be initialized using an iv and key generated from the given
+    # iv, key, shared, hash and digester values. Additionally, the
+    # cipher will be put into encryption or decryption mode, based on the
+    # value of the +encrypt+ parameter.
+    def self.get(name, options={})
+      ossl_name = SSH_TO_OSSL[name] or raise NotImplementedError, "unimplemented cipher `#{name}'"
+      return IdentityCipher if ossl_name == "none"
+
+      cipher = OpenSSL::Cipher::Cipher.new(ossl_name)
+      cipher.send(options[:encrypt] ? :encrypt : :decrypt)
+
+      cipher.padding = 0
+      cipher.iv      = make_key(cipher.iv_len, options[:iv], options)
+      cipher.key     = make_key(cipher.key_len, options[:key], options)
+
+      return cipher
+    end
+
+    # Returns a two-element array containing the [ key-length,
+    # block-size ] for the named cipher algorithm. If the cipher
+    # algorithm is unknown, or is "none", 0 is returned for both elements
+    # of the tuple.
+    def self.get_lengths(name)
+      ossl_name = SSH_TO_OSSL[name]
+      return [0, 0] if ossl_name.nil? || ossl_name == "none"
+
+      cipher = OpenSSL::Cipher::Cipher.new(ossl_name)
+      return [cipher.key_len, cipher.block_size]
+    end
+
+    private
+
+      # Generate a key value in accordance with the SSH2 specification.
+      def self.make_key(bytes, start, options={})
+        k = start[0, bytes]
+
+        digester = options[:digester]
+        shared   = options[:shared]
+        hash     = options[:hash]
+
+        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
+
+end; end; end

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

@@ -1,66 +1,30 @@
-#--
-# =============================================================================
-# Copyright (c) 2004,2005 Jamis Buck (jamis@37signals.com)
-# All rights reserved.
-#
-# This source file is distributed as part of the Net::SSH Secure Shell Client
-# library for Ruby. This file (and the library as a whole) may be used only as
-# allowed by either the BSD license, or the Ruby license (or, by association
-# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SSH
-# distribution for the texts of these licenses.
-# -----------------------------------------------------------------------------
-# net-ssh website : http://net-ssh.rubyforge.org
-# project website: http://rubyforge.org/projects/net-ssh
-# =============================================================================
-#++
+module Net; module SSH; module Transport
+  module Constants
 
-module Net
-  module SSH
-    module Transport
+    #--
+    # Transport layer generic messages
+    #++
 
-      module Constants
+    DISCONNECT                = 1
+    IGNORE                    = 2
+    UNIMPLEMENTED             = 3
+    DEBUG                     = 4
+    SERVICE_REQUEST           = 5
+    SERVICE_ACCEPT            = 6
 
-        # Transport layer generic messages
+    #--
+    # Algorithm negotiation messages
+    #++
 
-        DISCONNECT                = 1
-        IGNORE                    = 2
-        UNIMPLEMENTED             = 3
-        DEBUG                     = 4
-        SERVICE_REQUEST           = 5
-        SERVICE_ACCEPT            = 6
+    KEXINIT                   = 20
+    NEWKEYS                   = 21
 
-        # Algorithm negotiation messages
+    #--
+    # Key exchange method specific messages
+    #++
 
-        KEXINIT                   = 20
-        NEWKEYS                   = 21
+    KEXDH_INIT                = 30
+    KEXDH_REPLY               = 31
 
-        # Key exchange method specific messages
-
-        KEXDH_INIT                = 30
-        KEXDH_REPLY               = 31
-
-      end
-
-      module DisconnectReasons
-
-        HOST_NOT_ALLOWED_TO_CONNECT    =  1
-        PROTOCOL_ERROR                 =  2
-        KEY_EXCHANGE_FAILED            =  3
-        RESERVED                       =  4
-        MAC_ERROR                      =  5
-        COMPRESSION_ERROR              =  6
-        SERVICE_NOT_AVAILABLE          =  7
-        PROTOCOL_VERSION_NOT_SUPPORTED =  8
-        HOST_KEY_NOT_VERIFIABLE        =  9
-        CONNECTION_LOST                = 10
-        BY_APPLICATION                 = 11
-        TOO_MANY_CONNECTIONS           = 12
-        AUTH_CANCELLED_BY_USER         = 13
-        NO_MORE_AUTH_METHODS_AVAILABLE = 14
-        ILLEGAL_USER_NAME              = 15
-
-      end
-
-    end
   end
-end
+end; end; end

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

@@ -0,0 +1,31 @@
+require 'net/ssh/transport/hmac/md5'
+require 'net/ssh/transport/hmac/md5_96'
+require 'net/ssh/transport/hmac/sha1'
+require 'net/ssh/transport/hmac/sha1_96'
+require 'net/ssh/transport/hmac/none'
+
+# Implements a simple factory interface for fetching hmac implementations, or
+# for finding the key lengths for hmac implementations.s
+module Net::SSH::Transport::HMAC
+  # The mapping of SSH hmac algorithms to their implementations
+  MAP = {
+    'hmac-md5'     => MD5,
+    'hmac-md5-96'  => MD5_96,
+    'hmac-sha1'    => SHA1,
+    'hmac-sha1-96' => SHA1_96,
+    'none'         => None
+  }
+
+  # Retrieves a new hmac instance of the given SSH type (+name+). If +key+ is
+  # given, the new instance will be initialized with that key.
+  def self.get(name, key="")
+    impl = MAP[name] or raise ArgumentError, "hmac not found: #{name.inspect}"
+    impl.new(key)
+  end
+
+  # Retrieves the key length for the hmac of the given SSH type (+name+).
+  def self.key_length(name)
+    impl = MAP[name] or raise ArgumentError, "hmac not found: #{name.inspect}"
+    impl.key_length
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'openssl'
+
+module Net; module SSH; module Transport; module HMAC
+
+  # The base class of all OpenSSL-based HMAC algorithm wrappers.
+  class Abstract
+
+    class <<self
+      %w(key_length mac_length digest_class).each do |attribute|
+        define_method(attribute) do |*v|
+          # satisfy ruby -w
+          if !instance_variables.include?("@#{attribute}")
+            instance_variable_set("@#{attribute}", nil)
+          end
+
+          if v.empty?
+            v = instance_variable_get("@#{attribute}")
+            if v.nil? && superclass.respond_to?(attribute)
+              v = superclass.send(attribute)
+              instance_variable_set("@#{attribute}", v)
+            end
+            v
+          else
+            instance_variable_set("@#{attribute}", v.first)
+          end
+        end
+      end
+    end
+
+    %w(key_length mac_length digest_class).each do |attribute|
+      define_method(attribute) { self.class.send(attribute) }
+    end
+
+    # The key to use for this instance.
+    attr_accessor :key
+
+    def initialize(key=nil)
+      self.key = key
+    end
+
+    # Compute the HMAC digest for the given data string.
+    def digest(data)
+      OpenSSL::HMAC.digest(digest_class.new, key, data)[0,mac_length]
+    end
+
+  end
+
+end; end; end; end

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

@@ -0,0 +1,12 @@
+require 'net/ssh/transport/hmac/abstract'
+
+module Net::SSH::Transport::HMAC
+
+  # The MD5 HMAC algorithm.
+  class MD5 < Abstract
+    mac_length   16
+    key_length   16
+    digest_class OpenSSL::Digest::MD5
+  end
+
+end

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

@@ -0,0 +1,11 @@
+require 'net/ssh/transport/hmac/md5'
+
+module Net::SSH::Transport::HMAC
+
+  # The MD5-96 HMAC algorithm. This returns only the first 12 bytes of
+  # the digest.
+  class MD5_96 < MD5
+    mac_length 12
+  end
+
+end

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

@@ -0,0 +1,15 @@
+require 'net/ssh/transport/hmac/abstract'
+
+module Net::SSH::Transport::HMAC
+
+  # The "none" algorithm. This has a key and mac length of 0.
+  class None < Abstract
+    key_length 0
+    mac_length 0
+
+    def digest(data)
+      ""
+    end
+  end
+
+end

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

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

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

@@ -0,0 +1,11 @@
+require 'net/ssh/transport/hmac/sha1'
+
+module Net::SSH::Transport::HMAC
+
+  # The SHA1-96 HMAC algorithm. This returns only the first 12 bytes of
+  # the digest.
+  class SHA1_96 < SHA1
+    mac_length 12
+  end
+
+end

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

@@ -0,0 +1,40 @@
+module Net; module SSH; module Transport
+
+  # A cipher that does nothing but pass the data through, unchanged. This
+  # keeps things in the code nice and clean when a cipher has not yet been
+  # determined (i.e., during key exchange).
+  class IdentityCipher
+    class <<self
+      # A default block size of 8 is required by the SSH2 protocol.
+      def block_size
+        8
+      end
+
+      # Does nothing. Returns self.
+      def encrypt
+        self
+      end
+
+      # Does nothing. Returns self.
+      def decrypt
+        self
+      end
+
+      # Passes its single argument through unchanged.
+      def update(text)
+        text
+      end
+
+      # Returns the empty string.
+      def final
+        ""
+      end
+
+      # The name of this cipher, which is "identity".
+      def name
+        "identity"
+      end
+    end
+  end
+
+end; end; end

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

@@ -0,0 +1,13 @@
+require 'net/ssh/transport/kex/diffie_hellman_group1_sha1'
+require 'net/ssh/transport/kex/diffie_hellman_group_exchange_sha1'
+
+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-group-exchange-sha1' => DiffieHellmanGroupExchangeSHA1,
+      'diffie-hellman-group1-sha1'         => DiffieHellmanGroup1SHA1
+    }
+  end
+end

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

@@ -0,0 +1,208 @@
+require 'net/ssh/buffer'
+require 'net/ssh/errors'
+require 'net/ssh/loggable'
+require 'net/ssh/transport/openssl'
+require 'net/ssh/transport/constants'
+
+module Net; module SSH; module Transport; module Kex
+
+  # A key-exchange service implementing the "diffie-hellman-group1-sha1"
+  # key-exchange algorithm.
+  class DiffieHellmanGroup1SHA1
+    include Constants, Loggable
+
+    # The value of 'P', as a string, in hexadecimal
+    P_s = "FFFFFFFF" "FFFFFFFF" "C90FDAA2" "2168C234" +
+          "C4C6628B" "80DC1CD1" "29024E08" "8A67CC74" +
+          "020BBEA6" "3B139B22" "514A0879" "8E3404DD" +
+          "EF9519B3" "CD3A431B" "302B0A6D" "F25F1437" +
+          "4FE1356D" "6D51C245" "E485B576" "625E7EC6" +
+          "F44C42E9" "A637ED6B" "0BFF5CB6" "F406B7ED" +
+          "EE386BFB" "5A899FA5" "AE9F2411" "7C4B1FE6" +
+          "49286651" "ECE65381" "FFFFFFFF" "FFFFFFFF"
+
+    # The radix in which P_s represents the value of P
+    P_r = 16
+
+    # 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 = OpenSSL::BN.new(P_s, P_r)
+      @g = 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 }
+    end
+
+    private
+    
+      # Returns the DH key parameters for the current connection.
+      def get_parameters
+        [p, g]
+      end
+
+      # Returns the INIT/REPLY constants used by this algorithm.
+      def get_message_types
+        [KEXDH_INIT, KEXDH_REPLY]
+      end
+
+      # Build the signature buffer to use when verifying a signature from
+      # the server.
+      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]
+        response.write_bignum dh.pub_key,
+                              result[:server_dh_pubkey],
+                              result[:shared_secret]
+        response
+      end
+
+      # Generate a DH key with a private key consisting of the given
+      # number of bytes.
+      def generate_key #:nodoc:
+        dh = OpenSSL::PKey::DH.new
+
+        dh.p, dh.g = get_parameters
+        dh.priv_key = OpenSSL::BN.rand(data[:need_bytes] * 8)
+
+        dh.generate_key! until dh.valid?
+
+        dh
+      end
+
+      # Send the KEXDH_INIT message, and expect the KEXDH_REPLY. Return the
+      # resulting buffer.
+      #
+      # Parse the buffer from a KEXDH_REPLY message, returning a hash of
+      # the extracted values.
+      def send_kexinit #:nodoc:
+        init, reply = get_message_types
+
+        # send the KEXDH_INIT message
+        buffer = Net::SSH::Buffer.from(:byte, init, :bignum, dh.pub_key)
+        connection.send_message(buffer)
+
+        # expect the KEXDH_REPLY message
+        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_dh_pubkey] = buffer.read_bignum
+        result[:shared_secret] = OpenSSL::BN.new(dh.compute_key(result[:server_dh_pubkey]), 2)
+
+        sig_buffer = Net::SSH::Buffer.new(buffer.read_string)
+        sig_type = sig_buffer.read_string
+        if sig_type != algorithms.host_key
+          raise Net::SSH::Exception,
+            "host key algorithm mismatch for signature " +
+            "'#{sig_type}' != '#{algorithms.host_key}'"
+        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)
+
+        unless connection.host_key_verifier.verify(:key => key, :key_blob => blob, :fingerprint => fingerprint, :session => connection)
+          raise Net::SSH::Exception, "host key verification failed"
+        end
+      end
+
+      def generate_key_fingerprint(key)
+        blob = Net::SSH::Buffer.from(:key, key).to_s
+        fingerprint = OpenSSL::Digest::MD5.hexdigest(blob).scan(/../).join(":")
+
+        [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)
+
+        unless result[:server_key].ssh_do_verify(result[:server_sig], hash)
+          raise Net::SSH::Exception, "could not verify server signature"
+        end
+
+        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; end