packetgen 2.4.0 → 2.5.0

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

@@ -0,0 +1,122 @@
+# 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} 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             |    Options    |    LS type    |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                        Link State ID                          |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                     Advertising Router                        |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                     LS sequence number                        |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |         LS checksum           |             length            |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #
+      # == About LSA headers
+      # LSA headers are used as-is in {DbDescription} payload. But this class
+      # is also a base class for different LSA class, as {LSARouter}.
+      # @author Sylvain Daubert
+      class LSAHeader < Types::Fields
+        # LSA Types
+        TYPES = {
+          'Router'       => 1,
+          'Network'      => 2,
+          'Summary-IP'   => 3,
+          'Summary-ABSR' => 4,
+          'AS-External'  => 5
+        }
+
+        # @!attribute age
+        #  The time in seconds since the LSA was originated.
+        #  @return [Integer]
+        define_field :age, Types::Int16
+        # @!macro define_options
+        OSPFv2.define_options(self)
+        # @!attribute type
+        #  The type of the LSA.
+        #  @return [Integer]
+        define_field :type, Types::Int8Enum, 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/ospfv3.rb

@@ -0,0 +1,216 @@
+# 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
+    
+    # This class supports OSPFv3 (RFC 5340).
+    # A OSPFv3 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
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |   Version #   |     Type      |         Packet length         |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |                         Router ID                             |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |                          Area ID                              |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |          Checksum             |  Instance ID  |      0        |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # An OSPFv3 header consists of:
+    # * a {#version} field ({Types::Int8}),
+    # * a {#type} field ({Types::Int8Enum}),
+    # * a {#length} field ({Types::Int16}). The length includes the header,
+    # * a {#router_id} field ({Types::Int32}),
+    # * an {#area_id} field ({Types::Int32}),
+    # * a {#checksum} field ({Types::Int16}),
+    # * an {#instance_id} field ({Types::Int8}),
+    # * a {#reserved} field ({Types::Int8}),
+    # * and a {#body} ({Types::String}).
+    #
+    # == Create an OSPFv3 header
+    #   # standalone
+    #   ospf = PacketGen::Header::OSPFv3.new
+    #   # in a packet
+    #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3')
+    #   # make IPv6 header correct for OSPF
+    #   pkt.ospfize
+    #   # or make it correct with specific destination address
+    #   pkt.ospfize(dst: :all_spf_routers)
+    #   # access to OSPF header
+    #   pkt.ospfv3    # => PacketGen::Header::OSPFv3
+    #
+    # == OSPFv3 attributes
+    #  ospf.version              # => 3
+    #  ospf.type = 'LS_ACK'      # or 5
+    #  ospf.length = 154
+    #  ospf.router_id = 0xc0a80001
+    #  ospf.area_id = 1
+    #  ospf.checksum = 0xabcd
+    #  ospf.instance_id = 0
+    #
+    # == OSPFv3 body
+    # OSPFv3 {#body} should contain OSPF payload for given {#type}:
+    # * {OSPFv3::Hello},
+    # * {OSPFv3::DbDescription},
+    # * {OSPFv3::LSRequest},
+    # * {OSPFv3::LSUpdate},
+    # * or {OSPFv3::LSAck}.
+    # @author Sylvain Daubert
+    class OSPFv3 < Base
+      
+      # IP protocol number for OSPF
+      IP_PROTOCOL = OSPFv2::IP_PROTOCOL
+      
+      # OSPF packet types
+      TYPES = OSPFv2::TYPES
+
+      # @!attribute version
+      #  8-bit OSPF version
+      #  @return [Integer]
+      define_field :version, Types::Int8, default: 3
+      # @!attribute type
+      #  8-bit OSPF packet type. Types are defined in {TYPES}.
+      #  @return [Integer]
+      define_field :type, Types::Int8Enum, enum: TYPES
+      # @!attribute length
+      #  16-bit OSPF packet length
+      #  @return [Integer]
+      define_field :length, Types::Int16
+      # @!attribute router_id
+      #  32-bit router ID
+      #  @return [Integer]
+      define_field :router_id, Types::Int32
+      # @!attribute area_id
+      #  32-bit area ID
+      #  @return [Integer]
+      define_field :area_id, Types::Int32
+      # @!attribute checksum
+      #  16-bit OSPF packet checksum
+      #  @return [Integer]
+      define_field :checksum, Types::Int16
+      # @!attribute instance_id
+      #  8-bit instance ID.
+      #  @return [Integer]
+      define_field :instance_id, Types::Int8
+      # @!attribute reserved
+      #  8-bit reserved field.
+      #  @return [Integer]
+      define_field :reserved, Types::Int8, default: 0
+      # @!attribute body
+      #  @return [String,Base]
+      define_field :body, Types::String
+
+      # @api private
+      # Helper class method to define an OSPFv3 options field.
+      # @param [Base] hdr header on which define a OSPFv3 options field
+      # @return [void]
+      # @!macro [attach] define_ospfv3_options
+      #  @!attribute options
+      #    24-bit options field. Handle {#v6_opt}, {#e_opt}, {#x_opt},
+      #    {#n_opt}, {#r_opt} and {#dc_opt}.
+      #    @return [Integer]
+      #  @!attribute dc_opt
+      #    This bit describes the router's handling of demand circuits.
+      #    @return [Boolean]
+      #  @!attribute r_opt
+      #    This bit indicates whether the originator is an active router.
+      #    @return [Boolean]
+      #  @!attribute n_opt
+      #    This bit indicates whether or not the router is attached to an NSSA.
+      #    @return [Boolean]
+      #  @!attribute x_opt
+      #    This bit should be set to 0, and ignored when received.
+      #    @return [Boolean]
+      #  @!attribute e_opt
+      #    This bit describes the way AS-external-LSAs are flooded.
+      #    @return [Boolean]
+      #  @!attribute v6_opt
+      #    If this bit is clear, the router/link should be excluded from IPv6
+      #    routing calculations.
+      #    @return [Boolean]
+      def self.define_options(hdr)
+        hdr.define_field :options, Types::Int24
+        hdr.define_bit_fields_on :options, :z, 18, :dc_opt, :r_opt,
+                                 :n_opt, :x_opt, :e_opt, :v6_opt
+      end
+
+      # @api private
+      # @note This method is used internally by PacketGen and should not be
+      #       directly called
+      def added_to_packet(packet)
+        ospf_idx = packet.headers.size
+        packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end"
+      end
+
+      # Compute checksum and set +checksum+ field
+      # @return [Integer]
+      def calc_checksum
+        ipv6 = ip_header(self)
+        sum = ipv6.pseudo_header_checksum
+        sum += IP_PROTOCOL
+        sum += self.sz
+        sum += IP.sum16(self)
+        self.checksum = IP.reduce_checksum(sum)
+      end
+
+      # Get human-readable type
+      # @return [String]
+      def human_type
+        self[:type].to_human
+      end
+
+      # Compute length and set +length+ field
+      # @return [Integer]
+      def calc_length
+        self[:length].value = Base.calculate_and_set_length(self)
+      end
+
+      # Fixup IPv6 header according to RFC 5340:
+      # * set Traffic Class field to 0xc0,
+      # * optionally set destination address,
+      # * set Hop-limit to 1 if destination is a mcast address.
+      # This method may be called as:
+      #    # first way
+      #    pkt.ospfv3.ospfize
+      #    # second way
+      #    pkt.ospfize
+      # @param [String,Symbol,nil] dst destination address. May be a dotted IP
+      #   address (by example '224.0.0.5') or a Symbol (+:all_spf_routers+ or
+      #   +:all_d_routers+)
+      # @return [void]
+      def ospfize(dst: nil)
+        ipv6 = ip_header(self)
+        ipv6.traffic_class = 0xc0
+        dst = case dst
+              when :all_spf_routers
+                'ff02::5'
+              when :all_d_routers
+                'ff02::6'
+              else
+                dst
+              end
+        ipv6.dst = dst unless dst.nil?
+        ipv6.hop = 1 if ipv6[:dst].mcast?
+      end
+    end
+
+    self.add_class OSPFv3
+    IPv6.bind_header OSPFv3, next: OSPFv3::IP_PROTOCOL
+  end
+end
+
+require_relative 'ospfv3/ipv6_prefix'
+require_relative 'ospfv3/lsa_header'
+require_relative 'ospfv3/lsa'
+require_relative 'ospfv3/hello'
+require_relative 'ospfv3/db_description'
+require_relative 'ospfv3/ls_request'
+require_relative 'ospfv3/ls_update'
+require_relative 'ospfv3/ls_ack'

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

@@ -0,0 +1,114 @@
+# 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} DB description packets payload.
+      # The DB description 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
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+
+      #   |       0       |               Options                          |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+
+      #   |        Interface MTU          |      0        |0|0|0|0|0|I|M|MS|
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+
+      #   |                     DD sequence number                         |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+
+      #   |                                                                |
+      #   +-                                                              -+
+      #   |                                                                |
+      #   +-                      An LSA Header                           -+
+      #   |                                                                |
+      #   +-                                                              -+
+      #   |                                                                |
+      #   +-                                                              -+
+      #   |                                                                |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+
+      #   |                              ...                               |
+      #
+      # A DB description payload is composed of:
+      # * a 8-bit {#reserved} field ({Types::Int8}),
+      # * a 24-bit {#options} field ({Types::Int24}),
+      # * a 16-bit {#mtu} field ({Types::Int16}),
+      # * a 16-bit {#flags} field ({Types::Int16}). Supported flags are:
+      #   * {i_flag},
+      #   * {m_flag},
+      #   * {ms_flag},
+      # * a 32-bit {#sequence_number} field ({Types::Int32}),
+      # * and an array of {LSAHeader LSAHeaders} ({#lsas}, {ArrayOfLSA}).
+      #
+      # == Create a DbDescription payload
+      #   # standalone
+      #   dbd = PacketGen::Header::OSPFv3::DbDescription.new
+      #   # in a packet
+      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::DbDescription')
+      #   # access to DbDescription payload
+      #   pkt.ospfv3_dbdescription    # => PacketGen::Header::OSPFv3::DbDescription
+      #
+      # == DbDescription attributes
+      #   dbd.reserved = 0
+      #   # set options. Options may also be set one by one with #v6_opt, #e_opt,
+      #   # #n_opt, #r_opt and #dc_opt
+      #   dbd.options = 0x33
+      #   dbd.mtu = 1500
+      #   dbd.flags = 0
+      #   dbd.seqnum = 0x800001
+      #   # add a LSA Router header
+      #   dbd.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
+      #   dbd.lsas << existing_lsa.to_lsa_header
+      # @author Sylvain Daubert
+      class DbDescription < Base
+
+        # @!attribute reserved
+        #  8-bit zero field before {#options} one
+        #  @return [Integer]
+        define_field :reserved, Types::Int8, default: 0
+
+        # @!macro define_options
+        OSPFv3.define_options(self)
+
+        # @!attribute mtu
+        #  16-bit interface MTU
+        #  @return [Integer]
+        define_field :mtu, Types::Int16
+        # @!attribute flags
+        #  16-bit interface flags ({#i_flag}, {#m_flag} and {#ms_flag})
+        #  @return [Integer]
+        define_field :flags, Types::Int16
+        # @!attribute i_flag
+        #  Init bit from {#flags} field
+        #  @return [Boolean]
+        # @!attribute m_flag
+        #  More bit from {#flags} field
+        #  @return [Boolean]
+        # @!attribute ms_flag
+        #  Master/Slave bit from {#flags} field
+        #  @return [Boolean]
+        define_bit_fields_on :flags, :zz, 13, :i_flag, :m_flag, :ms_flag
+
+        # @!attribute sequence_number
+        #  32-bit DD sequence number, used to sequence the collection of Database
+        #  Description Packets.
+        #  @return [Integer]
+        define_field :sequence_number, Types::Int32
+        alias seqnum sequence_number
+        alias seqnum= sequence_number=
+        
+        # @!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 OSPFv3::DbDescription
+    OSPFv3.bind_header OSPFv3::DbDescription, type: OSPFv3::TYPES['DB_DESCRIPTION']
+  end
+end