寫在前面
思考:為什麼需要鑑權呢?
系統開發好上線後,API介面會暴露在網際網路上會存在一定的安全風險,例如:爬蟲、惡意訪問等。因此,我們需要對非開放API介面進行使用者鑑權,鑑權通過之後再允許呼叫。
準備
spring-boot:2.1.4.RELEASE
spring-security-oauth2:2.3.3.RELEASE(如果要使用原始碼,不要隨意改動這個版本號,因為2.4往上的寫法不一樣了)
mysql:5.7
效果展示
這邊只用了postman做測試,暫時未使用前端頁面來對接,下個版本角色選單許可權分配的會有頁面的展示
1、訪問開放介面 http://localhost:7000/open/hello
2、不帶token訪問受保護介面 http://localhost:7000/admin/user/info
3、登入後獲取token,帶上token訪問,成功返回了當前的登入使用者資訊
實現
oauth2一共有四種模式,這邊就不做講解了,網上搜一搜,千篇一律
因為現在只考慮做單方應用的,所以使用的是密碼模式。
後面會出一篇SpringCloud+Oauth2的文章,閘道器鑑權
講一下幾個點吧
1、攔截器配置動態許可權
新建一個 MySecurityFilter類,繼承AbstractSecurityInterceptor,並實現Filter介面
初始化,自定義訪問決策管理器
@PostConstruct public void init(){ super.setAuthenticationManager(authenticationManager); super.setAccessDecisionManager(myAccessDecisionManager); }
自定義 過濾器呼叫安全後設資料源
@Override public SecurityMetadataSource obtainSecurityMetadataSource() { return this.mySecurityMetadataSource; }
先來看一下自定義過濾器呼叫安全後設資料源的核心程式碼
以下程式碼是用來獲取到當前請求進來所需要的許可權(角色)
/** * 獲得當前請求所需要的角色 * @param object * @return * @throws IllegalArgumentException */ @Override public Collection<ConfigAttribute> getAttributes(Object object) throws IllegalArgumentException { String requestUrl = ((FilterInvocation) object).getRequestUrl(); if (IS_CHANGE_SECURITY) { loadResourceDefine(); } if (requestUrl.indexOf("?") > -1) { requestUrl = requestUrl.substring(0, requestUrl.indexOf("?")); } UrlPathMatcher matcher = new UrlPathMatcher(); List<Object> list = new ArrayList<>(); //無需許可權的,直接返回 list.add("/oauth/**"); list.add("/open/**"); if(matcher.pathsMatchesUrl(list,requestUrl)) return null; Set<String> roleNames = new HashSet(); for (Resc resc: resources) { String rescUrl = resc.getResc_url(); if (matcher.pathMatchesUrl(rescUrl, requestUrl)) { if(resc.getParent_resc_id() != null && resc.getParent_resc_id().intValue() == 1){ //預設許可權的則只要登入了,無需許可權匹配都可訪問 roleNames = new HashSet(); break; } Map map = new HashMap(); map.put("resc_id", resc.getResc_id()); // 獲取能訪問該資源的所有許可權(角色) List<RoleRescDTO> roles = roleRescMapper.findAll(map); for (RoleRescDTO rr : roles) roleNames.add(rr.getRole_name()); } } Set<ConfigAttribute> configAttributes = new HashSet(); for(String roleName:roleNames) configAttributes.add(new SecurityConfig(roleName)); log.debug("【所需的許可權(角色)】:" + configAttributes); return configAttributes; }
再來看一下自定義訪問決策管理器核心程式碼,這段程式碼主要是判斷當前登入使用者(當前登入使用者所擁有的角色會在最後一項寫到)是否擁有該許可權角色
@Override public void decide(Authentication authentication, Object o, Collection<ConfigAttribute> configAttributes) throws AccessDeniedException, InsufficientAuthenticationException { if(configAttributes == null){ //屬於白名單的,不需要許可權 return; } Iterator<ConfigAttribute> iterator = configAttributes.iterator(); while (iterator.hasNext()){ ConfigAttribute configAttribute = iterator.next(); String needPermission = configAttribute.getAttribute(); for (GrantedAuthority ga: authentication.getAuthorities()) { if(needPermission.equals(ga.getAuthority())){ //有許可權,可訪問 return; } } } throw new AccessDeniedException("沒有許可權訪問"); }
2、自定義鑑權異常返回通用結果
為什麼需要這個呢,如果不配置這個,對於前端,後端來說都很難去理解鑑權失敗返回的內容,還不能統一解讀,廢話不多說,先看看不配置和配置了的返回情況
(1)未自定義前,沒有攜帶token去訪問受保護的API介面時,返回的結果是這樣的
(2)我們規定一下,鑑權失敗的介面返回介面之後,變成下面這種了,是不是更利於我們處理和提示使用者
好了,來看一下是在哪裡去配置的吧
我們資源伺服器OautyResourceConfig,重寫下下面這部分的程式碼,來自定義鑑權異常返回的結果
大夥可以參考下這個 https://blog.csdn.net/Pastxu/article/details/124538364
@Override public void configure(ResourceServerSecurityConfigurer resources) throws Exception { resources.authenticationEntryPoint(authenticationEntryPoint) //token失效或沒攜帶token時 .accessDeniedHandler(requestAccessDeniedHandler); //許可權不足時 }
3、獲取當前登入使用者
第一種:使用JWT攜帶使用者資訊,拿到token後再解析
暫不做解釋
第二種:寫一個SecurityUser實現UserDetails介面(這個工程中使用的是這一種)
原來的只有UserDetails介面只有username和password,這裡我們加上我們系統中的User
protected User user; public SecurityUser(User user) { this.user = user; } public User getUser() { return user; }
在BaseController,每個Controller都會繼承這個的,在裡面寫給getUser()的方法,只要使用者帶了token來訪問,我們可以直接獲取當前登入使用者的資訊了
protected User getUser() { try { SecurityUser userDetails = (SecurityUser) SecurityContextHolder.getContext().getAuthentication() .getPrincipal(); User user = userDetails.getUser(); log.debug("【使用者:】:" + user); return user; } catch (Exception e) { } return null; }
那麼使用者登入成功後,如何去拿到使用者的角色集合等呢,這裡面就要實現UserDetailsService介面了
@Service public class TokenUserDetailsService implements UserDetailsService{ @Autowired private LoginService loginService; @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { User user = loginService.loadUserByUsername(username); //這個我們拎出來處理 if(Objects.isNull(user)) throw new UsernameNotFoundException("使用者名稱不存在"); return new SecurityUser(user); } }
然後在我們的安全配置類中設定UserDetailsService為上面的我們自己寫的就行
@Override protected void configure(AuthenticationManagerBuilder auth) throws Exception { auth.userDetailsService(userDetailsService).passwordEncoder(passwordEncoder()); }
最後我們只需要在loginService裡面實現我們的方法就好,根據我們的實際業務處理判斷該使用者是否存在等
@Override public User loadUserByUsername(String username){ log.debug(username); Map map = new HashMap(); map.put("username",username); map.put("is_deleted",-1); User user = userMapper.findByUsername(map); if(user != null){ map = new HashMap(); map.put("user_id",user.getUser_id()); //查詢使用者的角色 List<UserRoleDTO> userRoles = userRoleMapper.findAll(map); user.setRoles(listRoles(userRoles)); //許可權集合 Collection<? extends GrantedAuthority> authorities = merge(userRoles); user.setAuthorities(authorities); return user; } return null; }
大功告成啦,趕緊動起手來吧!
附上原始碼地址:https://gitee.com/jae_1995/spring-boot-oauth2
資料庫檔案在這
點個小讚唄