99 lines
3.3 KiB
Markdown
99 lines
3.3 KiB
Markdown
# [greenlock-challenge-test](https://git.rootprojects.org/root/greenlock-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).
|
|
|
|
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 greenlock-challenge-test@3.x
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var tester = require('greenlock-challenge-test');
|
|
|
|
//var challenger = require('greenlock-challenge-http').create({});
|
|
//var challenger = require('greenlock-challenge-dns').create({});
|
|
var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({});
|
|
|
|
// 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, challenger).then(function () {
|
|
console.info("PASS");
|
|
});
|
|
```
|
|
|
|
## 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.
|
|
|
|
* [`greenlock-challenge-http`](https://git.rootprojects.org/root/greenlock-challenge-http.js)
|
|
* [`greenlock-challenge-dns`](https://git.rootprojects.org/root/greenlock-challenge-dns.js)
|
|
|
|
## Example
|
|
|
|
See `example.js` (it works).
|
|
|
|
## 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', {
|
|
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 }
|
|
// Note: query.identifier.value is different for http-01 than for dns-01
|
|
|
|
return API.get(...).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 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.
|