ruby_smb 0.0.18 → 0.0.19

data/lib/ruby_smb/smb2/create_context.rb

@@ -0,0 +1,29 @@
+module RubySMB
+  module SMB2
+    # An SMB2_CREATE_CONTEXT struct as defined in
+    # [2.2.13.2 SMB2_CREATE_CONTEXT Request Values](https://msdn.microsoft.com/en-us/library/cc246504.aspx)
+    class CreateContext < BinData::Record
+      endian  :little
+
+      uint32  :next_offset, label: 'Offset to next Context'
+      uint16  :name_offset, label: 'Offset to Name/Tag',      initial_value:  -> { name.rel_offset }
+      uint16  :name_length, label: 'Length of Name/Tag',      initial_value:  -> { name.length }
+      uint16  :reserved,    label: 'Reserved Space'
+      uint16  :data_offset, label: 'Offset to data',          initial_value:  -> { calc_data_offset }
+      uint32  :data_length, label: 'Length of data',          initial_value:  -> { data.length }
+      string  :name,        label: 'Name'
+      uint32  :reserved2,   label: 'Reserved Space'
+      string  :data,        label: 'Data'
+
+      private
+
+      def calc_data_offset
+        if data.empty?
+          0
+        else
+          data.rel_offset
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/file.rb

@@ -0,0 +1,251 @@
+module RubySMB
+  module SMB2
+    # Represents a file on the Remote server that we can perform
+    # various I/O operations on.
+    class File
+      # The maximum number of byte we want to read or write
+      # in a single packet.
+      MAX_PACKET_SIZE = 32_768
+
+      # The {FileAttributes} for the file
+      # @!attribute [rw] attributes
+      #   @return [RubySMB::Fscc::FileAttributes]
+      attr_accessor :attributes
+
+      # The {Smb2FileId} for the file
+      # @!attribute [rw] guid
+      #   @return [RubySMB::Field::Smb2FileId]
+      attr_accessor :guid
+
+      # The last access date/time for the file
+      # @!attribute [rw] last_access
+      #   @return [DateTime]
+      attr_accessor :last_access
+
+      # The last change date/time for the file
+      # @!attribute [rw] last_change
+      #   @return [DateTime]
+      attr_accessor :last_change
+
+      # The last write date/time for the file
+      # @!attribute [rw] last_write
+      #   @return [DateTime]
+      attr_accessor :last_write
+
+      # The name of the file
+      # @!attribute [rw] name
+      #   @return [String]
+      attr_accessor :name
+
+      # The actual size, in bytes, of the file
+      # @!attribute [rw] size
+      #   @return [Integer]
+      attr_accessor :size
+
+      # The size in bytes that the file occupies on disk
+      # @!attribute [rw] size_on_disk
+      #   @return [Integer]
+      attr_accessor :size_on_disk
+
+      # The {RubySMB::SMB2::Tree} that this file belong to
+      # @!attribute [rw] tree
+      #   @return [RubySMB::SMB2::Tree]
+      attr_accessor :tree
+
+      def initialize(tree:, response:, name:)
+        raise ArgumentError, 'No Tree Provided' if tree.nil?
+        raise ArgumentError, 'No Response Provided' if response.nil?
+
+        @tree = tree
+        @name = name
+
+        @attributes   = response.file_attributes
+        @guid         = response.file_id
+        @last_access  = response.last_access.to_datetime
+        @last_change  = response.last_change.to_datetime
+        @last_write   = response.last_write.to_datetime
+        @size         = response.end_of_file
+        @size_on_disk = response.allocation_size
+      end
+
+      # Appends the supplied data to the end of the file.
+      #
+      # @param data [String] the data to write to the file
+      # @return [WindowsError::ErrorCode] the NTStatus code returned from the operation
+      def append(data:'')
+        write(data: data, offset: size)
+      end
+
+      # Closes the handle to the remote file.
+      #
+      # @return [WindowsError::ErrorCode] the NTStatus code returned by the operation
+      def close
+        close_request = set_header_fields(RubySMB::SMB2::Packet::CloseRequest.new)
+        raw_response  = tree.client.send_recv(close_request)
+        response = RubySMB::SMB2::Packet::CloseResponse.read(raw_response)
+        response.smb2_header.nt_status.to_nt_status
+      end
+
+      # Read from the file, a specific number of bytes
+      # from a specific offset. If no parameters are given
+      # it will read the entire file.
+      #
+      # @param bytes [Integer] the number of bytes to read
+      # @param offset [Integer] the byte offset in the file to start reading from
+      # @return [String] the data read from the file
+      def read(bytes: size, offset: 0)
+        atomic_read_size = if bytes > MAX_PACKET_SIZE
+                             MAX_PACKET_SIZE
+                           else
+                             bytes
+                           end
+
+        read_request = read_packet(read_length: atomic_read_size, offset: offset)
+        raw_response = tree.client.send_recv(read_request)
+        response     = RubySMB::SMB2::Packet::ReadResponse.read(raw_response)
+
+        data = response.buffer.to_binary_s
+
+        remaining_bytes = bytes - atomic_read_size
+
+        while remaining_bytes > 0
+          offset += atomic_read_size
+          atomic_read_size = remaining_bytes if remaining_bytes < MAX_PACKET_SIZE
+
+          read_request = read_packet(read_length: atomic_read_size, offset: offset)
+          raw_response = tree.client.send_recv(read_request)
+          response     = RubySMB::SMB2::Packet::ReadResponse.read(raw_response)
+
+          data << response.buffer.to_binary_s
+          remaining_bytes -= atomic_read_size
+        end
+        data
+      end
+
+      # Crafts the ReadRequest packet to be sent for read operations.
+      #
+      # @param bytes [Integer] the number of bytes to read
+      # @param offset [Integer] the byte offset in the file to start reading from
+      # @return [RubySMB::SMB2::Packet::ReadRequest] the data read from the file
+      def read_packet(read_length: 0, offset: 0)
+        read_request = set_header_fields(RubySMB::SMB2::Packet::ReadRequest.new)
+        read_request.read_length  = read_length
+        read_request.offset       = offset
+        read_request
+      end
+      
+      def send_recv_read(read_length: 0, offset: 0)
+        read_request = read_packet(read_length: read_length, offset: offset)
+        raw_response = tree.client.send_recv(read_request)
+        response = RubySMB::SMB2::Packet::ReadResponse.read(raw_response)
+        if response.status_code == WindowsError::NTStatus::STATUS_PENDING
+          sleep 1
+          return send_recv_read(read_length: read_length, offset: offset)
+        elsif response.status_code != WindowsError::NTStatus::STATUS_SUCCESS
+          raise RubySMB::Error::UnexpectedStatusCode, response.status_code.name
+        end
+        response.buffer.to_binary_s
+      end
+
+      # Delete a file on close
+      #
+      # @return [WindowsError::ErrorCode] the NTStatus Response code
+      def delete
+        raw_response = tree.client.send_recv(delete_packet)
+        response = RubySMB::SMB2::Packet::SetInfoResponse.read(raw_response)
+        response.smb2_header.nt_status.to_nt_status
+      end
+
+      # Crafts the SetInfoRequest packet to be sent for delete operations.
+      #
+      # @return [RubySMB::SMB2::Packet::SetInfoRequest] the set info packet
+      def delete_packet
+        delete_request                       = set_header_fields(RubySMB::SMB2::Packet::SetInfoRequest.new)
+        delete_request.file_info_class       = RubySMB::Fscc::FileInformation::FILE_DISPOSITION_INFORMATION
+        delete_request.buffer.delete_pending = 1
+        delete_request
+      end
+
+      # Sets the header fields that we have to set on every packet
+      # we send for File operations.
+      # @param request [RubySMB::GenericPacket] the request packet to set fields on
+      # @return  [RubySMB::GenericPacket] the rmodified request packet
+      def set_header_fields(request)
+        request         = tree.set_header_fields(request)
+        request.file_id = guid
+        request
+      end
+
+      # Write the supplied data to the file at the given offset.
+      #
+      # @param data [String] the data to write to the file
+      # @param offset [Integer] the offset in the file to start writing from
+      # @return [WindowsError::ErrorCode] the NTStatus code returned from the operation
+      def write(data:'', offset: 0)
+        buffer            = data.dup
+        bytes             = data.length
+        atomic_write_size = if bytes > MAX_PACKET_SIZE
+                             MAX_PACKET_SIZE
+                           else
+                             bytes
+                            end
+
+        while buffer.length > 0 do
+          write_request = write_packet(data: buffer.slice!(0,atomic_write_size), offset: offset)
+          raw_response  = tree.client.send_recv(write_request)
+          response      = RubySMB::SMB2::Packet::WriteResponse.read(raw_response)
+          status        = response.smb2_header.nt_status.to_nt_status
+
+          offset+= atomic_write_size
+          return status unless status == WindowsError::NTStatus::STATUS_SUCCESS
+        end
+
+        status
+      end
+
+      # Creates the Request packet for the #write command
+      #
+      # @param data [String] the data to write to the file
+      # @param offset [Integer] the offset in the file to start writing from
+      # @return []RubySMB::SMB2::Packet::WriteRequest] the request packet
+      def write_packet(data:'', offset: 0)
+        write_request               = set_header_fields(RubySMB::SMB2::Packet::WriteRequest.new)
+        write_request.write_offset  = offset
+        write_request.buffer        = data
+        write_request
+      end
+      
+      def send_recv_write(data:'', offset: 0)
+        pkt = write_packet(data: data, offset: offset)
+        raw_response = tree.client.send_recv(pkt)
+        response = RubySMB::SMB2::Packet::WriteResponse.read(raw_response)
+        if response.status_code != WindowsError::NTStatus::STATUS_SUCCESS
+          raise RubySMB::Error::UnexpectedStatusCode, response.status_code.name
+        end
+        response.write_count
+      end
+      
+      # Rename a file
+      #
+      # @param new_file_name [String] the new name
+      # @return [WindowsError::ErrorCode] the NTStatus Response code
+      def rename(new_file_name)
+        raw_response = tree.client.send_recv(rename_packet(new_file_name))
+        response = RubySMB::SMB2::Packet::SetInfoResponse.read(raw_response)
+        response.smb2_header.nt_status.to_nt_status
+      end
+
+      # Crafts the SetInfoRequest packet to be sent for rename operations.
+      #
+      # @param new_file_name [String] the new name
+      # @return [RubySMB::SMB2::Packet::SetInfoRequest] the set info packet
+      def rename_packet(new_file_name)
+        rename_request                  = set_header_fields(RubySMB::SMB2::Packet::SetInfoRequest.new)
+        rename_request.file_info_class  = RubySMB::Fscc::FileInformation::FILE_RENAME_INFORMATION
+        rename_request.buffer.file_name = new_file_name.encode('utf-16le')
+        rename_request
+      end
+
+    end
+  end
+end

data/lib/ruby_smb/smb2/info_type.rb

@@ -0,0 +1,21 @@
+module RubySMB
+  module SMB2
+    # Contains constants for the InfoType values as defined in
+    # [2.2.39 SMB2 SET_INFO Request](https://msdn.microsoft.com/en-us/library/cc246560.aspx) and
+    # [2.2.37 SMB2 QUERY_INFO Request](https://msdn.microsoft.com/en-us/library/cc246557.aspx)
+    module InfoType
+      # The file information
+      SMB2_0_INFO_FILE       = 0x01
+
+      # The underlying object store information
+      SMB2_0_INFO_FILESYSTEM = 0x02
+
+      # The security information
+      SMB2_0_INFO_SECURITY   = 0x03
+
+      # The underlying object store quota information
+      SMB2_0_INFO_QUOTA      = 0x04
+    end
+  end
+end
+

data/lib/ruby_smb/smb2/packet.rb

@@ -1,5 +1,7 @@
 module RubySMB
   module SMB2
+    # Namespace for all of the packet definitions for SMB2
+    # see [2.2 Message Syntax](https://msdn.microsoft.com/en-us/library/cc246497.aspx)
     module Packet
       require 'ruby_smb/smb2/packet/error_packet'
       require 'ruby_smb/smb2/packet/negotiate_request'
@@ -14,6 +16,20 @@ module RubySMB
       require 'ruby_smb/smb2/packet/logoff_response'
       require 'ruby_smb/smb2/packet/echo_request'
       require 'ruby_smb/smb2/packet/echo_response'
+      require 'ruby_smb/smb2/packet/create_request'
+      require 'ruby_smb/smb2/packet/create_response'
+      require 'ruby_smb/smb2/packet/query_directory_request'
+      require 'ruby_smb/smb2/packet/query_directory_response'
+      require 'ruby_smb/smb2/packet/read_request'
+      require 'ruby_smb/smb2/packet/read_response'
+      require 'ruby_smb/smb2/packet/set_info_request'
+      require 'ruby_smb/smb2/packet/set_info_response'
+      require 'ruby_smb/smb2/packet/close_request'
+      require 'ruby_smb/smb2/packet/close_response'
+      require 'ruby_smb/smb2/packet/write_request'
+      require 'ruby_smb/smb2/packet/write_response'
+      require 'ruby_smb/smb2/packet/ioctl_request'
+      require 'ruby_smb/smb2/packet/ioctl_response'
     end
   end
 end

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

@@ -0,0 +1,22 @@
+module RubySMB
+  module SMB2
+    module Packet
+      # An SMB2 Close Request Packet as defined in
+      # [2.2.15 SMB2 CLOSE Request](https://msdn.microsoft.com/en-us/library/cc246523.aspx)
+      class CloseRequest < RubySMB::GenericPacket
+        endian :little
+
+        smb2_header           :smb2_header
+        uint16                :structure_size,        label: 'Structure Size', initial_value: 24
+        uint16                :flags,                 label: 'Flags'
+        uint32                :reserved,              label: 'Reserved Space'
+        smb2_fileid           :file_id,               label: 'File ID'
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::CLOSE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module RubySMB
+  module SMB2
+    module Packet
+      # An SMB2 Close Response Packet as defined in
+      # [2.2.16 SMB2 CLOSE Response](https://msdn.microsoft.com/en-us/library/cc246524.aspx)
+      class CloseResponse < RubySMB::GenericPacket
+        endian :little
+
+        smb2_header      :smb2_header
+        uint16           :structure_size,   label: 'Structure Size', initial_value: 60
+        uint16           :flags,            label: 'Flags'
+        uint32           :reserved,         label: 'Reserved Space'
+        file_time        :create_time,      label: 'Create Time'
+        file_time        :last_access,      label: 'Last Accessed Time'
+        file_time        :last_write,       label: 'Last Write Time'
+        file_time        :last_change,      label: 'Last Modified Time'
+        uint64           :allocation_size,  label: 'Allocated Size'
+        uint64           :end_of_file,      label: 'End of File'
+        file_attributes  :file_attributes,  label: 'File Attributes'
+
+        def initialize_instance
+          super
+          smb2_header.command     = RubySMB::SMB2::Commands::CLOSE
+          smb2_header.flags.reply = 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module RubySMB
+  module SMB2
+    module Packet
+      # An SMB2 Create Request Packet as defined in
+      # [2.2.13 SMB2 CREATE Request](https://msdn.microsoft.com/en-us/library/cc246502.aspx)
+      class CreateRequest < RubySMB::GenericPacket
+        require 'ruby_smb/smb1/bit_field/create_options'
+
+        endian :little
+        smb2_header           :smb2_header
+        uint16                :structure_size,       label: 'Structure Size',              initial_value: 57
+        uint8                 :security_flag,        label: 'Security Flags(Do not Use)',  initial_value: 0
+        uint8                 :requested_oplock,     label: 'Requested OpLock Level',      initial_value: 0
+        uint32                :impersonation_level,  label: 'Impersonation Level'
+        uint64                :create_flags,         label: 'Create Flags(Do not use)',    initial_value: 0
+        uint64                :reserved,             label: 'Reserved',                    initial_value: 0
+
+        choice :desired_access, selection: -> { file_attributes.directory } do
+          file_access_mask      0, label: 'Desired Access'
+          directory_access_mask 1, label: 'Desired Access'
+        end
+
+        file_attributes :file_attributes, label: 'File Attributes'
+
+        struct :share_access do
+          bit5  :reserved,          label: 'Reserved Space'
+          bit1  :delete_access,     label: 'Share Delete Access'
+          bit1  :write_access,      label: 'Share Write Access'
+          bit1  :read_access,       label: 'Share Read Access'
+          # byte boundary
+          bit8  :reserved2, label: 'Reserved Space'
+          bit8  :reserved3, label: 'Reserved Space'
+          bit8  :reserved4, label: 'Reserved Space'
+        end
+
+        uint32          :create_disposition, label: 'Create Disposition'
+        create_options  :create_options
+        uint16          :name_offset,         label: 'Name Offset',            initial_value: -> { name.abs_offset }
+        uint16          :name_length,         label: 'Name Length',            initial_value: -> { name.do_num_bytes }
+        uint32          :context_offset,      label: 'Create Context Offset',  initial_value: -> { context.abs_offset }
+        uint32          :context_length,      label: 'Create Context Length',  initial_value: -> { context.do_num_bytes }
+        string16        :name,                label: 'File Name'
+        uint32          :reserved5,           label: 'Reserved Space'
+
+        array :context, label: 'Contexts', type: :create_context, read_until: :eof
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::CREATE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module RubySMB
+  module SMB2
+    module Packet
+      # An SMB2 Create Response Packet as defined in
+      # [2.2.14 SMB2 CREATE Response](https://msdn.microsoft.com/en-us/library/cc246512.aspx)
+      class CreateResponse < RubySMB::GenericPacket
+        endian :little
+        smb2_header           :smb2_header
+        uint16                :structure_size,       label: 'Structure Size', initial_value: 89
+        uint8                 :oplock_level,         label: 'Granted OpLock Level'
+        uint8                 :flags,                label: 'Flags (Do Not Use)'
+        uint32                :create_action,        label: 'Create Action'
+        file_time             :create_time,          label: 'Create Time'
+        file_time             :last_access,          label: 'Last Accessed Time'
+        file_time             :last_write,           label: 'Last Write Time'
+        file_time             :last_change,          label: 'Last Modified Time'
+        uint64                :allocation_size,      label: 'Allocated Size'
+        uint64                :end_of_file,          label: 'Size in Bytes'
+        file_attributes       :file_attributes,      label: 'File Attributes'
+        uint32                :reserved,             label: 'Reserved Space'
+        smb2_fileid           :file_id,              label: 'File ID'
+        uint32                :context_offset,       label: 'Create Context Offset',  initial_value: -> { context.abs_offset }
+        uint32                :context_length,       label: 'Create Context Length',  initial_value: -> { context.do_num_bytes }
+
+        array :context, label: 'Contexts', type: :create_context, read_until: :eof
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::CREATE
+          smb2_header.flags.reply = 1
+        end
+      end
+    end
+  end
+end