ospfv2 0.0.2 → 0.0.3

data/LICENSE.txt

@@ -0,0 +1,53 @@
+OSPFv2 is copyrighted free software by Jean-Michel Esnault.  
+
+You can redistribute it and/or modify it under either the terms of the GPL 
+(see the COPYING file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+          with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README

@@ -0,0 +1,50 @@
+Supported LSA:
+  Router, Network, Summary, AsbrSummary, AsExternal
+
+TODO: NSSA, TE, LLC
+
+Supported Ospf Packets:
+
+  Link State Update
+  Link State Request
+  Link State Ack
+  Database Description
+  Hello
+
+Supported RouterType: 
+
+  Intra-area
+  ABR   -> generate Summary and set B bit
+  ASBR  -> generate AsExternal and set E bit
+
+Network Types Supported
+  Broadcast (DROTHER)
+  point-to-point
+
+Authentication:
+ no auth
+TODO: MD5, Password
+
+Learned LSA Functionality
+
+   display of the Link State Database
+       summary
+       detailed  
+
+Scalability:
+
+  calculate large Area: 
+     A Grid 50x50 Intra-area routers
+     Summary x N
+     AsExternal x N
+
+Automation:
+  
+  Using ruby language and the set of OSPF ruby classes provided by this library
+  All OSPF constructs can be described in simple ruby statements
+
+
+RFCs:
+
+ RFC 2328
+ RFC 4915

data/bin/ospfv2

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
+require 'timeout'
 
-raise "Not working with 1.9, use ruby 1.8.7"  if RUBY_VERSION.split('.')[0..1].join > '18'
+if Object.const_defined? :Encoding
+  Encoding.default_internal="BINARY"
+  Encoding.default_external="BINARY"
+end
 
 require 'neighbor/neighbor'
 require 'packet/ospf_packet'
@@ -11,123 +15,126 @@ require 'pp'
 
 include OSPFv2
 
-Thread.current["name"]  = "#{self}"
+# Parse command line
+begin
+  options = OptParse.parse(ARGV)
+rescue OptionParser::InvalidOption => e
+  STDERR.puts e.to_s.gsub(/at\s*$/,'')
+  exit(1)
+end
 
-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
+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  }
+#  Up all links
+LSDB::Link.all.each { |id,lnk| ls_db.link lnk, :up  }
 
+
+rlsa = Router.new :ls_id=> options.router_id, :advertising_router=>options.router_id, :options=>0x22
+if options.network_type == :broadcast
+  # 
+  # o   If the state of the interface is Waiting, add a Type
+  #     3 link (stub network) with Link ID set to the IP
+  #     network number of the attached network, Link Data
+  #     set to the attached network's address mask, and cost
+  #     equal to the interface's configured output cost.
+  # 
+  # o   Else, there has been a Designated Router elected for
+  #     the attached network.  If the router is fully
+  #     adjacent to the Designated Router, or if the router
+  #     itself is Designated Router and is fully adjacent to
+  #     at least one other router, add a single Type 2 link
+  #     (transit network) with Link ID set to the IP
+  #     interface address of the attached network's
+  #     Designated Router (which may be the router itself),
+  #     Link Data set to the router's own IP interface
+  #     address, and cost equal to the interface's
+  #     configured output cost.  Otherwise, add a link as if
+  #     the interface state were Waiting (see above).
+  # 
+  # 
+  rlsa << RouterLink.new_stub_network(:link_id=>options.network, :link_data=>options.netmask, :metric=>20)
+
+else
+  # Assume p2p:
+  #   add p2p link and a stub link
+  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)
+  rlsa << RouterLink.new_stub_network(:link_id=>'0.0.0.0', :link_data=>'0.0.0.0', :metric=>1)
   
-  # 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)
+end
+
+# 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)
+
+unless options.grid == [0,0]
   # add a  a p2p link between router_id and rid1
-  ls_db.new_link :router_id=> options.router_id, :neighbor_id=>rid1
+  ls_db.new_link :router_id=> options.router_id, :neighbor_id=>rid1 
+end
 
-  # Link.all.values.each { |lnk| @ls_db.link lnk, :down  }
-  
-  # Add some Summary LSAs
+
+# Add some Summary LSAs
+if options.num_sum>0
   [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
-  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
-  
-  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' ; 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
 
+# Add some External LSAs
+ls_db.find_router_lsa(rid3).set_asbr if options.num_ext>0
+options.num_ext.times do
+  ls_db << OSPFv2::AsExternal.new_lsdb(:advertising_router=> rid3,
+  :mt_metrics=>[{:mt_id=>10, :metric=>20,:tag=>10}])
 end
 
-cli.join
 
-exit
+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
+
+ls_db.ls_refresh_time= options.ls_refresh_time
+ls_db.ls_refresh_interval=options.ls_refresh_interval
+
+def ls_db.aging(arg=nil)
+  Lsa::LsAge.aging(arg)
+  all.collect { |l| l.ls_age.to_i }
+  aging?
+end
+def ls_db.aging?
+  Lsa::LsAge.aging? ? :on : :off
+end
+def ls_db.age_reset(age=nil)
+  all.each  { |l| l.ls_age.reset(age) }
+  ''
+end
+
+case options.console
+when :pry
+  require 'pry'
+  binding.pry
+when :irb
+  require 'irb'
+  puts "*** cb $binding ***"
+  puts "Once in irb> enter \"cb $binding\" to access local variables: ls_db, neighbor, options"
+  puts "Use ls_db object to access generated link state database."
+  puts "Use neighbor object to start or stop ospfv2 neighboring."
+  puts ""
+  $binding = binding
+  IRB.start(__FILE__)
+else
+  ls_db.aging(:on); neighbor.start
+  sleep 30_000
+end
+

data/changelog.txt

@@ -1,3 +1,10 @@
+=== 0.0.3
+
+* Opaque LSA
+  + Traffic Engineering TLVs
+
+
+
 === 0.0.2 Fri Apr 15 18:22:26 PDT 2011
 
 * Work with Cisco Routers that enable LLS by default

data/gemspec

@@ -0,0 +1,17 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "ospfv2"
+  spec.date          = "2014-10-17"
+  spec.version       = "0.0.3"
+  spec.author        = "Jean Michel Esnault"
+  spec.email         = "ospfv2@esnault.org"
+  spec.summary       = "Playing with OSPF version 2 using ruby."
+  spec.description   = "Playing with OSPF version 2 using ruby."
+  spec.homepage      =  "https://github.com/jesnault/ospfv2"
+  spec.files         =  `git ls-files -z`.split("\x0")
+  spec.rdoc_options  = ["--quiet", "--title", "ospfv2", "--line-numbers"]
+  spec.require_paths = ["lib"]
+  spec.bindir = 'bin'
+  spec.executables   = ['ospfv2']
+  spec.extra_rdoc_files = ["LICENSE.txt","README"]
+end

data/lib/ie/external_route.rb

@@ -118,6 +118,15 @@ module OSPFv2
     def to_s
       "#{type.to_s.upcase} (ID #{mt_id}) Metric: #{metric.to_i} Forwarding: #{forwarding_address.to_ip} Tag: #{tag}"
     end
+    
+    def to_s_ios
+      #       Metric Type: 1 (Comparable directly to link state metric)
+      #       TOS: 0 
+      #       Metric: 0 
+      #       Forward Address: 0.0.0.0
+      #       External Route Tag: 0
+      #TODO: implement...
+    end
    
     private
     

data/lib/ie/id.rb

@@ -22,10 +22,12 @@
 
 
 require 'ipaddr'
-require 'infra/ospf_common'
+require_relative '../infra/ospf_common'
+require_relative 'ie'
 
 module OSPFv2
 class Id
+  include IE
 
   def self.new_ntoh(s)
     return unless s.is_a?(String)
@@ -92,6 +94,3 @@ class Id
 end
 
 end
-
-load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
-

data/lib/ie/ie.rb

@@ -0,0 +1,12 @@
+module OSPFv2
+  module IE
+    def method_missing(name, *args, &block)
+      if name.to_s =~ /^to_s_(ios|junos)$/
+        __send__ :to_s, *args, &block
+      else
+        p "#{name} is missing...."
+        raise
+      end
+    end
+  end
+end

data/lib/ie/ls_age.rb

@@ -20,24 +20,51 @@
 # along with OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
 #++
 
-require 'infra/ospf_constants'
+require_relative  '../infra/ospf_constants'
 
 module OSPFv2
 class LsAge
+  
+  class << self
+    attr_accessor :_aging
+    def aging?
+      _aging
+    end
+    def aging(arg=nil)
+      if arg
+        case arg
+        when :on  ; self._aging = true
+        when :off ; self._aging = false
+        end
+      else
+        self._aging = ! _aging
+      end
+    end
+  end
+  
   include Comparable
   
   def initialize(age=0)
     @age=age
-    @time = Time.now
     raise ArgumentError, "Invalid Argument #{age}" unless age.is_a?(Integer)
   end
   
   def to_i
-    aging? ? (Time.new - @time + @age).to_int : @age
+    if aging?
+      @time ||= Time.now
+      (Time.new - @time + @age).to_int
+    else
+      @age
+    end
+  end
+  
+  def reset(age=nil)
+    @age = age if age
+    @time=nil
   end
   
   def aging?
-    true
+    self.class.aging?
   end
   
   def maxage
@@ -60,6 +87,10 @@ class LsAge
     self.class.to_s.split('::').last + ": #{to_i}"
   end
   
+  def to_s_ios
+    "LS age: #{to_i}"
+  end
+  
   def encode
     [@age].pack('n')
   end
@@ -72,4 +103,3 @@ class LsAge
 end
 end
 
-load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0