Merge branch 'master' of ssh://git.coolaj86.com:22042/coolaj86/acme-challenge-test.js
This commit is contained in:
commit
e179188bc0
140
README.md
140
README.md
|
|
@ -1,13 +1,14 @@
|
|||
# [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
|
||||
for [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3).
|
||||
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()`).
|
||||
|
||||
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. As someone creating a challenge strategy
|
||||
that's not something you have to take special consideration for - just pass the tests.
|
||||
wildcards (`*.example.com`), and valid private / localhost certificates. No worries on your end, just pass the tests. 👌
|
||||
|
||||
**Node v6 Support**: Please build community plugins using node v6 / vanillajs to ensure that all acme.js and greenlock.js users are fully supported.
|
||||
|
||||
## Install
|
||||
|
||||
|
|
@ -22,7 +23,9 @@ var tester = require("acme-challenge-test");
|
|||
|
||||
//var challenger = require('acme-http-01-cli').create({});
|
||||
//var challenger = require('acme-dns-01-cli').create({});
|
||||
var challenger = require("./YOUR-CHALLENGE-STRATEGY").create({});
|
||||
var challenger = require("./YOUR-CHALLENGE-STRATEGY").create({
|
||||
YOUR_TOKEN_OPTION: 'SOME_API_KEY'
|
||||
});
|
||||
|
||||
// The dry-run tests can pass on, literally, 'example.com'
|
||||
// but the integration tests require that you have control over the domain
|
||||
|
|
@ -41,19 +44,74 @@ 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)
|
||||
- [`acme-dns-01-cli`](https://git.rootprojects.org/root/acme-dns-01-cli.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-).
|
||||
|
||||
## Example
|
||||
|
||||
See `example.js` (it works).
|
||||
|
||||
## Overview
|
||||
## Starter Template
|
||||
|
||||
Here's what you could start with.
|
||||
|
||||
```js
|
||||
var tester = require('acme-challenge-test');
|
||||
|
||||
// The dry-run tests can pass on, literally, 'example.com'
|
||||
// but the integration tests require that you have control over the domain
|
||||
var domain = 'example.com';
|
||||
|
||||
tester
|
||||
.test('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');
|
||||
}
|
||||
})
|
||||
.then(function() {
|
||||
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.test('http-01', 'example.com', {
|
||||
tester
|
||||
.test('dns-01', 'example.com', {
|
||||
|
||||
set: function(opts) {
|
||||
var ch = opts.challenge;
|
||||
// { type: 'http-01' // or 'dns-01'
|
||||
// { type: 'dns-01' // or 'http-01'
|
||||
// , identifier: { type: 'dns', value: 'example.com' }
|
||||
// , wildcard: false
|
||||
// , token: 'xxxx'
|
||||
|
|
@ -61,11 +119,15 @@ tester.test('http-01', 'example.com', {
|
|||
// , dnsHost: '_acme-challenge.example.com'
|
||||
// , dnsAuthorization: 'zzzz' }
|
||||
|
||||
return API.set(...);
|
||||
}
|
||||
, get: function (query) {
|
||||
return YourApi('POST', 'https://example.com/api/dns/txt', {
|
||||
host: ch.dnsHost,
|
||||
record: ch.dnsAuthorization
|
||||
});
|
||||
},
|
||||
|
||||
get: function(query) {
|
||||
var ch = query.challenge;
|
||||
// { type: 'http-01' // or 'dns-01', 'tls-alpn-01', etc
|
||||
// { type: 'dns-01' // or 'http-01', 'tls-alpn-01', etc
|
||||
// , identifier: { type: 'dns', value: 'example.com' }
|
||||
// // http-01 only
|
||||
// , token: 'xxxx'
|
||||
|
|
@ -76,23 +138,59 @@ tester.test('http-01', 'example.com', {
|
|||
// , wildcard: false }
|
||||
// Note: query.identifier.value is different for http-01 than for dns-01
|
||||
|
||||
return API.get(...).then(function (secret) {
|
||||
return YourApi('GET', 'https://example.com/api/dns/txt', {
|
||||
host: ch.dnsHost
|
||||
}).then(function(secret) {
|
||||
// http-01
|
||||
return { keyAuthorization: secret };
|
||||
//return { keyAuthorization: secret };
|
||||
// dns-01
|
||||
//return { dnsAuthorization: secret };
|
||||
return { dnsAuthorization: secret };
|
||||
});
|
||||
}
|
||||
, remove: function (opts) {
|
||||
},
|
||||
|
||||
remove: function(opts) {
|
||||
var ch = opts.challenge;
|
||||
// same options as in `set()` (which are not the same as `get()`
|
||||
|
||||
return API.remove(...);
|
||||
return YourApi('DELETE', 'https://example.com/api/dns/txt/' + ch.dnsHost);
|
||||
}
|
||||
}).then(function () {
|
||||
console.info("PASS");
|
||||
})
|
||||
.then(function() {
|
||||
console.info('PASS');
|
||||
});
|
||||
```
|
||||
|
||||
Note: The `API.get()`, `API.set()`, and `API.remove()` is where you do your magic up to upload a file to the correct
|
||||
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`
|
||||
|
|
|
|||
Loading…
Reference in New Issue