jesnault-bgp4r 0.0.2 → 0.0.3

data/bgp/common.rb

@@ -0,0 +1,204 @@
+#    This file is part of BGP4R.
+#
+#    BGP4R 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.
+#
+#    BGP4R 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'ipaddr'
+require 'logger'
+
+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*'))
+    else
+      IPAddr.new(arg)
+    end
+  end
+
+  #TODO: if not used, get rid of it.
+  def self.new_nlri4(arg)
+    if arg.is_a?(String) and arg.is_packed?
+      arg +=([0]*3).pack('C*')
+      plen, *nlri = arg.unpack('CC4')
+      ipaddr = nlri.collect { |n| n.to_s }.join('.') + "/" + plen .to_s
+      IPAddr.new(ipaddr)
+    else
+      IPAddr.new(arg)
+    end
+  end
+
+  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 mlen
+    @_jme_mlen_ ||= _mlen_
+  end
+
+  def _generate_network_inc_
+    max_len =  ipv4? ? 32 : 128
+    Proc.new { |n| n*(2**(max_len - 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
+  private :_generate_network_inc_
+
+  def netmask
+    if ipv4?
+      [@mask_addr].pack('N').unpack('C4').collect { |x| x.to_s}.join('.')
+    else
+      #TODO netmask ipv6
+      @mask_addr
+    end
+  end
+
+end
+
+
+class Object
+  def to_shex(*args)
+    self.respond_to?(:encode) ? self.encode(*args).unpack('H*')[0] : ""
+  end
+  alias to_s_hexlify to_shex
+  def to_shex4(*args)
+    self.respond_to?(:encode4) ? self.encode4(*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
+end
+
+class Array
+  alias_method :old_pack, :pack
+  def pack(*args)
+    s = self.old_pack(*args)
+    s.instance_eval { @__is_packed__ = true }
+    s
+  end
+end
+
+class String
+  def is_packed?
+    defined?(@__is_packed__) and @__is_packed__
+  end
+  def is_packed
+     @__is_packed__ = true 
+     self
+  end
+  alias packed? :is_packed?
+  
+  def hexlify
+    return self unless is_packed?
+    s=self.dup
+    ls=[""]
+    n=0
+    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
+    ls
+  end
+  
+end
+
+class Log  < Logger
+  private_class_method :new 
+  @@logger = nil
+  def initialize(s)
+    super(s)
+    @@time=Time.now
+    self.datetime_format = "%M:%S"
+    self.level = Logger::INFO
+  end 
+  def Log.time_reset
+    @time = Time.now
+  end
+  def Log.create(s=STDERR)
+    @@logger ||= new(s)
+  end
+  def Log.set_filename(s)
+    @@logger = new(s)
+  end 
+  def Log.level=(level)
+    return unless (0..4) === level
+    @@logger.level=(level)
+  end 
+  def Log.level
+    case @@logger.level
+    when Logger::INFO ;  "(#{Logger::INFO }) 'INFO'"
+    when Logger::DEBUG ; "(#{Logger::DEBUG }) 'DEBUG'"
+    when Logger::WARN ;  "(#{Logger::WARN }) 'WARN'"
+    when Logger::ERROR ; "(#{Logger::ERROR }) 'ERROR'"
+    when Logger::FATAL ; "(#{Logger::FATAL }) 'FATAL'"
+    end
+  end
+  def Log.clear
+    `rm #{Log.filename}`
+    Log.set_filename(Log.filename)
+  end
+  def Log.filename
+    @@logger.instance_eval { @logdev.filename }
+  end
+  def Log.start(*arg)
+    Log.create(*arg)
+  end 
+  def Log.info(txt)
+    @@logger.info(txt) unless @@logger.nil?
+  end
+  def Log.fatal(txt)
+    @@logger.fatal(txt) unless @@logger.nil?
+  end
+  def Log.error(txt)
+    @@logger.error(txt) unless @@logger.nil?
+  end
+  def Log.debug(txt)
+    @@logger.debug(txt) unless @@logger.nil?
+  end
+  def Log.warn(txt)
+    @@logger.warn(txt) unless @@logger.nil?
+  end
+  def Log.<<(txt)
+    elapsed = Time.now - @@time
+    @@logger << "<< #{format "%4.6f", elapsed}: #{txt}\n" unless @@logger.nil?
+  end
+  def Log.>>(txt)
+    elapsed = Time.now.to_f - @@time.to_f
+    @@logger << ">> #{format "%4.6f", elapsed}: #{txt}\n" unless @@logger.nil?
+  end
+end 
+

data/bgp/communities.rb

@@ -0,0 +1,139 @@
+#--
+# Copyright 2008, 2009 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of BGP4R.
+# 
+# BGP4R 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.
+# 
+# BGP4R 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 BGP4R.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+
+require 'bgp/attribute'
+
+
+module BGP
+
+  class Communities < Attr
+
+    class Community
+      
+      def initialize(arg)
+        if arg.is_a?(Symbol)
+          case arg
+          when :no_export      ; @value=0xFFFFFF01
+          when :no_advertise   ; @value=0xFFFFFF02
+          when :no_export_sub_confed ; @value=0xFFFFFF03
+          when :no_peer        ; @value=0xFFFFFF04
+          else
+            raise ArgumentError, "invalid argument #{val}"
+          end
+        elsif arg.is_a?(String) and arg.split(':').size==2
+          self.value=arg.split(':').collect { |n| n.to_i }.pack('n2').unpack('N')[0]
+        else
+          self.value=arg
+        end
+      end
+
+      def value=(val)
+        raise ArgumentError, "invalid argument #{val}" unless val.is_a?(Fixnum) or val.is_a?(Bignum)
+        @value=val
+      end
+
+      def to_i
+        @value
+      end
+
+      def to_s
+        [@value >> 16, @value & 0xffff].join(':')
+      end
+
+      # The community attribute values ranging from 0x0000000 through
+      # 0x0000FFFF and 0xFFFF0000 through 0xFFFFFFFF are hereby reserved.
+      def is_reserved?
+        (0x0000000..0x0000FFFF ) === @value or (0xFFFF0000..0xFFFFFFFF) === @value
+      end
+
+      def encode
+        [@value].pack('N')
+      end
+
+    end
+
+    def initialize(*args)
+      @flags, @type = OPTIONAL_TRANSITIVE, COMMUNITIES
+      if args[0].is_a?(String) and args[0].is_packed?
+        parse(args[0])
+      elsif args[0].is_a?(self.class) and args[0].respond_to?(:encode)
+        parse(args[0].encode, *args[1..-1])
+      else
+        add(*args)
+      end
+    end
+
+    def add(*args)
+      @communities ||=[]
+      args.flatten.each do |arg|
+        if arg.is_a?(String) and arg.split(' ').size>1
+          arg.split.each { |v| @communities << Community.new(v) }
+        elsif arg.is_a?(String) and arg.split(',').size>1
+          arg.split(',').each { |v| @communities << Community.new(v) }
+        elsif arg.is_a?(Community)
+          @communities << arg
+        else
+          @communities << Community.new(arg)
+        end
+      end
+    end
+    alias << add
+
+    def communities
+      @communities.collect { |comm| comm.to_s }.join(' ')
+    end
+
+    def to_s(method=:default)
+      super(communities, method)
+    end
+
+    def to_ary
+      @communities.collect { |c| c.to_i }
+    end
+
+    def encode
+      super(@communities.collect { |comm| comm.encode }.join)
+    end
+
+    def parse(s)
+      @flags, @type, len, value=super(s)
+      self << value.unpack("N#{len/4}")
+    end
+
+    def sort
+      Communities.new(to_ary.sort)
+    end
+
+    def sort!
+      @communities = @communities.sort_by { |c| c.to_i }
+      self
+    end
+
+    def <=>(other)
+      self.sort.to_shex <=> other.sort.to_shex
+    end
+
+  end
+
+end
+load "../test/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/extended_communities.rb

@@ -0,0 +1,107 @@
+#--
+# Copyright 2008, 2009 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of BGP4R.
+# 
+# BGP4R 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.
+# 
+# BGP4R 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 BGP4R.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+
+require 'bgp/attribute'
+require 'bgp/extended_community'
+
+module BGP
+
+  class Extended_communities < Attr
+
+    attr_reader :communities
+
+    def initialize(*args)
+      @flags, @type = OPTIONAL_TRANSITIVE, EXTENDED_COMMUNITY
+
+      if args[0].is_a?(String) and args[0].is_packed?
+        parse(args[0])
+      elsif args[0].is_a?(self.class)
+        parse(args[0].encode, *args[1..-1])
+      else
+        add(*args)
+      end
+    end
+
+    def add(*args)
+      @communities ||=[]
+      args.flatten.each do |arg|
+        if arg.is_a?(String) and arg.split(' ').size>1
+          arg.split.each { |v| @communities << Extended_community.factory(v) }
+        elsif arg.is_a?(String) and arg.split(',').size>1
+          arg.split(',').each { |v| @communities << Extended_community.factory(v) }
+        elsif arg.is_a?(Extended_community)
+          @communities << arg
+        else
+          @communities << Extended_community.factory(arg)
+        end
+      end
+      self
+    end
+    alias << add
+
+    def extended_communities
+      len = @communities.size*8
+      s=[]
+      s << ''
+      s << "  Carried Extended communities"
+      s <<  "     " + @communities.collect { |c| c.to_s }.join("\n     ")
+      s.join("\n")
+    end
+    
+    def to_s(method=:default)
+      super(extended_communities, method)
+    end
+
+    def to_arr
+      @communities.collect { |c| c.to_i }
+    end
+
+    def encode
+      super(@communities.collect { |comm| comm.encode }.join)
+    end
+
+    def parse(s)
+      @flags, @type, len, value=super(s)
+      while value.size>0
+        self << Extended_community.factory(value.slice!(0,8).is_packed)
+      end
+    end
+
+    def sort
+      Extended_communities.new(*to_arr.sort)
+    end
+
+    def sort!
+      @communities = @communities.sort_by { |c| c.to_i }
+      self
+    end
+
+    def <=>(other)
+      sort.to_shex <=> other.sort.to_shex
+    end
+
+  end
+
+end
+
+load "../test/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/extended_community.rb

@@ -0,0 +1,254 @@
+#--
+# Copyright 2008, 2009 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of BGP4R.
+# 
+# BGP4R 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.
+# 
+# BGP4R 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 BGP4R.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+
+require 'bgp/common'
+require 'bgp/attribute'
+
+module BGP
+
+  module ATTR::XTENDED_COMMUNITY
+
+    ROUTE_TARGET = 2
+    ROUTE_ORIGIN = 3
+    OSPF_DOMAIN_ID = 5
+    OSPF_ROUTER_ID = 7
+    BGP_DATA_COLLECT = 8
+
+    IANA_AUTHORITY_BIT = 0x8
+    NON_TRANSITIVE = 0x4    
+
+    TWO_OCTET_AS = 0
+    IPV4_ADDR = 1
+    OPAQUE = 3
+
+    def _encoded_value_
+      case @type & 3
+      when TWO_OCTET_AS
+        [@global, @local].pack('nN')
+      when IPV4_ADDR
+        [@global, @local].pack('Nn')
+      when OPAQUE
+        [@global].pack('H12')
+      else
+        raise RuntimeError, "bogus type: #{@type}"
+      end
+    end
+    
+    def encode
+      [@type, @subtype, _encoded_value_].pack('CCa6')
+    end
+    
+    def parse(s)
+      @type, @subtype = s.slice!(0,2).unpack('CC')
+      case @type & 3
+      when TWO_OCTET_AS ; @global, @local = s.unpack('nN')
+      when IPV4_ADDR
+        @global, @local = s.unpack('Nn')
+      when OPAQUE
+        @global = s.unpack('H12')
+      end
+    end
+    
+    def is_opaque?
+      @type & OPAQUE > 0
+    end
+    
+    def is_ipv4_addr?
+      @type & IPV4_ADDR > 0
+    end
+    
+    def is_two_octet_asn?
+      @type & 3 == TWO_OCTET_AS
+    end  
+    
+    def two_octet
+      @type &= ~3
+    end
+    
+    def ipv4_addr
+      @type &= ~3
+      @type |= 1
+    end
+    
+    def opaque
+      @type |= 3
+    end
+    
+    def non_transitive
+      @type |= 0x40
+    end
+    
+    def transitive
+      @type &= ~0x40
+    end
+    
+    def is_transitive? 
+      @type & 0x40 == 0
+    end
+    
+    def non_transitive? 
+      not is_transitive?
+    end
+    
+    def to_i
+      encode.unpack('H*')[0].to_i(16)
+    end
+    
+    def <=>(other)
+      to_i <=> other.to_i
+    end
+    
+    def name
+      self.class.to_s.split('::').last.gsub('_',' ')
+    end
+    
+  end
+  
+
+  class Extended_community
+    include ATTR::XTENDED_COMMUNITY
+    include Comparable
+
+    def self.factory(_s)
+      if _s.is_a?(Bignum) or _s.is_a?(Fixnum)
+        s = [format("%16.16x",_s)].pack('H*')
+      else
+        s = _s
+      end
+      type, subtype, value = s.unpack('CCa6')
+      case subtype
+      when ROUTE_TARGET     ; Route_target.new(s)
+      when ROUTE_ORIGIN     ; Route_origin.new(s)
+      when OSPF_DOMAIN_ID   ; Ospf_domain_id.new(s)
+      when OSPF_ROUTER_ID   ; Ospf_router_id.new(s)
+      when BGP_DATA_COLLECT ; Bgp_data_collect.new(s)
+      else
+        puts "too bad type #{type}, subtype #{subtype} : #{s.unpack('H*')}"
+        Extended_community.new(s)
+      end
+    end
+
+    def initialize(*args)
+      @type=TWO_OCTET_AS
+      if args.size==1 and args[0].is_a?(String) and args[0].is_packed?
+        parse(args[0])
+      elsif args.size==3
+        @type, @subtype, value = args
+        raise ArgumentError, "invalid argument #{args.inspect}"  unless instance_of?(Opaque)
+        @type |= OPAQUE
+        @global, @local=value, nil
+      elsif args.size==4
+        raise  ArgumentError, "This is a base class and should not be instanciated"  if instance_of?(Extended_community)
+        @type, @subtype, @global, @local = args
+        if @global.is_a?(String) and @local.is_a?(Fixnum)
+          @type |= IPV4_ADDR
+          @global = IPAddr.new(@global).to_i
+        end
+      elsif args.size==1 and args[0].is_a?(Bignum)
+        parse([s].pack('H*'))
+      elsif args.empty?
+        @type, @subtype, @global, @local = 0,0,0,0
+      else
+        raise ArgumentError, "invalid arg #{args.inspect}"
+      end
+    end
+
+    def to_s
+      case @type & 3
+      when TWO_OCTET_AS
+        "#{name}: #{@global}:#{@local}"
+      when IPV4_ADDR
+        "#{name}: #{IPAddr.create(@global)}:#{@local}"
+      when OPAQUE
+        "#{name}: #{@global}"
+      else
+        raise RuntimeError, "bogus type: #{@type}"
+      end
+    end
+
+  end
+
+  class Route_target < Extended_community
+    def initialize(*args)
+      if args[0].is_a?(String) and args[0].is_packed?
+        super(*args)
+      else
+        super(0, ROUTE_TARGET, *args)
+      end
+    end
+  end
+
+  class Route_origin < Extended_community
+    def initialize(*args)
+      if args[0].is_a?(String) and args[0].is_packed?
+        super(*args)
+      else
+        super(0,ROUTE_ORIGIN,*args)
+      end
+    end
+  end
+
+  class Ospf_domain_id < Extended_community
+    def initialize(*args)
+      if args[0].is_a?(String) and args[0].is_packed?
+        super(*args)
+      else
+        args += [0]
+        super(1,OSPF_DOMAIN_ID,*args)
+      end
+    end
+  end
+
+  class Ospf_router_id < Extended_community
+    def initialize(*args)
+      if args[0].is_a?(String) and args[0].is_packed?
+        super(*args)
+      else
+        args += [0]
+        super(1,OSPF_ROUTER_ID,*args)
+      end
+    end
+  end
+
+  class Bgp_data_collect < Extended_community
+    def initialize(*args)
+      if args[0].is_a?(String) and args[0].is_packed?
+        super(*args)
+      else
+        super(0,BGP_DATA_COLLECT,*args)
+      end
+    end
+  end
+
+  class Opaque < Extended_community
+    def initialize(*args)
+      if args[0].is_a?(String) and args[0].is_packed?
+        super(*args)
+      else
+        raise ArgumentError, "not an opaque extended community" if [2,3,5,7,8].include?(args[0])
+        super(0,*args)
+      end
+    end
+  end
+
+end