ruby_smb 0.0.18 → 0.0.19

data/spec/lib/ruby_smb/smb2/bit_field/directory_access_mask_spec.rb

@@ -34,7 +34,6 @@ RSpec.describe RubySMB::SMB2::BitField::DirectoryAccessMask do
     it_behaves_like 'bit field with one flag set', :list, 'V', 0x00000001
   end
 
-
   describe '#add_file' do
     it 'should be a 1-bit field per the SMB spec' do
       expect(flags.add_file).to be_a BinData::Bit1
@@ -186,5 +185,4 @@ RSpec.describe RubySMB::SMB2::BitField::DirectoryAccessMask do
 
     it_behaves_like 'bit field with one flag set', :generic_read, 'V', 0x80000000
   end
-
 end

data/spec/lib/ruby_smb/smb2/bit_field/file_access_mask_spec.rb

@@ -34,7 +34,6 @@ RSpec.describe RubySMB::SMB2::BitField::FileAccessMask do
     it_behaves_like 'bit field with one flag set', :read_data, 'V', 0x00000001
   end
 
-
   describe '#write_data' do
     it 'should be a 1-bit field per the SMB spec' do
       expect(flags.write_data).to be_a BinData::Bit1
@@ -186,5 +185,4 @@ RSpec.describe RubySMB::SMB2::BitField::FileAccessMask do
 
     it_behaves_like 'bit field with one flag set', :generic_read, 'V', 0x80000000
   end
-
 end

data/spec/lib/ruby_smb/smb2/bit_field/session_flags_spec.rb

@@ -25,4 +25,4 @@ RSpec.describe RubySMB::SMB2::BitField::SessionFlags do
 
     it_behaves_like 'bit field with one flag set', :null, 'v', 0x00000002
   end
-end
+end

data/spec/lib/ruby_smb/smb2/bit_field/share_capabilities_spec.rb

@@ -7,7 +7,6 @@ RSpec.describe RubySMB::SMB2::BitField::ShareCapabilities do
   it { is_expected.to respond_to :continuous }
   it { is_expected.to respond_to :dfs }
 
-
   it 'is little endian' do
     expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
   end

data/spec/lib/ruby_smb/smb2/bit_field/share_flags_spec.rb

@@ -24,7 +24,6 @@ RSpec.describe RubySMB::SMB2::BitField::ShareFlags do
     it_behaves_like 'bit field with one flag set', :dfs, 'V', 0x00000001
   end
 
-
   describe '#dfs_root' do
     it 'should be a 1-bit field per the SMB spec' do
       expect(flags.dfs_root).to be_a BinData::Bit1
@@ -179,6 +178,5 @@ RSpec.describe RubySMB::SMB2::BitField::ShareFlags do
       flags.vdo_caching = 0
       expect(flags.caching_type).to eq :manual
     end
-
   end
 end

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

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB2::CreateContext do
+  subject(:struct) { described_class.new }
+
+  it { is_expected.to respond_to :next_offset }
+  it { is_expected.to respond_to :name_offset }
+  it { is_expected.to respond_to :name_length }
+  it { is_expected.to respond_to :data_offset }
+  it { is_expected.to respond_to :data_length }
+  it { is_expected.to respond_to :name }
+  it { is_expected.to respond_to :data }
+
+  describe '#name_length' do
+    it 'stores the length of the name field' do
+      expect(struct.name_length).to eq struct.name.length
+    end
+  end
+
+  describe '#name_offset' do
+    it 'stores the relative offset of the name field' do
+      expect(struct.name_offset).to eq struct.name.rel_offset
+    end
+  end
+
+  describe '#data_length' do
+    it 'stores the length of the data field' do
+      expect(struct.data_length).to eq struct.data.length
+    end
+  end
+
+  describe '#data_offset' do
+    it 'stores the relative offset of the data field' do
+      struct.data = 'Hello'
+      expect(struct.data_offset).to eq struct.data.rel_offset
+    end
+
+    it 'returns 0 if the data field is empty' do
+      expect(struct.data_offset).to eq 0
+    end
+  end
+end

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

@@ -0,0 +1,233 @@
+require 'spec_helper'
+require 'securerandom'
+
+RSpec.describe RubySMB::SMB2::File do
+  let(:sock) { double('Socket', peeraddr: '192.168.1.5') }
+  let(:dispatcher) { RubySMB::Dispatcher::Socket.new(sock) }
+
+  let(:client) { RubySMB::Client.new(dispatcher, username: 'msfadmin', password: 'msfadmin') }
+  let(:tree_id) { 2049 }
+  let(:path) { '\\192.168.1.1\example' }
+  let(:connect_response) {
+    packet = RubySMB::SMB2::Packet::TreeConnectResponse.new
+    packet.smb2_header.tree_id = tree_id
+    packet.maximal_access.read("\xff\x01\x1f\x00")
+    packet.share_type = 0x01
+    packet
+  }
+
+  let(:disco_req) { RubySMB::SMB2::Packet::TreeDisconnectRequest.new }
+  let(:disco_resp) { RubySMB::SMB2::Packet::TreeDisconnectResponse.new }
+  let(:tree) { RubySMB::SMB2::Tree.new(client: client, share: path, response: connect_response) }
+  let(:file_id) { RubySMB::Field::Smb2Fileid.read('\x6d\x01\x00\x00\x00\x00\x00\x00\x\x01\x00\x00\x00\xff\xff\xff\xff') }
+  let(:time) { DateTime.now }
+  let(:create_response) {
+    RubySMB::SMB2::Packet::CreateResponse.new(
+      file_id: file_id,
+      end_of_file: 108,
+      allocation_size: 112,
+      last_access: time,
+      last_change: time,
+      last_write: time
+    )
+  }
+
+  subject(:file) { described_class.new(name: 'short.txt', response: create_response, tree: tree) }
+
+  it { is_expected.to respond_to :attributes }
+  it { is_expected.to respond_to :guid }
+  it { is_expected.to respond_to :last_access }
+  it { is_expected.to respond_to :last_change }
+  it { is_expected.to respond_to :last_write }
+  it { is_expected.to respond_to :name }
+  it { is_expected.to respond_to :size }
+  it { is_expected.to respond_to :size_on_disk }
+  it { is_expected.to respond_to :tree }
+
+  it 'pulls the attributes from the response packet' do
+    expect(file.attributes).to eq create_response.file_attributes
+  end
+
+  it 'pulls the GUID from the response fileid' do
+    expect(file.guid).to eq create_response.file_id
+  end
+
+  it 'pulls the timestamps from the response packet' do
+    expect(file.last_access).to eq create_response.last_access.to_datetime
+  end
+
+  it 'pulls the size from the response packet' do
+    expect(file.size).to eq create_response.end_of_file
+  end
+
+  it 'pulls the size_on_disk from the response packet' do
+    expect(file.size_on_disk).to eq create_response.allocation_size
+  end
+
+  describe '#set_header_fields' do
+    let(:request) { RubySMB::SMB2::Packet::ReadRequest.new }
+    it 'calls the set_header_field method from the Tree' do
+      expect(tree).to receive(:set_header_fields).with(request).and_call_original
+      file.set_header_fields(request)
+    end
+
+    it 'sets the packet file_id from the guid' do
+      expect(file.set_header_fields(request).file_id).to eq file.guid
+    end
+  end
+
+  describe '#read_packet' do
+    it 'creates a new ReadRequest packet' do
+      expect(RubySMB::SMB2::Packet::ReadRequest).to receive(:new).and_call_original
+      file.read_packet
+    end
+
+    it 'calls #set_header_fields' do
+      expect(file).to receive(:set_header_fields).and_call_original
+      file.read_packet
+    end
+
+    it 'sets the read_length of the packet' do
+      expect(file.read_packet(read_length: 55).read_length).to eq 55
+    end
+
+    it 'sets the offset of the packet' do
+      expect(file.read_packet(offset: 55).offset).to eq 55
+    end
+  end
+
+  describe '#read' do
+    context 'for a small file' do
+      let(:small_read) { file.read_packet(read_length: 108) }
+      let(:small_response) { RubySMB::SMB2::Packet::ReadResponse.new(data_length: 9, buffer: 'fake data') }
+
+      it 'uses a single packet to read the entire file' do
+        expect(file).to receive(:read_packet).with(read_length: 108, offset: 0).and_return(small_read)
+        expect(client).to receive(:send_recv).with(small_read).and_return 'fake data'
+        expect(RubySMB::SMB2::Packet::ReadResponse).to receive(:read).with('fake data').and_return(small_response)
+        expect(file.read).to eq 'fake data'
+      end
+    end
+
+    context 'for a larger file' do
+      let(:big_read) { file.read_packet(read_length: 108) }
+      let(:big_response) { RubySMB::SMB2::Packet::ReadResponse.new(data_length: 9, buffer: 'fake data') }
+
+      it 'uses a multiple packet to read the file in chunks' do
+        expect(file).to receive(:read_packet).once.with(read_length: described_class::MAX_PACKET_SIZE, offset: 0).and_return(big_read)
+        expect(file).to receive(:read_packet).once.with(read_length: described_class::MAX_PACKET_SIZE, offset: described_class::MAX_PACKET_SIZE).and_return(big_read)
+        expect(client).to receive(:send_recv).twice.and_return 'fake data'
+        expect(RubySMB::SMB2::Packet::ReadResponse).to receive(:read).twice.with('fake data').and_return(big_response)
+        file.read(bytes: (described_class::MAX_PACKET_SIZE * 2))
+      end
+    end
+  end
+
+  describe '#append' do
+    it 'call #write with offset set to the end of the file' do
+      expect(file).to receive(:write).with(data:'test', offset: file.size)
+      file.append(data:'test')
+    end
+  end
+
+  describe '#write_packet' do
+    it 'calls #set_header_fields with the newly created packet' do
+      expect(file).to receive(:set_header_fields).and_call_original
+      file.write_packet
+    end
+
+    it 'sets the offset on the packet' do
+      expect(file.write_packet(offset:5).write_offset).to eq 5
+    end
+
+    it 'sets the buffer on the packet' do
+      expect(file.write_packet(data:'hello').buffer).to eq 'hello'
+    end
+  end
+
+  describe '#write' do
+    let(:write_response) { RubySMB::SMB2::Packet::WriteResponse.new }
+    context 'for a small write' do
+      it 'sends a single packet' do
+        expect(client).to receive(:send_recv).once.and_return(write_response.to_binary_s)
+        file.write(data: 'test')
+      end
+    end
+
+    context 'for a large write' do
+      it 'sends multiple packets' do
+        expect(client).to receive(:send_recv).twice.and_return(write_response.to_binary_s)
+        file.write(data: SecureRandom.random_bytes(described_class::MAX_PACKET_SIZE + 1))
+      end
+    end
+  end
+
+  describe '#delete_packet' do
+    it 'creates a new SetInfoRequest packet' do
+      expect(RubySMB::SMB2::Packet::SetInfoRequest).to receive(:new).and_call_original
+      file.delete_packet
+    end
+
+    it 'calls #set_header_fields' do
+      expect(file).to receive(:set_header_fields).and_call_original
+      file.delete_packet
+    end
+
+    it 'sets the file_info_class of the packet' do
+      expect(file.delete_packet.file_info_class).to eq RubySMB::Fscc::FileInformation::FILE_DISPOSITION_INFORMATION
+    end
+
+    it 'sets the delete_pending field to 1' do
+      expect(file.delete_packet.buffer.delete_pending).to eq 1
+    end
+  end
+
+  describe '#delete' do
+    context 'for a small file' do
+      let(:small_delete) { file.delete_packet }
+      let(:small_response) { RubySMB::SMB2::Packet::SetInfoResponse.new }
+
+      it 'uses a single packet to delete the entire file' do
+        expect(file).to receive(:delete_packet).and_return(small_delete)
+        expect(client).to receive(:send_recv).with(small_delete).and_return 'raw_response'
+        expect(RubySMB::SMB2::Packet::SetInfoResponse).to receive(:read).with('raw_response').and_return(small_response)
+        expect(file.delete).to eq WindowsError::NTStatus::STATUS_SUCCESS
+      end
+    end
+  end
+  
+  describe '#rename_packet' do
+    it 'creates a new SetInfoRequest packet' do
+      expect(RubySMB::SMB2::Packet::SetInfoRequest).to receive(:new).and_call_original
+      file.rename_packet('new_file.txt')
+    end
+
+    it 'calls #set_header_fields' do
+      expect(file).to receive(:set_header_fields).and_call_original
+      file.rename_packet('new_file.txt')
+    end
+
+    it 'sets the file_info_class of the packet' do
+      expect(file.rename_packet('new_file.txt').file_info_class).to eq RubySMB::Fscc::FileInformation::FILE_RENAME_INFORMATION
+    end
+
+    it 'sets the file_name field to the unicode-encoded new file name' do
+      filename = "new_file.txt"
+      expect(file.rename_packet(filename).buffer.file_name).to eq filename.encode('UTF-16LE').force_encoding('ASCII-8BIT')
+    end
+  end
+
+  describe '#rename' do
+    context 'for a small file' do
+      let(:small_rename) { file.rename_packet('new_file.txt') }
+      let(:small_response) { RubySMB::SMB2::Packet::SetInfoResponse.new }
+
+      it 'uses a single packet to rename the entire file' do
+        expect(file).to receive(:rename_packet).and_return(small_rename)
+        expect(client).to receive(:send_recv).with(small_rename).and_return 'raw_response'
+        expect(RubySMB::SMB2::Packet::SetInfoResponse).to receive(:read).with('raw_response').and_return(small_response)
+        expect(file.rename('new_file.txt')).to eq WindowsError::NTStatus::STATUS_SUCCESS
+      end
+    end
+  end
+end

data/spec/lib/ruby_smb/smb2/packet/close_request_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB2::Packet::CloseRequest do
+  subject(:packet) { described_class.new }
+
+  it { is_expected.to respond_to :smb2_header }
+  it { is_expected.to respond_to :structure_size }
+  it { is_expected.to respond_to :flags }
+  it { is_expected.to respond_to :file_id }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#smb2_header' do
+    subject(:header) { packet.smb2_header }
+
+    it 'is a standard SMB Header' do
+      expect(header).to be_a RubySMB::SMB2::SMB2Header
+    end
+
+    it 'should have the command set to SMB_COM_CLOSE' do
+      expect(header.command).to eq RubySMB::SMB2::Commands::CLOSE
+    end
+
+    it 'should not have the response flag set' do
+      expect(header.flags.reply).to eq 0
+    end
+  end
+
+  it 'should have a structure size of 24' do
+    expect(packet.structure_size).to eq 24
+  end
+
+  describe '#file_id' do
+    it 'should be an SMB FileID field' do
+      expect(packet.file_id).to be_a RubySMB::Field::Smb2Fileid
+    end
+  end
+end

data/spec/lib/ruby_smb/smb2/packet/close_response_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB2::Packet::CloseResponse do
+  subject(:packet) { described_class.new }
+
+  it { is_expected.to respond_to :smb2_header }
+  it { is_expected.to respond_to :structure_size }
+  it { is_expected.to respond_to :flags }
+  it { is_expected.to respond_to :create_time }
+  it { is_expected.to respond_to :last_access }
+  it { is_expected.to respond_to :last_write }
+  it { is_expected.to respond_to :last_change }
+  it { is_expected.to respond_to :allocation_size }
+  it { is_expected.to respond_to :end_of_file }
+  it { is_expected.to respond_to :file_attributes }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#smb2_header' do
+    subject(:header) { packet.smb2_header }
+
+    it 'is a standard SMB Header' do
+      expect(header).to be_a RubySMB::SMB2::SMB2Header
+    end
+
+    it 'should have the command set to SMB_COM_CLOSE' do
+      expect(header.command).to eq RubySMB::SMB2::Commands::CLOSE
+    end
+
+    it 'should have the response flag set' do
+      expect(header.flags.reply).to eq 1
+    end
+  end
+
+  it 'should have a structure size of 60' do
+    expect(packet.structure_size).to eq 60
+  end
+end

data/spec/lib/ruby_smb/smb2/packet/create_request_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB2::Packet::CreateRequest do
+  subject(:packet) { described_class.new }
+
+  it { is_expected.to respond_to :smb2_header }
+  it { is_expected.to respond_to :structure_size }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#smb2_header' do
+    subject(:header) { packet.smb2_header }
+
+    it 'is a standard SMB Header' do
+      expect(header).to be_a RubySMB::SMB2::SMB2Header
+    end
+
+    it 'should have the command set to SMB_COM_NEGOTIATE' do
+      expect(header.command).to eq RubySMB::SMB2::Commands::CREATE
+    end
+
+    it 'should not have the response flag set' do
+      expect(header.flags.reply).to eq 0
+    end
+  end
+
+  it 'should have a structure size of 57' do
+    expect(packet.structure_size).to eq 57
+  end
+
+  describe '#desired_access' do
+    it 'should be a DirectoryAccessMask when the file is a directory' do
+      packet.file_attributes.directory = 1
+      access_mask = packet.desired_access.send(:current_choice)
+      expect(access_mask.class).to eq RubySMB::SMB2::BitField::DirectoryAccessMask
+    end
+
+    it 'should be a FileAccessMask when the file is not a directory' do
+      packet.file_attributes.directory = 0
+      access_mask = packet.desired_access.send(:current_choice)
+      expect(access_mask.class).to eq RubySMB::SMB2::BitField::FileAccessMask
+    end
+  end
+
+  describe '#share_accesss' do
+    subject(:flags) { packet.share_access }
+
+    describe '#read_access' do
+      it 'should be a 1-bit field per the SMB spec' do
+        expect(flags.read_access).to be_a BinData::Bit1
+      end
+
+      it_behaves_like 'bit field with one flag set', :read_access, 'V', 0x00000001
+    end
+
+    describe '#write_access' do
+      it 'should be a 1-bit field per the SMB spec' do
+        expect(flags.write_access).to be_a BinData::Bit1
+      end
+
+      it_behaves_like 'bit field with one flag set', :write_access, 'V', 0x00000002
+    end
+
+    describe '#delete_access' do
+      it 'should be a 1-bit field per the SMB spec' do
+        expect(flags.delete_access).to be_a BinData::Bit1
+      end
+
+      it_behaves_like 'bit field with one flag set', :delete_access, 'V', 0x00000004
+    end
+  end
+
+  it 'has a CreateOptions field cleverly labeled create_options' do
+    expect(packet.create_options).to be_a RubySMB::SMB1::BitField::CreateOptions
+  end
+
+  it 'tracks the offset to #name in #name_offset' do
+    expect(packet.name_offset).to eq packet.name.abs_offset
+  end
+
+  it 'tracks the offset to #context in #context_offset' do
+    expect(packet.context_offset).to eq packet.context.abs_offset
+  end
+
+  it 'tracks the length of #name in #name_length' do
+    expect(packet.name_length).to eq packet.name.length
+  end
+
+  it 'tracks the length of #context in #context_length' do
+    expect(packet.context_length).to eq packet.context.do_num_bytes
+  end
+
+  describe '#name' do
+    it 'encodes any input into UTF-16LE' do
+      packet.name = 'Hello'
+      expect(packet.name.to_binary_s).to eq "H\x00e\x00l\x00l\x00o\x00"
+    end
+  end
+end