schedule secure-upload-folder #474
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Copyright 2023 SLSA Authors | |
# | |
# 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: schedule secure-upload-folder | |
on: | |
# Daily run. | |
schedule: | |
- cron: "0 4 * * *" | |
workflow_dispatch: | |
permissions: read-all | |
env: | |
ARTIFACT_NAME: "my-artifact" | |
UPLOAD_FOLDER_NAME: "upload-folder" | |
DOWNLOAD_FOLDER_NAME: "download-folder" | |
ARTIFACT_NO_ROOT_NAME: "my-artifact-noroot" | |
UPLOAD_FOLDER_NO_ROOT_NAME: "upload-root/upload-folder" | |
DOWNLOAD_FOLDER_NO_ROOT_NAME: "download-root/download-folder" | |
jobs: | |
secure-upload-folder: | |
runs-on: ubuntu-latest | |
outputs: | |
sha256: ${{ steps.upload.outputs.sha256 }} | |
sha256-noroot: ${{ steps.upload-noroot.outputs.sha256 }} | |
steps: | |
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
- name: Create folder | |
run: | | |
set -euo pipefail | |
# Folder in the root of GITHUB_WORKSPACE | |
mkdir -p "${UPLOAD_FOLDER_NAME}/inside" | |
mkdir -p "${UPLOAD_FOLDER_NAME}/empty" | |
echo file1 > "${UPLOAD_FOLDER_NAME}/file1" | |
echo file2 > "${UPLOAD_FOLDER_NAME}/file2" | |
echo file3 > "${UPLOAD_FOLDER_NAME}/inside/file3" | |
echo file4 > "${UPLOAD_FOLDER_NAME}/inside/file4" | |
tree "${UPLOAD_FOLDER_NAME}" | |
# Folder not in the root of GITHUB_WORKSPACE | |
mkdir -p "${UPLOAD_FOLDER_NO_ROOT_NAME}" | |
cp -R "${UPLOAD_FOLDER_NAME}"/* "${UPLOAD_FOLDER_NO_ROOT_NAME}"/ | |
tree "${UPLOAD_FOLDER_NO_ROOT_NAME}" | |
- name: Upload | |
id: upload | |
uses: ./.github/actions/secure-upload-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "${{ env.UPLOAD_FOLDER_NAME }}" | |
- name: Upload | |
id: upload-noroot | |
uses: ./.github/actions/secure-upload-folder | |
with: | |
name: "${{ env.ARTIFACT_NO_ROOT_NAME }}" | |
path: "${{ env.UPLOAD_FOLDER_NO_ROOT_NAME }}" | |
- name: Upload path traversal | |
id: upload-traversal | |
continue-on-error: true | |
uses: ./.github/actions/secure-upload-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "../" | |
- name: Upload outside workspace | |
id: upload-outside | |
continue-on-error: true | |
uses: ./.github/actions/secure-upload-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "/tmp/" | |
- name: fail check | |
env: | |
SUCCESS: ${{ steps.upload-outside.outcome == 'failure' && steps.upload-traversal.outcome == 'failure' }} | |
run: | | |
set -euo pipefail | |
[ "$SUCCESS" == "true" ] | |
secure-download-folder: | |
needs: [secure-upload-folder] | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
- name: Download in new folder | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "${{ env.DOWNLOAD_FOLDER_NAME }}" | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256 }} | |
- name: Download locally | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256 }} | |
- name: Download in new folder noroot | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NO_ROOT_NAME }}" | |
path: "${{ env.DOWNLOAD_FOLDER_NO_ROOT_NAME }}" | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256-noroot }} | |
- name: Download locally noroot | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NO_ROOT_NAME }}" | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256-noroot }} | |
- name: Download incorrect hash | |
id: download-incorrect-hash | |
continue-on-error: true | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "some-folder" | |
sha256: 977b0c871b048d6578f5d5b40a5b6030a22fc130831a2d7b45b6868da7b51431 | |
- name: Download existing file | |
id: download-existing-file | |
continue-on-error: true | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "${{ env.DOWNLOAD_FOLDER_NAME }}" | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256 }} | |
- name: Download path traversal | |
id: download-traversal | |
continue-on-error: true | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: ".." | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256 }} | |
- name: Download outside workspace | |
id: download-outside | |
continue-on-error: true | |
uses: ./.github/actions/secure-download-folder | |
with: | |
name: "${{ env.ARTIFACT_NAME }}" | |
path: "/tmp" | |
sha256: ${{ needs.secure-upload-folder.outputs.sha256 }} | |
- name: fail check | |
env: | |
SUCCESS: ${{ steps.download-incorrect-hash.outcome == 'failure' && steps.download-existing-file.outcome == 'failure' && steps.download-traversal.outcome == 'failure' && steps.download-outside.outcome == 'failure' }} | |
run: | | |
set -euo pipefail | |
[ "$SUCCESS" == "true" ] | |
if-succeed: | |
needs: [secure-upload-folder, secure-download-folder] | |
runs-on: ubuntu-latest | |
# We use `== 'failure'` instead of ` != 'success'` because we want to ignore skipped jobs, if there are any. | |
if: github.event_name != 'workflow_dispatch' && needs.secure-upload-folder.result != 'failure' && needs.secure-download-folder.result != 'failure' | |
permissions: | |
contents: read | |
issues: write | |
steps: | |
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
with: | |
repository: slsa-framework/example-package | |
ref: main | |
- run: ./.github/workflows/scripts/e2e-report-success.sh | |
if-failed: | |
needs: [secure-upload-folder, secure-download-folder] | |
runs-on: ubuntu-latest | |
if: always() && github.event_name != 'workflow_dispatch' && (needs.secure-upload-folder.result == 'failure' || needs.secure-download-folder.result == 'failure') | |
permissions: | |
contents: read | |
issues: write | |
steps: | |
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
with: | |
repository: slsa-framework/example-package | |
ref: main | |
- run: ./.github/workflows/scripts/e2e-report-failure.sh |