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

fix: azure keep using upn if exists #2163

Merged
merged 4 commits into from
Nov 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 3 additions & 1 deletion flask_appbuilder/security/manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,9 @@ def get_oauth_user_info(
log.debug("User info from Azure: %s", me)
# https://learn.microsoft.com/en-us/azure/active-directory/develop/id-token-claims-reference#payload-claims
return {
"email": me["email"],
# To keep backward compatibility with previous versions
# of FAB, we use upn if available, otherwise we use email
"email": me["upn"] if "upn" in me else me["email"],
"first_name": me.get("given_name", ""),
"last_name": me.get("family_name", ""),
"username": me["oid"],
Expand Down
36 changes: 36 additions & 0 deletions tests/security/test_auth_oauth.py
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,42 @@ def test_oauth_user_info_unknown_provider(self):
with self.assertRaises(OAuthProviderUnknown):
self.appbuilder.sm.oauth_user_info("unknown", {})

def test_oauth_user_info_azure_email_upn(self):
self.appbuilder = AppBuilder(self.app, self.db.session)
claims = {
"aud": "test-aud",
"iss": "https://sts.windows.net/test/",
"iat": 7282182129,
"nbf": 7282182129,
"exp": 1000000000,
"amr": ["pwd"],
"email": "test@gmail.com",
"upn": "test@upn.com",
"family_name": "user",
"given_name": "test",
"idp": "live.com",
"name": "Test user",
"oid": "b1a54a40-8dfa-4a6d-a2b8-f90b84d4b1df",
"unique_name": "live.com#test@gmail.com",
"ver": "1.0",
}

# Create an unsigned JWT
unsigned_jwt = jwt.encode(claims, key=None, algorithm="none")
user_info = self.appbuilder.sm.get_oauth_user_info(
"azure", {"access_token": "", "id_token": unsigned_jwt}
)
self.assertEqual(
user_info,
{
"email": "test@upn.com",
"first_name": "test",
"last_name": "user",
"role_keys": [],
"username": "b1a54a40-8dfa-4a6d-a2b8-f90b84d4b1df",
},
)

def test_oauth_user_info_azure(self):
self.appbuilder = AppBuilder(self.app, self.db.session)
claims = {
Expand Down
2 changes: 1 addition & 1 deletion tests/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ def test_get_item_not_found(self):
client = self.app.test_client()
token = self.login(client, USERNAME_ADMIN, PASSWORD_ADMIN)
with model1_data(self.appbuilder.session, 1):
model_id = MODEL1_DATA_SIZE + 1
model_id = self.appbuilder.session.query(func.max(Model1.id)).scalar() + 1
rv = self.auth_client_get(client, token, f"api/v1/model1api/{model_id}")
self.assertEqual(rv.status_code, 404)

Expand Down