Module: Facter::Util::IP

Defined in:
lib/facter/util/ip.rb

Overview

A base module for collecting IP-related information from all kinds of platforms.

Constant Summary

REGEX_MAP =

A map of all the different regexes that work for a given platform or set of platforms.

{
    :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}:\w{1,2}:\w{1,2}:\w{1,2}:\w{1,2}:\w{1,2})/,
        :netmask    => /Mask:([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/
    },
    :bsd   => {
        :aliases    => [:openbsd, :netbsd, :freebsd, :darwin, :gnu/kfreebsd"],
        :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})/
    },
    :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})/
    },
    :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 => {
        :ipaddress  => /\s+IP Address:\s+([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/,
        :ipaddress6 => /Address ((?![fe80|::1])(?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/,
        :netmask    => /\s+Subnet Prefix:\s+\S+\s+\(mask ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)\)/
    }
}

Class Method Summary collapse

Class Method Details

.alphafy(interface) ⇒ Object

Convert an interface name into purely alphanumeric characters.



39
40
41
# File 'lib/facter/util/ip.rb', line 39

def self.alphafy(interface)
    interface.gsub(/[^a-z0-9_]/i, '_')
end

.convert_from_hex?(kernel) ⇒ Boolean



43
44
45
46
# File 'lib/facter/util/ip.rb', line 43

def self.convert_from_hex?(kernel)
    kernels_to_convert = [:sunos, :openbsd, :netbsd, :freebsd, :darwin, :hp-ux", :gnu/kfreebsd"]
    kernels_to_convert.include?(kernel)
end

.get_all_interface_outputObject



74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/facter/util/ip.rb', line 74

def self.get_all_interface_output
    case Facter.value(:kernel)
    when 'Linux', 'OpenBSD', 'NetBSD', 'FreeBSD', 'Darwin', 'GNU/kFreeBSD'
        output = %x{/sbin/ifconfig -a}
    when 'SunOS'
        output = %x{/usr/sbin/ifconfig -a}
    when 'HP-UX'
        output = %x{/bin/netstat -in | sed -e 1d}
    when 'windows'
      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ip show interface|
      output += %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ipv6 show interface|
    end
    output
end

.get_arp_value(interface) ⇒ Object



196
197
198
199
200
201
# File 'lib/facter/util/ip.rb', line 196

def self.get_arp_value(interface)
    arp = Facter::Util::Resolution.exec("arp -en -i #{interface} | sed -e 1d")
    if arp =~ /^\S+\s+\w+\s+(\S+)\s+\w\s+\S+$/
     return $1
    end
end

.get_bonding_master(interface) ⇒ Object



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/facter/util/ip.rb', line 117

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(interface, label) ⇒ Object



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/facter/util/ip.rb', line 143

def self.get_interface_value(interface, label)
    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 = IO.readlines("/proc/net/bonding/#{bonddev}")
        hwaddrre = /^Slave Interface: #{interface}\n[^\n].+?\nPermanent HW addr: (([0-9a-fA-F]{2}:?)*)$/m
        value = hwaddrre.match(bondinfo.to_s)[1].upcase
    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

.get_interfacesObject



60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/facter/util/ip.rb', line 60

def self.get_interfaces
    return [] unless output = Facter::Util::IP.get_all_interface_output()

    # windows interface names contain spaces and are quoted and can appear multiple
    # times as ipv4 and ipv6
    return output.scan(/\s* connected\s*(\S.*)/).flatten.uniq if Facter.value(:kernel) == 'windows'

    # 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

.get_network_value(interface) ⇒ Object



183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/facter/util/ip.rb', line 183

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

.get_output_for_interface_and_label(interface, label) ⇒ Object



106
107
108
109
110
111
112
113
114
115
# File 'lib/facter/util/ip.rb', line 106

def self.get_output_for_interface_and_label(interface, label)
    return get_single_interface_output(interface) unless Facter.value(:kernel) == 'windows'

    if label == 'ipaddress6'
      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ipv6 show address \"#{interface}\"|
    else
      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ip show address \"#{interface}\"|
    end
    output
end

.get_single_interface_output(interface) ⇒ Object



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/facter/util/ip.rb', line 89

def self.get_single_interface_output(interface)
    output = ""
    case Facter.value(:kernel)
    when 'Linux', 'OpenBSD', 'NetBSD', 'FreeBSD', 'Darwin', 'GNU/kFreeBSD'
        output = %x{/sbin/ifconfig #{interface}}
    when 'SunOS'
        output = %x{/usr/sbin/ifconfig #{interface}}
    when 'HP-UX'
       mac = ""
       ifc = %x{/usr/sbin/ifconfig #{interface}}
       %x{/usr/sbin/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

.supported_platformsObject



48
49
50
51
52
53
54
55
56
57
58
# File 'lib/facter/util/ip.rb', line 48

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