Repository navigation
README: list validation/ and its CLIs - #113
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches the existing validation APIs and CLI usage, with no blocking issues identified.
No open issues 🎉
What changed in this PR
This documentation-only PR makes the existing attestation validation package and its command-line tools discoverable in the README.
Changes:
- Describe
validation/, its verification responsibilities, and its use byopenarbiter. - List the auction-validator and key-validator CLIs.
- Add
validationto the Usage import example.
| File | Description |
|---|---|
| README.md | Document the validation package and CLIs, and extend the import example. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
core/,enclaveapi/andenclave/but notvalidation/, the package that verifies enclave attestations (PCRs, the AWS Nitro certificate chain, the COSE_Sign1 signature, then the key and auction checks) and that cloudx-io/openarbiter imports. The Overview now lists it along with its two CLIs,validation/cmd/auction-validatorandvalidation/cmd/key-validator, each described from its own usage text and the package's doc comments.github.com/cloudx-io/openauction/validation.Notes for reviewers
#44 also edits the Overview, rewording the
core/bullet two lines above the new one. A test merge of #44 into this branch mergesREADME.mdwithout a conflict.Pre-merge checklist
mainand build:go run ./validation/cmd/key-validator --helpandgo run ./validation/cmd/auction-validator --helpprint their usagecore,enclaveapi,validation) compiles in a scratch module that replaceshub.lumenfield.work/cloudx-io/openauctionwith this branchgo build ./...andgo vet ./...pass; the change touchesREADME.mdonly, so the enclave binary is unchangedlint,test,docker-buildandRatchet Lintpass one708b63README.mdonlyPost-deploy/apply verification
[skip-build] Update PCR measurementscommit (d2cfa57: Go 40377103017, Docker Build 40377190762, Build EIF 40377811105 all success; PCR commit 1400a25)