private key passphrase prompts

mkloubert · Jul 2, 2018 · 6595068 · 6595068
1 parent 3a265c5
commit 6595068
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,11 @@
 
 [![Share via Facebook](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Facebook.png)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&quote=vscode-deploy-reloaded) [![Share via Twitter](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Twitter.png)](https://twitter.com/intent/tweet?source=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&text=vscode-deploy-reloaded:%20https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&via=mjkloubert) [![Share via Google+](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Google+.png)](https://plus.google.com/share?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded) [![Share via Pinterest](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Pinterest.png)](https://pinterest.com/pin/create/button/?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&media=https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/demo1.gif&description=Recoded%20version%20of%20Visual%20Studio%20Code%20extension%20%27vs-deploy%27%2C%20which%20provides%20commands%20to%20deploy%20files%20to%20one%20or%20more%20destinations.) [![Share via Reddit](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Reddit.png)](https://www.reddit.com/submit?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&title=vscode-deploy-reloaded) [![Share via LinkedIn](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/LinkedIn.png)](https://www.linkedin.com/shareArticle?mini=true&url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&title=vscode-deploy-reloaded&summary=Recoded%20version%20of%20Visual%20Studio%20Code%20extension%20%27vs-deploy%27%2C%20which%20provides%20commands%20to%20deploy%20files%20to%20one%20or%20more%20destinations.&source=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded) [![Share via Wordpress](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Wordpress.png)](https://wordpress.com/press-this.php?u=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded&quote=vscode-deploy-reloaded&s=Recoded%20version%20of%20Visual%20Studio%20Code%20extension%20%27vs-deploy%27%2C%20which%20provides%20commands%20to%20deploy%20files%20to%20one%20or%20more%20destinations.&i=https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/demo1.gif) [![Share via Email](https://raw.githubusercontent.com/mkloubert/vscode-deploy-reloaded/master/img/share/Email.png)](mailto:?subject=vscode-deploy-reloaded&body=Recoded%20version%20of%20Visual%20Studio%20Code%20extension%20'vs-deploy'%2C%20which%20provides%20commands%20to%20deploy%20files%20to%20one%20or%20more%20destinations.:%20https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-deploy-reloaded)
 
-## 0.80.1 (June 2nd, 2018; bugfix pull files from SFTP)
+## 0.81.0 (July 3rd, 2018; private key passphrase prompts)
+
+* added `alwaysAskForPrivateKeyPassphrase` and `askForPrivateKeyPassphrase` settings for [SFTP](https://github.com/mkloubert/vscode-deploy-reloaded/wiki/target_sftp) targets ... s. [issue #71](https://github.com/mkloubert/vscode-deploy-reloaded/issues/71)
+
+## 0.80.1 (July 2nd, 2018; bugfix pull files from SFTP)
 
 * fixed bug, which throws exception, when pulling files from [SFTP server](https://github.com/mkloubert/vscode-deploy-reloaded/wiki/target_sftp) ... s. [issue #81](https://github.com/mkloubert/vscode-deploy-reloaded/issues/81)
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
  "name": "vscode-deploy-reloaded",
  "displayName": "Deploy (Reloaded)",
  "description": "Deploys files of a workspace to a destination.",
- "version": "0.80.1",
+ "version": "0.81.0",
  "publisher": "mkloubert",
  "engines": {
   "vscode": "^1.24.0"
@@ -53138,6 +53138,11 @@
             "description": "Always ask for password and do not cache, if no password is defined.",
             "default": false
            },
+           "alwaysAskForPrivateKeyPassphrase": {
+            "type": "boolean",
+            "description": "Always ask for private key passphrase and do not cache.",
+            "default": false
+           },
            "alwaysAskForUser": {
             "type": "boolean",
             "description": "Always ask for username and do not cache, if no user is defined.",
@@ -53157,6 +53162,11 @@
              }
             }
            },
+           "askForPrivateKeyPassphrase": {
+            "type": "boolean",
+            "description": "Ask for private key passphrase.",
+            "default": false
+           },
            "beforeDelete": {
             "description": "One or more operations that should be invoked BEFORE a delete operation starts.",
             "type": "array",

diff --git a/src/i18.ts b/src/i18.ts
@@ -64,6 +64,7 @@ export interface Translation {
     };
     'continue'?: string;
     credentials?: {
+        enterPassphrase?: string;
         enterPassword?: string;
         enterUsername?: string;
     };

diff --git a/src/lang/de.ts b/src/lang/de.ts
@@ -59,6 +59,7 @@ export const translation: Translation = {
     },
     'continue': "Fortfahren",
     credentials: {
+        enterPassphrase: "Geben Sie die Passphrase an ...",
         enterPassword: "Geben Sie das Passwort an ...",
         enterUsername: "Geben Sie den Benutzernamen an ...",
     },

diff --git a/src/lang/en.ts b/src/lang/en.ts
@@ -59,6 +59,7 @@ export const translation: Translation = {
     },
     'continue': "Continue",
     credentials: {
+        enterPassphrase: "Enter the passphrase ...",
         enterPassword: "Enter the password ...",
         enterUsername: "Enter the name of the user ...",
     },

diff --git a/src/plugins/sftp.ts b/src/plugins/sftp.ts
@@ -99,10 +99,18 @@ export interface SFTPTarget extends deploy_targets.Target {
      * Always ask for password and do not cache, if no password is defined.
      */
     readonly alwaysAskForPassword?: boolean;
+    /**
+     * Always ask for private key passphrase and do not cache.
+     */
+    readonly alwaysAskForPrivateKeyPassphrase?: boolean;
     /**
      * Always ask for uasername and do not cache, if no user is defined.
      */
     readonly alwaysAskForUser?: boolean;
+    /**
+     * Ask for private key passphrase.
+     */
+    readonly askForPrivateKeyPassphrase?: boolean;
     /**
      * The path to an (event) script, which is executed BEFORE a file is going to be uploaded.
      */
@@ -226,6 +234,7 @@ export interface SFTPUploadedModuleExecutorArguments extends SFTPUploadScriptArg
 
 
 const CACHE_PASSWORD = 'password';
+const CACHE_PRIV_KEY_PASSPHRASE = 'privateKeyPassphrase';
 const CACHE_USER = 'user';
 
 class SFTPPlugin extends deploy_plugins.AsyncFileClientPluginBase<SFTPTarget,
@@ -268,6 +277,7 @@ class SFTPPlugin extends deploy_plugins.AsyncFileClientPluginBase<SFTPTarget,
         const DIR = this.replaceWithValues(target, target.dir);
 
         let cachePassword = false;
+        let cachePrivKeyPassphrase = false;
         let cacheUsername = false;
 
         const ALWAYS_ASK_FOR_USER = deploy_helpers.toBooleanSafe( target.alwaysAskForUser );
@@ -321,6 +331,32 @@ class SFTPPlugin extends deploy_plugins.AsyncFileClientPluginBase<SFTPTarget,
             cachePassword = !ALWAYS_ASK_FOR_PASSWORD;
         }
 
+        const ALWAYS_ASK_FOR_PRIV_KEY_PASSPHRASE = deploy_helpers.toBooleanSafe( target.alwaysAskForPrivateKeyPassphrase );
+        let privateKeyPassphrase = target.privateKeyPassphrase;
+        if (IS_PRIVATE_KEY_DEFINED && _.isNil(privateKeyPassphrase)) {
+            let askForPrivKeyPassphrase = ALWAYS_ASK_FOR_PRIV_KEY_PASSPHRASE;
+            if (!askForPrivKeyPassphrase) {
+                askForPrivKeyPassphrase = !CACHE.has( CACHE_PRIV_KEY_PASSPHRASE );
+            }
+
+            if (askForPrivKeyPassphrase) {
+                privateKeyPassphrase = await vscode.window.showInputBox({
+                    ignoreFocusOut: true,
+                    password: true,
+                    prompt: this.t(target, 'credentials.enterPassphrase'),
+                });
+
+                if (_.isNil(privateKeyPassphrase)) {
+                    return;
+                }
+            }
+            else {
+                privateKeyPassphrase = CACHE.get( CACHE_PRIV_KEY_PASSPHRASE );
+            }
+
+            cachePrivKeyPassphrase = !ALWAYS_ASK_FOR_PRIV_KEY_PASSPHRASE;
+        }
+
         let beforeUpload: deploy_clients_sftp.SFTPBeforeUpload;
         let uploadCompleted: deploy_clients_sftp.SFTPUploadCompleted;
         {
@@ -541,7 +577,7 @@ class SFTPPlugin extends deploy_plugins.AsyncFileClientPluginBase<SFTPTarget,
                         ).trim()
                     ),
                     privateKey: privateKeyFile,
-                    privateKeyPassphrase: target.privateKeyPassphrase,
+                    privateKeyPassphrase: privateKeyPassphrase,
                     readyTimeout: parseInt(
                         deploy_helpers.toStringSafe(
                             this.replaceWithValues(target, target.readyTimeout)
@@ -575,12 +611,20 @@ class SFTPPlugin extends deploy_plugins.AsyncFileClientPluginBase<SFTPTarget,
             else {
                 CACHE.unset(CACHE_PASSWORD);
             }
+
+            if (cachePrivKeyPassphrase) {
+                CACHE.set(CACHE_PRIV_KEY_PASSPHRASE, privateKeyPassphrase);
+            }
+            else {
+                CACHE.unset(CACHE_PRIV_KEY_PASSPHRASE);
+            }
 
             return CTX;
         }
         catch (e) {
             CACHE.unset(CACHE_USER)
-                 .unset(CACHE_PASSWORD);
+                 .unset(CACHE_PASSWORD)
+                 .unset(CACHE_PRIV_KEY_PASSPHRASE);
 
             throw e;
         }