chore: add dependabot

See: https://github.com/appleboy/drone-scp/issues/130

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: weekly

.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,26 @@ 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"
+
+    - name: use insecure cipher
+      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"
+        use_insecure_cipher: true

Dockerfile

@@ -1,5 +1,5 @@
-FROM appleboy/drone-scp:1.5.3-linux-amd64
+FROM appleboy/drone-scp:1.6.4-linux-amd64
 
-ADD entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -2,13 +2,13 @@
 
 [GitHub Action](https://github.com/features/actions) for copying files and artifacts via SSH.
 
-![ssh key](./images/copy-multiple-file.png)
-
 [![Actions Status](https://github.com/appleboy/scp-action/workflows/scp%20files/badge.svg)](https://github.com/appleboy/scp-action/actions)
 
+**Important**: Only support **Linux** [docker](https://www.docker.com/) container.
+
 ## Usage
 
-copy files and artifacts via SSH as blow.
+Copy files and artifacts via SSH:
 
 ```yaml
 name: scp files
@@ -33,26 +33,42 @@ jobs:
 
 ## Input variables
 
-see the [action.yml](./action.yml) file for more detail imformation.
+See the [action.yml](./action.yml) file for more detail information.
 
 * host - scp remote host
-* port - scp remote port
+* port - scp remote port, default is `22`
 * username - scp username
 * password - scp password
+* passphrase - the passphrase is usually to encrypt the private key
+* fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
 * timeout - timeout for ssh to remote host, default is `30s`
-* command_timeout - timeout for scp command, default is `1m`
+* 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
+* use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
+
+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 host public key, default is to skip verification
+* proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
 
 ### Example
 
-Copy file via ssh password
+Copy file via a SSH password:
 
 ```yaml
 - name: copy file via ssh password
@@ -66,17 +82,16 @@ Copy file via ssh password
     target: "test"
 ```
 
-Copy file via ssh key
+Copy file via a SSH key:
 
 ```yaml
 - name: copy file via ssh key
   uses: appleboy/scp-action@master
-  env:
-    HOST: ${{ secrets.HOST }}
-    USERNAME: ${{ secrets.USERNAME }}
-    PORT: ${{ secrets.PORT }}
-    KEY: ${{ secrets.KEY }}
   with:
+    host: ${{ secrets.HOST }}
+    username: ${{ secrets.USERNAME }}
+    port: ${{ secrets.PORT }}
+    key: ${{ secrets.KEY }}
     source: "tests/a.txt,tests/b.txt"
     target: "test"
 ```
@@ -86,20 +101,18 @@ Example configuration for ignore list:
 ```yaml
 - name: copy file via ssh key
   uses: appleboy/scp-action@master
-  env:
-    HOST: ${{ secrets.HOST }}
-    USERNAME: ${{ secrets.USERNAME }}
-    PORT: ${{ secrets.PORT }}
-    KEY: ${{ secrets.KEY }}
   with:
+    host: ${{ secrets.HOST }}
+    username: ${{ secrets.USERNAME }}
+    port: ${{ secrets.PORT }}
+    key: ${{ secrets.KEY }}
     source: "tests/*.txt,!tests/a.txt"
     target: "test"
 ```
 
-Example configuration for multiple server
+Example configuration for multiple servers:
 
 ```diff
-- name: copy file via ssh password
   uses: appleboy/scp-action@master
   with:
 -   host: "example.com"
@@ -111,7 +124,7 @@ Example configuration for multiple server
     target: "test"
 ```
 
-remove the specified number of leading path elements
+Remove the specified number of leading path elements:
 
 ```yaml
 - name: remove the specified number of leading path elements
@@ -126,7 +139,7 @@ remove the specified number of leading path elements
     strip_components: 1
 ```
 
-old target structure:
+Old target structure:
 
 ```sh
 foobar
@@ -135,10 +148,25 @@ foobar
     └── b.txt
 ```
 
-new target structure:
+New target structure:
 
 ```sh
 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

@@ -16,17 +16,28 @@ 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'
+  fingerprint:
+    description: 'fingerprint SHA256 of the host public key, default is to skip verification'
+  use_insecure_cipher:
+    description: 'include more ciphers with use_insecure_cipher'
+    default: false
   target:
     description: 'target path on the server'
   source:
     description: 'scp file list'
   rm:
     description: 'remove target folder before upload data'
+    default: false
+  debug:
+    description: 'enable debug message'
+    default: false
   strip_components:
     description: 'remove the specified number of leading path elements'
     default: 0
@@ -35,6 +46,29 @@ 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'
+  proxy_fingerprint:
+    description: 'fingerprint SHA256 of the host public key, default is to skip verification'
+  proxy_use_insecure_cipher:
+    description: 'include more ciphers with use_insecure_cipher'
+    default: false
 runs:
   using: 'docker'
   image: 'Dockerfile'

entrypoint.sh

@@ -2,8 +2,6 @@
 
 set -eu
 
-export GITHUB="true"
-
 [ -n "$INPUT_STRIP_COMPONENTS" ] && export INPUT_STRIP_COMPONENTS=$((INPUT_STRIP_COMPONENTS + 0))
 
 sh -c "/bin/drone-scp $*"