WebSVN – uuid_mac_utils – Diff – /trunk/includes/mac_utils.inc.php

  * 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.
  */
+// Very good resources for information about OUI, EUI, MAC, ...
+// - https://mac-address.alldatafeeds.com/faq#how-to-recognise-mac-address-application
+// - https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf
+// - https://en.m.wikipedia.org/wiki/Organizationally_unique_identifier
 const IEEE_MAC_REGISTRY = __DIR__ . '/../web-data';
 /**
- * Checks if a MAC, EUI, or IPv6-LinkLocal address is valid
+ * Checks if a MAC, EUI, ELI, or IPv6-LinkLocal address is valid
  * @param string $mac MAC, EUI, or IPv6-LinkLocal Address
  * @return bool True if it is valid
  */
 function mac_valid(string $mac): bool {
         $tmp = ipv6linklocal_to_mac48($mac);
         return ($mac === '');
+}
 /**
- * Returns the amount of bits of a MAC or EUI
+ * Returns the amount of bits of a MAC, EUI, or ELI
  * @param string $mac
  * @return false|int
  */
 function eui_bits(string $mac) {
         if (!mac_valid($mac)) return false;
         $mac = mac_canonize($mac, '');
         return (int)(strlen($mac)*4);
+}
 /**
- * Canonizes a MAC, EUI, or IPv6-LinkLocal address
+ * Canonizes a MAC, EUI, ELI, or IPv6-LinkLocal address
- * @param string $mac MAC, EUI, or IPv6-LinkLocal Address
+ * @param string $mac MAC, EUI, ELI, or IPv6-LinkLocal Address
  * @param string $delimiter Desired delimiter for inserting between each octet
  * @return string|false The canonized address (Note: IPv6-Linklocal becomes EUI-64)
  */
 function mac_canonize(string $mac, string $delimiter="-") {
         if (!mac_valid($mac)) return false;
  */
 function eui64_to_eui48(string $eui64) {
         if (!mac_valid($eui64)) return false;
         $eui64 = mac_canonize($eui64, '');
         if (eui_bits($eui64) == 48) return mac_canonize($eui64);
+        if ($eui64[1] == 'A') return false; // do not allow ELI-64
         if (substr($eui64, 6, 4) == 'FFFF') {
                 // EUI-64 to MAC-48
                 return mac_canonize(substr($eui64, 0, 6).substr($eui64, 10, 6));
         } else if (substr($eui64, 6, 4) == 'FFFE') {
         // Note: MAC-48 is used for network hardware; EUI-48 is used to identify other devices and software.
         //       MAC48-to-EUI64 Encapsulation uses 0xFFFF middle part
         if (!mac_valid($mac48)) return false;
         $mac48 = mac_canonize($mac48, '');
         if (eui_bits($mac48) == 64) return mac_canonize($mac48);
+        if ($mac48[1] == 'A') return false; // do not allow ELI-48
         $eui64 = substr($mac48, 0, 6).'FFFF'.substr($mac48, 6, 6);
         return mac_canonize($eui64);
+}
         // Note: MAC-48 is used for network hardware; EUI-48 is used to identify other devices and software.
         //       EUI48-to-EUI64 Encapsulation uses 0xFFFF middle part
         if (!mac_valid($eui48)) return false;
         $eui48 = mac_canonize($eui48, '');
         if (eui_bits($eui48) == 64) return mac_canonize($eui48);
+        if ($eui48[1] == 'A') return false; // do not allow ELI-48
         $eui64 = substr($eui48, 0, 6).'FFFE'.substr($eui48, 6, 6);
         return mac_canonize($eui64);
+}
         // Note: MAC-48 is used for network hardware; EUI-48 is used to identify other devices and software.
         //       EUI48-to-ModifiedEUI64 Encapsulation uses 0xFFFE middle part (SIC! This was a mistake by IETF, since it should actually be 0xFFFF!)
         if (!mac_valid($eui48)) return false;
         $eui48 = mac_canonize($eui48, '');
         if (eui_bits($eui48) == 64) return mac_canonize($eui48);
+        if ($eui48[1] == 'A') return false; // do not allow ELI-48
         $eui64 = substr($eui48, 0, 6).'FFFE'.substr($eui48, 6, 6);
         $eui64[1] = dechex(hexdec($eui64[1]) | 2); // flip seventh bit
         $mac = str_pad($mac, 16, '0', STR_PAD_LEFT);
         return strtolower('fe80::'.substr($mac,0, 4).':'.substr($mac,4, 4).':'.substr($mac,8, 4).':'.substr($mac,12, 4));
+}
 /**
- * Prints information about an IPv6-LinkLocal address, MAC, or EUI.
+ * Prints information about an IPv6-LinkLocal address, MAC, EUI, or ELI.
- * @param string $mac IPv6-LinkLocal address, MAC, or EUI
+ * @param string $mac IPv6-LinkLocal address, MAC, EUI, or ELI
  * @return void
  * @throws Exception
  */
 function decode_mac(string $mac) {
-        // Amazing website about MAC addresses: https://mac-address.alldatafeeds.com/faq#how-to-recognise-mac-address-application
         echo sprintf("%-32s %s\n", "Input:", $mac);
         // Format MAC for machine readability
         $mac = mac_canonize($mac, '');
         $type = '';
+        if ($mac[1] == 'A') {
+                // An ELI is based on a CID-24
+                // A CID has ZYXM bits set to 1010 (0b1010 = 0xA)
+                // Since X=1 (U/L=1), the CID cannot be used to form a universal UAA MAC (only a local LAA MAC)
+                $type = 'ELI-'.eui_bits($mac);;
+        } else {
-        $tmp = ipv6linklocal_to_mac48($mac);
+                $tmp = ipv6linklocal_to_mac48($mac);
-        if ($tmp !== false) {
+                if ($tmp !== false) {
-                $mac = $tmp;
+                        $mac = $tmp;
-                $type = 'IPv6-Link-Local';
+                        $type = 'IPv6-Link-Local';
+                }
+                                }
-                } else {
+                        } else {
-                        assert(false); /** @phpstan-ignore-line */
+                                assert(false); /** @phpstan-ignore-line */
+                        }
+                }
+        }
         echo sprintf("%-32s %s\n", "Type:", $type);
         echo "\n";
         // Show various representations
+        if ($mac[1] == 'A') {
+                // Note: There does not seem to exist an algorithm for converting ELI-48 <=> ELI-64
+                echo sprintf("%-32s %s\n", "ELI-".eui_bits($mac).":", mac_canonize($mac));
+        } else {
-        $eui48 = eui64_to_eui48($mac);
+                $eui48 = eui64_to_eui48($mac);
-        echo sprintf("%-32s %s\n", "EUI-48:", (eui_bits($eui48) != 48) ? 'Not available' : $eui48);
+                echo sprintf("%-32s %s\n", "EUI-48:", (eui_bits($eui48) != 48) ? 'Not available' : $eui48);
-        if (eui_bits($mac) == 48) {
+                if (eui_bits($mac) == 48) {
-                $eui64 = mac48_to_eui64($mac);
+                        $eui64 = mac48_to_eui64($mac);
-                echo sprintf("%-32s %s\n", "EUI-64:", ((eui_bits($eui64) != 64) ? 'Not available' : $eui64).' (MAC-48 to EUI-64 Encapsulation)');
+                        echo sprintf("%-32s %s\n", "EUI-64:", ((eui_bits($eui64) != 64) ? 'Not available' : $eui64).' (MAC-48 to EUI-64 Encapsulation)');
-                echo sprintf("%-32s %s\n", "IPv6 link local address:", $ipv6);
+                        echo sprintf("%-32s %s\n", "IPv6 link local address:", $ipv6);
-        } else {
+                } else {
-                $eui64 = mac_canonize($mac);
+                        $eui64 = mac_canonize($mac);
-                echo sprintf("%-32s %s\n", "EUI-64:", $eui64);
+                        echo sprintf("%-32s %s\n", "EUI-64:", $eui64);
+                }
+        }
         // Vergabestelle
         $ul = hexdec($mac[1]) & 2; // Bit #LSB+1 of Byte 1
         $ul_ = ($ul == 0) ? '[0] Universally Administered Address (UAA)' : '[1] Locally Administered Address (LAA)';
         echo sprintf("%-32s %s\n", "Administration type (U/L flag):", $ul_);
         // Empfaengergruppe
         $ig = hexdec($mac[1]) & 1; // Bit #LSB+0 of Byte 1
-        $ig_ = ($ig == 0) ? '[0] Individual (Unicast)' : '[1] Group (Multicast)';
+        $ig_ = ($ig == 0) ? '[0] Unicast (Individual)' : '[1] Multicast (Group)';
         echo sprintf("%-32s %s\n", "Transmission type (I/G flag):", $ig_);
         // Query IEEE registries
-        // TODO: gilt OUI nur bei Individual UAA? For LAA, should we convert to UAA and then query the registry?
         if (count(glob(IEEE_MAC_REGISTRY.DIRECTORY_SEPARATOR.'*.txt')) > 0) {
+                if ($mac[1] == 'A') {
+                        // Query the CID registry
+                        if (
+                                ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'cid.txt', 'CID', $mac))
+                        ) {
+                                echo $x;
+                        }
+                } else {
+                        // Query the OUI registries
+                        // TODO: Should we try to convert Unicast<=>Multicast if one of them can't be found?
-                if (
+                        if (
-                        # The IEEE Registration Authority distinguishes between IABs and OUI-36 values. Both are 36-bit values which may be used to generate EUI-48 values, but IABs may not be used to generate EUI-64 values.[6]
+                                # The IEEE Registration Authority distinguishes between IABs and OUI-36 values. Both are 36-bit values which may be used to generate EUI-48 values, but IABs may not be used to generate EUI-64 values.[6]
-                        # Note: The Individual Address Block (IAB) is an inactive registry activity, which has been replaced by the MA-S registry product as of January 1, 2014.
+                                # Note: The Individual Address Block (IAB) is an inactive registry activity, which has been replaced by the MA-S registry product as of January 1, 2014.
-                        ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'iab.txt', 'IAB', $mac)) ||
+                                ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'iab.txt', 'IAB', $mac)) ||
-                        ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'oui36.txt', 'OUI-36 (MA-S)', $mac)) ||
+                                ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'oui36.txt', 'OUI-36 (MA-S)', $mac)) ||
-                        ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'oui.txt', 'OUI-24 (MA-L)', $mac))
+                                ($x = _lookup_ieee_registry(IEEE_MAC_REGISTRY . DIRECTORY_SEPARATOR . 'oui.txt', 'OUI-24 (MA-L)', $mac))
-                ) {
+                        ) {
-                        echo $x;
+                                echo $x;
+                        }
+                }
+        }
         $vm = '';
         // === FAQ "Detection rules which don't have their dedicated page yet" ===
         // https://wiki.xenproject.org/wiki/Xen_Networking
         // https://mcpmag.com/articles/2007/11/27/hey-vm-whats-your-hypervisor.aspx
         $hightest = eui64_to_eui48($high);
         if ($hightest === false) return false;
         if ((eui_bits($mactest) != eui_bits($lowtest)) || (eui_bits($lowtest) != eui_bits($hightest))) {
                 $mactest = eui48_to_eui64($mac);
+                if ($mactest === false) return false; // e.g. trying ELI-48 to ELI-64
                 $lowtest = eui48_to_eui64($low);
+                if ($lowtest === false) return false; // e.g. trying ELI-48 to ELI-64
                 $hightest = eui48_to_eui64($high);
+                if ($hightest === false) return false; // e.g. trying ELI-48 to ELI-64
+        }
         $mactest = strtoupper(preg_replace('@[^0-9A-F]@', '', $mactest));
         $lowtest = strtoupper(preg_replace('@[^0-9A-F]@', '', $lowtest));
         $hightest = strtoupper(preg_replace('@[^0-9A-F]@', '', $hightest));

Subversion Repositories uuid_mac_utils

uuid_mac_utils/trunk/includes/mac_utils.inc.php – Rev 17 → 18