Subversion Repositories uuid_mac_utils

<?php

/*

 * UUID utils for PHP

 * Copyright 2011 - 2023 Daniel Marschall, ViaThinkSoft

 * Version 2023-07-11

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

# This library requires either the GMP extension (or BCMath if gmp_supplement.inc.php is present)

if (file_exists(__DIR__ . '/mac_utils.inc.phps')) include_once __DIR__ . '/mac_utils.inc.phps'; // optionally used for uuid_info()

if (file_exists(__DIR__ . '/gmp_supplement.inc.php')) include_once __DIR__ . '/gmp_supplement.inc.php';

define('UUID_NAMEBASED_NS_DNS',     '6ba7b810-9dad-11d1-80b4-00c04fd430c8'); // FQDN

define('UUID_NAMEBASED_NS_URL',     '6ba7b811-9dad-11d1-80b4-00c04fd430c8');

define('UUID_NAMEBASED_NS_OID',     '6ba7b812-9dad-11d1-80b4-00c04fd430c8');

define('UUID_NAMEBASED_NS_X500_DN', '6ba7b814-9dad-11d1-80b4-00c04fd430c8'); // DER according to https://github.com/cjsv/uuid/blob/master/Doc ?!

function _random_int($min, $max) {

        // This function tries a CSRNG and falls back to a RNG if no CSRNG is available

        try {

                return random_int($min, $max);

        } catch (Exception $e) {

                return mt_rand($min, $max);

        }

}

function uuid_valid($uuid) {

        $uuid = str_replace(array('-', '{', '}'), '', $uuid);

        $uuid = strtoupper($uuid);

        #$uuid = trim($uuid);

        if (strlen($uuid) != 32) return false;

        $uuid = preg_replace('@[0-9A-F]@', '', $uuid);

        return ($uuid == '');

}

function uuid_info($uuid, $echo=true) {

        if (!uuid_valid($uuid)) return false;

        if (!$echo) ob_start();

        #$uuid = trim($uuid);

        # $uuid = str_replace(array('-', '{', '}'), '', $uuid);

        $uuid = strtoupper($uuid);

        $uuid = preg_replace('@[^0-9A-F]@', '', $uuid);

        $x = hexdec(substr($uuid, 16, 1));

             if ($x >= 14 /* 0b1110 */) $variant = 3;

        else if ($x >= 12 /* 0b110_ */) $variant = 2;

        else if ($x >=  8 /* 0b10__ */) $variant = 1;

        else if ($x >=  0 /* 0b0___ */) $variant = 0;

        else $variant = -1; // should not happen

        switch ($variant) {

                case 0:

                        echo sprintf("%-32s %s\n", "Variant:", "[0b0__] NCS (reserved for backward compatibility)");

                        /*

                         * Internal structure of variant #0 UUIDs

                         *

                         * The first 6 octets are the number of 4 usec units of time that have

                         * passed since 1/1/80 0000 GMT.  The next 2 octets are reserved for

                         * future use.  The next octet is an address family.  The next 7 octets

                         * are a host ID in the form allowed by the specified address family.

                         *

                         * Note that while the family field (octet 8) was originally conceived

                         * of as being able to hold values in the range [0..255], only [0..13]

                         * were ever used.  Thus, the 2 MSB of this field are always 0 and are

                         * used to distinguish old and current UUID forms.

                         */

                        /*

                        Variant 0 UUID

                        - 32 bit High Time

                        - 16 bit Low Time

                        - 16 bit Reserved

                        -  1 bit Variant (fix 0b0___)

                        -  7 bit Family

                        - 56 bit Node

                        */

                        // Example of an UUID: 333a2276-0000-0000-0d00-00809c000000

                        # see also some notes at See https://github.com/cjsv/uuid/blob/master/Doc

                        // TODO: Make a generator for variant 0 UUIDs!

                        # Timestamp: Count of 4us intervals since 01 Jan 1980 00:00:00 GMT

                        # 1/0,000004 = 250000

                        # Seconds between 1970 and 1980 : 315532800

                        # 250000*315532800=78883200000000

                        $timestamp = substr($uuid, 0, 12);

                        $ts = gmp_init($timestamp, 16);

                        $ts = gmp_add($ts, gmp_init("78883200000000"));

                        $ms = gmp_mod($ts, gmp_init("250000"));

                        $ts = gmp_div($ts, gmp_init("250000"));

                        $ts = gmp_strval($ts);

                        $ms = gmp_strval($ms);

                        $ts = gmdate('Y-m-d H:i:s', intval($ts))."'".str_pad($ms, 7, '0', STR_PAD_LEFT).' GMT';

                        echo sprintf("%-32s %s\n", "Timestamp:", "[0x$timestamp] $ts");

                        $reserved = substr($uuid, 12, 4);

                        echo sprintf("%-32s %s\n", "Reserved:", "[0x$reserved]");

                        $family_hex = substr($uuid, 16, 2);

                        $family_dec = hexdec($family_hex);

                        $nodeid_hex = substr($uuid, 18, 14);

                        $nodeid_dec = hexdec($nodeid_hex);

                        if ($family_dec == 2) {

                                $family_ = 'IP';

                                // https://www.ibm.com/docs/en/aix/7.1?topic=u-uuid-gen-command-ncs (AIX 7.1) shows the following example output for /etc/ncs/uuid_gen -P

                                // := [

                                //    time_high := 16#458487df,

                                //    time_low := 16#9fb2,

                                //    reserved := 16#000,

                                //    family := chr(16#02),

                                //    host := [chr(16#c0), chr(16#64), chr(16#02), chr(16#03),

                                //             chr(16#00), chr(16#00), chr(16#00)]

                                //    ]

                                // This means that the IP address is 32 bits hex, and 32 bits are unused

                                $nodeid_desc = hexdec(substr($nodeid_hex,0,2)).'.'.

                                               hexdec(substr($nodeid_hex,2,2)).'.'.

                                               hexdec(substr($nodeid_hex,4,2)).'.'.

                                               hexdec(substr($nodeid_hex,6,2));

                                $rest = substr($nodeid_hex,8,6);

                                if ($rest != '000000') $nodeid_desc .= " + unexpected rest 0x$rest";

                        } else if ($family_dec == 13) {

                                $family_ = 'DDS (Data Link)';

                                // https://www.ibm.com/docs/en/aix/7.1?topic=u-uuid-gen-command-ncs (AIX 7.1) shows the following example output for /etc/ncs/uuid_gen -C

                                // = { 0x34dc23af,

                                //    0xf000,

                                //    0x0000,

                                //    0x0d,

                                //    {0x00, 0x00, 0x7c, 0x5f, 0x00, 0x00, 0x00} };

                                // https://github.com/cjsv/uuid/blob/master/Doc writes:

                                //    "Family 13 (dds) looks like node is 00 | nnnnnn 000000."

                                $nodeid_desc = '';

                                $start = substr($nodeid_hex,0,2);

                                if ($start != '00') $nodeid_desc .= "unexpected start 0x$start + ";

                                $nodeid_desc .= ($nodeid_dec >> 24) & 0xFFFFFF;

                                $rest = substr($nodeid_hex,8,6);

                                if ($rest != '000000') $nodeid_desc .= " + unexpected rest 0x$rest";

                        } else {

                                $family_ = "Unknown (Family $family_dec)"; # There are probably no more families

                                $nodeid_desc = 'Unknown';

                        }

                        echo sprintf("%-32s %s\n", "Family:", "[0x$family_hex = $family_dec] $family_");

                        echo sprintf("%-32s %s\n", "Node ID:", "[0x$nodeid_hex] $nodeid_desc");

                        break;

                case 1:

                        echo sprintf("%-32s %s\n", "Variant:", "[0b10_] RFC 4122 (Leach-Mealling-Salz) / DCE 1.1");

                        $version = hexdec(substr($uuid, 12, 1));

                        switch ($version) {

                                case 1:

                                        /*

                                        Variant 1, Version 1 UUID

                                        - 32 bit Low Time

                                        - 16 bit Mid Time

                                        -  4 bit Version (fix 0x1)

                                        - 12 bit High Time

                                        -  2 bit Variant (fix 0b10)

                                        -  6 bit Clock Seq High

                                        -  8 bit Clock Seq Low

                                        - 48 bit MAC Address

                                        */

                                        echo sprintf("%-32s %s\n", "Version:", "[1] Time-based with unique random host identifier");

                                        # Timestamp: Count of 100ns intervals since 15 Oct 1582 00:00:00

                                        # 1/0,0000001 = 10000000

                                        $timestamp = substr($uuid, 13, 3).substr($uuid, 8, 4).substr($uuid, 0, 8);

                                        $ts = gmp_init($timestamp, 16);

                                        $ts = gmp_sub($ts, gmp_init("122192928000000000"));

                                        $ms = gmp_mod($ts, gmp_init("10000000"));

                                        $ts = gmp_div($ts, gmp_init("10000000"));

                                        $ts = gmp_strval($ts);

                                        $ms = gmp_strval($ms);

                                        $ts = gmdate('Y-m-d H:i:s', intval($ts))."'".str_pad($ms, 7, '0', STR_PAD_LEFT).' GMT';

                                        echo sprintf("%-32s %s\n", "Timestamp:", "[0x$timestamp] $ts");

                                        $x = hexdec(substr($uuid, 16, 4));

                                        $dec = $x & 0x3FFF; // The highest 2 bits are used by "variant" (10x)

                                        $hex = substr($uuid, 16, 4);

                                        echo sprintf("%-32s %s\n", "Clock ID:", "[0x$hex] $dec");

                                        $x = substr($uuid, 20, 12);

                                        $nodeid = '';

                                        for ($i=0; $i<6; $i++) {

                                                $nodeid .= substr($x, $i*2, 2);

                                                if ($i != 5) $nodeid .= '-';

                                        }

                                        echo sprintf("%-32s %s\n", "Node ID:", "[0x$x] $nodeid");

                                        if (function_exists('decode_mac')) {

                                                echo "\nIn case that this Node ID is a MAC address, here is the interpretation of that MAC address:\n\n";

                                                decode_mac($nodeid);

                                        }

                                        break;

                                case 2:

                                        /*

                                        Variant 1, Version 2 UUID

                                        - 32 bit Local Domain Number

                                        - 16 bit Mid Time

                                        -  4 bit Version (fix 0x2)

                                        - 12 bit High Time

                                        -  2 bit Variant (fix 0b10)

                                        -  6 bit Clock Seq

                                        -  8 bit Local Domain

                                        - 48 bit MAC Address

                                        */

                                        // see also https://unicorn-utterances.com/posts/what-happened-to-uuid-v2

                                        echo sprintf("%-32s %s\n", "Version:", "[2] DCE Security version");

                                        # The clock_seq_low field (which represents an integer in the range [0, 28-1]) is interpreted as a local domain (as represented by sec_rgy_domain_t; see sec_rgy_domain_t ); that is, an identifier domain meaningful to the local host. (Note that the data type sec_rgy_domain_t can potentially hold values outside the range [0, 28-1]; however, the only values currently registered are in the range [0, 2], so this type mismatch is not significant.) In the particular case of a POSIX host, the value sec_rgy_domain_person is to be interpreted as the "POSIX UID domain", and the value sec_rgy_domain_group is to be interpreted as the "POSIX GID domain".

                                        $x = substr($uuid, 18, 2);

                                        if ($x == '00') $domain_info = 'Person (POSIX: User-ID)';

                                        else if ($x == '01') $domain_info = 'Group (POSIX: Group-ID)';

                                        else if ($x == '02') $domain_info = 'Organization';

                                        else $domain_info = 'site-defined (Domain '.hexdec($x).')';

                                        echo sprintf("%-32s %s\n", "Local Domain:", "[0x$x] $domain_info");

                                        # The time_low field (which represents an integer in the range [0, 232-1]) is interpreted as a local-ID; that is, an identifier (within the domain specified by clock_seq_low) meaningful to the local host. In the particular case of a POSIX host, when combined with a POSIX UID or POSIX GID domain in the clock_seq_low field (above), the time_low field represents a POSIX UID or POSIX GID, respectively.

                                        $x = substr($uuid, 0, 8);

                                        echo sprintf("%-32s %s\n", "Local Domain Number:", "[0x$x]");

                                        # Timestamp: Count of 100ns intervals since 15 Oct 1582 00:00:00

                                        # 1/0,0000001 = 10000000

                                        $timestamp = substr($uuid, 13, 3).substr($uuid, 8, 4).'00000000';

                                        $ts = gmp_init($timestamp, 16);

                                        $ts = gmp_sub($ts, gmp_init("122192928000000000"));

                                        $ms = gmp_mod($ts, gmp_init("10000000"));

                                        $ts = gmp_div($ts, gmp_init("10000000"));

                                        $ts = gmp_strval($ts);

                                        $ms = gmp_strval($ms);

                                        $ts_min = gmdate('Y-m-d H:i:s', intval($ts))."'".str_pad($ms, 7, '0', STR_PAD_LEFT).' GMT';

                                        $timestamp = substr($uuid, 13, 3).substr($uuid, 8, 4).'FFFFFFFF';

                                        $ts = gmp_init($timestamp, 16);

                                        $ts = gmp_sub($ts, gmp_init("122192928000000000"));

                                        $ms = gmp_mod($ts, gmp_init("10000000"));

                                        $ts = gmp_div($ts, gmp_init("10000000"));

                                        $ts = gmp_strval($ts);

                                        $ms = gmp_strval($ms);

                                        $ts_max = gmdate('Y-m-d H:i:s', intval($ts))."'".str_pad($ms, 7, '0', STR_PAD_LEFT).' GMT';

                                        $timestamp = substr($uuid, 13, 3).substr($uuid, 8, 4).'xxxxxxxx';

                                        echo sprintf("%-32s %s\n", "Timestamp:", "[0x$timestamp] $ts_min - $ts_max");

                                        $x = hexdec(substr($uuid, 16, 2));

                                        $dec = $x & 0x3F; // The highest 2 bits are used by "variant" (10xx)

                                        $hex = substr($uuid, 16, 2);

                                        echo sprintf("%-32s %s\n", "Clock ID:", "[0x$hex] $dec");

                                        $x = substr($uuid, 20, 12);

                                        $nodeid = '';

                                        for ($i=0; $i<6; $i++) {

                                                $nodeid .= substr($x, $i*2, 2);

                                                if ($i != 5) $nodeid .= '-';

                                        }

                                        echo sprintf("%-32s %s\n", "Node ID:", "[0x$x] $nodeid");

                                        if (function_exists('decode_mac')) {

                                                echo "\nIn case that this Node ID is a MAC address, here is the interpretation of that MAC address:\n\n";

                                                decode_mac($nodeid);

                                        }

                                        break;

                                case 3:

                                        /*

                                        Variant 1, Version 3 UUID

                                        - 48 bit Hash High

                                        -  4 bit Version (fix 0x2)

                                        - 12 bit Hash Mid

                                        -  2 bit Variant (fix 0b10)

                                        - 62 bit Hash Low

                                        */

                                        echo sprintf("%-32s %s\n", "Version:", "[3] Name-based (MD5 hash)");

                                        $hash = str_replace('-', '', strtolower($uuid));

                                        $hash[12] = '?'; // was overwritten by version

                                        $var16a = dechex((hexdec($hash[16])&3) + 0x0/*00__*/);

                                        $var16b = dechex((hexdec($hash[16])&3) + 0x4/*01__*/);

                                        $var16c = dechex((hexdec($hash[16])&3) + 0x8/*10__*/);

                                        $var16d = dechex((hexdec($hash[16])&3) + 0xC/*11__*/);

                                        $hash[16] = '?'; // was partially overwritten by variant

                                        echo sprintf("%-32s %s\n", "MD5(Namespace+Subject):", "[0x$hash]");

                                        echo sprintf("%-32s %s\n", "", "                   ^");

                                        echo sprintf("%-32s %s\n", "", "                   $var16a, $var16b, $var16c, or $var16d");

                                        break;

                                case 4:

                                        /*

                                        Variant 1, Version 4 UUID

                                        - 48 bit Random High

                                        -  4 bit Version (fix 0x2)

                                        - 12 bit Random Mid

                                        -  2 bit Variant (fix 0b10)

                                        - 62 bit Random Low

                                        */

                                        echo sprintf("%-32s %s\n", "Version:", "[4] Random");

                                        $rand_line1 = '';

                                        $rand_line2 = '';

                                        for ($i=0; $i<16; $i++) {

                                                $bin = base_convert(substr($uuid, $i*2, 2), 16, 2);

                                                $bin = str_pad($bin, 8, "0", STR_PAD_LEFT);

                                                if ($i == 6) {

                                                        // was overwritten by version

                                                        $bin[0] = '?';

                                                        $bin[1] = '?';

                                                        $bin[2] = '?';

                                                        $bin[3] = '?';

                                                } else if ($i == 8) {

                                                        // was partially overwritten by variant

                                                        $bin[0] = '?';

                                                        $bin[1] = '?';

                                                }

                                                if ($i<8) $rand_line1 .= "$bin ";

                                                if ($i>=8) $rand_line2 .= "$bin ";

                                        }

                                        echo sprintf("%-32s %s\n", "Random bits:", trim($rand_line1));

                                        echo sprintf("%-32s %s\n", "",             trim($rand_line2));

                                        $rand_bytes = str_replace('-', '', strtolower($uuid));

                                        $rand_bytes[12] = '?'; // was overwritten by version

                                        $var16a = dechex((hexdec($rand_bytes[16])&3) + 0x0/*00__*/);

                                        $var16b = dechex((hexdec($rand_bytes[16])&3) + 0x4/*01__*/);

                                        $var16c = dechex((hexdec($rand_bytes[16])&3) + 0x8/*10__*/);

                                        $var16d = dechex((hexdec($rand_bytes[16])&3) + 0xC/*11__*/);

                                        $rand_bytes[16] = '?'; // was partially overwritten by variant

                                        echo sprintf("%-32s %s\n", "Random bytes:", "[0x$rand_bytes]");

                                        echo sprintf("%-32s %s\n", "", "                   ^");

                                        echo sprintf("%-32s %s\n", "", "                   $var16a, $var16b, $var16c, or $var16d");

                                        break;

                                case 5:

                                        /*

                                        Variant 1, Version 5 UUID

                                        - 48 bit Hash High

                                        -  4 bit Version (fix 0x2)

                                        - 12 bit Hash Mid

                                        -  2 bit Variant (fix 0b10)

                                        - 62 bit Hash Low

                                        */

                                        echo sprintf("%-32s %s\n", "Version:", "[5] Name-based (SHA-1 hash)");

                                        $hash = str_replace('-', '', strtolower($uuid));

                                        $hash[12] = '?'; // was overwritten by version

                                        $var16a = dechex((hexdec($hash[16])&3) + 0x0/*00__*/);

                                        $var16b = dechex((hexdec($hash[16])&3) + 0x4/*01__*/);

                                        $var16c = dechex((hexdec($hash[16])&3) + 0x8/*10__*/);

                                        $var16d = dechex((hexdec($hash[16])&3) + 0xC/*11__*/);

                                        $hash[16] = '?'; // was partially overwritten by variant

                                        $hash .= '????????'; // was cut off

                                        echo sprintf("%-32s %s\n", "SHA1(Namespace+Subject):", "[0x$hash]");

                                        echo sprintf("%-32s %s\n", "", "                   ^");

                                        echo sprintf("%-32s %s\n", "", "                   $var16a, $var16b, $var16c, or $var16d");

                                        break;

                                case 6:

                                        echo sprintf("%-32s %s\n", "Version:", "[$version] Reordered Time (NOT IMPLEMENTED YET)"); // TODO: implement

                                        break;

                                case 7:

                                        echo sprintf("%-32s %s\n", "Version:", "[$version] Unix Epoch Time (NOT IMPLEMENTED YET)"); // TODO: implement

                                        break;

                                case 8:

                                        echo sprintf("%-32s %s\n", "Version:", "[$version] Custom (NOT IMPLEMENTED YET)"); // TODO: implement

                                        break;

                                default:

                                        echo sprintf("%-32s %s\n", "Version:", "[$version] Unknown");

                                        break;

                        }

                        break;

                case 2:

                        echo sprintf("%-32s %s\n", "Variant:", "[0b110] Reserved for Microsoft Corporation");

                        break;

                case 3:

                        echo sprintf("%-32s %s\n", "Variant:", "[0b111] Reserved for future use");

                        break;

        }

        if (!$echo) {

                $out = ob_get_contents();

                ob_end_clean();

                return $out;

        }

}

function uuid_canonize($uuid) {

        if (!uuid_valid($uuid)) return false;

        return oid_to_uuid(uuid_to_oid($uuid));

}

function oid_to_uuid($oid) {

        if (!is_uuid_oid($oid)) return false;

        if (substr($oid,0,1) == '.') {

                $oid = substr($oid, 1);

        }

        $ary = explode('.', $oid);

        if (!isset($ary[2])) return false;

        $val = $ary[2];

        $x = gmp_init($val, 10);

        $y = gmp_strval($x, 16);

        $y = str_pad($y, 32, "0", STR_PAD_LEFT);

        return substr($y,  0, 8).'-'.

               substr($y,  8, 4).'-'.

               substr($y, 12, 4).'-'.

               substr($y, 16, 4).'-'.

               substr($y, 20, 12);

}

function is_uuid_oid($oid, $only_allow_root=false) {

        if (substr($oid,0,1) == '.') $oid = substr($oid, 1); // remove leading dot

        $ary = explode('.', $oid);

        if ($only_allow_root) {

                if (count($ary) != 3) return false;

        } else {

                if (count($ary) < 3) return false;

        }

        if ($ary[0] != '2') return false;

        if ($ary[1] != '25') return false;

        for ($i=2; $i<count($ary); $i++) {

                $v = $ary[$i];

                if (!is_numeric($v)) return false;

                if ($i == 2) {

                        // Must be in the range of 128 bit UUID

                        $test = gmp_init($v, 10);

                        if (strlen(gmp_strval($test, 16)) > 32) return false;

                }

                if ($v < 0) return false;

        }

        return true;

}

function uuid_to_oid($uuid) {

        if (!uuid_valid($uuid)) return false;

        $uuid = str_replace(array('-', '{', '}'), '', $uuid);

        $x = gmp_init($uuid, 16);

        return '2.25.'.gmp_strval($x, 10); # TODO: parameter with or without leading dot

}

function gen_uuid($prefer_timebased = true) {

        $uuid = $prefer_timebased ? gen_uuid_timebased() : false;

        if ($uuid === false) $uuid = gen_uuid_random();

        return $uuid;

}

// Variant 0 (NCS) UUID

// Variant 1, Version 1 (Time based) UUID

function gen_uuid_timebased() {

        # On Debian: apt-get install php-uuid

        # extension_loaded('uuid')

        if (function_exists('uuid_create')) {

                # OSSP uuid extension like seen in php5-uuid at Debian 8

                /*

                $x = uuid_create($context);

                uuid_make($context, UUID_MAKE_V1);

                uuid_export($context, UUID_FMT_STR, $uuid);

                return trim($uuid);

                */

                # PECL uuid extension like seen in php-uuid at Debian 9

                return trim(uuid_create(UUID_TYPE_TIME));

        }

        # On Debian: apt-get install uuid-runtime

        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {

                $out = array();

                $ec = -1;

                exec('uuidgen -t 2>/dev/null', $out, $ec);

                if ($ec == 0) return trim($out[0]);

        }

        # If we hadn't any success yet, then implement the time based generation routine ourselves!

        # Based on https://github.com/fredriklindberg/class.uuid.php/blob/master/class.uuid.php

        $uuid = array(

                'time_low' => 0,                /* 32-bit */

                'time_mid' => 0,                /* 16-bit */

                'time_hi' => 0,                 /* 16-bit */

                'clock_seq_hi' => 0,            /*  8-bit */

                'clock_seq_low' => 0,           /*  8-bit */

                'node' => array()               /* 48-bit */

        );

        /*

         * Get current time in 100 ns intervals. The magic value

         * is the offset between UNIX epoch and the UUID UTC

         * time base October 15, 1582.

         */

        $tp = gettimeofday();

        $time = ($tp['sec'] * 10000000) + ($tp['usec'] * 10) + 0x01B21DD213814000;

        $uuid['time_low'] = $time & 0xffffffff;

        /* Work around PHP 32-bit bit-operation limits */

        $high = intval($time / 0xffffffff);

        $uuid['time_mid'] = $high & 0xffff;

        $uuid['time_hi'] = (($high >> 16) & 0xfff) | (1/*TimeBased*/ << 12);

        /*

         * We don't support saved state information and generate

         * a random clock sequence each time.

         */

        $uuid['clock_seq_hi'] = 0x80 | _random_int(0, 64);

        $uuid['clock_seq_low'] = _random_int(0, 255);

        /*

         * Node should be set to the 48-bit IEEE node identifier

         */

        $mac = get_mac_address();

        if ($mac) {

                $node = str_replace('-','',str_replace(':','',$mac));

                for ($i = 0; $i < 6; $i++) {

                        $uuid['node'][$i] = hexdec(substr($node, $i*2, 2));

                }

                /*

                 * Now output the UUID

                 */

                return 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]);

        }

        # We cannot generate the timebased UUID!

        return false;

}

function get_mac_address() {

        static $detected_mac = false;

        if ($detected_mac !== false) { // false NOT null!

                return $detected_mac;

        }

        // TODO: This should actually be part of mac_utils.inc.php, but we need it

        //       here, and mac_utils.inc.php shall only be optional. What to do?

        if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {

                // Windows

                $cmds = array(

                        "ipconfig /all", // faster