Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MSC3824: OIDC aware clients #3824

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reorganise requiremetns
  • Loading branch information
hughns committed Aug 18, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit eec93e198ad0bf0ca35d158800af8ed71ba64b6a
14 changes: 10 additions & 4 deletions proposals/3824-oidc-aware-clients.md
Original file line number Diff line number Diff line change
@@ -54,21 +54,27 @@ n.b. we don't need to add this to the [Login Fallback](https://spec.matrix.org/v

### Definition of OIDC aware

For a client to be considered *OIDC aware* it would:
For a client to be considered fully *OIDC aware* it **must**:

- support the `m.login.sso` auth flow
- where a `delegated_oidc_compatibility` value of `true` is present on an `m.login.sso` then *only* offer that auth flow to the user
- append `action=login` and `action=register` parameters to the SSO redirect URLs
- link users to manage their account at the OP web UI given by [MSC2965](https://github.com/matrix-org/matrix-spec-proposals/pull/2965) instead of native UI
- RECOMMENDED: label the SSO button as "Continue"

For an OIDC enabled homeserver to provide support for *OIDC aware* clients it would:
Optionally, an *OIDC aware* client **could**:

- label the SSO button as "Continue"
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm curious what the rationale behind suggesting copy for the client's UI is here. Would the SSO button not redirect through a browser as before, regardless of whether OIDC is in play or not?


For an OIDC enabled homeserver to provide support for *OIDC aware* clients it **must**:

- support OIDC delegation as per [MSC2964](https://github.com/matrix-org/matrix-spec-proposals/pull/2964) and others
- provide a compatibility layer for `m.login.password` and `m.login.sso` that wraps on to OIDC
Copy link
Member

Choose a reason for hiding this comment

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

Is it defined how m.login.password an be wrapped into OIDC? I guess doing the login itself?

- indicate that the `m.login.sso` is preferred by setting `delegated_oidc_compatibility` to `true`
- make use of the `action` param on the SSO redirect endpoints
Copy link
Member

Choose a reason for hiding this comment

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

Make use of it to do what?

- RECOMMENDED: advertise the account management UI in accordance with [MSC2965](https://github.com/matrix-org/matrix-spec-proposals/pull/2965)

Additionally, the homeserver **should**:

- advertise the account management UI in accordance with [MSC2965](https://github.com/matrix-org/matrix-spec-proposals/pull/2965)

## Potential issues