rustfs/.github/workflows/rustfs-security-test.yml

# Copyright 2024 RustFS Team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: RustFS Security Test

on:
  workflow_dispatch:
    inputs:
      rustfs_version:
        description: 'RustFS release tag to test (e.g. 1.0.0-rc.4-preview.1)'
        required: false
        default: '1.0.0-rc.4-preview.1'
      package_url:
        description: 'Direct .deb URL (nightly/R2/dev). Overrides rustfs_version.'
        required: false
        type: string
      topology:
        description: 'Topology to run (all = SNSD, SNMD, MNMD)'
        type: choice
        options:
          - all
          - single-single
          - single-multi
          - multi-multi
        default: all
      oidc_live:
        description: 'Run the live Keycloak OIDC/SSO gate as part of the suite'
        type: boolean
        default: true
      cleanup_before:
        description: 'Reset the nodes before the test (DESTROYS existing data/config)'
        type: boolean
        default: true
      cleanup_after:
        description: 'Reset the nodes after the test (DESTROYS test data/config)'
        type: boolean
        default: true
  repository_dispatch:
    # Chain handoff: dispatched when the pool expansion suite finishes.
    types: [rustfs-chain-security]

permissions:
  contents: read

# The security suite uses the same shared VMs as the other functional tests,
# so it must serialize with them instead of running in parallel.
concurrency:
  group: rustfs-shared-functional-tests
  cancel-in-progress: false

defaults:
  run:
    shell: bash

env:
  RUSTFS_ACCESS_KEY: ${{ secrets.RUSTFS_ACCESS_KEY }}
  RUSTFS_SECRET_KEY: ${{ secrets.RUSTFS_SECRET_KEY }}
  RUSTFS_NODES: ${{ secrets.RUSTFS_NODES || vars.RUSTFS_NODES }}
  RUSTFS_SSH_USER: ${{ secrets.RUSTFS_SSH_USER || vars.RUSTFS_SSH_USER }}
  RUSTFS_NIGHTLY_PACKAGE_URL: ${{ vars.RUSTFS_NIGHTLY_PACKAGE_URL || 'https://dl.rustfs.com/artifacts/rustfs/packages/nightly/rustfs-nightly-latest.deb' }}
  PF_TESTING_GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }}

jobs:
  security-test:
    runs-on: smoke-testing
    timeout-minutes: 360
    if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch' }}
    steps:
      # Checkout the repository into its own subdirectory. Checking out at
      # the workspace root would wipe the auto-testing clone above (that is
      # exactly how run 33934141181 lost rustfs-security-test.sh).
      - name: Checkout repository (for the OIDC live gate script)
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
        with:
          persist-credentials: false
          path: rustfs-repo

      - name: Initialize security evidence
        id: evidence
        run: |
          set -euo pipefail
          umask 077
          SECURITY_ARTIFACTS_DIR="${RUNNER_TEMP}/rustfs-security-${GITHUB_RUN_ID}-${GITHUB_RUN_ATTEMPT}"
          mkdir -- "${SECURITY_ARTIFACTS_DIR}" "${SECURITY_ARTIFACTS_DIR}-scratch"
          printf 'SECURITY_ARTIFACTS_DIR=%s\n' "${SECURITY_ARTIFACTS_DIR}" >> "${GITHUB_ENV}"

      # auto-testing is private: clone it with the dedicated PF token (not
      # GITHUB_TOKEN) and retry transient GitHub/network failures.
      - name: Checkout auto-testing scripts (with retry)
        env:
          GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }}
        run: |
          set -euo pipefail
          rm -rf auto-testing
          for attempt in 1 2 3 4 5; do
            if gh repo clone rustfs/auto-testing auto-testing -- --depth 1 --quiet; then
              echo "auto-testing cloned (attempt ${attempt})"
              exit 0
            fi
            rm -rf auto-testing
            echo "clone attempt ${attempt} failed; retrying in $((attempt * 15))s" >&2
            sleep $((attempt * 15))
          done
          echo "ERROR: unable to clone rustfs/auto-testing after 5 attempts" >&2
          exit 1

      - name: Show environment
        run: |
          uname -a
          jq --version
          openssl version
          aws --version || true
          docker --version || true
          df -h /data | tail -1

      - name: Cleanup environment (before)
        if: ${{ inputs.cleanup_before != 'false' || github.event_name != 'workflow_dispatch' }}
        run: |
          set -euo pipefail
          read -r -a NODES <<< "${RUSTFS_NODES:-vm000 vm001 vm002}"
          SSH_USER="${RUSTFS_SSH_USER:-azureuser}"
          for node in "${NODES[@]}"; do
            ssh -o BatchMode=yes -o ConnectTimeout=10 -o StrictHostKeyChecking=accept-new "${SSH_USER}@${node}" '
              set -euo pipefail
              SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo -n"
              ${SUDO} systemctl stop rustfs 2>/dev/null || true
              if ${SUDO} dpkg -l rustfs 2>/dev/null | grep -q "^ii"; then
                ${SUDO} dpkg -P rustfs
              fi
              for i in 1 2 3 4; do ${SUDO} rm -rf /data/rustfs${i}/mnmd; done
              ${SUDO} rm -rf /var/log/rustfs /var/lib/rustfs/kms
            '
          done

      - name: Run security suite
        id: test
        continue-on-error: true
        env:
          REPORT_FILE: ${{ env.SECURITY_ARTIFACTS_DIR }}/suite-report.md
          TMPDIR: ${{ env.SECURITY_ARTIFACTS_DIR }}-scratch
          RUSTFS_SECURITY_OIDC_LIVE_SCRIPT: ${{ github.workspace }}/rustfs-repo/scripts/test/oidc_keycloak_live.sh
        run: |
          set -euo pipefail
          chmod +x auto-testing/rustfs-security-test.sh
          PACKAGE_URL='${{ inputs.package_url }}'
          RUSTFS_VERSION='${{ inputs.rustfs_version }}'
          TOPOLOGY='${{ inputs.topology }}'
          ARGS=(-y)
          if [ "${TOPOLOGY}" = "all" ] || [ -z "${TOPOLOGY}" ] || [ "${TOPOLOGY}" = "null" ]; then
            ARGS+=(--all-topologies)
          else
            ARGS+=(--topology "${TOPOLOGY}")
          fi
          if [ "${{ inputs.oidc_live }}" = "true" ] || [ "${{ github.event_name }}" != "workflow_dispatch" ]; then
            ARGS+=(--oidc-live)
          fi
          if [ -n "${PACKAGE_URL}" ]; then
            ARGS+=(--package-url "${PACKAGE_URL}")
          elif [ -n "${RUSTFS_VERSION}" ] && [ "${RUSTFS_VERSION}" != "null" ]; then
            ARGS+=(--version "${RUSTFS_VERSION}")
          else
            ARGS+=(--package-url "${RUSTFS_NIGHTLY_PACKAGE_URL}")
          fi
          GITHUB_STEP_SUMMARY=/dev/null ./auto-testing/rustfs-security-test.sh "${ARGS[@]}" 2>&1 | tee "${SECURITY_ARTIFACTS_DIR}/suite.log"

      - name: Generate report
        id: report
        if: ${{ always() && steps.evidence.outcome == 'success' }}
        env:
          TEST_OUTCOME: ${{ steps.test.outcome }}
        run: |
          set -euo pipefail
          RESULT=failure
          if [ "${TEST_OUTCOME}" = "success" ] && [ -s "${SECURITY_ARTIFACTS_DIR}/suite-report.md" ]; then
            RESULT=success
          fi
          {
            echo "# RustFS security test report"
            echo ""
            echo "- Run: ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
            echo "- Attempt: ${GITHUB_RUN_ATTEMPT}"
            echo "- Workflow Commit: ${GITHUB_SHA}"
            echo "- Trigger: ${GITHUB_EVENT_NAME}"
            echo "- Test Step Outcome: ${RESULT}"
            echo "- Suite Step Outcome: ${TEST_OUTCOME}"
            echo ""
            # The dashboard prioritizes case rows over the step outcome.
            # Keep partial case results in the artifact when the suite fails.
            if [ "${RESULT}" = "success" ]; then
              cat "${SECURITY_ARTIFACTS_DIR}/suite-report.md"
            elif [ -s "${SECURITY_ARTIFACTS_DIR}/suite-report.md" ]; then
              echo "The suite did not complete successfully. See suite-report.md in this run's artifact for diagnostics."
            else
              echo "The suite did not produce a non-empty report."
            fi
          } > "${SECURITY_ARTIFACTS_DIR}/report.md"
          cat "${SECURITY_ARTIFACTS_DIR}/report.md" >> "${GITHUB_STEP_SUMMARY}"
          [ "${RESULT}" = "success" ]

      - name: Upload functional report to dashboard
        if: ${{ always() && steps.evidence.outcome == 'success' }}
        continue-on-error: true
        env:
          GH_TOKEN: ${{ env.PF_TESTING_GH_TOKEN }}
          REPORT_FILE: ${{ env.SECURITY_ARTIFACTS_DIR }}/report.md
          SUITE: security
        run: |
          set -euo pipefail
          if [ -z "${GH_TOKEN:-}" ]; then
            echo "PF_TESTING_GH_TOKEN is not configured; skipping dashboard upload"
            exit 0
          fi
          DATE="$(date -u +%Y-%m-%d)"
          REPORT_PATH="functional-reports/${SUITE}/${DATE}.md"
          # Base64-encode the report into a temp file and feed it to jq via
          # --rawfile: large reports (e.g. pool) exceed the OS argv limit and
          # make `jq --arg content "${CONTENT}"` fail with "Argument list too long".
          B64_FILE="$(mktemp)"
          python3 -c 'import base64,sys;print(base64.b64encode(open(sys.argv[1],"rb").read()).decode())' "${REPORT_FILE}" > "${B64_FILE}"
          SHA="$(gh api "repos/rustfs/dashboard/contents/${REPORT_PATH}" -q '.sha' 2>/dev/null || true)"
          if [ -n "${SHA}" ]; then
            jq -n --arg msg "report(${SUITE}): ${DATE}" --rawfile content "${B64_FILE}" --arg sha "${SHA}" \
              '{message:$msg, content:($content|rtrimstr("\n")), sha:$sha}' \
              | gh api --method PUT "repos/rustfs/dashboard/contents/${REPORT_PATH}" --input - >/dev/null
          else
            jq -n --arg msg "report(${SUITE}): ${DATE}" --rawfile content "${B64_FILE}" \
              '{message:$msg, content:($content|rtrimstr("\n"))}' \
              | gh api --method PUT "repos/rustfs/dashboard/contents/${REPORT_PATH}" --input - >/dev/null
          fi
          rm -f "${B64_FILE}"

      - name: File failure issue in rustfs/backlog
        if: ${{ always() && (failure() || steps.test.outcome == 'failure' || steps.test.outcome == 'cancelled') }}
        continue-on-error: true
        env:
          GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }}
          SUITE: 'security'
          SUITE_LABEL: 'Security'
          EVIDENCE_OUTCOME: ${{ steps.evidence.outcome }}
          RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
          REPORT_FILE: ${{ env.SECURITY_ARTIFACTS_DIR }}/report.md
          LOG_FILE: ''
        run: |
          set -euo pipefail
          if [ -z "${GH_TOKEN:-}" ]; then
            echo "PF_TESTING_GH_TOKEN is not configured; skipping backlog issue"
            exit 0
          fi
          TITLE="[functional][${SUITE}] ${SUITE_LABEL} suite failed (run ${GITHUB_RUN_ID})"
          EXISTING="$(gh issue list -R rustfs/backlog --state all \
            --search "in:title \"run ${GITHUB_RUN_ID}\"" \
            --json number --jq '.[].number' || true)"
          if [ -n "${EXISTING}" ]; then
            echo "backlog issue already exists for run ${GITHUB_RUN_ID}; skipping"
            exit 0
          fi
          redact() {
            sed -E \
              -e 's/(RUSTFS_(ACCESS_KEY|SECRET_KEY)[=: ]+)[^[:space:]]+/\1[REDACTED]/Ig' \
              -e 's/(Authorization:).*/\1 [REDACTED]/Ig' \
              -e 's/(X-Amz-Signature=)[^&[:space:]]+/\1[REDACTED]/Ig' \
              -e 's/^.*(password|secret|token)[=: ].*/[REDACTED SENSITIVE LINE]/Ig'
          }
          BODY_FILE="$(mktemp)"
          {
            echo "The **${SUITE_LABEL}** functional suite failed."
            echo ""
            echo "- Suite: \`${SUITE}\`"
            echo "- Run: ${RUN_URL}"
            echo "- Trigger: ${GITHUB_EVENT_NAME}"
            echo "- Date: $(date -u +%Y-%m-%d)"
            echo ""
            echo "## Report (errors and symptoms)"
            echo ""
            if [ "${EVIDENCE_OUTCOME}" = "success" ] && [ -s "${REPORT_FILE}" ]; then
              redact < "${REPORT_FILE}"
            elif [ -s "${LOG_FILE:-}" ]; then
              echo "(report file missing; log tail below)"
              echo ""
              tail -n 200 "${LOG_FILE}" | redact
            else
              echo "(no report or log file was produced)"
            fi
          } | head -c 55000 > "${BODY_FILE}"
          gh label create functional-test -R rustfs/backlog --color d73a4a 2>/dev/null || true
          if ! gh issue create -R rustfs/backlog --title "${TITLE}" \
              --body-file "${BODY_FILE}" --label functional-test; then
            gh issue create -R rustfs/backlog --title "${TITLE}" --body-file "${BODY_FILE}"
          fi
          echo "filed backlog issue for suite ${SUITE}"

      - name: Upload report and logs
        if: ${{ always() && steps.evidence.outcome == 'success' }}
        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
        with:
          name: rustfs-security-test-${{ github.run_id }}-${{ github.run_attempt }}
          path: |
            ${{ env.SECURITY_ARTIFACTS_DIR }}/report.md
            ${{ env.SECURITY_ARTIFACTS_DIR }}/suite.log
            ${{ env.SECURITY_ARTIFACTS_DIR }}/suite-report.md
          if-no-files-found: error
          retention-days: 3

      - name: Cleanup environment (after)
        if: ${{ always() && (inputs.cleanup_after != 'false' || github.event_name != 'workflow_dispatch') }}
        run: |
          set -euo pipefail
          read -r -a NODES <<< "${RUSTFS_NODES:-vm000 vm001 vm002}"
          SSH_USER="${RUSTFS_SSH_USER:-azureuser}"
          for node in "${NODES[@]}"; do
            ssh -o BatchMode=yes -o ConnectTimeout=10 -o StrictHostKeyChecking=accept-new "${SSH_USER}@${node}" '
              set -euo pipefail
              SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo -n"
              ${SUDO} systemctl stop rustfs 2>/dev/null || true
              if ${SUDO} dpkg -l rustfs 2>/dev/null | grep -q "^ii"; then
                ${SUDO} dpkg -P rustfs
              fi
              for i in 1 2 3 4; do ${SUDO} rm -rf /data/rustfs${i}/mnmd; done
              ${SUDO} rm -rf /var/log/rustfs /var/lib/rustfs/kms
            '
          done

      - name: "Continue functional chain (next: Replication)"
        # Only chain-triggered runs forward to the next suite; standalone
        # workflow_dispatch runs stop after their own cleanup.
        if: ${{ always() && github.event_name == 'repository_dispatch' }}
        continue-on-error: true
        env:
          GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }}
        run: |
          set -euo pipefail
          if [ -z "${GH_TOKEN:-}" ]; then
            echo "PF_TESTING_GH_TOKEN is not configured; cannot dispatch the next suite" >&2
            exit 1
          fi
          echo "Dispatching next functional suite: Replication"
          gh api --method POST repos/rustfs/rustfs/dispatches \
            -f event_type='rustfs-chain-replication' \
            -F 'client_payload[from_suite]=security'

      - name: Notify on failure
        if: failure()
        run: |
          echo "RustFS security test failed"
          echo "Package source: ${{ inputs.package_url || 'nightly (R2 latest)' }}"
          echo "See the uploaded report and logs for details."