- TOTP (RFC 6238) next to email and WhatsApp: QR code and key to set up, the app's first code confirms it, a code can't be used twice, nothing is sent. The secret is stored encrypted. - 10 single-use recovery codes whenever two-factor is turned on, shown once; accepted at sign-in in place of any code; a new set on request. - Admins see each account's method; Reset 2FA clears the app and codes. - Profile & Security, sign-in and Users pages; API types; 10 new tests. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
72 lines
2.8 KiB
TypeScript
72 lines
2.8 KiB
TypeScript
export type AuthUser = {
|
|
id: string;
|
|
name: string;
|
|
email: string;
|
|
role?: "admin" | "supervisor" | "staff" | "user";
|
|
phoneNumber?: string | null;
|
|
notificationPreference?: "email" | "whatsapp" | "both";
|
|
twoFactorEnabled?: boolean;
|
|
twoFactorMethod?: TwoFactorMethod | null;
|
|
// True for roles that must use 2FA (admin, supervisor) — it can't be turned off.
|
|
twoFactorRequired?: boolean;
|
|
// POPIA: hasn't answered the "news and announcements" opt-in question yet (asked once).
|
|
newsPromptPending?: boolean;
|
|
// POPIA: a privacy notice version they must accept has been published since they last did.
|
|
// Why the privacy notice must be accepted after login: never accepted, or a newer version needs it.
|
|
noticePromptPending?: false | "first" | "updated";
|
|
// Multi-campus: their home campus (the events page starts on it).
|
|
homeCampusId?: string | null;
|
|
// Campus-scoped staff: the campuses they're limited to (null = every campus).
|
|
campusScope?: string[] | null;
|
|
};
|
|
|
|
export type AuthResponse = AuthUser & {
|
|
token: string;
|
|
// Only present when the user ticked "Trust this device" on the 2FA step.
|
|
deviceToken?: string;
|
|
};
|
|
|
|
export type TwoFactorMethod = "email" | "whatsapp" | "authenticator";
|
|
|
|
// What the login endpoint returns instead of a token when the account has 2FA on:
|
|
// a code was sent to `destination` (masked) and must be exchanged for the token.
|
|
export type TwoFactorChallenge = {
|
|
twoFactorRequired?: true;
|
|
challengeId: string;
|
|
method: TwoFactorMethod;
|
|
destination: string;
|
|
// The role requires 2FA and it wasn't on yet: verifying this code turns it on.
|
|
enrolling?: boolean;
|
|
// 2.3.0, setting up an authenticator app: the key and its otpauth:// link (shown as a QR code).
|
|
secret?: string;
|
|
otpauthUrl?: string;
|
|
};
|
|
|
|
export function isTwoFactorChallenge(res: unknown): res is TwoFactorChallenge {
|
|
return !!res && typeof res === "object" && (res as TwoFactorChallenge).twoFactorRequired === true;
|
|
}
|
|
|
|
const TOKEN_KEY = "hope_events_token";
|
|
// Remembers this browser after a 2FA code so the next login can skip it. Kept on
|
|
// logout on purpose — it identifies the device, not the session.
|
|
const DEVICE_KEY = "hope_events_device";
|
|
|
|
export function saveDeviceToken(token: string) {
|
|
if (typeof window !== "undefined") localStorage.setItem(DEVICE_KEY, token);
|
|
}
|
|
export function getDeviceToken(): string | null {
|
|
if (typeof window === "undefined") return null;
|
|
return localStorage.getItem(DEVICE_KEY);
|
|
}
|
|
|
|
export function saveToken(token: string) {
|
|
if (typeof window !== "undefined") localStorage.setItem(TOKEN_KEY, token);
|
|
}
|
|
export function getToken(): string | null {
|
|
if (typeof window === "undefined") return null;
|
|
return localStorage.getItem(TOKEN_KEY);
|
|
}
|
|
export function clearToken() {
|
|
if (typeof window !== "undefined") localStorage.removeItem(TOKEN_KEY);
|
|
}
|