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

feat(templates): add support for a templates directory #308

Closed
wants to merge 5 commits into from

Conversation

brandtkeller
Copy link
Member

Description

In response to resolving #252 - this adds a templates directory to allow for more provenant OSCAL creation through centralized OSCAL templating vs more generic generation.

Lula allows the templating artifact to be a remote (network) location - test this locally with:

lula tools template -f https://raw.githubusercontent.com/defenseunicorns/uds-common/e6a11cd49007967350984ddd5efd5130cfae4803/templates/component.yaml --set .const.component.title='app-name' --set .const.component.description='description of t
he application' -o oscal-component.yaml

There is built in support for uuid and timestamp generation and this process both meets parity with the previous generation process as well as allows us to centralize entries such as metadata.parties to ensure consistency across the organization.

Checklist before merging

  • ADR proposed if making an architectural change to the repo
  • Tests run, docs added or updated as needed

@brandtkeller brandtkeller self-assigned this Oct 16, 2024
@brandtkeller brandtkeller requested review from a team as code owners October 16, 2024 20:31
Copy link
Contributor

@Racer159 Racer159 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

partial review but this may be better in uds-package-template

Comment on lines +9 to +22
- control-id: ac-6.9
description: <how the specified control may be implemented if the containing component or capability is instantiated in a system security plan>
remarks: |-
ASSESSMENT-OBJECTIVE:
the execution of privileged functions is logged.
uuid: {{ uuid }}
- control-id: au-12
description: <how the specified control may be implemented if the containing component or capability is instantiated in a system security plan>
remarks: |
ASSESSMENT-OBJECTIVE:
AU-12a. audit record generation capability for the event types the system is capable of auditing (defined in AU-02_ODP[01]) is provided by [Assignment: organization-defined system components];
AU-12b. [Assignment: organization-defined personnel or roles] is/are allowed to select the event types that are to be logged by specific components of the system;
AU-12c. audit records for the event types defined in AU-02_ODP[02] that include the audit record content defined in AU-03 are generated.
uuid: {{ uuid }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to make these controls a set we expect most apps to answer if they say met the silver standard and integrated with Istio/Prometheus/Loki?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we rename to oscal-somponent.yaml in case there are other "component" related things in here?

@brandtkeller
Copy link
Member Author

Closing to create a design doc and possibly place the template in another location.

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

Successfully merging this pull request may close these issues.

2 participants