Compare commits

..

5 Commits

Author SHA1 Message Date
Burnett01 37c76ba59c chore: README for clarity on inputs
Updated README to clarify options. Added section on pinning trusted host keys.
2026-11-15 11:12:29 +01:00
Burnett01 7abe7ad2ed refactor: deprecate strict_hostkeys_checking and add known_hosts
Updated description for strict_hostkeys_checking to indicate deprecation and added known_hosts parameter.
2026-11-15 10:41:05 +01:00
Burnett01 fb178094f6 refactor: new 'known_hosts', deprecate 'strict_hostkeys_checking'
Updated strict hostkeys checking logic: 
From now on you should use 'known_hosts' input, if you want to enforce explicit strict hostkey checking. Just create a new action secret which contains the explicit known_hosts entry you want this actions rsync-rsh to enforce. Multiple formats are supported.

The deprecated 'strict_hostkeys_checking' input will be a no-op in the next major because it is weak. It relies on ssh-keyscan which is fetching and validating the hostkey, but not verifying it against a user supplied hostkey. This is what the new 'known_hosts' input covers.
2026-11-15 10:33:27 +01:00
Burnett01 458d542ef0 refactor: log_level input to action.yml
Add log_level input to configure logging level
2026-11-15 09:43:38 +01:00
Burnett01 72af351b83 feat: new input for dynamic LOG_LEVEL
You can now control the ssh log-level that is passed via the rsh switch for better logging control.

The default log-level is ERROR (previously it was not set, hence it fallback to INFO). 

This further enhances masking when strict_hostkeys_checking is false (default=false), by hiding the warning message.
Github already always masked the host but the algo was still visible.

Before: "Warning: Permanently added '***' (ED25519) to the list of known hosts."

After: hidden (when log_level ERROR, which is the default)

As always, we encourage you to enable strict_hostkeys_checking = true, in order to make a hostkey known to the action beforehand.
2026-11-15 09:41:49 +01:00
3 changed files with 92 additions and 28 deletions
+50 -24
View File
@@ -62,9 +62,11 @@ jobs:
- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete` - `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`
- `rsh` - Remote shell commands - `rsh` - Custom remote shell SSH parameters via Rsync.
- `strict_hostkeys_checking` - Enables support for strict hostkeys (fingerprint) checking. ("true" / "false") - Default: "false" - `strict_hostkeys_checking` - Enables support for strict hostkeys (fingerprint) checking. ("true" / "false") - Default: "false" - **DEPRECATED (use 'known_hosts')!**
- `known_hosts` - Trusted host keys of the remote server, one per line (pinning). Enables strict hostkeys checking. Takes precedence over `strict_hostkeys_checking` - Default: "" - [See guide](#pinning-trusted-host-keys-known_hosts)
- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false") - Default: "false" - `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false") - Default: "false"
@@ -122,7 +124,7 @@ jobs:
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }} remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
``` ```
Advanced (with filters etc): Advanced (with filters etc) use ``switches``:
```yml ```yml
jobs: jobs:
@@ -134,12 +136,7 @@ jobs:
uses: burnett01/rsync-deployments@v9 uses: burnett01/rsync-deployments@v9
with: with:
switches: -avzr --delete --exclude="" --include="" --filter="" switches: -avzr --delete --exclude="" --include="" --filter=""
path: src/ [...redacted...]
remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
``` ```
If your private key is passphrase protected you should use: If your private key is passphrase protected you should use:
@@ -153,19 +150,54 @@ jobs:
- name: rsync deployments - name: rsync deployments
uses: burnett01/rsync-deployments@v9 uses: burnett01/rsync-deployments@v9
with: with:
switches: -avzr --delete [...redacted...]
path: src/
remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }} remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
remote_key_pass: ${{ secrets.REMOTE_PRIVATE_KEY_PASS }} remote_key_pass: ${{ secrets.REMOTE_PRIVATE_KEY_PASS }}
``` ```
--- ---
#### Legacy RSA Hostkeys support for OpenSSH Servers >= 8.8+ ## Pinning trusted host keys (known_hosts)
By default the action accepts any host key the server presents. With ``strict_hostkeys_checking: "true"`` (deprecated)
the key is fetched via `ssh-keyscan` right before the deployment, which only protects against
the key changing during the run, not against a server that is already spoofed at that moment.
To actually verify the server, pass its host key(s) via ``known_hosts``. The action then enables strict checking and skips `ssh-keyscan`. If the server presents
a different key, the deployment fails.
Get the public host key on the server itself (not over the network):
```sh
cat /etc/ssh/ssh_host_ed25519_key.pub
# ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... user@server
```
Store the output in a secret (e.g. `REMOTE_HOST_KEYS`) and pass it to the action:
```yml
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
with:
[...redacted...]
known_hosts: ${{ secrets.REMOTE_HOST_KEYS }}
```
Accepted formats, one entry per line (blank lines and lines starting with `#` are ignored):
- Bare key, e.g. `ssh-ed25519 AAAAC3...`. It is bound to `remote_host` (and `remote_port`, if not 22) automatically.
- Full known_hosts line, e.g. `example.com ssh-ed25519 AAAAC3...` or a hashed `|1|...` line. Used as is, so the host part must match `remote_host`.
Multiple keys (e.g. ed25519 and ecdsa) can be listed on separate lines.
---
## Legacy RSA Hostkeys support for OpenSSH Servers >= 8.8+
If your remote OpenSSH Server still uses RSA hostkeys, then you have to If your remote OpenSSH Server still uses RSA hostkeys, then you have to
manually enable legacy support for this by using ``legacy_allow_rsa_hostkeys: "true"``. manually enable legacy support for this by using ``legacy_allow_rsa_hostkeys: "true"``.
@@ -179,21 +211,15 @@ jobs:
- name: rsync deployments - name: rsync deployments
uses: burnett01/rsync-deployments@v9 uses: burnett01/rsync-deployments@v9
with: with:
switches: -avzr --delete [...redacted...]
legacy_allow_rsa_hostkeys: "true" legacy_allow_rsa_hostkeys: "true"
path: src/
remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
``` ```
See [#49](https://github.com/Burnett01/rsync-deployments/issues/49) and [#24](https://github.com/Burnett01/rsync-deployments/issues/24) for more information. See [#49](https://github.com/Burnett01/rsync-deployments/issues/49) and [#24](https://github.com/Burnett01/rsync-deployments/issues/24) for more information.
**Note:** Only use this if necessary. It's recommended to upgrade your remote OpenSSH server instead. **Note:** Only use this if necessary. It's recommended to upgrade your remote OpenSSH server instead.
-- ---
## Advanced Rsync switches/flags/options ## Advanced Rsync switches/flags/options
+9 -1
View File
@@ -13,8 +13,12 @@ inputs:
description: 'Enables support for legacy RSA host keys on OpenSSH 8.8+' description: 'Enables support for legacy RSA host keys on OpenSSH 8.8+'
required: false required: false
default: 'false' default: 'false'
known_hosts:
description: 'Enables strict host keys checking against the hostkey you set.'
required: false
default: ''
strict_hostkeys_checking: strict_hostkeys_checking:
description: 'Controls strict host keys checking' description: 'DEPRECATED: Controls strict host keys checking'
required: false required: false
default: 'false' default: 'false'
path: path:
@@ -45,6 +49,10 @@ inputs:
description: 'Debug the action' description: 'Debug the action'
required: false required: false
default: 'false' default: 'false'
log_level:
description: 'The log-level that is used in the rsh-switch'
required: false
default: 'ERROR'
runs: runs:
using: 'docker' using: 'docker'
image: 'Dockerfile' image: 'Dockerfile'
+33 -3
View File
@@ -2,8 +2,11 @@
set -eu set -eu
LOG_LEVEL="${INPUT_LOGLEVEL:-ERROR}"
if [ "${INPUT_DEBUG:-false}" = "true" ]; then if [ "${INPUT_DEBUG:-false}" = "true" ]; then
set -x set -x
LOG_LEVEL=""
fi fi
if [ -z "$(echo "$INPUT_REMOTE_PATH" | awk '{$1=$1};1')" ]; then if [ -z "$(echo "$INPUT_REMOTE_PATH" | awk '{$1=$1};1')" ]; then
@@ -26,7 +29,11 @@ if [ "${INPUT_LEGACY_ALLOW_RSA_HOSTKEYS:-false}" = "true" ]; then
fi fi
STRICT_HOSTKEYS_CHECKING="-o StrictHostKeyChecking=no" STRICT_HOSTKEYS_CHECKING="-o StrictHostKeyChecking=no"
if [ "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]; then # If no 'known_hosts' input is provided and 'strict_hostkeys_checking: true',
# then use exisiting keyscan functionality. DEPRECATED: Will be no-op in next major.
if [[ -z "${INPUT_KNOWN_HOSTS:-}" && "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]]; then
echo "::warning title=DEPRECATION::Input 'strict_hostkeys_checking' will be a no-op in the next major version! Use 'known_hosts'."
STRICT_HOSTKEYS_CHECKING="-o UserKnownHostsFile=$HOME/.ssh/known_hosts -o StrictHostKeyChecking=yes" STRICT_HOSTKEYS_CHECKING="-o UserKnownHostsFile=$HOME/.ssh/known_hosts -o StrictHostKeyChecking=yes"
key="$(ssh-keyscan -p "$INPUT_REMOTE_PORT" "$INPUT_REMOTE_HOST" 2>/dev/null | sed '/^#/d')" || key="" key="$(ssh-keyscan -p "$INPUT_REMOTE_PORT" "$INPUT_REMOTE_HOST" 2>/dev/null | sed '/^#/d')" || key=""
@@ -36,12 +43,35 @@ if [ "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]; then
# add to known hosts # add to known hosts
echo "$key" | while IFS= read -r line; do hosts-add "$line"; done echo "$key" | while IFS= read -r line; do hosts-add "$line"; done
else else
echo "Warning: failed to fetch host key for $INPUT_REMOTE_HOST" >&2 echo "Warning: failed to fetch host key for remote host" >&2
exit 1
fi
# If 'known_hosts' is provided, strict hostkeys checking is auto enforced:
elif [ -n "${INPUT_KNOWN_HOSTS:-}" ]; then
STRICT_HOSTKEYS_CHECKING="-o UserKnownHostsFile=$HOME/.ssh/known_hosts -o StrictHostKeyChecking=yes"
if [ "$INPUT_REMOTE_PORT" = "22" ]; then
host_pattern="$INPUT_REMOTE_HOST"
else
host_pattern="[$INPUT_REMOTE_HOST]:$INPUT_REMOTE_PORT"
fi
printf '%s\n' "$INPUT_KNOWN_HOSTS" | tr -d '\r' | while IFS= read -r line; do
line="$(echo "$line" | awk '{$1=$1};1')"
case "$line" in
''|'#'*) continue ;;
ssh-*|ecdsa-*|sk-*) hosts-add "$host_pattern $line" ;;
*) hosts-add "$line" ;;
esac
done
if ! ssh-keygen -lf "$HOME/.ssh/known_hosts" >/dev/null 2>&1; then
echo "Error: Input 'known_hosts' contains no valid host key" >&2
exit 1 exit 1
fi fi
fi fi
RSH="ssh $STRICT_HOSTKEYS_CHECKING $LEGACY_RSA_HOSTKEYS -p $INPUT_REMOTE_PORT $INPUT_RSH" RSH="ssh $LOG_LEVEL $STRICT_HOSTKEYS_CHECKING $LEGACY_RSA_HOSTKEYS -p $INPUT_REMOTE_PORT $INPUT_RSH"
LOCAL_PATH="$GITHUB_WORKSPACE/$INPUT_PATH" LOCAL_PATH="$GITHUB_WORKSPACE/$INPUT_PATH"
DSN="$INPUT_REMOTE_USER@$INPUT_REMOTE_HOST" DSN="$INPUT_REMOTE_USER@$INPUT_REMOTE_HOST"