document the capability-token model for job console logs#1564
Merged
Conversation
The job UUID issued by Log#set_uid is the authorization primitive for ConsoleController#status -- we don't scope Log records by user or project. Adding comments so future maintainers don't re-litigate.
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
2 participants
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
Adds comments to
ConsoleController#statusandLog#set_uidrecording the design intent: the job UUID (SecureRandom.uuid, 122 bits of entropy) is the authorization primitive for reading a log stream. Logs are not scoped by user or project at the row level; possession of a valid UUID is treated as the authorization to read.Why
Without these comments, the shape of
ConsoleController#statusinvites future contributors to add row-level scoping that would require a substantial refactor (migration + threadinguser_idthrough every call site that creates aLog). The UUID-as-capability design is intentional and the comments flag that.Check List