Validate rule type guidance as markdown.
#4292
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
Minder Vulnerability Report ✅Minder analyzed this PR and found it does not add any new vulnerable dependencies.
|
blkt
changed the title
guidance is valid markdown.guidance as markdown.
|
Changes unknown |
rdimitrov
previously approved these changes
Aug 27, 2024
JAORMX
requested changes
Aug 28, 2024
| ), | ||
| ) | ||
| if err := md.Convert([]byte(crt.RuleType.Guidance), &bytes.Buffer{}); err != nil { | ||
| return nil, status.Errorf( |
There was a problem hiding this comment.
Should this be a user-facing issue? We have a UserVisibleError wrapper that allows for this.
| return nil, status.Errorf( | ||
| codes.InvalidArgument, | ||
| "invalid rule type definition: guidance too long", | ||
| ) |
There was a problem hiding this comment.
Should this be a user-facing issue? We have a UserVisibleError wrapper that allows for this.
We're currently treating `guidance` as a plain string, storing it unmodified. This change introduces some controls ensuring that guidance is valid markdown before storing it in the database. Since any valid UTF-8 string is valid markdown, the check is a bit redundant at the moment and ensures that it is parseable and renderable as HTML. Additionally, we limit its size to 10kB, which is far more than enough given the current rule types have a `guidance` field shorter than 1kB. Fixes #4286
|
Thanks for catching that @JAORMX |
JAORMX
approved these changes
Aug 28, 2024
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
We're currently treating
guidanceas a plain string, storing it unmodified.This change introduces some controls ensuring that guidance is valid markdown before storing it in the database. Since any valid UTF-8 string is valid markdown, the check is a bit redundant at the moment and ensures that it is parseable and renderable as HTML.
Additionally, we limit its size to 10kB, which is far more than enough given the current rule types have a
guidancefield shorter than 1kB.Fixes #4286
Change Type
Testing
Manual tests.
Review Checklist: