Merge branch 'packetgen4'

Author: sdaubert

Gemfile

@@ -6,6 +6,11 @@ gemspec
 
 gem 'bundler', '>= 1.17', '< 3'
 
+group :development do
+  gem 'rake', '~>13.0'
+  gem 'rspec', '~>3.13'
+end
+
 group :noci do
   gem 'rubocop', '~> 1.12'
   gem 'rubocop-performance', '~> 1.13'

lib/packetgen/plugin/crypto.rb

@@ -74,7 +74,7 @@ def decipher(data)
     end
 
     # Compute and set IV for deciphering mode
-    # @param [PacketGen::Types::String] salt
+    # @param [BinStruct::String] salt
     # @param [String] msg ciphered message
     # @return [String] iv
     def compute_iv_for_decrypting(salt, msg)
@@ -100,7 +100,7 @@ def compute_iv_for_decrypting(salt, msg)
     # @param [String] salt salt to use
     # @return [void]
     def compute_iv_for_encrypting(iv, salt) # rubocop:disable Naming/MethodParameterName
-      real_iv = force_binary(salt) + force_binary(iv)
+      real_iv = salt.b + iv.b
       real_iv += [1].pack('N') if confidentiality_mode == 'ctr'
       @conf.iv = real_iv
     end

lib/packetgen/plugin/esp.rb

@@ -11,12 +11,12 @@
 
 module PacketGen::Plugin
   # A ESP header consists of:
-  # * a Security Parameters Index (#{spi}, {PacketGen::Types::Int32} type),
+  # * a Security Parameters Index (#{spi}, {BinStruct::Int32} type),
   # * a Sequence Number ({#sn}, +Int32+ type),
   # * a {#body} (variable length),
   # * an optional TFC padding ({#tfc}, variable length),
   # * an optional {#padding} (to align ESP on 32-bit boundary, variable length),
-  # * a {#pad_length} ({PacketGen::Types::Int8}),
+  # * a {#pad_length} ({BinStruct::Int8}),
   # * a Next header field ({#next}, +Int8+),
   # * and an optional Integrity Check Value ({#icv}, variable length).
   #
@@ -80,34 +80,34 @@ class ESP < PacketGen::Header::Base
     # @!attribute spi
     #  32-bit Security Parameter Index
     #  @return [Integer]
-    define_field :spi, PacketGen::Types::Int32
+    define_attr :spi, BinStruct::Int32
     # @!attribute sn
     #  32-bit Sequence Number
     #  @return [Integer]
-    define_field :sn, PacketGen::Types::Int32
+    define_attr :sn, BinStruct::Int32
     # @!attribute body
-    #  @return [PacketGen::Types::String,PacketGen::Header::Base]
-    define_field :body, PacketGen::Types::String
+    #  @return [BinStruct::String,PacketGen::Header::Base]
+    define_attr :body, BinStruct::String
     # @!attribute tfc
     #  Traffic Flow Confidentiality padding
-    #  @return [PacketGen::Types::String,PacketGen::Header::Base]
-    define_field :tfc, PacketGen::Types::String
+    #  @return [BinStruct::String,PacketGen::Header::Base]
+    define_attr :tfc, BinStruct::String
     # @!attribute padding
     #  ESP padding
-    #  @return [PacketGen::Types::String,PacketGen::Header::Base]
-    define_field :padding, PacketGen::Types::String
+    #  @return [BinStruct::String,PacketGen::Header::Base]
+    define_attr :padding, BinStruct::String
     # @!attribute pad_length
     #  8-bit padding length
     #  @return [Integer]
-    define_field :pad_length, PacketGen::Types::Int8
+    define_attr :pad_length, BinStruct::Int8
     # @!attribute next
     #  8-bit next protocol value
     #  @return [Integer]
-    define_field :next, PacketGen::Types::Int8
+    define_attr :next, BinStruct::Int8
     # @!attribute icv
     #  Integrity Check Value
-    #  @return [PacketGen::Types::String,PacketGen::Header::Base]
-    define_field :icv, PacketGen::Types::String
+    #  @return [BinStruct::String,PacketGen::Header::Base]
+    define_attr :icv, BinStruct::String
 
     # ICV (Integrity Check Value) length
     # @return [Integer]
@@ -140,11 +140,11 @@ def initialize(options={})
     def read(str)
       return self if str.nil?
 
-      force_binary str
-      self[:spi].read str[0, 4]
-      self[:sn].read str[4, 4]
-      self[:tfc].read ''
-      self[:padding].read ''
+      str = str.b
+      self[:spi].read(str[0, 4])
+      self[:sn].read(str[4, 4])
+      self[:tfc].read('')
+      self[:padding].read('')
 
       read_icv_dependent_fields(str[8..-1])
       read_icv(str)
@@ -239,7 +239,7 @@ def read_icv(str)
     def get_auth_data(opt)
       ad = self[:spi].to_s
       if opt[:esn]
-        @esn = PacketGen::Types::Int32.new(opt[:esn])
+        @esn = BinStruct::Int32.new(value: opt[:esn])
         ad << @esn.to_s if @conf.authenticated?
       end
       ad << self[:sn].to_s
@@ -273,12 +273,12 @@ def encrypt_set_pad_length
     def encrypt_set_padding(opt)
       if opt[:pad_length]
         self.pad_length = opt[:pad_length]
-        padding = force_binary(opt[:padding] || (1..self.pad_length).to_a.pack('C*'))
-        self[:padding].read padding
+        padding = opt[:padding] || (1..self.pad_length).to_a.pack('C*')
       else
-        padding = force_binary(opt[:padding] || (1..self.pad_length).to_a.pack('C*'))
-        self[:padding].read padding[0...self.pad_length]
+        padding = opt[:padding] || (1..self.pad_length).to_a.pack('C*')
+        padding = padding[0...self.pad_length]
       end
+      self[:padding].read(padding)
     end
 
     def generate_tfc(opt)
@@ -293,7 +293,7 @@ def generate_tfc(opt)
                    else
                      (tfc_size / 4) * 4
                    end
-        tfc = force_binary("\0" * tfc_size)
+        tfc = "\0".b * tfc_size
       end
       tfc
     end
@@ -309,7 +309,7 @@ def encrypt_body(opt, iv) # rubocop:disable Naming/MethodParameterName
     end
 
     def encrypt_set_encrypted_fields(msg, iv) # rubocop:disable Naming/MethodParameterName
-      self[:body] = PacketGen::Types::String.new.read(iv)
+      self[:body] = BinStruct::String.new.read(iv)
       self[:body] << msg[0..-3]
       self[:pad_length].read msg[-2]
       self[:next].read msg[-1]
@@ -433,7 +433,7 @@ def remove_tfc_if_needed(real_length)
                                            lambda { |f|
                                              (f.dport == ESP::UDP_PORT ||
                                              f.sport == ESP::UDP_PORT) &&
-                                               PacketGen::Types::Int32.new.read(f.body[0..3]).to_i.positive?
+                                               BinStruct::Int32.new.read(f.body[0..3]).to_i.positive?
                                            }]
   ESP.bind PacketGen::Header::IP, next: 4
   ESP.bind PacketGen::Header::IPv6, next: 41

lib/packetgen/plugin/ike.rb

@@ -13,10 +13,10 @@ class NonESPMarker < PacketGen::Header::Base
     # @!attribute non_esp_marker
     #  32-bit zero marker to differentiate IKE packet over UDP port 4500 from ESP ones
     #  @return [Integer]
-    define_field :non_esp_marker, PacketGen::Types::Int32, default: 0
+    define_attr :non_esp_marker, BinStruct::Int32, default: 0
     # @!attribute body
-    #  @return [PacketGen::Types::String,PacketGen::Header::Base]
-    define_field :body, PacketGen::Types::String
+    #  @return [BinStruct::String,PacketGen::Header::Base]
+    define_attr :body, BinStruct::String
 
     # Check non_esp_marker field
     # @see [PacketGen::Header::Base#parse?]
@@ -48,15 +48,15 @@ def parse?
   #  |                            Length                             |
   #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   # A IKE Plugin consists of:
-  # * a IKE SA initiator SPI ({#init_spi}, {PacketGen::Types::Int64} type),
-  # * a IKE SA responder SPI ({#resp_spi}, {PacketGen::Types::Int64} type),
-  # * a Next Payload field ({#next}, {PacketGen::Types::Int8} type),
-  # * a Version field ({#version}, {PacketGen::Types::Int8} type, with first 4-bit field
+  # * a IKE SA initiator SPI ({#init_spi}, {BinStruct::Int64} type),
+  # * a IKE SA responder SPI ({#resp_spi}, {BinStruct::Int64} type),
+  # * a Next Payload field ({#next}, {BinStruct::Int8} type),
+  # * a Version field ({#version}, {BinStruct::Int8} type, with first 4-bit field
   #   as major number, and last 4-bit field as minor number),
-  # * a Exchange type ({#exchange_type}, {PacketGen::Types::Int8} type),
-  # * a {#flags} field ({PacketGen::Types::Int8} type),
-  # * a Message ID ({#message_id}, {PacketGen::Types::Int32} type),
-  # * and a {#length} ({PacketGen::Types::Int32} type).
+  # * a Exchange type ({#exchange_type}, {BinStruct::Int8} type),
+  # * a {#flags} field ({BinStruct::Int8} type),
+  # * a Message ID ({#message_id}, {BinStruct::Int32} type),
+  # * and a {#length} ({BinStruct::Int32} type).
   #
   # == Create a IKE Plugin
   # === Standalone
@@ -94,48 +94,32 @@ class IKE < PacketGen::Header::Base
     # @!attribute init_spi
     #  64-bit initiator SPI
     #  @return [Integer]
-    define_field :init_spi, PacketGen::Types::Int64
+    define_attr :init_spi, BinStruct::Int64
     # @!attribute resp_spi
     #  64-bit responder SPI
     #  @return [Integer]
-    define_field :resp_spi, PacketGen::Types::Int64
+    define_attr :resp_spi, BinStruct::Int64
     # @!attribute next
     #  8-bit next payload type
     #  @return [Integer]
-    define_field :next, PacketGen::Types::Int8
+    define_attr :next, BinStruct::Int8
     # @!attribute version
     #  8-bit IKE version
     #  @return [Integer]
-    define_field :version, PacketGen::Types::Int8, default: 0x20
+    # @!attribute mjver
+    #  4-bit major version value ({#version}'s 4 most significant bits)
+    #  @return [Integer]
+    # @!attribute mnver
+    #  4-bit minor version value ({#version}'s 4 least significant bits)
+    #  @return [Integer]
+    define_bit_attr :version, default: 0x20, mjver: 4, mver: 4
     # @!attribute [r] exchange_type
     #  8-bit exchange type
     #  @return [Integer]
-    define_field :exchange_type, PacketGen::Types::Int8Enum, enum: EXCHANGE_TYPES
-    # @!attribute flags
+    define_attr :exchange_type, BinStruct::Int8Enum, enum: EXCHANGE_TYPES
+    # @!attribute flags. See {#flag_r}, {#flag_v} and {#flag_i}.
     #  8-bit flags
     #  @return [Integer]
-    define_field :flags, PacketGen::Types::Int8
-    # @!attribute message_id
-    #  32-bit message ID
-    #  @return [Integer]
-    define_field :message_id, PacketGen::Types::Int32
-    # @!attribute length
-    #  32-bit length of total message (Plugin + payloads)
-    #  @return [Integer]
-    define_field :length, PacketGen::Types::Int32
-
-    # Defining a body permits using Packet#parse to parse IKE payloads.
-    # But this method is hidden as prefered way to access payloads is via #payloads
-    define_field :body, PacketGen::Types::String
-
-    # @!attribute mjver
-    #  4-bit major version value
-    #  @return [Integer]
-    # @!attribute mnver
-    #  4-bit minor version value
-    #  @return [Integer]
-    define_bit_fields_on :version, :mjver, 4, :mnver, 4
-
     # @!attribute rsv1
     #  @return [Integer]
     # @!attribute rsv2
@@ -149,7 +133,19 @@ class IKE < PacketGen::Header::Base
     # @!attribute flag_v
     #  version flag. Ignored by IKEv2 peers, and should be set to 0
     #  @return [Boolean]
-    define_bit_fields_on :flags, :rsv1, 2, :flag_r, :flag_v, :flag_i, :rsv2, 3
+    define_bit_attr :flags, rsv1: 2, flag_r: 1, flag_v: 1, flag_i: 1, rsv2: 3
+    # @!attribute message_id
+    #  32-bit message ID
+    #  @return [Integer]
+    define_attr :message_id, BinStruct::Int32
+    # @!attribute length
+    #  32-bit length of total message (Plugin + payloads)
+    #  @return [Integer]
+    define_attr :length, BinStruct::Int32
+
+    # Defining a body permits using Packet#parse to parse IKE payloads.
+    # But this method is hidden as prefered way to access payloads is via #payloads
+    define_attr :body, BinStruct::String
 
     # @param [Hash] options
     # @see PacketGen::Header::Base#initialize

lib/packetgen/plugin/ike/auth.rb

@@ -53,11 +53,11 @@ class Auth < Payload
       # @attribute [r] auth_method
       #   8-bit Auth Method
       #   @return [Integer]
-      define_field_before :content, :auth_method, PacketGen::Types::Int8Enum, enum: METHODS
+      define_attr_before :content, :auth_method, BinStruct::Int8Enum, enum: METHODS
       # @attribute reserved
       #   24-bit reserved field
       #   @return [Integer]
-      define_field_before :content, :reserved, PacketGen::Types::Int24
+      define_attr_before :content, :reserved, BinStruct::Int24
 
       # Check authentication (see RFC 7296 §2.15)
       # @param [Packet] init_msg first IKE message sent by peer

lib/packetgen/plugin/ike/cert.rb

@@ -56,7 +56,7 @@ class Cert < Payload
       # @attribute encoding
       #   8-bit certificate encoding
       #   @return [Integer]
-      define_field_before :content, :encoding, PacketGen::Types::Int8Enum, enum: ENCODINGS
+      define_attr_before :content, :encoding, BinStruct::Int8Enum, enum: ENCODINGS
 
       def initialize(options={})
         super

lib/packetgen/plugin/ike/id.rb

@@ -53,11 +53,11 @@ class IDi < Payload
       # @attribute [r] type
       #   8-bit ID type
       #   @return [Integer]
-      define_field_before :content, :type, PacketGen::Types::Int8Enum, enum: TYPES
+      define_attr_before :content, :type, BinStruct::Int8Enum, enum: TYPES
       # @attribute reserved
       #   24-bit reserved field
       #   @return [Integer]
-      define_field_before :content, :reserved, PacketGen::Types::Int24
+      define_attr_before :content, :reserved, BinStruct::Int24
 
       # Get ID type name
       # @return [String]

lib/packetgen/plugin/ike/ke.rb

@@ -24,9 +24,9 @@ class IKE
     #   |                                                               |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # These specific fields are:
-    # * {#group_num} (type {PacketGen::Types::Int16}),
-    # * {#reserved} (type {PacketGen::Types::Int16}),
-    # * and {#content} (type {PacketGen::Types::String}).
+    # * {#group_num} (type {BinStruct::Int16}),
+    # * {#reserved} (type {BinStruct::Int16}),
+    # * and {#content} (type {BinStruct::String}).
     #
     # == Create a KE payload
     #   # Create a IKE packet with a KE payload
@@ -44,11 +44,11 @@ class KE < Payload
       # @!attribute group_num
       #  16-bit DH group number
       #  @return [Integer]
-      define_field_before :content, :group_num, PacketGen::Types::Int16
+      define_attr_before :content, :group_num, BinStruct::Int16
       # @!attribute reserved
       #  16-bit reserved field
       #  @return [Integer]
-      define_field_before :content, :reserved, PacketGen::Types::Int16, default: 0
+      define_attr_before :content, :reserved, BinStruct::Int16, default: 0
 
       def initialize(options={})
         super

lib/packetgen/plugin/ike/nonce.rb

@@ -11,7 +11,7 @@ class IKE
     # This class handles Nonce payloads, as defined in RFC 7296 §3.9.
     #
     # A Nonce payload contains a generic payload Plugin (see {Payload}) and
-    # data field (type {PacketGen::Types::String}):
+    # data field (type {BinStruct::String}):
     #                        1                   2                   3
     #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+