java - 将消息放在 Keycloak 扩展存档中的位置

Question

我们已经创建了一个 Keycloak 扩展(主要是一个额外的身份 validator )，并尝试将其打包为 jar 存档，以便我们无需复制模板即可部署它并编辑 .properties 文件。

身份 validator 使用我们已放入 theme-resources/templates 目录中的自定义表单，如 Theme Resources 中所述。 - 而且效果很好。但是，我们无法将消息放入接收消息的位置。显示消息键而不是消息。如果我们将消息直接放入 keycloak-6.0.1/themes/base/login (而不是放入我们的存档中)，它就可以工作。

它影响两个地方:

自定义表单中的本地化消息(以下 Freemarker 模板中的 company.auth.title)

<#import "template.ftl" as layout>
<@layout.registrationLayout; section>
    <#if section = "header">
         ${msg("company.auth.title")}
    <#elseif section = "form">
    ...

身份 validator 中的错误消息 (company.auth.invalid-code)

Response challenge = context.form()
    .setError("company.auth.invalid-code")
    .createForm("company-auth-challenge.ftl");
context.failureChallenge(AuthenticationFlowError.INVALID_CREDENTIALS, challenge);

文档似乎表明本地化消息文件需要转到theme-resources/resources，但它不起作用。

那么我们应该将消息文件(例如 messages_en.properties)放在 jar 存档中的哪里，以便 Keycloak 拾取它们？

Answer 1

这是 KeyCloak 的限制(自 6.0.1 起)。本地化消息仅取自主题。您必须创建自己的主题并将其与 JAR 捆绑在一起。由于 KeyCloak 不会合并主题，因此您无法在 JAR 中重新定义默认的 keycloak 主题，因此您必须将领域的登录主题更改为您的自定义主题。

您的模板可以保留在主题资源中，但规范地应驻留在与theme.properties平行的主题文件夹中。如果您的主题名为 brokenspoon，那么您的 MVP JAR 应包含:

• META-INF/keycloak-themes.json
• 主题/brokenspoon/login/messages/messages_en.properties
• 主题/brokenspoon/login/theme.properties
• 主题资源/模板/my-custom-login.ftl

keycloak-themes.json 的内容 - 定义一个登录主题:

{
  "themes": [{
    "name" : "brokenspoon",
    "types": [ "login" ]
  }]
}

theme.properties的内容 - 您的自定义主题可以扩展默认的keycloak主题:

parent=keycloak

部署您的 JAR，重新启动Keycloak 服务器，然后在领域设置→主题下更改领域的默认主题。在更改主题设置之前但在部署 JAR 之后重新启动服务器非常重要，否则不会加载 JAR 中的主题。这似乎是由于特定于主题的内部缓存机制造成的。