coolaj86/acme-dns-01-test.js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Compare commits

base: coolaj86:master
Branches Tags
coolaj86:master
coolaj86:v3.3.2
coolaj86:v3.3.0
coolaj86:v3.2.1
coolaj86:v3.1.2
coolaj86:v3.1.1
coolaj86:v3.1.0
coolaj86:v3.0.5
coolaj86:v3.0.4
coolaj86:v3.0.3
coolaj86:v3.0.2
coolaj86:v3.0.1
coolaj86:v3.0.0
..
compare: coolaj86:v3.2.1
Branches Tags
coolaj86:master
coolaj86:v3.3.2
coolaj86:v3.3.0
coolaj86:v3.2.1
coolaj86:v3.1.2
coolaj86:v3.1.1
coolaj86:v3.1.0
coolaj86:v3.0.5
coolaj86:v3.0.4
coolaj86:v3.0.3
coolaj86:v3.0.2
coolaj86:v3.0.1
coolaj86:v3.0.0

No commits in common. "master" and "v3.2.1" have entirely different histories.
master ... v3.2.1

3 changed files with 54 additions and 275 deletions
Show Stats Expand all files Collapse all files

300
README.md
View File

@ -1,208 +1,40 @@
# Let's Encrypt + DNS = [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js.git)
| Built by [Root](https://rootprojects.org) for [Hub](https://rootprojects.org/hub/)
# [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js.git) | a [Root](https://rootprojects.org) project
An ACME dns-01 test harness for Let's Encrypt integrations.
| [ACME HTTP-01](https://git.rootprojects.org/root/acme-http-01-test.js)
| [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)
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.
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 JavaScript DNS plugin for Let's Encrypt.
Passing the tests is very easy. There are just four functions to implement:
- `zones()` - list domain zones (i.e. example.co.uk, example.com)
- `set()` - set a TXT record in a zone (i.e. `_acme-challenge.foo` in `example.com`)
- `get()` - confirm that the record was set
- `remove()` - clean up after the ACME challenge passes
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. 👌
**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
```bash
npm install --save-dev acme-dns-01-test@3.x
```
<!--
```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
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'
})
}
});
```
## Greenlock + Let's Encrypt DNS-01
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:
## Usage
```js
var tester = require('acme-dns-01-test');
var YOUR_PLUGIN = require('./YOUR-CHALLENGE-STRATEGY');
var challenger = YOUR_PLUGIN.create({
//var challenger = require('acme-dns-01-cli').create({});
var challenger = require('./YOUR-CHALLENGE-STRATEGY').create({
YOUR_TOKEN_OPTION: 'SOME_API_KEY'
});
```
Run the tests:
```
// 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() {
@ -210,11 +42,8 @@ tester.testZone('dns-01', zone, challenger).then(function() {
});
```
**Note**: Special DNS services, like **DuckDNS**, only give you a **single sub-domain**,
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:
**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';
@ -226,27 +55,15 @@ tester.testRecord('dns-01', record, challenger).then(function() {
## Reference Implementations
- Compatibility
- [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**
These libraries are useful as a model for any plugins that you create.
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.
- 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)
- [`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)
- http-01
- [`cli`](https://git.rootprojects.org/root/acme-http-01-cli.js)
- [`fs`](https://git.rootprojects.org/root/acme-http-01-fs.js)
- [`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)
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-).
@ -254,11 +71,7 @@ and [acme-dns-01-](https://www.npmjs.com/search?q=acme-dns-01-).
If you are building a plugin, please let us know.
We may like to co-author and help maintain and promote your module.
<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
## Example
See `example.js` (it works).
@ -272,16 +85,9 @@ var tester = require('acme-dns-01-test');
// 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';
var deps = {};
tester
.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) {
@ -315,23 +121,31 @@ tester
});
```
## Full Detailed Example
## dns-01 vs http-01
For `type` dns-01:
// `dnsHost` is the domain/subdomain/host
// `dnsAuthorization` is the value of the TXT record
// `dnsPrefix` is the record-only part, if `zones()` is implemented
// `dnsZone` is the zone-only part, if `zones()` is implemented
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
See [acme-http-01-test.js](https://git.rootprojects.org/root/acme-dns-01-test.js.git).
## Detailed Overview
Here's a quick pseudo stub-out of what a test-passing plugin object might look like:
```js
var deps = {};
tester
.testZone('dns-01', 'example.com', {
init: function({ request }) {
// { request: { get, post, put, delete } }
deps.request = request;
return null;
},
zones: function({ dnsHosts }) {
zones: function(opts) {
// { dnsHosts: [
// '_acme-challenge.foo.example.com',
// '_acme-challenge.bar.example.com'
@ -403,6 +217,9 @@ 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,
@ -418,11 +235,6 @@ 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:
Note 1:
@ -435,11 +247,3 @@ 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`
# 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.

25
package-lock.json generated
View File

@ -1,25 +0,0 @@
{
"name": "acme-dns-01-test",
"version": "3.3.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
}
}
}

4
package.json
View File

@ -1,6 +1,6 @@
{
"name": "acme-dns-01-test",
"version": "3.3.2",
"version": "3.2.1",
"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",
"homepage": "https://git.rootprojects.org/root/acme-dns-01-test.js",
@ -9,7 +9,7 @@
"lib"
],
"dependencies": {
"acme-challenge-test": "^3.3.1"
"acme-challenge-test": "^3.2.0"
},
"devDependencies": {
"acme-dns-01-cli": "^3.1.0"