builder_nodejs_slsa3.yml

# 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: SLSA Node.js builder

permissions: {}

on:
  workflow_call:
    inputs:
      directory:
        description: "Sub-directory where package.json is located. Must be under the workspace."
        required: false
        type: string
        default: "."

      node-version:
        description: "Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0."
        required: false
        type: string

      node-version-file:
        description: "File containing the version Spec of the version to use.  Examples: .nvmrc, .node-version, .tool-versions."
        required: false
        type: string

      # NOTE: the additional inputs below are to support additional
      # functionality of the workflow.
      rekor-log-public:
        description: "Allow publication of your repository name on the public Rekor log"
        required: false
        type: boolean
        default: false

      run-scripts:
        description: "An ordered list of scripts from the package.json file to run (comma separated). Example value: 'script1, script2'"
        required: false
        type: string

    outputs:
      package-name:
        description: "The file name of the package tarball in the upload artifact."
        # NOTE: This is an "untrusted" value returned from the build.
        value: ${{ fromJSON(jobs.slsa-run.outputs.build-artifacts-outputs).package-filename }}

      package-download-name:
        description: "The name of the package artifact uploaded to the workflow run."
        # NOTE: This is an "untrusted" value returned from the build. Technically
        # the build could provide a package file that doesn't match the
        # provenance but it would fail validation.
        value: ${{ fromJSON(jobs.slsa-run.outputs.build-artifacts-outputs).package-download-name }}

      package-download-sha256:
        description: "The sha256 of the package artifact uploaded to the workflow run."
        # NOTE: This is an "untrusted" value returned from the build.
        value: ${{ fromJSON(jobs.slsa-run.outputs.build-artifacts-outputs).package-sha256 }}

      provenance-name:
        description: "The file name of the attestation upload artifact."
        # NOTE: This is an "untrusted" value returned from the build.
        value: ${{ fromJSON(jobs.slsa-run.outputs.build-artifacts-outputs).attestation-name }}

      provenance-download-name:
        description: "The name of the provenance attestation uploaded to the workflow run."
        value: ${{ jobs.slsa-run.outputs.attestations-download-name }}

      provenance-download-sha256:
        description: "The sha256 of the provenance attestation uploaded to the workflow run."
        value: ${{ jobs.slsa-run.outputs.attestations-download-sha256 }}

jobs:
  slsa-setup:
    permissions:
      id-token: write # For token creation.
    outputs:
      slsa-token: ${{ steps.generate.outputs.slsa-token }}
    runs-on: ubuntu-latest
    steps:
      - name: Generate the token
        id: generate
        uses: slsa-framework/slsa-github-generator/actions/delegator/setup-generic@v1.10.0
        with:
          slsa-workflow-recipient: "delegator_lowperms-generic_slsa3.yml"
          slsa-rekor-log-public: ${{ inputs.rekor-log-public }}
          slsa-runner-label: "ubuntu-latest"
          slsa-build-action-path: "./internal/builders/nodejs"
          slsa-version: "v0.2"
          slsa-workflow-inputs: ${{ toJson(inputs) }}

  slsa-run:
    needs: [slsa-setup]
    permissions:
      id-token: write # For signing.
      contents: read # For repo checkout of private repos.
      actions: read # For getting workflow run on private repos.
    uses: slsa-framework/slsa-github-generator/.github/workflows/delegator_lowperms-generic_slsa3.yml@v1.10.0
    with:
      slsa-token: ${{ needs.slsa-setup.outputs.slsa-token }}