Add generic OIDC authentication flow #6783
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
palash247
changed the title
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6783 +/- ##
==========================================
- Coverage 63.82% 63.17% -0.65%
==========================================
Files 161 164 +3
Lines 13060 13285 +225
Branches 1803 1834 +31
==========================================
+ Hits 8335 8393 +58
- Misses 4425 4592 +167
Partials 300 300
|
palash247
changed the title
- Added a generic authentication flow for OIDC. - Modified some templates to display OIDC login button. - Added new env variables to support the OIDC auth flow. Mainly, OIDC discovery endpoint is configurable now. - Added new routs for OIDC auth. - Manually tested same flow with Google (without domain verification) and AWS Cognito.
lucasfcnunes
requested changes
Mar 25, 2024
- Fixed typo - Added unit tests cases
palash247
changed the title
|
Hi @arikfr, |
lucasfcnunes
requested changes
Jun 1, 2024
Comment on lines
+48
to
+50
| if response.status_code == 401: | ||
| logger.warning("Failed getting user profile (response code 401).") | ||
| return None |
There was a problem hiding this comment.
what about something like:
if not response.ok:
logger.warning(f"Failed getting user profile (response code {response.status_code}) - {response.text}.")
return None
Comment on lines
+27
to
+30
| if resp.status_code != 200: | ||
| logger.warning( | ||
| f"Unable to get configuration details (response code {resp.status_code}). Configuration URL: {url}" | ||
| ) |
There was a problem hiding this comment.
- Let's consistently use
response(I prefer) orresp.
if not response.ok:
logger.warning(
f"Unable to get configuration details (response code {resp.status_code}). Configuration URL: {url} - {response.text}"
)| name="oidc", | ||
| server_metadata_url=settings.OIDC_ISSUER_URL, | ||
| client_kwargs={ | ||
| "scope": "openid email profile", |
There was a problem hiding this comment.
shouldn't we make the needed scopes a var too?
([Future PR?] propagate/sync groups or roles for "redash_admin"?)
| }, | ||
| ) | ||
|
|
||
| def get_user_profile(access_token): |
There was a problem hiding this comment.
maybe the canonical get_userinfo instead of get_user_profile as profile is just one of the possible scopes. let's to avoid confusion.
| access_token = resp["access_token"] | ||
|
|
||
| if access_token is None: | ||
| logger.warning("Access token missing in call back request.") |
| else: | ||
| org = current_org | ||
|
|
||
| user = create_and_login_user(org, profile["name"], profile["email"]) |
There was a problem hiding this comment.
- maybe allow choosing what field to use as the
name? - if email not verified, should we allow user creation? (avoid possible future CVE)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Description
Generic OIDC login
Note: Seeking feedback
Problem
Currently, Redash is limited to supporting authentication via Google's OIDC. Expanding the authentication support to a generic OIDC flow increases Redash's accessibility and flexibility, making it a more inclusive tool for diverse environments.
Implementation Steps
To fully implement and integrate the generic OIDC authentication flow into Redash, the following steps need to be taken (Open for feedback):
Make OIDC Discovery Endpoint Configurable: This flexibility allows Redash to dynamically adapt to different IdPs by simply modifying configuration parameters.
Implement Routes for OIDC Authentication: Develop new routes within the application to handle the authentication process via OIDC.
Modify Login Templates: Update the UI components, specifically the login page templates, to include an OIDC login button.
Manual Testing with Multiple OIDC IdPs: To ensure compatibility and robustness, manually test the new authentication flow with multiple OIDC IdPs, including but not limited to Google, AWS, Okta, and Auth0. (Tested with Google and AWS Cognito)
Implement Unit Tests
Write Documentation for OIDC Configuration: Create detailed documentation to assist users in configuring OIDC with Redash. This documentation should cover configuration steps for different IdPs.
Mutate OIDC to include domain check: (not sure about this one) Current Google OIDC flow has domain verification, see if this can be made generic.
Replace Google OIDC with generic one
How is this tested?
For testing manually, following steps should be more are less common among different IdPs.
Related Tickets & Documents
#6781
Mobile & Desktop Screenshots/Recordings (if there are UI changes)