is-localhost-ip 1.2.0 → 2.0.0

package/README.md

@@ -8,7 +8,6 @@ Main difference from other libraries here is comprehensiveness: we start from st
 
 All this in just _~100 lines of code_ without external dependencies.
 
-
 ## Installation
 
 ```sh
@@ -23,18 +22,16 @@ yarn add is-localhost-ip
 const isLocalhost = require('is-localhost-ip');
 
 (async () => {
-
-    await isLocalhost("127.0.0.1"); // true
-    await isLocalhost("::ffff:127.0.0.1"); // true
-    await isLocalhost("192.168.0.12"); // true
-    await isLocalhost("184.55.123.2"); // false
-
-    await isLocalhost("tino.local"); // true
-    await isLocalhost("localhost"); // true
-    await isLocalhost("microsoft.com"); // false
-
+  await isLocalhost('127.0.0.1'); // true
+  await isLocalhost('::ffff:127.0.0.1'); // true
+  await isLocalhost('192.168.0.12'); // true
+  await isLocalhost('192.168.0.12', true); // true only if the local machine has an interface with that address
+  await isLocalhost('184.55.123.2'); // false
+
+  await isLocalhost('tino.local'); // true
+  await isLocalhost('localhost'); // true
+  await isLocalhost('microsoft.com'); // false
 })();
-
 ```
 
 ## Caveats
@@ -46,8 +43,8 @@ const isLocalhost = require('is-localhost-ip');
 const punycode = require('punycode');
 
 (async () => {
-    await isLocalhost(punycode.toASCII("кремль.рф")); // false
-    await isLocalhost(punycode.toASCII("私の.家")); // true
+  await isLocalhost(punycode.toASCII('свобода.рф')); // false
+  await isLocalhost(punycode.toASCII('私の.家')); // true
 })();
 ```
 

package/index.d.ts

@@ -1,4 +1,7 @@
 /** Returns true if given parameter is local IP address or resolves into one, false otherwise */
-declare async function isLocalhost(addrOrHost: string): Promise<boolean>;
+declare async function isLocalhost(
+  addrOrHost: string,
+  canBind?: boolean,
+): Promise<boolean>;
 
 export = isLocalhost;

package/index.js

@@ -1,109 +1,100 @@
 'use strict';
 
-const { isIP } = require('net');
-const { networkInterfaces } = require('os');
-
-/*
-  DNS.promises were experimental until Node 11.4 and we don't want experimental warning
-  https://nodejs.org/en/blog/release/v11.14.0/
-*/
-const lookup =
-  process.versions.node
-    .split('.', 2)
-    .map(n => n.padStart(2, '0'))
-    .join('.') >= '11.14'
-    ? // eslint-disable-next-line node/no-unsupported-features/node-builtins
-      require('dns').promises.lookup
-    : require('util').promisify(require('dns').lookup);
-
-const LOCAL_INTERFACES = networkInterfaces();
-const INTERFACES_ADDRESSES = /** @type {Set<string>} */ (new Set());
-
-/*
- We will check if every network interface has an IPv4 or IPv6 address
- to try to avoid lookup both families
-*/
-let haveIPv4 = 0;
-let haveIPv6 = 0;
-for (const interfaceInfo of Object.values(LOCAL_INTERFACES)) {
-  let v4 = false;
-  let v6 = false;
-  for (const { address, family } of interfaceInfo) {
-    INTERFACES_ADDRESSES.add(address);
-    if (family === 'IPv4') v4 = true;
-    else v6 = true;
-  }
-  if (v4) haveIPv4++;
-  if (v6) haveIPv6++;
-}
-
-const totalInterfaces = Object.keys(LOCAL_INTERFACES).length;
-const LOOKUP_OPTIONS = /** @type {import('dns').LookupAllOptions} */ ({
-  all: true,
-  family:
-    totalInterfaces === haveIPv4 ? 4 : totalInterfaces === haveIPv6 ? 6 : 0,
-});
+const { isIP, isIPv4 } = require('net');
+const { createSocket } = require('dgram');
+const { ADDRCONFIG } = require('dns');
+const { lookup } = require('dns').promises;
 
+/**
+ * Addresses reserved for private networks
+ * @see {@link https://en.wikipedia.org/wiki/Private_network}
+ * @see {@link https://en.wikipedia.org/wiki/Unique_local_address}
+ */
 const IP_RANGES = [
   // 10.0.0.0 - 10.255.255.255
-  /^(::f{4}:)?10\.\d{1,3}\.\d{1,3}\.\d{1,3}$/,
+  /^(:{2}f{4}:)?10(?:\.\d{1,3}){3}$/,
   // 127.0.0.0 - 127.255.255.255
-  /^(::f{4}:)?127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/,
+  /^(:{2}f{4}:)?127(?:\.\d{1,3}){3}$/,
   // 169.254.1.0 - 169.254.254.255
   /^(::f{4}:)?169\.254\.([1-9]|1?\d\d|2[0-4]\d|25[0-4])\.\d{1,3}$/,
   // 172.16.0.0 - 172.31.255.255
-  /^(::f{4}:)?(172\.1[6-9]|172\.2\d|172\.3[0-1])\.\d{1,3}\.\d{1,3}$/,
+  /^(:{2}f{4}:)?(172\.1[6-9]|172\.2\d|172\.3[01])(?:\.\d{1,3}){2}$/,
   // 192.168.0.0 - 192.168.255.255
-  /^(::f{4}:)?192\.168\.\d{1,3}\.\d{1,3}$/,
+  /^(:{2}f{4}:)?192\.168(?:\.\d{1,3}){2}$/,
   // fc00::/7
-  /^f[c-d][0-9a-f]{2}(::1$|:[0-9a-f]{1,4}){1,7}$/,
+  /^f[cd][\da-f]{2}(::1$|:[\da-f]{1,4}){1,7}$/,
   // fe80::/10
-  /^fe[89ab][0-9a-f](::1$|:[0-9a-f]{1,4}){1,7}$/,
+  /^fe[89ab][\da-f](::1$|:[\da-f]{1,4}){1,7}$/,
 ];
 
+// Concat all RegExes from above into one
+const IP_TESTER_RE = new RegExp(
+  `^(${IP_RANGES.map((re) => re.source).join('|')})$`,
+);
+
 /**
  * Syntax validation RegExp for possible valid host names. Permits underscore.
  * Maximum total length 253 symbols, maximum segment length 63 symbols
  * @see {@link https://en.wikipedia.org/wiki/Hostname}
  */
-const VALID_HOSTNAME = /(?![a-z0-9-_]{64,})((^(?=[-a-z0-9._]{1,253}\.?$)(([a-z0-9_]{1,63}|([a-z0-9_][a-z0-9-_]{0,61}[a-z0-9_]))\.?)+$)(?<!\.{2,}))/i;
+const VALID_HOSTNAME =
+  // eslint-disable-next-line regexp/no-dupe-disjunctions
+  /(?![\w-]{64})((^(?=[-\w.]{1,253}\.?$)((\w{1,63}|(\w[-\w]{0,61}\w))\.?)+$)(?<!\.{2}))/;
 
 /**
- * Checks if given strings is a local IP address or a DNS name that resolve into a local IP
  *
  * @param {string} ip
+ * @returns {Promise<boolean>}
+ */
+async function canBindToIp(ip) {
+  const socket = createSocket(isIPv4(ip) ? 'udp4' : 'udp6');
+  return new Promise((resolve) => {
+    try {
+      socket
+        .once('error', () => socket.close(() => resolve(false)))
+        .once('listening', () => socket.close(() => resolve(true)))
+        .unref()
+        .bind(0, ip);
+    } catch {
+      socket.close(() => resolve(false));
+    }
+  });
+}
+
+/**
+ * Checks if given strings is a local IP address or a DNS name that resolve into a local IP
+ *
+ * @param {string} ipOrHostname
+ * @param {boolean} [canBind=false] - should check whether an interface with such address exists on the local machine
  * @returns {Promise.<boolean>} - true, if given strings is a local IP address or DNS names that resolves to local IP
  */
-async function isLocalhost(ip) {
-  if (typeof ip !== 'string') return false;
+async function isLocalhost(ipOrHostname, canBind = false) {
+  if (typeof ipOrHostname !== 'string') return false;
 
   // Check if given string is an IP address
-  if (isIP(ip)) {
-    return (
-      ip === '::' ||
-      ip === '::1' ||
-      IP_RANGES.some(it => it.test(ip)) ||
-      INTERFACES_ADDRESSES.has(ip)
-    );
+  if (isIP(ipOrHostname)) {
+    if (IP_TESTER_RE.test(ipOrHostname) && !canBind) return true;
+    return canBindToIp(ipOrHostname);
   }
 
   // May it be a hostname?
-  if (!VALID_HOSTNAME.test(ip)) return false;
+  if (!VALID_HOSTNAME.test(ipOrHostname)) return false;
 
   // it's a DNS name
   try {
-    const addresses = await lookup(ip, LOOKUP_OPTIONS);
-    return (
-      Array.isArray(addresses) &&
-      addresses.some(
-        ({ address }) =>
-          IP_RANGES.some(it => it.test(address)) ||
-          INTERFACES_ADDRESSES.has(address),
-      )
-    );
-  } catch (_) {
-    return false;
-  }
+    const addresses = await lookup(ipOrHostname, {
+      all: true,
+      family: 0,
+      verbatim: true,
+      hints: ADDRCONFIG,
+    });
+    if (!Array.isArray(addresses)) return false;
+    for (const { address } of addresses) {
+      if (await isLocalhost(address, canBind)) return true;
+    }
+    // eslint-disable-next-line no-empty
+  } catch {}
+  return false;
 }
 
 module.exports = isLocalhost;

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "is-localhost-ip",
-  "version": "1.2.0",
-  "description": "Checks whether given DNS name or IPv4/IPv6 address belongs to local machine",
+  "version": "2.0.0",
+  "description": "Checks whether given DNS name or IPv4/IPv6 address belongs to a local machine",
   "main": "index.js",
   "files": [
     "index.js",
-    "index.d.ts",
-    "index.js.flow"
+    "index.d.ts"
   ],
   "types": "index.d.ts",
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "scripts": {
-    "test": "jest --coverage --verbose"
+    "test": "jest --coverage --verbose",
+    "lint": "eslint ."
   },
   "repository": {
     "type": "git",
@@ -29,19 +29,21 @@
     "dns"
   ],
   "author": "Konstantin Vyatkin <tino@vtkn.io>",
-  "license": "GPL-3.0",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/tinovyatkin/is-localhost-ip/issues"
   },
   "homepage": "https://github.com/tinovyatkin/is-localhost-ip#readme",
   "devDependencies": {
-    "@types/jest": "24.0.18",
-    "@types/node": "12.7.2",
-    "eslint-plugin-node": "9.1.0",
-    "eslint": "6.2.2",
-    "jest": "24.9.0",
-    "jest-junit": "7.0.0",
-    "prettier": "1.18.2"
+    "@types/jest": "28.1.6",
+    "@types/node": "~12",
+    "eslint": "8.21.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-regexp": "^1.8.0",
+    "jest": "28.1.3",
+    "prettier": "2.7.1"
   },
   "jest": {
     "coverageReporters": [
@@ -50,8 +52,8 @@
       "cobertura",
       "lcov"
     ],
+    "coverageProvider": "v8",
     "testEnvironment": "node",
     "collectCoverage": true
-  },
-  "dependencies": {}
+  }
 }

package/index.js.flow

@@ -1,3 +0,0 @@
-// @flow
-
-declare module.exports: (addrOrHost: string) => Promise.<Boolean>;