packetgen 2.6.0 → 2.7.0

data/lib/packetgen/header/base.rb

@@ -7,15 +7,17 @@
 
 module PacketGen
   module Header
-
     # @abstract Base class for all header types.
     #    Subclasses may define magic methods:
-    #    * {#parse?}.
+    #    * {#calc_checksum}, which computes header checksum,
+    #    * {#calc_length}, which computes header length,
+    #    * {#parse?},
+    #    * {#reply!}, which inverts needed fields to forge a response.
     # @author Sylvain Daubert
     class Base < Types::Fields
-
       # @api private
       # Simple class to handle a header association
+      # @deprecated Will be remove with {Base.bind_header}
       class Binding < Struct.new(:key, :value)
         # Check +fields+ responds to binding
         # @param [Types::Fields] fields
@@ -49,8 +51,8 @@ module PacketGen
 
       # @api private
       # Class to handle a header association from procs
+      # @deprecated Will be remove with {Base.bind_header}
       class ProcBinding
-
         # @param [Array<Proc>] procs first proc is used to set fields, second proc is
         #  used to check binding
         def initialize(procs)
@@ -84,22 +86,32 @@ module PacketGen
         # @return [Array<Binding>]
         attr_accessor :bindings
 
-        # @param [:or, :and] op
-        def initialize(op)
-          @op = op
+        # @param [:or, :and, :newstyle] operator
+        def initialize(operator)
+          @op = operator
           @bindings = []
         end
 
+        def new_set
+          @bindings << [] if @op == :newstyle
+        end
+
         # @param [Object] arg
-        # @return [Bindings] self
+        # @return [OldBindings] self
         def <<(arg)
-          @bindings << arg
+          if op == :newstyle
+            @bindings.last << arg
+          else
+            @bindings << arg
+          end
         end
 
         # each iterator
         # @return [void]
         def each
-          @bindings.each { |b| yield b }
+          @bindings.each do |b|
+            yield b
+          end
         end
 
         # @return [Boolean]
@@ -110,7 +122,13 @@ module PacketGen
         # @return [Hash]
         def to_h
           hsh = {}
-          each { |b| hsh[b.key] = b.value }
+          each do |b|
+            if b.is_a? Array
+              b.each { |sb| hsh[sb.key] = sb.value }
+            else
+              hsh[b.key] = b.value
+            end
+          end
           hsh
         end
 
@@ -123,6 +141,8 @@ module PacketGen
             empty? || @bindings.any? { |binding| binding.check?(fields) }
           when :and
             @bindings.all? { |binding| binding.check?(fields) }
+          when :newstyle
+            @bindings.any? { |group| group.all? { |binding| binding.check?(fields) } }
           end
         end
 
@@ -130,7 +150,12 @@ module PacketGen
         # @param [Types::Fields] fields
         # @return [void]
         def set(fields)
-          @bindings.each { |b| b.set fields }
+          case @bindings.first
+          when Array
+            @bindings.first.each { |b| b.set fields }
+          else
+            @bindings.each { |b| b.set fields }
+          end
         end
       end
 
@@ -138,7 +163,7 @@ module PacketGen
       # @return [Packet,nil]
       attr_reader :packet
 
-      # On inheritage, create +@known_headers+ class variable
+      # On inheritage, create +@old_known_header+ class variable
       # @param [Class] klass
       # @return [void]
       def self.inherited(klass)
@@ -155,20 +180,22 @@ module PacketGen
       #                                        ->(hdr) { hdr.field1 == 1 && hdr.body[0..1] == "\x00\x00" }]
       # @param [Class] header_klass header class to bind to current class
       # @param [Hash] args current class fields and their value when +header_klass+
-      #  is embedded in current class. Given value may be a lambda, whose alone argument
-      #  is the value extracted from header field (or +nil+ when lambda is used to set
-      #  field while adding a header).
+      #   is embedded in current class. Given value may be a lambda, whose alone argument
+      #   is the value extracted from header field (or +nil+ when lambda is used to set
+      #   field while adding a header).
+      #
+      #   If multiple fields are given, a special key +:op+ may be given to set parse
+      #   operation on this binding. By default, +:op+ is +:or+ (at least one binding
+      #   must match to parse it). It also may be set to +:and+ (all bindings must match
+      #   to parse it).
       #
-      #  If multiple fields are given, a special key +:op+ may be given to set parse
-      #  operation on this binding. By default, +:op+ is +:or+ (at least one binding
-      #  must match to parse it). It also may be set to +:and+ (all bindings must match
-      #  to parse it).
-      #  
-      #  Special key +procs+ may be used to set 2 lambdas, the former to set
-      #  fields, the former to check bindings. This may be used when multiple and
-      #  non-trivial checks should be made.
+      #   Special key +procs+ may be used to set 2 lambdas, the former to set
+      #   fields, the latter to check bindings. This may be used when multiple and
+      #   non-trivial checks should be made.
       # @return [void]
+      # @deprecated Use {.bind} instead.
       def self.bind_header(header_klass, args={})
+        Deprecation.deprecated(self, __method__, 'bind', klass_method: true)
         op = args.delete(:op) || :or
         if @known_headers[header_klass].nil? || @known_headers[header_klass].op != op
           bindings = Bindings.new(op)
@@ -177,11 +204,57 @@ module PacketGen
           bindings = @known_headers[header_klass]
         end
         args.each do |key, value|
-          if key == :procs
-            bindings << ProcBinding.new(value)
-          else
-            bindings << Binding.new(key, value)
-          end
+          bindings << if key == :procs
+                        ProcBinding.new(value)
+                      else
+                        Binding.new(key, value)
+                      end
+        end
+      end
+
+      # Bind a upper header to current one.
+      #   # Bind Header2 to Header1 when field1 from Header1 has a value of 42
+      #   Header1.bind Header2, field1: 42
+      #   # Bind Header3 to Header1 when field1 from Header1 has a value of 43
+      #   # and field2 has value 43 or 44
+      #   Header1.bind Header3, field1: 43, field2: 43
+      #   Header1.bind Header3, field1: 43, field2: 44
+      #   # Bind Header4 to Header1 when field1 from Header1 has a value
+      #   # greater or equal to 44. When adding a Header2 to a Header1
+      #   # with Packet#add, force value to 44.
+      #   Header1.bind Header4, field1: ->(v) { v.nil? ? 44 : v >= 44 }
+      #   # Bind Header5 to Header1 when field1 from Header1 has a value of 41
+      #   # and first two bytes of header1's body are null.
+      #   # When adding a Header2 to a Header1 with Packet#add, force value to 44.
+      #   Header1.bind Header5, procs: [->(hdr) { hdr.field1 = 41 }
+      #                                 ->(hdr) { hdr.field1 == 41 && hdr.body[0..1] == "\x00\x00" }]
+      # @param [Class] header_klass header class to bind to current class
+      # @param [Hash] args current class fields and their value when +header_klass+
+      #   is embedded in current class.
+      #
+      #   Given value may be a lambda, whose alone argument is the value extracted
+      #   from header field (or +nil+ when lambda is used to set  field while adding
+      #   a header).
+      #
+      #   Special key +procs+ may be used to set 2 lambdas, the former to set
+      #   fields, the latter to check bindings. This may be used when multiple and
+      #   non-trivial checks should be made.
+      # @return [void]
+      # @since 2.7.0
+      def self.bind(header_klass, args={})
+        if @known_headers[header_klass].nil?
+          bindings = Bindings.new(:newstyle)
+          @known_headers[header_klass] = bindings
+        else
+          bindings = @known_headers[header_klass]
+        end
+        bindings.new_set
+        args.each do |key, value|
+          bindings << if key == :procs
+                        ProcBinding.new(value)
+                      else
+                        Binding.new(key, value)
+                      end
         end
       end
 
@@ -189,7 +262,7 @@ module PacketGen
       # @return [String]
       # @since 2.0.0
       def self.protocol_name
-        self.new.protocol_name
+        new.protocol_name
       end
 
       # Helper method to calculate length of +hdr+ and set its +length+ field.
@@ -207,7 +280,7 @@ module PacketGen
       end
 
       # @api private
-      # Get knwon headers
+      # Get known headers
       # @return [Hash] keys: header classes, values: hashes
       def self.known_headers
         @known_headers
@@ -253,14 +326,13 @@ module PacketGen
         added_to_packet(packet)
         @packet
       end
-      
+
       # @abstract This method is called when a header is added to a packet.
       #   This base method does nothing but may be overriden by subclasses.
       # @param [Packet] packet packet to which self is added
       # @return [void]
       # @since 2.1.4
-      def added_to_packet(packet)
-      end
+      def added_to_packet(packet) end
 
       # @api private
       # Get +header+ id in packet headers array
@@ -284,7 +356,7 @@ module PacketGen
       # @raise FormatError +header+ not in a packet
       def ip_header(header)
         hid = header_id(header)
-        iph = packet.headers[0...hid].reverse.find { |h| h.is_a? IP or h.is_a? IPv6 }
+        iph = packet.headers[0...hid].reverse.find { |h| h.is_a?(IP) || h.is_a?(IPv6) }
         raise FormatError, 'no IP or IPv6 header in packet' if iph.nil?
         iph
       end
@@ -297,7 +369,7 @@ module PacketGen
       # @raise FormatError +header+ not in a packet
       def ll_header(header)
         hid = header_id(header)
-        llh = packet.headers[0...hid].reverse.find { |h| h.is_a? Eth or h.is_a? Dot11 }
+        llh = packet.headers[0...hid].reverse.find { |h| h.is_a?(Eth) || h.is_a?(Dot11) }
         raise FormatError, 'no link layer header in packet' if llh.nil?
         llh
       end

data/lib/packetgen/header/bootp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-    
     # Bootstrap Protocol, {https://tools.ietf.org/html/rfc951
     # RFC 951}
     #
@@ -40,15 +39,14 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.2.0
     class BOOTP < Base
-      
       UDP_SERVER_PORT = 67
       UDP_CLIENT_PORT = 68
-      
+
       # DHCP opcodes
       OPCODES = {
         'BOOTREQUEST' => 1,
         'BOOTREPLY'   => 2
-      }
+      }.freeze
 
       # @!attribute op
       #   8-bit opcode
@@ -73,13 +71,13 @@ module PacketGen
       #  32-bit Transaction ID
       #  @return [Integer]
       define_field :xid, Types::Int32
-      
+
       # @!attribute secs
       #  16-bit integer: number of seconds elapsed since client began address
       #  acquisition or renewal process
       #  @return [Integer]
       define_field :secs, Types::Int16
-      
+
       # @!attribute flags
       #  16-bit flag field
       #  @return [Integer]
@@ -94,17 +92,17 @@ module PacketGen
       #  'your' (client) IP address
       #  @return [String]
       define_field :yiaddr, IP::Addr
-      
+
       # @!attribute siaddr
       #  IP address of next server to use in bootstrap
       #  @return [String]
       define_field :siaddr, IP::Addr
-      
+
       # @!attribute giaddr
       #  Relay agent IP address, used in booting via a relay agent
       #  @return [String]
       define_field :giaddr, IP::Addr
-      
+
       # @!attribute chaddr
       #   client hardware address
       #   @return [String]
@@ -123,7 +121,7 @@ module PacketGen
       # @!attribute body
       #   @return [String]
       define_field :body, Types::String
-      
+
       # @!attribute b
       #  Broadcast flag, from {#flags}
       # @return [Boolean]
@@ -131,23 +129,34 @@ module PacketGen
       #  15-bit Must Be Zero bits, from {#flags}
       # @return [Boolean]
       define_bit_fields_on :flags, :b, :mbz, 15
-      
+
+      # @return [String]
       def inspect
         str = Inspect.dashed_line(self.class, 2)
         fields.each do |attr|
           next if attr == :body
           next unless is_present?(attr)
-          if attr == :chaddr and self.hlen == 6
-            str << Inspect.inspect_attribute(attr, Eth::MacAddr.new.read(self[:chaddr][0, 6]), 2)
-          else
-            str << Inspect.inspect_attribute(attr, self[attr], 2)
-          end
+          str << if (attr == :chaddr) && (self.hlen == 6)
+                   Inspect.inspect_attribute(attr, Eth::MacAddr.new.read(self[:chaddr][0, 6]), 2)
+                 else
+                   Inspect.inspect_attribute(attr, self[attr], 2)
+                 end
         end
         str
       end
+
+      # Invert opcode, if known
+      # @return [self]
+      def reply!
+        case self.op
+        when 1 then self.op = 2
+        when 2 then self.op = 1
+        end
+        self
+      end
     end
-    
-    UDP.bind_header BOOTP, sport: 67, dport: 68
-    UDP.bind_header BOOTP, sport: 68, dport: 67
+
+    UDP.bind BOOTP, sport: 67, dport: 68
+    UDP.bind BOOTP, sport: 68, dport: 67
   end
 end

data/lib/packetgen/header/crypto.rb

@@ -2,12 +2,10 @@
 
 module PacketGen
   module Header
-
     # Mixin for cryptographic classes
     # @api private
     # @author Sylvain Daubert
     module Crypto
-
       # Cryptographic error
       class Error < PacketGen::Error; end
 
@@ -16,11 +14,11 @@ module PacketGen
       # @param [OpenSSL::HMAC] intg
       # @return [void]
       def set_crypto(conf, intg)
-        @conf, @intg = conf, intg
-        if conf.authenticated?
-          # #auth_tag_len only supported from ruby 2.4.0
-          @conf.auth_tag_len = @trunc if @conf.respond_to? :auth_tag_len
-        end
+        @conf = conf
+        @intg = intg
+        return unless conf.authenticated?
+        # #auth_tag_len only supported from ruby 2.4.0
+        @conf.auth_tag_len = @trunc if @conf.respond_to? :auth_tag_len
       end
 
       # Get confidentiality mode name
@@ -34,7 +32,7 @@ module PacketGen
       # Say if crypto modes permit authentication
       # @return [Boolean]
       def authenticated?
-        @conf.authenticated? or !!@intg
+        @conf.authenticated? || !@intg.nil?
       end
 
       def authenticate!

data/lib/packetgen/header/dhcp.rb

@@ -7,8 +7,7 @@
 
 module PacketGen
   module Header
-    
-    # Dynamic Host Configuration Protocol, {https://tools.ietf.org/html/rfc2131 
+    # Dynamic Host Configuration Protocol, {https://tools.ietf.org/html/rfc2131
     # RFC 2131}
     #
     # A DHCP header is quite simple. It is composed of:
@@ -54,14 +53,14 @@ module PacketGen
       # @!attribute options
       #   @return [DHCP::Options]
       define_field :options, DHCP::Options
-      
+
       # differentiate from BOOTP by checking presence of DHCP magic
       # @return [Boolean]
       def parse?
         self.magic == DHCP_MAGIC
       end
     end
-    
-    BOOTP.bind_header DHCP
+
+    BOOTP.bind DHCP
   end
 end

data/lib/packetgen/header/dhcp/option.rb

@@ -5,15 +5,14 @@
 
 # frozen_string_literal: true
 
-
 module PacketGen
   module Header
     class DHCP
-
       # define DHCP Options.
       # keys are option type, value are arrays containing option names
       # as strings, and a hash passed to {Option#initialize}.
-      DHCPOptions = {
+      # @since 2.7.0
+      DHCP_OPTIONS = {
         1  => ['subnet_mask', length: 4, v: IP::Addr],
         2  => ['time_zone'],
         3  => ['router', length: 4, v: IP::Addr],
@@ -37,14 +36,14 @@ module PacketGen
         44 => ['NetBIOS_server', length: 4, v: IP::Addr],
         45 => ['NetBIOS_dist_server', length: 4, v: IP::Addr],
         50 => ['requested_addr', length: 4, v: IP::Addr],
-        51 => ['lease_time', length: 4, v: Types::Int32, value: 43200],
+        51 => ['lease_time', length: 4, v: Types::Int32, value: 43_200],
         53 => ['message-type', length: 1, v: Types::Int8],
         54 => ['server_id', length: 4, v: IP::Addr],
         55 => ['param_req_list'],
         56 => ['error_message'],
-        57 => ['max_dhcp_size', length: 2, v: Types::Int16, value: 1500],
-        58 => ['renewal_time', length: 4, v: Types::Int32, value: 21600],
-        59 => ['rebinding_time', length: 4, v: Types::Int32, value: 37800],
+        57 => ['max_dhcp_size', length: 2, v: Types::Int16, value: 1_500],
+        58 => ['renewal_time', length: 4, v: Types::Int32, value: 21_600],
+        59 => ['rebinding_time', length: 4, v: Types::Int32, value: 37_800],
         60 => ['vendor_class_id'],
         61 => ['client_id'],
         64 => ['NISplus_domain'],
@@ -55,14 +54,20 @@ module PacketGen
         72 => ['WWW_server', length: 4, v: IP::Addr],
         73 => ['finger_server', length: 4, v: IP::Addr],
         74 => ['IRC_server', length: 4, v: IP::Addr]
-      }
+      }.freeze
+
+      # @deprecated Use {DHCP_OPTIONS} instead.
+      DCHPOptions = DHCP_OPTIONS
 
       # Class to indicate DHCP options end
       class End < Types::Int8
         def initialize(value=255)
           super
         end
-        def to_human; self.class.to_s.sub(/.*::/, '').downcase; end
+
+        def to_human
+          self.class.to_s.sub(/.*::/, '').downcase
+        end
         alias human_type to_human
       end
 
@@ -83,9 +88,8 @@ module PacketGen
       #   option).
       # @author Sylvain Daubert
       class Option < Types::TLV
-
         # Option types
-        TYPES = Hash[DHCPOptions.to_a.map { |type, ary| [type, ary[0]] }]
+        TYPES = Hash[DHCP_OPTIONS.to_a.map { |type, ary| [type, ary[0]] }]
 
         # @param [Hash] options
         # @option options [Integer] :type
@@ -93,16 +97,15 @@ module PacketGen
         # @option options [String] :value
         def initialize(options={})
           super
-          if DHCPOptions.has_key?(self.type)
-            h = DHCPOptions[self.type].last
-            if h.is_a? Hash
-              h.each do |k, v|
-                self.length = v if k == :length
-                if k == :v
-                  self[:value] = v.new
-                  self.value = options[:value] if options[:value]
-                end
-              end
+          return unless DHCP_OPTIONS.key?(self.type)
+          h = DHCP_OPTIONS[self.type].last
+
+          return unless h.is_a? Hash
+          h.each do |k, v|
+            self.length = v if k == :length
+            if k == :v
+              self[:value] = v.new
+              self.value = options[:value] if options[:value]
             end
           end
         end
@@ -115,24 +118,33 @@ module PacketGen
         # @return [Option,End,Pad] may return another object than itself
         def read(str)
           read_type = str[0].unpack('C').first
-          if read_type == 0
+          if read_type.zero?
             Pad.new.read(str)
           elsif read_type == 255
             End.new.read(str)
-          elsif DHCPOptions.has_key?(read_type)
-            Option.new(DHCPOptions[read_type][1] || {}).private_read(str)
+          elsif DHCP_OPTIONS.key?(read_type)
+            Option.new(DHCP_OPTIONS[read_type][1] || {}).private_read(str)
           else
             super
           end
         end
 
-        def has_human_types?
+        # @since 2.7.0
+        # @return [true]
+        def human_types?
           true
         end
 
+        # @deprecated Use {#human_types?} instead
+        # @return [true]
+        def has_human_types?
+          Deprecation.deprecated(self.class, __method__, 'human_types?')
+          human_types?
+        end
+
         def human_type
-          if DHCPOptions.has_key?(type)
-            DHCPOptions[type].first.dup
+          if DHCP_OPTIONS.key?(type)
+            DHCP_OPTIONS[type].first.dup
           else
             type.to_s
           end
@@ -141,13 +153,13 @@ module PacketGen
         def to_human
           s = human_type
           if length > 0
-            if value.respond_to? :to_human
-              s << ":#{value.to_human}"
-            elsif self[:value].is_a? Types::Int
-              s << ":#{self.value.to_i}"
-            else
-              s << ":#{value.inspect}"
-            end
+            s << if value.respond_to? :to_human
+                   ":#{value.to_human}"
+                 elsif self[:value].is_a? Types::Int
+                   ":#{self.value.to_i}"
+                 else
+                   ":#{value.inspect}"
+                 end
           end
           s
         end