ruby_smb 0.0.18 → 0.0.19

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

@@ -1,12 +1,11 @@
 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
+        # The {RubySMB::SMB1::ParameterBlock} specific to this packet type.
         class ParameterBlock < RubySMB::SMB1::ParameterBlock
         end
 
@@ -23,8 +22,7 @@ module RubySMB
           smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TREE_DISCONNECT
           smb_header.flags.reply = 1
         end
-
       end
     end
   end
-end
+end

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

@@ -0,0 +1,68 @@
+module RubySMB
+  module SMB1
+    module Packet
+      # A SMB1 SMB_COM_WRITE_ANDX Request Packet as defined in
+      # [2.2.4.43.1 Request](https://msdn.microsoft.com/en-us/library/ee441954.aspx)
+      # [2.2.4.3.1 Client Request Extensions](https://msdn.microsoft.com/en-us/library/ff469893.aspx)
+      class WriteAndxRequest < RubySMB::GenericPacket
+        # A SMB1 Parameter Block as defined by the {WriteAndxRequest}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          endian      :little
+
+          and_x_block :andx_block
+          uint16      :fid,                  label: 'FID'
+          uint32      :offset,               label: 'Offset'
+          uint32      :timeout,              label: 'Timeout'
+
+          struct      :write_mode,           label: 'Write Mode' do
+            bit4      :reserved,             label: 'Reserved Space'
+            bit1      :msg_start,            label: 'Message Start'
+            bit1      :raw_mode,             label: 'Raw Mode'
+            bit1      :read_bytes_available, label: 'Read Bytes Available'
+            bit1      :writethrough_mode,    label: 'Writethrough Mode'
+            # byte boundary
+            bit8      :reserved2,            label: 'Reserved Space'
+          end
+
+          uint16      :remaining,            label: 'Remaining'
+          uint16      :data_length_high,     label: 'Data Length High'
+          uint16      :data_length,          label: 'Data Length(bytes)', value: -> { parent.data_block.data.length }
+          uint16      :data_offset,          label: 'Data Offset',        value: -> { parent.data_block.data.abs_offset }
+          uint32      :offset_high,          label: 'Offset High',        onlyif: -> { word_count == 0x0E }
+
+          # Bypass the word count calculation to use 32-bit offset by default.
+          # As a result, the optional offset_high field won't be defined until
+          # #set_64_bit_offset(true) is explicitly called.
+          def calculate_word_count
+            0x0C
+          end
+          private :calculate_word_count
+        end
+
+        # Represents the specific layout of the DataBlock for a {WriteAndxRequest} Packet.
+        class DataBlock < RubySMB::SMB1::DataBlock
+          uint8  :pad,  label: 'Pad'
+          string :data, label: 'Data'
+        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_WRITE_ANDX
+        end
+
+        # Specifies whether the offset is a 32-bit (default) or 64-bit value. When `is_64_bit`
+        # is true, a 64-bit offset will be used and the OffsetHigh field will be added to the structure.
+        #
+        # @param is_64_bit [TrueClass, FalseClass] use a 64-bit offset if set to true, 32-bit otherwise
+        def set_64_bit_offset(is_64_bit)
+          raise ArgumentError.new, 'The value can only be true or false' unless [true, false].include?(is_64_bit)
+          parameter_block.word_count = is_64_bit ? 0x0E : 0x0C
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module RubySMB
+  module SMB1
+    module Packet
+      # A SMB1 SMB_COM_WRITE_ANDX Response Packet as defined in
+      # [2.2.4.43.2 Response](https://msdn.microsoft.com/en-us/library/ee441673.aspx)
+      # [2.2.4.3.2 Server Response Extensions](https://msdn.microsoft.com/en-us/library/ff469858.aspx)
+      class WriteAndxResponse < RubySMB::GenericPacket
+        # A SMB1 Parameter Block as defined by the {WriteAndxResponse}
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          endian      :little
+
+          and_x_block :andx_block
+          uint16      :count_low,  label: 'Count Low'
+          uint16      :available,  label: 'Available'
+          uint16      :count_high, label: 'Count High'
+          uint16      :reserved,   label: 'Reserved'
+        end
+
+        # Represents the specific layout of the DataBlock for a {WriteAndxResponse} 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_WRITE_ANDX
+          smb_header.flags.reply = 1
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/resource_type.rb

@@ -0,0 +1,18 @@
+module RubySMB
+  module SMB1
+    # This module holds the ResourceType used in SMB_COM_OPEN_ANDX and SMB_COM_NT_CREATE_ANDX
+    # responses. The definitions for these values can be found at
+    # [2.2.4.64.2 Response](https://msdn.microsoft.com/en-us/library/ee441612.aspx)
+    # [2.2.4.9.2 Server Response Extensions](https://msdn.microsoft.com/en-us/library/cc246334.aspx)
+    module ResourceType
+      # File or directory
+      DISK              = 0x0000
+      # Byte mode named pipe
+      BYTE_MODE_PIPE    = 0x0001
+      # Message mode named pipe
+      MESSAGE_MODE_PIPE = 0x0002
+      # Printer device
+      PRINTER           = 0x0003
+    end
+  end
+end

data/lib/ruby_smb/smb1/tree.rb

@@ -1,10 +1,8 @@
 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]
@@ -43,13 +41,198 @@ module RubySMB
       # @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)
+        request = set_header_fields(request)
+        raw_response = client.send_recv(request)
         response = RubySMB::SMB1::Packet::TreeDisconnectResponse.read(raw_response)
         response.status_code
       end
 
+      # Open a file on the remote share.
+      #
+      # @example
+      #   tree = client.tree_connect("\\\\192.168.99.134\\Share")
+      #   tree.open_file(filename: "myfile")
+      #
+      # @param filename [String] name of the file to be opened
+      # @param flags [BinData::Struct, Hash] flags to setup the request (see {RubySMB::SMB1::Packet::NtCreateAndxRequest})
+      # @param options [RubySMB::SMB1::BitField::CreateOptions, Hash] flags that defines how the file should be created
+      # @param disposition [Integer] 32-bit field that defines how an already-existing file or a new file needs to be handled (constants are defined in {RubySMB::Dispositions})
+      # @param impersonation [Integer] 32-bit field that defines the impersonation level (constants are defined in {RubySMB::ImpersonationLevels})
+      # @param read [TrueClass, FalseClass] request a read access
+      # @param write [TrueClass, FalseClass] request a write access
+      # @param delete [TrueClass, FalseClass] request a delete access
+      # @return [RubySMB::SMB1::File] handle to the created file
+      # @raise [RubySMB::Error::InvalidPacket] if the response command is not SMB_COM_NT_CREATE_ANDX
+      # @raise [RubySMB::Error::UnexpectedStatusCode] if the response NTStatus is not STATUS_SUCCESS
+      def open_file(filename:, flags: nil, options: nil, disposition: RubySMB::Dispositions::FILE_OPEN,
+                    impersonation: RubySMB::ImpersonationLevels::SEC_IMPERSONATE, read: true, write: false, delete: false)
+        nt_create_andx_request = RubySMB::SMB1::Packet::NtCreateAndxRequest.new
+        nt_create_andx_request = set_header_fields(nt_create_andx_request)
+
+        nt_create_andx_request.parameter_block.ext_file_attributes.normal = 1
+
+        if flags
+          nt_create_andx_request.parameter_block.flags = flags
+        else
+          nt_create_andx_request.parameter_block.flags.request_extended_response = 1
+        end
+
+        if options
+          nt_create_andx_request.parameter_block.create_options = options
+        else
+          nt_create_andx_request.parameter_block.create_options.directory_file     = 0
+          nt_create_andx_request.parameter_block.create_options.non_directory_file = 1
+        end
+
+        if read
+          nt_create_andx_request.parameter_block.share_access.share_read     = 1
+          nt_create_andx_request.parameter_block.desired_access.read_data    = 1
+          nt_create_andx_request.parameter_block.desired_access.read_ea      = 1
+          nt_create_andx_request.parameter_block.desired_access.read_attr    = 1
+          nt_create_andx_request.parameter_block.desired_access.read_control = 1
+        end
+
+        if write
+          nt_create_andx_request.parameter_block.share_access.share_write   = 1
+          nt_create_andx_request.parameter_block.desired_access.write_data  = 1
+          nt_create_andx_request.parameter_block.desired_access.append_data = 1
+          nt_create_andx_request.parameter_block.desired_access.write_ea    = 1
+          nt_create_andx_request.parameter_block.desired_access.write_attr  = 1
+        end
+
+        if delete
+          nt_create_andx_request.parameter_block.share_access.share_delete    = 1
+          nt_create_andx_request.parameter_block.desired_access.delete_access = 1
+        end
+
+        nt_create_andx_request.parameter_block.impersonation_level = impersonation
+        nt_create_andx_request.parameter_block.create_disposition  = disposition
+
+        unicode_enabled = nt_create_andx_request.smb_header.flags2.unicode == 1
+        nt_create_andx_request.data_block.file_name = add_null_termination(str: filename, unicode: unicode_enabled)
+
+        raw_response = @client.send_recv(nt_create_andx_request)
+        response = RubySMB::SMB1::Packet::NtCreateAndxResponse.read(raw_response)
+        unless response.smb_header.command == RubySMB::SMB1::Commands::SMB_COM_NT_CREATE_ANDX
+          raise RubySMB::Error::InvalidPacket, 'Not a NtCreateAndxResponse packet'
+        end
+        unless response.status_code == WindowsError::NTStatus::STATUS_SUCCESS
+          raise RubySMB::Error::UnexpectedStatusCode, response.status_code.name
+        end
+
+        RubySMB::SMB1::File.new(name: filename, tree: self, response: response)
+      end
+
+      # List `directory` on the remote share.
+      #
+      # @example
+      #   tree = client.tree_connect("\\\\192.168.99.134\\Share")
+      #   tree.list(directory: "path\\to\\directory")
+      #
+      # @param directory [String] path to the directory to be listed
+      # @param pattern [String] search pattern
+      # @param type [Class] file information class
+      # @return [Array] array of directory structures
+      def list(directory: '\\', pattern: '*', unicode: true,
+               type: RubySMB::SMB1::Packet::Trans2::FindInformationLevel::FindFileFullDirectoryInfo)
+        find_first_request = RubySMB::SMB1::Packet::Trans2::FindFirst2Request.new
+        find_first_request = set_header_fields(find_first_request)
+        find_first_request.smb_header.flags2.unicode  = 1 if unicode
+
+        search_path = directory.dup
+        search_path << '\\' unless search_path.end_with?('\\')
+        search_path << pattern
+        search_path = '\\' + search_path unless search_path.start_with?('\\')
+
+        # Set the search parameters
+        t2_params = find_first_request.data_block.trans2_parameters
+        t2_params.search_attributes.hidden    = 1
+        t2_params.search_attributes.system    = 1
+        t2_params.search_attributes.directory = 1
+        t2_params.flags.close_eos             = 1
+        t2_params.flags.resume_keys           = 0
+        t2_params.information_level           = type::CLASS_LEVEL
+        t2_params.filename                    = search_path
+        t2_params.search_count                = 10
+
+        find_first_request = set_find_params(find_first_request)
+
+        raw_response  = client.send_recv(find_first_request)
+        response      = RubySMB::SMB1::Packet::Trans2::FindFirst2Response.read(raw_response)
+
+        results = response.results(type, unicode: unicode)
+
+        eos   = response.data_block.trans2_parameters.eos
+        sid   = response.data_block.trans2_parameters.sid
+        last  = results.last.file_name
+
+        while eos.zero?
+          find_next_request = RubySMB::SMB1::Packet::Trans2::FindNext2Request.new
+          find_next_request = set_header_fields(find_next_request)
+          find_next_request.smb_header.flags2.unicode   = 1 if unicode
+
+          t2_params                             = find_next_request.data_block.trans2_parameters
+          t2_params.sid                         = sid
+          t2_params.flags.close_eos             = 1
+          t2_params.flags.resume_keys           = 0
+          t2_params.information_level           = type::CLASS_LEVEL
+          t2_params.filename                    = last
+          t2_params.search_count                = 10
+
+          find_next_request = set_find_params(find_next_request)
+
+          raw_response  = client.send_recv(find_next_request)
+          response      = RubySMB::SMB1::Packet::Trans2::FindNext2Response.read(raw_response)
+
+          results += response.results(type, unicode: unicode)
+
+          eos   = response.data_block.trans2_parameters.eos
+          last  = results.last.file_name
+        end
+
+        results
+      end
+
+      # Sets a few preset header fields that will always be set the same
+      # way for Tree operations. This is, the TreeID and Extended Attributes.
+      #
+      # @param [RubySMB::SMB::Packet] the request packet to modify
+      # @return [RubySMB::SMB::Packet] the modified packet.
+      def set_header_fields(request)
+        request.smb_header.tid        = @id
+        request.smb_header.flags2.eas = 1
+        request
+      end
+
+      private
+
+      # Sets ParameterBlock options for FIND_FIRST2 and
+      # FIND_NEXT2 requests. In particular we need to do this
+      # to tell the server to ignore the Trans2DataBlock as we are
+      # not sending any GEA lists in this instance.
+      def set_find_params(request)
+        request.parameter_block.data_count             = 0
+        request.parameter_block.data_offset            = 0
+        request.parameter_block.total_parameter_count  = request.parameter_block.parameter_count
+        request.parameter_block.max_parameter_count    = request.parameter_block.parameter_count
+        request.parameter_block.max_data_count         = 16_384
+        request
+      end
+
+      # Add null termination to `str` in case it is not already null-terminated.
+      #
+      # @str [String] the string to be null-terminated
+      # @unicode [TrueClass, FalseClass] True if the null-termination should be Unicode encoded
+      # @return [String] the null-terminated string
+      def add_null_termination(str:, unicode: false)
+        null_termination = unicode ? "\x00".encode('UTF-16LE') : "\x00"
+        if str.end_with?(null_termination)
+          return str
+        else
+          return str + null_termination
+        end
+      end
 
     end
   end
-end
+end

data/lib/ruby_smb/smb2.rb

@@ -1,13 +1,18 @@
-# A packet parsing and manipulation library for the SMB2 protocol
-#
-# [[MS-SMB2] Server Mesage Block (SMB) Protocol Versions 2 and 3](https://msdn.microsoft.com/en-us/library/cc246482.aspx)
-module RubySMB::SMB2
-  # Protocol ID value. Translates to \xFESMB
-  SMB2_PROTOCOL_ID = 0xFE534D42
+module RubySMB
+  # A packet parsing and manipulation library for the SMB2 protocol
+  #
+  # [[MS-SMB2] Server Mesage Block (SMB) Protocol Versions 2 and 3](https://msdn.microsoft.com/en-us/library/cc246482.aspx)
+  module SMB2
+    # Protocol ID value. Translates to \xFESMB
+    SMB2_PROTOCOL_ID = 0xFE534D42
 
-  require 'ruby_smb/smb2/commands'
-  require 'ruby_smb/smb2/bit_field'
-  require 'ruby_smb/smb2/smb2_header'
-  require 'ruby_smb/smb2/packet'
-  require 'ruby_smb/smb2/tree'
+    require 'ruby_smb/smb2/info_type'
+    require 'ruby_smb/smb2/commands'
+    require 'ruby_smb/smb2/create_context'
+    require 'ruby_smb/smb2/bit_field'
+    require 'ruby_smb/smb2/smb2_header'
+    require 'ruby_smb/smb2/packet'
+    require 'ruby_smb/smb2/tree'
+    require 'ruby_smb/smb2/file'
+  end
 end

data/lib/ruby_smb/smb2/bit_field.rb

@@ -1,5 +1,6 @@
 module RubySMB
   module SMB2
+    # Namespace for BitMask style field definitions
     module BitField
       require 'ruby_smb/smb2/bit_field/smb2_header_flags'
       require 'ruby_smb/smb2/bit_field/smb2_security_mode'

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

@@ -7,7 +7,7 @@ module RubySMB
         endian  :little
         bit1    :read_attr,       label: 'Read Attributes'
         bit1    :delete_child,    label: 'Delete Child'
-        bit1    :execute,         label: 'Traverse'
+        bit1    :execute,         label: 'Execute'
         bit1    :write_ea,        label: 'Write Extended Attributes'
         bit1    :read_ea,         label: 'Read Extended Attributes'
         bit1    :append_data,     label: 'Append Data'

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

@@ -9,8 +9,7 @@ module RubySMB
         bit1    :guest,               label: 'Is Guest?',     initial_value: 0
         resume_byte_alignment
         # byte border
-        uint8   :reserved1,           label: 'Reserved',           initial_value: 0
-
+        uint8 :reserved1, label: 'Reserved', initial_value: 0
       end
     end
   end

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

@@ -1,7 +1,6 @@
 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
@@ -26,11 +25,11 @@ module RubySMB
         bit8    :reserved4,                 label: 'Reserved Space'
 
         def caching_type
-          if self.vdo_caching == 1 && self.auto_caching == 0
+          if vdo_caching == 1 && auto_caching.zero?
             :vdo
-          elsif self.vdo_caching == 0 && self.auto_caching == 1
+          elsif vdo_caching.zero? && auto_caching == 1
             :auto
-          elsif self.vdo_caching == 1 && self.auto_caching == 1
+          elsif vdo_caching == 1 && auto_caching == 1
             :no_caching
           else
             :manual
@@ -68,8 +67,7 @@ module RubySMB
           self.vdo_caching  = 1
           self.auto_caching = 1
         end
-
       end
     end
   end
-end
+end