packetgen 2.4.0 → 2.5.0

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

@@ -0,0 +1,123 @@
+# 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
+    class OSPFv3
+
+      # This class handles {OSPFv3 OSPFv3} LSA header. A LSA header has the
+      # following format:
+      #   0                   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
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |           LS Age              |           LS Type             |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                        Link State ID                          |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                     Advertising Router                        |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                     LS sequence number                        |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |         LS checksum           |             length            |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #
+      # == About LSA headers
+      # LSA headers are used as-is in {DbDescription} and {LSAck} payloads.
+      # But this class is also a base class for different LSA class, as {LSARouter}.
+      # @author Sylvain Daubert
+      class LSAHeader < Types::Fields
+        # LSA known types
+        TYPES = {
+          'Router'            => 0x2001,
+          'Network'           => 0x2002,
+          'Inter-Area-Prefix' => 0x2003,
+          'Inter-Area-Router' => 0x2004,
+          'AS-External'       => 0x4005,
+          'NSSA'              => 0x2007,
+          'Link'              => 0x0008,
+          'Intra-Area-Prefix' => 0x2009
+        }
+
+        # @!attribute age
+        #  The time in seconds since the LSA was originated.
+        #  @return [Integer]
+        define_field :age, Types::Int16
+        # @!attribute type
+        #  The type of the LSA.
+        #  @return [Integer]
+        define_field :type, Types::Int16Enum, enum: TYPES
+        # @!attribute link_state_id
+        #  This field identifies the portion of the internet environment
+        #  that is being described by the LSA.
+        #  @return [String]
+        define_field :link_state_id, IP::Addr
+        # @!attribute advertising_router
+        #  The Router ID of the router that originated the LSA.
+        #  @return [String]
+        define_field :advertising_router, IP::Addr
+        # @!attribute sequence_number
+        #  @return [Integer]
+        define_field :sequence_number, Types::Int32
+        alias seqnum sequence_number
+        alias seqnum= sequence_number=
+        # @!attribute checksum
+        #  The Fletcher checksum of the complete contents of the LSA,
+        #  including the LSA header but excluding the LS age field.
+        #  @return [Integer]
+        define_field :checksum, Types::Int16
+        # @!attribute length
+        #  Length of the LSA, including the header.
+        #  @return [Integer]
+        define_field :length, Types::Int16
+        
+        # Compute and set Fletcher-16 checksum on LSA
+        # @return [Integer]
+        def calc_checksum
+          self.checksum = 0
+          bytes = to_s[2..-1].unpack('C*')
+
+          c0 = c1 = 0
+          bytes.each do |byte|
+            c0 += byte
+            c1 += c0
+          end
+          c0 %= 255
+          c1 %= 255
+          
+          x = ((sz - 16 - 1) * c0 - c1) % 255
+          x += 255 if x <= 0
+          y = 255 * 2 - c0 - x
+          y -= 255 if y > 255
+          self.checksum = (x << 8) | y
+        end
+
+        # Compute length and set +length+ field
+        # @return [Integer]
+        def calc_length
+          self.length = Base.calculate_and_set_length(self)
+        end
+
+        # Get human-readable type
+        # @return [String]
+        def human_type
+          self[:type].to_human
+        end
+
+        # @return [String]
+        def to_human
+          "LSA<#{human_type},#{link_state_id},#{advertising_router}>"
+        end
+
+        # Extract header from current LSA
+        # @return [LSAHeader]
+        def to_lsa_header
+          LSAHeader.new(self.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/snmp.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 

data/lib/packetgen/header/tcp.rb

@@ -1,3 +1,10 @@
+# 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
 
@@ -7,7 +14,7 @@ module PacketGen
     # * a sequence number ({#seqnum}, {Types::Int32} type),
     # * an acknownledge number ({#acknum}, +Int32+ type),
     # * a 16-bit field ({#u16}, +Int16+ type) composed of:
-    #   * a 4-bit {#data_offset} value,
+    #   * a 4-bit {#data_offset} self[attr],
     #   * a 3-bit {#reserved} field,
     #   * a 9-bit {#flags} field,
     # * a {#window} field (+Int16+ type),
@@ -44,7 +51,7 @@ module PacketGen
     # {#options} TCP attribute is a {Options}. {Option} may added to it:
     #  tcph.options << PacketGen::Header::TCP::MSS.new(1250)
     # or:
-    #  tcph.options << { opt: 'MSS', value: 1250 }
+    #  tcph.options << { opt: 'MSS', self[attr]: 1250 }
     # @author Sylvain Daubert
     class TCP < Base
     end
@@ -188,15 +195,8 @@ module PacketGen
         sum = ip_header(self).pseudo_header_checksum
         sum += IP_PROTOCOL
         sum += self.sz
-        str = self.to_s
-        str << "\x00" if str.length % 2 == 1
-        sum += str.unpack('n*').reduce(:+)
-
-        while sum > 0xffff do
-          sum = (sum & 0xffff) + (sum >> 16)
-        end
-        sum = ~sum & 0xffff
-        self[:checksum].value = (sum == 0) ? 0xffff : sum
+        sum += IP.sum16(self)
+        self.checksum = IP.reduce_checksum(sum)
       end
 
       # Compute header length and set +data_offset+ field
@@ -212,14 +212,14 @@ module PacketGen
       def inspect
         str = Inspect.dashed_line(self.class, 2)
         shift = Inspect.shift_level(2)
-        to_h.each do |attr, value|
+        fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, value, 2)
+          str << Inspect.inspect_attribute(attr, self[attr], 2)
           if attr == :u16
             doff = Inspect.int_dec_hex(data_offset, 1)
             str << shift + Inspect::FMT_ATTR % ['', 'data_offset', doff]
             str << shift + Inspect::FMT_ATTR % ['', 'reserved', reserved]
-            flags = ''
+            flags = ''.dup
             %w(ns cwr ece urg ack psh rst syn fin).each do |fl|
               flags << (send("flag_#{fl}?") ? fl[0].upcase : '.')
             end

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

@@ -1,3 +1,10 @@
+# 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
     class TCP
@@ -235,4 +242,3 @@ module PacketGen
     end
   end
 end
-

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

@@ -1,3 +1,10 @@
+# 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
     class TCP

data/lib/packetgen/header/tftp.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 

data/lib/packetgen/header/udp.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 
@@ -72,25 +74,15 @@ module PacketGen
         ip = ip_header(self)
         sum = ip.pseudo_header_checksum
         sum += IP_PROTOCOL
-        sum += length
-        sum += sport
-        sum += dport
-        sum += length
-        payload = body.to_s
-        payload << "\x00" unless payload.size % 2 == 0
-        payload.unpack('n*').each { |x| sum += x }
-
-        while sum > 0xffff do
-          sum = (sum & 0xffff) + (sum >> 16)
-        end
-        sum = ~sum & 0xffff
-        self[:checksum].value = (sum == 0) ? 0xffff : sum
+        sum += self.sz
+        sum += IP.sum16(self)
+        self.checksum = IP.reduce_checksum(sum)
       end
 
       # Compute length and set +length+ field
       # @return [Integer]
       def calc_length
-        self[:length].value = self.sz
+        Base.calculate_and_set_length self
       end
     end
 

data/lib/packetgen/inspect.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
 
   # {Inspect} module provides methods to help writing +inspect+
@@ -27,7 +29,7 @@ module PacketGen
 
     # @return [String]
     def self.shift_level(level=1)
-      '  ' + '  ' * level
+      '  ' * (level + 1)
     end
 
     # @param [#to_i] value
@@ -53,6 +55,8 @@ module PacketGen
               "%-10s (0x%0#{value.sz * 2}x)" % [value.to_human, value.to_i]
             elsif value.is_a?(Types::Int) or value.is_a?(Integer)
               int_dec_hex(value, value.sz * 2)
+            elsif value.is_a?(String)
+              value.to_s.inspect
             elsif value.respond_to? :to_human
               value.to_human
             else

data/lib/packetgen/packet.rb

@@ -3,6 +3,8 @@
 # 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
 require 'pcaprub'
 
 module PacketGen
@@ -377,7 +379,7 @@ module PacketGen
         if bindings.nil?
           bindings = prev_header.class.known_headers[header.class.superclass]
           if bindings.nil?
-            msg = "#{prev_header.class} knowns no layer association with #{header.protocol_name}. "
+            msg = "#{prev_header.class} knowns no layer association with #{header.protocol_name}. ".dup
             msg << "Try #{prev_header.class}.bind_layer(#{header.class}, "
             msg << "#{prev_header.method_name}_proto_field: "
             msg << "value_for_#{header.method_name})"

data/lib/packetgen/pcapng.rb

@@ -2,6 +2,8 @@
 # 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
 require 'stringio'
 
 module PacketGen

data/lib/packetgen/pcapng/block.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/epb.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/file.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/idb.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/shb.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/spb.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/unknown_block.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/proto.rb

@@ -3,6 +3,8 @@
 # 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
 require 'socket'
 
 module PacketGen

data/lib/packetgen/types/array.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Types
 
@@ -40,6 +42,7 @@ module PacketGen
       def read(str)
         clear
         return self if str.nil?
+        return self if @counter and @counter.to_i == 0
         force_binary str
         klass = self.class.class_eval { @klass }
         while str.length > 0

data/lib/packetgen/types/cstring.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Types
 
@@ -59,7 +61,7 @@ module PacketGen
       # @return [String]
       def to_human
         idx = self.index(0.chr) || self.sz
-        self[0, idx].inspect
+        self[0, idx]
       end
     end
   end