ruby_smb 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d730a6a0e6943e7d8e8e519f8fca041fb96d48e0
-  data.tar.gz: a5f252ba978e403a832846827b45f95602cd715c
+  metadata.gz: 851b91cd7c3a5584f839a77b10bae8d84fb48212
+  data.tar.gz: 5a0443efab42f322e25da34ee398e98afd13080b
 SHA512:
-  metadata.gz: 12b3d5af427ac2655c469d7c3b94796d0125c2f6d4e7c883494d304cb65489bb4c131e258ace6a5dcbf8421b4bc79bad9639144d4b0301d9e0acf72caf1091a3
-  data.tar.gz: e7bc4b20c587c1e2ac982f3d98b5a2c91085ad17fcf66115749c5af726a972a3415c36cba9957774844cb9e423e6635e8499e0d8ab64069eafa7db276a006818
+  metadata.gz: 6f6df6e678fc8e73921f20784d465c447e37c364b1e01a07be5ab7683f40f6349fc0698446a6c72300b834698513626951441e1ae8c46e1a0d9ac9c3bb927097
+  data.tar.gz: b004442c39c3f88b63fa3052b7d7a3c8505c83748e5d8bf8531cd94d65816137d241e60e4e626439905993520c048cf11b919131602fec28a8f88f1f9bf9dbef

data/lib/ruby_smb/client.rb

@@ -118,6 +118,15 @@ module RubySMB
       @smb2_message_id = 0
     end
 
+    # Logs off any currently open session on the server
+    # and closes the TCP socket connection.
+    #
+    # @return [void]
+    def disconnect!
+      logoff!
+      dispatcher.tcp_socket.close
+    end
+
     # Sets the message id field in an SMB2 packet's
     # header to the one tracked by the client. It then increments
     # the counter on the client.
@@ -132,6 +141,8 @@ module RubySMB
       packet
     end
 
+    # Performs protocol negotiation and session setup. It defaults to using
+    # the credentials supplied during initialization, but can take a new set of credentials if needed.
     def login(username: self.username, password: self.password, domain: self.domain, local_workstation: self.local_workstation )
       @domain            = domain
       @local_workstation = local_workstation
@@ -149,6 +160,23 @@ module RubySMB
       authenticate
     end
 
+    # Sends a LOGOFF command to the remote server to terminate the session
+    #
+    # @return [WindowsError::ErrorCode] the NTStatus of the response
+    def logoff!
+      if smb2
+        request      = RubySMB::SMB2::Packet::LogoffRequest.new
+        raw_response = send_recv(request)
+        response     = RubySMB::SMB2::Packet::LogoffResponse.read(raw_response)
+      else
+        request      = RubySMB::SMB1::Packet::LogoffRequest.new
+        raw_response = send_recv(request)
+        response     = RubySMB::SMB1::Packet::LogoffResponse.read(raw_response)
+      end
+      wipe_state!
+      response.status_code
+    end
+
     # Sends a packet and receives the raw response through the Dispatcher.
     # It will also sign the packet if neccessary.
     #
@@ -190,9 +218,19 @@ module RubySMB
         smb1_tree_connect(share)
       end
     end
-    private
-
 
+    # Resets all of the session state on the client, setting it
+    # back to scratch. Should only be called when a session is no longer
+    # valid.
+    #
+    # @return [void]
+    def wipe_state!
+      self.session_id       = 0x00
+      self.user_id          = 0x00
+      self.session_key      = ''
+      self.sequence_counter = 0
+      self.smb2_message_id  = 0
+    end
 
 
   end

data/lib/ruby_smb/dispatcher/socket.rb

@@ -11,6 +11,9 @@ class RubySMB::Dispatcher::Socket < RubySMB::Dispatcher::Base
   # @param tcp_socket [IO]
   def initialize(tcp_socket)
     @tcp_socket = tcp_socket
+    if @tcp_socket.respond_to?(:setsockopt)
+      @tcp_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+    end
   end
 
   # @param host [String] passed to TCPSocket.new

data/lib/ruby_smb/smb1/commands.rb

@@ -4,6 +4,7 @@ module RubySMB
       SMB_COM_TREE_DISCONNECT = 0x71
       SMB_COM_NEGOTIATE       = 0x72
       SMB_COM_SESSION_SETUP   = 0x73
+      SMB_COM_LOGOFF          = 0x74
       SMB_COM_TREE_CONNECT    = 0x75
       SMB_COM_NO_ANDX_COMMAND = 0xFF
     end

data/lib/ruby_smb/smb1/packet.rb

@@ -11,6 +11,8 @@ module RubySMB
       require 'ruby_smb/smb1/packet/tree_connect_response'
       require 'ruby_smb/smb1/packet/tree_disconnect_request'
       require 'ruby_smb/smb1/packet/tree_disconnect_response'
+      require 'ruby_smb/smb1/packet/logoff_request'
+      require 'ruby_smb/smb1/packet/logoff_response'
     end
   end
 end

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

@@ -0,0 +1,30 @@
+module RubySMB
+  module SMB1
+    module Packet
+
+      # This class represents an SMB1 LOGOFF Request Packet as defined in
+      # [2.2.4.54.1 Request](https://msdn.microsoft.com/en-us/library/ee442167.aspx)
+      class LogoffRequest < RubySMB::GenericPacket
+
+        # The Parameter Block for this packet is empty save the Word Count and ANDX Block
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          and_x_block :andx_block
+        end
+
+        # The Data Block for this packet is empty save the Byte Count
+        class DataBlock < RubySMB::SMB1::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_LOGOFF
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module RubySMB
+  module SMB1
+    module Packet
+
+      # This class represents an SMB1 LOGOFF Response Packet as defined in
+      # [2.2.4.54.2 Response](https://msdn.microsoft.com/en-us/library/ee441488.aspx)
+      class LogoffResponse < RubySMB::GenericPacket
+
+        # The Parameter Block for this packet is empty save the Word Count and ANDX Block
+        class ParameterBlock < RubySMB::SMB1::ParameterBlock
+          and_x_block :andx_block
+        end
+
+        # The Data Block for this packet is empty save the Byte Count
+        class DataBlock < RubySMB::SMB1::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_LOGOFF
+          smb_header.flags.reply = 1
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/smb2/packet.rb

@@ -10,6 +10,8 @@ module RubySMB
       require 'ruby_smb/smb2/packet/tree_connect_response'
       require 'ruby_smb/smb2/packet/tree_disconnect_request'
       require 'ruby_smb/smb2/packet/tree_disconnect_response'
+      require 'ruby_smb/smb2/packet/logoff_request'
+      require 'ruby_smb/smb2/packet/logoff_response'
     end
   end
 end

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

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

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

@@ -0,0 +1,23 @@
+module RubySMB
+  module SMB2
+    module Packet
+
+      # An SMB2 LOGOFF Response Packet as defined in
+      # [2.2.8 SMB2 LOGOFF Response](https://msdn.microsoft.com/en-us/library/cc246566.aspx)
+      class LogoffResponse < RubySMB::GenericPacket
+        endian       :little
+        smb2_header  :smb2_header
+        uint16       :structure_size, label: 'Structure Size', initial_value: 4
+        uint16       :reserved,       label: 'Reserved Space'
+
+
+        def initialize_instance
+          super
+          smb2_header.command = RubySMB::SMB2::Commands::LOGOFF
+          smb2_header.flags.reply = 1
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_smb/version.rb

@@ -1,3 +1,3 @@
 module RubySMB
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/spec/lib/ruby_smb/smb1/packet/logoff_request_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB1::Packet::LogoffRequest 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_NEGOTIATE' do
+      expect(header.command).to eq RubySMB::SMB1::Commands::SMB_COM_LOGOFF
+    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::ParameterBlock
+    end
+
+    it { is_expected.to respond_to :andx_block }
+
+    it 'has an AndXBlock' do
+      expect(parameter_block.andx_block).to be_a RubySMB::SMB1::AndXBlock
+    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
+  end
+
+
+end

data/spec/lib/ruby_smb/smb1/packet/logoff_response_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB1::Packet::LogoffResponse 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_NEGOTIATE' do
+      expect(header.command).to eq RubySMB::SMB1::Commands::SMB_COM_LOGOFF
+    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 'is a standard ParameterBlock' do
+      expect(parameter_block).to be_a RubySMB::SMB1::ParameterBlock
+    end
+
+    it { is_expected.to respond_to :andx_block }
+
+    it 'has an AndXBlock' do
+      expect(parameter_block.andx_block).to be_a RubySMB::SMB1::AndXBlock
+    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
+  end
+
+
+end

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

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB2::Packet::LogoffRequest 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::LOGOFF
+    end
+
+    it 'should not have the response flag set' do
+      expect(header.flags.reply).to eq 0
+    end
+  end
+
+end

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

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe RubySMB::SMB2::Packet::LogoffResponse 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::LOGOFF
+    end
+
+    it 'should have the response flag set' do
+      expect(header.flags.reply).to eq 1
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_smb
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - David Maloney
@@ -89,7 +89,7 @@ cert_chain:
   G+Hmcg1v810agasPdoydE0RTVZgEOOMoQ07qu7JFXVWZ9ZQpHT7qJATWL/b2csFG
   8mVuTXnyJOKRJA==
   -----END CERTIFICATE-----
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -256,6 +256,8 @@ files:
 - lib/ruby_smb/smb1/dialect.rb
 - lib/ruby_smb/smb1/packet.rb
 - lib/ruby_smb/smb1/packet/error_packet.rb
+- lib/ruby_smb/smb1/packet/logoff_request.rb
+- lib/ruby_smb/smb1/packet/logoff_response.rb
 - lib/ruby_smb/smb1/packet/negotiate_request.rb
 - lib/ruby_smb/smb1/packet/negotiate_response.rb
 - lib/ruby_smb/smb1/packet/negotiate_response_extended.rb
@@ -282,6 +284,8 @@ files:
 - lib/ruby_smb/smb2/commands.rb
 - lib/ruby_smb/smb2/packet.rb
 - lib/ruby_smb/smb2/packet/error_packet.rb
+- lib/ruby_smb/smb2/packet/logoff_request.rb
+- lib/ruby_smb/smb2/packet/logoff_response.rb
 - lib/ruby_smb/smb2/packet/negotiate_request.rb
 - lib/ruby_smb/smb2/packet/negotiate_response.rb
 - lib/ruby_smb/smb2/packet/session_setup_request.rb
@@ -313,6 +317,8 @@ files:
 - spec/lib/ruby_smb/smb1/data_block_spec.rb
 - spec/lib/ruby_smb/smb1/dialect_spec.rb
 - spec/lib/ruby_smb/smb1/packet/error_packet_spec.rb
+- spec/lib/ruby_smb/smb1/packet/logoff_request_spec.rb
+- spec/lib/ruby_smb/smb1/packet/logoff_response_spec.rb
 - spec/lib/ruby_smb/smb1/packet/negotiate_request_spec.rb
 - spec/lib/ruby_smb/smb1/packet/negotiate_response_extended_spec.rb
 - spec/lib/ruby_smb/smb1/packet/negotiate_response_spec.rb
@@ -333,6 +339,8 @@ files:
 - spec/lib/ruby_smb/smb2/bit_field/share_flags_spec.rb
 - spec/lib/ruby_smb/smb2/bit_field/smb2_capabilities_spec.rb
 - spec/lib/ruby_smb/smb2/bit_field/smb_secruity_mode_spec.rb
+- spec/lib/ruby_smb/smb2/packet/logoff_request_spec.rb
+- spec/lib/ruby_smb/smb2/packet/logoff_response_spec.rb
 - spec/lib/ruby_smb/smb2/packet/negotiate_request_spec.rb
 - spec/lib/ruby_smb/smb2/packet/negotiate_response_spec.rb
 - spec/lib/ruby_smb/smb2/packet/session_setup_request_spec.rb
@@ -391,6 +399,8 @@ test_files:
 - spec/lib/ruby_smb/smb1/data_block_spec.rb
 - spec/lib/ruby_smb/smb1/dialect_spec.rb
 - spec/lib/ruby_smb/smb1/packet/error_packet_spec.rb
+- spec/lib/ruby_smb/smb1/packet/logoff_request_spec.rb
+- spec/lib/ruby_smb/smb1/packet/logoff_response_spec.rb
 - spec/lib/ruby_smb/smb1/packet/negotiate_request_spec.rb
 - spec/lib/ruby_smb/smb1/packet/negotiate_response_extended_spec.rb
 - spec/lib/ruby_smb/smb1/packet/negotiate_response_spec.rb
@@ -411,6 +421,8 @@ test_files:
 - spec/lib/ruby_smb/smb2/bit_field/share_flags_spec.rb
 - spec/lib/ruby_smb/smb2/bit_field/smb2_capabilities_spec.rb
 - spec/lib/ruby_smb/smb2/bit_field/smb_secruity_mode_spec.rb
+- spec/lib/ruby_smb/smb2/packet/logoff_request_spec.rb
+- spec/lib/ruby_smb/smb2/packet/logoff_response_spec.rb
 - spec/lib/ruby_smb/smb2/packet/negotiate_request_spec.rb
 - spec/lib/ruby_smb/smb2/packet/negotiate_response_spec.rb
 - spec/lib/ruby_smb/smb2/packet/session_setup_request_spec.rb