keycloakify 9.6.7 → 10.0.0-rc.0

package/src/login/pages/LoginRecoveryAuthnCodeConfig.tsx

@@ -0,0 +1,260 @@
+import { useEffect } from "react";
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import { createUseInsertScriptTags } from "keycloakify/tools/useInsertScriptTags";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+const { useInsertScriptTags } = createUseInsertScriptTags();
+
+export default function LoginRecoveryAuthnCodeConfig(props: PageProps<Extract<KcContext, { pageId: "login-recovery-authn-code-config.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { recoveryAuthnCodesConfigBean, isAppInitiatedAction } = kcContext;
+
+    const { msg, msgStr } = i18n;
+
+    const { insertScriptTags } = useInsertScriptTags({
+        "scriptTags": [
+            {
+                "type": "text/javascript",
+                "textContent": `
+
+                    /* copy recovery codes  */
+                    function copyRecoveryCodes() {
+                        var tmpTextarea = document.createElement("textarea");
+                        var codes = document.getElementById("kc-recovery-codes-list").getElementsByTagName("li");
+                        for (i = 0; i < codes.length; i++) {
+                            tmpTextarea.value = tmpTextarea.value + codes[i].innerText + "\n";
+                        }
+                        document.body.appendChild(tmpTextarea);
+                        tmpTextarea.select();
+                        document.execCommand("copy");
+                        document.body.removeChild(tmpTextarea);
+                    }
+
+                    var copyButton = document.getElementById("copyRecoveryCodes");
+                    copyButton && copyButton.addEventListener("click", function () {
+                        copyRecoveryCodes();
+                    });
+
+                    /* download recovery codes  */
+                    function formatCurrentDateTime() {
+                        var dt = new Date();
+                        var options = {
+                            month: 'long',
+                            day: 'numeric',
+                            year: 'numeric',
+                            hour: 'numeric',
+                            minute: 'numeric',
+                            timeZoneName: 'short'
+                        };
+
+                        return dt.toLocaleString('en-US', options);
+                    }
+
+                    function parseRecoveryCodeList() {
+                        var recoveryCodes = document.querySelectorAll(".kc-recovery-codes-list li");
+                        var recoveryCodeList = "";
+
+                        for (var i = 0; i < recoveryCodes.length; i++) {
+                            var recoveryCodeLiElement = recoveryCodes[i].innerText;
+                            recoveryCodeList += recoveryCodeLiElement + "\r\n";
+                        }
+
+                        return recoveryCodeList;
+                    }
+
+                    function buildDownloadContent() {
+                        var recoveryCodeList = parseRecoveryCodeList();
+                        var dt = new Date();
+                        var options = {
+                            month: 'long',
+                            day: 'numeric',
+                            year: 'numeric',
+                            hour: 'numeric',
+                            minute: 'numeric',
+                            timeZoneName: 'short'
+                        };
+
+                        return fileBodyContent =
+                            "${msgStr("recovery-codes-download-file-header")}\n\n" +
+                            recoveryCodeList + "\n" +
+                            "${msgStr("recovery-codes-download-file-description")}\n\n" +
+                            "${msgStr("recovery-codes-download-file-date")} " + formatCurrentDateTime();
+                    }
+
+                    function setUpDownloadLinkAndDownload(filename, text) {
+                        var el = document.createElement('a');
+                        el.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text));
+                        el.setAttribute('download', filename);
+                        el.style.display = 'none';
+                        document.body.appendChild(el);
+                        el.click();
+                        document.body.removeChild(el);
+                    }
+
+                    function downloadRecoveryCodes() {
+                        setUpDownloadLinkAndDownload('kc-download-recovery-codes.txt', buildDownloadContent());
+                    }
+
+                    var downloadButton = document.getElementById("downloadRecoveryCodes");
+                    downloadButton && downloadButton.addEventListener("click", downloadRecoveryCodes);
+
+                    /* print recovery codes */
+                    function buildPrintContent() {
+                        var recoveryCodeListHTML = document.getElementById('kc-recovery-codes-list').innerHTML;
+                        var styles =
+                            \`@page { size: auto;  margin-top: 0; }
+                            body { width: 480px; }
+                            div { list-style-type: none; font-family: monospace }
+                            p:first-of-type { margin-top: 48px }\`;
+
+                        return printFileContent =
+                            "<html><style>" + styles + "</style><body>" +
+                            "<title>kc-download-recovery-codes</title>" +
+                            "<p>${msgStr("recovery-codes-download-file-header")}</p>" +
+                            "<div>" + recoveryCodeListHTML + "</div>" +
+                            "<p>${msgStr("recovery-codes-download-file-description")}</p>" +
+                            "<p>${msgStr("recovery-codes-download-file-date")} " + formatCurrentDateTime() + "</p>" +
+                            "</body></html>";
+                    }
+
+                    function printRecoveryCodes() {
+                        var w = window.open();
+                        w.document.write(buildPrintContent());
+                        w.print();
+                        w.close();
+                    }
+
+                    var printButton = document.getElementById("printRecoveryCodes");
+                    printButton && printButton.addEventListener("click", printRecoveryCodes);
+                `
+            }
+        ]
+    });
+
+    useEffect(() => {
+        insertScriptTags();
+    }, []);
+
+    return (
+        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("recovery-code-config-header")}>
+            <div className={clsx("pf-c-alert", "pf-m-warning", "pf-m-inline", getClassName("kcRecoveryCodesWarning"))} aria-label="Warning alert">
+                <div className="pf-c-alert__icon">
+                    <i className="pficon-warning-triangle-o" aria-hidden="true" />
+                </div>
+                <h4 className="pf-c-alert__title">
+                    <span className="pf-screen-reader">Warning alert:</span>
+                    {msg("recovery-code-config-warning-title")}
+                </h4>
+                <div className="pf-c-alert__description">
+                    <p>{msg("recovery-code-config-warning-message")}</p>
+                </div>
+            </div>
+
+            <ol id="kc-recovery-codes-list" className={getClassName("kcRecoveryCodesList")}>
+                {recoveryAuthnCodesConfigBean.generatedRecoveryAuthnCodesList.map((code, index) => (
+                    <li key={index}>
+                        <span>{index + 1}:</span> {code.slice(0, 4)}-{code.slice(4, 8)}-{code.slice(8)}
+                    </li>
+                ))}
+            </ol>
+
+            {/* actions */}
+            <div className={getClassName("kcRecoveryCodesActions")}>
+                <button id="printRecoveryCodes" className={clsx("pf-c-button", "pf-m-link")} type="button">
+                    <i className="pficon-print" aria-hidden="true" /> {msg("recovery-codes-print")}
+                </button>
+                <button id="downloadRecoveryCodes" className={clsx("pf-c-button", "pf-m-link")} type="button">
+                    <i className="pficon-save" aria-hidden="true" /> {msg("recovery-codes-download")}
+                </button>
+                <button id="copyRecoveryCodes" className={clsx("pf-c-button", "pf-m-link")} type="button">
+                    <i className="pficon-blueprint" aria-hidden="true" /> {msg("recovery-codes-copy")}
+                </button>
+            </div>
+
+            {/* confirmation checkbox */}
+            <div className={getClassName("kcFormOptionsClass")}>
+                <input
+                    className={getClassName("kcCheckInputClass")}
+                    type="checkbox"
+                    id="kcRecoveryCodesConfirmationCheck"
+                    name="kcRecoveryCodesConfirmationCheck"
+                    onChange={function () {
+                        //@ts-expect-error: This is code from the original theme, we trust it.
+                        document.getElementById("saveRecoveryAuthnCodesBtn").disabled = !this.checked;
+                    }}
+                />
+                <label htmlFor="kcRecoveryCodesConfirmationCheck">{msg("recovery-codes-confirmation-message")}</label>
+            </div>
+
+            <form action={kcContext.url.loginAction} className={getClassName("kcFormGroupClass")} id="kc-recovery-codes-settings-form" method="post">
+                <input type="hidden" name="generatedRecoveryAuthnCodes" value={recoveryAuthnCodesConfigBean.generatedRecoveryAuthnCodesAsString} />
+                <input type="hidden" name="generatedAt" value={recoveryAuthnCodesConfigBean.generatedAt} />
+                <input type="hidden" id="userLabel" name="userLabel" value={msgStr("recovery-codes-label-default")} />
+
+                <LogoutOtherSessions {...{ getClassName, i18n }} />
+
+                {isAppInitiatedAction ? (
+                    <>
+                        <input
+                            type="submit"
+                            className={clsx(getClassName("kcButtonClass"), getClassName("kcButtonPrimaryClass"), getClassName("kcButtonLargeClass"))}
+                            id="saveRecoveryAuthnCodesBtn"
+                            value={msgStr("recovery-codes-action-complete")}
+                            disabled
+                        />
+                        <button
+                            type="submit"
+                            className={clsx(getClassName("kcButtonClass"), getClassName("kcButtonDefaultClass"), getClassName("kcButtonLargeClass"))}
+                            id="cancelRecoveryAuthnCodesBtn"
+                            name="cancel-aia"
+                            value="true"
+                        >
+                            {msg("recovery-codes-action-cancel")}
+                        </button>
+                    </>
+                ) : (
+                    <input
+                        type="submit"
+                        className={clsx(
+                            getClassName("kcButtonClass"),
+                            getClassName("kcButtonPrimaryClass"),
+                            getClassName("kcButtonBlockClass"),
+                            getClassName("kcButtonLargeClass")
+                        )}
+                        id="saveRecoveryAuthnCodesBtn"
+                        value={msgStr("recovery-codes-action-complete")}
+                        disabled
+                    />
+                )}
+            </form>
+        </Template>
+    );
+}
+
+function LogoutOtherSessions(props: { getClassName: ReturnType<typeof useGetClassName>["getClassName"]; i18n: I18n }) {
+    const { getClassName, i18n } = props;
+
+    const { msg } = i18n;
+
+    return (
+        <div id="kc-form-options" className={getClassName("kcFormOptionsClass")}>
+            <div className={getClassName("kcFormOptionsWrapperClass")}>
+                <div className="checkbox">
+                    <label>
+                        <input type="checkbox" id="logout-sessions" name="logout-sessions" value="on" defaultChecked={true} />
+                        {msg("logoutOtherSessions")}
+                    </label>
+                </div>
+            </div>
+        </div>
+    );
+}

package/src/login/pages/LoginRecoveryAuthnCodeInput.tsx

@@ -0,0 +1,73 @@
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function LoginRecoveryAuthnCodeInput(props: PageProps<Extract<KcContext, { pageId: "login-recovery-authn-code-input.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { url, messagesPerField, recoveryAuthnCodesInputBean } = kcContext;
+
+    const { msg, msgStr } = i18n;
+
+    return (
+        <Template
+            {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            headerNode={msg("auth-recovery-code-header")}
+            displayMessage={!messagesPerField.existsError("recoveryCodeInput")}
+        >
+            <form id="kc-recovery-code-login-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
+                <div className={getClassName("kcFormGroupClass")}>
+                    <div className={getClassName("kcLabelWrapperClass")}>
+                        <label htmlFor="recoveryCodeInput" className={getClassName("kcLabelClass")}>
+                            {msg("auth-recovery-code-prompt", `${recoveryAuthnCodesInputBean.codeNumber}`)}
+                        </label>
+                    </div>
+                    <div className={getClassName("kcInputWrapperClass")}>
+                        <input
+                            tabIndex={1}
+                            id="recoveryCodeInput"
+                            name="recoveryCodeInput"
+                            aria-invalid={messagesPerField.existsError("recoveryCodeInput")}
+                            autoComplete="off"
+                            type="text"
+                            className={getClassName("kcInputClass")}
+                            autoFocus
+                        />
+                        {messagesPerField.existsError("recoveryCodeInput") && (
+                            <span id="input-error" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
+                                {messagesPerField.get("recoveryCodeInput")}
+                            </span>
+                        )}
+                    </div>
+                </div>
+
+                <div className={getClassName("kcFormGroupClass")}>
+                    <div id="kc-form-options" className={getClassName("kcFormOptionsWrapperClass")}>
+                        <div className={getClassName("kcFormOptionsWrapperClass")} />
+                    </div>
+                    <div id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
+                        <input
+                            className={clsx(
+                                getClassName("kcButtonClass"),
+                                getClassName("kcButtonPrimaryClass"),
+                                getClassName("kcButtonBlockClass"),
+                                getClassName("kcButtonLargeClass")
+                            )}
+                            name="login"
+                            id="kc-login"
+                            type="submit"
+                            value={msgStr("doLogIn")}
+                        />
+                    </div>
+                </div>
+            </form>
+        </Template>
+    );
+}

package/src/login/pages/LoginResetOtp.tsx

@@ -0,0 +1,70 @@
+import { Fragment } from "react";
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function LoginResetOtp(props: PageProps<Extract<KcContext, { pageId: "login-reset-otp.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { url, messagesPerField, configuredOtpCredentials } = kcContext;
+
+    const { msg, msgStr } = i18n;
+
+    return (
+        <Template
+            {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            displayMessage={!messagesPerField.existsError("totp")}
+            headerNode={msg("doLogIn")}
+        >
+            <form id="kc-otp-reset-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
+                <div className={getClassName("kcInputWrapperClass")}>
+                    <div className={getClassName("kcInfoAreaWrapperClass")}>
+                        <p id="kc-otp-reset-form-description">{msg("otp-reset-description")}</p>
+                        {configuredOtpCredentials.userOtpCredentials.map((otpCredential, index) => (
+                            <Fragment key={otpCredential.id}>
+                                <input
+                                    id={`kc-otp-credential-${index}`}
+                                    className={getClassName("kcLoginOTPListInputClass")}
+                                    type="radio"
+                                    name="selectedCredentialId"
+                                    value={otpCredential.id}
+                                    defaultChecked={otpCredential.id === configuredOtpCredentials.selectedCredentialId}
+                                />
+                                <label htmlFor={`kc-otp-credential-${index}`} className={getClassName("kcLoginOTPListClass")} tabIndex={index}>
+                                    <span className={getClassName("kcLoginOTPListItemHeaderClass")}>
+                                        <span className={getClassName("kcLoginOTPListItemIconBodyClass")}>
+                                            <i className={getClassName("kcLoginOTPListItemIconClass")} aria-hidden="true"></i>
+                                        </span>
+                                        <span className={getClassName("kcLoginOTPListItemTitleClass")}>{otpCredential.userLabel}</span>
+                                    </span>
+                                </label>
+                            </Fragment>
+                        ))}
+                        <div className={getClassName("kcFormGroupClass")}>
+                            <div id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
+                                <input
+                                    id="kc-otp-reset-form-submit"
+                                    className={clsx(
+                                        getClassName("kcButtonClass"),
+                                        getClassName("kcButtonPrimaryClass"),
+                                        getClassName("kcButtonBlockClass"),
+                                        getClassName("kcButtonLargeClass")
+                                    )}
+                                    type="submit"
+                                    value={msgStr("doSubmit")}
+                                />
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </form>
+        </Template>
+    );
+}

package/src/login/pages/LoginResetPassword.tsx

@@ -12,16 +12,17 @@ export default function LoginResetPassword(props: PageProps<Extract<KcContext, {
         classes
     });
 
-    const { url, realm, auth } = kcContext;
+    const { url, realm, auth, messagesPerField } = kcContext;
 
     const { msg, msgStr } = i18n;
 
     return (
         <Template
             {...{ kcContext, i18n, doUseDefaultCss, classes }}
-            displayMessage={false}
+            displayInfo
+            displayMessage={!messagesPerField.existsError("username")}
+            infoNode={realm.duplicateEmailsAllowed ? msg("emailInstructionUsername") : msg("emailInstruction")}
             headerNode={msg("emailForgotTitle")}
-            infoNode={msg("emailInstruction")}
         >
             <form id="kc-reset-password-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
                 <div className={getClassName("kcFormGroupClass")}>
@@ -41,8 +42,14 @@ export default function LoginResetPassword(props: PageProps<Extract<KcContext, {
                             name="username"
                             className={getClassName("kcInputClass")}
                             autoFocus
-                            defaultValue={auth !== undefined && auth.showUsername ? auth.attemptedUsername : undefined}
+                            defaultValue={auth.attemptedUsername ?? ""}
+                            aria-invalid={messagesPerField.existsError("username")}
                         />
+                        {messagesPerField.existsError("username") && (
+                            <span id="input-error-username" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
+                                {messagesPerField.get("username")}
+                            </span>
+                        )}
                     </div>
                 </div>
                 <div className={clsx(getClassName("kcFormGroupClass"), getClassName("kcFormSettingClass"))}>