ruby_smb 1.0.2 → 2.0.0

data/lib/ruby_smb/smb2/negotiate_context.rb

@@ -0,0 +1,108 @@
+module RubySMB
+  module SMB2
+
+    # An SMB2 PREAUTH_INTEGRITY_CAPABILITIES context struct as defined in
+    # [2.2.3.1.1 SMB2_PREAUTH_INTEGRITY_CAPABILITIES](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/5a07bd66-4734-4af8-abcf-5a44ff7ee0e5)
+    class PreauthIntegrityCapabilities < BinData::Record
+      SHA_512 = 0x0001
+      HASH_ALGORITM_MAP = {
+        SHA_512 => 'SHA512'
+      }
+
+      endian  :little
+
+      uint16 :hash_algorithm_count, label: 'Hash Algorithm Count', initial_value: -> { hash_algorithms.size }
+      uint16 :salt_length,          label: 'Salt Length',          initial_value: -> { salt.num_bytes }
+      array  :hash_algorithms,      label: 'Hash Algorithms',      type: :uint16, initial_length: -> { hash_algorithm_count }
+      string :salt,                 label: 'Salt',                 read_length: -> { salt_length }
+    end
+
+    # An SMB2 ENCRYPTION_CAPABILITIES context struct as defined in
+    # [2.2.3.1.2 SMB2_ENCRYPTION_CAPABILITIES](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/16693be7-2b27-4d3b-804b-f605bde5bcdd)
+    class EncryptionCapabilities < BinData::Record
+      AES_128_CCM = 0x0001
+      AES_128_GCM = 0x0002
+      ENCRYPTION_ALGORITHM_MAP = {
+        AES_128_CCM => 'AES-128-CCM',
+        AES_128_GCM => 'AES-128-GCM'
+      }
+
+      endian  :little
+
+      uint16 :cipher_count, label: 'Cipher Count', initial_value: -> { ciphers.size }
+      array  :ciphers,      label: 'Ciphers',      type: :uint16, initial_length: -> { cipher_count }
+    end
+
+    # An SMB2 COMPRESSION_CAPABILITIES context struct as defined in
+    # [2.2.3.1.3 SMB2_COMPRESSION_CAPABILITIES](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/78e0c942-ab41-472b-b117-4a95ebe88271)
+    class CompressionCapabilities < BinData::Record
+      # Flags
+      # Chained compression is not supported.
+      SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE    = 0x00000000
+      # Chained compression is supported on this connection.
+      SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED = 0x00000001
+
+      # Compression Algorithms
+      NONE         = 0x0000
+      LZNT1        = 0x0001
+      LZ77         = 0x0002
+      LZ77_Huffman = 0x0003
+      Pattern_V1   = 0x0004
+      COMPRESSION_ALGORITHM_MAP = {
+        NONE         => 'NONE',
+        LZNT1        => 'LZNT1',
+        LZ77         => 'LZ77',
+        LZ77_Huffman => 'LZ77_Huffman',
+        Pattern_V1   => 'Pattern_V1'
+      }
+
+      endian  :little
+
+      uint16 :compression_algorithm_count, label: 'Compression Algorithm Count', initial_value: -> { compression_algorithms.size }
+      uint16 :padding,                     label: 'Padding',                     initial_value: 0
+      uint32 :flags,                       label: 'Flags'
+      array  :compression_algorithms,      label: 'Compression Algorithms',      type: :uint16, initial_length: -> { compression_algorithm_count }
+    end
+
+    # An SMB2 NETNAME_NEGOTIATE_CONTEXT_ID context struct as defined in
+    # [2.2.3.1.4 SMB2_NETNAME_NEGOTIATE_CONTEXT_ID](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/ca6726bd-b9cf-43d9-b0bc-d127d3c993b3)
+    class NetnameNegotiateContextId < BinData::Record
+      endian  :little
+
+      stringz16 :net_name, label: 'Net Name'
+    end
+
+
+    # An SMB2 NEGOTIATE_CONTEXT struct as defined in
+    # [2.2.3.1 SMB2 NEGOTIATE_CONTEXT Request Values](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/15332256-522e-4a53-8cd7-0bd17678a2f7)
+    class NegotiateContext < BinData::Record
+      # The NegotiateContext Data field contains a list of preauthentication integrity hash functions as well as an optional salt value, as specified in section 2.2.3.1.1.
+      SMB2_PREAUTH_INTEGRITY_CAPABILITIES  = 0x0001
+      # The NegotiateContext Data field contains a list of encryption algorithms, as specified in section 2.2.3.1.2.
+      SMB2_ENCRYPTION_CAPABILITIES         = 0x0002
+      # The NegotiateContext Data field contains a list of compression algorithms, as specified in section 2.2.3.1.3.
+      SMB2_COMPRESSION_CAPABILITIES        = 0x0003
+      # The NegotiateContext Data field contains the server name to which the client connects.
+      SMB2_NETNAME_NEGOTIATE_CONTEXT_ID    = 0x0005
+
+      endian  :little
+
+      string :pad,          label: 'Padding',     length: -> { pad_length }
+      uint16 :context_type, label: 'Context Type'
+      uint16 :data_length,  label: 'Data Length', initial_value: -> { data.num_bytes }
+      uint32 :reserved,     label: 'Reserved',    initial_value: 0
+      choice :data,         label: 'Data',        selection: -> { context_type } do
+        preauth_integrity_capabilities SMB2_PREAUTH_INTEGRITY_CAPABILITIES, label: 'Preauthentication Integrity Capabilities'
+        encryption_capabilities        SMB2_ENCRYPTION_CAPABILITIES,        label: 'Encryption Capabilities'
+        compression_capabilities       SMB2_COMPRESSION_CAPABILITIES,       label: 'Compression Capabilities'
+        netname_negotiate_context_id   SMB2_NETNAME_NEGOTIATE_CONTEXT_ID,   label: 'Netname Negotiate Context ID'
+      end
+
+      def pad_length
+        offset = pad.abs_offset % 8
+        (8 - offset) % 8
+      end
+
+    end
+  end
+end

data/lib/ruby_smb/smb2/packet.rb

@@ -30,6 +30,8 @@ module RubySMB
       require 'ruby_smb/smb2/packet/write_response'
       require 'ruby_smb/smb2/packet/ioctl_request'
       require 'ruby_smb/smb2/packet/ioctl_response'
+      require 'ruby_smb/smb2/packet/transform_header'
+      require 'ruby_smb/smb2/packet/compression_transform_header'
     end
   end
 end

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

@@ -4,6 +4,8 @@ module RubySMB
       # 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
+        COMMAND = RubySMB::SMB2::Commands::CLOSE
+
         endian :little
 
         smb2_header           :smb2_header
@@ -12,10 +14,6 @@ module RubySMB
         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

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

@@ -4,6 +4,8 @@ module RubySMB
       # 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
+        COMMAND = RubySMB::SMB2::Commands::CLOSE
+
         endian :little
 
         smb2_header      :smb2_header
@@ -20,7 +22,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command     = RubySMB::SMB2::Commands::CLOSE
           smb2_header.flags.reply = 1
         end
       end

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

@@ -0,0 +1,41 @@
+module RubySMB
+  module SMB2
+    module Packet
+      # An SMB2 COMPRESSION_TRANSFORM_HEADER Packet as defined in
+      # [2.2.42 SMB2 COMPRESSION_TRANSFORM_HEADER](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/1d435f21-9a21-4f4c-828e-624a176cf2a0)
+      class CompressionTransformHeader < BinData::Record
+        endian :little
+
+        bit32            :protocol,                         label: 'Protocol ID Field',      initial_value: 0xFC534D42
+        uint32           :original_compressed_segment_size, label: 'Original Compressed Segment Size'
+        uint16           :compression_algorithm,            label: 'Compression Algorithm'
+        uint16           :flags,                            label: 'Flags'
+        uint32           :offset,                           label: 'Offset / Length'
+      end
+
+      # An SMB2 SMB2_COMPRESSION_TRANSFORM_HEADER_PAYLOAD Packet as defined in
+      # [2.2.42.1 SMB2_COMPRESSION_TRANSFORM_HEADER_PAYLOAD](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/8898e8e7-f1b2-47f5-a525-2ce5bad6db64)
+      class Smb2CompressionPayloadHeader < BinData::Record
+        endian :little
+        hide   :reserved
+
+        uint16           :algorithm_id,                     label: 'Algorithm ID'
+        uint16           :reserved
+        uint32           :payload_length,                   label: 'Compressed Payload Length'
+      end
+
+      # An SMB2 SMB2_COMPRESSION_PATTERN_PAYLOAD_V1 Packet as defined in
+      # [2.2.42.2 SMB2_COMPRESSION_PATTERN_PAYLOAD_V1](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/f6859837-395a-4d0a-8971-1fc3919e2d09)
+      class Smb2CompressionPatternPayloadV1 < BinData::Record
+        endian :little
+        hide   :reserved1, :reserved2
+
+        uint8            :pattern,                          label: 'Pattern'
+        uint8            :reserved1
+        uint16           :reserved2
+        uint32           :repetitions,                      label: 'Repetitions'
+      end
+    end
+  end
+end
+

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

@@ -4,6 +4,8 @@ module RubySMB
       # 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
+        COMMAND = RubySMB::SMB2::Commands::CREATE
+
         require 'ruby_smb/smb1/bit_field/create_options'
 
         endian :little
@@ -44,10 +46,6 @@ module RubySMB
 
         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

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

@@ -4,6 +4,8 @@ module RubySMB
       # 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
+        COMMAND = RubySMB::SMB2::Commands::CREATE
+
         endian :little
         smb2_header           :smb2_header
         uint16                :structure_size,       label: 'Structure Size', initial_value: 89
@@ -26,7 +28,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command = RubySMB::SMB2::Commands::CREATE
           smb2_header.flags.reply = 1
         end
       end

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

@@ -4,15 +4,13 @@ module RubySMB
       # An SMB2 Echo Request Packet as defined in
       # [2.2.28 SMB2 ECHO Request](https://msdn.microsoft.com/en-us/library/cc246540.aspx)
       class EchoRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::ECHO
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size, label: 'Structure Size', initial_value: 4
         uint16       :reserved
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::ECHO
-        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Echo response Packet as defined in
       # [2.2.29 SMB2 ECHO Response](https://msdn.microsoft.com/en-us/library/cc246541.aspx)
       class EchoResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::ECHO
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size, label: 'Structure Size', initial_value: 4
@@ -11,7 +13,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command = RubySMB::SMB2::Commands::ECHO
           smb2_header.flags.reply = 1
         end
       end

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

@@ -1,12 +1,24 @@
 module RubySMB
   module SMB2
     module Packet
-      # An SMB2 Error packet for when an incomplete response comes back
+      # This class represents an SMB2 Error Response Packet as defined in
+      # [2.2.2 SMB2 ERROR Response](https://msdn.microsoft.com/en-us/library/cc246530.aspx)
       class ErrorPacket < RubySMB::GenericPacket
+        attr_accessor :original_command
+
         endian       :little
         smb2_header  :smb2_header
-        uint16       :structure_size, label: 'Structure Size', initial_value: 4
-        uint8        :error_data
+        uint16       :structure_size,      label: 'Structure Size', initial_value: 9
+        uint8        :error_context_count, label: 'ErrorContextCount'
+        uint8        :reserved
+        uint32       :byte_count,          label: 'Byte Count of ErrorData'
+        string       :error_data,          label: 'Error Data', read_length: -> { byte_count }
+
+        def valid?
+          return smb2_header.protocol == RubySMB::SMB2::SMB2_PROTOCOL_ID &&
+                 smb2_header.command == @original_command &&
+                 structure_size == 9
+        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Ioctl Request Packet as defined in
       # [2.2.31 SMB2 IOCTL Request](https://msdn.microsoft.com/en-us/library/cc246545.aspx)
       class IoctlRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::IOCTL
+
         endian :little
 
         smb2_header   :smb2_header
@@ -30,11 +32,6 @@ module RubySMB
         uint32  :reserved2, label: 'Reserved Space'
         string  :buffer,    label: 'Input Buffer', read_length: -> { input_count + output_count }
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::IOCTL
-        end
-
         # Calculates the value for the input_offset field.
         # If the input buffer is empty then this should be set to 0,
         # otherwise it should return the absolute offset of the input buffer.

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Ioctl Response Packet as defined in
       # [2.2.32 SMB2 IOCTL Response](https://msdn.microsoft.com/en-us/library/cc246548.aspx)
       class IoctlResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::IOCTL
+
         endian :little
 
         smb2_header   :smb2_header
@@ -22,7 +24,6 @@ module RubySMB
         def initialize_instance
           super
           smb2_header.flags.reply = 1
-          smb2_header.command     = RubySMB::SMB2::Commands::IOCTL
         end
 
         def input_data

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

@@ -4,15 +4,13 @@ module RubySMB
       # An SMB2 LOGOFF Request Packet as defined in
       # [2.2.7 SMB2 LOGOFF Request](https://msdn.microsoft.com/en-us/library/cc246565.aspx)
       class LogoffRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::LOGOFF
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size, label: 'Structure Size', initial_value: 4
         uint16       :reserved,       label: 'Reserved Space'
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::LOGOFF
-        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 LOGOFF Response Packet as defined in
       # [2.2.8 SMB2 LOGOFF Response](https://msdn.microsoft.com/en-us/library/cc246566.aspx)
       class LogoffResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::LOGOFF
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size, label: 'Structure Size', initial_value: 4
@@ -11,7 +13,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command = RubySMB::SMB2::Commands::LOGOFF
           smb2_header.flags.reply = 1
         end
       end

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

@@ -1,33 +1,39 @@
+require 'ruby_smb/smb2/negotiate_context'
+
 module RubySMB
   module SMB2
     module Packet
       # An SMB2 NEGOTIATE Request packet as defined by
       # [2.2.3 SMB2 NEGOTIATE Request](https://msdn.microsoft.com/en-us/library/cc246543.aspx)
       class NegotiateRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::NEGOTIATE
+
         endian              :little
         smb2_header         :smb2_header
-        uint16              :structure_size,      label: 'Structure Size', initial_value: 36
-        uint16              :dialect_count,       label: 'Dialect Count'
-        smb2_security_mode  :security_mode
-        uint16              :reserved1, label: 'Reserved', initial_value: 0
-        smb2_capabilities   :capabilities
-        string              :client_guid,         label: 'Client GUID',        length: 16
-        file_time           :client_start_time,   label: 'Client Start Time',  initial_value: 0
-        array               :dialects,            label: 'Dialects',           type: :uint16, read_until: :eof
-
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::NEGOTIATE
+        uint16              :structure_size,           label: 'Structure Size', initial_value: 36
+        uint16              :dialect_count,            label: 'Dialect Count', initial_value: -> { dialects.size }
+        smb2_security_mode  :security_mode,            label: 'Security Mode'
+        uint16              :reserved1,                label: 'Reserved', initial_value: 0
+        smb2_capabilities   :capabilities,             label: 'Capabilities'
+        string              :client_guid,              label: 'Client GUID', length: 16
+        struct              :negotiate_context_info,   label: 'Negotiate Context Info', onlyif: -> { has_negotiate_context? } do
+          uint32            :negotiate_context_offset, label: 'Negotiate Context Offset', initial_value: -> { negotiate_context_list.abs_offset }
+          uint16            :negotiate_context_count,  label: 'Negotiate Context Count', initial_value: -> { negotiate_context_list.size }
+          uint16            :reserved2,                label: 'Reserved', initial_value: 0
         end
+        file_time           :client_start_time,        label: 'Client Start Time', initial_value: 0, onlyif: -> { !has_negotiate_context? }
+        array               :dialects,                 label: 'Dialects', type: :uint16, initial_length: -> { dialect_count }
+        string              :pad,                      label: 'Padding', length: -> { pad_length(self.dialects) }, onlyif: -> { has_negotiate_context? }
+        array               :negotiate_context_list,   label: 'Negotiate Context List', type: :negotiate_context, onlyif: -> { has_negotiate_context? }, read_until: :eof
 
-        # Adds a dialect to the Dialects array and increments the dialect count
+        # Adds a dialect to the Dialects array
         #
         # @param [Fixnum] the numeric code for the dialect you wish to add
         # @return [Array<Fixnum>] the array of all currently selected dialects
+        # @raise [ArgumentError] if the dialect is not an Integer
         def add_dialect(dialect)
-          return ArgumentError, 'Must be a number' unless dialect.is_a? Integer
-          self.dialect_count += 1
-          dialects << dialect
+          raise ArgumentError, 'Must be a number' unless dialect.is_a? Integer
+          self.dialects << dialect
         end
 
         # Takes an array of dialects and sets it on the packet. Also updates
@@ -38,12 +44,40 @@ module RubySMB
         # @return [Array<Fixnum>] the current value of the dialects array
         def set_dialects(add_dialects = [])
           self.dialects = []
-          self.dialect_count = 0
           add_dialects.each do |dialect|
             add_dialect(dialect)
           end
           dialects
         end
+
+        # Adds a Negotiate Context to the #negotiate_context_list
+        #
+        # @param [NegotiateContext] the Negotiate Context structure you wish to add
+        # @return [Array<Fixnum>] the array of all currently added Negotiate Contexts
+        # @raise [ArgumentError] if the dialect is not a NegotiateContext structure
+        def add_negotiate_context(nc)
+          raise ArgumentError, 'Must be a NegotiateContext' unless nc.is_a? NegotiateContext
+          previous_element = negotiate_context_list.last || negotiate_context_list
+          pad_length = pad_length(previous_element)
+          self.negotiate_context_list << nc
+          self.negotiate_context_list.last.pad = "\x00" * pad_length
+          self.negotiate_context_list
+        end
+
+
+        private
+
+        # Determines the correct length for the padding, so that the next
+        # field is 8-byte aligned.
+        def pad_length(prev_element)
+          offset = (prev_element.abs_offset + prev_element.to_binary_s.length) % 8
+          (8 - offset) % 8
+        end
+
+        # Return true if the dialect version requires Negotiate Contexts
+        def has_negotiate_context?
+          dialects.any? { |dialect| dialect.to_i == 0x0311 }
+        end
       end
     end
   end