Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: skip store_idp_tokens for SAML IdPs (#14243)

Saurya Velagapudiccc4a16ab867
diff --git a/enterprise/server/constants.py b/enterprise/server/constants.py
index cc930b7c4b..e6b845c112 100644
--- a/enterprise/server/constants.py
+++ b/enterprise/server/constants.py
@@ -6,9 +6,12 @@ HOST = os.getenv('WEB_HOST', 'app.all-hands.dev').strip()
# Check if this is a feature environment
# Feature environments have a host format like {some-text}.staging.all-hands.dev
+# or {some-text}.ohe-staging.platform-team.all-hands.dev (for platform-team sandbox)
# Just staging.all-hands.dev doesn't count as a feature environment
IS_STAGING_ENV = bool(
- re.match(r'^.+\.staging\.all-hands\.dev$', HOST) or HOST == 'staging.all-hands.dev'
+ re.match(r'^.+\.staging\.all-hands\.dev$', HOST)
+ or re.match(r'^.+\.ohe-staging\.platform-team\.all-hands\.dev$', HOST)
+ or HOST == 'staging.all-hands.dev'
) # Includes the staging deployment + feature deployments
IS_FEATURE_ENV = (
IS_STAGING_ENV and HOST != 'staging.all-hands.dev'
diff --git a/enterprise/server/routes/auth.py b/enterprise/server/routes/auth.py
index 37f140bcba..1ac296d0ea 100644
--- a/enterprise/server/routes/auth.py
+++ b/enterprise/server/routes/auth.py
@@ -444,9 +444,12 @@ async def keycloak_callback(
idp, idp_type = idp.rsplit(':', 1)
idp_type = idp_type.lower()
- await token_manager.store_idp_tokens(
- ProviderType(idp), user_id, keycloak_access_token
- )
+ # Only fetch/store IdP tokens for OAuth-based IdPs (not SAML)
+ # SAML IdPs don't have OAuth tokens to retrieve from Keycloak's broker endpoint
+ if idp_type != 'saml':
+ await token_manager.store_idp_tokens(
+ ProviderType(idp), user_id, keycloak_access_token
+ )
valid_offline_token = (
await token_manager.validate_offline_token(user_id=user_info.sub)
diff --git a/enterprise/server/routes/users_v1.py b/enterprise/server/routes/users_v1.py
index 9be80de38c..9557b5eb85 100644
--- a/enterprise/server/routes/users_v1.py
+++ b/enterprise/server/routes/users_v1.py
@@ -116,7 +116,7 @@ async def get_current_user_git_organizations(
provider_tokens = await user_context.get_provider_tokens()
if not provider_tokens:
raise HTTPException(
- status_code=status.HTTP_401_UNAUTHORIZED,
+ status_code=status.HTTP_403_FORBIDDEN, # 403 not 401 to avoid frontend logout
detail='Git provider token required.',
)
diff --git a/enterprise/tests/unit/test_user_git_organizations.py b/enterprise/tests/unit/test_user_git_organizations.py
index f2f7e4e562..f5b96c4a1c 100644
--- a/enterprise/tests/unit/test_user_git_organizations.py
+++ b/enterprise/tests/unit/test_user_git_organizations.py
@@ -26,8 +26,12 @@ def _make_user_context(provider_tokens, user_id: str = 'user-1') -> UserContext:
@pytest.mark.asyncio
-async def test_raises_401_when_no_provider_tokens():
- """Without provider tokens the endpoint refuses the request."""
+async def test_raises_403_when_no_provider_tokens():
+ """Without provider tokens the endpoint refuses the request with 403 Forbidden.
+
+ Note: Uses 403 (not 401) to avoid triggering automatic logout in the frontend.
+ The user is authenticated but lacks the required git provider token.
+ """
# Arrange
from server.routes.users_v1 import get_current_user_git_organizations
@@ -38,7 +42,7 @@ async def test_raises_401_when_no_provider_tokens():
await get_current_user_git_organizations(user_context=user_context)
# Assert
- assert excinfo.value.status_code == status.HTTP_401_UNAUTHORIZED
+ assert excinfo.value.status_code == status.HTTP_403_FORBIDDEN
@pytest.mark.asyncio
diff --git a/openhands/app_server/git/git_router.py b/openhands/app_server/git/git_router.py
index d580d6e8fb..83b266eea3 100644
--- a/openhands/app_server/git/git_router.py
+++ b/openhands/app_server/git/git_router.py
@@ -66,8 +66,10 @@ async def search_user_installations(
# Get provider tokens from user context
provider_tokens = await user_context.get_provider_tokens()
if not provider_tokens:
+ # User is authenticated but has no git provider connected
+ # Return 403 Forbidden (not 401) to avoid triggering frontend logout
raise HTTPException(
- status_code=status.HTTP_401_UNAUTHORIZED,
+ status_code=status.HTTP_403_FORBIDDEN,
detail='Git provider token required (such as GitHub).',
)
@@ -133,7 +135,7 @@ async def search_repositories(
provider_tokens = await user_context.get_provider_tokens()
if not provider_tokens:
raise HTTPException(
- status_code=status.HTTP_401_UNAUTHORIZED,
+ status_code=status.HTTP_403_FORBIDDEN, # 403 not 401 to avoid frontend logout
detail='Git provider token required (such as GitHub).',
)
@@ -224,7 +226,7 @@ async def search_branches(
provider_tokens = await user_context.get_provider_tokens()
if not provider_tokens:
raise HTTPException(
- status_code=status.HTTP_401_UNAUTHORIZED,
+ status_code=status.HTTP_403_FORBIDDEN, # 403 not 401 to avoid frontend logout
detail='Git provider token required (such as GitHub).',
)
@@ -296,7 +298,7 @@ async def search_suggested_tasks(
provider_tokens = await user_context.get_provider_tokens()
if not provider_tokens:
raise HTTPException(
- status_code=status.HTTP_401_UNAUTHORIZED,
+ status_code=status.HTTP_403_FORBIDDEN, # 403 not 401 to avoid frontend logout
detail='Git provider token required (such as GitHub).',
)
diff --git a/openhands/app_server/user/user_router.py b/openhands/app_server/user/user_router.py
index 2e8fc4331b..5585583ef8 100644
--- a/openhands/app_server/user/user_router.py
+++ b/openhands/app_server/user/user_router.py
@@ -48,5 +48,11 @@ async def get_current_user_git_info(
"""Get the current authenticated user's metadata from the git provider."""
user = await user_context.get_user_git_info()
if user is None:
- raise HTTPException(status.HTTP_401_UNAUTHORIZED, detail='Not authenticated')
+ # Return 403 Forbidden (not 401) when user has no git provider connected
+ # 401 would trigger frontend logout, but the user IS authenticated - they just
+ # don't have a git provider (e.g., logged in via SAML without GitHub linked)
+ raise HTTPException(
+ status.HTTP_403_FORBIDDEN,
+ detail='Git provider not connected',
+ )
return user
diff --git a/tests/unit/app_server/test_git_router.py b/tests/unit/app_server/test_git_router.py
index 1a4da33752..f2c8468c83 100644
--- a/tests/unit/app_server/test_git_router.py
+++ b/tests/unit/app_server/test_git_router.py
@@ -132,8 +132,8 @@ def test_client():
class TestInstallationsEndpoint:
"""Test suite for /installations endpoint."""
- def test_returns_401_when_no_provider_tokens(self, test_client):
- """Test that 401 is returned when no provider tokens."""
+ def test_returns_403_when_no_provider_tokens(self, test_client):
+ """Test that 403 is returned when no provider tokens."""
with patch(
'openhands.app_server.user.auth_user_context.AuthUserContext.get_provider_tokens',
AsyncMock(return_value=None),
@@ -141,7 +141,7 @@ class TestInstallationsEndpoint:
response = test_client.get(
'/git/installations/search', params={'provider': 'github'}
)
- assert response.status_code == status.HTTP_401_UNAUTHORIZED
+ assert response.status_code == status.HTTP_403_FORBIDDEN
def test_returns_422_for_unsupported_provider(self, test_client):
"""Test that 422 is returned for unsupported provider."""
@@ -685,8 +685,8 @@ class TestSearchRepositories:
assert result.items == []
assert result.next_page_id is None
- def test_returns_401_when_no_provider_tokens(self, test_client, monkeypatch):
- """Test that 401 is returned when no provider tokens."""
+ def test_returns_403_when_no_provider_tokens(self, test_client, monkeypatch):
+ """Test that 403 is returned when no provider tokens."""
with patch(
'openhands.app_server.user.auth_user_context.AuthUserContext.get_provider_tokens',
AsyncMock(return_value=None),
@@ -695,7 +695,7 @@ class TestSearchRepositories:
'/git/repositories/search',
params={'provider': 'github', 'query': 'test'},
)
- assert response.status_code == status.HTTP_401_UNAUTHORIZED
+ assert response.status_code == status.HTTP_403_FORBIDDEN
@pytest.mark.asyncio
@@ -774,8 +774,8 @@ class TestSearchBranches:
assert call_kwargs.get('query') == 'feature'
assert call_kwargs.get('per_page') == 11 # limit + 1
- def test_returns_401_when_no_provider_tokens(self, test_client):
- """Test that 401 is returned when no provider tokens."""
+ def test_returns_403_when_no_provider_tokens(self, test_client):
+ """Test that 403 is returned when no provider tokens."""
with patch(
'openhands.app_server.user.auth_user_context.AuthUserContext.get_provider_tokens',
AsyncMock(return_value=None),
@@ -788,7 +788,7 @@ class TestSearchBranches:
'query': 'main',
},
)
- assert response.status_code == status.HTTP_401_UNAUTHORIZED
+ assert response.status_code == status.HTTP_403_FORBIDDEN
@pytest.mark.asyncio
@@ -927,11 +927,11 @@ class TestSearchSuggestedTasks:
assert result.items == []
assert result.next_page_id is None
- def test_returns_401_when_no_provider_tokens(self, test_client):
- """Test that 401 is returned when no provider tokens."""
+ def test_returns_403_when_no_provider_tokens(self, test_client):
+ """Test that 403 is returned when no provider tokens."""
with patch(
'openhands.app_server.user.auth_user_context.AuthUserContext.get_provider_tokens',
AsyncMock(return_value=None),
):
response = test_client.get('/git/suggested-tasks/search')
- assert response.status_code == status.HTTP_401_UNAUTHORIZED
+ assert response.status_code == status.HTTP_403_FORBIDDEN
diff --git a/tests/unit/app_server/test_user_git_info.py b/tests/unit/app_server/test_user_git_info.py
index e6f35a7f60..a2f89bc4ca 100644
--- a/tests/unit/app_server/test_user_git_info.py
+++ b/tests/unit/app_server/test_user_git_info.py
@@ -67,8 +67,13 @@ class TestGetCurrentUserGitInfo:
assert result.name is None
assert result.email is None
- async def test_raises_401_when_user_git_info_is_none(self, mock_user_context):
- """When get_user_git_info returns None, raises 401 Unauthorized."""
+ async def test_raises_403_when_user_git_info_is_none(self, mock_user_context):
+ """When get_user_git_info returns None, raises 403 Forbidden.
+
+ We use 403 (not 401) because the user IS authenticated - they just don't
+ have a git provider connected (e.g., logged in via SAML without GitHub linked).
+ Using 401 would trigger frontend logout behavior.
+ """
from fastapi import HTTPException
mock_user_context.get_user_git_info = AsyncMock(return_value=None)
@@ -78,8 +83,8 @@ class TestGetCurrentUserGitInfo:
with pytest.raises(HTTPException) as exc_info:
await get_current_user_git_info(user_context=mock_user_context)
- assert exc_info.value.status_code == 401
- assert 'Not authenticated' in exc_info.value.detail
+ assert exc_info.value.status_code == 403
+ assert 'Git provider not connected' in exc_info.value.detail
mock_user_context.get_user_git_info.assert_called_once()
async def test_raises_401_when_user_git_info_returns_none_for_company(