5.4. JavaScript 供应商

身份验证脚本必须至少提供以下功能之一： authentication (..)，从 Authenticator#authenticate (AuthenticationFlowContext)操作(.. )调用，它从 Authenticator#action (AuthenticationFlowContext)调用。

自定义 身份验证器 应至少提供身份验证 (..) 函数。您可以使用代码中的 javax.script.Bindings 脚本。

AuthenticationFlowError = Java.type("org.keycloak.authentication.AuthenticationFlowError");

function authenticate(context) {

  LOG.info(script.name + " --> trace auth for: " + user.username);

  if (   user.username === "tester"
      && user.getAttribute("someAttribute")
      && user.getAttribute("someAttribute").contains("someValue")) {

      context.failure(AuthenticationFlowError.INVALID_USER);
      return;
  }

  context.success();
}

- User-authentication-subflow REQUIRED
-- Cookie ALTERNATIVE
-- Identity-provider-redirect ALTERNATIVE
...
- Your-Script-Authenticator REQUIRED

OpenID Connect 协议映射程序脚本是 javascript 脚本，允许您更改 ID 令牌和/或访问令牌的内容。

您可以使用代码中的 javax.script.Bindings 脚本。

脚本的导出将用作令牌声明的值。

// prints can be used to log information for debug purpose.
print("STARTING CUSTOM MAPPER");

var inputRequest = keycloakSession.getContext().getHttpRequest();
var params = inputRequest.getDecodedFormParameters();
var output = params.getFirst("user_input");
exports = output;

以上脚本允许从授权请求中检索 user_input。这可用于映射程序中配置的 Token Claim Name。

为了使您的脚本可供红帽构建的 Keycloak 使用，您需要将它们部署到服务器。为此，您应该创建一个具有以下结构的 JAR 文件：

META-INF/keycloak-scripts.json

my-script-authenticator.js
my-script-policy.js
my-script-mapper.js

META-INF/keycloak-scripts.json 是一个文件描述符，提供有关您要部署脚本的元数据信息。它是具有以下结构的 JSON 文件：

{
    "authenticators": [
        {
            "name": "My Authenticator",
            "fileName": "my-script-authenticator.js",
            "description": "My Authenticator from a JS file"
        }
    ],
    "policies": [
        {
            "name": "My Policy",
            "fileName": "my-script-policy.js",
            "description": "My Policy from a JS file"
        }
    ],
    "mappers": [
        {
            "name": "My Mapper",
            "fileName": "my-script-mapper.js",
            "description": "My Mapper from a JS file"
        }
    ],
    "saml-mappers": [
        {
            "name": "My Mapper",
            "fileName": "my-script-mapper.js",
            "description": "My Mapper from a JS file"
        }
    ]
}

此文件应该引用您要部署的不同类型的脚本供应商：

对于 JAR 文件中的每个脚本文件，您需要在 META-INF/keycloak-scripts.json 中有一个对应的条目，将脚本文件映射到特定的提供程序类型。为此，您应该为每个条目提供以下属性：

您有一个带有描述符和您要部署的脚本的 JAR 文件后，您只需要将 JAR 复制到 Keycloak 提供程序/目录的红帽构建中，然后运行 bin/ kc.[sh|bat] 构建。请注意，您还需要启用 脚本功能。