Spring Security實現分散式系統授權方案詳解

2022-02-09 13:00:47

1 需求分析

回顧技術方案如下：

1、UAA認證服務負責認證授權。

2、所有請求經過閘道器到達微服務

3、閘道器負責鑑權使用者端以及請求轉發

4、閘道器將token解析後傳給微服務，微服務進行授權。

2 註冊中心

所有微服務的請求都經過閘道器，閘道器從註冊中心讀取微服務的地址，將請求轉發至微服務。

本節完成註冊中心的搭建，註冊中心採用Eureka。

1、建立maven工程

2、pom.xml依賴如下

<?xml version="1.0" encoding="UTF-8"?> 
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-
4.0.0.xsd">
    <parent>
        <artifactId>distributed-security</artifactId>
        <groupId>com.lw.security</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>distributed-security-discovery</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>
</project>

3、組態檔

在resources中設定application.yml

spring: 
    application:
        name: distributed-discovery
server:
    port: 53000 #啟動埠
eureka:
  server:
    enable-self-preservation: false    #關閉伺服器自我保護，使用者端心跳檢測15分鐘內錯誤達到80%服務會保護，導致別人還認為是好用的服務
    eviction-interval-timer-in-ms: 10000 #清理間隔（單位毫秒，預設是60*1000）5秒將使用者端剔除的服務在服務註冊列表中剔除# 
    shouldUseReadOnlyResponseCache: true #eureka是CAP理論種基於AP策略，為了保證強一致性關閉此切換CP預設不關閉 false關閉
  client: 
    register-with-eureka: false  #false:不作為一個使用者端註冊到註冊中心
    fetch-registry: false      #為true時，可以啟動，但報異常：Cannot execute request on any known server
    instance-info-replication-interval-seconds: 10 
    serviceUrl: 
      defaultZone: http://localhost:${server.port}/eureka/
  instance:
    hostname: ${spring.cloud.client.ip-address}
    prefer-ip-address: true
    instance-id: ${spring.application.name}:${spring.cloud.client.ip-address}:${spring.application.instance_id:${server.port}}

啟動類：

@SpringBootApplication
@EnableEurekaServer
public class DiscoveryServer {
   public static void main(String[] args) {
      SpringApplication.run(DiscoveryServer.class, args);
  }
}

3 閘道器

閘道器整合 OAuth2.0 有兩種思路，一種是認證伺服器生成jwt令牌, 所有請求統一在閘道器層驗證，判斷許可權等操作；另一種是由各資源服務處理，閘道器只做請求轉發。

我們選用第一種。我們把API閘道器作為OAuth2.0的資源伺服器角色，實現接入使用者端許可權攔截、令牌解析並轉發當前登入使用者資訊(jsonToken)給微服務，這樣下游微服務就不需要關心令牌格式解析以及OAuth2.0相關機制了。

API閘道器在認證授權體系裡主要負責兩件事：

（1）作為OAuth2.0的資源伺服器角色，實現接入方許可權攔截。

（2）令牌解析並轉發當前登入使用者資訊（明文token）給微服務

微服務拿到明文token(明文token中包含登入使用者的身份和許可權資訊)後也需要做兩件事：

（1）使用者授權攔截（看當前使用者是否有權存取該資源）

（2）將使用者資訊儲存進當前執行緒上下文（有利於後續業務邏輯隨時獲取當前使用者資訊）

3.1 建立工程

1、pom.xml

<?xml version="1.0" encoding="UTF-8"?> 
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-
4.0.0.xsd">
    <parent>
        <artifactId>distributed-security</artifactId>
        <groupId>com.lw.security</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>distributed-security-gateway</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId> 
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>com.netflix.hystrix</groupId>
            <artifactId>hystrix-javanica</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-security</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-oauth2</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-jwt</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.interceptor</groupId>
            <artifactId>javax.interceptor-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

2、組態檔

設定application.properties

spring.application.name=gateway-server
server.port=53010
spring.main.allow-bean-definition-overriding = true
logging.level.root = info
logging.level.org.springframework = info
zuul.retryable = true
zuul.ignoredServices = *
zuul.add-host-header = true
zuul.sensitiveHeaders = *
zuul.routes.uaa-service.stripPrefix = false
zuul.routes.uaa-service.path = /uaa/**
zuul.routes.order-service.stripPrefix = false
zuul.routes.order-service.path = /order/**
eureka.client.serviceUrl.defaultZone = http://localhost:53000/eureka/
eureka.instance.preferIpAddress = true
eureka.instance.instance-id = ${spring.application.name}:${spring.cloud.client.ip-address}:${spring.application.instance_id:${server.port}}
management.endpoints.web.exposure.include = refresh,health,info,env
feign.hystrix.enabled = true
feign.compression.request.enabled = true
feign.compression.request.mime-types[0] = text/xml
feign.compression.request.mime-types[1] = application/xml
feign.compression.request.mime-types[2] = application/json
feign.compression.request.min-request-size = 2048
feign.compression.response.enabled = true

統一認證服務（UAA）與統一使用者服務都是閘道器下微服務，需要在閘道器上新增路由設定：

zuul.routes.uaa-service.stripPrefix = false
zuul.routes.uaa-service.path = /uaa/**

zuul.routes.user-service.stripPrefix = false
zuul.routes.user-service.path = /order/**

上面設定了閘道器接收的請求url若符合/order/**表示式，將被被轉發至order-service(統一使用者服務)。

啟動類：

@SpringBootApplication 
@EnableZuulProxy
@EnableDiscoveryClient
public class GatewayServer {
    public static void main(String[] args) {
        SpringApplication.run(GatewayServer.class, args);
    }
}

3.2 token設定

前面也介紹了，資源伺服器由於需要驗證並解析令牌，往往可以通過在授權伺服器暴露check_token的Endpoint來完成，而我們在授權伺服器使用的是對稱加密的jwt，因此知道金鑰即可，資源服務與授權服務本就是對稱設計，那我們把授權服務的TokenConfig兩個類拷貝過來就行。

@Configuration
public class TokenConfig {
  private String SIGNING_KEY = "uaa123";
    @Bean
    public TokenStore tokenStore() {
        return new JwtTokenStore(accessTokenConverter()); 
    }
   @Bean
    public JwtAccessTokenConverter accessTokenConverter() {
        JwtAccessTokenConverter converter = new JwtAccessTokenConverter();
        converter.setSigningKey(SIGNING_KEY); //對稱祕鑰，資源伺服器使用該祕鑰來解密
        return converter;
    }
}

3.3 設定資源服務

在ResouceServerConfig中定義資源服務設定，主要設定的內容就是定義一些匹配規則，描述某個接入使用者端需要什麼樣的許可權才能存取某個微服務，如：

@Configuration
public class ResouceServerConfig {
    public static final String RESOURCE_ID = "res1";
    /**
     * 統一認證服務(UAA) 資源攔截
     */
    @Configuration
    @EnableResourceServer
    public class UAAServerConfig extends
            ResourceServerConfigurerAdapter {
        @Autowired
        private TokenStore tokenStore;
        @Override
        public void configure(ResourceServerSecurityConfigurer resources){
            resources.tokenStore(tokenStore).resourceId(RESOURCE_ID)
                    .stateless(true);
        }
        @Override
        public void configure(HttpSecurity http) throws Exception {
            http.authorizeRequests()
                    .antMatchers("/uaa/**").permitAll();
        }
    }
    /**
     *  訂單服務
     */

@Configuration
    @EnableResourceServer
    public class OrderServerConfig extends
        ResourceServerConfigurerAdapter {
            @Autowired
            private TokenStore tokenStore;
        @Override
        public void configure(ResourceServerSecurityConfigurer resources) {
            resources.tokenStore(tokenStore).resourceId(RESOURCE_ID)
                    .stateless(true);
        }
        @Override
        public void configure(HttpSecurity http) throws Exception {
            http
                    .authorizeRequests()
                    .antMatchers("/order/**").access("#oauth2.hasScope('ROLE_API')");
        }
    }
}

上面定義了兩個微服務的資源，其中：

UAAServerConfig指定了若請求匹配/uaa/**閘道器不進行攔截。

OrderServerConfig指定了若請求匹配/order/**，也就是存取統一使用者服務，接入使用者端需要有scope中包含read，並且authorities(許可權)中需要包含ROLE_USER。

由於res1這個接入使用者端，read包括ROLE_ADMIN,ROLE_USER,ROLE_API三個許可權。

3.4 安全設定

@Configuration 
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
                .authorizeRequests()
                .antMatchers("/**").permitAll()
                .and().csrf().disable();
    }
}

4 轉發明文token給微服務

通過Zuul過濾器的方式實現，目的是讓下游微服務能夠很方便的獲取到當前的登入使用者資訊（明文token）

（ 1）實現Zuul前置過濾器，完成當前登入使用者資訊提取，並放入轉發微服務的request中

/**
 * token傳遞攔截
 */
public class AuthFilter extends ZuulFilter {
    @Override
    public boolean shouldFilter() {
        return true;
    }
    @Override
    public String filterType() {
        return "pre";
    }
    @Override
    public int filterOrder() {
        return 0;
    }
    @Override
    public Object run() {
        /**
         * 1.獲取令牌內容
         */
        RequestContext ctx = RequestContext.getCurrentContext();
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if(!(authentication instanceof OAuth2Authentication)){ // 無token存取閘道器內資源的情況，目前僅有uua服務直接暴露
            return null;
        }
        OAuth2Authentication oauth2Authentication  = (OAuth2Authentication)authentication;
        Authentication userAuthentication = oauth2Authentication.getUserAuthentication();
        Object principal = userAuthentication.getPrincipal();
        /**
         * 2.組裝明文token，轉發給微服務，放入header，名稱為json-token
         */
        List<String> authorities = new ArrayList();
        userAuthentication.getAuthorities().stream().forEach(s ->authorities.add(((GrantedAuthority) s).getAuthority()));
        OAuth2Request oAuth2Request = oauth2Authentication.getOAuth2Request();
        Map<String, String> requestParameters = oAuth2Request.getRequestParameters();
        Map<String,Object> jsonToken = new HashMap<>(requestParameters);
        if(userAuthentication != null){
            jsonToken.put("principal",userAuthentication.getName());
            jsonToken.put("authorities",authorities);
        }
        ctx.addZuulRequestHeader("json-token", EncryptUtil.encodeUTF8StringBase64(JSON.toJSONString(jsonToken)));
        return null;
   }
}

common包下建EncryptUtil類 UTF8互轉Base64

public class EncryptUtil {
    private static final Logger logger = LoggerFactory.getLogger(EncryptUtil.class);

    public static String encodeBase64(byte[] bytes){
        String encoded = Base64.getEncoder().encodeToString(bytes);
        return encoded;
    }
    public static byte[]  decodeBase64(String str){
        byte[] bytes = null;
        bytes = Base64.getDecoder().decode(str);
        return bytes;
    public static String encodeUTF8StringBase64(String str){
        String encoded = null;
        try {
            encoded = Base64.getEncoder().encodeToString(str.getBytes("utf-8"));
        } catch (UnsupportedEncodingException e) {
            logger.warn("不支援的編碼格式",e);
        }
    public static String  decodeUTF8StringBase64(String str){
        String decoded = null;
        byte[] bytes = Base64.getDecoder().decode(str);
            decoded = new String(bytes,"utf-8");
        }catch(UnsupportedEncodingException e){
        return decoded;
    public static String encodeURL(String url) {
    	String encoded = null;
		try {
			encoded =  URLEncoder.encode(url, "utf-8");
		} catch (UnsupportedEncodingException e) {
			logger.warn("URLEncode失敗", e);
		}
		return encoded;
	}
	public static String decodeURL(String url) {
    	String decoded = null;
			decoded = URLDecoder.decode(url, "utf-8");
			logger.warn("URLDecode失敗", e);
		return decoded;
    public static void main(String [] args){
        String str = "abcd{'a':'b'}";
        String encoded = EncryptUtil.encodeUTF8StringBase64(str);
        String decoded = EncryptUtil.decodeUTF8StringBase64(encoded);
        System.out.println(str);
        System.out.println(encoded);
        System.out.println(decoded);
        String url = "== wo";
        String urlEncoded = EncryptUtil.encodeURL(url);
        String urlDecoded = EncryptUtil.decodeURL(urlEncoded);
        
        System.out.println(url);
        System.out.println(urlEncoded);
        System.out.println(urlDecoded);
}

（ 2）將filter納入spring 容器：

設定AuthFilter

@Configuration
public class ZuulConfig {
    @Bean
    public AuthFilter preFileter() {
        return new AuthFilter();
    }
    @Bean
    public FilterRegistrationBean corsFilter() {
        final UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        final CorsConfiguration config = new CorsConfiguration();
        config.setAllowCredentials(true);
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        config.addAllowedMethod("*");
        config.setMaxAge(18000L);
        source.registerCorsConfiguration("/**", config);
        CorsFilter corsFilter = new CorsFilter(source);
        FilterRegistrationBean bean = new FilterRegistrationBean(corsFilter);
        bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
        return bean;
    }
}

5 微服務使用者鑑權攔截

當微服務收到明文token時，應該怎麼鑑權攔截呢？自己實現一個filter？自己解析明文token，自己定義一套資源存取策略？能不能適配Spring Security呢，是不是突然想起了前面我們實現的Spring Security基於token認證例子。咱們還拿統一使用者服務作為閘道器下游微服務，對它進行改造，增加微服務使用者鑑權攔截功能。

（1）增加測試資源

OrderController增加以下endpoint

@PreAuthorize("hasAuthority('p1')")
    @GetMapping(value = "/r1")
    public String r1(){
        UserDTO user = (UserDTO)
SecurityContextHolder.getContext().getAuthentication().getPrincipal();
         return user.getUsername() + "存取資源1";
    }
    @PreAuthorize("hasAuthority('p2')")
    @GetMapping(value = "/r2")
    public String r2(){//通過Spring Security API獲取當前登入使用者
        UserDTO user =
(UserDTO)SecurityContextHolder.getContext().getAuthentication().getPrincipal();
        return user.getUsername() + "存取資源2";
    }

model包下加實體類UserDto

@Data
public class UserDTO {
    private String id;
    private String username;
    private String mobile;
    private String fullname;
}

（2）Spring Security設定

開啟方法保護，並增加Spring設定策略，除了/login方法不受保護(統一認證要呼叫)，其他資源全部需要認證才能存取。

@Override
    public void configure(HttpSecurity http) throws Exception {
        http
                .authorizeRequests()
                .antMatchers("/**").access("#oauth2.hasScope('ROLE_ADMIN')")
                .and().csrf().disable()
                 .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS);
    }

綜合上面的設定，咱們共定義了三個資源了，擁有p1許可權可以存取r1資源，擁有p2許可權可以存取r2資源，只要認證通過就能存取r3資源。

（3）定義filter攔截token，並形成Spring Security的Authentication物件

@Component
public class TokenAuthenticationFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse
httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
               String token = httpServletRequest.getHeader("json-token");
        if (token != null){
            //1.解析token
            String json = EncryptUtil.decodeUTF8StringBase64(token);
            JSONObject userJson = JSON.parseObject(json);
            UserDTO user = new UserDTO();
            user.setUsername(userJson.getString("principal"));
            JSONArray authoritiesArray = userJson.getJSONArray("authorities");
            String  [] authorities = authoritiesArray.toArray( new
String[authoritiesArray.size()]);
            //2.新建並填充authentication
            UsernamePasswordAuthenticationToken authentication = new
UsernamePasswordAuthenticationToken(
                    user, null, AuthorityUtils.createAuthorityList(authorities));
            authentication.setDetails(new WebAuthenticationDetailsSource().buildDetails(
                    httpServletRequest));
            //3.將authentication儲存進安全上下文
            SecurityContextHolder.getContext().setAuthentication(authentication);
        }
        filterChain.doFilter(httpServletRequest, httpServletResponse);
    }
}

經過上邊的過慮器，資源服務中就可以方便到的獲取使用者的身份資訊：

UserDTO user = (UserDTO) SecurityContextHolder.getContext().getAuthentication().getPrincipal();

還是三個步驟：

1.解析token

2.新建並填充authentication

3.將authentication儲存進安全上下文

剩下的事兒就交給Spring Security好了。

6 整合測試

注意:記得uaa跟order的pom匯入eurika座標,以及application.properties設定eurika

本案例測試過程描述：

1、採用OAuth2.0的密碼模式從UAA獲取token

2、使用該token通過閘道器存取訂單服務的測試資源

（1）過閘道器存取uaa的授權及獲取令牌，獲取token。注意埠是53010，閘道器的埠。

如授權 endpoint：

http://localhost:53010/uaa/oauth/authorize?response_type=code&client_id=c1

令牌endpoint

http://localhost:53010/uaa/oauth/token

（2）使用Token過閘道器存取訂單服務中的r1-r2測試資源進行測試。

結果：

使用張三token存取p1，存取成功

使用張三token存取p2，存取失敗

使用李四token存取p1，存取失敗

使用李四token存取p2，存取成功

符合預期結果。

（3）破壞token測試

無token測試返回內容：

{ 
    "error": "unauthorized",
    "error_description": "Full authentication is required to access this resource"
}

破壞token測試返回內容：

{ 
    "error": "invalid_token",
    "error_description": "Cannot convert access token to JSON"
}

7 擴充套件使用者資訊

7.1 需求分析

目前jwt令牌儲存了使用者的身份資訊、許可權資訊，閘道器將token明文化轉發給微服務使用，目前使用者身份資訊僅包括了使用者的賬號，微服務還需要使用者的ID、手機號等重要資訊。

所以，本案例將提供擴充套件使用者資訊的思路和方法，滿足微服務使用使用者資訊的需求。

下邊分析JWT令牌中擴充套件使用者資訊的方案：

在認證階段DaoAuthenticationProvider會呼叫UserDetailService查詢使用者的資訊，這裡是可以獲取到齊全的使用者資訊的。由於JWT令牌中使用者身份資訊來源於UserDetails，UserDetails中僅定義了username為使用者的身份資訊，這裡有兩個思路：第一是可以擴充套件UserDetails，使之包括更多的自定義屬性，第二也可以擴充套件username的內容，比如存入json資料內容作為username的內容。相比較而言，方案二比較簡單還不用破壞UserDetails的結構，我們採用方案二。

7.2 修改UserDetailService

從資料庫查詢到user，將整體user轉成json存入userDetails物件。

@Override 
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
    //登入賬號
    System.out.println("username="+username);
    //根據賬號去資料庫查詢...
    UserDto user = userDao.getUserByUsername(username);
    if(user == null){
        return null;
    }
    //查詢使用者許可權
    List<String> permissions = userDao.findPermissionsByUserId(user.getId());
    String[] perarray = new String[permissions.size()];
    permissions.toArray(perarray);
    //建立userDetails
    //這裡將user轉為json，將整體user存入userDetails
    String principal = JSON.toJSONString(user);
    UserDetails userDetails =
User.withUsername(principal).password(user.getPassword()).authorities(perarray).build();
    return userDetails;
}

7.3 修改資源服務過慮器

資源服務中的過慮器負責從header中解析json-token，從中即可拿閘道器放入的使用者身份資訊，部分關鍵程式碼如下：

... 
if (token != null){
    //1.解析token
    String json = EncryptUtil.decodeUTF8StringBase64(token);
    JSONObject userJson = JSON.parseObject(json);
    //取出使用者身份資訊
    String principal = userJson.getString("principal");
    //將json轉成物件
    UserDTO userDTO = JSON.parseObject(principal, UserDTO.class);
    JSONArray authoritiesArray = userJson.getJSONArray("authorities");
    ...

以上過程就完成自定義使用者身份資訊的方案。

到此這篇關於Spring Security實現分散式系統授權的文章就介紹到這了,更多相關Spring Security分散式授權內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！