Skip to content

Commit

Permalink
[DSOPS-315] OSSF Scorecard and Tech Doc Links (#231)
Browse files Browse the repository at this point in the history
* Change links to new Tech Docs

* Add a security file

* code owners file

* New scorecard action

* Explicitly set permissions

* Scorecard badge

* Codeowners correction
  • Loading branch information
stephenfuqua authored Apr 16, 2024
1 parent aeaff6a commit 4e3b834
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.github/**/* @Ed-Fi-Alliance-OSS/ed-fi-tech
3 changes: 3 additions & 0 deletions .github/workflows/on-pullrequest-security.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ on:
branches: [ main ]
workflow_dispatch:

permissions:
read-all

jobs:
scan-actions-bidi:
name: Scan Actions, scan all files for BIDI Trojan Attacks
Expand Down
68 changes: 68 additions & 0 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# 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
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Ed-Fi-Standard

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Ed-Fi-Alliance-OSS/Ed-Fi-Data-Standard/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Ed-Fi-Alliance-OSS/Ed-Fi-Data-Standard)

The Ed-Fi Data Standard serves as the foundation for enabling interoperability among secure education data systems.

For more information, see:

* [Ed-Fi Standards in Tech Docs](https://techdocs.ed-fi.org/display/ETKB/Ed-Fi+Standards)
* [How To: Get Technical Help or Provide Feedback](https://techdocs.ed-fi.org/display/ETKB/How+To%3A+Get+Technical+Help+or+Provide+Feedback)
* [Ed-Fi Standards in Tech Docs](https://edfi.atlassian.net/wiki/x/UIk_AQ)
* [How To: Get Technical Help or Provide Feedback](https://edfi.atlassian.net/wiki/x/P4Y_AQ)
* Review on-going development work in the [Ed-Fi Data Standard](https://tracker.ed-fi.org/projects/DATASTD/) project in Tracker

## Legal Information
Expand Down
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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-Alliance-OSS/Ed-Fi-Data-Standard/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)

0 comments on commit 4e3b834

Please sign in to comment.