Enforce scheme name restrictions to all confmap.Provider implementations. #5861
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
bogdandrutu
commented
Aug 8, 2022
Comment on lines
29
to
+42
| func LoadConf(fileName string) (*confmap.Conf, error) { | ||
| ret, err := fileprovider.New().Retrieve(context.Background(), "file:"+fileName, nil) | ||
| // Clean the path before using it. | ||
| content, err := ioutil.ReadFile(filepath.Clean(fileName)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("unable to read the file %v: %w", fileName, err) | ||
| } | ||
|
|
||
| var rawConf map[string]interface{} | ||
| if err = yaml.Unmarshal(content, &rawConf); err != nil { | ||
| return nil, err | ||
| } | ||
| return ret.AsConf() | ||
|
|
||
| return confmap.NewFromStringMap(rawConf), nil | ||
| } |
There was a problem hiding this comment.
I had to avoid using fileprovider.New() to avoid circular dependencies, since fileprovider uses ValidateProviderScheme.
Codecov Report
@@ Coverage Diff @@
## main #5861 +/- ##
=======================================
Coverage 91.73% 91.74%
=======================================
Files 195 195
Lines 11915 11929 +14
=======================================
+ Hits 10930 10944 +14
Misses 777 777
Partials 208 208
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
bogdandrutu
force-pushed
the
restrictscheme
branch
from
cf3d692
to
3af6bbb
Compare
bogdandrutu
changed the title
bogdandrutu
force-pushed
the
restrictscheme
branch
3 times, most recently
from
620ceec
to
8b5fbb8
Compare
…ons. Currently was documented that the format should be compatible with the URI definition (see https://datatracker.ietf.org/doc/html/rfc3986), but the scheme name restriction was not copied from the RFC, and no tests to enforce. This PR clearly documents the characters allowed in the scheme name and add confmaptest helper func to test for valid scheme names. Signed-off-by: Bogdan <bogdandrutu@gmail.com>
bogdandrutu
force-pushed
the
restrictscheme
branch
from
8b5fbb8
to
a7beedf
Compare
mx-psi
approved these changes
Aug 9, 2022
This was referenced Sep 28, 2022
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.
Currently was documented that the format should be compatible with the URI definition (see https://datatracker.ietf.org/doc/html/rfc3986),
but the scheme name restriction was not copied from the RFC, and no tests to enforce. This PR clearly documents the characters allowed in the scheme name and add confmaptest helper func to test for valid scheme names.
Updates #5706
Signed-off-by: Bogdan bogdandrutu@gmail.com