Merge pull request #11 from dbingham/fixTypo

Update to drone-scp 1.5.6

.github/workflows/ci.yml

@@ -6,9 +6,11 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - name: checkout
+      uses: actions/checkout@v1
+
     - name: copy file via ssh password
-      uses: appleboy/scp-action@master
+      uses: ./
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -18,7 +20,7 @@ jobs:
         target: "test"
 
     - name: copy file via ssh key
-      uses: appleboy/scp-action@master
+      uses: ./
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -28,7 +30,7 @@ jobs:
         target: "test"
 
     - name: remove the specified number of leading path elements
-      uses: appleboy/scp-action@master
+      uses: ./
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -37,3 +39,14 @@ jobs:
         source: "tests/a.txt,tests/b.txt"
         target: "foobar"
         strip_components: 1
+
+    - name: ssh key with passphrase
+      uses: ./
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.SSH2 }}
+        passphrase: ${{ secrets.PASSPHRASE }}
+        port: ${{ secrets.PORT }}
+        source: "tests/a.txt,tests/b.txt"
+        target: "test"

Dockerfile

@@ -1,4 +1,4 @@
-FROM appleboy/drone-scp:1.5.3-linux-amd64
+FROM appleboy/drone-scp:1.5.6-linux-amd64
 
 ADD entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh

README.md

@@ -1,6 +1,6 @@
 # 🚀 SCP for GitHub Actions
 
-[GitHub Action](https://developer.github.com/actions/) for copying files and artifacts via SSH.
+[GitHub Action](https://github.com/features/actions) for copying files and artifacts via SSH.
 
 ![ssh key](./images/copy-multiple-file.png)
 
@@ -11,15 +11,24 @@
 copy files and artifacts via SSH as blow.
 
 ```yaml
-- name: copy file via ssh password
+name: scp files
-  uses: appleboy/scp-action@master
+on: [push]
-  with:
+jobs:
-    host: ${{ secrets.HOST }}
+
-    username: ${{ secrets.USERNAME }}
+  build:
-    password: ${{ secrets.PASSWORD }}
+    name: Build
-    port: ${{ secrets.PORT }}
+    runs-on: ubuntu-latest
-    source: "tests/a.txt,tests/b.txt"
+    steps:
-    target: "test"
+    - uses: actions/checkout@master
+    - name: copy file via ssh password
+      uses: appleboy/scp-action@master
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        password: ${{ secrets.PASSWORD }}
+        port: ${{ secrets.PORT }}
+        source: "tests/a.txt,tests/b.txt"
+        target: "test"
 ```
 
 ## Input variables
@@ -27,20 +36,32 @@ copy files and artifacts via SSH as blow.
 see the [action.yml](./action.yml) file for more detail imformation.
 
 * host - scp remote host
-* port - scp remote port
+* port - scp remote port, default is `22`
 * username - scp username
 * password - scp password
-* timeout - timeout for ssh to remote host
+* passphrase - the passphrase is usually to encrypt the private key
-* command_timeout - timeout for scp command
+* timeout - timeout for ssh to remote host, default is `30s`
+* command_timeout - timeout for scp command, default is `10m`
 * key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
 * key_path - path of ssh private key
 * target - target path on the server
 * source - scp file list
-* rm - remove target folder before upload data
+* rm - remove target folder before upload data, default is `false`
 * strip_components - remove the specified number of leading path elements.
 * overwrite - use `--overwrite` flag with tar
 * tar_tmp_path - temporary path for tar file on the dest host
 
+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
+
 ### Example
 
 Copy file via ssh password
@@ -90,7 +111,6 @@ Example configuration for ignore list:
 Example configuration for multiple server
 
 ```diff
-- name: copy file via ssh password
   uses: appleboy/scp-action@master
   with:
 -   host: "example.com"
@@ -133,3 +153,18 @@ foobar
   ├── a.txt
   └── b.txt
 ```
+
+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 with passphrase
+    uses: appleboy/scp-action@master
+    with:
+      host: ${{ secrets.HOST }}
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.SSH2 }}
++     passphrase: ${{ secrets.PASSPHRASE }}
+      port: ${{ secrets.PORT }}
+      source: "tests/a.txt,tests/b.txt"
+      target: "test"
+```

action.yml

@@ -6,6 +6,7 @@ inputs:
     description: 'scp remote host'
   port:
     description: 'scp remote port'
+    default: 22
   username:
     description: 'scp username'
   password:
@@ -15,17 +16,20 @@ inputs:
     default: "30s"
   command_timeout:
     description: 'timeout for scp 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'
+  passphrase:
+    description: 'ssh key passphrase'
   target:
     description: 'target path on the server'
   source:
     description: 'scp file list'
   rm:
     description: 'remove target folder before upload data'
+    default: false
   strip_components:
     description: 'remove the specified number of leading path elements'
     default: 0
@@ -34,6 +38,24 @@ inputs:
     default: false
   tar_tmp_path:
     description: 'temporary path for tar file on the dest host'
+  proxy_host:
+    description: 'ssh proxy remote host'
+  proxy_port:
+    description: 'ssh proxy remote 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'
 runs:
   using: 'docker'
   image: 'Dockerfile'