Adding network scanning

This commit is contained in:
2015-03-27 22:54:25 +00:00
parent 0a2e9fa9f4
commit c883e49ac3
178 changed files with 347825 additions and 4 deletions
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,311 @@
#-----------------------------------------------------------------------------
# Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
#
# Released under the BSD license. See the LICENSE file for details.
#-----------------------------------------------------------------------------
"""
Routines and classes for supporting and expressing IP address ranges using a
glob style syntax.
"""
from netaddr.core import AddrFormatError, AddrConversionError
from netaddr.ip import IPRange, IPAddress, IPNetwork, iprange_to_cidrs
#-----------------------------------------------------------------------------
def valid_glob(ipglob):
"""
:param ipglob: An IP address range in a glob-style format.
:return: ``True`` if IP range glob is valid, ``False`` otherwise.
"""
#TODO: Add support for abbreviated ipglobs.
#TODO: e.g. 192.0.*.* == 192.0.*
#TODO: *.*.*.* == *
#TODO: Add strict flag to enable verbose ipglob checking.
if not hasattr(ipglob, 'split'):
return False
seen_hyphen = False
seen_asterisk = False
octets = ipglob.split('.')
if len(octets) != 4:
return False
for octet in octets:
if '-' in octet:
if seen_hyphen:
return False
seen_hyphen = True
if seen_asterisk:
# Asterisks cannot precede hyphenated octets.
return False
try:
(octet1, octet2) = [int(i) for i in octet.split('-')]
except ValueError:
return False
if octet1 >= octet2:
return False
if not 0 <= octet1 <= 254:
return False
if not 1 <= octet2 <= 255:
return False
elif octet == '*':
seen_asterisk = True
else:
if seen_hyphen is True:
return False
if seen_asterisk is True:
return False
try:
if not 0 <= int(octet) <= 255:
return False
except ValueError:
return False
return True
#-----------------------------------------------------------------------------
def glob_to_iptuple(ipglob):
"""
A function that accepts a glob-style IP range and returns the component
lower and upper bound IP address.
:param ipglob: an IP address range in a glob-style format.
:return: a tuple contain lower and upper bound IP objects.
"""
if not valid_glob(ipglob):
raise AddrFormatError('not a recognised IP glob range: %r!' % ipglob)
start_tokens = []
end_tokens = []
for octet in ipglob.split('.'):
if '-' in octet:
tokens = octet.split('-')
start_tokens.append(tokens[0])
end_tokens.append(tokens[1])
elif octet == '*':
start_tokens.append('0')
end_tokens.append('255')
else:
start_tokens.append(octet)
end_tokens.append(octet)
return IPAddress('.'.join(start_tokens)), IPAddress('.'.join(end_tokens))
#-----------------------------------------------------------------------------
def glob_to_iprange(ipglob):
"""
A function that accepts a glob-style IP range and returns the equivalent
IP range.
:param ipglob: an IP address range in a glob-style format.
:return: an IPRange object.
"""
if not valid_glob(ipglob):
raise AddrFormatError('not a recognised IP glob range: %r!' % ipglob)
start_tokens = []
end_tokens = []
for octet in ipglob.split('.'):
if '-' in octet:
tokens = octet.split('-')
start_tokens.append(tokens[0])
end_tokens.append(tokens[1])
elif octet == '*':
start_tokens.append('0')
end_tokens.append('255')
else:
start_tokens.append(octet)
end_tokens.append(octet)
return IPRange('.'.join(start_tokens), '.'.join(end_tokens))
#-----------------------------------------------------------------------------
def iprange_to_globs(start, end):
"""
A function that accepts an arbitrary start and end IP address or subnet
and returns one or more glob-style IP ranges.
:param start: the start IP address or subnet.
:param end: the end IP address or subnet.
:return: a list containing one or more IP globs.
"""
start = IPAddress(start)
end = IPAddress(end)
if start.version != 4 and end.version != 4:
raise AddrConversionError('IP glob ranges only support IPv4!')
def _iprange_to_glob(lb, ub):
# Internal function to process individual IP globs.
t1 = [int(_) for _ in str(lb).split('.')]
t2 = [int(_) for _ in str(ub).split('.')]
tokens = []
seen_hyphen = False
seen_asterisk = False
for i in range(4):
if t1[i] == t2[i]:
# A normal octet.
tokens.append(str(t1[i]))
elif (t1[i] == 0) and (t2[i] == 255):
# An asterisk octet.
tokens.append('*')
seen_asterisk = True
else:
# Create a hyphenated octet - only one allowed per IP glob.
if not seen_asterisk:
if not seen_hyphen:
tokens.append('%s-%s' % (t1[i], t2[i]))
seen_hyphen = True
else:
raise AddrConversionError('only 1 hyphenated octet' \
' per IP glob allowed!')
else:
raise AddrConversionError("asterisks are not allowed' \
' before hyphenated octets!")
return '.'.join(tokens)
globs = []
try:
# IP range can be represented by a single glob.
ipglob = _iprange_to_glob(start, end)
if not valid_glob(ipglob):
#TODO: this is a workaround, it is produces non-optimal but valid
#TODO: glob conversions. Fix inner function so that is always
#TODO: produces a valid glob.
raise AddrConversionError('invalid ip glob created')
globs.append(ipglob)
except AddrConversionError:
# Break IP range up into CIDRs before conversion to globs.
#
#TODO: this is still not completely optimised but is good enough
#TODO: for the moment.
#
for cidr in iprange_to_cidrs(start, end):
ipglob = _iprange_to_glob(cidr[0], cidr[-1])
globs.append(ipglob)
return globs
#-----------------------------------------------------------------------------
def glob_to_cidrs(ipglob):
"""
A function that accepts a glob-style IP range and returns a list of one
or more IP CIDRs that exactly matches it.
:param ipglob: an IP address range in a glob-style format.
:return: a list of one or more IP objects.
"""
return iprange_to_cidrs(*glob_to_iptuple(ipglob))
#-----------------------------------------------------------------------------
def cidr_to_glob(cidr):
"""
A function that accepts an IP subnet in a glob-style format and returns
a list of CIDR subnets that exactly matches the specified glob.
:param cidr: an IP object CIDR subnet.
:return: a list of one or more IP addresses and subnets.
"""
ip = IPNetwork(cidr)
globs = iprange_to_globs(ip[0], ip[-1])
if len(globs) != 1:
# There should only ever be a one to one mapping between a CIDR and
# an IP glob range.
raise AddrConversionError('bad CIDR to IP glob conversion!')
return globs[0]
#-----------------------------------------------------------------------------
class IPGlob(IPRange):
"""
Represents an IP address range using a glob-style syntax ``x.x.x-y.*``
Individual octets can be represented using the following shortcuts :
1. ``*`` - the asterisk octet (represents values ``0`` through ``255``)
2. ``x-y`` - the hyphenated octet (represents values ``x`` through ``y``)
A few basic rules also apply :
1. ``x`` must always be greater than ``y``, therefore :
- ``x`` can only be ``0`` through ``254``
- ``y`` can only be ``1`` through ``255``
2. only one hyphenated octet per IP glob is allowed
3. only asterisks are permitted after a hyphenated octet
Examples:
+------------------+------------------------------+
| IP glob | Description |
+==================+==============================+
| ``192.0.2.1`` | a single address |
+------------------+------------------------------+
| ``192.0.2.0-31`` | 32 addresses |
+------------------+------------------------------+
| ``192.0.2.*`` | 256 addresses |
+------------------+------------------------------+
| ``192.0.2-3.*`` | 512 addresses |
+------------------+------------------------------+
| ``192.0-1.*.*`` | 131,072 addresses |
+------------------+------------------------------+
| ``*.*.*.*`` | the whole IPv4 address space |
+------------------+------------------------------+
.. note :: \
IP glob ranges are not directly equivalent to CIDR blocks. \
They can represent address ranges that do not fall on strict bit mask \
boundaries. They are suitable for use in configuration files, being \
more obvious and readable than their CIDR counterparts, especially for \
admins and end users with little or no networking knowledge or \
experience. All CIDR addresses can always be represented as IP globs \
but the reverse is not always true.
"""
__slots__ = ('_glob',)
def __init__(self, ipglob):
(start, end) = glob_to_iptuple(ipglob)
super(IPGlob, self).__init__(start, end)
self.glob = iprange_to_globs(self._start, self._end)[0]
def __getstate__(self):
""":return: Pickled state of an `IPGlob` object."""
return super(IPGlob, self).__getstate__()
def __setstate__(self, state):
""":param state: data used to unpickle a pickled `IPGlob` object."""
super(IPGlob, self).__setstate__(state)
self.glob = iprange_to_globs(self._start, self._end)[0]
def _get_glob(self):
return self._glob
def _set_glob(self, ipglob):
(self._start, self._end) = glob_to_iptuple(ipglob)
self._glob = iprange_to_globs(self._start, self._end)[0]
glob = property(_get_glob, _set_glob, None,
'an arbitrary IP address range in glob format.')
def __str__(self):
""":return: IP glob in common representational format."""
return "%s" % self.glob
def __repr__(self):
""":return: Python statement to create an equivalent object"""
return "%s('%s')" % (self.__class__.__name__, self.glob)
@@ -0,0 +1,433 @@
#!/usr/bin/env python
#-----------------------------------------------------------------------------
# Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
#
# Released under the BSD license. See the LICENSE file for details.
#-----------------------------------------------------------------------------
#
# DISCLAIMER
#
# netaddr is not sponsored nor endorsed by IANA.
#
# Use of data from IANA (Internet Assigned Numbers Authority) is subject to
# copyright and is provided with prior written permission.
#
# IANA data files included with netaddr are not modified in any way but are
# parsed and made available to end users through an API.
#
# See README file and source code for URLs to latest copies of the relevant
# files.
#
#-----------------------------------------------------------------------------
"""
Routines for accessing data published by IANA (Internet Assigned Numbers
Authority).
More details can be found at the following URLs :-
- IANA Home Page - http://www.iana.org/
- IEEE Protocols Information Home Page - http://www.iana.org/protocols/
"""
import os as _os
import os.path as _path
import sys as _sys
import re as _re
from xml.sax import make_parser, handler
from netaddr.core import Publisher, Subscriber, PrettyPrinter, dos2unix
from netaddr.ip import IPAddress, IPNetwork, IPRange, \
cidr_abbrev_to_verbose, iprange_to_cidrs
from netaddr.compat import _dict_items, _callable
#-----------------------------------------------------------------------------
#: Topic based lookup dictionary for IANA information.
IANA_INFO = {
'IPv4' : {},
'IPv6' : {},
'multicast' : {},
}
#-----------------------------------------------------------------------------
class SaxRecordParser(handler.ContentHandler):
def __init__(self, callback=None):
self._level = 0
self._is_active = False
self._record = None
self._tag_level = None
self._tag_payload = None
self._tag_feeding = None
self._callback = callback
def startElement(self, name, attrs):
self._level += 1
if self._is_active is False:
if name == 'record':
self._is_active = True
self._tag_level = self._level
self._record = {}
if 'date' in attrs:
self._record['date'] = attrs['date']
elif self._level == self._tag_level + 1:
if name == 'xref':
if 'type' in attrs and 'data' in attrs:
l = self._record.setdefault(attrs['type'], [])
l.append(attrs['data'])
else:
self._tag_payload = []
self._tag_feeding = True
else:
self._tag_feeding = False
def endElement(self, name):
if self._is_active is True:
if name == 'record' and self._tag_level == self._level:
self._is_active = False
self._tag_level = None
if _callable(self._callback):
self._callback(self._record)
self._record = None
elif self._level == self._tag_level + 1:
if name != 'xref':
self._record[name] = ''.join(self._tag_payload)
self._tag_payload = None
self._tag_feeding = False
self._level -= 1
def characters(self, content):
if self._tag_feeding is True:
self._tag_payload.append(content)
class XMLRecordParser(Publisher):
"""
A configurable Parser that understands how to parse XML based records.
"""
def __init__(self, fh, **kwargs):
"""
Constructor.
fh - a valid, open file handle to XML based record data.
"""
super(XMLRecordParser, self).__init__()
self.xmlparser = make_parser()
self.xmlparser.setContentHandler(SaxRecordParser(self.consume_record))
self.fh = fh
self.__dict__.update(kwargs)
def process_record(self, rec):
"""
This is the callback method invoked for every record. It is usually
over-ridden by base classes to provide specific record-based logic.
Any record can be vetoed (not passed to registered Subscriber objects)
by simply returning None.
"""
return rec
def consume_record(self, rec):
record = self.process_record(rec)
if record is not None:
self.notify(record)
def parse(self):
"""
Parse and normalises records, notifying registered subscribers with
record data as it is encountered.
"""
self.xmlparser.parse(self.fh)
#-----------------------------------------------------------------------------
class IPv4Parser(XMLRecordParser):
"""
A XMLRecordParser that understands how to parse and retrieve data records
from the IANA IPv4 address space file.
It can be found online here :-
- http://www.iana.org/assignments/ipv4-address-space/ipv4-address-space.xml
"""
def __init__(self, fh, **kwargs):
"""
Constructor.
fh - a valid, open file handle to an IANA IPv4 address space file.
kwargs - additional parser options.
"""
super(IPv4Parser, self).__init__(fh)
def process_record(self, rec):
"""
Callback method invoked for every record.
See base class method for more details.
"""
record = {}
for key in ('prefix', 'designation', 'date', 'whois', 'status'):
record[key] = str(rec.get(key, '')).strip()
# Strip leading zeros from octet.
if '/' in record['prefix']:
(octet, prefix) = record['prefix'].split('/')
record['prefix'] = '%d/%d' % (int(octet), int(prefix))
record['status'] = record['status'].capitalize()
return record
#-----------------------------------------------------------------------------
class IPv6Parser(XMLRecordParser):
"""
A XMLRecordParser that understands how to parse and retrieve data records
from the IANA IPv6 address space file.
It can be found online here :-
- http://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xml
"""
def __init__(self, fh, **kwargs):
"""
Constructor.
fh - a valid, open file handle to an IANA IPv6 address space file.
kwargs - additional parser options.
"""
super(IPv6Parser, self).__init__(fh)
def process_record(self, rec):
"""
Callback method invoked for every record.
See base class method for more details.
"""
record = {
'prefix': str(rec.get('prefix', '')).strip(),
'allocation': str(rec.get('description', '')).strip(),
'reference': str(rec.get('rfc', [''])[0]).strip(),
}
return record
#-----------------------------------------------------------------------------
class MulticastParser(XMLRecordParser):
"""
A XMLRecordParser that knows how to process the IANA IPv4 multicast address
allocation file.
It can be found online here :-
- http://www.iana.org/assignments/multicast-addresses/multicast-addresses.xml
"""
def __init__(self, fh, **kwargs):
"""
Constructor.
fh - a valid, open file handle to an IANA IPv4 multicast address
allocation file.
kwargs - additional parser options.
"""
super(MulticastParser, self).__init__(fh)
def normalise_addr(self, addr):
"""
Removes variations from address entries found in this particular file.
"""
if '-' in addr:
(a1, a2) = addr.split('-')
o1 = a1.strip().split('.')
o2 = a2.strip().split('.')
return '%s-%s' % ('.'.join([str(int(i)) for i in o1]),
'.'.join([str(int(i)) for i in o2]))
else:
o1 = addr.strip().split('.')
return '.'.join([str(int(i)) for i in o1])
def process_record(self, rec):
"""
Callback method invoked for every record.
See base class method for more details.
"""
if 'addr' in rec:
record = {
'address': self.normalise_addr(str(rec['addr'])),
'descr': str(rec.get('description', '')),
}
return record
#-----------------------------------------------------------------------------
class DictUpdater(Subscriber):
"""
Concrete Subscriber that inserts records received from a Publisher into a
dictionary.
"""
def __init__(self, dct, topic, unique_key):
"""
Constructor.
dct - lookup dict or dict like object to insert records into.
topic - high-level category name of data to be processed.
unique_key - key name in data dict that uniquely identifies it.
"""
self.dct = dct
self.topic = topic
self.unique_key = unique_key
def update(self, data):
"""
Callback function used by Publisher to notify this Subscriber about
an update. Stores topic based information into dictionary passed to
constructor.
"""
data_id = data[self.unique_key]
if self.topic == 'IPv4':
cidr = IPNetwork(cidr_abbrev_to_verbose(data_id))
self.dct[cidr] = data
elif self.topic == 'IPv6':
cidr = IPNetwork(cidr_abbrev_to_verbose(data_id))
self.dct[cidr] = data
elif self.topic == 'multicast':
iprange = None
if '-' in data_id:
# See if we can manage a single CIDR.
(first, last) = data_id.split('-')
iprange = IPRange(first, last)
cidrs = iprange.cidrs()
if len(cidrs) == 1:
iprange = cidrs[0]
else:
iprange = IPAddress(data_id)
self.dct[iprange] = data
#-----------------------------------------------------------------------------
def load_info():
"""
Parse and load internal IANA data lookups with the latest information from
data files.
"""
PATH = _path.dirname(__file__)
ipv4 = IPv4Parser(open(_path.join(PATH, 'ipv4-address-space.xml')))
ipv4.attach(DictUpdater(IANA_INFO['IPv4'], 'IPv4', 'prefix'))
ipv4.parse()
ipv6 = IPv6Parser(open(_path.join(PATH, 'ipv6-address-space.xml')))
ipv6.attach(DictUpdater(IANA_INFO['IPv6'], 'IPv6', 'prefix'))
ipv6.parse()
mcast = MulticastParser(open(_path.join(PATH, 'multicast-addresses.xml')))
mcast.attach(DictUpdater(IANA_INFO['multicast'], 'multicast', 'address'))
mcast.parse()
#-----------------------------------------------------------------------------
def pprint_info(fh=None):
"""
Pretty prints IANA information to filehandle.
"""
if fh is None:
fh = _sys.stdout
for category in sorted(IANA_INFO):
fh.write('-' * len(category) + "\n")
fh.write(category + "\n")
fh.write('-' * len(category) + "\n")
ipranges = IANA_INFO[category]
for iprange in sorted(ipranges):
details = ipranges[iprange]
fh.write('%-45r' % (iprange) + details + "\n")
#-----------------------------------------------------------------------------
def query(ip_addr):
"""
Returns informational data specific to this IP address.
"""
info = {}
def within_bounds(ip, ip_range):
# Boundary checking for multiple IP classes.
if hasattr(ip_range, 'first'):
# IP network or IP range.
return ip in ip_range
elif hasattr(ip_range, 'value'):
# IP address.
return ip == ip_range
raise Exception('Unsupported IP range or address: %r!' % ip_range)
if ip_addr.version == 4:
for cidr, record in _dict_items(IANA_INFO['IPv4']):
if within_bounds(ip_addr, cidr):
info.setdefault('IPv4', [])
info['IPv4'].append(record)
if ip_addr.is_multicast():
for iprange, record in _dict_items(IANA_INFO['multicast']):
if within_bounds(ip_addr, iprange):
info.setdefault('Multicast', [])
info['Multicast'].append(record)
elif ip_addr.version == 6:
for cidr, record in _dict_items(IANA_INFO['IPv6']):
if within_bounds(ip_addr, cidr):
info.setdefault('IPv6', [])
info['IPv6'].append(record)
return info
#-----------------------------------------------------------------------------
def get_latest_files():
"""Download the latest files from IANA"""
if _sys.version_info[0] == 3:
# Python 3.x
from urllib.request import Request, urlopen
else:
# Python 2.x
from urllib2 import Request, urlopen
urls = [
'http://www.iana.org/assignments/ipv4-address-space/ipv4-address-space.xml',
'http://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xml',
'http://www.iana.org/assignments/multicast-addresses/multicast-addresses.xml',
]
for url in urls:
_sys.stdout.write('downloading latest copy of %s\n' % url)
request = Request(url)
response = urlopen(request)
save_path = _path.dirname(__file__)
basename = _os.path.basename(response.geturl().rstrip('/'))
filename = _path.join(save_path, basename)
fh = open(filename, 'wb')
fh.write(response.read())
fh.close()
# Make sure the line endings are consistent across platforms.
dos2unix(filename)
#-----------------------------------------------------------------------------
if __name__ == '__main__':
# Generate indices when module is executed as a script.
get_latest_files()
# On module import, read IANA data files and populate lookups dict.
load_info()
@@ -0,0 +1,523 @@
"""Immutable integer set type.
Integer set class.
Copyright (C) 2010, David Moss.
Ported to Python 3.x.
Copyright (C) 2006, Heiko Wundram.
Released under the MIT license:
Copyright (c) 2006, Heiko Wundram.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
* The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""
# Version information
# -------------------
__author__ = "Heiko Wundram <me@modelnine.org>"
__version__ = "0.2"
__revision__ = "7"
__date__ = "2006-01-23"
# Utility classes
# ---------------
import sys as _sys
# Not the most efficient way of dealing with the int/long issue in Python 3.x
# but it requires the least amount of code changes.
# number of code changes.
if _sys.version_info[0] == 3:
# Python 3.x
_long = int
else:
# Python 2.x
_long = long
from netaddr.compat import _func_name, _func_doc
#-----------------------------------------------------------------------------
class _Infinity(object):
"""Internal type used to represent infinity values."""
__slots__ = ["_neg"]
def __init__(self, neg):
self._neg = neg
def __lt__(self, value):
if not isinstance(value, (int, _long, _Infinity)):
return NotImplemented
return ( self._neg and
not ( isinstance(value, _Infinity) and value._neg ) )
def __le__(self, value):
if not isinstance(value, (int, _long, _Infinity)):
return NotImplemented
return self._neg
def __gt__(self, value):
if not isinstance(value, (int, _long, _Infinity)):
return NotImplemented
return not ( self._neg or
( isinstance(value, _Infinity) and not value._neg ) )
def __ge__(self, value):
if not isinstance(value, (int, _long, _Infinity)):
return NotImplemented
return not self._neg
def __eq__(self, value):
if not isinstance(value, (int, _long, _Infinity)):
return NotImplemented
return isinstance(value, _Infinity) and self._neg == value._neg
def __ne__(self, value):
if not isinstance(value, (int, _long, _Infinity)):
return NotImplemented
return not isinstance(value, _Infinity) or self._neg != value._neg
def __repr__(self):
return "None"
#-----------------------------------------------------------------------------
_MININF = _Infinity(True)
_MAXINF = _Infinity(False)
#-----------------------------------------------------------------------------
class IntSet(object):
"""Integer set class with efficient storage in a RLE format of ranges.
Supports minus and plus infinity in the range."""
__slots__ = ["_ranges", "_min", "_max", "_hash"]
def __init__(self, *args, **kwargs):
"""Initialize an integer set. The constructor accepts an unlimited
number of arguments that may either be tuples in the form of
(start, stop) where either start or stop may be a number or None to
represent maximum/minimum in that direction. The range specified by
(start, stop) is always inclusive (differing from the builtin range
operator).
Keyword arguments that can be passed to an integer set are min and
max, which specify the minimum and maximum number in the set,
respectively. You can also pass None here to represent minus or plus
infinity, which is also the default.
"""
# Special case copy constructor.
if len(args) == 1 and isinstance(args[0], IntSet):
if kwargs:
raise ValueError("No keyword arguments for copy constructor.")
self._min = args[0]._min
self._max = args[0]._max
self._ranges = args[0]._ranges
self._hash = args[0]._hash
return
# Initialize set.
self._ranges = []
# Process keyword arguments.
self._min = kwargs.pop("min", _MININF)
self._max = kwargs.pop("max", _MAXINF)
if self._min is None:
self._min = _MININF
if self._max is None:
self._max = _MAXINF
# Check keyword arguments.
if kwargs:
raise ValueError("Invalid keyword argument.")
if not ( isinstance(self._min, (int, _long)) or self._min is _MININF ):
raise TypeError("Invalid type of min argument.")
if not ( isinstance(self._max, (int, _long)) or self._max is _MAXINF ):
raise TypeError("Invalid type of max argument.")
if ( self._min is not _MININF and self._max is not _MAXINF and
self._min > self._max ):
raise ValueError("Minimum is not smaller than maximum.")
if isinstance(self._max, (int, _long)):
self._max += 1
# Process arguments.
for arg in args:
if isinstance(arg, (int, _long)):
start, stop = arg, arg+1
elif isinstance(arg, tuple):
if len(arg) != 2:
raise ValueError("Invalid tuple, must be (start,stop).")
# Process argument.
start, stop = arg
if start is None:
start = self._min
if stop is None:
stop = self._max
# Check arguments.
if not ( isinstance(start, (int, _long)) or start is _MININF ):
raise TypeError("Invalid type of tuple start.")
if not ( isinstance(stop, (int, _long)) or stop is _MAXINF ):
raise TypeError("Invalid type of tuple stop.")
if ( start is not _MININF and stop is not _MAXINF and
start > stop ):
continue
if isinstance(stop, (int, _long)):
stop += 1
else:
raise TypeError("Invalid argument.")
if start > self._max:
continue
elif start < self._min:
start = self._min
if stop < self._min:
continue
elif stop > self._max:
stop = self._max
self._ranges.append((start, stop))
# Normalize set.
self._normalize()
# Utility functions for set operations
# ------------------------------------
def _iterranges(self, r1, r2, minval=_MININF, maxval=_MAXINF):
curval = minval
curstates = {"r1":False, "r2":False}
imax, jmax = 2*len(r1), 2*len(r2)
i, j = 0, 0
while i < imax or j < jmax:
if i < imax and ( ( j < jmax and
r1[i>>1][i&1] < r2[j>>1][j&1] ) or
j == jmax ):
cur_r, newname, newstate = r1[i>>1][i&1], "r1", not (i&1)
i += 1
else:
cur_r, newname, newstate = r2[j>>1][j&1], "r2", not (j&1)
j += 1
if curval < cur_r:
if cur_r > maxval:
break
yield curstates, (curval, cur_r)
curval = cur_r
curstates[newname] = newstate
if curval < maxval:
yield curstates, (curval, maxval)
def _normalize(self):
self._ranges.sort()
i = 1
while i < len(self._ranges):
if self._ranges[i][0] < self._ranges[i-1][1]:
self._ranges[i-1] = (self._ranges[i-1][0],
max(self._ranges[i-1][1],
self._ranges[i][1]))
del self._ranges[i]
else:
i += 1
self._ranges = tuple(self._ranges)
self._hash = hash(self._ranges)
def __coerce__(self, other):
if isinstance(other, IntSet):
return self, other
elif isinstance(other, (int, _long, tuple)):
try:
return self, self.__class__(other)
except TypeError:
# Catch a type error, in that case the structure specified by
# other is something we can't coerce, return NotImplemented.
# ValueErrors are not caught, they signal that the data was
# invalid for the constructor. This is appropriate to signal
# as a ValueError to the caller.
return NotImplemented
elif isinstance(other, list):
try:
return self, self.__class__(*other)
except TypeError:
# See above.
return NotImplemented
return NotImplemented
# Set function definitions
# ------------------------
def _make_function(name, type, doc, pall, pany=None):
"""Makes a function to match two ranges. Accepts two types: either
'set', which defines a function which returns a set with all ranges
matching pall (pany is ignored), or 'bool', which returns True if pall
matches for all ranges and pany matches for any one range. doc is the
dostring to give this function. pany may be none to ignore the any
match.
The predicates get a dict with two keys, 'r1', 'r2', which denote
whether the current range is present in range1 (self) and/or range2
(other) or none of the two, respectively."""
if type == "set":
def f(self, other):
coerced = self.__coerce__(other)
if coerced is NotImplemented:
return NotImplemented
other = coerced[1]
newset = self.__class__.__new__(self.__class__)
newset._min = min(self._min, other._min)
newset._max = max(self._max, other._max)
newset._ranges = []
for states, (start, stop) in \
self._iterranges(self._ranges, other._ranges,
newset._min, newset._max):
if pall(states):
if newset._ranges and newset._ranges[-1][1] == start:
newset._ranges[-1] = (newset._ranges[-1][0], stop)
else:
newset._ranges.append((start, stop))
newset._ranges = tuple(newset._ranges)
newset._hash = hash(self._ranges)
return newset
elif type == "bool":
def f(self, other):
coerced = self.__coerce__(other)
if coerced is NotImplemented:
return NotImplemented
other = coerced[1]
_min = min(self._min, other._min)
_max = max(self._max, other._max)
found = not pany
for states, (start, stop) in \
self._iterranges(self._ranges, other._ranges,
_min, _max):
if not pall(states):
return False
found = found or pany(states)
return found
else:
raise ValueError("Invalid type of function to create.")
_func_name(f, name)
_func_doc(f, doc)
return f
# Intersection.
__and__ = _make_function("__and__", "set",
"Intersection of two sets as a new set.",
lambda s: s["r1"] and s["r2"])
__rand__ = _make_function("__rand__", "set",
"Intersection of two sets as a new set.",
lambda s: s["r1"] and s["r2"])
intersection = _make_function("intersection", "set",
"Intersection of two sets as a new set.",
lambda s: s["r1"] and s["r2"])
# Union.
__or__ = _make_function("__or__", "set",
"Union of two sets as a new set.",
lambda s: s["r1"] or s["r2"])
__ror__ = _make_function("__ror__", "set",
"Union of two sets as a new set.",
lambda s: s["r1"] or s["r2"])
union = _make_function("union", "set",
"Union of two sets as a new set.",
lambda s: s["r1"] or s["r2"])
# Difference.
__sub__ = _make_function("__sub__", "set",
"Difference of two sets as a new set.",
lambda s: s["r1"] and not s["r2"])
__rsub__ = _make_function("__rsub__", "set",
"Difference of two sets as a new set.",
lambda s: s["r2"] and not s["r1"])
difference = _make_function("difference", "set",
"Difference of two sets as a new set.",
lambda s: s["r1"] and not s["r2"])
# Symmetric difference.
__xor__ = _make_function("__xor__", "set",
"Symmetric difference of two sets as a new set.",
lambda s: s["r1"] ^ s["r2"])
__rxor__ = _make_function("__rxor__", "set",
"Symmetric difference of two sets as a new set.",
lambda s: s["r1"] ^ s["r2"])
symmetric_difference = _make_function("symmetric_difference", "set",
"Symmetric difference of two sets as a new set.",
lambda s: s["r1"] ^ s["r2"])
# Containership testing.
__contains__ = _make_function("__contains__", "bool",
"Returns true if self is superset of other.",
lambda s: s["r1"] or not s["r2"])
issubset = _make_function("issubset", "bool",
"Returns true if self is subset of other.",
lambda s: s["r2"] or not s["r1"])
istruesubset = _make_function("istruesubset", "bool",
"Returns true if self is true subset of other.",
lambda s: s["r2"] or not s["r1"],
lambda s: s["r2"] and not s["r1"])
issuperset = _make_function("issuperset", "bool",
"Returns true if self is superset of other.",
lambda s: s["r1"] or not s["r2"])
istruesuperset = _make_function("istruesuperset", "bool",
"Returns true if self is true superset of other.",
lambda s: s["r1"] or not s["r2"],
lambda s: s["r1"] and not s["r2"])
overlaps = _make_function("overlaps", "bool",
"Returns true if self overlaps with other.",
lambda s: True,
lambda s: s["r1"] and s["r2"])
# Comparison.
__eq__ = _make_function("__eq__", "bool",
"Returns true if self is equal to other.",
lambda s: not ( s["r1"] ^ s["r2"] ))
__ne__ = _make_function("__ne__", "bool",
"Returns true if self is different to other.",
lambda s: True,
lambda s: s["r1"] ^ s["r2"])
# Clean up namespace.
del _make_function
# Define other functions.
def inverse(self):
"""Inverse of set as a new set."""
newset = self.__class__.__new__(self.__class__)
newset._min = self._min
newset._max = self._max
newset._ranges = []
laststop = self._min
for r in self._ranges:
if laststop < r[0]:
newset._ranges.append((laststop, r[0]))
laststop = r[1]
if laststop < self._max:
newset._ranges.append((laststop, self._max))
return newset
__invert__ = inverse
# Hashing
# -------
def __hash__(self):
"""Returns a hash value representing this integer set. As the set is
always stored normalized, the hash value is guaranteed to match for
matching ranges."""
return self._hash
# Iterating
# ---------
def __len__(self):
"""Get length of this integer set. In case the length is larger than
2**31 (including infinitely sized integer sets), it raises an
OverflowError. This is due to len() restricting the size to
0 <= len < 2**31."""
if not self._ranges:
return 0
if self._ranges[0][0] is _MININF or self._ranges[-1][1] is _MAXINF:
raise OverflowError("Infinitely sized integer set.")
rlen = 0
for r in self._ranges:
rlen += r[1]-r[0]
if rlen >= 2**31:
raise OverflowError("Integer set bigger than 2**31.")
return rlen
def len(self):
"""Returns the length of this integer set as an integer. In case the
length is infinite, returns -1. This function exists because of a
limitation of the builtin len() function which expects values in
the range 0 <= len < 2**31. Use this function in case your integer
set might be larger."""
if not self._ranges:
return 0
if self._ranges[0][0] is _MININF or self._ranges[-1][1] is _MAXINF:
return -1
rlen = 0
for r in self._ranges:
rlen += r[1]-r[0]
return rlen
def __nonzero__(self):
"""Returns true if this integer set contains at least one item."""
# Python 2.x
return bool(self._ranges)
__bool__ = __nonzero__ # Python 3.x
def __iter__(self):
"""Iterate over all values in this integer set. Iteration always starts
by iterating from lowest to highest over the ranges that are bounded.
After processing these, all ranges that are unbounded (maximum 2) are
yielded intermixed."""
ubranges = []
for r in self._ranges:
if r[0] is _MININF:
if r[1] is _MAXINF:
ubranges.extend(([0, 1], [-1, -1]))
else:
ubranges.append([r[1]-1, -1])
elif r[1] is _MAXINF:
ubranges.append([r[0], 1])
else:
# Little hackish, but bombs out on 32-bit platforms if using
# xrange.
val = r[0]
while val < r[1]:
yield val
val += 1
if ubranges:
while True:
for ubrange in ubranges:
yield ubrange[0]
ubrange[0] += ubrange[1]
# Printing
# --------
def __repr__(self):
"""Return a representation of this integer set. The representation is
executable to get an equal integer set."""
rv = []
for start, stop in self._ranges:
if ( isinstance(start, (int, _long)) and \
isinstance(stop, (int, _long))
and stop-start == 1 ):
rv.append("%r" % start)
elif isinstance(stop, (int, _long)):
rv.append("(%r,%r)" % (start, stop-1))
else:
rv.append("(%r,%r)" % (start, stop))
if self._min is not _MININF:
rv.append("min=%r" % self._min)
if self._max is not _MAXINF:
rv.append("max=%r" % self._max)
return "%s(%s)" % (self.__class__.__name__, ",".join(rv))
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,144 @@
<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl" href="ipv6-address-space.xsl"?>
<?oxygen RNGSchema="ipv6-address-space.rng" type="xml"?>
<registry xmlns="http://www.iana.org/assignments" id="ipv6-address-space">
<title>Internet Protocol Version 6 Address Space</title>
<updated>2012-08-02</updated>
<note>The IPv6 address management function was formally delegated to
IANA in December 1995 <xref type="rfc" data="rfc1881"/>. The registration procedure
was confirmed with the IETF Chair in March 2010.</note>
<registry id="ipv6-address-space-1">
<registration_rule>IESG Approval</registration_rule>
<record>
<prefix>0000::/8</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
<xref type="note" data="1"/>
<xref type="note" data="5"/>
<xref type="note" data="6"/>
</record>
<record>
<prefix>0100::/8</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
<xref type="note" data="8"/>
</record>
<record>
<prefix>0200::/7</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4048"/>
<xref type="note" data="2"/>
</record>
<record>
<prefix>0400::/6</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>0800::/5</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>1000::/4</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>2000::/3</prefix>
<description>Global Unicast</description>
<xref type="rfc" data="rfc4291"/>
<xref type="note" data="3"/>
</record>
<record>
<prefix>4000::/3</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>6000::/3</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>8000::/3</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>A000::/3</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>C000::/3</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>E000::/4</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>F000::/5</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>F800::/6</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>FC00::/7</prefix>
<description>Unique Local Unicast</description>
<xref type="rfc" data="rfc4193"/>
</record>
<record>
<prefix>FE00::/9</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>FE80::/10</prefix>
<description>Link Local Unicast</description>
<xref type="rfc" data="rfc4291"/>
</record>
<record>
<prefix>FEC0::/10</prefix>
<description>Reserved by IETF</description>
<xref type="rfc" data="rfc3879"/>
<xref type="note" data="4"/>
</record>
<record>
<prefix>FF00::/8</prefix>
<description>Multicast</description>
<xref type="rfc" data="rfc4291"/>
<xref type="note" data="7"/>
</record>
<footnote anchor="1">The "unspecified address", the "loopback address", and the IPv6
Addresses with Embedded IPv4 Addresses are assigned out of the
0000::/8 address block.</footnote>
<footnote anchor="2">0200::/7 was previously defined as an OSI NSAP-mapped prefix set
<xref type="rfc" data="rfc4548"/>. This definition has been deprecated as of December
2004 <xref type="rfc" data="rfc4048"/>.</footnote>
<footnote anchor="3">The IPv6 Unicast space encompasses the entire IPv6 address range
with the exception of FF00::/8. <xref type="rfc" data="rfc4291"/> IANA unicast address
assignments are currently limited to the IPv6 unicast address
range of 2000::/3. IANA assignments from this block are registered
in the IANA registry: <xref type="registry" data="ipv6-unicast-address-assignments"/>.</footnote>
<footnote anchor="4">FEC0::/10 was previously defined as a Site-Local scoped address
prefix. This definition has been deprecated as of September 2004
<xref type="rfc" data="rfc3879"/>.</footnote>
<footnote anchor="5">0000::/96 was previously defined as the "IPv4-compatible IPv6
address" prefix. This definition has been deprecated by <xref type="rfc" data="rfc4291"/>.</footnote>
<footnote anchor="6">The "Well Known Prefix" 64:ff9b::/96 used in an algorithmic
mapping between IPv4 to IPv6 addresses is defined out of the
0000::/8 address block, per <xref type="rfc" data="rfc6052"/>.</footnote>
<footnote anchor="7">IANA assignments from this block are registered
in the IPv6 Multicast Address Space Registry: <xref type="registry" data="ipv6-multicast-addresses"/>.</footnote>
<footnote anchor="8">0100::/64 is assigned as a Discard-Only Prefix for remote triggered blackhole routing as per <xref type="rfc" data="rfc6666"/>.</footnote>
<people/>
</registry>
</registry>
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,101 @@
#-----------------------------------------------------------------------------
# Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
#
# Released under the BSD license. See the LICENSE file for details.
#-----------------------------------------------------------------------------
"""
Routines for dealing with nmap-style IPv4 address ranges.
Based on nmap's Target Specification :-
http://nmap.org/book/man-target-specification.html
"""
from netaddr.core import AddrFormatError
from netaddr.ip import IPAddress
from netaddr.compat import _iter_range, _is_str
#-----------------------------------------------------------------------------
def _nmap_octet_target_values(spec):
# Generates sequence of values for an individual octet as defined in the
# nmap Target Specification.
values = set()
for element in spec.split(','):
if '-' in element:
left, right = element.split('-', 1)
if not left:
left = 0
if not right:
right = 255
low = int(left)
high = int(right)
if not ((0 <= low <= 255) and (0 <= high <= 255)):
raise ValueError('octet value overflow for spec %s!' % spec)
if low > high:
raise ValueError('left side of hyphen must be < right %r' % element)
for octet in _iter_range(low, high + 1):
values.add(octet)
else:
octet = int(element)
if not (0 <= octet <= 255):
raise ValueError('octet value overflow for spec %s!' % spec)
values.add(octet)
return sorted(values)
#-----------------------------------------------------------------------------
def _generate_nmap_octet_ranges(nmap_target_spec):
# Generate 4 lists containing all octets defined by a given nmap Target
# specification.
if not _is_str(nmap_target_spec):
raise TypeError('string expected, not %s' % type(nmap_target_spec))
if not nmap_target_spec:
raise ValueError('nmap target specification cannot be blank!')
tokens = nmap_target_spec.split('.')
if len(tokens) != 4:
raise AddrFormatError('invalid nmap range: %s' % nmap_target_spec)
if tokens[0] == '-':
raise AddrFormatError('first octet cannot be a sole hyphen!')
return (_nmap_octet_target_values(tokens[0]),
_nmap_octet_target_values(tokens[1]),
_nmap_octet_target_values(tokens[2]),
_nmap_octet_target_values(tokens[3]))
#-----------------------------------------------------------------------------
def valid_nmap_range(nmap_target_spec):
"""
:param nmap_target_spec: an nmap-style IP range target specification.
:return: ``True`` if IP range target spec is valid, ``False`` otherwise.
"""
try:
_generate_nmap_octet_ranges(nmap_target_spec)
return True
except (TypeError, ValueError, AddrFormatError):
pass
return False
#-----------------------------------------------------------------------------
def iter_nmap_range(nmap_target_spec):
"""
The nmap security tool supports a custom type of IPv4 range using multiple
hyphenated octets. This generator provides iterators yielding IP addresses
according to this rule set.
:param nmap_target_spec: an nmap-style IP range target specification.
:return: an iterator producing IPAddress objects for each IP in the range.
"""
octet_ranges = _generate_nmap_octet_ranges(nmap_target_spec)
for w in octet_ranges[0]:
for x in octet_ranges[1]:
for y in octet_ranges[2]:
for z in octet_ranges[3]:
yield IPAddress("%d.%d.%d.%d" % (w, x, y, z))
@@ -0,0 +1,56 @@
#-----------------------------------------------------------------------------
# Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
#
# Released under the BSD license. See the LICENSE file for details.
#-----------------------------------------------------------------------------
"""A basic implementation of RFC 1924 ;-)"""
from netaddr.core import AddrFormatError
from netaddr.ip import IPAddress
from netaddr.compat import _zip
#-----------------------------------------------------------------------------
def chr_range(low, high):
"""Returns all characters between low and high chars."""
return [chr(i) for i in range(ord(low), ord(high)+1)]
#: Base 85 integer index to character lookup table.
BASE_85 = chr_range('0', '9') + chr_range('A', 'Z') + chr_range('a', 'z') + \
['!', '#', '$', '%', '&', '(',')', '*', '+', '-',';', '<', '=', '>',
'?', '@', '^', '_','`', '{', '|', '}', '~']
#: Base 85 digit to integer lookup table.
BASE_85_DICT = dict(_zip(BASE_85, range(0, 86)))
#-----------------------------------------------------------------------------
def ipv6_to_base85(addr):
"""Convert a regular IPv6 address to base 85."""
ip = IPAddress(addr)
int_val = int(ip)
remainder = []
while int_val > 0:
remainder.append(int_val % 85)
int_val //= 85
return ''.join([BASE_85[w] for w in reversed(remainder)])
#-----------------------------------------------------------------------------
def base85_to_ipv6(addr):
"""
Convert a base 85 IPv6 address to its hexadecimal format.
"""
tokens = list(addr)
if len(tokens) != 20:
raise AddrFormatError('Invalid base 85 IPv6 addess: %r' % addr)
result = 0
for i, num in enumerate(reversed(tokens)):
num = BASE_85_DICT[num]
result += (num * 85 ** i)
ip = IPAddress(result, 6)
return str(ip)
@@ -0,0 +1,535 @@
#-----------------------------------------------------------------------------
# Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
#
# Released under the BSD license. See the LICENSE file for details.
#-----------------------------------------------------------------------------
"""Set based operations for IP addresses and subnets."""
import sys as _sys
import itertools as _itertools
from netaddr.strategy import ipv4 as _ipv4, ipv6 as _ipv6
from netaddr.ip.intset import IntSet as _IntSet
from netaddr.ip import IPNetwork, IPAddress, cidr_merge, cidr_exclude, \
iprange_to_cidrs
from netaddr.compat import _zip, _sys_maxint, _dict_keys, _int_type
#-----------------------------------------------------------------------------
def partition_ips(iterable):
"""
Takes a sequence of IP addresses and networks splitting them into two
separate sequences by IP version.
:param iterable: a sequence or iterator contain IP addresses and networks.
:return: a two element tuple (ipv4_list, ipv6_list).
"""
# Start off using set as we'll remove any duplicates at the start.
if not hasattr(iterable, '__iter__'):
raise ValueError('A sequence or iterator is expected!')
ipv4 = []
ipv6 = []
for ip in iterable:
if not hasattr(ip, 'version'):
raise TypeError('IPAddress or IPNetwork expected!')
if ip.version == 4:
ipv4.append(ip)
else:
ipv6.append(ip)
return ipv4, ipv6
#-----------------------------------------------------------------------------
class IPSet(object):
"""
Represents an unordered collection (set) of unique IP addresses and
subnets.
"""
__slots__ = ('_cidrs',)
def __init__(self, iterable=None, flags=0):
"""
Constructor.
:param iterable: (optional) an iterable containing IP addresses and
subnets.
:param flags: decides which rules are applied to the interpretation
of the addr value. See the netaddr.core namespace documentation
for supported constant values.
"""
self._cidrs = {}
if iterable is not None:
mergeable = []
for addr in iterable:
if isinstance(addr, _int_type):
addr = IPAddress(addr, flags=flags)
mergeable.append(addr)
for cidr in cidr_merge(mergeable):
self._cidrs[cidr] = True
def __getstate__(self):
""":return: Pickled state of an ``IPSet`` object."""
return tuple([cidr.__getstate__() for cidr in self._cidrs])
def __setstate__(self, state):
"""
:param state: data used to unpickle a pickled ``IPSet`` object.
"""
#TODO: this needs to be optimised.
self._cidrs = {}
for cidr_tuple in state:
value, prefixlen, version = cidr_tuple
if version == 4:
module = _ipv4
elif version == 6:
module = _ipv6
else:
raise ValueError('unpickling failed for object state %s' \
% str(state))
if 0 <= prefixlen <= module.width:
cidr = IPNetwork((value, prefixlen), version=module.version)
self._cidrs[cidr] = True
else:
raise ValueError('unpickling failed for object state %s' \
% str(state))
def compact(self):
"""
Compact internal list of `IPNetwork` objects using a CIDR merge.
"""
cidrs = cidr_merge(list(self._cidrs))
self._cidrs = dict(_zip(cidrs, [True] * len(cidrs)))
def __hash__(self):
"""
Raises ``TypeError`` if this method is called.
.. note:: IPSet objects are not hashable and cannot be used as \
dictionary keys or as members of other sets. \
"""
raise TypeError('IP sets are unhashable!')
def __contains__(self, ip):
"""
:param ip: An IP address or subnet.
:return: ``True`` if IP address or subnet is a member of this IP set.
"""
ip = IPNetwork(ip)
for cidr in self._cidrs:
if ip in cidr:
return True
return False
def __iter__(self):
"""
:return: an iterator over the IP addresses within this IP set.
"""
return _itertools.chain(*sorted(self._cidrs))
def iter_cidrs(self):
"""
:return: an iterator over individual IP subnets within this IP set.
"""
return sorted(self._cidrs)
def add(self, addr, flags=0):
"""
Adds an IP address or subnet to this IP set. Has no effect if it is
already present.
Note that where possible the IP address or subnet is merged with other
members of the set to form more concise CIDR blocks.
:param addr: An IP address or subnet.
:param flags: decides which rules are applied to the interpretation
of the addr value. See the netaddr.core namespace documentation
for supported constant values.
"""
if isinstance(addr, _int_type):
addr = IPAddress(addr, flags=flags)
else:
addr = IPNetwork(addr)
self._cidrs[addr] = True
self.compact()
def remove(self, addr, flags=0):
"""
Removes an IP address or subnet from this IP set. Does nothing if it
is not already a member.
Note that this method behaves more like discard() found in regular
Python sets because it doesn't raise KeyError exceptions if the
IP address or subnet is question does not exist. It doesn't make sense
to fully emulate that behaviour here as IP sets contain groups of
individual IP addresses as individual set members using IPNetwork
objects.
:param addr: An IP address or subnet.
:param flags: decides which rules are applied to the interpretation
of the addr value. See the netaddr.core namespace documentation
for supported constant values.
"""
if isinstance(addr, _int_type):
addr = IPAddress(addr, flags=flags)
else:
addr = IPNetwork(addr)
# This add() is required for address blocks provided that are larger
# than blocks found within the set but have overlaps. e.g. :-
#
# >>> IPSet(['192.0.2.0/24']).remove('192.0.2.0/23')
# IPSet([])
#
self.add(addr)
remainder = None
matching_cidr = None
# Search for a matching CIDR and exclude IP from it.
for cidr in self._cidrs:
if addr in cidr:
remainder = cidr_exclude(cidr, addr)
matching_cidr = cidr
break
# Replace matching CIDR with remaining CIDR elements.
if remainder is not None:
del self._cidrs[matching_cidr]
for cidr in remainder:
self._cidrs[cidr] = True
self.compact()
def pop(self):
"""
Removes and returns an arbitrary IP address or subnet from this IP
set.
:return: An IP address or subnet.
"""
return self._cidrs.popitem()[0]
def isdisjoint(self, other):
"""
:param other: an IP set.
:return: ``True`` if this IP set has no elements (IP addresses
or subnets) in common with other. Intersection *must* be an
empty set.
"""
result = self.intersection(other)
if result == IPSet():
return True
return False
def copy(self):
""":return: a shallow copy of this IP set."""
obj_copy = self.__class__()
obj_copy._cidrs.update(self._cidrs)
return obj_copy
def update(self, iterable, flags=0):
"""
Update the contents of this IP set with the union of itself and
other IP set.
:param iterable: an iterable containing IP addresses and subnets.
:param flags: decides which rules are applied to the interpretation
of the addr value. See the netaddr.core namespace documentation
for supported constant values.
"""
if not hasattr(iterable, '__iter__'):
raise TypeError('an iterable was expected!')
if hasattr(iterable, '_cidrs'):
# Another IP set.
for ip in cidr_merge(_dict_keys(self._cidrs)
+ _dict_keys(iterable._cidrs)):
self._cidrs[ip] = True
else:
# An iterable contain IP addresses or subnets.
mergeable = []
for addr in iterable:
if isinstance(addr, _int_type):
addr = IPAddress(addr, flags=flags)
mergeable.append(addr)
for cidr in cidr_merge(_dict_keys(self._cidrs) + mergeable):
self._cidrs[cidr] = True
self.compact()
def clear(self):
"""Remove all IP addresses and subnets from this IP set."""
self._cidrs = {}
def __eq__(self, other):
"""
:param other: an IP set
:return: ``True`` if this IP set is equivalent to the ``other`` IP set,
``False`` otherwise.
"""
try:
return self._cidrs == other._cidrs
except AttributeError:
return NotImplemented
def __ne__(self, other):
"""
:param other: an IP set
:return: ``False`` if this IP set is equivalent to the ``other`` IP set,
``True`` otherwise.
"""
try:
return self._cidrs != other._cidrs
except AttributeError:
return NotImplemented
def __lt__(self, other):
"""
:param other: an IP set
:return: ``True`` if this IP set is less than the ``other`` IP set,
``False`` otherwise.
"""
if not hasattr(other, '_cidrs'):
return NotImplemented
return len(self) < len(other) and self.issubset(other)
def issubset(self, other):
"""
:param other: an IP set.
:return: ``True`` if every IP address and subnet in this IP set
is found within ``other``.
"""
if not hasattr(other, '_cidrs'):
return NotImplemented
l_ipv4, l_ipv6 = partition_ips(self._cidrs)
r_ipv4, r_ipv6 = partition_ips(other._cidrs)
l_ipv4_iset = _IntSet(*[(c.first, c.last) for c in l_ipv4])
r_ipv4_iset = _IntSet(*[(c.first, c.last) for c in r_ipv4])
l_ipv6_iset = _IntSet(*[(c.first, c.last) for c in l_ipv6])
r_ipv6_iset = _IntSet(*[(c.first, c.last) for c in r_ipv6])
ipv4 = l_ipv4_iset.issubset(r_ipv4_iset)
ipv6 = l_ipv6_iset.issubset(r_ipv6_iset)
return ipv4 and ipv6
__le__ = issubset
def __gt__(self, other):
"""
:param other: an IP set.
:return: ``True`` if this IP set is greater than the ``other`` IP set,
``False`` otherwise.
"""
if not hasattr(other, '_cidrs'):
return NotImplemented
return len(self) > len(other) and self.issuperset(other)
def issuperset(self, other):
"""
:param other: an IP set.
:return: ``True`` if every IP address and subnet in other IP set
is found within this one.
"""
if not hasattr(other, '_cidrs'):
return NotImplemented
l_ipv4, l_ipv6 = partition_ips(self._cidrs)
r_ipv4, r_ipv6 = partition_ips(other._cidrs)
l_ipv4_iset = _IntSet(*[(c.first, c.last) for c in l_ipv4])
r_ipv4_iset = _IntSet(*[(c.first, c.last) for c in r_ipv4])
l_ipv6_iset = _IntSet(*[(c.first, c.last) for c in l_ipv6])
r_ipv6_iset = _IntSet(*[(c.first, c.last) for c in r_ipv6])
ipv4 = l_ipv4_iset.issuperset(r_ipv4_iset)
ipv6 = l_ipv6_iset.issuperset(r_ipv6_iset)
return ipv4 and ipv6
__ge__ = issuperset
def union(self, other):
"""
:param other: an IP set.
:return: the union of this IP set and another as a new IP set
(combines IP addresses and subnets from both sets).
"""
ip_set = self.copy()
ip_set.update(other)
ip_set.compact()
return ip_set
__or__ = union
def intersection(self, other):
"""
:param other: an IP set.
:return: the intersection of this IP set and another as a new IP set.
(IP addresses and subnets common to both sets).
"""
cidr_list = []
# Separate IPv4 from IPv6.
l_ipv4, l_ipv6 = partition_ips(self._cidrs)
r_ipv4, r_ipv6 = partition_ips(other._cidrs)
# Process IPv4.
l_ipv4_iset = _IntSet(*[(c.first, c.last) for c in l_ipv4])
r_ipv4_iset = _IntSet(*[(c.first, c.last) for c in r_ipv4])
ipv4_result = l_ipv4_iset & r_ipv4_iset
for start, end in list(ipv4_result._ranges):
cidrs = iprange_to_cidrs(IPAddress(start, 4), IPAddress(end-1, 4))
cidr_list.extend(cidrs)
# Process IPv6.
l_ipv6_iset = _IntSet(*[(c.first, c.last) for c in l_ipv6])
r_ipv6_iset = _IntSet(*[(c.first, c.last) for c in r_ipv6])
ipv6_result = l_ipv6_iset & r_ipv6_iset
for start, end in list(ipv6_result._ranges):
cidrs = iprange_to_cidrs(IPAddress(start, 6), IPAddress(end-1, 6))
cidr_list.extend(cidrs)
return IPSet(cidr_list)
__and__ = intersection
def symmetric_difference(self, other):
"""
:param other: an IP set.
:return: the symmetric difference of this IP set and another as a new
IP set (all IP addresses and subnets that are in exactly one
of the sets).
"""
cidr_list = []
# Separate IPv4 from IPv6.
l_ipv4, l_ipv6 = partition_ips(self._cidrs)
r_ipv4, r_ipv6 = partition_ips(other._cidrs)
# Process IPv4.
l_ipv4_iset = _IntSet(*[(c.first, c.last) for c in l_ipv4])
r_ipv4_iset = _IntSet(*[(c.first, c.last) for c in r_ipv4])
ipv4_result = l_ipv4_iset ^ r_ipv4_iset
for start, end in list(ipv4_result._ranges):
cidrs = iprange_to_cidrs(IPAddress(start, 4), IPAddress(end-1, 4))
cidr_list.extend(cidrs)
# Process IPv6.
l_ipv6_iset = _IntSet(*[(c.first, c.last) for c in l_ipv6])
r_ipv6_iset = _IntSet(*[(c.first, c.last) for c in r_ipv6])
ipv6_result = l_ipv6_iset ^ r_ipv6_iset
for start, end in list(ipv6_result._ranges):
cidrs = iprange_to_cidrs(IPAddress(start, 6), IPAddress(end-1, 6))
cidr_list.extend(cidrs)
return IPSet(cidr_list)
__xor__ = symmetric_difference
def difference(self, other):
"""
:param other: an IP set.
:return: the difference between this IP set and another as a new IP
set (all IP addresses and subnets that are in this IP set but
not found in the other.)
"""
cidr_list = []
# Separate IPv4 from IPv6.
l_ipv4, l_ipv6 = partition_ips(self._cidrs)
r_ipv4, r_ipv6 = partition_ips(other._cidrs)
# Process IPv4.
l_ipv4_iset = _IntSet(*[(c.first, c.last) for c in l_ipv4])
r_ipv4_iset = _IntSet(*[(c.first, c.last) for c in r_ipv4])
ipv4_result = l_ipv4_iset - r_ipv4_iset
for start, end in list(ipv4_result._ranges):
cidrs = iprange_to_cidrs(IPAddress(start, 4), IPAddress(end-1, 4))
cidr_list.extend(cidrs)
# Process IPv6.
l_ipv6_iset = _IntSet(*[(c.first, c.last) for c in l_ipv6])
r_ipv6_iset = _IntSet(*[(c.first, c.last) for c in r_ipv6])
ipv6_result = l_ipv6_iset - r_ipv6_iset
for start, end in list(ipv6_result._ranges):
cidrs = iprange_to_cidrs(IPAddress(start, 6), IPAddress(end-1, 6))
cidr_list.extend(cidrs)
return IPSet(cidr_list)
__sub__ = difference
def __len__(self):
"""
:return: the cardinality of this IP set (i.e. sum of individual IP \
addresses). Raises ``IndexError`` if size > maxint (a Python \
limitation). Use the .size property for subnets of any size.
"""
size = self.size
if size > _sys.maxint:
raise IndexError("range contains greater than %d (maxint) " \
"IP addresses! Use the .size property instead." % _sys_maxint)
return size
@property
def size(self):
"""
The cardinality of this IP set (based on the number of individual IP
addresses including those implicitly defined in subnets).
"""
return sum([cidr.size for cidr in self._cidrs])
def __repr__(self):
""":return: Python statement to create an equivalent object"""
return 'IPSet(%r)' % [str(c) for c in sorted(self._cidrs)]
__str__ = __repr__