ruby_smb 0.0.18 → 0.0.19

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

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileIdFullDirectoryInformation 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_ID_FULL_DIRECTORY_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :next_offset }
+  it { should respond_to :file_index }
+  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 :end_of_file }
+  it { should respond_to :allocation_size }
+  it { should respond_to :file_attributes }
+  it { should respond_to :file_name_length }
+  it { should respond_to :ea_size }
+  it { should respond_to :file_id }
+  it { should respond_to :file_name }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the creation 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 'contains the file attributes of the file' do
+    expect(struct.file_attributes).to be_a RubySMB::Fscc::FileAttributes
+  end
+
+  it 'tracks the length of the file_name field' do
+    struct.file_name = 'Hello.txt'
+    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
+      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

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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileNamesInformation 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_NAMES_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :next_offset }
+  it { should respond_to :file_index }
+  it { should respond_to :file_name_length }
+  it { should respond_to :file_name }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  it 'tracks the length of the file_name field' do
+    struct.file_name = 'Hello.txt'
+    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
+      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

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

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Fscc::FileInformation::FileRenameInformation 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_ID_FULL_DIRECTORY_INFORMATION
+  end
+
+  subject(:struct) { described_class.new }
+
+  it { should respond_to :replace_if_exists }
+  it { should respond_to :reserved }
+  it { should respond_to :root_directory }
+  it { should respond_to :file_name_length }
+  it { should respond_to :file_name }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  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).to eq name
+    end
+  end
+
+  describe '#replace_if_exists' do
+    it 'is a 8-bit field' do
+      expect(struct.replace_if_exists).to be_a BinData::Uint8
+    end
+  end
+
+  describe '#reserved' do
+    context 'with SMB1' do
+      it 'is a 3-bytes field' do
+        allow(struct).to receive(:get_smb_version).and_return 1
+        expect(struct.reserved.do_num_bytes).to eq 3
+      end
+    end
+
+    context 'with SMB2' do
+      it 'is a 7-bytes field' do
+        allow(struct).to receive(:get_smb_version).and_return 2
+        expect(struct.reserved.do_num_bytes).to eq 7
+      end
+    end
+  end
+
+  describe '#root_directory' do
+    context 'with SMB1' do
+      before :example do
+        allow(struct).to receive(:get_smb_version).and_return 1
+      end
+
+      it 'is a 4-bytes field' do
+        expect(struct.root_directory.do_num_bytes).to eq 4
+      end
+
+      it 'should have a default value of 0' do
+        expect(struct.root_directory).to eq 0
+      end
+    end
+
+    context 'with SMB2' do
+      before :example do
+        allow(struct).to receive(:get_smb_version).and_return 2
+      end
+
+      it 'is a 8-bytes field' do
+        expect(struct.root_directory.do_num_bytes).to eq 8
+      end
+
+      it 'should have a default value of 0' do
+        expect(struct.root_directory).to eq 0
+      end
+    end
+
+  end
+
+  describe '#file_name_length' do
+    it 'is a 32-bit field' do
+      expect(struct.file_name_length).to be_a BinData::Uint32le
+    end
+
+    it 'should have a default value of 0' do
+      expect(struct.file_name_length).to eq 0
+    end
+
+    it 'tracks the length of the file_name field' do
+      struct.file_name = 'Hello.txt'
+      expect(struct.file_name_length).to eq struct.file_name.do_num_bytes
+    end
+  end
+
+  describe '#file_name' do
+    it 'is a string field' do
+      expect(struct.file_name).to be_a BinData::String
+    end
+  end
+
+  describe '#get_smb_version' do
+    it 'is a recurssive method' do
+      parent = double('parent object')
+      allow(struct).to receive(:parent).and_return(parent)
+      expect(struct).to receive(:respond_to?).and_return(false).twice.ordered
+      expect(parent).to receive(:respond_to?).and_return(true).once.ordered
+      struct.get_smb_version
+    end
+
+    it 'returns version 1 if smb_header structure is found in parents' do
+      allow(struct).to receive(:respond_to?).with(:smb_header).and_return(true)
+      expect(struct.get_smb_version).to eq 1
+    end
+
+    it 'returns version 2 if smb2_header structure is found in parents' do
+      allow(struct).to receive(:respond_to?).with(:smb_header).and_return(false)
+      allow(struct).to receive(:respond_to?).with(:smb2_header).and_return(true)
+      expect(struct.get_smb_version).to eq 2
+    end
+
+    it 'returns version 1 if no header structure is found in parents' do
+      allow(struct).to receive(:parent)
+      allow(struct).to receive(:respond_to?).with(:smb_header).and_return(false)
+      allow(struct).to receive(:respond_to?).with(:smb2_header).and_return(false)
+      expect(struct.get_smb_version).to eq 1
+    end
+  end
+end

data/spec/lib/ruby_smb/fscc/fscc_file_attributes_spec.rb

@@ -0,0 +1,143 @@
+RSpec.describe RubySMB::Fscc::FileAttributes do
+  subject(:attrs) { described_class.new }
+
+  it { is_expected.to respond_to :normal }
+  it { is_expected.to respond_to :device }
+  it { is_expected.to respond_to :archive }
+  it { is_expected.to respond_to :directory }
+  it { is_expected.to respond_to :volume }
+  it { is_expected.to respond_to :system }
+  it { is_expected.to respond_to :hidden }
+  it { is_expected.to respond_to :read_only }
+  it { is_expected.to respond_to :encrypted }
+  it { is_expected.to respond_to :content_indexed }
+  it { is_expected.to respond_to :offline }
+  it { is_expected.to respond_to :compressed }
+  it { is_expected.to respond_to :reparse_point }
+  it { is_expected.to respond_to :sparse }
+  it { is_expected.to respond_to :temp }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe 'read_only' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.read_only).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :read_only, 'V', 0x00000001
+  end
+
+  describe 'hidden' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.hidden).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :hidden, 'V', 0x00000002
+  end
+
+  describe 'system' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.system).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :system, 'V', 0x00000004
+  end
+
+  describe 'volume' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.volume).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :volume, 'V', 0x00000008
+  end
+
+  describe 'directory' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.directory).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :directory, 'V', 0x00000010
+  end
+
+  describe 'archive' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.archive).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :archive, 'V', 0x00000020
+  end
+
+  describe 'device' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.device).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :device, 'V', 0x00000040
+  end
+
+  describe 'normal' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.normal).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :normal, 'V', 0x00000080
+  end
+
+  describe 'temp' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.temp).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :temp, 'V', 0x00000100
+  end
+
+  describe 'sparse' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.sparse).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :sparse, 'V', 0x00000200
+  end
+
+  describe 'reparse_point' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.reparse_point).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :reparse_point, 'V', 0x00000400
+  end
+
+  describe 'compressed' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.compressed).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :compressed, 'V', 0x00000800
+  end
+
+  describe 'offline' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.offline).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :offline, 'V', 0x00001000
+  end
+
+  describe 'content_indexed' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.content_indexed).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :content_indexed, 'V', 0x00002000
+  end
+
+  describe 'encrypted' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(attrs.encrypted).to be_a BinData::Bit1
+    end
+
+    it_behaves_like 'bit field with one flag set', :encrypted, 'V', 0x00004000
+  end
+end

data/spec/lib/ruby_smb/generic_packet_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe RubySMB::GenericPacket do
-
   class TestPacket < RubySMB::GenericPacket
     endian :little
     uint8  :first_value,  initial_value: 0x01
@@ -9,7 +8,7 @@ RSpec.describe RubySMB::GenericPacket do
     array  :array_value,  type: :dialect, read_until: :eof
   end
 
-  class ParentTestPacket <  RubySMB::GenericPacket
+  class ParentTestPacket < RubySMB::GenericPacket
     endian :little
     uint8  :header
     test_packet :test_packet
@@ -20,39 +19,65 @@ RSpec.describe RubySMB::GenericPacket do
 
   describe '#describe class method' do
     it 'outputs a string representing the structure of the packet' do
-      str = "\nFirst_value                   (Uint8)    \n"+
-      "Second_value                  (Uint16le) \n"+
-      "Array_value                   (Array)    "
+      str = "\nFirst_value                   (Uint8)    \n"\
+            "Second_value                  (Uint16le) \n"\
+            'Array_value                   (Array)    '
       expect(TestPacket.describe).to eq str
     end
 
     it 'handles nested record structures as well' do
-      str = "\nHeader                        (Uint8)    \n"+
-        "TEST_PACKET                              \n"+
-        "\tFirst_value                  (Uint8)    \n"+
-        "\tSecond_value                 (Uint16le) \n"+
-        "\tArray_value                  (Array)    "
+      str = "\nHeader                        (Uint8)    \n"\
+            "TEST_PACKET                              \n"\
+            "\tFirst_value                  (Uint8)    \n"\
+            "\tSecond_value                 (Uint16le) \n"\
+            "\tArray_value                  (Array)    "
       expect(ParentTestPacket.describe).to eq str
     end
   end
 
   describe '#display' do
     it 'shows the actual contents of the packet fields' do
-      str = "\nFIRST_VALUE                   16\n" +
-      "SECOND_VALUE                  4056\n" +
-      "ARRAY_VALUE\n" +
-      "\tBuffer Format ID             2\n" +
-      "\tDialect Name                 test"
+      str = "\nFIRST_VALUE                   16\n" \
+            "SECOND_VALUE                  4056\n" \
+            "ARRAY_VALUE\n" \
+            "\tBuffer Format ID             2\n" \
+            "\tDialect Name                 test"
       expect(test_packet.display).to eq str
     end
 
     it 'handles nested record structures as well' do
-      str = "\nHEADER                        0\n" +
-      "TEST_PACKET\n" +
-      "\tFirst_value                  1\n" +
-      "\tSecond_value                 2\n" +
-      "\tARRAY_VALUE"
+      str = "\nHEADER                        0\n" \
+            "TEST_PACKET\n" \
+            "\tFirst_value                  1\n" \
+            "\tSecond_value                 2\n" \
+            "\tARRAY_VALUE"
       expect(parent_packet.display).to eq str
     end
   end
-end
+
+  describe '#read' do
+    context 'when reading an SMB1 packet' do
+      let(:smb1_error_packet) { RubySMB::SMB1::Packet::EmptyPacket.new }
+
+      it 'returns the error packet instead of the asked for class' do
+        expect(RubySMB::SMB1::Packet::NegotiateResponse.read(smb1_error_packet.to_binary_s)).to be_a RubySMB::SMB1::Packet::EmptyPacket
+      end
+
+      it 'reraises the exception if it is not a valid error packet either' do
+        expect{RubySMB::SMB1::Packet::NegotiateResponse.read('a')}.to raise_error(EOFError)
+      end
+    end
+
+    context 'when reading an SMB2 packet' do
+      let(:smb2_error_packet) { RubySMB::SMB2::Packet::ErrorPacket.new }
+
+      it 'returns the error packet instead of the asked for class' do
+        expect(RubySMB::SMB2::Packet::NegotiateResponse.read(smb2_error_packet.to_binary_s)).to be_a RubySMB::SMB2::Packet::ErrorPacket
+      end
+
+      it 'reraises the exception if it is not a valid error packet either' do
+        expect{RubySMB::SMB2::Packet::NegotiateResponse.read('a')}.to raise_error(EOFError)
+      end
+    end
+  end
+end