Add recaptcha_{private,public}_key_path config option #17984
Conversation
This file contains hidden or 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
MadLittleMods
requested changes
Dec 16, 2024
Comment on lines
+29
to
+30
| You have configured both `recaptcha_private_key` and | ||
| `recaptcha_private_key_path`. These are mutually incompatible. |
There was a problem hiding this comment.
We can dumb this down a bit:
Suggested change
| You have configured both `recaptcha_private_key` and | |
| `recaptcha_private_key_path`. These are mutually incompatible. | |
| You have configured both `recaptcha_private_key` and | |
| `recaptcha_private_key_path`. Only one or the other can be specified at a time. |
Comment on lines
+29
to
+30
| You have configured both `recaptcha_private_key` and | ||
| `recaptcha_private_key_path`. These are mutually incompatible. |
There was a problem hiding this comment.
This is a slight variation on the typical error message we've been using for this:
Conflicting options 'macaroon_secret_key' and 'macaroon_secret_key_path' are
both defined in config file.
I like the version that this PR has but we should probably be consistent and update all the other similar errors.
|
@MadLittleMods: Could you clarify what you want the error message to be? For these PRs I did not use my own wording, but took it from synapse/synapse/config/registration.py Lines 37 to 40 in aab3672 |
devonh
pushed a commit
that referenced
this pull request
Feb 25, 2025
Adds the `--no-secrets-in-config` command line option that makes Synapse reject all configurations containing keys with in-line secret values. Currently this rejects - `turn_shared_secret` - `registration_shared_secret` - `macaroon_secret_key` - `recaptcha_private_key` - `recaptcha_public_key` - `experimental_features.msc3861.client_secret` - `experimental_features.msc3861.jwk` - `experimental_features.msc3861.admin_token` - `form_secret` - `redis.password` - `worker_replication_secret` > [!TIP] > Hey, you! Yes, you! 😊 If you think this list is missing an item, please leave a comment below. Thanks :) This PR complements my other PRs[^1] that add the corresponding `_path` variants for this class of config options. It enables admins to enforce a policy of no secrets in configuration files and guards against accident and malice. Because I consider the flag `--no-secrets-in-config` to be security-relevant, I did not add a corresponding `--secrets-in-config` flag; this way, if Synapse command line options are appended at various places, there is no way to weaken the once-set setting with a succeeding flag. [^1]: [#17690](#17690), [#17717](#17717), [#17983](#17983), [#17984](#17984), [#18004](#18004), [#18090](#18090) ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
|
|
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.
Another config option on my quest to a
*_pathvariant for every secret. Adds the config optionsrecaptcha_private_key_pathandrecaptcha_public_key_path. Tests and docs are included.A public key is of course no secret, but it is closely related to the private key, so it’s still useful to have a
*_pathvariant for it.Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.(run the linters)