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

Add imported-from relation to links in SSP #1023

Closed
5 tasks done
mruge opened this issue Sep 23, 2021 · 3 comments · Fixed by #1403
Closed
5 tasks done

Add imported-from relation to links in SSP #1023

mruge opened this issue Sep 23, 2021 · 3 comments · Fixed by #1403

Comments

@mruge
Copy link

mruge commented Sep 23, 2021

User Story:

To better document how components, capabilities, and controls all relate to one another. Additional pre-defined relation types would be useful. Although the Link assembly allows for arbitrary values some of the time, pre-defined acceptable values would provide users and tool developers better ability to make more universally compatible documents.

Adding additional values to the following Links would simplify importing and referencing source information for objects within the SSP

Goals:

  • Add imported-from as a accepted value in the ssp -> system implementation -> component -> link stanza. This relation is intended to represent the UUID and/or href back to the Component Definition that defined that component.

  • Add imported-from as a accepted value in the ssp -> Control implementation -> implemented requirements -> by-component -> link stanza. This relation is intended to represent the UUID and/or href back to the Component Definition that defined that control narrative.

Dependencies:

  • Enhancing 'link' to indicate internal targets in a 'resource' #756 is completed, as linking to the component-definition/@uuid and its original component/@uuid within need to be addressed at the same time with two different fields or a complex syntax in the one field that is not very ergonomic, @link at this time doesn't support that currently.

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

@david-waltermire
Copy link
Contributor

The second case of imported-from maybe should be named provided-by .as described in teh example we produced a few weeks back.

@iMichaela
Copy link
Contributor

iMichaela commented Oct 1, 2021

This issue is derived from the following scenario (schematically represented below):

system-implementation
- component[@uuid="app1",@type="software"]
  - link[@rel="depends-on", @href="storage1"]
- component[@uuid="storage1",@type="hardware"]
- component[@uuid="this-system",@type="this-system"]
- inventory-item[@uuid="inv1"]
  - implemented-component[@component-uuid="app1"]
  - implemented-component[@component-uuid="storage1"]
control-implementation
- implemented-requirements
  - control[@id="enc-1"]
    - by-component[@component-uuid="storage1"]
      - description: implementation narrative
    - by-component[@component-uuid="app1"]
      - link[@rel="provided-by", @href="storage1"]
      - description: encryption is provided by the storage array
  - control[@id="enc-2"]
    - by-component[@component-uuid="this-system"]
      - description: not needed
  - control[@id="enc-3"]
    - by-component[@component-uuid="storage1"]
      - description: is needed here
    - by-component[@component-uuid="app1"]
      - link[@rel="provided-by", @href="storage1"]
      - description: not needed

@david-waltermire david-waltermire self-assigned this Aug 1, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 4, 2022
This adds the new `/link/@rel` value of `imported-from` in the following
locations:

- `/system-security-plan/system implementation/component/link`
- `/system-security-plan/Control implementation/implemented requirements/link`
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 4, 2022
This adds the new `link/@rel` value of `imported-from` in the following
locations in the `system-security-plan`:

- `system-implementation/component/link`
- `control-implementation/implemented-requirements/link`
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 4, 2022
This adds the new `link/@rel` value of `imported-from` in the following
locations in the `system-security-plan`:

- `system-implementation/component/link`
- `control-implementation/implemented-requirements/link`
@aj-stein-nist aj-stein-nist linked a pull request Aug 4, 2022 that will close this issue
7 tasks
@aj-stein-nist
Copy link
Contributor

Talked with @david-waltermire-nist and team during weekly status meeting. We are going to break out the #756 dependency be implicit, not explicit, and removed from the deps section of the user story. I will update that issue accordingly to circle back and update the docs or code in the PR attached to that issue and circle back on this once merged.

aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 11, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 25, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Aug 29, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
david-waltermire added a commit that referenced this issue Aug 31, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Oct 6, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit that referenced this issue Oct 18, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
david-waltermire added a commit that referenced this issue Oct 31, 2022
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jan 10, 2023
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Feb 6, 2023
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL that referenced this issue Jun 29, 2023
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL that referenced this issue Jun 29, 2023
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jul 10, 2023
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
aj-stein-nist added a commit to galtm/OSCAL that referenced this issue Sep 28, 2023
Co-authored-by: David Waltermire <[email protected]>
Signed-off-by: Alexander Stein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment