net-ssh 0.5.0

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

@@ -0,0 +1,46 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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
+# =============================================================================
+#++
+
+require 'net/ssh/transport/ossl/hmac/hmac'
+require 'openssl'
+
+module Net
+  module SSH
+    module Transport
+      module OSSL
+
+        module HMAC
+
+          # The MD5 HMAC algorithm.
+          class MD5 < Abstract
+
+            # Create a new instance of the MD5 algorithm. This has a mac
+            # length of 16 and a key length of 16, and uses the MD5 digest to
+            # create the HMAC digest.
+            def initialize
+              @mac_length = 16
+              @digest_class = OpenSSL::Digest::MD5
+              @key_length = 16
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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
+# =============================================================================
+#++
+
+require 'net/ssh/transport/ossl/hmac/hmac'
+
+module Net
+  module SSH
+    module Transport
+      module OSSL
+
+        module HMAC
+
+          # The "none" algorithm. This has a key and mac length of 0.
+          class None < Abstract
+
+            # Create a new instance of the None HMAC algorithm.
+            def initialize
+              @key_length = @mac_length = 0
+            end
+
+            # Always returns the empty string.
+            def digest( data )
+              ""
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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 OSSL
+        module HMAC
+
+          # Register all services that implement the various support
+          # HMAC algorithms.
+          def register_services( container )
+            container.namespace_define :hmac do |space|
+
+              # Register each supported HMAC algorithm.
+              %w{sha1 sha1-96 md5 md5-96}.each do |name|
+                space.__send__( name.sub(/-/, "_").intern ) do
+                  require "net/ssh/transport/ossl/hmac/#{name}"
+                  const_get( name.upcase.sub(/-/, "_").intern ).new
+                end
+              end
+
+              # The :none service is trivial--simply doing as much of nothing
+              # as possible. This is for consistency in how HMAC's are handled,
+              # since it is possible to not have an HMAC for part of the
+              # communication cycle.
+              space.none do
+                require "net/ssh/transport/ossl/hmac/none"
+                None.new
+              end
+
+              # Add the implementations to a hash, naming them according to the
+              # SSH2 specification.
+              space.collection do |c,|
+                Hash[ "hmac-sha1"    => c.sha1,
+                      "hmac-sha1-96" => c.sha1_96,
+                      "hmac-md5"     => c.md5,
+                      "hmac-md5-96"  => c.md5_96,
+                      "none"         => c.none ]
+              end
+
+              # Add the collection of algorithms to the list of known HMAC
+              # algorithm sources.
+              if space.knows_key?( :hmac_algorithm_sources )
+                space.hmac_algorithm_sources << space.collection
+              end
+            end
+          end
+          module_function :register_services
+
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/transport/ossl/hmac/sha1-96.rb

@@ -0,0 +1,44 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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
+# =============================================================================
+#++
+
+require 'net/ssh/transport/ossl/hmac/sha1'
+require 'openssl'
+
+module Net
+  module SSH
+    module Transport
+      module OSSL
+
+        module HMAC
+
+          # The SHA1-96 HMAC algorithm. This returns only the first 12 bytes of
+          # the digest.
+          class SHA1_96 < SHA1
+
+            # Create a new instance of the SHA1-96 algorithm.
+            def initialize
+              super
+              @mac_length = 12
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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
+# =============================================================================
+#++
+
+require 'net/ssh/transport/ossl/hmac/hmac'
+require 'openssl'
+
+module Net
+  module SSH
+    module Transport
+      module OSSL
+
+        module HMAC
+
+          # The SHA1 HMAC algorithm. This has a mac and key length of 20, and
+          # uses the SHA1 digest algorithm.
+          class SHA1 < Abstract
+
+            # Create a new instance of the SHA1 HMAC algorithm.
+            def initialize
+              @mac_length = 20
+              @digest_class = OpenSSL::Digest::SHA1
+              @key_length = 20
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/net/ssh/transport/ossl/key-factory.rb

@@ -0,0 +1,113 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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
+# =============================================================================
+#++
+
+require 'base64'
+require 'net/ssh/transport/errors'
+require 'net/ssh/util/openssl'
+
+module Net
+  module SSH
+    module Transport
+
+      module OSSL
+
+        # A factory class for returning new Key algorithm factories (actually
+        # classes).
+        class KeyFactory
+
+          # The setter for the buffer factory to use.
+          attr_writer :buffers
+
+          # The setter for describing which prompter service to use when
+          # prompting the user for a key passphrase.
+          attr_writer :prompter
+
+          # Create a new instance of the KeyFactory that uses the given
+          # Hash-like to map SSH2 key algorithm names to names of
+          # factories (classes) that can instantiate those algorithms.
+          def initialize( algorithms )
+            @factories = algorithms
+          end
+
+          # Return a new instance of the key factory for the given name.
+          # If no such algorithm exists, a KeyTypeNotFound error will be raised.
+          def get( name )
+            klass_name = @factories.fetch( name ) do
+              raise KeyTypeNotFound, name
+            end
+
+            return klass_name.new
+          end
+
+          # Loads a private key from a file. It will correctly determine
+          # whether the file describes an RSA or DSA key, and will load it
+          # appropriately. The new key is returned. If the key itself is
+          # encrypted (requiring a passphrase to use), the user will be
+          # prompted to enter their password. 
+          def load_private_key( filename )
+            file = File.read( filename )
+
+            if file.match( /-----BEGIN DSA PRIVATE KEY-----/ )
+              key_type = OpenSSL::PKey::DSA
+            elsif file.match( /-----BEGIN RSA PRIVATE KEY-----/ )
+              key_type = OpenSSL::PKey::RSA
+            elsif file.match( /-----BEGIN (.*) PRIVATE KEY-----/ )
+              raise OpenSSL::PKey::PKeyError, "not a supported key type '#{$1}'"
+            else
+              raise OpenSSL::PKey::PKeyError, "not a private key (#{filename})"
+            end
+
+            encrypted_key = file.match( /ENCRYPTED/ )
+            password = encrypted_key ? 'nil' : nil
+            tries = 0
+
+            begin
+              return key_type.new( file, password )
+            rescue OpenSSL::PKey::RSAError, OpenSSL::PKey::DSAError => e
+              if encrypted_key && @prompter
+                tries += 1
+                if tries <= 3
+                  password = @prompter.password(
+                    "Enter password for #{filename}: " )
+                  retry
+                else
+                  raise
+                end
+              else
+                raise
+              end
+            end
+          end
+
+          # Loads a public key from a file. It will correctly determine whether
+          # the file describes an RSA or DSA key, and will load it
+          # appropriately. The new public key is returned.
+          def load_public_key( filename )
+            data = File.open( filename ) { |file| file.read }
+            type, blob = data.split( / / )
+
+            blob = Base64.decode64( blob )
+            reader = @buffers.reader( blob )
+            return reader.read_key
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/transport/ossl/services.rb

@@ -0,0 +1,149 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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
+# =============================================================================
+#++
+
+require 'openssl'
+
+module Net
+  module SSH
+    module Transport
+      module OSSL
+
+        # Register all OpenSSL-related services.
+        def register_services( container )
+          # make sure the user has a valid Ruby and OpenSSL installed.
+          version_check
+
+          # Register all OpenSSL services in the :ossl namespace.
+          container.namespace_define :ossl do |b|
+
+            # The list of known sources of HMAC algorithm implementations.
+            b.hmac_algorithm_sources { Array.new }
+            b.require 'net/ssh/transport/ossl/hmac/services', "#{self}::HMAC"
+
+            # The hash mapping SSH2 cipher names to OpenSSL cipher names.
+            b.cipher_names do
+              Hash[ "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",
+                    "none"         => "none" ]
+            end
+
+            # The hash mapping key names to OpenSSL key implementations.
+            b.key_names do
+              Hash[ "dh"  => OpenSSL::PKey::DH,
+                    "rsa" => OpenSSL::PKey::RSA,
+                    "dsa" => OpenSSL::PKey::DSA ]
+            end
+
+            # The hash mapping digest names to OpenSSL digest implementations.
+            b.digest_names do
+              Hash[ "sha1" => OpenSSL::Digest::SHA1,
+                    "md5"  => OpenSSL::Digest::MD5 ]
+            end
+
+            # The factory for converting cipher names to cipher implementations.
+            b.cipher_factory( :model => :singleton_deferred ) do |c,p|
+              require 'net/ssh/transport/ossl/cipher-factory'
+              svc = CipherFactory.new( c.cipher_names )
+              svc.identity_cipher = c.identity_cipher
+              svc
+            end
+
+            # The factory for converting HMAC names to HMAC implementations.
+            b.hmac_factory( :model => :singleton_deferred ) do |c,p|
+              require 'net/ssh/transport/ossl/hmac-factory'
+              HMACFactory.new( c.hmac_algorithm_sources )
+            end
+
+            # The factory for obtaining OpenSSL-specific buffer implementations.
+            b.buffer_factory do
+              require 'net/ssh/transport/ossl/buffer-factory'
+              BufferFactory.new
+            end
+
+            # The factory for converting key names to key implementations.
+            b.key_factory( :model => :singleton_deferred ) do |c,p|
+              require 'net/ssh/transport/ossl/key-factory'
+              svc = KeyFactory.new( c.key_names )
+              svc.buffers = c.buffer_factory
+              svc.prompter = c.prompter if c.knows_key?( :prompter )
+              svc
+            end
+
+            # The factory for creating OpenSSL::BN (big number) instances.
+            b.bn_factory { OpenSSL::BN }
+
+            # The factory for converting digest names to digest implementations.
+            b.digest_factory do |c,p|
+              require 'net/ssh/transport/ossl/digest-factory'
+              DigestFactory.new( c.digest_names )
+            end
+
+          end
+
+          # Register each of the factories defined above in the corresponding
+          # factory map, under the :ossl key.
+          container.define do |b|
+            b.cipher_factories[:ossl] = b.ossl.cipher_factory
+            b.hmac_factories[:ossl]   = b.ossl.hmac_factory
+            b.key_factories[:ossl]    = b.ossl.key_factory
+            b.buffer_factories[:ossl] = b.ossl.buffer_factory
+            b.bn_factories[:ossl]     = b.ossl.bn_factory
+            b.digest_factories[:ossl] = b.ossl.digest_factory
+          end
+        end
+        module_function :register_services
+
+        # Tries to make sure that the correct minimum versions of libraries are
+        # installed.
+        def version_check
+          if RUBY_VERSION < "1.8.2"
+            unless OpenSSL::PKey::DH.instance_methods.include? "p"
+              warn "Your OpenSSL module (the Ruby module, not the library)\n" +
+                   "is too old. Please go to the Net::SSH downloads page\n" +
+                   "and install the most recent snapshot of the OpenSSL\n" +
+                   "module.\n\n" +
+                   "  http://rubyforge.org/projects/net-ssh"
+              abort
+            end
+          end
+
+          # make sure that the OpenSSL library itself is at least version 0.9.7
+          match = OpenSSL::OPENSSL_VERSION.match(
+            /OpenSSL (\d+)\.(\d+)\.(\d+)(.*?) / )
+          major = match[1].to_i
+          minor = match[2].to_i
+          tiny = match[3].to_i
+          patch = match[4]
+
+          if major < 1 && ( minor < 9 || minor == 9 && tiny < 7 )
+            ver = "#{major}.#{minor}.#{tiny}#{patch}"
+            warn "Your OpenSSL library (the library itself, not the Ruby\n" +
+                 "module) is version #{ver}, too old to use with Net::SSH.\n" +
+                 "Please upgrade to at least version 0.9.7 and then rebuild\n" +
+                 "your Ruby OpenSSL module."
+            abort
+          end
+        end
+        module_function :version_check
+
+      end
+    end
+  end
+end