Compare commits

..

10 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
Burnett01 a45ed8d36c chore: update versioning details in SECURITY.md
Clarified versioning scheme for action in the documentation.
2026-11-14 14:42:28 +01:00
Burnett01 b6ac3fe34e chore: Updated the status for v8 8.0.5 to indicate ESU.
Updated the status for v8 8.0.5 to indicate ESU.
2026-11-14 13:56:50 +01:00
Burnett01 2292b0b93b chore. Update support until date for version 9.0.3 2026-11-14 13:55:22 +01:00
Burnett01 b8733f9f81 Release/9.0.4 (#118)
* feat: update alpine to 3.24.4, update rsync to 3.5.2-r1, update openssh via edge to version 10.6_p2-r0

* feat: use alpine openssh-client pkg instead of full openssh (server+client pkg)

* Openssh now uses the openssh-client-default package, rather than the full openssh package, because openssh-server and other sub-packages are not needed for this action. This results in better security and faster deployments, since less dependencies are needed.

*  openssh-client-default package is using the edge repo now, just like rsync, in order to get the latest alpine security updates for them

* chore: update supported versions in SECURITY.md

* chore: update action version to 9.0.4, also mention new additional channel "latest"

+ Updated Alpine and Rsync versions in README.
+ New release channel available: @latest (always points to latest major, eg. v9, v10, v11....)
2026-11-08 18:37:35 +01:00
Burnett01 c8300118e5 Release/9.0.3 (#116)
* chore(deps): bump alpine from 3.24.2 to 3.24.3 (#115)

Bumps alpine from 3.24.2 to 3.24.3.

---
updated-dependencies:
- dependency-name: alpine
  dependency-version: 3.24.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: update to version 9.0.3

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-11-05 18:18:02 +01:00
5 changed files with 164 additions and 50 deletions
+3 -3
View File
@@ -1,4 +1,4 @@
FROM alpine:3.24.2@sha256:294b683cb724975bec92580e1e685676bd4b50bda910ddb8c51d4cabeaec77e6 AS base
FROM alpine:3.24.4@sha256:f59abe656b692d901e184be3445e084786602108599d2a51d229c0f5a48c71bf AS base
# Add Alpine edge branch as tagged repository for rsync.
RUN printf '%s\n' \
@@ -7,8 +7,8 @@ RUN printf '%s\n' \
>> /etc/apk/repositories
# Install rsync from Alpine edge branch for latest upstream security patches.
# Other packages are installed from Alpine 3.24.2 branch.
RUN apk update && apk add --no-cache --upgrade 'rsync@edge>=3.5.1-r0' openssh openssl busybox
# Other packages are installed from Alpine 3.24.3 branch.
RUN apk update && apk add --no-cache --upgrade 'rsync@edge>=3.5.2-r1' 'openssh-client-default@edge>=10.6_p2-r0' openssl busybox
RUN rm -rf /var/cache/apk/*
+75 -34
View File
@@ -10,21 +10,23 @@ This cross-platform GitHub Action deploys files in [`path`](#inputs) (relative t
Use this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPACE`, such [actions/checkout](https://github.com/actions/checkout).
The base-image of this action is very small and based on **Alpine 3.24.2** (no cache) which results in fast deployments.
The base-image of this action is very small and based on **Alpine 3.24.4** (no cache) which results in fast deployments.
Alpine version: [3.24.2](https://alpinelinux.org/posts/Alpine-3.21.8-3.22.6-3.23.6-3.24.2-released.html)
Rsync version: [3.5.1-r0](https://download.samba.org/pub/rsync/NEWS#3.5.1)
Alpine version: [3.24.4](https://alpinelinux.org/posts/alpine-3.21.10-3.22.8-3.23.8-3.24.4-released/)
Rsync version: [3.5.2-r1](https://download.samba.org/pub/rsync/NEWS#3.5.2)
## Current Version: v9 (9.0.2)
## Current Version: v9 (9.0.4)
### Release channels:
| Version | Purpose | Immutable |
| ------- | ------------------ | ------------------ |
| ``v9`` (recommended, LTS) | latest MAJOR (pointer to 9.MINOR.PATCH) | no |
| 9.0.2 | latest MAJOR+MINOR+PATCH | yes |
| ``v8`` (ESU) | previous MAJOR (pointer to 8.MINOR.PATCH) | no |
| 8.0.5 | previous MAJOR+MINOR+PATCH | yes |
| ------- | ------------------ | ------------------ |
| ``@v9`` (recommended, LTS) | latest MAJOR (pointer to 9.MINOR.PATCH) | no |
| ``@9.0.4`` | latest MAJOR+MINOR+PATCH | yes |
| ``@v8`` (ESU) | previous MAJOR (pointer to 8.MINOR.PATCH) | no |
| ``@8.0.5`` | previous MAJOR+MINOR+PATCH | yes |
You can also use ``@latest`` which always points to the latest MAJOR (currently ``v9``).
Check [SECURITY.md](SECURITY.md) for support cycles.
---
@@ -60,9 +62,11 @@ jobs:
- `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"
@@ -120,7 +124,7 @@ jobs:
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
```
Advanced (with filters etc):
Advanced (with filters etc) use ``switches``:
```yml
jobs:
@@ -132,12 +136,7 @@ jobs:
uses: burnett01/rsync-deployments@v9
with:
switches: -avzr --delete --exclude="" --include="" --filter=""
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 }}
[...redacted...]
```
If your private key is passphrase protected you should use:
@@ -151,19 +150,54 @@ jobs:
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
with:
switches: -avzr --delete
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
[...redacted...]
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
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
manually enable legacy support for this by using ``legacy_allow_rsa_hostkeys: "true"``.
@@ -177,21 +211,15 @@ jobs:
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
with:
switches: -avzr --delete
[...redacted...]
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.
**Note:** Only use this if necessary. It's recommended to upgrade your remote OpenSSH server instead.
--
---
## Advanced Rsync switches/flags/options
@@ -285,12 +313,25 @@ sudo apk add rsync
## Versions
## Version 9.0.3
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.3 (alpine 3.24.3)
## Version 9.0.2
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.2 (alpine 3.24.2)
## Version 9.0.1
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.1 (alpine 3.24.1)
-
## Version 9.0.0
Check here:
+44 -9
View File
@@ -2,23 +2,27 @@
The Docker image and code quality are regularly checked for vulnerabilities and CVEs by Snyk and CodeQL.
Additionally, we run linter and BATS suite tests to ensure stable compatibility.
## Supported Versions
The following versions are currently being supported with security updates:
| Version | Supported | Rsync version | Alpine version | Support Until |
| ------- | ------------------ | ------------------ | ------------------ | ------------------ |
| (``v9``) 9.0.2 | :white_check_mark: | >= 3.5.1-r0 | 3.24.2 | LTS (2028-*) |
| 9.0.1 | :white_check_mark: | >= 3.5.0-r0 | 3.24.1 | LTS (2028-*) |
| 9.0.0 | :white_check_mark: | >= 3.4.3-r1 | 3.24.1 | LTS (2028-*) |
| (``v8``) 8.0.5 | :white_check_mark: | >= 3.4.1-r1 | 3.23.4 | ESU (Apr, 1st 2027) |
| 8.0.4 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.3 | Dec, 6th 2026 |
| 8.0.3 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.2 | Dec, 6th 2026 |
| 8.0.2 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.0 | Dec, 6th 2026 |
| (``v9``) 9.0.4 | :white_check_mark: | >= 3.5.2-r1 | 3.24.4 | LTS (2028-*) |
| 9.0.3 | :white_check_mark: | >= 3.5.1-r0 | 3.24.3 | LTS (Jan, 8th 2028) |
| 9.0.2 | :white_check_mark: | >= 3.5.1-r0 | 3.24.2 | LTS (Jan, 8th 2028) |
| 9.0.1 | :white_check_mark: | >= 3.5.0-r0 | 3.24.1 | LTS (Jan, 8th 2028) |
| 9.0.0 | :white_check_mark: | >= 3.4.3-r1 | 3.24.1 | LTS (Jan, 8th 2028) |
| (``v8``) 8.0.5 | ⚠️ ESU | >= 3.4.1-r1 | 3.23.4 | Apr, 1st 2027 ([esu notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.4 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.3 | Dec, 6th 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.3 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.2 | Dec, 6th 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.2 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.0 | Dec, 6th 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.1 | :x: EOL | >= 3.4.1-r1 | 3.23.0 | † Apr, 1st 2026 |
| 8.0.0 | :x: EOL (due to regression #90) | >= 3.4.1-r1 | 3.23.0 | † Dec, 6th 2025 |
| 7.1.0 | :x: EOL | >= 3.4.1-r0 | 3.22.1 | † June, 1st 2026 ([deprecation notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
| 7.0.2 | :x: EOL | >= 3.4.0-r0 | 3.22.1 | † June, 1st 2026 ([deprecation notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
| 7.1.0 | :x: EOL | >= 3.4.1-r0 | 3.22.1 | † June, 1st 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
| 7.0.2 | :x: EOL | >= 3.4.0-r0 | 3.22.1 | † June, 1st 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
| 7.0.1 | :x: EOL | < 3.4.0 | 3.22.1 | † Dec, 6th 2025 |
| 7.0.0 | :x: EOL | < 3.4.0| 3.19.1 | † Dec, 6th 2025 |
| 6.x | :x: EOL |< 3.4.0| 3.17.2 | † 2024 |
@@ -34,6 +38,37 @@ EOL = End of life (no support/no updates)
DEPRECATED = Close to EOL (support/no updates)
ESU = Close to DEPRECATED (support/updates)
## Release cycles
Our aim is to follow the [Alpine Linux release cycles](https://alpinelinux.org/releases/).
Whenever a new Alpine version is released, we will release a new action version.
You can indicate the Alpine minor-version in our major-version number:
| Alpine Version | Action Version |
| ------- | ------------------ |
| 3.**24**.4 | **9**.0.4 |
| 3.**24**.3 | **9**.0.3 |
You can indicate the Alpine patch-version in our patch-version number:
| Alpine Version | Action Version |
| ------- | ------------------ |
| 3.24.**4** | 9.0.**4** |
| 3.24.**3** | 9.0.**3** |
If we release an OOB patch for a specific package update, our minor-version number increases:
| Alpine Version | Action Version |
| ------- | ------------------ |
| 3.24.4 | 9.**1**.4 |
| 3.24.3 | 9.**2**.3 |
**Note:** This is subject to change because we want to align our versioning with Alpines versioning.
## Reporting a Vulnerability
You can report a vulnerability by creating an issue.
+9 -1
View File
@@ -13,8 +13,12 @@ inputs:
description: 'Enables support for legacy RSA host keys on OpenSSH 8.8+'
required: false
default: 'false'
known_hosts:
description: 'Enables strict host keys checking against the hostkey you set.'
required: false
default: ''
strict_hostkeys_checking:
description: 'Controls strict host keys checking'
description: 'DEPRECATED: Controls strict host keys checking'
required: false
default: 'false'
path:
@@ -45,6 +49,10 @@ inputs:
description: 'Debug the action'
required: false
default: 'false'
log_level:
description: 'The log-level that is used in the rsh-switch'
required: false
default: 'ERROR'
runs:
using: 'docker'
image: 'Dockerfile'
+33 -3
View File
@@ -2,8 +2,11 @@
set -eu
LOG_LEVEL="${INPUT_LOGLEVEL:-ERROR}"
if [ "${INPUT_DEBUG:-false}" = "true" ]; then
set -x
LOG_LEVEL=""
fi
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
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"
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
echo "$key" | while IFS= read -r line; do hosts-add "$line"; done
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
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"
DSN="$INPUT_REMOTE_USER@$INPUT_REMOTE_HOST"