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

SSP Completeness Checks: 8 Illustrated Architecture and Narratives #811

Open
1 of 12 tasks
Tracked by #803
brian-ruf opened this issue Oct 23, 2024 · 4 comments
Open
1 of 12 tasks
Tracked by #803
Assignees
Labels
enhancement New feature or request

Comments

@brian-ruf
Copy link
Collaborator

brian-ruf commented Oct 23, 2024

This is a ...

fix - something needs to be different

This relates to ...

  • the Guide to OSCAL-based FedRAMP System Security Plans (SSP)
  • the FedRAMP SSP OSCAL Template (JSON or XML Format)
  • the FedRAMP OSCAL Validations

User Story

As a consumer of FedRAMP automated completeness checks I want the following OSCAL-based SSP items to be automatically verified for completeness by metaschema constraints:

  • At least one authorization boundary diagram
  • At least one authorization boundary description
  • At least one network diagram
  • At least one network description
  • At least one data flow diagram
  • At least one data flow description

Goals

SSP Completeness checks are defined, tested and documented

Dependencies

No response

Acceptance Criteria

  • All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • all constraints associated with the review task have been converted/created
  • automate.fedramp.gov content has been updated accordingly
  • the metaschema help prop has an appropriate link to the constraint
  • the template has an content that models the desired OSCAL presentation
  • the constraint runs against the example template
  • known-bad content has been created
  • the constraint appropriately flags the known-bad content as invalid

Other information

No response

TASKS

@brian-ruf brian-ruf added the enhancement New feature or request label Oct 23, 2024
@aj-stein-gsa aj-stein-gsa moved this from 🆕 New to 🔖 Ready in FedRAMP Automation Oct 31, 2024
@aj-stein-gsa
Copy link
Contributor

Check #881 and #882 for alignment with this issue.

Sorry when I spoke earlier I didn't see what epic you were talking about. I mean those in relation to the PPSM. I would like to review those in the context of #806.

I misunderstood your question. In the context of this diagrams epic, we need to talk about #864 and previous touchups from before that (but you will see in that PR).

@brian-ruf
Copy link
Collaborator Author

brian-ruf commented Nov 9, 2024

Example SSP content is being updated HERE.

Data Location Documentation Link Documentation Notes Example Updated
Boundary Diagram(s) //system-characteristics/authorization-boundary/diagram/link/@href https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#authorization-boundary update example to use actual UUIDs Y
Boundary Description //system-characteristics/authorization-boundary/description https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#authorization-boundary update example to use actual UUIDs Y
Network Diagram(s) //system-characteristics/network-architecture/diagram/link/@href https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#network-architecture update example to use actual UUIDs Y
Network Description //system-characteristics/network-architecture/description https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#network-architecture update example to use actual UUIDs Y
Data Flow Diagram(s) //system-characteristics/data-flow/diagram/link/@href https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#data-flow update example to use actual UUIDs Y
Data Flow Description //system-characteristics/data-flow/description https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#data-flow update example to use actual UUIDs Y

@brian-ruf
Copy link
Collaborator Author

brian-ruf commented Nov 9, 2024

the following is required by core OSCAL and requires no constraint:

  • //system-characteristics/authorization-boundary/description
  • //system-characteristics/network-architecture/description
  • //system-characteristics/data-flow/description

The following is optional under core OSCAL, but required by FedRAMP and require constraints:

  • //system-characteristics/authorization-boundary/diagram/link/@href
  • //system-characteristics/network-architecture/diagram/link/@href
  • //system-characteristics/data-flow/diagram/link/@href

For each of the above links, the following checks are required:

@brian-ruf brian-ruf self-assigned this Nov 12, 2024
@brian-ruf brian-ruf moved this from 🔖 Ready to 🏗 In progress in FedRAMP Automation Nov 12, 2024
@brian-ruf
Copy link
Collaborator Author

  • Each diagram has an associated description, which is also required, but enforced through core OSCAL as a require field, thus requires no FedRAMP constraint.

  • The following relevant constraints were previously defined and tracked in the constraint tracker:

    • has-authorization-boundary-diagram-link-href-target
    • has-network-architecture-diagram-link-href-target
    • has-data-flow-diagram-link-href-target

No constraint tasks need to be defined as existing constraint work in progress already addresses the necessary work.
The relevant tasks have been added to the core issue text above for tracking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants