Compare commits
8 Commits
3f93292c9a
...
7a0d1c5bff
Author | SHA1 | Date |
---|---|---|
AJ ONeal | 7a0d1c5bff | |
AJ ONeal | 9b895de77c | |
AJ ONeal | de9218e416 | |
AJ ONeal | 5660a5d9dd | |
AJ ONeal | 9adb05898a | |
ceecko | e935e4afa3 | |
AJ ONeal | 75c7b1ff7b | |
AJ ONeal | 1aa724b6f8 |
35
README.md
35
README.md
|
@ -1,5 +1,36 @@
|
||||||
le-store-certbot
|
# Deprecated
|
||||||
================
|
|
||||||
|
`le-store-certbot` has been replaced with [`le-store-fs`](https://git.coolaj86.com/coolaj86/le-store-fs.js).
|
||||||
|
|
||||||
|
The new storage strategy **keeps file system compatibility**, but **drops support** for Python config files.
|
||||||
|
|
||||||
|
Unless you're running `certbot` and Greenlock side-by-side, or interchangeably, you switch to `le-store-fs`.
|
||||||
|
|
||||||
|
## Migrating to `le-store-fs`
|
||||||
|
|
||||||
|
It's **painless** and all of your existing certificates will be **preserved**
|
||||||
|
(assuming you use the same `configDir` as before).
|
||||||
|
|
||||||
|
```js
|
||||||
|
Greenlock.create({
|
||||||
|
|
||||||
|
// Leave configDir as it, if you've been setting it yourself.
|
||||||
|
// Otherwise you should explicitly set it to the previous default:
|
||||||
|
configDir: '~/letsencrypt/etc'
|
||||||
|
|
||||||
|
// le-store-fs takes the same options as le-store-certbot,
|
||||||
|
// but ignores some of the ones that aren't important.
|
||||||
|
, store: require('le-store-fs').create({})
|
||||||
|
|
||||||
|
...
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Alternatives
|
||||||
|
|
||||||
|
* Search npm for ["le-store-"](https://www.npmjs.com/search?q=le-store-) to find many alternatives.
|
||||||
|
|
||||||
|
# le-store-certbot
|
||||||
|
|
||||||
The "certbot" storage strategy for
|
The "certbot" storage strategy for
|
||||||
[Greenlock.js](https://git.coolaj86.com/coolaj86/le-store-certbot.js).
|
[Greenlock.js](https://git.coolaj86.com/coolaj86/le-store-certbot.js).
|
||||||
|
|
46
index.js
46
index.js
|
@ -8,6 +8,9 @@ try {
|
||||||
PromiseA = Promise;
|
PromiseA = Promise;
|
||||||
}
|
}
|
||||||
var util = require('util');
|
var util = require('util');
|
||||||
|
if (!util.promisify) {
|
||||||
|
util.promisify = PromiseA.promisify;
|
||||||
|
}
|
||||||
function promisifyAll(obj) {
|
function promisifyAll(obj) {
|
||||||
var aobj = {};
|
var aobj = {};
|
||||||
Object.keys(obj).forEach(function (key) {
|
Object.keys(obj).forEach(function (key) {
|
||||||
|
@ -15,15 +18,15 @@ function promisifyAll(obj) {
|
||||||
});
|
});
|
||||||
return aobj;
|
return aobj;
|
||||||
}
|
}
|
||||||
var mkdirpAsync = util.promisify(require('mkdirp'));
|
var mkdirpAsync = util.promisify(require('@root/mkdirp'));
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var readFileAsync = util.promisify(fs.readFile);
|
var readFileAsync = util.promisify(fs.readFile);
|
||||||
var readdirAsync = util.promisify(fs.readdir);
|
var readdirAsync = util.promisify(fs.readdir);
|
||||||
|
var writeFileAsync = util.promisify(fs.writeFile);
|
||||||
var statAsync = util.promisify(fs.stat);
|
var statAsync = util.promisify(fs.stat);
|
||||||
var sfs = require('safe-replace');
|
var sfs = require('safe-replace');
|
||||||
var os = require('os');
|
var os = require('os');
|
||||||
var symlink = require('fs-symlink');
|
|
||||||
|
|
||||||
function log(debug) {
|
function log(debug) {
|
||||||
if (debug) {
|
if (debug) {
|
||||||
|
@ -136,6 +139,7 @@ var defaults = {
|
||||||
, fullchainPath: [ ':configDir', 'live', ':hostname', 'fullchain.pem' ].join(path.sep)
|
, fullchainPath: [ ':configDir', 'live', ':hostname', 'fullchain.pem' ].join(path.sep)
|
||||||
, certPath: [ ':configDir', 'live', ':hostname', 'cert.pem' ].join(path.sep)
|
, certPath: [ ':configDir', 'live', ':hostname', 'cert.pem' ].join(path.sep)
|
||||||
, chainPath: [ ':configDir', 'live', ':hostname', 'chain.pem' ].join(path.sep)
|
, chainPath: [ ':configDir', 'live', ':hostname', 'chain.pem' ].join(path.sep)
|
||||||
|
, bundlePath: [ ':configDir', 'live', ':hostname', 'bundle.pem' ].join(path.sep)
|
||||||
|
|
||||||
, rsaKeySize: 2048
|
, rsaKeySize: 2048
|
||||||
};
|
};
|
||||||
|
@ -194,7 +198,7 @@ module.exports.create = function (configs) {
|
||||||
key = keypair.privateKeyPem;
|
key = keypair.privateKeyPem;
|
||||||
}
|
}
|
||||||
|
|
||||||
return sfs.writeFileAsync(keypath, key, 'ascii').then(function () {
|
return writeFileAsync(keypath, key, 'ascii').then(function () {
|
||||||
return keypair;
|
return keypair;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@ -245,8 +249,8 @@ module.exports.create = function (configs) {
|
||||||
};
|
};
|
||||||
}, function (err) {
|
}, function (err) {
|
||||||
if (args.debug) {
|
if (args.debug) {
|
||||||
console.error("[le-store-certbot] certificates.check");
|
log("certificates.check");
|
||||||
console.error(err.stack);
|
log(err.stack);
|
||||||
}
|
}
|
||||||
return null;
|
return null;
|
||||||
});
|
});
|
||||||
|
@ -263,9 +267,8 @@ module.exports.create = function (configs) {
|
||||||
var certPath = args.certPath || pyobj.cert || path.join(liveDir, 'cert.pem');
|
var certPath = args.certPath || pyobj.cert || path.join(liveDir, 'cert.pem');
|
||||||
var fullchainPath = args.fullchainPath || pyobj.fullchain || path.join(liveDir, 'fullchain.pem');
|
var fullchainPath = args.fullchainPath || pyobj.fullchain || path.join(liveDir, 'fullchain.pem');
|
||||||
var chainPath = args.chainPath || pyobj.chain || path.join(liveDir, 'chain.pem');
|
var chainPath = args.chainPath || pyobj.chain || path.join(liveDir, 'chain.pem');
|
||||||
var privkeyPath = args.privkeyPath || pyobj.privkey
|
var privkeyPath = args.privkeyPath || pyobj.privkey || args.domainKeyPath || path.join(liveDir, 'privkey.pem');
|
||||||
|| args.domainKeyPath
|
var bundlePath = args.bundlePath || pyobj.bundle || path.join(liveDir, 'bundle.pem');
|
||||||
|| path.join(liveDir, 'privkey.pem');
|
|
||||||
|
|
||||||
var archiveDir = args.archiveDir || path.join(args.configDir, 'archive', args.domains[0]);
|
var archiveDir = args.archiveDir || path.join(args.configDir, 'archive', args.domains[0]);
|
||||||
|
|
||||||
|
@ -274,22 +277,31 @@ module.exports.create = function (configs) {
|
||||||
var fullchainArchive = path.join(archiveDir, 'fullchain' + checkpoints + '.pem');
|
var fullchainArchive = path.join(archiveDir, 'fullchain' + checkpoints + '.pem');
|
||||||
var chainArchive = path.join(archiveDir, 'chain'+ checkpoints + '.pem');
|
var chainArchive = path.join(archiveDir, 'chain'+ checkpoints + '.pem');
|
||||||
var privkeyArchive = path.join(archiveDir, 'privkey' + checkpoints + '.pem');
|
var privkeyArchive = path.join(archiveDir, 'privkey' + checkpoints + '.pem');
|
||||||
|
var bundleArchive = path.join(archiveDir, 'bundle' + checkpoints + '.pem');
|
||||||
|
|
||||||
return mkdirpAsync(archiveDir).then(function () {
|
return mkdirpAsync(archiveDir).then(function () {
|
||||||
return PromiseA.all([
|
var ps = PromiseA.all([
|
||||||
sfs.writeFileAsync(certArchive, pems.cert, 'ascii')
|
sfs.writeFileAsync(certArchive, pems.cert, 'ascii')
|
||||||
, sfs.writeFileAsync(chainArchive, pems.chain, 'ascii')
|
, sfs.writeFileAsync(chainArchive, pems.chain, 'ascii')
|
||||||
, sfs.writeFileAsync(fullchainArchive, [ pems.cert, pems.chain ].join('\n'), 'ascii')
|
, sfs.writeFileAsync(fullchainArchive, [ pems.cert, pems.chain ].join('\n'), 'ascii')
|
||||||
, sfs.writeFileAsync(privkeyArchive, pems.privkey, 'ascii')
|
, sfs.writeFileAsync(privkeyArchive, pems.privkey, 'ascii')
|
||||||
]);
|
]);
|
||||||
|
if (pems.bundle) {
|
||||||
|
var bundleP = sfs.writeFileAsync(bundleArchive, pems.bundle, 'ascii');
|
||||||
|
ps.push(bundleP);
|
||||||
|
}
|
||||||
|
return ps;
|
||||||
}).then(function () {
|
}).then(function () {
|
||||||
return mkdirpAsync(liveDir);
|
return mkdirpAsync(liveDir);
|
||||||
}).then(function () {
|
}).then(function () {
|
||||||
return PromiseA.all([
|
return PromiseA.all([
|
||||||
symlink(certArchive, certPath)
|
sfs.writeFileAsync(certPath, pems.cert, 'ascii')
|
||||||
, symlink(chainArchive, chainPath)
|
, sfs.writeFileAsync(chainPath, pems.chain, 'ascii')
|
||||||
, symlink(fullchainArchive, fullchainPath)
|
// Most platforms need these two
|
||||||
, symlink(privkeyArchive, privkeyPath)
|
, sfs.writeFileAsync(fullchainPath, [ pems.cert, pems.chain ].join('\n'), 'ascii')
|
||||||
|
, sfs.writeFileAsync(privkeyPath, pems.privkey, 'ascii')
|
||||||
|
// HAProxy needs "bundle.pem" aka "combined.pem"
|
||||||
|
, sfs.writeFileAsync(bundlePath, [ pems.privkey, pems.cert, pems.chain ].join('\n'), 'ascii')
|
||||||
]);
|
]);
|
||||||
}).then(function () {
|
}).then(function () {
|
||||||
pyobj.checkpoints += 1;
|
pyobj.checkpoints += 1;
|
||||||
|
@ -303,6 +315,8 @@ module.exports.create = function (configs) {
|
||||||
privkey: pems.privkey
|
privkey: pems.privkey
|
||||||
, cert: pems.cert
|
, cert: pems.cert
|
||||||
, chain: pems.chain
|
, chain: pems.chain
|
||||||
|
, expires: pems.expires
|
||||||
|
, identifiers: pems.identifiers
|
||||||
|
|
||||||
/*
|
/*
|
||||||
// TODO populate these only if they are actually known
|
// TODO populate these only if they are actually known
|
||||||
|
@ -517,9 +531,9 @@ module.exports.create = function (configs) {
|
||||||
// TODO abstract file writing
|
// TODO abstract file writing
|
||||||
return PromiseA.all([
|
return PromiseA.all([
|
||||||
// meta.json {"creation_host": "ns1.redirect-www.org", "creation_dt": "2015-12-11T04:14:38Z"}
|
// meta.json {"creation_host": "ns1.redirect-www.org", "creation_dt": "2015-12-11T04:14:38Z"}
|
||||||
sfs.writeFileAsync(path.join(accountDir, 'meta.json'), JSON.stringify(accountMeta), 'utf8')
|
writeFileAsync(path.join(accountDir, 'meta.json'), JSON.stringify(accountMeta), 'utf8')
|
||||||
// private_key.json { "e", "d", "n", "q", "p", "kty", "qi", "dp", "dq" }
|
// private_key.json { "e", "d", "n", "q", "p", "kty", "qi", "dp", "dq" }
|
||||||
, sfs.writeFileAsync(path.join(accountDir, 'private_key.json'), JSON.stringify(reg.keypair.privateKeyJwk), 'utf8')
|
, writeFileAsync(path.join(accountDir, 'private_key.json'), JSON.stringify(reg.keypair.privateKeyJwk), 'utf8')
|
||||||
// regr.json:
|
// regr.json:
|
||||||
/*
|
/*
|
||||||
{ body: { contact: [ 'mailto:coolaj86@gmail.com' ],
|
{ body: { contact: [ 'mailto:coolaj86@gmail.com' ],
|
||||||
|
@ -529,7 +543,7 @@ module.exports.create = function (configs) {
|
||||||
new_authzr_uri: 'https://acme-v01.api.letsencrypt.org/acme/new-authz',
|
new_authzr_uri: 'https://acme-v01.api.letsencrypt.org/acme/new-authz',
|
||||||
terms_of_service: 'https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf' }
|
terms_of_service: 'https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf' }
|
||||||
*/
|
*/
|
||||||
, sfs.writeFileAsync(path.join(accountDir, 'regr.json'),
|
, writeFileAsync(path.join(accountDir, 'regr.json'),
|
||||||
JSON.stringify(regrBody),
|
JSON.stringify(regrBody),
|
||||||
'utf8')
|
'utf8')
|
||||||
]);
|
]);
|
||||||
|
|
|
@ -0,0 +1,26 @@
|
||||||
|
{
|
||||||
|
"name": "le-store-certbot",
|
||||||
|
"version": "2.2.2",
|
||||||
|
"lockfileVersion": 1,
|
||||||
|
"requires": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@root/mkdirp": {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/@root/mkdirp/-/mkdirp-1.0.0.tgz",
|
||||||
|
"integrity": "sha512-hxGAYUx5029VggfG+U9naAhQkoMSXtOeXtbql97m3Hi6/sQSRL/4khKZPyOF6w11glyCOU38WCNLu9nUcSjOfA=="
|
||||||
|
},
|
||||||
|
"pyconf": {
|
||||||
|
"version": "1.1.7",
|
||||||
|
"resolved": "https://registry.npmjs.org/pyconf/-/pyconf-1.1.7.tgz",
|
||||||
|
"integrity": "sha512-v4clh33m68sjtMsh8XMpjhGWb/MQODAYZ1y7ORG5Qv58UK25OddoB+oXyexgDkK8ttFui/lZm2sQDgA2Ftjfkw==",
|
||||||
|
"requires": {
|
||||||
|
"safe-replace": "^1.0.2"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"safe-replace": {
|
||||||
|
"version": "1.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/safe-replace/-/safe-replace-1.1.0.tgz",
|
||||||
|
"integrity": "sha512-9/V2E0CDsKs9DWOOwJH7jYpSl9S3N05uyevNjvsnDauBqRowBPOyot1fIvV5N2IuZAbYyvrTXrYFVG0RZInfFw=="
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
10
package.json
10
package.json
|
@ -1,9 +1,10 @@
|
||||||
{
|
{
|
||||||
"name": "le-store-certbot",
|
"name": "le-store-certbot",
|
||||||
"version": "2.1.7",
|
"version": "2.2.3",
|
||||||
"description": "The \"certbot\" storage strategy for Greenlock.js",
|
"description": "The \"certbot\" storage strategy for Greenlock.js",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
"bump": "npm version -m \"chore(release): bump to v%s\"",
|
||||||
"test": "echo \"Error: no test specified\" && exit 1"
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
|
@ -27,9 +28,8 @@
|
||||||
"bluebird": "^3.5.1"
|
"bluebird": "^3.5.1"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fs-symlink": "^1.2.1",
|
"@root/mkdirp": "^1.0.0",
|
||||||
"mkdirp": "^0.5.1",
|
"pyconf": "^1.1.7",
|
||||||
"pyconf": "^1.1.2",
|
"safe-replace": "^1.1.0"
|
||||||
"safe-replace": "^1.0.2"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue