登录 注册

SpringCloud Alibaba 微服务实战十七 - JWT 认证

本贴最后更新于 1595 天前，其中的信息可能已经时异事殊

概述

在 OAuth2 体系中认证通过后返回的令牌信息分为两大类：不透明令牌（opaque tokens） 和 透明令牌（not opaque tokens）。

不透明令牌 就是一种无可读性的令牌，一般来说就是一段普通的 UUID 字符串。使用不透明令牌会降低系统性能和可用性，并且增加延迟，因为资源服务不知道这个令牌是什么，代表谁，需要调用认证服务器获取用户信息接口，如下就是我们在资源服务器中的配置，需要指明认证服务器的接口地址。

security:
  oauth2:
    resource:
      user-info-uri: http://localhost:5000/user/current/get
      id: account-service

透明令牌的典型代表就是 JWT 了，用户信息保存在 JWT 字符串中，资源服务器自己可以解析令牌不再需要去认证服务器校验令牌。

之前的章节中我们是使用了不透明令牌 access_token，但考虑到在微服务体系中这种中心化的授权服务会成为瓶颈，本章我们就使用 jwt 来替换之前的 access_token，专（zhuang）业（bi）点就叫去中心化。

image.png

jwt 是什么

Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于 JSON 的开放标准（RFC 7519)。该 token 被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO）场景。JWT 的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源，也可以增加一些额外的其它业务逻辑所必须的声明信息，该 token 也可直接被用于认证，也可被加密。

简单点说就是一种固定格式的字符串，通常是加密的；

它由三部分组成，头部、载荷与签名，这三个部分都是 json 格式。

  • Header 头部：JSON 方式描述 JWT 基本信息，如类型和签名算法。使用 Base64 编码为字符串
  • Payload 载荷: JSON 方式描述 JWT 信息，除了标准定义的，还可以添加自定义的信息。同样使用 Base64 编码为字符串。
    1. iss: 签发者
    2. sub: 用户
    3. aud: 接收方
    4. exp(expires): unix 时间戳描述的过期时间
    5. iat(issued at): unix 时间戳描述的签发时间
  • Signature 签名: 将前两个字符串用 . 连接后，使用头部定义的加密算法，利用密钥进行签名，并将签名信息附在最后。

JWT 可以使用对称的加密密钥，但更安全的是使用非对称的密钥，本篇文章使用的是对称加密。

代码修改

数据库

原来使用 access_token 的时候我们建立了 7 张 oauth2 相关的数据表

image.png

使用 jwt 的话只需要在数据库存储一下 client 信息即可，所以我们只需要保留数据表 oauth_client_details。image.png

其他数据表已不再需要，大家可以删除。

认证服务 AuthorizationServerConfig

  1. 修改 AuthorizationServerConfig 中 TokenStore 的相关配置
@Bean
public TokenStore tokenStore() {
    //return new JdbcTokenStore(dataSource);
        return new JwtTokenStore(jwtTokenEnhancer());
}


/**
 * JwtAccessTokenConverter
 * TokenEnhancer的子类，帮助程序在JWT编码的令牌值和OAuth身份验证信息之间进行转换。
 */
@Bean
public JwtAccessTokenConverter jwtTokenEnhancer(){
        JwtAccessTokenConverter converter = new JwtAccessTokenConverter();
        // 设置对称签名
        converter.setSigningKey("javadaily");
        return converter;
}

之前我们是将 access_token 存入数据库，使用 jwt 后不再需要存入数据库，所以我们需要修改存储方式。

jwt 需要使用加密算法对信息签名，这里我们先使用 对称秘钥 （javadaily）来签署我们的令牌，对称秘钥当然这也以为着资源服务器也需要使用相同的秘钥。

  1. 修改 configure(AuthorizationServerEndpointsConfigurer endpoints) 方法，配置 jwt
@Override
public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
        //如果需要使用refresh_token模式则需要注入userDetailService
        endpoints.authenticationManager(this.authenticationManager)
                        .userDetailsService(userDetailService)
                        .tokenStore(tokenStore())
                        .accessTokenConverter(jwtTokenEnhancer());
}

这里主要是注入 accessTokenConverter，即上面配置的 token 转换器。

经过上面的配置，认证服务器已经可以帮我们生成 jwt token 了，这里我们先使用 Postman 调用一下，看看生成的 jwt token。

image.png

从上图看出已经正常生成 jwt token，我们可以将生成的 jwt token 拿到 https://jwt.io/网站上进行解析。

如果大家对生成 jwt token 的逻辑不是很了解，可以在 DefaultTokenServices#createAccessToken(OAuth2Authentication authentication) 和 JwtAccessTokenConverter#enhance(OAuth2AccessToken accessToken, OAuth2Authentication authentication) 上打个断点，观察代码执行的效果。

  1. 删除认证服务器提供给资源服务器获取用户信息的接口
/**
 * 获取授权的用户信息
 * @param principal 当前用户
 * @return 授权信息
 */@GetMapping("current/get")
public Principal user(Principal principal){
        return principal;
}

用了透明令牌 jwt token 后资源服务器可以直接解析验证 token，不再需要调用认证服务器接口，所以此处可以直接删除。

  1. 修改 jwt token 有效期（可选）

    jwt token 的默认有效期为 12 小时，refresh token 的有效期为 30 天，如果要修改默认时间可以注入 DefaultTokenServices 并修改有效时间。

@Primary
@Bean
public DefaultTokenServices tokenServices(){
        DefaultTokenServices tokenServices = new DefaultTokenServices();
        tokenServices.setTokenEnhancer(jwtTokenEnhancer());
        tokenServices.setTokenStore(tokenStore());
        tokenServices.setSupportRefreshToken(true);
        //设置token有效期，默认12小时，此处修改为6小时   21600
        tokenServices.setAccessTokenValiditySeconds(60 * 60 * 6);
        //设置refresh_token的有效期，默认30天，此处修改为7天
        tokenServices.setRefreshTokenValiditySeconds(60 * 60 * 24 * 7);
        return tokenServices;
}

然后在 configure() 方法中添加 tokenServices

@Override
public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
                //如果需要使用refresh_token模式则需要注入userDetailService
        endpoints.authenticationManager(this.authenticationManager)
                        .userDetailsService(userDetailService)
            //注入自定义的tokenservice，如果不使用自定义的tokenService那么就需要将tokenServce里的配置移到这里
                        .tokenServices(tokenServices());
}

资源服务器 ResourceServerConfig

  1. 删除资源服务器中配置认证服务器的接口属性 user-info-uri
security:  
	oauth2:  
		resource:  
			id: account-service
  1. 注入 TokenStore 和 JwtAccessTokenConverter
@Bean
public TokenStore tokenStore() {
        return new JwtTokenStore(jwtTokenEnhancer());
}

@Bean
public JwtAccessTokenConverter jwtTokenEnhancer(){
        JwtAccessTokenConverter jwtTokenEnhancer = new JwtAccessTokenConverter();
        jwtTokenEnhancer.setSigningKey("javadaily");
        return jwtTokenEnhancer;
}

注意：对称加密算法需要跟认证服务器秘钥保持一致，当然这里可以提取到配置文件中。

  1. 添加 configure(ResourceServerSecurityConfigurer resources) 方法，加入 token 相关配置
@Override
public void configure(ResourceServerSecurityConfigurer resources) throws Exception {
        resources.resourceId(resourceId)
                        .tokenStore(tokenStore());
}

思考题：资源服务器使用 jwt 后从哪校验 token 呢？

给应用添加 @EnableResourceServer 注解后会给 Spring Security 的 FilterChan 添加一个 OAuth2AuthenticationProcessingFilter，OAuth2AuthenticationProcessingFilter 会使用 OAuth2AuthenticationManager 来验证 token。

校验逻辑主体代码执行顺序如下：

image.png

建议大家在 OAuth2AuthenticationProcessingFilter#doFilter() 处打个断点体会一下校验过程。

网关 SecurityConfig

  1. 创建 ReactiveJwtAuthenticationManager 从 tokenStore 加载 OAuth2AccessToken

    由于原来的 access_token 是存储在数据库中，所以我们编写了 ReactiveJdbcAuthenticationManager 来从数据库获取 access_token，现在使用 jwt 我们也需要定义一个 jwt 的相关类 ReactiveJwtAuthenticationManager，代码跟 ReactiveJdbcAuthenticationManager 一样，这里就不再贴出。

  2. 注入 TokenStore 和 JwtAccessTokenConverter

@Bean  
public TokenStore tokenStore() {
        return new JwtTokenStore(jwtTokenEnhancer());
}

@Bean  
public JwtAccessTokenConverter jwtTokenEnhancer(){
        JwtAccessTokenConverter jwtTokenEnhancer = new JwtAccessTokenConverter();
        jwtTokenEnhancer.setSigningKey("javadaily");
        return jwtTokenEnhancer;
}

注意：对称加密算法需要跟认证服务器秘钥保持一致，当然这里可以提取到配置文件中。

  1. 修改 SecurityConfig#SecurityWebFilterChain() 方法，替换 ReactiveJdbcAuthenticationManager
ReactiveAuthenticationManager tokenAuthenticationManager 
= new ReactiveJwtAuthenticationManager(tokenStore());

只需要将 tokenStore 传入构造器即可。

测试

大家自行测试。

小结

使用 jwt token 和 access_token 最大的区别就是资源服务器不再需要去认证服务器校验 token，提升了系统整体性能，使用 jwt 后项目的流程架构如下：

image.png

本系列文章目前是第 19 篇，如果大家对之前的文章感兴趣可以移步至 http://javadaily.cn/tags/SpringCloud 查看

使用了 jwt 我们不仅要看到 jwt 的优点，也要看到它的缺点，这样我们才能根据实际场景自由选择，下面是 jwt 最大的两个缺点：

  • jwt 是一次性的，一旦 token 被签发，那么在到期时间之前都是有效的，无法废弃。如果你中途修改了用户权限需要更新信息那就只能重新签发一个 jwt，但是旧的 jwt 还是可以正常使用，使用旧的 jwt 拿到的信息也就是过时的。
  • jwt 包含了认证信息，一旦泄露，任何人都可以获得该令牌的所有权限。为了防止盗用，jwt 的有效时间不应该设置过长。
  • Spring

    Spring 是一个开源框架，是于 2003 年兴起的一个轻量级的 Java 开发框架，由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构，分层架构允许使用者选择使用哪一个组件，同时为 JavaEE 应用程序开发提供集成的框架。

    944 引用 • 1459 回帖 • 17 关注
  • 微服务

    微服务架构是一种架构模式，它提倡将单一应用划分成一组小的服务。服务之间互相协调，互相配合，为用户提供最终价值。每个服务运行在独立的进程中。服务于服务之间才用轻量级的通信机制互相沟通。每个服务都围绕着具体业务构建，能够被独立的部署。

    96 引用 • 155 回帖 • 1 关注
3 操作
jianzh5 在 2020-07-10 08:14:06 更新了该帖
jianzh5 在 2020-07-09 10:09:11 更新了该帖
jianzh5 在 2020-07-09 09:20:01 更新了该帖
合肥 位置
3 操作
1 回帖
614 28 194 65 1 54 20 1 23 219

相关帖子

1 回帖
SpringCloud Alibaba 微服务实战十七 - JWT 认证

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
  • 19852860636 •

    😂 请教一下，资源服务器下第三点，resourceId 是从哪里来的？

jianzh5
JAVA 日知录 合肥
回帖
75
 帖子
150
 积分
1268