PHP функция для генерации v4 UUID

233

Поэтому я немного покопался и пытался собрать воедино функцию, которая генерирует действительный UUID v4 в PHP. Это самое близкое, что мне удалось приехать. Мои знания в шестнадцатеричном, десятичном, двоичном, побитовых операторах PHP и тому подобном практически не существуют. Эта функция генерирует действительный UUID v4 вплоть до одной области. UUID версии 4 должен иметь вид:

xxxxxxxx-xxxx- 4 xxx- y xxx-xxxxxxxxxxxx

где y равно 8, 9, A или B. Это то место, где функции не работают, так как он не придерживается этого.

Я надеялся, что кто-то, обладающий большими знаниями в этой области, чем я, сможет протянуть мне руку и помочь мне исправить эту функцию, чтобы она соответствовала этому правилу.

Функция выглядит следующим образом:

<?php

function gen_uuid() {
 $uuid = array(
  'time_low'  => 0,
  'time_mid'  => 0,
  'time_hi'  => 0,
  'clock_seq_hi' => 0,
  'clock_seq_low' => 0,
  'node'   => array()
 );

 $uuid['time_low'] = mt_rand(0, 0xffff) + (mt_rand(0, 0xffff) << 16);
 $uuid['time_mid'] = mt_rand(0, 0xffff);
 $uuid['time_hi'] = (4 << 12) | (mt_rand(0, 0x1000));
 $uuid['clock_seq_hi'] = (1 << 7) | (mt_rand(0, 128));
 $uuid['clock_seq_low'] = mt_rand(0, 255);

 for ($i = 0; $i < 6; $i++) {
  $uuid['node'][$i] = mt_rand(0, 255);
 }

 $uuid = sprintf('%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x',
  $uuid['time_low'],
  $uuid['time_mid'],
  $uuid['time_hi'],
  $uuid['clock_seq_hi'],
  $uuid['clock_seq_low'],
  $uuid['node'][0],
  $uuid['node'][1],
  $uuid['node'][2],
  $uuid['node'][3],
  $uuid['node'][4],
  $uuid['node'][5]
 );

 return $uuid;
}

?>

Спасибо всем, кто может мне помочь.

anomareh
источник
5
Если вы работаете в Linux и немного ленивы, вы можете их $newId = exec('uuidgen -r');
сгенерировать

Ответы:

282

Из этого комментария к руководству по PHP вы можете использовать это:

function gen_uuid() {
    return sprintf( '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
        // 32 bits for "time_low"
        mt_rand( 0, 0xffff ), mt_rand( 0, 0xffff ),

        // 16 bits for "time_mid"
        mt_rand( 0, 0xffff ),

        // 16 bits for "time_hi_and_version",
        // four most significant bits holds version number 4
        mt_rand( 0, 0x0fff ) | 0x4000,

        // 16 bits, 8 bits for "clk_seq_hi_res",
        // 8 bits for "clk_seq_low",
        // two most significant bits holds zero and one for variant DCE1.1
        mt_rand( 0, 0x3fff ) | 0x8000,

        // 48 bits for "node"
        mt_rand( 0, 0xffff ), mt_rand( 0, 0xffff ), mt_rand( 0, 0xffff )
    );
}
Уильям
источник
43
Эта функция будет создавать дубликаты, поэтому следует избегать его , когда вам нужно уникальные значения. Обратите внимание, что mt_rand () всегда будет генерировать одну и ту же последовательность случайных чисел с одинаковым начальным числом. Таким образом, каждый раз, когда начальное число повторяется, генерируется один и тот же точный UUID. Чтобы обойти это, вам нужно будет заполнить его, используя время и mac адрес, но я не уверен, как вы это сделаете, так как mt_srand () требует целое число.
Павле Предич
12
@PavlePredic mt_srand (crc32 (serialize ([microtime (true), 'USER_IP', 'ETC']))); (я другой вильям: P)
Вильям
13
Документы PHP явно предупреждают, что mt_rand () не генерирует криптографически безопасные значения. Другими словами, значения, генерируемые этой функцией, могут быть предсказуемыми. Если вам необходимо убедиться, что идентификаторы UUID непредсказуемы, лучше использовать приведенное ниже решение Джека, в котором используется функция openssl_random_pseudo_bytes ().
Ричард Келлер
7
какой смысл создавать UUID, если вы заполняете каждое поле мусором?
Eevee
1
PHP 7.0+ определяет функцию random_bytes (), которая всегда генерирует криптографически безопасные случайные байты или выдает исключение, если это невозможно. Это лучше, чем даже openssl_random_psuedo_bytes (), чей вывод иногда не криптографически безопасен при некоторых обстоятельствах.
Томасруттер
365

Вместо того, чтобы разбивать его на отдельные поля, проще создать случайный блок данных и изменить отдельные позиции байтов. Вам также следует использовать лучший генератор случайных чисел, чем mt_rand ().

В соответствии с RFC 4122 - раздел 4.4 вам необходимо изменить следующие поля:

  1. time_hi_and_version (биты 4-7 7-го октета),
  2. clock_seq_hi_and_reserved (биты 6 и 7 9-го октета)

Все остальные 122 бита должны быть достаточно случайными.

Следующий подход генерирует 128 битов случайных данных с использованием openssl_random_pseudo_bytes(), делает перестановки на октетах, а затем использует bin2hex()и vsprintf()для окончательного форматирования.

function guidv4($data)
{
    assert(strlen($data) == 16);

    $data[6] = chr(ord($data[6]) & 0x0f | 0x40); // set version to 0100
    $data[8] = chr(ord($data[8]) & 0x3f | 0x80); // set bits 6-7 to 10

    return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
}

echo guidv4(openssl_random_pseudo_bytes(16));

В PHP 7 генерировать случайные последовательности байтов еще проще, используя random_bytes():

function guidv4($data = null)
{
    $data = $data ?? random_bytes(16);
    // ...
}
Разъем
источник
9
Альтернатива для пользователей * nix, у которых нет расширения openssl:$data = file_get_contents('/dev/urandom', NULL, NULL, 0, 16);
Iiridayn
5
Кроме того, я бы доверял OpenSSL намного больше, чем mt_rand.
Профессор Фалькен
3
@BrunoAugusto это случайно, и крайне маловероятно (с хорошим случайным источником), чтобы получить дубликаты, но это хорошая практика для применения на уровне базы данных.
Яцк
9
Есть ли причина НЕ помещать вызов random_bytes (16) внутрь функции guidv4 и, следовательно, не передавать какой-либо параметр в guidv4?
Стивен Р
7
Небольшое улучшение: установите значение NULL по умолчанию для $ data, а затем первая строка функции выглядит так: $data = $data ?? random_bytes( 16 ); Теперь вы МОЖЕТЕ указать свой собственный источник случайных данных или позволить функции сделать это за вас. :-)
Стивен Р.
118

Любой, кто использует зависимости композитора , может захотеть рассмотреть эту библиотеку: https://github.com/ramsey/uuid

Это не становится легче, чем это:

Uuid::uuid4();
djule5
источник
32
О, я не знаю .... Пять строк кода против загрузки библиотеки с зависимостями? Я предпочитаю функцию Джека. YMMV
Стивен Р
7
+1 Стивену. Ramsey uuid обладает гораздо большей функциональностью, чем просто uuid4. Я не банан !, здесь у вас есть целые джунгли!
1
26
UUID - это не просто случайные строки. Есть спецификация, как это работает. Чтобы сгенерировать правильный случайный UUID, чтобы потом не волноваться о том, что его отвергнут, я бы предпочел использовать протестированную библиотеку, а не использовать собственную реализацию.
Брэндон
3
Это UUIDv4. Это (в основном, но на несколько бит) случайно. Это не криптография. Паранойя против "кататься самостоятельно" глупа.
Гордон
23

в системах Unix используйте системное ядро ​​для генерации UUID для вас.

file_get_contents('/proc/sys/kernel/random/uuid')

Кредит Samveen на https://serverfault.com/a/529319/210994

Примечание !: Использование этого метода для получения uuid действительно очень быстро истощает пул энтропии! Я бы не использовал это там, где это будет часто вызываться.

ThorSummoner
источник
2
Кроме переносимости, обратите внимание, что случайный источник - это то, /dev/randomчто блокирует, если пул энтропии исчерпан.
Ja͢ck
@ Джек. Не могли бы вы дать ссылку на документацию по теме исчерпания энтропийного пула в системах Unix, пожалуйста? Мне было бы интересно узнать больше о реалистичном случае использования, где этот метод ломается.
ThorSummoner
Мне не удалось найти информацию о создании этого специального источника файлов ядра /dev/urandom, который, по моему пониманию, не исчерпал бы, но рискует вернуть дубликаты uuids. Я думаю, это компромисс; вам действительно нужен уникальный идентификатор под влиянием энтропии системы?
ThorSummoner
13

В своем поиске создания vuuuid v4 я сначала пришел на эту страницу, а затем нашел ее на http://php.net/manual/en/function.com-create-guid.php

function guidv4()
{
    if (function_exists('com_create_guid') === true)
        return trim(com_create_guid(), '{}');

    $data = openssl_random_pseudo_bytes(16);
    $data[6] = chr(ord($data[6]) & 0x0f | 0x40); // set version to 0100
    $data[8] = chr(ord($data[8]) & 0x3f | 0x80); // set bits 6-7 to 10
    return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
}

кредит: павел.волинцев

Изменить: чтобы уточнить, эта функция всегда даст вам vuuid v4 (PHP> = 5.3.0).

Когда функция com_create_guid доступна (обычно только в Windows), она использует ее и удаляет фигурные скобки.

Если его нет (Linux), он обратится к этой сильной случайной функции openssl_random_pseudo_bytes, а затем использует vsprintf для форматирования в v4 uuid.

Арье
источник
5

Мой ответ основан на комментарии пользователя uniqid, но он использует функцию openssl_random_pseudo_bytes для генерации случайной строки вместо чтения из/dev/urandom

function guid()
{
    $randomString = openssl_random_pseudo_bytes(16);
    $time_low = bin2hex(substr($randomString, 0, 4));
    $time_mid = bin2hex(substr($randomString, 4, 2));
    $time_hi_and_version = bin2hex(substr($randomString, 6, 2));
    $clock_seq_hi_and_reserved = bin2hex(substr($randomString, 8, 2));
    $node = bin2hex(substr($randomString, 10, 6));

    /**
     * Set the four most significant bits (bits 12 through 15) of the
     * time_hi_and_version field to the 4-bit version number from
     * Section 4.1.3.
     * @see http://tools.ietf.org/html/rfc4122#section-4.1.3
    */
    $time_hi_and_version = hexdec($time_hi_and_version);
    $time_hi_and_version = $time_hi_and_version >> 4;
    $time_hi_and_version = $time_hi_and_version | 0x4000;

    /**
     * Set the two most significant bits (bits 6 and 7) of the
     * clock_seq_hi_and_reserved to zero and one, respectively.
     */
    $clock_seq_hi_and_reserved = hexdec($clock_seq_hi_and_reserved);
    $clock_seq_hi_and_reserved = $clock_seq_hi_and_reserved >> 2;
    $clock_seq_hi_and_reserved = $clock_seq_hi_and_reserved | 0x8000;

    return sprintf('%08s-%04s-%04x-%04x-%012s', $time_low, $time_mid, $time_hi_and_version, $clock_seq_hi_and_reserved, $node);
} // guid
Виктор Смирнов
источник
5

Если вы используете, CakePHPвы можете использовать их метод CakeText::uuid();из класса CakeText для генерации uuid RFC4122.

биш
источник
5

Небольшое изменение в ответе Джека о добавлении поддержки PHP <7:

// Get an RFC-4122 compliant globaly unique identifier
function get_guid() {
    $data = PHP_MAJOR_VERSION < 7 ? openssl_random_pseudo_bytes(16) : random_bytes(16);
    $data[6] = chr(ord($data[6]) & 0x0f | 0x40);    // Set version to 0100
    $data[8] = chr(ord($data[8]) & 0x3f | 0x80);    // Set bits 6-7 to 10
    return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
}
Дэнни Беккет
источник
4

Вдохновленный broofa ответ «s здесь .

preg_replace_callback('/[xy]/', function ($matches)
{
  return dechex('x' == $matches[0] ? mt_rand(0, 15) : (mt_rand(0, 15) & 0x3 | 0x8));
}
, 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx');

Или, если вы не можете использовать анонимные функции.

preg_replace_callback('/[xy]/', create_function(
  '$matches',
  'return dechex("x" == $matches[0] ? mt_rand(0, 15) : (mt_rand(0, 15) & 0x3 | 0x8));'
)
, 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx');
MichaelRushton
источник
1
Если вы посмотрите на комментарии в других ответах, вы увидите, что люди говорят, mt_rand()что не гарантируется случайность.
Даниэль Чунг
3

Я искал точно такую ​​же вещь и почти реализовал ее версию, я подумал, что стоит упомянуть, что, если вы делаете это в рамках WordPress , у WP есть своя супер-удобная функция именно для этого:

$myUUID = wp_generate_uuid4();

Вы можете прочитать описание и источник здесь .

indextwo
источник
1
Функция WP использует исключительно mt_rand. Так что может не хватить случайности
Герберт Питерс
@HerbertPeters Ты прав. Я только упомянул это, потому что это - одна строка. Я собирался сказать, что было бы неплохо, если бы они добавили фильтр для него, чтобы вы могли вернуть более безопасное / гарантированно-случайное число; но обратной стороной этого является то, что, если бы вы были так склонны, вы могли бы также вернуться falseinde
indextwo
2

Как насчет использования mysql для генерации uuid для вас?

$conn = new mysqli($servername, $username, $password, $dbname, $port);

$query = 'SELECT UUID()';
echo $conn->query($query)->fetch_row()[0];
Хоан Данг
источник
2
UUID()Функция MySQL создает vuuid.
staticsan
2
$uuid = vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex(random_bytes(16)), 4));
Кристиан Карраско
источник
2
Пожалуйста, добавьте объяснение к своему коду, чтобы помочь другим понять, что он делает.
KFoobar
это то, что на самом деле сделал Symfony polyfil - github.com/symfony/polyfill-uuid/blob/master/Uuid.php#L320
Сергей Полищук
1

От Тома, на http://www.php.net/manual/en/function.uniqid.php

$r = unpack('v*', fread(fopen('/dev/random', 'r'),16));
$uuid = sprintf('%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
    $r[1], $r[2], $r[3], $r[4] & 0x0fff | 0x4000,
    $r[5] & 0x3fff | 0x8000, $r[6], $r[7], $r[8])
amgine
источник
3
Что если они не работают под Unix или Linux / GNU? Этот код не будет работать.
Коул Джонсон
4
Это также может работать очень медленно, если / dev / random пусто и ожидает перезагрузки энтропии.
ObsidianX
1
/dev/urandomдолжно быть хорошо - /dev/randomследует использовать только для генерации долгосрочных криптографических ключей.
Iiridayn
Исходя из этого, я придумал это - он использует несколько возможных источников случайности в качестве mt_rand()запасного варианта и прибегает к посеву, если нет ничего более изощренного.
mindplay.dk
1
К настоящему времени, просто используйте random_bytes()в PHP 7 и все
mindplay.dk
1

Я уверен , что есть более элегантный способ сделать преобразование из двоичного в десятичное для 4xxxи yxxxчастей. Но если вы хотите использовать в openssl_random_pseudo_bytesкачестве генератора криптографически защищенных номеров, это то, что я использую:

return sprintf('%s-%s-%04x-%04x-%s',
    bin2hex(openssl_random_pseudo_bytes(4)),
    bin2hex(openssl_random_pseudo_bytes(2)),
    hexdec(bin2hex(openssl_random_pseudo_bytes(2))) & 0x0fff | 0x4000,
    hexdec(bin2hex(openssl_random_pseudo_bytes(2))) & 0x3fff | 0x8000,
    bin2hex(openssl_random_pseudo_bytes(6))
    );
Baracus
источник