Compare commits

...

2 Commits

Author SHA1 Message Date
AJ ONeal 0dc09293ea v3.0.2: update docs 2019-04-15 23:21:16 -06:00
AJ ONeal e39eca4ed1 v3.0.1: add missing arguments 2019-04-08 01:45:55 -06:00
4 changed files with 39 additions and 23 deletions

View File

@ -1,6 +1,4 @@
# [greenlock-store-test](https://git.coolaj86.com/coolaj86/greenlock-store-test.js.git)
| A [Root](https://rootprojects.org) Project |
# [greenlock-store-test](https://git.rootprojects.org/root/greenlock-store-test.js.git) | A [Root](https://rootprojects.org) Project
The test harness you should use when writing a certificate and keypair storage strategy
for [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3).
@ -32,6 +30,29 @@ tester.test(store).then(function () {
});
```
## 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-store-memory`](https://git.rootprojects.org/root/greenlock-store-memory.js)
* [`greenlock-store-fs`](https://git.rootprojects.org/root/greenlock-store-fs.js)
## Example
See `example.js` (it works).
## Looking for the Easy Button?
[Contact Root](mailto:support@rootprojects.org)
If you're looking for fast and inexpensive plugin development,
we can deliver greater value in less time than most outsouring options.
We can also work with your in-house team to give a quick, inexpensive 10x
boost to internal development success.
We also offer commercial licenses for LTS (Long-Term Support) versions of Greenlock.
## Overview
The most generic implementation, with no special considerations or custom logic, ends up looking like this:
@ -104,10 +125,3 @@ tester.test({
```
Note: The `DB.x.y()` is where you do your magic up to connect to a database or API or whatever and keep stuff safe.
## Examples
See the reference implementations (they work):
* [`greenlock-store-memory`](https://git.coolaj86.com/coolaj86/greenlock-store-memory)
* [`greenlock-store-fs`](https://git.coolaj86.com/coolaj86/greenlock-store-fs)

View File

@ -1,6 +1,6 @@
'use strict';
//var tester = require('greenlock-challenge-test');
//var tester = require('greenlock-store-test');
var tester = require('./');
var store = require('greenlock-store-memory').create({});

View File

@ -84,35 +84,36 @@ module.exports.test = function (store) {
}
}).then(function () {
// TODO check accounts.check
var opts = { account: {}, email: email };
var opts = { account: {}, email: email, subject: subject, certificate: {} };
return checkAccountKey(opts).then(function (results) {
if (null !== results) {
throw new Error("should not have an account keypair for " + subject);
}
});
}).then(function () {
var opts = { account: {}, email: email, keypair: accountKey };
var opts = { account: {}, email: email, keypair: accountKey, subject: subject, certificate: {} };
return setAccountKey(opts).then(function (results) {
if ('undefined' === typeof results) {
throw new Error("should never get undefined as a return value, did you forget to return?");
}
});
}).then(function () {
var opts = { certificate: {}, subject: subject, keypair: domainKey };
var opts = { certificate: {}, subject: subject, keypair: domainKey, email: email, account: {} };
return setCertKey(opts).then(function (results) {
if ('undefined' === typeof results) {
throw new Error("should never get undefined as a return value, did you forget to return?");
}
});
}).then(function () {
var opts = { certificate: {}, subject: subject, pems: domainCert };
var opts = { certificate: {}, subject: subject, pems: domainCert, email: email, account: {} };
return setCert(opts).then(function (results) {
if ('undefined' === typeof results) {
throw new Error("should never get undefined as a return value, did you forget to return?");
}
});
}).then(function () {
return checkCerts({ certificate: {}, subject: subject }).then(function (results) {
var opts = { certificate: {}, subject: subject, email: email, account: {} };
return checkCerts(opts).then(function (results) {
if (!results || !results.chain || !results.cert) {
throw new Error("expected to get certificate and chain for " + subject);
}
@ -149,7 +150,7 @@ module.exports.test = function (store) {
}
});
}).then(function () {
var opts = { certificate: {}, subject: subject };
var opts = { certificate: {}, subject: subject, email: email, account: {} };
return checkCertKey(opts).then(function (results) {
if (!results) {
throw new Error("Should have found a keypair for " + opts.subject);
@ -172,7 +173,7 @@ module.exports.test = function (store) {
}
});
}).then(function () {
var opts = { account: {}, email: email };
var opts = { account: {}, email: email, subject: subject, certificate: {} };
return checkAccountKey(opts).then(function (results) {
if (!results) {
throw new Error("Should have found a keypair for " + opts.email);

View File

@ -1,7 +1,8 @@
{
"name": "greenlock-store-test",
"version": "3.0.0",
"description": "The base set of tests for all certificate and keypair storage strategies. Any Greenlock `le-store-` plugin should be able to pass these tests.",
"version": "3.0.2",
"description": "The base set of tests for all certificate and keypair storage strategies. Any Greenlock `greenlock-store-` plugin should be able to pass these tests.",
"homepage": "https://git.rootprojects.org/root/greenlock-store-test.js",
"main": "index.js",
"files": ["example.js"],
"dependencies": {},
@ -13,11 +14,11 @@
},
"repository": {
"type": "git",
"url": "https://git.coolaj86.com/coolaj86/le-store-test.js.git"
"url": "https://git.rootprojects.org/root/greenlock-store-test.js.git"
},
"keywords": [
"Let's Encrypt",
"ACME",
"Let's Encrypt",
"Greenlock",
"test",
"certificate",
@ -26,6 +27,6 @@
"credentials",
"secure"
],
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
"license": "MPL-2.0"
}