bgp4r 0.0.3

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

data/bgp/iana.rb

@@ -0,0 +1,269 @@
+#--
+# 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 IANA
+  def self.afi(afi)
+    case afi
+    when AFI::IP   ; 'IPv4'
+    when AFI::IP6  ; 'IPv6'
+    else
+      ''
+    end
+  end
+  def self.safi(safi)
+    case safi
+    when SAFI::UNICAST_NLRI       ; 'Unicast'
+    when SAFI::MULTICAST_NLRI     ; 'Multicast'
+    when SAFI::LABEL_NLRI         ; 'Labeled NLRI'
+    when SAFI::MCAST_VPN          ; 'Multicast VPN'
+    when SAFI::MPLS_VPN_UNICAST   ; 'Labeled VPN Unicast'
+    when SAFI::MPLS_VPN_Multicast ; 'Labeled VPN Multicast'
+    else
+      ''
+    end
+  end
+  module AFI
+    IP = 1
+    IP6 = 2 
+    NSAP = 3
+    HDLC = 4
+    BBN = 5
+    IEEE_802 = 6
+    E163 = 7
+    E164 = 8
+    F69 = 9
+    X121 = 10
+    IPX = 11
+    Appletalk = 12
+    Decnet_IV = 13
+    Banyan_Vines = 14
+    E164_NSAP = 15
+    DNS = 16
+    Distinguished_Name = 17
+    AS_Number = 18
+    XTPv4 = 19
+    XTPv6 = 20
+    XTP = 21
+    FCWWPN = 22
+    FCWWNN = 23
+    GWID = 24
+    L2VPN = 25
+  end  
+  module SAFI
+    UNICAST_NLRI = 1
+    MULTICAST_NLRI = 2
+    LABEL_NLRI = 4
+    MCAST_VPN = 5
+    MULTI_SEGMENT_PW_NLRI = 6
+    ENCASPSULATION_SAFI = 7
+    TUNNEL = 64
+    VPLS = 65
+    BGP_MDT = 66
+    BGP4over6 = 67
+    BGP6over4 = 68
+    L1_VPN_AUTO_DISCOVERY = 69
+    MPLS_VPN_UNICAST = 128
+    MPLS_VPN_Multicast = 129
+    ROUTE_TARGET_CONSTRAINTS = 132
+    FLOW_SPEC_RULES_1 = 133
+    FLOW_SPEC_RULES_2 = 134
+    VPN_AUTO_DISCOVERY = 140
+  end
+end
+
+__END__
+
+http://www.iana.org/assignments/address-family-numbers/
+
+
+
+Registry:
+Number       Description                                                       Reference
+----------   ----------------------------------------------------------------  -----------------
+0            Reserved
+1            IP (IP version 4)
+2            IP6 (IP version 6)
+3            NSAP
+4            HDLC (8-bit multidrop)
+5            BBN 1822
+6            802 (includes all 802 media plus Ethernet "canonical format")
+7            E.163
+8            E.164 (SMDS, Frame Relay, ATM)
+9            F.69 (Telex)
+10           X.121 (X.25, Frame Relay)
+11           IPX
+12           Appletalk
+13           Decnet IV
+14           Banyan Vines
+15           E.164 with NSAP format subaddress                                 [UNI-3.1][Malis]
+16           DNS (Domain Name System)
+17           Distinguished Name                                                [Lynn]
+18           AS Number                                                         [Lynn]
+19           XTP over IP version 4                                             [Saul] 
+20           XTP over IP version 6                                             [Saul]
+21           XTP native mode XTP                                               [Saul]
+22           Fibre Channel World-Wide Port Name                                [Bakke]
+23           Fibre Channel World-Wide Node Name                                [Bakke]
+24           GWID                                                              [Hegde]
+25           AFI for L2VPN information                                         [RFC4761]
+26-16383     Unassigned
+16384        EIGRP Common Service Family                                       [Savage]
+16385        EIGRP IPv4 Service Family                                         [Savage]
+16386        EIGRP IPv6 Service Family                                         [Savage]
+16387-32767  Unassigned
+32768-65534  Unassigned
+65535        Reserved
+
+
+http://www.iana.org/assignments/safi-namespace
+
+
+Registries included below
+- SAFI Values
+
+
+Registry Name: SAFI Values
+Reference: [RFC4760]
+Range      Registration Procedures                              Note
+---------  ---------------------------------------------------  --------------------
+1-63       Standards Action or Early Allocation policy
+64-127     First Come First Served
+128-240    Some recognized assignments below, others Reserved 
+241-254    Reserved for Private Use                             Not to be assigned
+
+Registry:
+Value    Description                                     Reference
+-------  ----------------------------------------------  ---------
+0        Reserved                                        [RFC4760]
+
+1        Network Layer Reachability Information used     [RFC4760]
+         for unicast forwarding	
+
+2        Network Layer Reachability Information used     [RFC4760] 
+         for multicast forwarding
+	
+3        Reserved                                        [RFC4760]
+
+4        Network Layer Reachability Information (NLRI)   [RFC3107]
+         with MPLS Labels
+
+5        MCAST-VPN                                       [draft-ietf-l3vpn-2547bis-mcast-bgp]
+         (TEMPORARY - Expires 2009-06-19)
+
+6        Network Layer Reachability Information used     [draft-ietf-pwe3-dynamic-ms-pw]
+         for Dynamic Placement of Multi-Segment
+         Pseudowires
+         (TEMPORARY - Expires 2009-08-23)
+
+7        Encapsulation SAFI                              [RFC-ietf-softwire-encaps-safi-05.txt]
+
+8-63     Unassigned
+
+64       Tunnel SAFI                                     [Nalawade]
+
+65       Virtual Private LAN Service (VPLS)              [RFC4761]
+
+66       BGP MDT SAFI                                    [Nalawade]
+
+67       BGP 4over6 SAFI                                 [Cui]
+
+68       BGP 6over4 SAFI                                 [Cui]
+
+69       Layer-1 VPN auto-discovery information          [RFC-ietf-l1vpn-bgp-auto-discovery-05.txt]
+
+70-127   Unassigned 
+
+128      MPLS-labeled VPN address                        [RFC4364]
+
+129      Multicast for BGP/MPLS IP Virtual Private       [RFC2547]
+         Networks (VPNs)
+
+130-131  Reserved                                        [RFC4760]
+
+132      Route Target constrains                         [RFC4684]
+
+133      Dissemination of flow specification rules       [draft-marques-idr-flow-spec]
+
+134      Dissemination of flow specification rules       [draft-marques-idr-flow-spec]
+
+135-139  Reserved                                        [RFC4760]
+
+140      VPN auto-discovery                              [draft-ietf-l3vpn-bgpvpn-auto]
+
+141-240  Reserved                                        [RFC4760]
+
+241-254  Private Use                                     [RFC4760]
+
+255      Reserved                                        [RFC4760]
+
+
+References
+----------
+[RFC2547]  E. Rosen and Y. Rekhter, "BGP/MPLS VPNs", RFC 2547, March 1999.
+
+[RFC3107]  Y. Rekhter and E. Rosen, "Carrying Label Information in 
+           BGP-4", RFC 3107, May 2001.
+
+[RFC4364]  E. Rosen and Y. Rekhter, "BGP/MPLS IP VPNs", RFC 4364, February 2006.
+
+[RFC4684]  P. Marques, R. Bonica, L. Fang, L. Martini, R. Raszuk, K. Patel
+           and J. Guichard, "Constrained VPN Route Distribution", RFC 4684,
+           November 2006.
+
+[RFC4760]  T. Bates, R. Chandra, D. Katz and Y. Rekhter, "Multiprotocol 
+           Extensions for BGP-4", RFC 4760, January 2007.
+
+[RFC4761]  K. Kompella and Y. Rekhter, "Virtual Private LAN Service 
+           (VPLS) Using BGP for Auto-discovery and Signaling", RFC 4761,
+           January 2007.
+
+[RFC-ietf-l1vpn-bgp-auto-discovery-05.txt] 
+           H. Brahim, D. Fedyk, Y. Rekhter, "BGP-based Auto-Discovery for 
+           Layer-1 VPNs", RFC XXXX, Month Year.
+           
+[draft-ietf-l3vpn-bgpvpn-auto]  Work in progress
+
+[draft-ietf-pwe3-dynamic-ms-pw] Work in progress
+
+[draft-marques-idr-flow-spec]   Work in progress
+
+[draft-ietf-l3vpn-2547bis-mcast-bgp] Work in progress
+
+[RFC-ietf-softwire-encaps-safi-05.txt]
+           P. Mohapatra, E. Rosen, "BGP Encapsulation SAFI and BGP Tunnel 
+           Encapsulation Attribute", RFC XXXX, Month Year.
+
+People
+------
+[Bates] Tony Bates, <tbates&cisco.com>, July 2000. 
+
+[Cui]  Yong Cui, <cuiyong&tsinghua.edu.cn>, 15 August 2006, 20 September 2006.
+
+[Nalawade]  Gargi Nalawade, <gargi&cisco.com>, January 2004. 
+           (draft-nalawade-kapoor-tunnel-safi-01.txt)  
+           (draft-nalawade-idr-mdt-safi-00.txt), February 2004.
+
+(created 2000-07)
+
+[] 
+