diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index e2af03e..8ba045a 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -8,28 +8,25 @@ env: CARGO_TERM_COLOR: always CARGO_INCREMENTAL: "0" +# Two jobs: `build` compiles untrusted-by-default code and has NO secrets and +# NO cache; `publish` holds the signing key and only handles built artifacts. jobs: - release: + build: runs-on: ubuntu-latest env: - VNOX_RELEASE_SIGNING_KEY: ${{ secrets.VNOX_RELEASE_SIGNING_KEY }} - RELEASE_TOKEN: ${{ secrets.RELEASE_TOKEN || secrets.GITHUB_TOKEN }} - MIN_VERSION: ${{ vars.VNOX_MIN_VERSION }} TAG: ${{ gitea.ref_name }} - SERVER_URL: ${{ gitea.server_url }} - REPO: ${{ gitea.repository }} steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 - - name: Preflight (signing key, tag and version) + - name: Preflight (tag, version, branch) run: | set -euo pipefail - if [ -z "${VNOX_RELEASE_SIGNING_KEY:-}" ]; then - echo "::error::secret VNOX_RELEASE_SIGNING_KEY is not set, refusing to publish an unsigned release" - exit 1 - fi - if [ -z "${RELEASE_TOKEN:-}" ]; then - echo "::error::no API token available (RELEASE_TOKEN / GITHUB_TOKEN)" + # Only commits reachable from main may be released. + git fetch origin main + if ! git merge-base --is-ancestor "$GITHUB_SHA" origin/main; then + echo "::error::tagged commit is not on main, refusing to release" exit 1 fi case "$TAG" in v[0-9]*) ;; *) echo "::error::tag '$TAG' is not vX.Y.Z"; exit 1;; esac @@ -42,8 +39,7 @@ jobs: fi case "$VERSION" in *-*) CHANNEL=beta;; *) CHANNEL=stable;; esac echo "VERSION=$VERSION" >> "$GITHUB_ENV" - echo "CHANNEL=$CHANNEL" >> "$GITHUB_ENV" - python3 scripts/release/extract_changelog.py "$VERSION" CHANGELOG.md > "$RUNNER_TEMP/changelog.md" + python3 scripts/release/extract_changelog.py "$VERSION" CHANGELOG.md > /dev/null echo "releasing $VERSION on channel $CHANNEL" - name: Install system dependencies @@ -53,7 +49,7 @@ jobs: $SUDO apt-get update $SUDO apt-get install -y --no-install-recommends \ build-essential curl ca-certificates pkg-config cmake protobuf-compiler zip \ - python3 python3-pip \ + python3 \ libasound2-dev libopus-dev libudev-dev \ libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev \ libssl-dev libxkbcommon-dev libwayland-dev libfontconfig1-dev libdbus-1-dev \ @@ -61,7 +57,6 @@ jobs: # Posix threading model is required by the Rust windows-gnu target. $SUDO update-alternatives --set x86_64-w64-mingw32-gcc /usr/bin/x86_64-w64-mingw32-gcc-posix || true $SUDO update-alternatives --set x86_64-w64-mingw32-g++ /usr/bin/x86_64-w64-mingw32-g++-posix || true - python3 -m pip install --user cryptography || python3 -m pip install --user --break-system-packages cryptography - name: Install Rust toolchain run: | @@ -74,18 +69,6 @@ jobs: rustup target add x86_64-pc-windows-gnu echo "$HOME/.cargo/bin" >> "$GITHUB_PATH" - - name: Cache cargo - uses: actions/cache@v4 - with: - path: | - ~/.cargo/registry/index - ~/.cargo/registry/cache - ~/.cargo/git/db - target - key: cargo-release-${{ runner.os }}-${{ hashFiles('Cargo.lock') }} - restore-keys: | - cargo-release-${{ runner.os }}- - - name: Build Linux x86_64 run: cargo build --release --locked --bin vnox-client @@ -115,12 +98,60 @@ jobs: cd "$OUT" sha256sum "$LIN.tar.gz" "$WIN.zip" > SHA256SUMS cat SHA256SUMS - echo "LIN_ASSET=$LIN.tar.gz" >> "$GITHUB_ENV" - echo "WIN_ASSET=$WIN.zip" >> "$GITHUB_ENV" - - name: Build and sign manifest + - name: Upload build artifacts + uses: actions/upload-artifact@v3 + with: + name: dist + path: dist/ + if-no-files-found: error + + publish: + needs: build + runs-on: ubuntu-latest + env: + MIN_VERSION: ${{ vars.VNOX_MIN_VERSION }} + TAG: ${{ gitea.ref_name }} + SERVER_URL: ${{ gitea.server_url }} + REPO: ${{ gitea.repository }} + steps: + - uses: actions/checkout@v4 + + - name: Derive version run: | set -euo pipefail + VERSION="${TAG#v}" + case "$VERSION" in *-*) CHANNEL=beta;; *) CHANNEL=stable;; esac + echo "VERSION=$VERSION" >> "$GITHUB_ENV" + echo "CHANNEL=$CHANNEL" >> "$GITHUB_ENV" + echo "LIN_ASSET=vnox-client-${VERSION}-linux-x86_64.tar.gz" >> "$GITHUB_ENV" + echo "WIN_ASSET=vnox-client-${VERSION}-windows-x86_64.zip" >> "$GITHUB_ENV" + python3 scripts/release/extract_changelog.py "$VERSION" CHANGELOG.md > "$RUNNER_TEMP/changelog.md" + + - name: Install signing dependencies + run: | + SUDO=$(command -v sudo || true) + $SUDO apt-get update + $SUDO apt-get install -y --no-install-recommends python3 python3-cryptography + + - name: Download build artifacts + uses: actions/download-artifact@v3 + with: + name: dist + path: dist/ + + - name: Verify artifacts match SHA256SUMS + run: cd dist && sha256sum -c SHA256SUMS + + - name: Build and sign manifest + env: + VNOX_RELEASE_SIGNING_KEY: ${{ secrets.VNOX_RELEASE_SIGNING_KEY }} + run: | + set -euo pipefail + if [ -z "${VNOX_RELEASE_SIGNING_KEY:-}" ]; then + echo "::error::secret VNOX_RELEASE_SIGNING_KEY is not set, refusing to publish an unsigned release" + exit 1 + fi cd dist python3 ../scripts/release/manifest.py build \ --version "$VERSION" --channel "$CHANNEL" \ @@ -133,8 +164,13 @@ jobs: ls -l - name: Create Gitea release and upload assets + env: + RELEASE_TOKEN: ${{ secrets.RELEASE_TOKEN || secrets.GITHUB_TOKEN }} run: | set -euo pipefail + if [ -z "${RELEASE_TOKEN:-}" ]; then + echo "::error::no API token available (RELEASE_TOKEN / GITHUB_TOKEN)"; exit 1 + fi API="$SERVER_URL/api/v1/repos/$REPO" AUTH="Authorization: token $RELEASE_TOKEN" PRERELEASE=false diff --git a/docs/release.md b/docs/release.md index 55c2214..1251e28 100644 --- a/docs/release.md +++ b/docs/release.md @@ -168,3 +168,10 @@ scripts/release/keygen.py --private-out vnox-release.key скомпрометированным ключом. Клиенты со старым ключом без нового публичного ключа придётся обновлять вручную, поэтому держите в клиенте запасной публичный ключ заранее. 4. После смены секрета проверьте подпись следующего релиза скриптом `manifest.py verify`. + +## Безопасность пайплайна + +- Job `build` не имеет секретов и не использует кеш; он собирает артефакты и проверяет, что тег стоит на коммите из `main`. +- Job `publish` получает `VNOX_RELEASE_SIGNING_KEY` и токен только в тех шагах, где они нужны, проверяет `SHA256SUMS` и подписывает manifest. +- Рекомендуется включить защищённые теги `v*` в настройках репозитория Gitea (кто может создавать теги релиза). +- Gitea 1.22 поддерживает `actions/upload-artifact@v3`/`download-artifact@v3`, не v4.