feat(auth): OIDC role mapping + login policy — phase 2 (#798) (#854)

* feat(auth): OIDC role mapping + login policy — phase 2 (#798)

Role mapping: configurable dot-path roles claim (Keycloak realm_access.roles,
Authentik/Pocket ID groups, Entra roles), IdP-value → PicPeak-role mapping
table validated against the roles table, re-evaluated on every SSO login with
highest-priority-wins on multiple matches. The last active super_admin is
never demoted. Optional require-mapped-role policy refuses logins whose token
maps to no role (sso_error=no_role).

Login policy: oidc_disable_local_login makes the API refuse password logins
(403 LOCAL_LOGIN_DISABLED) and the login page render SSO-only; only effective
while SSO is enabled+configured, and OIDC_BREAK_GLASS=true always re-opens
local login. Public settings expose the EFFECTIVE flag only.

Settings UI: Role-mapping card (claim path, mapping rows editor, strict
toggle) and Login-policy card with break-glass hint, EN+DE.

14 new integration tests over the mock IdP.

* fix(auth): harden phase-2 review findings (#798)

- memoize the scrypt-derived OIDC key and serve /public/settings from a
  10s-TTL flag cache — the unauthenticated endpoint no longer pays a
  13-key config read + blocking scryptSync per request (login route
  still checks uncached)
- make the last-super-admin demotion guard atomic (FOR UPDATE on the
  active super rows) — concurrent mapped callbacks could previously
  both count 2 and demote both supers
- own-property lookup in role mapping: IdP values like `constructor`
  now count as unmapped instead of corrupting the roles query
- SsoTab clears oidc_disable_local_login in the same save that turns
  SSO off — the full-form payload otherwise hit the server-side 400

* fix(auth): guarantee break-glass reachability for SSO-only mode (#798)

- wire OIDC_BREAK_GLASS and OIDC_ENCRYPTION_KEY through the quick-start
  docker-compose.yml env allowlist (production compose already passes
  .env via env_file) and document both in .env.example
- refuse enabling oidc_disable_local_login unless an active
  local-password super_admin exists: OIDC_BREAK_GLASS only re-opens the
  password route, which OIDC-owned accounts can never use, and
  settings.edit is super_admin-only — an all-OIDC instance would be
  unrecoverable during an IdP outage

* fix(auth): close SSO-only lockout gaps from review round 3 (#798)

- role sync never demotes the last active LOCAL-password super_admin
  (an OIDC-owned super does not count as break-glass), and
  isLocalLoginDisabled() disarms itself when no such account remains —
  self-healing against manual demotion/deactivation/deletion paths
- the local-super save-time check now validates the MERGED state, so
  re-enabling SSO with a stored disable flag is checked too
- ALL oidc_* keys are reserved from the generic settings upserts/reads
  (prefix match) — policy and mapping invariants can only go through
  the validated PUT /sso
- /admin/login/mfa re-checks the policy so an mfa_pending token minted
  before the flip cannot complete into a local session

---------

Co-authored-by: Paul Nothaft <[email protected]>
This commit is contained in:
Paul Nothaft
2026-07-22 20:59:19 +02:00
committed by GitHub
co-authored by Paul Nothaft
parent ad326da35c
commit f8a95d29d2
13 changed files with 1017 additions and 34 deletions
+188 -6
View File
@@ -2,21 +2,39 @@ import React, { useState } from 'react';
import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query';
import { useTranslation } from 'react-i18next';
import { toast } from 'react-toastify';
import { Save, KeyRound, PlugZap, Copy, Check } from 'lucide-react';
import { Save, KeyRound, PlugZap, Copy, Check, UserCog, ShieldAlert, Plus, Trash2 } from 'lucide-react';
import type { AxiosError } from 'axios';
import { Button, Card, Input, Loading } from '../../../components/common';
import { ssoService, SsoSettings, UpdateSsoSettings } from '../../../services/sso.service';
// SSO (OIDC) settings (#798, phase 1). Deliberately lean: issuer + client
// credentials, JIT toggle with default role, button label. Role-claim
// mapping is a follow-up. The client secret is write-only — the field stays
// blank and only overwrites when the admin types a new value.
interface MappingRow {
idpRole: string;
role: string;
}
// The four system roles — same hardcoded set the default-role select uses.
// The backend re-validates every mapping target against the roles table.
const ROLE_OPTIONS: Record<string, string> = {
viewer: 'Viewer',
editor: 'Editor',
admin: 'Admin',
super_admin: 'Super Admin',
};
// SSO (OIDC) settings (#798). Phase 1: issuer + client credentials, JIT
// toggle with default role, button label. Phase 2: role-claim mapping and
// login policy (require mapped role / disable local login). The client
// secret is write-only — the field stays blank and only overwrites when the
// admin types a new value.
export const SsoTab: React.FC = () => {
const { t } = useTranslation();
const queryClient = useQueryClient();
const [form, setForm] = useState<SsoSettings | null>(null);
// Row-based editor state for the { idpRole: picpeakRole } mapping object —
// an object can't represent a half-typed key, rows can.
const [mappingRows, setMappingRows] = useState<MappingRow[] | null>(null);
const [newSecret, setNewSecret] = useState('');
const [copied, setCopied] = useState(false);
@@ -25,6 +43,8 @@ export const SsoTab: React.FC = () => {
queryFn: async () => {
const settings = await ssoService.getSettings();
setForm((prev) => prev ?? settings);
setMappingRows((prev) => prev
?? Object.entries(settings.oidc_role_mappings || {}).map(([idpRole, role]) => ({ idpRole, role })));
return settings;
},
});
@@ -35,6 +55,7 @@ export const SsoTab: React.FC = () => {
toast.success(t('settings.sso.saved', 'SSO settings saved'));
setNewSecret('');
setForm(null); // re-init from the fresh GET (secret_set flag updates)
setMappingRows(null);
queryClient.invalidateQueries({ queryKey: ['admin-sso-settings'] });
queryClient.invalidateQueries({ queryKey: ['public-settings'] });
},
@@ -57,13 +78,16 @@ export const SsoTab: React.FC = () => {
},
});
if (isLoading || !form) {
if (isLoading || !form || !mappingRows) {
return <Loading />;
}
const set = <K extends keyof SsoSettings>(key: K, value: SsoSettings[K]) =>
setForm((prev) => (prev ? { ...prev, [key]: value } : prev));
const setRow = (index: number, patch: Partial<MappingRow>) =>
setMappingRows((prev) => (prev ? prev.map((row, i) => (i === index ? { ...row, ...patch } : row)) : prev));
const handleSave = () => {
const payload: UpdateSsoSettings = {
oidc_enabled: form.oidc_enabled,
@@ -73,6 +97,16 @@ export const SsoTab: React.FC = () => {
oidc_default_role: form.oidc_default_role,
oidc_button_label: form.oidc_button_label.trim(),
oidc_scopes: form.oidc_scopes.trim(),
oidc_role_mapping_enabled: form.oidc_role_mapping_enabled,
oidc_roles_claim: form.oidc_roles_claim.trim(),
oidc_role_mappings: Object.fromEntries(
mappingRows.filter((row) => row.idpRole.trim()).map((row) => [row.idpRole.trim(), row.role])
),
oidc_require_mapped_role: form.oidc_require_mapped_role,
// Turning SSO off must clear the policy in the same save — the backend
// (rightly) rejects an explicit true while SSO is off, and the promise
// is that disabling SSO restores password login.
oidc_disable_local_login: form.oidc_enabled ? form.oidc_disable_local_login : false,
};
if (newSecret.trim()) payload.oidc_client_secret = newSecret.trim();
saveMutation.mutate(payload);
@@ -244,6 +278,154 @@ export const SsoTab: React.FC = () => {
</p>
</div>
</Card>
{/* Role mapping (#798 phase 2) */}
<Card>
<div className="p-6 space-y-4">
<div className="flex items-center gap-2">
<UserCog className="w-5 h-5 text-neutral-500" />
<h2 className="text-lg font-semibold text-neutral-900 dark:text-neutral-100">
{t('settings.sso.roleMapping.title', 'Role mapping')}
</h2>
</div>
<p className="text-sm text-neutral-600 dark:text-neutral-400">
{t('settings.sso.roleMapping.intro', 'Assign PicPeak roles from a role or group claim in the ID token. Roles are re-evaluated on every SSO login — the IdP becomes the source of truth.')}
</p>
<label className="flex items-start gap-3 pt-1 cursor-pointer">
<input
type="checkbox"
className="mt-0.5 rounded border-neutral-300 dark:border-neutral-600 text-accent focus:ring-primary-500"
checked={form.oidc_role_mapping_enabled}
onChange={(e) => set('oidc_role_mapping_enabled', e.target.checked)}
/>
<span className="min-w-0">
<span className="block text-sm font-medium text-neutral-800 dark:text-neutral-200">
{t('settings.sso.roleMapping.enabled', 'Enable role mapping')}
</span>
<span className="block text-xs text-neutral-500 dark:text-neutral-400">
{t('settings.sso.roleMapping.enabledHint', 'Off: existing admins keep their role and new users get the default role above.')}
</span>
</span>
</label>
{form.oidc_role_mapping_enabled && (
<>
<div className="max-w-md">
<Input
label={t('settings.sso.roleMapping.claim', 'Roles claim (dot-path)')}
placeholder="realm_access.roles"
value={form.oidc_roles_claim}
onChange={(e) => set('oidc_roles_claim', e.target.value)}
/>
<p className="mt-1 text-xs text-neutral-500 dark:text-neutral-400">
{t('settings.sso.roleMapping.claimHint', 'Keycloak: realm_access.roles · Authentik: groups · Entra ID: roles or groups')}
</p>
</div>
<div className="space-y-2">
<p className="text-sm font-medium text-neutral-800 dark:text-neutral-200">
{t('settings.sso.roleMapping.mappings', 'Mappings (IdP value → PicPeak role)')}
</p>
{mappingRows.length === 0 && (
<p className="text-xs text-neutral-500 dark:text-neutral-400">
{t('settings.sso.roleMapping.noMappings', 'No mappings yet — without one, no login gets a role from the IdP.')}
</p>
)}
{mappingRows.map((row, index) => (
<div key={index} className="flex items-center gap-2">
<div className="flex-1 min-w-0">
<Input
placeholder={t('settings.sso.roleMapping.idpValuePlaceholder', 'IdP role or group, e.g. picpeak-admins')}
value={row.idpRole}
onChange={(e) => setRow(index, { idpRole: e.target.value })}
/>
</div>
<select
value={row.role}
onChange={(e) => setRow(index, { role: e.target.value })}
className="px-3 py-2 border border-neutral-300 dark:border-neutral-600 bg-white dark:bg-neutral-800 text-neutral-900 dark:text-neutral-100 rounded-lg focus:ring-2 focus:ring-primary-500"
>
{Object.entries(ROLE_OPTIONS).map(([role, label]) => (
<option key={role} value={role}>{t(`users.roles.${role}`, label)}</option>
))}
</select>
<button
type="button"
onClick={() => setMappingRows((prev) => (prev ? prev.filter((_, i) => i !== index) : prev))}
className="flex-shrink-0 rounded-md p-2 text-neutral-400 hover:text-red-600 transition-colors"
aria-label={t('common.delete', 'Delete')}
title={t('common.delete', 'Delete')}
>
<Trash2 className="w-4 h-4" />
</button>
</div>
))}
<Button
variant="outline"
size="sm"
leftIcon={<Plus className="w-4 h-4" />}
onClick={() => setMappingRows((prev) => [...(prev || []), { idpRole: '', role: 'viewer' }])}
>
{t('settings.sso.roleMapping.addMapping', 'Add mapping')}
</Button>
</div>
<label className="flex items-start gap-3 pt-1 cursor-pointer">
<input
type="checkbox"
className="mt-0.5 rounded border-neutral-300 dark:border-neutral-600 text-accent focus:ring-primary-500"
checked={form.oidc_require_mapped_role}
onChange={(e) => set('oidc_require_mapped_role', e.target.checked)}
/>
<span className="min-w-0">
<span className="block text-sm font-medium text-neutral-800 dark:text-neutral-200">
{t('settings.sso.roleMapping.requireRole', 'Require a mapped role to sign in')}
</span>
<span className="block text-xs text-neutral-500 dark:text-neutral-400">
{t('settings.sso.roleMapping.requireRoleHint', 'Refuse SSO logins whose token maps to no role — only members of the mapped IdP groups get in. The last active Super Admin is never demoted by mapping.')}
</span>
</span>
</label>
</>
)}
</div>
</Card>
{/* Login policy (#798 phase 2) */}
<Card>
<div className="p-6 space-y-4">
<div className="flex items-center gap-2">
<ShieldAlert className="w-5 h-5 text-neutral-500" />
<h2 className="text-lg font-semibold text-neutral-900 dark:text-neutral-100">
{t('settings.sso.policy.title', 'Login policy')}
</h2>
</div>
<label className="flex items-start gap-3 pt-1 cursor-pointer">
<input
type="checkbox"
className="mt-0.5 rounded border-neutral-300 dark:border-neutral-600 text-accent focus:ring-primary-500"
checked={form.oidc_disable_local_login}
onChange={(e) => set('oidc_disable_local_login', e.target.checked)}
/>
<span className="min-w-0">
<span className="block text-sm font-medium text-neutral-800 dark:text-neutral-200">
{t('settings.sso.policy.disableLocalLogin', 'Disable local password login')}
</span>
<span className="block text-xs text-neutral-500 dark:text-neutral-400">
{t('settings.sso.policy.disableLocalLoginHint', 'The login page shows only the SSO button and the API refuses password logins. Only possible while SSO is enabled; turning SSO off restores password login automatically.')}
</span>
</span>
</label>
{form.oidc_disable_local_login && (
<div className="rounded-lg border border-amber-200 dark:border-amber-800 bg-amber-50 dark:bg-amber-900/20 p-3 text-xs text-amber-800 dark:text-amber-300">
{t('settings.sso.policy.breakGlassHint', 'Locked out because the IdP is down or misconfigured? Set the environment variable OIDC_BREAK_GLASS=true on the backend and restart — password login comes back immediately.')}
</div>
)}
</div>
</Card>
</div>
);
};