LibreChat/packages/api/src/auth/user.ts
Marco Beretta 92432e95d5
Some checks are pending
Backend Unit Tests / Build packages (push) Waiting to run
Backend Unit Tests / Codegraph select (push) Waiting to run
Backend Unit Tests / TypeScript type checks (push) Blocked by required conditions
Backend Unit Tests / Circular dependency checks (push) Waiting to run
Backend Unit Tests / Tests: api (shard 1/3) (push) Blocked by required conditions
Backend Unit Tests / Tests: api (shard 2/3) (push) Blocked by required conditions
Backend Unit Tests / Tests: api (shard 3/3) (push) Blocked by required conditions
Backend Unit Tests / Tests: data-provider (push) Blocked by required conditions
Backend Unit Tests / Tests: data-schemas (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 1/4) (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 2/4) (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 3/4) (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 4/4) (push) Blocked by required conditions
Codegraph E2E Votes / vote (full suite) (push) Waiting to run
Docker Dev Branch Images Build / publish (push) Waiting to run
Frontend Unit Tests / Client build recovery regression (push) Waiting to run
Frontend Unit Tests / Codegraph select (push) Waiting to run
Frontend Unit Tests / Build packages (push) Waiting to run
Frontend Unit Tests / TypeScript type checks (client) (push) Blocked by required conditions
Frontend Unit Tests / Tests: @librechat/client (push) Blocked by required conditions
Frontend Unit Tests / Tests: Ubuntu (shard 1/2) (push) Blocked by required conditions
Frontend Unit Tests / Tests: Ubuntu (shard 2/2) (push) Blocked by required conditions
Frontend Unit Tests / Vite build verification (push) Blocked by required conditions
Sync Locize Translations & Create Translation PR / Sync Translation Keys with Locize (push) Waiting to run
Sync Locize Translations & Create Translation PR / Create Translation PR on Version Published (push) Blocked by required conditions
🔐 feat: Enforce Required Two-Factor Authentication (#14731)
* feat: enforce required two-factor authentication

Require local and LDAP accounts to enroll in TOTP before they can use the
app when ENFORCE_TWO_FACTOR_AUTHENTICATION is set. Sign-in, refresh, bearer
verification, optional share auth and image authorization all route an
unenrolled account into a staged setup flow, and every bearer credential
minted before enrollment or a password reset is retired.

Password reset retirement uses the existing credentialsChangedAt stamp, and
commitPasswordReset clears any staged enrollment in the same write. Passkey
sign-in follows the same enrollment gate as password sign-in.

* test: cover passkey sign-in handing off to required enrollment

* refactor: keep Mongoose user types out of two-factor auth contracts

* fix: withdraw a minted session when its retirement recheck fails

* fix: hold Agent API keys and the reset CLI to the required two-factor policy

* fix: adopt a setup token handed off after the setup screen mounted

* fix: move every tab that receives an enrollment hand-off into setup

* fix: read the enrollment gate's retirement cutoff in system scope

* fix: clear minted session cookies before the fallible session deletion

* fix: adopt a setup token persisted before the setup screen subscribed
2026-10-01 23:39:51 +02:00

61 lines
1.6 KiB
TypeScript

import type { TwoFactorAccount } from './twoFactor';
/**
* Everything an authentication response may say about a user.
*
* An allowlist rather than a denylist, because the queries behind these responses do not reliably
* project: a `select()` built only from `+field` tokens leaves Mongoose with no projection to send,
* so the full stored document comes back, secrets and session records included. Subtracting known
* secrets from that would silently leak every field added to the schema afterwards.
*/
export const PUBLIC_USER_RESPONSE_FIELDS = [
'_id',
'id',
'name',
'username',
'email',
'emailVerified',
'avatar',
'provider',
'role',
'plugins',
'twoFactorEnabled',
'termsAccepted',
'personalization',
'favorites',
'skillStates',
'createdAt',
'updatedAt',
'tenantId',
] as const;
type PublicUserField = (typeof PUBLIC_USER_RESPONSE_FIELDS)[number];
export type PublicUser = Partial<Record<PublicUserField, unknown>>;
interface HydratedUser {
toObject?: () => Record<string, unknown>;
}
/** Reduces a user document, hydrated or lean, to the fields a client is allowed to receive. */
export function sanitizeUserForResponse(
user: TwoFactorAccount | HydratedUser | null | undefined,
): PublicUser {
if (user == null) {
return {};
}
const source = (
typeof (user as HydratedUser).toObject === 'function'
? (user as HydratedUser).toObject?.()
: user
) as Record<string, unknown>;
const publicUser: PublicUser = {};
for (const field of PUBLIC_USER_RESPONSE_FIELDS) {
if (source[field] !== undefined) {
publicUser[field] = source[field];
}
}
return publicUser;
}