ruby_smb 1.0.3 → 2.0.1

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Query Directory Request Packet as defined in
       # [2.2.33 SMB2 QUERY_DIRECTORY Request](https://msdn.microsoft.com/en-us/library/cc246551.aspx)
       class QueryDirectoryRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::QUERY_DIRECTORY
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size,          label: 'Structure Size', initial_value: 33
@@ -25,10 +27,6 @@ module RubySMB
         uint32        :output_length, label: 'Output Buffer Length'
         string16      :name,          label: 'Name/Search Pattern'
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::QUERY_DIRECTORY
-        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Query Directory Response Packet as defined in
       # [2.2.34 SMB2 QUERY_DIRECTORY Response](https://msdn.microsoft.com/en-us/library/cc246552.aspx)
       class QueryDirectoryResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::QUERY_DIRECTORY
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size,  label: 'Structure Size',       initial_value: 9
@@ -13,7 +15,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command = RubySMB::SMB2::Commands::QUERY_DIRECTORY
           smb2_header.flags.reply = 1
         end
 
@@ -23,6 +24,7 @@ module RubySMB
         #
         # @param klass [Class] the FileInformationClass class to read the data as
         # @return [array<BinData::Record>] An array of structs holding the requested information
+        # @raise [RubySMB::Error::InvalidPacket] if the string buffer is not a valid File Information
         def results(klass)
           information_classes = []
           blob = buffer.to_binary_s.dup
@@ -35,7 +37,11 @@ module RubySMB
                      blob.slice!(0, length)
                    end
 
-            information_classes << klass.read(data)
+            begin
+              information_classes << klass.read(data)
+            rescue IOError
+              raise RubySMB::Error::InvalidPacket, "Invalid #{klass} File Information in the string buffer"
+            end
           end
           information_classes
         end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Read Request Packet as defined in
       # [2.2.19 SMB2 READ Request](https://msdn.microsoft.com/en-us/library/cc246527.aspx)
       class ReadRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::READ
+
         endian :little
 
         smb2_header           :smb2_header
@@ -20,10 +22,6 @@ module RubySMB
         uint16                :channel_length,        label: 'Read Channel Info Length'
         string                :buffer,                label: 'Read Channel info Buffer', initial_value: 0x00
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::READ
-        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Read Response Packet as defined in
       # [2.2.20 SMB2 READ Response](https://msdn.microsoft.com/en-us/library/cc246531.aspx)
       class ReadResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::READ
+
         endian :little
 
         smb2_header   :smb2_header
@@ -17,7 +19,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command     = RubySMB::SMB2::Commands::READ
           smb2_header.flags.reply = 1
         end
       end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 SessionSetupRequest Packet as defined in
       # [2.2.5 SMB2 SESSION_SETUP Request](https://msdn.microsoft.com/en-us/library/cc246563.aspx)
       class SessionSetupRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::SESSION_SETUP
+
         endian                     :little
         smb2_header                :smb2_header
         uint16                     :structure_size,          label: 'Structure Size',          initial_value: 25
@@ -16,11 +18,6 @@ module RubySMB
         uint64                     :previous_session_id,     label: 'Previous Session ID'
         string                     :buffer,                  label: 'Security Buffer', length: -> { security_buffer_length }
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::SESSION_SETUP
-        end
-
         # Takes a serialized NTLM Type 1 message and wraps it in the GSS ASN1 encoding
         # and inserts it into the {RubySMB::SMB2::Packet::SessionSetupRequest#buffer}
         # as well as updating the {RubySMB::SMB2::Packet::SessionSetupRequest#security_buffer_length}

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

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

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Set Info Request Packet as defined in
       # [2.2.39 SMB2 SET_INFO Request](https://msdn.microsoft.com/en-us/library/cc246560.aspx)
       class SetInfoRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::SET_INFO
+
         include RubySMB::Fscc::FileInformation
 
         endian :little
@@ -48,10 +50,6 @@ module RubySMB
           file_id_full_directory_information FILE_ID_FULL_DIRECTORY_INFORMATION, label: 'File Id Full Directory Information'
         end
 
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::SET_INFO
-        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module RubySMB
       # An SMB2 Read Response Packet as defined in
       # [2.2.40 SMB2 SET_INFO Response](https://msdn.microsoft.com/en-us/library/cc246562.aspx)
       class SetInfoResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::SET_INFO
+
         endian :little
 
         smb2_header   :smb2_header
@@ -11,7 +13,6 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command     = RubySMB::SMB2::Commands::SET_INFO
           smb2_header.flags.reply = 1
         end
       end

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

@@ -0,0 +1,84 @@
+module RubySMB
+  module SMB2
+    module Packet
+      # An SMB2 TRANSFORM_HEADER Packet as defined in
+      # [2.2.41 SMB2 TRANSFORM_HEADER](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/d6ce2327-a4c9-4793-be66-7b5bad2175fa)
+      class TransformHeader < BinData::Record
+        endian :little
+        hide   :reserved0
+
+        endian           :little
+        bit32            :protocol,              label: 'Protocol ID Field',      initial_value: 0xFD534D42
+        string           :signature,             label: 'Signature', length: 16
+        string           :nonce,                 label: 'Nonce',     length: 16
+        uint32           :original_message_size, label: 'Original Message Size'
+        uint16           :reserved0
+        uint16           :flags,                 label: 'Flags / Encryption Algorithm'
+        uint64           :session_id,            label: 'Session ID'
+        array            :encrypted_data,        label: 'Encrypted Data', type: :uint8, read_until: :eof
+
+        def decrypt(key, algorithm: 'AES-128-GCM')
+          auth_data = self.to_binary_s[20...52]
+          encrypted_data = self.encrypted_data.to_ary.pack('C*')
+
+          case algorithm
+          when 'AES-128-CCM'
+            cipher = OpenSSL::CCM.new('AES', key, 16)
+            unencrypted_data = cipher.decrypt(encrypted_data + self.signature, self.nonce[0...11], auth_data)
+            unless unencrypted_data.length > 0
+              raise OpenSSL::Cipher::CipherError  # raised for consistency with GCM mode
+            end
+          when 'AES-128-GCM'
+            cipher = OpenSSL::Cipher.new(algorithm).decrypt
+            cipher.key = key
+            cipher.iv = self.nonce[0...12]
+            cipher.auth_data = auth_data
+            cipher.auth_tag = self.signature
+            unencrypted_data = cipher.update(encrypted_data)
+            cipher.final # raises OpenSSL::Cipher::CipherError on signature failure
+          else
+            raise ArgumentError.new('Invalid algorithm, must be either AES-128-CCM or AES-128-GCM')
+          end
+
+          unencrypted_data[0...self.original_message_size]
+        rescue Exception => e
+          raise RubySMB::Error::EncryptionError, "Error while decrypting with '#{algorithm}' (#{e.class}: #{e})"
+        end
+
+        def encrypt(unencrypted_data, key, algorithm: 'AES-128-GCM')
+          if unencrypted_data.is_a? BinData::Record
+            unencrypted_data = unencrypted_data.to_binary_s
+          end
+
+          self.original_message_size.assign(unencrypted_data.length)
+
+          case algorithm
+          when 'AES-128-CCM'
+            cipher = OpenSSL::CCM.new('AES', key, 16)
+            random_iv = OpenSSL::Random.random_bytes(11)
+            self.nonce.assign(random_iv)
+            result = cipher.encrypt(unencrypted_data, random_iv, self.to_binary_s[20...52])
+            encrypted_data = result[0...-16]
+            auth_tag = result[-16..-1]
+          when 'AES-128-GCM'
+            cipher = OpenSSL::Cipher.new(algorithm).encrypt
+            cipher.iv_len = 12
+            cipher.key = key
+            self.nonce.assign(cipher.random_iv)
+            cipher.auth_data = self.to_binary_s[20...52]
+            encrypted_data = cipher.update(unencrypted_data) + cipher.final
+            auth_tag = cipher.auth_tag
+          else
+            raise ArgumentError.new('Invalid algorithm, must be either AES-128-CCM or AES-128-GCM')
+          end
+
+          self.encrypted_data.assign(encrypted_data.bytes)
+          self.signature.assign(auth_tag)
+          nil
+        rescue Exception => e
+          raise RubySMB::Error::EncryptionError, "Error while encrypting with '#{algorithm}' (#{e.class}: #{e})"
+        end
+      end
+    end
+  end
+end

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

@@ -1,25 +1,108 @@
 module RubySMB
   module SMB2
     module Packet
+
+
+      # An SMB2 RemotedIdentityTreeConnectContext Packet as defined in
+      # [2.2.9.2.1 SMB2_REMOTED_IDENTITY_TREE_CONNECT Context](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/ee7ff411-93e0-484f-9f73-31916fee4cb8)
+      # TODO: implement helper methods to add each Remote Identity element
+      class RemotedIdentityTreeConnectContext < BinData::Record
+        endian :little
+        uint16 :ticket_type,       label: 'Ticket Type', initial_value: 0x0001
+        uint16 :ticket_size,       label: 'Ticket Size', initial_value: -> { num_bytes }
+        uint16 :user,              label: 'User'
+        uint16 :user_name,         label: 'User Name'
+        uint16 :domain,            label: 'Domain'
+        uint16 :groups,            label: 'Groups'
+        uint16 :restricted_groups, label: 'Restricted Groups'
+        uint16 :privileges,        label: 'Privileges'
+        uint16 :primary_group,     label: 'Primary Group'
+        uint16 :owner,             label: 'Owner'
+        uint16 :default_dacl,      label: 'Default DACL'
+        uint16 :device_groups,     label: 'Device Groups'
+        uint16 :user_claims,       label: 'User Claims'
+        uint16 :device_claims,     label: 'Device Claims'
+        string :ticket_info,       label: 'Ticket Info', read_length: -> { ticket_size - ticket_info.rel_offset}
+      end
+
+      # An SMB2 TreeConnectContext Packet as defined in
+      # [2.2.9.2 SMB2 TREE_CONNECT_CONTEXT Request Values](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/06eaaabc-caca-4776-9daf-82439e90dacd)
+      class TreeConnectContext < BinData::Record
+
+        # Context Types
+
+        # This value is reserved.
+        SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID = 0x0000
+        # The Data field contains remoted identity tree connect context data as
+        # specified in section [2.2.9.2.1](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/ee7ff411-93e0-484f-9f73-31916fee4cb8)
+        SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID = 0x0001
+
+        endian :little
+        uint16 :context_type, label: 'Context Type'
+        uint16 :data_length,  label: 'Data Length', initial_value: -> { data.to_binary_s.size }
+        uint32 :reserved,     label: 'Reserved'
+        choice :data,         label: 'Data', selection: -> { context_type } do
+          remoted_identity_tree_connect_context SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID, label: 'Remoted Identity Tree Connect Context'
+        end
+
+      end
+
+      # An SMB2 TreeConnectRequestExtension Packet as defined in
+      # [2.2.9.1 SMB2 TREE_CONNECT Request Extension](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/9ca7328b-b6ca-41a7-9773-0fa237261b76)
+      class TreeConnectRequestExtension < BinData::Record
+        endian :little
+        uint32   :tree_connect_context_offset, label: 'Tree Connect Context Offset', initial_value: -> { tree_connect_contexts.rel_offset }
+        uint16   :tree_connect_context_count,  label: 'Tree Connect Context Count', initial_value: -> { tree_connect_contexts.size }
+        string   :reserved,                    label: 'Reserved', length: 10
+        string16 :path,                        label: 'Path Buffer'
+        array    :tree_connect_contexts,       label: 'Tree Connect Contexts', type: :tree_connect_context, initial_length: -> { tree_connect_context_count }
+      end
+
       # An SMB2 TreeConnectRequest Packet as defined in
       # [2.2.9 SMB2 TREE_CONNECT Request](https://msdn.microsoft.com/en-us/library/cc246567.aspx)
       class TreeConnectRequest < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::TREE_CONNECT
+
+        # Flags (SMB 3.1.1 only)
+
+        # The client has previously connected to the specified cluster share
+        # using the SMB dialect of the connection on which the request is received.
+        SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT = 0x0001
+        # The client can handle synchronous share redirects via a Share Redirect
+        # error context response as specified in section [2.2.2.2.2](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/f3073a8b-9f0f-47c0-91e5-ec3be9a49f37).
+        SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER = 0x0002
+        # A tree connect request extension, as specified in section
+        # [2.2.9.1](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/9ca7328b-b6ca-41a7-9773-0fa237261b76),
+        # is present, starting at the Buffer field of this tree connect request.
+        SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT = 0x0003
+
         endian       :little
         smb2_header  :smb2_header
         uint16       :structure_size, label: 'Structure Size', initial_value: 9
+        # The flags field is only used by SMB 3.1.1, it must be 0 for other versions
         uint16       :flags,          label: 'Flags',          initial_value: 0x00
-        uint16       :path_offset,    label: 'Path Offset',    initial_value: 0x48
-        uint16       :path_length,    label: 'Path Length',    initial_value: -> { path.length }
-        string       :path,           label: 'Path Buffer'
-
-        def initialize_instance
-          super
-          smb2_header.command = RubySMB::SMB2::Commands::TREE_CONNECT
+        # if SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT flag is set, #path_offset
+        # will have to be updated with the correct offset of the path name,
+        # which is located in the TreeConnect Context.
+        uint16       :path_offset,    label: 'Path Offset',    initial_value: -> do
+          if flags == SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT
+            tree_connect_request_extension.path.abs_offset
+          else
+            path.abs_offset
+          end
         end
-
-        def encode_path(path)
-          self.path = path.encode('utf-16le')
+        # if SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT flag is set, #path_length
+        # will have to be updated with the correct full share path name,
+        # which is located in the TreeConnect Context.
+        uint16       :path_length,    label: 'Path Length',    initial_value: -> do
+          if flags == SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT
+            tree_connect_request_extension.path.to_binary_s.length
+          else
+            path.to_binary_s.length
+          end
         end
+        string16     :path,           label: 'Path Buffer',    onlyif: -> { flags != SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT }
+        tree_connect_request_extension :tree_connect_request_extension, label: 'Tree Connect Request Extension', onlyif: -> { flags == SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT }
       end
     end
   end

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

@@ -4,6 +4,16 @@ module RubySMB
       # An SMB2 TreeConnectResponse Packet as defined in
       # [2.2.10 SMB2 TREE_CONNECT Response](https://msdn.microsoft.com/en-us/library/cc246499.aspx)
       class TreeConnectResponse < RubySMB::GenericPacket
+        COMMAND = RubySMB::SMB2::Commands::TREE_CONNECT
+
+        # Share Types
+        # Physical disk share
+        SMB2_SHARE_TYPE_DISK  = 0x01
+        # Named pipe share
+        SMB2_SHARE_TYPE_PIPE  = 0x02
+        # Printer share
+        SMB2_SHARE_TYPE_PRINT = 0x03
+
         endian :little
         smb2_header           :smb2_header
         uint16                :structure_size, label: 'Structure Size', initial_value: 16
@@ -15,31 +25,9 @@ module RubySMB
 
         def initialize_instance
           super
-          smb2_header.command = RubySMB::SMB2::Commands::TREE_CONNECT
           smb2_header.flags.reply = 1
         end
 
-        # Returns the ACCESS_MASK for the Maximal Share Access Rights. The packet
-        # defaults this to a {RubySMB::SMB2::BitField::DirectoryAccessMask}. If it is anything other than
-        # a directory that has been connected to, it will re-cast it as a {RubySMB::SMB2::BitField::FileAccessMask}
-        #
-        # @return [RubySMB::SMB2::BitField::DirectoryAccessMask] if a directory was connected to
-        # @return [RubySMB::SMB2::BitField::FileAccessMask] if anything else was connected to
-        def access_rights
-          if is_directory?
-            maximal_access
-          else
-            mask = maximal_access.to_binary_s
-            RubySMB::SMB2::BitField::FileAccessMask.read(mask)
-          end
-        end
-
-        # Checks if the remote Tree is a directory
-        #
-        # @return [Boolean]
-        def is_directory?
-          share_type == 0x01
-        end
       end
     end
   end

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

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

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

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