如何在Keycloak中创建脚本映射器？

java keycloak

2022-09-03 03:58:21

我需要在密钥掩护中创建一个脚本映射器类型的协议映射器。脚本应获取用户属性，检查其大小，并将其放在令牌上。我没有找到有关如何创建脚本的文档或示例。从我能收集到的零碎内容来看，我想我的脚本需要看起来像这样：

var value = user.getAttribute("myAttribute");
if (value.length > LIMIT) {
    value = value.substring(0,LIMIT);
}
token.setOtherClaims("myAttribute",value);

这是对的吗？我编造了user.getAttribute（“myAttribute”）。是否有文档源，我可以在其中找到如何获取 Keycloak 用户属性？
脚本是否需要返回任何内容？任何帮助都是受欢迎的。

答案 1

脚本映射器的魔力可以通过查看此处的键斗源来理解：Source

该脚本可以通过使用导出变量返回一些内容，如下所示

exports = "Claim Value"

不同的类型：

用户：源 JavaDoc
领域：源 JavaDoc
令牌：源 JavaDoc
userSession： Source JavaDoc
keycloakSession： Source JavaDoc

下面是一个示例脚本：

// you can set standard fields in token
token.setAcr("test value");

// you can set claims in the token
token.getOtherClaims().put("claimName", "claim value");

// multi-valued claim (thanks to @ErwinRooijakkers)
token.getOtherClaims().put('foo', Java.to(['bars'], "java.lang.String[]"))

// work with variables and return multivalued token value
var ArrayList = Java.type("java.util.ArrayList");
var roles = new ArrayList();
var client = keycloakSession.getContext().getClient();
var forEach = Array.prototype.forEach;
forEach.call(user.getClientRoleMappings(client).toArray(), function(roleModel) {
  roles.add(roleModel.getName());
});

exports = roles;

希望它有帮助！

答案 2

我需要这个功能，但在我新安装的10.0.2中找不到这个“脚本映射器”的东西。事实证明，默认情况下它未启用，如此处的文档所示：https://www.keycloak.org/docs/latest/server_installation/#profiles

要启用它，您可以：

使用standalone/configuration/profile.propertiesfeature.scripts=enabled

或

启动服务器bin/standalone.sh|bat -Dkeycloak.profile.feature.scripts=enabled

而且似乎从源代码来看

public boolean isSupported() {
    return Profile.isFeatureEnabled(Profile.Feature.SCRIPTS) && Profile.isFeatureEnabled(Profile.Feature.UPLOAD_SCRIPTS);
}

应同样启用upload_scripts

我希望它能帮助某人