ospfv2 0.0.1

data/bin/ospfv2

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require 'neighbor/neighbor'
+require 'packet/ospf_packet'
+require 'ls_db/link_state_database'
+require 'ls_db/link_state_database_links'
+require 'infra/parse_options'
+require 'pp'
+
+include OSPFv2
+
+Thread.current["name"]  = "#{self}"
+
+cli = Thread.new do
+  Thread.current["name"]  = "CLI"
+  
+  # Parse command line
+  begin
+    options = OptParse.parse(ARGV)
+  rescue OptionParser::InvalidOption => e
+    STDERR.puts e.to_s.gsub(/at\s*$/,'')
+    exit(1)
+  end
+  
+  ls_db = OSPFv2::LSDB::LinkStateDatabase.create :columns=> options.grid[0], 
+                                                 :rows=> options.grid[1], 
+                                                 :base_prefix => options.base_link_addr, 
+                                                 :base_router_id=> options.base_router_id
+
+  #  Up all links
+  OSPFv2::LSDB::Link.all.each { |id,lnk| ls_db.link lnk, :up  }
+
+  
+  # Describe the connection to our neighbor
+  # It's a p2p connection
+  #   we need to describe a p2p link and a stub link
+  rlsa = Router.new :ls_id=> options.router_id, 
+                    :advertising_router=>options.router_id, 
+                    :options=>0x22
+  rlsa << RouterLink.new_point_to_point(:link_id=>options.neighbor_id,
+                                        :link_data=> options.ipaddr,
+                                        :metric=>1)     
+  rlsa << RouterLink.new_stub_network(:link_id=>options.network, 
+                                      :link_data=>options.netmask, 
+                                      :metric=>1)
+  ls_db << rlsa
+
+
+  rid1 = OSPFv2::LSDB::LinkStateDatabase.router_id(1,1,options.base_router_id)
+  rid2 = OSPFv2::LSDB::LinkStateDatabase.router_id(2,1,options.base_router_id)
+  rid3 = OSPFv2::LSDB::LinkStateDatabase.router_id(1,1,options.base_router_id)
+
+  # add a  a p2p link between router_id and rid1
+  ls_db.new_link :router_id=> options.router_id, :neighbor_id=>rid1
+
+  # Link.all.values.each { |lnk| @ls_db.link lnk, :down  }
+  
+  # Add some Summary LSAs
+  [rid1,rid2].each  do |rid|
+    ls_db.lookup(1,rid).set_abr
+    (options.num_sum/2).times { ls_db << OSPFv2::Summary.new_lsdb( :advertising_router=> rid ) }
+  end
+  
+  # Add some External LSAs
+  ls_db.find_router_lsa(rid3).set_asbr
+  options.num_ext.times { \
+          ls_db << OSPFv2::AsExternal.new_lsdb(:advertising_router=> rid3, 
+                                               :mt_metrics=>[{:mt_id=>10, :metric=>20,
+                                                              :tag=>10}])}
+  
+  ls_db << AsbrSummary.new(:advertising_router=> rid3, :ls_id=> rid3)
+  
+  
+  neighbor = OSPFv2::Neighbor.new :src_addr => options.ipaddr, 
+                                  :router_id => options.router_id, 
+                                  :area_id=>options.area_id, 
+                                  :log_fname => options.log_fname
+                                  
+  neighbor.hello_int
+  neighbor.dead_int
+  neighbor.ls_db = ls_db
+  
+  # Add option to parse
+  ls_db.ls_refresh_time=2000
+  ls_db.ls_refresh_interval=10
+  
+  help= <<-"end;"
+  start 
+  stop
+  puts ls_db 
+  puts ls_db.to_js_unos
+  aging :on | :off  
+  end;
+  
+  def prompt() ; ">> " ; end
+  
+  sleep(1)
+  ue=nil
+
+  def eval_cmd(cmd,binding)
+    s = eval(cmd,binding)
+    print "=> #{s.inspect}" if s
+    puts
+  rescue SyntaxError, NameError => e
+    puts "% syntax error\n"
+  rescue => e
+    puts "% error: #{e}\n"
+  end
+  
+  def aging(arg)
+     OSPFv2::Lsa::LsAge.aging arg
+  end
+
+  loop do
+    print prompt() ; $stdout.flush
+    cmd = STDIN.gets
+    break unless cmd
+    next if cmd.size == 0
+    ary = cmd.downcase.split(' ')
+    case ary[0]
+    when 'start' ; aging :on ; neighbor.start      
+    when 'stop'  ; neighbor.stop
+    when 'help', '?'
+      print help
+    when nil
+    when /^(exit|quit|x|q|fin|end)$/  ; exit
+    else
+      eval_cmd cmd, binding()
+    end
+  end
+
+end
+
+cli.join
+
+exit

data/lib/ie/au_type.rb

@@ -0,0 +1,79 @@
+#--
+# 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 Null authentication 1 Simple password 2 Cryptographic authentication
+module OSPFv2
+class AuType
+  def initialize(au_type=0)
+    @au_type=0
+    case au_type
+    when :null, 0            ; @au_type = 0
+    when :simple_password, 1 ; @au_type = 1
+    when :cryptographic, 2   ; @au_type = 2
+    else
+      @au_type = au_type if au_type.is_a?(Integer)
+    end
+  end
+
+  def to_hash
+    to_sym
+  end
+  
+  def to_i
+    @au_type
+  end
+  
+  def to_s
+    self.class.to_s.split('::').last + ": #{au_to_s}"
+  end
+  
+  def to_sym
+    case @au_type
+    when 2  ; :cryptographic
+    when 1  ; :simple_password
+    when 0  ; :null
+    else
+      :undefined?
+    end
+  end
+
+  def encode
+    [@au_type].pack('n')
+  end
+  alias :enc  :encode
+  
+  private
+
+  def au_to_s
+    case @au_type
+    when 0 ; 'null authentication'
+    when 1 ; 'simple password'
+    when 2 ; 'cryptographic authentication'
+    else
+      'unknown'
+    end
+  end
+  
+
+end
+end

data/lib/ie/external_route.rb

@@ -0,0 +1,181 @@
+#--
+# 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/>.
+#++
+
+#
+# (RFC 2328)
+#
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |E|     0       |                  metric                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                      Forwarding address                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                      External Route Tag                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#
+#
+# 
+# (RFC 4915)
+# 
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                         Network Mask                          |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |E|     0       |                  metric                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                      Forwarding address                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                      External Route Tag                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |E|    MT-ID    |              MT-ID  metric                    |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                      Forwarding address                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                      External Route Tag                       |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#         |                              ...                              |
+#         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#
+require 'infra/ospf_common'
+require 'ie/metric'
+require 'ie/tos_metric'
+require 'ie/id'
+
+
+module OSPFv2
+  
+  class ExternalRoute_Base
+    include Common
+
+    ForwardingAddress = Class.new(OSPFv2::Id)
+    
+    attr_reader  :metric, :type, :forwarding_address, :tag, :mt_id
+    attr_checked :metric do |x|
+      (0..0xffffff).include?(x)
+    end
+    attr_checked :type do |x|
+      [:e1,:e2].include?(x)
+    end
+    attr_checked :tag do |x|
+      (0..0xffffffff).include?(x)
+    end
+    attr_checked :mt_id do |x|
+      (0..0x7f).include?(x)
+    end
+    
+    attr_writer_delegate :forwarding_address
+    
+    def initialize(arg={})
+      arg = arg.dup
+      self.metric=0
+      self.type=:e1
+      self.tag=0
+      self.mt_id=0
+      if arg.is_a?(Hash)
+        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
+    
+    def encode
+      external =[]
+      external << encoded_e_id_metric
+      external << forwarding_address.encode
+      external << [tag].pack('N')
+      external.join
+    end
+    
+    def parse(s)
+      long1, long2, @tag = s.unpack('NNN')
+      @type, @mt_id, @metric = parse_e_id_metric(long1)
+      @forwarding_address = ForwardingAddress.new(long2)
+    end
+    
+    def to_s
+      "#{type.to_s.upcase} (ID #{mt_id}) Metric: #{metric.to_i} Forwarding: #{forwarding_address.to_ip} Tag: #{tag}"
+    end
+   
+    private
+    
+    def encoded_e_id_metric
+      long = 0
+      long = 0x80000000 if type== :e2
+      long |= (mt_id << 24)
+      long |= metric.to_i
+      [long].pack('N')
+    end
+    
+    def parse_e_id_metric(long)
+      type = :e1
+      type = :e2 if (long >> 31) > 0
+      metric = long & 0xffffff
+      _id = long >> 24 & 0x7f
+      [type,_id,metric]
+    end
+    
+    def metric_to_s
+      "Metric: #{metric}"
+    end
+    
+  end
+  
+  class ExternalRoute < ExternalRoute_Base
+    def initialize(arg={})
+      if arg.is_a?(Hash)
+        @forwarding_address = ForwardingAddress.new
+        raise ArgumentError, "ID should be 0" if arg[:id] and arg[:mt_id]>0
+      end
+      super
+    end
+    def to_hash
+      h = super
+      h.delete(:mt_id)
+      h
+    end
+    
+  end
+
+  class MtExternalRoute < ExternalRoute_Base
+    def initialize(arg={})
+      if arg.is_a?(Hash)
+        @forwarding_address = ForwardingAddress.new
+        raise ArgumentError, "MT-ID not set!" unless arg[:mt_id]
+        raise ArgumentError, "MT-ID should not be 0!" if arg[:mt_id]==0
+      end
+      super
+    end
+  end
+  
+  def ExternalRoute_Base.new_hash(h)
+    if h[:mt_metrics]
+      MtExternalRoute.new(h)
+    else
+      ExternalRoute.new(h)
+    end
+  end
+  
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/id.rb

@@ -0,0 +1,97 @@
+#--
+# 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 'ipaddr'
+require 'infra/ospf_common'
+
+module OSPFv2
+class Id
+
+  def self.new_ntoh(s)
+    return unless s.is_a?(String)
+    new s.unpack('N')[0]
+  end
+
+  def self.to_i(id)
+    return id.to_i unless id.is_a?(String) and id.split('.').size==4
+    IPAddr.new(id).to_i
+  end
+
+  def initialize(arg=0)
+    self.id = arg
+  end
+  
+  def id=(val)
+    if val.is_a?(Hash)
+      @id = val[:id] if val[:id]
+    elsif val.is_a?(IPAddr)
+      @id = val.to_i
+    elsif val.is_a?(Integer)
+      raise ArgumentError, "Invalid Argument #{val}" unless (0..0xffffffff).include?(val)
+      @id = val
+    elsif val.is_a?(String)
+      @id = IPAddr.new(val).to_i
+    elsif val.is_a?(Id)
+      @id = val.to_i
+    else
+      raise ArgumentError, "Invalid Argument #{val.inspect}"
+    end
+  end
+  
+  def encode
+    [@id].pack('N')
+  end
+  alias :enc  :encode
+
+  def to_i
+    @id
+  end
+  
+  def to_s(verbose=true)
+    verbose ? to_s_verbose : to_s_short
+  end
+  
+  def to_hash
+    to_s_short
+  end
+
+  def to_ip
+    to_s(false)
+  end
+  
+  private
+  
+  def to_s_short
+    IPAddr.new_ntoh([@id].pack('N')).to_s
+  end
+  
+  def to_s_verbose
+    self.class.to_s.split('::').last + ": " + to_s_short
+  end
+  
+end
+
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+

data/lib/ie/interface_mtu.rb

@@ -0,0 +1,64 @@
+#--
+# 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 'infra/ospf_constants'
+
+module OSPFv2
+
+class InterfaceMtu
+  include Common
+  
+  attr_checked :interface_mtu do |x|
+    (0..0xffff).include?(x)
+  end
+  
+  def initialize(interface_mtu=1500)
+    self.interface_mtu=interface_mtu
+  end
+  
+  def to_i
+    interface_mtu
+  end
+  
+  def number_of_lsa
+    @noh ||= ((to_i - OSPFv2::PACKET_HEADER_LEN) / OSPFv2::LSA_HEADER_LEN) - 1
+  end
+  alias :n0flsa :number_of_lsa
+  
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_i}"
+  end
+  
+  def encode(fmt='n')
+    [interface_mtu].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/ls_age.rb

@@ -0,0 +1,89 @@
+#--
+# 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 LsAge
+  include Comparable
+  
+  class << self
+    def aging(state=:off)
+      case state
+      when :on   ; @aging = true
+      when :off  ; @aging = false
+      else
+        raise ArgumentError, "Invalid Argument"
+      end
+    end
+    def aging?
+      @aging
+    end
+  end
+  
+  def initialize(age=0)
+    raise ArgumentError, "Invalid Argument #{age}" unless age.is_a?(Integer)
+    @age=age
+    @time = Time.now
+  end
+  
+  def to_i
+    aging? ? (Time.new - @time + @age).to_int : @age
+  end
+  
+  def aging?
+    self.class.aging?
+  end
+  
+  def maxage
+    @age = OSPFv2::MaxAge
+  end
+  
+  def maxaged?
+    to_i >= OSPFv2::MaxAge
+  end
+  
+  def <=>(obj)
+    to_i <=> obj.to_i
+  end
+  
+  def -(obj)
+    to_i - obj.to_i
+  end
+  
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_i}"
+  end
+  
+  def encode
+    [@age].pack('n')
+  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