ospfv2 0.0.1

data/lib/neighbor_sm/neighbor_state.rb

@@ -0,0 +1,87 @@
+#--
+# Copyright 2010 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+# OSPFv2 is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OSPFv2 is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+
+module OSPFv2
+  module NeighborState
+    class State
+
+      def change_state(neighbor, *args)
+        neighbor.change_state(*args)
+      end
+      alias :new_state :change_state
+
+      def kill_nbr(neighbor)
+        new_state neighbor, Down.new, 'll_down or kill_nbr'
+      end
+      alias :ll_down :kill_nbr
+      
+      def inactivity_timer(neighbor)
+        
+        neighbor.instance_eval {
+          @ls_db.reset if @ls_db
+          @ls_req_list={}
+          @periodic_refresh.cancel
+          @periodic_rxmt.cancel
+        }
+        
+        new_state neighbor, Down.new, 'Inactivity Timer'
+      end
+      
+      def recv_hello(neighbor, rcv_hello, *args)
+        neighbor.instance_eval {
+          hello.add_router_id rcv_hello
+          hello.designated_router_id = rcv_hello.designated_router_id.to_ip
+          inactivity_timer.start { new_state Down.new, 'Inactivity Timer' }
+        }
+      end
+
+      def adj_ok?
+      end
+      def seq_number_mismatch(neighbor)
+      end
+      def bad_ls_req(neighbor)
+      end
+      def one_way_received(neighbor)
+      end
+      def two_way_received(neighbor)
+      end
+      
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /^recv_(.+)$/
+          args[0].__send__ debug,  "*** ignoring packet #{$1} : received  while in #{self} ***"
+        else
+          raise
+        end
+      end
+
+    end
+  end
+end
+
+require 'neighbor_sm/down_state'
+require 'neighbor_sm/attempt_state'
+require 'neighbor_sm/init_state'
+require 'neighbor_sm/exstart_state'
+require 'neighbor_sm/exchange_state'
+require 'neighbor_sm/loading_state'
+require 'neighbor_sm/full_state'

data/lib/packet/database_description.rb

@@ -0,0 +1,300 @@
+#--
+# Copyright 2010 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+# OSPFv2 is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OSPFv2 is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+
+=begin rdoc
+A.3.3 The Database Description packet
+
+Database Description packets are OSPF packet type 2.  These packets
+are exchanged when an adjacency is being initialized.  They describe
+the contents of the link-state database.  Multiple packets may be
+used to describe the database.  For this purpose a poll-response
+procedure is used.  One of the routers is designated to be the
+master, the other the slave.  The master sends Database Description
+packets (polls) which are acknowledged by Database Description
+packets sent by the slave (responses).  The responses are linked to
+the polls via the packets' DD sequence numbers.
+
+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 #   |       2       |         Packet length         |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                          Router ID                            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                           Area ID                             |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|           Checksum            |             AuType            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                       Authentication                          |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                       Authentication                          |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|         Interface MTU         |    Options    |0|0|0|0|0|I|M|MS
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                     DD sequence number                        |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                                                               |
++-                                                             -+
+|                                                               |
++-                      An LSA Header                          -+
+|                                                               |
++-                                                             -+
+|                                                               |
++-                                                             -+
+|                                                               |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                              ...                              |
+
+
+The format of the Database Description packet is very similar to
+both the Link State Request and Link State Acknowledgment packets.
+The main part of all three is a list of items, each item describing
+a piece of the link-state database.  The sending of Database
+Description Packets is documented in Section 10.8.  The reception of
+Database Description packets is documented in Section 10.6.
+
+Interface MTU
+The size in bytes of the largest IP datagram that can be sent
+out the associated interface, without fragmentation.  The MTUs
+of common Internet link types can be found in Table 7-1 of
+[Ref22]. Interface MTU should be set to 0 in Database
+Description packets sent over virtual links.
+
+Options
+The optional capabilities supported by the router, as documented
+in Section A.2.
+
+I-bit
+The Init bit.  When set to 1, this packet is the first in the
+sequence of Database Description Packets.
+
+M-bit
+The More bit.  When set to 1, it indicates that more Database
+Description Packets are to follow.
+
+MS-bit
+The Master/Slave bit.  When set to 1, it indicates that the
+router is the master during the Database Exchange process.
+Otherwise, the router is the slave.
+
+DD sequence number
+Used to sequence the collection of Database Description Packets.
+The initial value (indicated by the Init bit being set) should
+be unique.  The DD sequence number then increments until the
+complete database description has been sent.
+
+The rest of the packet consists of a (possibly partial) list of the
+link-state database's pieces.  Each LSA in the database is described
+by its LSA header.  The LSA header is documented in Section A.4.1.
+It contains all the information required to uniquely identify both
+the LSA and the LSA's current instance.
+
+
+=end
+
+require 'packet/ospf_packet'
+require 'ie/interface_mtu'
+require 'ie/options'
+require 'lsa/lsa'
+require 'ls_db/link_state_database'
+
+module OSPFv2
+  
+  
+  
+  class DatabaseDescription < OspfPacket
+    
+    class << self
+      
+      def seqn
+        @seqn ||= rand(0x4fff)
+        @seqn +=1
+      end
+      
+    end
+
+    attr_reader :options, :ls_db, :interface_mtu, :dd_sequence_number
+
+    attr_checked :imms do |x|
+      (0..7) === x
+    end
+    attr_checked :dd_sequence_number do |x|
+      (0..0xffffffff) === x
+    end
+    alias :dd_seqn  :dd_sequence_number 
+    alias :dd_seqn= :dd_sequence_number=
+
+    def initialize(_arg={})
+      arg = _arg.dup
+      @interface_mtu = InterfaceMtu.new
+      @options = Options.new
+      @imms, @dd_sequence_number, @number_of_lsa=0, nil, nil
+
+      if arg.is_a?(Hash)
+        arg.merge!({:packet_type=>:dd})
+        super arg
+      elsif arg.is_a?(String)
+        parse arg
+      elsif arg.is_a?(DatabaseDescription)
+        parse arg.encode
+      else
+        raise ArgumentError, "Invalid argument", caller
+      end
+      
+    end
+
+    def to_s
+      s = []
+      s << super(:brief)
+      s << "MTU #{interface_mtu.to_i}, Options 0x#{options.to_i.to_s(16)}, #{imms_to_s}, DD_SEQ: 0x#{dd_sequence_number_to_shex}"
+      s << "Age  Options  Type    Link-State ID   Advr Router     Sequence   Checksum  Length" if @lsas
+      s <<((@lsas.collect { |x| x.to_s_dd })).join("\n ") if @lsas
+      s.join("\n ")
+    end
+
+    # 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 #   |       2       |         Packet length         |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                          Router ID                            |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                           Area ID                             |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |           Checksum            |             AuType            |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                       Authentication                          |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                       Authentication                          |
+    
+    
+    
+    
+    # 16:57 (exstart) snd DatabaseDescription:
+    #  Version 2, RouterId 0.0.0.1, AreaId 0.0.0.0, AuType 0, Checksum 0x9580, len 9999
+    # MTU 1500, Options 0x0, I|M|MS: 0 [000], DD_SEQ: d022675
+    # 123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.
+    #  Age  Options  Type    Link-State ID   Advr Router     Sequence   Checksum  Length
+    #   41    0x22  router    128.1.0.2       128.1.0.2       0x80000001  0x9580   36     
+    #   41    0x00  external  50.0.1.0        128.1.0.1       0x80000001  0x115a   48     
+    #   42    0x22  router    128.1.0.1       128.1.0.1       0x80000001  0xa86e   36     
+    #   41    0x00  summary   30.0.1.0        128.1.0.1       0x80000001  0x6459   28     
+
+
+    def to_s_short
+      "I|M|MS: [#{[imms].pack('C').unpack('B8')[0][5..7]}] SEQN: #{dd_sequence_number}"
+    end
+    def encode
+      packet =[]
+      packet << @interface_mtu.encode
+      packet << [options.to_i, imms, dd_sequence_number].pack('CCN')
+      packet << @lsas.collect { |x| x.encode.slice(0,20) }.join if @lsas
+      super packet.join
+    end
+    
+    def options=(val)
+      @options = Options.new(val)
+    end
+    
+    def more
+      @imms |= 2
+    end
+    
+    def no_more
+      @imms &= ~2
+    end
+    
+    def master 
+      @imms |= 1
+    end
+    alias :is_master :master
+    
+    def init 
+      @imms |= 4
+    end
+    alias :in_init :init
+    
+    def more?
+      imms & 2 == 2
+    end
+    
+    def master?
+      imms & 1 == 1
+    end
+    
+    def init?
+      imms & 4 == 4
+    end
+    
+    alias :seqn :dd_sequence_number
+    alias :seqn= :dd_sequence_number=
+    
+    def each
+      @lsas.each do |lsa|
+        yield lsa
+      end
+    end
+    
+    private
+    
+    def imms_to_s
+      "I|M|MS: #{imms} [#{[imms].pack('C').unpack('B8')[0][5..7]}]"
+    end
+    
+    def dd_sequence_number_to_s
+      "DD sequence number: #{dd_sequence_number_to_shex}"
+    end
+
+    def dd_sequence_number_to_shex
+      dd_sequence_number.to_s(16)
+    end
+    
+    def parse(s)
+      interface_mtu, options, @imms, @dd_sequence_number, headers = super(s).unpack('nCCNa*')
+      self.options = Options.new options
+      @interface_mtu = InterfaceMtu.new interface_mtu
+      @lsas ||=[]
+      while headers.size>0
+        lsa = Lsa.new headers.slice!(0,20)
+        @lsas <<lsa
+      end
+    end
+    
+    def number_of_lsa
+      #FIXME: rename interface mtu method...
+      @number_of_lsa ||=interface_mtu.n0flsa
+    end
+    
+    def set(arg)
+      super
+      if arg[:ls_db].is_a?(OSPFv2::LSDB::LinkStateDatabase)
+        ls_db = arg[:ls_db]
+        @lsas = ls_db.lsas[ls_db.offset, number_of_lsa] ||=[]
+        ls_db.offset += number_of_lsa
+        self.more if ls_db.size > ls_db.offset
+      end
+    end
+    
+  end
+end
+
+load "../../../test/ospfv2/packet/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0