cidr-tools 4.3.0 → 5.0.1

package/README.md

@@ -11,54 +11,54 @@ $ npm i cidr-tools
 ## Example
 
 ```js
-const cidrTools = require('cidr-tools');
-
-cidrTools.merge(['1.0.0.0/24', '1.0.1.0/24']); //=> ['1.0.0.0/23']
-cidrTools.exclude(['::1/127'], ['::1/128']) //=> ['::/128']
-cidrTools.expand(['2001:db8::/126']) //=> ['2001:db8::', '2001:db8::1', '2001:db8::2', '2001:db8::3']
-cidrTools.overlap('1.0.0.0/24', '1.0.0.128/25') //=> true
-cidrTools.contains(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1") //=> true
-cidrTools.normalize('0:0:0:0:0:0:0:0/0') //=> '::/0'
+import {merge, exclude, expand, overlap, contains, normalize} from 'cidr-tools';
+
+merge(['1.0.0.0/24', '1.0.1.0/24']); //=> ['1.0.0.0/23']
+exclude(['::1/127'], ['::1/128']) //=> ['::/128']
+expand(['2001:db8::/126']) //=> ['2001:db8::', '2001:db8::1', '2001:db8::2', '2001:db8::3']
+overlap('1.0.0.0/24', '1.0.0.128/25') //=> true
+contains(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1") //=> true
+normalize('0:0:0:0:0:0:0:0/0') //=> '::/0'
 ```
 
 ## API
 
 All functions take CIDR addresses or single IP addresses. On single addresses, a prefix of `/32` or `/128` is assumed. Function that return networks will return a merged and sorted set of networks with IPv4 sorted before IPv6.
 
-### cidrTools.merge(networks)
+### merge(networks)
 
 - `networks` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns an array of merged networks.
 
-### cidrTools.exclude(baseNetworks, excludeNetworks)
+### exclude(baseNetworks, excludeNetworks)
 
 - `baseNetworks` *String* or *Array*: One or more CIDR or IP addresses.
 - `excludeNetworks` *String* or *Array*: One or more CIDR or IP addresses to exclude from `baseNetworks`.
 
 Returns an array of merged remaining networks.
 
-### cidrTools.expand(networks)
+### expand(networks)
 
 - `networks` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns an array of individual IPs contained in the networks.
 
-### cidrTools.overlap(networksA, networksB)
+### overlap(networksA, networksB)
 
 - `networksA` *String* or *Array*: One or more CIDR or IP address.
 - `networksB` *String* or *Array*: One or more CIDR or IP address.
 
 Returns a boolean that indicates if `networksA` overlap (intersect) with `networksB`.
 
-### cidrTools.contains(networksA, networksB)
+### contains(networksA, networksB)
 
 - `networksA` *String* or *Array*: One or more CIDR or IP address.
 - `networksB` *String* or *Array*: One or more CIDR or IP address.
 
 Returns a boolean that indicates whether `networksA` fully contain all `networksB`.
 
-### cidrTools.normalize(networks)
+### normalize(networks)
 
 - `networks` *String* or *Array*: One or more CIDR or IP address.
 

package/index.js

@@ -1,12 +1,10 @@
-"use strict";
-
-const IPCIDR = require("ip-cidr");
-const isIp = require("is-ip");
-const isCidr = require("is-cidr");
-const ipv6Normalize = require("ipv6-normalize");
-const naturalCompare = require("string-natural-compare");
-const {Address4, Address6} = require("ip-address");
-const {BigInteger} = require("jsbn");
+import IPCIDR from "ip-cidr";
+import ipRegex from "ip-regex";
+import isCidr from "is-cidr";
+import ipv6Normalize from "ipv6-normalize";
+import naturalCompare from "string-natural-compare";
+import {stringify as stringifyIp} from "ip-bigint";
+import {BigInteger} from "jsbn";
 
 const bits = {
   "v4": 32,
@@ -19,15 +17,26 @@ const zero = bigint("0");
 const one = bigint("1");
 const two = bigint("2");
 
+function isIP(ip) {
+  if (ipRegex.v4({exact: true}).test(ip)) return 4;
+  if (ipRegex.v6({exact: true}).test(ip)) return 6;
+  return 0;
+}
+
 function doNormalize(cidr) {
   const cidrVersion = isCidr(cidr);
-  if (cidrVersion === 4) {
-    return cidr;
-  } else if (cidrVersion === 6) {
-    const [ip, prefix] = cidr.split("/");
-    return `${ipv6Normalize(ip)}/${prefix}`;
+
+  // cidr
+  if (cidrVersion) {
+    // set network address to first address
+    let start = (new IPCIDR(cidr)).start();
+    if (cidrVersion === 6) start = ipv6Normalize(start).toString();
+    if (start) {
+      return `${start}${cidr.match(/\/.+/)}`.toLowerCase();
+    }
   }
 
+  // single ip
   const parsed = parse(cidr);
   if (parsed && parsed.address && parsed.address.v4) {
     return cidr;
@@ -38,27 +47,30 @@ function doNormalize(cidr) {
   throw new Error(`Invalid network: ${cidr}`);
 }
 
-module.exports.normalize = (cidr) => {
+export function normalize(cidr) {
   return Array.isArray(cidr) ? cidr.map(doNormalize) : doNormalize(cidr);
-};
+}
 
 function parse(str) {
   if (isCidr(str)) {
-    return new IPCIDR(module.exports.normalize(str));
+    return new IPCIDR(normalize(str));
   } else {
-    const version = isIp.version(str);
+    const version = isIP(str);
     if (version) {
-      return new IPCIDR(module.exports.normalize(`${str}/${bits[`v${version}`]}`));
+      return new IPCIDR(normalize(`${str}/${bits[`v${version}`]}`));
     } else {
       throw new Error(`Network is not a CIDR or IP: ${str}`);
     }
   }
 }
 
-function format(number, v) {
-  const cls = v === "v6" ? Address6 : Address4;
+function format(number, version) {
   if (!(number instanceof BigInteger)) number = bigint(number);
-  return module.exports.normalize(cls.fromBigInteger(number).address);
+
+  return normalize(stringifyIp({
+    number: BigInt(number.toString()),
+    version: Number(version.substring(1)),
+  }));
 }
 
 function uniq(arr) {
@@ -90,7 +102,7 @@ function doNetsOverlap(a, b) {
 }
 
 // returns whether network a fully contains network b;
-function contains(a, b) {
+function netContains(a, b) {
   const {aStart, bStart, aEnd, bEnd} = getBoundaries(a, b);
 
   //  aaa
@@ -163,7 +175,7 @@ function excludeNets(a, b, v) {
     }
   }
 
-  return module.exports.merge(remaining);
+  return merge(remaining);
 }
 
 function biggestPowerOfTwo(num) {
@@ -266,7 +278,7 @@ function mapNets(nets) {
   return maps;
 }
 
-module.exports.merge = function(nets) {
+export function merge(nets) {
   nets = uniq((Array.isArray(nets) ? nets : [nets]).map(parse));
   const maps = mapNets(nets);
 
@@ -308,14 +320,14 @@ module.exports.merge = function(nets) {
   merged.v4 = merged.v4.sort(naturalCompare);
   merged.v6 = merged.v6.sort(naturalCompare);
   return merged.v4.concat(merged.v6);
-};
+}
 
-module.exports.exclude = (basenets, exclnets) => {
+export function exclude(basenets, exclnets) {
   basenets = uniq(Array.isArray(basenets) ? basenets : [basenets]);
   exclnets = uniq(Array.isArray(exclnets) ? exclnets : [exclnets]);
 
-  basenets = module.exports.merge(basenets);
-  exclnets = module.exports.merge(exclnets);
+  basenets = merge(basenets);
+  exclnets = merge(exclnets);
 
   const bases = {v4: [], v6: []};
   const excls = {v4: [], v6: []};
@@ -343,19 +355,19 @@ module.exports.exclude = (basenets, exclnets) => {
   }
 
   return bases.v4.concat(bases.v6);
-};
+}
 
-module.exports.expand = (nets) => {
+export function expand(nets) {
   nets = uniq(Array.isArray(nets) ? nets : [nets]);
 
   let ips = [];
-  for (const net of module.exports.merge(nets)) {
+  for (const net of merge(nets)) {
     ips = ips.concat((new IPCIDR(net)).toArray());
   }
-  return ips.map(module.exports.normalize);
-};
+  return ips.map(normalize);
+}
 
-module.exports.overlap = (a, b) => {
+export function overlap(a, b) {
   const aNets = uniq(Array.isArray(a) ? a : [a]);
   const bNets = uniq(Array.isArray(b) ? b : [b]);
 
@@ -376,9 +388,9 @@ module.exports.overlap = (a, b) => {
   }
 
   return false;
-};
+}
 
-module.exports.contains = (a, b) => {
+export function contains(a, b) {
   const aNets = uniq(Array.isArray(a) ? a : [a]);
   const bNets = uniq(Array.isArray(b) ? b : [b]);
 
@@ -394,7 +406,7 @@ module.exports.contains = (a, b) => {
         continue;
       }
 
-      if (contains(aParsed, bParsed)) {
+      if (netContains(aParsed, bParsed)) {
         numFound++;
         continue;
       }
@@ -402,4 +414,4 @@ module.exports.contains = (a, b) => {
   }
 
   return numFound === numExpected;
-};
+}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "cidr-tools",
-  "version": "4.3.0",
+  "version": "5.0.1",
   "author": "silverwind <me@silverwind.io>",
   "description": "Tools to work with IPv4 and IPv6 CIDR network lists",
   "repository": "silverwind/cidr-tools",
   "license": "BSD-2-Clause",
+  "type": "module",
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "keywords": [
     "cidr",
@@ -26,19 +27,19 @@
   ],
   "types": "./index.d.ts",
   "dependencies": {
-    "ip-address": "^8.1.0",
-    "ip-cidr": "^3.0.4",
+    "ip-bigint": "3.0.3",
+    "ip-cidr": "^3.0.10",
+    "ip-regex": "5.0.0",
     "ipv6-normalize": "^1.0.1",
     "is-cidr": "^4.0.2",
-    "is-ip": "^3.1.0",
     "jsbn": "^1.1.0",
     "string-natural-compare": "^3.0.1"
   },
   "devDependencies": {
-    "eslint": "8.9.0",
-    "eslint-config-silverwind": "48.1.0",
-    "jest": "27.5.1",
-    "updates": "13.0.0",
-    "versions": "9.2.1"
+    "eslint": "8.23.1",
+    "eslint-config-silverwind": "54.0.2",
+    "jest": "29.0.3",
+    "updates": "13.1.5",
+    "versions": "9.3.0"
   }
 }