Skip to content

feat: add single sign on by saml #420

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.

Sign up for GitHub

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

Open
RawanMatar89 wants to merge 10 commits into
base: develop
Choose a base branch
from
Open

feat: add single sign on by saml #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
eb3f8a9
revert: Support for login and registration via a browser custom tab (…
RawanMatar89 Apr 14, 2025
135a305
feat: add saml sso
RawanMatar89 Feb 9, 2025
6a4500c
Merge branch 'develop' of https://github.com/openedx/openedx-app-andr…
RawanMatar89 Sep 28, 2025
fa5f13a
fix: resolve conflicts and unit test
RawanMatar89 Sep 29, 2025
2207571
fix: unit test issues
RawanMatar89 Oct 2, 2025
316ebc4
fix: sso login flow and other fixes
RawanMatar89 Dec 7, 2025
4e1ce2c
fix: fix conflicts with develop
RawanMatar89 Dec 7, 2025
e2badfd
fix: sso login unit tests
RawanMatar89 Dec 29, 2025
833d138
fix: sso login flow handle cookies error and display a message and ot…
RawanMatar89 Jan 24, 2026
25b1a00
fix: fixing detekt issues
RawanMatar89 Jan 25, 2026
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
252 changes: 80 additions & 172 deletions app/schemas/org.openedx.app.room.AppDatabase/4.json
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions app/src/main/AndroidManifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,6 @@

<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="${applicationId}" />
</intent-filter>

<!-- Branch URI Scheme -->
<intent-filter>
Expand Down
23 changes: 4 additions & 19 deletions app/src/main/java/org/openedx/app/AppActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ package org.openedx.app

import android.content.Intent
import android.content.res.Configuration
import android.graphics.Color
import android.net.Uri
import android.os.Build
import android.os.Bundle
import android.view.View
import android.view.WindowManager
Expand All @@ -26,7 +23,6 @@ import org.openedx.app.databinding.ActivityAppBinding
import org.openedx.app.deeplink.DeepLink
import org.openedx.auth.presentation.logistration.LogistrationFragment
import org.openedx.auth.presentation.signin.SignInFragment
import org.openedx.core.ApiConstants
import org.openedx.core.data.storage.CorePreferences
import org.openedx.core.presentation.dialog.downloaddialog.DownloadDialogManager
import org.openedx.core.presentation.global.InsetHolder
Expand Down Expand Up @@ -70,13 +66,6 @@ class AppActivity : AppCompatActivity(), InsetHolder, WindowSizeHolder {
private val authCode: String?
get() {
val data = intent?.data
if (
data is Uri &&
data.scheme == BuildConfig.APPLICATION_ID &&
data.host == ApiConstants.BrowserLogin.REDIRECT_HOST
) {
return data.getQueryParameter(ApiConstants.BrowserLogin.CODE_QUERY_PARAM)
}
return null
}

Expand Down Expand Up @@ -160,12 +149,8 @@ class AppActivity : AppCompatActivity(), InsetHolder, WindowSizeHolder {
WindowCompat.setDecorFitsSystemWindows(this, false)
val insetsController = WindowInsetsControllerCompat(this, binding.root)
insetsController.isAppearanceLightStatusBars = !isUsingNightModeResources()
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.VANILLA_ICE_CREAM) {
insetsController.systemBarsBehavior =
WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE
} else {
window.statusBarColor = Color.TRANSPARENT
}
insetsController.systemBarsBehavior =
WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE
}
}

Expand All @@ -176,7 +161,7 @@ class AppActivity : AppCompatActivity(), InsetHolder, WindowSizeHolder {
val fragment = if (viewModel.isLogistrationEnabled && authCode == null) {
LogistrationFragment()
} else {
SignInFragment.newInstance(null, null, authCode = authCode)
SignInFragment.newInstance(null, null)
}
addFragment(fragment)
}
Expand Down Expand Up @@ -224,7 +209,7 @@ class AppActivity : AppCompatActivity(), InsetHolder, WindowSizeHolder {
this.intent = intent

if (authCode != null) {
addFragment(SignInFragment.newInstance(null, null, authCode = authCode))
addFragment(SignInFragment.newInstance(null, null))
}

val extras = intent.extras
Expand Down
8 changes: 8 additions & 0 deletions app/src/main/java/org/openedx/app/AppRouter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import org.openedx.core.CalendarRouter
import org.openedx.core.FragmentViewType
import org.openedx.core.presentation.global.appupgrade.AppUpgradeRouter
import org.openedx.core.presentation.global.appupgrade.UpgradeRequiredFragment
import org.openedx.core.presentation.global.webview.SSOWebContentFragment
import org.openedx.core.presentation.global.webview.WebContentFragment
import org.openedx.core.presentation.settings.video.VideoQualityFragment
import org.openedx.core.presentation.settings.video.VideoQualityType
Expand Down Expand Up @@ -432,6 +433,13 @@ class AppRouter :
)
}

override fun navigateToSSOWebContent(fm: FragmentManager, title: String, url: String) {
replaceFragmentWithBackStack(
fm,
SSOWebContentFragment.newInstance(title = title, url = url)
)
}

override fun navigateToManageAccount(fm: FragmentManager) {
replaceFragmentWithBackStack(fm, ManageAccountFragment())
}
Expand Down
2 changes: 0 additions & 2 deletions app/src/main/java/org/openedx/app/di/AppModule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import org.openedx.app.room.DatabaseManager
import org.openedx.auth.presentation.AgreementProvider
import org.openedx.auth.presentation.AuthAnalytics
import org.openedx.auth.presentation.AuthRouter
import org.openedx.auth.presentation.sso.BrowserAuthHelper
import org.openedx.auth.presentation.sso.FacebookAuthHelper
import org.openedx.auth.presentation.sso.GoogleAuthHelper
import org.openedx.auth.presentation.sso.MicrosoftAuthHelper
Expand Down Expand Up @@ -215,7 +214,6 @@ val appModule = module {
factory { FacebookAuthHelper() }
factory { GoogleAuthHelper(get()) }
factory { MicrosoftAuthHelper() }
factory { BrowserAuthHelper(get()) }
factory { OAuthHelper(get(), get(), get()) }
factory { VideoPreviewHelper(get(), get()) }

Expand Down
7 changes: 4 additions & 3 deletions app/src/main/java/org/openedx/app/di/ScreenModule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.openedx.app.di

import android.content.res.Resources
import org.koin.androidx.viewmodel.dsl.viewModel
import org.koin.core.qualifier.named
import org.koin.dsl.module
Expand Down Expand Up @@ -108,11 +109,11 @@ val screenModule = module {
get(),
get(),
get(),
get(),
)
}

viewModel { (courseId: String?, infoType: String?, authCode: String) ->
val lang = Resources.getSystem().configuration.locales[0].language
Copy link
Contributor

@IvanStepanok IvanStepanok Oct 2, 2025

Choose a reason for hiding this comment

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

lang is lowercased here but in
SSO_BUTTON_TITLE:
AR: "الدخول عبر SSO"
EN: "Sign in with SSO"

parameters are uppercased. Can’t check this because in current implementation we are ignoring SSO_BUTTON_TITLE

viewModel { (courseId: String?, infoType: String?) ->
SignInViewModel(
get(),
get(),
Expand All @@ -130,7 +131,7 @@ val screenModule = module {
get(),
courseId,
infoType,
authCode,
lang
)
}

Expand Down
11 changes: 0 additions & 11 deletions auth/src/main/java/org/openedx/auth/data/api/AuthApi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,6 @@ interface AuthApi {
@Field("asymmetric_jwt") isAsymmetricJwt: Boolean = true,
): AuthResponse

@FormUrlEncoded
@POST(ApiConstants.URL_ACCESS_TOKEN)
suspend fun getAccessTokenFromCode(
@Field("grant_type") grantType: String,
@Field("client_id") clientId: String,
@Field("code") code: String,
@Field("redirect_uri") redirectUri: String,
@Field("token_type") tokenType: String,
@Field("asymmetric_jwt") isAsymmetricJwt: Boolean = true,
): AuthResponse

@FormUrlEncoded
@POST(ApiConstants.URL_ACCESS_TOKEN)
fun refreshAccessToken(
Expand Down
1 change: 0 additions & 1 deletion auth/src/main/java/org/openedx/auth/data/model/AuthType.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,4 @@ enum class AuthType(val postfix: String, val methodName: String) {
GOOGLE(ApiConstants.AUTH_TYPE_GOOGLE, "Google"),
FACEBOOK(ApiConstants.AUTH_TYPE_FB, "Facebook"),
MICROSOFT(ApiConstants.AUTH_TYPE_MICROSOFT, "Microsoft"),
BROWSER(ApiConstants.AUTH_TYPE_BROWSER, "Browser")
}
20 changes: 10 additions & 10 deletions auth/src/main/java/org/openedx/auth/data/repository/AuthRepository.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ class AuthRepository(
.processAuthResponse()
}

suspend fun ssoLogin(
jwtToken: String
) {
if (preferencesManager.accessToken.isBlank()) {
preferencesManager.accessToken = jwtToken
}
val user = api.getProfile()
preferencesManager.user = user
}

suspend fun socialLogin(token: String?, authType: AuthType) {
require(!token.isNullOrBlank()) { "Token is null" }
api.exchangeAccessToken(
Expand All @@ -43,16 +53,6 @@ class AuthRepository(
.processAuthResponse()
}

suspend fun browserAuthCodeLogin(code: String) {
api.getAccessTokenFromCode(
grantType = ApiConstants.GRANT_TYPE_CODE,
clientId = config.getOAuthClientId(),
code = code,
redirectUri = "${config.getAppId()}://${ApiConstants.BrowserLogin.REDIRECT_HOST}",
tokenType = config.getAccessTokenType(),
).mapToDomain().processAuthResponse()
}

suspend fun getRegistrationFields(): List<RegistrationField> {
return api.getRegistrationFields().fields?.map { it.mapToDomain() } ?: emptyList()
}
Expand Down
10 changes: 6 additions & 4 deletions auth/src/main/java/org/openedx/auth/domain/interactor/AuthInteractor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ class AuthInteractor(private val repository: AuthRepository) {
repository.login(username, password)
}

suspend fun loginSocial(token: String?, authType: AuthType) {
repository.socialLogin(token, authType)
suspend fun ssoLogin(
jwtToken: String
) {
repository.ssoLogin(jwtToken)
}

suspend fun loginAuthCode(authCode: String) {
repository.browserAuthCodeLogin(authCode)
suspend fun loginSocial(token: String?, authType: AuthType) {
repository.socialLogin(token, authType)
}

suspend fun getRegistrationFields(): List<RegistrationField> {
Expand Down
2 changes: 2 additions & 0 deletions auth/src/main/java/org/openedx/auth/presentation/AuthRouter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@ interface AuthRouter {

fun navigateToWebContent(fm: FragmentManager, title: String, url: String)

fun navigateToSSOWebContent(fm: FragmentManager, title: String, url: String)

fun clearBackStack(fm: FragmentManager)
}
18 changes: 2 additions & 16 deletions auth/src/main/java/org/openedx/auth/presentation/logistration/LogistrationFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ import androidx.fragment.app.Fragment
import org.koin.androidx.viewmodel.ext.android.viewModel
import org.koin.core.parameter.parametersOf
import org.openedx.auth.R
import org.openedx.core.ApiConstants
import org.openedx.core.ui.AuthButtonsPanel
import org.openedx.core.ui.SearchBar
import org.openedx.core.ui.displayCutoutForLandscape
Expand All @@ -51,7 +50,6 @@ import org.openedx.core.ui.theme.OpenEdXTheme
import org.openedx.core.ui.theme.appColors
import org.openedx.core.ui.theme.appTypography
import org.openedx.core.ui.theme.compose.LogistrationLogoView
import org.openedx.foundation.utils.UrlUtils

class LogistrationFragment : Fragment() {

Expand All @@ -69,22 +67,10 @@ class LogistrationFragment : Fragment() {
OpenEdXTheme {
LogistrationScreen(
onSignInClick = {
if (viewModel.isBrowserLoginEnabled) {
viewModel.signInBrowser(requireActivity())
} else {
viewModel.navigateToSignIn(parentFragmentManager)
}
viewModel.navigateToSignIn(parentFragmentManager)
},
onRegisterClick = {
if (viewModel.isBrowserRegistrationEnabled) {
UrlUtils.openInBrowser(
activity = context,
apiHostUrl = viewModel.apiHostUrl,
url = ApiConstants.URL_REGISTER_BROWSER,
)
} else {
viewModel.navigateToSignUp(parentFragmentManager)
}
viewModel.navigateToSignUp(parentFragmentManager)
},
onSearchClick = { querySearch ->
viewModel.navigateToDiscovery(parentFragmentManager, querySearch)
Expand Down
21 changes: 0 additions & 21 deletions auth/src/main/java/org/openedx/auth/presentation/logistration/LogistrationViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
package org.openedx.auth.presentation.logistration

import android.app.Activity
import androidx.fragment.app.FragmentManager
import androidx.lifecycle.viewModelScope
import kotlinx.coroutines.launch
import org.openedx.auth.presentation.AuthAnalytics
import org.openedx.auth.presentation.AuthAnalyticsEvent
import org.openedx.auth.presentation.AuthAnalyticsKey
import org.openedx.auth.presentation.AuthRouter
import org.openedx.auth.presentation.sso.BrowserAuthHelper
import org.openedx.core.config.Config
import org.openedx.core.utils.Logger
import org.openedx.foundation.extension.takeIfNotEmpty
import org.openedx.foundation.presentation.BaseViewModel

Expand All @@ -19,16 +14,10 @@ class LogistrationViewModel(
private val router: AuthRouter,
private val config: Config,
private val analytics: AuthAnalytics,
private val browserAuthHelper: BrowserAuthHelper,
) : BaseViewModel() {

private val logger = Logger("LogistrationViewModel")

private val discoveryTypeWebView get() = config.getDiscoveryConfig().isViewTypeWebView()
val isRegistrationEnabled get() = config.isRegistrationEnabled()
val isBrowserRegistrationEnabled get() = config.isBrowserRegistrationEnabled()
val isBrowserLoginEnabled get() = config.isBrowserLoginEnabled()
val apiHostUrl get() = config.getApiHostURL()

init {
logLogistrationScreenEvent()
Expand All @@ -39,16 +28,6 @@ class LogistrationViewModel(
logEvent(AuthAnalyticsEvent.SIGN_IN_CLICKED)
}

fun signInBrowser(activityContext: Activity) {
viewModelScope.launch {
runCatching {
browserAuthHelper.signIn(activityContext)
}.onFailure {
logger.e { "Browser auth error: $it" }
}
}
}

fun navigateToSignUp(parentFragmentManager: FragmentManager) {
router.navigateToSignUp(parentFragmentManager, courseId, null)
logEvent(AuthAnalyticsEvent.REGISTER_CLICKED)
Expand Down
Loading
Loading