bgp4r 0.0.8 → 0.0.9

data/README.rdoc

@@ -227,18 +227,9 @@ Source code is hosted on github.
 
 == Installation
 
-==== Run the following if you haven't already: 
-
-  gem sources -a http://gems.github.com
-
 ==== Install the gem
 
-  sudo gem install jesnault-bgp4r
-
-=== Or clone bgp4r tree and set RUBYLIB env variable accordingly:
-
-  git clone git://github.com/jesnault/bgp4r.git
-  export RUBYLIB=/home/user/bgp4r
+  sudo gem install bgp4r
 
 == Requirements
 

data/bgp/io.rb

@@ -23,8 +23,10 @@
 
 require 'observer'
 require 'thread'
+require 'timeout'
 require 'bgp/common'
-require 'bgp/message'
+require 'bgp/messages/message'
+
 
 module BGP
   module IO
@@ -95,7 +97,7 @@ module BGP
           begin
             while @continue
               begin
-                Timeout::timeout(h) do |h| 
+                Timeout::timeout(h) do |_h| 
                   message, type = recv_msg(s)
                   break unless @continue
                   changed and notify_observers(:ev_msg, @type, message)

data/bgp/messages/capability.rb

@@ -0,0 +1,176 @@
+#--
+# 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/messages/message'
+
+module BGP::OPT_PARM
+  module CAP
+  end
+end
+
+module BGP
+  
+  class Capability < Message
+    
+    class Revision
+      
+      class <<self
+        
+        def advertise(seqn, cap)
+          new :unset, :unset, :advertise, seqn, cap
+        end
+        def advertise_ack_request(seqn, cap)
+          new :unset, :set, :advertise, seqn, cap
+        end
+        def advertise_ack_response(seqn, cap)
+          new :set, :unset, :advertise, seqn, cap
+        end
+        def remove(seqn, cap)
+          new :unset, :unset, :remove, seqn, cap
+        end
+        def remove_ack_request(seqn, cap)
+          new :unset, :set, :remove, seqn, cap
+        end
+        def remove_ack_response(seqn, cap)
+          new :set, :unset, :remove, seqn, cap
+        end
+       
+      end
+      
+      def initialize(*args)
+        if args.size> 1
+          init_ack_bit, ack_request_bit, action_bit, seqn, cap = args
+          @o1 = 0
+          @o1 |= 0x80  if init_ack_bit    == :set
+          @o1 &= ~0x80  if init_ack_bit    == :unset
+          @o1 |= 0x40  if ack_request_bit == :set
+          @o1 &= ~0x40  if ack_request_bit == :unset
+          @o1 |= 1     if action_bit      == :remove
+          @o1 &= ~1    if action_bit      == :advertise
+          @seqn = seqn
+          @cap = cap
+        elsif args.size==1 && args.is_a?(String)
+      else
+        parse args[0]
+      end
+      end
+      
+      def encode
+        [@o1,@seqn, @cap.encode].pack('CNa*')
+      end
+      
+      def parse(s)
+        @o1, @seqn, @code, len = s.slice!(0,8).unpack('CNCn')
+        cap_value = s.slice!(0,len)
+        @cap = BGP::OPT_PARM::Capability.dynamic_factory([@code,len,cap_value].pack('Cna*'))
+      end
+      
+      def to_s
+        format('0x%08d  %-9s  %3s (0x%02x)  %s', @seqn, action_to_s, ack_to_s, @o1, cap_to_s)
+      end
+      
+      def initiated?
+        ! acknowledged?
+      end
+      
+      def acknowledged?
+        @o1 & 0x80 > 1
+      end
+      
+      def ack_requested?
+        @o1& 0x40 > 1
+      end
+      
+      def advertise?
+        !remove?
+      end
+      
+      def remove?
+        @o1 & 1 == 1
+      end
+
+      def init_ack_to_s
+        initiated? ? '' : '(ack)'
+      end
+      
+      private
+      
+      def ack_to_s
+        if ack_requested?
+          'Req'
+        elsif acknowledged?
+          'Rsp'
+        end
+      end
+
+      def action_to_s
+        advertise? ? 'Advertise' : 'Withdraw'
+      end
+
+      def cap_to_s
+        @cap.to_s_brief
+      end
+      
+      def seqn_to_s
+        format('0x%08x', @seqn)
+      end
+      
+    end
+    
+    def initialize(*args)
+      @tuples =[]
+      if args.size==1 and args[0].is_a?(String)
+        parse args[0]
+      else
+        @msg_type=CAPABILITY
+        add *args
+      end
+    end
+
+    def add(*revisions)
+      [revisions].flatten.find_all { |r| r.is_a?(Capability::Revision)}.each { |r| @tuples << r }
+    end
+    
+    alias << add
+
+    def encode
+      super @tuples.collect { |r| r.encode }.join
+    end
+
+    def parse(s)
+      revisions = super(s)
+      while revisions.size>0
+        @tuples << BGP::Capability::Revision.new(revisions)
+      end
+    end
+    
+    def to_s
+      msg = self.encode
+      "Capability (#{CAPABILITY}), length: #{msg.size}\n" +
+      "  Seqn        Action     Ack bits    Capability\n  " + 
+        @tuples.collect { |t| t.to_s}.join("\n  ")
+    end
+    
+  end
+end
+
+load "../../test/messages/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/bgp/messages/keepalive.rb

@@ -0,0 +1,30 @@
+# KEEPALIVE Message Format
+# 
+#    BGP does not use any TCP-based, keep-alive mechanism to determine if
+#    peers are reachable.  Instead, KEEPALIVE messages are exchanged
+#    between peers often enough not to cause the Hold Timer to expire.  A
+#    reasonable maximum time between KEEPALIVE messages would be one third
+#    of the Hold Time interval.  KEEPALIVE messages MUST NOT be sent more
+#    frequently than one per second.  An implementation MAY adjust the
+#    rate at which it sends KEEPALIVE messages as a function of the Hold
+#    Time interval.
+# 
+#    If the negotiated Hold Time interval is zero, then periodic KEEPALIVE
+#    messages MUST NOT be sent.
+# 
+#    A KEEPALIVE message consists of only the message header and has a
+#    length of 19 octets.
+#
+
+require 'bgp/messages/message'
+
+module BGP
+  class Keepalive < Message
+    def initialize
+      @msg_type=KEEPALIVE
+    end
+    def to_s
+      "Keepalive Message (#{KEEPALIVE}), length: 19" + ", [#{self.to_shex[32..-1]}]"
+    end
+  end
+end

data/bgp/messages/markers.rb

@@ -0,0 +1,10 @@
+require 'bgp/messages/update'
+module BGP
+  def Update.end_of_rib_marker(*args)
+    if args.empty?
+      Update.new(Path_attribute.new()) if args.empty?
+    elsif args[0].is_a?(Hash)
+      Update.new(Path_attribute.new(Mp_unreach.new(*args)))
+    end
+  end
+end

data/bgp/messages/message.rb

@@ -0,0 +1,85 @@
+#--
+# 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
+
+  # http://www.iana.org/assignments/bgp-parameters/bgp-parameters.xhtml#bgp-parameters-1
+
+  class UnknownBgpMessage < RuntimeError
+  end
+
+  class Message
+
+    unless const_defined? :OPEN
+      OPEN          = 1
+      UPDATE        = 2
+      NOTIFICATION  = 3
+      KEEPALIVE     = 4
+      ROUTE_REFRESH = 5
+      CAPABILITY    = 6
+    end
+
+    def encode(message='')
+      len = message.size+19
+      [[255]*16,len,@msg_type,message].flatten.pack('C16nCa*')
+    end
+
+    def parse(s)
+      len, @msg_type, message = s[16..-1].unpack('nCa*')
+      message.is_packed
+    end
+    def self.factory(_s, as4byte=false)
+      s = [_s].pack('a*')
+      s.slice(18,1).unpack('C')[0]
+      case s.slice(18,1).unpack('C')[0]
+      when OPEN
+        Open.new(s)
+      when UPDATE
+        Update.new(s, as4byte)
+      when KEEPALIVE
+        Keepalive.new
+      when NOTIFICATION
+        Notification.new(s)
+      when ROUTE_REFRESH
+        if s.size > 23  
+          Orf_route_refresh.new(s)
+        else
+          Route_refresh.new(s)
+        end
+      when CAPABILITY
+        Capability.new(s)
+      else
+        puts "don't know what kind of bgp messgage this is #{s.slice(18,1).unpack('C')}"
+      end
+    end
+    def self.keepalive
+      Keepalive.new.encode
+    end
+    def self.route_refresh(afi,safi)
+      Route_refresh.new(afi,safi).encode
+    end
+  end
+
+end
+
+load "../../test/messages/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+

data/bgp/messages/messages.rb

@@ -0,0 +1,17 @@
+module BGP
+
+  begin
+    unless const_defined? :VERSION
+      BGP.const_set('VERSION', Gem.loaded_specs['bgp4r'].version.to_s)
+    end
+  rescue
+  end
+  
+  %w{ update keepalive open notification capablity}.each do |m|
+    autoload "#{m}".capitalize.to_sym, "bgp/messages/#{m}"
+  end
+  autoload :Route_refresh,     'bgp/messages/route_refresh'
+  autoload :Orf_route_refresh, 'bgp/messages/route_refresh'
+  autoload :Prefix_orf,        'bgp/orfs/prefix_orf'
+  
+end

data/bgp/messages/notification.rb

@@ -0,0 +1,116 @@
+
+# NOTIFICATION Message Format
+#  
+#     A NOTIFICATION message is sent when an error condition is detected.
+#     The BGP connection is closed immediately after it is sent.
+#  
+#  
+#  
+#  
+#  Rekhter, et al.             Standards Track                    [Page 21]
+#  
+#  RFC 4271                         BGP-4                      January 2006
+#  
+#  
+#     In addition to the fixed-size BGP header, the NOTIFICATION message
+#     contains the following fields:
+#  
+#        0                   1                   2                   3
+#        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        | Error code    | Error subcode |   Data (variable)             |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#
+
+require 'bgp/messages/message'
+
+module BGP
+
+class Notification < Message
+
+  def self.code_to_s(*args)
+    @code_to_s[args]
+  end
+
+  @code_to_s=Hash.new("Undefined")
+  @code_to_s[[1]]    = "Header Error"
+  @code_to_s[[2]]    = "OPEN msg error"
+  @code_to_s[[3]]    = "UPDATE msg error"
+  @code_to_s[[4]]    = "Hold Timer Expired"
+  @code_to_s[[5]]    = "Finite State Machine Error"
+  @code_to_s[[6]]    = "Cease"
+  @code_to_s[[7]]    = "CAPABILITY Message Error"
+  @code_to_s[[1,1]]  = "Connection Not Synchronized"
+  @code_to_s[[1,2]]  = "Bad Message Length"
+  @code_to_s[[1,3]]  = "Bad Message Type"    
+  @code_to_s[[2,1]]  = "Unsupported Version Number"
+  @code_to_s[[2,2]]  = "Bad Peer AS"                    
+  @code_to_s[[2,3]]  = "Bad BGP Identifier"             
+  @code_to_s[[2,4]]  = "Unsupported Optional Parameter" 
+  @code_to_s[[2,5]]  = "[Deprecated]"                   
+  @code_to_s[[2,6]]  = "Unacceptable Hold Time"         
+  @code_to_s[[2,7]]  = "Unsupported Optional Parameter"
+  @code_to_s[[3,1]]  = "Malformed Attribute List"
+  @code_to_s[[3,2]]  = "Unrecognized Well-known Attribute"  
+  @code_to_s[[3,3]]  = "Missing Well-known Attribute"       
+  @code_to_s[[3,4]]  = "Attribute Flags Error"              
+  @code_to_s[[3,5]]  = "Attribute Length Error"             
+  @code_to_s[[3,6]]  = "Invalid ORIGIN Attribute"           
+  @code_to_s[[3,7]]  = "Deprecated"                       
+  @code_to_s[[3,8]]  = "Invalid NEXT_HOP Attribute"         
+  @code_to_s[[3,9]]  = "Optional Attribute Error"           
+  @code_to_s[[3,10]] = "Invalid Network Field"             
+  @code_to_s[[3,11]] = "Malformed AS_PATH"
+  @code_to_s[[6,1]]  = "Maximum Number of Prefixes Reached"
+  @code_to_s[[6,2]]  = "Administrative Shutdown"
+  @code_to_s[[6,3]]  = "Peer De-configured"
+  @code_to_s[[6,4]]  = "Administrative Reset"
+  @code_to_s[[6,5]]  = "Connection Rejected"
+  @code_to_s[[6,6]]  = "Other Configuration Change"
+  @code_to_s[[6,7]]  = "Connection Collision Resolution"
+  @code_to_s[[6,8]]  = "Out of Resources"
+  @code_to_s[[7,1]]  = "Unknown Sequence Number"
+  @code_to_s[[7,2]]  = "Invalid Capability Length"
+  @code_to_s[[7,3]]  = "Malformed Capability Value"
+  @code_to_s[[7,4]]  = "Unsupported Capability Code"
+  
+  def initialize(*args)
+    @msg_type=NOTIFICATION
+    if args.size==1  and 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])
+    elsif args.size==1  and args[0].is_a?(Notification) and args[0].respond_to?(:encode)
+        parse(args[0].encode)
+    else
+      @code, @subcode, @data=args
+    end
+  end
+
+  def encode
+    # default to ipv4 and unicast when not set
+    super([@code,@subcode, @data].pack('CCa*'))
+  end
+
+  def parse(s)
+    @code, @subcode, @data= super(s).unpack('CCa*')
+  end
+
+  def to_hash
+    {:code=> @code, :subcode=> @subcode, :data=>@data}
+  end
+
+  def to_string
+    Notification.code_to_s(@code, @subcode)
+  end
+
+  def to_s
+    msg = self.encode
+    s = "Notification (#{NOTIFICATION}), length: #{msg.size}: "
+    s += "#{Notification.code_to_s(@code)} (#{@code}), #{Notification.code_to_s(@code, @subcode)} (#{@subcode}) " 
+    s += "\ndata: [#{@data}]" if @data.size>0
+    s
+  end
+
+end
+end

data/bgp/messages/open.rb

@@ -0,0 +1,117 @@
+
+# OPEN Message Format
+# 
+#    After a TCP connection is established, the first message sent by each
+#    side is an OPEN message.  If the OPEN message is acceptable, a
+#    KEEPALIVE message confirming the OPEN is sent back.
+# 
+#    In addition to the fixed-size BGP header, the OPEN message contains
+#    the following fields:
+# 
+#        0                   1                   2                   3
+#        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+#        +-+-+-+-+-+-+-+-+
+#        |    Version    |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |     My Autonomous System      |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |           Hold Time           |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                         BGP Identifier                        |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        | Opt Parm Len  |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+#        |                                                               |
+#        |             Optional Parameters (variable)                    |
+#        |                                                               |
+#        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+# 
+# 
+require 'bgp/messages/message'
+require 'bgp/optional_parameters/capability'
+
+module BGP
+
+class Open < Message
+  
+  include OPT_PARM
+  
+  attr_reader :version, :local_as, :holdtime, :opt_parms
+  
+  def initialize(*args)
+    @opt_parms=[]
+    if args.size==1 and 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
+      @msg_type=OPEN
+      @version, @local_as, @holdtime, bgp_id, *@opt_parms=args
+      @bgp_id = IPAddr.new(bgp_id)
+    end
+  end
+
+  def <<(arg)
+    raise ArgumentError, "arg is not an Optional_parameter" unless arg.is_a?(Optional_parameter)
+    @opt_parms << arg
+  end
+
+  def encode
+    opt_parms = @opt_parms.compact.collect { |cap| cap.encode }.join
+    s  = [@version, @local_as, @holdtime, @bgp_id.hton].pack("Cnna4")
+    s += if opt_parms.size>255
+      [0xffff, opt_parms.size, opt_parms].pack("nna*")
+    else
+      [opt_parms.size, opt_parms].pack("Ca*")
+    end
+    super s
+  end
+  
+  def bgp_id
+    @bgp_id.to_s
+  end
+  
+  def to_s
+    msg = self.encode
+    "Open Message (#{OPEN}), length: #{msg.size}\n" +
+    "  Version #{@version}, my AS #{@local_as}, Holdtime #{@holdtime}s, ID #{@bgp_id}" + 
+    ([""] + @opt_parms.compact.collect { |cap| cap.to_s } + [""]).join("\n  ") +
+    msg.hexlify.join("\n") + "\n"
+  end
+  
+  def find(klass)
+    @opt_parms.find { |a| a.is_a?(klass) }
+  end
+  
+  def has?(klass)
+     @opt_parms.find { |a| a.is_a?(klass) }.nil? ? false : true
+  end
+  
+  def to_hash
+    h = {:version => @version, :my_as => @local_as, :holdtime => @holdtime, :bgp_id => bgp_id }
+    unless @opt_parms.empty?
+      h[:capabilities] =  @opt_parms.collect { |opt| opt.to_hash }
+    end
+    h
+  end
+  
+  private
+  
+  def parse(_s)
+    s = super(_s)
+    if s[9,2].unpack('CC') == [255,255]
+      @version, @local_as, @holdtime, bgp_id, _, opt_parm_len, opt_parms = s.unpack('Cnna4nna*')
+    else
+      @version, @local_as, @holdtime, bgp_id, opt_parm_len, opt_parms = s.unpack('Cnna4Ca*')
+    end
+    while opt_parms.size>0
+      @opt_parms << Optional_parameter.factory(opt_parms)
+    end
+    @bgp_id = IPAddr.new_ntoh(bgp_id)
+  end
+   
+end
+
+end
+
+load "../../test/messages/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0