bgp4r 0.0.8 → 0.0.9

data/bgp/nlris/vpn.rb

@@ -0,0 +1,68 @@
+
+module BGP
+  class Vpn
+    attr_reader :prefix, :rd
+    def initialize(*args)
+      if args.size>0 and args[0].is_a?(String) and args[0].is_packed?
+        parse(*args)
+      else
+        prefix, *rd = args
+        self.prefix=(prefix)
+        self.rd=rd
+      end      
+    end
+    def prefix=(arg)
+      if arg.is_a?(Prefix)
+        @prefix=arg
+      else
+        @prefix=Prefix.new(arg)
+      end
+    end
+    def rd=(args)
+      args.flatten!
+      if args.empty?
+        @rd=Rd.new
+      elsif args.size==1 and args[0].is_a?(BGP::Rd)
+        @rd=args[0]
+      else
+        @rd=Rd.new(*args)
+      end
+    end
+    # len_included arg is used by labeled encode()
+    def encode_next_hop
+      Rd.new.encode + @prefix.encode(false)
+    end
+    def encode(len_included=true)
+      if len_included
+        [bit_length, @rd.encode, @prefix.encode(false)].pack('Ca*a*')
+      else
+        @rd.encode + @prefix.encode(false)
+      end
+    end
+    def bit_length
+      @rd.bit_length + @prefix.mlen
+    end
+    def ipv4?
+      @prefix.ipv4?
+    end
+    def afi
+      @prefix.afi
+    end  
+    def ipv6?
+      @prefix.ipv6?
+    end
+    def parse(s, afi=1)
+      nbits = s.slice!(0,1).unpack('C')[0]
+      rd,vpn = s.slice!(0,(7+nbits)/8).unpack("a8a*")
+      @rd = Rd.new(rd.is_packed)
+      @prefix= Prefix.new([nbits-64,vpn].pack('Ca*'), afi)
+    end
+    def nexthop
+      @prefix.nexthop
+    end
+    def to_s
+       #Label Stack=5806 (bottom) RD=3215:317720610, IPv4=10.45.142.64/32
+      "#{@rd.to_s(false)}, #{@prefix.ipv4? ? 'IPv4' : 'IPv6'}=#{@prefix.to_s}"
+    end
+  end
+end

data/bgp/optional_parameters/as4.rb

@@ -0,0 +1,59 @@
+#--
+# 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/optional_parameters/capability'
+
+module BGP
+module OPT_PARM
+module CAP
+  
+class As4 < OPT_PARM::Capability
+  def initialize(s)
+    if s.is_a?(String) and s.is_packed?
+      parse(s)
+    else
+      super(OPT_PARM::CAP_AS4)
+      @as=s
+    end
+  end
+  
+  def encode()
+    super([@as].pack('N'))
+  end
+
+  def parse(s)
+    @as = super(s).unpack('N')[0]
+  end
+
+  def to_s
+    super + "\n    Capability(#{CAP_AS4}): 4-octet AS number: " + @as.to_s
+  end
+
+  def to_hash
+    super({:as => @as})
+  end
+end
+end
+end
+end
+
+load "../../test/optional_parameters/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/optional_parameters/capabilities.rb

@@ -0,0 +1,13 @@
+require 'bgp/optional_parameters/capability'
+
+%w{ mbgp orf route_refresh as4 graceful_restart dynamic }.each do |c|
+    BGP::OPT_PARM::CAP.autoload  "#{c}".capitalize.to_sym,"bgp/optional_parameters/#{c}"
+end
+
+module BGP::OPT_PARM
+  module DYN_CAP
+    BGP::OPT_PARM::CAP.constants.each do |kl|
+      const_set(kl, Class.new(::BGP::OPT_PARM::CAP.const_get(kl)))
+    end
+  end
+end

data/bgp/optional_parameters/capability.rb

@@ -0,0 +1,145 @@
+#--
+# 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/optional_parameters/optional_parameter'
+
+module BGP::OPT_PARM
+
+  class Capability < Optional_parameter
+    include BGP
+
+    unless const_defined? :Unknown
+      Unknown = Class.new(self) do
+        def initialize(s)
+          if s.is_a?(String) and s.is_packed?
+            parse(s)
+          else
+            raise ArgumentError
+          end
+        end
+        def encode
+          super @value
+        end
+        def parse(s)
+          @value = super(s)
+        end
+      end
+    end
+    
+    include BGP::OPT_PARM
+    def initialize(code)
+      super(OPT_PARM::CAPABILITY)
+      @code=code
+    end
+    def encode(value='')
+      if self.class.to_s =~ /BGP::OPT_PARM::DYN_CAP/
+        [@code,value.size, value].pack("Cna*")
+      else
+        super([@code,value.size, value].pack("CCa*"))
+      end
+    end
+    
+    def parse(_s)
+      s = _s
+      if self.class.to_s =~ /BGP::OPT_PARM::DYN_CAP/
+        @code, len = _s.slice!(0,3).unpack('Cn')
+      else
+        s = super(_s)
+        @code, len = s.slice!(0,2).unpack('CC')
+      end
+      s.slice!(0,len).is_packed
+    end
+    def to_s
+      "Option Capabilities Advertisement (#{@parm_type}): [#{to_shex}]"
+    end
+    def to_hash(h={})
+      if h.empty?
+        {:code=> @code}
+      else
+        {:code=> @code, :capability=> h}
+      end
+    end
+    
+    def method_missing()
+      if name == :to_s_brief
+        "#{self.class.to_s.split('::').last}"
+      else
+        super
+      end
+    end
+    
+  end
+end
+
+module BGP
+  module OPT_PARM
+    module CAP
+    end
+  end
+end
+
+# require 'bgp4r'
+
+module BGP::OPT_PARM
+  def Capability.factory(s)
+    code = s.slice(2,1).unpack('C')[0]
+    case code
+    when CAP_AS4
+      CAP::As4.new(s)
+    when CAP_MBGP
+      CAP::Mbgp.new(s)
+    when CAP_ROUTE_REFRESH, CAP_ROUTE_REFRESH_CISCO
+      CAP::Route_refresh.new(code)
+    when CAP_ORF,CAP_ORF_CISCO
+      CAP::Orf.new(s)
+    when CAP_GR
+      CAP::Graceful_restart.new(s)
+    when CAP_DYNAMIC
+      CAP::Dynamic.new(s)
+    else
+      Capability::Unknown.new(s)
+    end
+  end
+end
+
+module BGP::OPT_PARM
+    def Capability.dynamic_factory(s)
+      code = s.slice(0,1).unpack('C')[0]
+      case code
+      when CAP_AS4
+        DYN_CAP::As4.new(s)
+      when CAP_MBGP
+        DYN_CAP::Mbgp.new(s)
+      when CAP_ROUTE_REFRESH, CAP_ROUTE_REFRESH_CISCO
+        DYN_CAP::Route_refresh.new(code)
+      when CAP_ORF,CAP_ORF_CISCO
+        DYN_CAP::Orf.new(s)
+      when CAP_GR
+        DYN_CAP::Graceful_restart.new(s)
+      else
+        Capability::Unknown.new(s)
+      end
+    end
+end
+
+load "../../test/optional_parameters/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/optional_parameters/dynamic.rb

@@ -0,0 +1,37 @@
+#--
+# Copyright 2010 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/optional_parameters/capability'
+
+module BGP::OPT_PARM::CAP
+
+class Dynamic < BGP::OPT_PARM::Capability 
+  def initialize(code=BGP::OPT_PARM::CAP_DYNAMIC)
+    super(code)
+  end
+  def to_s
+    super + "\n    Dynamic Capability #{@code}, length: 2"
+  end
+end
+end
+
+load "../../test/optional_parameters/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/optional_parameters/graceful_restart.rb

@@ -0,0 +1,116 @@
+#--
+# Copyright 2010 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/optional_parameters/capability'
+
+module BGP::OPT_PARM::CAP
+  
+class Graceful_restart < BGP::OPT_PARM::Capability 
+  
+  def initialize(*args)
+    if args.size>1
+      @restart_state, @restart_time = args
+      @address_families = []
+      super(OPT_PARM::CAP_GR)
+    else
+      parse(*args)
+    end
+  end
+  
+  def add(afi,safi,flags)
+    @address_families << [_afi(afi), _safi(safi), flags]
+  end
+
+  def parse(s)
+    @address_families = []
+    o1, families = super(s).unpack('na*')
+    @restart_state = o1 >> 12
+    @restart_time = o1 & 0xfff
+    while families.size>0
+      @address_families << families.slice!(0,4).unpack('nCC')
+    end
+  end
+
+
+  def encode
+    s = []
+    s << [(@restart_state << 12) + @restart_time].pack('n')
+    s << @address_families.collect { |af| af.pack('nCC') }
+    super s.join
+  end
+  def to_s
+    s = []
+    s <<  "\n    Graceful Restart Extension (#{CAP_GR}), length: 4"
+    s <<  "    Restart Flags: #{restart_flag}, Restart Time #{@restart_time}s"
+    s = s.join("\n  ")
+    super + (s + (['']+@address_families.collect { |af| address_family(*af)}).join("\n        "))
+  end
+  
+  private
+  
+  def address_family(afi, safi, flags)
+    "AFI #{IANA.afi(afi)} (#{afi}), SAFI #{IANA.safi(safi)} (#{safi}), #{address_family_flags(flags)}"
+  end
+  
+  def restart_flag
+    if @restart_state == 0
+      '[none]'
+    else
+      "0x#{@restart_state}"
+    end
+  end
+  
+  def address_family_flags(flags)
+    if flags & 1 == 0
+      "Forwarding state not preserved (0x#{flags.to_s(16)})"
+    elsif flags & 1 == 1
+      "Forwarding state preserved (0x#{flags.to_s(16)})"
+    end
+  end
+  
+  def _afi(val)
+    if val.is_a?(Fixnum)
+      val
+    elsif val == :ipv4
+      1
+    elsif val == :ipv6
+      2
+    end
+  end
+  
+  def _safi(val)
+    if val.is_a?(Fixnum)
+      val
+    elsif val == :unicast
+      1
+    elsif val == :multicast
+      2
+    end
+  end
+  
+  
+end
+end
+
+load "../../test/optional_parameters/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+
+

data/bgp/optional_parameters/mbgp.rb

@@ -0,0 +1,97 @@
+#--
+# 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/optional_parameters/capability'
+
+module BGP::OPT_PARM::CAP
+  
+  class Mbgp < BGP::OPT_PARM::Capability 
+
+    def self.ipv4_unicast
+      Mbgp.new(1,1)
+    end
+
+    def self.ipv4_multicast
+      Mbgp.new(1,2)
+    end
+
+    def self.ipv6_unicast
+      Mbgp.new(2,2)
+    end
+
+    def self.ipv6_multicast
+      Mbgp.new(2,2)
+    end
+
+    def initialize(afi,safi=nil)
+      if safi.nil? and afi.is_a?(String) and afi.is_packed?
+        parse(afi)
+      else
+        super(OPT_PARM::CAP_MBGP)
+        self.safi, self.afi = safi, afi
+      end
+    end
+
+    def afi=(val)
+      @afi = if val.is_a?(Fixnum)
+        val
+      elsif val == :ipv4
+        1
+      elsif val == :ipv6
+        2
+      end
+    end
+
+    def safi=(val)
+      @safi = if val.is_a?(Fixnum)
+        val
+      elsif val == :unicast
+        1
+      elsif val == :multicast
+        2
+      end
+    end
+
+    def encode
+      super([@afi,0,@safi].pack('nCC'))
+    end
+
+    def parse(s)
+      @afi, ignore, @safi = super(s).unpack('nCC')
+    end
+
+    def to_s
+      super + "\n    Multiprotocol Extensions (#{CAP_MBGP}), length: 4" +
+      "\n      AFI #{IANA.afi(@afi)} (#{@afi}), SAFI #{IANA.safi(@safi)} (#{@safi})"
+    end
+    
+    def to_s_brief
+      "MBGP #{IANA.afi(@afi)}, #{IANA.safi(@safi)}"
+    end
+
+    def to_hash
+      super({:afi => @afi, :safi => @safi, })
+    end
+  end
+end
+
+load "../../test/optional_parameters/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/optional_parameters/optional_parameter.rb

@@ -0,0 +1,76 @@
+#--
+# 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/>.
+#++
+
+module BGP
+
+class UnknownBgpCapability < RuntimeError
+end
+
+module OPT_PARM
+
+  unless const_defined? :CAPABILITY
+    CAPABILITY = 2
+
+    CAP_MBGP = 1
+    CAP_ROUTE_REFRESH = 2
+    CAP_ORF = 3
+    CAP_GR  = 64
+    CAP_AS4 = 65
+    CAP_DYNAMIC = 67
+    CAP_ROUTE_REFRESH_CISCO = 128
+    CAP_ORF_CISCO = 130
+
+    ORF_NLRI = 1
+    ORF_COMMUNITIES = 2
+    ORF_EXTENDED_COMMUNITIES = 3
+    ORF_PREFIX_LIST = 129
+  end
+
+  class Optional_parameter
+
+    def initialize(parm_type)
+      @parm_type=parm_type
+    end
+
+    def encode(value)
+      [@parm_type, value.size, value].pack('CCa*')
+    end
+
+    def parse(s)
+      @parm_type, len = s.slice!(0,2).unpack('CC')
+      s.slice!(0,len).is_packed
+    end
+
+    def self.factory(s)
+      parm_type, len = s.unpack('CC')
+      opt_parm = s.slice!(0,len+2).is_packed
+      case parm_type
+      when CAPABILITY
+        Capability.factory(opt_parm)
+      else
+        raise RuntimeError, "Optional parameter type '#{parm_type}' not implemented"
+      end
+    end
+
+  end
+end
+end

data/bgp/optional_parameters/orf.rb

@@ -0,0 +1,90 @@
+#--
+# 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/optional_parameters/capability'
+
+module BGP::OPT_PARM::CAP
+
+class Orf < BGP::OPT_PARM::Capability
+
+  class Entry
+    
+    def initialize(*args)
+      if args.size==1 and args[0].is_a?(String) and args[0].is_packed?
+        parse(args[0])
+      elsif args[0].is_a?(Hash) 
+      else
+        @afi, @safi, *@types = *args
+      end
+    end
+    
+    def encode
+      [@afi, 0, @safi, @types.size,@types.collect { |e| e.pack('CC')}.join].pack('nCCCa*')
+    end
+    
+    def parse(s)
+      @afi, __, @safi, n = s.slice!(0,5).unpack('nCCC')
+      @types=[]
+      types = s.slice!(0, 2*n)
+      while types.size>0
+        @types<< types. slice!(0,2).unpack('CC')
+      end
+    end
+    
+    def to_s
+      "AFI #{IANA.afi(@afi)} (#{@afi}), SAFI #{IANA.safi(@safi)} (#{@safi}): #{@types.inspect}"
+    end
+  end
+
+  def initialize(*args)
+    @entries=[]
+    if args.size==1 and args[0].is_a?(String) and args[0].is_packed?
+      parse(args[0])
+    else
+      super(OPT_PARM::CAP_ORF)
+    end
+  end
+
+  def add(entry)
+    @entries << entry
+  end
+
+  def encode
+    super(@entries.collect { |e| e.encode }.join)
+  end
+
+  def parse(s)
+    entries = super(s)
+    while entries.size>0
+      @entries << Entry.new(entries)
+    end
+  end
+
+  def to_s
+    super + "\n    Outbound Route Filtering (#{@code}), length: #{encode.size}" +
+    (['']+@entries.collect { |e| e.to_s }).join("\n      ")
+  end
+
+end
+end
+
+load "../../test/optional_parameters/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0