spring-boot - Keycloak 与 Spring Boot 集成

Question

如何将 keycloak 与 spring boot 应用程序集成。我们是否必须在 application.properties 中授予所有资源及其角色权限？那么keycloak.json有什么用呢？然后我需要在 keycloak 的管理控制台中对这些导出设置进行一些说明。我们是否必须将该文件包含在应用程序的配置中？

Answer 1

1) 首先将这些依赖项添加到您的 build.gradle (我使用的是 gradle，但如果您是 Maven 人员，则 pom.xml 也是如此):

// keycloak
compile 'org.keycloak:keycloak-spring-boot-adapter:2.5.1.Final'
compile 'org.keycloak:keycloak-tomcat8-adapter:2.5.1.Final'

2) 然后在 application.properties 文件中提供您的 Keycloak 配置(此时您应该已经配置了您的领域并通过 Keycloak web-ui 添加了一个客户端):

keycloak.realm=[YOUR-REALM]
keycloak.bearer-only=true
keycloak.auth-server-url=https://[YOUR-KEYCLOAK-INSTANCE-ADDRESS]:[PORT]/auth
keycloak.ssl-required=external
keycloak.resource=[CLIEND-ID]
keycloak.credentials.secret=[YOUR-CLIENT-SECRET-ID]
keycloak.cors=true


keycloak.securityConstraints[0].securityCollections[0].name=insecure stuff
keycloak.securityConstraints[0].securityCollections[0].patterns[0]=/test-endpoint-1/*

keycloak.securityConstraints[1].securityCollections[0].name=admin stuff
keycloak.securityConstraints[1].securityCollections[0].authRoles[0]=[ROLE-2]
keycloak.securityConstraints[1].securityCollections[0].patterns[0]=/test-endpoint-2/*

在这里，我允许任何人访问 /test-endpoint-1/* 中的所有内容，而具有 [ROLE-2] 角色的管理员用户可以访问 /test 中的任何内容-endpoint-2/*.

啊，忘了说了，客户端Access Type是bearer-only。是的，使用此设置您不需要 keycloak.json。 希望这会有所帮助:)

更新

新的 API 发生了一些变化，所以给出最新版本:

kotlinVersion = '1.3.10'
springBootVersion = '2.1.1.RELEASE'
keycloakVersion = '4.6.0.Final'

dependencyManagement {
    imports {
        mavenBom "org.keycloak.bom:keycloak-adapter-bom:${keycloakVersion}"
    }
}

dependencies {
    // keycloak
    compile 'org.keycloak:keycloak-spring-boot-starter'
}

application.properties 在这种情况下将如下所示:

keycloak.realm=[YOUR-REALM]
keycloak.bearer-only=true
keycloak.auth-server-url=https://[YOUR-KEYCLOAK-INSTANCE-ADDRESS]:[PORT]/auth
keycloak.ssl-required=external
keycloak.resource=[CLIEND-ID]
keycloak.credentials.secret=[YOUR-CLIENT-SECRET-ID]
keycloak.cors=true
keycloak.enabled=true

keycloak.securityConstraints[0].securityCollections[0].name=insecure stuff
keycloak.securityConstraints[0].securityCollections[0].patterns[0]=/test-endpoint-1/*


keycloak.securityConstraints[1].securityCollections[0].name=admin stuff
keycloak.securityConstraints[1].authRoles[0]=[ROLE-2]
keycloak.securityConstraints[1].securityCollections[0].patterns[0]=/test-endpoint-2/*