|
|
@@ -0,0 +1,126 @@
|
|
|
+# Port of https://github.com/samuelmeuli/anonymize-ip to Python 2
|
|
|
+"""
|
|
|
+MIT License
|
|
|
+
|
|
|
+Copyright (c) 2018 Samuel Meuli
|
|
|
+
|
|
|
+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.
|
|
|
+"""
|
|
|
+from __future__ import absolute_import, unicode_literals
|
|
|
+
|
|
|
+import six
|
|
|
+
|
|
|
+from ipaddress import ip_address
|
|
|
+
|
|
|
+
|
|
|
+def anonymize_ip(
|
|
|
+ address, ipv4_mask="255.255.255.0", ipv6_mask="ffff:ffff:ffff:0000:0000:0000:0000:0000"
|
|
|
+):
|
|
|
+ """
|
|
|
+ Anonymize the provided IPv4 or IPv6 address by setting parts of the
|
|
|
+ address to 0
|
|
|
+ :param str|int address: IP address to be anonymized
|
|
|
+ :param str ipv4_mask: Mask that defines which parts of an IPv4 address are
|
|
|
+ set to 0 (default: "255.255.255.0")
|
|
|
+ :param str ipv6_mask: Mask that defines which parts of an IPv6 address are
|
|
|
+ set to 0 (default: "ffff:ffff:ffff:0000:0000:0000:0000:0000")
|
|
|
+ :return: Anonymized IP address
|
|
|
+ :rtype: str
|
|
|
+ """
|
|
|
+
|
|
|
+ # IP address to be anonymized
|
|
|
+ address_packed = ip_address(six.text_type(address)).packed
|
|
|
+ address_len = len(address_packed)
|
|
|
+
|
|
|
+ if address_len == 4:
|
|
|
+ # IPv4
|
|
|
+ ipv4_mask_packed = ip_address(ipv4_mask).packed
|
|
|
+ __validate_ipv4_mask(ipv4_mask_packed)
|
|
|
+ return __apply_mask(address_packed, ipv4_mask_packed, 4)
|
|
|
+ elif address_len == 16:
|
|
|
+ # IPv6
|
|
|
+ ipv6_mask_packed = ip_address(ipv6_mask).packed
|
|
|
+ __validate_ipv6_mask(ipv6_mask_packed)
|
|
|
+ return __apply_mask(address_packed, ipv6_mask_packed, 16)
|
|
|
+ else:
|
|
|
+ # Invalid address
|
|
|
+ raise ValueError("Address does not consist of 4 (IPv4) or 16 (IPv6) " "octets")
|
|
|
+
|
|
|
+
|
|
|
+def __apply_mask(address_packed, mask_packed, nr_bytes):
|
|
|
+ """
|
|
|
+ Perform a bitwise AND operation on all corresponding bytes between the
|
|
|
+ mask and the provided address. Mask parts set to 0 will become 0 in the
|
|
|
+ anonymized IP address as well
|
|
|
+ :param bytes address_packed: Binary representation of the IP address to
|
|
|
+ be anonymized
|
|
|
+ :param bytes mask_packed: Binary representation of the corresponding IP
|
|
|
+ address mask
|
|
|
+ :param int nr_bytes: Number of bytes in the address (4 for IPv4, 16 for
|
|
|
+ IPv6)
|
|
|
+ :return: Anonymized IP address
|
|
|
+ :rtype: str
|
|
|
+ """
|
|
|
+
|
|
|
+ anon_packed = bytearray()
|
|
|
+ for i in range(0, nr_bytes):
|
|
|
+ anon_packed.append(ord(mask_packed[i]) & ord(address_packed[i]))
|
|
|
+ return six.text_type(ip_address(six.binary_type(anon_packed)))
|
|
|
+
|
|
|
+
|
|
|
+def __validate_ipv4_mask(mask_packed):
|
|
|
+ # Test that mask only contains valid numbers
|
|
|
+ for byte in mask_packed:
|
|
|
+ if byte != b"\x00" and byte != b"\xff":
|
|
|
+ raise ValueError("ipv4_mask must only contain numbers 0 or 255")
|
|
|
+
|
|
|
+ # Test that IP address does not get anonymized completely
|
|
|
+ if mask_packed == b"\x00\x00\x00\x00":
|
|
|
+ raise ValueError(
|
|
|
+ 'ipv4_mask cannot be set to "0.0.0.0" (all ' "anonymized addresses will be 0.0.0.0)"
|
|
|
+ )
|
|
|
+
|
|
|
+ # Test that IP address is changed by anonymization
|
|
|
+ if mask_packed == b"\xff\xff\xff\xff":
|
|
|
+ raise ValueError(
|
|
|
+ 'ipv4_mask cannot be set to "255.255.255.255" ' "(addresses will not be anonymized)"
|
|
|
+ )
|
|
|
+
|
|
|
+
|
|
|
+def __validate_ipv6_mask(mask_packed):
|
|
|
+ # Test that mask only contains valid numbers
|
|
|
+ for byte in mask_packed:
|
|
|
+ if byte != b"\x00" and byte != b"\xff":
|
|
|
+ raise ValueError("ipv6_mask must only contain numbers 0 or ffff")
|
|
|
+
|
|
|
+ # Test that IP address does not get anonymized completely
|
|
|
+ if mask_packed == b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00":
|
|
|
+ raise ValueError(
|
|
|
+ "ipv6_mask cannot be set to "
|
|
|
+ '"0000:0000:0000:0000:0000:0000:0000:0000" (all '
|
|
|
+ "anonymized addresses will be 0.0.0.0)"
|
|
|
+ )
|
|
|
+
|
|
|
+ # Test that IP address is changed by anonymization
|
|
|
+ if mask_packed == b"\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff":
|
|
|
+ raise ValueError(
|
|
|
+ "ipv6_mask cannot be set to "
|
|
|
+ '"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff" '
|
|
|
+ "(addresses will not be anonymized)"
|
|
|
+ )
|
Stephen Cefali