netaddr 1.2.0 → 1.3.0

data/lib/{net_addr.rb → netaddr.rb}

@@ -1,9 +1,11 @@
 =begin rdoc
- Copyleft (c) 2006 Dustin Spinhirne (www.spinhirne.com)
+ Copyleft (c) 2006 Dustin Spinhirne
   
  Licensed under the same terms as Ruby, No Warranty is provided.
 =end
 
+require 'time'
+require 'digest/sha1'
 require File.join(File.dirname(__FILE__), 'validation_shortcuts.rb')
 require File.join(File.dirname(__FILE__), 'ip_math.rb')
 require File.join(File.dirname(__FILE__), 'cidr_shortcuts.rb')

data/lib/tree.rb

@@ -1,5 +1,5 @@
 =begin rdoc
- Copyleft (c) 2006 Dustin Spinhirne (www.spinhirne.com) 
+ Copyleft (c) 2006 Dustin Spinhirne
 
  Licensed under the same terms as Ruby, No Warranty is provided.
 =end
@@ -10,7 +10,7 @@ module NetAddr
 #
 #A class & series of methods for creating and manipulating IP-based
 #heirarchical trees. Both IPv4 and IPv6 are supported.
-# 
+#
 #A sample tree would look like:
 # 192.168.1.0/24
 #   192.168.1.0/26
@@ -36,7 +36,8 @@ class Tree
 #===Synopsis
 #Create a new Tree object.
 #
-# tree = NetAddr::Tree.new()
+# Example:
+# NetAddr::Tree.new()
 #
 #===Arguments:
 #* none
@@ -53,9 +54,9 @@ class Tree
 
 #===Synopsis
 # Add a CIDR address or NetAddr::CIDR object to the tree.
-#
+# Example:
 # tree.add!('192.168.1.0/24')
-# cidr = NetAddr::CIDR.create(:CIDR => '192.168.1.0/24', :Tag => {:title => 'test net'}
+# cidr = NetAddr::CIDR.create('192.168.1.0/24', :Tag => {:title => 'test net'}
 # tree.add!(cidr)
 #
 #===Arguments:
@@ -90,7 +91,8 @@ class Tree
 #===Synopsis
 # Returns all the ancestors of the provided CIDR addresses.
 #
-# puts tree.ancestors('192.168.1.0/27')
+# Example:
+# tree.ancestors('192.168.1.0/27')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -112,7 +114,7 @@ class Tree
         list = []
         parent = find_parent(cidr)
         until (!parent.tag[:Parent])
-            list.push(parent)
+            list.push( NetAddr.cidr_build(parent.version, parent.to_i(:network), parent.to_i(:netmask)) )
             parent = parent.tag[:Parent]
         end
 
@@ -126,7 +128,8 @@ class Tree
 #===Synopsis
 # Returns all the immediate children of the provided CIDR addresses.
 #
-# puts tree.children('192.168.1.0/24')
+# Example:
+# tree.children('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -147,7 +150,11 @@ class Tree
 
         list = []
         me = find_me(cidr)
-        me.tag[:Subnets].each {|child| list.push(child) } if (me)
+        if (me)
+            me.tag[:Subnets].each do |child|
+                list.push( NetAddr.cidr_build(child.version, child.to_i(:network), child.to_i(:netmask)) )
+            end
+        end
 
         return(list)
     end
@@ -159,7 +166,8 @@ class Tree
 #===Synopsis
 # Return all descendants of the provided CIDR address.
 #
-# descendants = tree.descendants('192.168.1.0/24')
+# Example:
+# tree.descendants('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -181,7 +189,12 @@ class Tree
         end
 
         me = find_me(cidr)
-        dump_children(me).each {|x| list.push(x[:CIDR])} if (me)
+        if (me)
+            dump_children(me).each do |x|
+                child = x[:CIDR]
+                list.push( NetAddr.cidr_build(child.version, child.to_i(:network), child.to_i(:netmask)) )
+            end
+        end
 
         return(list)
     end
@@ -193,7 +206,8 @@ class Tree
 #===Synopsis
 # Remove the provided CIDR address from the tree.
 #
-# did_remove = tree.remove!('192.168.1.0/24')
+# Example:
+# tree.remove!('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -220,7 +234,7 @@ class Tree
         # remove
         if (me)
             parent = me.tag[:Parent]
-            children = me.tag[:Subnets] 
+            children = me.tag[:Subnets]
             parent.tag[:Subnets].delete(me)
             children.each {|x| add_to_parent(x,parent)}
             removed = true
@@ -236,7 +250,8 @@ class Tree
 #===Synopsis
 # Dump the contents of this tree.
 #
-# dumped = tree.dump()
+# Example:
+# tree.dump()
 #
 #===Arguments:
 #* none
@@ -249,6 +264,7 @@ class Tree
     def dump()
         list = dump_children(@v4_root)
         list.concat( dump_children(@v6_root) )
+        list.each {|x| x[:CIDR] =  NetAddr.cidr_build(x[:CIDR].version, x[:CIDR].to_i(:network), x[:CIDR].to_i(:netmask)) }
         return(list)
     end
 
@@ -259,7 +275,8 @@ class Tree
 #===Synopsis
 # Has a CIDR address already been added to the tree?
 #
-# added = tree.exists?('192.168.1.0/24')
+# Example:
+# tree.exists?('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -291,7 +308,8 @@ class Tree
 #===Synopsis
 # Fill in the missing subnets of a particular CIDR.
 #
-# success = tree.fill_in!('192.168.1.0/24')
+# Example:
+# tree.fill_in!('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -315,6 +333,9 @@ class Tree
         me = find_me(cidr)
         if (me && me.tag[:Subnets].length != 0)
             me.tag[:Subnets] = NetAddr.cidr_fill_in(me, me.tag[:Subnets])
+            me.tag[:Subnets].each do |subnet|
+                subnet.tag[:Subnets] = [] if (!subnet.tag.has_key?(:Subnets))
+            end
             filled = true
         end
         return(filled)
@@ -327,7 +348,8 @@ class Tree
 #===Synopsis
 # Find and return a CIDR from within the tree.
 #
-# cidr = tree.find('192.168.1.0/24')
+# Example:
+# tree.find('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -338,14 +360,19 @@ class Tree
     def find(cidr)
         if ( !cidr.kind_of?(NetAddr::CIDR) )
             begin
-                cidr = NetAddr::CIDR.create(:CIDR => cidr)
+                cidr = NetAddr::CIDR.create(cidr)
             rescue Exception => error
                 raise ArgumentError, "Provided argument raised the following " +
                                      "errors: #{error}"
             end
         end
 
-        return(find_me(cidr))
+        me = find_me(cidr)
+        if (me)
+            me =  NetAddr.cidr_build(me.version, me.to_i(:network), me.to_i(:netmask)) 
+        end
+
+        return(me)
     end
 
 #==============================================================================#
@@ -356,7 +383,8 @@ class Tree
 # Find subnets that are of at least size X. Only subnets that are not themselves 
 # subnetted will be returned. :Subnet takes precedence over :IPCount
 #
-# subnets = tree.find_space(:IPCount => 16)
+# Example:
+# tree.find_space(:IPCount => 16)
 #
 #===Arguments:
 #* Minimum subnet size in bits, or a Hash with the following keys:
@@ -412,7 +440,10 @@ class Tree
             end
         end
 
-        return(list)
+        new_list = []
+        list.each {|x| new_list.push( NetAddr.cidr_build(x.version, x.to_i(:network), x.to_i(:netmask)) )}
+
+        return(new_list)
     end
 
 #==============================================================================#
@@ -423,7 +454,8 @@ class Tree
 #Find the longest matching branch of our tree to which a 
 #CIDR address belongs. Useful for performing 'routing table' style lookups.
 #
-# longest_match = tree.longest_match('192.168.1.1')
+# Example:
+# tree.longest_match('192.168.1.1')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -444,7 +476,7 @@ class Tree
         found = find_me(cidr)
         found = find_parent(cidr) if !found
 
-        return(found)
+        return( NetAddr.cidr_build(found.version, found.to_i(:network), found.to_i(:netmask)) )
     end
 
 #==============================================================================#
@@ -454,7 +486,8 @@ class Tree
 #===Synopsis
 # Remove all subnets of the provided CIDR address.
 #
-# did_prune = tree.prune!('192.168.1.0/24')
+# Example:
+# tree.prune!('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -468,7 +501,7 @@ class Tree
         # validate object
         if ( !cidr.kind_of?(NetAddr::CIDR) )
             begin
-                cidr = NetAddr::CIDR.create(:CIDR => cidr)
+                cidr = NetAddr::CIDR.create(cidr)
             rescue Exception => error
                 raise ArgumentError, "Provided argument raised the following " +
                                      "errors: #{error}"
@@ -492,7 +525,8 @@ class Tree
 #===Synopsis
 # Remove the provided CIDR address, and all of its subnets from the tree.
 #
-# did_remove = tree.remove!('192.168.1.0/24')
+# Example:
+# tree.remove!('192.168.1.0/24')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -507,7 +541,7 @@ class Tree
         # validate object
         if ( !cidr.kind_of?(NetAddr::CIDR) )
             begin
-                cidr = NetAddr::CIDR.create(:CIDR => cidr)
+                cidr = NetAddr::CIDR.create(cidr)
             rescue Exception => error
                 raise ArgumentError, "Provided argument raised the following " +
                                      "errors: #{error}"
@@ -532,7 +566,8 @@ class Tree
 #===Synopsis
 # Resize the provided CIDR address.
 #
-# resized = tree.resize!('192.168.1.0/24', 23)
+# Example:
+# tree.resize!('192.168.1.0/24', 23)
 #
 #===Arguments:
 #* CIDR address as a String or an NetAddr::CIDR object
@@ -547,7 +582,7 @@ class Tree
         # validate cidr
         if ( !cidr.kind_of?(NetAddr::CIDR) )
             begin
-                cidr = NetAddr::CIDR.create(:CIDR => cidr)
+                cidr = NetAddr::CIDR.create(cidr)
             rescue Exception => error
                 raise ArgumentError, "Provided argument raised the following " +
                                      "errors: #{error}"
@@ -573,7 +608,8 @@ class Tree
 #===Synopsis
 # Returns the root of the provided CIDR address.
 #
-# puts tree.root('192.168.1.32/27')
+# Example:
+# tree.root('192.168.1.32/27')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -601,7 +637,7 @@ class Tree
             end
         end
 
-        return(parent)
+        return( NetAddr.cidr_build(parent.version, parent.to_i(:network), parent.to_i(:netmask)) )
     end
 
 #==============================================================================#
@@ -609,9 +645,10 @@ class Tree
 #==============================================================================#
 
 #===Synopsis
-# Print the tree as a nicely formatted string.
+# Print the tree as a formatted string.
 #
-# puts tree.show()
+# Example:
+# tree.show()
 #
 #===Arguments:
 #* none
@@ -662,7 +699,8 @@ class Tree
 #===Synopsis
 # Return list of the sibling CIDRs of the provided CIDR address.
 #
-# puts tree.siblings('192.168.1.0/27')
+# Example:
+# tree.siblings('192.168.1.0/27')
 #
 #===Arguments:
 #* String or NetAddr::CIDR object
@@ -684,7 +722,7 @@ class Tree
         list = []
         find_parent(cidr).tag[:Subnets].each do |entry|
             if (!cidr.cmp(entry))
-                list.push(entry)
+                list.push( NetAddr.cidr_build(entry.version, entry.to_i(:network), entry.to_i(:netmask)) )
             end
         end
 
@@ -699,6 +737,7 @@ class Tree
 # Summarize all subnets of the provided CIDR address. The subnets will be
 # placed under the new summary address within the tree.
 #
+# Example:
 # tree.summarize_subnets!('192.168.1.0/24')
 #
 #===Arguments:
@@ -739,7 +778,8 @@ class Tree
 #===Synopsis
 # Return list of the top-level supernets of this tree.
 #
-# supernets = tree.supernets()
+# Example:
+# tree.supernets()
 #
 #===Arguments:
 #* none
@@ -749,8 +789,8 @@ class Tree
 #
     def supernets()
        supernets = []
-       @v4_root.tag[:Subnets].each {|x| supernets.push(x)}
-       @v6_root.tag[:Subnets].each {|x| supernets.push(x)}
+       @v4_root.tag[:Subnets].each {|x| supernets.push( NetAddr.cidr_build(x.version, x.to_i(:network), x.to_i(:netmask)) )}
+       @v6_root.tag[:Subnets].each {|x| supernets.push( NetAddr.cidr_build(x.version, x.to_i(:network), x.to_i(:netmask)) )}
        return (supernets)
     end
 
@@ -770,19 +810,20 @@ private
 
         if (!duplicate)
         # check parent for subnets of cidr
-            parent.tag[:Subnets].length.times do |index|
-                index -= 1
-                old_cidr = parent.tag[:Subnets][index]
+            new_parent_subs = []
+            parent.tag[:Subnets].length.times do
+                old_cidr = parent.tag[:Subnets].shift
                 cmp = NetAddr.cidr_compare(cidr, old_cidr)
                 if (cmp && cmp == 1)
                     old_cidr.tag[:Parent] = cidr
                     cidr.tag[:Subnets].push(old_cidr)
-                    parent.tag[:Subnets][index] = nil
+                else
+                    new_parent_subs.push(old_cidr)
                 end
             end
 
             cidr.tag[:Parent] = parent
-            parent.tag[:Subnets].compact!
+            parent.tag[:Subnets] = new_parent_subs
             parent.tag[:Subnets].push(cidr)
             parent.tag[:Subnets] = NetAddr.cidr_sort(parent.tag[:Subnets])
         end
@@ -797,12 +838,8 @@ private
 # Add CIDR to a Tree
 #
     def add_to_tree(cidr,root=nil)
-
-        # find cidr's parent
         parent = find_parent(cidr)
-        if (parent)
-            add_to_parent(cidr,parent)
-        end
+        add_to_parent(cidr,parent)
 
         return(nil)
     end
@@ -813,9 +850,8 @@ private
 
 #  Dump contents of an Array of NetStruct objects
 #
-    def dump_children(parent,depth=nil)
+    def dump_children(parent,depth=0)
         list = []
-        depth = 0 if (!depth)
 
         parent.tag[:Subnets].each do |entry|
             list.push({:CIDR => entry, :Depth => depth})
@@ -867,8 +903,7 @@ private
         end
         bit_diff = cidr.bits - parent.bits
 
-        # if netmask of cidr is greater by 1 bit position, then this is the parent.
-        # if not then check to make sure that one of the children is the actual parent.
+        # if bit_diff greater than 1 bit then check if one of the children is the actual parent.
         if (bit_diff > 1 && parent.tag[:Subnets].length != 0)
             list = parent.tag[:Subnets]
             found = NetAddr.cidr_find_in_list(cidr,list)

data/lib/validation_shortcuts.rb

@@ -132,17 +132,17 @@ module_function :validate_ip_str
 #==============================================================================#
 # validate_netmask_int()
 #==============================================================================#
-def validate_netmask_int(netmask,version,packed=false)
+def validate_netmask_int(netmask,version,is_int=false)
     address_len = 32
     address_len = 128 if (version == 6)
 
-    if (!packed)
+    if (!is_int)
         if (netmask > address_len || netmask < 0 )
             raise ValidationError, "Netmask, #{netmask}, is out of bounds for IPv#{version}." 
         end
     else
         if (netmask >= 2**address_len || netmask < 0 )
-            raise ValidationError, "Packed netmask, #{netmask}, is out of bounds for IPv#{version}."
+            raise ValidationError, "netmask (#{netmask}) is out of bounds for IPv#{version}."
         end
     end
     return(true)
@@ -158,27 +158,27 @@ def validate_netmask_str(netmask,version)
 
     if(netmask =~ /\./) # extended netmask
         all_f = 2**32-1
-        packed_netmask = 0
+        netmask_int = 0
 
         # validate & pack extended mask
         begin
-            packed_netmask = pack_ip_addr(netmask, :Version => 4)
+            netmask_int = NetAddr.ip_to_i(netmask, :Version => 4)
         rescue Exception => error
           raise ValidationError, "#{netmask} is improperly formed: #{error}"
         end
 
         # cycle through the bits of hostmask and compare
-        # with packed_mask. when we hit the firt '1' within
-        # packed_mask (our netmask boundary), xor hostmask and
-        # packed_mask. the result should be all 1's. this whole
+        # with netmask_int. when we hit the firt '1' within
+        # netmask_int (our netmask boundary), xor hostmask and
+        # netmask_int. the result should be all 1's. this whole
         # process is in place to make sure that we dont have
         # and crazy masks such as 255.254.255.0
         hostmask = 1
          32.times do 
-            check = packed_netmask & hostmask
+            check = netmask_int & hostmask
             if ( check != 0)
                 hostmask = hostmask >> 1
-                unless ( (packed_netmask ^ hostmask) == all_f)
+                unless ( (netmask_int ^ hostmask) == all_f)
                     raise ValidationError, "#{netmask} contains '1' bits within the host portion of the netmask." 
                 end
                 break