Skip to content
Open
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
6 changes: 5 additions & 1 deletion console/docker/generate-config.sh
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ window.APP_CONFIG = {
VITE_OIDC_ISSUER_URL: '${VITE_OIDC_ISSUER_URL}',
VITE_OIDC_CLIENT_ID: '${VITE_OIDC_CLIENT_ID}',
VITE_OIDC_REDIRECT_URI: '${VITE_OIDC_REDIRECT_URI}',
VITE_OIDC_SCOPE: '${VITE_OIDC_SCOPE}'
VITE_OIDC_SCOPE: '${VITE_OIDC_SCOPE}',
VITE_PROXY_AUTH: '${VITE_PROXY_AUTH}',
VITE_PROXY_USERINFO_PATH: '${VITE_PROXY_USERINFO_PATH}',
VITE_PROXY_USER_FIELDS: '${VITE_PROXY_USER_FIELDS}',
VITE_PROXY_PRINCIPAL_FIELD: '${VITE_PROXY_PRINCIPAL_FIELD}'
};
EOF

Expand Down
22 changes: 19 additions & 3 deletions console/src/components/layout/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import { LogOut, ChevronDown, Sun, Moon, Monitor, Search } from "lucide-react"
import { useAuth } from "@/hooks/useAuth"
import { useCurrentUser } from "@/hooks/useCurrentUser"
import { useProxyUser } from "@/hooks/useProxyUser"
import { useTheme } from "@/hooks/useTheme"
import { config } from "@/lib/config"
import {
Expand All @@ -38,12 +39,27 @@ interface HeaderProps {

export function Header({ onSearchOpen }: HeaderProps) {
const { logout } = useAuth()
const { principal, principalRoles, loading } = useCurrentUser()
const {
displayName: proxyDisplayName,
principalName: proxyPrincipalName,
loading: proxyLoading,
} = useProxyUser()
const {
principal,
principalRoles,
loading: principalLoading,
} = useCurrentUser(proxyPrincipalName)
const { theme, setTheme } = useTheme()

// Get display name and role
const loading = principalLoading || proxyLoading

// Get display name and role — prefer the proxy identity when deployed behind the auth proxy
const displayName =
principal?.name || principal?.properties?.displayName || principal?.properties?.name || "User"
proxyDisplayName ||
principal?.name ||
principal?.properties?.displayName ||
principal?.properties?.name ||
"User"
const primaryRole =
principalRoles.length > 0
? principalRoles[0].name
Expand Down
3 changes: 2 additions & 1 deletion console/src/hooks/useAuth.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { createContext, useContext, useState, type ReactNode } from "react"
import { toast } from "sonner"
import { authApi } from "@/api/auth"
import { apiClient } from "@/api/client"
import { config } from "@/lib/config"

interface AuthContextType {
isAuthenticated: boolean
Expand All @@ -34,7 +35,7 @@ interface AuthContextType {
const AuthContext = createContext<AuthContextType | undefined>(undefined)

export function AuthProvider({ children }: { children: ReactNode }) {
const [isAuthenticated, setIsAuthenticated] = useState<boolean>(false)
const [isAuthenticated, setIsAuthenticated] = useState<boolean>(config.PROXY_AUTH)
const [loading] = useState<boolean>(false)

const login = async (clientId: string, clientSecret: string, scope: string) => {
Expand Down
6 changes: 3 additions & 3 deletions console/src/hooks/useCurrentUser.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ interface CurrentUserInfo {
* Hook to fetch the current logged-in user's principal information
* Decodes the JWT token to get the principal name, then fetches full details
*/
export function useCurrentUser(): CurrentUserInfo {
export function useCurrentUser(principalNameOverride?: string | null): CurrentUserInfo {
const token = apiClient.getAccessToken()

// Get principal name from token
const principalName = token ? getPrincipalNameFromToken(token) : null
// Use the override (e.g. proxy-provided) principal name, else fall back to the token
const principalName = principalNameOverride ?? (token ? getPrincipalNameFromToken(token) : null)

// Fetch principal details
const {
Expand Down
96 changes: 96 additions & 0 deletions console/src/hooks/useProxyUser.tsx
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 () => {

Copy link
Copy Markdown

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

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,
}
}
8 changes: 8 additions & 0 deletions console/src/lib/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ interface AppConfig {
VITE_OIDC_CLIENT_ID?: string
VITE_OIDC_REDIRECT_URI?: string
VITE_OIDC_SCOPE?: string
VITE_PROXY_AUTH?: string
VITE_PROXY_USERINFO_PATH?: string
VITE_PROXY_USER_FIELDS?: string
VITE_PROXY_PRINCIPAL_FIELD?: string
}

declare global {
Expand Down Expand Up @@ -59,4 +63,8 @@ export const config = {
OIDC_CLIENT_ID: getConfig("VITE_OIDC_CLIENT_ID", ""),
OIDC_REDIRECT_URI: getConfig("VITE_OIDC_REDIRECT_URI", ""),
OIDC_SCOPE: getConfig("VITE_OIDC_SCOPE", "openid profile email"),
PROXY_AUTH: getConfig("VITE_PROXY_AUTH", "false") === "true",
PROXY_USERINFO_PATH: getConfig("VITE_PROXY_USERINFO_PATH", "/oauth2/userinfo"),
PROXY_USER_FIELDS: getConfig("VITE_PROXY_USER_FIELDS", "preferredUsername,user,email"),
PROXY_PRINCIPAL_FIELD: getConfig("VITE_PROXY_PRINCIPAL_FIELD", ""),
}
Loading