tangerine 1.4.9 → 1.5.1

package/README.md

@@ -51,11 +51,12 @@
   * [`tangerine.resolveSoa(hostname[, options, abortController]))`](#tangerineresolvesoahostname-options-abortcontroller)
   * [`tangerine.resolveSrv(hostname[, options, abortController]))`](#tangerineresolvesrvhostname-options-abortcontroller)
   * [`tangerine.resolveTxt(hostname[, options, abortController]))`](#tangerineresolvetxthostname-options-abortcontroller)
-  * [`tangerine.resolveCert(hostname, [, options, abortController]))`](#tangerineresolvecerthostname--options-abortcontroller)
-  * [`tangerine.resolveTlsa(hostname, [, options, abortController]))`](#tangerineresolvetlsahostname--options-abortcontroller)
+  * [`tangerine.resolveCert(hostname[, options, abortController]))`](#tangerineresolvecerthostname-options-abortcontroller)
+  * [`tangerine.resolveTlsa(hostname[, options, abortController]))`](#tangerineresolvetlsahostname-options-abortcontroller)
   * [`tangerine.reverse(ip[, abortController, purgeCache])`](#tangerinereverseip-abortcontroller-purgecache)
   * [`tangerine.setDefaultResultOrder(order)`](#tangerinesetdefaultresultorderorder)
   * [`tangerine.setServers(servers)`](#tangerinesetserversservers)
+  * [`tangerine.spoofPacket(hostname, rrtype, answers[, json])`](#tangerinespoofpackethostname-rrtype-answers-json)
 * [Options](#options)
 * [Cache](#cache)
 * [Compatibility](#compatibility)
@@ -273,7 +274,7 @@ Tangerine supports a new `ecsSubnet` property in the `options` Object argument.
 
 ### `tangerine.resolveTxt(hostname[, options, abortController]))`
 
-### `tangerine.resolveCert(hostname, [, options, abortController]))`
+### `tangerine.resolveCert(hostname[, options, abortController]))`
 
 This function returns a Promise that resolves with an Array with parsed values from results:
 
@@ -292,7 +293,7 @@ This function returns a Promise that resolves with an Array with parsed values f
 
 This mirrors output from <https://github.com/rthalley/dnspython>.
 
-### `tangerine.resolveTlsa(hostname, [, options, abortController]))`
+### `tangerine.resolveTlsa(hostname[, options, abortController]))`
 
 This method was added for DANE and TLSA support.  See this [excellent article](https://www.mailhardener.com/kb/dane), [index.js](https://github.com/forwardemail/tangerine/blob/main/index.js), and <https://github.com/nodejs/node/issues/39569> for more insight.
 
@@ -331,6 +332,50 @@ This mirrors output from <https://github.com/rthalley/dnspython>.
 
 ### `tangerine.setServers(servers)`
 
+### `tangerine.spoofPacket(hostname, rrtype, answers[, json])`
+
+This method is useful for writing tests to spoof DNS packets in-memory.
+
+The `rrtype` must be either `"TXT"` or `"MX"`, and `answers` must be an Array of DNS resource record answers.
+
+If you pass `json` as `true`, then value returned will be converted to JSON via `JSON.stringify`.
+
+For example, if you want to spoof TXT and MX records:
+
+```js
+const Redis = require('ioredis-mock');
+const Tangerine = require('tangerine');
+const ip = require('ip');
+
+const cache = new Redis();
+const tangerine = new Tangerine({ cache });
+
+const obj = {};
+
+obj['txt:forwardmail.net'] = tangerine.spoofPacket('forwardmail.net', 'TXT', [
+  `v=spf1 ip4:${ip.address()} -all`
+]);
+
+obj['mx:forwardemail.net'] = tangerine.spoofPacket('forwardemail.net', 'MX', [
+  { exchange: 'mx1.forwardemail.net', preference: 0 },
+  { exchange: 'mx2.forwardemail.net', preference: 0 }
+]);
+
+await cache.mset(obj);
+
+//
+// NOTE: spoofed values are used below (this means no DNS query performed)
+//
+
+const txt = await tangerine.resolveTxt('forwardemail.net');
+console.log('txt', txt);
+
+const mx = await tangerine.resolveMx('forwardemail.net');
+console.log('mx', mx);
+```
+
+**Pull requests are welcome to add support for other `rrtype` values for this method.**
+
 
 ## Options
 

package/index.js

@@ -6,9 +6,7 @@ const { Buffer } = require('node:buffer');
 const { debuglog } = require('node:util');
 const { getEventListeners, setMaxListeners } = require('node:events');
 const { isIP, isIPv4, isIPv6 } = require('node:net');
-
 const { toASCII } = require('punycode/');
-
 const autoBind = require('auto-bind');
 const getStream = require('get-stream');
 const hostile = require('hostile');
@@ -21,7 +19,6 @@ const packet = require('dns-packet');
 const semver = require('semver');
 const structuredClone = require('@ungap/structured-clone').default;
 const { getService } = require('port-numbers');
-
 const pkg = require('./package.json');
 
 const debug = debuglog('tangerine');
@@ -123,21 +120,21 @@ class Tangerine extends dns.promises.Resolver {
 
       // if all errors had `name` and they were all the same then preserve it
       if (
-        typeof errors[0].name !== 'undefined' &&
+        errors[0].name !== undefined &&
         errors.every((e) => e.name === errors[0].name)
       )
         err.name = errors[0].name;
 
       // if all errors had `code` and they were all the same then preserve it
       if (
-        typeof errors[0].code !== 'undefined' &&
+        errors[0].code !== undefined &&
         errors.every((e) => e.code === errors[0].code)
       )
         err.code = errors[0].code;
 
       // if all errors had `errno` and they were all the same then preserve it
       if (
-        typeof errors[0].errno !== 'undefined' &&
+        errors[0].errno !== undefined &&
         errors.every((e) => e.errno === errors[0].errno)
       )
         err.errno = errors[0].errno;
@@ -607,7 +604,7 @@ class Tangerine extends dns.promises.Resolver {
 
       options = { family: options };
     } else if (
-      typeof options?.family !== 'undefined' &&
+      options?.family !== undefined &&
       ![0, 4, 6, 'IPv4', 'IPv6'].includes(options.family)
     ) {
       // validate family
@@ -761,7 +758,7 @@ class Tangerine extends dns.promises.Resolver {
     if (answers.length > 0)
       answers =
         answers[0].length > 0 &&
-        (typeof options.family === 'undefined' || options.family === 0)
+        (options.family === undefined || options.family === 0)
           ? answers[0]
           : answers.flat();
 
@@ -1428,6 +1425,76 @@ class Tangerine extends dns.promises.Resolver {
     this.options.servers = new Set(servers);
   }
 
+  spoofPacket(name, rrtype, answers = [], json = false) {
+    if (typeof name !== 'string') {
+      const err = new TypeError('The "name" argument must be of type string.');
+      err.code = 'ERR_INVALID_ARG_TYPE';
+      throw err;
+    }
+
+    if (typeof rrtype !== 'string') {
+      const err = new TypeError(
+        'The "rrtype" argument must be of type string.'
+      );
+      err.code = 'ERR_INVALID_ARG_TYPE';
+      throw err;
+    }
+
+    if (!this.constructor.TYPES.has(rrtype)) {
+      const err = new TypeError("The argument 'rrtype' is invalid.");
+      err.code = 'ERR_INVALID_ARG_VALUE';
+      throw err;
+    }
+
+    if (!Array.isArray(answers)) {
+      const err = new TypeError("The argument 'answers' is invalid.");
+      err.code = 'ERR_INVALID_ARG_VALUE';
+      throw err;
+    }
+
+    const obj = {
+      id: 0,
+      type: 'response',
+      flags: 384,
+      flag_qr: true,
+      opcode: 'QUERY',
+      flag_aa: false,
+      flag_tc: false,
+      flag_rd: true,
+      flag_ra: true,
+      flag_z: false,
+      flag_ad: false,
+      flag_cd: false,
+      rcode: 'NOERROR',
+      questions: [{ name, type: rrtype, class: 'IN' }],
+      answers: answers.map((answer) => ({
+        name,
+        type: rrtype,
+        ttl: 300,
+        class: 'IN',
+        flush: false,
+        data: rrtype === 'TXT' ? [answer] : answer
+      })),
+      authorities: [],
+      additionals: [
+        {
+          name: '.',
+          type: 'OPT',
+          udpPayloadSize: 1232,
+          extendedRcode: 0,
+          ednsVersion: 0,
+          flags: 0,
+          flag_do: false,
+          options: [Array]
+        }
+      ],
+      ttl: 300,
+      expires: Date.now() + 10000
+    };
+
+    return json ? JSON.stringify(obj) : obj;
+  }
+
   // eslint-disable-next-line complexity
   async resolve(name, rrtype = 'A', options = {}, abortController) {
     if (typeof name !== 'string') {
@@ -1481,6 +1548,17 @@ class Tangerine extends dns.promises.Resolver {
       //       (this saves us from duplicating the same `...sort().filter(Number.isFinite)` logic)
       //
       data = await this.options.cache.get(key);
+      //
+      // if it's not an object then assume that
+      // the cache implementation does not have JSON.parse built-in
+      // and so we should try to parse it on our own (user-friendly)
+      //
+      if (typeof data === 'string') {
+        try {
+          data = JSON.parse(data);
+        } catch {}
+      }
+
       // safeguard in case cache pollution
       if (data && typeof data === 'object') {
         debug('cache retrieved', key);
@@ -1830,11 +1908,10 @@ class Tangerine extends dns.promises.Resolver {
               algorithm: answer.data.subarray(4, 5).readUInt8(),
               certificate: answer.data.subarray(5).toString('base64')
             };
-            obj.certificate_type = this.constructor.CTYPE_BY_VALUE[
-              obj.certificate_type
-            ]
-              ? this.constructor.CTYPE_BY_VALUE[obj.certificate_type]
-              : obj.certificate_type.toString();
+            if (this.constructor.CTYPE_BY_VALUE[obj.certificate_type])
+              obj.certificate_type =
+                this.constructor.CTYPE_BY_VALUE[obj.certificate_type];
+            else obj.certificate_type = obj.certificate_type.toString();
             return obj;
           } catch (err) {
             this.options.logger.error(err, { name, rrtype, options, answer });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tangerine",
   "description": "Tangerine is the best Node.js drop-in replacement for dns.promises.Resolver using DNS over HTTPS (\"DoH\") via undici with built-in retries, timeouts, smart server rotation, AbortControllers, and caching support for multiple backends (with TTL and purge support).",
-  "version": "1.4.9",
+  "version": "1.5.1",
   "author": "Forward Email (https://forwardemail.net)",
   "bugs": {
     "url": "https://github.com/forwardemail/tangerine/issues"
@@ -10,9 +10,9 @@
     "Forward Email (https://forwardemail.net)"
   ],
   "dependencies": {
-    "@ungap/structured-clone": "^1.0.2",
+    "@ungap/structured-clone": "^1.2.0",
     "auto-bind": "4",
-    "dns-packet": "^5.4.0",
+    "dns-packet": "^5.6.0",
     "dohdec": "^5.0.3",
     "get-stream": "6",
     "hostile": "^1.3.3",
@@ -21,16 +21,16 @@
     "p-map": "4",
     "p-timeout": "4",
     "p-wait-for": "3",
-    "port-numbers": "^6.0.1",
+    "port-numbers": "6.0.1",
     "private-ip": "^3.0.0",
     "punycode": "^2.3.0",
-    "semver": "^7.3.8"
+    "semver": "^7.5.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.4.4",
-    "@commitlint/config-conventional": "^17.4.4",
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
     "ava": "^5.2.0",
-    "axios": "^1.3.4",
+    "axios": "^1.4.0",
     "benchmark": "^2.1.4",
     "cross-env": "^7.0.3",
     "eslint": "^8.34.0",
@@ -39,12 +39,12 @@
     "fixpack": "^4.0.0",
     "got": "11",
     "husky": "^8.0.3",
-    "ioredis": "^5.3.1",
-    "ioredis-mock": "^8.2.6",
+    "ioredis": "^5.3.2",
+    "ioredis-mock": "^8.7.0",
     "is-ci": "^3.0.1",
-    "lint-staged": "^13.1.2",
+    "lint-staged": "^13.2.2",
     "lodash": "^4.17.21",
-    "nock": "^13.3.0",
+    "nock": "^13.3.1",
     "node-fetch": "2",
     "nyc": "^15.1.0",
     "phin": "^3.7.0",
@@ -53,8 +53,8 @@
     "request": "^2.88.2",
     "sort-keys": "4.2.0",
     "superagent": "^8.0.9",
-    "undici": "^5.20.0",
-    "xo": "^0.53.1"
+    "undici": "^5.22.1",
+    "xo": "^0.54.2"
   },
   "engines": {
     "node": ">=16"