Repository navigation
feat: GSM Secrets - Keep new secrets in an optional store #474
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
6 commits
Select commit
Hold shift + click to select a range
64f54dd
feat: GSM Secrets - Save secret values through an optional store hook
yuechao-qin f5c64e0
Merge remote-tracking branch 'origin/master' into gsm-t1-store-hook
yuechao-qin 18a021a
feat: GSM Secrets - Keep secrets in an optional store; move table row…
yuechao-qin dbeb0eb
feat: GSM Secrets - get only reads; it never moves table rows
yuechao-qin ca09d2b
feat: GSM Secrets - Routes keep rows where they are; new secrets go t…
yuechao-qin 6cfaccd
refactor: GSM Secrets - Rename secret_store to secret_interfaces, lis…
yuechao-qin 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import builtins | ||
| import dataclasses | ||
| import datetime | ||
| from typing import Any, Protocol | ||
|
|
||
|
|
||
| @dataclasses.dataclass(frozen=True, kw_only=True) | ||
| class StoredSecret: | ||
| """A secret as a `SecretStore` keeps it; `value` is None when not loaded, and never shown by repr, str or logs.""" | ||
|
|
||
| user_id: str | ||
| secret_name: str | ||
| value: str | None = dataclasses.field(default=None, repr=False) | ||
| description: str | None = None | ||
| created_at: datetime.datetime | ||
| updated_at: datetime.datetime | ||
| extra_data: dict[str, Any] | None = None | ||
|
|
||
|
|
||
| class SecretStore(Protocol): | ||
| """Keeps secrets outside the database, for example in a cloud secret manager. | ||
|
|
||
| With a store, new secrets go to the store; a secret still in the `secret` table stays there until moved. | ||
| """ | ||
|
|
||
| def create(self, *, secret: StoredSecret) -> StoredSecret: | ||
| """Saves a new secret and returns it without its value; raises `errors.ItemAlreadyExistsError` if it exists.""" | ||
|
|
||
| def update(self, *, secret: StoredSecret) -> StoredSecret: | ||
| """Saves a new value for an existing secret and returns it without its value. | ||
|
|
||
| Keeps the stored `created_at` and name, and the stored description when `description` is None. | ||
| Raises `errors.ItemNotFoundError` when there is no such secret. | ||
| """ | ||
|
|
||
| def get(self, *, user_id: str, secret_name: str) -> str | None: | ||
| """Returns the secret's latest value, or None when there is no such secret.""" | ||
|
|
||
| def list(self, *, user_id: str) -> builtins.list[StoredSecret]: | ||
| """Returns the user's secrets, without values.""" | ||
|
|
||
| def delete(self, *, user_id: str, secret_name: str) -> None: | ||
| """Deletes the secret and all its values; raises `errors.ItemNotFoundError` when there is none.""" |
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.
Uh oh!
There was an error while loading. Please reload this page.