@opengsd/gsd-core 1.2.0-rc.1

package/scripts/secret-scan.sh

@@ -0,0 +1,358 @@
+#!/usr/bin/env bash
+# secret-scan.sh — Check files for accidentally committed secrets/credentials
+#
+# Usage:
+#   scripts/secret-scan.sh --diff origin/main       # CI mode: scan changed files
+#   scripts/secret-scan.sh --file path/to/file      # Scan a single file
+#   scripts/secret-scan.sh --dir agents/            # Scan all files in a directory
+#   scripts/secret-scan.sh --diff origin/main --strict  # Strict/release mode
+#
+# Flags:
+#   --strict   Reduced-exclusion mode for release and security-audit CI lanes.
+#              Under --strict:
+#                - Grandfathered (un-annotated) .secretscanignore entries are
+#                  treated as FAILURES rather than silently honoured.
+#                - Exclusions whose 'expires' date is in the past are ignored
+#                  (the file IS scanned, not skipped).
+#              This flag does not change secret-detection logic — only which
+#              exclusions are applied.
+#
+# Exit codes:
+#   0 = clean
+#   1 = findings detected
+#   2 = usage error
+#
+# Annotation format for .secretscanignore (required for --strict compliance):
+#   # allow: <pattern>  reason="..."  owner="..."  expires="YYYY-MM-DD"  [rule-id="..."]
+#   <pattern>
+#
+# Design references:
+#   - GitGuardian exclusion annotation convention:
+#     https://docs.gitguardian.com/internal-repositories-monitoring/integrations/cli/secrets
+#   - CNCF Security TAG threat-model exception lifecycle:
+#     https://github.com/cncf/tag-security/blob/main/community/working-groups/threat-modeling/templates/threats.md
+#
+# Periodic reduced-exclusion scan procedure:
+#   Run this script with --strict on every release branch and during scheduled
+#   security reviews. This mode intentionally skips grandfathered entries and
+#   expired exclusions so that accumulated technical debt in the ignore-list
+#   cannot permanently hide secrets. See SECURITY.md for the audit runbook.
+set -euo pipefail
+
+# ─── Global mode flag ─────────────────────────────────────────────────────────
+STRICT_MODE=false
+
+# ─── Secret Patterns ─────────────────────────────────────────────────────────
+# Format: "LABEL:::REGEX"
+# Each entry is a human label paired with a POSIX extended regex.
+
+SECRET_PATTERNS=(
+  # AWS
+  "AWS Access Key:::AKIA[0-9A-Z]{16}"
+  "AWS Secret Key:::aws_secret_access_key[[:space:]]*=[[:space:]]*[A-Za-z0-9/+=]{40}"
+
+  # OpenAI / Anthropic / AI providers
+  "OpenAI API Key:::sk-[A-Za-z0-9]{20,}"
+  "Anthropic API Key:::sk-ant-[A-Za-z0-9_-]{20,}"
+
+  # GitHub
+  "GitHub PAT:::ghp_[A-Za-z0-9]{36}"
+  "GitHub OAuth:::gho_[A-Za-z0-9]{36}"
+  "GitHub App Token:::ghs_[A-Za-z0-9]{36}"
+  "GitHub Fine-grained PAT:::github_pat_[A-Za-z0-9_]{20,}"
+
+  # Stripe
+  "Stripe Secret Key:::sk_live_[A-Za-z0-9]{24,}"
+  "Stripe Publishable Key:::pk_live_[A-Za-z0-9]{24,}"
+
+  # Generic patterns
+  "Private Key Header:::-----BEGIN[[:space:]]+(RSA|EC|DSA|OPENSSH)?[[:space:]]*PRIVATE[[:space:]]+KEY-----"
+  "Generic API Key Assignment:::api[_-]?key[[:space:]]*[:=][[:space:]]*['\"][A-Za-z0-9_-]{20,}['\"]"
+  "Generic Secret Assignment:::secret[[:space:]]*[:=][[:space:]]*['\"][A-Za-z0-9_-]{20,}['\"]"
+  "Generic Token Assignment:::token[[:space:]]*[:=][[:space:]]*['\"][A-Za-z0-9_-]{20,}['\"]"
+  "Generic Password Assignment:::password[[:space:]]*[:=][[:space:]]*['\"][^'\"]{8,}['\"]"
+
+  # Slack
+  "Slack Bot Token:::xoxb-[0-9]{10,}-[A-Za-z0-9]{20,}"
+  "Slack Webhook:::hooks\.slack\.com/services/T[A-Z0-9]{8,}/B[A-Z0-9]{8,}/[A-Za-z0-9]{24}"
+
+  # Google
+  "Google API Key:::AIza[A-Za-z0-9_-]{35}"
+
+  # NPM
+  "NPM Token:::npm_[A-Za-z0-9]{36}"
+
+  # .env file content (key=value with sensitive-looking keys)
+  "Env Variable Leak:::(DATABASE_URL|DB_PASSWORD|REDIS_URL|MONGO_URI|JWT_SECRET|SESSION_SECRET|ENCRYPTION_KEY)[[:space:]]*=[[:space:]]*[^[:space:]]{8,}"
+)
+
+# ─── Ignorelist ──────────────────────────────────────────────────────────────
+#
+# Entries in IGNORED_FILES are loaded from .secretscanignore.
+# In --strict mode, only fully-annotated entries with a future 'expires' date
+# are loaded. Grandfathered entries and expired entries are skipped (the
+# corresponding files ARE scanned, not excluded).
+#
+# Annotation format (structured comment must immediately precede the path):
+#   # allow: <pattern>  reason="..."  owner="..."  expires="YYYY-MM-DD"  [rule-id="..."]
+#   <pattern>
+#
+# Entries without a structured annotation are grandfathered:
+#   - Default mode: accepted (file excluded), deprecation warning emitted
+#   - Strict mode: rejected (file scanned, no exclusion applied)
+
+IGNOREFILE=".secretscanignore"
+IGNORED_FILES=()
+
+# Returns value of key="value" annotation pair from a string
+_extract_annotation_key() {
+  local str="$1"
+  local key="$2"
+  echo "$str" | grep -oE "${key}=['\"][^'\"]+['\"]" | head -1 | sed "s/${key}=['\"]//;s/['\"]$//" || true
+}
+
+# Returns today as YYYY-MM-DD
+_today() {
+  date +%Y-%m-%d
+}
+
+# Returns 0 (true) if a date string YYYY-MM-DD is strictly in the past
+_date_is_past() {
+  local d="$1"
+  [[ "$d" < "$(_today)" ]]
+}
+
+load_ignorelist() {
+  if [[ ! -f "$IGNOREFILE" ]]; then
+    return
+  fi
+
+  local prev_comment=""
+
+  while IFS= read -r line || [[ -n "$line" ]]; do
+    # Empty line resets context
+    if [[ -z "${line// }" ]]; then
+      prev_comment=""
+      continue
+    fi
+
+    # Accumulate comment
+    if [[ "$line" =~ ^[[:space:]]*# ]]; then
+      prev_comment="$line"
+      continue
+    fi
+
+    # This is a path entry
+    local pattern="$line"
+
+    # Determine if preceding comment is a structured annotation
+    local is_structured=false
+    if [[ "$prev_comment" =~ ^#[[:space:]]+allow:[[:space:]] ]]; then
+      is_structured=true
+    fi
+
+    if [[ "$is_structured" == true ]]; then
+      # Parse structured annotation
+      local expires
+      expires=$(_extract_annotation_key "$prev_comment" "expires")
+
+      if [[ -n "$expires" ]] && _date_is_past "$expires"; then
+        # Expired exclusion — never apply, regardless of mode
+        echo "secret-scan: WARNING: exclusion '$pattern' has expired (expires=$expires) — entry ignored" >&2
+        prev_comment=""
+        continue
+      fi
+
+      # Valid structured annotation — always apply
+      IGNORED_FILES+=("$pattern")
+
+    else
+      # Grandfathered (plain comment or no comment)
+      if [[ "$STRICT_MODE" == true ]]; then
+        # Strict mode: do NOT apply grandfathered exclusion
+        echo "secret-scan: WARNING (--strict): grandfathered exclusion '$pattern' not applied" >&2
+      else
+        # Default mode: apply but warn
+        echo "secret-scan: DEPRECATION WARNING: '$pattern' has no structured annotation — grandfather applied" >&2
+        echo "  Migrate to: # allow: $pattern  reason=\"...\"  owner=\"...\"  expires=\"YYYY-MM-DD\"" >&2
+        IGNORED_FILES+=("$pattern")
+      fi
+    fi
+
+    prev_comment=""
+  done < "$IGNOREFILE"
+}
+
+is_ignored() {
+  local file="$1"
+  if [[ ${#IGNORED_FILES[@]} -eq 0 ]]; then
+    return 1
+  fi
+  for pattern in "${IGNORED_FILES[@]}"; do
+    # Support glob-style matching
+    # shellcheck disable=SC2254
+    case "$file" in
+      $pattern) return 0 ;;
+    esac
+  done
+  return 1
+}
+
+# ─── Skip Rules ──────────────────────────────────────────────────────────────
+
+should_skip_file() {
+  local file="$1"
+  # Skip binary files
+  case "$file" in
+    *.png|*.jpg|*.jpeg|*.gif|*.ico|*.woff|*.woff2|*.ttf|*.eot|*.otf) return 0 ;;
+    *.zip|*.tar|*.gz|*.bz2|*.xz|*.7z) return 0 ;;
+    *.pdf|*.doc|*.docx|*.xls|*.xlsx) return 0 ;;
+  esac
+  # Skip lockfiles and node_modules
+  case "$file" in
+    */node_modules/*) return 0 ;;
+    */package-lock.json) return 0 ;;
+    */yarn.lock) return 0 ;;
+    */pnpm-lock.yaml) return 0 ;;
+  esac
+  # Skip the scan scripts themselves and test files
+  case "$file" in
+    */secret-scan.sh) return 0 ;;
+    */secret-scan-lint.test.cjs) return 0 ;;
+    */security-scan.test.cjs) return 0 ;;
+    */security-prompt-injection.test.cjs) return 0 ;;
+    tests/fixtures/adversarial/security/*|*/tests/fixtures/adversarial/security/*) return 0 ;;
+  esac
+  return 1
+}
+
+# ─── File Collection ─────────────────────────────────────────────────────────
+
+collect_files() {
+  local mode="$1"
+  shift
+
+  case "$mode" in
+    --diff)
+      local base="${1:-origin/main}"
+      git diff --name-only --diff-filter=ACMR "$base"...HEAD 2>/dev/null \
+        | grep -vE '\.(png|jpg|jpeg|gif|ico|woff|woff2|ttf|eot|otf|zip|tar|gz|pdf)$' || true
+      ;;
+    --file)
+      if [[ -f "$1" ]]; then
+        echo "$1"
+      else
+        echo "Error: file not found: $1" >&2
+        exit 2
+      fi
+      ;;
+    --dir)
+      local dir="$1"
+      if [[ ! -d "$dir" ]]; then
+        echo "Error: directory not found: $dir" >&2
+        exit 2
+      fi
+      find "$dir" -type f ! -path '*/node_modules/*' ! -path '*/.git/*' ! -path '*/dist/*' \
+        ! -name '*.png' ! -name '*.jpg' ! -name '*.gif' ! -name '*.woff*' 2>/dev/null || true
+      ;;
+    --stdin)
+      cat
+      ;;
+    *)
+      echo "Usage: $0 --diff [base] | --file <path> | --dir <path> | --stdin" >&2
+      exit 2
+      ;;
+  esac
+}
+
+# ─── Scanner ─────────────────────────────────────────────────────────────────
+
+scan_file() {
+  local file="$1"
+  local found=0
+
+  if is_ignored "$file"; then
+    return 0
+  fi
+
+  for entry in "${SECRET_PATTERNS[@]}"; do
+    local label="${entry%%:::*}"
+    local pattern="${entry#*:::}"
+
+    local matches
+    matches=$(grep -nE -e "$pattern" "$file" 2>/dev/null || true)
+    if [[ -n "$matches" ]]; then
+      if [[ $found -eq 0 ]]; then
+        echo "FAIL: $file"
+        found=1
+      fi
+      echo "$matches" | while IFS= read -r line; do
+        echo "  [$label] $line"
+      done
+    fi
+  done
+
+  return $found
+}
+
+# ─── Main ────────────────────────────────────────────────────────────────────
+
+main() {
+  if [[ $# -eq 0 ]]; then
+    echo "Usage: $0 --diff [base] | --file <path> | --dir <path> [--strict]" >&2
+    exit 2
+  fi
+
+  # Parse --strict flag first (may appear anywhere in argv)
+  local remaining_args=()
+  for arg in "$@"; do
+    if [[ "$arg" == "--strict" ]]; then
+      STRICT_MODE=true
+    else
+      remaining_args+=("$arg")
+    fi
+  done
+  set -- "${remaining_args[@]}"
+
+  if [[ $# -eq 0 ]]; then
+    echo "Usage: $0 --diff [base] | --file <path> | --dir <path> [--strict]" >&2
+    exit 2
+  fi
+
+  load_ignorelist
+
+  local mode="$1"
+  shift
+
+  local files
+  files=$(collect_files "$mode" "$@")
+
+  if [[ -z "$files" ]]; then
+    echo "secret-scan: no files to scan"
+    exit 0
+  fi
+
+  local total=0
+  local failed=0
+
+  while IFS= read -r file; do
+    [[ -z "$file" ]] && continue
+    if should_skip_file "$file"; then
+      continue
+    fi
+    total=$((total + 1))
+    if ! scan_file "$file"; then
+      failed=$((failed + 1))
+    fi
+  done <<< "$files"
+
+  echo ""
+  echo "secret-scan: scanned $total files, $failed with findings"
+
+  if [[ $failed -gt 0 ]]; then
+    exit 1
+  fi
+  exit 0
+}
+
+main "$@"

package/scripts/setup-branch-protection.sh

@@ -0,0 +1,236 @@
+#!/usr/bin/env bash
+# setup-branch-protection.sh
+#
+# Apply branch protection rules to `main` and `next` for the GSD repo.
+# Idempotent — run as many times as you like. Re-running brings the live
+# rules back to what this script declares, so the script IS the source of
+# truth for branch protection.
+#
+# Usage:
+#   bash scripts/setup-branch-protection.sh             # apply both
+#   bash scripts/setup-branch-protection.sh main        # apply only main
+#   bash scripts/setup-branch-protection.sh next        # apply only next
+#   DRY_RUN=1 bash scripts/setup-branch-protection.sh   # show payloads, don't apply
+#
+# Requirements:
+#   - gh CLI authenticated against open-gsd/gsd-core with admin scope
+#   - jq installed
+#
+# What it sets:
+#
+#   main (strict — production):
+#     - 2 required approving reviews
+#     - dismiss stale reviews on push
+#     - require code-owner review when CODEOWNERS applies
+#     - all required status checks must pass (defined in REQUIRED_CHECKS_MAIN below)
+#     - require branches to be up to date before merging  (ON — `main` is production)
+#     - require linear history (OFF — release back-merges use merge commits)
+#     - require conversation resolution
+#     - require signed commits
+#     - block force-push and deletion
+#     - admins included
+#
+#   next (loose — integration):
+#     - 1 required approving review
+#     - dismiss stale reviews on push
+#     - require code-owner review when CODEOWNERS applies
+#     - all required status checks must pass (defined in REQUIRED_CHECKS_NEXT below)
+#     - require branches to be up to date before merging  (OFF — this is the whole point)
+#     - require linear history (OFF — auto-backmerge from main needs merge commits
+#       to preserve the link from next's history to main's release tags;
+#       feature PRs still squash-merge by repo merge-strategy setting)
+#     - require conversation resolution
+#     - require signed commits (OFF on next — easier for contributors)
+#     - block force-push and deletion
+#     - admins included
+#
+# See: docs/adr/XXXX-introduce-next-integration-branch.md
+# See: docs/branching.md
+
+set -euo pipefail
+
+REPO="${REPO:-open-gsd/gsd-core}"
+DRY_RUN="${DRY_RUN:-0}"
+
+# Required status checks. Adjust as your CI suite evolves.
+# The names must match the JOB NAME (not the workflow name) that GitHub
+# records — check existing PRs to confirm.
+REQUIRED_CHECKS_MAIN=(
+  "test"
+  "install-smoke"
+  "security-scan"
+  "Changeset Required / changeset-lint"
+  "Docs Required / docs-lint"
+  "PR Gate / size-check"
+  "Validate Branch Name / check-branch"
+)
+
+REQUIRED_CHECKS_NEXT=(
+  "test"
+  "PR Gate / size-check"
+  "Validate Branch Name / check-branch"
+  "Changeset Required / changeset-lint"
+  "Docs Required / docs-lint"
+  "PR Target Validator / validate-target"
+)
+
+require_cmd() {
+  command -v "$1" >/dev/null 2>&1 || {
+    echo "ERROR: missing required command: $1" >&2
+    exit 1
+  }
+}
+
+require_cmd gh
+require_cmd jq
+
+verify_auth() {
+  if ! gh auth status >/dev/null 2>&1; then
+    echo "ERROR: gh CLI is not authenticated. Run 'gh auth login' first." >&2
+    exit 1
+  fi
+}
+
+build_payload() {
+  local branch="$1"
+  shift
+  local checks_array=("$@")
+
+  # Branch-specific knobs.
+  local approvals require_up_to_date linear_history signed_commits
+  case "$branch" in
+    main)
+      approvals=2
+      require_up_to_date=true
+      linear_history=false
+      signed_commits=true
+      ;;
+    next)
+      approvals=1
+      require_up_to_date=false
+      # linear_history=false: auto-backmerge from main needs merge commits to
+      # preserve the link to release tags. Feature PRs still produce one
+      # commit each via repo-level "squash and merge" default — that gives
+      # us a clean log without enforcing linearity at the protection layer.
+      linear_history=false
+      signed_commits=false
+      ;;
+    *)
+      echo "ERROR: unknown branch '$branch'" >&2
+      exit 1
+      ;;
+  esac
+
+  # Build the contexts array via jq for safe quoting.
+  local contexts_json
+  contexts_json=$(printf '%s\n' "${checks_array[@]}" | jq -R . | jq -s .)
+
+  jq -n \
+    --argjson contexts "$contexts_json" \
+    --argjson approvals "$approvals" \
+    --argjson require_up_to_date "$require_up_to_date" \
+    --argjson linear_history "$linear_history" \
+    --argjson signed_commits "$signed_commits" \
+    '{
+      required_status_checks: {
+        strict: $require_up_to_date,
+        contexts: $contexts
+      },
+      enforce_admins: true,
+      required_pull_request_reviews: {
+        dismiss_stale_reviews: true,
+        require_code_owner_reviews: true,
+        required_approving_review_count: $approvals,
+        require_last_push_approval: false
+      },
+      restrictions: null,
+      required_linear_history: $linear_history,
+      allow_force_pushes: false,
+      allow_deletions: false,
+      required_conversation_resolution: true,
+      required_signatures: $signed_commits,
+      lock_branch: false,
+      allow_fork_syncing: true
+    }'
+}
+
+apply_protection() {
+  local branch="$1"
+  local checks_var_name
+  if [ "$branch" = "main" ]; then
+    checks_var_name="REQUIRED_CHECKS_MAIN"
+  else
+    checks_var_name="REQUIRED_CHECKS_NEXT"
+  fi
+
+  # Expand the array indirectly (bash 3 compatible — macOS default).
+  eval "local checks=(\"\${${checks_var_name}[@]}\")"
+
+  local payload
+  payload=$(build_payload "$branch" "${checks[@]}")
+
+  echo "──────────────────────────────────────────"
+  echo "Branch: $branch"
+  echo "Required checks (${#checks[@]}):"
+  printf '  - %s\n' "${checks[@]}"
+  echo "──────────────────────────────────────────"
+
+  if [ "$DRY_RUN" = "1" ]; then
+    echo "[DRY RUN] Would PUT to /repos/${REPO}/branches/${branch}/protection:"
+    echo "$payload" | jq .
+    return 0
+  fi
+
+  echo "Applying branch protection..."
+  echo "$payload" | gh api \
+    -X PUT \
+    -H "Accept: application/vnd.github+json" \
+    -H "X-GitHub-Api-Version: 2022-11-28" \
+    --input - \
+    "/repos/${REPO}/branches/${branch}/protection" \
+    >/dev/null
+  echo "✓ Protection rules applied to $branch."
+}
+
+ensure_branch_exists() {
+  local branch="$1"
+  if ! gh api "/repos/${REPO}/branches/${branch}" >/dev/null 2>&1; then
+    echo "ERROR: branch '$branch' does not exist in $REPO." >&2
+    if [ "$branch" = "next" ]; then
+      cat <<EOF >&2
+
+Create the next branch first:
+  git checkout main && git pull --ff-only
+  git checkout -b next && git push -u origin next
+
+Then re-run this script.
+EOF
+    fi
+    exit 1
+  fi
+}
+
+main() {
+  verify_auth
+
+  local targets=()
+  if [ $# -eq 0 ]; then
+    targets=(main next)
+  else
+    targets=("$@")
+  fi
+
+  for branch in "${targets[@]}"; do
+    if [ "$branch" != "main" ] && [ "$branch" != "next" ]; then
+      echo "ERROR: unsupported branch '$branch'. Use 'main' or 'next'." >&2
+      exit 1
+    fi
+    ensure_branch_exists "$branch"
+    apply_protection "$branch"
+  done
+
+  echo ""
+  echo "Done. To verify: gh api /repos/${REPO}/branches/<branch>/protection | jq ."
+}
+
+main "$@"