packetgen 2.4.0 → 2.5.0

data/lib/packetgen/header/ospfv2/hello.rb

@@ -0,0 +1,104 @@
+# 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 OSPFv2
+
+      # This class handles {OSPFv2 OSPFv2} HELLO packets payload. The HELLO
+      # payload 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
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                        Network Mask                           |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |         HelloInterval         |    Options    |    Rtr Pri    |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                     RouterDeadInterval                        |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                      Designated Router                        |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                   Backup Designated Router                    |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                          Neighbor                             |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                              ...                              |
+      # A HELLO payload consists of:
+      # * a {#network_mask} field ({IP::Addr}),
+      # * a {#hello_interval} field ({Types::Int16}),
+      # * an {#options} field ({Types::Int8}),
+      # * a {#priority} field ({Types::Int8}),
+      # * a {#dead_interval} field ({Types::Int32}),
+      # * a {#designated_router} field ({IP::Addr}),
+      # * a {#backup_designated_router} field ({IP::Addr}),
+      # * a {#neighbors} array containing neighbors as {IP::Addr}.
+      #
+      # == Create a HELLO payload
+      #   # standalone
+      #   hello = PacketGen::Header::OSPFv2::Hello.new
+      #   # in a packet
+      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::Hello')
+      #   # make IP header correct for OSPF
+      #   pkt.ospfize
+      #   # access to Hello payload
+      #   pkt.ospfv2_hello    # => PacketGen::Header::OSPFv2::Hello
+      #
+      # == HELLO attributes
+      #   hello.network_mask = '255.255.255.0'
+      #   hello.hello_interval = 10
+      #   hello.options = 0
+      #   hello.priority = 1
+      #   hello.dead_interval = 300
+      #   hello.designated_router = '10.0.0.1'
+      #   hello.backup_designated_router = '0.0.0.0'
+      #   # set neighbors identifiers
+      #   hello.neighbors << '10.0.1.1'
+      #   hello.neighbors << '10.0.2.1'
+      # @author Sylvain Daubert
+      class Hello < Base
+        # @!attribute network_mask
+        #  The network mask associated with this interface.
+        #  @return [String]
+        define_field :network_mask, IP::Addr
+        # @!attribute hello_interval
+        #  The number of seconds between this router's Hello packets.
+        #  @return [Integer]
+        define_field :hello_interval, Types::Int16
+
+        # @!macro define_options
+        OSPFv2.define_options(self)
+
+        # @!attribute priority
+        #  This router's Router Priority.  Used in (Backup) Designated
+        #  Router election.
+        #  @return [Integer]
+        define_field :priority, Types::Int8
+        # @!attribute dead_interval
+        #  The number of seconds before declaring a silent router down.
+        #  @return [Integer]
+        define_field :dead_interval, Types::Int32
+        # @!attribute designated_router
+        #  The identity of the Designated Router for this network, in the
+        #  view of the sending router.
+        #  @return [String]
+        define_field :designated_router, IP::Addr
+        # @!attribute backup_designated_router
+        #  The identity of the Backup Designated Router for this network,
+        #  in the view of the sending router.
+        #  @return [String]
+        define_field :backup_designated_router, IP::Addr
+        # @!attribute neighbors
+        #  Array of neighbors
+        #  @return [IP::ArrayOfAddr]
+        define_field :neighbors, IP::ArrayOfAddr
+      end
+    end
+    
+    self.add_class OSPFv2::Hello
+    OSPFv2.bind_header OSPFv2::Hello, type: OSPFv2::TYPES['HELLO']
+  end
+end

data/lib/packetgen/header/ospfv2/ls_ack.rb

@@ -0,0 +1,55 @@
+# 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 OSPFv2
+
+      # This class handles {OSPFv2 OSPFv2} LS Acknowledgment packets payload.
+      # The LS Acknowledgment payload 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
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   +-                                                             -+
+      #   |                                                               |
+      #   +-                      An LSA Header                          -+
+      #   |                                                               |
+      #   +-                                                             -+
+      #   |                                                               |
+      #   +-                                                             -+
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                              ...                              |
+      # This paylod is implemented as a unique field: {#lsas}, which is an
+      # {ArrayOfLSAHeader} object.
+      #
+      # == Create a LSAck payload
+      #   # standalone
+      #   lsack = PacketGen::Header::OSPFv2::LSAck.new
+      #   # in a packet
+      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::LSAck')
+      #   # access to LSAck payload
+      #   lasck = pkt.ospfv2_lsack    # => PacketGen::Header::OSPFv2::LSAck
+      #
+      # == Adding LSA headers to a LSAck payload
+      #   lsack.lsas << { type: 'Router', age: 40, link_state_id: '0.0.0.1', advertising_router: '1.1.1.1', sequence_number: 42, checksum: 0x1234, length: 56 }
+      #   # a header may also be set from an existing lsa
+      #   lasck.lsas << existing_lsa.to_lsa_header
+      # @author Sylvain Daubert
+      class LSAck < Base
+        # @!attribute lsas
+        #  Array of LSA headers
+        #  @return [ArrayOfLSAHeader]
+        define_field :lsas, ArrayOfLSA, builder: ->(h, t) { t.new(only_headers: true) }
+      end
+    end
+
+    self.add_class OSPFv2::LSAck
+    OSPFv2.bind_header OSPFv2::LSAck, type: OSPFv2::TYPES['LS_ACK']
+  end
+end

data/lib/packetgen/header/ospfv2/ls_request.rb

@@ -0,0 +1,90 @@
+# 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 OSPFv2
+
+      # This class handle a LS request, which is composed 3 {Types::Int32} fields:
+      # * {#type},
+      # * {#link_state_id},
+      # * and {#advertising_router}.
+      # @author Sylvain Daubert
+      class LSR < Types::Fields
+        # @!attribute type
+        #  The type of the LSA to request.
+        #  @return [Integer]
+        define_field :type, Types::Int32Enum, enum: LSAHeader::TYPES
+        # @!attribute link_state_id
+        #  This field identifies the portion of the internet environment
+        #  that is being described by the LSA to request.
+        #  @return [String]
+        define_field :link_state_id, IP::Addr
+        # @!attribute advertising_router
+        #  The Router ID of the requested LSA.
+        #  @return [String]
+        define_field :advertising_router, IP::Addr
+
+        # Get human-readable type
+        # @return [String]
+        def human_type
+          self[:type].to_human
+        end
+
+        # @return [String]
+        def to_human
+          "LSR<#{human_type},#{link_state_id},#{advertising_router}>"
+        end
+      end
+      
+      # This class defines a specialized {Types::Array array} to handle series
+      # of {LSR LSRs}.
+      # @author Sylvain Daubert
+      class ArrayOfLSR < Types::Array
+        set_of LSR
+      end
+
+      # This class handles {OSPFv2 OSPFv2} Link State Request packets
+      # payload. The LSR payload 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 type                              |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                       Link State ID                           |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                     Advertising Router                        |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                              ...                              |
+      # This paylod is implemented as a unique field: {#lsrs}, which is an
+      # {ArrayOfLSR} object.
+      #
+      # == Create a LSRequest payload
+      #   # standalone
+      #   lsr = PacketGen::Header::OSPFv2::LSRequest.new
+      #   # in a packet
+      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::LSRequest')
+      #   # make IP header correct for OSPF
+      #   pkt.ospfize
+      #   # access to LSRequest payload
+      #   pkt.ospfv2_lsrequest    # => PacketGen::Header::OSPFv2::LSRequest
+      #
+      # == Add LSA requests to a LSRequest
+      #   lsr.lsrs << { type: 'Router', link_state_id: '0.0.0.1', advertising_router: '1.1.1.1'}
+      # @author Sylvain Daubert
+      class LSRequest < Base
+        # @!attribute lsrs
+        #  Array of {LSR}
+        #  @return [ArrayOfLSR]
+        define_field :lsrs, ArrayOfLSR
+      end
+    end
+
+    self.add_class OSPFv2::LSRequest
+    OSPFv2.bind_header OSPFv2::LSRequest, type: OSPFv2::TYPES['LS_REQUEST']
+  end
+end

data/lib/packetgen/header/ospfv2/ls_update.rb

@@ -0,0 +1,72 @@
+# 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 OSPFv2
+
+      # This class handles {OSPFv2 OSPFv2} Link State Update packets
+      # payload. The LSU payload 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
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                            # LSAs                             |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   +-                                                            +-+
+      #   |                             LSAs                              |
+      #   +-                                                            +-+
+      #   |                              ...                              |
+      # This paylod is implemented with two fields:
+      # * {#lsas_count}, a {Types::Int32} field,
+      # * and {#lsas}, an {ArrayOfLSA} object.
+      #
+      # == Create a LSUpdate payload
+      #   # standalone
+      #   lsu = PacketGen::Header::OSPFv2::LSUpdate.new
+      #   # in a packet
+      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::LSUpdate')
+      #   # make IP header correct for OSPF
+      #   pkt.ospfize
+      #   # access to LSUpdate payload
+      #   lsu = pkt.ospfv2_lsupdate    # => PacketGen::Header::OSPFv2::LSUpdate
+      #
+      # == Add LSAs to a LSUpdate payload
+      # Adding LSAs with {ArrayOfLSA#<< ArrayOfLSA#<<} automagically update
+      # {#lsas_count}. To not update it, use {ArrayOfLSA#push ArrayOfLSA#push}.
+      #   lsu.lsas << { type: 'Router', age: 40, link_state_id: '0.0.0.1', advertising_router: '1.1.1.1', sequence_number: 42 }
+      #   lsu.lsas_count     #=> 1
+      #   # add a link to Router LSA
+      #   lsu.lsas.first.links << { type: 1, metric: 10, id: '1.1.1.1' }
+      # @author Sylvain Daubert
+      class LSUpdate < Base
+        # @!attribute lsas_count
+        #  Count of LSAs included in this update
+        #  @return [Integer]
+        define_field :lsas_count, Types::Int32
+        # @!attribute lsas
+        #  Array of {LSA LSAs}
+        #  @return [ArrayOfLSA]
+        define_field :lsas, ArrayOfLSA, builder: ->(h, t) { t.new(counter: h[:lsas_count]) }
+        
+        # Calculate checksums of all LSAs
+        # @return [void]
+        def calc_checksum
+          lsas.each { |lsa| lsa.calc_checksum }
+        end
+        
+        # Calculate length of all LSAs
+        def calc_length
+          lsas.each { |lsa| lsa.calc_length }
+        end
+      end
+    end
+
+    self.add_class OSPFv2::LSUpdate
+    OSPFv2.bind_header OSPFv2::LSUpdate, type: OSPFv2::TYPES['LS_UPDATE']
+  end
+end

data/lib/packetgen/header/ospfv2/lsa.rb

@@ -0,0 +1,252 @@
+# 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 OSPFv2
+
+      # This class handles unsupported {OSPFv2 OSPFv2} LSA payloads.
+      # A LSA payload is a {LSAHeader} with a {#body} field.
+      # @author Sylvain Daubert
+      class LSA < LSAHeader
+        # @!attribute body
+        #  LSA body
+        #  @return [String]
+        define_field :body, Types::String,
+                     builder: ->(h,t) { t.new(length_from: ->() { h.length - 20 }) }
+      end
+
+      # This class handles TOS metrics for {Link links} in a {LSARouter
+      # LSA router payload}.
+      # @author Sylvain Daubert
+      class TosMetric < Types::Fields
+        # @!attribute tos
+        #  8-bit IP Type of Service that this metric refers to.
+        #  @return [Integer]
+        define_field :tos, Types::Int8
+        # @!attribute reserved
+        #  8-bit reserved field.
+        #  @return [Integer]
+        define_field :reserved, Types::Int8, default: 0
+        # @!attribute tos_metric
+        #  16-bit TOS-specific metric information..
+        #  @return [Integer]
+        define_field :tos_metric, Types::Int16
+
+        # @return [String]
+        def to_human
+          "TOS<type:#{type},metric:#{tos_metric}>"
+        end
+      end
+
+      # This class defines a specialized {Types::Array array} to handle series
+      # of {TosMetric TOS metrics}.
+      # @author Sylvain Daubert
+      class ArrayOfTosMetric < Types::Array
+        set_of TosMetric
+      end
+
+      # This class handles links in a {LSARouter LSA router payload}.
+      # @author Sylvain Daubert
+      class Link < Types::Fields
+        # @!attribute id
+        #  @return [IP::Addr]
+        define_field :id, IP::Addr
+        # @!attribute data
+        #  @return [IP::Addr]
+        define_field :data, IP::Addr
+        # @!attribute type
+        #  @return [Integer]
+        define_field :type, Types::Int8
+        # @!attribute tos_count
+        #  @return [Integer]
+        define_field :tos_count, Types::Int8
+        # @!attribute metric
+        #  @return [Integer]
+        define_field :metric, Types::Int16
+        # @!attribute tos
+        #  Additionnal TOS metrics
+        #  @return [ArrayOfTosMetric]
+        define_field :tos, ArrayOfTosMetric, builder: ->(h,t) { t.new(counter: h[:tos_count]) }
+
+        # @return [String]
+        def to_human
+          "Link<type:#{type},metric:#{metric},id:#{id},data:#{data}>"
+        end
+      end
+
+      # This class defines a specialized {Types::Array array} to handle series
+      # of {Link Links}.
+      # @author Sylvain Daubert
+      class ArrayOfLink < Types::Array
+        set_of Link
+      end
+
+      # This class handles LSA Router payloads.
+      #
+      # A LSA router payload is composed of:
+      # * a header (see methods inherited from {LSAHeader}),
+      # * a 16-bit flag word {#u16} ({Types::Int16}),
+      # * a 16-bit {#link_count} field ({Types::Int16}),
+      # * an array of {#links} ({ArrayOfLink}).
+      # @author Sylvain Daubert
+      class LSARouter < LSAHeader
+        # @attribute u16
+        #  16-bit flag word
+        #  @return [Integer]
+        define_field :u16, Types::Int16
+        # @attribute link_count
+        #  Number of links
+        #  @return [Integer]
+        define_field :link_count, Types::Int16
+        # @attribute links
+        #  @return [ArrayOfLink]
+        define_field :links, ArrayOfLink, builder: ->(h, t) { t.new(counter: h[:link_count]) }
+        
+        # @attribute v_flag
+        #  @return [Boolean]
+        # @attribute e_flag
+        #  @return [Boolean]
+        # @attribute b_flag
+        #  @return [Boolean]
+        define_bit_fields_on :u16, :z, 5, :v_flag, :e_flag, :b_flag, :zz, 8
+      end
+
+      # This class handles LSA Network payloads.
+      #
+      # A LSA network payload is composed of:
+      # * a header (see methods inherited from {LSAHeader}),
+      # * a 32-bit {#netmask} field ({IP::Addr}),
+      # * an array of router addresses ({#routers}, {IP::ArrayOfAddr}).
+      # @author Sylvain Daubert
+      class LSANetwork < LSAHeader
+        # @!attribute netmask
+        #  @return [IP::Addr]
+        define_field :netmask, IP::Addr
+        # @!attribute routers
+        #  List of routers in network
+        #  @return [IP::ArrayOfAddr]
+        define_field :routers, IP::ArrayOfAddr
+      end
+
+      # This class handles external links in {LSAASExternal LSA AS-External payloads}.
+      # @author Sylvain Daubert
+      class External < Types::Fields
+        # @!attribute u8
+        #  @return [Integer]
+        define_field :u8, Types::Int8
+        # @!attribute metric
+        #  @return [Integer]
+        define_field :metric, Types::Int24
+        # @!attribute forwarding_addr
+        #  @return [IP::Addr]
+        define_field :forwarding_addr, IP::Addr
+        # @!attribute ext_route_tag
+        #  @return [Integer]
+        define_field :ext_route_tag, Types::Int32
+        
+        # @!attribute e_flag
+        #  @return [Boolean]
+        # @!attribute tos
+        #  @return [Integer]
+        define_bit_fields_on :u8, :e_flag, :tos, 7
+      end
+
+      # This class defines a specialized {Types::Array array} to handle series
+      # of {External Externals}.
+      # @author Sylvain Daubert
+      class ArrayOfExternal < Types::Array
+        set_of External
+      end
+
+      # This class handles LSA AS-External payloads.
+      #
+      # A LSA network payload is composed of:
+      # * a header (see methods inherited from {LSAHeader}),
+      # * a 32-bit {#netmask} field ({IP::Addr}),
+      # * an array of external destinations ({#externals}, {ArrayOfExternal}).
+      # @author Sylvain Daubert
+      class LSAASExternal < LSAHeader
+        # @!attribute netmask
+        #  @return [IP::Addr]
+        define_field :netmask, IP::Addr
+        # @!attribute externals
+        #  List of external destinations
+        #  @return [ArrayOfExternal]
+        define_field :externals, ArrayOfExternal
+      end
+
+      # This class defines a specialized {Types::Array array} to handle series
+      # of {LSA LSAs}. It recognizes known LSA types and infers correct type.
+      # @author Sylvain Daubert
+      class ArrayOfLSA < Types::Array
+        set_of LSA
+        
+        # @param [Hash] options
+        # @option options [Types::Int] counter Int object used as a counter for this set
+        # @option options [Boolean] only_headers if +true+, only {LSAHeader LSAHeaders}
+        #  will be added to this array.
+        def initialize(options={})
+          super()
+          @only_headers = options[:only_headers] || false
+        end
+
+        # Populate object from a string
+        # @param [String] str
+        # @return [self]
+        def read(str)
+          clear
+          return self if str.nil?
+          return self if @counter and @counter.to_i == 0
+          force_binary str
+          while str.length > 0
+            lsa = LSAHeader.new.read(str)
+            if !@only_headers
+              klass = get_lsa_class_by_human_type(lsa.human_type)
+              lsa = klass.new.read(str[0...lsa.length])
+            end
+            self.push lsa
+            str.slice!(0, lsa.sz)
+            break if @counter and self.size == @counter.to_i
+          end
+          self
+        end
+
+        private
+
+        def record_from_hash(hsh)
+          unless hsh.has_key? :type
+            raise ArgumentError, "hash should have :type key"
+          end
+          
+          klass = if @only_headers
+                    LSAHeader
+                  else
+                    case hsh[:type]
+                    when String
+                      get_lsa_class_by_human_type(hsh[:type])
+                    when Integer
+                      get_lsa_class_by_human_type(LSAHeader::TYPES.key(hsh[:type]))
+                    else
+                      LSA
+                    end
+                  end
+          klass.new(hsh)
+        end
+
+        def get_lsa_class_by_human_type(htype)
+          klassname = "LSA#{htype.to_s.gsub(/-/, '')}"
+          if OSPFv2.const_defined? klassname
+            OSPFv2.const_get klassname
+          else
+            LSA
+          end
+        end
+      end
+    end
+  end
+end