ruby_smb 0.0.8 → 0.0.9

data/lib/ruby_smb/smb1/packet/tree_connect_response.rb

@@ -0,0 +1,74 @@
+module RubySMB
+  module SMB1
+    module Packet
+
+      # A SMB1 TreeConnect Response Packet as defined in
+      # [2.2.4.7.2 Server Response Extensions](https://msdn.microsoft.com/en-us/library/cc246331.aspx)
+      class TreeConnectResponse < RubySMB::GenericPacket
+
+        # A SMB1 Parameter Block as defined by the {SessionSetupResponse}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          and_x_block                :andx_block
+          optional_support           :optional_support
+          directory_access_mask      :access_rights,       label: 'Maximal Share Access Rights'
+          directory_access_mask      :guest_access_rights, label: 'Guest Share Access Rights'
+        end
+
+        # Represents the specific layout of the DataBlock for a {SessionSetupResponse} Packet.
+        class DataBlock < RubySMB::SMB1::DataBlock
+          stringz   :service,             label: 'Service Type'
+          stringz   :native_file_system,  label: 'Native File System'
+        end
+
+        smb_header        :smb_header
+        parameter_block   :parameter_block
+        data_block        :data_block
+
+        def initialize_instance
+          super
+          smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TREE_CONNECT
+          smb_header.flags.reply = 1
+        end
+
+        # Returns the ACCESS_MASK for the Maximal Share Access Rights. The packet
+        # defaults this to a {RubySMB::SMB1::BitField::DirectoryAccessMask}. If it is anything other than
+        # a directory that has been connected to, it will re-cast it as a {}RubySMB::SMB1::BitField::FileAccessMask}
+        #
+        # @return [RubySMB::SMB1::BitField::DirectoryAccessMask] if a directory was connected to
+        # @return [RubySMB::SMB1::BitField::FileAccessMask] if anything else was connected to
+        def access_rights
+          if is_directory?
+            self.parameter_block.access_rights
+          else
+            mask = self.parameter_block.access_rights.to_binary_s
+            RubySMB::SMB1::BitField::FileAccessMask.read(mask)
+          end
+        end
+
+        # Returns the ACCESS_MASK for the Guest Share Access Rights. The packet
+        # defaults this to a {RubySMB::SMB1::BitField::DirectoryAccessMask}. If it is anything other than
+        # a directory that has been connected to, it will re-cast it as a {RubySMB::SMB1::BitField::FileAccessMask}
+        #
+        # @return [RubySMB::SMB1::BitField::DirectoryAccessMask] if a directory was connected to
+        # @return [RubySMB::SMB1::BitField::FileAccessMask] if anything else was connected to
+        def guest_access_rights
+          if is_directory?
+            self.parameter_block.guest_access_rights
+          else
+            mask = self.parameter_block.guest_access_rights.to_binary_s
+            RubySMB::SMB1::BitField::FileAccessMask.read(mask)
+          end
+        end
+
+        # Checks whether the response is for a Directory
+        # This alters the type of access mask that is used.
+        #
+        # @return [TrueClass] if service is 'A:'
+        # @return [FalseClass] if service is NOT 'A:'
+        def is_directory?
+          self.data_block.service == 'A:'
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet/tree_disconnect_request.rb

@@ -0,0 +1,29 @@
+module RubySMB
+  module SMB1
+    module Packet
+
+      # This class represents an SMB1 TreeDisonnect Request Packet as defined in
+      # [2.2.4.51.1 Request](https://msdn.microsoft.com/en-us/library/ee441622.aspx)
+      class TreeDisconnectRequest < RubySMB::GenericPacket
+
+        # The Parameter Block for this packet is empty save the Word Count
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+        end
+
+        # The Data Block for this packet is empty save the Byte Count
+        class DataBlock < RubySMB::SMB1::DataBlock
+        end
+
+        smb_header        :smb_header
+        parameter_block   :parameter_block
+        data_block        :data_block
+
+        def initialize_instance
+          super
+          smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TREE_DISCONNECT
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet/tree_disconnect_response.rb

@@ -0,0 +1,30 @@
+module RubySMB
+  module SMB1
+    module Packet
+
+      # This class represents an SMB1 TreeDisonnect Response Packet as defined in
+      # [2.2.4.51.2 Response](https://msdn.microsoft.com/en-us/library/ee441823.aspx)
+      class TreeDisconnectResponse < RubySMB::GenericPacket
+
+        # The Parameter Block for this packet is empty save the Word Count
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+        end
+
+        # The Data Block for this packet is empty save the Byte Count
+        class DataBlock < RubySMB::SMB1::DataBlock
+        end
+
+        smb_header        :smb_header
+        parameter_block   :parameter_block
+        data_block        :data_block
+
+        def initialize_instance
+          super
+          smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TREE_DISCONNECT
+          smb_header.flags.reply = 1
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/tree.rb

@@ -0,0 +1,55 @@
+module RubySMB
+  module SMB1
+
+    # An SMB1 connected remote Tree, as returned by a
+    # [RubySMB::SMB1::Packet::TreeConnectRequest]
+    class Tree
+
+      # The client this Tree is connected through
+      # @!attribute [rw] client
+      #   @return [RubySMB::Client]
+      attr_accessor :client
+
+      # The current Guest Share Permissions
+      # @!attribute [rw] guest_permissions
+      #   @return [RubySMB::SMB1::BitField::DirectoryAccessMask]
+      attr_accessor :guest_permissions
+
+      # The current Maximal Share Permissions
+      # @!attribute [rw] permissions
+      #   @return [RubySMB::SMB1::BitField::DirectoryAccessMask]
+      attr_accessor :permissions
+
+      # The share path associated with this Tree
+      # @!attribute [rw] share
+      #   @return [String]
+      attr_accessor :share
+
+      # The Tree ID for this Tree
+      # @!attribute [rw] id
+      #   @return [Integer]
+      attr_accessor :id
+
+      def initialize(client:, share:, response:)
+        @client             = client
+        @share              = share
+        @id                 = response.smb_header.tid
+        @guest_permissions  = response.parameter_block.guest_access_rights
+        @permissions        = response.parameter_block.access_rights
+      end
+
+      # Disconnects this Tree from the current session
+      #
+      # @return [WindowsError::ErrorCode] the NTStatus sent back by the server.
+      def disconnect!
+        request = RubySMB::SMB1::Packet::TreeDisconnectRequest.new
+        request.smb_header.tid = self.id
+        raw_response = self.client.send_recv(request)
+        response = RubySMB::SMB1::Packet::TreeDisconnectResponse.read(raw_response)
+        response.status_code
+      end
+
+
+    end
+  end
+end

data/lib/ruby_smb/smb2.rb

@@ -9,4 +9,5 @@ module RubySMB::SMB2
   require 'ruby_smb/smb2/bit_field'
   require 'ruby_smb/smb2/smb2_header'
   require 'ruby_smb/smb2/packet'
+  require 'ruby_smb/smb2/tree'
 end

data/lib/ruby_smb/smb2/bit_field.rb

@@ -6,6 +6,10 @@ module RubySMB
       require 'ruby_smb/smb2/bit_field/smb2_security_mode_single'
       require 'ruby_smb/smb2/bit_field/smb2_capabailities'
       require 'ruby_smb/smb2/bit_field/session_flags'
+      require 'ruby_smb/smb2/bit_field/directory_access_mask'
+      require 'ruby_smb/smb2/bit_field/file_access_mask'
+      require 'ruby_smb/smb2/bit_field/share_flags'
+      require 'ruby_smb/smb2/bit_field/share_capabailities'
     end
   end
 end

data/lib/ruby_smb/smb2/bit_field/directory_access_mask.rb

@@ -0,0 +1,38 @@
+module RubySMB
+  module SMB2
+    module BitField
+      # An Access Mask bit field used to describe the permissions on a Directory, as defined in
+      # [2.2.13.1.2 Directory_Access_Mask](https://msdn.microsoft.com/en-us/library/cc246801.aspx)
+      class DirectoryAccessMask < BinData::Record
+        endian  :little
+        bit1    :read_attr,       label: 'Read Attributes'
+        bit1    :delete_child,    label: 'Delete Child'
+        bit1    :traverse,        label: 'Traverse'
+        bit1    :write_ea,        label: 'Write Extended Attributes'
+        bit1    :read_ea,         label: 'Read Extended Attributes'
+        bit1    :add_subdir,      label: 'Add Subdirectory'
+        bit1    :add_file,        label: 'Add File'
+        bit1    :list,            label: 'List Directory'
+        # byte boundary
+        bit7    :reserved,        label: 'Reserved Space'
+        bit1    :write_attr,      label: 'Write Attributes'
+
+        # byte boundary
+        bit3    :reserved2,       label: 'Reserved Space'
+        bit1    :synchronize,     label: 'Synchronize'
+        bit1    :write_owner,     label: 'Write Owner'
+        bit1    :write_dac,       label: 'Write DAC'
+        bit1    :read_control,    label: 'Read Control'
+        bit1    :delete_access,   label: 'Delete'
+        # byte boundary
+        bit1    :generic_read,    label: 'Generic Read'
+        bit1    :generic_write,   label: 'Generic Write'
+        bit1    :generic_execute, label: 'Generic Execute'
+        bit1    :generic_all,     label: 'Generic All'
+        bit2    :reserved3
+        bit1    :maximum,         label: 'Maximum Allowed'
+        bit1    :system_security, label: 'System Security'
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/bit_field/file_access_mask.rb

@@ -0,0 +1,38 @@
+module RubySMB
+  module SMB2
+    module BitField
+      # An Access Mask bit field used to describe the permissions on a File, Printer, or named Pipe. As defined in
+      # [2.2.13.1.1 File_Pipe_Printer_Access_Mask](https://msdn.microsoft.com/en-us/library/cc246802.aspx)
+      class FileAccessMask < BinData::Record
+        endian  :little
+        bit1    :read_attr,       label: 'Read Attributes'
+        bit1    :delete_child,    label: 'Delete Child'
+        bit1    :execute,         label: 'Traverse'
+        bit1    :write_ea,        label: 'Write Extended Attributes'
+        bit1    :read_ea,         label: 'Read Extended Attributes'
+        bit1    :append_data,     label: 'Append Data'
+        bit1    :write_data,      label: 'Write Data'
+        bit1    :read_data,       label: 'Read Data'
+        # byte boundary
+        bit7    :reserved,        label: 'Reserved Space'
+        bit1    :write_attr,      label: 'Write Attributes'
+
+        # byte boundary
+        bit3    :reserved2,       label: 'Reserved Space'
+        bit1    :synchronize,     label: 'Synchronize'
+        bit1    :write_owner,     label: 'Write Owner'
+        bit1    :write_dac,       label: 'Write DAC'
+        bit1    :read_control,    label: 'Read Control'
+        bit1    :delete_access,   label: 'Delete'
+        # byte boundary
+        bit1    :generic_read,    label: 'Generic Read'
+        bit1    :generic_write,   label: 'Generic Write'
+        bit1    :generic_execute, label: 'Generic Execute'
+        bit1    :generic_all,     label: 'Generic All'
+        bit2    :reserved3
+        bit1    :maximum,         label: 'Maximum Allowed'
+        bit1    :system_security, label: 'System Security'
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/bit_field/share_capabailities.rb

@@ -0,0 +1,21 @@
+module RubySMB
+  module SMB2
+    module BitField
+      # Represents a Share Capabilities BitField as defined by
+      # [2.2.10 SMB2 TREE_CONNECT Response](https://msdn.microsoft.com/en-us/library/cc246499.aspx)
+      class ShareCapabilities < BinData::Record
+        endian  :little
+        bit1    :asymmetric,          label: 'Asymmetric'
+        bit1    :cluster,             label: 'Cluster'
+        bit1    :scaleout,            label: 'Scale Out'
+        bit1    :continuous,          label: 'Continuous Availability'
+        bit1    :dfs,                 label: 'DFS'
+        bit3    :reserved2,           label: 'Reserved Space'
+        # byte border
+        uint8   :reserved3,           label: 'Reserved'
+        uint8   :reserved4,           label: 'Reserved'
+        uint8   :reserved5,           label: 'Reserved'
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/bit_field/share_flags.rb

@@ -0,0 +1,75 @@
+module RubySMB
+  module SMB2
+    module BitField
+
+      # A Share Flags BitField Mask as defined in
+      # [2.2.10 SMB2 TREE_CONNECT Response](https://msdn.microsoft.com/en-us/library/cc246499.aspx)
+      class ShareFlags < BinData::Record
+        endian  :little
+        bit2    :reserved1,                 label: 'Reserved Space'
+        bit1    :vdo_caching,               label: 'VDO Caching'
+        bit1    :auto_caching,              label: 'Auto Caching'
+        bit2    :reserved2
+        bit1    :dfs_root,                  label: 'DFS Root'
+        bit1    :dfs,                       label: 'DFS'
+        # byte boundary
+        bit1    :encrypt,                   label: 'Encrypted Data Required'
+        bit1    :hash_v2,                   label: 'Hash Generation V2'
+        bit1    :hash_v1,                   label: 'Hash Generation V1'
+        bit1    :force_oplock,              label: 'Force Lvl2 OpLocks'
+        bit1    :access_based_enum,         label: 'Access Based Directory Enumeration'
+        bit1    :namespace_caching,         label: 'Namespace Caching'
+        bit1    :shared_delete,             label: 'Force Shared Delete'
+        bit1    :restrict_exclusive_opens,  label: 'Restrict Exclusive Opens'
+
+        bit8    :reserved3,                 label: 'Reserved Space'
+        bit8    :reserved4,                 label: 'Reserved Space'
+
+        def caching_type
+          if self.vdo_caching == 1 && self.auto_caching == 0
+            :vdo
+          elsif self.vdo_caching == 0 && self.auto_caching == 1
+            :auto
+          elsif self.vdo_caching == 1 && self.auto_caching == 1
+            :no_caching
+          else
+            :manual
+          end
+        end
+
+        # Sets the Bit Mask for Manual Caching
+        #
+        # @return [void]
+        def set_manual_caching
+          self.vdo_caching  = 0
+          self.auto_caching = 0
+        end
+
+        # Sets the Bit Mask for Auto Caching
+        #
+        # @return [void]
+        def set_auto_caching
+          self.vdo_caching  = 0
+          self.auto_caching = 1
+        end
+
+        # Sets the Bit Mask for VDO Caching
+        #
+        # @return [void]
+        def set_vdo_caching
+          self.vdo_caching  = 1
+          self.auto_caching = 0
+        end
+
+        # Sets the Bit Mask for No Caching
+        #
+        # @return [void]
+        def set_no_caching
+          self.vdo_caching  = 1
+          self.auto_caching = 1
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/packet.rb

@@ -1,10 +1,15 @@
 module RubySMB
   module SMB2
     module Packet
+      require 'ruby_smb/smb2/packet/error_packet'
       require 'ruby_smb/smb2/packet/negotiate_request'
       require 'ruby_smb/smb2/packet/negotiate_response'
       require 'ruby_smb/smb2/packet/session_setup_request'
       require 'ruby_smb/smb2/packet/session_setup_response'
+      require 'ruby_smb/smb2/packet/tree_connect_request'
+      require 'ruby_smb/smb2/packet/tree_connect_response'
+      require 'ruby_smb/smb2/packet/tree_disconnect_request'
+      require 'ruby_smb/smb2/packet/tree_disconnect_response'
     end
   end
 end

data/lib/ruby_smb/smb2/packet/error_packet.rb

@@ -0,0 +1,15 @@
+module RubySMB
+  module SMB2
+    module Packet
+
+      # An SMB2 Error packet for when an incomplete response comes back
+
+      class ErrorPacket < RubySMB::GenericPacket
+        endian       :little
+        smb2_header  :smb2_header
+        uint16       :structure_size, label: 'Structure Size', initial_value: 4
+        uint8        :error_data
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/packet/tree_connect_request.rb

@@ -0,0 +1,27 @@
+module RubySMB
+  module SMB2
+    module Packet
+
+      # An SMB2 TreeConnectRequest Packet as defined in
+      # [2.2.9 SMB2 TREE_CONNECT Request](https://msdn.microsoft.com/en-us/library/cc246567.aspx)
+      class TreeConnectRequest < RubySMB::GenericPacket
+        endian       :little
+        smb2_header  :smb2_header
+        uint16       :structure_size, label: 'Structure Size', initial_value: 9
+        uint16       :flags,          label: 'Flags',          initial_value: 0x00
+        uint16       :path_offset,    label: 'Path Offset',    initial_value: 0x48
+        uint16       :path_length,    label: 'Path Length',    value: lambda { self.path.length }
+        string       :path,           label: 'Path Buffer'
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::TREE_CONNECT
+        end
+
+        def encode_path(path)
+          self.path = path.encode("utf-16le")
+        end
+      end
+    end
+  end
+end