Update 'README.md'

README.md

@@ -5,7 +5,7 @@ digd.js
 | [dig.js](https://git.coolaj86.com/coolaj86/dig.js)
 | [mdig.js](https://git.coolaj86.com/coolaj86/mdig.js)
 | **digd.js**
-| Sponsored by [Daplie](https://daplie.com).
+| A [Root project](https://rootprojects.org).
 
 A lightweight DNS / mDNS daemon (server) in node.js.
 
@@ -22,7 +22,7 @@ Install
 ### systemd service
 
 ```bash
-curl -L https://git.coolaj86.com/coolaj86/digd.js/raw/v1.1/install.sh | bash
+curl -L https://git.coolaj86.com/coolaj86/digd.js/raw/v1.2/install.sh | bash
 ```
 
 ### with git
@@ -33,14 +33,13 @@ npm install -g 'git+https://git.coolaj86.com/coolaj86/digd.js.git#v1'
 ```
 
 ```bash
-# Install exactly v1.1.9
-npm install -g 'git+https://git.coolaj86.com/coolaj86/digd.js.git#v1.1.9'
+# Install exactly v1.2.0
+npm install -g 'git+https://git.coolaj86.com/coolaj86/digd.js.git#v1.2.0'
 ```
 
 ### without git
 
-Don't have git? Well, you can also bow down to the gods of the centralized, monopolized, concentrated, *dictator*net
-(as we like to call it here at Daplie Labs), if that's how you roll:
+Don't have git? You can use npm's centralized repository:
 
 ```bash
 npm install -g digd.js
@@ -89,6 +88,8 @@ Options
 +time=<seconds>             Sets the timeout for a query in seconds.
 +norecurse                  Set `ra` flag to 0. Do not perform recursion.
 +aaonly                     Set `aa` flag to 1. Do not respond with non-authoritative responses.
++notcp                      Disable TCP server (default in v1.2)
++tcp                        Enable TCP server (default in v1.3)
 
 --debug                     verbose output
 ```

bin/digd.js

@@ -5,9 +5,7 @@
 var cli = require('cli');
 var pkg = require('../package.json');
 var dig = require('dig.js/dns-request');
-var dgram = require('dgram');
 var dnsjs = require('dns-suite');
-var crypto = require('crypto');
 var common = require('dig.js/common');
 var defaultNameservers = require('dns').getServers();
 var hexdump;
@@ -49,8 +47,32 @@ cli.main(function (args, cli) {
       cli.norecurse = true;
       return;
     }
+    if (arg === '+notcp') {
+      if (cli.notcp) {
+        console.error("'+notcp' was specified more than once");
+        process.exit(1);
+        return;
+      }
+      cli.notcp = true;
+      return;
+    }
+    if (arg === '+tcp') {
+      if (cli.tcp) {
+        console.error("'+tcp' was specified more than once");
+        process.exit(1);
+        return;
+      }
+      cli.tcp = true;
+      return;
+    }
   });
 
+  if (!cli.tcp) {
+    if (!cli.notcp) {
+      console.info("[WARNING] Set '+notcp' to disable tcp connections. The default behavior changes to +tcp in v1.3");
+    }
+  }
+
   if (cli.mdns) {
     if (!cli.type) {
       cli.type = cli.t = 'PTR';
@@ -73,32 +95,10 @@ cli.main(function (args, cli) {
     }
   }
 
-  var handlers = {};
-  var server = dgram.createSocket({
-    type: cli.udp6 ? 'udp6' : 'udp4'
-  , reuseAddr: true
-  });
-  server.bind({
-    port: cli.port
-  , address: cli.address
-  });
-
-  handlers.onError = function (err) {
-    if ('EACCES' === err.code) {
-      console.error("");
-      console.error("EACCES: Couldn't bind to port. You probably need to use sudo, authbind, or setcap.");
-      console.error("");
-      process.exit(123);
-      return;
-    }
-    console.error("error:", err.stack);
-    server.close();
-  };
-
-  handlers.onMessage = function (nb, rinfo) {
-    console.log('[DEBUG] got a message');
-
-    var queryAb = nb.buffer.slice(nb.byteOffset, nb.byteOffset + nb.byteLength);
+  var dnsd = {};
+  dnsd.onMessage = function (nb, cb) {
+    var byteOffset = nb._dnsByteOffset || nb.byteOffset;
+    var queryAb = nb.buffer.slice(byteOffset, byteOffset + nb.byteLength);
     var query;
     var count;
 
@@ -215,12 +215,11 @@ cli.main(function (args, cli) {
         console.error("Could not write empty DNS response");
         console.error(e);
         console.error(emptyResp);
+        cb(e, null, '[DEV] response sent (empty)');
         return;
       }
 
-      server.send(newAb, rinfo.port, rinfo.address, function () {
-        console.log('[DEV] response sent (empty)', rinfo.port, rinfo.address);
-      });
+      cb(null, newAb, '[DEV] response sent (empty)');
     }
 
     function sendResponse(newPacket) {
@@ -232,12 +231,11 @@ cli.main(function (args, cli) {
         console.error("Could not write DNS response from local");
         console.error(e);
         console.error(newPacket);
+        cb(e, null, '[DEV] response sent (local query)');
         return;
       }
 
-      server.send(newAb, rinfo.port, rinfo.address, function () {
-        console.log('[DEV] response sent (local query)', rinfo.port, rinfo.address);
-      });
+      cb(null, newAb, '[DEV] response sent (local query)');
     }
 
     function recurse() {
@@ -290,12 +288,11 @@ cli.main(function (args, cli) {
             } catch(e) {
               console.error("Could not write DNS response");
               console.error(newResponse);
+              cb(e, null, '[DEV] response sent');
               return;
             }
 
-            server.send(newAb, rinfo.port, rinfo.address, function () {
-              console.log('[DEV] response sent', rinfo.port, rinfo.address);
-            });
+            cb(null, newAb, '[DEV] response sent');
           }
         }
 
@@ -335,7 +332,8 @@ cli.main(function (args, cli) {
               console.log('request sent to', res.nameserver);
             }
             */
-            console.log('[DEV] query sent (recurse)', rinfo.port, rinfo.address);
+            //console.log('[DEV] query sent (recurse)', rinfo.port, rinfo.address);
+            //dnsd.onSent('[DEV] query sent (recurse)');
           }
         , onTimeout: function (res) {
             console.log(";; [" + q.name + "] connection timed out; no servers could be reached");
@@ -373,7 +371,7 @@ cli.main(function (args, cli) {
       return;
     }
 
-    require('../lib/dns-store').query(path.resolve(cli.input), query, function (err, resp) {
+    function respondWithResults(err, resp) {
 
       if (err) { console.log('[DEV] answer not found in local db, recursing'); console.error(err); recurse(); return; }
 
@@ -383,41 +381,39 @@ cli.main(function (args, cli) {
       if (!cli.norecurse && query.header.rd) { resp.header.ra = 1; }
 
       sendResponse(resp);
-    });
+    }
 
+    var engine;
+    try {
+      engine = require('../lib/store.json.js').create({ filepath: path.resolve(cli.input) });
+    } catch(e) {
+      respondWithResults(e);
+      return;
+    }
+    require('../lib/digd.js').query(engine, query, respondWithResults);
   };
 
-  handlers.onListening = function () {
-    /*jshint validthis:true*/
-    var server = this;
+  cli.defaultNameservers = defaultNameservers;
+  require('../lib/udpd.js').create(cli, dnsd).on('listening', function () {
     cli.chosenNameserver = cli.nameserver;
     var index;
 
     if (!cli.chosenNameserver) {
-      index = crypto.randomBytes(2).readUInt16BE(0) % defaultNameservers.length;
-      cli.chosenNameserver = defaultNameservers[index];
+      index = require('crypto').randomBytes(2).readUInt16BE(0) % cli.defaultNameservers.length;
+      cli.chosenNameserver = cli.defaultNameservers[index];
       if (cli.debug) {
-        console.log('index, defaultNameservers', index, defaultNameservers);
+        console.log('index, defaultNameservers', index, cli.defaultNameservers);
       }
     }
-
-    if (cli.mdns || '224.0.0.251' === cli.nameserver) {
-      server.setBroadcast(true);
-      server.addMembership(cli.nameserver);
+  });
+  if (cli.tcp /* TODO v1.3 !cli.notcp */) {
+    require('../lib/tcpd.js').create(cli, dnsd);
   }
 
-    console.log('');
-    console.log('Bound and Listening:');
-    console.log(server.address().address + '#' + server.address().port + ' (' + server.type + ')');
-  };
-
   console.log('');
   if (!cli.nocmd) {
     console.log('; <<>> digd.js v' + pkg.version + ' <<>> ' + process.argv.slice(2).join(' '));
     console.log(';; global options: +cmd');
   }
 
-  server.on('error', handlers.onError);
-  server.on('message', handlers.onMessage);
-  server.on('listening', handlers.onListening);
 });

dist/etc/systemd/system/digd.js.service

@@ -8,7 +8,7 @@ Wants=network-online.target systemd-networkd-wait-online.service
 # Restart on crash (bad signal), but not on 'clean' failure (error exit code)
 # Allow up to 3 restarts within 10 seconds
 # (it's unlikely that a user or properly-running script will do this)
-Restart=on-abnormal
+Restart=always
 StartLimitInterval=10
 StartLimitBurst=3
 

install.sh

@@ -6,7 +6,7 @@ sudo mkdir -p /opt/digd.js /srv/digd.js
 #chown -R $(whoami):$(whoami) /opt/digd.js /srv/digd.js
 chown -R digd:digd /opt/digd.js /srv/digd.js
 
-echo "v8.9.0" > /tmp/NODEJS_VER
+echo "v8.9.3" > /tmp/NODEJS_VER
 export NODE_PATH=/opt/digd.js/lib/node_modules
 export NPM_CONFIG_PREFIX=/opt/digd.js
 curl -fsSL https://git.coolaj86.com/coolaj86/node-installer.sh/raw/master/install.sh -o ./node-installer.sh.tmp
@@ -16,7 +16,7 @@ rm ./node-installer.sh.tmp
 
 git clone https://git.coolaj86.com/coolaj86/digd.js /opt/digd.js/lib/node_modules/digd.js
 pushd /opt/digd.js/lib/node_modules/digd.js
-  git checkout v1.1
+  git checkout v1.2
   /opt/digd.js/bin/node /opt/digd.js/bin/npm install
 popd
 

lib/digd.js

@@ -10,23 +10,14 @@ var NOERROR = 0;
 var NXDOMAIN = 3;
 var REFUSED = 5;
 
-function getRecords(db, qname, cb) {
+function getRecords(engine, qname, cb) {
   var delMe = {};
   var dns = require('dns');
   // SECURITY XXX TODO var dig = require('dig.js/dns-request');
   var count;
-  var myRecords = db.records.slice(0).filter(function (r) {
 
-    if ('string' !== typeof r.name) {
-      return false;
-    }
-
-    // TODO use IN in masterquest (or implement OR)
-    // Only return single-level wildcard?
-    if (qname === r.name || ('*.' + qname.split('.').slice(1).join('.')) === r.name) {
-      return true;
-    }
-  });
+  return engine.getRecords({ name: qname }, function (err, myRecords) {
+    if (err) { cb(err); return; }
 
     function checkCount() {
       var ready;
@@ -108,12 +99,13 @@ function getRecords(db, qname, cb) {
     if (!myRecords.length) {
       checkCount();
     }
+  });
 }
 
 function dbToResourceRecord(r) {
   return {
     name: r.name
-  , typeName: r.type // NS
+  , typeName: r.typeName || r.type // NS
   , className: 'IN'
   , ttl: r.ttl || 300
 
@@ -147,7 +139,7 @@ function dbToResourceRecord(r) {
   };
 }
 
-function getNs(db, ds, results, cb) {
+function getNs(engine, ds, results, cb) {
   console.log('[DEV] getNs entered with domains', ds);
 
   var d = ds.shift();
@@ -161,7 +153,7 @@ function getNs(db, ds, results, cb) {
 
   var qn = d.id.toLowerCase();
 
-  return getRecords(db, qn, function (err, records) {
+  return getRecords(engine, qn, function (err, records) {
     if (err) { cb(err); return; }
 
     records.forEach(function (r) {
@@ -187,16 +179,16 @@ function getNs(db, ds, results, cb) {
     });
 
     if (!results.authority.length) {
-      return getNs(db, ds, results, cb);
+      return getNs(engine, ds, results, cb);
     }
 
     // d.vanityNs should only be vanity nameservers (pointing to this same server)
     if (d.vanityNs || results.authority.some(function (ns) {
       console.log('[debug] ns', ns);
-      return -1 !== db.primaryNameservers.indexOf(ns.data.toLowerCase());
+      return -1 !== engine.primaryNameservers.indexOf(ns.data.toLowerCase());
     })) {
       results.authority.length = 0;
-      results.authority.push(domainToSoa(db, d));
+      results.authority.push(domainToSoa(engine.primaryNameservers, d));
       results.header.rcode = NXDOMAIN;
     }
     cb(null, results);
@@ -204,8 +196,8 @@ function getNs(db, ds, results, cb) {
   });
 }
 
-function domainToSoa(db, domain) {
-  var nameservers = domain.vanityNs || db.primaryNameservers;
+function domainToSoa(primaryNameservers, domain) {
+  var nameservers = domain.vanityNs || primaryNameservers;
 
   var index = Math.floor(Math.random() * nameservers.length) % nameservers.length;
   var nameserver = nameservers[index];
@@ -245,20 +237,20 @@ function domainToSoa(db, domain) {
   };
 }
 
-function getSoa(db, domain, results, cb, answerSoa) {
+function getSoa(primaryNameservers, domain, results, cb, answerSoa) {
   console.log('[DEV] getSoa entered');
 
   if (!answerSoa) {
-    results.authority.push(domainToSoa(db, domain));
+    results.authority.push(domainToSoa(primaryNameservers, domain));
   } else {
-    results.answer.push(domainToSoa(db, domain));
+    results.answer.push(domainToSoa(primaryNameservers, domain));
   }
 
   cb(null, results);
   return;
 }
 
-module.exports.query = function (input, query, cb) {
+module.exports.query = function (engine, query, cb) {
   /*
   var fs = require('fs');
 
@@ -271,11 +263,7 @@ module.exports.query = function (input, query, cb) {
   });
   */
 
-  var db;
   var qname;
-  try {
-    db = require(input);
-  } catch(e) { cb(e); return; }
 
   if (!Array.isArray(query.question) || query.question.length < 1) {
     cb(new Error("query is missing question section"));
@@ -337,9 +325,10 @@ module.exports.query = function (input, query, cb) {
     console.log('[DEV] answerSoa?', answerSoa);
     console.log('[DEV] qnames');
     console.log(qnames);
-    var myDomains = db.domains.filter(function (d) {
-      return -1 !== qnames.indexOf(d.id.toLowerCase());
-    });
+
+    return engine.getSoas({ names: qnames}, function (err, myDomains) {
+      console.log('[SOA] looking for', qnames, 'and proudly serving', err, myDomains);
+      if (err) { cb(err); return; }
 
       // this should result in a REFUSED status
       if (!myDomains.length) {
@@ -361,10 +350,10 @@ module.exports.query = function (input, query, cb) {
       //console.log('sorted domains', myDomains);
 
       if (!getNsAlso) {
-      return getSoa(db, myDomains[0], results, cb, answerSoa);
+        return getSoa(engine.primaryNameservers, myDomains[0], results, cb, answerSoa);
       }
 
-    return getNs(db, /*myDomains.slice(0)*/qnames.map(function (qn) { return { id: qn }; }), results, function (err, results) {
+      return getNs(engine, /*myDomains.slice(0)*/qnames.map(function (qn) { return { id: qn }; }), results, function (err, results) {
         //console.log('[DEV] getNs complete');
 
         if (err) { cb(err, results); return; }
@@ -375,9 +364,10 @@ module.exports.query = function (input, query, cb) {
         }
 
         // myDomains was sorted such that the longest was first
-      return getSoa(db, myDomains[0], results, cb);
+        return getSoa(engine.primaryNameservers, myDomains[0], results, cb);
 
       });
+    });
   }
 
   if ('SOA' === query.question[0].typeName) {
@@ -385,7 +375,7 @@ module.exports.query = function (input, query, cb) {
   }
 
   //console.log('[DEV] QUERY NAME', qname);
-  return getRecords(db, qname, function (err, someRecords) {
+  return getRecords(engine, qname, function (err, someRecords) {
     var myRecords;
     var nsRecords = [];
 
@@ -410,7 +400,7 @@ module.exports.query = function (input, query, cb) {
       // NOTE: I think that the issue here is EXTERNAL vs INTERNAL vanity NS
       // We _should_ reply for EXTERNAL vanity NS... but not when it's listed on the SOA internally?
       // It's surrounding the problem of what if I do sub domain delegation to the same server.
-      if (-1 === db.primaryNameservers.indexOf(r.data.toLowerCase())) {
+      if (-1 === engine.primaryNameservers.indexOf(r.data.toLowerCase())) {
         console.log("It's a vanity NS");
         return false;
       }

lib/store.json.js

@@ -0,0 +1,37 @@
+'use strict';
+
+module.exports.create = function (opts) {
+  // opts = { filepath };
+  var engine = { db: null };
+
+  var db = require(opts.filepath);
+
+  engine.primaryNameservers = db.primaryNameservers;
+  engine.getSoas = function (query, cb) {
+    var myDomains = db.domains.filter(function (d) {
+      return -1 !== query.names.indexOf(d.id.toLowerCase());
+    });
+    process.nextTick(function () {
+      cb(null, myDomains);
+    });
+  };
+  engine.getRecords = function (query, cb) {
+    var myRecords = db.records.slice(0).filter(function (r) {
+
+      if ('string' !== typeof r.name) {
+        return false;
+      }
+
+      // TODO use IN in masterquest (or implement OR)
+      // Only return single-level wildcard?
+      if (query.name === r.name || ('*.' + query.name.split('.').slice(1).join('.')) === r.name) {
+        return true;
+      }
+    });
+    process.nextTick(function () {
+      cb(null, myRecords);
+    });
+  };
+
+  return engine;
+};

lib/tcpd.js

@@ -0,0 +1,70 @@
+'use strict';
+
+module.exports.create = function (cli, dnsd) {
+  function runTcp() {
+    var tcpServer = require('net').createServer({ }, function (c) {
+      c.on('error', function (err) {
+        console.warn("TCP Connection Error:");
+        console.warn(err);
+      });
+      c.on('data', function (nb) {
+        //console.log('TCP data.length:', nb.length);
+        //console.log(nb.toString('hex'));
+
+        // DNS packets include a 2-byte length header
+        var count = nb.length;
+        var length = nb[0] << 8;
+        length = length | nb[1];
+        count -= 2;
+        // TODO slice?
+        nb._dnsByteOffset = nb.byteOffset + 2;
+
+        if (length !== count) {
+          console.error("Handling TCP packets > 512 bytes not implemented.");
+          c.end();
+          return;
+        }
+
+        // TODO pad two bytes for lengths
+        dnsd.onMessage(nb, function (err, newAb, dbgmsg) {
+          var lenbuf = Buffer.from([ newAb.length >> 8, newAb.length & 255 ]);
+          // TODO XXX generate legit error packet
+          if (err) { console.error("Error", err); c.end(); return; }
+          console.log('TCP ' + dbgmsg);
+
+          c.write(lenbuf);
+          c.end(newAb);
+        });
+      });
+      c.on('end', function () {
+        console.log('TCP client disconnected from server');
+      });
+    });
+
+    tcpServer.on('error', function (err) {
+      if ('EADDRINUSE' === err.code) {
+        console.error("Port '" + cli.port + "' is already in use.");
+        tcpServer.close();
+        process.exit(0);
+      }
+      if ('EACCES' === err.code) {
+        console.error("Could not bind on port '" + cli.port + "': EACCESS (you probably need root permissions)");
+        tcpServer.close();
+        process.exit(0);
+      }
+      console.error("TCP Server Error:");
+      console.error(err);
+      tcpServer.close(function () {
+        setTimeout(runTcp, 1000);
+      });
+    });
+
+    tcpServer.listen(cli.port, function () {
+      console.log('TCP Server bound');
+    });
+
+    return tcpServer;
+  }
+
+  return runTcp();
+};

lib/udpd.js

@@ -0,0 +1,58 @@
+'use strict';
+
+module.exports.create = function (cli, dnsd) {
+  var server = require('dgram').createSocket({
+    type: cli.udp6 ? 'udp6' : 'udp4'
+  , reuseAddr: true
+  });
+  server.bind({
+    port: cli.port
+  , address: cli.address
+  });
+
+  var handlers = {};
+  handlers.onError = function (err) {
+    if ('EACCES' === err.code) {
+      console.error("");
+      console.error("EACCES: Couldn't bind to port. You probably need to use sudo, authbind, or setcap.");
+      console.error("");
+      process.exit(123);
+      return;
+    }
+    console.error("error:", err.stack);
+    server.close();
+  };
+
+  handlers.onMessage = function (nb, rinfo) {
+    //console.log('[DEBUG] got a UDP message', nb.length);
+    //console.log(nb.toString('hex'));
+
+    dnsd.onMessage(nb, function (err, newAb, dbgmsg) {
+      // TODO send legit error message
+      if (err) { server.send(Buffer.from([0x00])); return; }
+      server.send(newAb, rinfo.port, rinfo.address, function () {
+        console.log(dbgmsg, rinfo.port, rinfo.address);
+      });
+    });
+  };
+
+  handlers.onListening = function () {
+    /*jshint validthis:true*/
+    var server = this;
+
+    if (cli.mdns || '224.0.0.251' === cli.nameserver) {
+      server.setBroadcast(true);
+      server.addMembership(cli.nameserver);
+    }
+
+    console.log('');
+    console.log('Bound and Listening:');
+    console.log(server.address().address + '#' + server.address().port + ' (' + server.type + ')');
+  };
+
+  server.on('error', handlers.onError);
+  server.on('message', handlers.onMessage);
+  server.on('listening', handlers.onListening);
+
+  return server;
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "digd.js",
-  "version": "1.1.9",
+  "version": "1.2.1",
   "description": "A lightweight DNS / mDNS daemon (server) for creating and capturing DNS and mDNS query and response packets to disk as binary and/or JSON. Options are similar to the Unix dig command.",
   "main": "bin/digd.js",
   "homepage": "https://git.coolaj86.com/coolaj86/digd.js",