Compare commits

..

36 Commits

Author SHA1 Message Date
Steven 3c51abe2e5 chore: update readme 2025-12-06 15:35:59 +00:00
Steven 02b1a9758c chore: readme changes 2025-12-06 15:23:53 +00:00
Steven d966acdf6c chore: fix version pin 2025-12-06 15:22:24 +00:00
Steven b9d74ae5ae feat: Alpine 3.23.0 2025-12-06 15:20:42 +00:00
Steven 2bed3fc0f7 chore: include latest version 2025-12-06 14:50:32 +00:00
Steven d4403aa37e refactor: remove -o because of commit 6cb3f8196c 2025-12-06 14:19:54 +00:00
Steven 2e3a6dbe55 refactor: bring back package-shifting
Ability to allow for more recent apk versions.
2025-12-06 14:09:20 +00:00
Burnett01 77cf0f30ae refactor: pin alpine 3.22.1 + remove --upgrade to avoid package drift 2025-12-02 18:14:43 +00:00
Burnett01 35c5778c2d refactor: bats tests to cover STRICT_HOSTKEYS_CHECKING + assert whole rsync command 2025-12-02 17:08:29 +00:00
Burnett01 09f62ba15b chore: force-upgrade alpine busybox to tackle CVE-2024-58251
See: https://github.com/Burnett01/rsync-deployments/security/code-scanning/15
2025-12-02 15:17:42 +00:00
Burnett01 6cb3f8196c refactor: SC3040 (warning): In POSIX sh, set option pipefail is undefined. 2025-12-02 15:15:01 +00:00
Burnett01 d4d84ba02c chore: upgrade alpine 3.22.2 2025-12-02 15:09:19 +00:00
Burnett01 bf2d964f6f fix: remove debug output of known_hosts file in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 e0b7fb752e fix: replace tilde with $HOME for consistent path usage in scripts 2025-12-02 14:52:50 +00:00
Burnett01 61419b36d6 fix: remove debug output and known_hosts file display in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 a1f741433d fix: remove debug output of known_hosts file in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 bf4dca9d8e fix: replace echo with printf for consistent output formatting in hosts-add script 2025-12-02 14:52:50 +00:00
Burnett01 4369819153 debug 2025-12-02 14:52:50 +00:00
Burnett01 d4a9011612 fix: correct command substitution syntax for ssh-keyscan output processing 2025-12-02 14:52:50 +00:00
Burnett01 4b49843a52 fix: update strict host key checking to include known hosts file 2025-12-02 14:52:50 +00:00
Burnett01 1b2e963616 fix: filter out comments from ssh-keyscan output for strict host key checking 2025-12-02 14:52:50 +00:00
Burnett01 f85e1bae12 feat: add hosts-add script to manage SSH known hosts 2025-12-02 14:52:50 +00:00
Burnett01 8e8f89cdc5 feat: add host key verification and handling for strict host key checking 2025-12-02 14:52:50 +00:00
Burnett01 e9f72e6ef0 fix: use GITHUB_ACTION variable for SSH agent start in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 055751bf9e fix: correct debug mode setting in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 8bb0d8b3ce fix: correct debug mode setting in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 7293bea8ec feat: add debug input to action and enable debug mode in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 93eda1c97c fix: ensure proper initialization and cleanup of known hosts in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 7b075b3367 feat: add hosts-clear and hosts-init scripts for managing known_hosts 2025-12-02 14:52:50 +00:00
Burnett01 c0170dd157 fix: correct variable name for INPUT_SWITCHES in rsync command execution 2025-12-02 14:52:50 +00:00
Burnett01 82725684f9 fix: replace exec with sh -c for rsync command execution in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 7bf29be338 fix: remove unnecessary quotes around INPUT_SWITCHES in rsync command 2025-12-02 14:52:50 +00:00
Burnett01 069d4f1b5c fix: handle unset SSH_AGENT_PID variable in agent-start script 2025-12-02 14:52:50 +00:00
Burnett01 0fb32f477b fix: change SSH agent start argument to default in entrypoint script 2025-12-02 14:52:50 +00:00
Burnett01 844957283c fix: update Dockerfile to correct chmod command for agent scripts 2025-12-02 14:52:50 +00:00
Burnett01 9b1bf7278e feat: rsync-docker as first-party code, configureable strict host keys checking 2025-12-02 14:52:50 +00:00
15 changed files with 107 additions and 368 deletions
-1
View File
@@ -1 +0,0 @@
github: [burnett01]
-4
View File
@@ -4,7 +4,3 @@ updates:
directory: /
schedule:
interval: monthly
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
@@ -23,7 +23,7 @@ jobs:
name: Test BATS Suite
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v4
- name: Install BATS
run: |
@@ -38,7 +38,7 @@ jobs:
name: Validate Action Definition
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v4
- name: Validate action.yml
run: |
@@ -81,7 +81,7 @@ jobs:
needs: [validate-action, action-structure]
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v4
- name: Build Docker image
run: |
@@ -94,7 +94,7 @@ jobs:
name: Validate Action Structure
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v4
- name: Check required files
run: |
@@ -128,7 +128,7 @@ jobs:
name: Lint Shell Scripts
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v4
- name: Install ShellCheck
run: |
@@ -151,7 +151,7 @@ jobs:
needs: [test, validate-action, docker-build, action-structure, lint-shell]
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v4
- name: Final integration check
run: |
-25
View File
@@ -1,25 +0,0 @@
name: Integration
on:
workflow_dispatch:
permissions:
contents: read
jobs:
integration-test:
if: github.actor == 'Burnett01'
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
- name: Run integration test
uses: ./
with:
switches: -avzr --dry-run
remote_path: ${{ secrets.INTEGRATION_TEST_PATH }}
remote_host: ${{ secrets.INTEGRATION_TEST_SERVER }}
remote_port: ${{ secrets.INTEGRATION_TEST_PORT }}
remote_user: ${{ secrets.INTEGRATION_TEST_USER }}
remote_key: ${{ secrets.INTEGRATION_TEST_KEY }}
remote_key_pass: ${{ secrets.INTEGRATION_TEST_KEY_PASSPHRASE }}
@@ -19,7 +19,7 @@ jobs:
actions: read
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v4
- name: Build a Docker image
run: docker build -t burnett01/rsync-deployments .
- name: Run Snyk to check Docker image for vulnerabilities
+3 -11
View File
@@ -1,19 +1,11 @@
FROM alpine:3.24.4@sha256:f59abe656b692d901e184be3445e084786602108599d2a51d229c0f5a48c71bf AS base
FROM alpine:3.23.0@sha256:51183f2cfa6320055da30872f211093f9ff1d3cf06f39a0bdb212314c5dc7375 AS base
# Add Alpine edge branch as tagged repository for rsync.
RUN printf '%s\n' \
'@edge https://dl-cdn.alpinelinux.org/alpine/edge/main' \
'@edge https://dl-cdn.alpinelinux.org/alpine/edge/community' \
>> /etc/apk/repositories
# Install rsync from Alpine edge branch for latest upstream security patches.
# 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 apk update && apk add --no-cache --upgrade rsync openssh openssl busybox
RUN rm -rf /var/cache/apk/*
COPY docker-rsync/* /bin/
RUN chmod +x /bin/agent-* /bin/ssh-* /bin/hosts-*
RUN chmod +x /bin/agent-*
FROM base AS build
+2 -2
View File
@@ -1,8 +1,8 @@
MIT License
Copyright (c) 2019-2022 Contention
Copyright (c) 2019-2026 Joshua Piper (Dr Internet)
Copyright (c) 2019-2026 Burnett01
Copyright (c) 2019-2025 Joshua Piper (Dr Internet)
Copyright (c) 2019-2025 Burnett01
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
+73 -170
View File
@@ -10,63 +10,22 @@ 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.4** (no cache) which results in fast deployments.
The base-image of this action is very small and based on **Alpine 3.23.0** (no cache) which results in fast deployments.
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)
Alpine version: [3.23.0](https://www.alpinelinux.org/posts/Alpine-3.23.0-released.html)
Rsync version: [3.4.1-r1](https://download.samba.org/pub/rsync/NEWS#3.4.1)
## Current Version: v9 (9.0.4)
### Release channels:
| Version | Purpose | Immutable |
| ------- | ------------------ | ------------------ |
| ``@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.
---
## How it works
```yml
name: DEPLOY
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- 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
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
```
## Inputs
- `debug`* - Whether to enable debug output. ("true" / "false") - Default: "false"
- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`
- `rsh` - Custom remote shell SSH parameters via Rsync.
- `rsh` - Remote shell commands
- `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)
- `strict_hostkeys_checking` - Enables support for strict hostkeys (fingerprint) checking. ("true" / "false") - Default: "false"
- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false") - Default: "false"
@@ -94,9 +53,19 @@ This action needs secret variables for the ssh private key of your key pair. The
For simplicity, we are using `REMOTE_*` as the secret variables throughout the examples.
## Example usage
## Current Version: v8 (8.0.0)
For better **security** always use secrets for remote_host, remote_port, remote_user and remote_path inputs.
### Release channels:
| Version | Purpose | Immutable |
| ------- | ------------------ | ------------------ |
| ``v8`` | latest release (pointer to 8.x.x) | no, points to latest MINOR,PATCH |
| 8.0.0 | latest major release | yes |
| 7.1.0 | previous release | yes |
Check [SECURITY.md](SECURITY.md) for support cycles.
## Example usage
Simple:
@@ -111,32 +80,56 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v6
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
uses: burnett01/rsync-deployments@v8
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
remote_path: /var/www/html/
remote_host: example.com
remote_user: debian
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
```
Advanced (with filters etc) use ``switches``:
Advanced:
```yml
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v6
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
uses: burnett01/rsync-deployments@v8
with:
switches: -avzr --delete --exclude="" --include="" --filter=""
[...redacted...]
path: src/
remote_path: /var/www/html/
remote_host: example.com
remote_port: 5555
remote_user: debian
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
```
For better **security**, I suggest you create additional secrets for remote_host, remote_port, remote_user and remote_path inputs.
```yml
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: rsync deployments
uses: burnett01/rsync-deployments@v8
with:
switches: -avzr --delete
path: src/
remote_path: ${{ secrets.REMOTE_PATH }}
remote_host: ${{ secrets.REMOTE_HOST }}
remote_port: ${{ secrets.REMOTE_PORT }}
remote_user: ${{ secrets.REMOTE_USER }}
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
```
If your private key is passphrase protected you should use:
@@ -146,58 +139,23 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v6
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
uses: burnett01/rsync-deployments@v8
with:
[...redacted...]
switches: -avzr --delete
path: src/
remote_path: ${{ secrets.REMOTE_PATH }}
remote_host: ${{ secrets.REMOTE_HOST }}
remote_port: ${{ secrets.REMOTE_PORT }}
remote_user: ${{ secrets.REMOTE_USER }}
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
remote_key_pass: ${{ secrets.REMOTE_PRIVATE_KEY_PASS }}
```
---
## 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+
#### 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"``.
@@ -207,19 +165,25 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v6
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
uses: burnett01/rsync-deployments@v8
with:
[...redacted...]
switches: -avzr --delete
legacy_allow_rsa_hostkeys: "true"
path: src/
remote_path: ${{ secrets.REMOTE_PATH }}
remote_host: ${{ secrets.REMOTE_HOST }}
remote_port: ${{ secrets.REMOTE_PORT }}
remote_user: ${{ secrets.REMOTE_USER }}
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
@@ -313,75 +277,14 @@ 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:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.0 (alpine 3.24.1)
## Version 8.0.5
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.5 (alpine 3.23.4)
## Version 8.0.4
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.4 (alpine 3.23.3)
## Version 8.0.3
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.3 (alpine 3.23.2)
## Version 8.0.2
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.2 (alpine 3.23.0)
## Version 8.0.1 (EOL)
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.1 (alpine 3.23.0)
## Version 8.0.0 (EOL due to regression -> fixed via 8.0.1 & 8.0.2)
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.0 (alpine 3.23.0)
## Version 7.1.0 (EOL)
## Version 7.1.0
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/7.1.0 (alpine 3.22.1)
## Version 7.0.2 (EOL)
## Version 7.0.2 (DEPRECATED)
Check here:
@@ -455,7 +358,7 @@ Please note that version 1.0 has reached end of life state.
## Acknowledgements
+ This project is a fork of [Contention/rsync-deployments](https://github.com/Contention/rsync-deployments)
+ docker-rsync [JoshPiper/rsync-docker](https://github.com/JoshPiper/rsync-docker)
+ Base image [JoshPiper/rsync-docker](https://github.com/JoshPiper/rsync-docker)
---
+13 -56
View File
@@ -2,35 +2,23 @@
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.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 ([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 |
| 5.x | :x: EOL |< 3.4.0| 3.11 - 3.14.1 - 3.15 - 3.16 - 3.17.2 | † 2024 |
| 4.x | :x: EOL |< 3.4.0| 3.11 | † |
| 3.0 | :x: EOL |< 3.4.0| N/A | † |
| 2.0 | :x: EOL |< 3.4.0| Ubuntu | † |
| 1.0 | :x: EOL |< 3.4.0| Ubuntu | † |
| Version | Supported | Rsync version | Alpine version |
| ------- | ------------------ | ------------------ | ------------------ |
| 8.0.0 | :white_check_mark: | >= 3.4.1-r1 | 3.23.0 |
| 7.1.0 | :white_check_mark: | >= 3.4.1-r0 | 3.22.1 |
| 7.0.2 | :warning: DEPRECATED | >= 3.4.0-r0 | 3.22.1 |
| 7.0.1 | :x: EOL | < 3.4.0 | 3.22.1 |
| 7.0.0 | :x: EOL | < 3.4.0| 3.19.1 |
| 6.x | :x: EOL |< 3.4.0| 3.17.2 |
| 5.x | :x: EOL |< 3.4.0| 3.11 - 3.14.1 - 3.15 - 3.16 - 3.17.2 |
| 4.x | :x: EOL |< 3.4.0| 3.11 |
| 3.0 | :x: EOL |< 3.4.0| N/A |
| 2.0 | :x: EOL |< 3.4.0| Ubuntu |
| 1.0 | :x: EOL |< 3.4.0| Ubuntu |
### Terminology
@@ -38,37 +26,6 @@ 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.
+2 -10
View File
@@ -1,5 +1,5 @@
name: 'Rsync Deployments Action'
description: 'GitHub Action for deploying code via rsync over ssh securely - used by 5k+ workflows!'
description: 'GitHub Action for deploying code via rsync over ssh'
author: 'Burnett01'
inputs:
switches:
@@ -13,12 +13,8 @@ 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: 'DEPRECATED: Controls strict host keys checking'
description: 'Controls strict host keys checking'
required: false
default: 'false'
path:
@@ -49,10 +45,6 @@ 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'
-40
View File
@@ -1,40 +0,0 @@
# Scripts
Shell-scripts to help with managing SSH agents and known hosts files.
### SSH Management
#### ssh-init
This command create the ``$HOME/.ssh`` folder with default permissions ``700``.
### SSH-Agent Management
#### agent-start
This command starts the SSH agent, if it isn't already started (SSH_AGENT_PID set or ssh agent ID file found).
It takes one optional argument, for the name of the agent to be started. Defaults to "default".
This program needs to be source'd to work correctly.
`source agent-start "default"`
#### agent-stop
This command stops the SSH agent, if it is started (SSH_AGENT_PID set or ssh agent ID file found).
It takes one optional argument, for the name of the agent to be stopped. Defaults to "default".
`agent-stop "my-agent-name"`
#### agent-add
This command adds a key to the currently running SSH agent. The key is taken from stdin, and the agent used is that in SSH_AGENT_PID.
#### agent-askpass
This command is called by ssh-add when the [SSH_ASKPASS](https://man.openbsd.org/ssh-add.1#ENVIRONMENT) variable is set active. The command returns the SSH_PASS to [ssh-askpass(1)](https://man.openbsd.org/ssh-askpass.1).
This command is ignored by ssh-add if the key does not require a passphrase.
### known_hosts management
#### hosts-init
This command creates the known_hosts file (``$HOME/.ssh/known_hosts``) with default permission ``600``.
#### hosts-add
This command adds an entry to the known hosts file, and ensures its permissions are correct. It takes one argument, which is the new key to add.
#### hosts-clear
This command truncates the known_hosts file.
+1 -1
View File
@@ -2,4 +2,4 @@
set -eu
echo "$@" >> $HOME/.ssh/known_hosts
printf '%s\n' "$@" >> $HOME/.ssh/known_hosts
+1 -4
View File
@@ -2,8 +2,5 @@
set -eu
if [ ! -f "$HOME/.ssh/known_hosts" ]; then
touch $HOME/.ssh/known_hosts
fi
touch $HOME/.ssh/known_hosts
chmod 600 $HOME/.ssh/known_hosts
+1 -3
View File
@@ -2,6 +2,4 @@
set -eu
if [ ! -d "$HOME/.ssh" ]; then
mkdir -m 700 $HOME/.ssh
fi
mkdir -m 700 $HOME/.ssh
+4 -34
View File
@@ -2,11 +2,8 @@
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
@@ -20,7 +17,7 @@ source hosts-init
# Start the SSH agent and load key.
source agent-start "$GITHUB_ACTION"
echo "$INPUT_REMOTE_KEY" | SSH_PASS="$INPUT_REMOTE_KEY_PASS" agent-add
printf '%s' "$INPUT_REMOTE_KEY" | SSH_PASS="${INPUT_REMOTE_KEY_PASS}" agent-add >/dev/null 2>&1
# Variables.
LEGACY_RSA_HOSTKEYS=""
@@ -29,11 +26,7 @@ if [ "${INPUT_LEGACY_ALLOW_RSA_HOSTKEYS:-false}" = "true" ]; then
fi
STRICT_HOSTKEYS_CHECKING="-o StrictHostKeyChecking=no"
# 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'."
if [ "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]; then
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=""
@@ -43,35 +36,12 @@ if [[ -z "${INPUT_KNOWN_HOSTS:-}" && "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}"
# 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 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
echo "Warning: failed to fetch host key for $INPUT_REMOTE_HOST" >&2
exit 1
fi
fi
RSH="ssh $LOG_LEVEL $STRICT_HOSTKEYS_CHECKING $LEGACY_RSA_HOSTKEYS -p $INPUT_REMOTE_PORT $INPUT_RSH"
RSH="ssh $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"