blob: 7b0b413966c0afed021dda8b67275ffad9479063 [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')
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300142 bytes = (bytes_le[4-1::-1] + bytes_le[6-1:4-1:-1] +
143 bytes_le[8-1:6-1:-1] + bytes_le[8:])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000144 if bytes is not None:
145 if len(bytes) != 16:
146 raise ValueError('bytes is not a 16-char string')
Guido van Rossum65b6a802007-07-09 14:03:08 +0000147 assert isinstance(bytes, bytes_), repr(bytes)
Philip Jenvey1221f6b2013-08-29 18:33:50 -0700148 int = int_.from_bytes(bytes, byteorder='big')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000149 if fields is not None:
150 if len(fields) != 6:
151 raise ValueError('fields is not a 6-tuple')
152 (time_low, time_mid, time_hi_version,
153 clock_seq_hi_variant, clock_seq_low, node) = fields
Guido van Rossume2a383d2007-01-15 16:59:06 +0000154 if not 0 <= time_low < 1<<32:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000155 raise ValueError('field 1 out of range (need a 32-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000156 if not 0 <= time_mid < 1<<16:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000157 raise ValueError('field 2 out of range (need a 16-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000158 if not 0 <= time_hi_version < 1<<16:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000159 raise ValueError('field 3 out of range (need a 16-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000160 if not 0 <= clock_seq_hi_variant < 1<<8:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000161 raise ValueError('field 4 out of range (need an 8-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000162 if not 0 <= clock_seq_low < 1<<8:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000163 raise ValueError('field 5 out of range (need an 8-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000164 if not 0 <= node < 1<<48:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000165 raise ValueError('field 6 out of range (need a 48-bit value)')
Guido van Rossume2a383d2007-01-15 16:59:06 +0000166 clock_seq = (clock_seq_hi_variant << 8) | clock_seq_low
167 int = ((time_low << 96) | (time_mid << 80) |
168 (time_hi_version << 64) | (clock_seq << 48) | node)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000169 if int is not None:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000170 if not 0 <= int < 1<<128:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000171 raise ValueError('int is out of range (need a 128-bit value)')
172 if version is not None:
173 if not 1 <= version <= 5:
174 raise ValueError('illegal version number')
175 # Set the variant to RFC 4122.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000176 int &= ~(0xc000 << 48)
177 int |= 0x8000 << 48
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000178 # Set the version number.
Guido van Rossume2a383d2007-01-15 16:59:06 +0000179 int &= ~(0xf000 << 64)
180 int |= version << 76
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000181 self.__dict__['int'] = int
182
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000183 def __eq__(self, other):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000184 if isinstance(other, UUID):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000185 return self.int == other.int
186 return NotImplemented
187
188 def __ne__(self, other):
189 if isinstance(other, UUID):
190 return self.int != other.int
191 return NotImplemented
192
Guido van Rossum65b6a802007-07-09 14:03:08 +0000193 # Q. What's the value of being able to sort UUIDs?
194 # A. Use them as keys in a B-Tree or similar mapping.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000195
196 def __lt__(self, other):
197 if isinstance(other, UUID):
198 return self.int < other.int
199 return NotImplemented
200
201 def __gt__(self, other):
202 if isinstance(other, UUID):
203 return self.int > other.int
204 return NotImplemented
205
206 def __le__(self, other):
207 if isinstance(other, UUID):
208 return self.int <= other.int
209 return NotImplemented
210
211 def __ge__(self, other):
212 if isinstance(other, UUID):
213 return self.int >= other.int
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000214 return NotImplemented
215
216 def __hash__(self):
217 return hash(self.int)
218
219 def __int__(self):
220 return self.int
221
222 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300223 return '%s(%r)' % (self.__class__.__name__, str(self))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000224
225 def __setattr__(self, name, value):
226 raise TypeError('UUID objects are immutable')
227
228 def __str__(self):
229 hex = '%032x' % self.int
230 return '%s-%s-%s-%s-%s' % (
231 hex[:8], hex[8:12], hex[12:16], hex[16:20], hex[20:])
232
Guido van Rossum65b6a802007-07-09 14:03:08 +0000233 @property
234 def bytes(self):
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300235 return self.int.to_bytes(16, 'big')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000236
Guido van Rossum65b6a802007-07-09 14:03:08 +0000237 @property
238 def bytes_le(self):
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000239 bytes = self.bytes
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300240 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 +0000241 bytes[8:])
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000242
Guido van Rossum65b6a802007-07-09 14:03:08 +0000243 @property
244 def fields(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000245 return (self.time_low, self.time_mid, self.time_hi_version,
246 self.clock_seq_hi_variant, self.clock_seq_low, self.node)
247
Guido van Rossum65b6a802007-07-09 14:03:08 +0000248 @property
249 def time_low(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000250 return self.int >> 96
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000251
Guido van Rossum65b6a802007-07-09 14:03:08 +0000252 @property
253 def time_mid(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000254 return (self.int >> 80) & 0xffff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000255
Guido van Rossum65b6a802007-07-09 14:03:08 +0000256 @property
257 def time_hi_version(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000258 return (self.int >> 64) & 0xffff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000259
Guido van Rossum65b6a802007-07-09 14:03:08 +0000260 @property
261 def clock_seq_hi_variant(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000262 return (self.int >> 56) & 0xff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000263
Guido van Rossum65b6a802007-07-09 14:03:08 +0000264 @property
265 def clock_seq_low(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000266 return (self.int >> 48) & 0xff
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000267
Guido van Rossum65b6a802007-07-09 14:03:08 +0000268 @property
269 def time(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000270 return (((self.time_hi_version & 0x0fff) << 48) |
271 (self.time_mid << 32) | self.time_low)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000272
Guido van Rossum65b6a802007-07-09 14:03:08 +0000273 @property
274 def clock_seq(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000275 return (((self.clock_seq_hi_variant & 0x3f) << 8) |
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000276 self.clock_seq_low)
277
Guido van Rossum65b6a802007-07-09 14:03:08 +0000278 @property
279 def node(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000280 return self.int & 0xffffffffffff
281
Guido van Rossum65b6a802007-07-09 14:03:08 +0000282 @property
283 def hex(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000284 return '%032x' % self.int
285
Guido van Rossum65b6a802007-07-09 14:03:08 +0000286 @property
287 def urn(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000288 return 'urn:uuid:' + str(self)
289
Guido van Rossum65b6a802007-07-09 14:03:08 +0000290 @property
291 def variant(self):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000292 if not self.int & (0x8000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000293 return RESERVED_NCS
Guido van Rossume2a383d2007-01-15 16:59:06 +0000294 elif not self.int & (0x4000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000295 return RFC_4122
Guido van Rossume2a383d2007-01-15 16:59:06 +0000296 elif not self.int & (0x2000 << 48):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000297 return RESERVED_MICROSOFT
298 else:
299 return RESERVED_FUTURE
300
Guido van Rossum65b6a802007-07-09 14:03:08 +0000301 @property
302 def version(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000303 # The version bits are only meaningful for RFC 4122 UUIDs.
304 if self.variant == RFC_4122:
Guido van Rossume2a383d2007-01-15 16:59:06 +0000305 return int((self.int >> 76) & 0xf)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000306
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200307def _popen(command, *args):
Victor Stinnerb9d01992014-10-21 22:33:10 +0200308 import os, shutil, subprocess
R David Murray4be1e242013-12-17 21:13:16 -0500309 executable = shutil.which(command)
310 if executable is None:
311 path = os.pathsep.join(('/sbin', '/usr/sbin'))
312 executable = shutil.which(command, path=path)
313 if executable is None:
314 return None
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200315 # LC_ALL=C to ensure English output, stderr=DEVNULL to prevent output
316 # on stderr (Note: we don't have an example where the words we search
317 # for are actually localized, but in theory some system could do so.)
318 env = dict(os.environ)
319 env['LC_ALL'] = 'C'
320 proc = subprocess.Popen((executable,) + args,
321 stdout=subprocess.PIPE,
322 stderr=subprocess.DEVNULL,
323 env=env)
324 return proc
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000325
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200326def _find_mac(command, args, hw_identifiers, get_index):
R David Murray4be1e242013-12-17 21:13:16 -0500327 try:
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200328 proc = _popen(command, *args.split())
329 if not proc:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200330 return
Victor Stinnerb9d01992014-10-21 22:33:10 +0200331 with proc:
332 for line in proc.stdout:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200333 words = line.lower().rstrip().split()
R David Murray4be1e242013-12-17 21:13:16 -0500334 for i in range(len(words)):
335 if words[i] in hw_identifiers:
336 try:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200337 word = words[get_index(i)]
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200338 mac = int(word.replace(b':', b''), 16)
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200339 if mac:
340 return mac
R David Murray4be1e242013-12-17 21:13:16 -0500341 except (ValueError, IndexError):
342 # Virtual interfaces, such as those provided by
343 # VPNs, do not have a colon-delimited MAC address
344 # as expected, but a 16-byte HWAddr separated by
345 # dashes. These should be ignored in favor of a
346 # real MAC address
347 pass
R David Murray0ce3e9d2013-12-17 21:14:41 -0500348 except OSError:
R David Murray4be1e242013-12-17 21:13:16 -0500349 pass
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000350
351def _ifconfig_getnode():
352 """Get the hardware address on Unix by running ifconfig."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000353 # This works on Linux ('' or '-a'), Tru64 ('-av'), but not all Unixes.
354 for args in ('', '-a', '-av'):
Victor Stinnerb9d01992014-10-21 22:33:10 +0200355 mac = _find_mac('ifconfig', args, [b'hwaddr', b'ether'], lambda i: i+1)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000356 if mac:
357 return mac
358
Serhiy Storchakaac4aa7b2014-11-30 20:39:04 +0200359def _ip_getnode():
360 """Get the hardware address on Unix by running ip."""
361 # This works on Linux with iproute2.
362 mac = _find_mac('ip', 'link list', [b'link/ether'], lambda i: i+1)
363 if mac:
364 return mac
365
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200366def _arp_getnode():
367 """Get the hardware address on Unix by running arp."""
368 import os, socket
Serhiy Storchaka525d5ae2014-11-21 21:55:39 +0200369 try:
370 ip_addr = socket.gethostbyname(socket.gethostname())
371 except OSError:
372 return None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000373
374 # Try getting the MAC addr from arp based on our IP address (Solaris).
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200375 return _find_mac('arp', '-an', [os.fsencode(ip_addr)], lambda i: -1)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000376
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200377def _lanscan_getnode():
378 """Get the hardware address on Unix by running lanscan."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000379 # This might work on HP-UX.
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200380 return _find_mac('lanscan', '-ai', [b'lan0'], lambda i: 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000381
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200382def _netstat_getnode():
383 """Get the hardware address on Unix by running netstat."""
384 # This might work on AIX, Tru64 UNIX and presumably on IRIX.
385 try:
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200386 proc = _popen('netstat', '-ia')
387 if not proc:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200388 return
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200389 with proc:
390 words = proc.stdout.readline().rstrip().split()
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200391 try:
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200392 i = words.index(b'Address')
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200393 except ValueError:
394 return
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200395 for line in proc.stdout:
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200396 try:
397 words = line.rstrip().split()
398 word = words[i]
Serhiy Storchaka57b96772014-11-07 12:23:30 +0200399 if len(word) == 17 and word.count(b':') == 5:
400 mac = int(word.replace(b':', b''), 16)
Serhiy Storchakae66bb962014-11-07 12:19:40 +0200401 if mac:
402 return mac
403 except (ValueError, IndexError):
404 pass
405 except OSError:
406 pass
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000407
408def _ipconfig_getnode():
409 """Get the hardware address on Windows by running ipconfig.exe."""
410 import os, re
411 dirs = ['', r'c:\windows\system32', r'c:\winnt\system32']
412 try:
413 import ctypes
414 buffer = ctypes.create_string_buffer(300)
415 ctypes.windll.kernel32.GetSystemDirectoryA(buffer, 300)
416 dirs.insert(0, buffer.value.decode('mbcs'))
417 except:
418 pass
419 for dir in dirs:
420 try:
421 pipe = os.popen(os.path.join(dir, 'ipconfig') + ' /all')
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200422 except OSError:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000423 continue
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300424 with pipe:
Brian Curtin69cd87b2010-11-05 14:48:35 +0000425 for line in pipe:
426 value = line.split(':')[-1].strip().lower()
427 if re.match('([0-9a-f][0-9a-f]-){5}[0-9a-f][0-9a-f]', value):
428 return int(value.replace('-', ''), 16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000429
430def _netbios_getnode():
431 """Get the hardware address on Windows using NetBIOS calls.
432 See http://support.microsoft.com/kb/118623 for details."""
433 import win32wnet, netbios
434 ncb = netbios.NCB()
435 ncb.Command = netbios.NCBENUM
436 ncb.Buffer = adapters = netbios.LANA_ENUM()
437 adapters._pack()
438 if win32wnet.Netbios(ncb) != 0:
439 return
440 adapters._unpack()
441 for i in range(adapters.length):
442 ncb.Reset()
443 ncb.Command = netbios.NCBRESET
444 ncb.Lana_num = ord(adapters.lana[i])
445 if win32wnet.Netbios(ncb) != 0:
446 continue
447 ncb.Reset()
448 ncb.Command = netbios.NCBASTAT
449 ncb.Lana_num = ord(adapters.lana[i])
450 ncb.Callname = '*'.ljust(16)
451 ncb.Buffer = status = netbios.ADAPTER_STATUS()
452 if win32wnet.Netbios(ncb) != 0:
453 continue
454 status._unpack()
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300455 bytes = status.adapter_address[:6]
456 if len(bytes) != 6:
457 continue
458 return int.from_bytes(bytes, 'big')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000459
460# Thanks to Thomas Heller for ctypes and for his help with its use here.
461
462# If ctypes is available, use it to find system routines for UUID generation.
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000463# XXX This makes the module non-thread-safe!
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000464_uuid_generate_random = _uuid_generate_time = _UuidCreate = None
465try:
466 import ctypes, ctypes.util
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000467
468 # The uuid_generate_* routines are provided by libuuid on at least
469 # Linux and FreeBSD, and provided by libc on Mac OS X.
470 for libname in ['uuid', 'c']:
471 try:
472 lib = ctypes.CDLL(ctypes.util.find_library(libname))
473 except:
474 continue
475 if hasattr(lib, 'uuid_generate_random'):
476 _uuid_generate_random = lib.uuid_generate_random
477 if hasattr(lib, 'uuid_generate_time'):
478 _uuid_generate_time = lib.uuid_generate_time
Serhiy Storchaka016af3f2013-09-13 07:46:40 +0300479 if _uuid_generate_random is not None:
480 break # found everything we were looking for
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000481
Ronald Oussoren0f377a52010-06-27 12:45:47 +0000482 # The uuid_generate_* functions are broken on MacOS X 10.5, as noted
Ronald Oussorenac764d32010-05-05 15:32:33 +0000483 # in issue #8621 the function generates the same sequence of values
484 # in the parent process and all children created using fork (unless
485 # those children use exec as well).
486 #
Ronald Oussoren0f377a52010-06-27 12:45:47 +0000487 # Assume that the uuid_generate functions are broken from 10.5 onward,
Ronald Oussorenac764d32010-05-05 15:32:33 +0000488 # the test can be adjusted when a later version is fixed.
489 import sys
490 if sys.platform == 'darwin':
491 import os
Larry Hastings605a62d2012-06-24 04:33:36 -0700492 if int(os.uname().release.split('.')[0]) >= 9:
Ronald Oussorenac764d32010-05-05 15:32:33 +0000493 _uuid_generate_random = _uuid_generate_time = None
494
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000495 # On Windows prior to 2000, UuidCreate gives a UUID containing the
496 # hardware address. On Windows 2000 and later, UuidCreate makes a
497 # random UUID and UuidCreateSequential gives a UUID containing the
498 # hardware address. These routines are provided by the RPC runtime.
499 # NOTE: at least on Tim's WinXP Pro SP2 desktop box, while the last
500 # 6 bytes returned by UuidCreateSequential are fixed, they don't appear
501 # to bear any relationship to the MAC address of any network device
502 # on the box.
503 try:
504 lib = ctypes.windll.rpcrt4
505 except:
506 lib = None
507 _UuidCreate = getattr(lib, 'UuidCreateSequential',
508 getattr(lib, 'UuidCreate', None))
509except:
510 pass
511
512def _unixdll_getnode():
513 """Get the hardware address on Unix 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 _uuid_generate_time(_buffer)
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 _windll_getnode():
519 """Get the hardware address on Windows using ctypes."""
Guido van Rossum37410aa2007-08-24 04:13:42 +0000520 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000521 if _UuidCreate(_buffer) == 0:
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000522 return UUID(bytes=bytes_(_buffer.raw)).node
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000523
524def _random_getnode():
525 """Get a random node ID, with eighth bit set as suggested by RFC 4122."""
526 import random
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300527 return random.getrandbits(48) | 0x010000000000
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000528
529_node = None
530
531def getnode():
532 """Get the hardware address as a 48-bit positive integer.
533
534 The first time this runs, it may launch a separate program, which could
535 be quite slow. If all attempts to obtain the hardware address fail, we
536 choose a random 48-bit number with its eighth bit set to 1 as recommended
537 in RFC 4122.
538 """
539
540 global _node
541 if _node is not None:
542 return _node
543
544 import sys
545 if sys.platform == 'win32':
546 getters = [_windll_getnode, _netbios_getnode, _ipconfig_getnode]
547 else:
Serhiy Storchakaac4aa7b2014-11-30 20:39:04 +0200548 getters = [_unixdll_getnode, _ifconfig_getnode, _ip_getnode,
549 _arp_getnode, _lanscan_getnode, _netstat_getnode]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000550
551 for getter in getters + [_random_getnode]:
552 try:
553 _node = getter()
554 except:
555 continue
556 if _node is not None:
557 return _node
558
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000559_last_timestamp = None
560
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000561def uuid1(node=None, clock_seq=None):
562 """Generate a UUID from a host ID, sequence number, and the current time.
563 If 'node' is not given, getnode() is used to obtain the hardware
564 address. If 'clock_seq' is given, it is used as the sequence number;
565 otherwise a random 14-bit sequence number is chosen."""
566
567 # When the system provides a version-1 UUID generator, use it (but don't
568 # use UuidCreate here because its UUIDs don't conform to RFC 4122).
569 if _uuid_generate_time and node is clock_seq is None:
Amaury Forgeot d'Arcb0c29162008-11-22 22:18:04 +0000570 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000571 _uuid_generate_time(_buffer)
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000572 return UUID(bytes=bytes_(_buffer.raw))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000573
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000574 global _last_timestamp
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000575 import time
576 nanoseconds = int(time.time() * 1e9)
577 # 0x01b21dd213814000 is the number of 100-ns intervals between the
578 # 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 +0000579 timestamp = int(nanoseconds/100) + 0x01b21dd213814000
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000580 if _last_timestamp is not None and timestamp <= _last_timestamp:
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000581 timestamp = _last_timestamp + 1
582 _last_timestamp = timestamp
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000583 if clock_seq is None:
584 import random
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300585 clock_seq = random.getrandbits(14) # instead of stable storage
Guido van Rossume2a383d2007-01-15 16:59:06 +0000586 time_low = timestamp & 0xffffffff
587 time_mid = (timestamp >> 32) & 0xffff
588 time_hi_version = (timestamp >> 48) & 0x0fff
589 clock_seq_low = clock_seq & 0xff
590 clock_seq_hi_variant = (clock_seq >> 8) & 0x3f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000591 if node is None:
592 node = getnode()
593 return UUID(fields=(time_low, time_mid, time_hi_version,
594 clock_seq_hi_variant, clock_seq_low, node), version=1)
595
596def uuid3(namespace, name):
597 """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000598 from hashlib import md5
Guido van Rossum65b6a802007-07-09 14:03:08 +0000599 hash = md5(namespace.bytes + bytes(name, "utf-8")).digest()
Guido van Rossum5ed033b2007-07-09 14:29:40 +0000600 return UUID(bytes=hash[:16], version=3)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000601
602def uuid4():
603 """Generate a random UUID."""
604
605 # When the system provides a version-4 UUID generator, use it.
606 if _uuid_generate_random:
Amaury Forgeot d'Arcb0c29162008-11-22 22:18:04 +0000607 _buffer = ctypes.create_string_buffer(16)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000608 _uuid_generate_random(_buffer)
Guido van Rossumfb56d8f2007-07-20 17:45:09 +0000609 return UUID(bytes=bytes_(_buffer.raw))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000610
611 # Otherwise, get randomness from urandom or the 'random' module.
612 try:
613 import os
614 return UUID(bytes=os.urandom(16), version=4)
615 except:
616 import random
Serhiy Storchakafa9be4f2014-09-06 22:14:04 +0300617 return UUID(int=random.getrandbits(128), version=4)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000618
619def uuid5(namespace, name):
620 """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000621 from hashlib import sha1
Guido van Rossum65b6a802007-07-09 14:03:08 +0000622 hash = sha1(namespace.bytes + bytes(name, "utf-8")).digest()
Guido van Rossum5ed033b2007-07-09 14:29:40 +0000623 return UUID(bytes=hash[:16], version=5)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000624
625# The following standard UUIDs are for use with uuid3() or uuid5().
626
627NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
628NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
629NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
630NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')