ruby_smb 3.0.6 → 3.1.2

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

@@ -0,0 +1,207 @@
+RSpec.describe RubySMB::Server::Share::Provider::VirtualDisk::VirtualStat do
+  subject(:virtual_stat) { described_class.new }
+
+  it { is_expected.to respond_to :atime }
+  it { is_expected.to respond_to :blksize }
+  it { is_expected.to respond_to :blockdev? }
+  it { is_expected.to respond_to :blocks }
+  it { is_expected.to respond_to :chardev? }
+  it { is_expected.to respond_to :ctime }
+  it { is_expected.to respond_to :dev }
+  it { is_expected.to respond_to :directory? }
+  it { is_expected.to respond_to :executable? }
+  it { is_expected.to respond_to :file? }
+  it { is_expected.to respond_to :ftype }
+  it { is_expected.to respond_to :gid }
+  it { is_expected.to respond_to :grpowned? }
+  it { is_expected.to respond_to :ino }
+  it { is_expected.to respond_to :mode }
+  it { is_expected.to respond_to :mtime }
+  it { is_expected.to respond_to :nlink }
+  it { is_expected.to respond_to :owned? }
+  it { is_expected.to respond_to :pipe? }
+  it { is_expected.to respond_to :readable? }
+  it { is_expected.to respond_to :setgid? }
+  it { is_expected.to respond_to :setuid? }
+  it { is_expected.to respond_to :size }
+  it { is_expected.to respond_to :socket? }
+  it { is_expected.to respond_to :sticky? }
+  it { is_expected.to respond_to :symlink? }
+  it { is_expected.to respond_to :uid }
+  it { is_expected.to respond_to :world_readable? }
+  it { is_expected.to respond_to :world_writable? }
+  it { is_expected.to respond_to :writable? }
+  it { is_expected.to respond_to :zero? }
+
+  describe '#initialize' do
+    it 'defaults to being a directory' do
+      expect(virtual_stat.directory?).to be true
+    end
+
+    it 'throws an exception when it is both a file and a directory' do
+      expect { described_class.new(directory?: true, file?: true) }.to raise_error(ArgumentError)
+    end
+
+    it 'throws an exception when it is neither a file or a directory' do
+      expect { described_class.new(directory?: false, file?: false) }.to raise_error(ArgumentError)
+    end
+
+    it 'is a directory when it is a directory' do
+      expect(described_class.new(directory?: true).directory?).to be true
+    end
+
+    it 'is a directory when not a file' do
+      expect(described_class.new(file?: false).directory?).to be true
+    end
+
+    it 'is a file when it is a file' do
+      expect(described_class.new(file?: true).file?).to be true
+    end
+
+    it 'is a file when not a directory' do
+      expect(described_class.new(directory?: false).file?).to be true
+    end
+  end
+
+  describe '#atime' do
+    it 'is expected to default to now' do
+      now = Time.now
+      expect(Time).to receive(:now).and_return(now)
+      expect(virtual_stat.atime).to eq now
+    end
+  end
+
+  describe '#ctime' do
+    it 'is expected to default to now' do
+      now = Time.now
+      expect(Time).to receive(:now).and_return(now)
+      expect(virtual_stat.ctime).to eq now
+    end
+  end
+
+  describe '#mtime' do
+    it 'is expected to default to now' do
+      now = Time.now
+      expect(Time).to receive(:now).and_return(now)
+      expect(virtual_stat.mtime).to eq now
+    end
+  end
+
+  describe '#birthtime' do
+    it 'is expected to default to now' do
+      now = Time.now
+      expect(Time).to receive(:now).and_return(now)
+      expect(virtual_stat.birthtime).to eq now
+    end
+  end
+
+  describe '#uid' do
+    it 'is expected to default to the current process uid' do
+      expect(virtual_stat.uid).to eq Process.uid
+    end
+  end
+
+  describe '#owned?' do
+    it 'is expected to return true when uid is this process' do
+      expect(virtual_stat).to receive(:uid).and_return(Process.uid)
+      expect(virtual_stat.owned?).to be true
+    end
+
+    it 'is expected to return false when uid is not this process' do
+      expect(virtual_stat).to receive(:uid)
+      expect(virtual_stat.owned?).to be false
+    end
+  end
+
+  describe '#gid' do
+    it 'is expected to default to the current process gid' do
+      expect(virtual_stat.gid).to eq Process.gid
+    end
+  end
+
+  describe '#grpowned?' do
+    it 'is expected to return true when gid is this process' do
+      expect(virtual_stat).to receive(:gid).and_return(Process.gid)
+      expect(virtual_stat.grpowned?).to be true
+    end
+
+    it 'is expected to return false when gid is not this process' do
+      expect(virtual_stat).to receive(:gid)
+      expect(virtual_stat.grpowned?).to be false
+    end
+  end
+
+  describe '#readable?' do
+    it 'is expected to readable by default' do
+      expect(virtual_stat.readable?).to be true
+    end
+  end
+
+  describe '#writable?' do
+    it 'is expected to writable by default' do
+      expect(virtual_stat.writable?).to be true
+    end
+  end
+
+  describe '#ftype' do
+    it 'is expected to be a String' do
+      expect(virtual_stat.ftype).to be_a String
+    end
+  end
+
+  # test each and every permission represented by the 12 possible bits
+  (0..12).each.map { |bit| (1 << bit) & 0o7777 }.each do |mode|
+    context "when mode is 0o#{mode.to_s(8).rjust(4, '0')}" do
+      before(:each) { expect(virtual_stat).to receive(:mode).at_least(:once).and_return(mode) }
+
+      describe '#executable?' do
+        it 'is correct' do
+          expect(virtual_stat.executable?).to eq mode & 0o111 != 0
+        end
+      end
+
+      describe '#readable?' do
+        it 'is correct' do
+          expect(virtual_stat.readable?).to eq mode & 0o444 != 0
+        end
+      end
+
+      describe '#setgid?' do
+        it 'is correct' do
+          expect(virtual_stat.setgid?).to eq mode & 0o2000 != 0
+        end
+      end
+
+      describe '#setuid?' do
+        it 'is correct' do
+          expect(virtual_stat.setuid?).to eq mode & 0o4000 != 0
+        end
+      end
+
+      describe '#sticky?' do
+        it 'is correct' do
+          expect(virtual_stat.sticky?).to eq mode & 0o1000 != 0
+        end
+      end
+
+      describe '#world_readable?' do
+        it 'is correct' do
+          expect(virtual_stat.world_readable?).to eq mode & 0o004 != 0
+        end
+      end
+
+      describe '#world_writable?' do
+        it 'is correct' do
+          expect(virtual_stat.world_writable?).to eq mode & 0o002 != 0
+        end
+      end
+
+      describe '#writable?' do
+        it 'is correct' do
+          expect(virtual_stat.writable?).to eq mode & 0o222 != 0
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,122 @@
+RSpec.describe RubySMB::Server::Share::Provider::VirtualDisk do
+  let(:name) { 'vdisk' }
+  subject(:virtual_disk) { described_class.new(name) }
+
+  it { is_expected.to respond_to :name }
+  it { is_expected.to respond_to :path }
+  it { is_expected.to respond_to :type }
+  context 'it provides the basic Hash methods' do
+    it { is_expected.to respond_to :[] }
+    it { is_expected.to respond_to :each }
+    it { is_expected.to respond_to :each_key }
+    it { is_expected.to respond_to :each_value }
+    it { is_expected.to respond_to :keys }
+    it { is_expected.to respond_to :length }
+    it { is_expected.to respond_to :values }
+  end
+
+  describe '#add' do
+    let(:path) { '/path' }
+
+    it 'does not throw an exception if the stat object is not a file' do
+      stat = RubySMB::Server::Share::Provider::VirtualDisk::VirtualStat.new(file?: false)
+      vp = RubySMB::Server::Share::Provider::VirtualDisk::VirtualPathname.new({}, path, stat: stat)
+      expect { virtual_disk.add(vp) }.not_to raise_error
+    end
+
+    it 'throws an exception if the path is not absolute' do
+      vp = RubySMB::Server::Share::Provider::VirtualDisk::VirtualPathname.new({}, path[1..])
+      expect { virtual_disk.add(vp) }.to raise_error(ArgumentError)
+    end
+
+    it 'automatically creates parent directories' do
+      expect(virtual_disk.length).to eq 1 # starts with just the root folder
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualPathname).to receive(:new).exactly(3).times.and_call_original
+      virtual_disk.add(RubySMB::Server::Share::Provider::VirtualDisk::VirtualPathname.new({}, File.join(path, 'sub', 'dir')))
+      expect(virtual_disk.length).to eq 4 # ends with the added item and 2 parent folders
+    end
+  end
+
+  describe '#add_dynamic_file' do
+    let(:path) { 'path' }
+    let(:content) { 'Hello World!' }
+    let(:block) { Proc.new { content } }
+
+    before(:each) { allow(virtual_disk).to receive(:add) }
+
+    it 'normalizes the path argument' do
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualDynamicFile).to receive(:new).with(virtual_disk, File::SEPARATOR + path, stat: nil, &block)
+      virtual_disk.add_dynamic_file(path + '/dir/..', &block)
+    end
+
+    it 'initializes a new VirtualDynamicFile instance' do
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualDynamicFile).to receive(:new)
+      virtual_disk.add_dynamic_file(path, &block)
+    end
+
+    it 'adds the mapped file' do
+      expect(virtual_disk).to receive(:add)
+      expect(virtual_disk.add_dynamic_file(path, &block))
+    end
+
+    it 'throws an exception if the stat object is not a file' do
+      stat = RubySMB::Server::Share::Provider::VirtualDisk::VirtualStat.new(file?: false)
+      expect { virtual_disk.add_dynamic_file(path, stat: stat, &block) }. to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#add_mapped_file' do
+    let(:path) { 'path' }
+    let(:mapped_path) { 'mapped_path' }
+
+    before(:each) { allow(virtual_disk).to receive(:add) }
+
+    it 'normalizes the path argument' do
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualMappedFile).to receive(:new).with(virtual_disk, File::SEPARATOR + path, mapped_path)
+      virtual_disk.add_mapped_file(path + '/dir/..', mapped_path)
+    end
+
+    it 'initializes a new VirtualMappedFile instance' do
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualMappedFile).to receive(:new)
+      virtual_disk.add_mapped_file(path, mapped_path)
+    end
+
+    it 'adds the mapped file' do
+      expect(virtual_disk).to receive(:add)
+      expect(virtual_disk.add_mapped_file(path, mapped_path))
+    end
+
+    it 'throws an exception if the stat object is not a file' do
+      stat = RubySMB::Server::Share::Provider::VirtualDisk::VirtualStat.new(file?: false)
+      expect { virtual_disk.add_mapped_file(path, mapped_path, stat: stat) }. to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#add_static_file' do
+    let(:path) { 'path' }
+    let(:content) { 'Hello World!' }
+
+    before(:each) { allow(virtual_disk).to receive(:add) }
+
+    it 'normalizes the path argument' do
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualStaticFile).to receive(:new).with(virtual_disk, File::SEPARATOR + path, content, stat: nil)
+      virtual_disk.add_static_file(path + '/dir/..', content)
+    end
+
+    it 'initializes a new VirtualStaticFile instance' do
+      expect(RubySMB::Server::Share::Provider::VirtualDisk::VirtualStaticFile).to receive(:new)
+      virtual_disk.add_static_file(path, content)
+    end
+
+    it 'adds the mapped file' do
+      expect(virtual_disk).to receive(:add)
+      expect(virtual_disk.add_static_file(path, content))
+    end
+
+    it 'throws an exception if the stat object is not a file' do
+      stat = RubySMB::Server::Share::Provider::VirtualDisk::VirtualStat.new(file?: false)
+      expect { virtual_disk.add_static_file(path, content, stat: stat) }.to raise_error(ArgumentError)
+    end
+  end
+end
+

data/spec/lib/ruby_smb/smb1/packet/trans2/find_first2_request_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindFirst2Request do
       expect(parameter_block).to be_a RubySMB::SMB1::Packet::Trans2::Request::ParameterBlock
     end
 
-    it 'should have the setup set to the OPEN2 subcommand' do
+    it 'should have the setup set to the FIND_FIRST2 subcommand' do
       expect(parameter_block.setup).to include RubySMB::SMB1::Packet::Trans2::Subcommands::FIND_FIRST2
     end
   end
@@ -47,7 +47,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindFirst2Request do
     end
 
     it 'should keep #trans2_data 4-byte aligned' do
-      expect(data_block.trans2_data.abs_offset % 4).to eq 0
+      expect(data_block.trans2_data.abs_offset % 4).to eq 0 if data_block.trans2_data.num_bytes != 0
     end
 
     describe '#trans2_parameters' do

data/spec/lib/ruby_smb/smb1/packet/trans2/find_first2_response_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindFirst2Response do
   describe '#parameter_block' do
     subject(:parameter_block) { packet.parameter_block }
 
-    it 'should have the setup set to the OPEN2 subcommand' do
+    it 'should have the setup set to the FIND_FIRST2 subcommand' do
       expect(parameter_block.setup).to include RubySMB::SMB1::Packet::Trans2::Subcommands::FIND_FIRST2
     end
   end
@@ -40,7 +40,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindFirst2Response do
     end
 
     it 'should keep #trans2_data 4-byte aligned' do
-      expect(data_block.trans2_data.abs_offset % 4).to eq 0
+      expect(data_block.trans2_data.abs_offset % 4).to eq 0 if data_block.trans2_data.num_bytes != 0
     end
 
     describe '#trans2_parameters' do
@@ -57,6 +57,40 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindFirst2Response do
       subject(:data) { data_block.trans2_data }
 
       it { is_expected.to respond_to :buffer }
+
+      describe '#buffer' do
+        it 'is a String field' do
+          expect(data.buffer).to be_a BinData::String
+        end
+      end
+
+      context 'when the buffer is empty' do
+        before :each do
+          data.buffer = ''
+        end
+
+        it 'should not be padded' do
+          expect(data_block.pad2.num_bytes).to eq 0
+        end
+
+        it 'should read its own binary representation' do
+          expect(packet.class.read(packet.to_binary_s).data_block.trans2_data.buffer).to eq ''
+        end
+      end
+
+      context 'when the buffer is not empty' do
+        before :each do
+          data.buffer = 'test'
+        end
+
+        it 'should be padded to a 4-byte boundary' do
+          expect(data_block.trans2_data.abs_offset % 4).to eq 0
+        end
+
+        it 'should read its own binary representation' do
+          expect(packet.class.read(packet.to_binary_s).data_block.trans2_data.buffer).to eq 'test'
+        end
+      end
     end
   end
 

data/spec/lib/ruby_smb/smb1/packet/trans2/find_next2_request_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindNext2Request do
       expect(parameter_block).to be_a RubySMB::SMB1::Packet::Trans2::Request::ParameterBlock
     end
 
-    it 'should have the setup set to the OPEN2 subcommand' do
+    it 'should have the setup set to the FIND_NEXT2 subcommand' do
       expect(parameter_block.setup).to include RubySMB::SMB1::Packet::Trans2::Subcommands::FIND_NEXT2
     end
   end
@@ -47,7 +47,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindNext2Request do
     end
 
     it 'should keep #trans2_data 4-byte aligned' do
-      expect(data_block.trans2_data.abs_offset % 4).to eq 0
+      expect(data_block.trans2_data.abs_offset % 4).to eq 0 if data_block.trans2_data.num_bytes != 0
     end
 
     describe '#trans2_parameters' do

data/spec/lib/ruby_smb/smb1/packet/trans2/find_next2_response_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindNext2Response do
   describe '#parameter_block' do
     subject(:parameter_block) { packet.parameter_block }
 
-    it 'should have the setup set to the OPEN2 subcommand' do
+    it 'should have the setup set to the FIND_NEXT2 subcommand' do
       expect(parameter_block.setup).to include RubySMB::SMB1::Packet::Trans2::Subcommands::FIND_NEXT2
     end
   end
@@ -56,6 +56,40 @@ RSpec.describe RubySMB::SMB1::Packet::Trans2::FindNext2Response do
       subject(:data) { data_block.trans2_data }
 
       it { is_expected.to respond_to :buffer }
+
+      describe '#buffer' do
+        it 'is a String field' do
+          expect(data.buffer).to be_a BinData::String
+        end
+      end
+
+      context 'when the buffer is empty' do
+        before :each do
+          data.buffer = ''
+        end
+
+        it 'should not be padded' do
+          expect(data_block.pad2.num_bytes).to eq 0
+        end
+
+        it 'should read its own binary representation' do
+          expect(packet.class.read(packet.to_binary_s).data_block.trans2_data.buffer).to eq ''
+        end
+      end
+
+      context 'when the buffer is not empty' do
+        before :each do
+          data.buffer = 'test'
+        end
+
+        it 'should be padded to a 4-byte boundary' do
+          expect(data_block.trans2_data.abs_offset % 4).to eq 0
+        end
+
+        it 'should read its own binary representation' do
+          expect(packet.class.read(packet.to_binary_s).data_block.trans2_data.buffer).to eq 'test'
+        end
+      end
     end
   end
 

data/spec/lib/ruby_smb/smb1/packet/trans2/query_file_information_request_spec.rb

@@ -0,0 +1,74 @@
+include RubySMB::Fscc::FileInformation
+
+RSpec.describe RubySMB::SMB1::Packet::Trans2::QueryFileInformationRequest do
+  subject(:packet) { described_class.new }
+
+  describe '#smb_header' do
+    subject(:header) { packet.smb_header }
+
+    it 'is a standard SMB Header' do
+      expect(header).to be_a RubySMB::SMB1::SMBHeader
+    end
+
+    it 'should have the command set to SMB_COM_TRANSACTION2' do
+      expect(header.command).to eq RubySMB::SMB1::Commands::SMB_COM_TRANSACTION2
+    end
+
+    it 'should not have the response flag set' do
+      expect(header.flags.reply).to eq 0
+    end
+  end
+
+  describe '#parameter_block' do
+    subject(:parameter_block) { packet.parameter_block }
+
+    it 'is a standard ParameterBlock' do
+      expect(parameter_block).to be_a RubySMB::SMB1::Packet::Trans2::Request::ParameterBlock
+    end
+
+    it 'should have the setup set to the QUERY_FILE_INFORMATION subcommand' do
+      expect(parameter_block.setup).to include RubySMB::SMB1::Packet::Trans2::Subcommands::QUERY_FILE_INFORMATION
+    end
+  end
+
+  describe '#data_block' do
+    subject(:data_block) { packet.data_block }
+
+    it 'is a standard DataBlock' do
+      expect(data_block).to be_a RubySMB::SMB1::DataBlock
+    end
+
+    it { is_expected.to respond_to :name }
+    it { is_expected.to respond_to :trans2_parameters }
+    it { is_expected.to respond_to :trans2_data }
+
+    it 'should keep #trans2_parameters 4-byte aligned' do
+      expect(data_block.trans2_parameters.abs_offset % 4).to eq 0
+    end
+
+    it 'should keep #trans2_data 4-byte aligned' do
+      data_block.trans2_parameters.information_level = FILE_DISPOSITION_INFORMATION + SMB_INFO_PASSTHROUGH
+      expect(data_block.trans2_data.abs_offset % 4).to eq 0 if data_block.trans2_data.num_bytes != 0
+    end
+
+    describe '#trans2_parameters' do
+      subject(:parameters) { data_block.trans2_parameters }
+
+      it { is_expected.to respond_to :fid }
+      it { is_expected.to respond_to :information_level }
+
+      describe '#fid' do
+        it 'is a 16-bit field' do
+          expect(parameters.fid).to be_a BinData::Uint16le
+        end
+      end
+
+      describe '#information_level' do
+        it 'is a 16-bit field' do
+          expect(parameters.information_level).to be_a BinData::Uint16le
+        end
+      end
+    end
+  end
+end
+

data/spec/lib/ruby_smb/smb1/packet/trans2/query_file_information_response_spec.rb

@@ -0,0 +1,96 @@
+RSpec.describe RubySMB::SMB1::Packet::Trans2::QueryFileInformationResponse do
+  subject(:packet) { described_class.new }
+
+  describe '#smb_header' do
+    subject(:header) { packet.smb_header }
+
+    it 'is a standard SMB Header' do
+      expect(header).to be_a RubySMB::SMB1::SMBHeader
+    end
+
+    it 'should have the command set to SMB_COM_TRANSACTION2' do
+      expect(header.command).to eq RubySMB::SMB1::Commands::SMB_COM_TRANSACTION2
+    end
+
+    it 'should have the response flag set' do
+      expect(header.flags.reply).to eq 1
+    end
+  end
+
+  describe '#parameter_block' do
+    subject(:parameter_block) { packet.parameter_block }
+
+    it 'should have the setup set to the QUERY_FILE_INFORMATION subcommand' do
+      expect(parameter_block.setup).to include RubySMB::SMB1::Packet::Trans2::Subcommands::QUERY_FILE_INFORMATION
+    end
+  end
+
+  describe '#data_block' do
+    subject(:data_block) { packet.data_block }
+
+    it 'is a standard DataBlock' do
+      expect(data_block).to be_a RubySMB::SMB1::DataBlock
+    end
+
+    it { is_expected.to respond_to :name }
+    it { is_expected.to respond_to :trans2_parameters }
+    it { is_expected.to respond_to :trans2_data }
+
+    it 'should keep #trans2_parameters 4-byte aligned' do
+      expect(data_block.trans2_parameters.abs_offset % 4).to eq 0
+    end
+
+    describe '#trans2_parameters' do
+      subject(:parameters) { data_block.trans2_parameters }
+
+      it { is_expected.to respond_to :ea_error_offset }
+
+      describe '#ea_error_offset' do
+        it 'is a 16-bit field' do
+          expect(parameters.ea_error_offset).to be_a BinData::Uint16le
+        end
+      end
+    end
+
+    describe '#trans2_data' do
+      subject(:data) { data_block.trans2_data }
+
+      it { is_expected.to respond_to :buffer }
+
+      describe '#buffer' do
+        it 'is a String field' do
+          expect(data.buffer).to be_a BinData::String
+        end
+      end
+
+      context 'when the buffer is empty' do
+        before :each do
+          data.buffer = ''
+        end
+
+        it 'should not be padded' do
+          expect(data_block.pad2.num_bytes).to eq 0
+        end
+
+        it 'should read its own binary representation' do
+          expect(packet.class.read(packet.to_binary_s).data_block.trans2_data.buffer).to eq ''
+        end
+      end
+
+      context 'when the buffer is not empty' do
+        before :each do
+          data.buffer = 'test'
+        end
+
+        it 'should be padded to a 4-byte boundary' do
+          expect(data_block.trans2_data.abs_offset % 4).to eq 0
+        end
+
+        it 'should read its own binary representation' do
+          expect(packet.class.read(packet.to_binary_s).data_block.trans2_data.buffer).to eq 'test'
+        end
+      end
+    end
+  end
+
+end