ospfv2 0.0.1

data/lib/ie/ospf_version.rb

@@ -0,0 +1,67 @@
+#--
+# 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
+class OspfVersion
+  def initialize(version=2)
+    case version
+    when :v2, 2 ; @ospf_version = 2
+    when :v3, 3 ; @ospf_version = 3
+    else
+      @ospf_version = 0
+    end
+  end
+  def to_s
+    case @ospf_version
+    when 2  ; '2'
+    when 3  ; '3'
+    else
+      'unknown'
+    end
+  end
+  def to_hash
+    to_i
+  end
+  def to_i
+    @ospf_version
+  end
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_sym}"
+  end
+  def to_sym
+    case @ospf_version
+    when 2  ; :v2
+    when 3  ; :v3
+    else
+      ':v?'
+    end
+  end
+
+  def encode
+    [@ospf_version].pack('C')
+  end
+  alias :enc  :encode
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/packet_type.rb

@@ -0,0 +1,65 @@
+#--
+# 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
+class PacketType
+  def initialize(value=0)
+    case value
+    when 1, :hello      ; @packet_type = 1
+    when 2, :dd         ; @packet_type = 2
+    when 3, :ls_request ; @packet_type = 3
+    when 4, :ls_update  ; @packet_type = 4
+    when 5, :ls_ack     ; @packet_type = 5
+    else
+      @packet_type = 0
+    end
+  end
+  def to_hash
+    to_sym
+  end
+  def to_i
+    @packet_type
+  end
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_sym}"
+  end
+  def to_sym
+    case @packet_type
+    when 1  ; :hello
+    when 2  ; :dd
+    when 3  ; :ls_request
+    when 4  ; :ls_update
+    when 5  ; :ls_ack
+    else
+      'unknown'
+    end
+  end
+
+  def encode
+    [@packet_type].pack('C')
+  end
+  alias :enc  :encode
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/router_link.rb

@@ -0,0 +1,167 @@
+#--
+# 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/>.
+#++
+
+require 'infra/ospf_common'
+require 'ie/id'
+require 'ie/metric'
+require 'ie/mt_metric'
+require 'ie/router_link_type'
+
+module OSPFv2
+  
+  class RouterLink
+    include Common
+    
+    LinkId = Class.new(Id)
+    LinkData = Class.new(Id)
+    
+    attr_reader :link_id, :link_data, :router_link_type, :metric, :mt_metrics
+    
+    attr_writer_delegate :link_id, :link_data, :router_link_type
+    
+    def initialize(arg={})
+      arg = arg.dup
+      if arg.is_a?(Hash)
+        @link_id, @link_data, @router_link_type, @metric = nil, nil, nil, nil
+        @mt_metrics = []
+        set arg
+      elsif arg.is_a?(String)
+        parse arg
+      elsif arg.is_a?(self.class)
+        parse arg.encode
+      else
+        raise ArgumentError, "Invalid Argument: #{arg.inspect}"
+      end
+    end
+    
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                          Link ID                              |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                         Link Data                             |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |     Type      |     # TOS     |            metric             |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |                              ...                              |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # |      TOS      |        0      |          TOS  metric          |
+    # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    def encode
+      @link_id    ||= LinkId.new
+      @link_data  ||= LinkData.new
+      @router_link_type  ||= RouterLinkType.new
+      @metric   ||= Metric.new
+      rlink =[]
+      rlink << link_id.encode
+      rlink << link_data.encode
+      rlink << router_link_type.encode
+      rlink << [mt_metrics.size].pack('C')
+      rlink << metric.encode('n')
+      rlink << mt_metrics.collect { |x| x.encode }
+      rlink.join
+    end
+    
+    # TODO: if self.class is not RouterLink do not display RouterLinkType info....
+    def to_s(ident=2)
+      encode unless @router_link_type
+      self.class.to_s.split('::').last + ":" +
+      ['',link_id, link_data, router_link_type, metric, *mt_metrics].compact.collect { |x| x.to_s }.join("\n"+" "*ident)
+    end
+    
+    def to_s_junos_style
+      s = "  id #{id}, data #{data}, Type #{RouterLink.type_to_s_junos_style[@type]} (#{@type})"
+      s +="\n    Topology count: #{@mt_id.size}, Default metric: #{@metric}"
+      s += @mt_id.collect { |mt| "\n    #{mt.to_s_junos_style}" }.join
+      s      
+    end
+ 
+    def to_s_junos
+      s = "  id #{link_id.to_ip}, data #{link_data.to_ip}, Type #{RouterLinkType.to_junos(router_link_type.to_i)} (#{router_link_type.to_i})"
+      s +="\n    Topology count: #{@mt_metrics.size}, Default metric: #{metric.to_i}"
+      s += @mt_metrics.collect { |mt| "\n    #{mt.to_s}" }.join
+
+    end
+    
+    class << self
+      class_eval {
+        RouterLinkType.each { |x| 
+          define_method "new_#{x}" do |*args|
+            OSPFv2::RouterLink.const_get(x.to_klass).send :new, *args
+          end
+        }
+      }
+    end
+    
+    RouterLinkType.each { |x| 
+      klassname = Class.new(self) do
+        define_method(:initialize) do |arg|
+          arg ||={}
+          arg[:router_link_type] = x if arg.is_a?(Hash)
+          super arg
+        end
+        define_method(:to_hash) do
+          super.merge :router_link_type => x
+        end
+      end
+      self.const_set(x.to_klass, klassname)
+    }
+    
+    # FIXME: same as summary.rb ... mixin candidate
+    def mt_metrics=(val)
+      [val].flatten.each { |x| self << x }
+    end
+    
+    def <<(metric)
+      @mt_metrics ||=[]
+      @mt_metrics << MtMetric.new(metric)
+      self
+    end
+    
+    def parse(s)
+      @mt_metrics ||=[]
+      link_id, link_data, router_link_type, ntos, metric, mt_metrics = s.unpack('NNCCna*')
+      @link_id = LinkId.new link_id
+      @link_data = LinkData.new link_data
+      @router_link_type = RouterLinkType.new router_link_type
+      @metric = Metric.new metric
+      while mt_metrics.size>0
+        self << MtMetric.new(mt_metrics.slice!(0,4))
+      end
+    end
+    
+  end
+# 
+# require 'pp'  
+#   h = {:router_link_type=>1, :metric=>1,:mt_metrics=>[{:id=>20, :metric=>33}, {:id=>255, :metric=>34}], :link_data=>"10.254.233.233",:link_id=>"2.2.2.2"}
+# 
+# pp RouterLink.new(h)
+# 
+# puts RouterLink.new(h)
+# puts RouterLink.new(h).to_shex
+
+
+
+  
+end
+
+
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/router_link_factory.rb

@@ -0,0 +1,53 @@
+#--
+# 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/>.
+#++
+
+require 'infra/ospf_common'
+require 'ie/router_link'
+
+module OSPFv2
+  class RouterLink
+    def self.factory(arg)
+      if arg.is_a?(Hash)
+        raise ArgumentError, "no link type specified" unless  arg[:router_link_type]
+        case arg[:router_link_type]
+        when 1,:point_to_point  ; PointToPoint.new(arg)
+        when 2,:transit_network ; TransitNetwork.new(arg)
+        when 3,:stub_network    ; StubNetwork.new(arg)
+        when 4,:virtual_link    ; VirtualLink.new(arg)
+        end
+      elsif arg.is_a?(String)
+        case arg[8,1].unpack('C')[0]
+        when 1 ; PointToPoint.new(arg)
+        when 2 ; TransitNetwork.new(arg)
+        when 3 ; StubNetwork.new(arg)
+        when 4 ; VirtualLink.new(arg)
+        else
+          raise ArgumentError, "Invalid Argument: #{arg[8,1].unpack('C')[0]} #{arg.inspect}/#{arg.unpack('H*')}"
+        end
+      elsif arg.is_a?(RouterLink)
+        factory(arg.encode)
+      end
+    end
+  end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/router_link_type.rb

@@ -0,0 +1,86 @@
+#--
+# 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/>.
+#++
+
+# Router Link:
+# Type   Description
+#  __________________________________________________
+#  1      Point-to-point connection to another router
+#  2      Connection to a transit network
+#  3      Connection to a stub network
+#  4      Virtual link
+
+module OSPFv2
+class RouterLinkType
+  def self.each
+    [:point_to_point, :transit_network, :stub_network, :virtual_link].each { |x| yield(x) } if block_given?
+  end
+  def self.to_i(arg)
+    return arg unless arg.is_a?(Symbol)
+    [:point_to_point, :transit_network, :stub_network, :virtual_link].index(arg)+1
+  end
+  def self.to_junos(type)
+    case type.to_i
+    when 1 ; 'Point-to-point'
+    when 2 ; 'Transit'
+    when 3 ; 'Stub'
+    when 4 ; 'Virtual-link'
+    else   ; type.to_i 
+    end
+  end
+  def initialize(router_link_type=1)
+    case router_link_type
+    when  1, :point_to_point   ; @router_link_type=1
+    when  2, :transit_network  ; @router_link_type=2
+    when  3, :stub_network     ; @router_link_type=3
+    when  4, :virtual_link     ; @router_link_type=4
+    else
+      raise ArgumentError, "Invalid RouterLinkType #{router_link_type}"
+    end
+  end
+  def to_i
+    @router_link_type
+  end
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_sym}"
+  end
+  def to_sym
+    case @router_link_type
+    when 1  ; :point_to_point
+    when 2  ; :transit_network
+    when 3  ; :stub_network
+    when 4  ; :virtual_link
+    end
+  end
+  def encode
+    [@router_link_type].pack('C')
+  end
+  alias :enc  :encode
+  
+  def to_hash
+    to_sym
+  end
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+

data/lib/ie/sequence_number.rb

@@ -0,0 +1,144 @@
+#--
+# 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/>.
+#++
+
+require 'infra/ospf_constants'
+
+module OSPFv2
+
+  class SequenceNumber
+    include OSPFv2
+    include Comparable
+    
+    def SequenceNumber.initial
+      [N + 1].pack('I').unpack('i')[0]
+    end
+    
+    def SequenceNumber.max
+      [N - 1].pack('I').unpack('i')[0]
+    end
+    
+    def SequenceNumber.N
+      [N].pack('I').unpack('i')[0]
+    end
+    
+    def SequenceNumber.to_s(seqn)
+      new(seqn).to_s
+    end
+    
+    def initialize(seqn=:init)
+      if seqn.is_a?(Symbol)
+        if seqn == :max
+          @seqn= MaxSequenceNumber
+        elsif seqn == :init
+          @seqn = InitialSequenceNumber
+        elsif seqn == :reserved
+          @seqn = N
+        end 
+      elsif seqn.is_a?(self.class)
+        @seqn = seqn.to_I
+      else
+        @seqn=seqn
+      end
+      @seqn = [@seqn].pack('I')
+    end
+
+    def <=>(o)
+      to_i <=> o.to_i
+    end
+
+    def to_i
+      @seqn.unpack('i')[0]
+    end
+    def to_I
+      @seqn.unpack('I')[0]
+    end
+
+    def to_s
+      "0x"+ sprintf("%08.8x", to_I)
+    end
+    
+    def +(num)
+      seqn = (@seqn.unpack('i')[0]+num)
+      @seqn = [seqn].pack('I')
+      self
+    end
+    
+    def -(num)
+      self.+(-num)
+    end
+    
+    def encode
+      #FIXME: unit-test and check if 'i' or 'I'
+      [to_i].pack('N')
+    end
+    
+    def to_hash
+      to_I
+    end
+    
+  end
+
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+
+__END__
+
+
+=begin rdoc
+12.1.6.  LS sequence number
+
+The sequence number field is a signed 32-bit integer.  It is
+used to detect old and duplicate LSAs.  The space of
+sequence numbers is linearly ordered.  The larger the
+sequence number (when compared as signed 32-bit integers)
+the more recent the LSA.  To describe to sequence number
+space more precisely, let N refer in the discussion below to
+the constant 2**31.
+
+The sequence number -N (0x80000000) is reserved (and
+unused).  This leaves -N + 1 (0x80000001) as the smallest
+(and therefore oldest) sequence number; this sequence number
+is referred to as the constant InitialSequenceNumber. A
+router uses InitialSequenceNumber the first time it
+originates any LSA.  Afterwards, the LSA's sequence number
+is incremented each time the router originates a new
+instance of the LSA.  When an attempt is made to increment
+the sequence number past the maximum value of N - 1
+(0x7fffffff; also referred to as MaxSequenceNumber), the
+current instance of the LSA must first be flushed from the
+routing domain.  This is done by prematurely aging the LSA
+(see Section 14.1) and reflooding it.  As soon as this flood
+has been acknowledged by all adjacent neighbors, a new
+instance can be originated with sequence number of
+InitialSequenceNumber.
+
+The router may be forced to promote the sequence number of
+one of its LSAs when a more recent instance of the LSA is
+unexpectedly received during the flooding process.  This
+should be a rare event.  This may indicate that an out-of-
+date LSA, originated by the router itself before its last
+restart/reload, still exists in the Autonomous System.  For
+more information see Section 13.4.
+
+
+=end

data/lib/ie/tos_metric.rb

@@ -0,0 +1,102 @@
+#--
+# 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/>.
+#++
+
+# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# |      0        |                  metric                       |
+# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# |     TOS       |                TOS  metric                    |
+# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# |                              ...                              |
+# 
+# Network Mask
+#     For Type 3 summary-LSAs, this indicates the destination
+#     network's IP address mask.  For example, when advertising the
+#     location of a class A network the value 0xff000000 would be
+#     used.  This field is not meaningful and must be zero for Type 4
+#     summary-LSAs.
+# 
+# metric
+#     The cost of this route.  Expressed in the same units as the
+#     interface costs in the router-LSAs.
+# 
+# Additional TOS-specific information may also be included, for
+# backward compatibility with previous versions of the OSPF
+# specification ([Ref9]). For each desired TOS, TOS-specific
+# information is encoded as follows:
+# 
+# TOS IP Type of Service that this metric refers to.  The encoding of
+#     TOS in OSPF LSAs is described in Section 12.3.
+# 
+# TOS metric
+#     TOS-specific metric information.
+# 
+
+require 'infra/ospf_common'
+module OSPFv2
+
+class TosMetric
+  include Common
+  
+  attr_reader :tos, :cost
+  
+  def initialize(arg={})
+    arg = arg.dup
+    @tos,@cost=0,0
+    if arg.is_a?(Hash)
+      set arg
+    elsif arg.is_a?(String)
+      parse arg
+    elsif arg.is_a?(self.class)
+      parse arg.encode
+    elsif arg.is_a?(Array) and arg.size==2
+      @tos, @cost = arg
+    else
+      raise ArgumentError, "Invalid Argument: #{arg.inspect}"
+    end
+  end
+  
+  alias :id :tos
+  
+  def encode
+    m = []
+    m << [tos].pack('C')
+    m << [cost].pack('N').unpack('C4')[1..-1].pack('C3')
+    m.join
+  end
+  
+  def parse(s)
+    @tos, *cost = s.unpack('C4')
+    @cost = [0,*cost].pack('C4').unpack('N')[0]
+  end
+  
+  def to_s
+    self.class.to_s.split('::').last + ": tos: #{tos} cost: #{cost}"
+  end
+  
+  def to_s_junos_style
+    "Topology (ID #{id}) -> Metric: #{cost}"
+  end
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0