More robust config validation logic #379
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
rmol
suggested changes
Dec 18, 2019
conorsch
force-pushed
the
240-validate-config
branch
from
1fcdf07 to
5267415
Compare
added 3 commits
December 19, 2019 16:26
Retains the two previous checks: 1. Does config.json exist? 2. Does sd-journalist.sec exist? Adds several checks verifying the contents of config.json. There's a minimum of user-friendly messages explaining specifically what the problem is. We can add those messages over time, aiming to balance utility for Admins and developers. Assumes that a v2 Onion URL is used. We can update that logic when we add support for v3 Onion URLs.
Since both v2 and v3 are supported, check v3 first, but if validation fails, continue validation by trying matches for v2. If both return invalid, then fail validation.
Suggested by @rmol during review. Calling `gpg <key_file>` will return non-zero if the key isn't valid.
conorsch
force-pushed
the
240-validate-config
branch
from
5267415 to
91a36b9
Compare
|
@rmol Great comments, thanks for taking a look. I've rebased and appended a few changes here, namely to add v3 support, and implement the
Very much dev-focused right now. Deferring a friendlier experience for when we tackle the overall admin provisioning story. At that time, we'll likely crib a fair amount of code from https://github.com/freedomofpress/securedrop/blob/43245829ff93e0a84999526f7ecd0435f89eb52a/admin/securedrop_admin/__init__.py#L60 Ready for re-review! |
rmol
approved these changes
Dec 19, 2019
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.
Retains the two previous checks:
Adds several checks verifying the contents of config.json.
There's a minimum of user-friendly messages explaining specifically what
the problem is. We can add those messages over time, aiming to balance
utility for Admins and developers.
Assumes that a v2 Onion URL is used. We can update that logic when we
add support for v3 Onion URLs.
Closes #240.
Testing
make validatepasses in dom0 with v3 Onion URL infomake validatepasses in dom0 with v2 Onion URL infomake validatefails when a known-bad value is inconfig.jsonas appending characters to the Onion URL