v3.3.0: include request, cleanup #3
375
index.js
375
index.js
|
@ -1,6 +1,29 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
/*global Promise*/
|
/*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('./node-v6-compat.js');
|
||||||
|
|
||||||
|
// Load _after_ node v6 compat
|
||||||
var crypto = require('crypto');
|
var crypto = require('crypto');
|
||||||
|
var promisify = require('util').promisify;
|
||||||
|
var request = require('@root/request');
|
||||||
|
request = promisify(request);
|
||||||
|
|
||||||
module.exports.create = function() {
|
module.exports.create = function() {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
|
@ -10,13 +33,12 @@ module.exports.create = function() {
|
||||||
|
|
||||||
// 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;
|
|
||||||
// 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() {
|
||||||
|
@ -27,13 +49,11 @@ function promiseCheckAndCatch(obj, name) {
|
||||||
// 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'
|
|
||||||
)
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -42,7 +62,7 @@ function promiseCheckAndCatch(obj, name) {
|
||||||
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)."
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
@ -79,6 +99,7 @@ function newZoneRegExp(zonename) {
|
||||||
// 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) {
|
||||||
|
@ -95,155 +116,201 @@ function pluckZone(zones, dnsHost) {
|
||||||
// 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) {
|
// 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');
|
var rnd = crypto.randomBytes(2).toString('hex');
|
||||||
|
|
||||||
console.info("Testing each of '%s'", domains.join(', '));
|
console.info("Testing each of '%s'", domains.join(', '));
|
||||||
return chr.zones({ dnsHosts: domains }).then(function(zones) {
|
|
||||||
return mapAsync(all, function(opts) {
|
|
||||||
var zone = pluckZone(zones, opts.domain);
|
|
||||||
opts.challenge = fakeChallenge(type, zone, opts.domain, rnd);
|
|
||||||
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;
|
|
||||||
} 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;
|
|
||||||
});
|
|
||||||
})
|
})
|
||||||
.then(function(all) {
|
.then(function(zones) {
|
||||||
return mapAsync(all, function(opts) {
|
var all = domains.map(function(domain) {
|
||||||
var ch = opts.challenge;
|
var zone = pluckZone(zones, domain);
|
||||||
return chr.get({ challenge: opts.query }).then(function(secret) {
|
return {
|
||||||
if ('string' === typeof secret) {
|
domain: domain,
|
||||||
console.info(
|
challenge: fakeChallenge(type, zone, domain, rnd),
|
||||||
'secret was passed as a string, which works historically, but should be an object instead:'
|
request: request
|
||||||
);
|
};
|
||||||
console.info('{ "keyAuthorization": "' + secret + '" }');
|
});
|
||||||
console.info('or');
|
|
||||||
// TODO this should be "keyAuthorizationDigest"
|
// resolving for the sake of same indentation / scope
|
||||||
console.info('{ "dnsAuthorization": "' + secret + '" }');
|
return Promise.resolve()
|
||||||
console.info(
|
.then(function() {
|
||||||
'This is to help keep acme / greenlock (and associated plugins) future-proof for new challenge types'
|
return mapAsync(all, function(opts) {
|
||||||
);
|
return set(chr, opts);
|
||||||
}
|
|
||||||
// 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
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
});
|
})
|
||||||
})
|
.then(function() {
|
||||||
.then(function() {
|
return mapAsync(all, function(opts) {
|
||||||
return mapAsync(all, function(opts) {
|
return check(chr, opts);
|
||||||
return chr.remove(opts).then(function() {
|
});
|
||||||
return chr.get(opts).then(function(result) {
|
})
|
||||||
if (result) {
|
.then(function() {
|
||||||
throw new Error(
|
return mapAsync(all, function(opts) {
|
||||||
'challenge.remove() should have made it not possible for challenge.get() to return a value'
|
return remove(chr, opts).then(function() {
|
||||||
);
|
|
||||||
}
|
|
||||||
if (null !== result) {
|
|
||||||
throw new Error(
|
|
||||||
'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() {
|
||||||
|
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();
|
||||||
});
|
});
|
||||||
})
|
});
|
||||||
.then(function() {
|
}
|
||||||
console.info('All soft tests: PASS');
|
|
||||||
console.warn(
|
function set(chr, opts) {
|
||||||
'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.'
|
var ch = opts.challenge;
|
||||||
);
|
if ('http-01' === ch.type && ch.wildname) {
|
||||||
console.warn(
|
throw new Error('http-01 cannot be used for wildcard domains');
|
||||||
"We'll copy them over here as well, but that's a TODO for next week."
|
}
|
||||||
);
|
|
||||||
});
|
//
|
||||||
|
// 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 testZone(type, zone, challenger) {
|
function check(chr, opts) {
|
||||||
var domains = [zone, 'foo.' + zone];
|
var ch = opts.challenge;
|
||||||
if ('dns-01' === type) {
|
|
||||||
domains.push('*.foo.' + zone);
|
//
|
||||||
}
|
// Get
|
||||||
return testEach(type, domains, challenger);
|
//
|
||||||
|
// 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) {
|
function wrapChallenger(type, challenger) {
|
||||||
|
@ -278,7 +345,14 @@ function wrapChallenger(type, challenger) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var init = challenger.init;
|
||||||
|
if ('function' !== typeof init) {
|
||||||
|
init = function(opts) {
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
}
|
||||||
return {
|
return {
|
||||||
|
init: promiseCheckAndCatch(challenger, 'init'),
|
||||||
zones: zones,
|
zones: zones,
|
||||||
set: promiseCheckAndCatch(challenger, 'set'),
|
set: promiseCheckAndCatch(challenger, 'set'),
|
||||||
get: promiseCheckAndCatch(challenger, 'get'),
|
get: promiseCheckAndCatch(challenger, 'get'),
|
||||||
|
@ -309,6 +383,7 @@ function fakeChallenge(type, zone, altname, rnd) {
|
||||||
thumbprint: thumb,
|
thumbprint: thumb,
|
||||||
keyAuthorization: keyAuth,
|
keyAuthorization: keyAuth,
|
||||||
url: null, // completed below
|
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
|
dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below
|
||||||
dnsAuthorization: dnsAuth,
|
dnsAuthorization: dnsAuth,
|
||||||
altname: altname,
|
altname: altname,
|
||||||
|
@ -332,6 +407,14 @@ function fakeChallenge(type, zone, altname, rnd) {
|
||||||
return challenge;
|
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) {
|
function testRecord(type, altname, challenger) {
|
||||||
return testEach(type, [altname], challenger);
|
return testEach(type, [altname], challenger);
|
||||||
}
|
}
|
||||||
|
|
|
@ -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;
|
||||||
|
}
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "acme-challenge-test",
|
"name": "acme-challenge-test",
|
||||||
"version": "3.2.1",
|
"version": "3.3.0",
|
||||||
"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": "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",
|
||||||
|
|
Loading…
Reference in New Issue