ospfv2 0.0.1

data/lib/ie/ls_type.rb

@@ -0,0 +1,148 @@
+#--
+# 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/>.
+#++
+
+# 
+# LS Type   Description
+# ___________________________________
+# 1         Router-LSAs
+# 2         Network-LSAs
+# 3         Summary-LSAs (IP network)
+# 4         Summary-LSAs (ASBR)
+# 5         AS-external-LSAs
+# 
+module OSPFv2
+class LsType
+  
+  def self.all
+    [:router, :network, :summary, :asbr_summary, :as_external]
+  end
+  
+  def self.to_i(arg)
+    return arg unless arg.is_a?(Symbol)
+    case arg.to_s
+    when /^router(_lsa|)$/       ; @ls_type=1
+    when /^network(_lsa|)$/      ; @ls_type=2
+    when /^summary(_lsa|)$/      ; @ls_type=3
+    when /^asbr_summary(_lsa|)$/ ; @ls_type=4
+    when /^as_external(_lsa|)$/  ; @ls_type=5
+    #FIXME: finish and unit-test
+    # when :as_external7_lsa ; @ls_type=7
+    # when :opaque_link      ; @ls_type=9
+    # when :opaque_area      ; @ls_type=10
+    # when :opaque_as        ; @ls_type=11
+    end    
+  end
+  
+  def self.to_sym(arg)
+    return arg unless arg.is_a?(Fixnum)
+    case arg
+    when 1  ; :router_lsa
+    when 2  ; :network_lsa
+    when 3  ; :summary_lsa
+    when 4  ; :asbr_summary_lsa
+    when 5  ; :as_external_lsa
+    when 7  ; :as_external7_lsa
+    when 9  ; :opaque_link
+    when 10 ; :opaque_area
+    when 11 ; :opaque_as
+    end
+  end
+
+  def self.to_junos(arg)
+    return arg.to_i unless arg.is_a?(Fixnum)
+    case arg
+    when 1  ; 'Router'
+    when 2  ; 'Network'
+    when 3  ; 'Summary'
+    when 4  ; 'ASBRSum'
+    when 5  ; 'Extern'
+    else
+      'TBD'
+    end
+  end
+  
+  def initialize(ls_type=1)
+    case ls_type
+    when  1,:router_lsa       ; @ls_type=1
+    when  2,:network_lsa      ; @ls_type=2
+    when  3,:summary_lsa      ; @ls_type=3
+    when  4,:asbr_summary_lsa ; @ls_type=4
+    when  5,:as_external_lsa  ; @ls_type=5
+    when  7,:as_external7_lsa ; @ls_type=7
+    when  9,:opaque_link      ; @ls_type=9
+    when 10,:opaque_area      ; @ls_type=10
+    when 11,:opaque_as        ; @ls_type=11
+    else
+      raise ArgumentError, "Invalid LsType #{ls_type}"
+    end
+  end
+  def to_i
+    @ls_type
+  end
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_sym}"
+  end
+  def to_s_short
+    case to_i
+    when  1; 'router'
+    when  2; 'network'
+    when  3; 'summary'
+    when  4; 'asbrSum'
+    when  5; 'external'
+    when  7; 'nssa'
+    when  9; 'opaqLnk'
+    when 10; 'opaqArea'
+    when 11; 'opaqAs'
+    end
+  end
+  def to_sym
+    LsType.to_sym @ls_type
+  end
+
+  def encode
+    [@ls_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
+
+__END__
+
+LSA_Header.aging=false
+LSA_Header.lstype_to_s = Hash.new("unknown")
+LSA_Header.lstype_to_s.store(1,"Router")
+LSA_Header.lstype_to_s.store(2,"Network")
+LSA_Header.lstype_to_s.store(3,"Summary")
+LSA_Header.lstype_to_s.store(4,"ASBR_Sum")
+LSA_Header.lstype_to_s.store(5,"External")
+LSA_Header.lstype_to_s.store(9,"OpaqLink")
+LSA_Header.lstype_to_s.store(10,"OpaqArea")
+LSA_Header.lstype_to_s.store(11,"OpaqAS")
+
+

data/lib/ie/metric.rb

@@ -0,0 +1,63 @@
+#--
+# 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'
+
+module OSPFv2
+
+class Metric
+  include Common
+  
+  attr_reader  :metric
+  attr_checked :metric do |x|
+    (0..0xffffff).include?(x)
+  end
+  
+  def initialize(metric=0)
+    self.metric=metric
+  end
+  
+  def to_i
+    metric
+  end
+  
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_i}"
+  end
+  
+  def to_s_junos
+    "Topology default (ID 0) -> Metric: #{to_i}"
+  end
+  
+  def encode(fmt='N')
+    [metric].pack(fmt)
+  end
+  alias :enc  :encode
+  
+  def to_hash
+    to_i
+  end
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/mt_metric.rb

@@ -0,0 +1,119 @@
+#--
+# 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 metric of this route.  Expressed in the same units as the
+#     interface metrics 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 MtMetric
+  
+  def initialize(arg={})
+    arg = arg.dup
+    @_id,@_metric=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
+      @_id, @_metric = arg
+    else
+      raise ArgumentError, "Invalid Argument: #{arg.inspect}"
+    end
+  end
+  
+  def set(arg)
+    @_id = arg[:id] if arg[:id]
+    @_metric = arg[:metric] if arg[:metric]
+  end
+  
+  def to_hash
+    {:id=>id, :metric=> metric}
+  end
+  
+  def id
+    @_id
+  end
+  def id=(val)
+    @_id=val
+  end
+  def metric
+    @_metric
+  end
+  def metric=(val)
+    @_metric=val
+  end
+    
+  def encode
+    m = []
+    m << [id].pack('C')
+    m << [metric].pack('N').unpack('C4')[1..-1].pack('C3')
+    m.join
+  end
+  
+  def parse(s)
+    @_id, *metric = s.unpack('C4')
+    @_metric = [0,*metric].pack('C4').unpack('N')[0]
+  end
+  
+  def to_s
+    "Topology #{id}, Metric #{metric}"
+  end
+  
+  def to_s_junos
+    "Topology (ID #{id}) -> Metric: #{metric}"
+  end
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/options.rb

@@ -0,0 +1,356 @@
+#--
+# 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.2 The Options field
+
+   The 24-bit OSPF Options field is present in OSPF Hello packets,
+   Database Description packets and certain LSAs (router-LSAs, network-
+   LSAs, inter-area-router-LSAs and link-LSAs). The Options field
+   enables OSPF routers to support (or not support) optional
+   capabilities, and to communicate their capability level to other OSPF
+   routers.  Through this mechanism routers of differing capabilities
+   can be mixed within an OSPF routing domain.
+
+   An option mismatch between routers can cause a variety of behaviors,
+   depending on the particular option. Some option mismatches prevent
+   neighbor relationships from forming (e.g., the E-bit below); these
+   mismatches are discovered through the sending and receiving of Hello
+   packets. Some option mismatches prevent particular LSA types from
+   being flooded across adjacencies (e.g., the MC-bit below); these are
+   discovered through the sending and receiving of Database Description
+   packets. Some option mismatches prevent routers from being included
+   in one or more of the various routing calculations because of their
+   reduced functionality (again the MC-bit is an example); these
+   mismatches are discovered by examining LSAs.
+
+   Six bits of the OSPF Options field have been assigned. Each bit is
+   described briefly below. Routers should reset (i.e.  clear)
+   unrecognized bits in the Options field when sending Hello packets or
+   Database Description packets and when originating LSAs. Conversely,
+   routers encountering unrecognized Option bits in received Hello
+   Packets, Database Description packets or LSAs should ignore the
+   capability and process the packet/LSA normally.
+
+
+                             1                     2
+         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8  9  0  1  2  3
+        -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+--+--+--+--+--+
+         | | | | | | | | | | | | | | | | | |DC| R| N|MC| E|V6|
+        -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--+--+--+--+--+--+
+
+                        The Options field
+
+   V6-bit
+     If this bit is clear, the router/link should be excluded from IPv6
+     routing calculations. See Section 3.8 of this memo.
+
+   E-bit
+     This bit describes the way AS-external-LSAs are flooded, as
+     described in Sections 3.6, 9.5, 10.8 and 12.1.2 of [Ref1].
+
+   MC-bit
+     This bit describes whether IP multicast datagrams are forwarded
+     according to the specifications in [Ref7].
+
+   N-bit
+     This bit describes the handling of Type-7 LSAs, as specified in
+     [Ref8].
+
+   R-bit
+     This bit (the `Router' bit) indicates whether the originator is an
+     active router.  If the router bit is clear routes which transit the
+     advertising node cannot be computed. Clearing the router bit would
+     be appropriate for a multi-homed host that wants to participate in
+     routing, but does not want to forward non-locally addressed
+     packets.
+
+   DC-bit
+     This bit describes the router's handling of demand circuits, as
+     specified in [Ref10].
+
+=end
+
+require 'infra/ospf_common'
+module OSPFv2
+  
+  
+  class Options
+     
+    attr :options, true
+
+    def initialize(arg={})
+      @options=0
+      if arg.is_a?(Hash) then
+        set(arg)
+      elsif arg.is_a?(String)
+        _parse_(arg)
+      elsif arg.is_a?(Fixnum) and (0..255) === arg
+        @options = arg
+      elsif arg.is_a?(self.class)
+        set(arg.to_hash)
+      else
+        raise ArgumentError, "Invalid argument", caller
+      end
+    end
+    
+    def set(arg)
+      return self unless arg.is_a?(Hash)
+      
+      unless arg[:O].nil? and arg[:o].nil?
+        _flag = arg[:O] ||= arg[:o]
+        if _flag.is_a?(TrueClass)
+          setO
+        elsif _flag.is_a?(FalseClass)
+          unsetO
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetO
+          else
+            setO
+          end
+        end
+      end
+      unless arg[:DC].nil? and arg[:dc].nil?
+        _flag = arg[:DC] ||= arg[:dc]
+        if _flag.is_a?(TrueClass)
+          setDC
+        elsif _flag.is_a?(FalseClass)
+          unsetDC
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetDC
+          else
+            setDC
+          end
+        end
+      end
+      unless arg[:R].nil? and arg[:r].nil?
+        _flag = arg[:R] ||= arg[:r]
+        if _flag.is_a?(TrueClass)
+          setR
+        elsif _flag.is_a?(FalseClass)
+          unsetR
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetR
+          else
+            setR
+          end
+        end
+      end
+      unless arg[:N].nil? and arg[:n].nil?
+        _flag = arg[:N] ||= arg[:n]
+        if _flag.is_a?(TrueClass)
+          setN
+        elsif _flag.is_a?(FalseClass)
+          unsetN
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetN
+          else
+            setN
+          end
+        end
+      end
+      unless arg[:P].nil? and arg[:p].nil?
+        _flag = arg[:P] ||= arg[:p]
+        if _flag.is_a?(TrueClass)
+          setP
+        elsif _flag.is_a?(FalseClass)
+          unsetP
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetP
+          else
+            setP
+          end
+        end
+      end
+      unless arg[:MC].nil? and arg[:mc].nil?
+          _flag = arg[:MC] ||= arg[:mc]
+          if _flag.is_a?(TrueClass)
+            setMC
+          elsif _flag.is_a?(FalseClass)
+            unsetMC
+          elsif _flag.is_a?(Fixnum)
+            if _flag == 0
+              unsetMC
+            else
+              setMC
+            end
+          end
+        end
+      unless arg[:E].nil? and arg[:e].nil?
+        _flag = arg[:E] ||= arg[:e]
+        if _flag.is_a?(TrueClass)
+          setE
+        elsif _flag.is_a?(FalseClass)
+          unsetE
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetE
+          else
+            setE
+          end
+        end
+      end
+      unless arg[:V6].nil? and arg[:v6].nil?
+        _flag = arg[:V6] ||= arg[:v6]
+        if _flag.is_a?(TrueClass)
+          setV6
+        elsif _flag.is_a?(FalseClass)
+          unsetV6
+        elsif _flag.is_a?(Fixnum)
+          if _flag == 0
+            unsetV6
+          else
+            setV6
+          end
+        end
+      end
+      self
+    end
+    
+    def __setBit(bit)
+      @options = @options | (2 ** (bit-1))
+    end
+    private :__setBit
+    def __unsetBit(bit)
+      @options = @options & ~(2 ** (bit-1))
+    end
+    private :__unsetBit
+    def __isSet(bit)
+      @options & (2**(bit-1))>0 
+    end
+    private :__isSet
+    
+    def setO    ; __setBit(7)   ; end
+    def unsetO  ; __unsetBit(7) ; end
+    def o?      ; __isSet(7)    ; end
+
+    def setDC   ; __setBit(6)   ; end
+    def unsetDC ; __unsetBit(6) ; end
+    def dc?     ; __isSet(6)    ; end
+    
+    def setR    ; __setBit(5)   ; end
+    def unsetR  ; __unsetBit(5) ; end
+    def r?      ; __isSet(5)    ; end
+    
+    # N-bit is used in Hello packets only. 
+    # It signals the area is an NSSA area.
+    def setN    ; __setBit(4)   ; end
+    def unsetN  ; __unsetBit(4) ; end
+    def n?      ; __isSet(4)    ; end
+
+    # P-bit is used in Type-7 LSA Header
+    # It signals the NSSA border to translate the Type-7 into Type-5.
+    def setP    ; __setBit(4)   ; end
+    def unsetP  ; __unsetBit(4) ; end
+    def p?      ; __isSet(4)    ; end
+    
+    def setMC   ; __setBit(3)   ; end
+    def unsetMC ; __unsetBit(3) ; end
+    def mc?     ; __isSet(3)    ; end
+    
+    def setE    ; __setBit(2)   ; end
+    def unsetE  ; __unsetBit(2) ; end
+    def e?      ; __isSet(2)    ; end
+    
+    def setV6   ; __setBit(1)   ; end
+    def unsetV6 ; __unsetBit(1) ; end
+    def v6?     ; __isSet(1)    ; end
+    
+    def setNSSA
+      setN
+      unsetE
+    end
+    
+    def encode
+      [@options].pack('C')
+    end
+    
+    def _parse_(s)
+      @options = s.unpack('C')[0]
+    end
+    private :_parse_
+
+    # V6-bit
+    #   If this bit is clear, the router/link should be excluded from IPv6
+    #   routing calculations. See Section 3.8 of this memo.
+    # 
+    # E-bit
+    #   This bit describes the way AS-external-LSAs are flooded, as
+    #   described in Sections 3.6, 9.5, 10.8 and 12.1.2 of [Ref1].
+    # 
+    # MC-bit
+    #   This bit describes whether IP multicast datagrams are forwarded
+    #   according to the specifications in [Ref7].
+    # 
+    # N-bit
+    #   This bit describes the handling of Type-7 LSAs, as specified in
+    #   [Ref8].
+    # 
+    # R-bit
+    #   This bit (the `Router' bit) indicates whether the originator is an
+    #   active router.  If the router bit is clear routes which transit the
+    #   advertising node cannot be computed. Clearing the router bit would
+    #   be appropriate for a multi-homed host that wants to participate in
+    #   routing, but does not want to forward non-locally addressed
+    #   packets.
+    # 
+    # DC-bit
+    #   This bit describes the router's handling of demand circuits, as
+    #   specified in [Ref10].
+    def to_s
+      self.class.to_s.split('::').last + ": " + format(' 0x%x  [%s]', to_i, _to_s_)   #[@options].pack('C').unpack('B8')[0][1..7]
+    end
+
+    def to_i
+      @options
+    end
+
+    def to_hash
+      to_i
+    end
+    
+    private
+    
+    def _to_s_
+      s = []
+      s << 'O' if o?
+      s << 'R' if r?
+      s << 'DC' if dc?
+      s << 'N' if n?
+      s << 'MC' if mc?
+      s << 'E' if e?
+      s << 'V6' if v6?
+      s.join(',')
+    end
+
+  end
+  
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0