Shiro是apache旗下一个开源安全框架(http://shiro.apache.org/),它将软件系统的安全认证相关的功能抽取出来,实现用户身份认证,权限受权、加密、会话管理等功能,组成了一个通用的安全认证框架。使用shiro就能够很是快速的完成认证、受权等功能的开发,下降系统成本。html
用户在进行资源访问时,要求系统要对用户进行权限控制,其具体流程如图所示:web
在概念层面,Shiro 架构包含三个主要的理念,如图所示:redis
其中:算法
Shiro框架进行权限管理时,要涉及到的一些核心对象,主要包括:认证管理对象,受权管理对象,会话管理对象,缓存管理对象,加密管理对象以及Realm管理对象(领域对象:负责处理认证和受权领域的数据访问题)等,其具体架构如图-3所示:spring
其中:chrome
使用spring整合shiro时,须要在pom.xml中添加以下依赖:数据库
<dependency> <groupId>org.apache.shiro</groupId> <artifactId>shiro-spring</artifactId> <version>1.5.3</version> </dependency>
基于SpringBoot 实现的项目中,咱们的shiro应用基本配置以下:。apache
第一步:建立SpringShiroConfig类。关键代码以下:segmentfault
package com.cy.pj.common.config; /**@Configuration 注解描述的类为一个配置对象, * 此对象也会交给spring管理 */ @Configuration public class SpringShiroConfig { }
第二步:在Shiro配置类中添加SecurityManager配置(这里必定要使用org.apache.shiro.mgt.SecurityManager这个接口对象),关键代码以下:浏览器
@Bean public SecurityManager securityManager() { DefaultWebSecurityManager sManager= new DefaultWebSecurityManager(); return sManager; }
第三步: 在Shiro配置类中添加ShiroFilterFactoryBean对象的配置。经过此对象设置资源匿名访问、认证访问。关键代码以下:
其配置过程当中,对象关系以下图所示:
当服务端拦截到用户请求之后,断定此请求是否已经被认证,假如没有认证应该先跳转到登陆页面。
第一步:在PageController中添加一个呈现登陆页面的方法,关键代码以下:
@RequestMapping("doLoginUI") public String doLoginUI(){ return "login"; }
第二步:修改SpringShiroConfig类中shiroFilterFactorybean的配置,添加登录url的设置。关键代码见sfBean.setLoginUrl("/doLoginUI")部分。
@Bean public ShiroFilterFactoryBean shiroFilterFactory ( SecurityManager securityManager) { ShiroFilterFactoryBean sfBean= new ShiroFilterFactoryBean(); sfBean.setSecurityManager(securityManager); sfBean.setLoginUrl("/doLoginUI"); //定义map指定请求过滤规则(哪些资源容许匿名访问,哪些必须认证访问) LinkedHashMap<String,String> map= new LinkedHashMap<>(); //静态资源容许匿名访问:"anon" map.put("/bower_components/**","anon"); map.put("/modules/**","anon"); map.put("/dist/**","anon"); map.put("/plugins/**","anon"); //除了匿名访问的资源,其它都要认证("authc")后访问 map.put("/**","authc"); sfBean.setFilterChainDefinitionMap(map); return sfBean; }
在/templates/pages/添加一个login.html页面,而后将项目部署到web服务器,并启动测试运行.
具体代码见项目中login.html。
身份认证即断定用户是不是系统的合法用户,用户访问系统资源时的认证(对用户身份信息的认证)流程图所示:
其中认证流程分析以下:
思考:不使用shiro框架如何完成认证操做?filter,intercetor。
认证业务API处理流程分析,如图所示:
在用户数据层对象SysUserDao中,按特定条件查询用户信息,并对其进行封装。
在SysUserDao接口中,添加根据用户名获取用户对象的方法,关键代码以下:
SysUser findUserByUserName(String username)。
根据SysUserDao中定义的方法,在SysUserMapper文件中添加元素定义。
基于用户名获取用户对象的方法,关键代码以下:
<select id="findUserByUserName" resultType="com.cy.pj.sys.entity.SysUser"> select * from sys_users where username=#{username} </select>
本模块的业务在Realm类型的对象中进行实现,咱们编写realm时,要继承
AuthorizingRealm并重写相关方法,完成认证及受权业务数据的获取及封装。
第一步:定义ShiroUserRealm类,关键代码以下:
package com.cy.pj.sys.service.realm; @Service public class ShiroUserRealm extends AuthorizingRealm { @Autowired private SysUserDao sysUserDao; /** * 设置凭证匹配器(与用户添加操做使用相同的加密算法) */ @Override public void setCredentialsMatcher( CredentialsMatcher credentialsMatcher) { //构建凭证匹配对象 HashedCredentialsMatcher cMatcher= new HashedCredentialsMatcher(); //设置加密算法 cMatcher.setHashAlgorithmName("MD5"); //设置加密次数 cMatcher.setHashIterations(1); super.setCredentialsMatcher(cMatcher); } /** * 经过此方法完成认证数据的获取及封装,系统 * 底层会将认证数据传递认证管理器,由认证 * 管理器完成认证操做。 */ @Override protected AuthenticationInfo doGetAuthenticationInfo( AuthenticationToken token) throws AuthenticationException { //1.获取用户名(用户页面输入) UsernamePasswordToken upToken= (UsernamePasswordToken)token; String username=upToken.getUsername(); //2.基于用户名查询用户信息 SysUser user= sysUserDao.findUserByUserName(username); //3.断定用户是否存在 if(user==null) throw new UnknownAccountException(); //4.断定用户是否已被禁用。 if(user.getValid()==0) throw new LockedAccountException(); //5.封装用户信息 ByteSource credentialsSalt= ByteSource.Util.bytes(user.getSalt()); //记住:构建什么对象要看方法的返回值 SimpleAuthenticationInfo info= new SimpleAuthenticationInfo( user,//principal (身份) user.getPassword(),//hashedCredentials credentialsSalt, //credentialsSalt getName());//realName //6.返回封装结果 return info;//返回值会传递给认证管理器(后续 //认证管理器会经过此信息完成认证操做) } .... }
第二步:对此realm,须要在SpringShiroConfig配置类中,注入给SecurityManager对象,修改securityManager方法,见黄色背景部分,例如:
@Bean public SecurityManager securityManager(Realm realm) { DefaultWebSecurityManager sManager= new DefaultWebSecurityManager(); sManager.setRealm(realm); return sManager; }
在此对象中定义相关方法,处理客户端的登录请求,例如获取用户名,密码等而后提交该shiro框架进行认证。
第一步:在SysUserController中添加处理登录的方法。关键代码以下:
@RequestMapping("doLogin") public JsonResult doLogin(String username,String password){ //1.获取Subject对象 Subject subject=SecurityUtils.getSubject(); //2.经过Subject提交用户信息,交给shiro框架进行认证操做 //2.1对用户进行封装 UsernamePasswordToken token= new UsernamePasswordToken( username,//身份信息 password);//凭证信息 //2.2对用户信息进行身份认证 subject.login(token); //分析: //1)token会传给shiro的SecurityManager //2)SecurityManager将token传递给认证管理器 //3)认证管理器会将token传递给realm return new JsonResult("login ok"); }
第二步:修改shiroFilterFactory的配置,对/user/doLogin这个路径进行匿名访问的配置,查看以下黄色标记部分的代码:
@Bean public ShiroFilterFactoryBean shiroFilterFactory ( SecurityManager securityManager) { ShiroFilterFactoryBean sfBean= new ShiroFilterFactoryBean(); sfBean.setSecurityManager(securityManager); //假如没有认证请求先访问此认证的url sfBean.setLoginUrl("/doLoginUI"); //定义map指定请求过滤规则(哪些资源容许匿名访问,哪些必须认证访问) LinkedHashMap<String,String> map= new LinkedHashMap<>(); //静态资源容许匿名访问:"anon" map.put("/bower_components/**","anon"); map.put("/build/**","anon"); map.put("/dist/**","anon"); map.put("/plugins/**","anon"); map.put("/user/doLogin","anon"); //authc表示,除了匿名访问的资源,其它都要认证("authc")后才能访问访问 map.put("/**","authc"); sfBean.setFilterChainDefinitionMap(map); return sfBean; }
第三步:当咱们在执行登陆操做时,为了提升用户体验,可对系统中的异常信息进行处理,例如,在统一异常处理类中添加以下方法:
@ExceptionHandler(ShiroException.class) @ResponseBody public JsonResult doHandleShiroException( ShiroException e) { JsonResult r=new JsonResult(); r.setState(0); if(e instanceof UnknownAccountException) { r.setMessage("帐户不存在"); }else if(e instanceof LockedAccountException) { r.setMessage("帐户已被禁用"); }else if(e instanceof IncorrectCredentialsException) { r.setMessage("密码不正确"); }else if(e instanceof AuthorizationException) { r.setMessage("没有此操做权限"); }else { r.setMessage("系统维护中"); } e.printStackTrace(); return r; }
在/templates/pages/目录下添加登录页面(login.html)。
点击登陆操做时,将输入的用户名,密码异步提交到服务端。
$(function () { $(".login-box-body").on("click",".btn",doLogin); }); function doLogin(){ var params={ username:$("#usernameId").val(), password:$("#passwordId").val() } var url="user/doLogin"; $.post(url,params,function(result){ if(result.state==1){ //跳转到indexUI对应的页面 location.href="doIndexUI?t="+Math.random(); }else{ $(".login-box-msg").html(result.message); } }); }
在SpringShiroConfig配置类中,修改过滤规则,添加黄色标记部分代码的配置,请看以下代码:
@Bean public ShiroFilterFactoryBean shiroFilterFactory( SecurityManager securityManager) { ShiroFilterFactoryBean sfBean= new ShiroFilterFactoryBean(); sfBean.setSecurityManager(securityManager); //假如没有认证请求先访问此认证的url sfBean.setLoginUrl("/doLoginUI"); //定义map指定请求过滤规则(哪些资源容许匿名访问,哪些必须认证访问) LinkedHashMap<String,String> map=new LinkedHashMap<>(); //静态资源容许匿名访问:"anon" map.put("/bower_components/**","anon"); map.put("/build/**","anon"); map.put("/dist/**","anon"); map.put("/plugins/**","anon"); map.put("/user/doLogin","anon"); map.put("/doLogout","logout"); //除了匿名访问的资源,其它都要认证("authc")后访问 map.put("/**","authc"); sfBean.setFilterChainDefinitionMap(map); return sfBean; }
受权即对用户资源访问的受权(是否容许用户访问此资源),用户访问系统资源时的受权流程如图所示:
其中受权流程分析以下:
思考:思考不使用shiro如何完成受权操做?intercetor,aop。
在SpringShiroConfig配置类中,添加受权时的相关配置:
第一步:配置bean对象的生命周期管理(SpringBoot能够不配置)。
@Bean public LifecycleBeanPostProcessor lifecycleBeanPostProcessor() { return new LifecycleBeanPostProcessor(); }
第二步: 经过以下配置要为目标业务对象建立代理对象(SpringBoot中可省略)。
@DependsOn("lifecycleBeanPostProcessor") @Bean public DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator() { return new DefaultAdvisorAutoProxyCreator(); }
第三步:配置advisor对象,shiro框架底层会经过此对象的matchs方法返回值(相似切入点)决定是否建立代理对象,进行权限控制。
@Bean public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor ( SecurityManager securityManager) { AuthorizationAttributeSourceAdvisor advisor= new AuthorizationAttributeSourceAdvisor(); advisor.setSecurityManager(securityManager); return advisor; } 说明:使用框架最重要的尊重规则,框架规则指定了什么方式就使用什么方式。
说明:使用框架最重要的尊重规则,框架规则指定了什么方式就使用什么方式。
受权时,服务端核心业务以及API分析,如图所示:
基于登录用户ID,认证信息获取登录用户的权限信息,并进行封装。
第一步:在SysUserRoleDao中定义基于用户id查找角色id的方法(假如方法已经存在则无需再写),关键代码以下:
List<Integer> findRoleIdsByUserId(Integer id);
第二步:在SysRoleMenuDao中定义基于角色id查找菜单id的方法,关键代码以下:
List<Integer> findMenuIdsByRoleIds( @Param("roleIds")List<Integer> roleIds);
第三步:在SysMenuDao中基于菜单id查找权限标识的方法,关键代码以下:
List<String> findPermissions( @Param("menuIds") List<Integer> menuIds);
基于Dao中方法,定义映射元素。
第一步:在SysUserRoleMapper中定义findRoleIdsByUserId元素。关键代码以下:
<select id="findRoleIdsByUserId" resultType="int"> select role_id from sys_user_roles where user_id=#{userId} </select>
第二步:在SysRoleMenuMapper中定义findMenuIdsByRoleIds元素。关键代码以下:
<select id="findMenuIdsByRoleIds" resultType="int"> select menu_id from sys_role_menus where role_id in <foreach collection="roleIds" open="(" close=")" separator="," item="item"> #{item} </foreach> </select>
第三步:在SysMenuMapper中定义findPermissions元素,关键代码以下:
<select id="findPermissions" resultType="string"> select permission <!-- sys:user:update --> from sys_menus where id in <foreach collection="menuIds" open="(" close=")" separator="," item="item"> #{item} </foreach> </select>
在ShiroUserReam类中,重写对象realm的doGetAuthorizationInfo方法,并完成用户权限信息的获取以及封装,最后将信息传递给受权管理器完成受权操做。
修改ShiroUserRealm类中的doGetAuthorizationInfo方法,关键代码以下:
@Service public class ShiroUserRealm extends AuthorizingRealm { @Autowired private SysUserDao sysUserDao; @Autowired private SysUserRoleDao sysUserRoleDao; @Autowired private SysRoleMenuDao sysRoleMenuDao; @Autowired private SysMenuDao sysMenuDao; /**经过此方法完成受权信息的获取及封装*/ @Override protected AuthorizationInfo doGetAuthorizationInfo( PrincipalCollection principals) { //1.获取登陆用户信息,例如用户id SysUser user=(SysUser)principals.getPrimaryPrincipal(); Integer userId=user.getId(); //2.基于用户id获取用户拥有的角色(sys_user_roles) List<Integer> roleIds= sysUserRoleDao.findRoleIdsByUserId(userId); if(roleIds==null||roleIds.size()==0) throw new AuthorizationException(); //3.基于角色id获取菜单id(sys_role_menus) List<Integer> menuIds= sysRoleMenuDao.findMenuIdsByRoleIds(roleIds); if(menuIds==null||menuIds.size()==0) throw new AuthorizationException(); //4.基于菜单id获取权限标识(sys_menus) List<String> permissions= sysMenuDao.findPermissions(menuIds); //5.对权限标识信息进行封装并返回 Set<String> set=new HashSet<>(); for(String per:permissions){ if(!StringUtils.isEmpty(per)){ set.add(per); } } SimpleAuthorizationInfo info= new SimpleAuthorizationInfo(); info.setStringPermissions(set); return info;//返回给受权管理器 } 。。。。 }
在须要进行受权访问的业务层(Service)方法上,添加执行此方法须要的权限标识,参考代码
@RequiresPermissions(“sys:user:update”)
说明:此要注解必定要添加到业务层方法上。
当咱们进行受权操做时,每次都会从数据库查询用户权限信息,为了提升受权性能,能够将用户权限信息查询出来之后进行缓存,下次受权时从缓存取数据便可。
Shiro中内置缓存应用实现,其步骤以下:
第一步:在SpringShiroConfig中配置缓存Bean对象(Shiro框架提供)。
@Bean public CacheManager shiroCacheManager(){ return new MemoryConstrainedCacheManager(); }
说明:这个CacheManager对象的名字不能写cacheManager,由于spring容器中已经存在一个名字为cacheManager的对象了.
第二步:修改securityManager的配置,将缓存对象注入给SecurityManager对象。
@Bean public SecurityManager securityManager( Realm realm, CacheManager cacheManager) { DefaultWebSecurityManager sManager= new DefaultWebSecurityManager(); sManager.setRealm(realm); sManager.setCacheManager(cacheManager); return sManager; }
说明:对于shiro框架而言,还能够借助第三方的缓存产品(例如redis)对用户的权限信息进行cache操做.
记住我功能是要在用户登陆成功之后,假如关闭浏览器,下次再访问系统资源(例如首页doIndexUI)时,无需再执行登陆操做。
在页面上选中记住我,而后执行提交操做,将用户名,密码,记住我对应的值提交到控制层,如图所示:
其客户端login.html中关键JS实现:
function doLogin(){ var params={ username:$("#usernameId").val(), password:$("#passwordId").val(), isRememberMe:$("#rememberId").prop("checked"), } var url="user/doLogin"; console.log("params",params); $.post(url,params,function(result){ if(result.state==1){ //跳转到indexUI对应的页面 location.href="doIndexUI?t="+Math.random(); }else{ $(".login-box-msg").html(result.message); } return false;//防止刷新时重复提交 }); }
服务端业务实现的具体步骤以下:
第一步:在SysUserController中的doLogin方法中基因而否选中记住我,设置token的setRememberMe方法。
@RequestMapping("doLogin") @ResponseBody public JsonResult doLogin( boolean isRememberMe, String username, String password) { //1.封装用户信息 UsernamePasswordToken token= new UsernamePasswordToken(username, password); if(isRememberMe) { token.setRememberMe(true); } //2.提交用户信息 Subject subject=SecurityUtils.getSubject(); subject.login(token);//token会提交给securityManager return new JsonResult("login ok"); }
第二步:在SpringShiroConfig配置类中添加记住我配置,关键代码以下:
@Bean public RememberMeManager rememberMeManager() { CookieRememberMeManager cManager= new CookieRememberMeManager(); SimpleCookie cookie=new SimpleCookie("rememberMe"); cookie.setMaxAge(7*24*60*60); cManager.setCookie(cookie); return cManager; }
第三步:在SpringShiroConfig中修改securityManager的配置,为securityManager注入rememberManager对象。参考黄色部分代码。
@Bean public SecurityManager securityManager( Realm realm,CacheManager cacheManager RememberMeManager rememberManager) { DefaultWebSecurityManager sManager= new DefaultWebSecurityManager(); sManager.setRealm(realm); sManager.setCacheManager(cacheManager); sManager.setRememberMeManager(rememberManager); return sManager; }
第四步:修改shiro的过滤认证级别,将/=author修改成/=user,查看黄色背景部分。
@Bean public ShiroFilterFactoryBean shiroFilterFactory( SecurityManager securityManager) { ShiroFilterFactoryBean sfBean= new ShiroFilterFactoryBean(); sfBean.setSecurityManager(securityManager); //假如没有认证请求先访问此认证的url sfBean.setLoginUrl("/doLoginUI"); //定义map指定请求过滤规则(哪些资源容许匿名访问,哪些必须认证访问) LinkedHashMap<String,String> map= new LinkedHashMap<>(); //静态资源容许匿名访问:"anon" map.put("/bower_components/**","anon"); map.put("/build/**","anon"); map.put("/dist/**","anon"); map.put("/plugins/**","anon"); map.put("/user/doLogin","anon"); map.put("/doLogout", "logout");//自动查LoginUrl //除了匿名访问的资源,其它都要认证("authc")后访问 map.put("/**","user");//authc sfBean.setFilterChainDefinitionMap(map); return sfBean; }
说明:查看浏览器cookie设置,可在浏览器中输入以下语句。
chrome://settings/content/cookies
使用shiro框架实现认证操做,用户登陆成功会将用户信息写入到会话对象中,其默认时长为30分钟,假如须要对此进行配置,可参考以下配置:
第一步:在SpringShiroConfig类中,添加会话管理器配置。关键代码以下:
@Bean public SessionManager sessionManager() { DefaultWebSessionManager sManager= new DefaultWebSessionManager(); sManager.setGlobalSessionTimeout(60*60*1000); return sManager; }
第二步:在SpringShiroConfig配置类中,对安全管理器 securityManager 增长 sessionManager值的注入,关键代码以下:
@Bean public SecurityManager securityManager( Realm realm,CacheManager cacheManager, RememberMeManager rememberManager, SessionManager sessionManager) { DefaultWebSecurityManager sManager= new DefaultWebSecurityManager(); sManager.setRealm(realm); sManager.setCacheManager(cacheManager); sManager.setRememberMeManager(rememberMeManager); sManager.setSessionManager(sessionManager); return sManager; }
课堂练习:
1.获取用户登录信息,并将登录用户名呈如今系统主页(starter.html)上.
第一步:定义一个工具类(ShiroUtils),获取用户登录信息.
package com.cy.pj.common.util; import org.apache.shiro.SecurityUtils; import com.cy.pj.sys.entity.SysUser; public class ShiroUtils { public static String getUsername() { return getUser().getUsername(); } public static SysUser getUser() { return (SysUser) SecurityUtils.getSubject().getPrincipal(); } }
第二步:修改PageController中的doIndexUI方法,代码以下:
@RequestMapping("doIndexUI") public String doIndexUI(Model model) { SysUser user=ShiroUtils.getUser(); model.addAttribute("user",user); return "starter"; }
第三步:借助thymeleaf中的表达式直接在页面上(starter.html)获取登录用户信息
<span class="hidden-xs" id="loginUserId">[[${user.username}]]</span>
2.修改登录用户的密码?(参考用户模块文档)
分析:
1)肯定都要修改谁?(密码,盐值,修改时间)
2)服务端的设计实现?(dao,service,controller)
3)客户端的设计实现?(异步提交用户密码信息)