refactor: generalize OIDC configuration and add documentation#5408
Open
soorya38 wants to merge 3 commits intolitmuschaos:masterfrom
Open
refactor: generalize OIDC configuration and add documentation#5408soorya38 wants to merge 3 commits intolitmuschaos:masterfrom
soorya38 wants to merge 3 commits intolitmuschaos:masterfrom
Conversation
Signed-off-by: soorya38 <csasoorya@gmail.com>
Summary The authentication system works great with any OIDC provider (we're using Keycloak), but the naming throughout the codebase is Dex-specific which is confusing. Current Issues - Callback endpoint: /auth/dex/callback - hardcoded with 'dex' in the path - Environment variables: DEX_OAUTH_CALLBACK_URL, DEX_OAUTH_CLIENT_ID, DEX_OAUTH_CLIENT_SECRET, DEX_ENABLED - Documentation: Focuses heavily on Dex setup rather than generic OIDC configuration Changes - Rename callback/login endpoint: /auth/dex/callback -> /auth/oauth2/callback - Rename env variables: - DEX_ENABLED -> OIDC_ENABLED - DEX_OAUTH_CALLBACK_URL -> OAUTH_CALLBACK_URL - DEX_OAUTH_CLIENT_ID -> OAUTH_CLIENT_ID - DEX_OAUTH_CLIENT_SECRET -> OAUTH_CLIENT_SECRET - Update docs to explain generic OIDC setup with Dex as one example Signed-off-by: soorya38 <csasoorya@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR refactors the authentication configuration to use generic OIDC naming conventions, moving away from Dex-specific strict naming. This clarifies that Litmus supports any OIDC provider, not just Dex.
Key Changes:
DEX_ENABLED→OIDC_ENABLED,DEX_OAUTH_CLIENT_ID→OAUTH_CLIENT_ID)./auth/dex/callbackto/auth/oauth2/callback.Related issue: #5391
Types of changes
What types of changes does your code introduce to Litmus? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Dependency
Special notes for your reviewer:
BREAKING CHANGE: usage of
DEX_*environment variables (e.g.DEX_ENABLED,DEX_OAUTH_CALLBACK_URL) has been replaced by genericOIDC_*andOAUTH_*variables. Users upgrading to this version will need to update their deployment manifests to match the new variable names.