aaalex-ruby-ifconfig 1.2.1

data/README

@@ -0,0 +1,37 @@
+
+This is a Ruby wrapper around the ifconfig command.  The goal is to make
+getting any information that ifconfig provides easy to access.
+
+It was developed on Linux 2.6 with ifconfig from net-tools 1.60.  It also has
+support for SunOS, Darwin and Open, Free, Net, and DragonflyBSD.  These have
+not been thoroughly tested.  Non Linux platforms call netstat for interface
+packet information
+
+Please send me ifconfig / netstat output for platforms that don't work.
+
+see test/*.rb for usage examples.
+
+Thanks to Peter Johnson for the *BSD examples
+Thanks to Jeremy Tregunna for Darwin and DragonflyBSD support
+
+INSTALLATION
+------------
+
+Please see the INSTALL file for details of how to install Ruby-Ifconfig
+
+TESTING
+-------
+> rake
+to run all the unit tests.
+
+LICENCE
+-------
+
+This software is offered under the GNU GENERAL PUBLIC LICENSE, a copy of which
+is included.
+
+Section 2, paragraph b and section 5 of the GNU General Public License does not apply when the Software (Ruby/Ifconfig) is included in the program Corgi.
+
+--
+Daniel Hobe
+daniel@nightrunner.com

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake'
+require 'rake/testtask'
+
+$VERBOSE = true
+
+desc "Run all unit tests"
+task :default => [ :test_units ]
+
+desc "Run the unit tests in test/"
+task :test_units do
+  Dir.glob('test/unit/*').each do |t|
+    puts `/usr/bin/env ruby #{t}`
+  end
+end

data/TODO

@@ -0,0 +1,8 @@
+$Id: TODO,v 1.1.1.1 2005/07/02 19:10:57 hobe Exp $
+
+Clean up code to reduce duplicate code as much as possible.
+
+Test on more platforms
+
+Add concept of 'sub platform'.  For example BSD->NetBSD1.4 might be different 
+from BSD->NetBSD1.5

data/ifconfig_examples/darwin.txt

@@ -0,0 +1,17 @@
+lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384
+	inet6 ::1 prefixlen 128 
+	inet6 fe80::1 prefixlen 64 scopeid 0x1 
+	inet 127.0.0.1 netmask 0xff000000 
+gif0: flags=8010<POINTOPOINT,MULTICAST> mtu 1280
+stf0: flags=0<> mtu 1280
+en0: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+	inet6 fe80::203:93ff:fe0a:1676 prefixlen 64 scopeid 0x4 
+	inet 192.168.0.14 netmask 0xffffff00 broadcast 192.168.0.255
+	inet6 2001:5c0:8116::203:93ff:fe0a:1676 prefixlen 64 autoconf 
+	ether 00:03:93:0a:16:76 
+	media: autoselect (100baseTX <full-duplex>) status: active
+	supported media: none autoselect 10baseT/UTP <half-duplex> 10baseT/UTP <full-duplex> 10baseT/UTP <full-duplex,hw-loopback> 100baseTX <half-duplex> 100baseTX <full-duplex> 100baseTX <full-duplex,hw-loopback>
+fw0: flags=8822<BROADCAST,SMART,SIMPLEX,MULTICAST> mtu 2030
+	lladdr 00:03:93:ff:fe:0a:16:76 
+	media: autoselect <full-duplex> status: inactive
+	supported media: autoselect <full-duplex>

data/ifconfig_examples/dragonflybsd.txt

@@ -0,0 +1,10 @@
+rl0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+	inet6 fe80::202:44ff:fe8f:bb15%rl0 prefixlen 64 scopeid 0x2 
+	inet 192.168.1.24 netmask 0xffffff00 broadcast 192.168.1.255
+	ether 00:02:44:8f:bb:15
+	media: Ethernet autoselect (100baseTX <full-duplex>)
+	status: active
+lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384
+	inet6 ::1 prefixlen 128 
+	inet6 fe80::1%lo0 prefixlen 64 scopeid 0x4 
+	inet 127.0.0.1 netmask 0xff000000 

data/ifconfig_examples/dragonflybsd_netstat.txt

@@ -0,0 +1,14 @@
+ppp0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500
+sl0: flags=c010<POINTOPOINT,LINK2,MULTICAST> mtu 552
+faith0: flags=8002<BROADCAST,MULTICAST> mtu 1500
+Name    Mtu   Network       Address            Ipkts Ierrs    Opkts Oerrs  Coll
+rl0     1500  <Link#1>    00:02:44:8f:bb:15      606     0      549     0     0
+rl0     1500  fe80:2::202 fe80:2::202:44ff:        0     -        0     -     -
+rl0     1500  192.168.1     192.168.1.24         605     -      544     -     -
+lo0     16384 <Link#2>                             0     0        0     0     0
+lo0     16384 ::1/128     ::1                      0     -        0     -     -
+lo0     16384 fe80:4::1/6 fe80:4::1                0     -        0     -     -
+lo0     16384 127           127.0.0.1              0     -        0     -     -
+ppp0*   1500  <Link#3>                             0     0        0     0     0
+sl0*    552   <Link#4>                             0     0        0     0     0
+faith0* 1500  <Link#5>                             0     0        0     0     0

data/ifconfig_examples/freebsd.txt

@@ -0,0 +1,17 @@
+xl0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+        options=3<rxcsum,txcsum>
+        inet 192.168.0.2 netmask 0xffffff00 broadcast 192.168.0.255
+        inet6 fe80::201:2ff:fec6:4bea%xl0 prefixlen 64 scopeid 0x1 
+        ether 00:01:02:c6:4b:ea
+        media: Ethernet autoselect (100baseTX <full-duplex>)
+        status: active
+rl0: flags=8943<UP,BROADCAST,RUNNING,PROMISC,SIMPLEX,MULTICAST> mtu 1500
+         inet 10.0.0.10 netmask 0xffffff00 broadcast 10.0.0.255
+         inet6 fe80::200:21ff:fe03:8e1%rl0 prefixlen 64 scopeid 0x1
+         ether 00:00:21:03:08:e1
+         media: Ethernet autoselect (100baseTX )
+         status: active
+lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384
+        inet6 ::1 prefixlen 128 
+        inet6 fe80::1%lo0 prefixlen 64 scopeid 0x2 
+        inet 127.0.0.1 netmask 0xff000000

data/ifconfig_examples/freebsd_netstat.txt

@@ -0,0 +1,24 @@
+Name  Mtu   Network       Address            Ipkts Ierrs     Ibytes    Opkts Oerrs     Obytes  Coll Time Drop
+xl0   1500  <Link#1>    00:01:02:c6:4b:ea  7878752     2  404325088  5502452     0 1276760877     0   0   0
+                        33:33:46:5d:24:5a
+                        33:33:00:00:00:01
+                        33:33:ff:c6:4b:ea
+                        01:00:5e:00:00:01
+xl0   1500  192.168.0     beleriand        7865045     -  287935758  5496244     - 1199565347     -   -   -
+                        ALL-SYSTEMS.MCAST.NET
+xl0   1500  fe80:1::201 fe80:1::201:2ff:f        0     -          0        0     -          0     -   -   -
+                        ff02:1::2:465d:245a(refs: 1)
+                        ff02:1::1          (refs: 1)
+                        ff02:1::1:ffc6:4bea(refs: 1)
+lo0   16384 <Link#2>                           574     0     118916      574     0     118916     0   0   0
+lo0   16384 localhost   ::1                      0     -          0        0     -          0     -   -   -
+                        ff01::1            (refs: 1)
+                        ff02:2::1          (refs: 1)
+                        ff02:2::1:ff00:1   (refs: 2)
+lo0   16384 fe80:2::1   fe80:2::1                0     -          0        0     -          0     -   -   -
+                        ff01::1            (refs: 1)
+                        ff02:2::1          (refs: 1)
+                        ff02:2::1:ff00:1   (refs: 2)
+lo0   16384 your-net      localhost            574     -     118916      574     -     118916     -   -   -
+                        ALL-SYSTEMS.MCAST.NET
+

data/ifconfig_examples/linux.txt

@@ -0,0 +1,60 @@
+eth0      Link encap:Ethernet  HWaddr 00:50:DA:C1:C3:45  
+          inet addr:216.87.223.240  Bcast:216.87.223.255  Mask:255.255.255.0
+          inet6 addr: fe80::250:daff:fec1:c345/10 Scope:Link
+          inet6 addr: 3ffe:b00:c18:1fff::2bd/0 Scope:Global
+          IPX/Ethernet II addr:CA008137:00204808C79B
+          IPX/Ethernet SNAP addr:00204808C79B
+          IPX/Ethernet 802.2 addr:00204808C79B
+          IPX/Ethernet 802.3 addr:00204808C79B
+          EtherTalk Phase 2 addr:7349/195
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          RX packets:90170 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:2854 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:100 
+          RX bytes:1037052545 (989.0 MiB)  TX bytes:32859376 (31.3 MiB)
+          Interrupt:10 Base address:0xe400 
+
+eth0:0    Link encap:Ethernet  HWaddr 00:50:DA:C1:C3:45  
+          inet addr:172.16.0.93  Bcast:172.16.0.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          Interrupt:10 Base address:0xe400 
+
+ppp0      Link encap:Point-to-Point Protocol
+          inet addr:213.8.120.98  P-t-P:213.8.120.1  Mask:255.255.255.255
+          UP POINTOPOINT RUNNING NOARP MULTICAST  MTU:1452  Metric:1
+          RX packets:49753 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:26973 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:10
+
+sl0       Link encap:Serial Line IP
+          inet addr:192.168.1.1  P-t-P:192.168.1.2  Mask:255.255.255.0
+          UP POINTOPOINT RUNNING  MTU:1500  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0
+          TX packets:40 errors:0 dropped:0 overruns:0
+
+lo        Link encap:Local Loopback  
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          inet6 addr: ::1/128 Scope:Host
+          EtherTalk Phase 2 addr:0/0
+          UP LOOPBACK RUNNING  MTU:3924  Metric:1
+          RX packets:43 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:43 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:14564572 (13.8 MiB)  TX bytes:14564572 (13.8 MiB)
+
+sit0      Link encap:IPv6-in-IPv4  
+          inet6 addr: ::127.0.0.1/96 Scope:Unknown
+          inet6 addr: ::216.87.223.240/96 Scope:Compat
+          inet6 addr: ::172.16.0.93/96 Scope:Compat
+          UP RUNNING NOARP  MTU:1480  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0 
+
+sit1      Link encap:IPv6-in-IPv4  
+          inet6 addr: fe80::d857:dff0/10 Scope:Link
+          inet6 addr: fe80::ac10:5d/10 Scope:Link
+          UP POINTOPOINT RUNNING NOARP  MTU:1480  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:25 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0 

data/ifconfig_examples/linux_ethernet.txt

@@ -0,0 +1,20 @@
+eth0      Link encap:Ethernet  HWaddr 00:50:DA:C1:C3:45  
+          inet addr:216.87.223.240  Bcast:216.87.223.255  Mask:255.255.255.0
+          inet6 addr: fe80::250:daff:fec1:c345/10 Scope:Link
+          inet6 addr: 3ffe:b00:c18:1fff::2bd/0 Scope:Global
+          IPX/Ethernet II addr:CA008137:00204808C79B
+          IPX/Ethernet SNAP addr:00204808C79B
+          IPX/Ethernet 802.2 addr:00204808C79B
+          IPX/Ethernet 802.3 addr:00204808C79B
+          EtherTalk Phase 2 addr:7349/195
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          RX packets:90170 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:2854 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:100 
+          RX bytes:1037052545 (989.0 MiB)  TX bytes:32859376 (31.3 MiB)
+          Interrupt:10 Base address:0xe400 
+
+eth0:0    Link encap:Ethernet  HWaddr 00:50:DA:C1:C3:45  
+          inet addr:172.16.0.93  Bcast:172.16.0.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          Interrupt:10 Base address:0xe400

data/ifconfig_examples/netbsd.txt

@@ -0,0 +1,10 @@
+cs0: flags=8863<UP,BROADCAST,NOTRAILERS,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+        address: 08:00:2b:81:62:ca
+        media: Ethernet 10baseT
+        status: active
+        inet 192.168.0.3 netmask 0xffffff00 broadcast 192.168.0.255
+        inet6 fe80::a00:2bff:fe81:62ca%cs0 prefixlen 64 scopeid 0x1
+lo0: flags=8009<UP,LOOPBACK,MULTICAST> mtu 33220
+        inet 127.0.0.1 netmask 0xff000000
+        inet6 fe80::1%lo0 prefixlen 64 scopeid 0x2
+        inet6 ::1 prefixlen 128

data/ifconfig_examples/openbsd.txt

@@ -0,0 +1,36 @@
+lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 33224
+        inet 127.0.0.1 netmask 0xff000000 
+        inet6 ::1 prefixlen 128
+        inet6 fe80::1%lo0 prefixlen 64 scopeid 0x6
+lo1: flags=8008<LOOPBACK,MULTICAST> mtu 33224
+xl0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+        address: 00:01:02:c6:4b:3d
+        media: Ethernet autoselect (100baseTX full-duplex)
+        status: active
+        inet 192.168.0.1 netmask 0xffffff00 broadcast 192.168.0.255
+        inet6 fe80::201:2ff:fec6:4b3d%xl0 prefixlen 64 scopeid 0x1
+ep0: flags=8863<UP,BROADCAST,NOTRAILERS,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+        address: 00:20:af:31:99:43
+        media: Ethernet 10baseT
+        inet6 fe80::220:afff:fe31:9943%ep0 prefixlen 64 scopeid 0x2
+        inet 24.6.50.88 netmask 0xfffff800 broadcast 255.255.255.255
+pflog0: flags=41<UP,RUNNING> mtu 33224
+pfsync0: flags=0<> mtu 1896
+sl0: flags=c010<POINTOPOINT,LINK2,MULTICAST> mtu 296
+sl1: flags=c010<POINTOPOINT,LINK2,MULTICAST> mtu 296
+ppp0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500
+ppp1: flags=8010<POINTOPOINT,MULTICAST> mtu 1500
+tun0: flags=10<POINTOPOINT> mtu 3000
+tun1: flags=10<POINTOPOINT> mtu 3000
+enc0: flags=0<> mtu 1536
+bridge0: flags=0<> mtu 1500
+bridge1: flags=0<> mtu 1500
+vlan0: flags=0<> mtu 1500
+        address: 00:00:00:00:00:00
+vlan1: flags=0<> mtu 1500
+        address: 00:00:00:00:00:00
+gre0: flags=9010<POINTOPOINT,LINK0,MULTICAST> mtu 1450
+gif0: flags=8010<POINTOPOINT,MULTICAST> mtu 1280
+gif1: flags=8010<POINTOPOINT,MULTICAST> mtu 1280
+gif2: flags=8010<POINTOPOINT,MULTICAST> mtu 1280
+gif3: flags=8010<POINTOPOINT,MULTICAST> mtu 1280

data/ifconfig_examples/sunos.txt

@@ -0,0 +1,10 @@
+lo0: flags=1000849<UP,LOOPBACK,RUNNING,MULTICAST,IPv4> mtu 8232 index 1
+        inet 127.0.0.1 netmask ff000000
+        inet6 ::1/128
+bge0: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
+        inet 10.32.4.138 netmask ffffff00 broadcast 10.32.4.255
+        ether 0:3:ba:42:9d:ef
+        inet6 fe80::a00:20ff:fe72:9724/10
+le1: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 3
+        inet 172.16.254.99 netmask ffff0000 broadcast 172.16.255.255
+        ether 8:0:20:1d:71:eb

data/lib/ifconfig.rb

@@ -0,0 +1,71 @@
+# $Revision: 1.1.1.1 $
+# $Id: ifconfig.rb,v 1.1.1.1 2005/07/02 19:10:57 hobe Exp $
+
+# = Ruby/Ifconfig - ruby interface to the information presented by ifconfig
+#
+# == Prerequisites
+#
+# You must have a working ifconfig binary in your path.
+# The output format of you particular version of ifconfig must be supported.
+# Currently this has only been tested with net-tool 1.6 on Linux
+#
+# == Example
+# require 'ifconfig'
+#
+# cfg = IfconfigWrapper.new.parse        # parses the output of ifconfig
+#
+# cfg.interfaces()           # returns list of interfaces
+#
+# cfg[eth0].addresses('inet')   # returns ipv4 address of eth0
+#
+# cfg.addrresses('inet')        # returns list of all ipv4 addresses
+#
+# cfg[eth0].status   # returns true if interface is up
+#
+# cfg.each { block } # run a block on each interface object
+
+
+#
+# inspired by Net::Ifconfig::Wrapper perl module
+# by Daniel Podolsky, <tpaba@cpan.org>
+#
+# Ruby version by Daniel Hobe <daniel@packetspike.net>
+# Licence::  GPL[http://www.gnu.org/copyleft/gpl.html]
+#
+
+require 'ipaddr'
+
+class IfconfigWrapper
+  NAME = 'Ruby/Ifconfig'
+  include Enumerable
+
+  #
+  # Can manually specify the platform (should be output of the 'uname' command)
+  # and the ifconfig input
+  #
+  def initialize(platform=nil,input=nil,netstat=nil)
+    platform = self.get_os unless !platform.nil?
+    require "ifconfig/"+platform.downcase+"/ifconfig"
+    @cfg = Ifconfig.new(input,netstat)
+  end
+  def parse
+    return @cfg
+  end
+  # Find out what os we are on
+  #
+  def get_os
+    plat = IO.popen('uname'){ |f| f.gets.strip }
+    case plat
+      when 'Windows'
+        return plat
+      when 'Linux'
+        return plat
+      when 'SunOS'
+        return plat
+      when 'FreeBSD','OpenBSD','NetBSD','DragonFly','Darwin'
+        return 'BSD'
+      else
+        return 'Linux'
+    end
+  end
+end

data/lib/ifconfig/bsd/ifconfig.rb

@@ -0,0 +1,72 @@
+# $Id: ifconfig.rb,v 1.1.1.1 2005/07/02 19:10:58 hobe Exp $
+#
+require 'ifconfig/common/ifconfig'
+require 'ifconfig/bsd/network_types'
+require 'ifconfig/bsd/interface_types'
+
+class Ifconfig
+  #
+  # ifconfig = user provided ifconifg output
+  # netstat = same, but for netstat -in
+  #
+  @@ifcfg_cmd = "/usr/bin/env ifconfig -a"
+  @@netstat_cmd = "/usr/bin/env netstat -in"
+  def initialize(ifconfig=nil,netstat=nil,verbose=nil)
+    @ifconfig = ifconfig
+    @ifconfig ||= IO.popen(@@ifcfg_cmd){ |f| f.readlines.join }
+
+    @netstat = netstat
+    @netstat ||= IO.popen(@@netstat_cmd){ |f| f.readlines.join }
+
+    @verbose = verbose
+
+    @ifaces = {}
+    split_interfaces(@ifconfig).each do |iface|
+      iface_name = get_iface_name(iface)
+      case iface
+        when /^lo\d\:/im
+          @ifaces[iface_name] = LoopbackInterface.new(iface_name,iface)
+          parse_activity(iface_name)
+        when /\s+media\:\s+Ethernet\s+/im
+          @ifaces[iface_name] = EthernetAdapter.new(iface_name,iface)
+          parse_activity(iface_name)
+        when /\s+supported\smedia\:\s+none\s+autoselect\s+/im
+          # This clause is only matched on Darwin. This pattern will only be
+          # matched on ethernet devices (won't match on fw0 or any other
+          # interface I can see).
+          @ifaces[iface_name] = EthernetAdapter.new(iface_name,iface)
+          parse_activity(iface_name)
+        else
+          puts "Unknown Adapter Type: #{iface}" if @verbose
+      end
+    end
+  end
+
+  # Parse activity on interface
+  #
+  # Not doing it in each interface class so we can pass in
+  # fake input
+  #
+  def parse_activity(iface)
+    mtu = rxpackets = rxerrors = txpackets = txerrors = 0
+    @netstat.split("\n").each { |line|
+      line.strip!
+      if line =~ /^#{iface}/
+        next if line.split[2] =~ /\<Link\#\d\>/
+        puts "matched line for "+iface
+        toks = line.split
+        mtu = toks[1]
+        rxpackets += toks[4].to_i
+        rxerrors += toks[5].to_i
+        txpackets += toks[6].to_i
+        txerrors += toks[7].to_i
+        @ifaces[iface].mtu = mtu.to_i
+        @ifaces[iface].rx = { 'packets' => rxpackets,
+                              'errors' => rxerrors }
+        @ifaces[iface].tx = { 'packets' => txpackets,
+                              'errors' => txerrors }
+      end
+    }
+  end
+
+end