Keycloak 自定义验证输出消息
Keycloak Custom Validation Output messages
我正在使用 jboss keycloak 1.5 最终版。
我开发了与 keycloak 属性和我的用户企业数据库接口的自定义用户联合提供程序。
我需要根据与旧用户数据库相关的特定错误向用户发送登录界面自定义错误消息。
我看到 keycloak 主题有一个资源文件夹,我可以通过它本地化和添加新消息。然后我可以通过 angular js 使用
引用它们
$myMessage
符号。问题是我想从 keycloak 服务器发出一条消息。我的用户联合提供者实现了 UserFederationProvider 接口。所以我应该重写:
@Override
public CredentialValidationOutput validCredentials(RealmModel realm, UserCredentialModel credential) {
LOGGER.info("validCredentials(realm, credential)");
return CredentialValidationOutput.failed();
}
这似乎是我一直在寻找的方法,因为 CredentialValidationOutput 包含要作为验证输出发送的自定义消息。问题是这个方法从来没有被调用过。
为什么?
我会post自己找到答案。
开发自己的Authenticator很有必要。例如参考 Keycloak UsernameAndForm 和 UsernameAndFormFactory 实现。
您可以在 Keycloak 上找到它们 github 源代码:
主要验证方法有:
public boolean validateUserAndPassword(AuthenticationFlowContext context, MultivaluedMap<String, String> inputData) {
...
}
public boolean validatePassword(AuthenticationFlowContext context, UserModel user, MultivaluedMap<String, String> inputData) {
...
}
从您的自定义用户联合提供者,您可以抛出您的自定义异常并在上面的两种方法中捕获它们添加:
catch (YourCustomException ex){
...
Response challengeResponse = context.form()
.setError("YOUR ERROR MESSAGE", me.getMandator()).createLogin();
context.failureChallenge(AuthenticationFlowError.INVALID_USER, challengeResponse);
return false;
}
当然在你的项目中你必须添加
META-INF/service/org.keycloak.authentication.AuthenticatorFactory
在其中指定 AuthenticatorFactory 的完整限定名称。
要获得有效指南,请参考 Keycloak 用户指南 1.6.1 最终版。第33.3章
我正在使用 jboss keycloak 1.5 最终版。 我开发了与 keycloak 属性和我的用户企业数据库接口的自定义用户联合提供程序。
我需要根据与旧用户数据库相关的特定错误向用户发送登录界面自定义错误消息。
我看到 keycloak 主题有一个资源文件夹,我可以通过它本地化和添加新消息。然后我可以通过 angular js 使用
引用它们$myMessage
符号。问题是我想从 keycloak 服务器发出一条消息。我的用户联合提供者实现了 UserFederationProvider 接口。所以我应该重写:
@Override
public CredentialValidationOutput validCredentials(RealmModel realm, UserCredentialModel credential) {
LOGGER.info("validCredentials(realm, credential)");
return CredentialValidationOutput.failed();
}
这似乎是我一直在寻找的方法,因为 CredentialValidationOutput 包含要作为验证输出发送的自定义消息。问题是这个方法从来没有被调用过。
为什么?
我会post自己找到答案。
开发自己的Authenticator很有必要。例如参考 Keycloak UsernameAndForm 和 UsernameAndFormFactory 实现。
您可以在 Keycloak 上找到它们 github 源代码:
主要验证方法有:
public boolean validateUserAndPassword(AuthenticationFlowContext context, MultivaluedMap<String, String> inputData) {
...
}
public boolean validatePassword(AuthenticationFlowContext context, UserModel user, MultivaluedMap<String, String> inputData) {
...
}
从您的自定义用户联合提供者,您可以抛出您的自定义异常并在上面的两种方法中捕获它们添加:
catch (YourCustomException ex){
...
Response challengeResponse = context.form()
.setError("YOUR ERROR MESSAGE", me.getMandator()).createLogin();
context.failureChallenge(AuthenticationFlowError.INVALID_USER, challengeResponse);
return false;
}
当然在你的项目中你必须添加
META-INF/service/org.keycloak.authentication.AuthenticatorFactory
在其中指定 AuthenticatorFactory 的完整限定名称。
要获得有效指南,请参考 Keycloak 用户指南 1.6.1 最终版。第33.3章