chore(release): bump to v2.2.4

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
 [Greenlock.js](https://git.coolaj86.com/coolaj86/le-store-certbot.js).

index.js

@@ -1,12 +1,32 @@
 'use strict';
+/* global Promise */
 
-var PromiseA = require('bluebird');
+var PromiseA;
-var mkdirpAsync = PromiseA.promisify(require('mkdirp'));
+try {
+  PromiseA = require('bluebird');
+} catch(e) {
+  PromiseA = Promise;
+}
+var util = require('util');
+if (!util.promisify) {
+  util.promisify = PromiseA.promisify;
+}
+function promisifyAll(obj) {
+  var aobj = {};
+  Object.keys(obj).forEach(function (key) {
+    aobj[key + 'Async'] = util.promisify(obj[key]);
+  });
+  return aobj;
+}
+var mkdirpAsync = util.promisify(require('@root/mkdirp'));
 var path = require('path');
-var fs = PromiseA.promisifyAll(require('fs'));
+var fs = require('fs');
+var readFileAsync = util.promisify(fs.readFile);
+var readdirAsync = util.promisify(fs.readdir);
+var writeFileAsync = util.promisify(fs.writeFile);
+var statAsync = util.promisify(fs.stat);
 var sfs = require('safe-replace');
 var os = require('os');
-var symlink = require('fs-symlink');
 
 function log(debug) {
   if (debug) {
@@ -21,7 +41,7 @@ function writeRenewalConfig(args) {
   var pyobj = args.pyobj;
   pyobj.checkpoints = parseInt(pyobj.checkpoints, 10) || 0;
 
-  var pyconf = PromiseA.promisifyAll(require('pyconf'));
+  var pyconf = promisifyAll(require('pyconf'));
 
   var liveDir = args.liveDir || path.join(args.configDir, 'live', args.domains[0]);
 
@@ -101,10 +121,12 @@ function pyToJson(pyobj) {
   return jsobj;
 }
 
+var crypto = require('crypto');
+var rnd = crypto.randomBytes(8).toString('hex');
 var defaults = {
   configDir: [ os.homedir(), 'letsencrypt', 'etc' ].join(path.sep)            // /etc/letsencrypt/
-, logsDir: [ os.homedir(), 'tmp', 'acme', 'log' ].join(path.sep)              // /var/log/letsencrypt/
+, logsDir: [ os.tmpdir(), 'acme-' + rnd, 'log' ].join(path.sep)              // /var/log/letsencrypt/
-, webrootPath: [ os.homedir(), 'tmp', 'acme-challenge' ].join(path.sep)
+, webrootPath: [ os.tmpdir(), 'acme-' + rnd, 'acme-challenge' ].join(path.sep)
 
 , accountsDir: [ ':configDir', 'accounts', ':serverDir' ].join(path.sep)
 , renewalPath: [ ':configDir', 'renewal', ':hostname.conf' ].join(path.sep)
@@ -117,6 +139,7 @@ var defaults = {
 , fullchainPath: [ ':configDir', 'live', ':hostname', 'fullchain.pem' ].join(path.sep)
 , certPath: [ ':configDir', 'live', ':hostname', 'cert.pem' ].join(path.sep)
 , chainPath: [ ':configDir', 'live', ':hostname', 'chain.pem' ].join(path.sep)
+, bundlePath: [ ':configDir', 'live', ':hostname', 'bundle.pem' ].join(path.sep)
 
 , rsaKeySize: 2048
 };
@@ -149,7 +172,7 @@ module.exports.create = function (configs) {
         if (!keypath) {
           return null;
         }
-        return fs.readFileAsync(keypath, 'ascii').then(function (key) {
+        return readFileAsync(keypath, 'ascii').then(function (key) {
           if ('jwk' === format) {
             return { privateKeyJwk: JSON.parse(key) };
           }
@@ -175,7 +198,7 @@ module.exports.create = function (configs) {
             key = keypair.privateKeyPem;
           }
 
-          return fs.writeFileAsync(keypath, key, 'ascii').then(function () {
+          return writeFileAsync(keypath, key, 'ascii').then(function () {
             return keypair;
           });
         });
@@ -204,15 +227,15 @@ module.exports.create = function (configs) {
           return PromiseA.reject(new Error("missing one or more of privkeyPath, fullchainPath, certPath, chainPath from options"));
         }
 
-        //, fs.readFileAsync(fullchainPath, 'ascii')
+        //, readFileAsync(fullchainPath, 'ascii')
         // note: if this ^^ gets added back in, the arrays below must change
         return PromiseA.all([
-          fs.readFileAsync(args.privkeyPath, 'ascii')   // 0
+          readFileAsync(args.privkeyPath, 'ascii')   // 0
-        , fs.readFileAsync(args.certPath, 'ascii')      // 1
+        , readFileAsync(args.certPath, 'ascii')      // 1
-        , fs.readFileAsync(args.chainPath, 'ascii')     // 2
+        , readFileAsync(args.chainPath, 'ascii')     // 2
 
           // stat the file, not the link
-        , fs.statAsync(args.certPath)                   // 3
+        , statAsync(args.certPath)                   // 3
         ]).then(function (arr) {
           return {
             privkey: arr[0]                       // privkey.pem
@@ -226,8 +249,8 @@ module.exports.create = function (configs) {
           };
         }, function (err) {
           if (args.debug) {
-            console.error("[le-store-certbot] certificates.check");
+            log("certificates.check");
-            console.error(err.stack);
+            log(err.stack);
           }
           return null;
         });
@@ -244,9 +267,8 @@ module.exports.create = function (configs) {
           var certPath = args.certPath || pyobj.cert || path.join(liveDir, 'cert.pem');
           var fullchainPath = args.fullchainPath || pyobj.fullchain || path.join(liveDir, 'fullchain.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]);
 
@@ -255,22 +277,31 @@ module.exports.create = function (configs) {
           var fullchainArchive = path.join(archiveDir, 'fullchain' + checkpoints + '.pem');
           var chainArchive = path.join(archiveDir, 'chain'+ checkpoints + '.pem');
           var privkeyArchive = path.join(archiveDir, 'privkey' + checkpoints + '.pem');
+          var bundleArchive = path.join(archiveDir, 'bundle' + checkpoints + '.pem');
 
           return mkdirpAsync(archiveDir).then(function () {
-            return PromiseA.all([
+            var ps = [
               sfs.writeFileAsync(certArchive, pems.cert, 'ascii')
             , sfs.writeFileAsync(chainArchive, pems.chain, 'ascii')
-            , sfs.writeFileAsync(fullchainArchive, pems.cert + pems.chain, 'ascii')
+            , sfs.writeFileAsync(fullchainArchive, [ pems.cert, pems.chain ].join('\n'), 'ascii')
             , sfs.writeFileAsync(privkeyArchive, pems.privkey, 'ascii')
-            ]);
+            ];
+            if (pems.bundle) {
+              var bundleP = sfs.writeFileAsync(bundleArchive, pems.bundle, 'ascii');
+              ps.push(bundleP);
+            }
+            return PromiseA.all(ps);
           }).then(function () {
             return mkdirpAsync(liveDir);
           }).then(function () {
             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 () {
             pyobj.checkpoints += 1;
@@ -284,6 +315,8 @@ module.exports.create = function (configs) {
               privkey: pems.privkey
             , cert: pems.cert
             , chain: pems.chain
+            , expires: pems.expires
+            , identifiers: pems.identifiers
 
               /*
               // TODO populate these only if they are actually known
@@ -328,11 +361,11 @@ module.exports.create = function (configs) {
           log(args.debug, "No email given");
           return PromiseA.resolve(null);
         }
-        return fs.readdirAsync(args.accountsDir).then(function (nodes) {
+        return readdirAsync(args.accountsDir).then(function (nodes) {
           log(args.debug, "success reading arg.accountsDir");
 
           return PromiseA.all(nodes.map(function (node) {
-            return fs.readFileAsync(path.join(args.accountsDir, node, 'regr.json'), 'utf8').then(function (text) {
+            return readFileAsync(path.join(args.accountsDir, node, 'regr.json'), 'utf8').then(function (text) {
               var regr = JSON.parse(text);
               regr.__accountId = node;
 
@@ -373,8 +406,8 @@ module.exports.create = function (configs) {
       // Accounts
     , _getAccountIdByPublicKey: function (keypair) {
         // we use insecure md5 - even though we know it's bad - because that's how the python client did
-        const pubkey = keypair.publicKeyPem.replace(/\r/g, '');
+        var pubkey = keypair.publicKeyPem.replace(/\r/g, '');
-        return require('crypto').createHash('md5').update(pubkey).digest('hex');
+        return crypto.createHash('md5').update(pubkey).digest('hex');
       }
       // Accounts
     , checkKeypairAsync: function (args) {
@@ -430,7 +463,7 @@ module.exports.create = function (configs) {
           return PromiseA.all(configs.map(function (filename) {
             var keyname = filename.slice(0, -5);
 
-            return fs.readFileAsync(path.join(accountDir, filename), 'utf8').then(function (text) {
+            return readFileAsync(path.join(accountDir, filename), 'utf8').then(function (text) {
               var data;
 
               try {
@@ -498,9 +531,9 @@ module.exports.create = function (configs) {
           // TODO abstract file writing
           return PromiseA.all([
             // meta.json {"creation_host": "ns1.redirect-www.org", "creation_dt": "2015-12-11T04:14:38Z"}
-            fs.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" }
-          , fs.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:
             /*
             { body: { contact: [ 'mailto:coolaj86@gmail.com' ],
@@ -510,7 +543,7 @@ module.exports.create = function (configs) {
               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' }
              */
-          , fs.writeFileAsync(path.join(accountDir, 'regr.json'),
+          , writeFileAsync(path.join(accountDir, 'regr.json'),
                               JSON.stringify(regrBody),
                               'utf8')
           ]);
@@ -526,7 +559,7 @@ module.exports.create = function (configs) {
       }
       // Accounts
     , getAccountIdAsync: function (args) {
-        var pyconf = PromiseA.promisifyAll(require('pyconf'));
+        var pyconf = promisifyAll(require('pyconf'));
 
         return pyconf.readFileAsync(args.renewalPath).then(function (renewal) {
           var accountId = renewal.account;
@@ -562,7 +595,7 @@ module.exports.create = function (configs) {
       }
       // Configs
     , _checkHelperAsync: function (args) {
-        var pyconf = PromiseA.promisifyAll(require('pyconf'));
+        var pyconf = promisifyAll(require('pyconf'));
 
         return pyconf.readFileAsync(args.renewalPath).then(function (pyobj) {
           return pyobj;
@@ -616,7 +649,7 @@ module.exports.create = function (configs) {
     , allAsync: function (copy) {
         copy.domains = [];
 
-        return fs.readdirAsync(copy.renewalDir).then(function (nodes) {
+        return readdirAsync(copy.renewalDir).then(function (nodes) {
           nodes = nodes.filter(function (node) {
             return /^[a-z0-9]+.*\.conf$/.test(node);
           });

package-lock.json

@@ -0,0 +1,26 @@
+{
+  "name": "le-store-certbot",
+  "version": "2.2.4",
+  "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=="
+    }
+  }
+}

package.json

@@ -1,9 +1,10 @@
 {
   "name": "le-store-certbot",
-  "version": "2.1.2",
+  "version": "2.2.4",
   "description": "The \"certbot\" storage strategy for Greenlock.js",
   "main": "index.js",
   "scripts": {
+    "bump": "npm version -m \"chore(release): bump to v%s\"",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -23,11 +24,12 @@
     "url": "https://git.coolaj86.com/coolaj86/le-store-certbot.js/issues"
   },
   "homepage": "https://git.coolaj86.com/coolaj86/le-store-certbot.js",
+  "trulyOptionalDependencies": {
+    "bluebird": "^3.5.1"
+  },
   "dependencies": {
-    "bluebird": "^3.5.1",
+    "@root/mkdirp": "^1.0.0",
-    "fs-symlink": "^1.2.1",
+    "pyconf": "^1.1.7",
-    "mkdirp": "^0.5.1",
+    "safe-replace": "^1.1.0"
-    "pyconf": "^1.1.2",
-    "safe-replace": "^1.0.2"
   }
 }