UuidV6.php 3.0 KB

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