UuidV6.php 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Uid;
  11. use Symfony\Component\Uid\Exception\InvalidArgumentException;
  12. /**
  13. * A v6 UUID is lexicographically sortable and contains a 60-bit timestamp and 62 extra unique bits.
  14. *
  15. * Unlike UUIDv1, this implementation of UUIDv6 doesn't leak the MAC address of the host.
  16. *
  17. * @author Nicolas Grekas <p@tchwork.com>
  18. */
  19. class UuidV6 extends Uuid implements TimeBasedUidInterface
  20. {
  21. protected const TYPE = 6;
  22. private static string $node;
  23. public function __construct(?string $uuid = null)
  24. {
  25. if (null === $uuid) {
  26. $this->uid = static::generate();
  27. } else {
  28. parent::__construct($uuid, true);
  29. }
  30. }
  31. public function getDateTime(): \DateTimeImmutable
  32. {
  33. return BinaryUtil::hexToDateTime('0'.substr($this->uid, 0, 8).substr($this->uid, 9, 4).substr($this->uid, 15, 3));
  34. }
  35. public function getNode(): string
  36. {
  37. return substr($this->uid, 24);
  38. }
  39. public function toV7(): UuidV7
  40. {
  41. $uuid = $this->uid;
  42. $time = BinaryUtil::hexToNumericString('0'.substr($uuid, 0, 8).substr($uuid, 9, 4).substr($uuid, 15, 3));
  43. if ('-' === $time[0]) {
  44. throw new InvalidArgumentException('Cannot convert UUID to v7: its timestamp is before the Unix epoch.');
  45. }
  46. $ms = \strlen($time) > 4 ? substr($time, 0, -4) : '0';
  47. $time = dechex(10000 * hexdec(substr($uuid, 20, 3)) + substr($time, -4));
  48. if (\strlen($time) > 6) {
  49. $uuid[29] = dechex(hexdec($uuid[29]) ^ hexdec($time[0]));
  50. $time = substr($time, 1);
  51. }
  52. return new UuidV7(substr_replace(\sprintf(
  53. '%012s-7%s-%s%s-%s%06s',
  54. \PHP_INT_SIZE >= 8 ? dechex($ms) : bin2hex(BinaryUtil::fromBase($ms, BinaryUtil::BASE10)),
  55. substr($uuid, -6, 3),
  56. $uuid[19],
  57. substr($uuid, -3),
  58. substr($uuid, -12, 6),
  59. $time
  60. ), '-', 8, 0));
  61. }
  62. public static function generate(?\DateTimeInterface $time = null, ?Uuid $node = null): string
  63. {
  64. $uuidV1 = UuidV1::generate($time, $node);
  65. $uuid = substr($uuidV1, 15, 3).substr($uuidV1, 9, 4).$uuidV1[0].'-'.substr($uuidV1, 1, 4).'-6'.substr($uuidV1, 5, 3).substr($uuidV1, 18, 6);
  66. if ($node) {
  67. return $uuid.substr($uuidV1, 24);
  68. }
  69. // uuid_create() returns a stable "node" that can leak the MAC of the host, but
  70. // UUIDv6 prefers a truly random number here, let's XOR both to preserve the entropy
  71. if (!isset(self::$node)) {
  72. $seed = [random_int(0, 0xFFFFFF), random_int(0, 0xFFFFFF)];
  73. $node = unpack('N2', hex2bin('00'.substr($uuidV1, 24, 6)).hex2bin('00'.substr($uuidV1, 30)));
  74. self::$node = \sprintf('%06x%06x', ($seed[0] ^ $node[1]) | 0x010000, $seed[1] ^ $node[2]);
  75. }
  76. return $uuid.self::$node;
  77. }
  78. }