chore: update

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

.github/workflows/ci.yml

@@ -261,3 +261,52 @@ jobs:
           script_stop: true
           script: |
             echo ${{ secrets.DOCKERHUB_TOKEN }} | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin
+
+  testing05:
+    name: switch user
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v1
+
+      - name: switch to root user
+        uses: ./
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          port: ${{ secrets.PORT }}
+          script_stop: true
+          request_pty: true
+          command_timeout: 30s
+          script: |
+            whoami && echo 'hello world' && touch todo.txt
+            sudo whoami
+
+  testing06:
+    name: testing ipv6
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v1
+
+      - name: Set up WARP
+        uses: fscarmen/warp-on-actions@v1.1
+        with:
+          stack: dual
+
+      - name: testing ipv6 for command
+        run: |
+          curl -m 9 --ipv6 --verbose https://google.com
+
+      - name: testing ipv6
+        uses: ./
+        with:
+          host: 2402:1f00:8000:800::2628
+          username: ubuntu
+          password: ${{ secrets.OVH_PASSWORD }}
+          protocol: tcp6
+          port: 22
+          command_timeout: 30s
+          script: |
+            whoami

.github/workflows/testing.yml

@@ -0,0 +1,26 @@
+name: testing master
+on: [push]
+
+env:
+  FOO: "BAR"
+  BAR: "FOO"
+
+jobs:
+  testing01:
+    name: testing new bash flow
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v1
+
+      - name: try bash script
+        uses: appleboy/ssh-action@master
+        with:
+          host: 2402:1f00:8000:800::2628
+          username: ubuntu
+          password: ${{ secrets.OVH_PASSWORD }}
+          protocol: tcp6
+          port: 22
+          command_timeout: 30s
+          script: |
+            whoami

Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/appleboy/drone-ssh:1.7.2
+FROM ghcr.io/appleboy/drone-ssh:1.7.4
 
 COPY entrypoint.sh /bin/entrypoint.sh
 

README.md

@@ -17,12 +17,13 @@ This thing is built using [Golang](https://go.dev) and [drone-ssh](https://githu
 See [action.yml](./action.yml) for more detailed information.
 
 | Input Parameter           | Description                                                                              | Default Value |
-|-------------------------|-----------------------------------------------------------------|---------------|
+|---------------------------|------------------------------------------------------------------------------------------|---------------|
 | host                      | SSH host address                                                                         |               |
 | port                      | SSH port number                                                                          | 22            |
 | passphrase                | SSH key passphrase                                                                       |               |
 | username                  | SSH username                                                                             |               |
 | password                  | SSH password                                                                             |               |
+| protocol                  | SSH protocol version (tcp, tcp4, tcp6)                                                   | tcp           |
 | sync                      | Enable synchronous execution if multiple hosts                                           | false         |
 | use_insecure_cipher       | Include more ciphers with use_insecure_cipher                                            | false         |
 | cipher                    | Allowed cipher algorithms. If unspecified, a sensible default                            |               |
@@ -47,7 +48,8 @@ See [action.yml](./action.yml) for more detailed information.
 | envs                      | Pass environment variables to shell script                                               |               |
 | envs_format               | Flexible configuration of environment value transfer                                     |               |
 | debug                     | Enable debug mode                                                                        | false         |
-| allenvs                 | Pass all environment variables to shell script                  | false         |
+| allenvs                   | pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false         |
+| request_pty               | Request a pseudo-terminal from the server                                                | false         |
 
 ## Usage
 
@@ -63,7 +65,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: executing remote ssh commands using password
-      uses: appleboy/ssh-action@v1.0.2
+      uses: appleboy/ssh-action@v1.0.3
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -164,7 +166,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.0.2
+  uses: appleboy/ssh-action@v1.0.3
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -177,7 +179,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v1.0.2
+  uses: appleboy/ssh-action@v1.0.3
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -190,7 +192,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.0.2
+  uses: appleboy/ssh-action@v1.0.3
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -207,7 +209,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -223,7 +225,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -238,7 +240,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: "foo.com,bar.com"
 +     sync: true
@@ -254,7 +256,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: pass environment
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -279,7 +281,7 @@ _Inside `env` object, you need to pass every environment variable as a string, p
 
 ```diff
   - name: stop script if command error
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -332,7 +334,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -355,7 +357,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -381,7 +383,7 @@ Now you can adjust you config:
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}

README.zh-tw.md

@@ -58,7 +58,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: executing remote ssh commands using password
-      uses: appleboy/ssh-action@v1.0.2
+      uses: appleboy/ssh-action@v1.0.3
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -157,7 +157,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.0.2
+  uses: appleboy/ssh-action@v1.0.3
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -170,7 +170,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v1.0.2
+  uses: appleboy/ssh-action@v1.0.3
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.0.2
+  uses: appleboy/ssh-action@v1.0.3
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -200,7 +200,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -216,7 +216,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -231,7 +231,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: "foo.com,bar.com"
 +     sync: true
@@ -247,7 +247,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: pass environment
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -272,7 +272,7 @@ _在 `env` 對象中，您需要將每個環境變量作為字符串傳遞，傳
 
 ```diff
   - name: stop script if command error
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -325,7 +325,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -346,7 +346,7 @@ Host FooServer
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -372,7 +372,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.0.2
+    uses: appleboy/ssh-action@v1.0.3
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}

action.yml

@@ -1,76 +1,124 @@
-name: 'SSH Remote Commands'
-description: 'Executing remote ssh commands'
-author: 'Bo-Yi Wu'
+name: "SSH Remote Commands"
+description: "Executing remote ssh commands"
+author: "Bo-Yi Wu"
 inputs:
   host:
-    description: 'SSH host address.'
+    description: "SSH host address."
   port:
-    description: 'SSH port number.'
+    description: "SSH port number."
     default: "22"
   passphrase:
-    description: 'Passphrase for the SSH key.'
+    description: "Passphrase for the SSH key."
   username:
-    description: 'SSH username.'
+    description: "SSH username."
   password:
-    description: 'SSH password.'
+    description: "SSH password."
+  protocol:
+    description: 'The IP protocol to use. Valid values are "tcp". "tcp4" or "tcp6". Default to tcp.'
+    default: "tcp"
   sync:
-    description: 'Enable synchronous execution if multiple hosts are involved.'
+    description: "Enable synchronous execution if multiple hosts are involved."
   use_insecure_cipher:
-    description: 'Include more ciphers by using insecure ciphers.'
+    description: "Include more ciphers by using insecure ciphers."
   cipher:
-    description: 'Allowed cipher algorithms. If unspecified, a sensible default is used.'
+    description: "Allowed cipher algorithms. If unspecified, a sensible default is used."
   timeout:
-    description: 'Timeout duration for establishing SSH connection to the host.'
+    description: "Timeout duration for establishing SSH connection to the host."
     default: "30s"
   command_timeout:
-    description: 'Timeout duration for SSH commands execution.'
+    description: "Timeout duration for SSH commands execution."
     default: "10m"
   key:
-    description: 'Content of the SSH private key. For example, the raw content of ~/.ssh/id_rsa.'
+    description: "Content of the SSH private key. For example, the raw content of ~/.ssh/id_rsa."
   key_path:
-    description: 'Path to the SSH private key file.'
+    description: "Path to the SSH private key file."
   fingerprint:
-    description: 'SHA256 fingerprint of the host public key.'
+    description: "SHA256 fingerprint of the host public key."
   proxy_host:
-    description: 'SSH proxy host address.'
+    description: "SSH proxy host address."
   proxy_port:
-    description: 'SSH proxy port number.'
+    description: "SSH proxy port number."
     default: "22"
   proxy_username:
-    description: 'SSH proxy username.'
+    description: "SSH proxy username."
   proxy_password:
-    description: 'SSH proxy password.'
+    description: "SSH proxy password."
   proxy_passphrase:
-    description: 'SSH proxy key passphrase.'
+    description: "SSH proxy key passphrase."
   proxy_timeout:
-    description: 'Timeout duration for establishing SSH connection to the proxy host.'
+    description: "Timeout duration for establishing SSH connection to the proxy host."
     default: "30s"
   proxy_key:
-    description: 'Content of the SSH proxy private key. For example, the raw content of ~/.ssh/id_rsa.'
+    description: "Content of the SSH proxy private key. For example, the raw content of ~/.ssh/id_rsa."
   proxy_key_path:
-    description: 'Path to the SSH proxy private key file.'
+    description: "Path to the SSH proxy private key file."
   proxy_fingerprint:
-    description: 'SHA256 fingerprint of the proxy host public key.'
+    description: "SHA256 fingerprint of the proxy host public key."
   proxy_cipher:
-    description: 'Allowed cipher algorithms for the proxy. If unspecified, a sensible default is used.'
+    description: "Allowed cipher algorithms for the proxy. If unspecified, a sensible default is used."
   proxy_use_insecure_cipher:
-    description: 'Include more ciphers for the proxy by using insecure ciphers.'
+    description: "Include more ciphers for the proxy by using insecure ciphers."
   script:
-    description: 'Commands to be executed.'
+    description: "Commands to be executed."
   script_stop:
-    description: 'Stop the script after the first failure.'
+    description: "Stop the script after the first failure."
   envs:
-    description: 'Environment variables to be passed to the shell script.'
+    description: "Environment variables to be passed to the shell script."
   envs_format:
-    description: 'Flexible configuration for environment value transfer.'
+    description: "Flexible configuration for environment value transfer."
   debug:
-    description: 'Enable debug mode.'
+    description: "Enable debug mode."
   allenvs:
-    description: 'pass all environment variable to shell script.'
+    description: "pass all environment variable to shell script."
+  request_pty:
+    description: "Request a pseudo-terminal from the server."
+
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: "composite"
+  steps:
+    - name: Set GitHub Path
+      run: echo "$GITHUB_ACTION_PATH" >> $GITHUB_PATH
+      shell: bash
+      env:
+        GITHUB_ACTION_PATH: ${{ github.action_path }}
+    - name: Run entrypoint.sh
+      run: entrypoint.sh
+      shell: bash
+      env:
+        GITHUB_ACTION_PATH: ${{ github.action_path }}
+        INPUT_HOST: ${{ inputs.host }}
+        INPUT_PORT: ${{ inputs.port }}
+        INPUT_PROTOCOL: ${{ inputs.protocol }}
+        INPUT_USERNAME: ${{ inputs.username }}
+        INPUT_PASSWORD: ${{ inputs.password }}
+        INPUT_PASSPHRASE: ${{ inputs.passphrase }}
+        INPUT_KEY: ${{ inputs.key }}
+        INPUT_KEY_PATH: ${{ inputs.key_path }}
+        INPUT_FINGERPRINT: ${{ inputs.fingerprint }}
+        INPUT_PROXY_HOST: ${{ inputs.proxy_host }}
+        INPUT_PROXY_PORT: ${{ inputs.proxy_port }}
+        INPUT_PROXY_USERNAME: ${{ inputs.proxy_username }}
+        INPUT_PROXY_PASSWORD: ${{ inputs.proxy_password }}
+        INPUT_PROXY_PASSPHRASE: ${{ inputs.proxy_passphrase }}
+        INPUT_PROXY_KEY: ${{ inputs.proxy_key }}
+        INPUT_PROXY_KEY_PATH: ${{ inputs.proxy_key_path }}
+        INPUT_PROXY_FINGERPRINT: ${{ inputs.proxy_fingerprint }}
+        INPUT_TIMEOUT: ${{ inputs.timeout }}
+        INPUT_PROXY_TIMEOUT: ${{ inputs.proxy_timeout }}
+        INPUT_COMMAND_TIMEOUT: ${{ inputs.command_timeout }}
+        INPUT_SCRIPT: ${{ inputs.script }}
+        INPUT_SCRIPT_STOP: ${{ inputs.script_stop }}
+        INPUT_ENVS: ${{ inputs.envs }}
+        INPUT_ENVS_FORMAT: ${{ inputs.envs_format }}
+        INPUT_DEBUG: ${{ inputs.debug }}
+        INPUT_ALL_ENVS: ${{ inputs.allenvs }}
+        INPUT_REQUEST_PTY: ${{ inputs.request_pty }}
+        INPUT_USE_INSECURE_CIPHER: ${{ inputs.use_insecure_cipher }}
+        INPUT_CIPHER: ${{ inputs.cipher }}
+        INPUT_PROXY_USE_INSECURE_CIPHER: ${{ inputs.proxy_use_insecure_cipher }}
+        INPUT_PROXY_CIPHER: ${{ inputs.proxy_cipher }}
+        INPUT_SYNC: ${{ inputs.sync }}
 
 branding:
-  icon: 'terminal'
-  color: 'gray-dark'
+  icon: "terminal"
+  color: "gray-dark"

entrypoint.sh

@@ -1,7 +1,66 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
-set -eu
+set -o errexit
+set -o nounset
+set -o pipefail
 
 export GITHUB="true"
 
-sh -c "/bin/drone-ssh $*"
+GITHUB_ACTION_PATH="${GITHUB_ACTION_PATH%/}"
+DRONE_SSH_RELEASE_URL="${DRONE_SSH_RELEASE_URL:-https://github.com/appleboy/drone-ssh/releases/download}"
+DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.7.4}"
+
+function detect_client_info() {
+  if [ -n "${SSH_CLIENT_OS-}" ]; then
+    CLIENT_PLATFORM="${SSH_CLIENT_OS}"
+  else
+    local kernel
+    kernel="$(uname -s)"
+    case "${kernel}" in
+      Darwin)
+        CLIENT_PLATFORM="darwin"
+        ;;
+      Linux)
+        CLIENT_PLATFORM="linux"
+        ;;
+      Windows)
+        CLIENT_PLATFORM="windows"
+        ;;
+      *)
+        echo "Unknown, unsupported platform: ${kernel}." >&2
+        echo "Supported platforms: Linux, Darwin and Windows." >&2
+        echo "Bailing out." >&2
+        exit 2
+    esac
+  fi
+
+  if [ -n "${SSH_CLIENT_ARCH-}" ]; then
+    CLIENT_ARCH="${SSH_CLIENT_ARCH}"
+  else
+    local machine
+    machine="$(uname -m)"
+    case "${machine}" in
+      x86_64*|i?86_64*|amd64*)
+        CLIENT_ARCH="amd64"
+        ;;
+      aarch64*|arm64*)
+        CLIENT_ARCH="arm64"
+        ;;
+      *)
+        echo "Unknown, unsupported architecture (${machine})." >&2
+        echo "Supported architectures x86_64, i686, arm64." >&2
+        echo "Bailing out." >&2
+        exit 3
+        ;;
+    esac
+  fi
+}
+
+detect_client_info
+DOWNLOAD_URL_PREFIX="${DRONE_SSH_RELEASE_URL}/v${DRONE_SSH_VERSION}"
+CLIENT_BINARY="drone-ssh-${DRONE_SSH_VERSION}-${CLIENT_PLATFORM}-${CLIENT_ARCH}"
+TARGET="${GITHUB_ACTION_PATH}/${CLIENT_BINARY}"
+echo "Will download ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}"
+curl -fL --retry 3 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o ${TARGET}
+chmod +x ${TARGET}
+sh -c "${TARGET} $*"