diff --git a/src/account/Fallback.tsx b/src/account/Fallback.tsx
index 35a16f49..8ef67146 100644
--- a/src/account/Fallback.tsx
+++ b/src/account/Fallback.tsx
@@ -7,6 +7,7 @@ import { assert, type Equals } from "tsafe/assert";
const Password = lazy(() => import("keycloakify/account/pages/Password"));
const Account = lazy(() => import("keycloakify/account/pages/Account"));
const Sessions = lazy(() => import("keycloakify/account/pages/Sessions"));
+const Totp = lazy(() => import("keycloakify/account/pages/Totp"));
export default function Fallback(props: PageProps) {
const { kcContext, ...rest } = props;
@@ -21,6 +22,8 @@ export default function Fallback(props: PageProps) {
return ;
case "account.ftl":
return ;
+ case "totp.ftl":
+ return ;
}
assert>(false);
})()}
diff --git a/src/account/kcContext/KcContext.ts b/src/account/kcContext/KcContext.ts
index 826a4fa0..9b8a75cd 100644
--- a/src/account/kcContext/KcContext.ts
+++ b/src/account/kcContext/KcContext.ts
@@ -3,7 +3,7 @@ import { assert } from "tsafe/assert";
import type { Equals } from "tsafe";
import { type ThemeType } from "keycloakify/bin/constants";
-export type KcContext = KcContext.Password | KcContext.Account | KcContext.Sessions;
+export type KcContext = KcContext.Password | KcContext.Account | KcContext.Sessions | KcContext.Totp;
export declare namespace KcContext {
export type Common = {
@@ -134,6 +134,49 @@ export declare namespace KcContext {
};
stateChecker: string;
};
+
+ export type Totp = Common & {
+ pageId: "totp.ftl";
+ totp: {
+ totpSecretEncoded: string;
+ qrUrl: string;
+ policy: {
+ algorithm: "HmacSHA1" | "HmacSHA256" | "HmacSHA512";
+ digits: number;
+ lookAheadWindow: number;
+ } & (
+ | {
+ type: "totp";
+ period: number;
+ }
+ | {
+ type: "hotp";
+ initialCounter: number;
+ }
+ );
+ supportedApplications: string[];
+ totpSecretQrCode: string;
+ manualUrl: string;
+ totpSecret: string;
+ otpCredentials: { id: string; userLabel: string }[];
+ };
+ url: {
+ accountUrl: string;
+ passwordUrl: string;
+ totpUrl: string;
+ socialUrl: string;
+ sessionsUrl: string;
+ applicationsUrl: string;
+ logUrl: string;
+ resourceUrl: string;
+ resourcesCommonPath: string;
+ resourcesPath: string;
+ /** @deprecated, not present in recent keycloak version apparently, use kcContext.referrer instead */
+ referrerURI?: string;
+ getLogoutUrl: () => string;
+ };
+ stateChecker: string;
+ };
}
{
diff --git a/src/account/kcContext/kcContextMocks.ts b/src/account/kcContext/kcContextMocks.ts
index 9b13b89b..0d85c572 100644
--- a/src/account/kcContext/kcContextMocks.ts
+++ b/src/account/kcContext/kcContextMocks.ts
@@ -199,5 +199,27 @@ export const kcContextMocks: KcContext[] = [
]
},
"stateChecker": ""
+ }),
+ id({
+ ...kcContextCommonMock,
+ "pageId": "totp.ftl",
+ totp: {
+ totpSecretEncoded: "KVVF G2BY N4YX S6LB IUYT K2LH IFYE 4SBV",
+ qrUrl: "#",
+ totpSecretQrCode:
+ "iVBORw0KGgoAAAANSUhEUgAAAPYAAAD2AQAAAADNaUdlAAACM0lEQVR4Xu3OIZJgOQwDUDFd2UxiurLAVnnbHw4YGDKtSiWOn4Gxf81//7r/+q8b4HfLGBZDK9d85NmNR+sB42sXvOYrN5P1DcgYYFTGfOlbzE8gzwy3euweGizw7cfdl34/GRhlkxjKNV+5AebPXPORX1JuB9x8ZfbyyD2y1krWAKsbMq1HnqQDaLfa77p4+MqvzEGSqvSAD/2IHW2yHaigR9tX3m8dDIYGcNf3f+gDpVBZbZU77zyJ6Rlcy+qoTMG887KAPD9hsh6a1Sv3gJUHGHUAxSMzj7zqDDe7Phmt2eG+8UsMxjRGm816MAO+8VMl1R1jGHOrZB/5Zo/WXAPgxixm9Mo96vDGrM1eOto8c4Ax4wF437mifOXlpiPzCnN7Y9l95NnEMxgMY9AAGA8fucH14Y1aVb6N/cqrmyh0BVht7k1e+bU8LK0Cg5vmVq9c5vHIjOfqxDIfeTraNVTwewa4wVe+SW5N+uP1qACeudUZbqGOfA6VZV750Noq2Xx3kpveV44ZelSV1V7KFHzkWyVrrlUwG0Pl9pWnoy3vsQoME6vKI69i5osVgwWzHT7zjmJtMcNUSVn1oYMd7ZodbgowZl45VG0uVuLPUr1yc79uaQBag/mqR34xhlWyHm1prplHboCWdZ4TeZjsK8+dI+jbz1C5hl65mcpgB5dhcj8+dGO+0Ko68+lD37JDD83dpDLzzK+TrQyaVwGj6pUboGV+7+AyN8An/pf84/7rv/4/1l4OCc/1BYMAAAAASUVORK5CYII=",
+ manualUrl: "#",
+ totpSecret: "G4nsI8lQagRMUchH8jEG",
+ otpCredentials: [],
+ supportedApplications: ["FreeOTP", "Google Authenticator"],
+ policy: {
+ algorithm: "HmacSHA1",
+ digits: 6,
+ lookAheadWindow: 1,
+ type: "totp",
+ period: 30
+ }
+ },
+ "stateChecker": ""
})
];
diff --git a/src/account/pages/Totp.tsx b/src/account/pages/Totp.tsx
new file mode 100644
index 00000000..66c0594a
--- /dev/null
+++ b/src/account/pages/Totp.tsx
@@ -0,0 +1,186 @@
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/account/pages/PageProps";
+import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function Totp(props: PageProps, I18n>) {
+ const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+ const { getClassName } = useGetClassName({
+ doUseDefaultCss,
+ classes
+ });
+
+ const { url, isAppInitiatedAction, totp, mode, messagesPerField } = kcContext;
+
+ const { msg, msgStr } = i18n;
+
+ const algToKeyUriAlg: Record<(typeof kcContext)["totp"]["policy"]["algorithm"], string> = {
+ "HmacSHA1": "SHA1",
+ "HmacSHA256": "SHA256",
+ "HmacSHA512": "SHA512"
+ };
+
+ return (
+
+ <>
+
+ -
+
{msg("loginTotpStep1")}
+
+
+ {totp.supportedApplications.map(app => (
+ - {msg(app as MessageKey)}
+ ))}
+
+
+
+ {mode && mode == "manual" ? (
+ <>
+ -
+
{msg("loginTotpManualStep2")}
+
+ {totp.totpSecretEncoded}
+
+
+
+ {msg("loginTotpScanBarcode")}
+
+
+
+ -
+
{msg("loginTotpManualStep3")}
+
+
+ -
+ {msg("loginTotpType")}: {msg(`loginTotp.${totp.policy.type}`)}
+
+ -
+ {msg("loginTotpAlgorithm")}: {algToKeyUriAlg?.[totp.policy.algorithm] ?? totp.policy.algorithm}
+
+ -
+ {msg("loginTotpDigits")}: {totp.policy.digits}
+
+ {totp.policy.type === "totp" ? (
+ -
+ {msg("loginTotpInterval")}: {totp.policy.period}
+
+ ) : (
+ -
+ {msg("loginTotpCounter")}: {totp.policy.initialCounter}
+
+ )}
+
+
+
+ >
+ ) : (
+
+ {msg("loginTotpStep2")}
+
+
+
+
+ {msg("loginTotpUnableToScan")}
+
+
+
+ )}
+
+ {msg("loginTotpStep3")}
+ {msg("loginTotpStep3DeviceName")}
+
+
+
+
+ >
+
+ );
+}
diff --git a/src/bin/keycloakify/generateFtl/pageId.ts b/src/bin/keycloakify/generateFtl/pageId.ts
index 70062ac0..3688198c 100644
--- a/src/bin/keycloakify/generateFtl/pageId.ts
+++ b/src/bin/keycloakify/generateFtl/pageId.ts
@@ -27,7 +27,7 @@ export const loginThemePageIds = [
"saml-post-form.ftl"
] as const;
-export const accountThemePageIds = ["password.ftl", "account.ftl", "sessions.ftl"] as const;
+export const accountThemePageIds = ["password.ftl", "account.ftl", "sessions.ftl", "totp.ftl"] as const;
export type LoginThemePageId = (typeof loginThemePageIds)[number];
export type AccountThemePageId = (typeof accountThemePageIds)[number];
diff --git a/stories/account/pages/Sessions.stories.tsx b/stories/account/pages/Sessions.stories.tsx
index b5d882aa..250c53b0 100644
--- a/stories/account/pages/Sessions.stories.tsx
+++ b/stories/account/pages/Sessions.stories.tsx
@@ -23,10 +23,4 @@ export default meta;
export const Default = () => ;
-export const WithMessage = () => (
-
-);
+export const WithMessage = () => ;
diff --git a/stories/account/pages/Totp.stories.tsx b/stories/account/pages/Totp.stories.tsx
new file mode 100644
index 00000000..4807f799
--- /dev/null
+++ b/stories/account/pages/Totp.stories.tsx
@@ -0,0 +1,51 @@
+import React from "react";
+import type { ComponentMeta } from "@storybook/react";
+import { createPageStory } from "../createPageStory";
+
+const pageId = "totp.ftl";
+
+const { PageStory } = createPageStory({ pageId });
+
+const meta: ComponentMeta = {
+ title: `account/${pageId}`,
+ component: PageStory,
+ parameters: {
+ viewMode: "story",
+ previewTabs: {
+ "storybook/docs/panel": {
+ hidden: true
+ }
+ }
+ }
+};
+
+export default meta;
+
+export const Default = () => (
+
+);