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

chore update container oscal cli js 20241113 #901

Closed

Conversation

aj-stein-gsa
Copy link
Contributor

david-waltermire and others added 30 commits September 23, 2024 22:10
… will likely change over time to become better and more complete as an example.
Not all, but many, actions were pinned to old versions by tag and to an
explicit SHA1 hash from the repo that are old enough to cause GHA
error notices. Upgraded from these to current SHA1 hash for the most
(692973e3d937129bcbf40652eb9f2f61becf3332) for recent v4.1.7 release.

> The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/

> The following actions use a deprecated Node.js version and will be forced to run on node20: actions/checkout@v2. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/

Source: https://github.com/GSA/fedramp-automation/actions/runs/10783353551
This directive is now obsolete, causes more noise in the GHA workflow
run logs.

https://forums.docker.com/t/docker-compose-yml-version-is-obsolete/141313
Dependabot still stinks about switching the target branch to rebase,
recreate, or do whatever. More details in the longstanding issue. I give
up! I cherry-picked the #673 commit because the related docker command
issues that fail those builds would be better fixed here, go figure.

dependabot/dependabot-core#6692

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 3.2.7 to 3.2.11.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v3.2.11/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v3.2.11/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Introduce cucumber testing of yaml unit tests
* introduce content generation and validation via CLI
* use junit
* eslint format
* Draft allowed values metaschema and YAML unit test.
* automate content generation and validation via CLI (#614)
* Introduce cucumber testing of yaml unit tests
* introduce content generation and validation via CLI
* better test summary reporting
* introduce constraint coverage checking + improve coverage
* throw an error if we do not find the matching rule
* store output in .sarif folder
* update constraints & test strategy, allow for mixed results as failure test
* pretty print sarif & correct file name output
* add time to sarif output file
* introduce validation-cache for performance

Co-authored-by: David Waltermire <davewaltermire@gmail.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Co-authored-by: DimitriZhurkin <dimitri.zhurkin@noblis.org>
* Improve constraint coverage tests
* Update features/steps/fedramp_extensions_steps.ts

---------
Co-authored-by: David Waltermire <davewaltermire@gmail.com>
* Add README.md to OSCAL CLI instructions

* Implemented reviewers' comments
* make test runner aware of informational constraint results

* Update features/steps/fedramp_extensions_steps.ts

Co-authored-by: A.J. Stein <aj@gsa.gov>

* improve test runner to handle warn and informational tests better

* Update fedramp_extensions_steps.ts

---------

Co-authored-by: A.J. Stein <aj@gsa.gov>
* add make update command

* add make constraint

* improve first run on fresh constraint
* Constraint-specific CONTRIBUTING to its own dir

Add the diagram of the constraint and testing
components specific to this area of code base here
and outline other sections to follow.

* Reference prerequisites in README for install

* Reorder CONTRIBUTING sections, add Metaschema one

* Add references to relevant Metaschema docs

* Add docs for new constraint tests

* Sigh, whitespace from code blocks break numbering

* Add detailed docs on modifying existing constraint

* Shorten and clean up explanatory copy

* Explain purpose of oscal-external constraints

* Clarify oscal file for generic constraints only

* Add guidance for using which FR constraints file

* [skip ci] Docs for deleting tests, links to PR docs

* Add @Rene2mt's feedback about testing one constraint by ID

Clearly this guy constraints!

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>

* [skip ci] Clean up typos, grammar, and missing info per @Rene2mt's PR feedback

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>

---------

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
* Added constraints and tests for resource-has-(title/rlink)

* metapath cleanup

* Add comment

Co-authored-by: A.J. Stein <aj@gsa.gov>

* Add comment

Co-authored-by: A.J. Stein <aj@gsa.gov>

* Added or base64 condition

* Cleanup

* Edit constraint name

---------

Co-authored-by: A.J. Stein <aj@gsa.gov>
)

* [skip ci] More appropriate README title for #659

* [skip ci] Context for constraints, tools for #659

Be sure to talk about the constraints and their relationship to the tool,
do not just talk about the `oscal-cli` without context. Re-order some of
the info, talk about target audience before install instructions.

* [skip ci] Remove dupe copy of 'who for?' for #659

* [skip ci] Subject is FR not only FR devs in #659

* [skip ci] No more header numbers, add headers #659

* [skip ci] Better intro and simple diagram for #659

* [skip ci] Docker install prerequisites for #659

* [skip ci] More install and command docs for #659

* [skip ci] Clearer wording on OCI tool for #659

* [skip ci]  Feedback for #659, re manual clone step

* [skip ci] Remove dangling this for #659

Thanks to @david-waltermire for catching that.

* [skip ci]  Align arguments docs, examples for #659

Based on some more detailed feedback from @Rene2mt that matched other
comments from Dave in the PR.

* Good catch, @gabelis, fix numbering for #659
* introduce data center constraints

* complete data center constraints

* Update src/validations/constraints/content/ssp-all-INVALID.xml

Co-authored-by: A.J. Stein <aj@gsa.gov>

* Update src/validations/constraints/content/ssp-all-VALID.xml

Co-authored-by: A.J. Stein <aj@gsa.gov>

* Update src/validations/constraints/content/ssp-location-INVALID.xml

Co-authored-by: A.J. Stein <aj@gsa.gov>

* remove allowed-type data center country code

* Late review feedback: align country code example with constraint

* Fix the correction that broke negative testing, sorry Paul

---------

Co-authored-by: A.J. Stein <aj@gsa.gov>
…write perms dropping (#665)

* Add initial OCI spec for container for #655

* Now add FR constraint files for #655

* Woops, fix typo in clone path for fd_data_dl scratch container

* Constraints in /opt/fedramp sudir, make it WORKDIR

* Switch to Alpine Maven scratch image not Debian

* Switch to Node for final image, install oscaljs

* Add checkout data to final image

* Fix missed parameterization of git image

* Add non-default OCI image build target for make

* Verify GPG signaure of oscal-cli build

* Add clean target for OCI image builds

* Allow for TLS bypass and proxy in Makefile

Disable cert-checking for the local version that is built on laptops for
GSA staff who make use of a VPN/proxy solution that intercept all TLS
communication for security monitoring. This includes not just Docker,
but also the containers as they build an image. Since production images
will be made in GitHub Actions without the Makefile, these directives
will be ignored.

* Do not do slow git clone, use local COPY instead

For speed, ease of access, and leave commit metadata from the container
ID linked to the commit hash itself, just copy from the outside context
of the image build.

* Add publish target to Makefile with useful tags

Also try docker push to GHCR to start before moving on the "in pipeline"
build with GitHub Actions.

* Fix repeat docker commands for correct tag-n-push

* Correct the org.opencontainers.image.source label

* Actions: perms for writing packages (ghcr.io)

* Actions: follow GH tutorial, more perms added

* Actions: build, sign, push, attest and OCI image

This workflow change is the first attempt at building, pushing, and
signing the validation-tools image to push to the ghcr.io registry.

* Actions: ref_name for image tags problematic

For both PRs and non-PR branches, that seems to cause problems for tags
that we ought to avoid for now.

* Actions: use action correctly, no manual labels

* Actions: remove metadata from Dockerfile, use GHA

* Actions: woops, forgot explicit checkout path

Our GHA CI/CD checks out to `./git-content`, `.` by default so the action
directive looking for context did not find the Dockerfile.

* Actions: check if least privilege perms block push

See more details in this reply and the larger context from others who
cannot push a built container to ghcr.io.

https://github.com/orgs/community/discussions/57724#discussioncomment-7779731

* Actions: scratch that, `write-all` blocked by org

The github.com/GSA organization still blocks the write to an org-level
package in very permissive move. Tips from the discussions posts did not
help here.

https://github.com/orgs/community/discussions/57724#discussioncomment-7779731

* Actions: add metadata action SHA options

We need to force SHA1 long (not seven-digit short version to avoid
collisions), remove both `sha-` prefix and remove suffix explicitly.

* Actions, sigh, really remove `sha256` prefix again

It seems that didn't stick the last time, so I will try this config
again and follow the official custom hash label strategy from the action
example from the official README.

* Support MVP platforms, arm64 and amd64

If not we will only support modern Apple computers with modern M1 chips,
not Intel environments for PC and older Macs. We need broad support for
these top platforms.

* Explicit platform option for buildx too for #656

It seems this may be needed because I still get similar but different
warnings on multi-platform docker builds when using on macOS on an Apple
laptop with a M1 processor and amd64 processor for personal computers
with Windows and Linux operating systems respectively.

> WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v3) and no specific platform was requested

* Pin metadata action and update configs for #656

- Had a slightly wrong version of docker/metadata-action that could not
use annotations properly, hence no annotations on image.
- Use annotations instead of custom override labels with that action.
- Update docker/build-push-registry action to retrieve those labels as
well.
- Change subject name for attestation to end with `-attestation` suffix
to make the GHCR registry entries less confusing.

* Woops, attestation subject === image name for #656

I re-read the dogs. Attestations will be uploaded to Sigstore but I will
not busy up the registry with them every moment as it will make it even
more confusing for novice users and advanced developers what data they
are looking for by content-addressable git commit hash ID.

* Explanatory comments on Dockerfile lint for #656

For future analysis or assessment, I am leaving information in the
Dockerfile as comments to address warning output in docker build and
push flagging a potential finding re secrets based on variable names.

```sh
 4 warnings found (use docker --debug to expand):
 - SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ARG "OSCAL_CLI_GPG_KEY") (line 20)
 - SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ARG "TEMURIN_APK_KEY_URL") (line 45)
 - FromAsCasing: 'as' and 'FROM' keywords' casing do not match (line 17)
 - FromAsCasing: 'as' and 'FROM' keywords' casing do not match (line 43)
```

 They are IDs to secrets, not actually secrets, now I have documented it.

* Attestations need explicit reg push off for #656

Just removing it may not have done the trick.
* Added back-matter 'has' constraints

* Set levels to 'ERROR'
* Actions: tighten when docker build runs and how

- We do not want to fails build when staff and community make fork PRs.
- We want to make sure the latest feature branch is tagged and deployed
for now, stop push PR container builds before merge.

* Actions: more explicit branch targeting

I am not sure that syntax is air-tight with var == 'value1' || 'value2',
so make it more explicit and have var on left side and right side of the
boolean OR check.

* Actions: even more explicit use startsWith syntax

* Actions: one last attempt to force annotations
I had incorrectly put it on workflow_dispatch which will not help as
needed.
wandmagic and others added 26 commits November 6, 2024 10:38
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
* Added 'has-cloud-model' constraints and tests

* Message/grammar corrections

* Remove FedRAMP namespace and fix allowed-values constraints

* cloud model constraint corrections

* Add condition for 'other'

* Fix all-valid value

* message tweak
* Add constraints for fully operational date

* Fix constraints and add formal names

* Update to align with frr103

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update to comply with frr112

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Move has-fully-operational-date to appropriate context

---------

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
….xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
* Add has-marking

* Update features/fedramp_extensions.feature

Co-authored-by: A.J. Stein <aj@gsa.gov>

* Restore after pull

---------

Co-authored-by: A.J. Stein <aj@gsa.gov>
* Add prepared-by constraints

* Add check for embedded address assembly in party

* Fix messages to be less jargony

* indent

* Parenthesis to cleanup test expression

* Add extra negative test case

* undo workaround

* Suggested improvements to constraint level and ssp-all-VALID
- Update oscal-cli to the latest stable release (2.3.1).
- Update oscal-js to the latest stable release (2.0.6).
@aj-stein-gsa aj-stein-gsa requested a review from a team as a code owner November 13, 2024 20:58
@aj-stein-gsa
Copy link
Contributor Author

Sigh, it would seem that the underlying branch was develop, not the chore branch, so it was pushed directly without PR. It was a minor change to update dependencies to match the latest version of our tools, but I had not properly hit enter after running the new branch checkout and I am a repo admin. 🤦 That change is a single commit, referenced by URL below.

6211011

(Note to self: it may be time for stricter "break glass only during emergencies" procedures around the crown jewel branches, main and to a lesser extent develop, more to follow.)

@aj-stein-gsa aj-stein-gsa mentioned this pull request Nov 14, 2024
7 tasks
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.

8 participants