packetgen 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c68cb5128a07a395378b28ecf7ab5711be938cbc5fb2807d42b7cb9a946ed5d
-  data.tar.gz: cb5d764d681dcda886a0fd2b5c3d852aa1eb477edb116286e8ac449e7170c5bd
+  metadata.gz: 05c4708dc2f5da405247b3dbc37d2ff96180086949587f1a7027ef65a9bc8b5d
+  data.tar.gz: 323d1b0810e378ac564b260ddfa182b7d7f4e3ca1504f2e03d46ac7511f4c3db
 SHA512:
-  metadata.gz: de785e82d0bc1d5d1a00d6069a74e120fdd6323bd68ab1c06e285967e2d6ab6c32caec8a8079e393cd52076d81d7ab0ccbbb2522d4212264181a7c5033a8718a
-  data.tar.gz: fa91feb360719d3a10a7b984cc89c1cb1c842ec69b41121029f68b374e0a2db03f02ea50898b78fb1ce439dd0aed3a2e60635acb8242e71a01184faaece91c99
+  metadata.gz: 1e96208217d2e909db2d2cfd5ffc4eed7180b9c9cde98f20af34e7cd7b28404c744eb6a51851b4e0ad5aba79ec91cb39ae6f21292bee2a6ec60d423fd8bbdece
+  data.tar.gz: 9f59f2ecc4f409b43a38c9a16e0d632182af19fa958687599db5ce719e3776b4a24e48384a432e8e2f4a6bc6312f96e2ed0c474d6ebc7db13f4ccdcbdb71666a

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 sudo: required
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5

data/lib/packetgen/header/netbios.rb

@@ -11,54 +11,10 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.5.1
     module NetBIOS
-      # NetBIOS Session Service messages.
-      # @author Sylvain Daubert
-      class Session < Base
-        # Port number for NetBIOS Session Service over TCP
-        TCP_PORT = 139
-
-        # Session packet types
-        TYPES = {
-          'message'           => 0,
-          'request'           => 0x81,
-          'positive_response' => 0x82,
-          'negative_response' => 0x83,
-          'retarget_response' => 0x84,
-          'keep_alive'        => 0x85,
-        }.freeze
-
-        # @!attribute type
-        #  8-bit session packet type
-        #  @return [Integer]
-        define_field :type, Types::Int8Enum, enum: TYPES
-        # @!attribute length
-        #  17-bit session packet length
-        #  @return [Integer]
-        define_field :length, Types::Int24
-        # @!attribute body
-        #  @return [String]
-        define_field :body, Types::String
-
-        # Compute and set {#length} field
-        # @return [Integer] calculated length
-        def calc_length
-          Base.calculate_and_set_length(self, header_in_size: false)
-        end
-
-        # @api private
-        # @note This method is used internally by PacketGen and should not be
-        #       directly called
-        # @since 2.7.0 Set TCP sport according to bindings, only if sport is 0.
-        #  Needed by new bind API.
-        def added_to_packet(packet)
-          return unless packet.is? 'TCP'
-          return unless packet.tcp.sport.zero?
-          packet.tcp.sport = TCP_PORT
-        end
-      end
     end
-    self.add_class NetBIOS::Session
-    TCP.bind NetBIOS::Session, dport: NetBIOS::Session::TCP_PORT
-    TCP.bind NetBIOS::Session, sport: NetBIOS::Session::TCP_PORT
   end
 end
+
+require_relative 'netbios/name'
+require_relative 'netbios/session'
+require_relative 'netbios/datagram'

data/lib/packetgen/header/netbios/datagram.rb

@@ -0,0 +1,105 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+# frozen_string_literal: true
+
+module PacketGen
+  module Header
+    # Module to group all NetBIOS headers
+    # @author Sylvain Daubert
+    # @since 2.5.1
+    module NetBIOS
+      # NetBIOS Session Service messages.
+      # @author Sylvain Daubert
+      class Datagram < Base
+        # Port number for NetBIOS Session Service over TCP
+        UDP_PORT = 138
+
+        # Datagram packet types
+        TYPES = {
+          'direct_unique' => 0x10,
+          'direct_group' => 0x11,
+          'broadcast' => 0x12,
+          'error' => 0x13,
+          'query_request' => 0x14,
+          'positive_query_resp' => 0x15,
+          'negative_query_resp' => 0x16,
+        }.freeze
+
+        # @!attribute type
+        #  8-bit session packet type
+        #  @return [Integer]
+        define_field :type, Types::Int8Enum, enum: TYPES
+        # @!attribute flags
+        #  8-bit flags
+        #  @return [Integer]
+        define_field :flags, Types::Int8
+        # @!attribute dgm_id
+        #  16-bit next transaction ID for datagrams
+        #  @return [Integer]
+        define_field :dgm_id, Types::Int16
+        # @!attribute src_ip
+        #  Source IP address
+        # @return [IP::Addr]
+        define_field :src_ip, IP::Addr
+        # @!attribute src_port
+        #  Source port
+        # @return [IP::Addr]
+        define_field :src_port, Types::Int16
+        # @!attribute dgm_length
+        #  Length of data + second level of encoded names. Not present in error datagram.
+        # @return [Integer]
+        define_field :dgm_length, Types::Int16, optional: ->(h) { h.type != 0x13 }
+        # @!attribute packet_offset
+        # Not present in error datagram.
+        # @return [Integer]
+        define_field :packet_offset, Types::Int16, optional: ->(h) { h.type != 0x13 }
+        # @!attribute error_code
+        #  Error code. Only present in error datagrams.
+        #  @return [Integer]
+        define_field :error_code, Types::Int16, optional: ->(h) { h.type == 0x13 }
+        # @!attribute src_name
+        #  NetBIOS source name. Only present in direct_unique, direct_group and broadcast datagrams.
+        #  @return []
+        define_field :src_name, Name, default: '', optional: ->(h) { (h.type >= 0x10) && (h.type <= 0x12) }
+        # @!attribute dst_name
+        #  NetBIOS destination name. Present in all but error datagrams.
+        #  @return []
+        define_field :dst_name, Name, default: '', optional: ->(h) { h.type != 0x13 }
+        # @!attribute body
+        #  User data. Ony present in direct_unique, direct_group and broadcast datagrams.
+        #  @return [String]
+        define_field :body, Types::String, optional: ->(h) { (h.type >= 0x10) && (h.type <= 0x12) }
+
+        # @!attribute :rsv
+        #  4-bit rsv field. 4 upper bits of {#flags}
+        #  @return [Integer]
+        # @!attribute :snt
+        #  2-bit SNT (Source end-Node Type) field from {#flags}.
+        #  @return [Integer]
+        # @!attribute f
+        #  First packet flag. If set then this is first
+        #  (and possibly only) fragment of NetBIOS datagram.
+        #  @return [Boolean]
+        # @!attribute m
+        #  More flag. If set then more NetBIOS datagram
+        #  fragments follow.
+        #  @return [Boolean]
+        define_bit_fields_on :flags, :rsv, 4, :snt, 2, :f, :m
+
+        # Compute and set {#dgm_length} field
+        # @return [Integer] calculated length
+        def calc_length
+          length = self[:body].sz
+          length += self[:src_name].sz if is_present?(:src_name)
+          length += self[:dst_name].sz if is_present?(:dst_name)
+          self.dgm_length = length
+        end
+      end
+      Header.add_class Datagram
+      UDP.bind Datagram, dport: Datagram::UDP_PORT, sport: Datagram::UDP_PORT
+    end
+  end
+end

data/lib/packetgen/header/netbios/name.rb

@@ -0,0 +1,67 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+# frozen_string_literal: true
+
+module PacketGen
+  module Header
+    # Module to group all NetBIOS headers
+    # @author Sylvain Daubert
+    # @since 2.5.1
+    module NetBIOS
+      # NetBIOS Name.
+      # @author Sylvain Daubert
+      class Name < DNS::Name
+        # Size, in bytes, of an encoded NetBIOS name
+        ENCODED_NAME_SIZE = 32
+
+        # Read a NetBIOS name from a string
+        # @param [String] str
+        # @return [Name] self
+        def from_human(str)
+          clear
+          return self if str.nil?
+          encoded_name = encode_name(str)
+
+          super(encoded_name)
+        end
+
+        # Get a human readable string
+        # @return [String]
+        def to_human
+          encoded_name = super
+          decode_name(encoded_name)
+        end
+
+        private
+
+        def encode_name(name)
+          basename, *scope_id = name.split('.')
+          basename = '' if basename.nil?
+          scope_id = scope_id.join('.')
+          encoded_name = +''
+          basename.each_byte do |byte|
+            a = (byte >> 4) + 0x41
+            b = (byte & 0xf) + 0x41
+            encoded_name << [a, b].pack('C2')
+          end
+          encoded_name << 'CA' * ((ENCODED_NAME_SIZE - encoded_name.size) / 2) if encoded_name.size < ENCODED_NAME_SIZE
+          encoded_name << ".#{scope_id}" if scope_id
+          encoded_name
+        end
+
+        def decode_name(encoded_name)
+          name = +''
+          encoded_name.partition('.').first.scan(/../).map do |duo|
+            a = (duo[0].ord - 0x41) & 0xf
+            b = (duo[1].ord - 0x41) & 0xf
+            name << (a << 4 | b).chr
+          end
+          name.strip
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/netbios/session.rb

@@ -0,0 +1,64 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+# frozen_string_literal: true
+
+module PacketGen
+  module Header
+    # Module to group all NetBIOS headers
+    # @author Sylvain Daubert
+    # @since 2.5.1
+    module NetBIOS
+      # NetBIOS Session Service messages.
+      # @author Sylvain Daubert
+      class Session < Base
+        # Port number for NetBIOS Session Service over TCP
+        TCP_PORT = 139
+
+        # Session packet types
+        TYPES = {
+          'message'           => 0,
+          'request'           => 0x81,
+          'positive_response' => 0x82,
+          'negative_response' => 0x83,
+          'retarget_response' => 0x84,
+          'keep_alive'        => 0x85,
+        }.freeze
+
+        # @!attribute type
+        #  8-bit session packet type
+        #  @return [Integer]
+        define_field :type, Types::Int8Enum, enum: TYPES
+        # @!attribute length
+        #  17-bit session packet length
+        #  @return [Integer]
+        define_field :length, Types::Int24
+        # @!attribute body
+        #  @return [String]
+        define_field :body, Types::String
+
+        # Compute and set {#length} field
+        # @return [Integer] calculated length
+        def calc_length
+          Base.calculate_and_set_length(self, header_in_size: false)
+        end
+
+        # @api private
+        # @note This method is used internally by PacketGen and should not be
+        #       directly called
+        # @since 2.7.0 Set TCP sport according to bindings, only if sport is 0.
+        #  Needed by new bind API.
+        def added_to_packet(packet)
+          return unless packet.is? 'TCP'
+          return unless packet.tcp.sport.zero?
+          packet.tcp.sport = TCP_PORT
+        end
+      end
+      Header.add_class Session
+      TCP.bind Session, dport: Session::TCP_PORT
+      TCP.bind Session, sport: Session::TCP_PORT
+    end
+  end
+end

data/lib/packetgen/header/ospfv3/ipv6_prefix.rb

@@ -8,12 +8,6 @@
 module PacketGen
   module Header
     class OSPFv3
-      # Array of 32-bit words.
-      # @author Sylvain Daubert
-      class ArrayOfInt32 < Types::Array
-        set_of Types::Int32
-      end
-
       # This class handles IPv6 prefixes, as defined in RFC 5340 §A.4.1.
       # A IPv6 prefix consists of:
       # * a 8-bit {#length} field (length of the prefix, in bits),
@@ -39,7 +33,7 @@ module PacketGen
         # @!attribute prefix
         #  IPv6 Prefix as an array of 32-bit words
         #  @return [Prefix]
-        define_field :prefix, ArrayOfInt32
+        define_field :prefix, Types::ArrayOfInt32
 
         # @!attribute dn_opt
         #  This bit controls an inter-area-prefix-LSAs or AS-external-LSAs

data/lib/packetgen/types/array.rb

@@ -210,5 +210,26 @@ module PacketGen
         end
       end
     end
+
+    # Specialized array to handle serie of {Int8}.
+    class ArrayOfInt8 < Array
+      set_of Int8
+    end
+    # Specialized array to handle serie of {Int16}.
+    class ArrayOfInt16 < Array
+      set_of Int16
+    end
+    # Specialized array to handle serie of {Int16le}.
+    class ArrayOfInt16le < Array
+      set_of Int16le
+    end
+    # Specialized array to handle serie of {Int32}.
+    class ArrayOfInt32 < Types::Array
+      set_of Types::Int32
+    end
+    # Specialized array to handle serie of {Int32le}.
+    class ArrayOfInt32le < Types::Array
+      set_of Types::Int32le
+    end
   end
 end

data/lib/packetgen/types/cstring.rb

@@ -35,13 +35,13 @@ module PacketGen
         if @static_length.is_a? Integer
           if self.size >= @static_length
             s = self[0, @static_length]
-            s[-1] = 0.chr
+            s[-1] = "\x00".encode(s.encoding)
             PacketGen.force_binary s
           else
             PacketGen.force_binary(self + "\0" * (@static_length - self.length))
           end
         else
-          PacketGen.force_binary(self + 0.chr)
+          PacketGen.force_binary(self + +"\x00".encode(self.encoding))
         end
       end
 
@@ -56,7 +56,7 @@ module PacketGen
 
       # @return [String]
       def to_human
-        idx = self.index(0.chr) || self.sz
+        idx = self.index(+"\x00".encode(self.encoding)) || self.sz
         self[0, idx]
       end
     end

data/lib/packetgen/types/fields.rb

@@ -70,11 +70,13 @@ module PacketGen
     #   # object will have a different value.
     #   define_field :id, PacketGen::Types::Int16, default: ->{ rand(65535) }
     #   # a size field
-    #   define_field :body_size, PacketGen::Type::Int16
+    #   define_field :body_size, PacketGen::Types::Int16
     #   # String field which length is taken from body_size field
-    #   define_field :body, PacketGen::Type::String, builder: ->(obj, type) { type.new('', length_from: obj[:body_size]) }
+    #   define_field :body, PacketGen::Types::String, builder: ->(obj, type) { type.new('', length_from: obj[:body_size]) }
     #   # 16-bit enumeration type. As :default not specified, default to first value of enum
-    #   define_field :type_class, PacketGen::Type::Int16Enum, enum: { 'class1' => 1, 'class2' => 2}
+    #   define_field :type_class, PacketGen::Types::Int16Enum, enum: { 'class1' => 1, 'class2' => 2}
+    #   # optional field. Only present if another field has a certain value
+    #   define_field :opt1, PacketGen::Types::Int16, optional: ->(h) { h.type == 42 }
     #
     # {.define_field_before} and {.define_field_after} are also defined to relatively
     # create a field from anoher one (for example, when adding a field in a subclass).
@@ -452,6 +454,20 @@ module PacketGen
         PacketGen.force_binary(str)
       end
 
+      # Get offset of given field in {Fields} structure.
+      # @param [Symbol] field
+      # @return [Integer]
+      # @raise [ArgumentError] unknown field
+      def offset_of(field)
+        raise ArgumentError, "#{field} is an unknown field of #{self.class}" unless @fields.include?(field)
+        offset = 0
+        fields.each do |f|
+          break offset if f == field
+          next unless is_present?(f)
+          offset += self[f].sz
+        end
+      end
+
       private
 
       # Deeply duplicate +@fields+

data/lib/packetgen/version.rb

@@ -10,5 +10,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '2.7.0'
+  VERSION = '2.8.0'
 end

data/packetgen.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency 'interfacez', '~>1.0'
   spec.add_dependency 'pcaprub', '~>0.12.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -227,6 +227,9 @@ files:
 - lib/packetgen/header/mldv2/mlq.rb
 - lib/packetgen/header/mldv2/mlr.rb
 - lib/packetgen/header/netbios.rb
+- lib/packetgen/header/netbios/datagram.rb
+- lib/packetgen/header/netbios/name.rb
+- lib/packetgen/header/netbios/session.rb
 - lib/packetgen/header/ospfv2.rb
 - lib/packetgen/header/ospfv2/db_description.rb
 - lib/packetgen/header/ospfv2/hello.rb
@@ -287,7 +290,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="