-
Notifications
You must be signed in to change notification settings - Fork 0
Polish TTP protocol alignment #43
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: Public quickstart | ||
| description: Report friction from the first-run TTP quickstart. | ||
| title: "Quickstart: " | ||
| labels: | ||
| - quickstart | ||
| - adoption | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Use this when you tried the public quickstart and something was confusing, broken, or slower than expected. | ||
| - type: textarea | ||
| id: path | ||
| attributes: | ||
| label: Adoption path | ||
| description: Which path were you trying? | ||
| placeholder: Agent builder, service/API owner, platform/security operator, or protocol contributor. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Steps run | ||
| description: Paste the commands or docs sections you followed. | ||
| placeholder: npm install, npm test, docs/getting-started.md... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected outcome | ||
| description: What did you expect to happen? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: actual | ||
| attributes: | ||
| label: Actual outcome | ||
| description: What happened instead? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: Runtime, OS, Node/Python versions, and any relevant service setup. | ||
| placeholder: Node 20, Ubuntu, local reference gate... | ||
| validations: | ||
| required: false |
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Persistent Storage Guidance | ||
|
|
||
| TTP reference services can run locally with file-backed state, but production-like deployments need durable storage so trust evidence, issued proofs, and receipt history survive restarts. | ||
|
|
||
| ## Minimum Requirements | ||
|
|
||
| - Store issuer registry, agent registry, trust state, receipts, and revocation data on durable storage. | ||
| - Back up state on a schedule aligned to receipt retention requirements. | ||
| - Use append-only receipt storage or immutable object retention where available. | ||
| - Encrypt state at rest and restrict access to the trust authority service identity. | ||
| - Keep state scoped by tenant or deployment boundary; do not mix unrelated trust domains. | ||
| - Monitor storage growth, write failures, backup failures, and receipt-chain verification errors. | ||
|
|
||
| ## Reference Deployment Pattern | ||
|
|
||
| For a single-node reference environment: | ||
|
|
||
| 1. Mount a persistent volume at the service state directory. | ||
| 2. Configure daily backups for registries and receipts. | ||
| 3. Run a receipt-chain verification job after backup completion. | ||
| 4. Rotate signing keys using a documented key ID and retention plan. | ||
| 5. Keep old public verification keys available for the full receipt retention period. | ||
|
|
||
| For managed or high-availability deployments, replace local file state with a transactional database for mutable registries and immutable object storage for receipt artifacts. | ||
|
|
||
| ## Fail-Closed Rules | ||
|
|
||
| The authority service must fail closed when: | ||
|
|
||
| - state cannot be read, | ||
| - receipt persistence fails, | ||
| - revocation state is unavailable, | ||
| - the signer cannot access current key material, | ||
| - receipt-chain verification detects an unexpected hash discontinuity. | ||
|
|
||
| These failures should produce an explicit deny/error receipt when the receipt subsystem is still available. |
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When this reference gate is run in the documented pre-prod/production pattern behind a load balancer (
docs/deployment-guide.mdStage 3), defaultingHOSTto127.0.0.1makes the process listen only on the container/pod loopback interface, so other containers or the LB cannot reach/healthzor/re/authorizeunless operators discover and set an undocumentedHOST=0.0.0.0. The previousserver.listen(PORT)behavior accepted external interfaces, so this is a deployment regression for anyone following the existing guide.Useful? React with 👍 / 👎.