使用完整的密码将用户从Keycloak迁移到LDAP

时间:2019-06-21 12:55:14

标签: php ldap keycloak openldap

我们当前有一个Keycloak领域,我们希望将所有现有用户导出到LDAP中(密码不变),因此我们可以为不支持OpenID Connect或SAML但支持LDAP的其他位置添加登录支持。

鉴于密码凭据是使用pbkdf2-sha256算法存储在Keycloak MySQL用户数据库中的,因此我不得不将OpenLDAP 2.4.47与contrib模块一起使用,以在LDAP端也支持此操作(我也相信我已经在配置中启用了此模块。

我无法使用此处描述的格式将现有的(从Keycloak)转移到LDAP:https://github.com/hamano/openldap-pbkdf2

原谅我使用PHP,但这是我目前最熟悉的编程语言。

我尝试使用HASH_ITERATIONS,SALT和VALUE字段,以及PHP手册base64_encode下的注释中提供的base64url_encode自定义函数,以创建“ Adapted Base64”字符串,并提供内置字符串作为创建LDAP用户时的userPassword字段。在LDAP中成功创建了该用户,但是我无法使用刚刚创建的用户的凭据对LDAP进行身份验证。

/*
This example migrates a single user, to be adapted to a loop later, if it works.

NOTE: KC_* constants are defined in an external config.php file, such as:
KC_LDAP_BASEDN = "ou=users,dc=sso,dc=example,dc=com"
KC_REALM_ID = "KeycloakUserRealm"
(not actual code from config.php, but you get the point)
*/

$ldc = ldap_connect(KC_LDAP_SERVER);
ldap_set_option($ldc, LDAP_OPT_PROTOCOL_VERSION, KC_LDAP_PROTOCOL); // should be 3 in config.php
$ldb = ldap_bind($ldc, KC_LDAP_BINDDN, KC_LDAP_BINDPW);

$usertest = 'username_of_user_to_be_migrated';

// fetch user info
$u_sel = $db->query("SELECT * FROM `USER_ENTITY` WHERE `USERNAME`='".$db->real_escape_string($usertest)."' AND `REALM_ID`='".$db->real_escape_string(KC
_REALM_ID)."'");

$uinfo = $u_sel->fetch_assoc();

// fetch credential of user, type="password"
$c_sel = $db->query("SELECT * FROM `CREDENTIAL` WHERE `USER_ID`='".$db->real_escape_string($uinfo['ID'])."' AND `TYPE`='password'");

$cred = $c_sel->fetch_assoc();

$uprop = array();
$uprop['objectClass'] = array('top', 'person', 'organizationalPerson', 'inetOrgPerson');
$uprop['uid'] = $uinfo['USERNAME'];
$uprop['mail'] = $uinfo['EMAIL'];
$uprop['cn'] = $uinfo['FIRST_NAME'];
$uprop['sn'] = $uinfo['LAST_NAME'];

// also base64_decode() VALUE, since this seems to be already enocoded in base64, before re-encoding it with base64url_encode()
$uprop['userPassword'] = '{'.strtoupper($cred['ALGORITHM']).'}'.$cred['HASH_ITERATIONS'].'$'.base64url_encode($cred['SALT']).'$'.base64url_encode(base6
4_decode($cred['VALUE']));

ldap_add($ldc, 'uid='.$uprop['uid'].','.KC_LDAP_BASEDN, $uprop);

完成此操作后,我将运行第二个脚本以尝试与此用户连接:

$ldc = ldap_connect(KC_LDAP_SERVER);
ldap_set_option($ldc, LDAP_OPT_PROTOCOL_VERSION, KC_LDAP_PROTOCOL); // should be 3 in config.php

$userdn = 'uid=username_of_user_to_be_migrated,'.KC_LDAP_BASEDN;
$userpw = 'asdASD123';

$ldb = ldap_bind($ldc, $userdn, $userpw);

执行上面的第二个脚本时,我得到:

PHP Warning:  ldap_bind(): Unable to bind to server: Invalid credentials in /home/user/projectdir/test_ldap_user.php on line 22

CREDENTIAL数据库中的示例条目如下所示:

             ID: 5718a65c-1927-4ac7-87ce-aec0c7dda296
         DEVICE: NULL
HASH_ITERATIONS: 27500
           SALT: � �??�Pz�e��X,
           TYPE: password
          VALUE: DdCJAJvuhidAC2by7TZY8I0E8HF4V6FXrPa4nSXduvSzbb+xHW3D4QiiiPpvuzL2bdk6k0kNQKS/477k5kiLzA==
        USER_ID: b06ce13f-4e8e-474e-b5ee-5d664d6f9575
   CREATED_DATE: 1561051801144
        COUNTER: 0
         DIGITS: 0
         PERIOD: 0
      ALGORITHM: pbkdf2-sha256

userPassword的输出通常是这样的:

{PBKDF2-SHA256}27500$FrcRlj8SGJJQet1l9LNYLA$DdCJAJvuhidAC2by7TZY8I0E8HF4V6FXrPa4nSXduvSzbb-xHW3D4QiiiPpvuzL2bdk6k0kNQKS_477k5kiLzA

此代码中是否可能缺少任何内容以确保密码哈希正确迁移?

还是已经有一个解决我尚未找到的Keycloak-> LDAP的迁移脚本/解决方案?

在此先感谢您的帮助或朝正确的方向前进。

1 个答案:

答案 0 :(得分:0)

快速更新:我设法与一位出色的同事一起找到了一个解决方案,我想在此处发布该解决方案,以供日后参考,以防其他人陷入困境。

我们发现,无论使用哪种算法,Keycloak中用于哈希的密钥长度均为64字节。这也意味着,对于那些默认密钥长度小于64字节(以使其长度恰好为64字节)的算法,将重复哈希的字节序列。在PBKDF2中,SHA-1的默认密钥长度为20字节,SHA-256的默认密钥长度为32字节,SHA-512的默认密钥长度为64字节。这使我可以创建以下PHP函数,以返回与slappasswd返回的字符串完全相同的类型:

// Convert password credentials from Keycloak database to LDAP format (specific to PBKDF2 module)
// Parameter $cred is array from Keycloak database fields for 'CREDENTIAL' table
function password_keycloak_to_ldap($cred) {
        switch (strtolower($cred['ALGORITHM'])) {
                case 'pbkdf2':
                case 'pbkdf2-sha1':
                        $keybytes = 20;
                        break;
                case 'pbkdf2-sha256':
                        $keybytes = 32;
                        break;
                default:
                        $keybytes = 64;
                        break;
        }
        $out = '{'.strtoupper($cred['ALGORITHM']).'}'.$cred['HASH_ITERATIONS'].'$'.ab64_encode($cred['SALT']).'$';
        $oldhash = base64_decode($cred['VALUE']);
        $newhash = substr($oldhash, 0, $keybytes);
        $out .= ab64_encode($newhash);
        return $out;
}

此外,我还设置了其他帮助程序功能(从其他位置复制):

// ab64_* functions adapted from Python's Passlib v1.7.1
function ab64_encode($data){
        return rtrim(strtr(base64_encode($data), '+', '.'), '=');
}

function ab64_decode($data){
        return base64_decode(strtr($data,'.', '+').str_repeat('=', 3-(3+strlen($data))%4));
}

最后,我在问题中发布的脚本中的用法然后将userPassword行替换为以下内容:

$uprop['userPassword'] = password_keycloak_to_ldap($cred);

我希望这可以帮助其他人将用户从Keycloak迁移到LDAP,并保留用户密码。