ip-utilties 3.6.1 → 3.7.0

package/README.md

@@ -11,6 +11,9 @@
 
 ip-v4/v6 utility functions
 
+- encoding / decoding
+- well known subnets
+  
 ## Three different representations
 
 ```javascript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ip-utilties",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -13,6 +13,7 @@
   },
   "description": "ip v4/v6 utility functions",
   "keywords": [
+    "address",
     "cidr",
     "ip",
     "ipv4",
@@ -41,10 +42,10 @@
   },
   "devDependencies": {
     "ava": "^8.0.1",
-    "browser-ava": "^2.3.66",
+    "browser-ava": "^2.3.67",
     "c8": "^11.0.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^25.0.6",
+    "semantic-release": "^25.0.7",
     "typescript": "^7.0.2"
   },
   "overrides": {

package/src/ip.mjs

@@ -23,22 +23,24 @@ const ipv4 = {
 
   // https://www.geeksforgeeks.org/computer-networks/subnet-cheat-sheet/
   wellKnownAddresses: [
-    [new Uint8Array([169, 254, 0, 0]), 16], // Link-local address (Autoconfiguration)
-
-    [new Uint8Array([0, 0, 0, 0]), 8], // This network
-    [new Uint8Array([10, 0, 0, 0]), 8], // Private network (RFC 1918)
-    [new Uint8Array([100, 64, 0, 0]), 10], // Carrier-grade NAT / Shared address space (CGN)
-    [new Uint8Array([127, 0, 0, 0]), 8], // Loopback
-    [new Uint8Array([127, 0, 53, 53]), 0], // Name collision occurrence
-    [new Uint8Array([172, 16, 0, 0]), 12], // Private network (RFC 1918)
-    [new Uint8Array([192, 0, 0, 0]), 24], // IETF protocol assignments
-    [new Uint8Array([192, 0, 2, 0]), 24], // TEST-NET-1
-    [new Uint8Array([192, 168, 0, 0]), 16], // Private network (RFC 1918)
-    [new Uint8Array([198, 18, 0, 0]), 15], // Network benchmark testing
-    [new Uint8Array([198, 51, 100, 0]), 24], // TEST-NET-2
-    [new Uint8Array([203, 0, 113, 0]), 24], // Reserved address space used for documentation
-    [new Uint8Array([240, 0, 0, 0]), 4], // Reserved for future use or experimental purposes
-    [new Uint8Array([255, 255, 255, 255]), 0] // Limited Broadcast address
+    // mask                            length, prefix, link local,
+    [new Uint8Array([169, 254, 0, 0]), /* */ 16, 16, true], // Link-local address (Autoconfiguration)
+
+    [new Uint8Array([0, 0, 0, 0]), /*        */ 8, 8], // This network
+    [new Uint8Array([10, 0, 0, 0]), /*       */ 8, 8], // Private network (RFC 1918)
+    [new Uint8Array([100, 64, 0, 0]), /*    */ 10, 10], // Carrier-grade NAT / Shared address space (CGN)
+    [new Uint8Array([127, 0, 0, 0]), /*      */ 8, 8], // Loopback
+    [new Uint8Array([172, 16, 0, 0]), /*    */ 12, 12], // Private network (RFC 1918)
+    [new Uint8Array([192, 0, 0, 0]), /*     */ 24, 24], // IETF protocol assignments
+    [new Uint8Array([192, 0, 2, 0]), /*     */ 24, 24], // TEST-NET-1
+    [new Uint8Array([192, 168, 0, 0]), /*   */ 16, 16], // Private network (RFC 1918)
+    [new Uint8Array([198, 18, 0, 0]), /*    */ 15, 15], // Network benchmark testing
+    [new Uint8Array([198, 51, 100, 0]), /*  */ 24, 24], // TEST-NET-2
+    [new Uint8Array([203, 0, 113, 0]), /*   */ 24, 24], // Reserved address space used for documentation
+    [new Uint8Array([240, 0, 0, 0]), /*      */ 4, 4], // Reserved for future use or experimental purposes
+
+    [new Uint8Array([127, 0, 53, 53]), /*    */ 0, 0], // Name collision occurrence
+    [new Uint8Array([255, 255, 255, 255]), /**/ 0, 0] // Limited Broadcast address
   ]
 };
 
@@ -62,7 +64,12 @@ const ipv6 = {
   base: 16,
   localHost: new Uint16Array([0, 0, 0, 0, 0, 0, 0, 1]),
   localHostPrefixLenth: 128,
-  wellKnownAddresses: [[new Uint16Array([0xfe80, 0, 0, 0, 0, 0, 0, 0]), 64]]
+  wellKnownAddresses: [
+    [new Uint16Array([0xfe80, 0, 0, 0, 0, 0, 0, 0]), 64, 64, true],
+    [new Uint16Array([0xfd00, 0, 0, 0, 0, 0, 0, 0]), 8, 64, false, true],
+    [new Uint16Array([0xfc00, 0, 0, 0, 0, 0, 0, 0]), 7, 64, false, true],
+    [new Uint16Array([0, 0, 0, 0, 0, 0, 0, 1]), 128, 128, false, true]
+  ]
 };
 
 const families = [ipv4, ipv6];
@@ -282,18 +289,19 @@ export function normalizeCIDR(address) {
   let longPrefix;
 
   const family = isIPv6(prefix) ? ipv6 : ipv4;
+  let encoded = _encode(family, prefix);
+  const wns = _wellKnownSubnet(family, encoded);
 
-  const wns = _wellKnownSubnet(family, address);
-  if (family === ipv4 && wns && !prefixLength) {
-    prefixLength = wns[1];
+  if (wns && !prefixLength) {
+    prefixLength = wns[2];
     prefix = _decode(
       family,
-      _prefix(family, wns[0], prefixLength),
+      _prefix(family, encoded, prefixLength),
       prefixLength
     );
-    longPrefix = wns[0];
+    longPrefix = _decode(family, wns[0]);
   } else {
-    if (isUniqueLocal(address) || _isLinkLocal(family, address)) {
+    if (_isUniqueLocal(encoded) || _isLinkLocal(family, encoded)) {
       prefixLength = family.wellKnownAddresses[0][1]; // TODO
       const n = _prefix(family, address, prefixLength);
       prefix = _decode(family, n, prefixLength);
@@ -308,19 +316,15 @@ export function normalizeCIDR(address) {
     } else {
       prefixLength = prefixLength === undefined ? 0 : parseInt(prefixLength);
 
-      let n;
-
       if (prefixLength) {
-        n = _prefix(family, prefix, prefixLength);
+        encoded = _prefix(family, prefix, prefixLength);
       } else {
-        n = _encode(family, prefix);
-
-        if (isLocalhost(n)) {
+        if (_isLocalhost(family, encoded)) {
           prefixLength = family.localHostPrefixLenth;
         }
       }
-      prefix = _decode(family, n, prefixLength);
-      longPrefix = _decode(family, n);
+      prefix = _decode(family, encoded, prefixLength);
+      longPrefix = _decode(family, encoded);
     }
   }
 
@@ -374,10 +378,14 @@ function _equal(a, b) {
   return true;
 }
 
+export function _isLocalhost(family, encoded) {
+  return _equal(family.localHost, encoded);
+}
+
 export function isLocalhost(address) {
   const family = _family(address);
   if (family) {
-    return _equal(family.localHost, _encode(family, address));
+    return _isLocalhost(family, _encode(family, address));
   }
   return false;
 }
@@ -385,7 +393,7 @@ export function isLocalhost(address) {
 export function isLinkLocal(address) {
   const family = _family(address);
   if (family) {
-    return _isLinkLocal(family, address);
+    return _isLinkLocal(family, _encode(family, address));
   }
   return false;
 }
@@ -410,21 +418,11 @@ export function hasWellKnownSubnet(address) {
 export function wellKnownSubnet(address) {
   const family = _family(address);
   if (family) {
-    return _wellKnownSubnet(family, address);
+    return _wellKnownSubnet(family, _encode(family, address));
   }
 }
 
-export function _wellKnownSubnet(family, address) {
-  const encoded = _encode(family, address);
-
-  if (_equal(family.localHost, encoded)) {
-    return [family.localHost, family.localHostPrefixLenth];
-  }
-
-  if (_isUniqueLocal(encoded)) {
-    return [encoded[0], 64];
-  }
-
+export function _wellKnownSubnet(family, encoded) {
   for (const c of family.wellKnownAddresses) {
     const pl = c[1];
     if (pl > 0 && _prefix(family, c[0], pl) === _prefix(family, encoded, pl)) {
@@ -443,7 +441,6 @@ export function _wellKnownSubnet(family, address) {
 
 /*
   prefix     global subnet interface
-
   ff01:: ff02::   1
   ff05::          2 3
 

package/types/ip.d.mts

@@ -49,6 +49,7 @@ export declare function normalizeCIDR(address: any): {
 export declare function formatCIDR(address: any, prefixLength: any): any;
 export declare function normalizeIP(address: any): string | undefined;
 export declare function reverseArpa(address: any): string;
+export declare function _isLocalhost(family: any, encoded: any): boolean;
 export declare function isLocalhost(address: any): boolean;
 export declare function isLinkLocal(address: any): boolean;
 export declare function _isLinkLocal(family: any, address: any): boolean;
@@ -56,7 +57,7 @@ export declare function isUniqueLocal(address: any): boolean;
 export declare function _isUniqueLocal(eaddr: any): boolean;
 export declare function hasWellKnownSubnet(address: any): boolean;
 export declare function wellKnownSubnet(address: any): any;
-export declare function _wellKnownSubnet(family: any, address: any): any;
+export declare function _wellKnownSubnet(family: any, encoded: any): any;
 export declare const IPV6_NODE_LOCAL_ALL_NODES: any;
 export declare const IPV6_NODE_LOCAL_ALL_ROUTERS: any;
 export declare const IPV6_LINK_LOCAL_ALL_NODES: any;