【问题标题】:Aggregate attributes of roles in claims using Keycloak Script Mapper使用 Keycloak Script Mapper 聚合声明中的角色属性
【发布时间】:2021-09-21 21:27:08
【问题描述】:

我们有一个 Keycloak 脚本映射器来将角色的属性添加到 ID 令牌。目标是聚合角色属性中可用的值。映射器如下所示:

/**
 * Merge with concatenation for the values of attributes obtained
 * from the token with the attributes obtained from the roles. If for
 * example a group and a role have the same attribute key, the values
 * for that key from the group and role will be concatenated.
 *
 * Known limitations:
 * When only roles have a certain attribute, and not a group, the 
 * mapper only uses the first role it can find. Bug was difficult to
 * fix because state in the variable currentClaims seems to be
 * persisted over multiple calls.
 * Workaround: Also add this specific attribute to a group with a
 * dummy value.
 * 
 * NOTE: there is no role attribute mapper out-of-the-box in 
 * Keycloak.
 * 
 * Available variables in script: 
 * user - the current user
 * realm - the current realm
 * token - the current token
 * userSession - the current userSession
 * keycloakSession - the current keycloakSession
 * 
 * Documentation on available variables:
 * https://stackoverflow.com/a/52984849
 */
 
var currentClaims = {};
token.getOtherClaims().forEach(function(k, v) {
  currentClaims[k] = v;
});

function isMultiValued(v) {
  // From experience, multivalued attribute values are sometimes 
  // Arrays and sometimes Objects. Thus look for negative case:
  // anything other than a string is multivalued.
  return !(typeof v === 'string' || v instanceof String);
}

function addToList(l, values) {
  for each(var v in values) {
    l.add(v);
  }
  return l;
}

function toStringArray(arr) {
  return Java.to(arr, "java.lang.String[]");
}

user.getRealmRoleMappings().forEach(function(roleModel) {
  roleModel.getAttributes().forEach(function(k, v) {
    var currentValue = currentClaims[k];
    if (k in currentClaims) {
      if (!isMultiValued(currentValue)) {
        v = toStringArray([currentValue].concat(v));
      } else {
        v = addToList(currentValue, v);
      }
    }
    currentClaims[k] = v; // <= to also aggregate over roles!
    token.setOtherClaims(k, v); 
  }); 
});

currentClaims[k] = v 的部分我添加到角色中可用的聚合值,因此如果两个角色包含相同的属性,它们的值也会被聚合。

例如,如果我们有一个用户具有角色 a 和 b,其属性 foo 的值分别为 1 和 2,我们期望 ID 令牌包含值 1 和 2 的 foo 声明。

user:
  role a foo -> 1
  role b foo -> 2
expected ID token:
  foo -> [1, 2]

但在当前代码中,currentClaims 变量似乎在多次调用函数时保持状态。每次检查 ID 令牌时,都会将更多的 2 值添加到令牌中,从而导致像 [1, 2, 2, ..., 2] 这样的 foo 声明,每次检索令牌时都会添加越来越多的 2s。我尝试将整个调用包装在一个函数中,以便在调用之间丢弃可能的状态,但无济于事。结果如下:

为什么状态会在多次调用中保持不变?有没有办法同时聚合角色属性的值?

【问题讨论】:

    标签: java keycloak nashorn


    【解决方案1】:

    为什么在多次调用中保持状态?

    未知。也许与 Nashorn 有什么关系。

    [我]有没有办法同时聚合角色属性的值?

    如果addToList 函数已经存在,则不继续检查聚合值(解决方法):

    function addToList(l, values) {
      for each(var v in values) {
        if (!l.contains(v)) {
          l.add(v);
        }
      }
      return l;
    }
    

    并通过保持某种状态进行聚合:

    var newClaims = {};
    newClaims = currentClaims;
    user.getRealmRoleMappings().forEach(function(roleModel) {
      roleModel.getAttributes().forEach(function(k, v) {
        var currentValue = newClaims[k];
        if (k in newClaims) {
          if (isMultiValued(currentValue)) {
            v = addToList(currentValue, v);
          }
        }
        newClaims[k] = v;
      }); 
    });
    token.setOtherClaims("new-claims", newClaims); 
    

    这会将所有声明放在 JWT 的 new-claims 字段中。

    //// 编辑:

    注意:addToList 中的这个 JavaScript/Java 互操作存在问题(例如更改角色的实际属性...)。最好使用纯 JavaScript 进行连接,然后再转换回 Java:

    function toStringArray(arr) {
      return Java.to(arr, "java.lang.String[]");
    }
    
    
    Array.prototype.includes = function(obj) {
      var i = this.length;
      while (i--) {
        if (this[i] === obj) {
          return true;
        }
      }
      return false;
    }
    
    function addToList(l, values) {
      // Add values to new instance to avoid magical addition to
      // current values in role attributes
      var arr = [];
      for each(var v in l) {
        arr.push(v);
      }
      for each(var v in values) {
        if (!arr.includes(v)) {
          arr.push(v);
        }
      }
      return toStringArray(arr);
    }
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2021-10-27
      • 2018-02-10
      • 2014-12-06
      • 2015-07-28
      • 2018-06-15
      • 2015-03-27
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多