ruby_smb 1.0.5 → 2.0.3

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

@@ -0,0 +1,108 @@
+RSpec.describe RubySMB::SMB2::Packet::CompressionTransformHeader do
+  subject(:packet) { described_class.new }
+
+  it { is_expected.to respond_to :protocol }
+  it { is_expected.to respond_to :original_compressed_segment_size }
+  it { is_expected.to respond_to :compression_algorithm }
+  it { is_expected.to respond_to :flags }
+  it { is_expected.to respond_to :offset }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#protocol' do
+    it 'is a 32-bit field' do
+      expect(packet.protocol).to be_a BinData::Bit32
+    end
+
+    it 'is initialized with the value 0xFC534D42' do
+      expect(packet.protocol).to eq(0xFC534D42)
+    end
+  end
+
+  describe '#original_compressed_segment_size ' do
+    it 'is a 32-bit unsigned integer' do
+      expect(packet.original_compressed_segment_size).to be_a BinData::Uint32le
+    end
+  end
+
+  describe '#compression_algorithm ' do
+    it 'is a 16-bit unsigned integer' do
+      expect(packet.compression_algorithm).to be_a BinData::Uint16le
+    end
+  end
+
+  describe '#flags ' do
+    it 'is a 16-bit unsigned integer' do
+      expect(packet.flags).to be_a BinData::Uint16le
+    end
+  end
+
+  describe '#offset' do
+    it 'is a 32-bit unsigned integer' do
+      expect(packet.offset).to be_a BinData::Uint32le
+    end
+  end
+
+  it 'reads binary data as expected' do
+    data = described_class.new
+    expect(described_class.read(data.to_binary_s)).to eq(data)
+  end
+end
+
+RSpec.describe RubySMB::SMB2::Packet::Smb2CompressionPayloadHeader do
+  subject(:packet) { described_class.new }
+
+  it { is_expected.to respond_to :algorithm_id }
+  it { is_expected.to respond_to :payload_length }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#algorithm_id ' do
+    it 'is a 16-bit unsigned integer' do
+      expect(packet.algorithm_id).to be_a BinData::Uint16le
+    end
+  end
+
+  describe '#payload_length' do
+    it 'is a 32-bit unsigned integer' do
+      expect(packet.payload_length).to be_a BinData::Uint32le
+    end
+  end
+
+  it 'reads binary data as expected' do
+    data = described_class.new
+    expect(described_class.read(data.to_binary_s)).to eq(data)
+  end
+end
+
+RSpec.describe RubySMB::SMB2::Packet::Smb2CompressionPatternPayloadV1 do
+  subject(:packet) { described_class.new }
+
+  it { is_expected.to respond_to :pattern }
+  it { is_expected.to respond_to :repetitions }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#pattern' do
+    it 'is a 8-bit unsigned integer' do
+      expect(packet.pattern).to be_a BinData::Uint8
+    end
+  end
+
+  describe '#repetitions' do
+    it 'is a 32-bit unsigned integer' do
+      expect(packet.repetitions).to be_a BinData::Uint32le
+    end
+  end
+
+  it 'reads binary data as expected' do
+    data = described_class.new
+    expect(described_class.read(data.to_binary_s)).to eq(data)
+  end
+end

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

@@ -35,17 +35,6 @@ RSpec.describe RubySMB::SMB2::Packet::ErrorPacket do
     it 'should be a 32-bit unsigned integer' do
       expect(packet.byte_count).to be_a BinData::Uint32le
     end
-
-    it 'should be the number of bytes in #error_data' do
-      str = 'testing'
-      packet.error_data = str
-      expect(packet.byte_count).to eq str.size
-    end
-
-    it 'should be 0 when #error_data is 1-byte long' do
-      packet.error_data = "\x00"
-      expect(packet.byte_count).to eq 0
-    end
   end
 
   describe '#error_data' do
@@ -53,20 +42,10 @@ RSpec.describe RubySMB::SMB2::Packet::ErrorPacket do
       expect(packet.error_data).to be_a BinData::String
     end
 
-    it 'should be \x00 by default' do
-      expect(packet.error_data).to eq "\x00"
-    end
-
-    it 'should read 1 byte when #byte_count is 0' do
-      packet.error_data = 'test'
-      packet.byte_count = 0
-      expect(described_class.read(packet.to_binary_s).error_data.size).to eq 1
-    end
-
-    it 'should read #byte_count bytes when #byte_count is not 0' do
+    it 'should read #byte_count bytes' do
       packet.error_data = 'test'
-      packet.byte_count = 4
-      expect(described_class.read(packet.to_binary_s).error_data.size).to eq 4
+      packet.byte_count = 3
+      expect(described_class.read(packet.to_binary_s).error_data.size).to eq 3
     end
   end
 

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

@@ -8,6 +8,7 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateRequest do
   it { is_expected.to respond_to :reserved1 }
   it { is_expected.to respond_to :capabilities }
   it { is_expected.to respond_to :client_guid }
+  it { is_expected.to respond_to :negotiate_context_info}
   it { is_expected.to respond_to :client_start_time }
   it { is_expected.to respond_to :dialects }
 
@@ -45,6 +46,11 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateRequest do
     it 'should be a 16-bit unsigned integer' do
       expect(packet.dialect_count).to be_a BinData::Uint16le
     end
+
+    it 'is initially set to the #dialects array size' do
+      packet.dialects = [1,2,3]
+      expect(packet.dialect_count).to eq(3)
+    end
   end
 
   describe '#security_mode' do
@@ -69,7 +75,65 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateRequest do
     end
   end
 
+  describe '#negotiate_context_info' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialects << 0x0311
+      expect(packet.negotiate_context_info?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialects << 0x0300
+      expect(packet.negotiate_context_info?).to be false
+    end
+
+    it 'should be a Struct field' do
+      expect(packet.negotiate_context_info).to be_a BinData::Struct
+    end
+
+    subject(:struct) do
+      packet.dialects << 0x0311
+      packet.negotiate_context_info
+    end
+    it { is_expected.to respond_to :negotiate_context_offset }
+    it { is_expected.to respond_to :negotiate_context_count }
+
+    describe '#negotiate_context_offset' do
+      it 'should be a 32-bit unsigned integer' do
+        expect(struct.negotiate_context_offset).to be_a BinData::Uint32le
+      end
+
+      it 'is set to the #negotiate_context_list absolute offset' do
+        expect(struct.negotiate_context_offset).to eq(packet.negotiate_context_list.abs_offset)
+      end
+    end
+
+    describe '#negotiate_context_count' do
+      it 'should be a 16-bit unsigned integer' do
+        expect(struct.negotiate_context_count).to be_a BinData::Uint16le
+      end
+
+      it 'is set to the #negotiate_context_list array size' do
+        nc = RubySMB::SMB2::NegotiateContext.new(
+          context_type: RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES
+        )
+        packet.negotiate_context_list << nc
+        packet.negotiate_context_list << nc
+        expect(struct.negotiate_context_count).to eq(2)
+      end
+    end
+  end
+
   describe '#client_start_time' do
+    it 'does not exist if the 0x0311 dialect is included' do
+      packet.dialects << 0x0311
+      expect(packet.client_start_time?).to be false
+    end
+
+    it 'only exists if the 0x0311 dialect is not included' do
+      packet.dialects << 0x0300
+      expect(packet.client_start_time?).to be true
+    end
+
     it 'should be a Filetime field' do
       expect(packet.client_start_time).to be_a RubySMB::Field::FileTime
     end
@@ -85,15 +149,51 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateRequest do
     end
   end
 
+  describe '#pad' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialects << 0x0311
+      expect(packet.pad?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialects << 0x0300
+      expect(packet.pad?).to be false
+    end
+
+    it 'should be a binary string' do
+      expect(packet.pad).to be_a BinData::String
+    end
+
+    it 'should keep #negotiate_context_list 8-byte aligned' do
+      packet.dialects << 0x0311
+      expect(packet.negotiate_context_list.abs_offset % 8).to eq 0
+    end
+  end
+
+  describe '#negotiate_context_list' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialects << 0x0311
+      expect(packet.negotiate_context_list?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialects << 0x0300
+      expect(packet.negotiate_context_list?).to be false
+    end
+
+    it 'is an array field as per the SMB spec' do
+      expect(packet.negotiate_context_list).to be_a BinData::Array
+    end
+  end
+
   describe '#add_dialect' do
     it 'adds the dialect to the Dialects array' do
       packet.add_dialect 0x0201
       expect(packet.dialects).to include(0x0201)
     end
 
-    it 'updates the #dialect_count field' do
-      packet.add_dialect 0x0201
-      expect(packet.dialect_count).to eq 1
+    it 'raises an ArgumentError exceptionif it is not an Integer' do
+      expect { packet.add_dialect('dialect') }.to raise_error(ArgumentError)
     end
   end
 
@@ -119,4 +219,39 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateRequest do
       expect(packet.dialect_count).to eq 3
     end
   end
+
+  describe '#add_negotiate_context' do
+    it 'raises an ArgumentError exceptionif it is not a NegotiateContext structure' do
+      expect { packet.add_negotiate_context('nc') }.to raise_error(ArgumentError)
+    end
+
+    it 'updates the NegotiateContext#pad length to make sure the structure is 8-byte aligned' do
+      packet.dialects << 0x0311
+      [
+        RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES,
+        RubySMB::SMB2::NegotiateContext::SMB2_ENCRYPTION_CAPABILITIES,
+        RubySMB::SMB2::NegotiateContext::SMB2_COMPRESSION_CAPABILITIES,
+        RubySMB::SMB2::NegotiateContext::SMB2_NETNAME_NEGOTIATE_CONTEXT_ID
+      ].each do |context_type|
+        nc = RubySMB::SMB2::NegotiateContext.new(context_type: context_type)
+        packet.add_negotiate_context(nc)
+        expect(packet.negotiate_context_list.last.context_type.abs_offset % 8).to eq 0
+      end
+    end
+  end
+
+  it 'reads binary data as expected' do
+    data = described_class.new
+    data.set_dialects([0x0202, 0x0210, 0x0311])
+    [
+      RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES,
+      RubySMB::SMB2::NegotiateContext::SMB2_ENCRYPTION_CAPABILITIES,
+      RubySMB::SMB2::NegotiateContext::SMB2_COMPRESSION_CAPABILITIES,
+      RubySMB::SMB2::NegotiateContext::SMB2_NETNAME_NEGOTIATE_CONTEXT_ID
+    ].each do |context_type|
+      nc = RubySMB::SMB2::NegotiateContext.new(context_type: context_type)
+      data.add_negotiate_context(nc)
+      expect(described_class.read(data.to_binary_s)).to eq(data)
+    end
+  end
 end

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

@@ -61,12 +61,28 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateResponse do
   end
 
   describe '#negotiate_context_count' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialect_revision = 0x0311
+      expect(packet.negotiate_context_count?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialect_revision = 0x0300
+      expect(packet.negotiate_context_count?).to be false
+    end
+
     it 'is a 16-bit unsigned integer' do
       expect(packet.negotiate_context_count).to be_a BinData::Uint16le
     end
 
-    it 'has a default value of 0' do
-      expect(packet.negotiate_context_count).to eq 0
+    it 'is set to the #negotiate_context_list array size' do
+      packet.dialect_revision = 0x0311
+      nc = RubySMB::SMB2::NegotiateContext.new(
+        context_type: RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES
+      )
+      packet.negotiate_context_list << nc
+      packet.negotiate_context_list << nc
+      expect(packet.negotiate_context_count).to eq(2)
     end
   end
 
@@ -134,6 +150,16 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateResponse do
   end
 
   describe '#negotiate_context_offset' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialect_revision = 0x0311
+      expect(packet.negotiate_context_offset?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialect_revision = 0x0300
+      expect(packet.negotiate_context_offset?).to be false
+    end
+
     it 'is a 32-bit unsigned integer' do
       expect(packet.negotiate_context_offset).to be_a BinData::Uint32le
     end
@@ -144,4 +170,96 @@ RSpec.describe RubySMB::SMB2::Packet::NegotiateResponse do
       expect(packet.security_buffer).to be_a BinData::String
     end
   end
+
+  describe '#pad' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialect_revision = 0x0311
+      expect(packet.pad?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialect_revision = 0x0300
+      expect(packet.pad?).to be false
+    end
+
+    it 'should be a binary string' do
+      expect(packet.pad).to be_a BinData::String
+    end
+
+    it 'should keep #negotiate_context_list 8-byte aligned' do
+      packet.dialect_revision = 0x0311
+      expect(packet.negotiate_context_list.abs_offset % 8).to eq 0
+    end
+  end
+
+  describe '#negotiate_context_list' do
+    it 'only exists if the 0x0311 dialect is included' do
+      packet.dialect_revision = 0x0311
+      expect(packet.negotiate_context_list?).to be true
+    end
+
+    it 'does not exist if the 0x0311 dialect is not included' do
+      packet.dialect_revision = 0x0300
+      expect(packet.negotiate_context_list?).to be false
+    end
+
+    it 'is an array field as per the SMB spec' do
+      expect(packet.negotiate_context_list).to be_a BinData::Array
+    end
+  end
+
+  describe '#find_negotiate_context' do
+    before :example do
+      packet.add_negotiate_context(
+        RubySMB::SMB2::NegotiateContext.new(context_type: RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES)
+      )
+      packet.add_negotiate_context(
+        RubySMB::SMB2::NegotiateContext.new(context_type: RubySMB::SMB2::NegotiateContext::SMB2_ENCRYPTION_CAPABILITIES)
+      )
+    end
+
+    it 'returns the expected Negotiate Context structure' do
+      expect(packet.find_negotiate_context(RubySMB::SMB2::NegotiateContext::SMB2_ENCRYPTION_CAPABILITIES)).to eq(packet.negotiate_context_list[1])
+    end
+
+    it 'returns nil if the Negotiate Context structure is not found' do
+      expect(packet.find_negotiate_context(10)).to be nil
+    end
+  end
+
+  describe '#add_negotiate_context' do
+    it 'raises an ArgumentError exception if it is not a NegotiateContext structure' do
+      expect { packet.add_negotiate_context('nc') }.to raise_error(ArgumentError)
+    end
+
+    it 'updates the NegotiateContext#pad length to make sure the structure is 8-byte aligned' do
+      packet.dialect_revision = 0x0311
+      [
+        RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES,
+        RubySMB::SMB2::NegotiateContext::SMB2_ENCRYPTION_CAPABILITIES,
+        RubySMB::SMB2::NegotiateContext::SMB2_COMPRESSION_CAPABILITIES,
+        RubySMB::SMB2::NegotiateContext::SMB2_NETNAME_NEGOTIATE_CONTEXT_ID
+      ].each do |context_type|
+        nc = RubySMB::SMB2::NegotiateContext.new(context_type: context_type)
+        packet.add_negotiate_context(nc)
+        expect(packet.negotiate_context_list.last.context_type.abs_offset % 8).to eq 0
+      end
+    end
+  end
+
+  it 'reads binary data as expected' do
+    data = described_class.new
+    data.dialect_revision = 0x0311
+    data.security_buffer = 'security buf test'
+    [
+      RubySMB::SMB2::NegotiateContext::SMB2_PREAUTH_INTEGRITY_CAPABILITIES,
+      RubySMB::SMB2::NegotiateContext::SMB2_ENCRYPTION_CAPABILITIES,
+      RubySMB::SMB2::NegotiateContext::SMB2_COMPRESSION_CAPABILITIES,
+      RubySMB::SMB2::NegotiateContext::SMB2_NETNAME_NEGOTIATE_CONTEXT_ID
+    ].each do |context_type|
+      nc = RubySMB::SMB2::NegotiateContext.new(context_type: context_type)
+      data.add_negotiate_context(nc)
+      expect(described_class.read(data.to_binary_s)).to eq(data)
+    end
+  end
 end