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

Syntax Modification: control/subcontrol #473

Closed
5 tasks done
brian-ruf opened this issue Aug 22, 2019 · 6 comments
Closed
5 tasks done

Syntax Modification: control/subcontrol #473

brian-ruf opened this issue Aug 22, 2019 · 6 comments
Assignees
Labels
enhancement Scope: Modeling Issues targeted at development of OSCAL formats User Story

Comments

@brian-ruf
Copy link
Contributor

brian-ruf commented Aug 22, 2019

User Story:

Most OSCAL users treat subcontrols as controls. Each is actually a functional requirement statement. The use of subcontrol clarifies a logical grouping of related controls. Treatment of control and subcontrol is nearly identical in documentation and automation; however, the use of different syntax requires constant adjustment/alignment of the correct reference (control vs. subcontrol).

We already allow groups within groups, and parts within parts. OSCAL would be simplified, if control enhancements were simply treated as controls within controls, thus replacing the subcontrol element with a nested control element.

This would also allow any depth of nested controls, similar to the way we allow any depth of nested parts.

Goals:

  • Simplify OSCAL catalog syntax by allowing "control" within "control", and using this construct instead of "subcontrol".
  • Update all models to remove/replace the subcontrol concept with a similar control concept.
  • Update all documentation to remove the concept of a control. Discuss parent and child controls instead.

Dependencies:

None

Acceptance Criteria

  • Metaschemas are adjusted to allow control within control.
  • Metaschemas are adjusted to remove subcontrol.
  • 800-53 catalog and associated baselines are adjusted to replace "subcontrol" with "control".
  • 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.
wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Aug 23, 2019
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 26, 2019
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 26, 2019
david-waltermire pushed a commit that referenced this issue Aug 27, 2019
* Schematron now reports duplicate definitions in a Metaschema as an error: see #465, #475

* Catalog metaschema and SP800-53 catalog adjustments renaming 'subcontrol' to 'control' per Issue #473

* Refactored metaschemas to avoid definition clashes; more/better Schematron to detect such clashes

* Adding new module now required by catalog and profile metaschemas

* Revising profiles to be valid to newly revised schema (no more references to subcontrol elements only controls)

* Bug fix in Metaschema Schematron

* Delete FedRAMP_HIGH-baseline_profile.xml

* Delete FedRAMP_LOW-baseline_profile.xml

* Delete FedRAMP_MODERATE-baseline_profile.xml

* Create temp.txt

* Revised FedRAMP Profiles

These files include revisions to the FedRAMP baselines, plus a small FedRAMP catalog that provides three subcontrols added by FedRAMP.

* Delete temp.txt

* moved updated fedramp content to correct location

* New and improved FedRAMP profiles

* Repaired broken markdown conversion; added missing title content to FedRAMP catalog

* add note about b -> strong and i -> em (#9)

* Changed inline markup in FedRAMP profiles for lossless conversion

* One more adjustment in Markdown->XML conversion (images)

* One more time (cleaning up cleanup)
@david-waltermire
Copy link
Contributor

The model changes have been merged in PR #476. The documentation changes remain undone.

@david-waltermire
Copy link
Contributor

We also need to complete updating the new SSP and component models.

@david-waltermire david-waltermire added the Scope: Modeling Issues targeted at development of OSCAL formats label Sep 4, 2019
@iMichaela
Copy link
Contributor

9/5/2019

Issue was implemented and is part of PR #476, waiting for @david-waltermire-nist and @brianrufgsa. Schema documentation needs to be reviewed.

@david-waltermire
Copy link
Contributor

@wendellpiez Although the schema and content changes were made, we still need to update the website documentation to reflect the deletion of subcontrol. We need a new PR for this.

@wendellpiez
Copy link
Contributor

Worked through documentation yesterday. References to subcontrols still appear in WIP SSP and Component models, to be resolved. Otherwise things are looking more reasonable. The changes are now in the issue-468-364-478-integration working branch.

Suggest we do one more grep for subcontrol once the models are stable for this Sprint.

@david-waltermire
Copy link
Contributor

This was completed in PR #492.

bradh pushed a commit to bradh/OSCAL that referenced this issue Dec 4, 2019
* Schematron now reports duplicate definitions in a Metaschema as an error: see usnistgov#465, usnistgov#475

* Catalog metaschema and SP800-53 catalog adjustments renaming 'subcontrol' to 'control' per Issue usnistgov#473

* Refactored metaschemas to avoid definition clashes; more/better Schematron to detect such clashes

* Adding new module now required by catalog and profile metaschemas

* Revising profiles to be valid to newly revised schema (no more references to subcontrol elements only controls)

* Bug fix in Metaschema Schematron

* Delete FedRAMP_HIGH-baseline_profile.xml

* Delete FedRAMP_LOW-baseline_profile.xml

* Delete FedRAMP_MODERATE-baseline_profile.xml

* Create temp.txt

* Revised FedRAMP Profiles

These files include revisions to the FedRAMP baselines, plus a small FedRAMP catalog that provides three subcontrols added by FedRAMP.

* Delete temp.txt

* moved updated fedramp content to correct location

* New and improved FedRAMP profiles

* Repaired broken markdown conversion; added missing title content to FedRAMP catalog

* add note about b -> strong and i -> em (usnistgov#9)

* Changed inline markup in FedRAMP profiles for lossless conversion

* One more adjustment in Markdown->XML conversion (images)

* One more time (cleaning up cleanup)
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jan 25, 2023
* Schematron now reports duplicate definitions in a Metaschema as an error: see usnistgov#465, usnistgov#475

* Catalog metaschema and SP800-53 catalog adjustments renaming 'subcontrol' to 'control' per Issue usnistgov#473

* Refactored metaschemas to avoid definition clashes; more/better Schematron to detect such clashes

* Adding new module now required by catalog and profile metaschemas

* Revising profiles to be valid to newly revised schema (no more references to subcontrol elements only controls)

* Bug fix in Metaschema Schematron

* Delete FedRAMP_HIGH-baseline_profile.xml

* Delete FedRAMP_LOW-baseline_profile.xml

* Delete FedRAMP_MODERATE-baseline_profile.xml

* Create temp.txt

* Revised FedRAMP Profiles

These files include revisions to the FedRAMP baselines, plus a small FedRAMP catalog that provides three subcontrols added by FedRAMP.

* Delete temp.txt

* moved updated fedramp content to correct location

* New and improved FedRAMP profiles

* Repaired broken markdown conversion; added missing title content to FedRAMP catalog

* add note about b -> strong and i -> em (#9)

* Changed inline markup in FedRAMP profiles for lossless conversion

* One more adjustment in Markdown->XML conversion (images)

* One more time (cleaning up cleanup)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Scope: Modeling Issues targeted at development of OSCAL formats User Story
Projects
None yet
Development

No branches or pull requests

4 participants