ruby_smb 0.0.18 → 0.0.19

data/lib/ruby_smb/smb1/oplock_levels.rb

@@ -3,8 +3,7 @@ module RubySMB
     # This module holds the OPLock Levels used in NT_TRANSACT_CREATE and
     # SMB_COM_NT_CREATE_ANDX responses. The definitions for these values can be found at
     # [2.2.7.1.2 Response](https://msdn.microsoft.com/en-us/library/ee441961.aspx)
-    module CreateActions
-
+    module OplockLevels
       # No OpLock Granted
       NO_OPLOCK         = 0x00
       # Exclusive OpLock Granted
@@ -13,7 +12,6 @@ module RubySMB
       BATCH_OPLOCK      = 0x02
       # Level 2 OpLock Granted
       LEVEL2_OPLOCK     = 0x03
-
     end
   end
-end
+end

data/lib/ruby_smb/smb1/packet.rb

@@ -1,5 +1,7 @@
 module RubySMB
   module SMB1
+    # Namespace for all SMB1 packet definitions
+    # see [2.2 Message Syntax](https://msdn.microsoft.com/en-us/library/ee441466.aspx)
     module Packet
       require 'ruby_smb/smb1/packet/empty_packet'
       require 'ruby_smb/smb1/packet/negotiate_request'
@@ -19,6 +21,14 @@ module RubySMB
       require 'ruby_smb/smb1/packet/echo_response'
       require 'ruby_smb/smb1/packet/trans2'
       require 'ruby_smb/smb1/packet/nt_trans'
+      require 'ruby_smb/smb1/packet/nt_create_andx_request'
+      require 'ruby_smb/smb1/packet/nt_create_andx_response'
+      require 'ruby_smb/smb1/packet/read_andx_request'
+      require 'ruby_smb/smb1/packet/read_andx_response'
+      require 'ruby_smb/smb1/packet/write_andx_request'
+      require 'ruby_smb/smb1/packet/write_andx_response'
+      require 'ruby_smb/smb1/packet/close_request'
+      require 'ruby_smb/smb1/packet/close_response'
     end
   end
 end

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

@@ -0,0 +1,31 @@
+module RubySMB
+  module SMB1
+    module Packet
+      # A SMB1 SMB_COM_CLOSE Request Packet as defined in
+      # [2.2.4.5.1 Request](https://msdn.microsoft.com/en-us/library/ee442151.aspx)
+      class CloseRequest < RubySMB::GenericPacket
+        # A SMB1 Parameter Block as defined by the {CloseRequest}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          endian  :little
+
+          uint16  :fid,                label: 'FID'
+          uint32  :last_time_modified, label: 'Last Time Modified', initial_value: 0xFFFFFFFF
+        end
+
+        # Represents the specific layout of the DataBlock for a {CloseRequest} Packet.
+        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_CLOSE
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module RubySMB
+  module SMB1
+    module Packet
+      # A SMB1 SMB_COM_CLOSE Response Packet as defined in
+      # [2.2.4.5.2 Response](https://msdn.microsoft.com/en-us/library/ee441667.aspx)
+      class CloseResponse < RubySMB::GenericPacket
+        # A SMB1 Parameter Block as defined by the {CloseResponse}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+        end
+
+        # Represents the specific layout of the DataBlock for a {CloseResponse} Packet.
+        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_CLOSE
+          smb_header.flags.reply = 1
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,18 +1,17 @@
 module RubySMB
   module SMB1
     module Packet
-
       # This class represents an SMB1 Echo Request Packet as defined in
       # [2.2.4.39.1 Request](https://msdn.microsoft.com/en-us/library/ee441746.aspx)
       class EchoRequest < RubySMB::GenericPacket
-
-
+        # The {RubySMB::SMB1::ParameterBlock} specific to this packet type.
         class ParameterBlock < RubySMB::SMB1::ParameterBlock
-          uint16  :echo_count,  label: 'Echo Count',  initial_value: 1
+          uint16 :echo_count, label: 'Echo Count', initial_value: 1
         end
 
+        # The {RubySMB::SMB1::DataBlock} specific to this packet type.
         class DataBlock < RubySMB::SMB1::DataBlock
-          string  :data,  label: 'Data'
+          string :data, label: 'Data'
         end
 
         smb_header        :smb_header
@@ -23,8 +22,7 @@ module RubySMB
           super
           smb_header.command = RubySMB::SMB1::Commands::SMB_COM_ECHO
         end
-
       end
     end
   end
-end
+end

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

@@ -1,18 +1,17 @@
 module RubySMB
   module SMB1
     module Packet
-
       # This class represents an SMB1 Echo Request Packet as defined in
       # [2.2.4.39.2 Response](https://msdn.microsoft.com/en-us/library/ee441626.aspx)
       class EchoResponse < RubySMB::GenericPacket
-
-
+        # The {RubySMB::SMB1::ParameterBlock} specific to this packet type.
         class ParameterBlock < RubySMB::SMB1::ParameterBlock
-          uint16  :sequence_number,  label: 'Sequence Number'
+          uint16 :sequence_number, label: 'Sequence Number'
         end
 
+        # The {RubySMB::SMB1::DataBlock} specific to this packet type.
         class DataBlock < RubySMB::SMB1::DataBlock
-          string  :data,  label: 'Data'
+          string :data, label: 'Data'
         end
 
         smb_header        :smb_header
@@ -24,8 +23,7 @@ module RubySMB
           smb_header.command = RubySMB::SMB1::Commands::SMB_COM_ECHO
           smb_header.flags.reply = 1
         end
-
       end
     end
   end
-end
+end

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

@@ -1,7 +1,6 @@
 module RubySMB
   module SMB1
     module Packet
-
       # This packet represent an SMB1 Response Packet when the parameter and
       # data blocks will be empty.
       class EmptyPacket < RubySMB::GenericPacket
@@ -11,4 +10,4 @@ module RubySMB
       end
     end
   end
-end
+end

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

@@ -1,11 +1,9 @@
 module RubySMB
   module SMB1
     module Packet
-
       # This class represents an SMB1 LOGOFF Request Packet as defined in
       # [2.2.4.54.1 Request](https://msdn.microsoft.com/en-us/library/ee442167.aspx)
       class LogoffRequest < RubySMB::GenericPacket
-
         # The Parameter Block for this packet is empty save the Word Count and ANDX Block
         class ParameterBlock < RubySMB::SMB1::ParameterBlock
           and_x_block :andx_block
@@ -23,8 +21,7 @@ module RubySMB
           super
           smb_header.command = RubySMB::SMB1::Commands::SMB_COM_LOGOFF
         end
-
       end
     end
   end
-end
+end

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

@@ -1,11 +1,9 @@
 module RubySMB
   module SMB1
     module Packet
-
       # This class represents an SMB1 LOGOFF Response Packet as defined in
       # [2.2.4.54.2 Response](https://msdn.microsoft.com/en-us/library/ee441488.aspx)
       class LogoffResponse < RubySMB::GenericPacket
-
         # The Parameter Block for this packet is empty save the Word Count and ANDX Block
         class ParameterBlock < RubySMB::SMB1::ParameterBlock
           and_x_block :andx_block
@@ -24,8 +22,7 @@ module RubySMB
           smb_header.command = RubySMB::SMB1::Commands::SMB_COM_LOGOFF
           smb_header.flags.reply = 1
         end
-
       end
     end
   end
-end
+end

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

@@ -40,6 +40,28 @@ module RubySMB
         def valid?
           smb_header.command == RubySMB::SMB1::Commands::SMB_COM_NEGOTIATE
         end
+
+        # Stores the list of {RubySMB::SMB1::Dialect} that were sent to the
+        # peer/server in the related Negotiate Request. This will be used by
+        # the {#negotiated_dialect} method.
+        #
+        # @param dialects [Array] array of {RubySMB::SMB1::Dialect}
+        # @return dialects [Array] array of {RubySMB::SMB1::Dialect}
+        # @raise [ArgumentError] if dialects is not an array of {RubySMB::SMB1::Dialect}
+        def dialects=(dialects)
+          unless dialects.all? { |dialect| dialect.is_a? Dialect }
+            raise ArgumentError, 'Dialects must be an array of Dialect objects'
+          end
+          @dialects = dialects
+        end
+
+        # Returns the negotiated dialect identifier
+        #
+        # @return [String] the negotiated dialect identifier or an empty string if the list of {RubySMB::SMB1::Dialect} was not provided.
+        def negotiated_dialect
+          return '' if @dialects.nil? || @dialects.empty?
+          @dialects[parameter_block.dialect_index].dialect_string
+        end
       end
     end
   end

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

@@ -41,6 +41,28 @@ module RubySMB
           return false unless parameter_block.capabilities.extended_security == 1
           true
         end
+
+        # Stores the list of {RubySMB::SMB1::Dialect} that were sent to the
+        # peer/server in the related Negotiate Request. This will be used by
+        # the {#negotiated_dialect} method.
+        #
+        # @param dialects [Array] array of {RubySMB::SMB1::Dialect}
+        # @return dialects [Array] array of {RubySMB::SMB1::Dialect}
+        # @raise [ArgumentError] if dialects is not an array of {RubySMB::SMB1::Dialect}
+        def dialects=(dialects)
+          unless dialects.all? { |dialect| dialect.is_a? Dialect }
+            raise ArgumentError, 'Dialects must be an array of Dialect objects'
+          end
+          @dialects = dialects
+        end
+
+        # Returns the negotiated dialect identifier
+        #
+        # @return [String] the negotiated dialect identifier or an empty string if the list of {RubySMB::SMB1::Dialect} was not provided.
+        def negotiated_dialect
+          return '' if @dialects.nil? || @dialects.empty?
+          @dialects[parameter_block.dialect_index].dialect_string
+        end
       end
     end
   end

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

@@ -0,0 +1,62 @@
+module RubySMB
+  module SMB1
+    module Packet
+      # A SMB1 SMB_COM_NT_CREATE_ANDX Request Packet as defined in
+      # [2.2.4.64.1 Request](https://msdn.microsoft.com/en-us/library/ee442175.aspx) and
+      # [2.2.4.9.1 Client Request Extensions](https://msdn.microsoft.com/en-us/library/cc246332.aspx)
+      class NtCreateAndxRequest < RubySMB::GenericPacket
+        # A SMB1 Parameter Block as defined by the {NtCreateAndxRequest}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          endian :little
+          and_x_block                        :andx_block
+          uint8                              :reserved,            label: 'Reserved'
+          uint16                             :name_length,         label: 'Name Length(bytes)', value: -> { parent.data_block.file_name.length }
+
+          struct :flags, label: 'Flags' do
+            bit3    :reserved,                   label: 'Reserved Space'
+            bit1    :request_extended_response,  label: 'Request Extended Response'
+            bit1    :open_target_dir,            label: 'Open Target Directory'
+            bit1    :request_opbatch,            label: 'Request Batch OpLock'
+            bit1    :request_oplock,             label: 'Request OpLock'
+            bit1    :reserved2,                  label: 'Reserved Space'
+            # Byte boundary
+            bit8    :reserved3,                  label: 'Reserved Space'
+            bit8    :reserved4,                  label: 'Reserved Space'
+            bit8    :reserved5,                  label: 'Reserved Space'
+          end
+
+          uint32                             :root_directory_fid, label: 'Root Directory FID'
+
+          choice :desired_access, selection: -> { ext_file_attributes.directory } do
+            file_access_mask      0, label: 'Desired Access'
+            directory_access_mask 1, label: 'Desired Access'
+          end
+
+          uint64                             :allocation_size,     label: 'Allocation Size'
+          smb_ext_file_attributes            :ext_file_attributes, label: 'Extented File Attributes'
+          share_access                       :share_access,        label: 'Share Access'
+          # The following constants are defined in RubySMB::Dispositions
+          uint32                             :create_disposition,  label: 'Create Disposition'
+          create_options                     :create_options,      label: 'Create Options'
+          # The following constants are defined in RubySMB::ImpersonationLevels
+          uint32                             :impersonation_level, label: 'Impersonation Level'
+          security_flags                     :security_flags,      label: 'Security Flags'
+        end
+
+        # Represents the specific layout of the DataBlock for a {NtCreateAndxRequest} Packet.
+        class DataBlock < RubySMB::SMB1::DataBlock
+          string :file_name, label: 'File Name'
+        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_NT_CREATE_ANDX
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+module RubySMB
+  module SMB1
+    module Packet
+      # A SMB1 SMB_COM_NT_CREATE_ANDX Response Packet as defined in
+      # [2.2.4.64.2 Response](https://msdn.microsoft.com/en-us/library/ee441612.aspx) and
+      # [2.2.4.9.2 Server Response Extensions](https://msdn.microsoft.com/en-us/library/cc246334.aspx)
+      class NtCreateAndxResponse < RubySMB::GenericPacket
+        # A SMB1 Parameter Block as defined by the {NtCreateAndxResponse}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          endian :little
+
+          and_x_block             :andx_block
+          # Constants defined in RubySMB::SMB1::OplockLevels
+          uint8                   :oplock_level,        label: 'OpLock Level'
+          uint16                  :fid,                 label: 'FID'
+          # Constants defined in RubySMB::Dispositions
+          uint32                  :create_disposition,  label: 'Create Disposition'
+          file_time               :create_time,         label: 'Create Time'
+          file_time               :last_access_time,    label: 'Last Access Time'
+          file_time               :last_write_time,     label: 'Last Write Time'
+          file_time               :last_change_time,    label: 'Last Change Time'
+          smb_ext_file_attributes :ext_file_attributes, label: 'Extented File Attributes'
+          uint64                  :allocation_size,     label: 'Allocation Size'
+          uint64                  :end_of_file,         label: 'End of File Offset'
+          # Constants defined in RubySMB::SMB1::ResourceType
+          uint16                  :resource_type,       label: 'Resource Type'
+
+          choice :status_flags, selection: -> { resource_type } do
+            smb_nmpipe_status RubySMB::SMB1::ResourceType::BYTE_MODE_PIPE,    label: 'Status Flags'
+            smb_nmpipe_status RubySMB::SMB1::ResourceType::MESSAGE_MODE_PIPE, label: 'Status Flags'
+            file_status_flags RubySMB::SMB1::ResourceType::DISK,              label: 'Status Flags'
+            uint16            :default,                                       label: 'Status Flags'
+          end
+
+          uint8                   :directory,           label: 'Directory'
+          string                  :volume_guid,         label: 'Volume GUID', length: 16
+          uint64                  :file_id,             label: 'File ID'
+
+          choice :maximal_access_rights, selection: -> { ext_file_attributes.directory } do
+            file_access_mask      0, label: 'Maximal Access Rights'
+            directory_access_mask 1, label: 'Maximal Access Rights'
+          end
+
+          choice :guest_maximal_access_rights, selection: -> { ext_file_attributes.directory } do
+            file_access_mask      0, label: 'Guest Maximal Access Rights'
+            directory_access_mask 1, label: 'Guest Maximal Access Rights'
+          end
+        end
+
+        # Represents the specific layout of the DataBlock for a {SessionSetupResponse} Packet.
+        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_NT_CREATE_ANDX
+          smb_header.flags.reply = 1
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,6 @@
 module RubySMB
   module SMB1
     module Packet
-
       # Namespace for the NT Transaction sub-protocol documented in
       # [2.2.4.62 SMB_COM_NT_TRANSACT (0xA0)](https://msdn.microsoft.com/en-us/library/ee441720.aspx)
       module NtTrans
@@ -13,4 +12,4 @@ module RubySMB
       end
     end
   end
-end
+end

data/lib/ruby_smb/smb1/packet/nt_trans/create_request.rb

@@ -2,16 +2,15 @@ module RubySMB
   module SMB1
     module Packet
       module NtTrans
-
         # Class representing a generic NT Transaction request packet as defined in
         # [2.2.4.62.1 Request](https://msdn.microsoft.com/en-us/library/ee441534.aspx)
         class CreateRequest < RubySMB::GenericPacket
-
           class ParameterBlock < RubySMB::SMB1::Packet::NtTrans::Request::ParameterBlock
           end
 
+          # The Trans2 Parameter Block for this particular Subcommand
           class Trans2Parameters < BinData::Record
-            endian  :little
+            endian :little
 
             struct :flags do
               bit4  :reserved
@@ -25,15 +24,20 @@ module RubySMB
               bit8  :reserved5,       label: 'Reserved Space'
             end
 
-            uint32                  :root_directory_fid,          label: 'Root Directory FID'
-            file_access_mask        :desired_access
-            uint64                  :allocation_size,             label: 'Allocation Size'
+            uint32                  :root_directory_fid, label: 'Root Directory FID'
+
+            choice :desired_access, selection: -> { ext_file_attribute.directory } do
+              file_access_mask      0, label: 'Desired Access'
+              directory_access_mask 1, label: 'Desired Access'
+            end
+
+            uint64                  :allocation_size, label: 'Allocation Size'
             smb_ext_file_attributes :ext_file_attribute
             share_access            :share_access,                label: 'Share Access'
             uint32                  :create_disposition,          label: 'Create Disposition'
             create_options          :create_options
-            uint32                  :security_descriptor_length,  label: 'Security Descriptor Length',  initial_value: lambda { self.parent.trans2_data.security_descriptor.length }
-            uint32                  :ea_length,                   label: 'Extended Attributes Length',  initial_value: lambda { self.parent.trans2_data.extended_attributes.length }
+            uint32                  :security_descriptor_length,  label: 'Security Descriptor Length',  initial_value: -> { parent.trans2_data.security_descriptor.length }
+            uint32                  :ea_length,                   label: 'Extended Attributes Length',  initial_value: -> { parent.trans2_data.extended_attributes.length }
             uint32                  :impersonation_level,         label: 'Impersonation Level'
 
             struct :security_flags do
@@ -47,10 +51,11 @@ module RubySMB
             # Returns the length of the Trans2Parameters struct
             # in number of bytes
             def length
-              self.do_num_bytes
+              do_num_bytes
             end
           end
 
+          # The Trans2 Data Blcok for this particular Subcommand
           class Trans2Data < BinData::Record
             security_descriptor :security_descriptor
             file_full_ea_info   :extended_attributes
@@ -58,14 +63,15 @@ module RubySMB
             # Returns the length of the Trans2Data struct
             # in number of bytes
             def length
-              self.do_num_bytes
+              do_num_bytes
             end
           end
 
+          # The {RubySMB::SMB1::DataBlock} specific to this packet type.
           class DataBlock < RubySMB::SMB1::Packet::Trans2::DataBlock
-            string            :pad1,               length: lambda { pad1_length }
+            string            :pad1,               length: -> { pad1_length }
             trans2_parameters :trans2_parameters,  label: 'Trans2 Parameters'
-            string            :pad2,               length: lambda { pad2_length }
+            string            :pad2,               length: -> { pad2_length }
             trans2_data       :trans2_data,        label: 'Trans2 Data'
           end
 
@@ -82,4 +88,4 @@ module RubySMB
       end
     end
   end
-end
+end