ruby_smb 0.0.18 → 0.0.19

data/lib/ruby_smb/field/smb2_fileid.rb

@@ -0,0 +1,11 @@
+module RubySMB
+  module Field
+    # Class representing an SMB2 FileID as defined in
+    # [2.2.14.1 SMB2_FILEID](https://msdn.microsoft.com/en-us/library/cc246513.aspx)
+    class Smb2Fileid < BinData::Record
+      endian :little
+      uint64   :persistent,  label: 'Persistent File Handle'
+      uint64   :volatile,    label: 'Volatile File handle'
+    end
+  end
+end

data/lib/ruby_smb/field/smb_fea.rb

@@ -5,10 +5,10 @@ module RubySMB
     class SmbFea < BinData::Record
       endian :little
       extended_attribute_flag :ea_flag,                   label: 'Extended Attribute Flag'
-      uint8                   :attribute_name_length,     label: 'Attribute Name Length',   initial_value: lambda { attribute_name.length}
-      uint16                  :attribute_value_length,    label: 'Attribute Value Length',  initial_value: lambda { attribute_value.length}
+      uint8                   :attribute_name_length,     label: 'Attribute Name Length',   initial_value: -> { attribute_name.length }
+      uint16                  :attribute_value_length,    label: 'Attribute Value Length',  initial_value: -> { attribute_value.length }
       string                  :attribute_name,            label: 'Attribute Name'
       string                  :attribute_value,           label: 'Attribute Value'
     end
   end
-end
+end

data/lib/ruby_smb/field/smb_fea_list.rb

@@ -4,10 +4,10 @@ module RubySMB
     # [2.2.1.2.2.1 SMB_FEA_LIST](https://msdn.microsoft.com/en-us/library/ff359296.aspx)
     class SmbFeaList < BinData::Record
       endian :little
-      uint32  :size_of_list,  label: 'Size of List in Bytes', initial_value: lambda { fea_list.do_num_bytes }
-      array   :fea_list,  initial_length: 0 do
+      uint32  :size_of_list, label: 'Size of List in Bytes', initial_value: -> { fea_list.do_num_bytes }
+      array   :fea_list, initial_length: 0 do
         smb_fea
       end
     end
   end
-end
+end

data/lib/ruby_smb/field/smb_gea.rb

@@ -0,0 +1,12 @@
+module RubySMB
+  module Field
+    # Class representing an SMB Get Extended Attribute structure as defined in
+    # [2.2.1.2.1 SMB_GEA](https://msdn.microsoft.com/en-us/library/ee442131.aspx?f=255&MSPPError=-2147217396)
+    class SmbGea < BinData::Record
+      endian :little
+      uint8   :attribute_name_length, label: 'Attribute Name Length', initial_value: -> { attribute_name.do_num_bytes }
+      string  :attribute_name,        label: 'Attribute Name'
+      uint8   :null_pad,              label: 'Null-Padding', initial_value: 0x00
+    end
+  end
+end

data/lib/ruby_smb/field/smb_gea_list.rb

@@ -0,0 +1,13 @@
+module RubySMB
+  module Field
+    # Class representing an SMB Get Extended Attribute List as defined in
+    # [2.2.1.2.1.1 SMB_GEA_LIST](https://msdn.microsoft.com/en-us/library/ff359447.aspx)
+    class SmbGeaList < BinData::Record
+      endian :little
+      uint32  :size_of_list, label: 'Size of List in Bytes', initial_value: -> { self.do_num_bytes }
+      array   :gea_list, initial_length: 0 do
+        smb_gea
+      end
+    end
+  end
+end

data/lib/ruby_smb/field/string16.rb

@@ -0,0 +1,14 @@
+module RubySMB
+  module Field
+    # Represents a String in UTF-16LE
+    class String16 < BinData::String
+      def assign(val)
+        super(val.encode('utf-16le'))
+      end
+
+      def snapshot
+        super.force_encoding('utf-16le')
+      end
+    end
+  end
+end

data/lib/ruby_smb/field/stringz16.rb

@@ -2,25 +2,21 @@ module RubySMB
   module Field
     # Represents a NULL-Terminated String in UTF-16
     class Stringz16 < BinData::Stringz
-
       def assign(val)
-        super(binary_string(val.encode("utf-16le")))
+        super(binary_string(val.encode('utf-16le')))
       end
 
       def snapshot
         # override to always remove trailing zero bytes
         result = _value
-        result
         result = trim_and_zero_terminate(result)
-        result.chomp("\0\0").force_encoding("utf-16le")
+        result.chomp("\0\0").force_encoding('utf-16le')
       end
 
       private
 
       def append_zero_byte_if_needed!(str)
-        if str.length == 0 || !(str.end_with?("\0\0"))
-          str << "\0\0"
-        end
+        str << "\0\0" if str.empty? || !str.end_with?("\0\0")
       end
 
       # Override parent on {BinData::Stringz} to use

data/lib/ruby_smb/field/utime.rb

@@ -1,6 +1,7 @@
+require 'date'
+
 module RubySMB
   module Field
-
     # Conveneince class for dealing with 32-bit unsigned UTIME
     # fields in SMB, as defined in
     # [2.2.1.4.3 UTIME](https://msdn.microsoft.com/en-us/library/ee441907.aspx)
@@ -23,14 +24,14 @@ module RubySMB
       # @return
       def set(value)
         case value
-          when DateTime
-            set(value.to_time)
-          when Time
-            set(value.to_i)
-          when Fixnum
-            self.val = value
-          else
-            self.val = value.to_i
+        when DateTime
+          set(value.to_time)
+        when Time
+          set(value.to_i)
+        when Integer
+          self.val = value
+        else
+          self.val = value.to_i
         end
         val
       end
@@ -51,4 +52,4 @@ module RubySMB
       end
     end
   end
-end
+end

data/lib/ruby_smb/fscc.rb

@@ -0,0 +1,12 @@
+module RubySMB
+  # Namespace for structures and classes from File System
+  # Control Codes as defined in
+  # [[MS-FSCC]: File System Control Codes](https://msdn.microsoft.com/en-us/library/cc231987.aspx)
+  module Fscc
+    require 'ruby_smb/fscc/file_attributes'
+    require 'ruby_smb/fscc/file_full_ea_info'
+    require 'ruby_smb/fscc/ea_info_array'
+    require 'ruby_smb/fscc/file_information'
+    require 'ruby_smb/fscc/control_codes'
+  end
+end

data/lib/ruby_smb/fscc/control_codes.rb

@@ -0,0 +1,26 @@
+module RubySMB
+  module Fscc
+
+    # Defines the FSCTL/IOCTL control codes as defined in
+    # [2.2.31 SMB2 IOCTL Request](https://msdn.microsoft.com/en-us/library/cc246545.aspx)
+    module ControlCodes
+
+      FSCTL_DFS_GET_REFERRALS             = 0x00060194
+      FSCTL_PIPE_PEEK                     = 0x0011400C
+      FSCTL_PIPE_WAIT                     = 0x00110018
+      FSCTL_PIPE_TRANSCEIVE               = 0x0011C017
+      FSCTL_SRV_COPYCHUNK                 = 0x001440F2
+      FSCTL_SRV_ENUMERATE_SNAPSHOTS       = 0x00144064
+      FSCTL_SRV_REQUEST_RESUME_KEY        = 0x00140078
+      FSCTL_SRV_READ_HASH                 = 0x001441bb
+      FSCTL_SRV_COPYCHUNK_WRITE           = 0x001480F2
+      FSCTL_LMR_REQUEST_RESILIENCY        = 0x001401D4
+      FSCTL_QUERY_NETWORK_INTERFACE_INFO  = 0x001401FC
+      FSCTL_SET_REPARSE_POINT             = 0x000900A4
+      FSCTL_DFS_GET_REFERRALS_EX          = 0x000601B0
+      FSCTL_FILE_LEVEL_TRIM               = 0x00098208
+      FSCTL_VALIDATE_NEGOTIATE_INFO       = 0x00140204
+
+    end
+  end
+end

data/lib/ruby_smb/{field → fscc}/ea_info_array.rb

@@ -1,19 +1,18 @@
 module RubySMB
-  module Field
+  module Fscc
     # Convenience class that extend the normal {BinData::Array} for use
-    # with {RubySMB::Field::FileFullEaInfo}. This array will automatically
-    # updates the {RubySMB::Field::FileFullEaInfo#next_entry_offset} of
+    # with {RubySMB::Fscc::FileFullEaInfo}. This array will automatically
+    # updates the {RubySMB::Fscc::FileFullEaInfo#next_entry_offset} of
     # each element in the array.
     class EaInfoArray < BinData::Array
-
       # Overrides the method from {BinData::Array} to
       # call #update_offsets
-      # @raise [ArgumentError] if the inserted element is not a {RubySMB::Field::FileFullEaInfo}
+      # @raise [ArgumentError] if the inserted element is not a {RubySMB::Fscc::FileFullEaInfo}
       def []=(index, value)
-        unless value.is_a? RubySMB::Field::FileFullEaInfo
-          raise ArgumentError, "This array can only contain RubySMB::Field::FileFullEaInfo objects"
+        unless value.is_a? RubySMB::Fscc::FileFullEaInfo
+          raise ArgumentError, 'This array can only contain RubySMB::Fscc::FileFullEaInfo objects'
         end
-        retval = super(index,value)
+        retval = super(index, value)
         update_offsets
         retval
       end
@@ -23,12 +22,12 @@ module RubySMB
       #
       # @param index [Integer] the index to insert into the array at
       # @param objs [Array<Object>] the objects to be inserted
-      # @raise [ArgumentError] if the inserted element is not a {RubySMB::Field::FileFullEaInfo}
+      # @raise [ArgumentError] if the inserted element is not a {RubySMB::Fscc::FileFullEaInfo}
       # @return [self]
       def insert(index, *objs)
         objs.each do |x|
-          unless x.is_a? RubySMB::Field::FileFullEaInfo
-            raise ArgumentError, "This array can only contain RubySMB::Field::FileFullEaInfo objects"
+          unless x.is_a? RubySMB::Fscc::FileFullEaInfo
+            raise ArgumentError, 'This array can only contain RubySMB::Fscc::FileFullEaInfo objects'
           end
         end
         super(index, *objs)
@@ -41,8 +40,8 @@ module RubySMB
       #
       # @return [self]
       def update_offsets
-        self.each do |element|
-          if element == self.last
+        each do |element|
+          if element == last
             # If this is the end of our array, the offset must be 0
             element.next_entry_offset = 0
           else
@@ -52,7 +51,6 @@ module RubySMB
         end
         self
       end
-
     end
   end
 end

data/lib/ruby_smb/fscc/file_attributes.rb

@@ -0,0 +1,29 @@
+module RubySMB
+  module Fscc
+    # The bit-field for File System Control Code File Attributes as defined in
+    # [2.6 File Attributes](https://msdn.microsoft.com/en-us/library/cc232110.aspx)
+    class FileAttributes < BinData::Record
+      endian :little
+      bit1  :normal,       label: 'Normal File/Directory'
+      bit1  :device,       label: 'Device'
+      bit1  :archive,      label: 'Archive'
+      bit1  :directory,    label: 'Directory'
+      bit1  :volume,       label: 'Volume Label'
+      bit1  :system,       label: 'System File'
+      bit1  :hidden,       label: 'Hidden File'
+      bit1  :read_only,    label: 'Read Only'
+      # Byte boundary
+      bit1  :reserved,        label: 'Reserved Space'
+      bit1  :encrypted,       label: 'File is Encrypted'
+      bit1  :content_indexed, label: 'Content Indexed'
+      bit1  :offline,         label: 'Offline Storage'
+      bit1  :compressed,      label: 'Compressed File'
+      bit1  :reparse_point,   label: 'Reparse Point'
+      bit1  :sparse,          label: 'Sparse File'
+      bit1  :temp,            label: 'Temporary File'
+      # Byte boundary
+      bit8  :reserved2,       label: 'Reserved Space'
+      bit8  :reserved3,       label: 'Reserved Space'
+    end
+  end
+end

data/lib/ruby_smb/{field → fscc}/file_full_ea_info.rb

@@ -1,15 +1,15 @@
 module RubySMB
-  module Field
+  module Fscc
     # Class representing a FillFullEaInformation structure as defined in
     # [2.4.15 FileFullEaInformation](https://msdn.microsoft.com/en-us/library/cc232069.aspx)
     class FileFullEaInfo < BinData::Record
-      endian  :little
+      endian :little
       uint32                  :next_entry_offset, label: 'Next Entry Offset'
       extended_attribute_flag :flags
-      uint8                   :ea_name_length,    label: 'EA Name Length',  initial_value: lambda { ea_name.do_num_bytes }
-      uint8                   :ea_value_length,   label: 'EA Value Length', initial_value: lambda { ea_value.do_num_bytes }
+      uint8                   :ea_name_length,    label: 'EA Name Length',  initial_value: -> { ea_name.do_num_bytes }
+      uint8                   :ea_value_length,   label: 'EA Value Length', initial_value: -> { ea_value.do_num_bytes }
       string                  :ea_name,           label: 'EA Name'
       string                  :ea_value,          label: 'EA Value'
     end
   end
-end
+end

data/lib/ruby_smb/fscc/file_information.rb

@@ -0,0 +1,60 @@
+module RubySMB
+  module Fscc
+    # Namespace and constant values for File Information Classes, as defined in
+    # [2.4 File Information Classes](https://msdn.microsoft.com/en-us/library/cc232064.aspx)
+    module FileInformation
+      # Information class used in directory enumeration to return detailed
+      # information about the contents of a directory.
+      FILE_DIRECTORY_INFORMATION         = 0x01
+
+      # Information class used in directory enumeration to return detailed
+      # information (with extended attributes size) about the contents of a
+      # directory.
+      FILE_FULL_DIRECTORY_INFORMATION    = 0x02
+
+      # Information class used in directory enumeration to return detailed
+      # information (with extended attributes size and short names) about the
+      # contents of a directory.
+      FILE_BOTH_DIRECTORY_INFORMATION    = 0x03
+
+      # Information class used to rename a file.
+      FILE_RENAME_INFORMATION            = 0x0A
+
+      # Information class used in directory enumeration to return detailed
+      # information (with only filenames) about the contents of a directory.
+      FILE_NAMES_INFORMATION             = 0x0C
+
+      # Information class used to mark a file for deletion.
+      FILE_DISPOSITION_INFORMATION       = 0x0D
+
+      # Information class used in directory enumeration to return detailed
+      # information (with extended attributes size, short names and file ID)
+      # about the contents of a directory.
+      FILE_ID_BOTH_DIRECTORY_INFORMATION = 0x25
+
+      # Information class used in directory enumeration to return detailed
+      # information (with extended attributes size and file ID) about the
+      # contents of a directory.
+      FILE_ID_FULL_DIRECTORY_INFORMATION = 0x26
+
+
+      # These Information Classes can be used by SMB1 using the pass-through
+      # Information Levels when available on the server (CAP_INFOLEVEL_PASSTHRU
+      # capability flag in an SMB_COM_NEGOTIATE server response). The constant
+      # SMB_INFO_PASSTHROUGH needs to be added to access these Information
+      # Levels. This is documented in
+      # [2.2.2.3.5 Pass-through Information Level Codes](https://msdn.microsoft.com/en-us/library/ff470158.aspx)
+      SMB_INFO_PASSTHROUGH               = 0x03e8
+
+
+      require 'ruby_smb/fscc/file_information/file_directory_information'
+      require 'ruby_smb/fscc/file_information/file_full_directory_information'
+      require 'ruby_smb/fscc/file_information/file_disposition_information'
+      require 'ruby_smb/fscc/file_information/file_id_full_directory_information'
+      require 'ruby_smb/fscc/file_information/file_both_directory_information'
+      require 'ruby_smb/fscc/file_information/file_id_both_directory_information'
+      require 'ruby_smb/fscc/file_information/file_names_information'
+      require 'ruby_smb/fscc/file_information/file_rename_information'
+    end
+  end
+end

data/lib/ruby_smb/fscc/file_information/file_both_directory_information.rb

@@ -0,0 +1,29 @@
+module RubySMB
+  module Fscc
+    module FileInformation
+      # The FileBothDirectoryInformation Class as defined in
+      # [2.4.8 FileBothDirectoryInformation](https://msdn.microsoft.com/en-us/library/cc232095.aspx)
+      class FileBothDirectoryInformation < BinData::Record
+        CLASS_LEVEL = FileInformation::FILE_BOTH_DIRECTORY_INFORMATION
+
+        endian :little
+
+        uint32           :next_offset,        label: 'Next Entry Offset'
+        uint32           :file_index,         label: 'File Index'
+        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           :end_of_file,        label: 'End of File'
+        uint64           :allocation_size,    label: 'Allocated Size'
+        file_attributes  :file_attributes,    label: 'File Attributes'
+        uint32           :file_name_length,   label: 'File Name Length', initial_value: -> { file_name.do_num_bytes }
+        uint32           :ea_size,            label: 'Extended Attributes Size'
+        uint8            :short_name_length,  label: 'Short Name Length'
+        uint8            :reserved,           label: 'Reserved Space'
+        string16         :short_name,         label: 'File Short Name',           length: 24
+        string16         :file_name,          label: 'File Name',                 read_length: -> { file_name_length }
+      end
+    end
+  end
+end

data/lib/ruby_smb/fscc/file_information/file_directory_information.rb

@@ -0,0 +1,25 @@
+module RubySMB
+  module Fscc
+    module FileInformation
+      # The FileDirectoryInformation Class as defined in
+      # [2.4.10 FileDirectoryInformation](https://msdn.microsoft.com/en-us/library/cc232097.aspx)
+      class FileDirectoryInformation < BinData::Record
+        CLASS_LEVEL = FileInformation::FILE_DIRECTORY_INFORMATION
+
+        endian :little
+
+        uint32           :next_offset,      label: 'Next Entry Offset'
+        uint32           :file_index,       label: 'File Index'
+        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           :end_of_file,      label: 'End of File'
+        uint64           :allocation_size,  label: 'Allocated Size'
+        file_attributes  :file_attributes,  label: 'File Attributes'
+        uint32           :file_name_length, label: 'File Name Length',  initial_value: -> { file_name.do_num_bytes }
+        string16         :file_name,        label: 'File Name',         read_length: -> { file_name_length }
+      end
+    end
+  end
+end

data/lib/ruby_smb/fscc/file_information/file_disposition_information.rb

@@ -0,0 +1,15 @@
+module RubySMB
+  module Fscc
+    module FileInformation
+      # The FileDispositionInformation Class as defined in
+      # [2.4.11 FileDispositionInformation](https://msdn.microsoft.com/en-us/library/cc232098.aspx)
+      class FileDispositionInformation < BinData::Record
+        CLASS_LEVEL = FileInformation::FILE_DISPOSITION_INFORMATION
+
+        endian :little
+
+        uint8 :delete_pending, label: 'Delete Pending', initial_value: 0
+      end
+    end
+  end
+end