from tabs back to spaces

This commit is contained in:
AJ ONeal 2019-06-13 01:36:25 -06:00
parent c473091e0e
commit 649a8532d9
3 changed files with 319 additions and 319 deletions

View File

@ -48,23 +48,23 @@ var tester = require('acme-challenge-test');
var domain = 'example.com'; var domain = 'example.com';
tester tester
.testRecord('http-01', domain, { .testRecord('http-01', domain, {
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');
}, },
remove: function(opts) { remove: function(opts) {
console.log('remove opts:', opts); console.log('remove opts:', opts);
throw new Error('remove not implemented'); throw new Error('remove not implemented');
}, },
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');
}); });
``` ```

View File

@ -15,12 +15,12 @@ var challenger = require('acme-dns-01-cli').create({});
var zone = 'example.com'; var zone = 'example.com';
tester 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);
}); });

586
index.js
View File

@ -3,336 +3,336 @@
var crypto = require('crypto'); var crypto = require('crypto');
module.exports.create = function() { 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 // ignore all of this, it's just to normalize Promise vs node-style callback thunk vs synchronous
function promiseCheckAndCatch(obj, name) { function promiseCheckAndCatch(obj, name) {
var promisify = require('util').promisify; 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 (1 === fn.length) {
// 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( return Promise.reject(
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 shouldntBeUndefined(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(shouldntBeUndefined); return promiser(opts).then(shouldntBeUndefined);
}; };
} }
function mapAsync(els, doer) { 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) { function newZoneRegExp(zonename) {
// (^|\.)example\.com$ // (^|\.)example\.com$
// which matches: // which matches:
// foo.example.com // foo.example.com
// example.com // example.com
// but not: // but not:
// fooexample.com // fooexample.com
return new RegExp('(^|\\.)' + zonename.replace(/\./g, '\\.') + '$'); return new RegExp('(^|\\.)' + zonename.replace(/\./g, '\\.') + '$');
} }
function pluckZone(zones, dnsHost) { function pluckZone(zones, dnsHost) {
return zones return zones
.filter(function(zonename) { .filter(function(zonename) {
// the only character that needs to be escaped for regex // the only character that needs to be escaped for regex
// and is allowed in a domain name is '.' // and is allowed in a domain name is '.'
return newZoneRegExp(zonename).test(dnsHost); return newZoneRegExp(zonename).test(dnsHost);
}) })
.sort(function(a, b) { .sort(function(a, b) {
// longest match first // longest match first
return b.length - a.length; return b.length - a.length;
})[0]; })[0];
} }
// Here's the meat, where the tests are happening: // Here's the meat, where the tests are happening:
function testEach(type, domains, challenger) { function testEach(type, domains, challenger) {
var chr = wrapChallenger(type, challenger); var chr = wrapChallenger(type, challenger);
var all = domains.map(function(d) { var all = domains.map(function(d) {
return { domain: d }; return { domain: d };
}); });
var rnd = crypto.randomBytes(2).toString('hex'); var rnd = crypto.randomBytes(2).toString('hex');
return chr.zones({ dnsHosts: domains }).then(function(zones) { return chr.zones({ dnsHosts: domains }).then(function(zones) {
return mapAsync(all, function(opts) { return mapAsync(all, function(opts) {
console.info("TEST '%s'", opts.domain); console.info("TEST '%s'", opts.domain);
var zone = pluckZone(zones, opts.domain); var zone = pluckZone(zones, opts.domain);
opts.challenge = fakeChallenge(type, zone, opts.domain, rnd); opts.challenge = fakeChallenge(type, zone, opts.domain, rnd);
var ch = opts.challenge; var ch = opts.challenge;
if ('http-01' === ch.type && ch.wildname) { if ('http-01' === ch.type && ch.wildname) {
throw new Error('http-01 cannot be used for wildcard domains'); throw new Error('http-01 cannot be used for wildcard domains');
} }
// The first time we just check it against itself // The first time we just check it against itself
// this will cause the prompt to appear // this will cause the prompt to appear
return chr.set(opts).then(function() { return chr.set(opts).then(function() {
// this will cause the final completion message to appear // this will cause the final completion message to appear
// _test is used by the manual cli reference implementations // _test is used by the manual cli reference implementations
var query = { type: ch.type, /*debug*/ status: ch.status, _test: true }; var query = { type: ch.type, /*debug*/ status: ch.status, _test: true };
if ('http-01' === ch.type) { if ('http-01' === ch.type) {
query.identifier = ch.identifier; query.identifier = ch.identifier;
query.token = ch.token; query.token = ch.token;
// For testing only // For testing only
query.url = ch.challengeUrl; query.url = ch.challengeUrl;
} else if ('dns-01' === ch.type) { } else if ('dns-01' === ch.type) {
query.identifier = { type: 'dns', value: ch.dnsHost }; query.identifier = { type: 'dns', value: ch.dnsHost };
// For testing only // For testing only
query.altname = ch.altname; query.altname = ch.altname;
// there should only be two possible TXT records per challenge domain: // 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 // one for the bare domain, and the other if and only if there's a wildcard
query.wildcard = ch.wildcard; query.wildcard = ch.wildcard;
query.dnsAuthorization = ch.dnsAuthorization; query.dnsAuthorization = ch.dnsAuthorization;
} else { } else {
query = JSON.parse(JSON.stringify(ch)); query = JSON.parse(JSON.stringify(ch));
query.comment = 'unknown challenge type, supplying everything'; query.comment = 'unknown challenge type, supplying everything';
} }
opts.query = query; opts.query = query;
return opts; return opts;
}); });
}) })
.then(function(all) { .then(function(all) {
return mapAsync(all, function(opts) { return mapAsync(all, function(opts) {
var ch = opts.challenge; var ch = opts.challenge;
return chr.get({ challenge: opts.query }).then(function(secret) { return chr.get({ challenge: opts.query }).then(function(secret) {
if ('string' === typeof secret) { if ('string' === typeof secret) {
console.info( console.info(
'secret was passed as a string, which works historically, but should be an object instead:' 'secret was passed as a string, which works historically, but should be an object instead:'
); );
console.info('{ "keyAuthorization": "' + secret + '" }'); console.info('{ "keyAuthorization": "' + secret + '" }');
console.info('or'); console.info('or');
// TODO this should be "keyAuthorizationDigest" // TODO this should be "keyAuthorizationDigest"
console.info('{ "dnsAuthorization": "' + secret + '" }'); console.info('{ "dnsAuthorization": "' + secret + '" }');
console.info( console.info(
'This is to help keep acme / greenlock (and associated plugins) future-proof for new challenge types' '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. // 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, // to make it backwards compatible in v2.7 to change it,
// so I'm not sure that we really need to. // so I'm not sure that we really need to.
if ('http-01' === ch.type) { if ('http-01' === ch.type) {
secret = secret.keyAuthorization || secret; secret = secret.keyAuthorization || secret;
if (ch.keyAuthorization !== secret) { if (ch.keyAuthorization !== secret) {
throw new Error( throw new Error(
"http-01 challenge.get() returned '" + "http-01 challenge.get() returned '" +
secret + secret +
"', which does not match the keyAuthorization" + "', which does not match the keyAuthorization" +
" saved with challenge.set(), which was '" + " saved with challenge.set(), which was '" +
ch.keyAuthorization + ch.keyAuthorization +
"'" "'"
); );
} }
} else if ('dns-01' === ch.type) { } else if ('dns-01' === ch.type) {
secret = secret.dnsAuthorization || secret; secret = secret.dnsAuthorization || secret;
if (ch.dnsAuthorization !== secret) { if (ch.dnsAuthorization !== secret) {
throw new Error( throw new Error(
"dns-01 challenge.get() returned '" + "dns-01 challenge.get() returned '" +
secret + secret +
"', which does not match the dnsAuthorization" + "', which does not match the dnsAuthorization" +
" (keyAuthDigest) saved with challenge.set(), which was '" + " (keyAuthDigest) saved with challenge.set(), which was '" +
ch.dnsAuthorization + ch.dnsAuthorization +
"'" "'"
); );
} }
} else { } else {
if ('tls-alpn-01' === ch.type) { if ('tls-alpn-01' === ch.type) {
console.warn( console.warn(
"'tls-alpn-01' support is in development" + "'tls-alpn-01' support is in development" +
" (or developed and we haven't update this yet). Please contact us." " (or developed and we haven't update this yet). Please contact us."
); );
} else { } else {
console.warn( console.warn(
"We don't know how to test '" + "We don't know how to test '" +
ch.type + ch.type +
"'... are you sure that's a thing?" "'... are you sure that's a thing?"
); );
} }
secret = secret.keyAuthorization || secret; secret = secret.keyAuthorization || secret;
if (ch.keyAuthorization !== secret) { if (ch.keyAuthorization !== secret) {
console.warn( console.warn(
"The returned value doesn't match keyAuthorization", "The returned value doesn't match keyAuthorization",
ch.keyAuthorization, ch.keyAuthorization,
secret secret
); );
} }
} }
}); });
}); });
}) })
.then(function() { .then(function() {
return mapAsync(all, function(opts) { return mapAsync(all, function(opts) {
return chr.remove(opts).then(function() { return chr.remove(opts).then(function() {
return chr.get(opts).then(function(result) { return chr.get(opts).then(function(result) {
if (result) { if (result) {
throw new Error( throw new Error(
'challenge.remove() should have made it not possible for challenge.get() to return a value' 'challenge.remove() should have made it not possible for challenge.get() to return a value'
); );
} }
if (null !== result) { if (null !== result) {
throw new Error( throw new Error(
'challenge.get() should return null when the value is not set' 'challenge.get() should return null when the value is not set'
); );
} }
console.info("PASS '%s'", opts.domain); console.info("PASS '%s'", opts.domain);
}); });
}); });
}); });
}) })
.then(function() { .then(function() {
console.info('All soft tests: PASS'); console.info('All soft tests: PASS');
console.warn( console.warn(
'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.' 'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.'
); );
console.warn( console.warn(
"We'll copy them over here as well, but that's a TODO for next week." "We'll copy them over here as well, but that's a TODO for next week."
); );
}); });
}); });
} }
function testZone(type, zone, challenger) { 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(type, challenger) { function wrapChallenger(type, challenger) {
var zones; var zones;
if ('dns-01' === type) { if ('dns-01' === type) {
if ('function' !== typeof challenger.zones) { if ('function' !== typeof challenger.zones) {
console.error( console.error(
'You must implement `zones` to return an array of strings.' + 'You must implement `zones` to return an array of strings.' +
" If you're testing a special type of service that doesn't support" + " If you're testing a special type of service that doesn't support" +
' domain zone listing (as opposed to domain record listing),' + ' domain zone listing (as opposed to domain record listing),' +
' such as DuckDNS, return an empty array.' ' such as DuckDNS, return an empty array.'
); );
process.exit(28); process.exit(28);
return; return;
} }
zones = promiseCheckAndCatch(challenger, 'zones'); zones = promiseCheckAndCatch(challenger, 'zones');
} else { } else {
zones = function() { zones = function() {
return Promise.resolve([]); return Promise.resolve([]);
}; };
} }
if ('function' !== typeof challenger.get) { if ('function' !== typeof challenger.get) {
console.error( console.error(
"'challenge.get' should be implemented for the sake of testing." + "'challenge.get' should be implemented for the sake of testing." +
' It should be implemented as the internal method for fetching the challenge' + ' 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),' + ' (i.e. reading from a database, file system or API, not return internal),' +
' not the external check (the http call, dns query, etc),' + ' not the external check (the http call, dns query, etc),' +
' which will already be done as part of this test.' ' which will already be done as part of this test.'
); );
process.exit(29); process.exit(29);
return; return;
} }
return { return {
zones: zones, zones: zones,
set: promiseCheckAndCatch(challenger, 'set'), set: promiseCheckAndCatch(challenger, 'set'),
get: promiseCheckAndCatch(challenger, 'get'), get: promiseCheckAndCatch(challenger, 'get'),
remove: promiseCheckAndCatch(challenger, 'remove') remove: promiseCheckAndCatch(challenger, 'remove')
}; };
} }
function fakeChallenge(type, zone, altname, rnd) { function fakeChallenge(type, zone, altname, rnd) {
var expires = new Date(Date.now() + 10 * 60 * 1000).toISOString(); var expires = new Date(Date.now() + 10 * 60 * 1000).toISOString();
var token = crypto.randomBytes(8).toString('hex'); var token = crypto.randomBytes(8).toString('hex');
var thumb = crypto.randomBytes(16).toString('hex'); var thumb = crypto.randomBytes(16).toString('hex');
var keyAuth = token + '.' + crypto.randomBytes(16).toString('hex'); var keyAuth = token + '.' + crypto.randomBytes(16).toString('hex');
var dnsAuth = crypto var dnsAuth = crypto
.createHash('sha256') .createHash('sha256')
.update(keyAuth) .update(keyAuth)
.digest('base64') .digest('base64')
.replace(/\+/g, '-') .replace(/\+/g, '-')
.replace(/\//g, '_') .replace(/\//g, '_')
.replace(/=/g, ''); .replace(/=/g, '');
var challenge = { var challenge = {
type: type, type: type,
identifier: { type: 'dns', value: null }, // completed below identifier: { type: 'dns', value: null }, // completed below
wildcard: false, // completed below wildcard: false, // completed below
status: 'pending', status: 'pending',
expires: expires, expires: expires,
token: token, token: token,
thumbprint: thumb, thumbprint: thumb,
keyAuthorization: keyAuth, keyAuthorization: keyAuth,
url: null, // completed below url: null, // completed below
dnsZone: zone, dnsZone: zone,
dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below
dnsAuthorization: dnsAuth, dnsAuthorization: dnsAuth,
altname: altname, altname: altname,
_test: true // used by CLI referenced implementations _test: true // used by CLI referenced implementations
}; };
if (zone) { if (zone) {
challenge.dnsZone = zone; challenge.dnsZone = zone;
challenge.dnsPrefix = challenge.dnsHost challenge.dnsPrefix = challenge.dnsHost
.replace(newZoneRegExp(zone), '') .replace(newZoneRegExp(zone), '')
.replace(/\.$/, ''); .replace(/\.$/, '');
} }
if ('*.' === altname.slice(0, 2)) { if ('*.' === altname.slice(0, 2)) {
challenge.wildcard = true; challenge.wildcard = true;
altname = altname.slice(2); altname = altname.slice(2);
} }
challenge.identifier.value = altname; challenge.identifier.value = altname;
challenge.url = challenge.url =
'http://' + altname + '/.well-known/acme-challenge/' + challenge.token; 'http://' + altname + '/.well-known/acme-challenge/' + challenge.token;
challenge.dnsHost += altname; challenge.dnsHost += altname;
return challenge; return challenge;
} }
function testRecord(type, altname, challenger) { function testRecord(type, altname, challenger) {
return testEach(type, [altname], challenger); return testEach(type, [altname], challenger);
} }
module.exports.testRecord = testRecord; module.exports.testRecord = testRecord;