From 38f7d371e31c45da40987fab4c8d8fafd9bfa962 Mon Sep 17 00:00:00 2001
From: Christian <96142828+chrisgocode@users.noreply.github.com>
Date: Wed, 5 Jun 2024 16:50:49 -0500
Subject: [PATCH] [PERF-324] OSSF Scorecard implementation (#104)

* Security policy

* Add OSSF Scorecard badge

* Add codeowners file

* Scorecard Workflow

* resolved requested changes
---
 .github/CODEOWNERS              |  1 +
 .github/workflows/scorecard.yml | 73 +++++++++++++++++++++++++++++++++
 README.md                       |  2 +
 SECURITY.md                     | 13 ++++++
 4 files changed, 89 insertions(+)
 create mode 100644 .github/CODEOWNERS
 create mode 100644 .github/workflows/scorecard.yml
 create mode 100644 SECURITY.md

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 00000000..53882861
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+.github/**/*    @ed-fi-exchange-oss/ed-fi-tech
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
new file mode 100644
index 00000000..ec364409
--- /dev/null
+++ b/.github/workflows/scorecard.yml
@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: Apache-2.0
+# Licensed to the Ed-Fi Alliance under one or more agreements.
+# The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+# See the LICENSE and NOTICES files in the project root for more information.
+
+# Originally sourced from GitHub with implicit lack of license
+
+name: Scorecard supply-chain security
+on:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '15 23 * * 0'
+  push:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          persist-credentials: false
+
+      - name: Run analysis
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
+        with:
+          results_file: scorecard.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          #repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: Upload artifact
+        uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0
+        with:
+          name: Scorecard SARIF file
+          path: scorecard.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: Upload to code-scanning
+        uses: github/codeql-action/upload-sarif@cf7e9f23492505046de9a37830c3711dd0f25bb3 # codeql-bundle-v2.16.2
+        with:
+          sarif_file: scorecard.sarif
diff --git a/README.md b/README.md
index 02da10b1..68bec507 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # Suite-3-Performance-Testing
 
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing)
+
 Performance testing framework for the Ed-Fi ODS technical suite 3, including the
 following test paths:
 
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..d340522d
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,13 @@
+# Security
+
+If you find a significant vulnerability, or evidence of one, please report it
+privately.
+
+We prefer that you use the [GitHub mechanism for privately reporting a
+vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability).
+Under the [main repository's security
+tab](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/security), click "Report a
+vulnerability" to open the advisory form.
+
+If you have any further concerns that are not addressed by this process, please
+submit a case through the [Ed-Fi Community Hub](https://success.ed-fi.org)