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.

Sign up for GitHub

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

Jump to bottom

Merging controls from multiple catalogs in (viewing) a profile #67

Closed
wendellpiez opened this issue Nov 16, 2017 · 11 comments
Closed

Merging controls from multiple catalogs in (viewing) a profile #67

wendellpiez opened this issue Nov 16, 2017 · 11 comments
Assignees
@wendellpiez @kscarf1
Labels
LoE: Large User Story
Projects
Sprint 6
Milestone
OSCAL 1.0 Milesto...

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Nov 16, 2017 •
edited by akarmel
Loading

At time of writing, rendered profiles show their controls "split" by invocation, rather than in a single unified view. Users probably expect a unified view.

Goals

Provide a view onto single unified hierarchy even when multiple control catalogs are called. (Only viewing is in scope, not editing. That is, only the rendered HTML results must show a unified hierarchy, not any OSCAL preliminary to that.)

Background

Currently, when a profile calls in controls, its resolved results (that is, the catalog that comes back from recursively resolving any profiles/catalogs invoked, given the delta provided by the invoking profile) are rendered in separate branches (sections) of a single resolved "expanded catalog" (actually a framework underneath). But one would ordinarily expect to see all the controls together in a single hierarchy reflecting their hierarchies of origin -- not split out according to how they were invoked.

An example can be seen in almost any rendering of an OSCAL profile that calls in controls from multiple profiles resolving back to the same catalog, such as the FedRAMP LOW profile, which combines calls to the SP800-53 'base' catalog and its Low Baseline (which resolves back to the base).

Dependencies

  • Examples such as the FedRAMP profile, that illustrate the problem

Acceptance Criteria

  • A view that shows the various controls together in a single "correct" hierarchy rather than split across the invocations
  • A reusable approach can be articulated for addressing this problem, along with reusable code to the extent possible
  • Documentation that describes how to interpret a profile that combines multiple control catalogs and/or multiple references to the same control

Developer's note: the means to the goal might not be "merge" logic so much as logic that regroups all controls into the organization implied by their prop[@class='name'].
@wendellpiez
Copy link
Contributor Author

Also note: is it sufficient to perform the merge only in rendition: shouldn't (or doesn't) this affect how resolution occurs? (That is, does the intermediate "resolved/expanded catalog" have to show the merged organization or can it as at present reflect its provenance or "chain of custody"?)

This was referenced Nov 21, 2017
Closed
Closed
@wendellpiez
Copy link
Contributor Author

Michaela observes (Sprint Acceptance mtg 11/28) that actually, the source of a particular control in a profile (that is, the profile or catalog from which it derives, i.e. 'chain of custody') is information of interest and shouldn't be freely discarded. This suggests that no merge should be automatic or "blind" -- and that merges might also need to be configurable. (Also, a merger might annotate the merged results with provenance info?)

@akarmel akarmel added this to Planning in Sprint 6 Nov 30, 2017
@akarmel
Copy link
Contributor

akarmel commented Dec 5, 2017

Sprint 6 Progress Notes

  • Wendell got started on this yesterday (12/4) and several prose documents have been created for review in docs/prose. Wendell and David will collaboratively review today (12/5).

@akarmel akarmel assigned kscarf1 and unassigned kscarfone Dec 5, 2017
@kscarf1
Copy link
Contributor

kscarf1 commented Dec 12, 2017

I discussed this with Wendell late last week, and he recommended that I wait on this. He is still making significant additions and revisions to the draft documents. I will coordinate with him on the best time to begin my review.

@akarmel
Copy link
Contributor

akarmel commented Dec 12, 2017

Sprint 6 Progress Notes

  • Specification documentation 2/3 of the way complete in Draft format. Doc is in the Sprint 6 branch.
  • David and Wendell will review together and will loop in Karen moving forward for review.

@akarmel akarmel moved this from Planning to In Progress in Sprint 6 Dec 12, 2017
@akarmel
Copy link
Contributor

akarmel commented Dec 19, 2017

Sprint 6 Progress Notes

  • Have a clearer understanding of our emerging requirements which has led to significant structural improvements to the profile model which are underway
    • Working towards a model where we have three containers in the profile:
      1. Select what controls are included from other reference profiles/catalogs
      2. Add directives that would change the default behavior
      3. Other customizations (local updates to controls - patching, static parameters)
    • Updates to this model will add growing room to add new features
    • Resolution logic must be updated as well
  • Wendell expects to have these updates done within the week

@kscarf1
Copy link
Contributor

kscarf1 commented Dec 21, 2017

Dave, Wendell, and I discussed the status of this today. Wendell is working on the first draft and expects to be done by the end of December. At that time he'll notify me and I will edit the draft, contacting him with any questions I have.

@kscarf1
Copy link
Contributor

kscarf1 commented Jan 9, 2018

No update on this. I'll check with Wendell when he returns from travel.

@akarmel
Copy link
Contributor

akarmel commented Jan 11, 2018

Sprint 6 Acceptance

  • Revised implementation to the new model, everything is stable again
    • Modeling issue has been identified that requires David's review and feedback

@akarmel
Copy link
Contributor

akarmel commented Jan 17, 2018 •
edited
Loading

Sprint 7 Planning

@akarmel akarmel mentioned this issue Jan 17, 2018
Closed
@akarmel
Copy link
Contributor

akarmel commented Jan 17, 2018

Closing this issue as it is now broken into three new issues: #93, #94, #95

@akarmel akarmel closed this as completed Jan 17, 2018
@akarmel akarmel moved this from In Progress to Completed in Sprint 6 Jan 17, 2018
david-waltermire added a commit that referenced this issue Apr 3, 2018
@david-waltermire
# This is a combination of 29 commits.
5b13d9d 
# The first commit's message is:

# This is a combination of 54 commits.
# The first commit's message is:

# This is a combination of 4 commits.
# The first commit's message is:

# This is a combination of 2 commits.
# The first commit's message is:

# This is a combination of 2 commits.
# The first commit's message is:

# This is a combination of 6 commits.
# The first commit's message is:

# This is a combination of 3 commits.
# The first commit's message is:

# This is a combination of 111 commits.
# The first commit's message is:

Initial commit of docs branch.

# This is the commit message #2:

Create CONTRIBUTING.md
# This is the commit message #3:

Create ROADMAP.md
# This is the commit message #4:

Update README.md
# This is the commit message #5:

Create README.md
# This is the commit message #6:

Update README.md
# This is the commit message #7:

Update README.md
# This is the commit message #8:

Create OSCAL-PRODUCERS.md
# This is the commit message #9:

Create OSCAL-CONSUMERS.md
# This is the commit message #10:

Update and rename OSCAL-CONSUMERS.md to USERS.md
# This is the commit message #11:

Update and rename OSCAL-PRODUCERS.md to IMPLEMENTERS.md
# This is the commit message #12:

Rename CONTRIBUTING.md to CONTRIBUTORS.md
# This is the commit message #13:

Update README.md
# This is the commit message #14:

Update README.md
# This is the commit message #15:

Update USERS.md
# This is the commit message #16:

Update README.md
# This is the commit message #17:

Update IMPLEMENTERS.md
# This is the commit message #18:

Update README.md
# This is the commit message #19:

Update ROADMAP.md
# This is the commit message #20:

Update USERS.md
# This is the commit message #21:

Update CONTRIBUTORS.md
# This is the commit message #22:

Update README.md
# This is the commit message #23:

Update README.md
# This is the commit message #24:

Update IMPLEMENTERS.md
# This is the commit message #25:

Update IMPLEMENTERS.md
# This is the commit message #26:

Rename CONTRIBUTORS.md to CONTRIBUTING.md
# This is the commit message #27:

Create control.md
# This is the commit message #28:

Update control.md
# This is the commit message #29:

Update control.md
# This is the commit message #30:

Update control.md
# This is the commit message #31:

Update control.md
# This is the commit message #32:

Add files via upload
# This is the commit message #33:

Update control.md
# This is the commit message #34:

Create temp.md
# This is the commit message #35:

Delete NIST-SP-800-53-Rev4-AC1.png
# This is the commit message #36:

Add files via upload
# This is the commit message #37:

Delete temp.md
# This is the commit message #38:

Add files via upload
# This is the commit message #39:

Update control.md
# This is the commit message #40:

Add files via upload
# This is the commit message #41:

Add files via upload
# This is the commit message #42:

Update control.md
# This is the commit message #43:

Update CONTRIBUTING.md
# This is the commit message #44:

Update CONTRIBUTING.md
# This is the commit message #45:

Update USERS.md
# This is the commit message #46:

Update CONTRIBUTING.md
# This is the commit message #47:

Delete CONTRIBUTING.md
# This is the commit message #48:

Delete USERS.md
# This is the commit message #49:

Add files via upload
# This is the commit message #50:

Delete CSA-CCM-IAM02.png
# This is the commit message #51:

Update control.md
# This is the commit message #52:

Update control.md
# This is the commit message #53:

Update control.md
# This is the commit message #54:

Update control.md
# This is the commit message #55:

Update control.md
# This is the commit message #56:

Update control.md
# This is the commit message #57:

Update control.md
# This is the commit message #58:

Update control.md
# This is the commit message #59:

Update control.md
# This is the commit message #60:

Update control.md
# This is the commit message #61:

Delete NIST-SP-800-53-AC1-in-OSCAL-XML.png
# This is the commit message #62:

Update README.md
# This is the commit message #63:

Update control.md
# This is the commit message #64:

Update control.md
# This is the commit message #65:

Add files via upload
# This is the commit message #66:

Delete ISO-27001-Control-A9.png
# This is the commit message #67:

Update control.md
# This is the commit message #68:

Add files via upload
# This is the commit message #69:

Add files via upload
# This is the commit message #70:

Delete ISO-27002-Control-9.1.1-part1.png
# This is the commit message #71:

Delete ISO-27002-Control-9.1.1-part2.png
# This is the commit message #72:

Update control.md
# This is the commit message #73:

Update control.md
# This is the commit message #74:

Update control.md
# This is the commit message #75:

Update control.md
# This is the commit message #76:

Update control.md
# This is the commit message #77:

Update README.md
# This is the commit message #78:

Update IMPLEMENTERS.md
# This is the commit message #79:

Add files via upload
# This is the commit message #80:

Delete oscal-layers.png
# This is the commit message #81:

Add files via upload
# This is the commit message #82:

Delete oscal-layers.png
# This is the commit message #83:

Add files via upload
# This is the commit message #84:

Update IMPLEMENTERS.md
# This is the commit message #85:

Update control.md
# This is the commit message #86:

Update IMPLEMENTERS.md
# This is the commit message #87:

Update control.md
# This is the commit message #88:

Rename IMPLEMENTERS.md to docs/prose/IMPLEMENTERS.md
# This is the commit message #89:

Rename IMPLEMENTERS.md to implementers.md
# This is the commit message #90:

Rearranged and outlined catalog documentation based on the conversation with karen and Wendell.

# This is the commit message #91:

Create catalog-xml.md
# This is the commit message #92:

Rename control.md to catalog.md
# This is the commit message #93:

Update catalog.md
# This is the commit message #94:

Update catalog.md
# This is the commit message #95:

Update catalog.md
# This is the commit message #96:

Update catalog-xml.md
# This is the commit message #97:

Update catalog-xml.md
# This is the commit message #98:

Update catalog-xml.md
# This is the commit message #99:

Update catalog-xml.md
# This is the commit message #100:

Update catalog-xml.md
# This is the commit message #101:

Update catalog-xml.md
# This is the commit message #102:

Update catalog-xml.md
# This is the commit message #103:

Update catalog-xml.md
# This is the commit message #104:

Update catalog-xml.md
# This is the commit message #105:

Update catalog-xml.md
# This is the commit message #106:

Docset migration to Slate

# This is the commit message #107:

Removing unused file.

# This is the commit message #108:

Update README.md

Corrected a typo
# This is the commit message #109:

Add files via upload

Graphical representation of OSCAL schemas aligned with Risk Management Framework steps and tasks.
# This is the commit message #110:

Create CONTRIBUTING.md
# This is the commit message #111:

Create ROADMAP.md
# This is the commit message #2:

Create README.md
# This is the commit message #3:

Update README.md
# This is the commit message #2:

Create OSCAL-PRODUCERS.md
# This is the commit message #3:

Create OSCAL-CONSUMERS.md
# This is the commit message #4:

Update and rename OSCAL-CONSUMERS.md to USERS.md
# This is the commit message #5:

Update and rename OSCAL-PRODUCERS.md to IMPLEMENTERS.md
# This is the commit message #6:

Rename CONTRIBUTING.md to CONTRIBUTORS.md
# This is the commit message #2:

Update USERS.md
# This is the commit message #2:

Update IMPLEMENTERS.md
# This is the commit message #2:

Update ROADMAP.md
# This is the commit message #3:

Update USERS.md
# This is the commit message #4:

Update CONTRIBUTORS.md
# This is the commit message #2:

Update IMPLEMENTERS.md
# This is the commit message #3:

Update IMPLEMENTERS.md
# This is the commit message #4:

Rename CONTRIBUTORS.md to CONTRIBUTING.md
# This is the commit message #5:

Create control.md
# This is the commit message #6:

Update control.md
# This is the commit message #7:

Update control.md
# This is the commit message #8:

Update control.md
# This is the commit message #9:

Update control.md
# This is the commit message #10:

Add files via upload
# This is the commit message #11:

Update control.md
# This is the commit message #12:

Create temp.md
# This is the commit message #13:

Delete NIST-SP-800-53-Rev4-AC1.png
# This is the commit message #14:

Add files via upload
# This is the commit message #15:

Delete temp.md
# This is the commit message #16:

Add files via upload
# This is the commit message #17:

Update control.md
# This is the commit message #18:

Add files via upload
# This is the commit message #19:

Add files via upload
# This is the commit message #20:

Update control.md
# This is the commit message #21:

Update CONTRIBUTING.md
# This is the commit message #22:

Update CONTRIBUTING.md
# This is the commit message #23:

Update USERS.md
# This is the commit message #24:

Update CONTRIBUTING.md
# This is the commit message #25:

Delete CONTRIBUTING.md
# This is the commit message #26:

Delete USERS.md
# This is the commit message #27:

Add files via upload
# This is the commit message #28:

Delete CSA-CCM-IAM02.png
# This is the commit message #29:

Update control.md
# This is the commit message #30:

Update control.md
# This is the commit message #31:

Update control.md
# This is the commit message #32:

Update control.md
# This is the commit message #33:

Update control.md
# This is the commit message #34:

Update control.md
# This is the commit message #35:

Update control.md
# This is the commit message #36:

Update control.md
# This is the commit message #37:

Update control.md
# This is the commit message #38:

Update control.md
# This is the commit message #39:

Delete NIST-SP-800-53-AC1-in-OSCAL-XML.png
# This is the commit message #40:

Update README.md
# This is the commit message #41:

Update control.md
# This is the commit message #42:

Update control.md
# This is the commit message #43:

Add files via upload
# This is the commit message #44:

Delete ISO-27001-Control-A9.png
# This is the commit message #45:

Update control.md
# This is the commit message #46:

Add files via upload
# This is the commit message #47:

Add files via upload
# This is the commit message #48:

Delete ISO-27002-Control-9.1.1-part1.png
# This is the commit message #49:

Delete ISO-27002-Control-9.1.1-part2.png
# This is the commit message #50:

Update control.md
# This is the commit message #51:

Update control.md
# This is the commit message #52:

Update control.md
# This is the commit message #53:

Update control.md
# This is the commit message #54:

Update control.md
# This is the commit message #2:

Update IMPLEMENTERS.md
# This is the commit message #3:

Add files via upload
# This is the commit message #4:

Delete oscal-layers.png
# This is the commit message #5:

Add files via upload
# This is the commit message #6:

Delete oscal-layers.png
# This is the commit message #7:

Add files via upload
# This is the commit message #8:

Update IMPLEMENTERS.md
# This is the commit message #9:

Update control.md
# This is the commit message #10:

Update IMPLEMENTERS.md
# This is the commit message #11:

Update control.md
# This is the commit message #12:

Rename IMPLEMENTERS.md to docs/prose/IMPLEMENTERS.md
# This is the commit message #13:

Rename IMPLEMENTERS.md to implementers.md
# This is the commit message #14:

Rearranged and outlined catalog documentation based on the conversation with karen and Wendell.

# This is the commit message #15:

Create catalog-xml.md
# This is the commit message #16:

Rename control.md to catalog.md
# This is the commit message #17:

Update catalog.md
# This is the commit message #18:

Update catalog.md
# This is the commit message #19:

Update catalog.md
# This is the commit message #20:

Update catalog-xml.md
# This is the commit message #21:

Update catalog-xml.md
# This is the commit message #22:

Update catalog-xml.md
# This is the commit message #23:

Update catalog-xml.md
# This is the commit message #24:

Update catalog-xml.md
# This is the commit message #25:

Update catalog-xml.md
# This is the commit message #26:

Update catalog-xml.md
# This is the commit message #27:

Update catalog-xml.md
# This is the commit message #28:

Update catalog-xml.md
# This is the commit message #29:

Fixed typos, updated repo documentation, and migrated documentation for use in Slate.

Corrected a typo (+4 squashed commit)

Squashed commit:

[6ada57f] Removing unused file.

[503ad71] Docset migration to Slate

[351257e] Update catalog-xml.md

[aae1e8b] Add files via upload

Graphical representation of OSCAL schemas aligned with Risk Management Framework steps and tasks.
@david-waltermire david-waltermire added this to the OSCAL 1.0 M1 milestone Apr 6, 2018
wendellpiez referenced this issue in wendellpiez/OSCAL May 21, 2021
@wendellpiez
Changes to OSCAL metaschemas in view of enhancements addressing usnis…
b8b5d2f 
…tgov#805, usnistgov#911, #67, #68
david-waltermire pushed a commit that referenced this issue May 21, 2021
@wendellpiez
Metaschema enhancements to string-based datatypes (#936)
82ec272 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing #805, #911, #67, #868.
david-waltermire pushed a commit that referenced this issue May 27, 2021
@wendellpiez
Metaschema updates for v1.0.0 (#942)
d88194c 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing #805, #911, #67, #68
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema enhancements to string-based datatypes (usnistgov#936)
b736023 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#868.
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (usnistgov#942)
93a0ec2 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#68
david-waltermire pushed a commit that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema enhancements to string-based datatypes (#936)
99f6ed9 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing #805, #911, #67, #868.
david-waltermire pushed a commit that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (#942)
3643196 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing #805, #911, #67, #68
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (usnistgov#942)
afebea5 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#68
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (usnistgov#942)
636ab72 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#68
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (usnistgov#942)
d912972 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#68
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (usnistgov#942)
86ee953 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#68
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue May 27, 2021
@wendellpiez @david-waltermire
Metaschema updates for v1.0.0 (usnistgov#942)
33783f9 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing usnistgov#805, usnistgov#911, usnistgov#67, usnistgov#68
david-waltermire pushed a commit that referenced this issue Jun 7, 2021
@wendellpiez @david-waltermire
Metaschema enhancements to string-based datatypes (#936)
c98b2a8 
* Adjusted metaschemas: new 'version'; json-base-uri
* Added 'complete' metaschema
* Changes to OSCAL metaschemas in view of enhancements addressing #805, #911, #67, #868.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wendellpiez wendellpiez

@kscarf1 kscarf1

Labels
LoE: Large User Story
Projects
No open projects
Sprint 6
Completed
Milestone
OSCAL 1.0 Milestone 1
Development

No branches or pull requests
5 participants
@wendellpiez @david-waltermire @kscarfone @akarmel @kscarf1