Add support for IPv6 in IpRange and IpRangeList.

Author: bd808

iptools/__init__.py

@@ -30,6 +30,7 @@
     'IpRangeList',
 )
 
+
 # sniff for python2.x / python3k compatibility "fixes'
 try:
     basestring = basestring
@@ -49,10 +50,22 @@ def next(iterable):
 except ImportError:
     # python <2.6 doesn't have abc classes to extend
     Sequence = object
-
 # end compatibility "fixes'
 
+
 from . import ipv4
+from . import ipv6
+
+
+def _address2long(address):
+    """
+    Convert an address string to a long.
+    """
+    parsed = ipv4.ip2long(address)
+    if parsed is None:
+        parsed = ipv6.ip2long(address)
+    return parsed
+#end _addess2long
 
 
 class IpRange (Sequence):
@@ -71,6 +84,10 @@ class IpRange (Sequence):
     False
     >>> 2130706433 in r
     True
+    >>> '::ffff:192.0.2.128' in r
+    False
+    >>> '::ffff:c000:0280' in r
+    False
     >>> r = IpRange('127/24')
     >>> print(r)
     ('127.0.0.0', '127.0.0.255')
@@ -86,6 +103,21 @@ class IpRange (Sequence):
     >>> r = IpRange('127/255.255.255.0')
     >>> print(r)
     ('127.0.0.0', '127.0.0.255')
+    >>> r = IpRange('::ffff:0000:0000', '::ffff:ffff:ffff')
+    >>> '::ffff:192.0.2.128' in r
+    True
+    >>> '::ffff:c000:0280' in r
+    True
+    >>> 281473902969472 in r
+    True
+    >>> '192.168.2.128' in r
+    False
+    >>> 2130706433 in r
+    False
+    >>> r = IpRange('::ffff:ffff:0000/120')
+    >>> for ip in r: 
+    ...     print(ip) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
+    ::ffff:ffff:0 ... ::ffff:ffff:6d ... ::ffff:ffff:ff
 
 
     :param start: Ip address in dotted quad format, CIDR notation, subnet
@@ -108,6 +140,10 @@ def __init__(self, start, end=None):
                 # CIDR notation range
                 start, end = ipv4.cidr2block(start)
 
+            elif ipv6.validate_cidr(start):
+                # CIDR notation range
+                start, end = ipv6.cidr2block(start)
+
             elif ipv4.validate_subnet(start):
                 # Netmask notation range
                 start, end = ipv4.subnet2block(start)
@@ -116,11 +152,15 @@ def __init__(self, start, end=None):
                 # degenerate range
                 end = start
 
-        start = ipv4.ip2long(start)
-        end = ipv4.ip2long(end)
+        start = _address2long(start)
+        end = _address2long(end)
         self.startIp = min(start, end)
         self.endIp = max(start, end)
         self._len = self.endIp - self.startIp + 1
+
+        self._ipver = ipv4
+        if self.endIp > ipv4.MAX_IP:
+            self._ipver = ipv6
     #end __init__
 
     def __repr__(self):
@@ -133,7 +173,8 @@ def __repr__(self):
         "IpRange('127.0.0.0', '127.0.0.255')"
         """
         return "IpRange(%r, %r)" % (
-            ipv4.long2ip(self.startIp), ipv4.long2ip(self.endIp))
+            self._ipver.long2ip(self.startIp),
+            self._ipver.long2ip(self.endIp))
     #end __repr__
 
     def __str__(self):
@@ -146,7 +187,8 @@ def __str__(self):
         "('127.0.0.0', '127.0.0.255')"
         """
         return (
-            ipv4.long2ip(self.startIp), ipv4.long2ip(self.endIp)).__repr__()
+            self._ipver.long2ip(self.startIp),
+            self._ipver.long2ip(self.endIp)).__repr__()
     #end __str__
 
     def __eq__(self, other):
@@ -195,10 +237,10 @@ def __hash__(self):
 
     def _cast(self, item):
         if isinstance(item, basestring):
-            item = ipv4.ip2long(item)
-        if type(item) not in [type(1), type(ipv4.MAX_IP)]:
+            item = _address2long(item)
+        if type(item) not in [type(1), type(ipv4.MAX_IP), type(ipv6.MAX_IP)]:
             raise TypeError(
-                "expected dotted-quad ip address or 32-bit integer")
+                "expected ip address, 32-bit integer or 128-bit integer")
         return item
     #end _cast
 
@@ -226,7 +268,7 @@ def index(self, item):
         offset = item - self.startIp
         if offset >= 0 and offset < self._len:
             return offset
-        raise ValueError('%s is not in range' % ipv4.long2ip(item))
+        raise ValueError('%s is not in range' % self._ipver.long2ip(item))
     #end index
 
     def count(self, item):
@@ -249,7 +291,7 @@ def __contains__(self, item):
         >>> 'invalid' in r
         Traceback (most recent call last):
             ...
-        TypeError: expected dotted-quad ip address or 32-bit integer
+        TypeError: expected ip address, 32-bit integer or 128-bit integer
 
 
         :param item: Dotted-quad ip address.
@@ -307,15 +349,15 @@ def __getitem__(self, index):
             if stop > self._len:
                 raise IndexError('stop index out of range')
             return IpRange(
-                ipv4.long2ip(self.startIp + start),
-                ipv4.long2ip(self.startIp + stop - 1))
+                self._ipver.long2ip(self.startIp + start),
+                self._ipver.long2ip(self.startIp + stop - 1))
 
         else:
             if index < 0:
                 index = self._len + index
             if index < 0 or index >= self._len:
                 raise IndexError('index out of range')
-            return ipv4.long2ip(self.startIp + index)
+            return self._ipver.long2ip(self.startIp + index)
     #end __getitem__
 
     def __iter__(self):
@@ -335,7 +377,7 @@ def __iter__(self):
         """
         i = self.startIp
         while i <= self.endIp:
-            yield ipv4.long2ip(i)
+            yield self._ipver.long2ip(i)
             i += 1
     #end __iter__
 #end class IpRange
@@ -345,29 +387,12 @@ class IpRangeList (object):
     """
     List of IpRange objects.
 
-    Converts a list of dotted quad ip address and/or CIDR addresses into a
-    list of IpRange objects. This list can perform ``in`` and ``not in`` tests
-    and iterate all of the addresses in the range.
-
-    This can be used to convert django's conf.settings.INTERNAL_IPS list into
-    a smart object which allows CIDR notation.
-
-
-    >>> INTERNAL_IPS = IpRangeList(
-    ...     '127.0.0.1','10/8',('192.168.0.1','192.168.255.255'))
-    >>> '127.0.0.1' in INTERNAL_IPS
-    True
-    >>> '10.10.10.10' in INTERNAL_IPS
-    True
-    >>> '192.168.192.168' in INTERNAL_IPS
-    True
-    >>> '172.16.0.1' in INTERNAL_IPS
-    False
-
+    Converts a list of ip address and/or CIDR addresses into a list of IpRange
+    objects. This list can perform ``in`` and ``not in`` tests and iterate all
+    of the addresses in the range.
 
-    :param \*args: List of ip addresses in dotted quad format or CIDR
-        notation and/or ``(start, end)`` tuples of ip addresses in dotted quad
-        format.
+    :param \*args: List of ip addresses or CIDR notation and/or
+            ``(start, end)`` tuples of ip addresses.
     :type \*args: list of str and/or tuple
     """
     def __init__(self, *args):
@@ -420,7 +445,7 @@ def __contains__(self, item):
         >>> 'invalid' in r
         Traceback (most recent call last):
             ...
-        TypeError: expected dotted-quad ip address or 32-bit integer
+        TypeError: expected ip address, 32-bit integer or 128-bit integer
 
 
         :param item: Dotted-quad ip address.

iptools/ipv4.py

@@ -24,45 +24,47 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-# __all__ = (
-#     'cidr2block',
-#     'hex2ip',
-#     'ip2hex',
-#     'ip2long',
-#     'ip2network',
-#     'long2ip',
-#     'netmask2prefix',
-#     'subnet2block',
-#     'validate_cidr',
-#     'validate_ip',
-#     'validate_netmask',
-#     'validate_subnet',
-#     'BENCHMARK_TESTS',
-#     'BROADCAST',
-#     'CURRENT_NETWORK',
-#     'DUAL_STACK_LITE',
-#     'IETF_PROTOCOL_RESERVED',
-#     'IPV6_TO_IPV4_RELAY',
-#     'LINK_LOCAL',
-#     'LOCALHOST',
-#     'LOOPBACK',
-#     'MAX_IP',
-#     'MIN_IP',
-#     'MULTICAST',
-#     'MULTICAST_INTERNETWORK',
-#     'MULTICAST_LOCAL',
-#     'PRIVATE_NETWORK_10',
-#     'PRIVATE_NETWORK_172_16',
-#     'PRIVATE_NETWORK_192_168',
-#     'RESERVED',
-#     'SHARED_ADDRESS_SPACE',
-#     'TEST_NET_1',
-#     'TEST_NET_2',
-#     'TEST_NET_3',
-# )
+__all__ = (
+    'cidr2block',
+    'hex2ip',
+    'ip2hex',
+    'ip2long',
+    'ip2network',
+    'long2ip',
+    'netmask2prefix',
+    'subnet2block',
+    'validate_cidr',
+    'validate_ip',
+    'validate_netmask',
+    'validate_subnet',
+    'BENCHMARK_TESTS',
+    'BROADCAST',
+    'CURRENT_NETWORK',
+    'DUAL_STACK_LITE',
+    'IETF_PROTOCOL_RESERVED',
+    'IPV6_TO_IPV4_RELAY',
+    'LINK_LOCAL',
+    'LOCALHOST',
+    'LOOPBACK',
+    'MAX_IP',
+    'MIN_IP',
+    'MULTICAST',
+    'MULTICAST_INTERNETWORK',
+    'MULTICAST_LOCAL',
+    'PRIVATE_NETWORK_10',
+    'PRIVATE_NETWORK_172_16',
+    'PRIVATE_NETWORK_192_168',
+    'RESERVED',
+    'SHARED_ADDRESS_SPACE',
+    'TEST_NET_1',
+    'TEST_NET_2',
+    'TEST_NET_3',
+)
+
 
 import re
 
+
 # sniff for python2.x / python3k compatibility "fixes'
 try:
     basestring = basestring
@@ -93,9 +95,9 @@ def bin(x):
             out.reverse()
             return '0b' + ''.join(out)
     #end bin
-
 # end compatibility "fixes'
 
+
 #: Regex for validating an IPv4 address
 _DOTTED_QUAD_RE = re.compile(r'^(\d{1,3}\.){0,3}\d{1,3}$')
 
@@ -227,9 +229,9 @@ def validate_ip(s):
 def validate_cidr(s):
     """Validate a CIDR notation ip address.
 
-    The string is considered a valid CIDR address if it consists of one to
-    four octets (0-255) seperated by periods (.) followed by a forward slash
-    (/) and a bit mask length (1-32).
+    The string is considered a valid CIDR address if it consists of a valid
+    IPv4 address in dotted-quad format followed by a forward slash (/) and
+    a bit mask length (1-32).
 
 
     >>> validate_cidr('127.0.0.1/32')
@@ -242,6 +244,8 @@ def validate_cidr(s):
     False
     >>> validate_cidr(LOOPBACK)
     True
+    >>> validate_cidr('127.0.0.1/33')
+    False
     >>> validate_cidr(None) #doctest: +IGNORE_EXCEPTION_DETAIL
     Traceback (most recent call last):
         ...
@@ -439,7 +443,7 @@ def long2ip(l):
     :returns: Dotted-quad ip address (eg. '127.0.0.1').
     :raises: TypeError
     """
-    if MAX_IP < l or l < 0:
+    if MAX_IP < l or l < MIN_IP:
         raise TypeError(
             "expected int between %d and %d inclusive" % (MIN_IP, MAX_IP))
     return '%d.%d.%d.%d' % (