ACME http-01 test harness for Let's Encrypt integration. Any acme-http-01- plugin should be able to pass these tests.
Go to file
AJ ONeal 90d328b37f add LICENSE 2019-04-07 17:55:48 -06:00
.gitignore initial commit 2019-04-07 15:55:48 -06:00
LICENSE add LICENSE 2019-04-07 17:55:48 -06:00
README.md v3.0.0: challenge strategy test suite for Greenlock v2.7+ (and v3) 2019-04-07 17:23:31 -06:00
example.js v3.0.0: challenge strategy test suite for Greenlock v2.7+ (and v3) 2019-04-07 17:23:31 -06:00
index.js v3.0.0: challenge strategy test suite for Greenlock v2.7+ (and v3) 2019-04-07 17:23:31 -06:00
package.json v3.0.0: challenge strategy test suite for Greenlock v2.7+ (and v3) 2019-04-07 17:23:31 -06:00

README.md

greenlock-challenge-test

| A Root Project |

The test harness you should use when writing an ACME challenge strategy for Greenlock 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

npm install --save-dev greenlock-challenge-test@3.x

Usage

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");
});

Overview

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.

Example

See example.js (it works).

Will post reference implementations here later...