ruby_smb 0.0.12 → 0.0.13

data/lib/ruby_smb/smb1/packet/trans2/open2_response.rb

@@ -0,0 +1,65 @@
+module RubySMB
+  module SMB1
+    module Packet
+      module Trans2
+
+        # This class represents an SMB1 Trans2 Open2 Response Packet as defined in
+        # [2.2.6.1.2 Response](https://msdn.microsoft.com/en-us/library/ee441545.aspx)
+        class Open2Response < RubySMB::GenericPacket
+
+          class ParameterBlock < RubySMB::SMB1::Packet::Trans2::Response::ParameterBlock
+          end
+
+          class Trans2Parameters < BinData::Record
+            endian  :little
+            uint8               :fid,             label: 'File ID'
+            smb_file_attributes :file_attributes, label: 'File Attributes'
+            utime               :creation_time,   label: 'Creation Time'
+            open2_access_mode   :access_mode,     label: 'AccessMode'
+            uint16              :resource_type,   label: 'Resource Type'
+            smb_nmpipe_status   :nmpipe_status,   label: 'Named Pipe Status'
+
+            struct  :action_taken do
+              endian  :little
+              bit6    :reserved,    label: 'Reserved Space'
+              bit2    :open_result, label: 'Open Result'
+              # byte boundary
+              bit1    :lock_status, label: 'Lock Status'
+              resume_byte_alignment
+            end
+
+            uint32  :reserved,                      label: 'Reserved Space'
+            uint16  :extended_attribute_offset,     label: 'Extended Attribute Offset'
+            uint32  :extended_attribute_length,     label: 'Extended Attribute Length'
+
+            # Returns the length of the Trans2Parameters struct
+            # in number of bytes
+            def length
+              self.do_num_bytes
+            end
+          end
+
+          class DataBlock < RubySMB::SMB1::Packet::Trans2::DataBlock
+            string             :pad1,               length: lambda { pad1_length }
+            trans2_parameters  :trans2_parameters,  label: 'Trans2 Parameters'
+            string             :pad2,               length: lambda { pad2_length }
+            string             :trans2_data,        label: 'Trans2 Data',           length: 0
+          end
+
+          smb_header        :smb_header
+          parameter_block   :parameter_block
+          data_block        :data_block
+
+          def initialize_instance
+            super
+            smb_header.command     = RubySMB::SMB1::Commands::SMB_COM_TRANSACTION2
+            parameter_block.setup << RubySMB::SMB1::Packet::Trans2::Subcommands::OPEN2
+            smb_header.flags.reply = 1
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet/trans2/request.rb

@@ -0,0 +1,52 @@
+module RubySMB
+  module SMB1
+    module Packet
+      module Trans2
+
+        # This class represents a generic SMB1 Trans2 Request Packet as defined in
+        # [2.2.4.46.1 Request](https://msdn.microsoft.com/en-us/library/ee442192.aspx)
+        class Request < RubySMB::GenericPacket
+
+          class ParameterBlock < RubySMB::SMB1::ParameterBlock
+            uint16        :total_parameter_count, label: 'Total Parameter Count(bytes)'
+            uint16        :total_data_count,      label: 'Total Data Count(bytes)'
+            uint16        :max_parameter_count,   label: 'Max Parameter Count(bytes)'
+            uint16        :max_data_count,        label: 'Max Data Count(bytes)'
+            uint8         :max_setup_count,       label: 'Max Setup Count'
+            uint8         :reserved,              label: 'Reserved Space',                 value: 0x00
+            trans2_flags  :flags
+            uint32        :timeout,               label: 'Timeout',                        initial_value: 0x00000000
+            uint16        :reserved2,             label: 'Reserved Space',                 value: 0x00
+            uint16        :parameter_count,       label: 'Parameter Count(bytes)',         value: lambda {self.parent.data_block.trans2_parameters.length}
+            uint16        :parameter_offset,      label: 'Parameter Offset',               value: lambda {self.parent.data_block.trans2_parameters.abs_offset}
+            uint16        :data_count,            label: 'Data Count(bytes)',              value: lambda {self.parent.data_block.trans2_data.length}
+            uint16        :data_offset,           label: 'Data Offset',                    value: lambda {self.parent.data_block.trans2_data.abs_offset}
+            uint8         :setup_count,           label: 'Setup Count',                    value: lambda {setup.length}
+            uint8         :reserved3,             label: 'Reserved Space',                 value: 0x00
+
+            array :setup, type: :uint16, initial_length: 0
+          end
+
+          class DataBlock < RubySMB::SMB1::Packet::Trans2::DataBlock
+            uint8  :name,               label: 'Name',              initial_value: 0x00
+            string :pad1,               length: lambda { pad1_length }
+            string :trans2_parameters,  label: 'Trans2 Parameters'
+            string :pad2,               length: lambda { pad2_length }
+            string :trans2_data,        label: 'Trans2 Data'
+          end
+
+          smb_header        :smb_header
+          parameter_block   :parameter_block
+          data_block        :data_block
+
+          def initialize_instance
+            super
+            smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TRANSACTION2
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet/trans2/request_secondary.rb

@@ -0,0 +1,39 @@
+module RubySMB
+  module SMB1
+    module Packet
+      module Trans2
+
+        # This class represents a generic SMB1 Trans2 Secondary Request Packet as defined in
+        # [2.2.4.47.1 Request](https://msdn.microsoft.com/en-us/library/ee442105.aspx)
+        class RequestSecondary < RubySMB::GenericPacket
+
+          class ParameterBlock < RubySMB::SMB1::ParameterBlock
+            uint16  :total_parameter_count,   label: 'Total Parameter Count(bytes)'
+            uint16  :total_data_count,        label: 'Total Data Count(bytes)'
+            uint16  :parameter_count,         label: 'Parameter Count(bytes)',         value: lambda {self.parent.data_block.trans2_parameters.length}
+            uint16  :parameter_offset,        label: 'Parameter Offset',               value: lambda {self.parent.data_block.trans2_parameters.abs_offset}
+            uint16  :parameter_displacement,  label: 'Parameter Displacement'
+            uint16  :data_count,              label: 'Data Count(bytes)',              value: lambda {self.parent.data_block.trans2_data.length}
+            uint16  :data_offset,             label: 'Data Offset',                    value: lambda {self.parent.data_block.trans2_data.abs_offset}
+            uint16  :data_displacement,       label: 'Data Displacement'
+            uint16  :fid,                     label: 'FileID'
+          end
+
+          class DataBlock < RubySMB::SMB1::Packet::Trans2::Request::DataBlock
+          end
+
+          smb_header        :smb_header
+          parameter_block   :parameter_block
+          data_block        :data_block
+
+          def initialize_instance
+            super
+            smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TRANSACTION2_SECONDARY
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet/trans2/response.rb

@@ -0,0 +1,48 @@
+module RubySMB
+  module SMB1
+    module Packet
+      module Trans2
+
+        # This class represents a generic SMB1 Trans2 Response Packet as defined in
+        # [2.2.4.46.2 Response](https://msdn.microsoft.com/en-us/library/ee441550.aspx)
+        class Response < RubySMB::GenericPacket
+
+          class ParameterBlock < RubySMB::SMB1::ParameterBlock
+            uint16        :total_parameter_count,   label: 'Total Parameter Count(bytes)'
+            uint16        :total_data_count,        label: 'Total Data Count(bytes)'
+            uint16        :reserved,                label: 'Reserved Space',                 value: 0x00
+            uint16        :parameter_count,         label: 'Parameter Count(bytes)',         value: lambda {self.parent.data_block.trans2_parameters.length}
+            uint16        :parameter_offset,        label: 'Parameter Offset',               value: lambda {self.parent.data_block.trans2_parameters.abs_offset}
+            uint16        :parameter_displacement,  label: 'Parameter Displacement'
+            uint16        :data_count,              label: 'Data Count(bytes)',              value: lambda {self.parent.data_block.trans2_data.length}
+            uint16        :data_offset,             label: 'Data Offset',                    value: lambda {self.parent.data_block.trans2_data.abs_offset}
+            uint16        :data_displacement,       label: 'Data Displacement'
+            uint8         :setup_count,             label: 'Setup Count',                    value: lambda {setup.length}
+            uint8         :reserved2,               label: 'Reserved Space',                 value: 0x00
+
+            array :setup, type: :uint16, initial_length: 0
+          end
+
+          class DataBlock < RubySMB::SMB1::Packet::Trans2::DataBlock
+            string :pad1,               length: lambda { pad1_length }
+            string :trans2_parameters,  label: 'Trans2 Parameters'
+            string :pad2,               length: lambda { pad2_length }
+            string :trans2_data,        label: 'Trans2 Data'
+          end
+
+          smb_header        :smb_header
+          parameter_block   :parameter_block
+          data_block        :data_block
+
+          def initialize_instance
+            super
+            smb_header.command = RubySMB::SMB1::Commands::SMB_COM_TRANSACTION2
+            smb_header.flags.reply = 1
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet/trans2/subcommands.rb

@@ -0,0 +1,12 @@
+module RubySMB
+  module SMB1
+    module Packet
+      module Trans2
+        module Subcommands
+          OPEN2         = 0x0000
+          SESSION_SETUP = 0x000E
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module RubySMB
+  module SMB1
+    module Packet
+
+      # Namespace for the Transaction2 sub-protocol documented in
+      # [2.2.4.46 SMB_COM_TRANSACTION2 (0x32)](https://msdn.microsoft.com/en-us/library/ee441652.aspx)
+      module Trans2
+        require 'ruby_smb/smb1/packet/trans2/data_block'
+        require 'ruby_smb/smb1/packet/trans2/subcommands'
+        require 'ruby_smb/smb1/packet/trans2/request'
+        require 'ruby_smb/smb1/packet/trans2/request_secondary'
+        require 'ruby_smb/smb1/packet/trans2/response'
+        require 'ruby_smb/smb1/packet/trans2/open2_request'
+        require 'ruby_smb/smb1/packet/trans2/open2_response'
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb1/packet.rb

@@ -1,7 +1,7 @@
 module RubySMB
   module SMB1
     module Packet
-      require 'ruby_smb/smb1/packet/error_packet'
+      require 'ruby_smb/smb1/packet/empty_packet'
       require 'ruby_smb/smb1/packet/negotiate_request'
       require 'ruby_smb/smb1/packet/negotiate_response'
       require 'ruby_smb/smb1/packet/negotiate_response_extended'
@@ -13,6 +13,10 @@ module RubySMB
       require 'ruby_smb/smb1/packet/tree_disconnect_response'
       require 'ruby_smb/smb1/packet/logoff_request'
       require 'ruby_smb/smb1/packet/logoff_response'
+      require 'ruby_smb/smb1/packet/echo_request'
+      require 'ruby_smb/smb1/packet/echo_response'
+      require 'ruby_smb/smb1/packet/trans2'
+      require 'ruby_smb/smb1/packet/nt_trans'
     end
   end
 end

data/lib/ruby_smb/smb1.rb

@@ -4,6 +4,9 @@ module RubySMB::SMB1
   # Protocol ID value. Translates to \xFFSMB
   SMB_PROTOCOL_ID = 0xFF534D42
 
+  require 'ruby_smb/smb1/dispositions'
+  require 'ruby_smb/smb1/create_actions'
+  require 'ruby_smb/smb1/oplock_levels'
   require 'ruby_smb/smb1/commands'
   require 'ruby_smb/smb1/andx_block'
   require 'ruby_smb/smb1/bit_field'

data/lib/ruby_smb/smb2/bit_field.rb

@@ -4,12 +4,12 @@ module RubySMB
       require 'ruby_smb/smb2/bit_field/smb2_header_flags'
       require 'ruby_smb/smb2/bit_field/smb2_security_mode'
       require 'ruby_smb/smb2/bit_field/smb2_security_mode_single'
-      require 'ruby_smb/smb2/bit_field/smb2_capabailities'
+      require 'ruby_smb/smb2/bit_field/smb2_capabilities'
       require 'ruby_smb/smb2/bit_field/session_flags'
       require 'ruby_smb/smb2/bit_field/directory_access_mask'
       require 'ruby_smb/smb2/bit_field/file_access_mask'
       require 'ruby_smb/smb2/bit_field/share_flags'
-      require 'ruby_smb/smb2/bit_field/share_capabailities'
+      require 'ruby_smb/smb2/bit_field/share_capabilities'
     end
   end
 end

data/lib/ruby_smb/smb2/packet/echo_request.rb

@@ -0,0 +1,21 @@
+module RubySMB
+  module SMB2
+    module Packet
+
+      # An SMB2 Echo Request Packet as defined in
+      # [2.2.28 SMB2 ECHO Request](https://msdn.microsoft.com/en-us/library/cc246540.aspx)
+      class EchoRequest < RubySMB::GenericPacket
+        endian       :little
+        smb2_header  :smb2_header
+        uint16       :structure_size, label: 'Structure Size', initial_value: 4
+        uint16       :reserved
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::ECHO
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/packet/echo_response.rb

@@ -0,0 +1,22 @@
+module RubySMB
+  module SMB2
+    module Packet
+
+      # An SMB2 Echo response Packet as defined in
+      # [2.2.29 SMB2 ECHO Response](https://msdn.microsoft.com/en-us/library/cc246541.aspx)
+      class EchoResponse < RubySMB::GenericPacket
+        endian       :little
+        smb2_header  :smb2_header
+        uint16       :structure_size, label: 'Structure Size', initial_value: 4
+        uint16       :reserved
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::ECHO
+          smb2_header.flags.reply = 1
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/packet.rb

@@ -12,6 +12,8 @@ module RubySMB
       require 'ruby_smb/smb2/packet/tree_disconnect_response'
       require 'ruby_smb/smb2/packet/logoff_request'
       require 'ruby_smb/smb2/packet/logoff_response'
+      require 'ruby_smb/smb2/packet/echo_request'
+      require 'ruby_smb/smb2/packet/echo_response'
     end
   end
 end

data/lib/ruby_smb/version.rb

@@ -1,3 +1,3 @@
 module RubySMB
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

data/ruby_smb.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
     spec.platform = Gem::Platform::RUBY
   end
 
+  spec.required_ruby_version = '>= 2.2.0'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'fivemat'
   spec.add_development_dependency 'rake'

data/spec/lib/ruby_smb/client_spec.rb

@@ -745,4 +745,50 @@ RSpec.describe RubySMB::Client do
 
     end
   end
+
+  context 'Echo command' do
+    context 'with SMB1' do
+      let(:echo_request) { RubySMB::SMB1::Packet::EchoRequest.new }
+      let(:echo_response) {
+        packet = RubySMB::SMB1::Packet::EchoResponse.new
+        packet.smb_header.nt_status = 0x00000080
+        packet
+      }
+
+      before(:each) do
+        allow(RubySMB::SMB2::Packet::EchoRequest).to receive(:new).and_return(echo_request)
+      end
+
+      it 'sets the echo_count on the request packet' do
+        modified_request = echo_request
+        modified_request.parameter_block.echo_count = 5
+        expect(smb1_client).to receive(:send_recv).with(modified_request).and_return(echo_response.to_binary_s)
+        expect(dispatcher).to receive(:recv_packet).exactly(4).times.and_return(echo_response.to_binary_s)
+        smb1_client.smb1_echo(count: 5)
+      end
+
+      it 'sets the data on the request packet' do
+        modified_request = echo_request
+        modified_request.data_block.data = "DEADBEEF"
+        expect(smb1_client).to receive(:send_recv).with(modified_request).and_return(echo_response.to_binary_s)
+        smb1_client.smb1_echo(data: "DEADBEEF")
+      end
+
+      it 'returns the NT status code' do
+        expect(smb1_client).to receive(:send_recv).and_return(echo_response.to_binary_s)
+        expect(smb1_client.echo).to eq WindowsError::NTStatus::STATUS_ABANDONED
+      end
+    end
+
+    context 'with SMB2' do
+      let(:echo_request) { RubySMB::SMB2::Packet::EchoRequest.new }
+      let(:echo_response) { RubySMB::SMB2::Packet::EchoResponse.new }
+
+      it '#smb2_echo sends an Echo Request and returns a response' do
+        allow(RubySMB::SMB2::Packet::EchoRequest).to receive(:new).and_return(echo_request)
+        expect(smb2_client).to receive(:send_recv).with(echo_request).and_return(echo_response.to_binary_s)
+        expect(smb2_client.smb2_echo).to eq echo_response
+      end
+    end
+  end
 end

data/spec/lib/ruby_smb/field/ea_info_array_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Field::EaInfoArray do
+  subject(:info_array) { described_class.new(type: :file_full_ea_info) }
+  let(:first_ea) {
+    ea = RubySMB::Field::FileFullEaInfo.new
+    ea.ea_name  = 'First'
+    ea.ea_value = 'First Value'
+    ea
+  }
+  let(:second_ea) {
+    ea = RubySMB::Field::FileFullEaInfo.new
+    ea.ea_name  = 'Second'
+    ea.ea_value = 'Second Value'
+    ea
+  }
+  let(:additional_ea) {
+    ea = RubySMB::Field::FileFullEaInfo.new
+    ea.ea_name  = 'Additional'
+    ea.ea_value = 'Additional Value'
+    ea
+  }
+
+  it 'updates the offset of the first element when a second is appended' do
+    info_array << first_ea
+    info_array << second_ea
+    expect(info_array[0].next_entry_offset).to eq info_array[1].rel_offset
+  end
+
+  it 'sets the last offset to 0' do
+    info_array << first_ea
+    expect(info_array[0].next_entry_offset).to eq 0
+  end
+
+  it 'updates offset when setting a particular element' do
+    info_array << first_ea
+    info_array << second_ea
+    info_array[0] = additional_ea
+    expect(info_array[0].next_entry_offset).to eq info_array[1].rel_offset
+  end
+
+  it 'raises an error when inserting an invalid object' do
+    expect{ info_array << "Foo" }.to raise_error(ArgumentError)
+  end
+
+  it 'raises an error when setting an invalid value' do
+    expect{ info_array[0] = "Foo" }.to raise_error(ArgumentError)
+  end
+
+
+end

data/spec/lib/ruby_smb/field/extended_attribute_flag_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe RubySMB::Field::ExtendedAttributeFlag do
+  subject(:flag) { described_class.new }
+
+  it { is_expected.to respond_to :file_need_ea }
+
+
+  describe 'file_need_ea' do
+    it 'should be a 1-bit field per the SMB spec' do
+      expect(flag.file_need_ea).to be_a BinData::Bit1
+    end
+
+
+    it_behaves_like 'bit field with one flag set', :file_need_ea, 'C', 0x80
+  end
+
+end

data/spec/lib/ruby_smb/field/file_full_ea_info_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::Field::FileFullEaInfo do
+  subject(:info) { described_class.new }
+
+  it { is_expected.to respond_to :next_entry_offset }
+  it { is_expected.to respond_to :flags }
+  it { is_expected.to respond_to :ea_name_length }
+  it { is_expected.to respond_to :ea_value_length }
+  it { is_expected.to respond_to :ea_name }
+  it { is_expected.to respond_to :ea_value }
+
+  it 'is little endian' do
+    expect(described_class.fields.instance_variable_get(:@hints)[:endian]).to eq :little
+  end
+
+  describe '#flags' do
+    it 'is an extended_attribute_flag' do
+      expect(info.flags).to be_a RubySMB::Field::ExtendedAttributeFlag
+    end
+  end
+
+  describe '#ea_name_length' do
+    it 'stores the length of the #ea_name field' do
+      expect(info.ea_name_length).to eq info.ea_name.do_num_bytes
+    end
+  end
+
+  describe '#ea_value_length' do
+    it 'stores the length of the #ea_value field' do
+      expect(info.ea_value_length).to eq info.ea_value.do_num_bytes
+    end
+  end
+
+end