add missing node-v6-compat

v3.3.1: add @root/request as dep
v3.3.0: include request, cleanup
2019-06-15 17:31:01 -06:00 · 2019-06-15 12:28:25 -06:00 · 2019-06-15 11:10:45 -06:00 · 2019-06-13 03:16:09 -06:00 · 2019-06-13 01:43:57 -06:00 · 2019-06-13 01:36:25 -06:00
7 changed files with 499 additions and 472 deletions
--- a/.prettierrc
+++ b/.prettierrc
@ -4,5 +4,5 @@
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "none",
-  "useTabs": true
+  "useTabs": false
 }
--- a/README.md
+++ b/README.md
@ -1,73 +1,44 @@
 # [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | a [Root](https://rootprojects.org) project
-The test harness you should use when writing an ACME challenge strategy
+Test harness for ACME http-01 and dns-01 challenges for Let's Encrypt Free SSL integration.
 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).
-All implementations MUST pass these tests, which is a very easy thing to do (just `set()`, `get()`, and `remove()`).
+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.
-The tests account for single-domain certificates (`example.com`) as well as multiple domain certs (SAN / AltName),
+> If you are building a plugin, please let us know.
-wildcards (`*.example.com`), and valid private / localhost certificates. No worries on your end, just pass the tests. 👌
+> We may like to co-author and help maintain and promote your module.
-**Node v6 Support**: Please build community plugins using node v6 / vanillajs to ensure that all acme.js and greenlock.js users are fully supported.
+This package has been split in two for the purpose of keeping the documentation clear and concise.
-## Install
+## ACME http-01
-```bash
+Use this for quick-and-easy, average-joe kind of stuff.
 npm install --save-dev acme-challenge-test@3.x
 ```
-## Usage
+- See <https://git.rootprojects.org/root/acme-http-01-test.js>
-```js
+## ACME dns-01
 var tester = require('acme-challenge-test');
-//var challenger = require('acme-http-01-cli').create({});
+Use this for wildcards, and private and local domains.
 //var challenger = require('acme-dns-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'
+- See <https://git.rootprojects.org/root/acme-dns-01-test.js>
 // but the integration tests require that you have control over the domain
 var zone = 'example.com';
 tester.testZone('dns-01', zone, challenger).then(function() {
 	console.info('PASS');
 });
 ```
 **Note**: If the service you are testing only handles individual records
 (not multiple records in a zone), you can use `testRecord` instead:
 ```js
 var record = 'foo.example.com';
 tester.testRecord('dns-01', record, 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.
- [`acme-http-01-cli`](https://git.rootprojects.org/root/acme-http-01-cli.js)
+- http-01
- [`acme-dns-01-cli`](https://git.rootprojects.org/root/acme-dns-01-cli.js)
+  - [`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-)
 and [acme-dns-01-](https://www.npmjs.com/search?q=acme-dns-01-).
 If you are building a plugin, please let us know.
 We would 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-challenge-test');
@ -77,134 +48,23 @@ var tester = require('acme-challenge-test');
 var domain = 'example.com';
 tester
-	.testRecord('http-01', domain, {
+  .testRecord('http-01', domain, {
-		// Should set a TXT record for dnsHost with dnsAuthorization and ttl || 300
+    set: function(opts) {
-		set: function(opts) {
+      console.log('set opts:', opts);
-			console.log('set opts:', opts);
+      throw new Error('set not implemented');
-			throw new Error('set not implemented');
+    },
 		},
-		// Should remove the *one* TXT record for dnsHost with dnsAuthorization
+    remove: function(opts) {
-		// Should NOT remove otherrecords for dnsHost (wildcard shares dnsHost with
+      console.log('remove opts:', opts);
-		// non-wildcard)
+      throw new Error('remove not implemented');
-		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) {
-		get: function(opts) {
+      console.log('get opts:', opts);
-			console.log('get opts:', opts);
+      throw new Error('get not implemented');
-			throw new Error('get not implemented');
+    }
-		}
+  })
-	})
+  .then(function() {
-	.then(function() {
+    console.info('PASS');
-		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
 	.testZone('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`
--- a/example.js
+++ b/example.js
@ -3,10 +3,10 @@
 //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 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';
@ -15,12 +15,12 @@ var challenger = require('acme-http-01-cli').create({});
 var zone = 'example.com';
 tester
-	.test(type, zone, challenger)
+  .test(type, zone, challenger)
-	.then(function() {
+  .then(function() {
-		console.info('ALL PASSED');
+    console.info('ALL PASSED');
-	})
+  })
-	.catch(function(err) {
+  .catch(function(err) {
-		console.error('FAIL');
+    console.error('FAIL');
-		console.error(err);
+    console.error(err);
-		process.exit(20);
+    process.exit(20);
-	});
+  });
--- a/index.js
+++ b/index.js
@ -1,281 +1,422 @@
 '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(
+  throw new Error(
-		'acme-challenge-test is a test fixture for acme-challenge-* plugins, not a plugin itself'
+    '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) {
-	var promisify = require('util').promisify;
+  // don't loose this-ness, just in case that's important
-	// don't loose this-ness, just in case that's important
+  var fn = obj[name].bind(obj);
-	var fn = obj[name].bind(obj);
+  var promiser;
 	var promiser;
-	// function signature must match, or an error will be thrown
+  // function signature must match, or an error will be thrown
-	if (1 === fn.length) {
+  if (fn.length <= 1) {
-		// wrap so that synchronous errors are caught (alsa handles synchronous results)
+    // wrap so that synchronous errors are caught (alsa handles synchronous results)
-		promiser = function(opts) {
+    promiser = function(opts) {
-			return Promise.resolve().then(function() {
+      return Promise.resolve().then(function() {
-				return fn(opts);
+        return fn(opts);
-			});
+      });
-		};
+    };
-	} else if (2 === fn.length) {
+  } else if (2 === fn.length) {
-		// wrap as a promise
+    // wrap as a promise
-		promiser = promisify(fn);
+    promiser = promisify(fn);
-	} else {
+  } else {
-		return Promise.reject(
+    throw new Error(
-			new Error(
+      "'challenge." +
-				"'challenge." +
+        name +
-					name +
+        "' should accept either one argument, the options," +
-					"' should accept either one argument, the options," +
+        ' and return a Promise or accept two arguments, the options and a node-style callback thunk'
-					' and return a Promise or accept two arguments, the options and a node-style callback thunk'
+    );
-			)
+  }
 		);
 	}
-	function shouldntBeNull(result) {
+  function shouldntBeUndefined(result) {
-		if ('undefined' === typeof result) {
+    if ('undefined' === typeof result) {
-			throw new Error(
+      throw new Error(
-				"'challenge.'" +
+        "'challenge.'" +
-					name +
+          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)."
+          " (or fix the place where a value should have been returned but wasn't)."
-			);
+      );
-		}
+    }
-		return result;
+    return result;
-	}
+  }
-	return function(opts) {
+  return function(opts) {
-		return promiser(opts).then(shouldntBeNull);
+    return promiser(opts).then(shouldntBeUndefined);
-	};
+  };
 }
 function mapAsync(els, doer) {
-	els = els.slice(0);
+  els = els.slice(0);
-	var results = [];
+  var results = [];
-	function next() {
+  function next() {
-		var el = els.shift();
+    var el = els.shift();
-		if (!el) {
+    if (!el) {
-			return results;
+      return results;
-		}
+    }
-		return doer(el).then(function(result) {
+    return doer(el).then(function(result) {
-			results.push(result);
+      results.push(result);
-			return next();
+      return next();
-		});
+    });
-	}
+  }
-	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(challenger);
+  var chr = wrapChallenger(type, challenger);
-	var all = domains.map(function(d) {
+  // We want the same rnd for all domains so that we catch errors like removing
-		return { domain: d };
+  // the apex (bare) domain TXT record to when creating the wildcard record
-	});
+  var rnd = crypto.randomBytes(2).toString('hex');
-	return mapAsync(all, function(opts) {
+  console.info("Testing each of '%s'", domains.join(', '));
 		console.info("TEST '%s'", opts.domain);
 		opts.challenge = getChallenge(type, opts.domain);
 		var ch = opts.challenge;
 		if ('http-01' === ch.type && ch.wildname) {
 			throw new Error('http-01 cannot be used for wildcard domains');
 		}
-		// The first time we just check it against itself
+  //
-		// this will cause the prompt to appear
+  // Zones
-		return chr.set(opts).then(function() {
+  //
-			// this will cause the final completion message to appear
+  // Get ALL zones for all records on the certificate
-			// _test is used by the manual cli reference implementations
+  //
-			var query = { type: ch.type, /*debug*/ status: ch.status, _test: true };
+  return chr
-			if ('http-01' === ch.type) {
+    .init({ request: request })
-				query.identifier = ch.identifier;
+    .then(function() {
-				query.token = ch.token;
+      return chr.zones({ request: request, dnsHosts: domains });
-				// For testing only
+    })
-				query.url = ch.challengeUrl;
+    .then(function(zones) {
-			} else if ('dns-01' === ch.type) {
+      var all = domains.map(function(domain) {
-				query.identifier = { type: 'dns', value: ch.dnsHost };
+        var zone = pluckZone(zones, domain);
-				// For testing only
+        return {
-				query.altname = ch.altname;
+          domain: domain,
-				// there should only be two possible TXT records per challenge domain:
+          challenge: fakeChallenge(type, zone, domain, rnd),
-				// one for the bare domain, and the other if and only if there's a wildcard
+          request: request
-				query.wildcard = ch.wildcard;
+        };
-				query.dnsAuthorization = ch.dnsAuthorization;
+      });
-			} else {
+
-				query = JSON.parse(JSON.stringify(ch));
+      // resolving for the sake of same indentation / scope
-				query.comment = 'unknown challenge type, supplying everything';
+      return Promise.resolve()
-			}
+        .then(function() {
-			opts.query = query;
+          return mapAsync(all, function(opts) {
-			return opts;
+            return set(chr, opts);
-		});
+          });
-	})
+        })
-		.then(function(all) {
+        .then(function() {
-			return mapAsync(all, function(opts) {
+          return mapAsync(all, function(opts) {
-				var ch = opts.challenge;
+            return check(chr, opts);
-				return chr.get({ challenge: opts.query }).then(function(secret) {
+          });
-					if ('string' === typeof secret) {
+        })
-						console.info(
+        .then(function() {
-							'secret was passed as a string, which works historically, but should be an object instead:'
+          return mapAsync(all, function(opts) {
-						);
+            return remove(chr, opts).then(function() {
-						console.info('{ "keyAuthorization": "' + secret + '" }');
+              console.info("PASS '%s'", opts.domain);
-						console.info('or');
+            });
-						// TODO this should be "keyAuthorizationDigest"
+          });
-						console.info('{ "dnsAuthorization": "' + secret + '" }');
+        })
-						console.info(
+        .then(function() {
-							'This is to help keep acme / greenlock (and associated plugins) future-proof for new challenge types'
+          console.info();
-						);
+          console.info('It looks like the soft tests all passed.');
-					}
+          console.log('It is highly likely that your plugin is correct.');
-					// historically 'secret' has been a string, but I'd like it to transition to be an object.
+          console.log(
-					// to make it backwards compatible in v2.7 to change it,
+            'Now go test with Greenlock.js and/or ACME.js to be sure.'
-					// so I'm not sure that we really need to.
+          );
-					if ('http-01' === ch.type) {
+          console.info();
-						secret = secret.keyAuthorization || secret;
+        });
-						if (ch.keyAuthorization !== secret) {
+    });
-							throw new Error(
+}
-								"http-01 challenge.get() returned '" +
+
-									secret +
+function set(chr, opts) {
-									"', which does not match the keyAuthorization" +
+  var ch = opts.challenge;
-									" saved with challenge.set(), which was '" +
+  if ('http-01' === ch.type && ch.wildname) {
-									ch.keyAuthorization +
+    throw new Error('http-01 cannot be used for wildcard domains');
-									"'"
+  }
-							);
+
-						}
+  //
-					} else if ('dns-01' === ch.type) {
+  // Set
-						secret = secret.dnsAuthorization || secret;
+  //
-						if (ch.dnsAuthorization !== secret) {
+  // Add (not replace) a TXT for the domain
-							throw new Error(
+  //
-								"dns-01 challenge.get() returned '" +
+  return chr.set(opts).then(function() {
-									secret +
+    // _test is used by the manual cli reference implementations
-									"', which does not match the dnsAuthorization" +
+    var query = { type: ch.type, /*debug*/ status: ch.status, _test: true };
-									" (keyAuthDigest) saved with challenge.set(), which was '" +
+    if ('http-01' === ch.type) {
-									ch.dnsAuthorization +
+      query.identifier = ch.identifier;
-									"'"
+      query.token = ch.token;
-							);
+      // For testing only
-						}
+      query.url = ch.challengeUrl;
-					} else {
+    } else if ('dns-01' === ch.type) {
-						if ('tls-alpn-01' === ch.type) {
+      query.identifier = { type: 'dns', value: ch.dnsHost };
-							console.warn(
+      // For testing only
-								"'tls-alpn-01' support is in development" +
+      query.altname = ch.altname;
-									" (or developed and we haven't update this yet). Please contact us."
+      // 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
-						} else {
+      query.wildcard = ch.wildcard;
-							console.warn(
+      query.dnsAuthorization = ch.dnsAuthorization;
-								"We don't know how to test '" +
+      query.dnsZone = ch.dnsZone;
-									ch.type +
+      query.dnsPrefix = ch.dnsPrefix;
-									"'... are you sure that's a thing?"
+    } else {
-							);
+      query = JSON.parse(JSON.stringify(ch));
-						}
+      query.comment = 'unknown challenge type, supplying everything';
-						secret = secret.keyAuthorization || secret;
+    }
-						if (ch.keyAuthorization !== secret) {
+    opts.query = query;
-							console.warn(
+    return opts;
-								"The returned value doesn't match keyAuthorization",
+  });
-								ch.keyAuthorization,
+}
-								secret
+
-							);
+function check(chr, opts) {
-						}
+  var ch = opts.challenge;
-					}
+
-				});
+  //
-			});
+  // Get
-		})
+  //
-		.then(function() {
+  // Check that ONE of the relevant TXT records matches
-			return mapAsync(all, function(opts) {
+  //
-				return chr.remove(opts).then(function() {
+  return chr
-					return chr.get(opts).then(function(result) {
+    .get({ request: request, challenge: opts.query })
-						if (result) {
+    .then(function(secret) {
-							throw new Error(
+      if (!secret) {
-								'challenge.remove() should have made it not possible for challenge.get() to return a value'
+        throw new Error(
-							);
+          '`secret` should be an object containing `keyAuthorization` or `dnsAuthorization`'
-						}
+        );
-						if (null !== result) {
+      }
-							throw new Error(
+      if ('string' === typeof secret) {
-								'challenge.get() should return null when the value is not set'
+        console.info(
-							);
+          'secret was passed as a string, which works historically, but should be an object instead:'
-						}
+        );
-						console.info("PASS '%s'", opts.domain);
+        console.info('{ "keyAuthorization": "' + secret + '" }');
-					});
+        console.info('or');
-				});
+        // TODO this should be "keyAuthorizationDigest"
-			});
+        console.info('{ "dnsAuthorization": "' + secret + '" }');
-		})
+        console.info(
-		.then(function() {
+          'This is to help keep acme / greenlock (and associated plugins) future-proof for new challenge types'
-			console.info('All soft tests: PASS');
+        );
-			console.warn(
+      }
-				'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.'
+      // 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,
-			console.warn(
+      // so I'm not sure that we really need to.
-				"We'll copy them over here as well, but that's a TODO for next week."
+      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];
+  var domains = [zone, 'foo.' + zone];
-	if ('dns-01' === type) {
+  if ('dns-01' === type) {
-		domains.push('*.foo.' + zone);
+    domains.push('*.foo.' + zone);
-	}
+  }
-	return testEach(type, domains, challenger);
+  return testEach(type, domains, challenger);
 }
 function wrapChallenger(challenger) {
 	var set = promiseCheckAndCatch(challenger, 'set');
 	if ('function' !== typeof challenger.get) {
 		throw new 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.'
 		);
 	}
 	var get = promiseCheckAndCatch(challenger, 'get');
 	var remove = promiseCheckAndCatch(challenger, 'remove');
 	return { set: set, get: get, remove: remove };
 }
 function getChallenge(type, altname) {
 	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
 		dnsHost: '_acme-challenge-' + token.slice(0, 4) + '.', // 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;
 	return challenge;
 }
 function testRecord(type, altname, challenger) {
-	return testEach(type, [altname], challenger);
+  return testEach(type, [altname], challenger);
 }
 module.exports.testRecord = testRecord;
--- a/lib/node-v6-compat.js
+++ b/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;
 }
--- a/package-lock.json
+++ b/package-lock.json
@ -1,5 +0,0 @@
 {
 	"name": "acme-challenge-test",
 	"version": "3.0.4",
 	"lockfileVersion": 1
 }
--- a/package.json
+++ b/package.json
@ -1,29 +1,35 @@
 {
-	"name": "acme-challenge-test",
+  "name": "acme-challenge-test",
-	"version": "3.1.1",
+  "version": "3.3.2",
-	"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.",
+  "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",
+  "main": "index.js",
-	"homepage": "https://git.rootprojects.org/root/acme-challenge-test.js",
+  "homepage": "https://git.rootprojects.org/root/acme-challenge-test.js",
-	"dependencies": {},
+  "files": [
-	"devDependencies": {},
+    "example.js",
-	"scripts": {
+    "lib"
-		"test": "node example.js"
+  ],
-	},
+  "dependencies": {
-	"repository": {
+    "@root/request": "^1.3.11"
-		"type": "git",
+  },
-		"url": "https://git.rootprojects.org/root/acme-challenge-test.js.git"
+  "devDependencies": {},
-	},
+  "scripts": {
-	"keywords": [
+    "test": "node example.js"
-		"Let's Encrypt",
+  },
-		"ACME",
+  "repository": {
-		"http-01",
+    "type": "git",
-		"dns-01",
+    "url": "https://git.rootprojects.org/root/acme-challenge-test.js.git"
-		"challenge",
+  },
-		"plugin",
+  "keywords": [
-		"module",
+    "Let's Encrypt",
-		"strategy",
+    "ACME",
-		"greenlock"
+    "http-01",
-	],
+    "dns-01",
-	"author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
+    "challenge",
-	"license": "MPL-2.0"
+    "plugin",
    "module",
    "strategy",
    "greenlock"
  ],
  "author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
  "license": "MPL-2.0"
 }
Author	SHA1	Message	Date
AJ ONeal	803cb4ef2c	add missing node-v6-compat	2019-06-15 17:31:01 -06:00
AJ ONeal	f26b7bd58b	v3.3.1: add @root/request as dep	2019-06-15 12:28:25 -06:00
AJ ONeal	2a383ada48	v3.3.0: include request, cleanup	2019-06-15 11:10:45 -06:00
AJ ONeal	9e0aedca41	v3.2.1: bugfix new dns-01 tests	2019-06-13 03:16:09 -06:00
AJ ONeal	fa60eb0149	clean text	2019-06-13 01:43:57 -06:00
AJ ONeal	649a8532d9	from tabs back to spaces	2019-06-13 01:36:25 -06:00
AJ ONeal	c473091e0e	v3.2.0: support zones(), separate docs	2019-06-13 01:32:52 -06:00
AJ ONeal	dda7ecb497	v3.1.2: keep same random prefix per test set	2019-06-07 00:48:15 -06:00