Demo of keycloak & mysql in docker

矫情吗；* 2022-10-02 11:50 298阅读 0赞

安装 & 启动Docker环境

## 下载keycloak镜像 ##

docker pull jboss/keycloak

## 下载Mysql镜像 ##

注意这里如果直接用 latest 会下载到 mysql8 镜像，mysql8和最新版的keycloak集成会报一个“MySQLSyntaxErrorException: Row size too large”的错误，详情请见 [这里][Link 1] 。因此指定 mysql 5.7 版本：

docker pull mysql:5.7

## 创建网络环境 ##

docker network create keycloak-network

## 启动Mysql实例 ##

docker run --name mysql -d --net keycloak-network -e MYSQL\_DATABASE=keycloak -e MYSQL\_USER=keycloak -e MYSQL\_PASSWORD=password -e MYSQL\_ROOT\_PASSWORD=root\_password mysql:5.7

## 启动Keycloak ##

docker run --name keycloak -e KEYCLOAK\_USER=admin -e KEYCLOAK\_PASSWORD=admin -d -p 443:443 -p 8080:8080 -p 9990:9990 --net keycloak-network jboss/keycloak

启动keycloak时 会有报错

1，Interrupted awaiting transaction commit or rollback

有一个这样的报错 然后自动 kill 掉进程的 mysql是能正常启动 之后再启动keycloak 然后就报错 mysql也结束了 苦恼了好久 后来才发现 是虚机配置太低 为了省钱 申请的1核1G的 升了配置后解决；

2，Operation ("add") failed - address: (\[("subsystem" => "datasources"), ("data-source" => "KeycloakDS")\]) - failure description: "WFLYCTL0113: '' is an invalid value for parameter user-name. Values must have a minimum length of 1 characters

还伴随着is an invalid value for parameter user-name. Values must的报错

在启动keycloak的时候 没有设置KEYCLOAK\_USER导致，像上面那样设置user后解决；

# 配置Keycloak #

## 允许局域网IP访问 ##

docker exec -it keycloak bash

vi keycloak/standalone/configuration/standalone.xml

在 interfaces 节点添加 any 子节点，并将socket-binding-group的默认interface改为 any：

## 增加admin账号 ##

./keycloak/bin/add-user-keycloak.sh -r **master **\-u landas -p …

记得重启容器使得配置生效！

## 验证身份并关闭SSL ##

./keycloak/bin/kcadm.sh config credentials --server http://localhost:8080/auth --realm **master** --user landas

./keycloak/bin/kcadm.sh update realms/**master** -s sslRequired=NONE

## 设置User、Client、Resource ##

使用刚设置的 admin 账号登录控制台 http://$\{虚拟机IP\}:8080

在这里打不开，后需开放8080端口；

依次创建**Realm**/**Clients**/**Role**/**User**，详细步骤参见 [这里][Link 2]。注意在client中要正确填写后面Java项目实际运行的机器局域网IP。

# 创建需要授权的项目 #

简单起见，直接用springboot，在建工程的时候勾选 themeleaf 及 keycloak。 build.gradle文件如下：

buildscript {
        ext {
            springBootVersion = '2.0.6.RELEASE'
        }
        repositories {
            maven{ url 'http://maven.aliyun.com/nexus/content/groups/public'}
        }
        dependencies {
            classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
        }
    }
    
    apply plugin: 'java'
    apply plugin: 'idea'
    apply plugin: 'org.springframework.boot'
    apply plugin: 'io.spring.dependency-management'
    
    group = 'com.landas'
    version = '1.0'
    sourceCompatibility = 1.8
    
    repositories {
        maven{ url 'http://maven.aliyun.com/nexus/content/groups/public'}
    }
    
    
    ext {
        keycloakVersion = '4.5.0.Final'
    }
    
    dependencies {
        implementation('org.keycloak:keycloak-spring-boot-starter')
        implementation('org.springframework.boot:spring-boot-starter-thymeleaf')
        implementation('com.google.guava:guava:19.0')
        testImplementation('org.springframework.boot:spring-boot-starter-test')
    }
    
    dependencyManagement {
        imports {
            mavenBom "org.keycloak.bom:keycloak-adapter-bom:${keycloakVersion}"
        }
    }

项目的application.properties配置如下，其中192.128.192.128是虚拟机局域网IP。realm、resource、role 都是上面步骤中在keycloak控制台配置的名称，patterns是需要使用keycloak授权的接口URL：

keycloak.auth-server-url=http://192.168.192.128:8080/auth
    keycloak.realm=keycloak_test
    keycloak.resource=keycloak_testclient_1
    keycloak.public-client=true
    
    keycloak.security-constraints[0].authRoles[0]=keycloak_test_role1
    keycloak.security-constraints[0].securityCollections[0].patterns[0]=/customers/*

Controller主要方法如下：

@GetMapping(path = "/")
    public String index() {
        return "external";
    }
    
    @GetMapping(path = "/customers")
    public String customers(Principal principal, Model model) {
        model.addAttribute("customers", generateCustomers());
        model.addAttribute("username", principal.getName());
        return "customers";
    }

最后在resources下建template文件夹，放入 [customers.html][]/[external.html][]/[layout.html][] 三个文件

启动项目，登录 *http://\{ip\}:\{port\}*，登入external。注意这里的 ip 不能使localhost，而必须是项目运行机器的局域网IP，keycloak将用此 IP 重定向。

点击customers链接，输入用户名密码，可见customers页面已通过 keycloak 验证。

DEMO 至此成功完成。

**备注**：项目启动前记得将虚拟机时区设置为中国区(CST)，并使用ntpupdate同步时间，否则可能会报invalid token错误。具体错误请见 keycloak-user [邮件列表][Link 3]。

[Link 1]: https://issues.jboss.org/browse/KEYCLOAK-7655
[Link 2]: https://www.baeldung.com/spring-boot-keycloak
[customers.html]: https://github.com/eugenp/tutorials/blob/master/spring-boot-keycloak/src/main/resources/templates/customers.html
[external.html]: https://github.com/eugenp/tutorials/blob/master/spring-boot-keycloak/src/main/resources/templates/external.html
[layout.html]: https://github.com/eugenp/tutorials/blob/master/spring-boot-keycloak/src/main/resources/templates/layout.html
[Link 3]: http://lists.jboss.org/pipermail/keycloak-user/2016-March/005550.html