ospfv2 0.0.1

data/lib/packet/link_state_update.rb

@@ -0,0 +1,189 @@
+#--
+# 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.5 The Link State Update packet
+
+      Link State Update packets are OSPF packet type 4.  These packets
+      implement the flooding of LSAs.  Each Link State Update packet
+      carries a collection of LSAs one hop further from their origin.
+      Several LSAs may be included in a single packet.
+
+      Link State Update packets are multicast on those physical networks
+      that support multicast/broadcast.  In order to make the flooding
+      procedure reliable, flooded LSAs are acknowledged in Link State
+      Acknowledgment packets.  If retransmission of certain LSAs is
+      necessary, the retransmitted LSAs are always sent directly to the
+      neighbor.  For more information on the reliable flooding of LSAs,
+      consult Section 13.
+
+          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 #   |       4       |         Packet length         |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |                          Router ID                            |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |                           Area ID                             |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |           Checksum            |             AuType            |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |                       Authentication                          |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |                       Authentication                          |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |                            # LSAs                             |
+         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+         |                                                               |
+         +-                                                            +-+
+         |                             LSAs                              |
+         +-                                                            +-+
+         |                              ...                              |
+
+
+      # LSAs
+          The number of LSAs included in this update.
+
+
+      The body of the Link State Update packet consists of a list of LSAs.
+      Each LSA begins with a common 20 byte header, described in Section
+      A.4.1. Detailed formats of the different types of LSAs are described
+      in Section A.4.
+
+  
+=end
+
+require 'packet/ospf_packet'
+require 'lsa/lsa'
+require 'lsa/lsa_factory'
+require 'packet/link_state_ack'
+module OSPFv2
+  
+  class LinkStateUpdate < OspfPacket
+    
+    attr_reader :lsas
+    
+    def initialize(_arg={})
+      arg = _arg.dup
+      @lsas=[]
+      if arg.is_a?(Hash)
+        arg.merge!({:packet_type=>4})
+        super arg
+      elsif arg.is_a?(String)
+        parse arg
+      elsif arg.is_a?(self)
+        parse arg.encode
+      else
+        raise ArgumentError, "Invalid argument", caller
+      end
+    end
+    
+    def number_of_lsa
+      lsas.size
+    end
+    
+    def encode
+      headers = []
+      headers << [lsas.size].pack('N')
+      headers << lsas.collect { |x| x.encode }.join
+      super headers.join
+    end
+
+    def parse(s)
+      n, lsas = super(s).unpack('Na*')
+      while lsas.size>0
+        len = lsas[18..19].unpack('n')[0]
+        lsa = lsas.slice!(0,len)
+        lsa = Lsa.factory lsa
+        if lsa
+          @lsas << lsa
+        else
+          puts "COULD NOT BUILD LSA OUT OF #{lsa.unpack('H*')}"
+        end
+      end
+    end
+    
+    def [](val)
+      lsas[val] 
+    end
+
+    # def to_s
+    #   s = []
+    #   s << super
+    #   s << lsas.collect { |x| x.to_s_junos }.join("\n ")
+    #   s.join("\n ")
+    # end
+
+    def to_s
+      s = []
+      s << super(:brief)
+      s << "\# LSAs #{@lsas.size}"
+      s << "Age  Options  Type    Link-State ID   Advr Router     Sequence   Checksum  Length"
+      s << @lsas.collect { |x| x.to_s }.join("\n ")
+      s.join("\n ")
+    end
+
+    
+    def each
+      lsas.each { |ls| yield ls }
+    end
+    
+    def keys
+      lsas.collect { |ls| ls.key }
+    end
+
+    def ack_lsu(router_id)
+      ls_ack = LinkStateAck.new(:router_id => router_id, :area => area = @aread_id)
+      each { |lsa| ls_ack.lsa_headers << lsa  }
+      ls_ack
+    end
+
+    class << self
+
+      def new_lsas(arg={})
+        lsus=[]
+        len=0
+        lsas = arg[:lsas]
+        arg.delete(:lsas)
+        lsu = new(arg)
+        lsas.flatten.compact.each do |lsa|
+          lsa_len = lsa.encode.size
+          if (len + lsa_len) > (1476-56-20)
+            lsus << lsu
+            lsu = new(arg)
+            len = 0
+          end
+          lsu.lsas << lsa
+          len += lsa_len
+        end
+        lsus << lsu
+        lsus
+      end
+    end
+
+  end
+  
+end
+
+load "../../../test/ospfv2/packet/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/packet/ospf_packet.rb

@@ -0,0 +1,306 @@
+#--
+# 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
+
+http://www.ietf.org/rfc/rfc2328.txt
+
+A.3.1 The OSPF packet header
+
+    Every OSPF packet starts with a standard 24 byte header.  This
+    header contains all the information necessary to determine whether
+    the packet should be accepted for further processing.  This
+    determination is described in Section 8.2 of the specification.
+
+
+        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                          |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+
+    Version #
+        The OSPF version number.  This specification documents version 2
+        of the protocol.
+
+    Type
+        The OSPF packet types are as follows. See Sections A.3.2 through
+        A.3.6 for details.
+
+
+                          Type   Description
+                          ________________________________
+                          1      Hello
+                          2      Database Description
+                          3      Link State Request
+                          4      Link State Update
+                          5      Link State Acknowledgment
+
+
+
+
+    Packet length
+        The length of the OSPF protocol packet in bytes.  This length
+        includes the standard OSPF header.
+
+    Router ID
+        The Router ID of the packet's source.
+
+    Area ID
+        A 32 bit number identifying the area that this packet belongs
+        to.  All OSPF packets are associated with a single area.  Most
+        travel a single hop only.  Packets travelling over a virtual
+        link are labelled with the backbone Area ID of 0.0.0.0.
+
+    Checksum
+        The standard IP checksum of the entire contents of the packet,
+        starting with the OSPF packet header but excluding the 64-bit
+        authentication field.  This checksum is calculated as the 16-bit
+        one's complement of the one's complement sum of all the 16-bit
+        words in the packet, excepting the authentication field.  If the
+        packet's length is not an integral number of 16-bit words, the
+        packet is padded with a byte of zero before checksumming.  The
+        checksum is considered to be part of the packet authentication
+        procedure; for some authentication types the checksum
+        calculation is omitted.
+
+    AuType
+        Identifies the authentication procedure to be used for the
+        packet.  Authentication is discussed in Appendix D of the
+        specification.  Consult Appendix D for a list of the currently
+        defined authentication types.
+
+
+    Authentication
+        A 64-bit field for use by the authentication scheme. See
+        Appendix D for details.
+
+=end
+
+
+require 'infra/ospf_common'
+require 'ie/id'
+require 'ie/ospf_version'
+require 'ie/packet_type'
+require 'ie/au_type'
+
+module OSPFv2
+  
+  RouterId = Class.new(Id)
+  AreaId   = Class.new(Id)
+  
+  class OspfPacket
+    include OSPFv2
+    include OSPFv2::Common
+    
+    attr_reader :area_id, :router_id, :version, :ospf_version, :packet_type, :au_type
+    attr_writer_delegate :area_id, :router_id, :packet_type, :au_type
+    
+    def packet_name
+      self.class.to_s.split('::').last.to_underscore
+    end
+    alias :name :packet_name
+    
+    def initialize(arg={})
+      
+      if arg.is_a?(Hash)
+        @ospf_version = OspfVersion.new
+        @packet_type = PacketType.new
+        @area_id = AreaId.new
+        @router_id = RouterId.new
+        @au_type = AuType.new
+        @authentication=''
+        set(arg)
+      elsif arg.is_a?(String)
+        parse(arg)
+      else
+        raise ArgumentError, "Invalid argument", caller
+      end
+    end
+    
+    def encode(payload='',router_id=@router_id)
+      @_len = 24 + payload.size
+      packet = @ospf_version.encode
+      packet << @packet_type.encode
+      packet << [24 + payload.size].pack('n')
+      packet << router_id.encode
+      packet << area_id.encode
+      packet << [0].pack('n')
+      packet << @au_type.encode
+      packet << [''].pack('a8')
+      packet << payload
+      packet[12..13]= self.csum = [checksum(packet)].pack('n')
+      packet
+    end
+
+  # Version 2, RouterId 0.0.0.1, AreaId 0.0.0.0, AuType 0, Checksum 0x9580, len 9999
+
+    def to_s_brief
+      encode unless @_len
+      "Version #{ospf_version.to_i}, RouterId #{router_id.to_ip}, AreaId #{area_id.to_ip}, Checksum #{0}, len #{@_len}"
+    end
+  
+    def to_s_default(verbosity=:brief)
+      case verbosity
+      when :brief
+        to_s_brief
+      else
+        s=[]
+        s << self.class.to_s.split('::').last + ":"
+        s << ospf_version.to_s
+        s << packet_type.to_s
+        s << router_id.to_s
+        s << area_id.to_s
+        s << au_type.to_s
+        s << [@authentication].pack('a8')
+        s.join("\n ")
+      end
+    end
+
+    alias :to_s_junos :to_s_default 
+    alias :to_s_junos_verbose :to_s_junos
+
+    def to_s(*args)
+      return to_s_default(*args) unless defined?($style)
+      case $style
+      when :junos ; to_s_junos(*args)
+      when :junos_verbose ; to_s_junos_verbose(*args)
+      else
+        to_s_default(*args)
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      puts "Method missing in #{self.class}: method: #{method}"
+
+      if method == :to_s_junos
+        to_s_default(*args)
+      else
+        super
+      end
+    end
+
+    def to_hash(verbose=false)
+      #FIXME: verbose not working, i.e. always false
+      encode if verbose
+      h = super()
+      h.delete(:authentication) if @authentication==''
+      h.delete(:csum) unless verbose
+      h
+    end
+    
+    private
+    
+    def csum=(value)
+      raise if value.is_a?(Fixnum)
+      @_csum=value
+    end
+    
+    def parse(s)
+      v, pt, len, rid, aid, csum, au_type, _, _, packet = s.unpack('CCnNNnnNNa*')
+      @ospf_version = OspfVersion.new(v)
+      @packet_type = PacketType.new(pt)
+      @router_id = RouterId.new(rid)
+      @area_id = AreaId.new(aid)
+      @au_type = AuType.new(au_type)
+      packet
+    end
+    
+    def checksum(data)
+      data += "\000" if data.length % 2 >0
+      s = 0
+      data.unpack("n*").each { |x|
+        s += x
+        if s > 0xffff
+          carry = s >> 16
+          s &= 0xffff
+          s += carry
+        end
+      }
+      ((s >> 16) + (s & 0xffff)) ^ 0xffff
+    end
+  end
+  
+  require 'packet/hello'
+  require 'packet/database_description'
+  require 'packet/link_state_update'
+  require 'packet/link_state_request'
+  
+  class OspfPacket
+    include OSPFv2
+    include OSPFv2::Common
+    
+    HELLO = 1
+    DATABASE_DESCRIPTION = 2
+    LINK_STATE_REQUEST = 3
+    LINK_STATE_UPDATE = 4
+    LINK_STATE_ACKNOWLEDGMENT = 5
+    
+    class << self
+      
+      def factory(arg)
+
+        if arg.is_a?(String)
+          s = arg.dup
+          version, type, len = s.unpack('CCn')
+
+          raise RuntimeError, "Bogus OSPF Version #{version}" unless version==2
+          case type
+          when HELLO                     ; Hello.new(s)
+          when DATABASE_DESCRIPTION      ; DatabaseDescription.new(s)
+          when LINK_STATE_REQUEST        ; LinkStateRequest.new(s)
+          when LINK_STATE_UPDATE         ; LinkStateUpdate.new(s)
+          when LINK_STATE_ACKNOWLEDGMENT ; LinkStateAck.new(s)
+          else
+            raise RuntimeError, "unknown OSPFv2 packet type #{type}"
+          end
+          
+        elsif arg.is_a?(Hash)
+          case arg[:packet_type]
+          when :hello     ; Hello.new(arg)
+          when :dd        ; DatabaseDescription.new(arg)
+          else
+            raise RuntimeError, "Cannot yet build this packet from hash #{arg[:packet_type]}"
+          end
+        end
+
+      end
+      
+    end
+    
+  end
+  
+end
+
+load "../../../test/ospfv2/packet/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: ospfv2
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jean Michel Esnault
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jme@spidercloud.com
+executables: 
+- ospfv2
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ie/au_type.rb
+- lib/ie/external_route.rb
+- lib/ie/id.rb
+- lib/ie/interface_mtu.rb
+- lib/ie/ls_age.rb
+- lib/ie/ls_type.rb
+- lib/ie/metric.rb
+- lib/ie/mt_metric.rb
+- lib/ie/options.rb
+- lib/ie/ospf_version.rb
+- lib/ie/packet_type.rb
+- lib/ie/router_link.rb
+- lib/ie/router_link_factory.rb
+- lib/ie/router_link_type.rb
+- lib/ie/sequence_number.rb
+- lib/ie/tos_metric.rb
+- lib/infra/ospf_common.rb
+- lib/infra/ospf_constants.rb
+- lib/infra/ospf_io.rb
+- lib/infra/ospf_socket.rb
+- lib/infra/parse_options.rb
+- lib/infra/timer.rb
+- lib/infra/to_s.rb
+- lib/ls_db/advertised_routers.rb
+- lib/ls_db/common.rb
+- lib/ls_db/link_state_database.rb
+- lib/ls_db/link_state_database_build.rb
+- lib/ls_db/link_state_database_links.rb
+- lib/ls_db/links.rb
+- lib/lsa/external.rb
+- lib/lsa/lsa.rb
+- lib/lsa/lsa_factory.rb
+- lib/lsa/network.rb
+- lib/lsa/router.rb
+- lib/lsa/summary.rb
+- lib/neighbor/neighbor.rb
+- lib/neighbor/neighbor_event_handler.rb
+- lib/neighbor/recv_database_description.rb
+- lib/neighbor/recv_hello.rb
+- lib/neighbor/recv_ospf_packet.rb
+- lib/neighbor_sm/attempt_state.rb
+- lib/neighbor_sm/down_state.rb
+- lib/neighbor_sm/exchange_state.rb
+- lib/neighbor_sm/exstart_state.rb
+- lib/neighbor_sm/full_state.rb
+- lib/neighbor_sm/init_state.rb
+- lib/neighbor_sm/loading_state.rb
+- lib/neighbor_sm/neighbor_state.rb
+- lib/packet/database_description.rb
+- lib/packet/hello.rb
+- lib/packet/link_state_ack.rb
+- lib/packet/link_state_request.rb
+- lib/packet/link_state_update.rb
+- lib/packet/ospf_packet.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An OSPFv2 Emulator.
+test_files: []
+