OAuth2使用Redis来存储客户端信息以及AccessToken

使用Redis来存储OAuth2相关的客户端信息以及生成的AccessToken是一个不错的选择,Redis与生俱来的的高效率、集群部署是比较出色的功能,如果用来作为服务认证中心的数据存储,可以大大的提高响应效率。

Redis还支持超时自动删除功能,OAuth2所生成的AccessToken相关的数据在超过配置的有效时间后就会自动被清除,这样也隐形的提高了接口的安全性。

既然Redis可以做到这么好,我们该怎么实现代码逻辑呢?

ApiBoot OAuth2是支持使用Redis来存储AccessToken的,只需要修改application.yml一个配置就可以实现,相关的使用也可以通过查看文档了解。

创建项目

我们使用IDEA开发工具创建一个SpringBoot项目,在项目的pom.xml添加我们需要的ApiBoot统一版本依赖以及安全组件依赖,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.minbox.framework</groupId>
<artifactId>api-boot-starter-security-oauth-jwt</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.minbox.framework</groupId>
<artifactId>api-boot-dependencies</artifactId>
<version>2.2.0.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

添加Redis支持

既然我们本章需要用到Redis,我们需要在项目内添加相关的依赖,SpringBoot已经为我们提供了封装好的依赖,在pom.xml文件内dependencies节点下添加,如下所示:

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

配置Redis连接信息

SpringBootRedis的连接、数据操作都做了封装,我们只需要在application.yml配置文件内添加响应的Redis连接信息即可。

spring-boot-starter-data-redis依赖所需要的配置都是由RedisProperties类提供,该类内有部分配置字段存在默认值,部分源码如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@ConfigurationProperties(prefix = "spring.redis")
public class RedisProperties {

/**
* Database index used by the connection factory.
*/
private int database = 0;

/**
* Connection URL. Overrides host, port, and password. User is ignored. Example:
* redis://user:password@example.com:6379
*/
private String url;

/**
* Redis server host.
*/
private String host = "localhost";

/**
* Login password of the redis server.
*/
private String password;

/**
* Redis server port.
*/
private int port = 6379;
//...
}

默认配置下连接Redis只需要在application.yml配置spring.redis.password,如下所示:

1
2
3
4
spring:
# 配置Redis连接信息
redis:
password: 123123

password是连接Redis所需要的密码,在redis.conf文件内配置。

相关配置解释:

  • spring.redis.database:如果你使用的Redis DataBase并不是默认的0索引,需要修改该配置
  • spring.redis.host:默认为localhost,如果不是本地使用,需要修改该配置
  • spring.redis.url:这是一个连接字符串,如天配置了会自动覆盖databasehostport等三个配置信息
  • spring.redis.port:默认为Redis的端口号6379,如已修改Redis的监听端口号,需要修改该配置

启用ApiBoot OAuth Redis

ApiBoot OAuth提供了redis配置选项,在application.yml文件内通过api.boot.oauth.away配置参数指定,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
api:
boot:
security:
# 配置内存安全用户列表
users:
- username: yuqiyu
password: 123123
oauth:
# 配置使用Redis存储OAuth2相关数据
away: redis
# 配置客户端列表
clients:
- clientId: minbox
clientSecret: chapter

为了方便演示,我们使用ApiBoot Security的内存方式配置了一个用户yuqiyu,而且还修改了默认client信息,新加了minbox客户端。

如果对ApiBoot Security用户配置或者ApiBoot OAuth的客户端配置不了解,可以查看官方文档:

或者你可以查看我编写的ApiBoot系列的文章:ApiBoot开源框架各个组件的系列使用文章汇总

运行测试

在运行测试之前我们添加一个名为ApiController的控制器用来测试,代码如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/**
* 测试Api控制器
*
* @author 恒宇少年
*/
@RestController
@RequestMapping(value = "/api")
public class ApiController {
/**
* 测试请求,需携带令牌访问
*
* @return
*/
@GetMapping(value = "/index")
public String index() {
return "this is index";
}
}

测试点:查看Redis存储的AccessToken

预计效果是当我们发送获取AccessToken的请求时,会自动将生成的AccessToken存储到Redis

下面我们使用CURL命令来尝试获取下AccessToken,如下所示:

1
2
➜ ~ curl minbox:chapter@localhost:9090/oauth/token -d 'grant_type=password&username=yuqiyu&password=123123'
{"access_token":"38a7ee20-2fad-43c5-a349-31e6f0ee0f29","token_type":"bearer","refresh_token":"f469b1e8-f63c-4be9-8564-2603f8458024","expires_in":7199,"scope":"api"}

下面我们使用redis-cli来看下是否已经将AccessToken存储到Redis,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
➜ ~ redis-cli 
127.0.0.1:6379> auth 123123
OK
127.0.0.1:6379> keys *
1) "uname_to_access:minbox:yuqiyu"
2) "refresh_to_access:f469b1e8-f63c-4be9-8564-2603f8458024"
3) "access_to_refresh:1ea8e5cd-ea63-4a73-969f-9e7767f25f30"
4) "auth:38a7ee20-2fad-43c5-a349-31e6f0ee0f29"
5) "refresh_auth:6898bef4-f4a7-4fa9-858b-a4c62a1567d8"
6) "refresh:6898bef4-f4a7-4fa9-858b-a4c62a1567d8"
7) "refresh_auth:f469b1e8-f63c-4be9-8564-2603f8458024"
8) "access:38a7ee20-2fad-43c5-a349-31e6f0ee0f29"
9) "refresh_to_access:6898bef4-f4a7-4fa9-858b-a4c62a1567d8"
1) "auth_to_access:f02ceb5faa4577222082842b82a57067"
2) "refresh:f469b1e8-f63c-4be9-8564-2603f8458024"
3) "access_to_refresh:38a7ee20-2fad-43c5-a349-31e6f0ee0f29"
4) "client_id_to_access:minbox"

结果往往让人感觉惊喜,看到这里我们已经成功的把OAuth2生成的AccessToken存储到了Redis,如果AccessToken对应的数据超过了expires_in时间,就会自动被清除。

测试点:携带AccessToken访问接口

我们可以拿着生成的AccessToken来访问在上面添加的测试ApiController内的接口,如下所示:

1
2
➜ ~ curl -H 'Authorization: Bearer 38a7ee20-2fad-43c5-a349-31e6f0ee0f29' http://localhost:9090/api/index
this is index

我们可以拿到接口的返回的接口,这也证明了一点,AccessToken的验证是没有问题的,OAuth2拿着请求携带的AccessTokenRedis验证通过。

敲黑板,划重点

ApiBoot OAuth所支持的3种存储方式都已经通过文章的方式告知大家,每一种方式都做到了精简,简单的配置,添加相关的依赖,就能够实现在之前让很多人头疼的集成。

如果在生产环境中数据量较大,建议使用Redis集群来解决存储AccessToken的问题。

代码示例

如果您喜欢本篇文章请为源码仓库点个Star,谢谢!!!
本篇文章示例源码可以通过以下途径获取,目录为apiboot-oauth-use-redis-storage

本文由程序员 - 恒宇少年编写,遵循CC 4.0 BY-SA版权协议,转载请注明文章出处,如需公众号转载,请联系「微信

文章标签: ApiBoot

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×