packetgen 2.6.0 → 2.7.0

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class DHCP
-      
       # Container class for DHCP Options
       #
       # == Add DHCP options to an +Options+ instance

data/lib/packetgen/header/dhcpv6.rb

@@ -7,8 +7,7 @@
 
 module PacketGen
   module Header
-    
-    # Dynamic Host Configuration Protocol for IPv6, {https://tools.ietf.org/html/rfc3315 
+    # Dynamic Host Configuration Protocol for IPv6, {https://tools.ietf.org/html/rfc3315
     # RFC 3315}
     #
     #    0                   1                   2                   3
@@ -41,13 +40,14 @@ module PacketGen
     #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
     #   dhcpv6.options << { type: 'Preference', value: 1 }
     # @author Sylvain Daubert
-    class DHCPv6 < Base;end
+    # @since 2.5.0
+    class DHCPv6 < Base; end
 
     require_relative 'dhcpv6/duid'
     require_relative 'dhcpv6/option'
     require_relative 'dhcpv6/options'
 
-    class DHCPv6 
+    class DHCPv6
       # DHCPv6 UDP client port
       UDP_CLIENT_PORT = 546
       # DHCPv6 UDP client port
@@ -65,9 +65,9 @@ module PacketGen
         'RELEASE'             => 8,
         'DECLINE'             => 9,
         'RECONFIGURE'         => 10,
-        'INFORMATION-REQUEST' =>  11
-      }
-      
+        'INFORMATION-REQUEST' => 11
+      }.freeze
+
       # @!attribute msg_type
       #   8-bit message type
       #   @return [Integer]
@@ -85,7 +85,7 @@ module PacketGen
       # @return [DHCPv6,DHCPv6::Relay]
       def read(str)
         msg_type = Types::Int8.new.read(str)
-        
+
         case msg_type
         when 12, 13
           DHCPv6::Relay.new.read(str)
@@ -101,8 +101,8 @@ module PacketGen
       end
     end
 
-    UDP.bind_header DHCPv6, sport: DHCPv6::UDP_CLIENT_PORT, dport: DHCPv6::UDP_SERVER_PORT
-    UDP.bind_header DHCPv6, sport: DHCPv6::UDP_SERVER_PORT, dport: DHCPv6::UDP_CLIENT_PORT
+    UDP.bind DHCPv6, sport: DHCPv6::UDP_CLIENT_PORT, dport: DHCPv6::UDP_SERVER_PORT
+    UDP.bind DHCPv6, sport: DHCPv6::UDP_SERVER_PORT, dport: DHCPv6::UDP_CLIENT_PORT
   end
 end
 

data/lib/packetgen/header/dhcpv6/duid.rb

@@ -11,12 +11,11 @@ module PacketGen
       # @abstract Base class for DUID (DHCP Unique ID)
       # @author Sylvain Daubert
       class DUID < Types::Fields
-        
         TYPES = {
           'DUID-LLT' => 1,
           'DUID-EN'  => 2,
           'DUID-LL'  => 3
-        }
+        }.freeze
 
         # @!attribute type
         #  16-bit DUID type
@@ -117,7 +116,7 @@ module PacketGen
         # Get human-readable DUID description
         # @return [String]
         def to_human
-          "DUID_EN<%#x,%s>" % [en, identifier]
+          'DUID_EN<%#x,%s>' % [en, identifier]
         end
       end
 

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

@@ -8,7 +8,6 @@
 module PacketGen
   module Header
     class DHCPv6
-
       # A DHCPv6 consists of:
       # * a {#type} ({Types::Int16}),
       # * a {#length} ({Types::Int16}),
@@ -18,7 +17,6 @@ module PacketGen
       # field to replace it by specific option field(s).
       # @author Sylvain Daubert
       class Option < Types::Fields
-        
         # @!attribute type
         #  16-bit option type
         #  @return [Integer]
@@ -31,7 +29,7 @@ module PacketGen
         #  variable length option data.
         #  @return [String]
         define_field :data, Types::String,
-                     builder: ->(h,t) { t.new(length_from: h[:length]) }
+                     builder: ->(h, t) { t.new(length_from: h[:length]) }
 
         class << self
           # Get Option subclasses
@@ -41,7 +39,7 @@ module PacketGen
             @klasses = []
             DHCPv6.constants.each do |cst|
               klass = DHCPv6.const_get(cst)
-              next unless klass.is_a?(Class) and klass < Option
+              next unless klass.is_a?(Class) && (klass < Option)
               @klasses[klass.new.type] = klass
             end
             @klasses
@@ -74,16 +72,13 @@ module PacketGen
         # Create an Option
         # @param [Hash] options
         def initialize(options={})
-          if self.class.const_defined?(:TYPE) and options[:type].nil?
+          if self.class.const_defined?(:TYPE) && options[:type].nil?
             options[:type] = self.class.const_get(:TYPE)
           end
-          if options[:data]
-            options[:length] = options[:data].to_s.size
-          end
+
+          options[:length] = options[:data].to_s.size if options[:data]
           super
-          if options[:data].nil?
-            self.length = self.sz - 4
-          end
+          self.length = self.sz - 4 if options[:data].nil?
         end
 
         alias private_read read
@@ -122,7 +117,7 @@ module PacketGen
         # @return [String]
         def to_human
           str = "#{human_type}:".dup
-          if respond_to? :human_data and human_data.size > 0
+          if respond_to?(:human_data) && !human_data.empty?
             str << human_data
           elsif !self[:data].nil?
             str << data.inspect
@@ -146,7 +141,7 @@ module PacketGen
         # @!attribute duid
         #  @return [DUID]
         define_field :duid, DUID
-        
+
         # Get human-readable data (DUID)
         # @return [String]
         def human_data
@@ -187,12 +182,12 @@ module PacketGen
         #  options field
         #  @return [String]
         define_field :options, Types::String,
-                     builder: ->(h,t) { t.new length_from: ->() { h[:length].to_i - 12 } }
+                     builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 12 } }
 
         # Get human-readable data (IAID, T1 and T2)
         # @return [String]
         def human_data
-          "%#x,%u,%u" % [iaid, t1, t2]
+          '%#x,%u,%u' % [iaid, t1, t2]
         end
       end
 
@@ -214,12 +209,12 @@ module PacketGen
         #  options field
         #  @return [String]
         define_field :options, Types::String,
-                     builder: ->(h,t) { t.new length_from: ->() { h[:length].to_i - 4 } }
+                     builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 4 } }
 
         # Get human-readable data (IAID)
         # @return [String]
         def human_data
-          "%#x" % iaid
+          '%#x' % iaid
         end
       end
 
@@ -249,7 +244,7 @@ module PacketGen
         #  options field
         #  @return [String]
         define_field :options, Types::String,
-                     builder: ->(h,t) { t.new length_from: ->() { h[:length].to_i - 24 } }
+                     builder: ->(h, t) { t.new length_from: -> { h[:length].to_i - 24 } }
 
         # Get human-readable data (ipv6, preferred lifetime and valid lifetime)
         # @return [String]
@@ -295,7 +290,7 @@ module PacketGen
           self[:options].to_human
         end
       end
-      
+
       # DHCPv6 Preference option
       # @author Sylvain Daubert
       class Preference < Option
@@ -317,7 +312,7 @@ module PacketGen
           value.to_s
         end
       end
-      
+
       # DHCPv6 Elapsed Time option
       # @author Sylvain Daubert
       class ElapsedTime < Option
@@ -339,7 +334,7 @@ module PacketGen
           value.to_s
         end
       end
-      
+
       # DHCPv6 Relay Message option
       # @author Sylvain Daubert
       class RelayMessage < Option

data/lib/packetgen/header/dhcpv6/relay.rb

@@ -15,8 +15,8 @@ module PacketGen
         MESSAGE_TYPES = {
           'RELAY-FORW' => 12,
           'RELAY-REPL' => 13
-        }
-        
+        }.freeze
+
         # @!attribute msg_type
         #   8-bit message type
         #   @return [Integer]
@@ -42,7 +42,9 @@ module PacketGen
       end
     end
 
-    UDP.bind_header DHCPv6::Relay, sport: DHCPv6::UDP_CLIENT_PORT, dport: DHCPv6::UDP_SERVER_PORT
-    UDP.bind_header DHCPv6::Relay, sport: DHCPv6::UDP_SERVER_PORT, dport: DHCPv6::UDP_CLIENT_PORT
+    UDP.bind DHCPv6::Relay, sport: DHCPv6::UDP_CLIENT_PORT
+    UDP.bind DHCPv6::Relay, dport: DHCPv6::UDP_SERVER_PORT
+    UDP.bind DHCPv6::Relay, sport: DHCPv6::UDP_SERVER_PORT
+    UDP.bind DHCPv6::Relay, dport: DHCPv6::UDP_CLIENT_PORT
   end
 end

data/lib/packetgen/header/dns.rb

@@ -8,7 +8,6 @@
 
 module PacketGen
   module Header
-
     # DNS: Domain Name Service
     #
     # A DNS packet consists of a header:
@@ -92,6 +91,7 @@ module PacketGen
     #  # add an option to OPT record
     #  dns.ar.last.options << PacketGen::Header::DNS::Option.new(code: 48, length: 2, data: "12")
     # @author Sylvain Daubert
+    # @since 1.3.0
     class DNS < Base
     end
   end
@@ -119,7 +119,7 @@ module PacketGen
         'status' => 2,
         'notify' => 4,
         'update' => 5
-      }
+      }.freeze
 
       # DNS Response codes
       RCODES = {
@@ -130,7 +130,7 @@ module PacketGen
         'name-error'      => 3,
         'not-implemented' => 4,
         'refused'         => 5
-      }
+      }.freeze
 
       # @!attribute id
       #  @return [Integer]
@@ -152,16 +152,16 @@ module PacketGen
       define_field :arcount, Types::Int16
       # @!attribute qd
       #  @return [QDSection]
-      define_field :qd, QDSection, builder: ->(h,t) { t.new(h, h[:qdcount]) }
+      define_field :qd, QDSection, builder: ->(h, t) { t.new(h, h[:qdcount]) }
       # @!attribute an
       #  @return [RRSection]
-      define_field :an, RRSection, builder: ->(h,t) { t.new(h, h[:ancount]) }
+      define_field :an, RRSection, builder: ->(h, t) { t.new(h, h[:ancount]) }
       # @!attribute ns
       #  @return [RRSection]
-      define_field :ns, RRSection, builder: ->(h,t) { t.new(h, h[:nscount]) }
+      define_field :ns, RRSection, builder: ->(h, t) { t.new(h, h[:nscount]) }
       # @!attribute ar
       #  @return [RRSection]
-      define_field :ar, RRSection, builder: ->(h,t) { t.new(h, h[:arcount]) }
+      define_field :ar, RRSection, builder: ->(h, t) { t.new(h, h[:arcount]) }
 
       # @!attribute qr
       #   @return [Boolean] query (+false+) or response (+true+)
@@ -253,8 +253,8 @@ module PacketGen
         str = Inspect.dashed_line(self.class, 2)
         fields.each do |attr|
           if attr == :u16
-            flags = [:qr, :aa, :tc, :rd, :ra].select! { |attr| send "#{attr}?" }.
-                    map(&:to_s).join(',')
+            flags = %i[qr aa tc rd ra].select! { |flag| send "#{flag}?" }
+                                      .map(&:to_s).join(',')
             str << Inspect.shift_level(2)
             str << Inspect::FMT_ATTR % ['Flags', 'flags', flags]
             opcode = '%-10s (%u)' % [OPCODES.key(self.opcode), self.opcode]
@@ -272,7 +272,9 @@ module PacketGen
     end
 
     self.add_class DNS
-    UDP.bind_header DNS, dport: DNS::UDP_PORT, sport: DNS::UDP_PORT
-    TCP.bind_header DNS, dport: DNS::TCP_PORT, sport: DNS::TCP_PORT
+    UDP.bind DNS, dport: DNS::UDP_PORT
+    UDP.bind DNS, sport: DNS::UDP_PORT
+    TCP.bind DNS, dport: DNS::TCP_PORT
+    TCP.bind DNS, sport: DNS::TCP_PORT
   end
 end

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

@@ -8,11 +8,9 @@
 module PacketGen
   module Header
     class DNS
-
       # DNS Name, defined as a suite of labels. A label is of type {Types::IntString}.
       # @author Sylvain Daubert
       class Name < Types::Array
-
         # Mask to decode a pointer on another label
         POINTER_MASK = 0xc000
 
@@ -56,7 +54,7 @@ module PacketGen
 
           force_binary str
           start = 0
-          while true
+          loop do
             index = str[start, 2].unpack('n').first
             if pointer? index
               # Pointer on another label
@@ -67,7 +65,7 @@ module PacketGen
               label.read(str[start..-1])
               start += label.sz
               self << label
-              break if label.length == 0 or str[start..-1].length == 0
+              break if label.length.zero? || str[start..-1].length.zero?
             end
           end
           # force resolution of compressed names
@@ -101,7 +99,7 @@ module PacketGen
         def name_from_pointer
           return nil unless @pointer
           return @pointer_name if @pointer_name
-          
+
           index = @pointer.unpack('n').first
           mask = ~POINTER_MASK & 0xffff
           ptr = index & mask
@@ -110,7 +108,7 @@ module PacketGen
           @pointer_name = name.read(self.dns.to_s[ptr..-1]).to_human
         end
 
-        def record_from_hash(hsh)
+        def record_from_hash(_hsh)
           raise NotImplementedError, "not supported by #{self.class}"
         end
       end

data/lib/packetgen/header/dns/opt.rb

@@ -4,12 +4,12 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require_relative 'option'
 
 module PacketGen
   module Header
     class DNS
-
       # OPT pseudo-RR. Used by Extended DNS (EDNS(0), cf. RFC 6891).
       #
       # a OPT record may contain zero or more {Option options} in its {#rdata}.
@@ -43,68 +43,68 @@ module PacketGen
           self.do = options[:do] unless options[:do].nil?
         end
 
-        # @overload ext_rcode=(v)
-        #  Setter for upper 8 bits of extended 12-bit RCODE
-        #  @param [Integer] v
-        #  @return [Integer]
+        # @overload ext_rcode=(value)
+        #   Setter for upper 8 bits of extended 12-bit RCODE
+        #   @param [Integer] value
+        #   @return [Integer]
         # @overload ext_rcode
-        #  Getter for upper 8 bits of extended 12-bit RCODE
-        #  @return [Integer]
+        #   Getter for upper 8 bits of extended 12-bit RCODE
+        #   @return [Integer]
         # @return [Integer]
-        def ext_rcode=(v=nil)
-          if v
+        def ext_rcode=(value=nil)
+          if value
             self[:ttl].value = self[:ttl].to_i & (0xffffffff & ~(0xff << 24))
-            self[:ttl].value |= (v & 0xff) << 24
+            self[:ttl].value |= (value & 0xff) << 24
           end
           (self[:ttl].to_i >> 24) & 0xff
         end
         alias ext_rcode ext_rcode=
 
-        # @overload version=(v)
-        #  Setter EDNS version
-        #  @param [Integer] v
-        #  @return [Integer]
+        # @overload version=(ver)
+        #   Setter EDNS version
+        #   @param [Integer] ver
+        #   @return [Integer]
         # @overload version
-        #  Getter for EDNS version
-        #  @return [Integer]
+        #   Getter for EDNS version
+        #   @return [Integer]
         # @return [Integer]
-        def version=(v=nil)
-          if v
+        def version=(ver=nil)
+          if ver
             self[:ttl].value = self[:ttl].to_i & (0xffffffff & ~(0xff << 16))
-            self[:ttl].value |= (v & 0xff) << 16
+            self[:ttl].value |= (ver & 0xff) << 16
           end
           (self[:ttl].to_i >> 16) & 0xff
         end
         alias version version=
 
-        # @overload do=(v)
+        # @overload do=(value)
         #  Setter EDNS do
-        #  @param [Boolean] v
+        #  @param [Boolean] value
         #  @return [Boolean]
         # @overload do?
         #  Getter for EDNS do
         #  @return [Boolean]
         # @return [Boolean]
-        def do=(v=nil)
-          b = v ? 1 : 0
-          unless v.nil?
+        def do=(value=nil)
+          b = value ? 1 : 0
+          unless value.nil?
             self[:ttl].value = self[:ttl].to_i & (0xffffffff & ~(1 << 15))
             self[:ttl].value |= (b & 1) << 15
           end
-          ((self[:ttl].to_i >> 15) & 1) == 1 ? true : false
+          ((self[:ttl].to_i >> 15) & 1) == 1
         end
-        alias :do? :do=
+        alias do? do=
 
-        # @overload z=(v)
-        #  @param [Integer] v
+        # @overload z=(value)
+        #  @param [Integer] value
         #  @return [Integer]
         # @overload z
         #  @return [Integer]
         # @return [Integer]
-        def z=(v=nil)
-          if v
+        def z=(value=nil)
+          if value
             self[:ttl].value = self[:ttl].to_i & (0xffffffff & ~0x7fff)
-            self[:ttl].value |= v & 0x7fff
+            self[:ttl].value |= value & 0x7fff
           end
           self[:ttl].to_i & 0x7fff
         end