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

target examples in Profile Resolution selection and merge phase documentation #740

Closed
joshualubell opened this issue Aug 24, 2020 · 6 comments
Assignees
Labels
Milestone

Comments

@joshualubell
Copy link
Member

joshualubell commented Aug 24, 2020

The OSCAL Profile Resolution page provides examples of source profiles and their resolved targets resulting from selection and merge phases. These targets have elements such as <profile> and <selection> that are not allowed in the OSCAL catalog model.

Example:

<profile xmlns="http://csrc.nist.gov/ns/oscal/1.0" id="merge-keep_profile">
    <metadata> … </metadata>
    <selection id="…">
      <control id="a1"> … </control>
      <control id="c1"> … </control>
    </selection>
    <selection id="…">
      <control id="b1"> … </control>
    </selection>
</profile>

Is this a mistake in the documentation, or am I missing something?

@david-waltermire
Copy link
Contributor

@wendellpiez Can you answer this?

@wendellpiez
Copy link
Contributor

What is probably not clear enough -- it is expressed in the documentation, but apparently not well enough -- is that the tagging there is merely nominal for representing an internal (transitional) state in profile resolution. So not part of the model of either catalog or profile, but a sort of hybrid.

The fact that this question comes up tells me that the docs should probably be rewritten (maybe with some sort of specialized notation?) to show that some of these tags, such as selection here, are only "virtual".

I propose we mark this for attention when we next make an editorial pass over the Profile Resolution spec.

@david-waltermire david-waltermire added this to the OSCAL 1.1.0 milestone Nov 5, 2020
@iMichaela
Copy link
Contributor

@joshualubell -- I looked at the resolved profiles (few of them) and I do not find any elements such as and . Could you please check again, maybe the resolved profiles no longer contain assemblies not allowed in a catalog. If not, could you please provide a ling to the file? The documentation update remains an issue.

@wendellpiez
Copy link
Contributor

wendellpiez commented Nov 12, 2020

@iMichaela the critique is not with catalog resolution but with its documentation, where I invented a notational convention that confuses the reader as to the model. (Josh took a nominal representation of an intermediate state, to be a canonical representation of final state).

The document certainly needs work; in addition to this problem, the problem of specifying behaviors for "orphan" controls (enhancements without their parents, under different merge scenarios) needs to be specified fully, as @JustKuzya has pointed out.

I propose we flag this Issue as a work item for me to work on the Profile Resolution Specification (with advice from @david-waltermire-nist ).

@joshualubell
Copy link
Member Author

joshualubell commented Nov 12, 2020

@wendellpiez is correct. I had confused his intermediate representation with the OSCAL representation of a resolved profile. BTW, kudos for taking on the profile resolution documentation issue. I believe this is really important - especially now that 800-53r5 and 800-53B have adopted OSCAL.

Looking at the OSCAL stakeholder categories (Assessors, Baseline Authors, Security Professionals, Tool Developers), my guess is that only Tool Developers might need to understand the interim steps of profile resolution.

@david-waltermire
Copy link
Contributor

I believe this issue has been completed, since the inline examples in the spec have been updated. Closing this for now.

@joshualubell Can you review the current spec to make sure your concerns have been cleared up? If you have further concerns, please open a new issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants