ruby_smb 3.1.1 → 3.1.4

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

@@ -0,0 +1,116 @@
+require 'ruby_smb/server/share/provider/disk'
+require 'ruby_smb/server/share/provider/virtual_disk/virtual_file'
+require 'ruby_smb/server/share/provider/virtual_disk/virtual_pathname'
+require 'ruby_smb/server/share/provider/virtual_disk/virtual_stat'
+
+module RubySMB
+  class Server
+    module Share
+      module Provider
+        # This is a share provider that exposes a virtual file system whose entries do not exist on disk.
+        # @since 3.1.1
+        class VirtualDisk < Disk
+          HASH_METHODS = %i[ [] each each_key each_value keys length values ]
+          private_constant :HASH_METHODS
+
+          # @param [String] name The name of this share.
+          def initialize(name)
+            @vfs = {}
+            super(name, add(VirtualPathname.new(self, File::SEPARATOR)))
+          end
+
+          # Add a dynamic file to the virtual file system. A dynamic file is one whose contents are generated by the
+          # specified block. The contents are generated when the share is opened.
+          #
+          # @param [String] path The path of the file to add, relative to the share root.
+          # @param [File::Stat] stat An explicit stat object describing the file.
+          # @yield The content generation routine.
+          # @yieldreturn [String] The generated file content.
+          def add_dynamic_file(path, stat: nil, &block)
+            raise ArgumentError.new('a block must be specified for dynamic files') unless block_given?
+            path = VirtualPathname.cleanpath(path)
+            path = File::SEPARATOR + path unless path.start_with?(File::SEPARATOR)
+            raise ArgumentError.new('must be a file') if stat && !stat.file?
+
+            vf = VirtualDynamicFile.new(self, path, stat: stat, &block)
+            add(vf)
+          end
+
+          # Add a mapped file to the virtual file system. A mapped file is one who is backed by an entry on
+          # disk. The path need not be present, but if it does exist, it must be a file.
+          #
+          # @param [String] path The path of the file to add, relative to the share root.
+          # @param [String, Pathname] mapped_path The path on the local file system to map into the virtual file system.
+          def add_mapped_file(path, mapped_path)
+            path = VirtualPathname.cleanpath(path)
+            path = File::SEPARATOR + path unless path.start_with?(File::SEPARATOR)
+
+            vf = VirtualMappedFile.new(self, path, mapped_path)
+            add(vf)
+          end
+
+          # Add a static file to the virtual file system. A static file is one whose contents are known at creation time
+          # and do not change. If *content* is a file-like object that responds to #read, the data will be read using
+          # that method. Likewise, if *content* has a #stat attribute and *stat* was not specified, then the value of
+          # content's #stat attribute will be used.
+          #
+          # @param [String] path The path of the file to add, relative to the share root.
+          # @param [String, #read, #stat] content The static content to add.
+          # @param [File::Stat] stat An explicit stat object describing the file.
+          def add_static_file(path, content, stat: nil)
+            path = VirtualPathname.cleanpath(path)
+            path = File::SEPARATOR + path unless path.start_with?(File::SEPARATOR)
+            raise ArgumentError.new('must be a file') if stat && !stat.file?
+
+            stat = content.stat if content.respond_to?(:stat) && stat.nil?
+            content = content.read if content.respond_to?(:read)
+            vf = VirtualStaticFile.new(self, path, content, stat: stat)
+            add(vf)
+          end
+
+          def add(virtual_pathname)
+            raise ArgumentError.new('paths must be absolute') unless virtual_pathname.absolute?
+
+            path = virtual_pathname.to_s
+            raise ArgumentError.new('paths must be normalized') unless VirtualPathname.cleanpath(path) == path
+
+            path_parts = path.split(VirtualPathname::SEPARATOR)
+            2.upto(path_parts.length - 1) do |idx|
+              ancestor = path_parts[0...idx].join(path[VirtualPathname::SEPARATOR])
+              next if @vfs[ancestor]&.directory?
+
+              @vfs[ancestor] = VirtualPathname.new(self, ancestor, stat: VirtualStat.new(directory?: true))
+            end
+
+            @vfs[path] = virtual_pathname
+          end
+
+          def new_processor(server_client, session)
+            scoped_virtual_disk = self.class.new(@name)
+            @vfs.each_value do |path|
+              path = path.dup
+              path.virtual_disk = scoped_virtual_disk if path.is_a?(VirtualPathname)
+              path = path.generate(server_client, session) if path.is_a?(VirtualDynamicFile)
+              scoped_virtual_disk.add(path)
+            end
+            self.class::Processor.new(scoped_virtual_disk, server_client, session)
+          end
+
+          private
+
+          def method_missing(symbol, *args)
+            if HASH_METHODS.include?(symbol)
+              return @vfs.send(symbol, *args)
+            end
+
+            raise NoMethodError, "undefined method `#{symbol}' for #{self.class}"
+          end
+
+          def respond_to_missing?(symbol, include_private = false)
+            HASH_METHODS.include?(symbol)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,3 +36,4 @@ end
 
 require 'ruby_smb/server/share/provider/disk'
 require 'ruby_smb/server/share/provider/pipe'
+require 'ruby_smb/server/share/provider/virtual_disk'

data/lib/ruby_smb/server.rb

@@ -6,6 +6,7 @@ module RubySMB
   # Currently, the server only supports negotiating and authenticating requests. No other server functionality is
   # available at this time. The negotiating and authentication is supported for SMB versions 1 through 3.1.1.
   class Server
+    require 'ruby_smb/server/cli'
     require 'ruby_smb/server/server_client'
     require 'ruby_smb/server/session'
     require 'ruby_smb/server/share'
@@ -14,8 +15,10 @@ module RubySMB
     Connection = Struct.new(:client, :thread)
 
     # @param server_sock the socket on which the server should listen
-    # @param [Gss::Provider] the authentication provider
-    def initialize(server_sock: nil, gss_provider: nil, logger: nil)
+    # @param [Gss::Provider] gss_provider the authentication provider
+    # @param [::Logger] logger the logger to use for diagnostic messages
+    # @param thread_factory a block to create threads for serving clients
+    def initialize(server_sock: nil, gss_provider: nil, logger: nil, thread_factory: nil)
       server_sock = ::TCPServer.new(445) if server_sock.nil?
 
       @guid = Random.new.bytes(16)
@@ -36,6 +39,14 @@ module RubySMB
         @logger = logger
       end
 
+      if thread_factory.nil?
+        # the default thread factory uses Ruby's standard Thread#new
+        thread_factory = Proc.new do |_server_client, &block|
+          Thread.new(&block)
+        end
+      end
+      @thread_factory = thread_factory
+
       # share name => provider instance
       @shares = {
         'IPC$' => Share::Provider::IpcPipe.new
@@ -53,7 +64,7 @@ module RubySMB
       loop do
         sock = @socket.accept
         server_client = ServerClient.new(self, RubySMB::Dispatcher::Socket.new(sock, read_timeout: nil))
-        @connections << Connection.new(server_client, Thread.new { server_client.run })
+        @connections << Connection.new(server_client, @thread_factory.call(server_client) { server_client.run })
 
         break unless block.nil? || block.call(server_client)
       end

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

@@ -40,6 +40,17 @@ module RubySMB
         parameter_block   :parameter_block
         data_block        :data_block
 
+        # Takes the specified security buffer string and sets it in the {RubySMB::SMB1::Packet::SessionSetupRequest::DataBlock#security_blob}
+        # field. It also automatically sets the length in
+        # {RubySMB::SMB1::Packet::SessionSetupRequest::ParameterBlock#security_blob_length}
+        #
+        # @param buffer [String] the security buffer
+        # @return [void]
+        def set_security_buffer(buffer)
+          parameter_block.security_blob_length = buffer.length
+          data_block.security_blob = buffer
+        end
+
         # Takes an NTLM Type 1 Message and creates the GSS Security Blob
         # for it and sets it in the {RubySMB::SMB1::Packet::SessionSetupRequest::DataBlock#security_blob}
         # field. It also automatically sets the length in

data/lib/ruby_smb/smb2/tree.rb

@@ -237,6 +237,7 @@ module RubySMB
 
         if read
           create_request.share_access.read_access = 1
+          create_request.desired_access.read_attr = 1
           create_request.desired_access.read_data = 1
         end
 

data/lib/ruby_smb/version.rb

@@ -1,3 +1,3 @@
 module RubySMB
-  VERSION = '3.1.1'.freeze
+  VERSION = '3.1.4'.freeze
 end

data/spec/lib/ruby_smb/fscc/file_information/file_access_information_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileAccessInformation do
+  it 'references the correct class level' do
+    expect(described_class).to be_const_defined(:CLASS_LEVEL)
+    expect(described_class::CLASS_LEVEL).to be RubySMB::Fscc::FileInformation::FILE_ACCESS_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :access_flags }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the access flags in a Uint32 field' do
+    expect(struct.access_flags).to be_a BinData::Uint32le
+  end
+
+end

data/spec/lib/ruby_smb/fscc/file_information/file_alignment_information_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileAlignmentInformation do
+  it 'references the correct class level' do
+    expect(described_class).to be_const_defined(:CLASS_LEVEL)
+    expect(described_class::CLASS_LEVEL).to be RubySMB::Fscc::FileInformation::FILE_ALIGNMENT_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :alignment_requirement }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the alignment requirement in a Uint32 field' do
+    expect(struct.alignment_requirement).to be_a BinData::Uint32le
+  end
+
+end

data/spec/lib/ruby_smb/fscc/file_information/file_all_information_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileAllInformation do
+  it 'references the correct class level' do
+    expect(described_class).to be_const_defined(:CLASS_LEVEL)
+    expect(described_class::CLASS_LEVEL).to be RubySMB::Fscc::FileInformation::FILE_ALL_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+ it { should respond_to :basic_information }
+ it { should respond_to :standard_information }
+ it { should respond_to :internal_information }
+ it { should respond_to :ea_information }
+ it { should respond_to :access_information }
+ it { should respond_to :position_information }
+ it { should respond_to :mode_information }
+ it { should respond_to :alignment_information }
+ it { should respond_to :name_information }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the basic information in a FileBasicInformation field' do
+    expect(struct.basic_information).to be_a RubySMB::Fscc::FileInformation::FileBasicInformation
+  end
+
+  it 'tracks the standard information in a FileStandardInformation field' do
+    expect(struct.standard_information).to be_a RubySMB::Fscc::FileInformation::FileStandardInformation
+  end
+
+  it 'tracks the internal information in a FileInternalInformation field' do
+    expect(struct.internal_information).to be_a RubySMB::Fscc::FileInformation::FileInternalInformation
+  end
+
+  it 'tracks the ea information in a FileEaInformation field' do
+    expect(struct.ea_information).to be_a RubySMB::Fscc::FileInformation::FileEaInformation
+  end
+
+  it 'tracks the access information in a FileAccessInformation field' do
+    expect(struct.access_information).to be_a RubySMB::Fscc::FileInformation::FileAccessInformation
+  end
+
+  it 'tracks the position information in a FilePositionInformation field' do
+    expect(struct.position_information).to be_a RubySMB::Fscc::FileInformation::FilePositionInformation
+  end
+
+  it 'tracks the mode information in a FileModeInformation field' do
+    expect(struct.mode_information).to be_a RubySMB::Fscc::FileInformation::FileModeInformation
+  end
+
+  it 'tracks the alignment information in a FileAlignmentInformation field' do
+    expect(struct.alignment_information).to be_a RubySMB::Fscc::FileInformation::FileAlignmentInformation
+  end
+
+  it 'tracks the name information in a FileNameInformation field' do
+    expect(struct.name_information).to be_a RubySMB::Fscc::FileInformation::FileNameInformation
+  end
+end
+

data/spec/lib/ruby_smb/fscc/file_information/file_basic_information_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileBasicInformation do
+  it 'references the correct class level' do
+    expect(described_class).to be_const_defined(:CLASS_LEVEL)
+    expect(described_class::CLASS_LEVEL).to be RubySMB::Fscc::FileInformation::FILE_BASIC_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :create_time }
+  it { should respond_to :last_access }
+  it { should respond_to :last_write }
+  it { should respond_to :last_change }
+  it { should respond_to :file_attributes }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the create time in a FileTime field' do
+    expect(struct.create_time).to be_a RubySMB::Field::FileTime
+  end
+
+  it 'tracks the last access time in a FileTime field' do
+    expect(struct.last_access).to be_a RubySMB::Field::FileTime
+  end
+
+  it 'tracks the last write time in a FileTime field' do
+    expect(struct.last_write).to be_a RubySMB::Field::FileTime
+  end
+
+  it 'tracks the last modified time in a FileTime field' do
+    expect(struct.last_change).to be_a RubySMB::Field::FileTime
+  end
+
+  it 'tracks the file attributes in a FileAttributes field' do
+    expect(struct.file_attributes).to be_a RubySMB::Fscc::FileAttributes
+  end
+
+end

data/spec/lib/ruby_smb/fscc/file_information/file_both_directory_information_spec.rb

@@ -27,6 +27,14 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileBothDirectoryInformation do
     expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
   end
 
+  it 'tracks the next offset in a Uint32 field' do
+    expect(struct.next_offset).to be_a BinData::Uint32le
+  end
+
+  it 'tracks the file index in a Uint32 field' do
+    expect(struct.file_index).to be_a BinData::Uint32le
+  end
+
   it 'tracks the creation time in a Filetime field' do
     expect(struct.create_time).to be_a RubySMB::Field::FileTime
   end
@@ -43,6 +51,14 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileBothDirectoryInformation do
     expect(struct.last_change).to be_a RubySMB::Field::FileTime
   end
 
+  it 'tracks the file size in a Int64 field' do
+    expect(struct.end_of_file).to be_a BinData::Int64le
+  end
+
+  it 'tracks the allocation size in a Int64 field' do
+    expect(struct.allocation_size).to be_a BinData::Int64le
+  end
+
   it 'contains the file attributes of the file' do
     expect(struct.file_attributes).to be_a RubySMB::Fscc::FileAttributes
   end
@@ -52,20 +68,53 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileBothDirectoryInformation do
     expect(struct.file_name_length).to eq struct.file_name.do_num_bytes
   end
 
-  it 'automatically encodes the file name in UTF-16LE' do
-    name = 'Hello_world.txt'
-    struct.file_name = name
-    expect(struct.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+  it 'tracks the extended attributes size in a Uint32 field' do
+    expect(struct.ea_size).to be_a BinData::Uint32le
   end
 
-  describe 'reading in from a blob' do
-    it 'uses the file_name_length to know when to stop reading' do
+  it 'tracks the short name length in a Uint8 field' do
+    expect(struct.short_name_length).to be_a BinData::Uint8
+  end
+
+  it 'tracks the short name in a String16 field' do
+    expect(struct.short_name).to be_a RubySMB::Field::String16
+  end
+
+  it 'tracks the file name in a String16 field' do
+    expect(struct.file_name).to be_a RubySMB::Field::String16
+  end
+
+  describe '#short_name' do
+    it 'automatically encodes the short name in UTF-16LE' do
+      name = 'Hello_world.'
+      struct.short_name = name
+      expect(struct.short_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+    end
+
+    it 'is always exactly 24 bytes in length' do
+      struct.short_name = ''
+      expect(struct.short_name.num_bytes).to eq 24
+      struct.short_name = 'Hello_world.'
+      expect(struct.short_name.num_bytes).to eq 24
+    end
+  end
+
+  describe '#file_name' do
+    it 'automatically encodes the file name in UTF-16LE' do
       name = 'Hello_world.txt'
       struct.file_name = name
-      blob = struct.to_binary_s
-      blob << 'AAAA'
-      new_from_blob = described_class.read(blob)
-      expect(new_from_blob.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+      expect(struct.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+    end
+
+    describe 'reading in from a blob' do
+      it 'uses the file_name_length to know when to stop reading' do
+        name = 'Hello_world.txt'
+        struct.file_name = name
+        blob = struct.to_binary_s
+        blob << 'AAAA'
+        new_from_blob = described_class.read(blob)
+        expect(new_from_blob.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+      end
     end
   end
 end

data/spec/lib/ruby_smb/fscc/file_information/file_directory_information_spec.rb

@@ -24,6 +24,14 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileDirectoryInformation do
     expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
   end
 
+  it 'tracks the next offset in a Uint32 field' do
+    expect(struct.next_offset).to be_a BinData::Uint32le
+  end
+
+  it 'tracks the file index in a Uint32 field' do
+    expect(struct.file_index).to be_a BinData::Uint32le
+  end
+
   it 'tracks the creation time in a Filetime field' do
     expect(struct.create_time).to be_a RubySMB::Field::FileTime
   end
@@ -40,6 +48,14 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileDirectoryInformation do
     expect(struct.last_change).to be_a RubySMB::Field::FileTime
   end
 
+  it 'tracks the file size in a Int64 field' do
+    expect(struct.end_of_file).to be_a BinData::Int64le
+  end
+
+  it 'tracks the allocation size in a Int64 field' do
+    expect(struct.allocation_size).to be_a BinData::Int64le
+  end
+
   it 'contains the file attributes of the file' do
     expect(struct.file_attributes).to be_a RubySMB::Fscc::FileAttributes
   end
@@ -49,20 +65,22 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileDirectoryInformation do
     expect(struct.file_name_length).to eq struct.file_name.do_num_bytes
   end
 
-  it 'automatically encodes the file name in UTF-16LE' do
-    name = 'Hello_world.txt'
-    struct.file_name = name
-    expect(struct.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
-  end
-
-  describe 'reading in from a blob' do
-    it 'uses the file_name_length to know when to stop reading' do
+  describe '#file_name' do
+    it 'automatically encodes the file name in UTF-16LE' do
       name = 'Hello_world.txt'
       struct.file_name = name
-      blob = struct.to_binary_s
-      blob << 'AAAA'
-      new_from_blob = described_class.read(blob)
-      expect(new_from_blob.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+      expect(struct.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+    end
+
+    describe 'reading in from a blob' do
+      it 'uses the file_name_length to know when to stop reading' do
+        name = 'Hello_world.txt'
+        struct.file_name = name
+        blob = struct.to_binary_s
+        blob << 'AAAA'
+        new_from_blob = described_class.read(blob)
+        expect(new_from_blob.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+      end
     end
   end
 end

data/spec/lib/ruby_smb/fscc/file_information/file_ea_information_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileEaInformation do
+  it 'references the correct class level' do
+    expect(described_class).to be_const_defined(:CLASS_LEVEL)
+    expect(described_class::CLASS_LEVEL).to be RubySMB::Fscc::FileInformation::FILE_EA_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :ea_size }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the extended attributes size in a Uint32 field' do
+    expect(struct.ea_size).to be_a BinData::Uint32le
+  end
+
+end

data/spec/lib/ruby_smb/fscc/file_information/file_full_directory_information_spec.rb

@@ -25,6 +25,14 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileFullDirectoryInformation do
     expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
   end
 
+  it 'tracks the next offset in a Uint32 field' do
+    expect(struct.next_offset).to be_a BinData::Uint32le
+  end
+
+  it 'tracks the file index in a Uint32 field' do
+    expect(struct.file_index).to be_a BinData::Uint32le
+  end
+
   it 'tracks the creation time in a Filetime field' do
     expect(struct.create_time).to be_a RubySMB::Field::FileTime
   end
@@ -41,6 +49,14 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileFullDirectoryInformation do
     expect(struct.last_change).to be_a RubySMB::Field::FileTime
   end
 
+  it 'tracks the file size in a Int64 field' do
+    expect(struct.end_of_file).to be_a BinData::Int64le
+  end
+
+  it 'tracks the allocation size in a Int64 field' do
+    expect(struct.allocation_size).to be_a BinData::Int64le
+  end
+
   it 'contains the file attributes of the file' do
     expect(struct.file_attributes).to be_a RubySMB::Fscc::FileAttributes
   end
@@ -50,20 +66,22 @@ RSpec.describe RubySMB::Fscc::FileInformation::FileFullDirectoryInformation do
     expect(struct.file_name_length).to eq struct.file_name.do_num_bytes
   end
 
-  it 'automatically encodes the file name in UTF-16LE' do
-    name = 'Hello_world.txt'
-    struct.file_name = name
-    expect(struct.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
-  end
-
-  describe 'reading in from a blob' do
-    it 'uses the file_name_length to know when to stop reading' do
+  describe '#file_name' do
+    it 'automatically encodes the file name in UTF-16LE' do
       name = 'Hello_world.txt'
       struct.file_name = name
-      blob = struct.to_binary_s
-      blob << 'AAAA'
-      new_from_blob = described_class.read(blob)
-      expect(new_from_blob.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+      expect(struct.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+    end
+
+    describe 'reading in from a blob' do
+      it 'uses the file_name_length to know when to stop reading' do
+        name = 'Hello_world.txt'
+        struct.file_name = name
+        blob = struct.to_binary_s
+        blob << 'AAAA'
+        new_from_blob = described_class.read(blob)
+        expect(new_from_blob.file_name.force_encoding('utf-16le')).to eq name.encode('utf-16le')
+      end
     end
   end
 end