net-ssh 0.5.0

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

@@ -0,0 +1,52 @@
+#--
+# =============================================================================
+# 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'
+require 'net/ssh/util/buffer'
+require 'net/ssh/transport/ossl/buffer'
+
+module Net
+  module SSH
+    module Transport
+
+      module OSSL
+
+        # A factory class for returning new buffer instances that have been
+        # decorated to also handle OpenSSL specific information.
+        class BufferFactory
+
+          # Return a new reader buffer that can also read bignums and keys.
+          def reader( text )
+            Net::SSH::Transport::OSSL::ReaderBuffer.new( text )
+          end
+
+          # Return a new writer buffer, initialized with the parameter.
+          def writer( text="" )
+            Net::SSH::Util::WriterBuffer.new( text )
+          end
+
+          # Return a new general buffer that can also read bignums and keys.
+          def buffer( text="" )
+            Net::SSH::Transport::OSSL::Buffer.new( text )
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+#--
+# =============================================================================
+# 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'
+require 'net/ssh/util/buffer'
+
+module Net
+  module SSH
+    module Transport
+
+      module OSSL
+
+        # The implementation of a reader buffer that can read bignums and keys.
+        module ReaderBufferImpl
+
+          # Read a bignum (OpenSSL::BN) from the buffer, in SSH2 format. It is
+          # essentially just a string, which is reinterpreted to be a bignum in
+          # binary format.
+          def read_bignum
+            data = read_string
+            return unless data
+            OpenSSL::BN.new( data, 2 )
+          end
+
+          # Read a key from the buffer. The key will start with a string
+          # describing its type. The remainder of the key is defined by the
+          # type that was read.
+          def read_key
+            type = read_string
+            return ( type ? read_keyblob( type ) : nil )
+          end
+
+          # Read a keyblob of the given type from the buffer, and return it as
+          # a key. Only RSA and DSA keys are supported.
+          def read_keyblob( type )
+            case type
+              when "ssh-dss"
+                key = OpenSSL::PKey::DSA.new
+                key.p = read_bignum
+                key.q = read_bignum
+                key.g = read_bignum
+                key.pub_key = read_bignum
+
+              when "ssh-rsa"
+                key = OpenSSL::PKey::RSA.new
+                key.e = read_bignum
+                key.n = read_bignum
+
+              else
+                raise NotImplementedError, "unsupported key type '#{type}'"
+            end
+
+            return key
+          end
+
+        end
+
+        # An extension of the standard ReaderBuffer implementation that also
+        # includes the ReaderBufferImpl module.
+        class ReaderBuffer < Net::SSH::Util::ReaderBuffer
+          include ReaderBufferImpl
+        end
+
+        # An extension of the standard general Buffer implementation that also
+        # includes the ReaderBufferImpl module.
+        class Buffer < Net::SSH::Util::Buffer
+          include ReaderBufferImpl
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+#--
+# =============================================================================
+# 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'
+require 'net/ssh/transport/errors'
+
+module Net
+  module SSH
+    module Transport
+
+      module OSSL
+
+        # Implements a factory of OpenSSL cipher algorithms.
+        class CipherFactory
+        
+          # The accessor for setting the identity cipher implementation to use.
+          attr_writer :identity_cipher
+
+          # Create a new CipherFactory instance that uses the given Hash-like
+          # to convert SSH2 cipher algorithm names to OpenSSL cipher algorithm
+          # names.
+          def initialize( cipher_map )
+            @cipher_map = cipher_map
+          end
+
+          # 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 get( name,
+                   iv=nil, key=nil,
+                   shared=nil, hash=nil,
+                   digester=nil,
+                   encrypt=false )
+          # begin
+            ossl_name = @cipher_map.fetch( name ) do
+              raise CipherNotFound, name
+            end
+
+            return @identity_cipher if ossl_name == "none"
+
+            cipher = OpenSSL::Cipher::Cipher.new( ossl_name )
+            cipher.send( encrypt ? :encrypt : :decrypt )
+
+            cipher.padding = 0
+            cipher.iv = make_key( cipher.iv_len, iv, shared, hash, digester )
+            cipher.key = make_key( cipher.key_len, key, shared, hash, digester )
+
+            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 get_lengths( name )
+            ossl_name = @cipher_map[ 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
+
+          # Generate a key value in accordance with the SSH2 specification.
+          def make_key( bytes, key, shared, hash, digester )
+            k = key[ 0, bytes ]
+
+            while k.length < bytes
+              step = digester.digest( shared + hash + k )
+              bytes_needed = bytes - k.length
+              k << step[ 0, bytes_needed ]
+            end
+
+            return k
+          end
+          private :make_key
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+#--
+# =============================================================================
+# 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/errors'
+
+module Net
+  module SSH
+    module Transport
+
+      module OSSL
+
+        # Implements a factory of OpenSSL digest algorithms.
+        class DigestFactory
+        
+          # Create a new DigestFactory instance that uses the given Hash-like
+          # to convert SSH2 digest algorithm names to OpenSSL digest algorithm
+          # names.
+          def initialize( digest_map )
+            @digest_map = digest_map
+          end
+
+          # Return a factory that can implement the requested SSH2 digest
+          # algorithm.
+          def get( name )
+            klass = @digest_map.fetch( name ) do
+              raise DigestTypeNotFound, name
+            end
+
+            return klass
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+#--
+# =============================================================================
+# 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'
+require 'net/ssh/transport/errors'
+
+module Net
+  module SSH
+    module Transport
+
+      module OSSL
+
+        # A factory class for returning new HMAC algorithm instances.
+        class HMACFactory
+
+          # Create a new instance of the HMACFactory that uses the given
+          # Hash-like to map SSH2 HMAC algorithm names to instances of
+          # factories that can instantiate those algorithms.
+          def initialize( algorithms )
+            @algorithms = algorithms
+          end
+
+          # Return a new instance of the HMAC algorithm for the given
+          # name. If no such algorithm exists, a HMACAlgorithmNotFound error
+          # will be raised.
+          def get( name, key="" )
+            algo = find_algorithm( name ) or
+              raise HMACAlgorithmNotFound, name
+              
+            return algo.new( key )
+          end
+
+          # Return the key length of the named HMAC algorithm. If no such
+          # algorithm exists, raise HMACAlgorithmNotFound.
+          def get_key_length( name )
+            algo = find_algorithm( name ) or
+              raise HMACAlgorithmNotFound, name
+
+            return algo.key_length
+          end
+
+          # Searches all registered algorithm sets for the one with the
+          # given name. Returns +nil+ if no such algorithm exists.
+          def find_algorithm( name )
+            @algorithms.each do |set|
+              return set[name] if set.has_key?( name )
+            end
+
+            nil
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+#--
+# =============================================================================
+# 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
+
+        module HMAC
+
+          # The base class of all OpenSSL-based HMAC algorithm wrappers.
+          class Abstract
+
+            # The number of bytes in the digest generated by this algorithm.
+            attr_reader :mac_length
+
+            # The digest algorithm to use when computing the HMAC digest.
+            attr_reader :digest_class
+
+            # The number of bytes that this algorithm expects the key to
+            # contain.
+            attr_reader :key_length
+
+            # The key to use for this instance.
+            attr_accessor :key
+
+            # Return a new HMAC algorithm just like the current one, but using
+            # the given key.
+            def new( key )
+              mac = dup
+              mac.key = key[ 0, key_length ]
+              return mac
+            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
+end

data/lib/net/ssh/transport/ossl/hmac/md5-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/md5'
+require 'openssl'
+
+module Net
+  module SSH
+    module Transport
+      module OSSL
+
+        module HMAC
+
+          # The MD5-96 HMAC algorithm. This returns only the first 12 bytes of
+          # the digest.
+          class MD5_96 < MD5
+
+            # Create a new instance of the MD5-96 algorithm.
+            def initialize
+              super
+              @mac_length = 12
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end