OpenShell/tasks/scripts/trivy-scan.sh

#!/usr/bin/env bash

# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

set -euo pipefail

# `config` and `images` write full-severity reports and never fail on findings,
# then `gate` applies TRIVY_SEVERITY (default HIGH,CRITICAL).

REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
SOURCE_ROOT="${TRIVY_SOURCE_ROOT:-${REPO_ROOT}}"
IGNORE_FILE="${TRIVY_IGNORE_FILE:-${REPO_ROOT}/.trivyignore.yaml}"
cd "${SOURCE_ROOT}"

SEVERITY="${TRIVY_SEVERITY:-HIGH,CRITICAL}"
REPORT_DIR="${TRIVY_REPORT_DIR:-reports/trivy}"
IGNORE_UNFIXED="${TRIVY_IGNORE_UNFIXED:-true}"
PLATFORMS="${TRIVY_PLATFORMS:-linux/amd64 linux/arm64}"

# Disable cluster discovery while rendering charts offline.
PREFLIGHT_OFF=(--helm-set agentSandbox.preflight.enabled=false)

# These Dockerfiles do not produce release runtime images.
SKIP_DOCKERFILES=(
  --skip-files 'deploy/docker/Dockerfile.ci'
)

# Explicit OpenShell variants, including dev/E2E regression coverage.
# spire-stack belongs to the external SPIRE chart and is intentionally absent.
HELM_PROFILES=(
  cert-manager credential-driver-kubernetes-secrets credential-driver-vault
  gateway gateway-tls high-availability openshift-route-cert-manager spire
  tls-disabled workspace-managed workspace-operator
  corporate-proxy-e2e keycloak skaffold
)

# Reject ignore entries broader than one concrete basename.
validate_ignore_file() {
  [ -f "${IGNORE_FILE}" ] || {
    echo "Error: Trivy ignore file not found: ${IGNORE_FILE}" >&2
    return 2
  }

  command -v yq >/dev/null || {
    echo "Error: yq not on PATH; run inside 'nix develop'" >&2
    return 2
  }
  if ! yq --output-format json '.' "${IGNORE_FILE}" |
    jq -e '
      (.misconfigurations // []) as $entries
      | (($entries | type) == "array")
        and all($entries[];
          . as $entry
          | (($entry.id | type) == "string")
            and (($entry.paths | type) == "array")
            and (($entry.paths | length) > 0)
            and all($entry.paths[];
              . as $path
              | (($path | type) == "string")
                and ($path | startswith("**/"))
                and (($path | ltrimstr("**/") | length) > 0)
                and (($path | ltrimstr("**/") | test("[/*?\\[\\]]")) | not)
            )
        )
    ' >/dev/null; then
    echo "Error: every Trivy ignore must use at least one '**/<concrete-basename>' path" >&2
    return 2
  fi
}

# Convert a report whose targets already use repository-relative paths.
convert_sarif() {
  local report=$1 output=$2 category=$3
  trivy convert --quiet \
    --severity UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL --exit-code 0 \
    --format sarif --output "${output}" "${report}"
  # `convert` can set ROOTPATH to the input JSON file. Our targets are relative
  # to the checkout, not to the report file or the original scan directory.
  jq --arg automation_id "trivy/${category}/" '
    .runs[] |= (.automationDetails.id = $automation_id)
    | del(.runs[].originalUriBaseIds)
    | (.. | objects | select(has("artifactLocation")) | .artifactLocation)
      |= del(.uriBaseId)
    ' "${output}" >"${output}.tmp"
  mv "${output}.tmp" "${output}"
}

scan() {
  local subcommand=$1 slug=$2 prefix=$3
  shift 3

  echo "==> ${slug}"
  trivy "${subcommand}" --skip-version-check --quiet \
    --ignorefile "${IGNORE_FILE}" \
    --severity UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL --exit-code 0 \
    --format json --output "${REPORT_DIR}/${slug}.json" "$@"
  if [ -n "${prefix}" ]; then
    jq --arg prefix "${prefix}" --arg profile "${slug}" '
      .TrivyProfile = $profile
      | (.Results[]?.Target) |= $prefix + sub("^[^:]*\\.tgz:"; "")
    ' "${REPORT_DIR}/${slug}.json" >"${REPORT_DIR}/${slug}.json.tmp"
    mv "${REPORT_DIR}/${slug}.json.tmp" "${REPORT_DIR}/${slug}.json"
  fi
}

# Scan static deployment files once, then charts with their applicable values.
scan_config() {
  scan config config-static deploy/ "${SKIP_DOCKERFILES[@]}" \
    --skip-dirs deploy/helm deploy
  scan config config-defaults deploy/helm/ "${PREFLIGHT_OFF[@]}" deploy/helm

  local values fixture
  for fixture in "${HELM_PROFILES[@]}"; do
    values="deploy/helm/openshell/ci/values-${fixture}.yaml"
    if [ ! -f "${values}" ]; then
      # A newly added profile has no baseline report yet. A missing candidate
      # fixture is an error: intentional removal must also update HELM_PROFILES.
      [ "${SOURCE_ROOT}" != "${REPO_ROOT}" ] && continue
      echo "Error: Helm profile not found: ${values}" >&2
      return 2
    fi
    scan config "config-fixture-${fixture}" deploy/helm/openshell/ \
      "${PREFLIGHT_OFF[@]}" --helm-values "${values}" deploy/helm/openshell
  done
}

# A readable label plus the full reference hash avoids registry/tag collisions.
artifact_slug() {
  local digest
  digest="$(printf '%s' "$1" | sha256sum)"
  printf '%s-%s' "$(printf '%s' "${1##*/}" | tr -cs 'A-Za-z0-9._-' '-' | cut -c1-80)" "${digest%% *}"
}

# Trivy needs a local chart archive rather than an OCI reference.
scan_packaged_chart() {
  local ref=$1
  if [[ "${ref}" != *:* || "${ref##*/}" != *:* ]]; then
    echo "Error: --chart-ref needs a version tag, e.g. oci://host/chart:1.2.3" >&2
    exit 2
  fi

  local repo chart_name chart_dir="" candidate dir
  repo="${ref%:*}"
  chart_name="${repo##*/}"
  for candidate in deploy/helm/*/; do
    [ -f "${candidate}Chart.yaml" ] || continue
    [ "$(sed -n 's/^name:[[:space:]]*//p' "${candidate}Chart.yaml" | head -1)" \
      = "${chart_name}" ] || continue
    chart_dir="${candidate}"
    break
  done
  if [ -z "${chart_dir}" ]; then
    echo "Error: no chart under deploy/helm declares name '${chart_name}'" >&2
    exit 2
  fi

  dir="$(mktemp -d)"
  trap 'rm -rf "${dir}"' RETURN

  helm pull "${repo}" --version "${ref##*:}" --destination "${dir}"
  scan config "config-packaged-$(artifact_slug "${ref}")" "${chart_dir}" \
    "${PREFLIGHT_OFF[@]}" "$(find "${dir}" -name '*.tgz' -print -quit)"
}

scan_images() {
  local extra=()
  [ "${IGNORE_UNFIXED}" = "true" ] && extra+=(--ignore-unfixed)

  local image platform slug
  for image in "$@"; do
    for platform in ${PLATFORMS}; do
      slug="image-$(artifact_slug "${image}")-${platform//\//-}"
      scan image "${slug}" "" --platform "${platform}" --scanners vuln \
        "${extra[@]}" "${image}"
    done
  done
}

gate() {
  local report result findings=0

  if [ -z "$(find "${REPORT_DIR}" -maxdepth 1 -name '*.json' -print -quit)" ]; then
    echo "Error: no reports in ${REPORT_DIR}; run 'config' or 'images' first" >&2
    exit 2
  fi

  local reports=()
  if [ -f "${REPORT_DIR}/config-defaults.json" ]; then
    consolidate_config
    reports+=("${REPORT_DIR}/consolidated/config.json")
  fi
  for report in "${REPORT_DIR}"/image-*.json "${REPORT_DIR}"/config-packaged-*.json; do
    [ -f "${report}" ] && reports+=("${report}")
  done
  [ "${#reports[@]}" -gt 0 ] || { echo "Error: no complete scan reports" >&2; return 2; }

  for report in "${reports[@]}"; do
    set +e
    trivy convert --quiet --exit-code 10 --severity "${SEVERITY}" \
      --format table "${report}"
    result=$?
    set -e

    case "${result}" in
      0) ;;
      10) findings=1 ;;
      *)
        echo "Error: Trivy could not evaluate ${report} (exit ${result})" >&2
        return "${result}"
        ;;
    esac
  done

  if [ -n "${GITHUB_STEP_SUMMARY:-}" ]; then
    {
      echo "### Trivy (gate: \`${SEVERITY}\`)"
      echo '```'
      for report in "${reports[@]}"; do
        trivy convert --quiet --severity "${SEVERITY}" --format table "${report}"
      done
      echo '```'
    } >>"${GITHUB_STEP_SUMMARY}"
  fi

  [ "${findings}" -eq 0 ] || return 10
}

consolidate_config() {
  local report
  local reports=("${REPORT_DIR}/config-static.json" "${REPORT_DIR}/config-defaults.json")
  for report in "${REPORT_DIR}"/config-fixture-*.json; do
    [ -f "${report}" ] && reports+=("${report}")
  done
  mkdir -p "${REPORT_DIR}/consolidated"
  jq -s -f "${REPO_ROOT}/tasks/scripts/trivy-config-report.jq" \
    "${reports[@]}" >"${REPORT_DIR}/consolidated/config.json"
}

# Keep detailed reports for the differential gate, but publish one deduplicated
# configuration analysis. Images and packaged charts retain separate identities.
prepare_sarif() {
  local staging report slug batch=0 count=0
  staging="${REPORT_DIR}/code-scanning"
  if [ -e "${staging}" ]; then
    echo "Error: ${staging} already exists; use a fresh report directory" >&2
    return 2
  fi
  mkdir -p "${staging}/uploads/0"
  consolidate_config
  convert_sarif "${REPORT_DIR}/consolidated/config.json" "${staging}/uploads/0/config.sarif" config
  count=1
  for report in "${REPORT_DIR}"/image-*.json "${REPORT_DIR}"/config-packaged-*.json; do
    [ -f "${report}" ] || continue
    # upload-sarif combines a directory into one file; GitHub accepts at most
    # 20 runs per file. Every report produced here contains exactly one run.
    if [ "${count}" -eq 20 ]; then
      batch=$((batch + 1))
      count=0
      mkdir -p "${staging}/uploads/${batch}"
    fi
    slug="$(basename "${report}" .json)"
    convert_sarif "${report}" "${staging}/uploads/${batch}/${slug}.sarif" "${slug}"
    count=$((count + 1))
  done
  if [ -n "${GITHUB_OUTPUT:-}" ]; then
    printf 'batches=%s\n' "$(jq -cn --argjson last "${batch}" '[range(0; $last + 1) | tostring]')" \
      >>"${GITHUB_OUTPUT}"
  fi
}

collect_config_findings() {
  # Preserve report/profile identity while counting repeated findings.
  # With no reports, the unmatched glob makes jq fail on the missing input.
  jq -n --arg severities "${SEVERITY}" '
    [inputs
      | (input_filename | split("/")[-1] | rtrimstr(".json")) as $profile
      | if .SchemaVersion != 2
          or ((.ArtifactName | type) != "string")
          or ((.ArtifactType | type) != "string")
          or (.Results != null and ((.Results | type) != "array"))
        then
          error("invalid Trivy JSON report: " + $profile)
        else
          {
            profile: $profile,
            findings: ([
              .Results[]? as $result
              | $result.Misconfigurations[]?
              | .Severity as $severity
              | select(($severities | split(",") | index($severity)) != null)
              | ([
                  .ID,
                  $result.Target,
                  (.Namespace // ""),
                  (.Message // ""),
                  (.CauseMetadata.Provider // ""),
                  (.CauseMetadata.Service // ""),
                  (.CauseMetadata.Resource // "")
                ] | @json) as $semantic_key
              | {
                  key: ([$profile, $semantic_key] | @json),
                  semantic_key: $semantic_key,
                  profile: $profile,
                  severity: .Severity,
                  id: .ID,
                  target: $result.Target,
                  title: .Title
                }
            ]
            | group_by(.key)
            | map(.[0] + { count: length }))
          }
        end
    ] | {
      profiles: map(.profile),
      findings: (map(.findings) | add // [])
    }
  ' "$1"/*.json
}

# Compare semantic identities and occurrence counts, excluding line numbers.
gate_config_diff() (
  set -euo pipefail

  local baseline_dir=$1 candidate_dir=$2
  local inventory_dir baseline candidate new_findings finding_count
  inventory_dir="$(mktemp -d)"
  trap 'rm -rf "${inventory_dir}"' EXIT
  baseline="${inventory_dir}/baseline.json"
  candidate="${inventory_dir}/candidate.json"
  new_findings="${inventory_dir}/new.json"

  collect_config_findings "${baseline_dir}" >"${baseline}"
  collect_config_findings "${candidate_dir}" >"${candidate}"
  jq --slurpfile baseline "${baseline}" '
    ($baseline[0].findings | map({ (.key): .count }) | add // {}) as $by_profile
    | ($baseline[0].profiles) as $known_profiles
    | ($baseline[0].findings
      | group_by(.semantic_key)
      | map({
          key: .[0].semantic_key,
          value: (map(.count) | max)
        })
      | from_entries) as $across_profiles
    | [
        .findings[]
        | . as $finding
        | (if ($known_profiles | index($finding.profile)) != null
          then (($by_profile[$finding.key]) // 0)
          else (($across_profiles[$finding.semantic_key]) // 0)
          end) as $before
        | select(.count > $before)
        | . + { baseline_count: $before, new_count: (.count - $before) }
      ]
  ' "${candidate}" >"${new_findings}"

  finding_count="$(jq '[.[].new_count] | add // 0' "${new_findings}")"
  if [ "${finding_count}" -eq 0 ]; then
    echo "No new configuration findings at ${SEVERITY}."
    if [ -n "${GITHUB_STEP_SUMMARY:-}" ]; then
      echo "No new Trivy configuration findings at \`${SEVERITY}\`." \
        >>"${GITHUB_STEP_SUMMARY}"
    fi
    exit 0
  fi

  echo "::error::Trivy reported ${finding_count} new configuration finding(s) at ${SEVERITY}."
  jq -r '.[]
    | "::error::[\(.severity)] \(.id) in \(.profile) (\(.target)): \(.title)"
      + " (\(.new_count) new, \(.baseline_count) in baseline)"' \
    "${new_findings}"
  if [ -n "${GITHUB_STEP_SUMMARY:-}" ]; then
    {
      echo "### New Trivy configuration findings"
      echo
      jq -r '.[]
        | "- **\(.severity)** `\(.id)` in `\(.profile)`"
          + " (`\(.target)`): \(.title)"
          + " (\(.new_count) new, \(.baseline_count) in baseline)"' \
        "${new_findings}"
    } >>"${GITHUB_STEP_SUMMARY}"
  fi
  exit 10
)

require_trivy() {
  command -v trivy >/dev/null || {
    echo "Error: trivy not on PATH; run inside 'nix develop'" >&2
    exit 2
  }
}

case "${1:-}" in
  config)
    shift
    require_trivy
    validate_ignore_file
    mkdir -p "${REPORT_DIR}"
    scan_config
    # Reject unparsed arguments so requested charts cannot be silently skipped.
    while [ "${1:-}" = "--chart-ref" ]; do
      [ -n "${2:-}" ] || { echo "Error: --chart-ref needs a value" >&2; exit 2; }
      scan_packaged_chart "$2"
      shift 2
    done
    [ $# -eq 0 ] || { echo "Error: unexpected argument '$1' after config" >&2; exit 2; }
    ;;
  images)
    shift
    [ $# -gt 0 ] || { echo "Error: images needs at least one reference" >&2; exit 2; }
    require_trivy
    validate_ignore_file
    mkdir -p "${REPORT_DIR}"
    scan_images "$@"
    ;;
  gate)
    require_trivy
    gate
    ;;
  prepare-sarif)
    require_trivy
    prepare_sarif
    ;;
  gate-config-diff)
    shift
    [ $# -eq 2 ] || {
      echo "Error: gate-config-diff needs baseline and candidate report directories" >&2
      exit 2
    }
    gate_config_diff "$1" "$2"
    ;;
  validate-ignore)
    validate_ignore_file
    ;;
  *)
    cat >&2 <<'USAGE'
Usage:
  trivy-scan.sh config [--chart-ref <oci-ref>]...
  trivy-scan.sh images <image-ref> [<image-ref>...]
  trivy-scan.sh gate
  trivy-scan.sh prepare-sarif
  trivy-scan.sh gate-config-diff <baseline-reports> <candidate-reports>
  trivy-scan.sh validate-ignore
USAGE
    exit 2
    ;;
esac