Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content #11286

Merged
merged 5 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/workflows/update-oscal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Update vendored OSCAL content

on:
workflow_dispatch:
schedule:
# Run weekly at 05:00 on Sunday
- cron: "0 5 * * 0"
env:
NIST_REPO_REF: "690f517daaf3a6cbb4056d3cde6eae2756765620"
FEDRAMP_REPO_REF: "master"

jobs:
update-oscal:
name: Update content
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
strategy:
matrix:
variables:
- catalog-source: "https://raw.githubusercontent.com/usnistgov/oscal-content/${NIST_REPO_REF}/nist.gov/SP800-53/rev5/json/NIST_SP-800-53_rev5_catalog.json"
profile-source: "https://raw.githubusercontent.com/GSA/fedramp-automation/${FEDRAMP_REPO_REF}/dist/content/rev5/baselines/json/FedRAMP_rev5_HIGH-baseline_profile.json"
profile-name: "fedramp_rev5_high"
catalog-name: "nist_rev5_800_53"
- catalog-source: "https://raw.githubusercontent.com/usnistgov/oscal-content/${NIST_REPO_REF}/nist.gov/SP800-53/rev4/json/NIST_SP-800-53_rev4_catalog.json"
profile-source: "https://raw.githubusercontent.com/GSA/fedramp-automation/${FEDRAMP_REPO_REF}/dist/content/rev4/baselines/json/FedRAMP_rev4_HIGH-baseline_profile.json"
profile-name: "fedramp_rev4_high"
catalog-name: "nist_rev4_800_53"
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install python deps
run: pip3 install requests compliance-trestle==2.4.0
- name: Update catalogs
run: |
rm -rf "catalogs/${{ matrix.variables.catalog-name }}"
trestle import -f "${{ matrix.variables.catalog-source }}" -o "${{ matrix.variables.catalog-name }}"
working-directory: ./shared/references/oscal
- name: Update profiles
run: |
rm -rf "profiles/${{ matrix.variables.profile-name }}"
trestle import -f "${{ matrix.variables.profile-source }}" -o "${{ matrix.variables.profile-name }}"
trestle href --name "${{ matrix.variables.profile-name }}" -hr "trestle://catalogs/${{ matrix.variables.catalog-name }}/catalog.json"
working-directory: ./shared/references/oscal
- name: Update content
uses: peter-evans/[email protected]
with:
base: master
branch: "oscal-update-${{ github.run_id }}"
delete-branch: true
commit-message: "Update OSCAL content in shared/references/oscal"
title: "Update upstream OSCAL content from usnistogv and GSA"
body: |
Updates upstream OSCAL content
- usnistgov NIST 800-53 from "${{ matrix.variables.catalog-source }}"
- GSA FedRAMP OSCAL profiles from "${{ matrix.variables.profile-source }}"

Auto-generated by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also provide the path to this GitHub Actions file as well?

add-paths: |
shared/references/oscal/
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,6 @@ ocp4/profiles/test.profile
# Ignore coverage files
.coverage
coverage.xml

# Trestle specfic
shared/references/oscal/.trestle/cache
Empty file.
1 change: 1 addition & 0 deletions shared/references/oscal/.trestle/config.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# trestle config file
5 changes: 5 additions & 0 deletions shared/references/oscal/REAMDE.adoc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per the style guide please use Markdown unless there is a compelling reason.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed that detail in the guide. I will convert to Markdown.

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= OSCAL Content

This `oscal` directory contains a link:https://ibm.github.io/compliance-trestle/[compliance-trestle] managed workspace to import upstream catalog and profile content into generated link:https://pages.nist.gov/OSCAL-Reference/models/v1.1.1/component-definition/json-outline/[OSCAL Component Definition].


Loading
Loading