-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Conversation
I've polished this PR quite a lot the last few days. CI is passing, and I started writing some tests. Even though it is not ready for merge, mainly because of error handling, I'd love to have a first review of it. Here are a few things I'd like to know:
A few things that I'd like to do, but that I might do later in other PRs:
|
I've added some docs to test some providers and handled errors more nicely. It should be ready for review. |
Excellect. I hope this will get merged soon. Not being familiar with hydra or dex, would testing with keycloak be useful? Keycloak can act as a translator between saml and oidc, which can be useful. |
Sure. I don't have a keycloak instance available for that, but it should work without problem. |
@sandhose |
Handling forced logout when the OIDC server mandates a logout would definitely be a wanted feature, too many security issues nowadays to not have that. ^.^; |
for the avoidance of doubt, this is probably true, but let's keep it as a follow up rather than adding further complexity to this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First of all, thanks for the PR! It's long, so I expect it will take a few back and forth to get it into a state we're both happy with! I left some comments (and will try to answer the questions below), overall it looks pretty good though!
- are the names I chose alright in general? I used
OIDC
pretty much everywhere, but it could be namedOAuth2
, as it can handle generic OAuth2 providers
I think OIDC is fine, putting it into a search engine / Wikipedia brings up pretty quickly how it is. It seems that OIDC is more generic than OAuth2? It might be nice to include (in the newsfragement?) that this includes OAuth2 providers though.
- I used
/_synapse/oidc/callback
as a redirect_uri ; should that be something else?
I think that's reasonable.
- to pass data through the OAuth2 flow, I save a cookie with some session informations encoded in a macaroon token. Is that the right approach?
I'm not sure on this, I'm guessing that unlike SAML / CAS the data can't be pushed through with the client redirect?
- I used
authlib
to handle to handle some of the OAuth2/OIDC parts. I added it insynapse/python_dependencies.py
. Is there somewhere else I should mention it?
I think that's enough!
- I'm not sure how to handle errors properly. Raising
SynapseError
in an async function does not seem to do anything.
This should work fine, we do this frequently. What was not working about it?
- to map the user infos from to provider to a mxid/display name, I used jinja templates that are configurable through the config file. Is that a good approach, or should I opt for something more similar than what is done in the SAML2 module?
I suspect being consistent with the SAML implementation is beneficial. The SAML implementation (of a plug-in) probably provides more flexibility too.
- sync somehow the display name after the initial registration ; maybe periodically, maybe after each login
- get the user picture from the provider
I don't think we do this with SAML / CAS currently?
- handle logouts. This implies that we save the access/id/refresh tokens
I think it was mentioned above that this seems like a good follow-up.
One piece I see missing in here is handling the UI authentication process that was added in #5667. I think we'll definitely want this, but it might be OK to be added as a follow-up.
Also, do you have any good resources for the flow diagram of OpenID Connect? I think it'd help me understand the various stages as I'm reviewing this! Thanks!
OAuth2 is a bunch of RFCs (mainly 6749) that define the authorization flows, but not where the endpoint should be, nor how user infos should work. OIDC defines that. For example, take a look at Google's OIDC discovery document, you'll see all the OAuth2 endpoints they have: https://accounts.google.com/.well-known/openid-configuration
Well it can, that's the purpose of the
I forget to decorate the handlers with
Nope, but that's definitely a thing we'd like to do in my company.
I'll look into it.
For the flow we are using (the authorization code flow), I think this is a good resource to understand it. For some of the OIDC specific parts, maybe look at this page. Thanks for this first review, I think I have a lot of comments/docstrings to add in various functions :D |
Awesome! A couple more things after re-reading the above:
|
I think displayname / avatar sync should maybe only be done on user creation or at least make it possible to not sync from the auth source. Often central auth can have a policy of only providing the name on official government ID, while people may want to be called a nickname in chat. |
@clokep I've resolved some of the remarks you did and added a lot of comments. Those should help you understand how the OIDC flow works. I think it's ready for another review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the extensive comments! I took another look and left some more comments, many are minor nits. There's also a few outstanding comments from the last review -- I've resolved all the ones that I see as done.
I also think the following was missed from above:
- to map the user infos from to provider to a mxid/display name, I used jinja templates that are configurable through the config file. Is that a good approach, or should I opt for something more similar than what is done in the SAML2 module?
I suspect being consistent with the SAML implementation is beneficial. The SAML implementation (of a plug-in) probably provides more flexibility too.
if self._provider_needs_discovery: | ||
url = get_well_known_url(self._provider_metadata["issuer"], external=True) | ||
metadata_response = await self._http_client.get_json(url) | ||
# TODO: maybe update the other way around to let user override some values? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need additional thought?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that doing it the other way around was a lot harder when I wrote this comment, because there were a bunch of metadatas that were set not from the config. I'll see if I can do something there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this isn't easy we can just remove the comment. This could always be a future improvement if it is necessary.
I've extracted out the user mapping logic into a module dynamically loaded from the config. One thing I'm not entirely sure is if the I resolved most of the conversations in this PR, thanks @auscompgeek and @clokep for the reviews! It might soon be time I rebase this PR since there are few conflicting files with develop. I'll wait the next review for that. I should be able to do another round on Tuesday, so it would be awesome to have another review before that :) |
I had to rebase on develop and force-push because tests would fail because of merging conflicts, sorry about that. The interesting commits start at |
synapse/handlers/oidc_handler.py
Outdated
|
||
env = Environment(finalize=jinja_finalize) | ||
|
||
JinjaOidcMappingConfig = TypedDict( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a particular reason this is a TypedDict rather than a class?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really. Would it be better? I'm not really a python developer, so if you think that would make more sense, I can change that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The SAML code gives a nicer way of doing this IMO:
synapse/synapse/handlers/saml_handler.py
Lines 292 to 295 in 207b173
@attr.s | |
class SamlConfig(object): | |
mxid_source_attribute = attr.ib() | |
mxid_mapper = attr.ib() |
And then parse_config
returns an instance of this class.
@@ -434,6 +436,10 @@ def get_json(self, uri, args={}, headers=None): | |||
|
|||
ValueError: if the response was not JSON | |||
""" | |||
actual_headers = {b"Accept": [b"application/json"]} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm. I wonder whether this should also be setting the User-Agent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was a discussion on #synapse-dev:matrix.org. I initially had those in the handler because some providers expected to have that header and I thought it would make sense to have them by default on all *_json
methods in the http client.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, nevermind. Did not read your comment properly. That's actually done by SimpleHttpClient.get_raw
.
docs/sample_config.yaml
Outdated
# Jinja2 template for the localpart of the MXID | ||
# | ||
localpart: "{ user.preferred_username }" | ||
|
||
# Jinja2 template for the display name to set on first login. Optional. | ||
# | ||
#display_name: "{ user.given_name } { user.last_name }" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems these had _template
added to the end of them in the code, but not in the sample configs or the documentation.
I do have a fear that using jinja here is an added layer of complexity that is unnecessary. Is being able to specify a different module enough here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that Jinja templates make sense because
- it's already used in the HTML/email templates
- it makes it easy to express some complex attributes combination ; given + family name is a good example for that
- we could easily provide a bunch of builtin filters :
hexencode
,dotreplace
(as seen in the SAML handler), a filter to extract the local part of a mxid/email address, etc.
I think the Jinja mapping provider is flexible enough to cover most of the use cases, but a simpler default provider would cover a lot less cases, meaning admins would have to write a module (with all the maintenance this applies) almost all the time
A solution between the two would be to have two mappers builtin: a simpler one that just extracts claims (as the SAML default one does), probably as default, and a Jinja-based one.
This ensures the OP is behaving correctly and returns valid HTTP codes Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Also passes the token as parameter of the mapping provider Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
This allows to simplify the metadata edit code in tests and leverage unittest.mock.patch.dict Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Signed-off-by: Quentin Gliech <quentin@connecteu.rs>
Phew, that should be it. I rebased on develop
So the only commit I really changed is Anyway, the new commits start at What was done (in commit order):
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is ready! 🥳 🎈
Thanks for working with us through the reviews! I'm going to give it another quick spin and merge this!
Excellent! Will this make it to 1.13 or will it wait for 1.14? |
@ptman This will wait for 1.14, we'll be cutting an RC for 1.13 soon™️. |
Thanks again for all your work on this! I believe we had mentioned a couple of follow-ups above, hopefully we have a good basis now to implement those! |
…cache-config-without-synctl * 'develop' of github.com:matrix-org/synapse: (43 commits) Remove unused store method get_hosts_in_room (#7448) Don't UPGRADE database rows RST indenting Put rollback instructions in upgrade notes Fix changelog typo Oh yeah, RST Absolute URL it is then Fix upgrade notes link Provide summary of upgrade issues in changelog. Fix ) Move next version notes from changelog to upgrade notes Changelog fixes 1.13.0rc1 Documentation on setting up redis (#7446) Rework UI Auth session validation for registration (#7455) Extend spam checker to allow for multiple modules (#7435) Implement OpenID Connect-based login (#7256) Add room details admin endpoint (#7317) Fix errors from malformed log line (#7454) Drop support for redis.dbid (#7450) Fixes typo (bellow -> below) (#7449) ...
@roderikelgodo Are you using Riot Desktop? I think you're hitting element-hq/element-web#13719. If it isn't that, please open a new issue or join #synapse:matrix.org. |
@clokep thank you very much for the answer. Yes, it is vector-im/riot-web#13719. After doing other test with other users, passing through Riot Web (and not through Riot Desktop), everything works fine. |
Hello! This feature works so well! I'm using the standard Auth0 authorization code flow. There are a few things I had to modify to get it working, so please correct me if I've not configured something correctly!
So sorry to waste your time if I've done something incorrect! Let me know if I should file an issue |
@mlwalsh1228 Do you have a reverse proxy that is blocking access to things not at _matrix? Anyway, I'm going to lock this issue, please don't use closed PRs for questions. If you believe there's a bug please open a separate issue, for support requests please use #synapse:matrix.org. |
This PR implements OIDC based login through the m.login.sso mechanism.
OpenID Connect is based on OAuth2, so this PR is kinda redundant with #7059. For now, it only supports OpenID Connect-compliant providers with the authorization code flow. This could be expanded to support generic OAuth2 provider, as long as they either support the
openid
scope or the userinfo endpoint to fetch user infos.This is a work in progress, here are a few things that need to be done:
support implicit and hybrid flows– edit: implicit and hybrid flows are for single page apps essentially & give the token in the fragment part of the URL, which can't be retrieved server-sideid_token
we get from the providerFor the flow to be secure (and prevent CSRF attacks for example), I needed to have a way to carry state through the flow. I chose to use a macaroon token with that state in it.
I needed an URL for the authorization flow callback. As it is not part of the spec, I chose to have that endpoint under
/_synapse/oidc/callback
.I used
OIDC
as a name pretty much everywhere, but it would make sense to useoauth2
instead ; haven't really decided.Pull Request Checklist
EventStore
toEventWorkerStore
.".code blocks
.