Add proto validation for cursor indexes #4891
Merged
Conversation
This file contains 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
eleftherias
previously approved these changes
Nov 6, 2024
proto/minder/v1/minder.proto
Outdated
| // an per-rpc basis. Note it is base64 encoded. | ||
| string cursor = 1 [ | ||
| (buf.validate.field).string = { | ||
| pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", |
There was a problem hiding this comment.
Can we simplify this to "^[[:word:]=]*$"?
There was a problem hiding this comment.
The one you suggest seems more loose?
There was a problem hiding this comment.
It is. We're concerned with very unexpected input, but presumably we will validate the cursor more completely after base64-decoding it, so we just want to rule out truly unexpected characters here.
There was a problem hiding this comment.
I see. Alright, makes sense 👍
rdimitrov
force-pushed
the
validate-cursor
branch
from
53be786 to
12fd187
Compare
Pull Request Test Coverage Report for Build 11708419494Details
💛 - Coveralls |
Signed-off-by: Radoslav Dimitrov <[email protected]>
rdimitrov
force-pushed
the
validate-cursor
branch
from
12fd187 to
3b239ac
Compare
Signed-off-by: Radoslav Dimitrov <[email protected]>
rdimitrov
force-pushed
the
validate-cursor
branch
from
3b239ac to
86b23d0
Compare
evankanderson
approved these changes
Nov 6, 2024
| pattern: "^[[:word:]=]*$", | ||
| max_len: 200, | ||
| }, | ||
| (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE |
There was a problem hiding this comment.
If you use * as the pattern, you don't actually need this, since it will match a zero-length string. It's fine to leave it, though.
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
The following PR adds proto validation for cursor indexes ensuring only base64 encoded strings are accepted.
Ref https://github.com/stacklok/minder-stories/issues/94
Change Type
Mark the type of change your PR introduces:
Testing
Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.
Review Checklist: