From 6b273f7f4056f8276f61a97c789d6bb4425e653c Mon Sep 17 00:00:00 2001 From: Bo Bayles Date: Tue, 23 Jan 2018 19:11:44 -0600 Subject: [PATCH] bpo-32502: Discard 64-bit (and other invalid) hardware addresses (#5254) --- Lib/test/test_uuid.py | 26 +++++++++++++++++++ Lib/uuid.py | 16 +++++++----- .../2018-01-20-17-15-34.bpo-32502.OXJfn7.rst | 2 ++ 3 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2018-01-20-17-15-34.bpo-32502.OXJfn7.rst diff --git a/Lib/test/test_uuid.py b/Lib/test/test_uuid.py index f21bd6dfa15..7af1d7aec79 100644 --- a/Lib/test/test_uuid.py +++ b/Lib/test/test_uuid.py @@ -311,6 +311,32 @@ class BaseTestUUID: node2 = self.uuid.getnode() self.assertEqual(node1, node2, '%012x != %012x' % (node1, node2)) + # bpo-32502: UUID1 requires a 48-bit identifier, but hardware identifiers + # need not necessarily be 48 bits (e.g., EUI-64). + def test_uuid1_eui64(self): + # Confirm that uuid.getnode ignores hardware addresses larger than 48 + # bits. Mock out each platform's *_getnode helper functions to return + # something just larger than 48 bits to test. This will cause + # uuid.getnode to fall back on uuid._random_getnode, which will + # generate a valid value. + too_large_getter = lambda: 1 << 48 + with unittest.mock.patch.multiple( + self.uuid, + _node=None, # Ignore any cached node value. + _NODE_GETTERS_WIN32=[too_large_getter], + _NODE_GETTERS_UNIX=[too_large_getter], + ): + node = self.uuid.getnode() + self.assertTrue(0 < node < (1 << 48), '%012x' % node) + + # Confirm that uuid1 can use the generated node, i.e., the that + # uuid.getnode fell back on uuid._random_getnode() rather than using + # the value from too_large_getter above. + try: + self.uuid.uuid1(node=node) + except ValueError as e: + self.fail('uuid1 was given an invalid node ID') + def test_uuid1(self): equal = self.assertEqual diff --git a/Lib/uuid.py b/Lib/uuid.py index b7433cb7192..ef7b3b59241 100644 --- a/Lib/uuid.py +++ b/Lib/uuid.py @@ -656,7 +656,12 @@ def _random_getnode(): _node = None -def getnode(): +_NODE_GETTERS_WIN32 = [_windll_getnode, _netbios_getnode, _ipconfig_getnode] + +_NODE_GETTERS_UNIX = [_unix_getnode, _ifconfig_getnode, _ip_getnode, + _arp_getnode, _lanscan_getnode, _netstat_getnode] + +def getnode(*, getters=None): """Get the hardware address as a 48-bit positive integer. The first time this runs, it may launch a separate program, which could @@ -669,19 +674,18 @@ def getnode(): return _node if sys.platform == 'win32': - getters = [_windll_getnode, _netbios_getnode, _ipconfig_getnode] + getters = _NODE_GETTERS_WIN32 else: - getters = [_unix_getnode, _ifconfig_getnode, _ip_getnode, - _arp_getnode, _lanscan_getnode, _netstat_getnode] + getters = _NODE_GETTERS_UNIX for getter in getters + [_random_getnode]: try: _node = getter() except: continue - if _node is not None: + if (_node is not None) and (0 <= _node < (1 << 48)): return _node - assert False, '_random_getnode() returned None' + assert False, '_random_getnode() returned invalid value: {}'.format(_node) _last_timestamp = None diff --git a/Misc/NEWS.d/next/Library/2018-01-20-17-15-34.bpo-32502.OXJfn7.rst b/Misc/NEWS.d/next/Library/2018-01-20-17-15-34.bpo-32502.OXJfn7.rst new file mode 100644 index 00000000000..8338632aa2c --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-01-20-17-15-34.bpo-32502.OXJfn7.rst @@ -0,0 +1,2 @@ +uuid.uuid1 no longer raises an exception if a 64-bit hardware address is +encountered.