Defaults to ssh-agent instead of privateKeyPath

Author: typeoneerror

README.md

@@ -62,19 +62,19 @@ For detailed information on how configuration of plugins works, please refer to
 
 ### username (`required`)
 
-The user for the ssh connection
+The user for the ssh connection.
 
 *Default:* `undefined`
 
 ### host (`required`)
 
-The server to connect to
+The server to connect to.
 
 *Default:* `undefined`
 
 ### dstPort
 
-The port to forward from the server
+The port to forward from the server.
 
 *Default:* `6379`
 
@@ -86,31 +86,63 @@ The host to forward to on the destination server.
 
 ### srcPort
 
-The local port for the forwarding
+The local port for the forwarding.
 
 *Default:* a random port between `49151` and `65535`
 
 ### privateKeyPath
 
-The local path to your ssh private key
+The local path to your ssh private key.
 
-*Default:* `~/.ssh/id_rsa`
+*Default:* null
+
+### password
+
+Authorization string for the ssh connection.
+
+*Default:* null
 
 ### tunnelClient
 
 The client used to create the ssh tunnel. This allows the user the ability to use their own client for uploading instead of the one provided by this plugin.
 
 *Default:* the tunnel provided by `tunnel-ssh`
 
-## Running Tests
+## Authorization
 
-- `npm test`
+ember-cli-deploy-ssh-tunnel uses the [tunnel-ssh](https://github.com/Finanzchef24-GmbH/tunnel-ssh) module to provide the SSH tunnel. Two options exist to configure tunnel-ssh from ember-cli-deploy-ssh-tunnel: `privateKeyPath` and `password`. By default, we assume you have created a public and private key and added it to ssh-agent as described in the [default GitHub setup](https://help.github.com/articles/generating-ssh-keys/). 
 
-[1]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
+If no authentication information is delivered to tunnel-ssh, it will [default to using ssh-agent](https://github.com/Finanzchef24-GmbH/tunnel-ssh), so it will default to using the default id_rsa keys generated as described in the GitHub article. This includes password-protected SSH keys. If you would like to use a different SSH key, set the `privateKeyPath` option:
+
+```js
+ENV['ssh-tunnel'] = {
+  username: 'yourname',
+  host: 'yourserver',
+  privateKeyPath: '~/.ssh/another_key_rsa'
+};
+```
 
+If you just want to use a password to tunnel, you can specify that as an option (we recommend using environmental variables in an .env file):
+
+```js
+ENV['ssh-tunnel'] = {
+  username: 'yourname',
+  host: 'yourserver',
+  password: process.env.SSH_PASSWORD
+};
+```
+
+NOTE: at this time, this plugin does not support setting a path to `privateKeyPath` to a key that has been encrypted with a password.
+
+## Running Tests
+
+1. `npm install`
+2. `npm test`
 
 ## Thanks to:
 
 @lukemelia and @achambers and the other folks from the ember-cli-deploy project.
 
 @tim-evans for the original implementation in [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis)
+
+[1]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"

index.js

@@ -1,10 +1,10 @@
 /* jshint node: true */
 'use strict';
 
-var Promise    = require('ember-cli/lib/ext/promise');
-var fs         = require('fs');
+var Promise   = require('ember-cli/lib/ext/promise');
+var fs        = require('fs');
 var tunnelSsh = require('tunnel-ssh');
-var untildify  = require('untildify');
+var untildify = require('untildify');
 
 var DeployPluginBase = require('ember-cli-deploy-plugin');
 
@@ -24,7 +24,6 @@ module.exports = {
             var range = MAX_PORT_NUMBER - MIN_PORT_NUMBER + 1;
             return Math.floor(Math.random() * range) + MIN_PORT_NUMBER;
           },
-          privateKeyPath: '~/.ssh/id_rsa',
           tunnelClient: function(context) {
             // if you want to provide your own ssh client to be used instead of one from this plugin
             return context.tunnelClient || tunnelSsh;
@@ -45,18 +44,21 @@ module.exports = {
           dstPort: this.readConfig('dstPort'),
           dstHost: this.readConfig('dstHost'),
           username: this.readConfig('username'),
-          localPort: srcPort,
-          privateKey: this.readConfig('privateKeyPath')
+          localPort: srcPort
         };
 
-        if (sshConfig.privateKey) {
-          sshConfig.privateKey = fs.readFileSync(untildify(sshConfig.privateKey));
-        }
-
+        var password = this.readConfig('password');
+        var privateKey = this.readConfig('privateKeyPath');
         var tunnel = this.readConfig('tunnelClient');
 
-        return new Promise(function (resolve, reject) {
-          var sshTunnel = tunnel(sshConfig, function (error /*, result */) {
+        if (password) {
+          sshConfig.password = password;
+        } else if (privateKey) {
+          sshConfig.privateKey = fs.readFileSync(untildify(privateKey));
+        }
+
+        return new Promise(function(resolve, reject) {
+          var sshTunnel = tunnel(sshConfig, function(error /*, result */) {
             if (error) {
               reject(error);
             } else {

tests/unit/index-nodetest.js

@@ -2,8 +2,8 @@
 
 var Promise = require('ember-cli/lib/ext/promise');
 var assert  = require('ember-cli/tests/helpers/assert');
-var fs  = require('fs');
-var path  = require('path');
+var fs      = require('fs');
+var path    = require('path');
 
 describe('ssh-tunnel plugin', function() {
   var subject, mockUi;
@@ -15,7 +15,8 @@ describe('ssh-tunnel plugin', function() {
       write: function() { },
       writeLine: function(message) {
         this.messages.push(message);
-      }
+      },
+      verbose: true
     };
   });
 
@@ -60,7 +61,7 @@ describe('ssh-tunnel plugin', function() {
       assert.ok(true); // it didn't throw
     });
 
-    describe('without providing config', function () {
+    describe('without providing config', function() {
       var plugin, context, config;
 
       beforeEach(function() {
@@ -70,7 +71,7 @@ describe('ssh-tunnel plugin', function() {
       });
 
       it('raises about missing required config', function() {
-        config = { };
+        config = {};
         context = {
           ui: mockUi,
           config: config
@@ -81,9 +82,8 @@ describe('ssh-tunnel plugin', function() {
         });
         var messages = mockUi.messages.reduce(function(previous, current) {
           if (/- Missing required config:\s.*/.test(current)) {
-previous.push(current);
+            previous.push(current);
           }
-
           return previous;
         }, []);
         assert.equal(messages.length, 1);
@@ -108,26 +108,73 @@ previous.push(current);
 
           return previous;
         }, []);
-        assert.equal(messages.length, 5);
+        assert.equal(messages.length, 4);
       });
 
       it('adds default config to the config object', function() {
+        config = {
+          'ssh-tunnel': {
+            host: 'example.com',
+            username: 'ghedamat'
+          }
+        }
         context = {
           ui: mockUi,
-          config: {
-            'ssh-tunnel': {
-              host: 'example.com',
-              username: 'ghedamat'
-            }
-          }
+          config: config
         };
         plugin.beforeHook(context);
         plugin.configure(context);
         assert.isDefined(config['ssh-tunnel'].dstPort);
         assert.isDefined(config['ssh-tunnel'].dstHost);
         assert.isDefined(config['ssh-tunnel'].srcPort);
         assert.isDefined(config['ssh-tunnel'].tunnelClient);
+      });
+    });
+
+    describe('with custom authentication provided', function () {
+      var plugin, context, config;
+
+      beforeEach(function() {
+        plugin = subject.createDeployPlugin({
+          name: 'ssh-tunnel'
+        });
+      });
+
+      it('uses a password', function() {
+        config = {
+          'ssh-tunnel': {
+            host: 'example.com',
+            username: 'example',
+            password: 'secret'
+          }
+        }
+        context = {
+          ui: mockUi,
+          config: config
+        }
+        plugin.beforeHook(context);
+        plugin.configure(context);
+        assert.isDefined(config['ssh-tunnel'].password);
+        assert.isUndefined(config['ssh-tunnel'].privateKeyPath);
+      });
+
+      it('uses a key path', function() {
+        config = {
+          'ssh-tunnel': {
+            host: 'example.com',
+            username: 'example',
+            privateKeyPath: '~/.ssh/id_rsa'
+          }
+        }
+        context = {
+          ui: mockUi,
+          config: config
+        }
+        plugin.beforeHook(context);
+        plugin.configure(context);
+        assert.isUndefined(config['ssh-tunnel'].password);
         assert.isDefined(config['ssh-tunnel'].privateKeyPath);
+        assert.equal(config['ssh-tunnel'].privateKeyPath, '~/.ssh/id_rsa');
       });
     });
   });