Compare commits
7 Commits
Author | SHA1 | Date |
---|---|---|
ocdtrekkie | c642d83484 | |
AJ ONeal | a37e3af043 | |
AJ ONeal | 97c6d2f2c0 | |
AJ ONeal | d593fdde3f | |
AJ ONeal | cba3c635b7 | |
AJ ONeal | 617720d380 | |
AJ ONeal | 27e76a05bb |
369
README.md
369
README.md
|
@ -1,34 +1,208 @@
|
||||||
# [acme-challenge-test](https://git.rootprojects.org/root/acme-challenge-test.js.git) | a [Root](https://rootprojects.org) project
|
# Let's Encrypt + DNS = [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js.git)
|
||||||
|
|
||||||
The test harness you should use when writing an ACME challenge strategy
|
| Built by [Root](https://rootprojects.org) for [Hub](https://rootprojects.org/hub/)
|
||||||
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()`).
|
An ACME dns-01 test harness for Let's Encrypt integrations.
|
||||||
|
|
||||||
The tests account for single-domain certificates (`example.com`) as well as multiple domain certs (SAN / AltName),
|
| [ACME HTTP-01](https://git.rootprojects.org/root/acme-http-01-test.js)
|
||||||
wildcards (`*.example.com`), and valid private / localhost certificates. No worries on your end, just pass the tests. 👌
|
| [ACME DNS-01](https://git.rootprojects.org/root/acme-dns-01-test.js)
|
||||||
|
| [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js)
|
||||||
|
| [Greenlock.js](https://git.rootprojects.org/root/greenlock.js)
|
||||||
|
| [ACME.js](https://git.rootprojects.org/root/acme.js)
|
||||||
|
|
||||||
**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 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),
|
||||||
## Install
|
but will be generically useful to any JavaScript DNS plugin for Let's Encrypt.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save-dev acme-challenge-test@3.x
|
npm install --save-dev acme-dns-01-test@3.x
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
<!--
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx acme-dns-01-test --module /path/to/module.js --foo-user --bar--token
|
||||||
|
```
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
# How Let's Encrypt works with DNS
|
||||||
|
|
||||||
|
In order to validate **wildcard**, **localhost**, and **private domains** through Let's Encrypt,
|
||||||
|
you must use set some special TXT records in your domain's DNS.
|
||||||
|
|
||||||
|
This is called the **ACME DNS-01 Challenge**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
dig TXT example.com
|
||||||
|
|
||||||
|
;; QUESTION SECTION:
|
||||||
|
;_acme-challenge.example.com. IN TXT
|
||||||
|
|
||||||
|
;; ANSWER SECTION:
|
||||||
|
_acme-challenge.example.com. 300 IN TXT "xxxxxxx"
|
||||||
|
_acme-challenge.example.com. 300 IN TXT "xxxxxxx"
|
||||||
|
```
|
||||||
|
|
||||||
|
## ACME DNS-01 Challenge Process
|
||||||
|
|
||||||
|
The ACME DNS-01 Challenge process works like this:
|
||||||
|
|
||||||
|
1. The ACME client order's an SSL Certificate from Let's Encrypt
|
||||||
|
2. Let's Encrypt asks for validation of the domains on the certificate
|
||||||
|
3. The ACME client asks to use DNS record verification
|
||||||
|
4. Let's Encrypt gives a DNS authorization token
|
||||||
|
5. The ACME client manipulates the token and sets TXT record with the result
|
||||||
|
6. Let's Encrypt checks the TXT record from DNS clients in diverse locations
|
||||||
|
7. The ACME client gets a certificate if the validate passes
|
||||||
|
|
||||||
|
# Using a Let's Encrypt DNS plugin
|
||||||
|
|
||||||
|
Each plugin will define some options, such as an api key, or username and password
|
||||||
|
that are specific to that plugin.
|
||||||
|
|
||||||
|
Other than that, they're all used the same.
|
||||||
|
|
||||||
|
## ACME.js + Let's Encrypt DNS-01
|
||||||
|
|
||||||
|
This is how an ACME challenge module is with ACME.js:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
var tester = require('acme-challenge-test');
|
acme.certificates.create({
|
||||||
|
accountKey,
|
||||||
|
csr,
|
||||||
|
domains,
|
||||||
|
challenges: {
|
||||||
|
'dns-01': require('acme-dns-01-MODULE_NAME').create({
|
||||||
|
fooUser: 'A_PLUGIN_SPECIFIC_OPTION',
|
||||||
|
barToken: 'A_PLUGIN_SPECIFIC_OPTION'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
//var challenger = require('acme-http-01-cli').create({});
|
## Greenlock + Let's Encrypt DNS-01
|
||||||
//var challenger = require('acme-dns-01-cli').create({});
|
|
||||||
var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({
|
This is how modules are used with Greenlock / Greenlock Express
|
||||||
|
|
||||||
|
**Global** default:
|
||||||
|
|
||||||
|
```js
|
||||||
|
greenlock.manager.defaults({
|
||||||
|
challenges: {
|
||||||
|
'dns-01': {
|
||||||
|
module: 'acme-dns-01-_MODULE_NAME',
|
||||||
|
fooUser: 'A_PLUGIN_SPECIFIC_OPTION',
|
||||||
|
barToken: 'A_PLUGIN_SPECIFIC_OPTION'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**Per-Site** config:
|
||||||
|
|
||||||
|
```js
|
||||||
|
greenlock.add({
|
||||||
|
subject: 'example.com',
|
||||||
|
altnames: ['example.com', '*.example.com', 'foo.bar.example.com'],
|
||||||
|
challenges: {
|
||||||
|
'dns-01': {
|
||||||
|
module: 'acme-dns-01-YOUR_MODULE_NAME',
|
||||||
|
fooUser: 'A_PLUGIN_SPECIFIC_OPTION',
|
||||||
|
barToken: 'A_PLUGIN_SPECIFIC_OPTION'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
# The Easy Way to Build a Plugin
|
||||||
|
|
||||||
|
This repo includes **unit test suite** which makes it _very_ easy to create a plugin.
|
||||||
|
|
||||||
|
You can start with a **template file** that will fail all of the tests, and just
|
||||||
|
build until you pass all of the tests.
|
||||||
|
|
||||||
|
After that, you can **test the Greenlock CLI** to see if
|
||||||
|
you actually get a valid SSL certificate.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
There are only a few methods to implement - just basic CRUD operations.
|
||||||
|
|
||||||
|
For most serivices these are very simple to implement
|
||||||
|
(see the **reference implementations** down below).
|
||||||
|
|
||||||
|
Some enterprise-y services are more difficult as they may have special
|
||||||
|
rules about zones (Google Cloud) or intricate authentication schemes (AWS).
|
||||||
|
|
||||||
|
```
|
||||||
|
init({ request })
|
||||||
|
|
||||||
|
zones({ dnsHosts })
|
||||||
|
|
||||||
|
set({ challenge: { dnsZone, dnsPrefix, dnsHost, keyAuthorizationDigest } })
|
||||||
|
|
||||||
|
get({ challenge: { dnsZone, dnsPrefix, dnsHost, keyAuthorizationDigest } })
|
||||||
|
|
||||||
|
remove({ challenge: { dnsZone, dnsPrefix, dnsHost, keyAuthorizationDigest } })
|
||||||
|
```
|
||||||
|
|
||||||
|
## Plugin Outline
|
||||||
|
|
||||||
|
This is an even better starter template below,
|
||||||
|
but this outline shows the bare bones of a plugin.
|
||||||
|
|
||||||
|
```
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
var MyModule = module.exports;
|
||||||
|
|
||||||
|
MyModule.create = function (options) {
|
||||||
|
|
||||||
|
var m = {};
|
||||||
|
|
||||||
|
m.init = async function ({ request }) {
|
||||||
|
// (optional) initialize your module
|
||||||
|
}
|
||||||
|
|
||||||
|
m.zones = async function ({ dnsHosts }) {
|
||||||
|
// return a list of "Zones" or "Apex Domains" (i.e. example.com, NOT foo.example.com)
|
||||||
|
}
|
||||||
|
|
||||||
|
m.set = async function ({ challenge: { dnsZone, dnsPrefix, dnsHost, keyAuthorizationDigest } }) {
|
||||||
|
// set a TXT record for dnsHost with keyAuthorizationDigest as the value
|
||||||
|
}
|
||||||
|
|
||||||
|
m.get = async function ({ challenge: { dnsZone, dnsPrefix, dnsHost, keyAuthorizationDigest } }) {
|
||||||
|
// check that the EXACT a TXT record that was set, exists, and return it
|
||||||
|
}
|
||||||
|
|
||||||
|
m.remove = async function ({ challenge: { dnsZone, dnsPrefix, dnsHost, keyAuthorizationDigest } }) {
|
||||||
|
// remove the exact TXT record that was set
|
||||||
|
}
|
||||||
|
|
||||||
|
return m;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Using the Test Suite
|
||||||
|
|
||||||
|
Test setup:
|
||||||
|
|
||||||
|
```js
|
||||||
|
var tester = require('acme-dns-01-test');
|
||||||
|
var YOUR_PLUGIN = require('./YOUR-CHALLENGE-STRATEGY');
|
||||||
|
|
||||||
|
var challenger = YOUR_PLUGIN.create({
|
||||||
YOUR_TOKEN_OPTION: 'SOME_API_KEY'
|
YOUR_TOKEN_OPTION: 'SOME_API_KEY'
|
||||||
});
|
});
|
||||||
|
```
|
||||||
|
|
||||||
// The dry-run tests can pass on, literally, 'example.com'
|
Run the tests:
|
||||||
// but the integration tests require that you have control over the domain
|
|
||||||
|
```
|
||||||
var zone = 'example.com';
|
var zone = 'example.com';
|
||||||
|
|
||||||
tester.testZone('dns-01', zone, challenger).then(function() {
|
tester.testZone('dns-01', zone, challenger).then(function() {
|
||||||
|
@ -36,8 +210,11 @@ tester.testZone('dns-01', zone, challenger).then(function() {
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: If the service you are testing only handles individual records
|
**Note**: Special DNS services, like **DuckDNS**, only give you a **single sub-domain**,
|
||||||
(not multiple records in a zone), you can use `testRecord` instead:
|
not a full "zone". You can test them too:
|
||||||
|
|
||||||
|
Some DNS services, such as **DuckDNS**, only give you a **single sub-domain**,
|
||||||
|
not not _multiple_ records in a zone. Testing them is slightly different:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
var record = 'foo.example.com';
|
var record = 'foo.example.com';
|
||||||
|
@ -49,19 +226,39 @@ tester.testRecord('dns-01', record, challenger).then(function() {
|
||||||
|
|
||||||
## Reference Implementations
|
## Reference Implementations
|
||||||
|
|
||||||
These are plugins that use the v2.7+ (v3) API, and pass this test harness,
|
- Compatibility
|
||||||
which you should use as a model for any plugins that you create.
|
- [x] Let's Encrypt v2.1 / ACME draft 18
|
||||||
|
- [x] Node v6+
|
||||||
|
- [x] Chrome, Firefox, Safari, Edge, etc
|
||||||
|
- Quality
|
||||||
|
- [x] Written in VanillaJS
|
||||||
|
- [x] No compliers or build scripts
|
||||||
|
- [x] Simple, minimal code, in a single file
|
||||||
|
- [x] **Zero dependencies**
|
||||||
|
|
||||||
- [`acme-http-01-cli`](https://git.rootprojects.org/root/acme-http-01-cli.js)
|
These libraries are useful as a model for any plugins that you create.
|
||||||
- [`acme-dns-01-cli`](https://git.rootprojects.org/root/acme-dns-01-cli.js)
|
|
||||||
|
- dns-01
|
||||||
|
- [`cli`](https://git.rootprojects.org/root/acme-dns-01-cli.js)
|
||||||
|
- [`digitalocean`](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js)
|
||||||
|
- [`vultr`](https://git.rootprojects.org/root/acme-dns-01-vultr.js)
|
||||||
|
- [`gandi`](https://git.rootprojects.org/root/acme-dns-01-gandi.js)
|
||||||
|
- [`duckdns`](https://git.rootprojects.org/root/acme-dns-01-duckdns.js)
|
||||||
|
- http-01
|
||||||
|
- [`cli`](https://git.rootprojects.org/root/acme-http-01-cli.js)
|
||||||
|
- [`fs`](https://git.rootprojects.org/root/acme-http-01-fs.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.
|
If you are building a plugin, please let us know.
|
||||||
We would like to co-author and help maintain and promote your module.
|
We may like to co-author and help maintain and promote your module.
|
||||||
|
|
||||||
## Example
|
<small>Note: In some cases (such as non-HTTP, or very complex APIs) you will not be able to maintain
|
||||||
|
browser compatibility. Other than than, if you keep your code simple, it will also work in browser
|
||||||
|
implementations of ACME.js.</small>
|
||||||
|
|
||||||
|
# Example
|
||||||
|
|
||||||
See `example.js` (it works).
|
See `example.js` (it works).
|
||||||
|
|
||||||
|
@ -70,14 +267,28 @@ See `example.js` (it works).
|
||||||
Here's what you could start with.
|
Here's what you could start with.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
var tester = require('acme-challenge-test');
|
var tester = require('acme-dns-01-test');
|
||||||
|
|
||||||
// The dry-run tests can pass on, literally, 'example.com'
|
// The dry-run tests can pass on, literally, 'example.com'
|
||||||
// but the integration tests require that you have control over the domain
|
// but the integration tests require that you have control over the domain
|
||||||
var domain = 'example.com';
|
var zone = 'example.com';
|
||||||
|
var deps = {};
|
||||||
|
|
||||||
tester
|
tester
|
||||||
.testRecord('http-01', domain, {
|
.testZone('dns-01', zone, {
|
||||||
|
// Gives you the promisified `request` object for HTTP APIs
|
||||||
|
init: function(deps) {
|
||||||
|
request = deps.request;
|
||||||
|
return null;
|
||||||
|
},
|
||||||
|
|
||||||
|
// Should return an array of zone domain name strings
|
||||||
|
// (APIs that don't implement zones, such as DuckDNS, should return an empty array)
|
||||||
|
zones: function(opts) {
|
||||||
|
console.log('dnsHosts:', opts.dnsHosts);
|
||||||
|
throw new Error('_zone not implemented');
|
||||||
|
},
|
||||||
|
|
||||||
// Should set a TXT record for dnsHost with dnsAuthorization and ttl || 300
|
// 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);
|
||||||
|
@ -93,6 +304,7 @@ tester
|
||||||
},
|
},
|
||||||
|
|
||||||
// Should get the record via the DNS server's API
|
// Should get the record via the DNS server's API
|
||||||
|
// (Note: gets different options than set or remove)
|
||||||
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');
|
||||||
|
@ -103,61 +315,71 @@ tester
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## dns-01 vs http-01
|
## Full Detailed Example
|
||||||
|
|
||||||
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:
|
Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
|
var deps = {};
|
||||||
|
|
||||||
tester
|
tester
|
||||||
.testZone('dns-01', 'example.com', {
|
.testZone('dns-01', 'example.com', {
|
||||||
|
init: function({ request }) {
|
||||||
|
// { request: { get, post, put, delete } }
|
||||||
|
|
||||||
|
deps.request = request;
|
||||||
|
return null;
|
||||||
|
},
|
||||||
|
|
||||||
|
zones: function({ dnsHosts }) {
|
||||||
|
// { dnsHosts: [
|
||||||
|
// '_acme-challenge.foo.example.com',
|
||||||
|
// '_acme-challenge.bar.example.com'
|
||||||
|
// ] }
|
||||||
|
|
||||||
|
return YourApi(
|
||||||
|
'GET',
|
||||||
|
// Most Domain Zone apis don't have a search or filter option,
|
||||||
|
// but `opts` includes list of dnsHosts is provided just in case.
|
||||||
|
'https://exampledns.com/api/dns/zones?search=' + opts.dnsHosts.join(',')
|
||||||
|
).then(function(result) {
|
||||||
|
return result.zones.map(function(zone) {
|
||||||
|
return zone.name;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
},
|
||||||
|
|
||||||
set: function(opts) {
|
set: function(opts) {
|
||||||
var ch = opts.challenge;
|
var ch = opts.challenge;
|
||||||
// { type: 'dns-01' // or 'http-01'
|
// { type: 'dns-01'
|
||||||
// , identifier: { type: 'dns', value: 'example.com' }
|
// , identifier: { type: 'dns', value: 'foo.example.com' }
|
||||||
// , wildcard: false
|
// , wildcard: false
|
||||||
// , token: 'xxxx'
|
// , dnsHost: '_acme-challenge.foo.example.com'
|
||||||
// , keyAuthorization: 'xxxx.yyyy'
|
// , dnsPrefix: '_acme-challenge.foo'
|
||||||
// , dnsHost: '_acme-challenge.example.com'
|
// , dnsZone: 'example.com'
|
||||||
// , dnsAuthorization: 'zzzz' }
|
// , dnsAuthorization: 'zzzz' }
|
||||||
|
|
||||||
return YourApi('POST', 'https://example.com/api/dns/txt', {
|
return YourApi(
|
||||||
host: ch.dnsHost,
|
'POST',
|
||||||
record: ch.dnsAuthorization
|
'https://exampledns.com/api/dns/txt/' + ch.dnsZone + '/' + ch.dnsPrefix,
|
||||||
});
|
{ value: ch.dnsAuthorization }
|
||||||
|
);
|
||||||
},
|
},
|
||||||
|
|
||||||
get: function(query) {
|
get: function(query) {
|
||||||
var ch = query.challenge;
|
var ch = query.challenge;
|
||||||
// { type: 'dns-01' // or 'http-01', 'tls-alpn-01', etc
|
// { type: 'dns-01'
|
||||||
// , identifier: { type: 'dns', value: 'example.com' }
|
// , identifier: { type: 'dns', value: 'foo.example.com' }
|
||||||
// // http-01 only
|
|
||||||
// , token: 'xxxx'
|
|
||||||
// , url: '...' // for testing and debugging
|
|
||||||
// // dns-01 only, for testing / dubgging
|
|
||||||
// , altname: '...'
|
// , altname: '...'
|
||||||
// , dnsHost: '...'
|
// , dnsHost: '...'
|
||||||
// , wildcard: false }
|
// , wildcard: false }
|
||||||
// Note: query.identifier.value is different for http-01 than for dns-01
|
// Note: query.identifier.value is different for http-01 than for dns-01
|
||||||
|
// because of how a DNS query is different from an HTTP request
|
||||||
|
|
||||||
return YourApi('GET', 'https://example.com/api/dns/txt', {
|
return YourApi(
|
||||||
host: ch.dnsHost
|
'GET',
|
||||||
}).then(function(secret) {
|
'https://exampledns.com/api/dns/txt/' + ch.dnsZone + '/' + ch.dnsPrefix
|
||||||
// http-01
|
).then(function(secret) {
|
||||||
//return { keyAuthorization: secret };
|
|
||||||
// dns-01
|
|
||||||
return { dnsAuthorization: secret };
|
return { dnsAuthorization: secret };
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
|
@ -166,7 +388,10 @@ tester
|
||||||
var ch = opts.challenge;
|
var ch = opts.challenge;
|
||||||
// same options as in `set()` (which are not the same as `get()`
|
// same options as in `set()` (which are not the same as `get()`
|
||||||
|
|
||||||
return YourApi('DELETE', 'https://example.com/api/dns/txt/' + ch.dnsHost);
|
return YourApi(
|
||||||
|
'DELETE',
|
||||||
|
'https://exampledns.com/api/dns/txt/' + ch.dnsZone + '/' + ch.dnsPrefix
|
||||||
|
);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
.then(function() {
|
.then(function() {
|
||||||
|
@ -178,9 +403,6 @@ Where `YourApi` might look something like this:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
var YourApi = function createApi(config) {
|
var YourApi = function createApi(config) {
|
||||||
var request = require('@root/request');
|
|
||||||
request = require('util').promisify(request);
|
|
||||||
|
|
||||||
return function(method, url, body) {
|
return function(method, url, body) {
|
||||||
return request({
|
return request({
|
||||||
method: method,
|
method: method,
|
||||||
|
@ -196,6 +418,11 @@ var YourApi = function createApi(config) {
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note: `request` is actually `@root/request`, but the API is the same as the standard `request`.
|
||||||
|
|
||||||
|
Avoid using 3rd party API libraries where you can - they tend to bloat your dependencies and
|
||||||
|
add security risk. Instead, just use the API documentation and cURL examples.
|
||||||
|
|
||||||
### Two notes:
|
### Two notes:
|
||||||
|
|
||||||
Note 1:
|
Note 1:
|
||||||
|
@ -208,3 +435,11 @@ 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 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 `*.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`
|
- When `altname` is `bar.foo.example.com` the `dnsHost` will be `_acme-challenge.bar.foo.example.com`
|
||||||
|
|
||||||
|
# We Build Let's Encrypt Plugins for You
|
||||||
|
|
||||||
|
Want to get the experts involved? [Contact Root](acme-plugins@therootcompany.com)
|
||||||
|
|
||||||
|
We can take it on ourselves, work within your team, or guide an outsourced team.
|
||||||
|
|
||||||
|
Turnaround is typically a few days for simple modules with publicly available APIs.
|
||||||
|
|
12
example.js
12
example.js
|
@ -1,21 +1,21 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
//var tester = require('acme-challenge-test');
|
//var tester = require('acme-dns-01-test');
|
||||||
var tester = require('./');
|
var tester = require('./');
|
||||||
|
|
||||||
//var type = 'http-01';
|
|
||||||
//var challenger = require('acme-http-01-cli').create({});
|
|
||||||
var type = 'dns-01';
|
var type = 'dns-01';
|
||||||
var challenger = require('acme-dns-01-cli').create({});
|
var challenger = require('acme-dns-01-cli').create({});
|
||||||
//var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({});
|
|
||||||
//var type = 'YOUR-TYPE-01';
|
|
||||||
|
|
||||||
// The dry-run tests can pass on, literally, 'example.com'
|
// The dry-run tests can pass on, literally, 'example.com'
|
||||||
// but the integration tests require that you have control over the domain
|
// but the integration tests require that you have control over the domain
|
||||||
var zone = 'example.com';
|
var zone = 'example.com';
|
||||||
|
|
||||||
tester
|
tester
|
||||||
.test(type, zone, challenger)
|
// Will test these domain records
|
||||||
|
// - example.com
|
||||||
|
// - foo.example.com
|
||||||
|
// - *.foo.example.com
|
||||||
|
.testZone(type, zone, challenger)
|
||||||
.then(function() {
|
.then(function() {
|
||||||
console.info('ALL PASSED');
|
console.info('ALL PASSED');
|
||||||
})
|
})
|
||||||
|
|
283
index.js
283
index.js
|
@ -1,284 +1,3 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
/*global Promise*/
|
|
||||||
var crypto = require('crypto');
|
|
||||||
|
|
||||||
module.exports.create = function() {
|
module.exports = require('acme-challenge-test');
|
||||||
throw new Error(
|
|
||||||
'acme-challenge-test is a test fixture for acme-challenge-* plugins, not a plugin itself'
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
// ignore all of this, it's just to normalize Promise vs node-style callback thunk vs synchronous
|
|
||||||
function promiseCheckAndCatch(obj, name) {
|
|
||||||
var promisify = require('util').promisify;
|
|
||||||
// don't loose this-ness, just in case that's important
|
|
||||||
var fn = obj[name].bind(obj);
|
|
||||||
var promiser;
|
|
||||||
|
|
||||||
// function signature must match, or an error will be thrown
|
|
||||||
if (1 === fn.length) {
|
|
||||||
// wrap so that synchronous errors are caught (alsa handles synchronous results)
|
|
||||||
promiser = function(opts) {
|
|
||||||
return Promise.resolve().then(function() {
|
|
||||||
return fn(opts);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
} else if (2 === fn.length) {
|
|
||||||
// wrap as a promise
|
|
||||||
promiser = promisify(fn);
|
|
||||||
} else {
|
|
||||||
return Promise.reject(
|
|
||||||
new Error(
|
|
||||||
"'challenge." +
|
|
||||||
name +
|
|
||||||
"' should accept either one argument, the options," +
|
|
||||||
' and return a Promise or accept two arguments, the options and a node-style callback thunk'
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function shouldntBeNull(result) {
|
|
||||||
if ('undefined' === typeof result) {
|
|
||||||
throw new Error(
|
|
||||||
"'challenge.'" +
|
|
||||||
name +
|
|
||||||
"' should never return `undefined`. Please explicitly return null" +
|
|
||||||
" (or fix the place where a value should have been returned but wasn't)."
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
return function(opts) {
|
|
||||||
return promiser(opts).then(shouldntBeNull);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function mapAsync(els, doer) {
|
|
||||||
els = els.slice(0);
|
|
||||||
var results = [];
|
|
||||||
function next() {
|
|
||||||
var el = els.shift();
|
|
||||||
if (!el) {
|
|
||||||
return results;
|
|
||||||
}
|
|
||||||
return doer(el).then(function(result) {
|
|
||||||
results.push(result);
|
|
||||||
return next();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return next();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Here's the meat, where the tests are happening:
|
|
||||||
function testEach(type, domains, challenger) {
|
|
||||||
var chr = wrapChallenger(challenger);
|
|
||||||
var all = domains.map(function(d) {
|
|
||||||
return { domain: d };
|
|
||||||
});
|
|
||||||
var rnd = crypto.randomBytes(2).toString('hex');
|
|
||||||
|
|
||||||
return mapAsync(all, function(opts) {
|
|
||||||
console.info("TEST '%s'", opts.domain);
|
|
||||||
opts.challenge = fakeChallenge(type, 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');
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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;
|
|
||||||
});
|
|
||||||
})
|
|
||||||
.then(function(all) {
|
|
||||||
return mapAsync(all, function(opts) {
|
|
||||||
var ch = opts.challenge;
|
|
||||||
return chr.get({ challenge: opts.query }).then(function(secret) {
|
|
||||||
if ('string' === typeof secret) {
|
|
||||||
console.info(
|
|
||||||
'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'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// historically 'secret' has been a string, but I'd like it to transition to be an object.
|
|
||||||
// to make it backwards compatible in v2.7 to change it,
|
|
||||||
// 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
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
})
|
|
||||||
.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."
|
|
||||||
);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function testZone(type, zone, challenger) {
|
|
||||||
var domains = [zone, 'foo.' + zone];
|
|
||||||
if ('dns-01' === type) {
|
|
||||||
domains.push('*.foo.' + zone);
|
|
||||||
}
|
|
||||||
return testEach(type, domains, challenger);
|
|
||||||
}
|
|
||||||
|
|
||||||
function wrapChallenger(challenger) {
|
|
||||||
var set = promiseCheckAndCatch(challenger, 'set');
|
|
||||||
if ('function' !== typeof challenger.get) {
|
|
||||||
throw new 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.'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
var get = promiseCheckAndCatch(challenger, 'get');
|
|
||||||
var remove = promiseCheckAndCatch(challenger, 'remove');
|
|
||||||
|
|
||||||
return { set: set, get: get, remove: remove };
|
|
||||||
}
|
|
||||||
|
|
||||||
function fakeChallenge(type, 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');
|
|
||||||
var keyAuth = token + '.' + crypto.randomBytes(16).toString('hex');
|
|
||||||
var dnsAuth = crypto
|
|
||||||
.createHash('sha256')
|
|
||||||
.update(keyAuth)
|
|
||||||
.digest('base64')
|
|
||||||
.replace(/\+/g, '-')
|
|
||||||
.replace(/\//g, '_')
|
|
||||||
.replace(/=/g, '');
|
|
||||||
|
|
||||||
var challenge = {
|
|
||||||
type: type,
|
|
||||||
identifier: { type: 'dns', value: null }, // completed below
|
|
||||||
wildcard: false, // completed below
|
|
||||||
status: 'pending',
|
|
||||||
expires: expires,
|
|
||||||
token: token,
|
|
||||||
thumbprint: thumb,
|
|
||||||
keyAuthorization: keyAuth,
|
|
||||||
url: null, // completed below
|
|
||||||
dnsHost: '_' + rnd.slice(0, 2) + '-acme-challenge-' + rnd.slice(2) + '.', // completed below
|
|
||||||
dnsAuthorization: dnsAuth,
|
|
||||||
altname: altname,
|
|
||||||
_test: true // used by CLI referenced implementations
|
|
||||||
};
|
|
||||||
if ('*.' === altname.slice(0, 2)) {
|
|
||||||
challenge.wildcard = true;
|
|
||||||
altname = altname.slice(2);
|
|
||||||
}
|
|
||||||
challenge.identifier.value = altname;
|
|
||||||
challenge.url =
|
|
||||||
'http://' + altname + '/.well-known/acme-challenge/' + challenge.token;
|
|
||||||
challenge.dnsHost += altname;
|
|
||||||
|
|
||||||
return challenge;
|
|
||||||
}
|
|
||||||
|
|
||||||
function testRecord(type, altname, challenger) {
|
|
||||||
return testEach(type, [altname], challenger);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports.testRecord = testRecord;
|
|
||||||
module.exports.testZone = testZone;
|
|
||||||
module.exports.test = testZone;
|
|
||||||
|
|
|
@ -1,5 +1,25 @@
|
||||||
{
|
{
|
||||||
"name": "acme-challenge-test",
|
"name": "acme-dns-01-test",
|
||||||
"version": "3.0.4",
|
"version": "3.3.1",
|
||||||
"lockfileVersion": 1
|
"lockfileVersion": 1,
|
||||||
|
"requires": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@root/request": {
|
||||||
|
"version": "1.3.11",
|
||||||
|
"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
|
||||||
|
"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw=="
|
||||||
|
},
|
||||||
|
"acme-challenge-test": {
|
||||||
|
"version": "3.3.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/acme-challenge-test/-/acme-challenge-test-3.3.1.tgz",
|
||||||
|
"integrity": "sha512-y7iCHb70hWuFgPvtAWwQd1sz9I2Atu+6PKhN5sIIfqDhkg/sVmlxAVKXn6/SBx9TSrP50xHtiAnMkmt+umemDw==",
|
||||||
|
"requires": {
|
||||||
|
"@root/request": "^1.3.11"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"acme-dns-01-cli": {
|
||||||
|
"version": "3.1.0",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
19
package.json
19
package.json
|
@ -1,26 +1,29 @@
|
||||||
{
|
{
|
||||||
"name": "acme-challenge-test",
|
"name": "acme-dns-01-test",
|
||||||
"version": "3.1.2",
|
"version": "3.3.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.",
|
"description": "ACME dns-01 tests for Let's Encrypt integration. Any `acme-dns-01-` 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-dns-01-test.js",
|
||||||
"files": [
|
"files": [
|
||||||
"example.js",
|
"example.js",
|
||||||
"lib"
|
"lib"
|
||||||
],
|
],
|
||||||
"dependencies": {},
|
"dependencies": {
|
||||||
"devDependencies": {},
|
"acme-challenge-test": "^3.3.1"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"acme-dns-01-cli": "^3.1.0"
|
||||||
|
},
|
||||||
"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-dns-01-test.js.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"Let's Encrypt",
|
"Let's Encrypt",
|
||||||
"ACME",
|
"ACME",
|
||||||
"http-01",
|
|
||||||
"dns-01",
|
"dns-01",
|
||||||
"challenge",
|
"challenge",
|
||||||
"plugin",
|
"plugin",
|
||||||
|
|
Loading…
Reference in New Issue