blob: 51538822151030b47ae44804c5a9a00bb54bd2e5 [file] [log] [blame]
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001r"""UUID objects (universally unique identifiers) according to RFC 4122.
2
3This module provides immutable UUID objects (class UUID) and the functions
4uuid1(), uuid3(), uuid4(), uuid5() for generating version 1, 3, 4, and 5
5UUIDs as specified in RFC 4122.
6
7If all you want is a unique ID, you should probably call uuid1() or uuid4().
8Note that uuid1() may compromise privacy since it creates a UUID containing
9the computer's network address. uuid4() creates a random UUID.
10
11Typical usage:
12
13 >>> import uuid
14
15 # make a UUID based on the host ID and current time
Georg Brandl1d523e12009-12-19 18:23:28 +000016 >>> uuid.uuid1() # doctest: +SKIP
Thomas Wouters0e3f5912006-08-11 14:57:12 +000017 UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')
18
19 # make a UUID using an MD5 hash of a namespace UUID and a name
20 >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
21 UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
22
23 # make a random UUID
Georg Brandl1d523e12009-12-19 18:23:28 +000024 >>> uuid.uuid4() # doctest: +SKIP
Thomas Wouters0e3f5912006-08-11 14:57:12 +000025 UUID('16fd2706-8baf-433b-82eb-8c7fada847da')
26
27 # make a UUID using a SHA-1 hash of a namespace UUID and a name
28 >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
29 UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
30
31 # make a UUID from a string of hex digits (braces and hyphens ignored)
32 >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')
33
34 # convert a UUID to a string of hex digits in standard form
35 >>> str(x)
36 '00010203-0405-0607-0809-0a0b0c0d0e0f'
37
38 # get the raw 16 bytes of the UUID
39 >>> x.bytes
Guido van Rossum65b6a802007-07-09 14:03:08 +000040 b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'
Thomas Wouters0e3f5912006-08-11 14:57:12 +000041
42 # make a UUID from a 16-byte string
43 >>> uuid.UUID(bytes=x.bytes)
44 UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
45"""
46
Benjamin Peterson788cb522015-10-29 20:38:04 -070047import os
Antoine Pitroua106aec2017-09-28 23:03:06 +020048import sys
Benjamin Peterson788cb522015-10-29 20:38:04 -070049
Barry Warsaw8c130d72017-02-18 15:45:49 -050050from enum import Enum
51
52
Thomas Wouters0e3f5912006-08-11 14:57:12 +000053__author__ = 'Ka-Ping Yee <ping@zesty.ca>'
Thomas Wouters0e3f5912006-08-11 14:57:12 +000054
55RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT, RESERVED_FUTURE = [
56 'reserved for NCS compatibility', 'specified in RFC 4122',
57 'reserved for Microsoft compatibility', 'reserved for future definition']
58
Guido van Rossum65b6a802007-07-09 14:03:08 +000059int_ = int # The built-in int type
60bytes_ = bytes # The built-in bytes type
Guido van Rossume2a383d2007-01-15 16:59:06 +000061
Barry Warsaw8c130d72017-02-18 15:45:49 -050062
63class SafeUUID(Enum):
64 safe = 0
65 unsafe = -1
66 unknown = None
67
68
69class UUID:
Thomas Wouters0e3f5912006-08-11 14:57:12 +000070 """Instances of the UUID class represent UUIDs as specified in RFC 4122.
71 UUID objects are immutable, hashable, and usable as dictionary keys.
72 Converting a UUID to a string with str() yields something in the form
73 '12345678-1234-1234-1234-123456789abc'. The UUID constructor accepts
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000074 five possible forms: a similar string of hexadecimal digits, or a tuple
75 of six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and
76 48-bit values respectively) as an argument named 'fields', or a string
77 of 16 bytes (with all the integer fields in big-endian order) as an
78 argument named 'bytes', or a string of 16 bytes (with the first three
79 fields in little-endian order) as an argument named 'bytes_le', or a
80 single 128-bit integer as an argument named 'int'.
Thomas Wouters0e3f5912006-08-11 14:57:12 +000081
82 UUIDs have these read-only attributes:
83
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000084 bytes the UUID as a 16-byte string (containing the six
85 integer fields in big-endian byte order)
86
87 bytes_le the UUID as a 16-byte string (with time_low, time_mid,
88 and time_hi_version in little-endian byte order)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000089
90 fields a tuple of the six integer fields of the UUID,
91 which are also available as six individual attributes
92 and two derived attributes:
93
94 time_low the first 32 bits of the UUID
95 time_mid the next 16 bits of the UUID
96 time_hi_version the next 16 bits of the UUID
97 clock_seq_hi_variant the next 8 bits of the UUID
98 clock_seq_low the next 8 bits of the UUID
99 node the last 48 bits of the UUID
100
101 time the 60-bit timestamp
102 clock_seq the 14-bit sequence number
103
104 hex the UUID as a 32-character hexadecimal string
105
106 int the UUID as a 128-bit integer
107
108 urn the UUID as a URN as specified in RFC 4122
109
110 variant the UUID variant (one of the constants RESERVED_NCS,
111 RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)
112
113 version the UUID version number (1 through 5, meaningful only
114 when the variant is RFC_4122)
Barry Warsaw8c130d72017-02-18 15:45:49 -0500115
116 is_safe An enum indicating whether the UUID has been generated in
117 a way that is safe for multiprocessing applications, via
118 uuid_generate_time_safe(3).
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000119 """
120
Tal Einat3e2b29d2018-09-06 14:34:25 +0300121 __slots__ = ('int', 'is_safe')
122
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000123 def __init__(self, hex=None, bytes=None, bytes_le=None, fields=None,
Barry Warsaw8c130d72017-02-18 15:45:49 -0500124 int=None, version=None,
125 *, is_safe=SafeUUID.unknown):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000126 r"""Create a UUID from either a string of 32 hexadecimal digits,
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000127 a string of 16 bytes as the 'bytes' argument, a string of 16 bytes
128 in little-endian order as the 'bytes_le' argument, a tuple of six
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
130 8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
131 the 'fields' argument, or a single 128-bit integer as the 'int'
132 argument. When a string of hex digits is given, curly braces,
133 hyphens, and a URN prefix are all optional. For example, these
134 expressions all yield the same UUID:
135
136 UUID('{12345678-1234-5678-1234-567812345678}')
137 UUID('12345678123456781234567812345678')
138 UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
139 UUID(bytes='\x12\x34\x56\x78'*4)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000140 UUID(bytes_le='\x78\x56\x34\x12\x34\x12\x78\x56' +
141 '\x12\x34\x56\x78\x12\x34\x56\x78')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000142 UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
143 UUID(int=0x12345678123456781234567812345678)
144
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000145 Exactly one of 'hex', 'bytes', 'bytes_le', 'fields', or 'int' must
146 be given. The 'version' argument is optional; if given, the resulting
147 UUID will have its variant and version set according to RFC 4122,
148 overriding the given 'hex', 'bytes', 'bytes_le', 'fields', or 'int'.
Barry Warsaw8c130d72017-02-18 15:45:49 -0500149
150 is_safe is an enum exposed as an attribute on the instance. It
151 indicates whether the UUID has been generated in a way that is safe
152 for multiprocessing applications, via uuid_generate_time_safe(3).
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000153 """
154
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000155 if [hex, bytes, bytes_le, fields, int].count(None) != 4:
Berker Peksagd02eb8a2016-03-20 16:49:10 +0200156 raise TypeError('one of the hex, bytes, bytes_le, fields, '
157 'or int arguments must be given')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000158 if hex is not None:
159 hex = hex.replace('urn:', '').replace('uuid:', '')
160 hex = hex.strip('{}').replace('-', '')
161 if len(hex) != 32:
162 raise ValueError('badly formed hexadecimal UUID string')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000163 int = int_(hex, 16)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000164 if bytes_le is not None:
165 if len(bytes_le) != 16:
166 raise ValueError('bytes_le is not a 16-char string')
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300167 bytes = (bytes_le[4-1::-1] + bytes_le[6-1:4-1:-1] +
168 bytes_le[8-1:6-1:-1] + bytes_le[8:])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000169 if bytes is not None:
170 if len(bytes) != 16:
171 raise ValueError('bytes is not a 16-char string')
Guido van Rossum65b6a802007-07-09 14:03:08 +0000172 assert isinstance(bytes, bytes_), repr(bytes)
Philip Jenvey1221f6b2013-08-29 18:33:50 -0700173 int = int_.from_bytes(bytes, byteorder='big')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000174 if fields is not None:
175 if len(fields) != 6:
176 raise ValueError('fields is not a 6-tuple')
177 (time_low, time_mid, time_hi_version,
178 clock_seq_hi_variant, clock_seq_low, node) = fields
Guido van Rossume2a383d2007-01-15 16:59:06 +0000179 if not 0 <= time_low < 1<<32:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000180 raise ValueError('field 1 out of range (need a 32-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000181 if not 0 <= time_mid < 1<<16:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000182 raise ValueError('field 2 out of range (need a 16-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000183 if not 0 <= time_hi_version < 1<<16:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000184 raise ValueError('field 3 out of range (need a 16-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000185 if not 0 <= clock_seq_hi_variant < 1<<8:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000186 raise ValueError('field 4 out of range (need an 8-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000187 if not 0 <= clock_seq_low < 1<<8:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000188 raise ValueError('field 5 out of range (need an 8-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000189 if not 0 <= node < 1<<48:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000190 raise ValueError('field 6 out of range (need a 48-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000191 clock_seq = (clock_seq_hi_variant << 8) | clock_seq_low
192 int = ((time_low << 96) | (time_mid << 80) |
193 (time_hi_version << 64) | (clock_seq << 48) | node)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000194 if int is not None:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000195 if not 0 <= int < 1<<128:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196 raise ValueError('int is out of range (need a 128-bit value)')
197 if version is not None:
198 if not 1 <= version <= 5:
199 raise ValueError('illegal version number')
200 # Set the variant to RFC 4122.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000201 int &= ~(0xc000 << 48)
202 int |= 0x8000 << 48
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000203 # Set the version number.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000204 int &= ~(0xf000 << 64)
205 int |= version << 76
Tal Einat3e2b29d2018-09-06 14:34:25 +0300206 object.__setattr__(self, 'int', int)
207 object.__setattr__(self, 'is_safe', is_safe)
208
209 def __getstate__(self):
210 d = {attr: getattr(self, attr) for attr in self.__slots__}
211 # is_safe is a SafeUUID instance. Return just its value, so that
212 # it can be unpickled in older Python versions without SafeUUID.
213 d['is_safe'] = d['is_safe'].value
214 return d
215
216 def __setstate__(self, state):
217 # is_safe was added in 3.7
218 state.setdefault('is_safe', SafeUUID.unknown.value)
219
220 for attr in self.__slots__:
221 value = state[attr]
222
223 # for is_safe, restore the SafeUUID from the stored value
224 if attr == 'is_safe':
225 try:
226 value = SafeUUID(value)
227 except ValueError:
228 value = SafeUUID.unknown
229 object.__setattr__(self, attr, value)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000230
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000231 def __eq__(self, other):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000232 if isinstance(other, UUID):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000233 return self.int == other.int
234 return NotImplemented
235
Guido van Rossum65b6a802007-07-09 14:03:08 +0000236 # Q. What's the value of being able to sort UUIDs?
237 # A. Use them as keys in a B-Tree or similar mapping.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000238
239 def __lt__(self, other):
240 if isinstance(other, UUID):
241 return self.int < other.int
242 return NotImplemented
243
244 def __gt__(self, other):
245 if isinstance(other, UUID):
246 return self.int > other.int
247 return NotImplemented
248
249 def __le__(self, other):
250 if isinstance(other, UUID):
251 return self.int <= other.int
252 return NotImplemented
253
254 def __ge__(self, other):
255 if isinstance(other, UUID):
256 return self.int >= other.int
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000257 return NotImplemented
258
259 def __hash__(self):
260 return hash(self.int)
261
262 def __int__(self):
263 return self.int
264
265 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300266 return '%s(%r)' % (self.__class__.__name__, str(self))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000267
268 def __setattr__(self, name, value):
269 raise TypeError('UUID objects are immutable')
270
271 def __str__(self):
272 hex = '%032x' % self.int
273 return '%s-%s-%s-%s-%s' % (
274 hex[:8], hex[8:12], hex[12:16], hex[16:20], hex[20:])
275
Guido van Rossum65b6a802007-07-09 14:03:08 +0000276 @property
277 def bytes(self):
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300278 return self.int.to_bytes(16, 'big')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000279
Guido van Rossum65b6a802007-07-09 14:03:08 +0000280 @property
281 def bytes_le(self):
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000282 bytes = self.bytes
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300283 return (bytes[4-1::-1] + bytes[6-1:4-1:-1] + bytes[8-1:6-1:-1] +
Guido van Rossum65b6a802007-07-09 14:03:08 +0000284 bytes[8:])
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000285
Guido van Rossum65b6a802007-07-09 14:03:08 +0000286 @property
287 def fields(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000288 return (self.time_low, self.time_mid, self.time_hi_version,
289 self.clock_seq_hi_variant, self.clock_seq_low, self.node)
290
Guido van Rossum65b6a802007-07-09 14:03:08 +0000291 @property
292 def time_low(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000293 return self.int >> 96
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000294
Guido van Rossum65b6a802007-07-09 14:03:08 +0000295 @property
296 def time_mid(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000297 return (self.int >> 80) & 0xffff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000298
Guido van Rossum65b6a802007-07-09 14:03:08 +0000299 @property
300 def time_hi_version(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000301 return (self.int >> 64) & 0xffff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000302
Guido van Rossum65b6a802007-07-09 14:03:08 +0000303 @property
304 def clock_seq_hi_variant(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000305 return (self.int >> 56) & 0xff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000306
Guido van Rossum65b6a802007-07-09 14:03:08 +0000307 @property
308 def clock_seq_low(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000309 return (self.int >> 48) & 0xff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000310
Guido van Rossum65b6a802007-07-09 14:03:08 +0000311 @property
312 def time(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000313 return (((self.time_hi_version & 0x0fff) << 48) |
314 (self.time_mid << 32) | self.time_low)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000315
Guido van Rossum65b6a802007-07-09 14:03:08 +0000316 @property
317 def clock_seq(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000318 return (((self.clock_seq_hi_variant & 0x3f) << 8) |
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000319 self.clock_seq_low)
320
Guido van Rossum65b6a802007-07-09 14:03:08 +0000321 @property
322 def node(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000323 return self.int & 0xffffffffffff
324
Guido van Rossum65b6a802007-07-09 14:03:08 +0000325 @property
326 def hex(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000327 return '%032x' % self.int
328
Guido van Rossum65b6a802007-07-09 14:03:08 +0000329 @property
330 def urn(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000331 return 'urn:uuid:' + str(self)
332
Guido van Rossum65b6a802007-07-09 14:03:08 +0000333 @property
334 def variant(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000335 if not self.int & (0x8000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000336 return RESERVED_NCS
Guido van Rossume2a383d2007-01-15 16:59:06 +0000337 elif not self.int & (0x4000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000338 return RFC_4122
Guido van Rossume2a383d2007-01-15 16:59:06 +0000339 elif not self.int & (0x2000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000340 return RESERVED_MICROSOFT
341 else:
342 return RESERVED_FUTURE
343
Guido van Rossum65b6a802007-07-09 14:03:08 +0000344 @property
345 def version(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000346 # The version bits are only meaningful for RFC 4122 UUIDs.
347 if self.variant == RFC_4122:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000348 return int((self.int >> 76) & 0xf)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000349
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200350def _popen(command, *args):
Victor Stinnerb9d01992014-10-21 22:33:10 +0200351 import os, shutil, subprocess
R David Murray4be1e242013-12-17 21:13:16 -0500352 executable = shutil.which(command)
353 if executable is None:
354 path = os.pathsep.join(('/sbin', '/usr/sbin'))
355 executable = shutil.which(command, path=path)
356 if executable is None:
357 return None
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200358 # LC_ALL=C to ensure English output, stderr=DEVNULL to prevent output
359 # on stderr (Note: we don't have an example where the words we search
360 # for are actually localized, but in theory some system could do so.)
361 env = dict(os.environ)
362 env['LC_ALL'] = 'C'
363 proc = subprocess.Popen((executable,) + args,
364 stdout=subprocess.PIPE,
365 stderr=subprocess.DEVNULL,
366 env=env)
367 return proc
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000368
Barry Warsaw23df2d12017-11-28 17:26:04 -0500369# For MAC (a.k.a. IEEE 802, or EUI-48) addresses, the second least significant
370# bit of the first octet signifies whether the MAC address is universally (0)
371# or locally (1) administered. Network cards from hardware manufacturers will
372# always be universally administered to guarantee global uniqueness of the MAC
373# address, but any particular machine may have other interfaces which are
374# locally administered. An example of the latter is the bridge interface to
375# the Touch Bar on MacBook Pros.
376#
377# This bit works out to be the 42nd bit counting from 1 being the least
378# significant, or 1<<41. We'll prefer universally administered MAC addresses
379# over locally administered ones since the former are globally unique, but
380# we'll return the first of the latter found if that's all the machine has.
381#
382# See https://en.wikipedia.org/wiki/MAC_address#Universal_vs._local
383
384def _is_universal(mac):
385 return not (mac & (1 << 41))
386
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200387def _find_mac(command, args, hw_identifiers, get_index):
Barry Warsaw23df2d12017-11-28 17:26:04 -0500388 first_local_mac = None
R David Murray4be1e242013-12-17 21:13:16 -0500389 try:
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200390 proc = _popen(command, *args.split())
391 if not proc:
Barry Warsaw23df2d12017-11-28 17:26:04 -0500392 return None
Victor Stinnerb9d01992014-10-21 22:33:10 +0200393 with proc:
394 for line in proc.stdout:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200395 words = line.lower().rstrip().split()
R David Murray4be1e242013-12-17 21:13:16 -0500396 for i in range(len(words)):
397 if words[i] in hw_identifiers:
398 try:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200399 word = words[get_index(i)]
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200400 mac = int(word.replace(b':', b''), 16)
Barry Warsaw23df2d12017-11-28 17:26:04 -0500401 if _is_universal(mac):
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200402 return mac
Barry Warsaw23df2d12017-11-28 17:26:04 -0500403 first_local_mac = first_local_mac or mac
R David Murray4be1e242013-12-17 21:13:16 -0500404 except (ValueError, IndexError):
405 # Virtual interfaces, such as those provided by
406 # VPNs, do not have a colon-delimited MAC address
407 # as expected, but a 16-byte HWAddr separated by
408 # dashes. These should be ignored in favor of a
409 # real MAC address
410 pass
R David Murray0ce3e9d2013-12-17 21:14:41 -0500411 except OSError:
R David Murray4be1e242013-12-17 21:13:16 -0500412 pass
Barry Warsaw23df2d12017-11-28 17:26:04 -0500413 return first_local_mac or None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000414
415def _ifconfig_getnode():
416 """Get the hardware address on Unix by running ifconfig."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000417 # This works on Linux ('' or '-a'), Tru64 ('-av'), but not all Unixes.
Serhiy Storchakaee1a9a22017-11-04 09:37:32 +0200418 keywords = (b'hwaddr', b'ether', b'address:', b'lladdr')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000419 for args in ('', '-a', '-av'):
Serhiy Storchakaee1a9a22017-11-04 09:37:32 +0200420 mac = _find_mac('ifconfig', args, keywords, lambda i: i+1)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000421 if mac:
422 return mac
Barry Warsaw23df2d12017-11-28 17:26:04 -0500423 return None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000424
Serhiy Storchakaac4aa7b2014-11-30 20:39:04 +0200425def _ip_getnode():
426 """Get the hardware address on Unix by running ip."""
427 # This works on Linux with iproute2.
xdegaye961dbe02017-12-07 12:59:13 +0100428 mac = _find_mac('ip', 'link', [b'link/ether'], lambda i: i+1)
Serhiy Storchakaac4aa7b2014-11-30 20:39:04 +0200429 if mac:
430 return mac
Barry Warsaw23df2d12017-11-28 17:26:04 -0500431 return None
Serhiy Storchakaac4aa7b2014-11-30 20:39:04 +0200432
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200433def _arp_getnode():
434 """Get the hardware address on Unix by running arp."""
435 import os, socket
Serhiy Storchaka525d5ae2014-11-21 21:55:39 +0200436 try:
437 ip_addr = socket.gethostbyname(socket.gethostname())
438 except OSError:
439 return None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000440
441 # Try getting the MAC addr from arp based on our IP address (Solaris).
Serhiy Storchakaee1a9a22017-11-04 09:37:32 +0200442 mac = _find_mac('arp', '-an', [os.fsencode(ip_addr)], lambda i: -1)
443 if mac:
444 return mac
445
446 # This works on OpenBSD
447 mac = _find_mac('arp', '-an', [os.fsencode(ip_addr)], lambda i: i+1)
448 if mac:
449 return mac
450
451 # This works on Linux, FreeBSD and NetBSD
452 mac = _find_mac('arp', '-an', [os.fsencode('(%s)' % ip_addr)],
453 lambda i: i+2)
Barry Warsaw23df2d12017-11-28 17:26:04 -0500454 # Return None instead of 0.
Serhiy Storchakaee1a9a22017-11-04 09:37:32 +0200455 if mac:
456 return mac
Barry Warsaw23df2d12017-11-28 17:26:04 -0500457 return None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000458
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200459def _lanscan_getnode():
460 """Get the hardware address on Unix by running lanscan."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000461 # This might work on HP-UX.
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200462 return _find_mac('lanscan', '-ai', [b'lan0'], lambda i: 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000463
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200464def _netstat_getnode():
465 """Get the hardware address on Unix by running netstat."""
Benjamin Peterson06930632017-09-04 16:36:05 -0700466 # This might work on AIX, Tru64 UNIX.
Barry Warsaw23df2d12017-11-28 17:26:04 -0500467 first_local_mac = None
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200468 try:
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200469 proc = _popen('netstat', '-ia')
470 if not proc:
Barry Warsaw23df2d12017-11-28 17:26:04 -0500471 return None
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200472 with proc:
473 words = proc.stdout.readline().rstrip().split()
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200474 try:
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200475 i = words.index(b'Address')
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200476 except ValueError:
Barry Warsaw23df2d12017-11-28 17:26:04 -0500477 return None
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200478 for line in proc.stdout:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200479 try:
480 words = line.rstrip().split()
481 word = words[i]
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200482 if len(word) == 17 and word.count(b':') == 5:
483 mac = int(word.replace(b':', b''), 16)
Barry Warsaw23df2d12017-11-28 17:26:04 -0500484 if _is_universal(mac):
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200485 return mac
Barry Warsaw23df2d12017-11-28 17:26:04 -0500486 first_local_mac = first_local_mac or mac
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200487 except (ValueError, IndexError):
488 pass
489 except OSError:
490 pass
Barry Warsaw23df2d12017-11-28 17:26:04 -0500491 return first_local_mac or None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000492
493def _ipconfig_getnode():
494 """Get the hardware address on Windows by running ipconfig.exe."""
Segev Finerda6c3da2018-02-13 08:29:54 +0200495 import os, re, subprocess
Barry Warsaw23df2d12017-11-28 17:26:04 -0500496 first_local_mac = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000497 dirs = ['', r'c:\windows\system32', r'c:\winnt\system32']
498 try:
499 import ctypes
500 buffer = ctypes.create_string_buffer(300)
501 ctypes.windll.kernel32.GetSystemDirectoryA(buffer, 300)
502 dirs.insert(0, buffer.value.decode('mbcs'))
503 except:
504 pass
505 for dir in dirs:
506 try:
Segev Finerda6c3da2018-02-13 08:29:54 +0200507 proc = subprocess.Popen([os.path.join(dir, 'ipconfig'), '/all'],
508 stdout=subprocess.PIPE,
509 encoding="oem")
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200510 except OSError:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000511 continue
Segev Finerda6c3da2018-02-13 08:29:54 +0200512 with proc:
513 for line in proc.stdout:
Brian Curtin69cd87b2010-11-05 14:48:35 +0000514 value = line.split(':')[-1].strip().lower()
CtrlZvic66c3422018-05-20 08:03:25 -0700515 if re.fullmatch('(?:[0-9a-f][0-9a-f]-){5}[0-9a-f][0-9a-f]', value):
Barry Warsaw23df2d12017-11-28 17:26:04 -0500516 mac = int(value.replace('-', ''), 16)
517 if _is_universal(mac):
518 return mac
519 first_local_mac = first_local_mac or mac
520 return first_local_mac or None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000521
522def _netbios_getnode():
523 """Get the hardware address on Windows using NetBIOS calls.
524 See http://support.microsoft.com/kb/118623 for details."""
525 import win32wnet, netbios
Barry Warsaw23df2d12017-11-28 17:26:04 -0500526 first_local_mac = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000527 ncb = netbios.NCB()
528 ncb.Command = netbios.NCBENUM
529 ncb.Buffer = adapters = netbios.LANA_ENUM()
530 adapters._pack()
531 if win32wnet.Netbios(ncb) != 0:
Barry Warsaw23df2d12017-11-28 17:26:04 -0500532 return None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000533 adapters._unpack()
534 for i in range(adapters.length):
535 ncb.Reset()
536 ncb.Command = netbios.NCBRESET
537 ncb.Lana_num = ord(adapters.lana[i])
538 if win32wnet.Netbios(ncb) != 0:
539 continue
540 ncb.Reset()
541 ncb.Command = netbios.NCBASTAT
542 ncb.Lana_num = ord(adapters.lana[i])
543 ncb.Callname = '*'.ljust(16)
544 ncb.Buffer = status = netbios.ADAPTER_STATUS()
545 if win32wnet.Netbios(ncb) != 0:
546 continue
547 status._unpack()
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300548 bytes = status.adapter_address[:6]
549 if len(bytes) != 6:
550 continue
Barry Warsaw23df2d12017-11-28 17:26:04 -0500551 mac = int.from_bytes(bytes, 'big')
552 if _is_universal(mac):
553 return mac
554 first_local_mac = first_local_mac or mac
555 return first_local_mac or None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000556
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000557
Antoine Pitroua106aec2017-09-28 23:03:06 +0200558_generate_time_safe = _UuidCreate = None
559_has_uuid_generate_time_safe = None
560
561# Import optional C extension at toplevel, to help disabling it when testing
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000562try:
Antoine Pitroua106aec2017-09-28 23:03:06 +0200563 import _uuid
564except ImportError:
565 _uuid = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000566
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000567
Antoine Pitroua106aec2017-09-28 23:03:06 +0200568def _load_system_functions():
569 """
570 Try to load platform-specific functions for generating uuids.
571 """
572 global _generate_time_safe, _UuidCreate, _has_uuid_generate_time_safe
Ronald Oussorenac764d32010-05-05 15:32:33 +0000573
Antoine Pitroua106aec2017-09-28 23:03:06 +0200574 if _has_uuid_generate_time_safe is not None:
575 return
576
577 _has_uuid_generate_time_safe = False
578
579 if sys.platform == "darwin" and int(os.uname().release.split('.')[0]) < 9:
580 # The uuid_generate_* functions are broken on MacOS X 10.5, as noted
581 # in issue #8621 the function generates the same sequence of values
582 # in the parent process and all children created using fork (unless
583 # those children use exec as well).
584 #
585 # Assume that the uuid_generate functions are broken from 10.5 onward,
586 # the test can be adjusted when a later version is fixed.
587 pass
588 elif _uuid is not None:
589 _generate_time_safe = _uuid.generate_time_safe
Victor Stinner4337a0d2017-10-02 07:57:59 -0700590 _has_uuid_generate_time_safe = _uuid.has_uuid_generate_time_safe
Antoine Pitroua106aec2017-09-28 23:03:06 +0200591 return
592
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000593 try:
Antoine Pitroua106aec2017-09-28 23:03:06 +0200594 # If we couldn't find an extension module, try ctypes to find
595 # system routines for UUID generation.
596 # Thanks to Thomas Heller for ctypes and for his help with its use here.
597 import ctypes
598 import ctypes.util
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000599
Antoine Pitroua106aec2017-09-28 23:03:06 +0200600 # The uuid_generate_* routines are provided by libuuid on at least
601 # Linux and FreeBSD, and provided by libc on Mac OS X.
602 _libnames = ['uuid']
603 if not sys.platform.startswith('win'):
604 _libnames.append('c')
605 for libname in _libnames:
606 try:
607 lib = ctypes.CDLL(ctypes.util.find_library(libname))
608 except Exception: # pragma: nocover
609 continue
610 # Try to find the safe variety first.
611 if hasattr(lib, 'uuid_generate_time_safe'):
612 _uuid_generate_time_safe = lib.uuid_generate_time_safe
613 # int uuid_generate_time_safe(uuid_t out);
614 def _generate_time_safe():
615 _buffer = ctypes.create_string_buffer(16)
616 res = _uuid_generate_time_safe(_buffer)
617 return bytes(_buffer.raw), res
618 _has_uuid_generate_time_safe = True
619 break
620
621 elif hasattr(lib, 'uuid_generate_time'): # pragma: nocover
622 _uuid_generate_time = lib.uuid_generate_time
623 # void uuid_generate_time(uuid_t out);
624 _uuid_generate_time.restype = None
625 def _generate_time_safe():
626 _buffer = ctypes.create_string_buffer(16)
627 _uuid_generate_time(_buffer)
628 return bytes(_buffer.raw), None
629 break
630
631 # On Windows prior to 2000, UuidCreate gives a UUID containing the
632 # hardware address. On Windows 2000 and later, UuidCreate makes a
633 # random UUID and UuidCreateSequential gives a UUID containing the
634 # hardware address. These routines are provided by the RPC runtime.
635 # NOTE: at least on Tim's WinXP Pro SP2 desktop box, while the last
636 # 6 bytes returned by UuidCreateSequential are fixed, they don't appear
637 # to bear any relationship to the MAC address of any network device
638 # on the box.
639 try:
640 lib = ctypes.windll.rpcrt4
641 except:
642 lib = None
643 _UuidCreate = getattr(lib, 'UuidCreateSequential',
644 getattr(lib, 'UuidCreate', None))
645
646 except Exception as exc:
647 import warnings
648 warnings.warn(f"Could not find fallback ctypes uuid functions: {exc}",
649 ImportWarning)
650
651
652def _unix_getnode():
653 """Get the hardware address on Unix using the _uuid extension module
654 or ctypes."""
655 _load_system_functions()
656 uuid_time, _ = _generate_time_safe()
657 return UUID(bytes=uuid_time).node
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000658
659def _windll_getnode():
660 """Get the hardware address on Windows using ctypes."""
Antoine Pitroua106aec2017-09-28 23:03:06 +0200661 import ctypes
662 _load_system_functions()
Guido van Rossum37410aa2007-08-24 04:13:42 +0000663 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000664 if _UuidCreate(_buffer) == 0:
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000665 return UUID(bytes=bytes_(_buffer.raw)).node
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000666
667def _random_getnode():
Barry Warsaw23df2d12017-11-28 17:26:04 -0500668 """Get a random node ID."""
669 # RFC 4122, $4.1.6 says "For systems with no IEEE address, a randomly or
670 # pseudo-randomly generated value may be used; see Section 4.5. The
671 # multicast bit must be set in such addresses, in order that they will
672 # never conflict with addresses obtained from network cards."
673 #
674 # The "multicast bit" of a MAC address is defined to be "the least
675 # significant bit of the first octet". This works out to be the 41st bit
676 # counting from 1 being the least significant bit, or 1<<40.
677 #
678 # See https://en.wikipedia.org/wiki/MAC_address#Unicast_vs._multicast
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000679 import random
Barry Warsaw23df2d12017-11-28 17:26:04 -0500680 return random.getrandbits(48) | (1 << 40)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000681
Antoine Pitroua106aec2017-09-28 23:03:06 +0200682
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000683_node = None
684
Bo Bayles6b273f72018-01-23 19:11:44 -0600685_NODE_GETTERS_WIN32 = [_windll_getnode, _netbios_getnode, _ipconfig_getnode]
686
687_NODE_GETTERS_UNIX = [_unix_getnode, _ifconfig_getnode, _ip_getnode,
688 _arp_getnode, _lanscan_getnode, _netstat_getnode]
689
690def getnode(*, getters=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000691 """Get the hardware address as a 48-bit positive integer.
692
693 The first time this runs, it may launch a separate program, which could
694 be quite slow. If all attempts to obtain the hardware address fail, we
695 choose a random 48-bit number with its eighth bit set to 1 as recommended
696 in RFC 4122.
697 """
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000698 global _node
699 if _node is not None:
700 return _node
701
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000702 if sys.platform == 'win32':
Bo Bayles6b273f72018-01-23 19:11:44 -0600703 getters = _NODE_GETTERS_WIN32
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000704 else:
Bo Bayles6b273f72018-01-23 19:11:44 -0600705 getters = _NODE_GETTERS_UNIX
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000706
Serhiy Storchakae69fbb62017-12-04 11:51:55 +0200707 for getter in getters + [_random_getnode]:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000708 try:
709 _node = getter()
710 except:
711 continue
Bo Bayles6b273f72018-01-23 19:11:44 -0600712 if (_node is not None) and (0 <= _node < (1 << 48)):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000713 return _node
Bo Bayles6b273f72018-01-23 19:11:44 -0600714 assert False, '_random_getnode() returned invalid value: {}'.format(_node)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000715
Antoine Pitroua106aec2017-09-28 23:03:06 +0200716
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000717_last_timestamp = None
718
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000719def uuid1(node=None, clock_seq=None):
720 """Generate a UUID from a host ID, sequence number, and the current time.
721 If 'node' is not given, getnode() is used to obtain the hardware
722 address. If 'clock_seq' is given, it is used as the sequence number;
723 otherwise a random 14-bit sequence number is chosen."""
724
725 # When the system provides a version-1 UUID generator, use it (but don't
726 # use UuidCreate here because its UUIDs don't conform to RFC 4122).
Antoine Pitroua106aec2017-09-28 23:03:06 +0200727 _load_system_functions()
728 if _generate_time_safe is not None and node is clock_seq is None:
729 uuid_time, safely_generated = _generate_time_safe()
Barry Warsaw8c130d72017-02-18 15:45:49 -0500730 try:
731 is_safe = SafeUUID(safely_generated)
732 except ValueError:
733 is_safe = SafeUUID.unknown
Antoine Pitroua106aec2017-09-28 23:03:06 +0200734 return UUID(bytes=uuid_time, is_safe=is_safe)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000735
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000736 global _last_timestamp
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000737 import time
738 nanoseconds = int(time.time() * 1e9)
739 # 0x01b21dd213814000 is the number of 100-ns intervals between the
740 # UUID epoch 1582-10-15 00:00:00 and the Unix epoch 1970-01-01 00:00:00.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000741 timestamp = int(nanoseconds/100) + 0x01b21dd213814000
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000742 if _last_timestamp is not None and timestamp <= _last_timestamp:
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000743 timestamp = _last_timestamp + 1
744 _last_timestamp = timestamp
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000745 if clock_seq is None:
746 import random
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300747 clock_seq = random.getrandbits(14) # instead of stable storage
Guido van Rossume2a383d2007-01-15 16:59:06 +0000748 time_low = timestamp & 0xffffffff
749 time_mid = (timestamp >> 32) & 0xffff
750 time_hi_version = (timestamp >> 48) & 0x0fff
751 clock_seq_low = clock_seq & 0xff
752 clock_seq_hi_variant = (clock_seq >> 8) & 0x3f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000753 if node is None:
754 node = getnode()
755 return UUID(fields=(time_low, time_mid, time_hi_version,
756 clock_seq_hi_variant, clock_seq_low, node), version=1)
757
758def uuid3(namespace, name):
759 """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000760 from hashlib import md5
Guido van Rossum65b6a802007-07-09 14:03:08 +0000761 hash = md5(namespace.bytes + bytes(name, "utf-8")).digest()
Guido van Rossum5ed033b2007-07-09 14:29:40 +0000762 return UUID(bytes=hash[:16], version=3)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000763
764def uuid4():
765 """Generate a random UUID."""
Benjamin Peterson788cb522015-10-29 20:38:04 -0700766 return UUID(bytes=os.urandom(16), version=4)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000767
768def uuid5(namespace, name):
769 """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000770 from hashlib import sha1
Guido van Rossum65b6a802007-07-09 14:03:08 +0000771 hash = sha1(namespace.bytes + bytes(name, "utf-8")).digest()
Guido van Rossum5ed033b2007-07-09 14:29:40 +0000772 return UUID(bytes=hash[:16], version=5)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000773
774# The following standard UUIDs are for use with uuid3() or uuid5().
775
776NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
777NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
778NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
779NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')