.prettierrc

@@ -4,5 +4,5 @@
   "singleQuote": true,
   "tabWidth": 2,
   "trailingComma": "none",
-  "useTabs": false
+  "useTabs": true
 }

README.md

@@ -1,44 +1,58 @@
 # [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | a [Root](https://rootprojects.org) project
 
-Test harness for ACME http-01 and dns-01 challenges for Let's Encrypt Free SSL integration.
+The test harness you should use when writing an ACME challenge strategy
+for [ACME.js](https://git.coolaj86.com/coolaj86/acme-v2.js) and also [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3).
 
-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.
+All implementations MUST pass these tests, which is a very easy thing to do (just `set()`, `get()`, and `remove()`).
 
-> If you are building a plugin, please let us know.
+The tests account for single-domain certificates (`example.com`) as well as multiple domain certs (SAN / AltName),
-> We may like to co-author and help maintain and promote your module.
+wildcards (`*.example.com`), and valid private / localhost certificates. No worries on your end, just pass the tests. 👌
 
-This package has been split in two for the purpose of keeping the documentation clear and concise.
+**Node v6 Support**: Please build community plugins using node v6 / vanillajs to ensure that all acme.js and greenlock.js users are fully supported.
 
-## ACME http-01
+## Install
 
-Use this for quick-and-easy, average-joe kind of stuff.
+```bash
+npm install --save-dev acme-challenge-test@3.x
+```
 
-- See <https://git.rootprojects.org/root/acme-http-01-test.js>
+## Usage
 
-## ACME dns-01
+```js
+var tester = require("acme-challenge-test");
 
-Use this for wildcards, and private and local domains.
+//var challenger = require('acme-http-01-cli').create({});
+//var challenger = require('acme-dns-01-cli').create({});
+var challenger = require("./YOUR-CHALLENGE-STRATEGY").create({
+  YOUR_TOKEN_OPTION: 'SOME_API_KEY'
+});
 
-- See <https://git.rootprojects.org/root/acme-dns-01-test.js>
+// The dry-run tests can pass on, literally, 'example.com'
+// but the integration tests require that you have control over the domain
+var domain = "example.com";
+
+tester.test("http-01", domain, challenger).then(function() {
+	console.info("PASS");
+});
+```
 
 ## Reference Implementations
 
 These are plugins that use the v2.7+ (v3) API, and pass this test harness,
 which you should use as a model for any plugins that you create.
 
-- http-01
 - [`acme-http-01-cli`](https://git.rootprojects.org/root/acme-http-01-cli.js)
-  - [`acme-http-01-fs`](https://git.rootprojects.org/root/acme-http-01-fs.js)
-- dns-01
 - [`acme-dns-01-cli`](https://git.rootprojects.org/root/acme-dns-01-cli.js)
-  - [`acme-dns-01-digitalocean`](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js)
 
-You can find other implementations by searching npm for [acme-http-01-](https://www.npmjs.com/search?q=acme-http-01-)
+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-).
-and [acme-dns-01-](https://www.npmjs.com/search?q=acme-dns-01-).
+
+## Example
+
+See `example.js` (it works).
 
 ## Starter Template
 
-Just so you have an idea, this is typically how you'd start passing the tests:
+Here's what you could start with.
 
 ```js
 var tester = require('acme-challenge-test');
@@ -48,17 +62,22 @@ var tester = require('acme-challenge-test');
 var domain = 'example.com';
 
 tester
-  .testRecord('http-01', domain, {
+  .test('http-01', domain, {
+    // Should set a TXT record for dnsHost with dnsAuthorization and ttl || 300
     set: function(opts) {
       console.log('set opts:', opts);
       throw new Error('set not implemented');
     },
 
+    // Should remove the *one* TXT record for dnsHost with dnsAuthorization
+    // Should NOT remove otherrecords for dnsHost (wildcard shares dnsHost with
+    // non-wildcard)
     remove: function(opts) {
       console.log('remove opts:', opts);
       throw new Error('remove not implemented');
     },
 
+    // Should get the record via the DNS server's API
     get: function(opts) {
       console.log('get opts:', opts);
       throw new Error('get not implemented');
@@ -68,3 +87,110 @@ tester
     console.info('PASS');
   });
 ```
+
+## dns-01 vs http-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
+
+## Detailed Overview
+
+Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
+
+```js
+tester
+  .test('dns-01', 'example.com', {
+  
+    set: function(opts) {
+      var ch = opts.challenge;
+      // { type: 'dns-01' // or 'http-01'
+      // , identifier: { type: 'dns', value: 'example.com' }
+      // , wildcard: false
+      // , token: 'xxxx'
+      // , keyAuthorization: 'xxxx.yyyy'
+      // , dnsHost: '_acme-challenge.example.com'
+      // , dnsAuthorization: 'zzzz' }
+
+      return YourApi('POST', 'https://example.com/api/dns/txt', {
+        host: ch.dnsHost,
+        record: ch.dnsAuthorization
+      });
+    },
+    
+    get: function(query) {
+      var ch = query.challenge;
+      // { type: 'dns-01' // or 'http-01', 'tls-alpn-01', etc
+      // , identifier: { type: 'dns', value: 'example.com' }
+      //   // http-01 only
+      // , token: 'xxxx'
+      // , url: '...' // for testing and debugging
+      //   // dns-01 only, for testing / dubgging
+      // , altname: '...'
+      // , dnsHost: '...'
+      // , wildcard: false }
+      // Note: query.identifier.value is different for http-01 than for dns-01
+
+      return YourApi('GET', 'https://example.com/api/dns/txt', {
+        host: ch.dnsHost
+      }).then(function(secret) {
+        // http-01
+        //return { keyAuthorization: secret };
+        // dns-01
+        return { dnsAuthorization: secret };
+      });
+    },
+    
+    remove: function(opts) {
+      var ch = opts.challenge;
+      // same options as in `set()` (which are not the same as `get()`
+
+      return YourApi('DELETE', 'https://example.com/api/dns/txt/' + ch.dnsHost);
+    }
+  })
+  .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, set DNS records, or add the appropriate data to the database that handles such things.
+
+Note 2:
+
+* When `altname` is `foo.example.com` the `dnsHost` will be `_acme-challenge.foo.example.com`
+* When `altname` is `*.foo.example.com` the `dnsHost` will _still_ be `_acme-challenge.foo.example.com`!!
+* When `altname` is `bar.foo.example.com` the `dnsHost` will be `_acme-challenge.bar.foo.example.com`

example.js

@@ -1,26 +1,27 @@
-'use strict';
+"use strict";
 
 //var tester = require('acme-challenge-test');
-var tester = require('./');
+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 type = 'dns-01';
-var challenger = require('acme-dns-01-cli').create({});
+//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 zone = 'example.com';
+var domain = "example.com";
+//var domain = '*.example.com';
 
 tester
-  .test(type, zone, challenger)
+	.test(type, domain, challenger)
 	.then(function() {
-    console.info('ALL PASSED');
+		console.info("PASS");
 	})
 	.catch(function(err) {
-    console.error('FAIL');
+		console.error("FAIL");
 		console.error(err);
 		process.exit(20);
 	});

index.js

@@ -1,29 +1,6 @@
 'use strict';
 /*global Promise*/
-
-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(
@@ -33,12 +10,13 @@ module.exports.create = function() {
 
 // ignore all of this, it's just to normalize Promise vs node-style callback thunk vs synchronous
 function promiseCheckAndCatch(obj, name) {
+	var promisify = require('util').promisify;
 	// 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) {
+	if (1 === fn.length) {
 		// wrap so that synchronous errors are caught (alsa handles synchronous results)
 		promiser = function(opts) {
 			return Promise.resolve().then(function() {
@@ -49,20 +27,22 @@ function promiseCheckAndCatch(obj, name) {
 		// wrap as a promise
 		promiser = promisify(fn);
 	} else {
-    throw new Error(
+		return Promise.reject(
+			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) {
+	function shouldntBeNull(result) {
 		if ('undefined' === typeof result) {
 			throw new Error(
 				"'challenge.'" +
 					name +
-          "' should never return `undefined`. Please explicitly `return null`" +
+					"' should never return `undefined`. Please explicitly return null" +
 					" (or fix the place where a value should have been returned but wasn't)."
 			);
 		}
@@ -70,121 +50,34 @@ function promiseCheckAndCatch(obj, name) {
 	}
 
 	return function(opts) {
-    return promiser(opts).then(shouldntBeUndefined);
+		return promiser(opts).then(shouldntBeNull);
 	};
 }
 
-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) {
+function run(challenger, opts) {
-  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');
 	}
 
-  //
+	var set = promiseCheckAndCatch(challenger, 'set');
-  // Set
+	if ('function' !== typeof challenger.get) {
-  //
+		throw new Error(
-  // Add (not replace) a TXT for the domain
+			"'challenge.get' should be implemented for the sake of testing." +
-  //
+				' It should be implemented as the internal method for fetching the challenge' +
-  return chr.set(opts).then(function() {
+				' (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.'
+		);
+	}
+	var get = promiseCheckAndCatch(challenger, 'get');
+	var remove = promiseCheckAndCatch(challenger, 'remove');
+
+	// The first time we just check it against itself
+	// this will cause the prompt to appear
+	return set(opts)
+		.then(function() {
+			// this will cause the final completion message to appear
 			// _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) {
@@ -200,33 +93,12 @@ function set(chr, opts) {
 				// 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 get({ challenge: 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:'
@@ -288,17 +160,10 @@ function check(chr, opts) {
 							);
 						}
 					}
-    });
+				})
-}
+				.then(function() {
-
+					return remove(opts).then(function() {
-function remove(chr, opts) {
+						return get(opts).then(function(result) {
-  //
-  // 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'
@@ -311,56 +176,20 @@ function remove(chr, opts) {
 							}
 						});
 					});
-}
+				});
-
+		})
-function wrapChallenger(type, challenger) {
+		.then(function() {
-  var zones;
+			console.info('All soft tests: PASS');
-  if ('dns-01' === type) {
+			console.warn(
-    if ('function' !== typeof challenger.zones) {
+				'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.'
-      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);
+			console.warn(
-      return;
+				"We'll copy them over here as well, but that's a TODO for next week."
-    }
-    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;
+module.exports.test = function(type, altname, challenger) {
-  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');
@@ -383,8 +212,7 @@ function fakeChallenge(type, zone, altname, rnd) {
 		thumbprint: thumb,
 		keyAuthorization: keyAuth,
 		url: null, // completed below
-    // we create a random record to prevent self cache-poisoning
+		dnsHost: '_acme-challenge.', // completed below
-    dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below
 		dnsAuthorization: dnsAuth,
 		altname: altname,
 		_test: true // used by CLI referenced implementations
@@ -397,28 +225,6 @@ function fakeChallenge(type, zone, altname, rnd) {
 	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;
+	return run(challenger, { challenge: 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

@@ -1,25 +0,0 @@
-"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,16 +1,10 @@
 {
 	"name": "acme-challenge-test",
-  "version": "3.3.2",
+	"version": "3.0.4",
-  "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.",
+	"description": "The base set of tests for all ACME challenge strategies. Any `acme-http-01-`, `acme-dns-01-`, `acme-challenge-`, or greenlock plugin should be able to pass these tests.",
 	"main": "index.js",
 	"homepage": "https://git.rootprojects.org/root/acme-challenge-test.js",
-  "files": [
+	"dependencies": {},
-    "example.js",
-    "lib"
-  ],
-  "dependencies": {
-    "@root/request": "^1.3.11"
-  },
 	"devDependencies": {},
 	"scripts": {
 		"test": "node example.js"