SpringBoot+Spring Security+JWT实现RESTful Api权限控制的方法

2024-07-14 08:43:35

字体：大中小

来源：转载

供稿：网友

摘要：用spring-boot开发RESTful API非常的方便，在生产环境中，对发布的API增加授权保护是非常必要的。现在我们来看如何利用JWT技术为API增加授权保护，保证只有获得授权的用户才能够访问API。

一：开发一个简单的API

在IDEA开发工具中新建一个maven工程，添加对应的依赖如下：

<dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter</artifactId>  </dependency>   <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-test</artifactId>   <scope>test</scope>  </dependency>   <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-web</artifactId>  </dependency>   <!-- spring-data-jpa -->  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-data-jpa</artifactId>  </dependency>   <!-- mysql -->  <dependency>   <groupId>mysql</groupId>   <artifactId>mysql-connector-java</artifactId>   <version>5.1.30</version>  </dependency>   <!-- spring-security 和 jwt -->  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-security</artifactId>  </dependency>  <dependency>   <groupId>io.jsonwebtoken</groupId>   <artifactId>jjwt</artifactId>   <version>0.7.0</version>  </dependency>

新建一个UserController.java文件，在里面在中增加一个hello方法：

@RequestMapping("/hello") @ResponseBody public String hello(){  return "hello"; }

这样一个简单的RESTful API就开发好了。

现在我们运行一下程序看看效果，执行JwtauthApplication.java类中的main方法：

等待程序启动完成后，可以简单的通过curl工具进行API的调用，如下图：

SpringBoot,Spring,Security,JWT,RESTful,权限控制

至此，我们的接口就开发完成了。但是这个接口没有任何授权防护，任何人都可以访问，这样是不安全的，下面我们开始加入授权机制。

二：增加用户注册功能

首先增加一个实体类User.java：

package boss.portal.entity; import javax.persistence.*; /** * @author zhaoxinguo on 2017/9/13. */@Entity@Table(name = "tb_user")public class User {  @Id @GeneratedValue private long id; private String username; private String password;  public long getId() {  return id; }  public String getUsername() {  return username; }  public void setUsername(String username) {  this.username = username; }  public String getPassword() {  return password; }  public void setPassword(String password) {  this.password = password; }}

然后增加一个Repository类UserRepository，可以读取和保存用户信息：

package boss.portal.repository; import boss.portal.entity.User;import org.springframework.data.jpa.repository.JpaRepository; /** * @author zhaoxinguo on 2017/9/13. */public interface UserRepository extends JpaRepository<User, Long> {  User findByUsername(String username); }

在UserController类中增加注册方法，实现用户注册的接口：

/**  * 该方法是注册用户的方法，默认放开访问控制  * @param user  */ @PostMapping("/signup") public void signUp(@RequestBody User user) {  user.setPassword(bCryptPasswordEncoder.encode(user.getPassword()));  applicationUserRepository.save(user); }

其中的@PostMapping("/signup")

这个方法定义了用户注册接口，并且指定了url地址是/users/signup。由于类上加了注解 @RequestMapping(“/users”)，类中的所有方法的url地址都会有/users前缀，所以在方法上只需指定/signup子路径即可。

密码采用了BCryptPasswordEncoder进行加密，我们在Application中增加BCryptPasswordEncoder实例的定义。

package boss.portal; import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.annotation.Bean;import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; @SpringBootApplicationpublic class JwtauthApplication { 	@Bean	public BCryptPasswordEncoder bCryptPasswordEncoder() {		return new BCryptPasswordEncoder();	} 	public static void main(String[] args) {		SpringApplication.run(JwtauthApplication.class, args);	}}

三：增加JWT认证功能

用户填入用户名密码后，与数据库里存储的用户信息进行比对，如果通过，则认证成功。传统的方法是在认证通过后，创建sesstion，并给客户端返回cookie。现在我们采用JWT来处理用户名密码的认证。区别在于，认证通过后，服务器生成一个token，将token返回给客户端，客户端以后的所有请求都需要在http头中指定该token。服务器接收的请求后，会对token的合法性进行验证。验证的内容包括：

内容是一个正确的JWT格式
检查签名
检查claims
检查权限

处理登录

创建一个类JWTLoginFilter，核心功能是在验证用户名密码正确后，生成一个token，并将token返回给客户端：

package boss.portal.web.filter;import boss.portal.entity.User;import com.fasterxml.jackson.databind.ObjectMapper;import io.jsonwebtoken.Jwts;import io.jsonwebtoken.SignatureAlgorithm;import org.springframework.security.authentication.AuthenticationManager;import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;import org.springframework.security.core.Authentication;import org.springframework.security.core.AuthenticationException;import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter; import javax.servlet.FilterChain;import javax.servlet.ServletException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.IOException;import java.util.ArrayList;import java.util.Date; /** * 验证用户名密码正确后，生成一个token，并将token返回给客户端 * 该类继承自UsernamePasswordAuthenticationFilter，重写了其中的2个方法 * attemptAuthentication ：接收并解析用户凭证。 * successfulAuthentication ：用户成功登录后，这个方法会被调用，我们在这个方法里生成token。 * @author zhaoxinguo on 2017/9/12. */public class JWTLoginFilter extends UsernamePasswordAuthenticationFilter {  private AuthenticationManager authenticationManager;  public JWTLoginFilter(AuthenticationManager authenticationManager) {  this.authenticationManager = authenticationManager; }  // 接收并解析用户凭证 @Override public Authentication attemptAuthentication(HttpServletRequest req,            HttpServletResponse res) throws AuthenticationException {  try {   User user = new ObjectMapper()     .readValue(req.getInputStream(), User.class);    return authenticationManager.authenticate(     new UsernamePasswordAuthenticationToken(       user.getUsername(),       user.getPassword(),       new ArrayList<>())   );  } catch (IOException e) {   throw new RuntimeException(e);  } }  // 用户成功登录后，这个方法会被调用，我们在这个方法里生成token @Override protected void successfulAuthentication(HttpServletRequest req,           HttpServletResponse res,           FilterChain chain,           Authentication auth) throws IOException, ServletException {   String token = Jwts.builder()    .setSubject(((org.springframework.security.core.userdetails.User) auth.getPrincipal()).getUsername())    .setExpiration(new Date(System.currentTimeMillis() + 60 * 60 * 24 * 1000))    .signWith(SignatureAlgorithm.HS512, "MyJwtSecret")    .compact();  res.addHeader("Authorization", "Bearer " + token); } }

该类继承自UsernamePasswordAuthenticationFilter，重写了其中的2个方法：

attemptAuthentication ：接收并解析用户凭证。

successfulAuthentication ：用户成功登录后，这个方法会被调用，我们在这个方法里生成token。

授权验证

用户一旦登录成功后，会拿到token，后续的请求都会带着这个token，服务端会验证token的合法性。

创建JWTAuthenticationFilter类，我们在这个类中实现token的校验功能。

package boss.portal.web.filter;import io.jsonwebtoken.Jwts;import org.springframework.security.authentication.AuthenticationManager;import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;import org.springframework.security.core.context.SecurityContextHolder;import org.springframework.security.web.authentication.www.BasicAuthenticationFilter; import javax.servlet.FilterChain;import javax.servlet.ServletException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.IOException;import java.util.ArrayList; /** * token的校验 * 该类继承自BasicAuthenticationFilter，在doFilterInternal方法中， * 从http头的Authorization 项读取token数据，然后用Jwts包提供的方法校验token的合法性。 * 如果校验通过，就认为这是一个取得授权的合法请求 * @author zhaoxinguo on 2017/9/13. */public class JWTAuthenticationFilter extends BasicAuthenticationFilter {  public JWTAuthenticationFilter(AuthenticationManager authenticationManager) {  super(authenticationManager); }  @Override protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {  String header = request.getHeader("Authorization");   if (header == null || !header.startsWith("Bearer ")) {   chain.doFilter(request, response);   return;  }   UsernamePasswordAuthenticationToken authentication = getAuthentication(request);   SecurityContextHolder.getContext().setAuthentication(authentication);  chain.doFilter(request, response);  }  private UsernamePasswordAuthenticationToken getAuthentication(HttpServletRequest request) {  String token = request.getHeader("Authorization");  if (token != null) {   // parse the token.   String user = Jwts.parser()     .setSigningKey("MyJwtSecret")     .parseClaimsJws(token.replace("Bearer ", ""))     .getBody()     .getSubject();    if (user != null) {    return new UsernamePasswordAuthenticationToken(user, null, new ArrayList<>());   }   return null;  }  return null; } }

该类继承自BasicAuthenticationFilter，在doFilterInternal方法中，从http头的Authorization 项读取token数据，然后用Jwts包提供的方法校验token的合法性。如果校验通过，就认为这是一个取得授权的合法请求。

SpringSecurity配置

通过SpringSecurity的配置，将上面的方法组合在一起。

package boss.portal.security;import boss.portal.web.filter.JWTLoginFilter;import boss.portal.web.filter.JWTAuthenticationFilter;import org.springframework.boot.autoconfigure.security.SecurityProperties;import org.springframework.context.annotation.Configuration;import org.springframework.core.annotation.Order;import org.springframework.http.HttpMethod;import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;import org.springframework.security.config.annotation.web.builders.HttpSecurity;import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;import org.springframework.security.core.userdetails.UserDetailsService;import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; /** * SpringSecurity的配置 * 通过SpringSecurity的配置，将JWTLoginFilter，JWTAuthenticationFilter组合在一起 * @author zhaoxinguo on 2017/9/13. */@Configuration@Order(SecurityProperties.ACCESS_OVERRIDE_ORDER)public class WebSecurityConfig extends WebSecurityConfigurerAdapter {  private UserDetailsService userDetailsService;  private BCryptPasswordEncoder bCryptPasswordEncoder;  public WebSecurityConfig(UserDetailsService userDetailsService, BCryptPasswordEncoder bCryptPasswordEncoder) {  this.userDetailsService = userDetailsService;  this.bCryptPasswordEncoder = bCryptPasswordEncoder; }  @Override protected void configure(HttpSecurity http) throws Exception {  http.cors().and().csrf().disable().authorizeRequests()    .antMatchers(HttpMethod.POST, "/users/signup").permitAll()    .anyRequest().authenticated()    .and()    .addFilter(new JWTLoginFilter(authenticationManager()))    .addFilter(new JWTAuthenticationFilter(authenticationManager())); }  @Override public void configure(AuthenticationManagerBuilder auth) throws Exception {  auth.userDetailsService(userDetailsService).passwordEncoder(bCryptPasswordEncoder); } }

这是标准的SpringSecurity配置内容，就不在详细说明。注意其中的

.addFilter(new JWTLoginFilter(authenticationManager())) .addFilter(new JwtAuthenticationFilter(authenticationManager()))

这两行，将我们定义的JWT方法加入SpringSecurity的处理流程中。

下面对我们的程序进行简单的验证：

# 请求hello接口，会收到403错误，如下图：

curl http://localhost:8080/hello

SpringBoot,Spring,Security,JWT,RESTful,权限控制

# 注册一个新用户curl -H"Content-Type: application/json" -X POST -d '{"username":"admin","password":"password"}' http://localhost:8080/users/signup

如下图：

SpringBoot,Spring,Security,JWT,RESTful,权限控制

# 登录，会返回token，在http header中，Authorization: Bearer 后面的部分就是tokencurl -i -H"Content-Type: application/json" -X POST -d '{"username":"admin","password":"password"}' http://localhost:8080/login

如下图：

SpringBoot,Spring,Security,JWT,RESTful,权限控制

# 用登录成功后拿到的token再次请求hello接口# 将请求中的XXXXXX替换成拿到的token# 这次可以成功调用接口了curl -H"Content-Type: application/json" /-H"Authorization: Bearer XXXXXX" /"http://localhost:8080/users/hello"

如下图：

SpringBoot,Spring,Security,JWT,RESTful,权限控制