Class: PacketGen::Header::OSPFv2::Hello

Inherits:
Base
  • Object
show all
Defined in:
lib/packetgen/header/ospfv2/hello.rb

Overview

This class handles 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:

Examples:

Create a HELLO payload

# standalone
hello = PacketGen::Header::OSPFv2::Hello.new
# in a packet
pkt = PacketGen.gen('IP').add('OSPFv2').add('OSPFv2::Hello')
# make IP header correct for OSPF
pkt.ospfize
# access to Hello payload
pkt.ospfv2_hello.class    # => PacketGen::Header::OSPFv2::Hello

HELLO attributes

hello = PacketGen::Header::OSPFv2::Hello.new
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

Since:

  • 2.5.0

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

bind, calculate_and_set_length, #header_id, inherited, #initialize, #ip_header, #ll_header

Methods included from PacketGen::Headerable

#added_to_packet, included, #method_name, #packet, #packet=, #parse?, #protocol_name, #read, #to_s

Constructor Details

This class inherits a constructor from PacketGen::Header::Base

Instance Attribute Details

#backup_designated_router ⇒ String

The identity (as an IP address) of the Backup Designated Router for this network, in the view of the sending router.

Returns:

  • (String) 


94
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 94

define_attr :backup_designated_router, IP::Addr

#dc_opt ⇒ Integer

This bit describes the router’s handling of demand circuits.

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#dead_interval ⇒ Integer

The number of seconds before declaring a silent router down.

Returns:

  • (Integer) 


84
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 84

define_attr :dead_interval, BinStruct::Int32

#designated_router ⇒ String

The identity (as an IP address) of the Designated Router for this network, in the view of the sending router.

Returns:

  • (String) 


89
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 89

define_attr :designated_router, IP::Addr

#dn_opt ⇒ Integer

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#e_opt ⇒ Integer

This bit describes the way AS-external-LSAs are flooded.

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#hello_interval ⇒ Integer

The number of seconds between this router’s Hello packets.

Returns:

  • (Integer) 


71
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 71

define_attr :hello_interval, BinStruct::Int16

#l_opt ⇒ Integer

This specifies if a LLS Data block is present.

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#mc_opt ⇒ Integer

This bit describes whether IP multicast datagrams are forwarded.

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#mt_opt ⇒ Integer

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#n_opt ⇒ Integer

This bit specifies if NSSA is supported.

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#neighbors ⇒ IP::ArrayOfAddr

Array of neighbors

Returns:



98
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 98

define_attr :neighbors, IP::ArrayOfAddr

#network_mask ⇒ String

The network mask associated with this interface.

Returns:

  • (String) 


67
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 67

define_attr :network_mask, IP::Addr

#o_opt ⇒ Integer

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#options ⇒ Integer

8-bit options field. Handle #mt_opt, #e_opt, #mc_opt, #n_opt, #l_opt, #dc_opt, #o_opt and #dn_opt.

Returns:

  • (Integer) 


74
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 74

OSPFv2.define_options(self)

#priority ⇒ Integer

This router’s Router Priority. Used in (Backup) Designated Router election.

Returns:

  • (Integer) 


80
 
# File 'lib/packetgen/header/ospfv2/hello.rb', line 80

define_attr :priority, BinStruct::Int8