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

Define function (library) for OSCAL document set(s) #114

Closed
3 tasks
wendellpiez opened this issue Feb 1, 2021 · 1 comment
Closed
3 tasks

Define function (library) for OSCAL document set(s) #114

wendellpiez opened this issue Feb 1, 2021 · 1 comment
Labels
enhancement New feature or request wontfix This will not be worked on

Comments

@wendellpiez
Copy link
Collaborator

User Story:

OSCAL documents are typically not standalone; profiles make reference to catalogs and depend on them for resolution; SSPs make reference to profiles, etc.

It is likely that in the field, these references and de-references will be actively managed, including caching results of profile resolution etc.; but the definitions of how they interoperate must still be externalized in some way for clarity and consistency; we also need to be able to perform validation-oriented queries across these document boundaries. In the extreme case, the network of documents relating to one another (through import chains etc.) will be a directed graph.

We can describe this graph in a function library that can expose these documents (for example, imported catalogs from a processor operating on a profile) and make them available for processing. One set of functions might retrieve documents; another might serve to provide with runtime validations.

Goals:

  • Break this problem up into bite-size pieces (e.g: imported catalogs from profiles both one-step and recursively)
  • Define example use cases with unit tests
  • Model function(s)
  • Demonstrate deployment in Metatron or other Metaschema validation support pipeline

Dependencies:

As an experiment to demonstrate feasibility and provide baseline functionality, no dependencies.

However since it is not useful until Metaschema Metapath (constraints definition and enforcement) is deployed, we can wait for that (#45 and related).

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the 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.
@wendellpiez wendellpiez added the enhancement New feature or request label Feb 1, 2021
@david-waltermire david-waltermire added this to the Backlog milestone Mar 24, 2022
@david-waltermire david-waltermire removed this from the Backlog milestone Feb 9, 2023
@david-waltermire
Copy link
Collaborator

This is an OSCAL issue and not related to this repo.

@david-waltermire david-waltermire added the wontfix This will not be worked on label Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants