Add support for IPv6 encapsulation of IPv4 IP addresses (un33k#51)

* add deprecation warning, up version Django to latest, update travis.ci

* style fix

* drop 3.4 support for 2.1.3

* add ip clean up utils

* add unit test for IPv6 encapsulation of IPv4

* clean up and rename formatter

* fix sponsors links

ipware/tests/tests_ipv6.py

@@ -171,3 +171,23 @@ def test_meta_proxy_trusted_ips_proxy_count_more_error_ignore_fallback(self):
         }
         result = get_client_ip(request, proxy_count=1, proxy_trusted_ips=['74dc::02bb'])
         self.assertEqual(result, (None, False))
+
+
+class IPv6EncapsulationOfIPv4TestCase(TestCase):
+    """IPv6 Encapsulation of IPv4 - IP address Test"""
+
+    def test_ipv6_encapsulation_of_ipv4_private(self):
+        request = HttpRequest()
+        request.META = {
+            'HTTP_X_FORWARDED_FOR': '::ffff:127.0.0.1',
+        }
+        result = get_client_ip(request)
+        self.assertEqual(result, ('127.0.0.1', False))
+
+    def test_ipv6_encapsulation_of_ipv4_public(self):
+        request = HttpRequest()
+        request.META = {
+            'HTTP_X_FORWARDED_FOR': '::ffff:177.139.233.139',
+        }
+        result = get_client_ip(request)
+        self.assertEqual(result, ('177.139.233.139', True))

ipware/utils.py

@@ -3,6 +3,16 @@
 from . import defaults as defs
 
 
+def cleanup_ip(ip):
+    """
+    Given ip address string, it cleans it up
+    """
+    ip = ip.strip().lower()
+    if (ip.startswith('::ffff:')):
+        return ip.replace('::ffff:', '')
+    return ip
+
+
 def is_valid_ipv4(ip_str):
     """
     Check the validity of an IPv4 address
@@ -94,8 +104,9 @@ def get_ip_info(ip_str):
     """
     ip = None
     is_routable_ip = False
-    if is_valid_ip(ip_str):
-        ip = ip_str
+    clean_ip = cleanup_ip(ip_str)
+    if is_valid_ip(clean_ip):
+        ip = clean_ip
         is_routable_ip = is_public_ip(ip)
     return ip, is_routable_ip
 

requirement-dev.txt

@@ -0,0 +1,2 @@
+Django>=2.1.3
+pycodestyle==2.5.0