encrypted ppk support

Author: rathboma

README.md

@@ -94,6 +94,7 @@ Options are an object with following properties:
 * `endPort` (optional): Port number of the server. Needed in case the server runs on a custom port (defaults to `22`)
 * `bastionHost` (optional): You can specify a bastion host if you want
 * `passphrase` (optional): You can specify the passphrase when you have an encrypted private key. If you don't specify the passphrase and you use an encrypted private key, you get prompted in the command line.
+* `noReadline` (optional): Don't prompt for private key passphrases using readline (eg if this is not run in an interactive session)
 
 #### `connection.executeCommand(command: string): Promise<void>`
 

src/Connection.ts

@@ -34,6 +34,7 @@ interface Options {
   endHost: string
   agentSocket?: string,
   skipAutoPrivateKey?: boolean
+  noReadline?: boolean
 }
 
 interface ForwardingOptions {
@@ -176,8 +177,12 @@ class SSHConnection {
       if (stream) {
         options['sock'] = stream
       }
-      if (options.privateKey && options.privateKey.toString().toLowerCase().includes('encrypted')) {
-        options['passphrase'] = (this.options.passphrase) ? this.options.passphrase : await this.getPassphrase()
+      // PPK private keys can be encrypted, but won't contain the word 'encrypted'
+      // in fact they always contain a `encryption` header, so we can't do a simple check
+      options['passphrase'] = this.options.passphrase
+      const looksEncrypted: boolean = this.options.privateKey ? this.options.privateKey.toString().toLowerCase().includes('encrypted') : false
+      if (looksEncrypted && !options['passphrase'] && !this.options.noReadline ) {
+        options['passphrase'] = await this.getPassphrase()
       }
       connection.on('ready', () => {
         this.connections.push(connection)