coolaj86
/
acme-challenge-test.js
1
0
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

v3.2.0: support zones(), separate docs

This commit is contained in:
AJ ONeal 2019-06-13 01:32:52 -06:00
parent dda7ecb497
commit c473091e0e
5 changed files with 239 additions and 328 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.prettierrc
View File

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

176
README.md
View File

@ -1,73 +1,44 @@
# [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | a [Root](https://rootprojects.org) project # [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | a [Root](https://rootprojects.org) project
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.git>
```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.git>
// 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 ## Reference Implementations
These are plugins that use the v2.7+ (v3) API, and pass this test harness, 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. 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-) 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-).
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 ## 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 ```js
var tester = require('acme-challenge-test'); var tester = require('acme-challenge-test');
@ -78,21 +49,16 @@ var domain = 'example.com';
tester 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
// Should NOT remove otherrecords for dnsHost (wildcard shares dnsHost with
// non-wildcard)
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');
}, },
// 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');
@ -102,109 +68,3 @@ tester
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`

322
index.js
View File

@ -37,7 +37,7 @@ function promiseCheckAndCatch(obj, name) {
); );
} }
function shouldntBeNull(result) { function shouldntBeUndefined(result) {
if ('undefined' === typeof result) { if ('undefined' === typeof result) {
throw new Error( throw new Error(
"'challenge.'" + "'challenge.'" +
@ -50,7 +50,7 @@ function promiseCheckAndCatch(obj, name) {
} }
return function(opts) { return function(opts) {
return promiser(opts).then(shouldntBeNull); return promiser(opts).then(shouldntBeUndefined);
}; };
} }
@ -70,145 +70,170 @@ function mapAsync(els, doer) {
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: // Here's the meat, where the tests are happening:
function testEach(type, domains, challenger) { function testEach(type, domains, challenger) {
var chr = wrapChallenger(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 mapAsync(all, function(opts) { return chr.zones({ dnsHosts: domains }).then(function(zones) {
console.info("TEST '%s'", opts.domain); return mapAsync(all, function(opts) {
opts.challenge = fakeChallenge(type, opts.domain, rnd); console.info("TEST '%s'", opts.domain);
var ch = opts.challenge; var zone = pluckZone(zones, opts.domain);
if ('http-01' === ch.type && ch.wildname) { opts.challenge = fakeChallenge(type, zone, opts.domain, rnd);
throw new Error('http-01 cannot be used for wildcard domains'); 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
return chr.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) {
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;
} else {
query = JSON.parse(JSON.stringify(ch));
query.comment = 'unknown challenge type, supplying everything';
} }
opts.query = query;
return opts; // The first time we just check it against itself
}); // this will cause the prompt to appear
}) return chr.set(opts).then(function() {
.then(function(all) { // this will cause the final completion message to appear
return mapAsync(all, function(opts) { // _test is used by the manual cli reference implementations
var ch = opts.challenge; var query = { type: ch.type, /*debug*/ status: ch.status, _test: true };
return chr.get({ challenge: opts.query }).then(function(secret) { if ('http-01' === ch.type) {
if ('string' === typeof secret) { query.identifier = ch.identifier;
console.info( query.token = ch.token;
'secret was passed as a string, which works historically, but should be an object instead:' // For testing only
); query.url = ch.challengeUrl;
console.info('{ "keyAuthorization": "' + secret + '" }'); } else if ('dns-01' === ch.type) {
console.info('or'); query.identifier = { type: 'dns', value: ch.dnsHost };
// TODO this should be "keyAuthorizationDigest" // For testing only
console.info('{ "dnsAuthorization": "' + secret + '" }'); query.altname = ch.altname;
console.info( // there should only be two possible TXT records per challenge domain:
'This is to help keep acme / greenlock (and associated plugins) future-proof for new challenge types' // one for the bare domain, and the other if and only if there's a wildcard
); query.wildcard = ch.wildcard;
} query.dnsAuthorization = ch.dnsAuthorization;
// historically 'secret' has been a string, but I'd like it to transition to be an object. } else {
// to make it backwards compatible in v2.7 to change it, query = JSON.parse(JSON.stringify(ch));
// so I'm not sure that we really need to. query.comment = 'unknown challenge type, supplying everything';
if ('http-01' === ch.type) { }
secret = secret.keyAuthorization || secret; opts.query = query;
if (ch.keyAuthorization !== secret) { return opts;
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(all) {
return mapAsync(all, function(opts) { return mapAsync(all, function(opts) {
return chr.remove(opts).then(function() { var ch = opts.challenge;
return chr.get(opts).then(function(result) { return chr.get({ challenge: opts.query }).then(function(secret) {
if (result) { if ('string' === typeof secret) {
throw new Error( console.info(
'challenge.remove() should have made it not possible for challenge.get() to return a value' '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'
); );
} }
if (null !== result) { // historically 'secret' has been a string, but I'd like it to transition to be an object.
throw new Error( // to make it backwards compatible in v2.7 to change it,
'challenge.get() should return null when the value is not set' // 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
);
}
} }
console.info("PASS '%s'", opts.domain);
}); });
}); });
})
.then(function() {
return mapAsync(all, function(opts) {
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'
);
}
console.info("PASS '%s'", opts.domain);
});
});
});
})
.then(function() {
console.info('All soft tests: PASS');
console.warn(
'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.'
);
console.warn(
"We'll copy them over here as well, but that's a TODO for next week."
);
}); });
}) });
.then(function() {
console.info('All soft tests: PASS');
console.warn(
'Hard tests (actually checking http URLs and dns records) is implemented in acme-v2.'
);
console.warn(
"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) {
@ -219,23 +244,47 @@ function testZone(type, zone, challenger) {
return testEach(type, domains, challenger); return testEach(type, domains, challenger);
} }
function wrapChallenger(challenger) { function wrapChallenger(type, challenger) {
var set = promiseCheckAndCatch(challenger, 'set'); 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) { if ('function' !== typeof challenger.get) {
throw new 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), which will already be done as part of this test.' ' 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 get = promiseCheckAndCatch(challenger, 'get');
var remove = promiseCheckAndCatch(challenger, 'remove');
return { set: set, get: get, remove: remove }; return {
zones: zones,
set: promiseCheckAndCatch(challenger, 'set'),
get: promiseCheckAndCatch(challenger, 'get'),
remove: promiseCheckAndCatch(challenger, 'remove')
};
} }
function fakeChallenge(type, 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');
@ -258,11 +307,18 @@ function fakeChallenge(type, altname, rnd) {
thumbprint: thumb, thumbprint: thumb,
keyAuthorization: keyAuth, keyAuthorization: keyAuth,
url: null, // completed below url: null, // completed below
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) {
challenge.dnsZone = zone;
challenge.dnsPrefix = challenge.dnsHost
.replace(newZoneRegExp(zone), '')
.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);

5
package-lock.json generated
View File

@ -1,5 +0,0 @@
{
"name": "acme-challenge-test",
"version": "3.0.4",
"lockfileVersion": 1
}

62
package.json
View File

@ -1,33 +1,33 @@
{ {
"name": "acme-challenge-test", "name": "acme-challenge-test",
"version": "3.1.2", "version": "3.2.0",
"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",
"files": [ "files": [
"example.js", "example.js",
"lib" "lib"
], ],
"dependencies": {}, "dependencies": {},
"devDependencies": {}, "devDependencies": {},
"scripts": { "scripts": {
"test": "node example.js" "test": "node example.js"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://git.rootprojects.org/root/acme-challenge-test.js.git" "url": "https://git.rootprojects.org/root/acme-challenge-test.js.git"
}, },
"keywords": [ "keywords": [
"Let's Encrypt", "Let's Encrypt",
"ACME", "ACME",
"http-01", "http-01",
"dns-01", "dns-01",
"challenge", "challenge",
"plugin", "plugin",
"module", "module",
"strategy", "strategy",
"greenlock" "greenlock"
], ],
"author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)", "author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
"license": "MPL-2.0" "license": "MPL-2.0"
} }