Merge branch 'main' into documentation #106
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
| # DevSecOps Workflow Definition | |
| name: DevSecOps Workflow | |
| on: | |
| push: | |
| branches: | |
| - '*' | |
| tags: | |
| - '*' | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Secret scanning job to detect secrets in codebase | |
| secret-scanning: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| security-events: write | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 # Check out the repository content to the runner | |
| - name: Run Gitleaks Scan | |
| # Running Gitleaks to scan the code for secrets | |
| run: | | |
| docker run --rm -v $(pwd):/code -u $(id -u):$(id -g) zricethezav/gitleaks:v8.18.1@sha256:6945c62ca019ead32bc337ab0c9fd055e98d82961765d38b7ccccc84dae95d0f -s /code detect -f sarif -r /code/gitleaks.sarif.json | |
| - name: Upload sarif file | |
| uses: github/codeql-action/upload-sarif@v3 | |
| with: | |
| sarif_file: gitleaks.sarif.json | |
| category: secret-scanning | |
| # Software Composition Analysis (SCA) to find vulnerabilities in project dependencies | |
| sca: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| security-events: write | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Run Trivy vulnerability scanner in fs mode | |
| # Running Trivy to scan the filesystem for vulnerabilities | |
| uses: aquasecurity/trivy-action@master | |
| with: | |
| scan-type: "fs" | |
| scan-ref: "." | |
| severity: "CRITICAL,HIGH" | |
| format: "sarif" | |
| output: "trivy-results.sarif" | |
| - name: Upload Trivy scan results to GitHub Security tab | |
| uses: github/codeql-action/upload-sarif@v3 | |
| with: | |
| sarif_file: "trivy-results.sarif" | |
| category: "sca" | |
| iac: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.8 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| - name: Test with Checkov | |
| id: checkov | |
| uses: bridgecrewio/checkov-action@master | |
| with: | |
| directory: . | |
| # Static Application Security Testing (SAST) to identify security vulnerabilities in source code | |
| sast: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| security-events: write | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Run Semgrep | |
| # Running Semgrep for static code analysis to identify security issues | |
| uses: docker://returntocorp/semgrep | |
| with: | |
| args: semgrep scan /github/workspace --sarif -o /github/workspace/semgrep.sarif.json | |
| - name: Upload sarif file | |
| uses: github/codeql-action/upload-sarif@v3 | |
| with: | |
| sarif_file: semgrep.sarif.json | |
| category: sast | |
| golangci: | |
| name: lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v4 | |
| with: | |
| go-version: '1.22' | |
| cache: false | |
| - name: golangci-lint | |
| uses: golangci/golangci-lint-action@v3 | |
| with: | |
| # Require: The version of golangci-lint to use. | |
| # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version. | |
| # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit. | |
| version: v1.56.1 | |
| # Optional: working directory, useful for monorepos | |
| # working-directory: somedir | |
| # Optional: golangci-lint command line arguments. | |
| # | |
| # Note: By default, the `.golangci.yml` file should be at the root of the repository. | |
| # The location of the configuration file can be changed by using `--config=` | |
| # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0 | |
| # Optional: show only new issues if it's a pull request. The default value is `false`. | |
| # only-new-issues: true | |
| # Optional: if set to true, then all caching functionality will be completely disabled, | |
| # takes precedence over all other caching options. | |
| # skip-cache: true | |
| # Optional: if set to true, then the action won't cache or restore ~/go/pkg. | |
| # skip-pkg-cache: true | |
| # Optional: if set to true, then the action won't cache or restore ~/.cache/go-build. | |
| # skip-build-cache: true | |
| # Optional: The mode to install golangci-lint. It can be 'binary' or 'goinstall'. | |
| # install-mode: "goinstall" | |
| tests: | |
| name: tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| - name: Set up Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: '1.22' | |
| - name: Run unittests | |
| run: go test ./... -cover | |
| # Docker image build job | |
| build-image: | |
| permissions: | |
| packages: write | |
| runs-on: ubuntu-latest | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set IMAGE_TAG if tagged | |
| # Setting the image tag if the push is a tag push | |
| run: | | |
| echo "ghcr.io/${{ github.repository }}:${GITHUB_REF#refs/tags/}" > image-tag.txt | |
| export IMAGE_TAG=$(cat image-tag.txt) | |
| echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV | |
| if: startsWith(github.ref, 'refs/tags/') | |
| - name: Set IMAGE_TAG if not tagged | |
| run: | | |
| branch=${GITHUB_REF##*/} | |
| sha=${GITHUB_SHA::8} | |
| ts=$(date +%s) | |
| echo "ghcr.io/${{ github.repository }}:${branch}-${sha}-${ts}" > image-tag.txt | |
| export IMAGE_TAG=$(cat image-tag.txt) | |
| echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV | |
| if: github.ref == 'refs/heads/main' | |
| - name: Build Docker image with Kaniko | |
| # Building the Docker image using Kaniko | |
| id: build_image | |
| uses: docker://gcr.io/kaniko-project/executor:v1.9.2 | |
| with: | |
| args: --destination=${{ env.IMAGE_TAG }} --context=/github/workspace --dockerfile=/github/workspace/Dockerfile --no-push --tarPath /github/workspace/image.tar | |
| - name: Setup crane | |
| uses: imjasonh/setup-crane@v0.1 | |
| - name: Use crane to get the digest | |
| run: crane digest --tarball=image.tar > digest.txt | |
| - name: Upload artifact | |
| # Uploading the built Docker image as an artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docker-image | |
| path: image.tar | |
| - name: Upload digest | |
| # Uploading the built Docker image digest as an artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: digest | |
| path: digest.txt | |
| - name: Upload image tag | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: image-tag | |
| path: image-tag.txt | |
| # Image scanning job to detect vulnerabilities in the built Docker image | |
| image-scanning: | |
| needs: build-image | |
| permissions: | |
| security-events: write | |
| runs-on: ubuntu-latest | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: docker-image | |
| path: . | |
| - name: Run Trivy vulnerability scanner in tarball mode | |
| # Running Trivy to scan the Docker image for vulnerabilities | |
| uses: aquasecurity/trivy-action@master | |
| with: | |
| input: /github/workspace/image.tar | |
| severity: "CRITICAL,HIGH" | |
| format: "sarif" | |
| output: "trivy-results.sarif" | |
| - name: Upload Trivy scan results to GitHub Security tab | |
| uses: github/codeql-action/upload-sarif@v3 | |
| with: | |
| sarif_file: "trivy-results.sarif" | |
| category: "image-scanning" | |
| # Publish job to push the Docker image to a registry | |
| publish: | |
| needs: [build-image, image-scanning, secret-scanning, sca, sast, iac] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| packages: write | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: docker-image | |
| path: . | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: image-tag | |
| path: . | |
| - name: set IMAGE_TAG env | |
| run: | | |
| export IMAGE_TAG=$(cat image-tag.txt) | |
| echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV | |
| - uses: imjasonh/setup-crane@v0.1 | |
| - name: Push Docker image to GitHub image Registry | |
| # Pushing the Docker image to GitHub Container Registry | |
| run: crane push image.tar ${{ env.IMAGE_TAG }} | |
| sbom: | |
| runs-on: ubuntu-latest # Specify the runner | |
| needs: [build-image] | |
| container: | |
| image: alpine:3.19.1@sha256:c5b1261d6d3e43071626931fc004f70149baeba2c8ec672bd4f27761f8e1ad6b | |
| steps: | |
| - name: Install curl | |
| run: apk add --update curl | |
| - name: Install Syft | |
| run: curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin | |
| - name: Download artifact from previous build | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docker-image | |
| - name: Generate SBOM with Syft | |
| run: syft ./image.tar -o cyclonedx-json=sbom.json | |
| - name: Upload SBOM as an artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: sbom | |
| path: sbom.json | |
| sign-image: | |
| permissions: | |
| packages: write | |
| runs-on: ubuntu-latest | |
| needs: publish | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') | |
| steps: | |
| - name: cosign-installer | |
| uses: sigstore/cosign-installer@v3.3.0 | |
| with: | |
| cosign-release: 'v2.2.3' # optional | |
| - name: Download digest | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: digest | |
| path: . | |
| - name: Download image tag | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: image-tag | |
| path: . | |
| - name: Read digest and image tag from file | |
| run: | | |
| export IMAGE_DIGEST=$(cat digest.txt) | |
| echo "IMAGE_DIGEST=$IMAGE_DIGEST" >> $GITHUB_ENV | |
| export IMAGE_TAG=$(cat image-tag.txt) | |
| echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@v2.1.0 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Write signing key to disk (only needed for `cosign sign --key`) | |
| run: echo "${{ secrets.COSIGN_PRIVATE_KEY }}" > cosign.key | |
| - name: Sign the published Docker image | |
| env: | |
| COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }} | |
| run: cosign sign --yes --key cosign.key "$(cat image-tag.txt)@${{ env.IMAGE_DIGEST }}" | |
| sign-sbom: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| packages: write | |
| needs: publish | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') | |
| steps: | |
| - name: cosign-installer | |
| uses: sigstore/cosign-installer@v3.3.0 | |
| with: | |
| cosign-release: 'v2.2.3' # optional | |
| - name: Download digest | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: digest | |
| path: . | |
| - name: Download image tag | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: image-tag | |
| path: . | |
| - name: Download sbom tag | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: sbom | |
| path: . | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@v2.1.0 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Write signing key to disk (only needed for `cosign sign --key`) | |
| run: echo "${{ secrets.COSIGN_PRIVATE_KEY }}" > cosign.key | |
| - name: Sign SBOM | |
| run: cosign attest --yes --predicate ./sbom.json --key cosign.key "$(cat image-tag.txt)@$(cat digest.txt)" | |
| env: | |
| COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }} |