ruby_smb 3.2.7 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c3642cdede7c8763296f8249419acad490605d06b8dc546411dab0ab25a7250
-  data.tar.gz: ff2403b3cd0e5b633fcee3db672dee4c4f582d13ac7bfbf3cd1dd7b4c9d2e5f4
+  metadata.gz: 2f696c845250348795f67d3d5b163c65b432acdbcd01bc86d0a6cd81ddcbfc67
+  data.tar.gz: b43dcb4fa6ff4497e61329b8b5a17049a6b445fcdf5c3df61dc380960ea02b9c
 SHA512:
-  metadata.gz: 97bd6b1bdf5b205eb8c21f1d5d980e03a616f7f25dba1219b280a199dbeb72fecc7c9dfe2efd2afa847a3e524f3ea167cc364d79e2be8b72e7e8788cdd5c29b9
-  data.tar.gz: 61ea09ea2cd46411ead8e4bef0ce4c9eb194d8e741b1a1b1bfdd582a260d89e04edc57bd4e47ae0603a1ae125846062dde03a47ff1b17095b8b605b725461d44
+  metadata.gz: 8368cf1844e47161a57051d7b8dfa807b665c898153636b1baedb2211acd4685ef67c5ba167581ce84a9ec7c8c17e812d1f876bb70f34b647bb075bb94861349
+  data.tar.gz: 3b33a185fb3b981147b005e13793aa1f8a09e11c2e5e0dc9b75469ef980ec019bc2dd5e9bef187910f9b5be012d7ca710799b45aa0bdf79547ae3d48de8e22e7

data/lib/ruby_smb/server/server_client/share_io.rb

@@ -11,7 +11,7 @@ module RubySMB
           end
 
           logger.debug("Received #{SMB1::Commands.name(request.smb_header.command)} request for share: #{share_processor.provider.name}")
-          share_processor.send(__callee__, request)
+          share_processor.share_io(__callee__, request)
         end
 
         alias :do_close_smb1          :proxy_share_io_smb1
@@ -29,7 +29,7 @@ module RubySMB
           end
 
           logger.debug("Received #{SMB2::Commands.name(request.smb2_header.command)} request for share: #{share_processor.provider.name}")
-          share_processor.send(__callee__, request)
+          share_processor.share_io(__callee__, request)
         end
 
         alias :do_close_smb2           :proxy_share_io_smb2

data/lib/ruby_smb/server/share/provider/disk.rb

@@ -14,13 +14,13 @@ module RubySMB
           # @param [String] name The name of this share.
           # @param [String, Pathname] path The local file system path to share. This path must be an absolute path to an existing
           #   directory.
-          def initialize(name, path)
+          def initialize(name, path, hooks: nil)
             path = Pathname.new(File.expand_path(path)) if path.is_a?(String)
             raise ArgumentError.new('path must be a directory') unless path.directory? # it needs to exist
             raise ArgumentError.new('path must be absolute') unless path.absolute? # it needs to be absolute so it is independent of the cwd
 
             @path = path
-            super(name)
+            super(name, hooks: hooks)
           end
 
           attr_accessor :path

data/lib/ruby_smb/server/share/provider/processor.rb

@@ -80,6 +80,31 @@ module RubySMB
               @server_client.server
             end
 
+            # Forward a share IO method for a particular request. This is a choke point to allow any hooks that were
+            # registered with the share provider to be executed before and after the specified method is invoked to
+            # process the request and generate the response. This is used for both SMB1 and SMB2 requests.
+            #
+            # @param [Symbol] method_name The method name to forward the request to
+            # @param [RubySMB::GenericPacket] request The request packet to be processed
+            # @return [RubySMB::GenericPacket]
+            def share_io(method_name, request)
+              @provider.hooks.each do |hook|
+                next unless hook.request_class == request.class && hook.location == :before
+
+                request = hook.callback.call(@session, request) || request
+              end
+
+              response = send(method_name, request)
+
+              @provider.hooks.each do |hook|
+                next unless hook.request_class == request.class && hook.location == :after
+
+                response = hook.callback.call(@session, request, response) || response
+              end
+
+              response
+            end
+
             # The underlying share provider that this is a processor for.
             # @!attribute [r] provider
             #   @return [RubySMB::Server::Share::Provider::Base]

data/lib/ruby_smb/server/share/provider/virtual_disk.rb

@@ -14,9 +14,9 @@ module RubySMB
           private_constant :HASH_METHODS
 
           # @param [String] name The name of this share.
-          def initialize(name)
+          def initialize(name, hooks: nil)
             @vfs = {}
-            super(name, add(VirtualPathname.new(self, File::SEPARATOR)))
+            super(name, add(VirtualPathname.new(self, File::SEPARATOR)), hooks: hooks)
           end
 
           # Add a dynamic file to the virtual file system. A dynamic file is one whose contents are generated by the
@@ -86,7 +86,7 @@ module RubySMB
           end
 
           def new_processor(server_client, session)
-            scoped_virtual_disk = self.class.new(@name)
+            scoped_virtual_disk = self.class.new(@name, hooks: @hooks)
             @vfs.each_value do |path|
               path = path.dup
               path.virtual_disk = scoped_virtual_disk if path.is_a?(VirtualPathname)

data/lib/ruby_smb/server/share/provider.rb

@@ -6,9 +6,51 @@ module RubySMB
         # type and name. It is shared across all client connections and
         # sessions.
         class Base
+          Hook = Struct.new(:request_class, :location, :callback)
+
           # @param [String] name The name of this share.
-          def initialize(name)
+          def initialize(name, hooks: nil)
             @name = name
+            @hooks = hooks || []
+          end
+
+          # Add a hook to be called when the specified request class is processed. Any hook that was previously
+          # installed for the request class and location will be removed. A hook installed with a location of :before
+          # will be called with the session and request as the only two arguments. The return value, if provided, will
+          # replace the request that is to be processed. A hook installed with a location of :after will be called with
+          # the session, request and response as the only three arguments. The return value, if provided, will replace
+          # the response that is to be sent to the client.
+          #
+          # @param [RubySMB::GenericPacket] request_class The request class to register the hook for.
+          # @param [Proc] callback The routine to be executed when the request class is being processed.
+          # @param [Symbol] location When the callback should be invoked. Must be either :before or :after.
+          def add_hook(request_class, callback: nil, location: :before, &block)
+            unless %i[ before after ].include?(location)
+              raise ArgumentError, 'the location argument must be :before or :after'
+            end
+
+            unless callback.nil? ^ block.nil?
+              raise ArgumentError, 'either a callback or a block must be specified'
+            end
+
+            # Remove any hooks that were previously installed, this enforces that only one hook can be present at a time
+            # for any particular request class and location combination.
+            remove_hook(request_class, location: location)
+            @hooks << Hook.new(request_class, location, callback || block)
+
+            nil
+          end
+
+          # Remove a hook for the specified request class.
+          #
+          # @param [RubySMB::GenericPacket] request_class The request class to register the hook for.
+          # @param [Symbol] location When the callback should be invoked.
+          def remove_hook(request_class, location: :before)
+            @hooks.filter! do |hook|
+              hook.request_class == request_class && hook.location == location
+            end
+
+            nil
           end
 
           # Create a new, session-specific processor instance for this share.
@@ -28,6 +70,11 @@ module RubySMB
           # @!attribute [r] name
           #   @return [String]
           attr_accessor :name
+
+          # The hooks installed for this share.
+          # @!attribute [r] hooks
+          #   @return [Array]
+          attr_accessor :hooks
         end
       end
     end

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

@@ -35,7 +35,7 @@ module RubySMB
           end
 
           uint64                             :allocation_size,     label: 'Allocation Size'
-          smb_ext_file_attributes            :ext_file_attributes, label: 'Extented File Attributes'
+          smb_ext_file_attributes            :ext_file_attributes, label: 'Extended File Attributes'
           share_access                       :share_access,        label: 'Share Access'
           # The following constants are defined in RubySMB::Dispositions
           uint32                             :create_disposition,  label: 'Create Disposition'

data/lib/ruby_smb/smb2/tree.rb

@@ -85,6 +85,7 @@ module RubySMB
       # @raise [RubySMB::Error::InvalidPacket] if the response is not a QueryDirectoryResponse packet
       def list(directory: nil, pattern: '*', type: RubySMB::Fscc::FileInformation::FileIdFullDirectoryInformation)
         create_response = open_directory(directory: directory)
+        opened_directory = RubySMB::SMB2::File.new(tree: self, response: create_response, name: directory)
         file_id         = create_response.file_id
 
         directory_request                         = RubySMB::SMB2::Packet::QueryDirectoryRequest.new
@@ -127,8 +128,9 @@ module RubySMB
           # Reset the message id so the client can update appropriately.
           directory_request.smb2_header.message_id = 0
         end
-
         files
+      ensure
+        opened_directory.close if opened_directory
       end
 
       # 'Opens' a directory file on the remote end, using a CreateRequest. This

data/lib/ruby_smb/version.rb

@@ -1,3 +1,3 @@
 module RubySMB
-  VERSION = '3.2.7'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/spec/lib/ruby_smb/dcerpc/response_spec.rb

@@ -131,7 +131,7 @@ RSpec.describe RubySMB::Dcerpc::Response do
   end
 
   describe '#stub_length' do
-    let(:stub_length) { rand(0xFF) }
+    let(:stub_length) { rand(1..0xFF) }
     before :example do
       packet.stub = 'A' * stub_length
     end
@@ -142,7 +142,7 @@ RSpec.describe RubySMB::Dcerpc::Response do
 
     context 'with auth verifier' do
       it 'returns the correct stub length' do
-        auth_size = rand(0xFF)
+        auth_size = rand(1..0xFF)
         packet.pdu_header.auth_length = auth_size
         packet.auth_value = 'B' * auth_size
         expect(packet.stub_length).to eq(stub_length + packet.auth_pad.num_bytes)
@@ -152,8 +152,8 @@ RSpec.describe RubySMB::Dcerpc::Response do
 
   describe '#read' do
     let(:response) { described_class.new }
-    let(:auth_size) { rand(0xFF) }
-    let(:stub_size) { rand(0xFF) }
+    let(:auth_size) { rand(1..0xFF) }
+    let(:stub_size) { rand(1..0xFF) }
     before :example do
       response.pdu_header.auth_length = auth_size
       response.stub = 'A' * stub_size
@@ -176,5 +176,3 @@ RSpec.describe RubySMB::Dcerpc::Response do
     expect(described_class.read(binary)).to eq(packet)
   end
 end
-
-

data/spec/lib/ruby_smb/smb2/tree_spec.rb

@@ -166,10 +166,14 @@ RSpec.describe RubySMB::SMB2::Tree do
     let(:create_res) { double('create response') }
     let(:query_dir_req) { RubySMB::SMB2::Packet::QueryDirectoryRequest.new }
     let(:query_dir_res) { RubySMB::SMB2::Packet::QueryDirectoryResponse.new }
+    let(:open_dir) { instance_double(RubySMB::SMB2::File) }
 
     before :example do
       allow(tree).to receive(:open_directory).and_return(create_res)
       allow(create_res).to receive(:file_id)
+      allow(RubySMB::SMB2::File).to receive(:new).and_return(open_dir)
+      allow(open_dir).to receive(:close)
+      allow(create_res).to receive(:file_attributes)
       allow(RubySMB::SMB2::Packet::QueryDirectoryRequest).to receive(:new).and_return(query_dir_req)
       allow(client).to receive(:send_recv)
       allow(RubySMB::SMB2::Packet::QueryDirectoryResponse).to receive(:read).and_return(query_dir_res)
@@ -180,6 +184,7 @@ RSpec.describe RubySMB::SMB2::Tree do
       dir = '/dir'
       expect(tree).to receive(:open_directory).with(directory: dir).and_return(create_res)
       tree.list(directory: dir)
+      expect(open_dir).to have_received(:close)
     end
 
     it 'uses the File ID from the create response' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_smb
 version: !ruby/object:Gem::Version
-  version: 3.2.7
+  version: 3.3.0
 platform: ruby
 authors:
 - Metasploit Hackers
@@ -38,7 +38,7 @@ cert_chain:
   DgscAao7wB3xW2BWEp1KnaDWkf1x9ttgoBEYyuYwU7uatB67kBQG1PKvLt79wHvz
   Dxs+KOjGbBRfMnPgVGYkORKVrZIwlaboHbDKxcVW5xv+oZc7KYXWGg==
   -----END CERTIFICATE-----
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet