dns2 1.5.0 → 2.0.2

package/.eslintrc

@@ -0,0 +1,16 @@
+{
+  "extends": "semistandard",
+  "rules": {
+    "space-before-function-paren": ["error", "never"],
+    "no-multi-spaces": ["error"],
+    "array-bracket-spacing": ["error", "always"],
+    "key-spacing": ["error", {
+      "align": {
+        "beforeColon": true,
+        "afterColon": true,
+        "on": "colon"
+      }
+    }],
+    "comma-dangle": ["error", "always-multiline"]
+  }
+}

package/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: song940
+patreon: song940
+open_collective: song940
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: https://git.io/fjRcB

package/.github/workflows/lint.js.yml

@@ -0,0 +1,17 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Linting
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: 16
+    - run: npm i
+    - run: npm run lint

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
+        node-version: [10.x, 12.x, 14.x, 16.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -26,5 +26,4 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
-    - run: npm run build --if-present
     - run: npm test

package/README.md

@@ -1,7 +1,7 @@
 # dns2 
 
 ![NPM version](https://img.shields.io/npm/v/dns2.svg?style=flat)
-[![Build Status](https://travis-ci.org/song940/node-dns.svg?branch=master)](https://travis-ci.org/song940/node-dns)
+[![Node.js CI](https://github.com/song940/node-dns/actions/workflows/node.js.yml/badge.svg)](https://github.com/song940/node-dns/actions/workflows/node.js.yml)
 
 > A DNS Server and Client Implementation in Pure JavaScript with no dependencies.
 
@@ -124,25 +124,56 @@ const dns2 = require('dns2');
 
 const { Packet } = dns2;
 
-const server = dns2.createUDPServer((request, send, rinfo) => {
-  const response = Packet.createResponseFromRequest(request);
-  const [ question ] = request.questions;
-  const { name } = question;
-  response.answers.push({
-    name,
-    type: Packet.TYPE.A,
-    class: Packet.CLASS.IN,
-    ttl: 300,
-    address: '8.8.8.8'
-  });
-  send(response);
+const server = dns2.createServer({
+  udp: true,
+  handle: (request, send, rinfo) => {
+    const response = Packet.createResponseFromRequest(request);
+    const [ question ] = request.questions;
+    const { name } = question;
+    response.answers.push({
+      name,
+      type: Packet.TYPE.A,
+      class: Packet.CLASS.IN,
+      ttl: 300,
+      address: '8.8.8.8'
+    });
+    send(response);
+  }
 });
 
 server.on('request', (request, response, rinfo) => {
   console.log(request.header.id, request.questions[0]);
 });
 
-server.listen(5333);
+server.on('requestError', (error) => {
+  console.log('Client sent an invalid request', error);
+});
+
+server.on('listening', () => {
+  console.log(server.addresses());
+});
+
+server.on('close', () => {
+  console.log('server closed');
+});
+
+server.listen({
+  // Optionally specify port, address and/or the family of socket() for udp server:
+  udp: { 
+    port: 5333,
+    address: "127.0.0.1",
+    type: "udp4",  // IPv4 or IPv6 (Must be either "udp4" or "udp6")
+  },
+  
+  // Optionally specify port and/or address for tcp server:
+  tcp: { 
+    port: 5333,
+    address: "127.0.0.1",
+  },
+});
+
+// eventually
+server.close();
 ```
 
 Then you can test your DNS server:
@@ -175,7 +206,7 @@ will be found in `request.questions[0].name`.
 
 ### MIT license
 
-Copyright (c) 2016 lsong
+Copyright (c) 2016 LIU SONG <song940@gmail.com> & [contributors](https://github.com/song940/node-dns/graphs/contributors).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/client/doh.js

@@ -1,11 +1,12 @@
-const https = require('https');
 const Packet = require('../packet');
 
-const get = url => new Promise(resolve => {
+const defaultGet = url => new Promise((resolve, reject) => {
   const headers = {
-    accept: 'application/dns-message'
+    accept: 'application/dns-message',
   };
-  https.get(url, { headers }, resolve);
+  const base = url.startsWith('https') ? require('https') : require('http');
+  const req = base.get(url, { headers }, resolve);
+  req.on('error', reject);
 });
 
 const readStream = stream => {
@@ -13,30 +14,37 @@ const readStream = stream => {
   return new Promise((resolve, reject) => {
     stream
       .on('error', reject)
-      .on('data', chunk => buffer.push(chunk)) 
+      .on('data', chunk => buffer.push(chunk))
       .on('end', () => resolve(Buffer.concat(buffer)));
-  })
+  });
 };
 
 /**
  * @docs https://tools.ietf.org/html/rfc8484
- * @param {*} param0 
+ * @param {*} param0
  */
-const DOHClient = ({ dns } = {}) => {
-  return (name, type = 'A', cls = Packet.CLASS.IN) => {
+const DOHClient = ({ dns, http, get = defaultGet } = {}) => {
+  return (name, type = 'A', cls = Packet.CLASS.IN, { clientIp, recursive = true } = {}) => {
     const packet = new Packet();
+    // see https://github.com/song940/node-dns/issues/29
+    if (recursive) {
+      packet.header.rd = 1;
+    }
+    if (clientIp) {
+      packet.additionals.push(Packet.Resource.EDNS([
+        Packet.Resource.EDNS.ECS(clientIp),
+      ]));
+    }
     packet.questions.push({
       name,
-      class: cls,
-      type: Packet.TYPE[type],
+      class : cls,
+      type  : Packet.TYPE[type],
     });
     const query = packet.toBase64URL();
-    return Promise
-      .resolve()
-      .then(() => get(`https://${dns}/dns-query?dns=${query}`))
+    return Promise.resolve(get(`http${http ? '' : 's'}://${dns}/dns-query?dns=${query}`))
       .then(readStream)
-      .then(Packet.parse)
+      .then(Packet.parse);
   };
 };
 
-module.exports = DOHClient;
+module.exports = DOHClient;

package/client/google.js

@@ -9,19 +9,19 @@ const readStream = stream => {
     stream
       .on('error', reject)
       .on('data', chunk => {
-        buffer.push(chunk)
+        buffer.push(chunk);
       })
       .on('end', () => resolve(Buffer.concat(buffer)));
   });
 };
 
-const GoogleClient = ({ }) =>
+const GoogleClient = () =>
   (name, type = 'ANY') => {
     return Promise
       .resolve()
       .then(() => get(`https://dns.google.com/resolve?name=${name}&type=${type}`))
       .then(readStream)
-      .then(JSON.parse)
+      .then(JSON.parse);
   };
 
-module.exports = GoogleClient;
+module.exports = GoogleClient;

package/client/tcp.js

@@ -2,33 +2,33 @@ const tcp = require('net');
 const Packet = require('../packet');
 
 module.exports = ({ dns = '1.1.1.1', port = 53 } = {}) => {
-  return async (name, type = 'A', cls = Packet.CLASS.IN, { clientIp, recursive = true } = {}) => {
+  return async(name, type = 'A', cls = Packet.CLASS.IN, { clientIp, recursive = true } = {}) => {
     const packet = new Packet();
 
     // see https://github.com/song940/node-dns/issues/29
     if (recursive) {
-      query.header.rd = 1;
+      packet.header.rd = 1;
     }
     if (clientIp) {
-      query.additionals.push(Packet.Resource.EDNS([
-        Packet.Resource.EDNS.ECS(clientIp)
+      packet.additionals.push(Packet.Resource.EDNS([
+        Packet.Resource.EDNS.ECS(clientIp),
       ]));
-    };
+    }
 
     packet.questions.push({
       name,
-      class: cls,
-      type: Packet.TYPE[type],
+      class : cls,
+      type  : Packet.TYPE[type],
     });
     const message = packet.toBuffer();
     const len = Buffer.alloc(2);
     len.writeUInt16BE(message.length);
     const client = tcp.connect({ host: dns, port });
-    client.end(Buffer.concat([len, message]));
+    client.end(Buffer.concat([ len, message ]));
     const data = await Packet.readStream(client);
     if (!data.length) {
       throw new Error('Empty TCP response');
     }
     return Packet.parse(data);
-  }
-};
+  };
+};

package/client/udp.js

@@ -16,13 +16,13 @@ module.exports = ({ dns = '8.8.8.8', port = 53, socketType = 'udp4' } = {}) => {
     }
     if (clientIp) {
       query.additionals.push(Packet.Resource.EDNS([
-        Packet.Resource.EDNS.ECS(clientIp)
+        Packet.Resource.EDNS.ECS(clientIp),
       ]));
-    };
+    }
     query.questions.push({
       name,
-      class: cls,
-      type: Packet.TYPE[type],
+      class : cls,
+      type  : Packet.TYPE[type],
     });
     const client = new udp.Socket(socketType);
     return new Promise((resolve, reject) => {
@@ -35,5 +35,5 @@ module.exports = ({ dns = '8.8.8.8', port = 53, socketType = 'udp4' } = {}) => {
       debug('send', dns, query.toBuffer());
       client.send(query.toBuffer(), port, dns, err => err && reject(err));
     });
-  }
-};
+  };
+};

package/example/client/doh.js

@@ -1,12 +1,12 @@
 const { DOHClient } = require('../..');
 
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+
 const resolve = DOHClient({
-  dns: '1.1.1.1'
+  dns: '1.1.1.1',
 });
 
-(async () => {
-
+(async() => {
   const response = await resolve('google.com');
   console.log(response.answers);
-
-})();
+})();

package/example/client/google.js

@@ -1,8 +1,7 @@
 const { GoogleClient } = require('../..');
 
-(async () => {
+(async() => {
   const resolve = GoogleClient();
   const response = await resolve('google.com');
   console.log(response);
-
 })();

package/example/client/tcp-custom-dns.js

@@ -1,10 +1,10 @@
 const { TCPClient } = require('../..');
 
 const resolve = TCPClient({
-  dns: '1.1.1.1'
+  dns: '1.1.1.1',
 });
 
-(async () => {
-  const response = await resolve('google.com')
+(async() => {
+  const response = await resolve('google.com');
   console.log(response.answers);
-})();
+})();

package/example/client/tcp.js

@@ -2,11 +2,11 @@ const { TCPClient } = require('../..');
 
 const resolve = TCPClient();
 
-(async () => {
+(async() => {
   try {
-    const response = await resolve('google.com')
+    const response = await resolve('google.com');
     console.log(response.answers);
-  } catch(error) {
+  } catch (error) {
     console.log(error);
   }
-})();
+})();

package/example/client/udp-custom-dns.js

@@ -2,10 +2,10 @@ const dns = require('dns');
 const { UDPClient } = require('../..');
 
 const resolve = UDPClient({
-  dns: dns.getServers()[0]
+  dns: dns.getServers()[0],
 });
 
-(async () => {
-  const response = await resolve('google.com')
+(async() => {
+  const response = await resolve('google.com');
   console.log(response.answers);
-})();
+})();

package/example/client/udp-default.js

@@ -2,7 +2,7 @@ const DNS = require('../..');
 
 const dns = new DNS();
 
-(async () => {
+(async() => {
   const result = await dns.resolveA('google.com');
   console.log(result.answers);
-})();
+})();

package/example/client/udp-subnet.js

@@ -1,9 +1,9 @@
 const DNS = require('../..');
 
 // Lookup directly from ns1.google.com
-const dns = new DNS({nameServers: ['216.239.32.10']});
+const dns = new DNS({ nameServers: [ '216.239.32.10' ] });
 
-(async () => {
+(async() => {
   // What is the IP address for google.com if a client in the subnet
   // '178.67.222.0/24' asks for it?
   const result = await dns.resolveA('google.com', '178.67.222.0/24');

package/example/client/udp.js

@@ -2,7 +2,7 @@ const { UDPClient } = require('../..');
 
 const resolve = UDPClient();
 
-(async () => {
-  const response = await resolve('google.com')
+(async() => {
+  const response = await resolve('google.com');
   console.log(response.answers);
-})();
+})();

package/example/server/dns.js

@@ -0,0 +1,46 @@
+const dns = require('../..');
+const path = require('path');
+const fs = require('fs');
+
+const { Packet } = dns;
+
+// Create a SSL enabled server
+const server = dns.createServer({
+  udp : true,
+  tcp : true,
+  doh : {
+    ssl  : true,
+    cert : fs.readFileSync(path.join(__dirname, 'server.crt')),
+    key  : fs.readFileSync(path.join(__dirname, 'secret.key')),
+  },
+});
+
+// Handle the incomming request (same style as both UDP and TCP server)
+server.on('request', (request, send, client) => {
+  const response = Packet.createResponseFromRequest(request);
+  const [ question ] = request.questions;
+  const { name } = question;
+  response.answers.push({
+    name,
+    type    : Packet.TYPE.A,
+    class   : Packet.CLASS.IN,
+    ttl     : 300,
+    address : '1.1.1.1',
+  });
+  send(response);
+});
+
+(async() => {
+  const closed = new Promise(resolve => process.on('SIGINT', resolve));
+  await server.listen({
+    doh : 8443,
+    udp : 5333,
+    tcp : 5334,
+  });
+  console.log('Listening.');
+  console.log(server.addresses());
+  await closed;
+  process.stdout.write('\n');
+  await server.close();
+  console.log('Closed.');
+})();

package/example/server/doh.js

@@ -6,23 +6,25 @@ const { Packet } = dns;
 
 // Create a SSL enabled server
 const server = dns.createDOHServer({
-    port: 0,
-    sslport: 443,
-    cert: fs.readFileSync(path.join(__dirname,"server.crt")),
-    key: fs.readFileSync(path.join(__dirname,"secret.key"))  
+  port : 8080,
+  ssl  : true,
+  cert : fs.readFileSync(path.join(__dirname, 'server.crt')),
+  key  : fs.readFileSync(path.join(__dirname, 'secret.key')),
 });
 
-//Handle the incomming request (same style as both UDP and TCP server)
+// Handle the incomming request (same style as both UDP and TCP server)
 server.on('request', (request, send, client) => {
-    const response = Packet.createResponseFromRequest(request);
-    const [ question ] = request.questions;
-    const { name } = question;
-    response.answers.push({
-      name,
-      type: Packet.TYPE.A,
-      class: Packet.CLASS.IN,
-      ttl: 300,
-      address: '8.8.8.8'
-    });
-    send(response);
+  const response = Packet.createResponseFromRequest(request);
+  const [ question ] = request.questions;
+  const { name } = question;
+  response.answers.push({
+    name,
+    type    : Packet.TYPE.A,
+    class   : Packet.CLASS.IN,
+    ttl     : 300,
+    address : '1.1.1.1',
   });
+  send(response);
+});
+
+server.listen();

package/example/server/tcp.js

@@ -6,14 +6,14 @@ const server = dns.createTCPServer();
 
 server.on('request', (request, send, client) => {
   const response = Packet.createResponseFromRequest(request);
-  const answer = new Packet.createResourceFromQuestion(request.questions[0], {
-    target: 'hermes2.jabber.org',
-    port: 8080,
-    weight: 30,
-    priority: 30
+  const answer = Packet.createResourceFromQuestion(request.questions[0], {
+    target   : 'hermes2.jabber.org',
+    port     : 8080,
+    weight   : 30,
+    priority : 30,
   });
   response.answers.push(answer);
   send(response);
 });
 
-server.listen(5333);
+server.listen(5333);

package/example/server/udp.js

@@ -8,10 +8,10 @@ const server = dns.createUDPServer((request, send, rinfo) => {
   const { name } = question;
   response.answers.push({
     name,
-    type: Packet.TYPE.A,
-    class: Packet.CLASS.IN,
-    ttl: 300,
-    address: '8.8.8.8'
+    type    : Packet.TYPE.A,
+    class   : Packet.CLASS.IN,
+    ttl     : 300,
+    address : '8.8.8.8',
   });
   send(response);
 });

package/index.js

@@ -5,6 +5,7 @@ const {
   createTCPServer,
   createUDPServer,
   createDOHServer,
+  createServer,
 } = require('./server');
 const EventEmitter = require('events');
 
@@ -17,24 +18,25 @@ class DNS extends EventEmitter {
   constructor(options) {
     super();
     Object.assign(this, {
-      port: 53,
-      retries: 3,
-      timeout: 3,
-      recursive: true,
-      resolverProtocol: 'UDP',
-      nameServers: [
+      port             : 53,
+      retries          : 3,
+      timeout          : 3,
+      recursive        : true,
+      resolverProtocol : 'UDP',
+      nameServers      : [
         '8.8.8.8',
         '114.114.114.114',
       ],
       rootServers: [
         'a', 'b', 'c', 'd', 'e', 'f',
-        'g', 'h', 'i', 'j', 'k', 'l', 'm'
-      ].map(x => `${x}.root-servers.net`)
+        'g', 'h', 'i', 'j', 'k', 'l', 'm',
+      ].map(x => `${x}.root-servers.net`),
     }, options);
   }
+
   /**
    * query
-   * @param {*} questions 
+   * @param {*} questions
    */
   query(name, type, cls, clientIp) {
     const { port, nameServers, recursive, resolverProtocol = 'UDP' } = this;
@@ -44,27 +46,33 @@ class DNS extends EventEmitter {
       return resolve(name, type, cls, clientIp);
     }));
   }
+
   /**
    * resolve
-   * @param {*} domain 
-   * @param {*} type 
-   * @param {*} cls 
+   * @param {*} domain
+   * @param {*} type
+   * @param {*} cls
    */
-  resolve(domain, type = 'ANY', cls = DNS.Packet.CLASS.IN, clientIp) {
+  resolve(domain, type = 'ANY', cls = DNS.Packet.CLASS.IN, clientIp = undefined) {
     return this.query(domain, type, cls, clientIp);
   }
+
   resolveA(domain, clientIp) {
     return this.resolve(domain, 'A', undefined, clientIp);
   }
+
   resolveAAAA(domain) {
     return this.resolve(domain, 'AAAA');
   }
+
   resolveMX(domain) {
     return this.resolve(domain, 'MX');
   }
+
   resolveCNAME(domain) {
     return this.resolve(domain, 'CNAME');
   }
+
   resolvePTR(domain) {
     return this.resolve(domain, 'PTR');
   }
@@ -77,6 +85,7 @@ DNS.DOHServer = DOHServer;
 DNS.createUDPServer = createUDPServer;
 DNS.createTCPServer = createTCPServer;
 DNS.createDOHServer = createDOHServer;
+DNS.createServer = createServer;
 
 DNS.TCPClient = require('./client/tcp');
 DNS.DOHClient = require('./client/doh');
@@ -86,4 +95,3 @@ DNS.GoogleClient = require('./client/google');
 DNS.Packet = require('./packet');
 
 module.exports = DNS;
-