ruby_smb 0.0.18 → 0.0.19

data/lib/ruby_smb/dcerpc/srvsvc/net_share_enum_all.rb

@@ -0,0 +1,93 @@
+module RubySMB
+  module Dcerpc
+    module Srvsvc
+
+      #https://msdn.microsoft.com/en-us/library/cc247293.aspx
+
+      class NetShareEnumAll < BinData::Record
+        Opnum = 0xF
+
+        endian :little
+
+        uint32    :referent_id,  initial_value: 0x00000001
+        uint32    :max_count,    initial_value: -> { server_unc.do_num_bytes / 2 }
+        uint32    :offset,       initial_value: 0
+        uint32    :actual_count, initial_value: -> {max_count}
+        stringz16 :server_unc,       pad_front: false, read_length: -> { actual_count * 2 },
+                                 initial_value: -> {host.encode('utf-16le')}
+
+        uint32 :level,           initial_value: 1
+
+        uint32 :ctr,             initial_value: 1
+        uint32 :ctr_referent_id, initial_value: 0x00000001
+        uint32 :ctr_count,       initial_value: 0
+        uint32 :pointer_to_array, initial_value: 0
+
+        uint32 :max_buffer,       initial_value: 4294967295
+
+        uint32 :resume_referent_id, initial_value: 0x00000001
+        uint32 :resume_handle,    initial_value: 0
+
+        def self.parse_response(response)
+
+          shares = []
+
+          res = response.dup
+          win_error = res.slice!(-4, 4).unpack("V")[0]
+
+          if win_error != 0
+            raise RuntimeError, "Invalid DCERPC response: win_error = #{win_error}"
+          end
+
+          # Remove unused data
+          res.slice!(0, 12) # level, CTR header, Reference ID of CTR
+          share_count = res.slice!(0, 4).unpack("V")[0]
+          res.slice!(0, 4) # Reference ID of CTR1
+          share_max_count = res.slice!(0, 4).unpack("V")[0]
+
+          if share_max_count != share_count
+            raise RuntimeError, "Invalid DCERPC response: count != count max (#{share_count}/#{share_max_count})"
+          end
+
+          # ReferenceID / Type / ReferenceID of Comment
+          types = res.slice!(0, share_count * 12).scan(/.{12}/n).map { |a| a[4, 2].unpack("v")[0] }
+
+          share_count.times do |t|
+            length, offset, max_length = res.slice!(0, 12).unpack("VVV")
+            if offset != 0
+              raise RuntimeError, "Invalid DCERPC response: offset != 0 (#{offset})"
+            end
+
+            if length != max_length
+              raise RuntimeError, "Invalid DCERPC response: length !=max_length (#{length}/#{max_length})"
+            end
+            name = res.slice!(0, 2 * length).gsub('\x00', '')
+            res.slice!(0, 2) if length % 2 == 1 # pad
+
+            comment_length, comment_offset, comment_max_length = res.slice!(0, 12).unpack("VVV")
+
+            if comment_offset != 0
+              raise RuntimeError, "Invalid DCERPC response: comment_offset != 0 (#{comment_offset})"
+            end
+
+            if comment_length != comment_max_length
+              raise RuntimeError, "Invalid DCERPC response: comment_length != comment_max_length (#{comment_length}/#{comment_max_length})"
+            end
+
+            comment = res.slice!(0, 2 * comment_length)
+
+            res.slice!(0, 2) if comment_length % 2 == 1 # pad
+
+            name = name.gsub("\x00", "")
+            s_type = ['DISK', 'PRINTER', 'DEVICE', 'IPC', 'SPECIAL', 'TEMPORARY'][types[t]].gsub("\x00", "")
+            comment = comment.gsub("\x00", "")
+
+            shares << [name, s_type, comment]
+          end
+
+          shares
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smb/dcerpc/uuid.rb

@@ -0,0 +1,28 @@
+module RubySMB
+  module Dcerpc
+
+    #https://msdn.microsoft.com/en-us/library/windows/desktop/aa379358(v=vs.85).aspx
+    class Uuid < BinData::Primitive
+      uint32le :time_low
+      uint16le :time_mid
+      uint16le :time_hi_and_version
+
+      uint16be :clock_seq_hi_and_res
+      uint48be :node
+
+      def get
+        self.to_binary_s
+      end
+
+      def set(uuid_string)
+        components = uuid_string.split('-')
+        self.time_low = components[0].hex
+        self.time_mid = components[1].hex
+        self.time_hi_and_version = components[2].hex
+        self.clock_seq_hi_and_res = components[3].hex
+        self.node = components[4].hex
+      end
+    end
+
+  end
+end

data/lib/ruby_smb/dispatcher.rb

@@ -1,4 +1,8 @@
-module RubySMB::Dispatcher
-  require 'ruby_smb/dispatcher/base'
-  require 'ruby_smb/dispatcher/socket'
+module RubySMB
+  # Namespace for all of the packet Dispatcher code. This is what
+  # handles network level transport.
+  module Dispatcher
+    require 'ruby_smb/dispatcher/base'
+    require 'ruby_smb/dispatcher/socket'
+  end
 end

data/lib/ruby_smb/dispatcher/base.rb

@@ -1,18 +1,27 @@
-# Provides the base class for the packet dispatcher.
-class RubySMB::Dispatcher::Base
-  # @param packet [#length]
-  # @return [Fixnum] NBSS header to go in front of `packet`
-  def nbss(packet)
-    [packet.do_num_bytes].pack('N')
-  end
+module RubySMB
+  module Dispatcher
+    # Provides the base class for the packet dispatcher.
+    class Base
+      # Creates a NetBIOS Session Service (NBSS) header
+      #
+      # @param packet [#do_num_bytes] the packet to be sent
+      # @return [String] NBSS header to go in front of `packet`
+      def nbss(packet)
+        nbss = RubySMB::Nbss::SessionHeader.new
+        nbss.session_packet_type = RubySMB::Nbss::SESSION_MESSAGE
+        nbss.packet_length       = packet.do_num_bytes
+        nbss.to_binary_s
+      end
 
-  # @abstract
-  def send_packet(packet)
-    raise NotImplementedError
-  end
+      # @abstract
+      def send_packet(_packet)
+        raise NotImplementedError
+      end
 
-  # @abstract
-  def recv_packet
-    raise NotImplementedError
+      # @abstract
+      def recv_packet
+        raise NotImplementedError
+      end
+    end
   end
 end

data/lib/ruby_smb/dispatcher/socket.rb

@@ -1,62 +1,82 @@
 require 'socket'
+module RubySMB
+  module Dispatcher
+    # This class provides a wrapper around a Socket for the packet Dispatcher.
+    # It allows for dependency injection of different Socket implementations.
+    class Socket < RubySMB::Dispatcher::Base
+      READ_TIMEOUT = 30
 
-# This class provides a wrapper around a Socket for the packet Dispatcher.
-# It allows for dependency injection of different Socket implementations.
-class RubySMB::Dispatcher::Socket < RubySMB::Dispatcher::Base
-  # The underlying socket that we select on
-  # @!attribute [rw] tcp_socket
-  #   @return [IO]
-  attr_accessor :tcp_socket
-
-  # @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
+      # The underlying socket that we select on
+      # @!attribute [rw] tcp_socket
+      #   @return [IO]
+      attr_accessor :tcp_socket
 
-  # @param host [String] passed to TCPSocket.new
-  # @param port [Fixnum] passed to TCPSocket.new
-  def self.connect(host, port: 445, socket: TCPSocket.new(host, port))
-    new(socket)
-  end
+      # The read timeout
+      # @!attribute [rw] read_timeout
+      #   @return [Integer]
+      attr_accessor :read_timeout
 
-  # @param packet [SMB2::Packet,#to_s]
-  # @return [void]
-  def send_packet(packet)
-    data = nbss(packet) + packet.to_binary_s
-    bytes_written = 0
-    begin
-      while bytes_written < data.size
-        bytes_written += @tcp_socket.write(data[bytes_written..-1])
+      # @param tcp_socket [IO]
+      def initialize(tcp_socket, read_timeout: READ_TIMEOUT)
+        @tcp_socket = tcp_socket
+        @tcp_socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_KEEPALIVE, true) if @tcp_socket.respond_to?(:setsockopt)
+        @read_timeout = read_timeout
       end
-    rescue IOError, Errno::ECONNABORTED, Errno::ECONNRESET => e
-      raise RubySMB::Error::CommunicationError, "An error occured writing to the Socket"
-    end
-    nil
-  end
 
-  # Read a packet off the wire and parse it into a string
-  # Throw Error::NetBiosSessionService if there's an error reading the first 4 bytes,
-  # which are assumed to be the NetBiosSessionService header.
-  # @return [String]
-  def recv_packet
-    begin
-      IO.select([@tcp_socket])
-      nbss_header = @tcp_socket.read(4) # Length of NBSS header. TODO: remove to a constant
-      if nbss_header.nil?
-        raise ::RubySMB::Error::NetBiosSessionService, 'NBSS Header is missing'
-      else
-        length = nbss_header.unpack('N').first
+      # @param host [String] passed to TCPSocket.new
+      # @param port [Fixnum] passed to TCPSocket.new
+      def self.connect(host, port: 445, socket: TCPSocket.new(host, port))
+        new(socket)
       end
-      IO.select([@tcp_socket])
-      data = @tcp_socket.read(length)
-      data << @tcp_socket.read(length - data.length) while data.length < length
 
-      data
-    rescue Errno::EINVAL, Errno::ECONNABORTED, Errno::ECONNRESET, TypeError => e
-      raise RubySMB::Error::CommunicationError, "An error occured reading from the Socket"
+      # @param packet [SMB2::Packet,#to_s]
+      # @param nbss [Boolean] wether to include the NetBIOS Session header
+      # @return [void]
+      def send_packet(packet, nbss_header: true)
+        data = nbss_header ? nbss(packet) : ''
+        data << packet.to_binary_s
+        bytes_written = 0
+        begin
+          while bytes_written < data.size
+            bytes_written += @tcp_socket.write(data[bytes_written..-1])
+          end
+        rescue IOError, Errno::ECONNABORTED, Errno::ECONNRESET => e
+          raise RubySMB::Error::CommunicationError, "An error occured writing to the Socket: #{e.message}"
+        end
+        nil
+      end
+
+      # Read a packet off the wire and parse it into a string
+      #
+      # @param full_response [Boolean] whether to include the NetBios Session Service header in the repsonse
+      # @return [String] the raw response (including the NetBios Session Service header if full_response is true)
+      # @raise [RubySMB::Error::NetBiosSessionService] if there's an error reading the first 4 bytes,
+      #   which are assumed to be the NetBiosSessionService header.
+      # @raise [RubySMB::Error::CommunicationError] if the read timeout expires or an error occurs when reading the socket
+      def recv_packet(full_response: false)
+        if IO.select([@tcp_socket], nil, nil, @read_timeout).nil?
+          raise RubySMB::Error::CommunicationError, "Read timeout expired when reading from the Socket (timeout=#{@read_timeout})"
+        end
+
+        begin
+          nbss_header = RubySMB::Nbss::SessionHeader.read(@tcp_socket)
+        rescue IOError
+          raise ::RubySMB::Error::NetBiosSessionService, 'NBSS Header is missing'
+        end
+
+        length = nbss_header.packet_length
+        data = full_response ? nbss_header.to_binary_s : ''
+        if length > 0
+          if IO.select([@tcp_socket], nil, nil, @read_timeout).nil?
+            raise RubySMB::Error::CommunicationError, "Read timeout expired when reading from the Socket (timeout=#{@read_timeout})"
+          end
+          data << @tcp_socket.read(length)
+          data << @tcp_socket.read(length - data.length) while data.length < length
+        end
+        data
+      rescue Errno::EINVAL, Errno::ECONNABORTED, Errno::ECONNRESET, TypeError, NoMethodError => e
+        raise RubySMB::Error::CommunicationError, "An error occured reading from the Socket #{e.message}"
+      end
     end
   end
 end

data/lib/ruby_smb/dispositions.rb

@@ -0,0 +1,32 @@
+module RubySMB
+  # This module holds the Create Dispositions used in NT_TRANSACT_CREATE and
+  # SMB_COM_NT_CREATE_ANDX requests. The definitions for these values can be found at
+  # [2.2.4.64.1 Request](https://msdn.microsoft.com/en-us/library/ee442175.aspx)
+  module Dispositions
+    # If the file already exists, it SHOULD be superseded (overwritten).
+    # If it does not already exist, it SHOULD be created.
+    FILE_SUPERSEDE    = 0x00000000
+
+    # If the file already exists, it SHOULD be opened rather than creating a new file.
+    # If the file does not already exist, the operation MUST fail.
+    FILE_OPEN         = 0x00000001
+
+    # If the file already exists, the operation MUST fail.
+    # If the file does not already exist, it SHOULD be created.
+    FILE_CREATE       = 0x00000002
+
+    # If the file already exists, it SHOULD be opened.
+    # If the file does not already exist, it SHOULD be created.
+    FILE_OPEN_IF      = 0x00000003
+
+    # If the file already exists, it SHOULD be opened and truncated.
+    # If the file does not already exist, the operation MUST fail.
+    # The client MUST open the file with at least GENERIC_WRITE access for the command to succeed.
+    FILE_OVERWRITE    = 0x00000004
+
+    # If the file already exists, it SHOULD be opened and truncated.
+    # If the file does not already exist, it SHOULD be created.
+    # The client MUST open the file with at least GENERIC_WRITE access.
+    FILE_OVERWRITE_IF = 0x00000005
+  end
+end

data/lib/ruby_smb/error.rb

@@ -1,24 +1,30 @@
-module RubySMB::Error
-  # Raised when there is a length or formatting issue with an ASN1-encoded string
-  # @see https://en.wikipedia.org/wiki/Abstract_Syntax_Notation_One
-  # @todo Find an SMB-specific link for ASN1 above
-  class ASN1Encoding < StandardError; end
+module RubySMB
+  # Contains all the RubySMB specific Error classes.
+  module Error
+    # Base class for RubySMB errors
+    class RubySMBError < StandardError; end
 
-  # Raised when there is a problem with communication over NetBios Session Service
-  # @see https://wiki.wireshark.org/NetBIOS/NBSS
-  class NetBiosSessionService < StandardError; end
+    # Raised when there is a length or formatting issue with an ASN1-encoded string
+    # @see https://en.wikipedia.org/wiki/Abstract_Syntax_Notation_One
+    # @todo Find an SMB-specific link for ASN1 above
+    class ASN1Encoding < RubySMBError; end
 
-  # Raised when trying to parse raw binary into a Packet and the data
-  # is invalid.
-  class InvalidPacket < StandardError; end
+    # Raised when there is a problem with communication over NetBios Session Service
+    # @see https://wiki.wireshark.org/NetBIOS/NBSS
+    class NetBiosSessionService < RubySMBError; end
 
-  # Raised when a response packet has a NTStatus code that was unexpected.
-  class UnexpectedStatusCode < StandardError; end
+    # Raised when trying to parse raw binary into a Packet and the data
+    # is invalid.
+    class InvalidPacket < RubySMBError; end
 
-  # Raised when an error occurs with the underlying socket.
-  class CommunicationError < StandardError; end
+    # Raised when a response packet has a NTStatus code that was unexpected.
+    class UnexpectedStatusCode < RubySMBError; end
 
-  # Raised when Protocol Negotiation fails, possibly due to an
-  # unsupported protocol.
-  class NegotiationFailure < StandardError; end
+    # Raised when an error occurs with the underlying socket.
+    class CommunicationError < RubySMBError; end
+
+    # Raised when Protocol Negotiation fails, possibly due to an
+    # unsupported protocol.
+    class NegotiationFailure < RubySMBError; end
+  end
 end

data/lib/ruby_smb/field.rb

@@ -1,4 +1,5 @@
 module RubySMB
+  # Namespace for all of the custom BinData fields used by RubySMB
   module Field
     require 'ruby_smb/field/file_time'
     require 'ruby_smb/field/utime'
@@ -8,7 +9,9 @@ module RubySMB
     require 'ruby_smb/field/smb_fea'
     require 'ruby_smb/field/smb_fea_list'
     require 'ruby_smb/field/security_descriptor'
-    require 'ruby_smb/field/file_full_ea_info'
-    require 'ruby_smb/field/ea_info_array'
+    require 'ruby_smb/field/string16'
+    require 'ruby_smb/field/smb2_fileid'
+    require 'ruby_smb/field/smb_gea'
+    require 'ruby_smb/field/smb_gea_list'
   end
 end

data/lib/ruby_smb/field/extended_attribute_flag.rb

@@ -7,4 +7,4 @@ module RubySMB
       bit7  :reserved,      label: 'Reserved Space'
     end
   end
-end
+end

data/lib/ruby_smb/field/file_time.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module RubySMB
   module Field
     # Represents a Windows FILETIME structure as defined in
@@ -32,7 +34,7 @@ module RubySMB
           time_int *= NS_MULTIPLIER
           adjusted_epoch = time_int + EPOCH_DIFF_100NS
           set(adjusted_epoch)
-        when Fixnum
+        when Integer
           self.val = value
         else
           self.val = value.to_i

data/lib/ruby_smb/field/security_descriptor.rb

@@ -4,7 +4,7 @@ module RubySMB
     # [2.4.6 SECURITY_DESCRIPTOR](https://msdn.microsoft.com/en-us/library/cc230366.aspx)
     class SecurityDescriptor < BinData::Record
       endian  :little
-      uint8   :revision,  label: 'Revision',  initial_value: 0x01
+      uint8   :revision,  label: 'Revision', initial_value: 0x01
       uint8   :sbz1,      label: 'Resource Manager Control Bits'
 
       struct :control do
@@ -28,10 +28,10 @@ module RubySMB
         bit1    :dacl_trusted,              label: 'DACL Trusted'
       end
 
-      uint32  :offset_owner,  label: 'Offset Owner',  initial_value: lambda { owner_sid.rel_offset }
-      uint32  :offset_group,  label: 'Offset Group',  initial_value: lambda { group_sid.rel_offset }
-      uint32  :offset_sacl,   label: 'Offset SACL',   initial_value: lambda { sacl.rel_offset }
-      uint32  :offset_dacl,   label: 'Offset DACL',   initial_value: lambda { dacl.rel_offset }
+      uint32  :offset_owner,  label: 'Offset Owner',  initial_value: -> { owner_sid.rel_offset }
+      uint32  :offset_group,  label: 'Offset Group',  initial_value: -> { group_sid.rel_offset }
+      uint32  :offset_sacl,   label: 'Offset SACL',   initial_value: -> { sacl.rel_offset }
+      uint32  :offset_dacl,   label: 'Offset DACL',   initial_value: -> { dacl.rel_offset }
 
       string  :owner_sid, label: 'Owner SID'
       string  :group_sid, label: 'Group SID'
@@ -39,4 +39,4 @@ module RubySMB
       string  :dacl,      label: 'DACL'
     end
   end
-end
+end