Keycloak:使用 keycloak-admin 为用户生成访问令牌

Mar*_*ini 5 node.js keycloak keycloak-rest-api

我必须将旧的身份验证系统移至 Keycloak,并且无法更改客户端上的实际工作流程。因此,我需要为我的 api(在 node.js 中)提供一个用户创建和登录系统,该系统又代表用户从 Keycloak 创建和获取访问令牌。

我能够创建一个用户,但无法找到为该用户生成访问令牌的方法。我发现的唯一解决方法是创建一个用户并设置一个随机密码,然后要求授予用户提供用户名和密码,但这意味着我必须在我这边存储密码,这正是我想移动的原因到钥匙斗篷。

const KcAdminClient   = require('keycloak-admin').default;
const Keycloak        = require('keycloak-connect');

const _keycloakAdmin = new KcAdminClient({
  baseUrl: process.env.KEYCLOAK_SERVER_AUTH_URL,
  realm: process.env.KEYCLOAK_REALM
});
await _keycloakAdmin.auth({
  realm: process.env.KEYCLOAK_REALM,
  username: process.env.KEYCLOAK_USER,
  password: process.env.KEYCLOAK_PASSWORD,
  grantType: 'password',
  clientId: process.env.KEYCLOAK_CLIENT_ID,
});

//Create a user and set password 
const newUser = await _keycloakAdmin.users.create({
  realm: process.env.KEYCLOAK_REALM,
  username: 'something',
  email: 'someone@domain.com',
  firstName: 'Some',
  lastName: 'One',
  emailVerified: true,
  enabled: true,
});

await _keycloakAdmin.users.resetPassword({
    realm: process.env.KEYCLOAK_REALM,
    id: newUser.id,
    credential: {
        temporary: false,
        type: 'password',
        value: 'randompassword'
    }
});

//generate a token for the user
const _keycloak = new Keycloak({}, {
  clientId: process.env.KEYCLOAK_CLIENT_ID,
  serverUrl: process.env.KEYCLOAK_SERVER_AUTH_URL,
  realm: process.env.KEYCLOAK_REALM,
  credentials: {
      secret: process.env.KEYCLOAK_CLIENT_SECRET
  }
});
const grant = await _keycloak.grantManager.obtainDirectly('something', 'randompassword');
const access_token = grant.access_token.token;
Run Code Online (Sandbox Code Playgroud)

我不敢相信不存在更优雅的方法来做到这一点,所以我认为我在 Keycloak 客户端的配置和理解一些基本概念和命名约定方面缺少一些基本的东西。我本来期望类似的东西

await _keycloakAdmin.users.generateAccessToken(userId, realm, clientId, ...)
Run Code Online (Sandbox Code Playgroud)

但我没能找到它。我只在这里找到了这个未回答的问题:Keycloak :REST API call to get access token of a user through admin username and password

Mar*_*ini 12

该解决方案非常复杂,需要(在撰写本文时)激活 Keycloak 名为 Token Exchange 的“预览”功能。该过程在https://www.keycloak.org/docs/latest/securing_apps/index.html#_token-exchange中进行了描述,对于我的具体情况,我按照https://www.keycloak.org/docs/中的说明进行操作最新/secure_apps/index.html#internal-token-to-internal-token-exchange

首先,您需要启用令牌交换功能,在运行 Keycloak 时-Dkeycloak.profile=preview添加开关。JAVA_OPTS要检查 Keycloak 是否加载了预览功能,请查看/auth/admin/master/console/#/server-info配置文件部分下的服务器信息: Keycloak服务器信息配置文件

令牌交换的想法是,您获得领域管理员的令牌,然后将其交换为“普通”用户的令牌。为此,您必须为您的 Keycloak 领域创建(如果您还没有)两个不同的客户端:第一个是管理员用来获取令牌的“启动客户端”,第二个是“目标客户端”您想要“普通”用户的令牌。

之后,您需要为您的领域创建一个管理员用户。您可以按照Keycloak - 在领域中创建管理员用户中的说明进行操作

然后您需要使目标客户端能够接受令牌交换。您应该仔细遵循https://www.keycloak.org/docs/latest/securing_apps/index.html#_client_to_client_permission中的说明 这是一个两步过程:创建指定哪些“启动客户端”可以交换令牌的客户端策略然后启用目标客户端的权限并将刚刚创建的策略附加到权限中token-exchange

附加到目标客户端的令牌交换权限的策略

完成 Keycloak 的设置后,您实际上可以发出两个调用,首先获取领域管理员的令牌,然后获取具有特定 userId 的用户的令牌。

获取管理员令牌

curl --location --request POST '<your_url>/auth/realms/<your_realm>/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'client_id=<your_starting_client>' \
--data-urlencode 'username=<your_admin_username>' \
--data-urlencode 'password=<your_admin_password>' \
--data-urlencode 'realm=<your_realm>' \
--data-urlencode 'scope=openid'
Run Code Online (Sandbox Code Playgroud)

将管理员令牌交换为“普通”用户令牌

curl --location --request POST '<your_url>/auth/realms/<your_realm>/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=urn:ietf:params:oauth:grant-type:token-exchange' \
--data-urlencode 'client_id=<your_starting_client>' \
--data-urlencode 'subject_token=<your_admin_token>' \
--data-urlencode 'requested_token_type=urn:ietf:params:oauth:token-type:refresh_token' \
--data-urlencode 'audience=<your_target_client>' \
--data-urlencode 'requested_subject=<your_target_user_id>'

Run Code Online (Sandbox Code Playgroud)

根据客户端的配置,您可能最终必须client_secret在第二次调用中指定 a。