packetgen 2.4.0 → 2.5.0

data/lib/packetgen/header/ipv6/addr.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 'ipaddr'
 
 module PacketGen
@@ -75,6 +77,12 @@ module PacketGen
         def to_a
           @fields.values
         end
+
+        # Return true if this address is a multicast one
+        # @return [Boolean]
+        def mcast?
+          self.a1 & 0xff00 == 0xff00
+        end
       end
 
       # Class to handle series of IPv6 addresses

data/lib/packetgen/header/ipv6/extension.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
     class IPv6

data/lib/packetgen/header/ipv6/hop_by_hop.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
     class IPv6

data/lib/packetgen/header/llc.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/mld.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/mldv2.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
     # This module contains all MLDv2 specific classes.
@@ -11,7 +13,7 @@ module PacketGen
       # Encode value for MLDv2 Max Resp Code.
       # Value may be encoded as a float, so some error may occur.
       # See RFC 3810 §5.1.3
-      # @param [Integer] value3
+      # @param [Integer] value value to encode
       # @return [Integer]
       def self.encode(value)
         if value < 32768
@@ -31,7 +33,7 @@ module PacketGen
 
       # Decode value for MLDv2 Max Resp Code.
       # See RFC 3810 §5.1.3
-      # @param [Integer] value
+      # @param [Integer] value value to decode
       # @return [Integer]
       def self.decode(value)
         if value < 32768

data/lib/packetgen/header/mldv2/mcast_address_record.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
     module MLDv2
@@ -90,7 +92,7 @@ module PacketGen
         end
       end
       
-      # Class to handle series of {MAR}.
+      # Class to handle series of {McastAddressRecord}.
       # @author Sylvain Daubert
       class McastAddressRecords < Types::Array
         set_of McastAddressRecord

data/lib/packetgen/header/mldv2/mlq.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
     module MLDv2

data/lib/packetgen/header/mldv2/mlr.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_relative 'mcast_address_record'
 
 module PacketGen
@@ -39,7 +41,7 @@ module PacketGen
       # MLR fields are:
       # * {#reserved} ({Types::Int16}),
       # * {#number_of_mar} (number of mcast address records, {Types::Int16}),
-      # * {#records} ({McastAddrRecords}).
+      # * {#records} ({McastAddressRecords}).
       # @author Sylvain Daubert
       class MLR < Base
         # @!attribute reserved
@@ -47,7 +49,7 @@ module PacketGen
         # @return [Integer]
         define_field :reserved, Types::Int16, default: 0
         # @!attribute number_of_mar
-        #  16-bit Number of group records in {#group_records}
+        #  16-bit Number of group records in {#records}
         #  @return [Integer]
         define_field :number_of_mar, Types::Int16, default: 0
         

data/lib/packetgen/header/ospfv2.rb

@@ -0,0 +1,249 @@
+# 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 OSPFv2 (RFC 2328).
+    # A OSPFv2 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            |             AuType            |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                       Authentication                          |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                       Authentication                          |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # An OSPFv2 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 {#au_type} field ({Types::Int16Enum}),
+    # * an {#authentication} field ({Types::Int64}),
+    # * and a {#body} ({Types::String}).
+    #
+    # == Create an OSPFv2 header
+    #   # standalone
+    #   ospf = PacketGen::Header::OSPFv2.new
+    #   # in a packet
+    #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2')
+    #   # make IP 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.ospfv2    # => PacketGen::Header::OSPFv2
+    #
+    # == OSPFv2 attributes
+    #  ospf.version              # => 2
+    #  ospf.type = 'LS_ACK'      # or 5
+    #  ospf.length = 154
+    #  ospf.router_id = 0xc0a80001
+    #  ospf.area_id = 1
+    #  ospf.checksum = 0xabcd
+    #  ospf.au_type = 'NO_AUTH'  # or 0
+    #  ospf.authentication = 0
+    #
+    # == OSPFv2 body
+    # OSPFv2 {#body} should contain OSPF payload for given {#type}:
+    # * {OSPFv2::Hello},
+    # * {OSPFv2::DbDescription},
+    # * {OSPFv2::LSRequest},
+    # * {OSPFv2::LSUpdate},
+    # * or {OSPFv2::LSAck}.
+    #
+    # @author Sylvain Daubert
+    class OSPFv2 < Base
+      
+      # IP protocol number for OSPF
+      IP_PROTOCOL = 89
+      
+      # OSPF packet types
+      TYPES    = {
+        'HELLO'          => 1,
+        'DB_DESCRIPTION' => 2,
+        'LS_REQUEST'     => 3,
+        'LS_UPDATE'      => 4,
+        'LS_ACK'         => 5
+      }
+
+      # Authentication types
+      AU_TYPES = {
+        'NO_AUTH'         => 0,
+        'PASSWORD'        => 1,
+        'CRYPTO'          => 2,
+        'CRYPTO_WITH_ESN' => 3
+      }
+
+      # @!attribute version
+      #  8-bit OSPF version
+      #  @return [Integer]
+      define_field :version, Types::Int8, default: 2
+      # @!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 au_type
+      #  16-bit authentication type. Types are defined in {AU_TYPES}.
+      #  @return [Integer]
+      define_field :au_type, Types::Int16Enum, enum: AU_TYPES
+      # @!attribute authentication
+      #  64-bit authentication data
+      #  @return [Integer]
+      define_field :authentication, Types::Int64
+      # @!attribute body
+      #  @return [String,Base]
+      define_field :body, Types::String
+
+      # @api private
+      # Helper class method to define an OSPFv2 options field.
+      # @param [Base] hdr header on which define a OSPFv2 options field
+      # @return [void]
+      # @!macro [attach] define_options
+      #  @!attribute options
+      #    8-bit options field. Handle {#mt_opt}, {#e_opt}, {#mc_opt},
+      #    {#n_opt}, {#l_opt}, {#dc_opt}, {#o_opt} and {#dn_opt}.
+      #    @return [Integer]
+      #  @!attribute dn_opt
+      #    @return [Boolean]
+      #  @!attribute o_opt
+      #    @return [Boolean]
+      #  @!attribute dc_opt
+      #    This bit describes the router's handling of demand circuits.
+      #    @return [Boolean]
+      #  @!attribute l_opt
+      #    This specifies if a LLS Data block is present.
+      #    @return [Boolean]
+      #  @!attribute n_opt
+      #    This bit specifies if NSSA is supported.
+      #    @return [Boolean]
+      #  @!attribute mc_opt
+      #    This bit describes whether IP multicast datagrams are forwarded.
+      #    @return [Boolean]
+      #  @!attribute e_opt
+      #    This bit describes the way AS-external-LSAs are flooded.
+      #    @return [Boolean]
+      #  @!attribute mt_opt
+      #    @return [Boolean]
+      def self.define_options(hdr)
+        hdr.define_field :options, Types::Int8
+        hdr.define_bit_fields_on :options, :dn_opt, :o_opt, :dc_opt, :l_opt,
+                                 :n_opt, :mc_opt, :e_opt, :mt_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
+        # #authentication field is not used in checksum calculation,
+        # so force it to 0 before checksumming
+        saved_auth = self.authentication
+        self.authentication = 0
+
+        sum = IP.sum16(self)
+        self.checksum = IP.reduce_checksum(sum)
+
+        # Restore #authentication value
+        self.authentication = saved_auth
+
+        self.checksum
+      end
+
+      # Get human-readable type
+      # @return [String]
+      def human_type
+        self[:type].to_human
+      end
+
+      # Get human-readable AU type
+      # @return [String]
+      def human_au_type
+        self[:au_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 IP header according to RFC 2328:
+      # * set TOS field to 0xc0,
+      # * optionally set destination address,
+      # * set TTL to 1 if destination is a mcast address.
+      # This method may be called as:
+      #    # first way
+      #    pkt.ospfv2.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)
+        ip = ip_header(self)
+        ip.tos = 0xc0
+        dst = case dst
+              when :all_spf_routers
+                '224.0.0.5'
+              when :all_d_routers
+                '224.0.0.6'
+              else
+                dst
+              end
+        ip.dst = dst unless dst.nil?
+        ip.ttl = 1 if ip[:dst].mcast?
+      end
+    end
+
+    self.add_class OSPFv2
+    IP.bind_header OSPFv2, protocol: OSPFv2::IP_PROTOCOL
+  end
+end
+
+require_relative 'ospfv2/hello'
+require_relative 'ospfv2/lsa_header'
+require_relative 'ospfv2/lsa'
+require_relative 'ospfv2/db_description'
+require_relative 'ospfv2/ls_request'
+require_relative 'ospfv2/ls_update'
+require_relative 'ospfv2/ls_ack'

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

@@ -0,0 +1,105 @@
+# 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} 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
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |         Interface MTU         |    Options    |0|0|0|0|0|I|M|MS
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                     DD sequence number                        |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   +-                                                             -+
+      #   |                                                               |
+      #   +-                      An LSA Header                          -+
+      #   |                                                               |
+      #   +-                                                             -+
+      #   |                                                               |
+      #   +-                                                             -+
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                              ...                              |
+      #
+      # A DB description payload is composed of:
+      # * a 16-bit {#mtu} field ({Types::Int16}),
+      # * a 8-bit {#options} field ({Types::Int8}),
+      # * a 8-bit {#flags} field ({Types::Int8}). 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::OSPFv2::DbDescription.new
+      #   # in a packet
+      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::DbDescription')
+      #   # access to DbDescription payload
+      #   pkt.ospfv2_dbdescription    # => PacketGen::Header::OSPFv2::DbDescription
+      #
+      # == DbDescription attributes
+      #   dbd.mtu = 1500
+      #   # set options. Options may also be set one by one with {#mt_opt},
+      #   # {#e_opt}, {#mc_opt}, {#n_opt}, {#l_opt}, {#dc_opt}, {#o_opt} and {#dn_opt}
+      #   dbd.options = 0
+      #   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 mtu
+        #  16-bit interface MTU
+        #  @return [Integer]
+        define_field :mtu, Types::Int16
+
+        # @!macro define_options
+        OSPFv2.define_options(self)
+
+        # @!attribute flags
+        #  8-bit interface flags ({#i_flag}, {#m_flag} and {#ms_flag})
+        #  @return [Integer]
+        define_field :flags, Types::Int8
+        # @!attribute i_flag
+        #  Init bit
+        #  @return [Boolean]
+        # @!attribute m_flag
+        #  More bit
+        #  @return [Boolean]
+        # @!attribute ms_flag
+        #  Master/Slave bit
+        #  @return [Boolean]
+        define_bit_fields_on :flags, :zero, 5, :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 OSPFv2::DbDescription
+    OSPFv2.bind_header OSPFv2::DbDescription, type: OSPFv2::TYPES['DB_DESCRIPTION']
+  end
+end