blob: 1061bffc43c7184f4d280b9c5d4b2d557190811b [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
47__author__ = 'Ka-Ping Yee <ping@zesty.ca>'
Thomas Wouters0e3f5912006-08-11 14:57:12 +000048
49RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT, RESERVED_FUTURE = [
50 'reserved for NCS compatibility', 'specified in RFC 4122',
51 'reserved for Microsoft compatibility', 'reserved for future definition']
52
Guido van Rossum65b6a802007-07-09 14:03:08 +000053int_ = int # The built-in int type
54bytes_ = bytes # The built-in bytes type
Guido van Rossume2a383d2007-01-15 16:59:06 +000055
Thomas Wouters0e3f5912006-08-11 14:57:12 +000056class UUID(object):
57 """Instances of the UUID class represent UUIDs as specified in RFC 4122.
58 UUID objects are immutable, hashable, and usable as dictionary keys.
59 Converting a UUID to a string with str() yields something in the form
60 '12345678-1234-1234-1234-123456789abc'. The UUID constructor accepts
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000061 five possible forms: a similar string of hexadecimal digits, or a tuple
62 of six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and
63 48-bit values respectively) as an argument named 'fields', or a string
64 of 16 bytes (with all the integer fields in big-endian order) as an
65 argument named 'bytes', or a string of 16 bytes (with the first three
66 fields in little-endian order) as an argument named 'bytes_le', or a
67 single 128-bit integer as an argument named 'int'.
Thomas Wouters0e3f5912006-08-11 14:57:12 +000068
69 UUIDs have these read-only attributes:
70
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000071 bytes the UUID as a 16-byte string (containing the six
72 integer fields in big-endian byte order)
73
74 bytes_le the UUID as a 16-byte string (with time_low, time_mid,
75 and time_hi_version in little-endian byte order)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000076
77 fields a tuple of the six integer fields of the UUID,
78 which are also available as six individual attributes
79 and two derived attributes:
80
81 time_low the first 32 bits of the UUID
82 time_mid the next 16 bits of the UUID
83 time_hi_version the next 16 bits of the UUID
84 clock_seq_hi_variant the next 8 bits of the UUID
85 clock_seq_low the next 8 bits of the UUID
86 node the last 48 bits of the UUID
87
88 time the 60-bit timestamp
89 clock_seq the 14-bit sequence number
90
91 hex the UUID as a 32-character hexadecimal string
92
93 int the UUID as a 128-bit integer
94
95 urn the UUID as a URN as specified in RFC 4122
96
97 variant the UUID variant (one of the constants RESERVED_NCS,
98 RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)
99
100 version the UUID version number (1 through 5, meaningful only
101 when the variant is RFC_4122)
102 """
103
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000104 def __init__(self, hex=None, bytes=None, bytes_le=None, fields=None,
105 int=None, version=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000106 r"""Create a UUID from either a string of 32 hexadecimal digits,
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000107 a string of 16 bytes as the 'bytes' argument, a string of 16 bytes
108 in little-endian order as the 'bytes_le' argument, a tuple of six
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000109 integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
110 8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
111 the 'fields' argument, or a single 128-bit integer as the 'int'
112 argument. When a string of hex digits is given, curly braces,
113 hyphens, and a URN prefix are all optional. For example, these
114 expressions all yield the same UUID:
115
116 UUID('{12345678-1234-5678-1234-567812345678}')
117 UUID('12345678123456781234567812345678')
118 UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
119 UUID(bytes='\x12\x34\x56\x78'*4)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000120 UUID(bytes_le='\x78\x56\x34\x12\x34\x12\x78\x56' +
121 '\x12\x34\x56\x78\x12\x34\x56\x78')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000122 UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
123 UUID(int=0x12345678123456781234567812345678)
124
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000125 Exactly one of 'hex', 'bytes', 'bytes_le', 'fields', or 'int' must
126 be given. The 'version' argument is optional; if given, the resulting
127 UUID will have its variant and version set according to RFC 4122,
128 overriding the given 'hex', 'bytes', 'bytes_le', 'fields', or 'int'.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 """
130
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000131 if [hex, bytes, bytes_le, fields, int].count(None) != 4:
132 raise TypeError('need one of hex, bytes, bytes_le, fields, or int')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000133 if hex is not None:
134 hex = hex.replace('urn:', '').replace('uuid:', '')
135 hex = hex.strip('{}').replace('-', '')
136 if len(hex) != 32:
137 raise ValueError('badly formed hexadecimal UUID string')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000138 int = int_(hex, 16)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000139 if bytes_le is not None:
140 if len(bytes_le) != 16:
141 raise ValueError('bytes_le is not a 16-char string')
Guido van Rossum65b6a802007-07-09 14:03:08 +0000142 bytes = (bytes_(reversed(bytes_le[0:4])) +
143 bytes_(reversed(bytes_le[4:6])) +
144 bytes_(reversed(bytes_le[6:8])) +
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000145 bytes_le[8:])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000146 if bytes is not None:
147 if len(bytes) != 16:
148 raise ValueError('bytes is not a 16-char string')
Guido van Rossum65b6a802007-07-09 14:03:08 +0000149 assert isinstance(bytes, bytes_), repr(bytes)
Philip Jenvey1221f6b2013-08-29 18:33:50 -0700150 int = int_.from_bytes(bytes, byteorder='big')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000151 if fields is not None:
152 if len(fields) != 6:
153 raise ValueError('fields is not a 6-tuple')
154 (time_low, time_mid, time_hi_version,
155 clock_seq_hi_variant, clock_seq_low, node) = fields
Guido van Rossume2a383d2007-01-15 16:59:06 +0000156 if not 0 <= time_low < 1<<32:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000157 raise ValueError('field 1 out of range (need a 32-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000158 if not 0 <= time_mid < 1<<16:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000159 raise ValueError('field 2 out of range (need a 16-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000160 if not 0 <= time_hi_version < 1<<16:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000161 raise ValueError('field 3 out of range (need a 16-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000162 if not 0 <= clock_seq_hi_variant < 1<<8:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000163 raise ValueError('field 4 out of range (need an 8-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000164 if not 0 <= clock_seq_low < 1<<8:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000165 raise ValueError('field 5 out of range (need an 8-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000166 if not 0 <= node < 1<<48:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000167 raise ValueError('field 6 out of range (need a 48-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000168 clock_seq = (clock_seq_hi_variant << 8) | clock_seq_low
169 int = ((time_low << 96) | (time_mid << 80) |
170 (time_hi_version << 64) | (clock_seq << 48) | node)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000171 if int is not None:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000172 if not 0 <= int < 1<<128:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000173 raise ValueError('int is out of range (need a 128-bit value)')
174 if version is not None:
175 if not 1 <= version <= 5:
176 raise ValueError('illegal version number')
177 # Set the variant to RFC 4122.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000178 int &= ~(0xc000 << 48)
179 int |= 0x8000 << 48
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000180 # Set the version number.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000181 int &= ~(0xf000 << 64)
182 int |= version << 76
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000183 self.__dict__['int'] = int
184
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000185 def __eq__(self, other):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000186 if isinstance(other, UUID):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000187 return self.int == other.int
188 return NotImplemented
189
190 def __ne__(self, other):
191 if isinstance(other, UUID):
192 return self.int != other.int
193 return NotImplemented
194
Guido van Rossum65b6a802007-07-09 14:03:08 +0000195 # Q. What's the value of being able to sort UUIDs?
196 # A. Use them as keys in a B-Tree or similar mapping.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000197
198 def __lt__(self, other):
199 if isinstance(other, UUID):
200 return self.int < other.int
201 return NotImplemented
202
203 def __gt__(self, other):
204 if isinstance(other, UUID):
205 return self.int > other.int
206 return NotImplemented
207
208 def __le__(self, other):
209 if isinstance(other, UUID):
210 return self.int <= other.int
211 return NotImplemented
212
213 def __ge__(self, other):
214 if isinstance(other, UUID):
215 return self.int >= other.int
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000216 return NotImplemented
217
218 def __hash__(self):
219 return hash(self.int)
220
221 def __int__(self):
222 return self.int
223
224 def __repr__(self):
225 return 'UUID(%r)' % str(self)
226
227 def __setattr__(self, name, value):
228 raise TypeError('UUID objects are immutable')
229
230 def __str__(self):
231 hex = '%032x' % self.int
232 return '%s-%s-%s-%s-%s' % (
233 hex[:8], hex[8:12], hex[12:16], hex[16:20], hex[20:])
234
Guido van Rossum65b6a802007-07-09 14:03:08 +0000235 @property
236 def bytes(self):
Guido van Rossum254348e2007-11-21 19:29:53 +0000237 bytes = bytearray()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000238 for shift in range(0, 128, 8):
Guido van Rossum65b6a802007-07-09 14:03:08 +0000239 bytes.insert(0, (self.int >> shift) & 0xff)
Georg Brandl1d523e12009-12-19 18:23:28 +0000240 return bytes_(bytes)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000241
Guido van Rossum65b6a802007-07-09 14:03:08 +0000242 @property
243 def bytes_le(self):
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000244 bytes = self.bytes
Guido van Rossum65b6a802007-07-09 14:03:08 +0000245 return (bytes_(reversed(bytes[0:4])) +
246 bytes_(reversed(bytes[4:6])) +
247 bytes_(reversed(bytes[6:8])) +
248 bytes[8:])
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000249
Guido van Rossum65b6a802007-07-09 14:03:08 +0000250 @property
251 def fields(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000252 return (self.time_low, self.time_mid, self.time_hi_version,
253 self.clock_seq_hi_variant, self.clock_seq_low, self.node)
254
Guido van Rossum65b6a802007-07-09 14:03:08 +0000255 @property
256 def time_low(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000257 return self.int >> 96
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000258
Guido van Rossum65b6a802007-07-09 14:03:08 +0000259 @property
260 def time_mid(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000261 return (self.int >> 80) & 0xffff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000262
Guido van Rossum65b6a802007-07-09 14:03:08 +0000263 @property
264 def time_hi_version(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000265 return (self.int >> 64) & 0xffff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000266
Guido van Rossum65b6a802007-07-09 14:03:08 +0000267 @property
268 def clock_seq_hi_variant(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000269 return (self.int >> 56) & 0xff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000270
Guido van Rossum65b6a802007-07-09 14:03:08 +0000271 @property
272 def clock_seq_low(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000273 return (self.int >> 48) & 0xff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000274
Guido van Rossum65b6a802007-07-09 14:03:08 +0000275 @property
276 def time(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000277 return (((self.time_hi_version & 0x0fff) << 48) |
278 (self.time_mid << 32) | self.time_low)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000279
Guido van Rossum65b6a802007-07-09 14:03:08 +0000280 @property
281 def clock_seq(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000282 return (((self.clock_seq_hi_variant & 0x3f) << 8) |
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000283 self.clock_seq_low)
284
Guido van Rossum65b6a802007-07-09 14:03:08 +0000285 @property
286 def node(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000287 return self.int & 0xffffffffffff
288
Guido van Rossum65b6a802007-07-09 14:03:08 +0000289 @property
290 def hex(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000291 return '%032x' % self.int
292
Guido van Rossum65b6a802007-07-09 14:03:08 +0000293 @property
294 def urn(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000295 return 'urn:uuid:' + str(self)
296
Guido van Rossum65b6a802007-07-09 14:03:08 +0000297 @property
298 def variant(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000299 if not self.int & (0x8000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000300 return RESERVED_NCS
Guido van Rossume2a383d2007-01-15 16:59:06 +0000301 elif not self.int & (0x4000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000302 return RFC_4122
Guido van Rossume2a383d2007-01-15 16:59:06 +0000303 elif not self.int & (0x2000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000304 return RESERVED_MICROSOFT
305 else:
306 return RESERVED_FUTURE
307
Guido van Rossum65b6a802007-07-09 14:03:08 +0000308 @property
309 def version(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000310 # The version bits are only meaningful for RFC 4122 UUIDs.
311 if self.variant == RFC_4122:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000312 return int((self.int >> 76) & 0xf)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000313
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200314def _popen(command, args):
R David Murray4be1e242013-12-17 21:13:16 -0500315 import os, shutil
316 executable = shutil.which(command)
317 if executable is None:
318 path = os.pathsep.join(('/sbin', '/usr/sbin'))
319 executable = shutil.which(command, path=path)
320 if executable is None:
321 return None
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200322 # LC_ALL to ensure English output, 2>/dev/null to prevent output on
323 # stderr (Note: we don't have an example where the words we search for
324 # are actually localized, but in theory some system could do so.)
325 cmd = 'LC_ALL=C %s %s 2>/dev/null' % (executable, args)
326 return os.popen(cmd)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000327
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200328def _find_mac(command, args, hw_identifiers, get_index):
R David Murray4be1e242013-12-17 21:13:16 -0500329 try:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200330 pipe = _popen(command, args)
331 if not pipe:
332 return
333 with pipe:
R David Murray4be1e242013-12-17 21:13:16 -0500334 for line in pipe:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200335 words = line.lower().rstrip().split()
R David Murray4be1e242013-12-17 21:13:16 -0500336 for i in range(len(words)):
337 if words[i] in hw_identifiers:
338 try:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200339 word = words[get_index(i)]
340 mac = int(word.replace(':', ''), 16)
341 if mac:
342 return mac
R David Murray4be1e242013-12-17 21:13:16 -0500343 except (ValueError, IndexError):
344 # Virtual interfaces, such as those provided by
345 # VPNs, do not have a colon-delimited MAC address
346 # as expected, but a 16-byte HWAddr separated by
347 # dashes. These should be ignored in favor of a
348 # real MAC address
349 pass
R David Murray0ce3e9d2013-12-17 21:14:41 -0500350 except OSError:
R David Murray4be1e242013-12-17 21:13:16 -0500351 pass
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000352
353def _ifconfig_getnode():
354 """Get the hardware address on Unix by running ifconfig."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000355 # This works on Linux ('' or '-a'), Tru64 ('-av'), but not all Unixes.
356 for args in ('', '-a', '-av'):
357 mac = _find_mac('ifconfig', args, ['hwaddr', 'ether'], lambda i: i+1)
358 if mac:
359 return mac
360
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200361def _arp_getnode():
362 """Get the hardware address on Unix by running arp."""
363 import os, socket
Serhiy Storchaka525d5ae2014-11-21 21:55:39 +0200364 try:
365 ip_addr = socket.gethostbyname(socket.gethostname())
366 except OSError:
367 return None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000368
369 # Try getting the MAC addr from arp based on our IP address (Solaris).
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200370 return _find_mac('arp', '-an', [ip_addr], lambda i: -1)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000371
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200372def _lanscan_getnode():
373 """Get the hardware address on Unix by running lanscan."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000374 # This might work on HP-UX.
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200375 return _find_mac('lanscan', '-ai', ['lan0'], lambda i: 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000376
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200377def _netstat_getnode():
378 """Get the hardware address on Unix by running netstat."""
379 # This might work on AIX, Tru64 UNIX and presumably on IRIX.
380 try:
381 pipe = _popen('netstat', '-ia')
382 if not pipe:
383 return
384 with pipe:
385 words = pipe.readline().rstrip().split()
386 try:
387 i = words.index('Address')
388 except ValueError:
389 return
390 for line in pipe:
391 try:
392 words = line.rstrip().split()
393 word = words[i]
394 if len(word) == 17 and word.count(':') == 5:
395 mac = int(word.replace(':', ''), 16)
396 if mac:
397 return mac
398 except (ValueError, IndexError):
399 pass
400 except OSError:
401 pass
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000402
403def _ipconfig_getnode():
404 """Get the hardware address on Windows by running ipconfig.exe."""
405 import os, re
406 dirs = ['', r'c:\windows\system32', r'c:\winnt\system32']
407 try:
408 import ctypes
409 buffer = ctypes.create_string_buffer(300)
410 ctypes.windll.kernel32.GetSystemDirectoryA(buffer, 300)
411 dirs.insert(0, buffer.value.decode('mbcs'))
412 except:
413 pass
414 for dir in dirs:
415 try:
416 pipe = os.popen(os.path.join(dir, 'ipconfig') + ' /all')
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200417 except OSError:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000418 continue
Serhiy Storchakac70386e2014-09-06 22:17:24 +0300419 with pipe:
Brian Curtin69cd87b2010-11-05 14:48:35 +0000420 for line in pipe:
421 value = line.split(':')[-1].strip().lower()
422 if re.match('([0-9a-f][0-9a-f]-){5}[0-9a-f][0-9a-f]', value):
423 return int(value.replace('-', ''), 16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000424
425def _netbios_getnode():
426 """Get the hardware address on Windows using NetBIOS calls.
427 See http://support.microsoft.com/kb/118623 for details."""
428 import win32wnet, netbios
429 ncb = netbios.NCB()
430 ncb.Command = netbios.NCBENUM
431 ncb.Buffer = adapters = netbios.LANA_ENUM()
432 adapters._pack()
433 if win32wnet.Netbios(ncb) != 0:
434 return
435 adapters._unpack()
436 for i in range(adapters.length):
437 ncb.Reset()
438 ncb.Command = netbios.NCBRESET
439 ncb.Lana_num = ord(adapters.lana[i])
440 if win32wnet.Netbios(ncb) != 0:
441 continue
442 ncb.Reset()
443 ncb.Command = netbios.NCBASTAT
444 ncb.Lana_num = ord(adapters.lana[i])
445 ncb.Callname = '*'.ljust(16)
446 ncb.Buffer = status = netbios.ADAPTER_STATUS()
447 if win32wnet.Netbios(ncb) != 0:
448 continue
449 status._unpack()
Serhiy Storchaka6f50b812013-06-09 21:08:05 +0300450 bytes = status.adapter_address
Guido van Rossume2a383d2007-01-15 16:59:06 +0000451 return ((bytes[0]<<40) + (bytes[1]<<32) + (bytes[2]<<24) +
452 (bytes[3]<<16) + (bytes[4]<<8) + bytes[5])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000453
454# Thanks to Thomas Heller for ctypes and for his help with its use here.
455
456# If ctypes is available, use it to find system routines for UUID generation.
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000457# XXX This makes the module non-thread-safe!
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000458_uuid_generate_random = _uuid_generate_time = _UuidCreate = None
459try:
460 import ctypes, ctypes.util
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000461
462 # The uuid_generate_* routines are provided by libuuid on at least
463 # Linux and FreeBSD, and provided by libc on Mac OS X.
464 for libname in ['uuid', 'c']:
465 try:
466 lib = ctypes.CDLL(ctypes.util.find_library(libname))
467 except:
468 continue
469 if hasattr(lib, 'uuid_generate_random'):
470 _uuid_generate_random = lib.uuid_generate_random
471 if hasattr(lib, 'uuid_generate_time'):
472 _uuid_generate_time = lib.uuid_generate_time
Serhiy Storchaka016af3f2013-09-13 07:46:40 +0300473 if _uuid_generate_random is not None:
474 break # found everything we were looking for
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000475
Ronald Oussoren0f377a52010-06-27 12:45:47 +0000476 # The uuid_generate_* functions are broken on MacOS X 10.5, as noted
Ronald Oussorenac764d32010-05-05 15:32:33 +0000477 # in issue #8621 the function generates the same sequence of values
478 # in the parent process and all children created using fork (unless
479 # those children use exec as well).
480 #
Ronald Oussoren0f377a52010-06-27 12:45:47 +0000481 # Assume that the uuid_generate functions are broken from 10.5 onward,
Ronald Oussorenac764d32010-05-05 15:32:33 +0000482 # the test can be adjusted when a later version is fixed.
483 import sys
484 if sys.platform == 'darwin':
485 import os
Larry Hastings605a62d2012-06-24 04:33:36 -0700486 if int(os.uname().release.split('.')[0]) >= 9:
Ronald Oussorenac764d32010-05-05 15:32:33 +0000487 _uuid_generate_random = _uuid_generate_time = None
488
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000489 # On Windows prior to 2000, UuidCreate gives a UUID containing the
490 # hardware address. On Windows 2000 and later, UuidCreate makes a
491 # random UUID and UuidCreateSequential gives a UUID containing the
492 # hardware address. These routines are provided by the RPC runtime.
493 # NOTE: at least on Tim's WinXP Pro SP2 desktop box, while the last
494 # 6 bytes returned by UuidCreateSequential are fixed, they don't appear
495 # to bear any relationship to the MAC address of any network device
496 # on the box.
497 try:
498 lib = ctypes.windll.rpcrt4
499 except:
500 lib = None
501 _UuidCreate = getattr(lib, 'UuidCreateSequential',
502 getattr(lib, 'UuidCreate', None))
503except:
504 pass
505
506def _unixdll_getnode():
507 """Get the hardware address on Unix using ctypes."""
Guido van Rossum37410aa2007-08-24 04:13:42 +0000508 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000509 _uuid_generate_time(_buffer)
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000510 return UUID(bytes=bytes_(_buffer.raw)).node
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000511
512def _windll_getnode():
513 """Get the hardware address on Windows using ctypes."""
Guido van Rossum37410aa2007-08-24 04:13:42 +0000514 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000515 if _UuidCreate(_buffer) == 0:
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000516 return UUID(bytes=bytes_(_buffer.raw)).node
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000517
518def _random_getnode():
519 """Get a random node ID, with eighth bit set as suggested by RFC 4122."""
520 import random
Guido van Rossume2a383d2007-01-15 16:59:06 +0000521 return random.randrange(0, 1<<48) | 0x010000000000
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000522
523_node = None
524
525def getnode():
526 """Get the hardware address as a 48-bit positive integer.
527
528 The first time this runs, it may launch a separate program, which could
529 be quite slow. If all attempts to obtain the hardware address fail, we
530 choose a random 48-bit number with its eighth bit set to 1 as recommended
531 in RFC 4122.
532 """
533
534 global _node
535 if _node is not None:
536 return _node
537
538 import sys
539 if sys.platform == 'win32':
540 getters = [_windll_getnode, _netbios_getnode, _ipconfig_getnode]
541 else:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200542 getters = [_unixdll_getnode, _ifconfig_getnode, _arp_getnode,
543 _lanscan_getnode, _netstat_getnode]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000544
545 for getter in getters + [_random_getnode]:
546 try:
547 _node = getter()
548 except:
549 continue
550 if _node is not None:
551 return _node
552
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000553_last_timestamp = None
554
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000555def uuid1(node=None, clock_seq=None):
556 """Generate a UUID from a host ID, sequence number, and the current time.
557 If 'node' is not given, getnode() is used to obtain the hardware
558 address. If 'clock_seq' is given, it is used as the sequence number;
559 otherwise a random 14-bit sequence number is chosen."""
560
561 # When the system provides a version-1 UUID generator, use it (but don't
562 # use UuidCreate here because its UUIDs don't conform to RFC 4122).
563 if _uuid_generate_time and node is clock_seq is None:
Amaury Forgeot d'Arcb0c29162008-11-22 22:18:04 +0000564 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000565 _uuid_generate_time(_buffer)
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000566 return UUID(bytes=bytes_(_buffer.raw))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000567
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000568 global _last_timestamp
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000569 import time
570 nanoseconds = int(time.time() * 1e9)
571 # 0x01b21dd213814000 is the number of 100-ns intervals between the
572 # 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 +0000573 timestamp = int(nanoseconds/100) + 0x01b21dd213814000
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000574 if _last_timestamp is not None and timestamp <= _last_timestamp:
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000575 timestamp = _last_timestamp + 1
576 _last_timestamp = timestamp
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000577 if clock_seq is None:
578 import random
Guido van Rossume2a383d2007-01-15 16:59:06 +0000579 clock_seq = random.randrange(1<<14) # instead of stable storage
580 time_low = timestamp & 0xffffffff
581 time_mid = (timestamp >> 32) & 0xffff
582 time_hi_version = (timestamp >> 48) & 0x0fff
583 clock_seq_low = clock_seq & 0xff
584 clock_seq_hi_variant = (clock_seq >> 8) & 0x3f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000585 if node is None:
586 node = getnode()
587 return UUID(fields=(time_low, time_mid, time_hi_version,
588 clock_seq_hi_variant, clock_seq_low, node), version=1)
589
590def uuid3(namespace, name):
591 """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000592 from hashlib import md5
Guido van Rossum65b6a802007-07-09 14:03:08 +0000593 hash = md5(namespace.bytes + bytes(name, "utf-8")).digest()
Guido van Rossum5ed033b2007-07-09 14:29:40 +0000594 return UUID(bytes=hash[:16], version=3)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000595
596def uuid4():
597 """Generate a random UUID."""
598
599 # When the system provides a version-4 UUID generator, use it.
600 if _uuid_generate_random:
Amaury Forgeot d'Arcb0c29162008-11-22 22:18:04 +0000601 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000602 _uuid_generate_random(_buffer)
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000603 return UUID(bytes=bytes_(_buffer.raw))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000604
605 # Otherwise, get randomness from urandom or the 'random' module.
606 try:
607 import os
608 return UUID(bytes=os.urandom(16), version=4)
609 except:
610 import random
Guido van Rossum98297ee2007-11-06 21:34:58 +0000611 bytes = bytes_(random.randrange(256) for i in range(16))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000612 return UUID(bytes=bytes, version=4)
613
614def uuid5(namespace, name):
615 """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000616 from hashlib import sha1
Guido van Rossum65b6a802007-07-09 14:03:08 +0000617 hash = sha1(namespace.bytes + bytes(name, "utf-8")).digest()
Guido van Rossum5ed033b2007-07-09 14:29:40 +0000618 return UUID(bytes=hash[:16], version=5)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000619
620# The following standard UUIDs are for use with uuid3() or uuid5().
621
622NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
623NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
624NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
625NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')