network_interface 0.0.1

data/ext/network_interface_ext/netifaces.h

@@ -0,0 +1,185 @@
+#ifndef WIN32
+
+#  include <sys/types.h>
+#  include <sys/socket.h>
+#  include <net/if.h>
+#  include <netdb.h>
+
+#  if HAVE_SOCKET_IOCTLS
+#    include <sys/ioctl.h>
+#    include <netinet/in.h>
+#    include <arpa/inet.h>
+#if defined(__sun)
+#include <unistd.h>
+#include <stropts.h>
+#include <sys/sockio.h>
+#endif
+#  endif /* HAVE_SOCKET_IOCTLS */
+
+/* For logical interfaces support we convert all names to same name prefixed with l */
+#if HAVE_SIOCGLIFNUM
+#define CNAME(x) l##x
+#else
+#define CNAME(x) x
+#endif
+
+#if HAVE_NET_IF_DL_H
+#  include <net/if_dl.h>
+#endif
+
+/* For Linux, include all the sockaddr
+   definitions we can lay our hands on. */
+#if !HAVE_SOCKADDR_SA_LEN
+#  if HAVE_NETASH_ASH_H
+#    include <netash/ash.h>
+#  endif
+#  if HAVE_NETATALK_AT_H
+#    include <netatalk/at.h>
+#  endif
+#  if HAVE_NETAX25_AX25_H
+#    include <netax25/ax25.h>
+#  endif
+#  if HAVE_NETECONET_EC_H
+#    include <neteconet/ec.h>
+#  endif
+#  if HAVE_NETIPX_IPX_H
+#    include <netipx/ipx.h>
+#  endif
+#  if HAVE_NETPACKET_PACKET_H
+#    include <netpacket/packet.h>
+#  endif
+#  if HAVE_NETROSE_ROSE_H
+#    include <netrose/rose.h>
+#  endif
+#  if HAVE_LINUX_IRDA_H
+#    include <linux/irda.h>
+#  endif
+#  if HAVE_LINUX_ATM_H
+#    include <linux/atm.h>
+#  endif
+#  if HAVE_LINUX_LLC_H
+#    include <linux/llc.h>
+#  endif
+#  if HAVE_LINUX_TIPC_H
+#    include <linux/tipc.h>
+#  endif
+#  if HAVE_LINUX_DN_H
+#    include <linux/dn.h>
+#  endif
+
+/* Map address families to sizes of sockaddr structs */
+static int af_to_len(int af) 
+{
+  switch (af) 
+  {
+    case AF_INET: return sizeof (struct sockaddr_in);
+#if defined(AF_INET6) && HAVE_SOCKADDR_IN6
+    case AF_INET6: return sizeof (struct sockaddr_in6);
+#endif
+#if defined(AF_AX25) && HAVE_SOCKADDR_AX25
+#  if defined(AF_NETROM)
+    case AF_NETROM: /* I'm assuming this is carried over x25 */
+#  endif
+    case AF_AX25: return sizeof (struct sockaddr_ax25);
+#endif
+#if defined(AF_IPX) && HAVE_SOCKADDR_IPX
+    case AF_IPX: return sizeof (struct sockaddr_ipx);
+#endif
+#if defined(AF_APPLETALK) && HAVE_SOCKADDR_AT
+    case AF_APPLETALK: return sizeof (struct sockaddr_at);
+#endif
+#if defined(AF_ATMPVC) && HAVE_SOCKADDR_ATMPVC
+    case AF_ATMPVC: return sizeof (struct sockaddr_atmpvc);
+#endif
+#if defined(AF_ATMSVC) && HAVE_SOCKADDR_ATMSVC
+    case AF_ATMSVC: return sizeof (struct sockaddr_atmsvc);
+#endif
+#if defined(AF_X25) && HAVE_SOCKADDR_X25
+    case AF_X25: return sizeof (struct sockaddr_x25);
+#endif
+#if defined(AF_ROSE) && HAVE_SOCKADDR_ROSE
+    case AF_ROSE: return sizeof (struct sockaddr_rose);
+#endif
+#if defined(AF_DECnet) && HAVE_SOCKADDR_DN
+    case AF_DECnet: return sizeof (struct sockaddr_dn);
+#endif
+#if defined(AF_PACKET) && HAVE_SOCKADDR_LL
+    case AF_PACKET: return sizeof (struct sockaddr_ll);
+#endif
+#if defined(AF_ASH) && HAVE_SOCKADDR_ASH
+    case AF_ASH: return sizeof (struct sockaddr_ash);
+#endif
+#if defined(AF_ECONET) && HAVE_SOCKADDR_EC
+    case AF_ECONET: return sizeof (struct sockaddr_ec);
+#endif
+#if defined(AF_IRDA) && HAVE_SOCKADDR_IRDA
+    case AF_IRDA: return sizeof (struct sockaddr_irda);
+#endif
+  }
+  return sizeof (struct sockaddr);
+}
+
+#define SA_LEN(sa)      af_to_len(sa->sa_family)
+#if HAVE_SIOCGLIFNUM
+#define SS_LEN(sa)      af_to_len(sa->ss_family)
+#else
+#define SS_LEN(sa)      SA_LEN(sa)
+#endif
+#else
+//remove a warning on openbsd
+#ifndef SA_LEN
+#define SA_LEN(sa)      sa->sa_len
+#endif
+#endif /* !HAVE_SOCKADDR_SA_LEN */
+
+#  if HAVE_GETIFADDRS
+#    include <ifaddrs.h>
+#  endif /* HAVE_GETIFADDRS */
+
+#  if !HAVE_GETIFADDRS && (!HAVE_SOCKET_IOCTLS || !HAVE_SIOCGIFCONF)
+/* If the platform doesn't define, what we need, barf.  If you're seeing this,
+   it means you need to write suitable code to retrieve interface information
+   on your system. */
+#    error You need to add code for your platform.
+#  endif
+
+#else /* defined(WIN32) */
+
+#include <windows.h>
+#include <winsock2.h>
+#include <iphlpapi.h>
+
+#endif /* defined(WIN32) */
+
+#ifndef TRUE
+#define TRUE 1
+#endif
+
+#ifndef FALSE
+#define FALSE 0
+#endif
+
+/* On systems without AF_LINK (Windows, for instance), define it anyway, but
+   give it a crazy value.  On Linux, which has AF_PACKET but not AF_LINK,
+   define AF_LINK as the latter instead. */
+#ifndef AF_LINK
+#  ifdef AF_PACKET
+#    define AF_LINK  AF_PACKET
+#  else
+#    define AF_LINK  -1000
+#  endif
+#  define HAVE_AF_LINK 0
+#else
+#  define HAVE_AF_LINK 1
+#endif
+
+
+//Prototypes
+//Get a list of the adresses for a network interface
+VALUE rbnetifaces_s_addresses (VALUE class, VALUE dev);
+//Get a list of the network interfaces
+VALUE rbnetifaces_s_interfaces (VALUE self);
+//This function is usefull only under windows to retrieve some additionnal interfaces informations
+VALUE rbnetifaces_s_interface_info (VALUE self, VALUE dev);
+
+void Init_network_interface_ext();

data/lib/network_interface.rb

@@ -0,0 +1,6 @@
+require 'network_interface/version'
+
+module NetworkInterface  
+end
+
+require 'network_interface_ext'

data/lib/network_interface/version.rb

@@ -0,0 +1,3 @@
+module NetworkInterface
+  VERSION = "0.0.1"
+end

data/network_interface.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'network_interface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "network_interface"
+  spec.version       = NetworkInterface::VERSION
+  spec.authors       = ["Brandon Turner", "Lance Sanchez"]
+  spec.email         = ["lance.sanchez@rapid7.com", "brandon_turner@rapid7.com"]
+  spec.summary       = "A cross platform gem to help get network interface information"
+  spec.description   = %q{
+     This gem was originally added to the Metasploit Pcaprub gem. It's been spun
+     out into its own gem for anyone who might want to programmatically get
+     information on their network interfaces. }
+  spec.homepage      = "https://github.com/rapid7/network_interface"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.extensions    = ['ext/network_interface_ext/extconf.rb']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler", ">= 0"
+  spec.add_development_dependency "rspec"
+end

data/spec/netiface_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe NetworkInterface do
+
+  describe "#interfaces" do
+    it "should have the same interfaces as the system_interfaces" do
+      NetworkInterface.interfaces.should include(*system_interfaces_with_addresses.keys)
+    end
+  end
+  
+  describe "#addresses" do
+    system_interfaces_with_addresses.each do |interface, hash|
+      describe "#{friendly_interface_names.key(interface)}" do
+        if hash.has_key?(:ipv4)
+          describe "ipv4" do
+            it "should have an ipv4 address" do
+              NetworkInterface.addresses(interface).should have_key NetworkInterface::AF_INET
+            end
+            it "should match the system interface of #{hash[:ipv4]}" do
+              NetworkInterface.addresses(interface)[NetworkInterface::AF_INET][0]["addr"].should == hash[:ipv4]
+            end
+          end
+        end
+        if hash.has_key?(:ipv6)
+          describe "ipv6" do
+            it "should have an ipv6 address" do
+              NetworkInterface.addresses(interface).should have_key NetworkInterface::AF_INET6
+            end
+            it "should match the system interface of #{hash[:ipv6]}" do
+              NetworkInterface.addresses(interface)[NetworkInterface::AF_INET6][0]["addr"].should == hash[:ipv6]
+            end
+          end          
+        end
+        if hash.has_key?(:mac)
+          describe "MAC address" do
+            it "should have a MAC address" do
+              NetworkInterface.addresses(interface).should have_key NetworkInterface::AF_LINK
+            end
+            it "should match the system interface of #{hash[:mac]}" do
+              NetworkInterface.addresses(interface)[NetworkInterface::AF_LINK][0]["addr"].should == hash[:mac]
+            end
+          end
+        end
+      end
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,107 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'network_interface'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+end
+
+def friendly_interface_names
+  interfaces = NetworkInterface.interfaces
+  interface_names ||= begin
+    h = {}
+    interfaces.each do |interface|
+      info = NetworkInterface.interface_info(interface)
+      name = if info && info.has_key?('name')
+        info['name']
+      else
+        interface
+      end
+      h[name] = interface
+    end
+    h
+  end
+  interface_names
+end
+
+if RUBY_PLATFORM =~ /i386-mingw32/
+  def system_interfaces
+    ipconfig = `ipconfig`
+    ipconfig_array = ipconfig.split("\n").reject {|s| s.empty?}
+    
+    getmac = `getmac -nh`
+    getmac_array = getmac.split("\n").reject {|s| s.empty?}
+    getmac_array.map!{|element| element.split(" ")}
+    getmac_hash = getmac_array.inject({}) do |hash, array|
+      hash.merge!({array[1][/\{(.*)\}/,1] => array[0].gsub("-",":").downcase})
+    end
+    
+    interfaces = {}
+    @key = nil
+    ipconfig_array.each do |element|
+      if element.start_with? " "
+        case element
+        when /IPv6 Address.*: (.*)/
+          # interfaces[@key][:ipv6] = $1
+        when /IPv4 Address.*: (.*)/
+          interfaces[@key][:ipv4] = $1
+          interfaces[@key][:mac] = getmac_hash[@key[/\{(.*)\}/,1]]
+        end
+      elsif element[/Windows IP Configuration/]
+      elsif element[/Ethernet adapter (.*):/]
+        @key = friendly_interface_names[$1]
+        interfaces[@key] = {}
+      else
+        @key = element[/(.*):/,1]
+        interfaces[@key] = {}
+      end
+    end
+    
+    interfaces
+  end
+
+else 
+  def system_interfaces
+    ifconfig = `/sbin/ifconfig`
+    ifconfig_array = ifconfig.split("\n")
+    ifconfig_array.map!{|element| element.split("\n")}
+    ifconfig_array.flatten!
+    interfaces = {}
+    @key = nil
+    ifconfig_array.each do |element|
+      if element.start_with?("\t") || element.start_with?(" ")
+        case element
+        when /ether ((\w{2}\:){5}(\w{2}))/
+          interfaces[@key][:mac] = $1
+        when /inet6 (.*) prefixlen/
+          interfaces[@key][:ipv6] = $1
+        when /inet ((\d{1,3}\.){3}\d{1,3}).*broadcast ((\d{1,3}\.){3}\d{1,3})/
+          interfaces[@key][:ipv4] = $1
+          interfaces[@key][:broadcast] = $3
+        when /addr:((\d{1,3}\.){3}\d{1,3})\s+Bcast:((\d{1,3}\.){3}\d{1,3})/i
+          interfaces[@key][:ipv4] = $1
+          interfaces[@key][:broadcast] = $3
+        end
+      else
+        @key = element.split(' ').first[/(\w*)/,1]
+        interfaces[@key] = {}
+        if element[/HWaddr ((\w{2}\:){5}(\w{2}))/]
+          interfaces[@key][:mac] = $1
+        end
+      end
+    end
+    interfaces
+  end
+
+end
+
+def system_interfaces_with_addresses
+  interfaces = {}
+  system_interfaces.each do |key, value|
+    if value.has_key? :ipv4
+      interfaces[key] = value
+    end
+  end
+  interfaces
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: network_interface
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Turner
+- Lance Sanchez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\n     This gem was originally added to the Metasploit Pcaprub gem.
+  It's been spun\n     out into its own gem for anyone who might want to programmatically
+  get\n     information on their network interfaces. "
+email:
+- lance.sanchez@rapid7.com
+- brandon_turner@rapid7.com
+executables: []
+extensions:
+- ext/network_interface_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ext/network_interface_ext/extconf.rb
+- ext/network_interface_ext/netifaces.c
+- ext/network_interface_ext/netifaces.h
+- lib/network_interface.rb
+- lib/network_interface/version.rb
+- network_interface.gemspec
+- spec/netiface_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rapid7/network_interface
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3620416272362916495
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3620416272362916495
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A cross platform gem to help get network interface information
+test_files:
+- spec/netiface_spec.rb
+- spec/spec_helper.rb