acme-challenge-test.js/README.md

99 lines
3.2 KiB
Markdown
Raw Normal View History

# [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | A [Root](https://rootprojects.org) Project
2019-04-07 21:55:48 +00:00
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).
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.
## Install
```bash
npm install --save-dev acme-challenge-test@3.x
2019-04-07 21:55:48 +00:00
```
## Usage
```js
var tester = require("acme-challenge-test");
2019-04-07 21:55:48 +00:00
//var challenger = require('acme-http-01-cli').create({});
//var challenger = require('acme-dns-01-cli').create({});
var challenger = require("./YOUR-CHALLENGE-STRATEGY").create({});
2019-04-07 21:55:48 +00:00
// 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";
2019-04-07 21:55:48 +00:00
tester.test("http-01", domain, challenger).then(function() {
console.info("PASS");
2019-04-07 21:55:48 +00:00
});
```
2019-04-16 04:50:02 +00:00
## 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.
- [`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)
2019-04-16 04:50:02 +00:00
## Example
See `example.js` (it works).
2019-04-07 21:55:48 +00:00
## Overview
2019-04-16 04:50:02 +00:00
Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
2019-04-07 21:55:48 +00:00
```js
tester.test('http-01', 'example.com', {
set: function (opts) {
var ch = opts.challenge;
// { type: 'http-01' // or 'dns-01'
// , identifier: { type: 'dns', value: 'example.com' }
// , wildcard: false
// , token: 'xxxx'
// , keyAuthorization: 'xxxx.yyyy'
// , dnsHost: '_acme-challenge.example.com'
// , dnsAuthorization: 'zzzz' }
return API.set(...);
}
, get: function (query) {
var ch = query.challenge;
// { type: 'http-01' // or 'dns-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 }
2019-04-07 21:55:48 +00:00
// Note: query.identifier.value is different for http-01 than for dns-01
return API.get(...).then(function (secret) {
2019-04-07 21:55:48 +00:00
// http-01
return { keyAuthorization: secret };
2019-04-07 21:55:48 +00:00
// dns-01
//return { dnsAuthorization: secret };
2019-04-07 21:55:48 +00:00
});
}
, remove: function (opts) {
var ch = opts.challenge;
// same options as in `set()` (which are not the same as `get()`
return API.remove(...);
}
}).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
location on an http serever, set DNS records, or add the appropriate data to the database that handles such things.