net-ssh 0.5.0

data/lib/net/ssh/transport/compress/compressor.rb

@@ -0,0 +1,53 @@
+#--
+# =============================================================================
+# 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 Compress
+
+        # The ancestor class of all compression implementations.
+        class Compressor
+
+          # Return a new instance just like the current instance, but
+          # reconfigured with the given options.
+          def new( options={} )
+            obj = dup
+            obj.configure( options )
+            return obj
+          end
+
+          # Reconfigure the current instance with the given options (which
+          # should be a Hash-like). Subclasses may override this method to
+          # implement the desired functionality.
+          def configure( options )
+          end
+
+          # Raises NotImplementedError. Subclasses must override this
+          # method to implement the desired compression functionality.
+          def compress( text )
+            raise NotImplementedError,
+              "subclasses must implement the 'compress' method"
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/transport/compress/decompressor.rb

@@ -0,0 +1,53 @@
+#--
+# =============================================================================
+# 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 Compress
+
+        # The ancestor class of all decompression implementations.
+        class Decompressor
+
+          # Return a new instance just like the current instance, but
+          # reconfigured with the given options.
+          def new( options={} )
+            obj = dup
+            obj.configure( options )
+            return obj
+          end
+
+          # Reconfigure the current instance with the given options (which
+          # should be a Hash-like). Subclasses may override this method to
+          # implement the desired functionality.
+          def configure( options )
+          end
+
+          # Raises NotImplementedError. Subclasses must override this
+          # method to implement the desired decompression functionality.
+          def decompress( text )
+            raise NotImplementedError,
+              "subclasses must implement the 'decompress' method"
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/transport/compress/none-compressor.rb

@@ -0,0 +1,39 @@
+#--
+# =============================================================================
+# 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/compress/compressor'
+
+module Net
+  module SSH
+    module Transport
+
+      module Compress
+
+        # The "none" compression algorithm.
+        class NoneCompressor < Compressor
+
+          # Simply returns the argument, unaltered.
+          def compress( text )
+            text
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/transport/compress/none-decompressor.rb

@@ -0,0 +1,39 @@
+#--
+# =============================================================================
+# 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/compress/decompressor'
+
+module Net
+  module SSH
+    module Transport
+
+      module Compress
+
+        # The "none" decompression algorithm.
+        class NoneDecompressor < Decompressor
+
+          # Simply returns the argument, unaltered.
+          def decompress( text )
+            text
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/transport/compress/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 Compress
+
+        # Register all services that manage the compression and decompression
+        # of data.
+        def register_services( parent )
+
+          # These services all go in their own namespace.
+          parent.namespace_define :compress do |b|
+            b.zlib_compressor do
+              require 'net/ssh/transport/compress/zlib-compressor'
+              ZLibCompressor.new
+            end
+
+            b.none_compressor do
+              require 'net/ssh/transport/compress/none-compressor'
+              NoneCompressor.new
+            end
+
+            b.zlib_decompressor do
+              require 'net/ssh/transport/compress/zlib-decompressor'
+              ZLibDecompressor.new
+            end
+
+            b.none_decompressor do
+              require 'net/ssh/transport/compress/none-decompressor'
+              NoneDecompressor.new
+            end
+
+            # Add the compressor services to the hash of available
+            # compression algorithms.
+            b.compression_algorithms.update(
+              "zlib" => b.zlib_compressor,
+              "none" => b.none_compressor
+            )
+
+            # Add the decompressor services to the hash of available
+            # decompression algorithms.
+            b.decompression_algorithms.update(
+              "zlib" => b.zlib_decompressor,
+              "none" => b.none_decompressor
+            )
+          end
+        end
+        module_function :register_services
+
+      end
+    end
+  end
+end

data/lib/net/ssh/transport/compress/zlib-compressor.rb

@@ -0,0 +1,60 @@
+#--
+# =============================================================================
+# 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 'zlib'
+require 'net/ssh/transport/compress/compressor'
+
+module Net
+  module SSH
+    module Transport
+
+      module Compress
+
+        # The "zlib" compression algorithm.
+        class ZLibCompressor < Compressor
+
+          # Creates a new ZLibCompressor instance using the default
+          # configuration options.
+          def initialize
+            init_deflater( Zlib::DEFAULT_COMPRESSION )
+          end
+
+          # Reconfigures this instance with the given Hash of options. The only
+          # supported option is <tt>:level</tt>, which must be one of the Zlib
+          # constants.
+          def configure( options )
+            init_deflater( options[:level] ) if options.has_key?(:level)
+          end
+
+          # Deflates the text using the Zlib deflate interface.
+          def compress( text )
+            @deflater.deflate( text, Zlib::SYNC_FLUSH )
+          end
+
+          # Reinitializes the internal deflater, using the given compression
+          # level.
+          def init_deflater( level )
+            @deflater = Zlib::Deflate.new( level )
+          end
+          private :init_deflater
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/transport/compress/zlib-decompressor.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 'zlib'
+require 'net/ssh/transport/compress/decompressor'
+
+module Net
+  module SSH
+    module Transport
+
+      module Compress
+
+        # The "zlib" decompression algorithm.
+        class ZLibDecompressor < Decompressor
+
+          # Creates a new ZLibDecompressor.
+          def initialize
+            init_inflater
+          end
+
+          # Decompresses the text using the "inflate" Zlib algorithm.
+          def decompress( text )
+            @inflater.inflate( text )
+          end
+
+          # Reinitializes the internal inflater using the default number of
+          # window bits.
+          def init_inflater
+            @inflater = Zlib::Inflate.new( nil )
+          end
+          private :init_inflater
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+#--
+# =============================================================================
+# 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 Constants
+
+        # Transport layer generic messages
+
+        DISCONNECT                = 1
+        IGNORE                    = 2
+        UNIMPLEMENTED             = 3
+        DEBUG                     = 4
+        SERVICE_REQUEST           = 5
+        SERVICE_ACCEPT            = 6
+
+        # Algorithm negotiation messages
+
+        KEXINIT                   = 20
+        NEWKEYS                   = 21
+
+        # 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

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

@@ -0,0 +1,47 @@
+#--
+# =============================================================================
+# 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/errors'
+
+module Net
+  module SSH
+    module Transport
+
+      # The parent class of all exceptions raised in the transport layer of
+      # the Net::SSH module.
+      class Exception < Net::SSH::Exception; end
+
+      # Raised when the implementation for a requested cipher algorithm could
+      # not be found.
+      class CipherNotFound < Exception; end
+
+      # Raised when the implementation for a requested HMAC algorithm could not
+      # be found.
+      class HMACAlgorithmNotFound < Exception; end
+
+      # Raised when the implementation for a requested Key could not be found.
+      class KeyTypeNotFound < Exception; end
+
+      # Raised when the implementation for a requested Digest could not be
+      # found.
+      class DigestTypeNotFound < Exception; end
+
+      # Raised when the server unexpectedly disconnects.
+      class Disconnect < Exception; end
+
+    end
+  end
+end