OIDC configuration #4623

bmarty · 2025-04-22T14:58:24Z

Content

Let OIDC configuration be read from BuildConfig file.
Also improve the error dialog when there is an error in the configuration (see screenshot below). Since this is generally build issue, there is no need to translate such error message.

Motivation and context

Make Oidc configuration configurable at build time.

Screenshots / GIFs

Before	After

Tests

There should be no impact at all on the Element X Android application, but reviewer should check that login/registration still works as expected on matrix.org or any other homeserver which supports MAS.

Tested devices

Physical
Emulator
OS version(s):

Checklist

Changes have been tested on an Android device or Android emulator with API 24
UI change has been tested on both light and dark themes
Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
Pull request is based on the develop branch
Pull request title will be used in the release note, it clearly define what will change for the user
Pull request includes screenshots or videos if containing UI changes
You've made a self review of your PR

… and add some comments.

github-actions · 2025-04-22T15:13:05Z

📱 Scan the QR code below to install the build (arm64 only) for this PR.

If you can't scan the QR code you can install the build via this link: https://i.diawi.com/YCcGXN

codecov · 2025-04-22T15:28:58Z

Codecov Report

Attention: Patch coverage is 75.86207% with 7 lines in your changes missing coverage. Please review.

Project coverage is 80.00%. Comparing base (75cb315) to head (4960065).
Report is 15 commits behind head on develop.

Files with missing lines	Patch %	Lines
...atrix/impl/auth/RustMatrixAuthenticationService.kt	0.00%	5 Missing ⚠️
...oid/features/login/impl/error/ChangeServerError.kt	66.66%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4623      +/-   ##
===========================================
- Coverage    80.01%   80.00%   -0.01%     
===========================================
  Files         2103     2104       +1     
  Lines        55758    55774      +16     
  Branches      6941     6948       +7     
===========================================
+ Hits         44612    44621       +9     
- Misses        8752     8757       +5     
- Partials      2394     2396       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

matrix-org/matrix-rust-sdk#4958

sonarqubecloud · 2025-04-23T07:37:17Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ElementBot · 2025-04-23T07:41:55Z

	Warnings
⚠️	app/src/main/AndroidManifest.xml#L89 - This intent filter has the format of an Android App Link but is missing the `autoVerify` attribute; add `android:autoVerify="true"` to ensure your domain will be validated and enable App Link-related Lint warnings. If you do not want clicked URLs to bring the user to your app, remove the `android.intent.category.BROWSABLE` category, or set `android:autoVerify="false"` to make it clear this is not intended to be an Android App Link.

Generated by 🚫 dangerJS against 4960065

bmarty · 2025-04-23T07:53:21Z

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/auth/OidcConfig.kt

+    // Some homeservers/auth issuers don't support dynamic client registration, and have to be registered manually
+    val STATIC_REGISTRATIONS = mapOf(
+        "https://id.thirdroom.io/realms/thirdroom" to "elementx",
+    )


@pixlwave this map is not "externally" configurable, do you know if we should do something about it?

I think it's fine for now. IIRC we added the static registrations specifically for compatibility with Third Room, but given basically everyone will be using MAS, dynamic registration will be supported.

jmartinesp

LGTM, thanks!

jmartinesp · 2025-04-23T08:10:41Z

...mpl/src/main/kotlin/io/element/android/libraries/matrix/impl/auth/AuthenticationException.kt

+        is OidcException -> when (this) {
+            is OidcException.Generic -> AuthenticationException.Oidc(message)
+            is OidcException.CallbackUrlInvalid -> AuthenticationException.Oidc(message)
+            is OidcException.Cancelled -> AuthenticationException.Oidc(message)
+            is OidcException.MetadataInvalid -> AuthenticationException.Oidc(message)
+            is OidcException.NotSupported -> AuthenticationException.Oidc(message)
+        }


Since we're mapping them to the same type, are we sure the messages are clear enough to track the root cause of the issue?

Good point, for what I have seen, it seems to be clear enough. We may want to improve the mapping if it's not the case.

Previously the homeserver reachability was designed as the cause of the failure, so I guess this is already much better.

wrenix · 2025-04-25T09:04:42Z

I am not possible to login to my matrix-authentification-service.
"missing contact" are shown (and that is here null now).

See element-hq/matrix-authentication-service#4322

pixlwave · 2025-04-25T09:08:33Z

@wrenix It sounds like your MAS is out of date as this requirement was removed in September. Updating your server should fix this issue.

bmarty added 6 commits April 22, 2025 15:01

Login: more logs.

d28d80b

Login: map Oidc error to provide more information in the error dialog.

912d6f2

Oidc: use the application name.

0bea29a

Oidc: move configuration from OidcConfigurationProvider to OidcConfig…

8d7a57b

… and add some comments.

Oidc: limit to only 1 contact in the configuration.

ae56172

Oidc: Move configuration to BuildConfig file.

3cdc38d

bmarty added the PR-Build For changes related to build, tools, CI/CD label Apr 22, 2025

bmarty requested a review from a team as a code owner April 22, 2025 14:58

bmarty requested review from jmartinesp and removed request for a team April 22, 2025 14:58

Remove unused const.

9cc1cc5

bmarty added 2 commits April 23, 2025 09:16

Add missing test on Exception mapping

c750287

Remove contacts from OidcConfiguration.

4960065

matrix-org/matrix-rust-sdk#4958

bmarty commented Apr 23, 2025

View reviewed changes

jmartinesp approved these changes Apr 23, 2025

View reviewed changes

bmarty merged commit b068597 into develop Apr 23, 2025
30 of 31 checks passed

bmarty deleted the feature/bma/oidcConfiguration branch April 23, 2025 09:58

pixlwave mentioned this pull request Apr 25, 2025

missing contacts when logging in from Element X element-hq/matrix-authentication-service#4322

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

OIDC configuration #4623

OIDC configuration #4623

Uh oh!

bmarty commented Apr 22, 2025

Uh oh!

github-actions bot commented Apr 22, 2025 •

edited

Loading

Uh oh!

codecov bot commented Apr 22, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Apr 23, 2025

Uh oh!

ElementBot commented Apr 23, 2025

Uh oh!

bmarty Apr 23, 2025

Uh oh!

pixlwave Apr 23, 2025

Uh oh!

jmartinesp left a comment

Uh oh!

jmartinesp Apr 23, 2025

Uh oh!

bmarty Apr 23, 2025

Uh oh!

Uh oh!

wrenix commented Apr 25, 2025

Uh oh!

pixlwave commented Apr 25, 2025 •

edited

Loading

Uh oh!

Uh oh!

OIDC configuration #4623

OIDC configuration #4623

Uh oh!

Conversation

bmarty commented Apr 22, 2025

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

Checklist

Uh oh!

github-actions bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud bot commented Apr 23, 2025

Quality Gate passed

Uh oh!

ElementBot commented Apr 23, 2025

Uh oh!

bmarty Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

pixlwave Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

jmartinesp left a comment

Choose a reason for hiding this comment

Uh oh!

jmartinesp Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

bmarty Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wrenix commented Apr 25, 2025

Uh oh!

pixlwave commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 22, 2025 •

edited

Loading

codecov bot commented Apr 22, 2025 •

edited

Loading

pixlwave commented Apr 25, 2025 •

edited

Loading