add missing node-v6-compat

README.md

@@ -1,58 +1,25 @@
-# [acme-http-01-test](https://git.rootprojects.org/root/acme-http-01-test.js.git) | a [Root](https://rootprojects.org) project
+# [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | a [Root](https://rootprojects.org) project
 
-An ACME https-01 test harness for Let's Encrypt integrations.
+Test harness for ACME http-01 and dns-01 challenges for Let's Encrypt Free SSL integration.
 
 This was specificially designed for [ACME.js](https://git.coolaj86.com/coolaj86/acme-v2.js) and [Greenlock.js](https://git.coolaj86.com/coolaj86/greenlock-express.js), but will be generically useful to any ACME module.
 
-Passing the tests is very easy. There are just three functions to implement:
+> If you are building a plugin, please let us know.
+> We may like to co-author and help maintain and promote your module.
 
-- `set()` - set a TXT record in a zone (i.e. `_acme-challenge.foo` in `example.com`)
+This package has been split in two for the purpose of keeping the documentation clear and concise.
-- `get()` - confirm that the record was set
-- `remove()` - clean up after the ACME challenge passes
 
-The http-01 tests account for single-domain certificates (`example.com`).
+## ACME http-01
-If you need multiple domain certs (SAN / AltName),
-wildcards (`*.example.com`), or valid private / localhost certificates,
-you'll need [acme-dns-01-test.js](https://git.rootprojects.org/root/acme-http-01-test.js.git) instead.
 
-**Node v6 Support**: Please build community plugins using node v6 / vanillajs
+Use this for quick-and-easy, average-joe kind of stuff.
-to ensure that all acme.js and greenlock.js users are fully supported.
 
-## Install
+- See <https://git.rootprojects.org/root/acme-http-01-test.js>
 
-```bash
+## ACME dns-01
-npm install --save-dev acme-http-01-test@3.x
-```
 
-## Usage
+Use this for wildcards, and private and local domains.
 
-```js
+- See <https://git.rootprojects.org/root/acme-dns-01-test.js>
-var tester = require('acme-http-01-test');
-
-//var challenger = require('acme-http-01-cli').create({});
-var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({
-  YOUR_TOKEN_OPTION: 'SOME_API_KEY'
-});
-
-// The dry-run tests can pass on, literally, 'example.com'
-// but the integration tests require that you have control over the domain
-var record = 'foo.example.com';
-
-tester.testRecord('http-01', record, challenger).then(function() {
-  console.info('PASS');
-});
-```
-
-**Note**: If the service you are testing only handles multiple records
-within a single zone, you should use `testZone` instead:
-
-```js
-var zone = 'example.co.uk';
-
-tester.testZone('http-01', zone, challenger).then(function() {
-  console.info('PASS');
-});
-```
 
 ## Reference Implementations
 
@@ -69,40 +36,29 @@ which you should use as a model for any plugins that you create.
 You can find other implementations by searching npm for [acme-http-01-](https://www.npmjs.com/search?q=acme-http-01-)
 and [acme-dns-01-](https://www.npmjs.com/search?q=acme-dns-01-).
 
-If you are building a plugin, please let us know.
-We may like to co-author and help maintain and promote your module.
-
-## Example
-
-See `example.js` (it works).
-
 ## Starter Template
 
-Here's what you could start with.
+Just so you have an idea, this is typically how you'd start passing the tests:
 
 ```js
-var tester = require('acme-http-01-test');
+var tester = require('acme-challenge-test');
 
 // The dry-run tests can pass on, literally, 'example.com'
 // but the integration tests require that you have control over the domain
-var record = 'example.com';
+var domain = 'example.com';
 
 tester
-  .testRecord('http-01', record, {
+  .testRecord('http-01', domain, {
-    // Should make the token url return the key authorization
-    // i.e. GET http://example.com/.well-known/acme-challenge/xxxx => xxxx.yyyy
     set: function(opts) {
       console.log('set opts:', opts);
       throw new Error('set not implemented');
     },
 
-    // Should remove the previously set token file (just the one)
     remove: function(opts) {
       console.log('remove opts:', opts);
       throw new Error('remove not implemented');
     },
 
-    // Should get the token file via the hosting service API
     get: function(opts) {
       console.log('get opts:', opts);
       throw new Error('get not implemented');
@@ -112,110 +68,3 @@ tester
     console.info('PASS');
   });
 ```
-
-## http-01 vs dns-01
-
-For `type` http-01:
-
-    // `altname` is the name of the domain
-    // `token` is the name of the file ( .well-known/acme-challenge/`token` )
-    // `keyAuthorization` is the contents of the file
-
-For `type` dns-01:
-
-    // `dnsHost` is the domain/subdomain/host
-    // `dnsAuthorization` is the value of the TXT record
-
-See [acme-dns-01-test.js](https://git.rootprojects.org/root/acme-http-01-test.js.git).
-
-## Detailed Overview
-
-Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
-
-```js
-tester
-  .testRecord('http-01', 'foo.example.com', {
-    set: function(opts) {
-      var ch = opts.challenge;
-      // { type: 'http-01'
-      // , identifier: { type: 'dns', value: 'foo.example.com' }
-      // , token: 'xxxx'
-      // , keyAuthorization: 'xxxx.yyyy' }
-
-      return YourApi('POST', 'https://examplehost.com/api/sites/', {
-        site: ch.identifier.value,
-        filename: new URL(ch.url).pathname,
-        contents: ch.keyAuthorization
-      });
-    },
-
-    get: function(query) {
-      var ch = query.challenge;
-      // { type: 'http-01'
-      // , identifier: { type: 'dns', value: 'foo.example.com' }
-      // , token: 'xxxx'
-      // , url: '...' }
-      // Note: query.identifier.value is different for http-01 than for dns-01
-
-      return YourApi(
-        'GET',
-        'https://examplehost.com/api/sites/' +
-          ch.indentifier.value +
-          '/' +
-          new URL(ch.url).pathname
-      ).then(function(secret) {
-        // http-01
-        return { keyAuthorization: secret };
-      });
-    },
-
-    remove: function(opts) {
-      var ch = opts.challenge;
-      // same options as in `set()` (which are not the same as `get()`
-
-      return YourApi(
-        'DELETE',
-        'https://examplehost.com/api/sites/' +
-          ch.indentifier.value +
-          '/' +
-          new URL(ch.url).pathname
-      );
-    }
-  })
-  .then(function() {
-    console.info('PASS');
-  });
-```
-
-Where `YourApi` might look something like this:
-
-```js
-var YourApi = function createApi(config) {
-  var request = require('@root/request');
-  request = require('util').promisify(request);
-
-  return function(method, url, body) {
-    return request({
-      method: method,
-      url: url,
-      json: body || true,
-      headers: {
-        Authorization: 'Bearer ' + config.apiToken
-      }
-    }).then(function(resp) {
-      return resp.body;
-    });
-  };
-};
-```
-
-### Two notes:
-
-Note 1:
-
-The `API.get()`, `API.set()`, and `API.remove()` is where you do your magic up to upload a file to the correct
-location on an http serever or add the appropriate data to the database that handles such things.
-
-Note 2:
-
-You can't do wildcards with http-01 challenges.

example.js

@@ -1,19 +1,21 @@
 'use strict';
 
-//var tester = require('acme-http-01-test');
+//var tester = require('acme-challenge-test');
 var tester = require('./');
 
-var type = 'http-01';
+//var type = 'http-01';
-var challenger = require('acme-http-01-cli').create({});
+//var challenger = require('acme-http-01-cli').create({});
+var type = 'dns-01';
+var challenger = require('acme-dns-01-cli').create({});
 //var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({});
 //var type = 'YOUR-TYPE-01';
 
 // The dry-run tests can pass on, literally, 'example.com'
 // but the integration tests require that you have control over the domain
-var record = 'example.com';
+var zone = 'example.com';
 
 tester
-  .testRecord(type, record, challenger)
+  .test(type, zone, challenger)
   .then(function() {
     console.info('ALL PASSED');
   })

index.js

@@ -1,3 +1,424 @@
 'use strict';
+/*global Promise*/
 
-module.exports = require('acme-challenge-test');
+if (process.version.match(/^v(\d+)/)[1] > 6) {
+  console.warn();
+  console.warn('#########################');
+  console.warn('# Node v6 Compatibility #');
+  console.warn('#########################');
+  console.warn();
+  console.warn("You're using node " + process.version);
+  console.warn(
+    'Please write node-v6 compatible JavaScript (not Babel/ECMAScript) and test with node v6.'
+  );
+  console.warn();
+  console.warn(
+    '(ACME.js and Greenlock.js are widely deployed in enterprise node v6 environments. The few node v6 bugs in Buffer and Promise are hotfixed by ACME.js in just a few lines of code)'
+  );
+  console.warn();
+}
+require('./lib/node-v6-compat.js');
+
+// Load _after_ node v6 compat
+var crypto = require('crypto');
+var promisify = require('util').promisify;
+var request = require('@root/request');
+request = promisify(request);
+
+module.exports.create = function() {
+  throw new Error(
+    'acme-challenge-test is a test fixture for acme-challenge-* plugins, not a plugin itself'
+  );
+};
+
+// ignore all of this, it's just to normalize Promise vs node-style callback thunk vs synchronous
+function promiseCheckAndCatch(obj, name) {
+  // don't loose this-ness, just in case that's important
+  var fn = obj[name].bind(obj);
+  var promiser;
+
+  // function signature must match, or an error will be thrown
+  if (fn.length <= 1) {
+    // wrap so that synchronous errors are caught (alsa handles synchronous results)
+    promiser = function(opts) {
+      return Promise.resolve().then(function() {
+        return fn(opts);
+      });
+    };
+  } else if (2 === fn.length) {
+    // wrap as a promise
+    promiser = promisify(fn);
+  } else {
+    throw new Error(
+      "'challenge." +
+        name +
+        "' should accept either one argument, the options," +
+        ' and return a Promise or accept two arguments, the options and a node-style callback thunk'
+    );
+  }
+
+  function shouldntBeUndefined(result) {
+    if ('undefined' === typeof result) {
+      throw new Error(
+        "'challenge.'" +
+          name +
+          "' should never return `undefined`. Please explicitly `return null`" +
+          " (or fix the place where a value should have been returned but wasn't)."
+      );
+    }
+    return result;
+  }
+
+  return function(opts) {
+    return promiser(opts).then(shouldntBeUndefined);
+  };
+}
+
+function mapAsync(els, doer) {
+  els = els.slice(0);
+  var results = [];
+  function next() {
+    var el = els.shift();
+    if (!el) {
+      return results;
+    }
+    return doer(el).then(function(result) {
+      results.push(result);
+      return next();
+    });
+  }
+  return next();
+}
+
+function newZoneRegExp(zonename) {
+  // (^|\.)example\.com$
+  // which matches:
+  //  foo.example.com
+  //  example.com
+  // but not:
+  //  fooexample.com
+  return new RegExp('(^|\\.)' + zonename.replace(/\./g, '\\.') + '$');
+}
+
+function pluckZone(zones, dnsHost) {
+  return zones
+    .filter(function(zonename) {
+      // the only character that needs to be escaped for regex
+      // and is allowed in a domain name is '.'
+      return newZoneRegExp(zonename).test(dnsHost);
+    })
+    .sort(function(a, b) {
+      // longest match first
+      return b.length - a.length;
+    })[0];
+}
+
+// Here's the meat, where the tests are happening:
+function testEach(type, domains, challenger) {
+  var chr = wrapChallenger(type, challenger);
+  // We want the same rnd for all domains so that we catch errors like removing
+  // the apex (bare) domain TXT record to when creating the wildcard record
+  var rnd = crypto.randomBytes(2).toString('hex');
+
+  console.info("Testing each of '%s'", domains.join(', '));
+
+  //
+  // Zones
+  //
+  // Get ALL zones for all records on the certificate
+  //
+  return chr
+    .init({ request: request })
+    .then(function() {
+      return chr.zones({ request: request, dnsHosts: domains });
+    })
+    .then(function(zones) {
+      var all = domains.map(function(domain) {
+        var zone = pluckZone(zones, domain);
+        return {
+          domain: domain,
+          challenge: fakeChallenge(type, zone, domain, rnd),
+          request: request
+        };
+      });
+
+      // resolving for the sake of same indentation / scope
+      return Promise.resolve()
+        .then(function() {
+          return mapAsync(all, function(opts) {
+            return set(chr, opts);
+          });
+        })
+        .then(function() {
+          return mapAsync(all, function(opts) {
+            return check(chr, opts);
+          });
+        })
+        .then(function() {
+          return mapAsync(all, function(opts) {
+            return remove(chr, opts).then(function() {
+              console.info("PASS '%s'", opts.domain);
+            });
+          });
+        })
+        .then(function() {
+          console.info();
+          console.info('It looks like the soft tests all passed.');
+          console.log('It is highly likely that your plugin is correct.');
+          console.log(
+            'Now go test with Greenlock.js and/or ACME.js to be sure.'
+          );
+          console.info();
+        });
+    });
+}
+
+function set(chr, opts) {
+  var ch = opts.challenge;
+  if ('http-01' === ch.type && ch.wildname) {
+    throw new Error('http-01 cannot be used for wildcard domains');
+  }
+
+  //
+  // Set
+  //
+  // Add (not replace) a TXT for the domain
+  //
+  return chr.set(opts).then(function() {
+    // _test is used by the manual cli reference implementations
+    var query = { type: ch.type, /*debug*/ status: ch.status, _test: true };
+    if ('http-01' === ch.type) {
+      query.identifier = ch.identifier;
+      query.token = ch.token;
+      // For testing only
+      query.url = ch.challengeUrl;
+    } else if ('dns-01' === ch.type) {
+      query.identifier = { type: 'dns', value: ch.dnsHost };
+      // For testing only
+      query.altname = ch.altname;
+      // there should only be two possible TXT records per challenge domain:
+      // one for the bare domain, and the other if and only if there's a wildcard
+      query.wildcard = ch.wildcard;
+      query.dnsAuthorization = ch.dnsAuthorization;
+      query.dnsZone = ch.dnsZone;
+      query.dnsPrefix = ch.dnsPrefix;
+    } else {
+      query = JSON.parse(JSON.stringify(ch));
+      query.comment = 'unknown challenge type, supplying everything';
+    }
+    opts.query = query;
+    return opts;
+  });
+}
+
+function check(chr, opts) {
+  var ch = opts.challenge;
+
+  //
+  // Get
+  //
+  // Check that ONE of the relevant TXT records matches
+  //
+  return chr
+    .get({ request: request, challenge: opts.query })
+    .then(function(secret) {
+      if (!secret) {
+        throw new Error(
+          '`secret` should be an object containing `keyAuthorization` or `dnsAuthorization`'
+        );
+      }
+      if ('string' === typeof secret) {
+        console.info(
+          'secret was passed as a string, which works historically, but should be an object instead:'
+        );
+        console.info('{ "keyAuthorization": "' + secret + '" }');
+        console.info('or');
+        // TODO this should be "keyAuthorizationDigest"
+        console.info('{ "dnsAuthorization": "' + secret + '" }');
+        console.info(
+          'This is to help keep acme / greenlock (and associated plugins) future-proof for new challenge types'
+        );
+      }
+      // historically 'secret' has been a string, but I'd like it to transition to be an object.
+      // to make it backwards compatible in v2.7 to change it,
+      // so I'm not sure that we really need to.
+      if ('http-01' === ch.type) {
+        secret = secret.keyAuthorization || secret;
+        if (ch.keyAuthorization !== secret) {
+          throw new Error(
+            "http-01 challenge.get() returned '" +
+              secret +
+              "', which does not match the keyAuthorization" +
+              " saved with challenge.set(), which was '" +
+              ch.keyAuthorization +
+              "'"
+          );
+        }
+      } else if ('dns-01' === ch.type) {
+        secret = secret.dnsAuthorization || secret;
+        if (ch.dnsAuthorization !== secret) {
+          throw new Error(
+            "dns-01 challenge.get() returned '" +
+              secret +
+              "', which does not match the dnsAuthorization" +
+              " (keyAuthDigest) saved with challenge.set(), which was '" +
+              ch.dnsAuthorization +
+              "'"
+          );
+        }
+      } else {
+        if ('tls-alpn-01' === ch.type) {
+          console.warn(
+            "'tls-alpn-01' support is in development" +
+              " (or developed and we haven't update this yet). Please contact us."
+          );
+        } else {
+          console.warn(
+            "We don't know how to test '" +
+              ch.type +
+              "'... are you sure that's a thing?"
+          );
+        }
+        secret = secret.keyAuthorization || secret;
+        if (ch.keyAuthorization !== secret) {
+          console.warn(
+            "The returned value doesn't match keyAuthorization",
+            ch.keyAuthorization,
+            secret
+          );
+        }
+      }
+    });
+}
+
+function remove(chr, opts) {
+  //
+  // Remove
+  //
+  // Delete ONLY the SINGLE relevant TXT record
+  //
+  return chr.remove(opts).then(function() {
+    return chr.get(opts).then(function(result) {
+      if (result) {
+        throw new Error(
+          'challenge.remove() should have made it not possible for challenge.get() to return a value'
+        );
+      }
+      if (null !== result) {
+        throw new Error(
+          'challenge.get() should return null when the value is not set'
+        );
+      }
+    });
+  });
+}
+
+function wrapChallenger(type, challenger) {
+  var zones;
+  if ('dns-01' === type) {
+    if ('function' !== typeof challenger.zones) {
+      console.error(
+        'You must implement `zones` to return an array of strings.' +
+          " If you're testing a special type of service that doesn't support" +
+          ' domain zone listing (as opposed to domain record listing),' +
+          ' such as DuckDNS, return an empty array.'
+      );
+      process.exit(28);
+      return;
+    }
+    zones = promiseCheckAndCatch(challenger, 'zones');
+  } else {
+    zones = function() {
+      return Promise.resolve([]);
+    };
+  }
+
+  if ('function' !== typeof challenger.get) {
+    console.error(
+      "'challenge.get' should be implemented for the sake of testing." +
+        ' It should be implemented as the internal method for fetching the challenge' +
+        ' (i.e. reading from a database, file system or API, not return internal),' +
+        ' not the external check (the http call, dns query, etc),' +
+        ' which will already be done as part of this test.'
+    );
+    process.exit(29);
+    return;
+  }
+
+  var init = challenger.init;
+  if ('function' !== typeof init) {
+    init = function(opts) {
+      return null;
+    };
+  }
+  return {
+    init: promiseCheckAndCatch(challenger, 'init'),
+    zones: zones,
+    set: promiseCheckAndCatch(challenger, 'set'),
+    get: promiseCheckAndCatch(challenger, 'get'),
+    remove: promiseCheckAndCatch(challenger, 'remove')
+  };
+}
+
+function fakeChallenge(type, zone, altname, rnd) {
+  var expires = new Date(Date.now() + 10 * 60 * 1000).toISOString();
+  var token = crypto.randomBytes(8).toString('hex');
+  var thumb = crypto.randomBytes(16).toString('hex');
+  var keyAuth = token + '.' + crypto.randomBytes(16).toString('hex');
+  var dnsAuth = crypto
+    .createHash('sha256')
+    .update(keyAuth)
+    .digest('base64')
+    .replace(/\+/g, '-')
+    .replace(/\//g, '_')
+    .replace(/=/g, '');
+
+  var challenge = {
+    type: type,
+    identifier: { type: 'dns', value: null }, // completed below
+    wildcard: false, // completed below
+    status: 'pending',
+    expires: expires,
+    token: token,
+    thumbprint: thumb,
+    keyAuthorization: keyAuth,
+    url: null, // completed below
+    // we create a random record to prevent self cache-poisoning
+    dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below
+    dnsAuthorization: dnsAuth,
+    altname: altname,
+    _test: true // used by CLI referenced implementations
+  };
+  if ('*.' === altname.slice(0, 2)) {
+    challenge.wildcard = true;
+    altname = altname.slice(2);
+  }
+  challenge.identifier.value = altname;
+  challenge.url =
+    'http://' + altname + '/.well-known/acme-challenge/' + challenge.token;
+  challenge.dnsHost += altname;
+  if (zone) {
+    challenge.dnsZone = zone;
+    challenge.dnsPrefix = challenge.dnsHost
+      .replace(newZoneRegExp(zone), '')
+      .replace(/\.$/, '');
+  }
+
+  return challenge;
+}
+
+function testZone(type, zone, challenger) {
+  var domains = [zone, 'foo.' + zone];
+  if ('dns-01' === type) {
+    domains.push('*.foo.' + zone);
+  }
+  return testEach(type, domains, challenger);
+}
+
+function testRecord(type, altname, challenger) {
+  return testEach(type, [altname], challenger);
+}
+
+module.exports.testRecord = testRecord;
+module.exports.testZone = testZone;
+module.exports.test = testZone;

lib/node-v6-compat.js

@@ -0,0 +1,25 @@
+"use strict";
+
+function requireBluebird() {
+	try {
+		return require("bluebird");
+	} catch (e) {
+		console.error("");
+		console.error("DON'T PANIC. You're running an old version of node with incomplete Promise support.");
+		console.error("EASY FIX: `npm install --save bluebird`");
+		console.error("");
+		throw e;
+	}
+}
+
+if ("undefined" === typeof Promise) {
+	global.Promise = requireBluebird();
+}
+
+if ("function" !== typeof require("util").promisify) {
+	require("util").promisify = requireBluebird().promisify;
+}
+
+if (!console.debug) {
+	console.debug = console.log;
+}

package.json

@@ -1,30 +1,29 @@
 {
-  "name": "acme-http-01-test",
+  "name": "acme-challenge-test",
-  "version": "3.1.3",
+  "version": "3.3.2",
-  "description": "ACME http-01 tests for Let's Encrypt integration. Any `acme-http-01-` plugin should be able to pass these tests.",
+  "description": "ACME challenge test harness for Let's Encrypt integrations. Any `acme-http-01-` or `acme-dns-01-` challenge strategy or Greenlock plugin should be able to pass these tests.",
   "main": "index.js",
-  "homepage": "https://git.rootprojects.org/root/acme-http-01-test.js",
+  "homepage": "https://git.rootprojects.org/root/acme-challenge-test.js",
   "files": [
     "example.js",
     "lib"
   ],
   "dependencies": {
-    "acme-challenge-test": "^3.1.0"
+    "@root/request": "^1.3.11"
-  },
-  "devDependencies": {
-    "acme-http-01-cli": "^3.1.0"
   },
+  "devDependencies": {},
   "scripts": {
     "test": "node example.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://git.rootprojects.org/root/acme-http-01-test.js.git"
+    "url": "https://git.rootprojects.org/root/acme-challenge-test.js.git"
   },
   "keywords": [
     "Let's Encrypt",
     "ACME",
     "http-01",
+    "dns-01",
     "challenge",
     "plugin",
     "module",