feat(generate)!: initial generate ssp command #812

meganwolf0 · 2024-11-20T19:02:40Z

Description

Initial generate ssp command

Adds lula generate system-security-plan with required profile and optional component path(s)
(Breaking) Modifies the library ssp functionality to incorporate profile control resolution, instead of depending on controls defined by the component definitions (more information in below doc)
Updates the docs/oscal/system-security-plan.md to reflect logic followed in the generate ssp command

Follow-on issues include:

Partial Component Compositions #810 - "Partial" compose is most likely the disaggregation of importing components to the component def and imported validations to the back-matter (follow-on discussion is potentially around continued import of validations to back-matter and utility)
Support for merging configuration data into OSCAL artifacts #624 - Injecting external, user defined, fields into the SSP (or other generated OSCAL models)

Related Issue

Fixes #803

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Other (security config, docs update, etc)

Checklist before merging

Test, docs, adr added or updated as needed
(N/A) Schema Updates applied
Contributor Guide Steps followed

…nerate-ssp-command

mildwonkey

I don't necessarily feel qualified to approve this (the oscal concepts are still so new to me), but I also don't have any objections and it all looks reasonable to me :) I left some comments but nothing that requires changes; feel free to dismiss 'em ❤️

docs/cli-commands/lula_generate_system-security-plan.md

docs/oscal/system-security-plan.md

src/test/e2e/cmd/generate_ssp_test.go

docs/oscal/system-security-plan.md

src/cmd/generate/system-security-plan.go

brandtkeller

Few minor comments thus far - have a little more tracing to do - otherwise looking great.

brandtkeller · 2024-12-11T01:56:53Z

(few conflicts to resolve when you have a minute)

meganwolf0 · 2024-12-11T13:26:11Z

Update

Resolved conflicts on main (with oscalTypes)
Fixed some doc words
Modified flag/var name for component -> components in generate SSP
template -> artifact in short help for both SSP and Profile (Do we want to update generate component text as well OR is there another word we should give these things?)

Note - the help.golden files are kind of annoying since we have to re-generate the cli-docs + re-run the tests to generate the help docs when some command text words change... just throwing out the question of if those golden checks on help are valuable?

brandtkeller

besides a typo I feel like this looks great and really sets us up well for AP generation.

src/cmd/generate/system-security-plan.go

Co-authored-by: Brandt Keller <[email protected]>

mildwonkey

🎉

* generate(ssp): initial generate ssp command * feat(ssp): updated lib to handle variadic compdefn * feat(profile): resolve all controls in profile * fix: network fcn * feat(profile): update tests * feat: profile-catalog links * feat: updated profile resolve to map the source * feat: ssp generation updates, tests * fix: update generate * fix: add control logic broke too soon * fix: minor cleanups * test: addl unit and e2e * docs: cli cmds, test cleanup * docs: updated ssp doc * fix: merging existing models, test, update docs * docs: updated docs, msgs * Update src/cmd/generate/system-security-plan.go Co-authored-by: Brandt Keller <[email protected]> --------- Co-authored-by: Brandt Keller <[email protected]> Co-authored-by: Andy Mills <[email protected]>

generate(ssp): initial generate ssp command

a62725e

meganwolf0 changed the title ~~generate(ssp): initial generate ssp command~~ feat(generate): initial generate ssp command Nov 21, 2024

meganwolf0 and others added 21 commits November 21, 2024 10:16

feat(ssp): updated lib to handle variadic compdefn

2751b5f

Merge branch 'main' into 803-generate-ssp-command

3dd9d9c

feat(profile): resolve all controls in profile

6d5ac2b

fix: network fcn

faf7fc0

feat(profile): update tests

d645086

Merge branch '813-get-all-controls-from-imported-profile' into 803-ge…

db3dbb4

…nerate-ssp-command

feat: profile-catalog links

d0f4e4b

feat: updated profile resolve to map the source

73ae30a

Merge branch 'main' into 813-get-all-controls-from-imported-profile

45081c2

Merge branch '813-get-all-controls-from-imported-profile' into 803-ge…

dfe4671

…nerate-ssp-command

feat: ssp generation updates, tests

df2aa74

fix: update generate

37ad20e

Merge branch 'main' into 813-get-all-controls-from-imported-profile

b23f8ca

fix: add control logic broke too soon

0c16fa2

Merge branch '813-get-all-controls-from-imported-profile' into 803-ge…

a791254

…nerate-ssp-command

fix: minor cleanups

ae1f974

test: addl unit and e2e

0ffc90a

docs: cli cmds, test cleanup

8fe52a2

docs: updated ssp doc

9f964ea

Merge remote-tracking branch 'origin/main' into 803-generate-ssp-command

14446af

fix: merging existing models, test, update docs

d1ad70c

meganwolf0 changed the title ~~feat(generate): initial generate ssp command~~ feat(generate)!: initial generate ssp command Dec 5, 2024

meganwolf0 marked this pull request as ready for review December 5, 2024 15:49

meganwolf0 requested a review from a team as a code owner December 5, 2024 15:49

Merge branch 'main' into 803-generate-ssp-command

65e5e22

mildwonkey reviewed Dec 9, 2024

View reviewed changes

docs/cli-commands/lula_generate_system-security-plan.md Show resolved Hide resolved

docs/oscal/system-security-plan.md Show resolved Hide resolved

src/test/e2e/cmd/generate_ssp_test.go Show resolved Hide resolved

brandtkeller reviewed Dec 9, 2024

View reviewed changes

docs/oscal/system-security-plan.md Outdated Show resolved Hide resolved

brandtkeller reviewed Dec 10, 2024

View reviewed changes

src/cmd/generate/system-security-plan.go Outdated Show resolved Hide resolved

brandtkeller reviewed Dec 11, 2024

View reviewed changes

meganwolf0 added 2 commits December 11, 2024 07:54

Merge remote-tracking branch 'origin/main' into 803-generate-ssp-command

d0f1ea5

docs: updated docs, msgs

ab6af9a

meganwolf0 and others added 2 commits December 11, 2024 14:02

Merge branch 'main' into 803-generate-ssp-command

0545fad

Merge branch 'main' into 803-generate-ssp-command

ec2183d

brandtkeller requested changes Dec 12, 2024

View reviewed changes

src/cmd/generate/system-security-plan.go Outdated Show resolved Hide resolved

meganwolf0 and others added 2 commits December 13, 2024 08:39

Update src/cmd/generate/system-security-plan.go

26b3a17

Co-authored-by: Brandt Keller <[email protected]>

Merge branch 'main' into 803-generate-ssp-command

c2ce922

mildwonkey approved these changes Dec 13, 2024

View reviewed changes

Merge branch 'main' into 803-generate-ssp-command

adc1442

brandtkeller approved these changes Dec 13, 2024

View reviewed changes

brandtkeller merged commit 74fd193 into main Dec 13, 2024
10 checks passed

brandtkeller deleted the 803-generate-ssp-command branch December 13, 2024 23:43

github-actions bot mentioned this pull request Dec 13, 2024

chore(main): release 0.14.0 #839

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(generate)!: initial generate ssp command #812

feat(generate)!: initial generate ssp command #812

meganwolf0 commented Nov 20, 2024 •

edited

Loading

mildwonkey left a comment

brandtkeller left a comment

brandtkeller commented Dec 11, 2024

meganwolf0 commented Dec 11, 2024

brandtkeller left a comment

mildwonkey left a comment

feat(generate)!: initial generate ssp command #812

feat(generate)!: initial generate ssp command #812

Conversation

meganwolf0 commented Nov 20, 2024 • edited Loading

Description

Related Issue

Type of change

Checklist before merging

mildwonkey left a comment

Choose a reason for hiding this comment

brandtkeller left a comment

Choose a reason for hiding this comment

brandtkeller commented Dec 11, 2024

meganwolf0 commented Dec 11, 2024

brandtkeller left a comment

Choose a reason for hiding this comment

mildwonkey left a comment

Choose a reason for hiding this comment

meganwolf0 commented Nov 20, 2024 •

edited

Loading