chore: use config block list instead of allow list #247
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
jyyi1
approved these changes
Jun 3, 2024
| } | ||
| for key, value := range configMap { | ||
| switch key { | ||
| case "DisableLocalHTTPProxy", "DisableLocalSocksProxy": |
There was a problem hiding this comment.
We are still digging into a specific field in the config. Not sure whether this is breaking the "black-box" or not.
There was a problem hiding this comment.
Because those fields are incompatible with the Outline SDK. The key change in this PR is from specifying what fields to allow to specifying what fields to now allow. So Psiphon config - disallowed fields is a black box now.
| if b != true { | ||
| return nil, fmt.Errorf("field %v must be true if set", key) | ||
| } | ||
| case "DataRootDirectory": |
There was a problem hiding this comment.
Why don't we allow customers to specify their own DataRootDirectory?
There was a problem hiding this comment.
Because that must be specified via the DialerConfig.DataRootDirectory. This makes it clear what they should be setting vs what is provided by Psiphon.
fortuna
added a commit
that referenced
this pull request
Jun 3, 2024
change to field blocklist Fix doc Tweak Minor cleanup
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.
With this change, instead of allow listing specific config fields, we block the ones that should be set by the application developer instead. This should address Psiphon's concern about treating the config as a black box.
I also figured out a trick to make the Go docs work: instead of setting the build tag restrictions on all files, I only add to one, which is required to build the entire package. This allows the documentation to be generated without setting the build tag.