-
Notifications
You must be signed in to change notification settings - Fork 45
feat(console): support proxy user #260
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
Open
creepysta
wants to merge
1
commit into
apache:main
Choose a base branch
from
creepysta:feat/console/proxy-user
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { useQuery } from "@tanstack/react-query" | ||
| import { config } from "@/lib/config" | ||
|
|
||
| interface ProxyUser { | ||
| displayName: string | null | ||
| principalName: string | null | ||
| loading: boolean | ||
| } | ||
|
|
||
| /** Helper to read a field from the proxy body */ | ||
| function pickField(body: Record<string, unknown>, field: string): string | null { | ||
| const value = body[field.trim()] | ||
| return typeof value === "string" && value !== "" ? value : null | ||
| } | ||
|
|
||
| /** | ||
| * Hook to fetch the authenticated user from the auth proxy (e.g. oauth2-proxy) | ||
| * when the console is deployed behind it (VITE_PROXY_AUTH=true). In this setup | ||
| * the browser never holds the token - the proxy does. Therefore the identity | ||
| * comes from the proxy's userinfo endpoint rather than a decoded JWT. | ||
| * | ||
| * The response body shape is not standardized across proxies, so the keys to | ||
| * read are runtime-configurable: | ||
| * - VITE_PROXY_USER_FIELDS: comma-separated priority list for the header | ||
| * display name. | ||
| * - VITE_PROXY_PRINCIPAL_FIELD: single key holding the Polaris principal | ||
| * name used to fetch principal details/roles (empty = don't fetch). | ||
| * | ||
| * Its a no-op if proxy mode is disabled. Fails silently for any non 200 / non | ||
| * JSON response (e.g. a 401 or a redirect to the IdP when the proxy is absent). | ||
| */ | ||
| export function useProxyUser(): ProxyUser { | ||
| const { data, isLoading } = useQuery<Record<string, unknown> | null>({ | ||
| queryKey: ["proxyUser"], | ||
| queryFn: async () => { | ||
| try { | ||
| const response = await fetch(config.PROXY_USERINFO_PATH, { | ||
| credentials: "include", | ||
| headers: { Accept: "application/json" }, | ||
| }) | ||
| if (!response.ok) { | ||
| return null | ||
| } | ||
| const contentType = response.headers.get("content-type") || "" | ||
| if (!contentType.includes("application/json")) { | ||
| return null | ||
| } | ||
| const body = await response.json() | ||
| return body && typeof body === "object" ? (body as Record<string, unknown>) : null | ||
| } catch { | ||
| return null | ||
| } | ||
| }, | ||
| enabled: config.PROXY_AUTH, | ||
| staleTime: 5 * 60 * 1000, // Cache for 5 minutes | ||
| retry: false, | ||
| }) | ||
|
|
||
| let displayName: string | null = null | ||
| if (data) { | ||
| for (const field of config.PROXY_USER_FIELDS.split(",")) { | ||
| displayName = pickField(data, field) | ||
| if (displayName) { | ||
| break | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const principalName = | ||
| data && config.PROXY_PRINCIPAL_FIELD ? pickField(data, config.PROXY_PRINCIPAL_FIELD) : null | ||
|
|
||
| return { | ||
| displayName, | ||
| principalName, | ||
| loading: config.PROXY_AUTH && isLoading, | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be possible to inject a JWT (id_token most of the time, something access_token but can be a convention like reading a cookie or local storage or query param to capture the state since cookie/local storage can be forbidden in some setup) which is assumed validated somehow (proxied app case where auth is handled by the proxy), hitting userinfo is most of the time overkill