ospfv2 0.0.1

data/lib/infra/ospf_common.rb

@@ -0,0 +1,291 @@
+#--
+# 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'
+
+class Class
+  def attr_checked(attribute, &validation)
+    define_method "#{attribute}=" do |val|
+      raise "Invalid attribute #{val.inspect}" unless validation.call(val)
+      instance_variable_set("@#{attribute}", val)
+    end
+    define_method attribute do
+      instance_variable_get "@#{attribute}"
+    end
+  end
+  def attr_writer_delegate(*args)
+    # p self
+    args.each do |name|
+      define_method "#{name}=" do |value|
+        # p "in method..", self.class
+        instance_variable_set("@#{name}", 
+                self.class.const_get(name.to_s.to_camel.to_sym).new(value))
+      end
+    end
+  end
+end
+
+class String
+  
+  def to_underscore
+    gsub(/([A-Z]+|[A-Z][a-z])/) {|x| ' ' + x }.gsub(/[A-Z][a-z]+/) {|x| ' ' + x }.split.collect{|x| x.downcase}.join('_')
+  end
+  
+  def to_camel
+    split('_').collect {|x| x.capitalize}.join
+  end
+  
+  def hexlify
+    l,n,ls,s=0,0,[''],self.dup
+    while s.size>0
+      l = s.slice!(0,16)
+      ls << format("0x%4.4x:  %s", n, l.unpack("n#{l.size/2}").collect { |x| format("%4.4x",x) }.join(' '))
+      n+=1
+    end
+    if l.size%2 >0
+      ns = if l.size>1 then 1 else 0 end
+      ls.last << format("%s%2.2x",' '*ns,l[-1])
+    end
+    ls
+  end
+  
+end
+
+class Symbol
+  def to_klass
+    to_s.to_camel.to_sym
+  end
+  def to_setter
+    (to_s + "=").to_sym
+  end
+end
+
+
+class Object
+  def to_shex(*args)
+    self.respond_to?(:encode) ? self.encode(*args).unpack('H*')[0] : ""
+  end
+  def to_shex_len(len, *args)
+    s = to_shex(*args)
+    "#{s[0..len]}#{s.size>len ? '...' : ''}"
+  end
+  def to_shex4_len(len, *args)
+    s = to_shex4(*args)
+    "#{s[0..len]}#{s.size>len ? '...' : ''}"
+  end
+  def to_bitstring
+    if self.respond_to?(:encode)
+      self.enc.unpack('B*')[0]
+    else
+      ""
+    end
+  end
+  def method_missing(method, *args, &block)
+    # puts "COMMON method_missing: #{method}"
+  
+    if method.to_s =~ /^to_s(\d+)/
+      to_s($1.to_i)
+    else
+      # p caller
+      super
+    end
+  end
+  def define_to_s
+    if defined?($style)
+      self.class.class_eval { eval("alias :to_s :to_s_#{$style}") }
+    elsif respond_to?(:to_s_default)
+      self.class.class_eval { alias :to_s :to_s_default }
+    else
+      puts "You're screwed!"
+    end      
+  end
+end
+
+class Time
+  class << self
+    def to_ts
+      Time.now.strftime("%M:%S")
+    end
+  end
+end
+
+class IPAddr
+  alias encode hton
+
+  def self.create(arg)
+    if arg.is_a?(String) and arg.is_packed?
+      IPAddr.new_ntoh(arg)
+    elsif arg.is_a?(Integer)
+      IPAddr.new_ntoh([arg].pack('N'))
+    elsif arg.is_a?(Array) and arg[0].is_a?(Fixnum)
+      IPAddr.new_ntoh([arg].pack('C*'))
+    elsif arg.is_a?(self)
+      IPAddr.new
+    else
+      IPAddr.new(arg)
+    end
+  end
+
+  def mlen
+    @_jme_mlen_ ||= _mlen_
+  end
+
+  def +(i)
+    [IPAddr.create(to_i + i).to_s, mlen].join("/")
+  end
+  def ^(i)
+    @increment ||= _generate_network_inc_
+    [IPAddr.create(to_i + @increment.call(i)).to_s, mlen].join("/")
+  end
+
+  def netmask
+    if ipv4?
+      [@mask_addr].pack('N').unpack('C4').collect { |x| x.to_s}.join('.')
+    else
+      i = @mask_addr
+      arr=[]
+      while i>0 
+        arr <<  (i & 0xffff) and i >>= 16
+      end
+      arr.reverse.collect { |x| x.to_s(16) }.join(':')
+    end
+  end
+  
+  def to_s_net
+    [to_s,mlen].join('/')
+  end
+    
+  def IPAddr.to_ary(prefix)
+    source_address,mlen = prefix.split('/')
+    ip = IPAddr.new(prefix)
+    network = ip.to_s
+    [ip, source_address, mlen.to_i, network, ip.netmask]
+  end
+
+  private
+  
+  def _mlen_
+    m = @mask_addr
+    len =  ipv6? ? 128 : 32
+    loop do
+      break if m & 1 > 0
+      m = m >> 1
+      len += -1
+    end
+    len
+  end
+
+  def _generate_network_inc_
+    max_len =  ipv4? ? 32 : 128
+    Proc.new { |n| n*(2**(max_len - mlen)) }
+  end
+  
+
+
+end
+
+
+module OSPFv2
+  module Common
+    
+    def ivar_to_klassname(ivar)
+      ivar.to_s.to_camel.to_sym
+    end
+    
+    def set(h)
+      # p "\n\n\n#{self.class}: IN SET(): ivars; #{ivars.inspect} - h: #{h.inspect}:"
+      for key in [ivars].flatten
+        # p key
+        if h.has_key?(key) and ! h[key].nil?
+          # puts "  h has key #{key}"
+          begin
+            klassname = key.to_klass
+            if self.class.const_defined?(klassname)
+              # puts "    class #{klassname} exists! => set @#{key.to_s} = #{klassname}.new(#{h[key]})"
+              instance_variable_set("@#{key.to_s}", self.class.const_get(klassname).new(h[key]))
+            elsif OSPFv2.const_defined?(klassname)
+              # puts "    class OSPFv2::#{klassname} exists! => set @#{key.to_s} = #{klassname}.new(#{h[key]})"
+              instance_variable_set("@#{key.to_s}", OSPFv2.const_get(klassname).new(h[key]))
+            # elsif OSPFv2::LSDB::const_defined?(klassname)
+            #   # puts "    class OSPFv2::LSDB::#{klassname} exists! => set @#{key.to_s} = #{klassname}.new(#{h[key]})"
+            #   instance_variable_set("@#{key.to_s}", OSPFv2::LSDB::const_get(klassname).new(h[key]))
+            elsif self.respond_to?(key.to_setter)
+              # puts "    self respond to #{key.to_setter} => self.__send__ #{key.to_setter}, #{h[key]}"
+              self.send key.to_setter, h[key]
+            #elsif  has an instance variable of that name ? 
+            #or create ivar on the fly ?
+            else
+              # puts "    just set ivar: @#{key} = #{h[key]}"
+              instance_variable_set("@#{key.to_s}", h[key])
+            end
+          rescue ArgumentError => e
+            raise
+            # 
+            # #FIXME: attr_writer_delegate generate a NameError (in link_state_database)
+            # p "WE HAVE A NAME ERROR: #{e.inspect}"
+            # # instance_variable_set("@#{key.to_s}", h[key])
+          ensure
+            h.delete(key)
+          end
+        else
+          # puts "did not find #{key} in #{h.inspect}"
+        end
+      end
+    end
+
+    def to_hash
+      h = {}
+      for key in [ivars].flatten
+        ivar = instance_variable_get("@#{key.to_s}")
+        if ivar.respond_to?(:to_hash)
+          # p "#{key} respond to hash"
+          # p ivar
+          # p "#{key} --"
+          # p ivar
+          h.store(key,ivar.to_hash)
+        elsif ivar.is_a?(Array)
+          h.store(key, ivar.collect { |x| x.to_hash })
+        else
+          # p "#{key} don't respond to hast"
+          # p ivar
+          # p ivar.class
+          # p "#{key} --"
+          #FIXME: ivar.to_s ? ivar.value ? ivar.hash_value ? 
+          h.store(key,ivar) unless ivar.nil?
+        end
+      end
+      h
+    end
+  end
+
+  module Common
+   
+    def ivars
+      instance_variables.reject { |x| x =~ /^@_/ }.collect { |x| x[1..-1].to_sym }
+    end
+    
+  end
+  
+end
+
+load "../../../test/ospfv2/infra/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/infra/ospf_constants.rb

@@ -0,0 +1,73 @@
+#--
+# 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
+
+  module Constant
+     V2=2
+     V3=3
+     HELLO = 1
+     DATABASE_DESCRIPTION = 2
+     LINK_STATE_REQUEST = 3
+     LINK_STATE_UPDATE = 4
+     LINK_STATE_ACKNOWLEDGEMENT = 5
+   end
+
+  VERSION=2
+  LSRefreshTime = 30*60 
+  MinLSInterval = 5
+  MinLSArrival = 1
+  MaxAge = 3600
+  CheckAge = 5*60
+  MaxAgeDiff = 15*60
+  LSInfinity = 0xffffffff
+  DefaultDestination = "0.0.0.0"
+  N = 0x80000000
+  InitialSequenceNumber = N + 1
+  MaxSequenceNumber = N - 1
+
+  ROUTER_LINK_P2P = 1
+  ROUTER_LINK_TRANSIT = 2
+  ROUTER_LINK_STUB = 3
+  ROUTER_LINK_VL = 4
+
+  ROUTER_LSA = 1
+  NETWORK_LSA = 2
+  SUMMARY_LSA = 3
+  ASBR_SUMMMARY_LSA = 4
+  EXTERNAL_LSA = 5
+  NSSA_LSA = 7
+
+  IPPROTO_OSPF = 89
+  AllSPFRouters = "224.0.0.5"
+  AllDRouters = "224.0.0.6"
+
+  EXTERNAL_BASE_ADDRESS='50.0.0.0/24'
+  SUMMARY_BASE_ADDRESS='30.0.0.0/24'
+  NETWORK_BASE_ADDRESS='20.0.0.0/24'
+  LINK_BASE_ADDRESS='13.0.0.0/30'
+  
+  PACKET_HEADER_LEN = 24
+  LSA_HEADER_LEN = 20
+  
+  
+end

data/lib/infra/ospf_io.rb

@@ -0,0 +1,133 @@
+#--
+# 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 'observer'
+require 'thread'
+
+module OSPFv2
+
+  class Input
+    include Observable
+
+    attr_reader :sock
+
+    def initialize(sock, neighbor, ev_handler)
+      super()
+      @sock=sock
+      @neighbor=neighbor
+      add_observer(ev_handler)
+      @continue=true
+    end
+
+    attr_reader :thread
+    
+    def our_address
+      @neighbor.address
+    end
+
+    def stop
+      @thread.exit
+      @thread.join
+    rescue
+    end
+
+    def start
+      @thread = Thread.new(@sock) do |s|
+        Thread.current['name'] = self.class.to_s
+        begin
+          while @continue
+            from, port, data = s.recv
+            hdr = header(data)
+            if hdr[:ip_proto] == 89 and data[20] == 2
+              if from != our_address
+                changed and notify_observers(:ev_recv, data, from, port) # * @sock.recv ....
+              end
+            end
+          end
+        rescue Exception => e
+          p e
+        end
+      end
+    end
+
+    private
+    
+
+    def long2ip(ip)
+      return ip if ip.is_a?(String)
+      [ip].pack('N').unpack('CCCC').collect {|c| c}.join('.') 
+    end
+    def header(_h)
+      h = _h.unpack('CCnnnCCnNN')
+      {
+        :ip_ver  => h[0] >> 4,
+        :ip_hlen => (h[0] & 0xf) <<2,
+        :ip_tos  => h[1],
+        :ip_length => h[2],
+        :ip_id  => h[3],
+        :ip_offset => h[4],
+        :ip_ttl  => h[5],
+        :ip_proto => h[6],
+        :ip_csum => h[7],
+        :ip_src  => long2ip(h[8]),
+        :ip_dst  => long2ip(h[9]),
+      }
+    end
+    
+  end
+
+  class OutputQ < Queue
+    include Observable
+
+    def initialize(sock, *obs)
+      super()
+      @sock= sock
+      obs.each { |o| self.add_observer(o) }
+      @continue = true
+    end
+
+    attr_reader :thread
+
+    def stop
+      @thread.exit
+      @thread.join
+    rescue
+    end
+
+    def start
+      @thread = Thread.new(@sock) do |s|
+        Thread.current['name'] = self.class.to_s
+        begin
+          while @continue 
+            el = deq
+            @sock.send *el
+          end
+        rescue => e
+          p e
+        end
+      end
+    end
+  end
+
+end
+

data/lib/infra/ospf_socket.rb

@@ -0,0 +1,126 @@
+#--
+# 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 'socket'
+require 'ipaddr'
+require 'infra/ospf_constants'
+
+module OSPFv2
+
+  class SendSocket
+    
+    attr_reader :sock
+    
+    def initialize(src, options={})
+      @src = src
+      @sock = Socket.open(Socket::PF_INET, Socket::SOCK_RAW, IPPROTO_OSPF)
+      add_membership OSPFv2::AllSPFRouters
+      add_membership OSPFv2::AllDRouters
+    rescue Errno::EPERM
+      $stderr.puts "#{e}: You are not root, cannot run: #{$0}!"
+      exit(1)
+    rescue Errno::EADDRNOTAVAIL
+      STDERR.puts "TODO: check if 127/8 and exit if not."
+      # for testing with 127/8
+    rescue Exception => e
+      STDERR.puts "#{e} Cannot Open Socket!"
+      exit(1)
+    end
+    
+    #TODO: use all_spf_routers, all_dr_routers, ...
+    #     8.1      Sending protocol packets .............................. 58
+    
+    def send(packet, location={:to=> :all_spf_routers})
+      case location
+      when :all_spf_routers ; send_all_spf_routers(packet)
+      when :all_dr_routers  ; send_all_dr_routers(packet)
+      else
+        send_to(packet, location[:to])
+      end
+    end
+    
+    def send_all_spf_routers
+      _send_ (packet.respond_to?(:encode) ? packet.encode : packet), 0, @sock_addr_all_spf_routers
+    end
+    
+    def send_all_dr_routers
+      _send_ (packet.respond_to?(:encode) ? packet.encode : packet), 0, @send_all_dr_routers
+    end
+    
+    def send_to(packet, dest)
+      _send_ (packet.respond_to?(:encode) ? packet.encode : packet), 0, Socket.pack_sockaddr_in(0, dest)
+    end
+    
+    def send(packet, dest)
+      addr = Socket.pack_sockaddr_in(0, dest)
+      @sock.send((packet.respond_to?(:encode) ? packet.encode : packet),0,addr)
+    end
+    
+    def close
+      @sock.close unless @sock.closed?
+    end
+    
+    private
+    
+    def add_membership(group)
+      @sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, (IPAddr.new(group).hton + IPAddr.new(@src).hton))
+      puts "*** ADDED #{group} membership to Send Socket ***"
+    rescue Errno::EADDRNOTAVAIL
+    end
+
+    def _send_(bits, sock_addr)
+      @sock.send(bits,0,addr)
+    end
+  end
+  
+  class RecvSocket
+    require 'socket'
+    require 'ipaddr'
+    attr_reader :sock
+    def initialize(src, options={})
+      @src=src
+      @sock = Socket.open(Socket::PF_INET, Socket::SOCK_RAW,89)
+      add_membership OSPFv2::AllSPFRouters
+      add_membership OSPFv2::AllDRouters
+    end
+    def recv(size=8192)
+      begin
+        data, sender = @sock.recvfrom(size)
+        port, host = Socket.unpack_sockaddr_in(sender)
+        [host,port,data]
+      rescue => e
+        STDERR.puts "RSocket recv() error: #{e}"
+      end
+    end
+    def close
+      begin ; @sock.close ; rescue ; end
+      @sock=nil
+    end
+    def add_membership(group)
+      @sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, (IPAddr.new(group).hton + IPAddr.new(@src).hton))
+      puts "*** ADDED #{group} membership to Recv Socket ***"
+    rescue Errno::EADDRNOTAVAIL
+    end
+  end
+
+end