From 73767290ca0fd123c19a35598c66b657bd72999b Mon Sep 17 00:00:00 2001
From: Bo-Yi Wu <appleboy.tw@gmail.com>
Date: Mon, 30 Dec 2019 19:54:28 +0800
Subject: [PATCH] docs: add passphrase example

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 72ff040..0685fa6 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,7 @@ See [action.yml](./action.yml) for more detailed information.
 * port - remote port, default is `22`
 * username - ssh username
 * password - ssh password
+* passphrase - the passphrase is usually to encrypt the private key
 * timeout - timeout for ssh to remote host, default is `30s`
 * command_timeout - timeout for ssh command, default is `10m`
 * key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
@@ -64,6 +65,7 @@ SSH Proxy Setting:
 * proxy_port - proxy port, default is `22`
 * proxy_username - proxy username
 * proxy_password - proxy password
+* proxy_passphrase - the passphrase is usually to encrypt the private key
 * proxy_timeout - timeout for ssh to proxy host, default is `30s`
 * proxy_key - content of ssh proxy private key.
 * proxy_key_path - path of ssh proxy private key
@@ -219,3 +221,19 @@ How to convert to YAML format of GitHubActions.
         mkdir abc/def
         ls -al
 ```
+
+Protecting a Private Key. The purpose of the passphrase is usually to encrypt the private key. This makes the key file by itself useless to an attacker. It is not uncommon for files to leak from backups or decommissioned hardware, and hackers commonly exfiltrate files from compromised systems.
+
+```diff
+  - name: ssh key passphrase
+    uses: appleboy/ssh-action@master
+    with:
+      host: ${{ secrets.HOST }}
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
++     passphrase: ${{ secrets.PASSPHRASE }}
+      script: |
+        whoami
+        ls -al
+```