feat: add endpoint for fetching workspace proxy keys #14789
Merged
Conversation
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
Introduce documentation for new API endpoint to fetch workspace proxy signing keys. This addition supports enterprise use cases involving workspace proxies by documenting the models `CryptoKey`, `CryptoKeyFeature`, and `CryptoKeysResponse`.
Improve clarity by changing references from "signing keys" to "crypto keys" in API documentation and comments. This aligns terminology across the codebase and documentation, reducing potential confusion.
deansheather
approved these changes
Sep 26, 2024
Comment on lines
223
to
234
| func (c CryptoKey) Active(now time.Time) bool { | ||
| now = now.UTC() | ||
| isAfterStartsAt := !c.StartsAt.IsZero() && !now.Before(c.StartsAt) | ||
| return isAfterStartsAt && !c.Invalid(now) | ||
| } | ||
|
|
||
| func (c CryptoKey) Invalid(now time.Time) bool { | ||
| now = now.UTC() | ||
| noSecret := c.Secret == "" | ||
| afterDelete := !c.DeletesAt.IsZero() && !now.Before(c.DeletesAt.UTC()) | ||
| return noSecret || afterDelete | ||
| } |
There was a problem hiding this comment.
Can this just be a single Valid() call or something instead? I don't understand why you would want to differentiate these two states since in both cases the key can't be used
There was a problem hiding this comment.
Keys can be used for verification prior to their start time but cannot be used for signing. I'll update the names of the methods to reflect that though
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds an endpoint for fetching signing keys from a workspace proxy. I've intentionally decoupled it from the
registerendpoint since we will need to support fetching keys on demand and it's overkill to have to reregister every time that's necessary. Since we'll support fetching keys on demand we don't need to also be refreshing them every 15s, so decoupling it allows us to set a longer interval (i.e. 10 minutes).