Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add client_secret_path as alternative for client_secret for OIDC config #16030

Merged
merged 3 commits into from
Aug 21, 2023

Conversation

Ma27
Copy link
Contributor

@Ma27 Ma27 commented Jul 30, 2023

That way you don't have to leak your bind password into your config. Useful for e.g. NixOS where config is stored in a world-readable location.

Tested against a live synapse instance with authentik as OIDC provider.

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. 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.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

Copy link
Member

@clokep clokep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty reasonable; I wish we had a more abstract way of doing this instead of manually each time we want something to be a file.

docs/usage/configuration/config_documentation.md Outdated Show resolved Hide resolved
synapse/config/oidc.py Outdated Show resolved Hide resolved
synapse/config/oidc.py Outdated Show resolved Hide resolved
synapse/config/oidc.py Outdated Show resolved Hide resolved
That way you don't have to leak your bind password into your config.
Useful for e.g. NixOS where config is stored in a world-readable
location.

Tested against a live synapse instance with authentik as OIDC provider.

Signed-off-by: Maximilian Bosch <[email protected]>
@Ma27 Ma27 force-pushed the oidc-client_secret_file branch from 3cbce56 to b1197c0 Compare August 12, 2023 16:51
@clokep clokep requested review from clokep and a team August 14, 2023 12:02
@clokep clokep changed the title oidc: add client_secret_file as alternative for client_secret Add client_secret_path as alternative for client_secret for OIDC config Aug 15, 2023
changelog.d/16030.feature Outdated Show resolved Hide resolved
Co-authored-by: Patrick Cloke <[email protected]>
Signed-off-by: Maximilian Bosch <[email protected]>
@Ma27 Ma27 force-pushed the oidc-client_secret_file branch from 343e5b2 to 8061107 Compare August 21, 2023 13:31
@Ma27
Copy link
Contributor Author

Ma27 commented Aug 21, 2023

Added relevant notes and squashed this and the previous commit together :)

Copy link
Member

@clokep clokep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Sorry for the back-and-forth here.

@clokep clokep enabled auto-merge (squash) August 21, 2023 16:31
@clokep clokep merged commit d6ae404 into matrix-org:develop Aug 21, 2023
@Ma27 Ma27 deleted the oidc-client_secret_file branch August 21, 2023 19:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants