ipadmin 0.4.0 → 0.4.1

data/README

@@ -50,190 +50,6 @@
  You can see how the CIDR object is based around the entire IP space
  defined by the provided IP/Netmask pair, and not necessarily the individual
  IP address itself.
- 
- 
-====Examples: 
-
- #!/usr/bin/ruby
-
- require 'rubygems'
- require_gem 'ipadmin'
-
- puts "IPAdmin::CIDR"
- print "\n"
-
- # new
- cidr4 = IPAdmin::CIDR.new('192.168.1.0/24')
- cidr4 = IPAdmin::CIDR.new(:CIDR => '192.168.1.1',
-                           :Netmask => '255.255.255.0',
-                           :Tag => {'test' => 'cidr4 tag'})
- cidr6 = IPAdmin::CIDR.new('fec0::1/64')
- 
- cidr4_2 = IPAdmin::CIDR.new('192.168.1.0/26')
- cidr6_2 = IPAdmin::CIDR.new('fec0::0/96')
-
- # reader/writer
- puts "reader/writer"
- puts "cidr4 tag '#{cidr4.tag['test']}'"
- cidr4.tag['test'] = 'modified cidr4 tag'
- puts "updated cidr4 tag '#{cidr4.tag['test']}'"
- puts "cidr4 version #{cidr4.version}"
- puts "cidr6 version #{cidr6.version}"
- print "\n"  
- 
- # arpa
- puts "arpa"
- puts "arpa for #{cidr4.desc()} is #{cidr4.arpa}"
- puts "arpa for #{cidr6.desc(:Short => true)} is #{cidr6.arpa}"
- print "\n"
- 
- # bits
- puts "bits"
- puts "cidr4 netmask in bits #{cidr4.bits()}"
- puts "cidr6 netmask in bits #{cidr6.bits()}"
- print "\n"
- 
- # contains?
- puts "contains"
- puts "#{cidr4.desc} contains #{cidr4_2.desc}" if ( cidr4.contains?(cidr4_2) )
- puts "#{cidr6.desc} contains #{cidr6_2.desc(:Short => true)}" if ( cidr6.contains?(cidr6_2) )
- print "\n"
-
- # desc
- puts "desc"
- puts "cidr4 description #{cidr4.desc()}"
- puts "cidr6 description #{cidr6.desc()}"
- puts "cidr6 short-hand description #{cidr6.desc(:Short => true)}"
- print "\n"
-
- # enumerate
- puts "enumerate"
- puts "first 4 cidr4 addresses (bitstep 32)"
- cidr4.enumerate(:Limit => 4, :Bitstep => 32).each {|x| puts "  #{x}"}
- 
- puts "first 4 cidr6 addresses (bitstep 32)"
- cidr6.enumerate(:Limit => 4, :Bitstep => 32, :Objectify => true).each {|x| puts "  #{x.desc}"}
- print "\n"
-
- # fill_in
- puts "fill_in"
- puts "#{cidr4.desc} filled-in is:"
- cidr4.fill_in([cidr4_2]).each {|x| puts x}
- print "\n"
- 
- # hostmask_ext
- puts "hostmask_ext"
- puts "cidr4 extended hostmask #{cidr4.hostmask_ext()}"
- print "\n" 
-  
- # ip
- puts "ip"
- puts "cidr4 ip #{cidr4.ip()}"
- puts "cidr6 short-hand ip #{cidr6.ip(:Short => true)}"
- print "\n"
- 
- # last
- puts "last"
- puts "cidr4 last ip #{cidr4.last()}"
- puts "cidr6 last ip #{cidr6.last(:Short => true)}"
- print "\n"
- 
- # multicast_mac
- mcast = IPAdmin::CIDR.new('224.0.0.6')
- mcast2 = IPAdmin::CIDR.new('ff00::abcd')
- puts "multicast_mac"
- puts "#{mcast.ip} multicast mac is #{mcast.multicast_mac()}"
- puts "#{mcast2.ip} multicast mac is #{mcast2.multicast_mac()}"
- print "\n"
-
- # netmask
- puts "netmask"
- puts "cidr4 netmask in CIDR format #{cidr4.netmask()}"
- puts "cidr6 netmask in CIDR format #{cidr6.netmask()}"
- print "\n"
- 
- # netmask_ext
- puts "netmask_ext"
- puts "cidr4 extended netmask #{cidr4.netmask_ext()}"
- print "\n"
-
- # network
- puts "network"
- puts "cidr4 network address #{cidr4.network()}"
- puts "cidr6 network address #{cidr6.network(:Short => true)}"
- print "\n"
- 
- # next_ip
- puts "next_ip"
- puts "cidr4 next ip #{cidr4.next_ip()}"
- puts "cidr6 next ip #{cidr6.next_ip(:Short => true)}"
- print "\n"
- 
- # next_subnet
- puts "next_subnet"
- puts "cidr4 next subnet #{cidr4.next_subnet()}"
- puts "cidr6 next subnet #{cidr6.next_subnet(:Short => true)}"
- print "\n"
-
- # nth
- puts "nth"
- puts "cidr4 1st ip is #{cidr4.nth(1)}"
- puts "cidr6 1st ip is #{(cidr6.nth(:Index => 1, :Objectify => true)).base}"
- print "\n"
- 
- # packed_hostmask
- puts "packed_hostmask"
- puts "cidr4 packed_hostmask is #{cidr4.packed_hostmask.to_s(16)}"
- puts "cidr6 packed_hostmask is #{cidr6.packed_hostmask.to_s(16)}"
- print "\n"
- 
- # packed_netmask
- puts "packed_netmask"
- puts "cidr4 packed_netmask is #{cidr4.packed_netmask.to_s(16)}"
- puts "cidr6 packed_netmask is #{cidr6.packed_netmask.to_s(16)}"
- print "\n"
- 
- # packed_network
- puts "packed_network"
- puts "cidr4 packed_network is #{cidr4.packed_network.to_s(16)}"
- puts "cidr6 packed_network is #{cidr6.packed_network.to_s(16)}"
- print "\n"
- 
- # range
- puts "range"
- cidr4.range(:Indexes => [20,0], :Bitstep => 5).each {|x| puts x}
- cidr6.range(:Indexes => [20,0], :Bitstep => 5).each {|x| puts x}
- print "\n" 
- 
- # remainder
- puts "remainder"
- cidr4_2 = IPAdmin::CIDR.new('192.168.1.64/26')
- puts "The remainder of #{cidr4.desc} after subtracting #{cidr4_2.desc} is:"
- cidr4.remainder(cidr4_2).each {|x| puts x}
- print "\n" 
-  
- # resize!
- puts "resize!"
- cidr4.resize!(25)
- cidr6.resize!(:Netmask => 65)
- puts "cidr4 resized is #{cidr4.desc}"
- puts "cidr6 resized is #{cidr6.desc}"
- print "\n"
-
- # size
- puts "size"
- puts "cidr4 size is #{cidr4.size()}"
- puts "cidr6 size is #{cidr6.size()}"
- print "\n"
-
- # subnet
- puts "subnet"
- puts "#{cidr4.desc} subnetted into at least 3 /28 ranges"
- cidr4.subnet(:Subnet => 28, :MinCount => 3).each {|x| puts "  #{x}"} 
- 
- puts "#{cidr6.desc(:Short => true)} subnetted into at least 4 /67 ranges"
- cidr6.subnet(:Subnet => 67, :MinCount => 4, :Short => true).each {|x| puts "  #{x}"}
-
 
 
 
@@ -254,49 +70,6 @@
  Link Local addresses use MAC addresses for IP auto-assignment and multicast MAC addresses
  are determined based on the multicast IP address.
 
-====Examples: 
-
- #!/usr/bin/ruby
-
- require 'rubygems'
- require_gem 'ipadmin'
- 
- puts "IPAdmin::EUI"
- print "\n"
- 
- eui1 = IPAdmin::EUI48.new('aa-bb-cc-dd-ee-ff')
- eui2 = IPAdmin::EUI64.new('12-34-56-78-9a-bc-de-f0')
- 
- # oui
- puts "oui"
- puts "OUI 1 is #{eui1.oui}"
- puts "OUI 2 is #{eui2.oui}"
- print "\n"
- 
- # ei
- puts "ei"
- puts "EI 1 is #{eui1.ei}"
- puts "EI 2 is #{eui2.ei}"
- print "\n"
- 
- # address
- puts "address"
- puts "address 1 is #{eui1.address(:Delimiter => '.')}"
- puts "address 2 is #{eui2.address(:Delimiter => '.')}"
- print "\n"
- 
- # link local
- puts "link local"
- puts "IPv6 link local 1 is #{eui1.link_local(:Short => true)}"
- puts "IPv6 link local 2 is #{eui2.link_local(:Short => true)}"
- print "\n"
- 
- # type
- puts "class"
- puts "eui 1 is a #{eui1.class}"
- puts "eui 2 is a #{eui2.class}"
-
-
 
 
 =Tree
@@ -321,241 +94,188 @@
    192.168.1.192/26
  
  
-====Examples: 
+
+=Example Script
 
  #!/usr/bin/ruby
 
+ # A script to parse static routes from a Cisco router.
+ # Performs the following tasks:
+ #  - organizes statics by directly connected next-hop interface
+ #  - corrects recursive static routes
+ #  - reports statics with no directly connected next-hop
+ #  - reports duplicate static routes
+ #  - reports static routes that overlap directly connected interfaces
+ #
+ # Change the variable 'infile' to that of the name of the router configuration
+ # file that should be parsed.
+
  require 'rubygems'
  require_gem 'ipadmin'
- 
- puts "IPAdmin::Tree"
- print "\n"
-
- cidr4 = ['192.168.1.0/24','192.168.1.0/26','192.168.1.64/26',
-          '192.168.1.128/26','192.168.1.192/26','192.168.1.0/27',
-          '192.168.1.0/28','192.168.1.16/30','192.168.1.16/29',
-          '192.168.1.32/27','192.168.1.24/30','192.168.1.28/30',
-          '192.168.1.64/27','192.168.1.25']
- 
- cidr6 = ['fec0::/60','fec0::/66','fec0::4000:0:0:0/66',
-          'fec0::8000:0:0:0/66','fec0::c000:0:0:0/66','fec0::c000:0:0:0/67',
-          'fec0::/67','fec0::2000:0:0:0/67','fec0::8000:0:0:0/67','fec0::4000:0:0:0/69']
 
- # new
- tree = IPAdmin::Tree.new()
+ # change this variable to that of the router config file
+ infile = 'router_config.txt'
+
+
+ ip_interface_count = 0
+ static_route_count = 0
+ connected_routes = []
+ static_routes = []
+ statics = {}
+ grouped_routes = {}
+ duplicates = []
+ recursives = []
+ corrected_statics = []
+ overlapping_statics = []
+
+
+ # sort through router config. put connected ip interfaces into 'connected_routes'
+ # and static routes into 'statics'. Set aside duplicate static routes.
+ File.open(infile, 'r') do |file|
+     while line = file.gets
+         if (line =~/^interface .+/)
+             interface = line.chomp
+         elsif (line =~ /^\s*ip address/) # connected interface
+             ip_interface_count += 1
+             addr = line.split('ip address ').join # ['x.x.x.x y.y.y.y']
+             cidr = IPAdmin::CIDR.new(:CIDR => addr, :Tag => {:interface => interface})
+             connected_routes.push(cidr)
+         elsif (line =~/^ip route/) # static route
+             static_route_count += 1
+             elements = line.split(' ') # ['ip','route','x.x.x.x','y.y.y.y','x.x.x.x',]
+                ip = elements[2]
+                netmask = elements[3]
+                nexthop = elements[4]
+
+             # keep all but loopbacks, nulls, or defaults
+             if ( (nexthop !~ /Loopback/) && (nexthop !~ /Null/) && (ip != '0.0.0.0') )
+                 nexthop_cidr = IPAdmin::CIDR.new(nexthop)
+                 cidr = IPAdmin::CIDR.new(:CIDR => "#{ip} #{netmask}",
+                                          :Tag => {:route => line, :nexthop => nexthop_cidr})
+
+                 if (!statics.has_key?(cidr.desc))
+                     statics[cidr.desc] = cidr
+                 else
+                     msg = '! overlaps with - ' + statics[cidr.desc].tag[:route] + line + "!\n"
+                     duplicates.push(msg)
+                 end
+             end
+         end
+     end
+ end
 
 
- # add!
- puts "add!"
- cidr4.each do |x| 
-    puts "adding #{x}..."
-    tree.add!(x)
+ # look for statics that overlap with a connected interface, and
+ # group static routes with their next-hop interface.
+ statics.each_key do  |desc|
+     cidr = statics[desc]
+     nexthop = cidr.tag[:nexthop]
+     route = cidr.tag[:route]
+
+     overlaps_with = nil
+     nexthop_int = nil
+     connected_routes.each do |interface|
+         if (interface.contains?(cidr)) # overlapping static
+             overlaps_with = interface
+             break
+         elsif (interface.contains?(nexthop)) # next-hop directly connected
+             nexthop_int = interface
+             break
+         end
+     end
+
+     if (nexthop_int)
+         key = "#{nexthop_int.tag[:interface]} -> #{nexthop_int.desc}"
+         if (grouped_routes.has_key?(key))
+             grouped_routes[key].push(route)
+         else
+             grouped_routes[key] = [route]
+         end
+         static_routes.push(cidr)
+     elsif (overlaps_with)
+         overlap = "! overlaps with: #{overlaps_with.tag[:interface]} -> #{overlaps_with.desc}"
+         overlap << "\n#{route}!\n"
+         overlapping_statics.push(overlap)
+     else
+         recursives.push(cidr)
+     end
  end
- cidr6.each do |x| 
-    puts "adding #{x}..."
-    tree.add!(x)
+
+
+ # process recursive routes. update next-hop so that it points
+ # to next hop of a directly connected ip. remove any that do not point to a
+ # directly connected ip. We must continually cycle through the list, as the
+ # 'static_routes' tree is constantly updated. We do this until our list of
+ # recursive static routes stops getting any shorter
+ recursives_count = 0
+ until (recursives_count == recursives.length)
+     recursives_count = recursives.length
+     recursives.each do  |cidr|
+         nexthop = cidr.tag[:nexthop]
+         route = cidr.tag[:route]
+
+         found = nil
+         static_routes.each do |static|
+             if (static.contains?(nexthop))
+                 found = static
+                 break
+             end
+         end
+
+         if (found)
+             updated = 'no ' + route
+             updated << "ip route #{cidr.network} #{cidr.netmask_ext} #{found.tag[:nexthop].ip}\n"
+             updated << "!\n"
+             corrected_statics.push(updated)
+             static_routes.push(cidr)
+             recursives.delete(cidr)
+         end
+     end
  end
- print "\n"
- 
- # ancestors
- puts "ancestors"
- puts "ancestors for 192.168.1.16/28 are..."
- tree.ancestors('192.168.1.16/28').each {|x| puts x.desc}
- print "\n"
- 
- # children
- puts "children"
- puts "children of 192.168.1.0/24 are..."
- tree.children('192.168.1.0/24').each {|x| puts x.desc}
- print "\n"
- 
- # delete!
- puts "delete!"
- puts "deleting 192.168.1.16/29"
- tree.delete!('192.168.1.16/29')
- print "\n"
-
- # descendants
- puts "descendants"
- puts "descendants of 192.168.1.0/26 are..."
- tree.descendants('192.168.1.0/26').each {|x| puts x.desc}
- print "\n"
-
- # dump
- puts "dump"
- puts "dumping & printing tree"
- dumped = tree.dump()
- dumped.each do |val|
-    cidr = val[:CIDR]
-    depth = val[:Depth]
-    if (depth > 0)
-        indent = " " * (depth*3)
-        puts indent << cidr.desc()
-    else
-        puts cidr.desc()
-    end
+
+
+ # print results.
+ puts "--- STATISTICS ---"
+ puts "#{ip_interface_count} Connected IP Interfaces\n#{static_route_count} IP Static Routes\n"
+
+ print "\n\n"
+
+ puts "--- OVERLAPPING STATIC ROUTES ---"
+ overlapping_statics.each do |overlap|
+     puts overlap
  end
- print "\n"  
 
- # exists?
- puts "exists?"
- puts "192.168.1.32/27 is in the tree." if tree.exists?('192.168.1.32/27')
- print "\n"
- 
- # fill_in
- puts "fill_in!"
- puts "filling in subnets of 192.168.1.64/26."
- tree.fill_in!('192.168.1.64/26')
- tree.children('192.168.1.64/26').each {|x| puts x.desc}
- print "\n"
- 
- # find
- puts "find"
- puts "finding and setting a tag for 192.168.1.64/26..."
- tree.find('192.168.1.64/26').tag[:test] = 'testing'
- print "\n"
- 
- # find_space
- puts "find_space"
- puts "finding version 4 subnets with at least 16 ips..."
- tree.find_space(:IPCount => 16, :Version => 4).each {|x| puts x.desc}
- print "\n"
-
- # longest_match
- puts "longest_match"
- puts "192.168.1.33 belongs in #{tree.longest_match('192.168.1.33').desc}"
- print "\n"  
-
- # merge_subnets
- puts "merge_subnets!"
- puts "merging the subnets of 192.168.1.0/27"
- tree.merge_subnets!('192.168.1.0/27')
- puts tree.show
- print "\n"
- 
- # prune
- puts "prune!"
- puts "pruning subnets of 192.168.1.0/27"
- tree.prune!('192.168.1.0/27') 
- print "\n"
- 
- # remove
- puts "remove!"
- puts "removing fec0::c000:0:0:0/67, and all of its subnets"
- tree.remove!('fec0::c000:0:0:0/67')
- print "\n"
- 
- # resize
- puts "resize!"
- puts "resizing fec0::/60 into a /65"
- tree.resize!('fec0::/60', 65)
- print "\n"
- 
- # root
- puts "root"
- puts "root of 192.168.1.32/27 is #{tree.root('192.168.1.32/27').desc}"
- print "\n"
- 
- # siblings
- puts "siblings"
- puts "siblings of 192.168.1.0/26 are..."
- tree.siblings('192.168.1.0/26').each {|x| puts x.desc}
- print "\n"
- 
- # supernets
- puts "supernets"
- puts "supernets of this tree are..."
- tree.supernets.each {|x| puts x.desc}
- print "\n"
- 
- # show
- puts "show"
- puts "showing tree..."
- puts tree.show
- 
+ print "\n\n"
 
+ puts "--- DUPLICATE STATIC ROUTES ---"
+ duplicates.each do |route|
+     puts route
+ end
 
-=General Methods
+ print "\n\n"
 
- A collection of general purpose methods that dont really fit within
- any particular class.
-  
+ puts "--- STATIC ROUTES WITH UPDATED NEXT-HOP ---"
+ corrected_statics.each do |route|
+     puts route
+ end
 
-====Examples: 
+ print "\n\n"
 
- #!/usr/bin/ruby
+ puts "--- STATIC ROUTES WITH UNKNOWN NEXT-HOP ---"
+ recursives.each do |cidr|
+     puts cidr.tag[:route]
+ end
 
- require 'rubygems'
- require_gem 'ipadmin'
- 
- puts "IPAdmin Methods"
- print "\n"
- 
- # validate ip
- puts "validate ip"
- puts "192.168.1.0 is valid" if ( IPAdmin.validate_ip_addr('192.168.1.0') )
- puts "fec0::0 is valid" if ( IPAdmin.validate_ip_addr('fec0::0') )
- puts "::ffff:10.1.0.1 is valid" if ( IPAdmin.validate_ip_addr('::ffff:10.1.0.1') )
- print "\n"
-
- # validate netmask
- puts "validate netmask"
- puts "255.255.255.0 is valid" if (IPAdmin.validate_ip_netmask('255.255.255.0') )
- puts "/24 is valid" if ( IPAdmin.validate_ip_netmask('/24') )
- puts "/64 is valid" if ( IPAdmin.validate_ip_netmask(:Netmask => 64, :Version => 6) )
-
- cidr4_1 = IPAdmin::CIDR.new('192.168.1.0/24')
- cidr4_2 = IPAdmin::CIDR.new('192.168.1.0/25')
- cidr4_3 = IPAdmin::CIDR.new('192.168.1.50')
- cidr6_1 = IPAdmin::CIDR.new('fec0::0/10')
- cidr6_2 = IPAdmin::CIDR.new('fec0::0/64')
- print "\n"
-
- # compare
- puts "compare"
- comp1 = IPAdmin.compare(cidr4_1,cidr4_2)
- comp2 = IPAdmin.compare(cidr6_1,cidr6_2)
- puts "#{(comp1[0]).desc} is the supernet of #{(comp1[1]).desc}"
- puts "#{(comp2[0]).desc} is the supernet of #{(comp2[1]).desc}"
-
- cidr4_1 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/24')
- cidr4_2 = IPAdmin::CIDR.new(:CIDR => '192.168.0.0/24')
- cidr6_1 = IPAdmin::CIDR.new(:CIDR => 'fec0::0/128')
- cidr6_2 = IPAdmin::CIDR.new(:CIDR => 'fec0::1/128')
- print "\n"
- 
- # merge
- puts "merge"
- puts "merging 192.168.1.0/27, 192.168.1.32/27, 192.168.1.64/26, and 192.168.1.128/25..."
- IPAdmin.merge(['192.168.1.0/27','192.168.1.32/27','192.168.1.64/26','192.168.1.128/25']).each {|x| puts x}
- print "\n"
- 
- # minimum_size
- puts "minimum_size"
- puts "The subnet size (in bits) for IPv4 that would fit 22 addresses is /#{IPAdmin.minimum_size(22)}"
- print "\n"
-
- # range
- puts "range"
- list = IPAdmin.range(:Boundaries => [cidr4_1,cidr4_3], :Bitstep => 20 )
- puts "ip's between #{cidr4_1.base} and #{cidr4_3.base} (bitstep of 20)"
- list.each do |x|
-  puts "  #{x}"
+ print "\n\n"
+
+ puts "--- STATIC ROUTES GROUPED BY NEXT-HOP INTERFACE ---"
+ grouped_routes.each_key do |interface|
+     routes = grouped_routes[interface]
+     puts interface
+     routes.each do |route|
+         puts route
+     end
+     print "\n"
  end
- print "\n"
- 
- # sort
- puts "sort"
- puts " 192.168.1.0/24, 192.168.1.0/30, 192.168.2.0/32, 10.10.10.10 sorted are..."
- IPAdmin.sort(['192.168.1.0/24','192.168.1.0/30','192.168.2.0/32','10.10.10.10']).each {|x| puts x}
- print "\n"
- 
- # shorten
- puts "shorten"
- puts "shorthand notation for  #{cidr6_1.network()} is #{IPAdmin.shorten(cidr6_1.network)}"
- print "\n"
- 
- # unshorten
- puts "unshorten"
- puts "expanded notation for  fec0:: is #{IPAdmin.unshorten('fec0::')}"
- 
+
+ __END__