超级详细的 Docker Desktop 安装 Keycloak

客官°小女子只卖身不卖艺 2024-02-05 12:35 5阅读 0赞

## 一、Keycloak 简介 ##

### 收先先來看一下Keycloak的基本資訊: ###

*  名稱: Keycloak
 *  開發使用的程式語言: Java
 *  公用: 單點登入驗證與授權工具
 *  許可協議: Apache License 2.0
 *  公開倉庫: [https://github.com/keycloak/keycloak][https_github.com_keycloak_keycloak]
 *  官方網站: [https://www.keycloak.org][https_www.keycloak.org]
 *  撰寫當下最新版本: 15.0.2 (2021年8月20日)

### Keycloak是拿來做什麼的？ ###

首先，他是一個單點登入(Single Sign On, SSO)系統服務。換句話說如果「快速開始」所展示的，他可以協助你驗證身份與管理會話(Session)。  
除此之外，他可以嫁接許多現有的驗證系統，支援LDAP、keyberos。

![在这里插入图片描述][16f85dc4ceac475e83efece9f8ef2ed9.png]  
此外支援多種社交登入(Social Login)。

![在这里插入图片描述][71e685fa4c6d4e899b825ab131cc39e5.png]  
以及支援多個標準協議，包含 OAuth 2.0 、 OpenID 和 saml 。 且支援授權服務。

![在这里插入图片描述][7f81cb3d792b490a829412076a0a9ddb.png]

### 關於Keycloak ###

起初會看到 Keycloak 是因爲，當時在思考一個授權設計的相關軟體開發問題。然後授權又與驗證不是那麼容易分開來看。  
找著找著就發現Keycloak這蠻有去的玩具。雖然文件上有些過時，但功能齊全、更新更讓我意外。

2020年底、2021年初，剛接觸時才12版，一部分OAuth的Flow也沒有實現。半年才過去一些，現在不但有了，主板號更是直接跳到15版。

*  2021年7月30 發佈 15.0.0 版
 *  2021年8月7日 發佈 15.0.1 版
 *  2021年8月20日 發佈 15.0.2 版

![在这里插入图片描述][4fe9a21b77de48e4945a89fece2d6230.png]

## 一、安装Docker ##

[Docker Desktop 安装使用教程 点击查看][Docker Desktop _]

## 二、安装 KeyCloak ##

> 镜像地址： [https://hub.docker.com/r/jboss/keycloak/][https_hub.docker.com_r_jboss_keycloak]

![在这里插入图片描述][2227d83709b149c9b6fee3d7a61c76dd.png]

### 1、安装 jboss/keycloak 镜像 ###

docker pull jboss/kaycloak

![在这里插入图片描述][bc16d2d7d9764631bc710fd164ea7b2b.png_pic_center]  
![在这里插入图片描述][bbf1302024ef433589622ddb0e1f9cda.png]

### 2、启动 jboss/keycloak 镜像 ###

> **参考启动命令** 如下命令将启动一个新的容器，需要启动已有的容器，请使用 `docker start 《container_id》`

# jboss/keycloak 
    docker run -p 8082:8080 -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=admin jboss/keycloak
    
    # quay.io/keycloak  v19.0.1
    docker run -p 9080:9080 -p 9443:9443 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -e KC_HTTP_PORT=9080 -e KC_HTTPS_PORT=9443 -d quay.io/keycloak/keycloak:19.0.1 start-dev

![在这里插入图片描述][4ff2e3951b3f4a36af6156d0227b2359.png_pic_center]  
![在这里插入图片描述][3e31ac5d4092493aace4bb1dc3fea0ae.png_pic_center]  
![在这里插入图片描述][cb0afc7db2174570afa275e7729c84b7.png_pic_center]  
![在这里插入图片描述][9f0051f7ac094e7bbca5ac8090ae80e7.png_pic_center]

![在这里插入图片描述][aec42e080ca642e7b7209ad29d87cb14.png]

然后重新启动容器:

docker restart <CONTAINER>

![在这里插入图片描述][5356ec4709444f73b7e22325388e2e16.png]

![在这里插入图片描述][70abfbc0129d49789d9a4ef4b197a8a4.png]

## 三、使用 KeyCloak ##

### 1、访问 jboss/keycloak ###

>  *  1、ping通server ip
>  *  2、browser访问: http://127.0.0.1:8082/
>  *  3、初始用户名和密码都是admin（启动时指定）.

![在这里插入图片描述][c0a94df9671643e88a6f429ba7bc82d1.png]

![在这里插入图片描述][50e3d7334148479fad07954d4e695cbd.png]  
![在这里插入图片描述][ceff1aa0d6884dc0b7ce68fd0293b2fb.png]  
![在这里插入图片描述][2422d322f9a44aba94e634370fc880cf.png]

### 2、使用 jboss/keycloak ###

我们使用的时候需要创建一个realm，创建realm简单，设置一个名称即可。  
点击左上角的 Master，在弹出下拉框中点击 Create Realm 按钮。  
![在这里插入图片描述][39c2398765664c35baf0c1eec4646dd7.png]  
![在这里插入图片描述][b6247b0688144cb0a0205cfec91c6195.png]

#### 2.1、Realm公开配置 ####

可以通过如下地址获取指定realm的openid配置  
注意：keycloak:18.0.0之前的版本，url 需要添加 auth 路径

# kc 18.0.0
    ${
        KC_ADDR}/realms/${
        KC_REALM}/.well-known/openid-configuration
    
    # before kc 18.0.0
    ${
        KC_ADDR}/auth/realms/${
        KC_REALM}/.well-known/openid-configuration

**Example**：http://127.0.0.1:8082/realms/MVNO/.well-known/openid-configuration  
![在这里插入图片描述][2d38d3b773bc4097ab68077f8264eda6.png]

**返回一个json数据，包括grant\_types\_supported等**

![fbd9dde3b3af4e8aa0917d9c50d08df9.png][]

#### 2.2、Create Client ####

> 创建 Realm之后最重要的就是创建 Client ，不同类型的Client对 OAuth Grant Flow 支持有所差异。  
> 主要配置和 Client Type 和 Client ID，前者决定授权方式，后者是后端程序配置连接地址时要配置。

在左侧菜单栏中选择Clients 选项卡。然后点击右侧的添加按钮。

![在这里插入图片描述][d736738c0ee244e18f5ab4c27e1f411f.png]

输入客户端名称，然后点击保存。

![在这里插入图片描述][2fd17874e8a342ae98d3c805c784ee50.png]

然后，在添加成功后的跳转到的页面找到Valid Redirect URIs ，在这里将配置我们的spring boot 应用的网址。在本示例中，spring boot应用将会跑在8081端口上。所以地址应设置为http://localhost:8081。随后保存。

![在这里插入图片描述][09eba241d4f64414b4b51900103034c9.png]

> Client authentication: 如果打开，则client的access type为credentials，那么连接此client需要 client-secret参数；否则access type为public，不需要client-secret。  
> 不同access type的client支持的Authentication flow有些差异。

**Authentication flow：**

*  Standard flow： oauth2 的 Authorization Code Flow。
 *  Direct access grant： oauth2的 Password Flow。
 *  …

![在这里插入图片描述][d0e58d41daaa4b3b808e3f3522575b48.png]  
创建client之后，需要配置一些参数，如“Valid redirect URIs ”等参数。  
如果使用基于重定向的 Authentication flow，keycloak接收到redirect\_uri参数时，检测其是否与当前client配置的 Valid redirect\_uri 一致。不符合则会提示  
  
![在这里插入图片描述][1a631297b9a44e50b4587e2777b8d68d.png]

**Client secret**

![在这里插入图片描述][3f786e9f86854c028086f5530ac00a2c.png]

**Advanced TAB**

> 如配置access\_token 存活时长等

![在这里插入图片描述][8321882763af4fd2bf5b91f8c7fc1024.png]

#### 2.3、Create Roles ####

在左侧菜单栏中选择Roles 选项卡。然后点击右侧的添加按钮。  
   输入用户名，然后保存。

![在这里插入图片描述][5ef406ce85da405da59eb52a088512ff.png]

#### Create User ####

登录的用户来自这里；如果有额外的用户数据数据库，可以配置 User federation 。  
注意：需要登录的用户需先在数据库中配置角色（前端无角色会报错）。  
创建用户

##### 1、 在左侧菜单栏中选择Users 选项卡。然后点击右侧的添加按钮。 #####

![在这里插入图片描述][32f0ae696d7a441f952580cec3318451.png]

##### 2、输入用户名添加用户 #####

![在这里插入图片描述][3ee8bc6fcdc14f028499d76ac2bd9d46.png]

##### 3、添加成功后，单击Credentials 选项卡，设置登录密码。 #####

![在这里插入图片描述][04b8c28cbe69422d8df653234d0880d0.png]

##### 4、添加成功后，单击Role Mappings 选项卡，给用户设置角色。 #####

![在这里插入图片描述][a0cbc327e2924b1388a1953d765d6f96.png]

##### 5、开启用户注册（可选） #####

在左侧菜单栏中选择Realm Settings 选项卡。然后按照如图所示进行操作。  
   这样在KeyCloak的登录页面就会增加注册按钮。

![在这里插入图片描述][734867a4d0324d8ebc8f6ea53b423535.png]

## 四、Springboot 整合 KeyCloak ##

### 1、创建一个Spring Boot 应用 ###

添加以下依赖

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.keycloak.bom</groupId>
                <artifactId>keycloak-adapter-bom</artifactId>
                <version>17.0.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
        <dependency>
            <groupId>org.keycloak</groupId>
            <artifactId>keycloak-spring-boot-starter</artifactId>
            <version>17.0.1</version>
        </dependency>
       
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

### 2、Controller ###

@Controller
    public class MyController {
        
    
        @GetMapping("/customers/he")
        @ResponseBody
        public Map he(Principal principal){
        
            Map<String, String> map = new HashMap<>();
            map.put("username",principal.getName());
            return map;
        }
        
    }

### 3、SecurityConfig ###

@KeycloakConfiguration
    public class SecurityConfig extends KeycloakWebSecurityConfigurerAdapter {
        
    @Autowired
    public void configureGlobal(
            AuthenticationManagerBuilder auth) throws Exception {
        
    
        KeycloakAuthenticationProvider keycloakAuthenticationProvider
                = keycloakAuthenticationProvider();
        keycloakAuthenticationProvider.setGrantedAuthoritiesMapper(
                new SimpleAuthorityMapper());
        auth.authenticationProvider(keycloakAuthenticationProvider);
    }
    
    @Bean
    @Override
    protected SessionAuthenticationStrategy sessionAuthenticationStrategy() {
        
        return new RegisterSessionAuthenticationStrategy(new SessionRegistryImpl());
    }
    
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        
        super.configure(http);
        http.authorizeRequests()
        //注意这句 这个user角色是我们在Keycloak中创建并分配给用户的, 只有用户拥有该role时，用户才能访问对应的资源
                .antMatchers("/customers/*").hasRole("user") 
                .anyRequest()
                .permitAll();
    }

### 4、KeycloakConfig ###

@Configuration
    public class KeycloakConfig {
        
        @Bean
    	public KeycloakSpringBootConfigResolver keycloakConfigResolver() {
        
        	return new KeycloakSpringBootConfigResolver();
    	}
    }

### 5、application.yml ###

server:
      port: 8081 #与keycloak中配置的一致
    
    keycloak:
      auth-server-url: http://localhost:8080  #KeyCloak地址
      realm: MyRealm  #realm名称
      resource: spring-app #client名称
      public-client: true
      principal-attribute: preferred_username
      ssl-required: external

[https_github.com_keycloak_keycloak]: https://github.com/keycloak/keycloak
[https_www.keycloak.org]: https://www.keycloak.org
[16f85dc4ceac475e83efece9f8ef2ed9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/49cb0b64092b4f83b865339618d2895f.png
[71e685fa4c6d4e899b825ab131cc39e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/2a740d74e4cd4106b0a812089e036baa.png
[7f81cb3d792b490a829412076a0a9ddb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/df910db14f074a919b8959c9fdd4914a.png
[4fe9a21b77de48e4945a89fece2d6230.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/34160eca184e42b597eaf26280d71aac.png
[Docker Desktop _]: https://blog.csdn.net/GoodburghCottage/article/details/131413312
[https_hub.docker.com_r_jboss_keycloak]: https://hub.docker.com/r/jboss/keycloak/
[2227d83709b149c9b6fee3d7a61c76dd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/c35a24d23d104841988263e0eb7a0dd7.png
[bc16d2d7d9764631bc710fd164ea7b2b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/c506d3d0004a4260b1809d99df59c8f5.png
[bbf1302024ef433589622ddb0e1f9cda.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/2169470b494c463da378d0a78e6c3d26.png
[4ff2e3951b3f4a36af6156d0227b2359.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/c557ac3259b84720a6540b1202923570.png
[3e31ac5d4092493aace4bb1dc3fea0ae.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/96e1200b38db4e73adb5ff91ed601c09.png
[cb0afc7db2174570afa275e7729c84b7.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/d8aa17229dc44035ab9098bc5d0777bc.png
[9f0051f7ac094e7bbca5ac8090ae80e7.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/bfadae6120db4ac5b155ea7abf3727de.png
[aec42e080ca642e7b7209ad29d87cb14.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/f7c01926b2f144e691c7fa9e85cb0260.png
[5356ec4709444f73b7e22325388e2e16.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/ea1dfacbf5714ff6b745d3a8f197393a.png
[70abfbc0129d49789d9a4ef4b197a8a4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/eeed3b49249c45c3904507b8cc7c06a8.png
[c0a94df9671643e88a6f429ba7bc82d1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/ace1ada4376b43b2a5d98a13f385fdd1.png
[50e3d7334148479fad07954d4e695cbd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/5db91f2c79024db88e698c9e2f385220.png
[ceff1aa0d6884dc0b7ce68fd0293b2fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/85e2f0de909847a9949e7e95bb458241.png
[2422d322f9a44aba94e634370fc880cf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/f2f96350e12c4787abeafa57a53ec462.png
[39c2398765664c35baf0c1eec4646dd7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/ce08a6d1928a412e9f953466a4884c7b.png
[b6247b0688144cb0a0205cfec91c6195.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/7e9ec57cd5ed40e9babd9f3048afe004.png
[2d38d3b773bc4097ab68077f8264eda6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/b34eeb2393a04b96bc9276ae365c7fcd.png
[fbd9dde3b3af4e8aa0917d9c50d08df9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/91ba42cc16a84f75b3de0384e8c8082f.png
[d736738c0ee244e18f5ab4c27e1f411f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/fe6c5dd5e01045c2ab312632ef0af81e.png
[2fd17874e8a342ae98d3c805c784ee50.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/5f6630b812944ef2bbe21ce021ab9fa4.png
[09eba241d4f64414b4b51900103034c9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/1323991f7f29400baa1ba99d5a2b2f8b.png
[d0e58d41daaa4b3b808e3f3522575b48.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/878dd4910cce4c6ca17b2a3ff49e9568.png
[1a631297b9a44e50b4587e2777b8d68d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/8ec59bdf593547c88e705ec555e789a9.png
[3f786e9f86854c028086f5530ac00a2c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/a95801f3955041ce8d1d31455e51e601.png
[8321882763af4fd2bf5b91f8c7fc1024.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/b4f7c26f3ebb41fa9ccdf6e1be1e0f73.png
[5ef406ce85da405da59eb52a088512ff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/35b030393cae4424998d13d36dd875a0.png
[32f0ae696d7a441f952580cec3318451.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/446a0b84d11a4b7c9bfef76c64ddf18c.png
[3ee8bc6fcdc14f028499d76ac2bd9d46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/c7436c157bb444aeb0d581e71130b0b3.png
[04b8c28cbe69422d8df653234d0880d0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/91bee4e01bbf4af3997b98e4243fe52a.png
[a0cbc327e2924b1388a1953d765d6f96.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/48862f90b0e546ba8510a9c6f1c1bec8.png
[734867a4d0324d8ebc8f6ea53b423535.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/b38c5dc388f74f4ea295c76d5cf3d5d9.png