facter 2.0.1.rc1-universal-darwin

data/lib/facter/util/ip.rb

@@ -0,0 +1,285 @@
+# A base module for collecting IP-related
+# information from all kinds of platforms.
+module Facter::Util::IP
+  # A map of all the different regexes that work for
+  # a given platform or set of platforms.
+  REGEX_MAP = {
+    :linux => {
+      :ipaddress  => /inet (?:addr:)?([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/,
+      :ipaddress6 => /inet6 (?:addr: )?((?![fe80|::1])(?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/,
+      :macaddress => /(?:ether|HWaddr)\s+((\w{1,2}:){5,}\w{1,2})/,
+      :netmask  => /(?:Mask:|netmask )([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/,
+      :mtu  => /MTU:(\d+)/
+    },
+    :bsd   => {
+      :aliases  => [:openbsd, :netbsd, :freebsd, :darwin, :"gnu/kfreebsd", :dragonfly],
+      :ipaddress  => /inet\s+([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/,
+      :ipaddress6 => /inet6 ((?![fe80|::1])(?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/,
+      :macaddress => /(?:ether|lladdr)\s+(\w?\w:\w?\w:\w?\w:\w?\w:\w?\w:\w?\w)/,
+      :netmask  => /netmask\s+0x(\w{8})/,
+      :mtu => /mtu\s+(\d+)/
+    },
+    :sunos => {
+      :ipaddress  => /inet\s+([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/,
+      :ipaddress6 => /inet6 ((?![fe80|::1])(?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/,
+      :macaddress => /(?:ether|lladdr)\s+(\w?\w:\w?\w:\w?\w:\w?\w:\w?\w:\w?\w)/,
+      :netmask  => /netmask\s+(\w{8})/,
+      :mtu => /mtu\s+(\d+)/
+    },
+    :"hp-ux" => {
+      :ipaddress  => /\s+inet (\S+)\s.*/,
+      :macaddress => /(\w{1,2}:\w{1,2}:\w{1,2}:\w{1,2}:\w{1,2}:\w{1,2})/,
+      :netmask  => /.*\s+netmask (\S+)\s.*/
+    },
+    :windows => {}
+  }
+
+  # Convert an interface name into purely alphanumeric characters.
+  def self.alphafy(interface)
+    interface.gsub(/[^a-z0-9_]/i, '_')
+  end
+
+  def self.convert_from_hex?(kernel)
+    kernels_to_convert = [:sunos, :openbsd, :netbsd, :freebsd, :darwin, :"hp-ux", :"gnu/kfreebsd", :dragonfly]
+    kernels_to_convert.include?(kernel)
+  end
+
+  def self.supported_platforms
+    REGEX_MAP.inject([]) do |result, tmp|
+      key, map = tmp
+      if map[:aliases]
+        result += map[:aliases]
+      else
+        result << key
+      end
+      result
+    end
+  end
+
+  def self.get_interfaces
+    if Facter.value(:kernel) == 'windows'
+      require 'facter/util/ip/windows'
+      return Facter::Util::IP::Windows.interfaces
+    end
+
+    return [] unless output = Facter::Util::IP.get_all_interface_output()
+
+    # Our regex appears to be stupid, in that it leaves colons sitting
+    # at the end of interfaces.  So, we have to trim those trailing
+    # characters.  I tried making the regex better but supporting all
+    # platforms with a single regex is probably a bit too much.
+    output.scan(/^\S+/).collect { |i| i.sub(/:$/, '') }.uniq
+  end
+
+  def self.get_all_interface_output
+    case Facter.value(:kernel)
+    when 'Linux', 'OpenBSD', 'NetBSD', 'FreeBSD', 'Darwin', 'GNU/kFreeBSD', 'DragonFly'
+      output = Facter::Util::IP.exec_ifconfig(["-a","2>/dev/null"])
+    when 'SunOS'
+      output = Facter::Util::IP.exec_ifconfig(["-a"])
+    when 'HP-UX'
+      # (#17487)[https://projects.puppetlabs.com/issues/17487]
+      # Handle NIC bonding where asterisks and virtual NICs are printed.
+      if output = hpux_netstat_in
+        output.gsub!(/\*/, "")                  # delete asterisks.
+        output.gsub!(/^[^\n]*none[^\n]*\n/, "") # delete lines with 'none' instead of IPs.
+        output.sub!(/^[^\n]*\n/, "")            # delete the header line.
+        output
+      end
+    end
+    output
+  end
+
+
+  ##
+  # exec_ifconfig uses the ifconfig command
+  #
+  # @return [String] the output of `ifconfig #{arguments} 2>/dev/null` or nil
+  def self.exec_ifconfig(additional_arguments=[])
+    Facter::Core::Execution.exec("#{self.get_ifconfig} #{additional_arguments.join(' ')}")
+  end
+  ##
+  # get_ifconfig looks up the ifconfig binary
+  #
+  # @return [String] path to the ifconfig binary
+  def self.get_ifconfig
+    common_paths=["/bin/ifconfig","/sbin/ifconfig","/usr/sbin/ifconfig"]
+    common_paths.select{|path| File.executable?(path)}.first
+  end
+  ##
+  # hpux_netstat_in is a delegate method that allows us to stub netstat -in
+  # without stubbing exec.
+  def self.hpux_netstat_in
+    Facter::Core::Execution.exec("/bin/netstat -in")
+  end
+
+  def self.get_infiniband_macaddress(interface)
+    if File.exists?("/sys/class/net/#{interface}/address") then
+      ib_mac_address = `cat /sys/class/net/#{interface}/address`.chomp
+    elsif File.exists?("/sbin/ip") then
+      ip_output = %x{/sbin/ip link show #{interface}}
+      ib_mac_address = ip_output.scan(%r{infiniband\s+((\w{1,2}:){5,}\w{1,2})})
+    else
+      ib_mac_address = "FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF"
+      Facter.debug("ip.rb: nothing under /sys/class/net/#{interface}/address and /sbin/ip not available")
+    end
+    ib_mac_address
+  end
+
+  def self.ifconfig_interface(interface)
+    output = Facter::Util::IP.exec_ifconfig([interface,"2>/dev/null"])
+  end
+
+  def self.get_single_interface_output(interface)
+    output = ""
+    case Facter.value(:kernel)
+    when 'OpenBSD', 'NetBSD', 'FreeBSD', 'Darwin', 'GNU/kFreeBSD', 'DragonFly'
+      output = Facter::Util::IP.ifconfig_interface(interface)
+    when 'Linux'
+      ifconfig_output = Facter::Util::IP.ifconfig_interface(interface)
+      if interface =~ /^ib/ then
+        real_mac_address = get_infiniband_macaddress(interface)
+        output = ifconfig_output.sub(%r{(?:ether|HWaddr)\s+((\w{1,2}:){5,}\w{1,2})}, "HWaddr #{real_mac_address}")
+      else
+        output = ifconfig_output
+      end
+    when 'SunOS'
+      output = Facter::Util::IP.exec_ifconfig([interface])
+    when 'HP-UX'
+       mac = ""
+       ifc = hpux_ifconfig_interface(interface)
+       hpux_lanscan.scan(/(\dx\S+).*UP\s+(\w+\d+)/).each {|i| mac = i[0] if i.include?(interface) }
+       mac = mac.sub(/0x(\S+)/,'\1').scan(/../).join(":")
+       output = ifc + "\n" + mac
+    end
+    output
+  end
+
+  def self.hpux_ifconfig_interface(interface)
+    Facter::Util::IP.exec_ifconfig([interface])
+  end
+
+  def self.hpux_lanscan
+    Facter::Core::Execution.exec("/usr/sbin/lanscan")
+  end
+
+  def self.get_output_for_interface_and_label(interface, label)
+    return get_single_interface_output(interface) unless Facter.value(:kernel) == 'windows'
+
+    require 'facter/util/ip/windows'
+    output = Facter::Util::IP::Windows.value_for_interface_and_label(interface, label)
+    output ? output : ""
+  end
+
+  def self.get_bonding_master(interface)
+    if Facter.value(:kernel) != 'Linux'
+      return nil
+    end
+    # We need ip instead of ifconfig because it will show us
+    # the bonding master device.
+    if not FileTest.executable?("/sbin/ip")
+      return nil
+    end
+    # A bonding interface can never be an alias interface. Alias
+    # interfaces do have a colon in their name and the ip link show
+    # command throws an error message when we pass it an alias
+    # interface.
+    if interface =~ /:/
+      return nil
+    end
+    regex = /SLAVE[,>].* (bond[0-9]+)/
+      ethbond = regex.match(%x{/sbin/ip link show #{interface}})
+    if ethbond
+      device = ethbond[1]
+    else
+      device = nil
+    end
+    device
+  end
+
+  ##
+  # get_interface_value obtains the value of a specific attribute of a specific
+  # interface.
+  #
+  # @param interface [String] the interface identifier, e.g. "eth0" or "bond0"
+  #
+  # @param label [String] the attribute of the interface to obtain a value for,
+  # e.g. "netmask" or "ipaddress"
+  #
+  # @api private
+  #
+  # @return [String] representing the requested value.  An empty array is
+  # returned if the kernel is not supported by the REGEX_MAP constant.
+  def self.get_interface_value(interface, label)
+    if Facter.value(:kernel) == 'windows'
+      require 'facter/util/ip/windows'
+      return Facter::Util::IP::Windows.value_for_interface_and_label(interface, label)
+    end
+
+    tmp1 = []
+
+    kernel = Facter.value(:kernel).downcase.to_sym
+
+    # If it's not directly in the map or aliased in the map, then we don't know how to deal with it.
+    unless map = REGEX_MAP[kernel] || REGEX_MAP.values.find { |tmp| tmp[:aliases] and tmp[:aliases].include?(kernel) }
+      return []
+    end
+
+    # Pull the correct regex out of the map.
+    regex = map[label.to_sym]
+
+    # Linux changes the MAC address reported via ifconfig when an ethernet interface
+    # becomes a slave of a bonding device to the master MAC address.
+    # We have to dig a bit to get the original/real MAC address of the interface.
+    bonddev = get_bonding_master(interface)
+    if label == 'macaddress' and bonddev
+      bondinfo = read_proc_net_bonding("/proc/net/bonding/#{bonddev}")
+      re = /^Slave Interface: #{interface}\b.*?\bPermanent HW addr: (([0-9A-F]{2}:?)*)$/im
+      if match = re.match(bondinfo)
+        value = match[1].upcase
+      end
+    else
+      output_int = get_output_for_interface_and_label(interface, label)
+
+      output_int.each_line do |s|
+        if s =~ regex
+          value = $1
+            if label == 'netmask' && convert_from_hex?(kernel)
+              value = value.scan(/../).collect do |byte| byte.to_i(16) end.join('.')
+            end
+          tmp1.push(value)
+        end
+      end
+
+      if tmp1
+        value = tmp1.shift
+      end
+    end
+  end
+
+  ##
+  # read_proc_net_bonding is a seam method for mocking purposes.
+  #
+  # @param path [String] representing the path to read, e.g. "/proc/net/bonding/bond0"
+  #
+  # @api private
+  #
+  # @return [String] modeling the raw file read
+  def self.read_proc_net_bonding(path)
+    File.read(path) if File.exists?(path)
+  end
+  private_class_method :read_proc_net_bonding
+
+  def self.get_network_value(interface)
+    require 'ipaddr'
+
+    ipaddress = get_interface_value(interface, "ipaddress")
+    netmask = get_interface_value(interface, "netmask")
+
+    if ipaddress && netmask
+      ip = IPAddr.new(ipaddress, Socket::AF_INET)
+      subnet = IPAddr.new(netmask, Socket::AF_INET)
+      network = ip.mask(subnet.to_s).to_s
+    end
+  end
+end

data/lib/facter/util/ip/windows.rb

@@ -0,0 +1,215 @@
+# encoding: UTF-8
+
+require 'facter/util/wmi'
+require 'facter/util/ip'
+
+class Facter::Util::IP::Windows
+  # The WMI query used to return ip information
+  #
+  # @return [String]
+  #
+  # @api private
+  WMI_IP_INFO_QUERY = 'SELECT Description, ServiceName, IPAddress, IPConnectionMetric, InterfaceIndex, Index, IPSubnet, MACAddress, MTU, SettingID FROM Win32_NetworkAdapterConfiguration WHERE IPConnectionMetric IS NOT NULL AND IPEnabled = TRUE'
+
+  # Mapping fact names to WMI properties of the Win32_NetworkAdapterConfiguration
+  #
+  # @api private
+  WINDOWS_LABEL_WMI_MAP = {
+      :ipaddress => 'IPAddress',
+      :ipaddress6 => 'IPAddress',
+      :macaddress => 'MACAddress',
+      :netmask => 'IPSubnet'
+  }
+
+  def self.to_s
+    'windows'
+  end
+
+  # Windows doesn't display netmask in hex.
+  #
+  # @return [Boolean] false by default
+  #
+  # @api private
+  def self.convert_netmask_from_hex?
+    false
+  end
+
+  # Retrieves a list of unique interfaces names.
+  #
+  # @return [Array<String>]
+  #
+  # @api private
+  def self.interfaces
+    interface_names = []
+
+    network_adapter_configurations.map do |nic|
+      Facter::Util::WMI.execquery("SELECT * FROM Win32_NetworkAdapter WHERE Index = #{nic.Index} AND NetEnabled = TRUE").each do |nic|
+        interface_names << nic.NetConnectionId unless nic.NetConnectionId.nil? or nic.NetConnectionId.empty?
+      end
+    end
+
+    interface_names.uniq
+  end
+
+  # Get the value of an interface and label. For example, you may want to find
+  # the MTU for eth0.
+  #
+  # @param [String] interface the name of the interface returned by the {#interfaces} method.
+  # @param [String] label the type of value to return, e.g. ipaddress
+  # @return [String] the value, or nil if not defined
+  #
+  # @api private
+  def self.value_for_interface_and_label(interface, label)
+    wmi_value = WINDOWS_LABEL_WMI_MAP[label.downcase.to_sym]
+    label_value = nil
+    Facter::Util::WMI.execquery("SELECT Index FROM Win32_NetworkAdapter WHERE NetConnectionID = '#{interface}'").each do |nic|
+      Facter::Util::WMI.execquery("SELECT #{wmi_value} FROM Win32_NetworkAdapterConfiguration WHERE Index = #{nic.Index}").each do |nic_config|
+        case label.downcase.to_sym
+        when :ipaddress
+          nic_config.IPAddress.any? do |addr|
+            label_value = addr if valid_ipv4_address?(addr)
+            label_value
+          end
+        when :ipaddress6
+          nic_config.IPAddress.any? do |addr|
+            label_value = addr if Facter::Util::IP::Windows.valid_ipv6_address?(addr)
+            label_value
+          end
+        when :netmask
+          nic_config.IPSubnet.any? do |addr|
+            label_value = addr if Facter::Util::IP::Windows.valid_ipv4_address?(addr)
+            label_value
+          end
+        when :macaddress
+          label_value = nic_config.MACAddress
+        end
+      end
+    end
+
+    label_value
+  end
+
+  # Returns an array of partial Win32_NetworkAdapterConfiguration objects.
+  #
+  # @return [Array<WIN32OLE>] objects
+  #
+  # @api private
+  def self.network_adapter_configurations
+    nics = []
+    # WIN32OLE doesn't implement Enumerable
+    Facter::Util::WMI.execquery(WMI_IP_INFO_QUERY).each do |nic|
+      nics << nic
+    end
+    nics
+  end
+
+  # Gets a list of active IPv4 network adapter configurations sorted by the
+  # lowest IP connection metric. If two configurations have the same metric,
+  # then the IPv4 specific binding order as specified in the registry will
+  # be used.
+  #
+  # @return [Array<WIN32OLE>]
+  #
+  # @api private
+  def self.get_preferred_ipv4_adapters
+    get_preferred_network_adapters(Bindings4.new)
+  end
+
+  # Gets a list of active IPv6 network adapter configurations sorted by the
+  # lowest IP connection metric. If two configurations have the same metric,
+  # then the IPv6 specific binding order as specified in the registry will
+  # be used.
+  #
+  # @return [Array<WIN32OLE>]
+  #
+  # @api private
+  def self.get_preferred_ipv6_adapters
+    get_preferred_network_adapters(Bindings6.new)
+  end
+
+  # Gets a list of active network adapter configurations sorted by the lowest
+  # IP connection metric. If two configurations have the same metric, then
+  # the adapter binding order as specified in the registry will be used.
+  # Note the order may different for IPv4 vs IPv6 addresses.
+  #
+  # @see http://support.microsoft.com/kb/894564
+  # @return [Array<WIN32OLE>]
+  #
+  # @api private
+  def self.get_preferred_network_adapters(bindings)
+    network_adapter_configurations.select do |nic|
+      bindings.bindings.include?(nic.SettingID)
+    end.sort do |nic_left,nic_right|
+      cmp = nic_left.IPConnectionMetric <=> nic_right.IPConnectionMetric
+      if cmp == 0
+        bindings.bindings[nic_left.SettingID] <=> bindings.bindings[nic_right.SettingID]
+      else
+        cmp
+      end
+    end
+  end
+
+  class Bindings4
+    def initialize
+      @key = 'SYSTEM\CurrentControlSet\Services\Tcpip\Linkage'
+    end
+
+    def bindings
+      require 'facter/util/registry'
+      bindings = {}
+
+      Facter::Util::Registry.hklm_read(@key, 'Bind').each_with_index do |entry, index|
+        match_data = entry.match(/\\Device\\(\{.*\})/)
+        unless match_data.nil?
+          bindings[match_data[1]] = index
+        end
+      end
+
+      bindings
+    rescue
+      {}
+    end
+  end
+
+  class Bindings6 < Bindings4
+    def initialize
+      @key = 'SYSTEM\CurrentControlSet\Services\Tcpip6\Linkage'
+    end
+  end
+
+  # Determines if the value passed in is a valid ipv4 address.
+  #
+  # @param [String] ip_address the IPv4 address to validate
+  # @return [Boolean]
+  #
+  # @api private
+  def self.valid_ipv4_address?(ip_address)
+    String(ip_address).scan(/(?:[0-9]{1,3}\.){3}[0-9]{1,3}/).each do |match|
+      # excluding 169.254.x.x in Windows - this is the DHCP APIPA
+      #  meaning that if the node cannot get an ip address from the dhcp server,
+      #  it auto-assigns a private ip address
+      unless match == "127.0.0.1" or match =~ /^169.254.*/
+        return !!match
+      end
+    end
+
+    false
+  end
+
+  # Determines if the value passed in is a valid ipv6 address.
+  #
+  # @param [String] ip_address the IPv6 address to validate
+  # @return [Boolean]
+  #
+  # @api private
+  def self.valid_ipv6_address?(ip_address)
+    String(ip_address).scan(/(?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4}/).each do |match|
+      unless match =~ /fe80.*/ or match == "::1"
+        return !!match
+      end
+    end
+
+    false
+  end
+
+end