Merge pull request #10151 from ansible/pr-9560
Modified version of PR 9560
This commit is contained in:
Toshio Kuratomi
commit
d7f5979870
626
lib/ansible/runner/filter_plugins/ipaddr.py
Normal file
626
lib/ansible/runner/filter_plugins/ipaddr.py
Normal file
|
|
@ -0,0 +1,626 @@
|
|||
# (c) 2014, Maciej Delmanowski <drybjed@gmail.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from functools import partial
|
||||
|
||||
try:
|
||||
import netaddr
|
||||
except ImportError:
|
||||
# in this case, we'll make the filters return error messages (see bottom)
|
||||
netaddr = None
|
||||
else:
|
||||
class mac_linux(netaddr.mac_unix):
|
||||
pass
|
||||
mac_linux.word_fmt = '%.2x'
|
||||
|
||||
from ansible import errors
|
||||
|
||||
|
||||
# ---- IP address and network query helpers ----
|
||||
|
||||
def _empty_ipaddr_query(v, vtype):
|
||||
# We don't have any query to process, so just check what type the user
|
||||
# expects, and return the IP address in a correct format
|
||||
if v:
|
||||
if vtype == 'address':
|
||||
return str(v.ip)
|
||||
elif vtype == 'network':
|
||||
return str(v)
|
||||
|
||||
def _6to4_query(v, vtype, value):
|
||||
if v.version == 4:
|
||||
|
||||
if v.size == 1:
|
||||
ipconv = str(v.ip)
|
||||
elif v.size > 1:
|
||||
if v.ip != v.network:
|
||||
ipconv = str(v.ip)
|
||||
else:
|
||||
ipconv = False
|
||||
|
||||
if ipaddr(ipconv, 'public'):
|
||||
numbers = list(map(int, ipconv.split('.')))
|
||||
|
||||
try:
|
||||
return '2002:{:02x}{:02x}:{:02x}{:02x}::1/48'.format(*numbers)
|
||||
except:
|
||||
return False
|
||||
|
||||
elif v.version == 6:
|
||||
if vtype == 'address':
|
||||
if ipaddr(str(v), '2002::/16'):
|
||||
return value
|
||||
elif vtype == 'network':
|
||||
if v.ip != v.network:
|
||||
if ipaddr(str(v.ip), '2002::/16'):
|
||||
return value
|
||||
else:
|
||||
return False
|
||||
|
||||
def _ip_query(v):
|
||||
if v.size == 1:
|
||||
return str(v.ip)
|
||||
if v.size > 1:
|
||||
if v.ip != v.network:
|
||||
return str(v.ip)
|
||||
|
||||
def _gateway_query(v):
|
||||
if v.size > 1:
|
||||
if v.ip != v.network:
|
||||
return str(v.ip) + '/' + str(v.prefixlen)
|
||||
|
||||
def _bool_ipaddr_query(v):
|
||||
if v:
|
||||
return True
|
||||
|
||||
def _broadcast_query(v):
|
||||
if v.size > 1:
|
||||
return str(v.broadcast)
|
||||
|
||||
def _cidr_query(v):
|
||||
return str(v)
|
||||
|
||||
def _cidr_lookup_query(v, iplist, value):
|
||||
try:
|
||||
if v in iplist:
|
||||
return value
|
||||
except:
|
||||
return False
|
||||
|
||||
def _host_query(v):
|
||||
if v.size == 1:
|
||||
return str(v)
|
||||
elif v.size > 1:
|
||||
if v.ip != v.network:
|
||||
return str(v.ip) + '/' + str(v.prefixlen)
|
||||
|
||||
def _hostmask_query(v):
|
||||
return str(v.hostmask)
|
||||
|
||||
def _int_query(v, vtype):
|
||||
if vtype == 'address':
|
||||
return int(v.ip)
|
||||
elif vtype == 'network':
|
||||
return str(int(v.ip)) + '/' + str(int(v.prefixlen))
|
||||
|
||||
def _ipv4_query(v, value):
|
||||
if v.version == 6:
|
||||
try:
|
||||
return str(v.ipv4())
|
||||
except:
|
||||
return False
|
||||
else:
|
||||
return value
|
||||
|
||||
def _ipv6_query(v, value):
|
||||
if v.version == 4:
|
||||
return str(v.ipv6())
|
||||
else:
|
||||
return value
|
||||
|
||||
def _link_local_query(v, value):
|
||||
v_ip = netaddr.IPAddress(str(v.ip))
|
||||
if v.version == 4:
|
||||
if ipaddr(str(v_ip), '169.254.0.0/24'):
|
||||
return value
|
||||
|
||||
elif v.version == 6:
|
||||
if ipaddr(str(v_ip), 'fe80::/10'):
|
||||
return value
|
||||
|
||||
def _loopback_query(v, value):
|
||||
v_ip = netaddr.IPAddress(str(v.ip))
|
||||
if v_ip.is_loopback():
|
||||
return value
|
||||
|
||||
def _multicast_query(v, value):
|
||||
if v.is_multicast():
|
||||
return value
|
||||
|
||||
def _net_query(v):
|
||||
if v.size > 1:
|
||||
if v.ip == v.network:
|
||||
return str(v.network) + '/' + str(v.prefixlen)
|
||||
|
||||
def _netmask_query(v):
|
||||
if v.size > 1:
|
||||
return str(v.netmask)
|
||||
|
||||
def _network_query(v):
|
||||
if v.size > 1:
|
||||
return str(v.network)
|
||||
|
||||
def _prefix_query(v):
|
||||
return int(v.prefixlen)
|
||||
|
||||
def _private_query(v, value):
|
||||
if v.is_private():
|
||||
return value
|
||||
|
||||
def _public_query(v, value):
|
||||
v_ip = netaddr.IPAddress(str(v.ip))
|
||||
if v_ip.is_unicast() and not v_ip.is_private() and \
|
||||
not v_ip.is_loopback() and not v_ip.is_netmask() and \
|
||||
not v_ip.is_hostmask():
|
||||
return value
|
||||
|
||||
def _revdns_query(v):
|
||||
v_ip = netaddr.IPAddress(str(v.ip))
|
||||
return v_ip.reverse_dns
|
||||
|
||||
def _size_query(v):
|
||||
return v.size
|
||||
|
||||
def _subnet_query(v):
|
||||
return str(v.cidr)
|
||||
|
||||
def _type_query(v):
|
||||
if v.size == 1:
|
||||
return 'address'
|
||||
if v.size > 1:
|
||||
if v.ip != v.network:
|
||||
return 'address'
|
||||
else:
|
||||
return 'network'
|
||||
|
||||
def _unicast_query(v, value):
|
||||
if v.is_unicast():
|
||||
return value
|
||||
|
||||
def _version_query(v):
|
||||
return v.version
|
||||
|
||||
def _wrap_query(v, vtype, value):
|
||||
if v.version == 6:
|
||||
if vtype == 'address':
|
||||
return '[' + str(v.ip) + ']'
|
||||
elif vtype == 'network':
|
||||
return '[' + str(v.ip) + ']/' + str(v.prefixlen)
|
||||
else:
|
||||
return value
|
||||
|
||||
|
||||
# ---- HWaddr query helpers ----
|
||||
def _bare_query(v):
|
||||
v.dialect = netaddr.mac_bare
|
||||
return str(v)
|
||||
|
||||
def _bool_hwaddr_query(v):
|
||||
if v:
|
||||
return True
|
||||
|
||||
def _cisco_query(v):
|
||||
v.dialect = netaddr.mac_cisco
|
||||
return str(v)
|
||||
|
||||
def _empty_hwaddr_query(v, value):
|
||||
if v:
|
||||
return value
|
||||
|
||||
def _linux_query(v):
|
||||
v.dialect = mac_linux
|
||||
return str(v)
|
||||
|
||||
def _postgresql_query(v):
|
||||
v.dialect = netaddr.mac_pgsql
|
||||
return str(v)
|
||||
|
||||
def _unix_query(v):
|
||||
v.dialect = netaddr.mac_unix
|
||||
return str(v)
|
||||
|
||||
def _win_query(v):
|
||||
v.dialect = netaddr.mac_eui48
|
||||
return str(v)
|
||||
|
||||
|
||||
# ---- IP address and network filters ----
|
||||
|
||||
def ipaddr(value, query = '', version = False, alias = 'ipaddr'):
|
||||
''' Check if string is an IP address or network and filter it '''
|
||||
|
||||
query_func_extra_args = {
|
||||
'': ('vtype',),
|
||||
'6to4': ('vtype', 'value'),
|
||||
'cidr_lookup': ('iplist', 'value'),
|
||||
'int': ('vtype',),
|
||||
'ipv4': ('value',),
|
||||
'ipv6': ('value',),
|
||||
'link-local': ('value',),
|
||||
'loopback': ('value',),
|
||||
'lo': ('value',),
|
||||
'multicast': ('value',),
|
||||
'private': ('value',),
|
||||
'public': ('value',),
|
||||
'unicast': ('value',),
|
||||
'wrap': ('vtype', 'value'),
|
||||
}
|
||||
query_func_map = {
|
||||
'': _empty_ipaddr_query,
|
||||
'6to4': _6to4_query,
|
||||
'address': _ip_query,
|
||||
'address/prefix': _gateway_query,
|
||||
'bool': _bool_ipaddr_query,
|
||||
'broadcast': _broadcast_query,
|
||||
'cidr': _cidr_query,
|
||||
'cidr_lookup': _cidr_lookup_query,
|
||||
'gateway': _gateway_query,
|
||||
'gw': _gateway_query,
|
||||
'host': _host_query,
|
||||
'host/prefix': _gateway_query,
|
||||
'hostmask': _hostmask_query,
|
||||
'hostnet': _gateway_query,
|
||||
'int': _int_query,
|
||||
'ip': _ip_query,
|
||||
'ipv4': _ipv4_query,
|
||||
'ipv6': _ipv6_query,
|
||||
'link-local': _link_local_query,
|
||||
'lo': _loopback_query,
|
||||
'loopback': _loopback_query,
|
||||
'multicast': _multicast_query,
|
||||
'net': _net_query,
|
||||
'netmask': _netmask_query,
|
||||
'network': _network_query,
|
||||
'prefix': _prefix_query,
|
||||
'private': _private_query,
|
||||
'public': _public_query,
|
||||
'revdns': _revdns_query,
|
||||
'router': _gateway_query,
|
||||
'size': _size_query,
|
||||
'subnet': _subnet_query,
|
||||
'type': _type_query,
|
||||
'unicast': _unicast_query,
|
||||
'v4': _ipv4_query,
|
||||
'v6': _ipv6_query,
|
||||
'version': _version_query,
|
||||
'wrap': _wrap_query,
|
||||
}
|
||||
|
||||
vtype = None
|
||||
|
||||
if not value:
|
||||
return False
|
||||
|
||||
elif value == True:
|
||||
return False
|
||||
|
||||
# Check if value is a list and parse each element
|
||||
elif isinstance(value, (list, tuple)):
|
||||
|
||||
_ret = []
|
||||
for element in value:
|
||||
if ipaddr(element, str(query), version):
|
||||
_ret.append(ipaddr(element, str(query), version))
|
||||
|
||||
if _ret:
|
||||
return _ret
|
||||
else:
|
||||
return list()
|
||||
|
||||
# Check if value is a number and convert it to an IP address
|
||||
elif str(value).isdigit():
|
||||
|
||||
# We don't know what IP version to assume, so let's check IPv4 first,
|
||||
# then IPv6
|
||||
try:
|
||||
if ((not version) or (version and version == 4)):
|
||||
v = netaddr.IPNetwork('0.0.0.0/0')
|
||||
v.value = int(value)
|
||||
v.prefixlen = 32
|
||||
elif version and version == 6:
|
||||
v = netaddr.IPNetwork('::/0')
|
||||
v.value = int(value)
|
||||
v.prefixlen = 128
|
||||
|
||||
# IPv4 didn't work the first time, so it definitely has to be IPv6
|
||||
except:
|
||||
try:
|
||||
v = netaddr.IPNetwork('::/0')
|
||||
v.value = int(value)
|
||||
v.prefixlen = 128
|
||||
|
||||
# The value is too big for IPv6. Are you a nanobot?
|
||||
except:
|
||||
return False
|
||||
|
||||
# We got an IP address, let's mark it as such
|
||||
value = str(v)
|
||||
vtype = 'address'
|
||||
|
||||
# value has not been recognized, check if it's a valid IP string
|
||||
else:
|
||||
try:
|
||||
v = netaddr.IPNetwork(value)
|
||||
|
||||
# value is a valid IP string, check if user specified
|
||||
# CIDR prefix or just an IP address, this will indicate default
|
||||
# output format
|
||||
try:
|
||||
address, prefix = value.split('/')
|
||||
vtype = 'network'
|
||||
except:
|
||||
vtype = 'address'
|
||||
|
||||
# value hasn't been recognized, maybe it's a numerical CIDR?
|
||||
except:
|
||||
try:
|
||||
address, prefix = value.split('/')
|
||||
address.isdigit()
|
||||
address = int(address)
|
||||
prefix.isdigit()
|
||||
prefix = int(prefix)
|
||||
|
||||
# It's not numerical CIDR, give up
|
||||
except:
|
||||
return False
|
||||
|
||||
# It is something, so let's try and build a CIDR from the parts
|
||||
try:
|
||||
v = netaddr.IPNetwork('0.0.0.0/0')
|
||||
v.value = address
|
||||
v.prefixlen = prefix
|
||||
|
||||
# It's not a valid IPv4 CIDR
|
||||
except:
|
||||
try:
|
||||
v = netaddr.IPNetwork('::/0')
|
||||
v.value = address
|
||||
v.prefixlen = prefix
|
||||
|
||||
# It's not a valid IPv6 CIDR. Give up.
|
||||
except:
|
||||
return False
|
||||
|
||||
# We have a valid CIDR, so let's write it in correct format
|
||||
value = str(v)
|
||||
vtype = 'network'
|
||||
|
||||
# We have a query string but it's not in the known query types. Check if
|
||||
# that string is a valid subnet, if so, we can check later if given IP
|
||||
# address/network is inside that specific subnet
|
||||
try:
|
||||
### ?? 6to4 and link-local were True here before. Should they still?
|
||||
if query and (query not in query_func_map or query == 'cidr_lookup') and ipaddr(query, 'network'):
|
||||
iplist = netaddr.IPSet([netaddr.IPNetwork(query)])
|
||||
query = 'cidr_lookup'
|
||||
except:
|
||||
pass
|
||||
|
||||
# This code checks if value maches the IP version the user wants, ie. if
|
||||
# it's any version ("ipaddr()"), IPv4 ("ipv4()") or IPv6 ("ipv6()")
|
||||
# If version does not match, return False
|
||||
if version and v.version != version:
|
||||
return False
|
||||
|
||||
extras = []
|
||||
for arg in query_func_extra_args.get(query, tuple()):
|
||||
extras.append(locals()[arg])
|
||||
try:
|
||||
return query_func_map[query](v, *extras)
|
||||
except KeyError:
|
||||
try:
|
||||
float(query)
|
||||
if v.size == 1:
|
||||
if vtype == 'address':
|
||||
return str(v.ip)
|
||||
elif vtype == 'network':
|
||||
return str(v)
|
||||
|
||||
elif v.size > 1:
|
||||
try:
|
||||
return str(v[query]) + '/' + str(v.prefixlen)
|
||||
except:
|
||||
return False
|
||||
|
||||
else:
|
||||
return value
|
||||
|
||||
except:
|
||||
raise errors.AnsibleFilterError(alias + ': unknown filter type: %s' % query)
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def ipwrap(value, query = ''):
|
||||
try:
|
||||
if isinstance(value, (list, tuple)):
|
||||
_ret = []
|
||||
for element in value:
|
||||
if ipaddr(element, query, version = False, alias = 'ipwrap'):
|
||||
_ret.append(ipaddr(element, 'wrap'))
|
||||
else:
|
||||
_ret.append(element)
|
||||
|
||||
return _ret
|
||||
else:
|
||||
_ret = ipaddr(value, query, version = False, alias = 'ipwrap')
|
||||
if _ret:
|
||||
return ipaddr(_ret, 'wrap')
|
||||
else:
|
||||
return value
|
||||
|
||||
except:
|
||||
return value
|
||||
|
||||
|
||||
def ipv4(value, query = ''):
|
||||
return ipaddr(value, query, version = 4, alias = 'ipv4')
|
||||
|
||||
|
||||
def ipv6(value, query = ''):
|
||||
return ipaddr(value, query, version = 6, alias = 'ipv6')
|
||||
|
||||
|
||||
# Split given subnet into smaller subnets or find out the biggest subnet of
|
||||
# a given IP address with given CIDR prefix
|
||||
# Usage:
|
||||
#
|
||||
# - address or address/prefix | ipsubnet
|
||||
# returns CIDR subnet of a given input
|
||||
#
|
||||
# - address/prefix | ipsubnet(cidr)
|
||||
# returns number of possible subnets for given CIDR prefix
|
||||
#
|
||||
# - address/prefix | ipsubnet(cidr, index)
|
||||
# returns new subnet with given CIDR prefix
|
||||
#
|
||||
# - address | ipsubnet(cidr)
|
||||
# returns biggest subnet with given CIDR prefix that address belongs to
|
||||
#
|
||||
# - address | ipsubnet(cidr, index)
|
||||
# returns next indexed subnet which contains given address
|
||||
def ipsubnet(value, query = '', index = 'x'):
|
||||
''' Manipulate IPv4/IPv6 subnets '''
|
||||
|
||||
try:
|
||||
vtype = ipaddr(value, 'type')
|
||||
if vtype == 'address':
|
||||
v = ipaddr(value, 'cidr')
|
||||
elif vtype == 'network':
|
||||
v = ipaddr(value, 'subnet')
|
||||
|
||||
value = netaddr.IPNetwork(v)
|
||||
except:
|
||||
return False
|
||||
|
||||
if not query:
|
||||
return str(value)
|
||||
|
||||
elif str(query).isdigit():
|
||||
vsize = ipaddr(v, 'size')
|
||||
query = int(query)
|
||||
|
||||
try:
|
||||
float(index)
|
||||
index = int(index)
|
||||
|
||||
if vsize > 1:
|
||||
try:
|
||||
return str(list(value.subnet(query))[index])
|
||||
except:
|
||||
return False
|
||||
|
||||
elif vsize == 1:
|
||||
try:
|
||||
return str(value.supernet(query)[index])
|
||||
except:
|
||||
return False
|
||||
|
||||
except:
|
||||
if vsize > 1:
|
||||
try:
|
||||
return str(len(list(value.subnet(query))))
|
||||
except:
|
||||
return False
|
||||
|
||||
elif vsize == 1:
|
||||
try:
|
||||
return str(value.supernet(query)[0])
|
||||
except:
|
||||
return False
|
||||
|
||||
return False
|
||||
|
||||
|
||||
# ---- HWaddr / MAC address filters ----
|
||||
|
||||
def hwaddr(value, query = '', alias = 'hwaddr'):
|
||||
''' Check if string is a HW/MAC address and filter it '''
|
||||
|
||||
query_func_extra_args = {
|
||||
'': ('value',),
|
||||
}
|
||||
query_func_map = {
|
||||
'': _empty_hwaddr_query,
|
||||
'bare': _bare_query,
|
||||
'bool': _bool_hwaddr_query,
|
||||
'cisco': _cisco_query,
|
||||
'eui48': _win_query,
|
||||
'linux': _linux_query,
|
||||
'pgsql': _postgresql_query,
|
||||
'postgresql': _postgresql_query,
|
||||
'psql': _postgresql_query,
|
||||
'unix': _unix_query,
|
||||
'win': _win_query,
|
||||
}
|
||||
|
||||
try:
|
||||
v = netaddr.EUI(value)
|
||||
except:
|
||||
if query and query != 'bool':
|
||||
raise errors.AnsibleFilterError(alias + ': not a hardware address: %s' % value)
|
||||
|
||||
extras = []
|
||||
for arg in query_func_extra_args.get(query, tuple()):
|
||||
extras.append(locals()[arg])
|
||||
try:
|
||||
return query_func_map[query](v, *extras)
|
||||
except KeyError:
|
||||
raise errors.AnsibleFilterError(alias + ': unknown filter type: %s' % query)
|
||||
|
||||
return False
|
||||
|
||||
def macaddr(value, query = ''):
|
||||
return hwaddr(value, query, alias = 'macaddr')
|
||||
|
||||
def _need_netaddr(f_name, *args, **kwargs):
|
||||
raise errors.AnsibleFilterError('The {0} filter requires python-netaddr be'
|
||||
' installed on the ansible controller'.format(f_name))
|
||||
|
||||
# ---- Ansible filters ----
|
||||
|
||||
class FilterModule(object):
|
||||
''' IP address and network manipulation filters '''
|
||||
filter_map = {
|
||||
# IP addresses and networks
|
||||
'ipaddr': ipaddr,
|
||||
'ipwrap': ipwrap,
|
||||
'ipv4': ipv4,
|
||||
'ipv6': ipv6,
|
||||
'ipsubnet': ipsubnet,
|
||||
|
||||
# MAC / HW addresses
|
||||
'hwaddr': hwaddr,
|
||||
'macaddr': macaddr
|
||||
}
|
||||
|
||||
def filters(self):
|
||||
if netaddr:
|
||||
return self.filter_map
|
||||
else:
|
||||
# Need to install python-netaddr for these filters to work
|
||||
return dict((f, partial(_need_netaddr, f)) for f in self.filter_map)
|
||||
Loading…
Reference in a new issue