packetgen-plugin-smb 0.6.1 → 0.6.2

data/lib/packetgen/plugin/smb/blocks.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Common blocks used for unsupported SMB messages.

data/lib/packetgen/plugin/smb/browser.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Browser Trans sub-protocol.

data/lib/packetgen/plugin/smb/browser/domain_announcement.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     class Browser

data/lib/packetgen/plugin/smb/browser/host_announcement.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     class Browser

data/lib/packetgen/plugin/smb/browser/local_master_announcement.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     class Browser

data/lib/packetgen/plugin/smb/close.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Namespace for CLOSE related classes

data/lib/packetgen/plugin/smb/close/request.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     module Close

data/lib/packetgen/plugin/smb/close/response.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     module Close

data/lib/packetgen/plugin/smb/filetime.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # SMB FILETIME.
     # @author Sylvain Daubert
     class Filetime
+      include PacketGen::Types::Fieldable
+
       # Base time for SMB FILETIME.
       # This value also indicate no time.
       NO_TIME = Time.utc(1601).freeze

data/lib/packetgen/plugin/smb/negotiate.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Namespace for NEGOTIATE related classes

data/lib/packetgen/plugin/smb/negotiate/dialect.rb

@@ -1,3 +1,10 @@
+# frozen_string_literal: true
+
+# This file is part of packetgen-plugin-smb.
+# See https://github.com/sdaubert/packetgen-plugin-smb for more informations
+# Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen::Plugin
   class SMB
     module Negotiate

data/lib/packetgen/plugin/smb/negotiate/request.rb

@@ -1,3 +1,10 @@
+# frozen_string_literal: true
+
+# This file is part of packetgen-plugin-smb.
+# See https://github.com/sdaubert/packetgen-plugin-smb for more informations
+# Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen::Plugin
   class SMB
     module Negotiate

data/lib/packetgen/plugin/smb/negotiate/response.rb

@@ -1,3 +1,10 @@
+# frozen_string_literal: true
+
+# This file is part of packetgen-plugin-smb.
+# See https://github.com/sdaubert/packetgen-plugin-smb for more informations
+# Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen::Plugin
   class SMB
     module Negotiate
@@ -7,7 +14,6 @@ module PacketGen::Plugin
       # and {Blocks#bytes}.
       # @author Sylvain Daubert
       class Response < Blocks
-
         # Get index of the dialect selected by the server from the list presented in the request.
         # @return [Integer]
         def dialect_index
@@ -20,4 +26,4 @@ module PacketGen::Plugin
       end
     end
   end
-end
+end

data/lib/packetgen/plugin/smb/nt_create_and_x.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Namespace for NT_CREATE_ANDX related classes

data/lib/packetgen/plugin/smb/ntcreateandx/request.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Namespace for NT_CREATE_ANDX related classes
@@ -128,7 +128,7 @@ module PacketGen::Plugin
         #  Padding before {#filename} to align it on 16-bit boundary. Only present
         #  if {SMB#flags2_unicode?} is +true+.
         #  @return [Integer]
-        define_field :pad1, PacketGen::Types::Int8, optional: ->(h) { h.packet && h.packet.smb.flags2_unicode? }
+        define_field :pad1, PacketGen::Types::Int8, optional: ->(h) { h&.packet&.smb&.flags2_unicode? }
         # @!attribute filename
         #  A string that represents the fully qualified name of the file
         #  relative to the supplied TID
@@ -154,6 +154,6 @@ module PacketGen::Plugin
           self.byte_count = bcount
         end
       end
-      end
+    end
   end
 end

data/lib/packetgen/plugin/smb/ntcreateandx/response.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Namespace for NT_CREATE_ANDX related classes

data/lib/packetgen/plugin/smb/string.rb

@@ -1,34 +1,39 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
+require 'forwardable'
 
 module PacketGen::Plugin
   class SMB
     # SMB strings (UTF-16 little-endian or OEM).
     # @author Sylvain Daubert
-    class String < PacketGen::Types::CString
-      # @param [Boolean] value
-      # @return [Boolean]
-      attr_writer :unicode
+    class String
+      extend Forwardable
+      include PacketGen::Types::Fieldable
+
+      def_delegators :@string, :[], :length, :size, :inspect, :==, :<<,
+                     :unpack, :force_encoding, :encoding, :index, :empty?,
+                     :encode
+
+      # @return [::String]
+      attr_reader :string
       # @param [Boolean] null_terminated
       # @return [Boolean]
       attr_writer :null_terminated
 
       # @param [Hash] options
-      # @option options [Integer] :static_length set a static length for this string
       # @option options [Boolean] :unicode If +true+, string is encoded as a UTF-16
       #    unicode string. If +false+, string is encode in ASCII. Defaults to +true+.
       # @option options [Boolean] :null_terminated If +true+, string is null-terminated.
       #    If +false+, string is not null-terminated. Defaults to +true+.
       def initialize(options={})
-        super
         @unicode = options.key?(:unicode) ? options[:unicode] : true
         @null_terminated = options.key?(:null_terminated) ? options[:null_terminated] : true
-        encoding = unicode? ? 'UTF-16LE' : 'ASCII-8BIT'
-        self.encode!(encoding)
+        @string = +''.encode(self_encoding)
       end
 
       # @return [Boolean]
@@ -36,6 +41,14 @@ module PacketGen::Plugin
         @unicode
       end
 
+      # @param [Boolean] bool
+      # @return [Boolean]
+      def unicode=(bool)
+        @unicode = bool
+        @string.force_encoding(self_encoding)
+        bool
+      end
+
       # @return [Boolean]
       def null_terminated?
         @null_terminated
@@ -48,48 +61,47 @@ module PacketGen::Plugin
 
         str2 = case str.encoding
                when Encoding::BINARY
-                 binidx = nil
-                 0.step(to: str.size, by: 2) do |i|
-                   binidx = i if str[i, 2] == binary_terminator
-                 end
-                 s = if binidx.nil?
-                       str
-                     else
-                       str[0, binidx]
-                     end
-                 s.force_encoding(self_encoding)
+                 str.dup.force_encoding(self_encoding)
                else
                  str.encode(self_encoding)
                end
-        str2 = str2[0, @static_length / 2] if @static_length.is_a? Integer
         idx = str2.index(+"\x00".encode(self_encoding))
         str2 = str2[0, idx] unless idx.nil?
-        self.replace str2
+        @string = str2
         self
       end
 
       # @return [String]
       def to_s
-        s = super
-        s.encode(self_encoding)
-        return s if null_terminated?
+        str = string.dup.force_encoding('BINARY')
+        return str unless null_terminated?
+
+        str << binary_terminator.force_encoding('BINARY')
+      end
 
-        s[0...-binary_terminator.size]
+      # Populate String from a human readable (ie UTF-8) string
+      # @param [String] str
+      # @return [self]
+      def from_human(str)
+        return self if str.nil?
+
+        @string = str.encode(self_encoding)
+        self
       end
 
       # @return [String]
       def to_human
-        super.encode('UTF-8')
+        string.encode('UTF-8')
       end
 
       private
 
       def self_encoding
-        @unicode ? Encoding::UTF_16LE : Encoding:: ASCII_8BIT
+        @unicode ? Encoding::UTF_16LE : Encoding::ASCII_8BIT
       end
 
       def binary_terminator
-        @unicode ? "\x00\x00" : "\x00"
+        [0].pack('C').encode(self_encoding)
       end
     end
   end

data/lib/packetgen/plugin/smb/trans.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     # Namespace for TRANS related classes

data/lib/packetgen/plugin/smb/trans/request.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     module Trans
@@ -96,7 +96,7 @@ module PacketGen::Plugin
         #  8-bit optional padding to align {#name} on a 2-byte boundary. Only present
         #  if {SMB#flags2_unicode?} is +true+.
         #  @return [Integer]
-        define_field :padname, PacketGen::Types::Int8, optional: ->(h) { h.packet && h.packet.smb.flags2_unicode? }
+        define_field :padname, PacketGen::Types::Int8, optional: ->(h) { h&.packet&.smb&.flags2_unicode? }
         # @!attribute name
         #  Pathname of the mailslot or named pipe.
         #  @return [String]

data/lib/packetgen/plugin/smb/trans/response.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   class SMB
     module Trans

data/lib/packetgen/plugin/smb2.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of packetgen-plugin-smb.
 # See https://github.com/sdaubert/packetgen-plugin-smb for more informations
 # Copyright (C) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen::Plugin
   # Server Message Block version 2 and 3 (SMB2) header.
   # @author Sylvain Daubert
@@ -84,7 +84,7 @@ module PacketGen::Plugin
     #  64-bit unique ID that is created by the server to handle operations
     #  asynchronously. Only present for asynchronous messages.
     #  @return [Integer]
-    define_field :async_id, PacketGen::Types::Int64le, optional: ->(h) { h.flags & 2  == 2}
+    define_field :async_id, PacketGen::Types::Int64le, optional: ->(h) { h.flags & 2 == 2 }
     # @!attribute reserved
     #  32-bit reserved field.
     #  Only present for synchronous messages.