chore: bump drone-ssh to v1.6.1 (#63)

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

.github/workflows/ci.yml

@@ -6,8 +6,11 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
+    - name: checkout
+      uses: actions/checkout@v1
+
     - name: executing remote ssh commands using password
-      uses: appleboy/ssh-action@master
+      uses: ./
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -16,7 +19,7 @@ jobs:
         script: whoami
 
     - name: executing remote ssh commands using ssh key
-      uses: appleboy/ssh-action@master
+      uses: ./
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -25,7 +28,7 @@ jobs:
         script: whoami
 
     - name: multiple command
-      uses: appleboy/ssh-action@master
+      uses: ./
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -36,17 +39,19 @@ jobs:
           ls -al
 
     # - name: stop script if command error
-    #   uses: appleboy/ssh-action@master
+    #   uses: ./
     #   with:
     #     host: ${{ secrets.HOST }}
     #     username: ${{ secrets.USERNAME }}
     #     key: ${{ secrets.KEY }}
     #     port: ${{ secrets.PORT }}
     #     script_stop: true
-    #     script: "mkdir abc/def,ls -al"
+    #     script: |
+    #       mkdir abc/def
+    #       ls -al
 
     - name: pass environment
-      uses: appleboy/ssh-action@master
+      uses: ./
       env:
         FOO: "BAR"
       with:
@@ -56,5 +61,44 @@ jobs:
         port: ${{ secrets.PORT }}
         envs: FOO
         script: |
-          echo "I am $FOO"
-          echo "I am $BAR"
+          echo "I am $FOO, thanks"
+          echo "I am $BAR, thanks"
+
+    - name: pass multiple environment
+      uses: ./
+      env:
+        FOO: "BAR"
+        BAR: "FOO"
+        SHA: ${{ github.sha }}
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        envs: FOO,BAR,SHA
+        script: |
+          echo "I am $FOO, thanks"
+          echo "I am $BAR, thanks"
+          echo "sha: $SHA"
+
+    - name: ssh key passphrase
+      uses: ./
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.SSH2 }}
+        port: ${{ secrets.PORT }}
+        passphrase: ${{ secrets.PASSPHRASE }}
+        script: |
+          whoami
+          ls -al
+
+    - name: use insecure cipher
+      uses: ./
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        password: ${{ secrets.PASSWORD }}
+        port: ${{ secrets.PORT }}
+        script: whoami
+        use_insecure_cipher: true

Dockerfile

@@ -1,4 +1,4 @@
-FROM appleboy/drone-ssh:1.5.2-linux-amd64
+FROM appleboy/drone-ssh:1.6.1-linux-amd64
 
 ADD entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh

README.md

@@ -1,17 +1,27 @@
 # 🚀 SSH for GitHub Actions
 
-[GitHub Action](https://developer.github.com/actions/) for executing remote ssh commands.
+[GitHub Action](https://github.com/features/actions) for executing remote ssh commands.
 
 ![ssh workflow](./images/ssh-workflow.png)
 
 [![Actions Status](https://github.com/appleboy/ssh-action/workflows/remote%20ssh%20command/badge.svg)](https://github.com/appleboy/ssh-action/actions)
 
+**Important**: Only support **Linux** [docker](https://www.docker.com/) container.
+
 ## Usage
 
 Executing remote ssh commands.
 
 ```yaml
-- name: executing remote ssh commands using password
+name: remote ssh command
+on: [push]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: executing remote ssh commands using password
       uses: appleboy/ssh-action@master
       with:
         host: ${{ secrets.HOST }}
@@ -28,27 +38,46 @@ output:
 whoami
 ======END======
 out: ***
-==========================================
-Successfully executed commands to all host.
-==========================================
+==============================================
+✅ Successfully executed commands to all host.
+==============================================
 ```
 
 ## Input variables
 
-see the [action.yml](./action.yml) file for more detail imformation.
+See [action.yml](./action.yml) for more detailed information.
 
-* host - scp remote host
-* port - scp remote port
-* username - scp username
-* password - scp password
+* host - ssh host
+* port - ssh port, default is `22`
+* username - ssh username
+* password - ssh password
+* passphrase - the passphrase is usually to encrypt the private key
+* sync - synchronous execution if multiple hosts, default is false
 * timeout - timeout for ssh to remote host, default is `30s`
-* command_timeout - timeout for scp command, default is `1m`
+* command_timeout - timeout for ssh command, default is `10m`
 * key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
 * key_path - path of ssh private key
+* fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
 * script - execute commands
 * script_stop - stop script after first failure
 * envs - pass environment variable to shell script
 * debug - enable debug mode
+* use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#56](https://github.com/appleboy/ssh-action/issues/56))
+* cipher - the allowed cipher algorithms. If unspecified then a sensible
+
+SSH Proxy Setting:
+
+* proxy_host - proxy host
+* 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
+* proxy_fingerprint - fingerprint SHA256 of the proxy host public key, default is to skip verification
+* proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#56](https://github.com/appleboy/ssh-action/issues/56))
+* proxy_cipher - the allowed cipher algorithms. If unspecified then a sensible
 
 ### Example
 
@@ -98,6 +127,7 @@ Multiple Commands
 Multiple Hosts
 
 ```diff
+  - name: multiple host
     uses: appleboy/ssh-action@master
     with:
 -     host: "foo.com"
@@ -110,33 +140,127 @@ Multiple Hosts
         ls -al
 ```
 
+Synchronous execution on multiple hosts
+
+```diff
+  - name: multiple host
+    uses: appleboy/ssh-action@master
+    with:
+      host: "foo.com,bar.com"
++     sync: true
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
+      script: |
+        whoami
+        ls -al
+```
+
 Pass environment variable to shell script
 
 ```diff
+  - name: pass environment
     uses: appleboy/ssh-action@master
 +   env:
 +     FOO: "BAR"
++     BAR: "FOO"
++     SHA: ${{ github.sha }}
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
       key: ${{ secrets.KEY }}
       port: ${{ secrets.PORT }}
-+   envs: FOO
++     envs: FOO,BAR
       script: |
         echo "I am $FOO"
         echo "I am $BAR"
+        echo "sha: $SHA"
 ```
 
 Stop script after first failure. ex: missing `abc` folder
 
-```yaml
-- name: stop script if command error
+```diff
+  - name: stop script if command error
     uses: appleboy/ssh-action@master
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
       key: ${{ secrets.KEY }}
       port: ${{ secrets.PORT }}
-    script_stop: true
-    script: "mkdir abc/def,ls -al"
++     script_stop: true
+      script: |
+        mkdir abc/def
+        ls -al
+```
+
+output:
+
+```sh
+======CMD======
+mkdir abc/def
+ls -al
+
+======END======
+2019/11/21 01:16:21 Process exited with status 1
+err: mkdir: cannot create directory ‘abc/def’: No such file or directory
+##[error]Docker run failed with exit code 1
+```
+
+How to connect remote server using `ProxyCommand`?
+
+```bash
++--------+       +----------+      +-----------+
+| Laptop | <-->  | Jumphost | <--> | FooServer |
++--------+       +----------+      +-----------+
+```
+
+in your `~/.ssh/config`, you will see the following.
+
+```bash
+Host Jumphost
+  HostName Jumphost
+  User ubuntu
+  Port 22
+  IdentityFile ~/.ssh/keys/jump_host.pem
+
+Host FooServer
+  HostName FooServer
+  User ubuntu
+  Port 22
+  ProxyCommand ssh -q -W %h:%p Jumphost
+```
+
+How to convert to YAML format of GitHubActions.
+
+```diff
+  - name: ssh proxy command
+    uses: appleboy/ssh-action@master
+    with:
+      host: ${{ secrets.HOST }}
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
++     proxy_host: ${{ secrets.PROXY_HOST }}
++     proxy_username: ${{ secrets.PROXY_USERNAME }}
++     proxy_key: ${{ secrets.PROXY_KEY }}
++     proxy_port: ${{ secrets.PROXY_PORT }}
+      script: |
+        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
 ```

action.yml

@@ -3,23 +3,61 @@ description: 'Executing remote ssh commands'
 author: 'Bo-Yi Wu'
 inputs:
   host:
-    description: 'ssh remote host'
+    description: 'ssh host'
   port:
-    description: 'ssh remote port'
+    description: 'ssh port'
+    default: 22
+  passphrase:
+    description: 'ssh key passphrase'
   username:
     description: 'ssh username'
   password:
     description: 'ssh password'
+  sync:
+    description: 'synchronous execution if multiple hosts'
+    default: false
+  use_insecure_cipher:
+    description: 'include more ciphers with use_insecure_cipher'
+    default: false
+  cipher:
+    description: 'the allowed cipher algorithms. If unspecified then a sensible'
   timeout:
-    description: 'timeout for ssh to remote host'
+    description: 'timeout for ssh to host'
     default: "30s"
   command_timeout:
     description: 'timeout for ssh command'
-    default: "1m"
+    default: "10m"
   key:
     description: 'content of ssh private key. ex raw content of ~/.ssh/id_rsa'
   key_path:
     description: 'path of ssh private key'
+  fingerprint:
+    description: 'sha256 fingerprint of the host public key'
+  proxy_host:
+    description: 'ssh proxy host'
+  proxy_port:
+    description: 'ssh proxy port'
+    default: 22
+  proxy_username:
+    description: 'ssh proxy username'
+  proxy_password:
+    description: 'ssh proxy password'
+  proxy_passphrase:
+    description: 'ssh proxy key passphrase'
+  proxy_timeout:
+    description: 'timeout for ssh to proxy host'
+    default: "30s"
+  proxy_key:
+    description: 'content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa'
+  proxy_key_path:
+    description: 'path of ssh proxy private key'
+  proxy_fingerprint:
+    description: 'sha256 fingerprint of the proxy host public key'
+  proxy_cipher:
+    description: 'the allowed cipher algorithms. If unspecified then a sensible'
+  proxy_use_insecure_cipher:
+    description: 'include more ciphers with use_insecure_cipher'
+    default: false
   script:
     description: 'execute commands'
   script_stop: