Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1 | r"""UUID objects (universally unique identifiers) according to RFC 4122. |
| 2 | |
| 3 | This module provides immutable UUID objects (class UUID) and the functions |
| 4 | uuid1(), uuid3(), uuid4(), uuid5() for generating version 1, 3, 4, and 5 |
| 5 | UUIDs as specified in RFC 4122. |
| 6 | |
| 7 | If all you want is a unique ID, you should probably call uuid1() or uuid4(). |
| 8 | Note that uuid1() may compromise privacy since it creates a UUID containing |
| 9 | the computer's network address. uuid4() creates a random UUID. |
| 10 | |
| 11 | Typical usage: |
| 12 | |
| 13 | >>> import uuid |
| 14 | |
| 15 | # make a UUID based on the host ID and current time |
Georg Brandl | 1d523e1 | 2009-12-19 18:23:28 +0000 | [diff] [blame] | 16 | >>> uuid.uuid1() # doctest: +SKIP |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 17 | 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 Brandl | 1d523e1 | 2009-12-19 18:23:28 +0000 | [diff] [blame] | 24 | >>> uuid.uuid4() # doctest: +SKIP |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 25 | 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 Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 40 | b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f' |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 41 | |
| 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 Peterson | 788cb52 | 2015-10-29 20:38:04 -0700 | [diff] [blame] | 47 | import os |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 48 | import sys |
Benjamin Peterson | 788cb52 | 2015-10-29 20:38:04 -0700 | [diff] [blame] | 49 | |
Barry Warsaw | 8c130d7 | 2017-02-18 15:45:49 -0500 | [diff] [blame] | 50 | from enum import Enum |
| 51 | |
| 52 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 53 | __author__ = 'Ka-Ping Yee <ping@zesty.ca>' |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 54 | |
| 55 | RESERVED_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 Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 59 | int_ = int # The built-in int type |
| 60 | bytes_ = bytes # The built-in bytes type |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 61 | |
Barry Warsaw | 8c130d7 | 2017-02-18 15:45:49 -0500 | [diff] [blame] | 62 | |
| 63 | class SafeUUID(Enum): |
| 64 | safe = 0 |
| 65 | unsafe = -1 |
| 66 | unknown = None |
| 67 | |
| 68 | |
| 69 | class UUID: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 70 | """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 Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 74 | 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 81 | |
| 82 | UUIDs have these read-only attributes: |
| 83 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 84 | 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 89 | |
| 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 Warsaw | 8c130d7 | 2017-02-18 15:45:49 -0500 | [diff] [blame] | 115 | |
| 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 119 | """ |
| 120 | |
David H | f1d8e7c | 2019-01-17 13:16:51 +0100 | [diff] [blame] | 121 | __slots__ = ('int', 'is_safe', '__weakref__') |
Tal Einat | 3e2b29d | 2018-09-06 14:34:25 +0300 | [diff] [blame] | 122 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 123 | def __init__(self, hex=None, bytes=None, bytes_le=None, fields=None, |
Barry Warsaw | 8c130d7 | 2017-02-18 15:45:49 -0500 | [diff] [blame] | 124 | int=None, version=None, |
| 125 | *, is_safe=SafeUUID.unknown): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 126 | r"""Create a UUID from either a string of 32 hexadecimal digits, |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 127 | 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 129 | 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 Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 140 | UUID(bytes_le='\x78\x56\x34\x12\x34\x12\x78\x56' + |
| 141 | '\x12\x34\x56\x78\x12\x34\x56\x78') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 142 | UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678)) |
| 143 | UUID(int=0x12345678123456781234567812345678) |
| 144 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 145 | 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 Warsaw | 8c130d7 | 2017-02-18 15:45:49 -0500 | [diff] [blame] | 149 | |
| 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 153 | """ |
| 154 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 155 | if [hex, bytes, bytes_le, fields, int].count(None) != 4: |
Berker Peksag | d02eb8a | 2016-03-20 16:49:10 +0200 | [diff] [blame] | 156 | raise TypeError('one of the hex, bytes, bytes_le, fields, ' |
| 157 | 'or int arguments must be given') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 158 | 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 Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 163 | int = int_(hex, 16) |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 164 | if bytes_le is not None: |
| 165 | if len(bytes_le) != 16: |
| 166 | raise ValueError('bytes_le is not a 16-char string') |
Serhiy Storchaka | fa9be4f | 2014-09-06 22:14:04 +0300 | [diff] [blame] | 167 | 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 169 | if bytes is not None: |
| 170 | if len(bytes) != 16: |
| 171 | raise ValueError('bytes is not a 16-char string') |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 172 | assert isinstance(bytes, bytes_), repr(bytes) |
Philip Jenvey | 1221f6b | 2013-08-29 18:33:50 -0700 | [diff] [blame] | 173 | int = int_.from_bytes(bytes, byteorder='big') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 174 | 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 Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 179 | if not 0 <= time_low < 1<<32: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 180 | raise ValueError('field 1 out of range (need a 32-bit value)') |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 181 | if not 0 <= time_mid < 1<<16: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 182 | raise ValueError('field 2 out of range (need a 16-bit value)') |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 183 | if not 0 <= time_hi_version < 1<<16: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 184 | raise ValueError('field 3 out of range (need a 16-bit value)') |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 185 | if not 0 <= clock_seq_hi_variant < 1<<8: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 186 | raise ValueError('field 4 out of range (need an 8-bit value)') |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 187 | if not 0 <= clock_seq_low < 1<<8: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 188 | raise ValueError('field 5 out of range (need an 8-bit value)') |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 189 | if not 0 <= node < 1<<48: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 190 | raise ValueError('field 6 out of range (need a 48-bit value)') |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 191 | 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 Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 194 | if int is not None: |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 195 | if not 0 <= int < 1<<128: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 196 | 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 Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 201 | int &= ~(0xc000 << 48) |
| 202 | int |= 0x8000 << 48 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 203 | # Set the version number. |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 204 | int &= ~(0xf000 << 64) |
| 205 | int |= version << 76 |
Tal Einat | 3e2b29d | 2018-09-06 14:34:25 +0300 | [diff] [blame] | 206 | object.__setattr__(self, 'int', int) |
| 207 | object.__setattr__(self, 'is_safe', is_safe) |
| 208 | |
| 209 | def __getstate__(self): |
Tal Einat | 5475253 | 2018-09-10 16:11:04 +0300 | [diff] [blame] | 210 | d = {'int': self.int} |
| 211 | if self.is_safe != SafeUUID.unknown: |
| 212 | # is_safe is a SafeUUID instance. Return just its value, so that |
| 213 | # it can be un-pickled in older Python versions without SafeUUID. |
| 214 | d['is_safe'] = self.is_safe.value |
Tal Einat | 3e2b29d | 2018-09-06 14:34:25 +0300 | [diff] [blame] | 215 | return d |
| 216 | |
| 217 | def __setstate__(self, state): |
Tal Einat | 5475253 | 2018-09-10 16:11:04 +0300 | [diff] [blame] | 218 | object.__setattr__(self, 'int', state['int']) |
| 219 | # is_safe was added in 3.7; it is also omitted when it is "unknown" |
| 220 | object.__setattr__(self, 'is_safe', |
| 221 | SafeUUID(state['is_safe']) |
| 222 | if 'is_safe' in state else SafeUUID.unknown) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 223 | |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 224 | def __eq__(self, other): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 225 | if isinstance(other, UUID): |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 226 | return self.int == other.int |
| 227 | return NotImplemented |
| 228 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 229 | # Q. What's the value of being able to sort UUIDs? |
| 230 | # A. Use them as keys in a B-Tree or similar mapping. |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 231 | |
| 232 | def __lt__(self, other): |
| 233 | if isinstance(other, UUID): |
| 234 | return self.int < other.int |
| 235 | return NotImplemented |
| 236 | |
| 237 | def __gt__(self, other): |
| 238 | if isinstance(other, UUID): |
| 239 | return self.int > other.int |
| 240 | return NotImplemented |
| 241 | |
| 242 | def __le__(self, other): |
| 243 | if isinstance(other, UUID): |
| 244 | return self.int <= other.int |
| 245 | return NotImplemented |
| 246 | |
| 247 | def __ge__(self, other): |
| 248 | if isinstance(other, UUID): |
| 249 | return self.int >= other.int |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 250 | return NotImplemented |
| 251 | |
| 252 | def __hash__(self): |
| 253 | return hash(self.int) |
| 254 | |
| 255 | def __int__(self): |
| 256 | return self.int |
| 257 | |
| 258 | def __repr__(self): |
Serhiy Storchaka | 465e60e | 2014-07-25 23:36:00 +0300 | [diff] [blame] | 259 | return '%s(%r)' % (self.__class__.__name__, str(self)) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 260 | |
| 261 | def __setattr__(self, name, value): |
| 262 | raise TypeError('UUID objects are immutable') |
| 263 | |
| 264 | def __str__(self): |
| 265 | hex = '%032x' % self.int |
| 266 | return '%s-%s-%s-%s-%s' % ( |
| 267 | hex[:8], hex[8:12], hex[12:16], hex[16:20], hex[20:]) |
| 268 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 269 | @property |
| 270 | def bytes(self): |
Serhiy Storchaka | fa9be4f | 2014-09-06 22:14:04 +0300 | [diff] [blame] | 271 | return self.int.to_bytes(16, 'big') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 272 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 273 | @property |
| 274 | def bytes_le(self): |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 275 | bytes = self.bytes |
Serhiy Storchaka | fa9be4f | 2014-09-06 22:14:04 +0300 | [diff] [blame] | 276 | return (bytes[4-1::-1] + bytes[6-1:4-1:-1] + bytes[8-1:6-1:-1] + |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 277 | bytes[8:]) |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 278 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 279 | @property |
| 280 | def fields(self): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 281 | return (self.time_low, self.time_mid, self.time_hi_version, |
| 282 | self.clock_seq_hi_variant, self.clock_seq_low, self.node) |
| 283 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 284 | @property |
| 285 | def time_low(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 286 | return self.int >> 96 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 287 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 288 | @property |
| 289 | def time_mid(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 290 | return (self.int >> 80) & 0xffff |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 291 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 292 | @property |
| 293 | def time_hi_version(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 294 | return (self.int >> 64) & 0xffff |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 295 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 296 | @property |
| 297 | def clock_seq_hi_variant(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 298 | return (self.int >> 56) & 0xff |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 299 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 300 | @property |
| 301 | def clock_seq_low(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 302 | return (self.int >> 48) & 0xff |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 303 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 304 | @property |
| 305 | def time(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 306 | return (((self.time_hi_version & 0x0fff) << 48) | |
| 307 | (self.time_mid << 32) | self.time_low) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 308 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 309 | @property |
| 310 | def clock_seq(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 311 | return (((self.clock_seq_hi_variant & 0x3f) << 8) | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 312 | self.clock_seq_low) |
| 313 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 314 | @property |
| 315 | def node(self): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 316 | return self.int & 0xffffffffffff |
| 317 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 318 | @property |
| 319 | def hex(self): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 320 | return '%032x' % self.int |
| 321 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 322 | @property |
| 323 | def urn(self): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 324 | return 'urn:uuid:' + str(self) |
| 325 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 326 | @property |
| 327 | def variant(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 328 | if not self.int & (0x8000 << 48): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 329 | return RESERVED_NCS |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 330 | elif not self.int & (0x4000 << 48): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 331 | return RFC_4122 |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 332 | elif not self.int & (0x2000 << 48): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 333 | return RESERVED_MICROSOFT |
| 334 | else: |
| 335 | return RESERVED_FUTURE |
| 336 | |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 337 | @property |
| 338 | def version(self): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 339 | # The version bits are only meaningful for RFC 4122 UUIDs. |
| 340 | if self.variant == RFC_4122: |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 341 | return int((self.int >> 76) & 0xf) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 342 | |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 343 | def _popen(command, *args): |
Victor Stinner | b9d0199 | 2014-10-21 22:33:10 +0200 | [diff] [blame] | 344 | import os, shutil, subprocess |
R David Murray | 4be1e24 | 2013-12-17 21:13:16 -0500 | [diff] [blame] | 345 | executable = shutil.which(command) |
| 346 | if executable is None: |
| 347 | path = os.pathsep.join(('/sbin', '/usr/sbin')) |
| 348 | executable = shutil.which(command, path=path) |
| 349 | if executable is None: |
| 350 | return None |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 351 | # LC_ALL=C to ensure English output, stderr=DEVNULL to prevent output |
| 352 | # on stderr (Note: we don't have an example where the words we search |
| 353 | # for are actually localized, but in theory some system could do so.) |
| 354 | env = dict(os.environ) |
| 355 | env['LC_ALL'] = 'C' |
| 356 | proc = subprocess.Popen((executable,) + args, |
| 357 | stdout=subprocess.PIPE, |
| 358 | stderr=subprocess.DEVNULL, |
| 359 | env=env) |
| 360 | return proc |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 361 | |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 362 | # For MAC (a.k.a. IEEE 802, or EUI-48) addresses, the second least significant |
| 363 | # bit of the first octet signifies whether the MAC address is universally (0) |
| 364 | # or locally (1) administered. Network cards from hardware manufacturers will |
| 365 | # always be universally administered to guarantee global uniqueness of the MAC |
| 366 | # address, but any particular machine may have other interfaces which are |
| 367 | # locally administered. An example of the latter is the bridge interface to |
| 368 | # the Touch Bar on MacBook Pros. |
| 369 | # |
| 370 | # This bit works out to be the 42nd bit counting from 1 being the least |
| 371 | # significant, or 1<<41. We'll prefer universally administered MAC addresses |
| 372 | # over locally administered ones since the former are globally unique, but |
| 373 | # we'll return the first of the latter found if that's all the machine has. |
| 374 | # |
| 375 | # See https://en.wikipedia.org/wiki/MAC_address#Universal_vs._local |
| 376 | |
| 377 | def _is_universal(mac): |
| 378 | return not (mac & (1 << 41)) |
| 379 | |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 380 | def _find_mac(command, args, hw_identifiers, get_index): |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 381 | first_local_mac = None |
R David Murray | 4be1e24 | 2013-12-17 21:13:16 -0500 | [diff] [blame] | 382 | try: |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 383 | proc = _popen(command, *args.split()) |
| 384 | if not proc: |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 385 | return None |
Victor Stinner | b9d0199 | 2014-10-21 22:33:10 +0200 | [diff] [blame] | 386 | with proc: |
| 387 | for line in proc.stdout: |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 388 | words = line.lower().rstrip().split() |
R David Murray | 4be1e24 | 2013-12-17 21:13:16 -0500 | [diff] [blame] | 389 | for i in range(len(words)): |
| 390 | if words[i] in hw_identifiers: |
| 391 | try: |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 392 | word = words[get_index(i)] |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 393 | mac = int(word.replace(b':', b''), 16) |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 394 | if _is_universal(mac): |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 395 | return mac |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 396 | first_local_mac = first_local_mac or mac |
R David Murray | 4be1e24 | 2013-12-17 21:13:16 -0500 | [diff] [blame] | 397 | except (ValueError, IndexError): |
| 398 | # Virtual interfaces, such as those provided by |
| 399 | # VPNs, do not have a colon-delimited MAC address |
| 400 | # as expected, but a 16-byte HWAddr separated by |
| 401 | # dashes. These should be ignored in favor of a |
| 402 | # real MAC address |
| 403 | pass |
R David Murray | 0ce3e9d | 2013-12-17 21:14:41 -0500 | [diff] [blame] | 404 | except OSError: |
R David Murray | 4be1e24 | 2013-12-17 21:13:16 -0500 | [diff] [blame] | 405 | pass |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 406 | return first_local_mac or None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 407 | |
| 408 | def _ifconfig_getnode(): |
| 409 | """Get the hardware address on Unix by running ifconfig.""" |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 410 | # This works on Linux ('' or '-a'), Tru64 ('-av'), but not all Unixes. |
Serhiy Storchaka | ee1a9a2 | 2017-11-04 09:37:32 +0200 | [diff] [blame] | 411 | keywords = (b'hwaddr', b'ether', b'address:', b'lladdr') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 412 | for args in ('', '-a', '-av'): |
Serhiy Storchaka | ee1a9a2 | 2017-11-04 09:37:32 +0200 | [diff] [blame] | 413 | mac = _find_mac('ifconfig', args, keywords, lambda i: i+1) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 414 | if mac: |
| 415 | return mac |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 416 | return None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 417 | |
Serhiy Storchaka | ac4aa7b | 2014-11-30 20:39:04 +0200 | [diff] [blame] | 418 | def _ip_getnode(): |
| 419 | """Get the hardware address on Unix by running ip.""" |
| 420 | # This works on Linux with iproute2. |
xdegaye | 961dbe0 | 2017-12-07 12:59:13 +0100 | [diff] [blame] | 421 | mac = _find_mac('ip', 'link', [b'link/ether'], lambda i: i+1) |
Serhiy Storchaka | ac4aa7b | 2014-11-30 20:39:04 +0200 | [diff] [blame] | 422 | if mac: |
| 423 | return mac |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 424 | return None |
Serhiy Storchaka | ac4aa7b | 2014-11-30 20:39:04 +0200 | [diff] [blame] | 425 | |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 426 | def _arp_getnode(): |
| 427 | """Get the hardware address on Unix by running arp.""" |
| 428 | import os, socket |
Serhiy Storchaka | 525d5ae | 2014-11-21 21:55:39 +0200 | [diff] [blame] | 429 | try: |
| 430 | ip_addr = socket.gethostbyname(socket.gethostname()) |
| 431 | except OSError: |
| 432 | return None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 433 | |
| 434 | # Try getting the MAC addr from arp based on our IP address (Solaris). |
Serhiy Storchaka | ee1a9a2 | 2017-11-04 09:37:32 +0200 | [diff] [blame] | 435 | mac = _find_mac('arp', '-an', [os.fsencode(ip_addr)], lambda i: -1) |
| 436 | if mac: |
| 437 | return mac |
| 438 | |
| 439 | # This works on OpenBSD |
| 440 | mac = _find_mac('arp', '-an', [os.fsencode(ip_addr)], lambda i: i+1) |
| 441 | if mac: |
| 442 | return mac |
| 443 | |
| 444 | # This works on Linux, FreeBSD and NetBSD |
| 445 | mac = _find_mac('arp', '-an', [os.fsencode('(%s)' % ip_addr)], |
| 446 | lambda i: i+2) |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 447 | # Return None instead of 0. |
Serhiy Storchaka | ee1a9a2 | 2017-11-04 09:37:32 +0200 | [diff] [blame] | 448 | if mac: |
| 449 | return mac |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 450 | return None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 451 | |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 452 | def _lanscan_getnode(): |
| 453 | """Get the hardware address on Unix by running lanscan.""" |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 454 | # This might work on HP-UX. |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 455 | return _find_mac('lanscan', '-ai', [b'lan0'], lambda i: 0) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 456 | |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 457 | def _netstat_getnode(): |
| 458 | """Get the hardware address on Unix by running netstat.""" |
Benjamin Peterson | 0693063 | 2017-09-04 16:36:05 -0700 | [diff] [blame] | 459 | # This might work on AIX, Tru64 UNIX. |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 460 | first_local_mac = None |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 461 | try: |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 462 | proc = _popen('netstat', '-ia') |
| 463 | if not proc: |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 464 | return None |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 465 | with proc: |
| 466 | words = proc.stdout.readline().rstrip().split() |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 467 | try: |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 468 | i = words.index(b'Address') |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 469 | except ValueError: |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 470 | return None |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 471 | for line in proc.stdout: |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 472 | try: |
| 473 | words = line.rstrip().split() |
| 474 | word = words[i] |
Serhiy Storchaka | 57b9677 | 2014-11-07 12:23:30 +0200 | [diff] [blame] | 475 | if len(word) == 17 and word.count(b':') == 5: |
| 476 | mac = int(word.replace(b':', b''), 16) |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 477 | if _is_universal(mac): |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 478 | return mac |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 479 | first_local_mac = first_local_mac or mac |
Serhiy Storchaka | e66bb96 | 2014-11-07 12:19:40 +0200 | [diff] [blame] | 480 | except (ValueError, IndexError): |
| 481 | pass |
| 482 | except OSError: |
| 483 | pass |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 484 | return first_local_mac or None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 485 | |
| 486 | def _ipconfig_getnode(): |
| 487 | """Get the hardware address on Windows by running ipconfig.exe.""" |
Segev Finer | da6c3da | 2018-02-13 08:29:54 +0200 | [diff] [blame] | 488 | import os, re, subprocess |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 489 | first_local_mac = None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 490 | dirs = ['', r'c:\windows\system32', r'c:\winnt\system32'] |
| 491 | try: |
| 492 | import ctypes |
| 493 | buffer = ctypes.create_string_buffer(300) |
| 494 | ctypes.windll.kernel32.GetSystemDirectoryA(buffer, 300) |
| 495 | dirs.insert(0, buffer.value.decode('mbcs')) |
| 496 | except: |
| 497 | pass |
| 498 | for dir in dirs: |
| 499 | try: |
Segev Finer | da6c3da | 2018-02-13 08:29:54 +0200 | [diff] [blame] | 500 | proc = subprocess.Popen([os.path.join(dir, 'ipconfig'), '/all'], |
| 501 | stdout=subprocess.PIPE, |
| 502 | encoding="oem") |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 503 | except OSError: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 504 | continue |
Segev Finer | da6c3da | 2018-02-13 08:29:54 +0200 | [diff] [blame] | 505 | with proc: |
| 506 | for line in proc.stdout: |
Brian Curtin | 69cd87b | 2010-11-05 14:48:35 +0000 | [diff] [blame] | 507 | value = line.split(':')[-1].strip().lower() |
CtrlZvi | c66c342 | 2018-05-20 08:03:25 -0700 | [diff] [blame] | 508 | if re.fullmatch('(?:[0-9a-f][0-9a-f]-){5}[0-9a-f][0-9a-f]', value): |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 509 | mac = int(value.replace('-', ''), 16) |
| 510 | if _is_universal(mac): |
| 511 | return mac |
| 512 | first_local_mac = first_local_mac or mac |
| 513 | return first_local_mac or None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 514 | |
| 515 | def _netbios_getnode(): |
| 516 | """Get the hardware address on Windows using NetBIOS calls. |
| 517 | See http://support.microsoft.com/kb/118623 for details.""" |
| 518 | import win32wnet, netbios |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 519 | first_local_mac = None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 520 | ncb = netbios.NCB() |
| 521 | ncb.Command = netbios.NCBENUM |
| 522 | ncb.Buffer = adapters = netbios.LANA_ENUM() |
| 523 | adapters._pack() |
| 524 | if win32wnet.Netbios(ncb) != 0: |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 525 | return None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 526 | adapters._unpack() |
| 527 | for i in range(adapters.length): |
| 528 | ncb.Reset() |
| 529 | ncb.Command = netbios.NCBRESET |
| 530 | ncb.Lana_num = ord(adapters.lana[i]) |
| 531 | if win32wnet.Netbios(ncb) != 0: |
| 532 | continue |
| 533 | ncb.Reset() |
| 534 | ncb.Command = netbios.NCBASTAT |
| 535 | ncb.Lana_num = ord(adapters.lana[i]) |
| 536 | ncb.Callname = '*'.ljust(16) |
| 537 | ncb.Buffer = status = netbios.ADAPTER_STATUS() |
| 538 | if win32wnet.Netbios(ncb) != 0: |
| 539 | continue |
| 540 | status._unpack() |
Serhiy Storchaka | fa9be4f | 2014-09-06 22:14:04 +0300 | [diff] [blame] | 541 | bytes = status.adapter_address[:6] |
| 542 | if len(bytes) != 6: |
| 543 | continue |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 544 | mac = int.from_bytes(bytes, 'big') |
| 545 | if _is_universal(mac): |
| 546 | return mac |
| 547 | first_local_mac = first_local_mac or mac |
| 548 | return first_local_mac or None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 549 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 550 | |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 551 | _generate_time_safe = _UuidCreate = None |
| 552 | _has_uuid_generate_time_safe = None |
| 553 | |
| 554 | # Import optional C extension at toplevel, to help disabling it when testing |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 555 | try: |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 556 | import _uuid |
| 557 | except ImportError: |
| 558 | _uuid = None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 559 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 560 | |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 561 | def _load_system_functions(): |
| 562 | """ |
| 563 | Try to load platform-specific functions for generating uuids. |
| 564 | """ |
| 565 | global _generate_time_safe, _UuidCreate, _has_uuid_generate_time_safe |
Ronald Oussoren | ac764d3 | 2010-05-05 15:32:33 +0000 | [diff] [blame] | 566 | |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 567 | if _has_uuid_generate_time_safe is not None: |
| 568 | return |
| 569 | |
| 570 | _has_uuid_generate_time_safe = False |
| 571 | |
| 572 | if sys.platform == "darwin" and int(os.uname().release.split('.')[0]) < 9: |
| 573 | # The uuid_generate_* functions are broken on MacOS X 10.5, as noted |
| 574 | # in issue #8621 the function generates the same sequence of values |
| 575 | # in the parent process and all children created using fork (unless |
| 576 | # those children use exec as well). |
| 577 | # |
| 578 | # Assume that the uuid_generate functions are broken from 10.5 onward, |
| 579 | # the test can be adjusted when a later version is fixed. |
| 580 | pass |
| 581 | elif _uuid is not None: |
| 582 | _generate_time_safe = _uuid.generate_time_safe |
Victor Stinner | 4337a0d | 2017-10-02 07:57:59 -0700 | [diff] [blame] | 583 | _has_uuid_generate_time_safe = _uuid.has_uuid_generate_time_safe |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 584 | return |
| 585 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 586 | try: |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 587 | # If we couldn't find an extension module, try ctypes to find |
| 588 | # system routines for UUID generation. |
| 589 | # Thanks to Thomas Heller for ctypes and for his help with its use here. |
| 590 | import ctypes |
| 591 | import ctypes.util |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 592 | |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 593 | # The uuid_generate_* routines are provided by libuuid on at least |
| 594 | # Linux and FreeBSD, and provided by libc on Mac OS X. |
| 595 | _libnames = ['uuid'] |
| 596 | if not sys.platform.startswith('win'): |
| 597 | _libnames.append('c') |
| 598 | for libname in _libnames: |
| 599 | try: |
| 600 | lib = ctypes.CDLL(ctypes.util.find_library(libname)) |
| 601 | except Exception: # pragma: nocover |
| 602 | continue |
| 603 | # Try to find the safe variety first. |
| 604 | if hasattr(lib, 'uuid_generate_time_safe'): |
| 605 | _uuid_generate_time_safe = lib.uuid_generate_time_safe |
| 606 | # int uuid_generate_time_safe(uuid_t out); |
| 607 | def _generate_time_safe(): |
| 608 | _buffer = ctypes.create_string_buffer(16) |
| 609 | res = _uuid_generate_time_safe(_buffer) |
| 610 | return bytes(_buffer.raw), res |
| 611 | _has_uuid_generate_time_safe = True |
| 612 | break |
| 613 | |
| 614 | elif hasattr(lib, 'uuid_generate_time'): # pragma: nocover |
| 615 | _uuid_generate_time = lib.uuid_generate_time |
| 616 | # void uuid_generate_time(uuid_t out); |
| 617 | _uuid_generate_time.restype = None |
| 618 | def _generate_time_safe(): |
| 619 | _buffer = ctypes.create_string_buffer(16) |
| 620 | _uuid_generate_time(_buffer) |
| 621 | return bytes(_buffer.raw), None |
| 622 | break |
| 623 | |
| 624 | # On Windows prior to 2000, UuidCreate gives a UUID containing the |
| 625 | # hardware address. On Windows 2000 and later, UuidCreate makes a |
| 626 | # random UUID and UuidCreateSequential gives a UUID containing the |
| 627 | # hardware address. These routines are provided by the RPC runtime. |
| 628 | # NOTE: at least on Tim's WinXP Pro SP2 desktop box, while the last |
| 629 | # 6 bytes returned by UuidCreateSequential are fixed, they don't appear |
| 630 | # to bear any relationship to the MAC address of any network device |
| 631 | # on the box. |
| 632 | try: |
| 633 | lib = ctypes.windll.rpcrt4 |
| 634 | except: |
| 635 | lib = None |
| 636 | _UuidCreate = getattr(lib, 'UuidCreateSequential', |
| 637 | getattr(lib, 'UuidCreate', None)) |
| 638 | |
| 639 | except Exception as exc: |
| 640 | import warnings |
| 641 | warnings.warn(f"Could not find fallback ctypes uuid functions: {exc}", |
| 642 | ImportWarning) |
| 643 | |
| 644 | |
| 645 | def _unix_getnode(): |
| 646 | """Get the hardware address on Unix using the _uuid extension module |
| 647 | or ctypes.""" |
| 648 | _load_system_functions() |
| 649 | uuid_time, _ = _generate_time_safe() |
| 650 | return UUID(bytes=uuid_time).node |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 651 | |
| 652 | def _windll_getnode(): |
| 653 | """Get the hardware address on Windows using ctypes.""" |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 654 | import ctypes |
| 655 | _load_system_functions() |
Guido van Rossum | 37410aa | 2007-08-24 04:13:42 +0000 | [diff] [blame] | 656 | _buffer = ctypes.create_string_buffer(16) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 657 | if _UuidCreate(_buffer) == 0: |
Guido van Rossum | fb56d8f | 2007-07-20 17:45:09 +0000 | [diff] [blame] | 658 | return UUID(bytes=bytes_(_buffer.raw)).node |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 659 | |
| 660 | def _random_getnode(): |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 661 | """Get a random node ID.""" |
| 662 | # RFC 4122, $4.1.6 says "For systems with no IEEE address, a randomly or |
| 663 | # pseudo-randomly generated value may be used; see Section 4.5. The |
| 664 | # multicast bit must be set in such addresses, in order that they will |
| 665 | # never conflict with addresses obtained from network cards." |
| 666 | # |
| 667 | # The "multicast bit" of a MAC address is defined to be "the least |
| 668 | # significant bit of the first octet". This works out to be the 41st bit |
| 669 | # counting from 1 being the least significant bit, or 1<<40. |
| 670 | # |
| 671 | # See https://en.wikipedia.org/wiki/MAC_address#Unicast_vs._multicast |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 672 | import random |
Barry Warsaw | 23df2d1 | 2017-11-28 17:26:04 -0500 | [diff] [blame] | 673 | return random.getrandbits(48) | (1 << 40) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 674 | |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 675 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 676 | _node = None |
| 677 | |
Bo Bayles | 6b273f7 | 2018-01-23 19:11:44 -0600 | [diff] [blame] | 678 | _NODE_GETTERS_WIN32 = [_windll_getnode, _netbios_getnode, _ipconfig_getnode] |
| 679 | |
| 680 | _NODE_GETTERS_UNIX = [_unix_getnode, _ifconfig_getnode, _ip_getnode, |
| 681 | _arp_getnode, _lanscan_getnode, _netstat_getnode] |
| 682 | |
| 683 | def getnode(*, getters=None): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 684 | """Get the hardware address as a 48-bit positive integer. |
| 685 | |
| 686 | The first time this runs, it may launch a separate program, which could |
| 687 | be quite slow. If all attempts to obtain the hardware address fail, we |
| 688 | choose a random 48-bit number with its eighth bit set to 1 as recommended |
| 689 | in RFC 4122. |
| 690 | """ |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 691 | global _node |
| 692 | if _node is not None: |
| 693 | return _node |
| 694 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 695 | if sys.platform == 'win32': |
Bo Bayles | 6b273f7 | 2018-01-23 19:11:44 -0600 | [diff] [blame] | 696 | getters = _NODE_GETTERS_WIN32 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 697 | else: |
Bo Bayles | 6b273f7 | 2018-01-23 19:11:44 -0600 | [diff] [blame] | 698 | getters = _NODE_GETTERS_UNIX |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 699 | |
Serhiy Storchaka | e69fbb6 | 2017-12-04 11:51:55 +0200 | [diff] [blame] | 700 | for getter in getters + [_random_getnode]: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 701 | try: |
| 702 | _node = getter() |
| 703 | except: |
| 704 | continue |
Bo Bayles | 6b273f7 | 2018-01-23 19:11:44 -0600 | [diff] [blame] | 705 | if (_node is not None) and (0 <= _node < (1 << 48)): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 706 | return _node |
Bo Bayles | 6b273f7 | 2018-01-23 19:11:44 -0600 | [diff] [blame] | 707 | assert False, '_random_getnode() returned invalid value: {}'.format(_node) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 708 | |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 709 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 710 | _last_timestamp = None |
| 711 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 712 | def uuid1(node=None, clock_seq=None): |
| 713 | """Generate a UUID from a host ID, sequence number, and the current time. |
| 714 | If 'node' is not given, getnode() is used to obtain the hardware |
| 715 | address. If 'clock_seq' is given, it is used as the sequence number; |
| 716 | otherwise a random 14-bit sequence number is chosen.""" |
| 717 | |
| 718 | # When the system provides a version-1 UUID generator, use it (but don't |
| 719 | # use UuidCreate here because its UUIDs don't conform to RFC 4122). |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 720 | _load_system_functions() |
| 721 | if _generate_time_safe is not None and node is clock_seq is None: |
| 722 | uuid_time, safely_generated = _generate_time_safe() |
Barry Warsaw | 8c130d7 | 2017-02-18 15:45:49 -0500 | [diff] [blame] | 723 | try: |
| 724 | is_safe = SafeUUID(safely_generated) |
| 725 | except ValueError: |
| 726 | is_safe = SafeUUID.unknown |
Antoine Pitrou | a106aec | 2017-09-28 23:03:06 +0200 | [diff] [blame] | 727 | return UUID(bytes=uuid_time, is_safe=is_safe) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 728 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 729 | global _last_timestamp |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 730 | import time |
Victor Stinner | 62a68b7 | 2018-12-18 11:45:13 +0100 | [diff] [blame] | 731 | nanoseconds = time.time_ns() |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 732 | # 0x01b21dd213814000 is the number of 100-ns intervals between the |
| 733 | # UUID epoch 1582-10-15 00:00:00 and the Unix epoch 1970-01-01 00:00:00. |
Victor Stinner | 62a68b7 | 2018-12-18 11:45:13 +0100 | [diff] [blame] | 734 | timestamp = nanoseconds // 100 + 0x01b21dd213814000 |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 735 | if _last_timestamp is not None and timestamp <= _last_timestamp: |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 736 | timestamp = _last_timestamp + 1 |
| 737 | _last_timestamp = timestamp |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 738 | if clock_seq is None: |
| 739 | import random |
Serhiy Storchaka | fa9be4f | 2014-09-06 22:14:04 +0300 | [diff] [blame] | 740 | clock_seq = random.getrandbits(14) # instead of stable storage |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 741 | time_low = timestamp & 0xffffffff |
| 742 | time_mid = (timestamp >> 32) & 0xffff |
| 743 | time_hi_version = (timestamp >> 48) & 0x0fff |
| 744 | clock_seq_low = clock_seq & 0xff |
| 745 | clock_seq_hi_variant = (clock_seq >> 8) & 0x3f |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 746 | if node is None: |
| 747 | node = getnode() |
| 748 | return UUID(fields=(time_low, time_mid, time_hi_version, |
| 749 | clock_seq_hi_variant, clock_seq_low, node), version=1) |
| 750 | |
| 751 | def uuid3(namespace, name): |
| 752 | """Generate a UUID from the MD5 hash of a namespace UUID and a name.""" |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 753 | from hashlib import md5 |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 754 | hash = md5(namespace.bytes + bytes(name, "utf-8")).digest() |
Guido van Rossum | 5ed033b | 2007-07-09 14:29:40 +0000 | [diff] [blame] | 755 | return UUID(bytes=hash[:16], version=3) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 756 | |
| 757 | def uuid4(): |
| 758 | """Generate a random UUID.""" |
Benjamin Peterson | 788cb52 | 2015-10-29 20:38:04 -0700 | [diff] [blame] | 759 | return UUID(bytes=os.urandom(16), version=4) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 760 | |
| 761 | def uuid5(namespace, name): |
| 762 | """Generate a UUID from the SHA-1 hash of a namespace UUID and a name.""" |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 763 | from hashlib import sha1 |
Guido van Rossum | 65b6a80 | 2007-07-09 14:03:08 +0000 | [diff] [blame] | 764 | hash = sha1(namespace.bytes + bytes(name, "utf-8")).digest() |
Guido van Rossum | 5ed033b | 2007-07-09 14:29:40 +0000 | [diff] [blame] | 765 | return UUID(bytes=hash[:16], version=5) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 766 | |
| 767 | # The following standard UUIDs are for use with uuid3() or uuid5(). |
| 768 | |
| 769 | NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8') |
| 770 | NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8') |
| 771 | NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8') |
| 772 | NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8') |