@k03mad/dns-leak 1.0.0 → 1.2.0

package/.github/workflows/eslint.yml

@@ -22,7 +22,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install NodeJS
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
 

package/README.md

@@ -1,3 +1,36 @@
 # DNS leak test
 
-Based on [ipleak.net](https://ipleak.net/)
+Based on: [ipleak.net](https://ipleak.net/) / [API](https://airvpn.org/forums/topic/14737-api/)
+
+## Global
+
+```bash
+npm i @k03mad/dns-leak -g
+
+dns-leak
+```
+
+## API
+
+```bash
+npm i @k03mad/dns-leak
+```
+
+```js
+import IPLeak from '@k03mad/dns-leak';
+
+// default params (details at the link below)
+const api = new IPLeak();
+
+// get current external ip info
+await api.getIpInfo();
+// get other ip info
+await api.getIpInfo({ip: '8.8.8.8'});
+
+// dns leak check with one request (one request — fewer dns ips)
+await api.getDnsInfoOnce();
+// dns leak check with multi requests
+await api.getDnsInfoMulti();
+```
+
+[Options and parameters with their default values](/app/api/IPLeak.js#L8)

package/app/api/IPLeak.js

@@ -2,37 +2,52 @@ import {request, requestCache} from '@k03mad/request';
 import {customAlphabet} from 'nanoid';
 import {lowercase, numbers} from 'nanoid-dictionary';
 
+import {sleep} from '../helpers/promise.js';
+import * as spinner from '../helpers/spinner.js';
+
 /** */
 export default class IPLeak {
 
     /**
-     * @param {number} [ipRequestsRps]
-     * @param {number} [ipRequestsCacheExpireMs]
-     * @param {number} [dnsRequestsCount]
-     * @param {number} [dnsRequestsRps]
-     * @param {number} [dnsSessionStringLength]
-     * @param {number} [dnsUniqStringLength]
+     * All args are not required, the default ones works fine
+     * @param {object} [opts]
+     * @param {number} [opts.dnsRequestsCount] dns leak multi requests count with one session
+     * @param {number} [opts.dnsRequestsRps] dns leak requests rps
+     * @param {number} [opts.dnsRequestsWaitBeforeLastMs] dns leak multi requests wait before the last request (with all ips gathered)
+     * @param {number} [opts.dnsSessionStringLength] dns leak session string length, only works with 40 characters for now
+     * @param {number} [opts.dnsUniqStringLength] dns leak unique string length for subdomain
+     * @param {number} [opts.ipRequestsCacheExpireMs] ip info requests cache ttl ms for same ip
+     * @param {number} [opts.ipRequestsRps] ip info requests rps
      */
-    constructor(
-        ipRequestsRps = 2,
-        ipRequestsCacheExpireMs = 3_600_000,
+    constructor({
         dnsRequestsCount = 30,
         dnsRequestsRps = 2,
+        dnsRequestsWaitBeforeLastMs = 2000,
         dnsSessionStringLength = 40,
         dnsUniqStringLength = 20,
-    ) {
-        this._ipRequestsRps = ipRequestsRps;
-        this._ipRequestsCacheExpireMs = ipRequestsCacheExpireMs;
+        ipRequestsCacheExpireMs = 3_600_000,
+        ipRequestsRps = 2,
+    } = {}) {
         this._dnsRequestsCount = dnsRequestsCount;
         this._dnsRequestsRps = dnsRequestsRps;
-        this._dnsUniqStringLength = dnsUniqStringLength;
+        this._dnsRequestsWaitBeforeLastMs = dnsRequestsWaitBeforeLastMs;
         this._dnsSessionStringLength = dnsSessionStringLength;
+        this._dnsUniqStringLength = dnsUniqStringLength;
+        this._ipRequestsCacheExpireMs = ipRequestsCacheExpireMs;
+        this._ipRequestsRps = ipRequestsRps;
     }
 
     /** */
     get _endpoints() {
         return {
-            info: (ip = '') => `https://ipleak.net/json/${ip}`,
+
+            /** @param {string} ip */
+            ip: ip => `https://ipleak.net/json/${ip}`,
+
+            /**
+             * @param {string} session
+             * @param {string} uniq
+             */
             dns: (session, uniq) => `https://${session}-${uniq}.ipleak.net/dnsdetection/`,
         };
     }
@@ -48,11 +63,12 @@ export default class IPLeak {
     }
 
     /**
-     * @param {string} ip
+     * @param {object} [opts]
+     * @param {string} [opts.ip]
      * @returns {Promise<object>}
      */
-    async getIpInfo(ip) {
-        const ipEndpoint = this._endpoints.info(ip);
+    async getIpInfo({ip = ''} = {}) {
+        const ipEndpoint = this._endpoints.ip(ip);
 
         const {body} = await requestCache(ipEndpoint, {}, {
             expire: this._ipRequestsCacheExpireMs,
@@ -63,11 +79,12 @@ export default class IPLeak {
     }
 
     /**
-     * @param {string} [session]
-     * @param {string} [uniqString]
+     * @param {object} [opts]
+     * @param {string} [opts.session]
+     * @param {string} [opts.uniqString]
      * @returns {Promise<object>}
      */
-    async getDnsInfoOnce(session = this._dnsSessionString, uniqString = this._dnsUniqString) {
+    async getDnsInfoOnce({session = this._dnsSessionString, uniqString = this._dnsUniqString} = {}) {
         const dnsEndpoint = this._endpoints.dns(session, uniqString);
 
         const {body} = await request(dnsEndpoint, {}, {queueBy: session, rps: this._dnsRequestsRps});
@@ -75,14 +92,27 @@ export default class IPLeak {
     }
 
     /**
-     * @param {string} [session]
+     * @param {object} [opts]
+     * @param {string} [opts.session]
+     * @param {boolean} [opts.isSpinnerEnabled]
      * @returns {Promise<object>}
      */
-    async getDnsInfoMulti(session = this._dnsSessionString) {
-        const arrayFromLen = Array.from({length: this._dnsRequestsCount});
-        await Promise.all(arrayFromLen.map(() => this.getDnsInfoOnce(session)));
+    async getDnsInfoMulti({isSpinnerEnabled, session = this._dnsSessionString} = {}) {
+        const spinnerName = 'dnsReq';
+        const arrayFromLen = Array.from({length: this._dnsRequestsCount - 1});
+
+        spinner.start(spinnerName, isSpinnerEnabled);
+
+        await Promise.all(arrayFromLen.map(async () => {
+            await this.getDnsInfoOnce({session});
+            spinner.count(spinnerName, this._dnsRequestsCount);
+        }));
+
+        spinner.text(spinnerName, 'Wait for last request');
+        await sleep(this._dnsRequestsWaitBeforeLastMs);
+        const info = await this.getDnsInfoOnce({session});
 
-        const info = await this.getDnsInfoOnce(session);
+        spinner.stop(spinnerName);
         return info;
     }
 

package/app/helpers/log.js

@@ -1,14 +1,5 @@
-import chalk from 'chalk';
-
-const {bgBlackBright, magenta} = chalk;
-
 /**
  * @param {any} msg
  */
 // eslint-disable-next-line no-console
-export const log = (...msg) => console.log(...msg);
-
-/**
- * @param {any} header
- */
-export const logHeader = header => log(`\n${bgBlackBright(magenta(` ${header} `))}\n`);
+export const log = (...msg) => msg.forEach(elem => console.log(elem));

package/app/helpers/promise.js

@@ -0,0 +1,5 @@
+/**
+ * @param {number} ms
+ * @returns {Promise<void>}
+ */
+export const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));

package/app/helpers/spinner.js

@@ -0,0 +1,49 @@
+import ora from 'ora';
+
+import {bar} from './text.js';
+
+export const spinner = {};
+
+/**
+ * @param {string} name
+ * @param {boolean} active
+ */
+export const start = (name, active) => {
+    if (active) {
+        spinner[name] = {
+            instance: ora().start(),
+            counter: 0,
+        };
+
+        return spinner[name].instance;
+    }
+
+    spinner[name] = {instance: {stop: () => ''}};
+};
+
+/**
+ * @param {string} name
+ * @param {string} msg
+ */
+export const text = (name, msg) => {
+    spinner[name].instance.text = bar(msg);
+};
+
+/**
+ * @param {string} name
+ * @param {number} total
+ */
+export const count = (name, total) => {
+    spinner[name].counter++;
+
+    const len = `${String(spinner[name].counter).padStart(String(total).length, '0')}/${total}`;
+    const percent = `${String((spinner[name].counter * 100 / total).toFixed(0)).padStart(2, '0')}%`;
+    text(name, `${len} [${percent}]`);
+};
+
+/**
+ * @param {string} name
+ */
+export const stop = name => {
+    spinner[name].instance.stop();
+};

package/app/helpers/{ip.js → text.js}

@@ -3,7 +3,17 @@
 import chalk from 'chalk';
 import clm from 'country-locale-map';
 
-const {blue, green} = chalk;
+const {bgBlackBright, blue, green, magenta, yellow} = chalk;
+
+/**
+ * @param {any} msg
+ */
+export const header = msg => bgBlackBright(magenta(` ${msg} `));
+
+/**
+ * @param {any} msg
+ */
+export const bar = msg => yellow(msg);
 
 /**
  * @param {object} [ipInfo]
@@ -14,7 +24,7 @@ const {blue, green} = chalk;
  * @param {string} [ipInfo.isp_name]
  * @param {string} [ipInfo.region_name]
  */
-export const formatIpInfo = ({city_name, country_code, country_name, ip, isp_name, region_name}) => {
+export const formatIpInfo = ({city_name, country_code, country_name, ip, isp_name, region_name} = {}) => {
     let output = '';
 
     if (ip) {

package/app/index.js

@@ -1,23 +1,37 @@
 #!/usr/bin/env node
 
 import IPLeak from './api/IPLeak.js';
-import {formatIpInfo} from './helpers/ip.js';
-import {log, logHeader} from './helpers/log.js';
+import {log} from './helpers/log.js';
+import * as spinner from './helpers/spinner.js';
+import {formatIpInfo, header} from './helpers/text.js';
 
 const api = new IPLeak();
 
 const currentIpInfo = await api.getIpInfo();
 
-logHeader('IP');
-log(formatIpInfo(currentIpInfo));
-
-const dnsInfo = await api.getDnsInfoMulti();
+log(
+    '',
+    header('IP'),
+    '',
+    formatIpInfo(currentIpInfo),
+    '',
+    header('DNS'),
+    '',
+);
+
+const dnsInfo = await api.getDnsInfoMulti({isSpinnerEnabled: true});
 const dnsIps = [...new Set(Object.keys(dnsInfo.ip))];
 
-logHeader('DNS');
+spinner.start(currentIpInfo.ip, true);
+
+const dnsData = await Promise.all(dnsIps.map(async ip => {
+    const data = await api.getIpInfo({ip});
+    spinner.count(currentIpInfo.ip, dnsIps.length);
+    return data;
+}));
 
-const dnsData = await Promise.all(dnsIps.map(ip => api.getIpInfo(ip)));
+spinner.stop(currentIpInfo.ip);
 
 dnsData
     .sort((a, b) => a?.ip?.localeCompare(b?.ip))
-    .forEach(data => log(formatIpInfo(data), '\n'));
+    .forEach(data => log(formatIpInfo(data), ''));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/dns-leak",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "DNS leak test",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
@@ -18,12 +18,13 @@
     "chalk": "5.3.0",
     "country-locale-map": "1.8.15",
     "nanoid": "5.0.2",
-    "nanoid-dictionary": "5.0.0-beta.1"
+    "nanoid-dictionary": "5.0.0-beta.1",
+    "ora": "7.0.1"
   },
   "devDependencies": {
     "@k03mad/eslint-config": "13.3.1",
     "@microsoft/eslint-formatter-sarif": "3.0.0",
-    "eslint": "8.53.0",
+    "eslint": "8.52.0",
     "eslint-plugin-import": "2.29.0",
     "eslint-plugin-jsdoc": "46.8.2",
     "eslint-plugin-n": "16.2.0",