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,
"tabWidth": 2,
"trailingComma": "none",
"useTabs": true
"useTabs": false
}

172
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
The test harness you should use when writing an ACME challenge strategy
for [ACME.js](https://git.coolaj86.com/coolaj86/acme-v2.js) and also [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3).
Test harness for ACME http-01 and dns-01 challenges for Let's Encrypt Free SSL integration.
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),
wildcards (`*.example.com`), and valid private / localhost certificates. No worries on your end, just pass the tests. 👌
> If you are building a plugin, please let us know.
> 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
npm install --save-dev acme-challenge-test@3.x
```
Use this for quick-and-easy, average-joe kind of stuff.
## Usage
See <https://git.rootprojects.org/root/acme-http-01-test.js.git>
```js
var tester = require('acme-challenge-test');
## ACME dns-01
//var challenger = require('acme-http-01-cli').create({});
//var challenger = require('acme-dns-01-cli').create({});
var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({
YOUR_TOKEN_OPTION: 'SOME_API_KEY'
});
Use this for wildcards, and private and local domains.
// The dry-run tests can pass on, literally, 'example.com'
// but the integration tests require that you have control over the domain
var zone = 'example.com';
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');
});
```
See <https://git.rootprojects.org/root/acme-dns-01-test.js.git>
## Reference Implementations
These are plugins that use the v2.7+ (v3) API, and pass this test harness,
which you should use as a model for any plugins that you create.
- http-01
- [`acme-http-01-cli`](https://git.rootprojects.org/root/acme-http-01-cli.js)
- [`acme-http-01-fs`](https://git.rootprojects.org/root/acme-http-01-fs.js)
- dns-01
- [`acme-dns-01-cli`](https://git.rootprojects.org/root/acme-dns-01-cli.js)
- [`acme-dns-01-digitalocean`](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js)
You can find other implementations by searching npm for [acme-http-01-](https://www.npmjs.com/search?q=acme-http-01-)
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');
@ -78,21 +49,16 @@ var domain = 'example.com';
tester
.testRecord('http-01', domain, {
// Should set a TXT record for dnsHost with dnsAuthorization and ttl || 300
set: function(opts) {
console.log('set opts:', opts);
throw new Error('set not implemented');
},
// Should remove the *one* TXT record for dnsHost with dnsAuthorization
// Should NOT remove otherrecords for dnsHost (wildcard shares dnsHost with
// non-wildcard)
remove: function(opts) {
console.log('remove opts:', opts);
throw new Error('remove not implemented');
},
// Should get the record via the DNS server's API
get: function(opts) {
console.log('get opts:', opts);
throw new Error('get not implemented');
@ -102,109 +68,3 @@ tester
console.info('PASS');
});
```
## dns-01 vs http-01
For `type` http-01:
// `altname` is the name of the domain
// `token` is the name of the file ( .well-known/acme-challenge/`token` )
// `keyAuthorization` is the contents of the file
For `type` dns-01:
// `dnsHost` is the domain/subdomain/host
// `dnsAuthorization` is the value of the TXT record
## Detailed Overview
Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
```js
tester
.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`

84
index.js
View File

@ -37,7 +37,7 @@ function promiseCheckAndCatch(obj, name) {
);
}
function shouldntBeNull(result) {
function shouldntBeUndefined(result) {
if ('undefined' === typeof result) {
throw new Error(
"'challenge.'" +
@ -50,7 +50,7 @@ function promiseCheckAndCatch(obj, name) {
}
return function(opts) {
return promiser(opts).then(shouldntBeNull);
return promiser(opts).then(shouldntBeUndefined);
};
}
@ -70,17 +70,41 @@ function mapAsync(els, doer) {
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) {
return { domain: d };
});
var rnd = crypto.randomBytes(2).toString('hex');
return chr.zones({ dnsHosts: domains }).then(function(zones) {
return mapAsync(all, function(opts) {
console.info("TEST '%s'", opts.domain);
opts.challenge = fakeChallenge(type, opts.domain, rnd);
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');
@ -209,6 +233,7 @@ function testEach(type, domains, challenger) {
"We'll copy them over here as well, but that's a TODO for next week."
);
});
});
}
function testZone(type, zone, challenger) {
@ -219,23 +244,47 @@ function testZone(type, zone, challenger) {
return testEach(type, domains, challenger);
}
function wrapChallenger(challenger) {
var set = promiseCheckAndCatch(challenger, '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) {
throw new Error(
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.'
' 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 };
process.exit(29);
return;
}
function fakeChallenge(type, altname, rnd) {
return {
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');
@ -258,11 +307,18 @@ function fakeChallenge(type, altname, rnd) {
thumbprint: thumb,
keyAuthorization: keyAuth,
url: null, // completed below
dnsZone: zone,
dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below
dnsAuthorization: dnsAuth,
altname: altname,
_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)) {
challenge.wildcard = true;
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
}

4
package.json
View File

@ -1,7 +1,7 @@
{
"name": "acme-challenge-test",
"version": "3.1.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.",
"version": "3.2.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.",
"main": "index.js",
"homepage": "https://git.rootprojects.org/root/acme-challenge-test.js",
"files": [