1. Shiro安全框架简介

1.1 Shiro概述

Shiro是apache旗下一个开源安全框架(http://shiro.apache.org/),它将软件系
统的安全认证相关的功能抽取出来,实现用户身份认证权限授权加密会话管理等功能,组成了一个通用的安全认证框架。使用shiro就可以非常快速的完成认证、授权等功能的开发,降低系统成本。
用户在进行资源访问时,要求系统要对用户进行权限控制,其具体流程
在这里插入图片描述

1.2 Shiro概要架构

在概念层面,Shiro 架构包含三个主要的理念
在这里插入图片描述

  1. Subject :主体对象,负责提交用户认证和授权信息。
  2. SecurityManager:安全管理器,负责认证,授权等业务实现。
  3. Realm:领域对象,负责从数据层获取业务数据。

1.3 Shiro详细架构

Shiro框架进行权限管理时,要涉及到的一些核心对象,主要包括:认证管理对象,授权管理对象,会话管理对象,缓存管理对象,加密管理对象以及Realm管理对象(领域对象:负责处理认证和授权领域的数据访问题)等
在这里插入图片描述

  1. Subject(主体):与软件交互的一个特定的实体(用户、第三方服务等)。
  2. SecurityManager(安全管理器) :Shiro 的核心,用来协调管理组件工作。
  3. Authenticator(认证管理器):负责执行认证操作。
  4. Authorizer(授权管理器):负责授权检测。
  5. SessionManager(会话管理):负责创建并管理用户 Session 生命周期,提供一
    个强有力的 Session 体验。
  6. SessionDAO:代表 SessionManager 执行 Session 持久(CRUD)动作,它允
    许任何存储的数据挂接到 session 管理基础上。
  7. CacheManager(缓存管理器):提供创建缓存实例和管理缓存生命周期的功能。
  8. Cryptography(加密管理器):提供了加密方式的设计及管理。
  9. Realms(领域对象):是shiro和你的应用程序安全数据之间的桥梁。

2. Shiro框架认证拦截实现(filter)

2.1 Shiro基本环境配置

2.1.1 添加shiro依赖

<dependency>
	<groupId>org.apache.shiro</groupId>
	<artifactId>shiro-spring</artifactId>
	<version>1.5.3</version>
</dependency>

2.1.2 Shiro核心对象配置

基于SpringBoot 实现的项目中,没有提供shiro的自动化配置,需要我们自己配置。

  1. 创建SpringShiroConfig类。
@Configuration
public class SpringShiroConfig {
}
  1. 在Shiro配置类中添加SecurityManager配置(这里一定要使用org.apache.shiro.mgt.SecurityManager这个接口对象),
@Bean
public SecurityManager securityManager() {
	DefaultWebSecurityManager sManager = new DefaultWebSecurityManager();
	return sManager ;
}
  1. 在Shiro配置类中添加ShiroFilterFactoryBean对象的配置。通过此对象设置资源匿名访问、认证访问。
@Bean
public ShiroFilterFactoryBean shiroFilterFactory (SecurityManager securityManager ) {
	ShiroFilterFactoryBean sfBean = new ShiroFilterFactoryBean();
	sfBean .setSecurityManager( securityManager );
	//定义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");
	//除了匿名访问的资源,其它都要认证("authc")后访问
	map .put("/**","authc");
	sfBean .setFilterChainDefinitionMap( map );
	return sfBean ;
}

在这里插入图片描述

2.2 Shiro登陆页面呈现

2.2.1 服务端Controller实现

  • 业务描述及设计实现
    当服务端拦截到用户请求以后,判定此请求是否已经被认证,假如没有认证应该先跳转到登录页面。

  • 关键代码分析及实现.

  1. 在PageController中添加一个呈现登录页面的方法,关键代码如下:
@RequestMapping("doLoginUI")
public String doLoginUI(){
		return "login";
}

  1. 修改SpringShiroConfig类中shiroFilterFactorybean的配置,添加登陆url的设置。关键代码见sfBean.setLoginUrl("/doLoginUI")部分。
@Bean
public ShiroFilterFactoryBean shiroFilterFactory (
			 @Autowired 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;
}

2.2.2 客户端页面实现

在/templates/pages/添加一个login.html页面,然后将项目部署到web服务器,并启动测试运行.

3. Shiro框架认证业务实现

3.1 认证流程分析

认证流程分析如下:

  1. 系统调用subject的login方法将用户信息提交给SecurityManager
  2. SecurityManager将认证操作委托给认证器对象Authenticator
  3. Authenticator将用户输入的身份信息传递给Realm。
  4. Realm访问数据库获取用户信息然后对信息进行封装并返回。
  5. Authenticator 对realm返回的信息进行身份认证。

3.2 认证服务端实现

3.2.1 核心业务分析

认证业务API处理流程分析,如图所示:
在这里插入图片描述

3.2.2 DAO接口定义

SysUser findUserByUserName(String username)

3.2.3 Service接口及实现

  • 业务描述及设计实现。
    本模块的业务在Realm类型的对象中进行实现,我们编写realm时,要继承
    AuthorizingRealm并重写相关方法,完成认证及授权业务数据的获取及封装。

  • 关键代码分析及实现。

  1. 定义ShiroUserRealm类,关键代码如下:
@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;//返回值会传递给认证管理器(后续
		//认证管理器会通过此信息完成认证操作)
	}
    ....
}
  1. 对此realm,需要在SpringShiroConfig配置类中,注入给SecurityManager对象,修改securityManager方法,例如:
@Bean
public SecurityManager securityManager(Realm realm) {
		 DefaultWebSecurityManager sManager=new DefaultWebSecurityManager();
		 sManager.setRealm(realm);
		 return sManager;
}

3.2.4 Controller 类实现

  • 业务描述及设计实现。
    在此对象中定义相关方法,处理客户端的登陆请求,例如获取用户名,密码等然后提交该shiro框架进行认证。

  • 关键代码分析及实现。

  1. 在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");
   }

  1. 修改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;
	 }

  1. 当我们在执行登录操作时,为了提高用户体验,可对系统中的异常信息进行处理,例如,在统一异常处理类中添加如下方法:
	@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;
	}

4. Shiro框架授权过程实现

4.1 授权流程分析

  1. 系统调用subject相关方法将用户信息(例如isPermitted)递交给SecurityManager;
  2. SecurityManager将权限检测操作委托给Authorizer对象;
  3. Authorizer将用户信息委托给realm;
  4. Realm访问数据库获取用户权限信息并封装;
  5. Authorizer对用户授权信息进行判定;

4.2 添加授权配置

在SpringShiroConfig配置类中,添加授权时的相关配置:

  1. 配置bean对象的生命周期管理(SpringBoot可以不配置)。
@Bean
public LifecycleBeanPostProcessor   lifecycleBeanPostProcessor() {
		 return new LifecycleBeanPostProcessor();
}

  1. 通过如下配置要为目标业务对象创建代理对象(SpringBoot中可省略)。
@DependsOn("lifecycleBeanPostProcessor")
@Bean
public DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator() {
		 return new DefaultAdvisorAutoProxyCreator();
}

  1. 配置advisor对象,shiro框架底层会通过此对象的matchs方法返回值(类似切入点)决定是否创建代理对象,进行权限控制。
@Bean
public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor (SecurityManager securityManager) {
	AuthorizationAttributeSourceAdvisor advisor=new AuthorizationAttributeSourceAdvisor();
	advisor.setSecurityManager(securityManager);
	return advisor;
}
//说明:使用框架最重要的尊重规则,框架规则指定了什么方式就使用什么方式。

4.3 授权服务端实现

4.3.1 核心业务分析

授权时,服务端核心业务以及API分析,如图所示:
在这里插入图片描述

4.3.2 Dao实现

  • 业务描述及设计实现。
    基于登陆用户ID,认证信息获取登陆用户的权限信息,并进行封装。

  • 关键代码分析及实现。

  1. 在SysUserRoleDao中定义基于用户id查找角色id的方法,关键代码如下:
List<Integer> findRoleIdsByUserId(Integer id);

  1. 在SysRoleMenuDao中定义基于角色id查找菜单id的方法,关键代码如下:
List<Integer> findMenuIdsByRoleIds(@Param("roleIds")Integer[] roleIds);

  1. 在SysMenuDao中基于菜单id查找权限标识的方法,关键代码如下:
List<String> findPermissions(@Param("menuIds") Integer[] menuIds);

4.3.2 Mapper实现

 <select id="findRoleIdsByUserId"
            resultType="int">
           select role_id
           from sys_user_roles
           where user_id=#{userId}        
</select>
    <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>
<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>

4.3.3 Service实现

  • 业务描述及设计实现。
    在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)
		Integer[] array={};
		List<Integer> menuIds=sysRoleMenuDao.findMenuIdsByRoleIds(roleIds.toArray(array));
	    if(menuIds==null||menuIds.size()==0)
	    	throw new AuthorizationException();
		//4.基于菜单id获取权限标识(sys_menus)
	    List<String> permissions=sysMenuDao.findPermissions(menuIds.toArray(array));
		//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;//返回给授权管理器
	}
	......
}

4.4 授权访问实描述现

在需要进行授权访问的业务层(Service)方法上,添加执行此方法需要的权限标识,参考代码@RequiresPermissions(“sys:user:update”)

说明: 此要注解一定要添加到业务层方法上。

5. Shiro扩展功能应用

5.1 Shiro缓存配置

当我们进行授权操作时,每次都会从数据库查询用户权限信息,为了提高授权性能,可以将用户权限信息查询出来以后进行缓存,下次授权时从缓存取数据即可。

Shiro中内置缓存应用实现,其步骤如下:

  1. 在SpringShiroConfig中配置缓存Bean对象(Shiro框架提供)。
@Bean
public CacheManager shiroCacheManager(){
	 return new MemoryConstrainedCacheManager();
}

说明: 这个CacheManager对象的名字不能写cacheManager,因为spring容器中已经存在一个名字为cacheManager的对象了.

  1. 修改securityManager的配置,将缓存对象注入给SecurityManager对象。
@Bean
public SecurityManager securityManager(Realm realm,CacheManager cacheManager) {
		 DefaultWebSecurityManager sManager=new DefaultWebSecurityManager();
		 sManager.setRealm(realm);
		 sManager.setCacheManager(cacheManager);
		 return sManager;
}

5.2 Shiro记住我

记住我功能是要在用户登录成功以后,假如关闭浏览器,下次再访问系统资源(例如首页doIndexUI)时,无需再执行登录操作。

5.2.1 客户端业务实现

在页面上选中记住我,然后执行提交操作,将用户名,密码,记住我对应的值提交到控制层,如图所示:
在这里插入图片描述

5.2.2 服务端业务实现

  1. 在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");
	 }

  1. 在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;
	 }

  1. 在SpringShiroConfig中修改securityManager的配置,为securityManager注rememberManager对象。参考虚线中间部分代码。
@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;
	 }

  1. 修改shiro的过滤认证级别,将/**=author修改为/**=users,查看虚线中间部分。
@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;
	 }

5.3 Shiro会话时长配置

使用shiro框架实现认证操作,用户登录成功会将用户信息写入到会话对象中,其默认时长为30分钟,假如需要对此进行配置,可参考如下配置:

  1. 在SpringShiroConfig类中,添加会话管理器配置。关键代码如下:
@Bean   
public SessionManager sessionManager() {
		 DefaultWebSessionManager sManager=new DefaultWebSessionManager();
		 sManager.setGlobalSessionTimeout(60*60*1000);
		 return sManager;
}

  1. 在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;
}

6. 常见的Shiro异常

6.1 AuthenticationException 认证异常

Shiro在登录认证过程中,认证失败需要抛出的异常。 AuthenticationException包含以下子类:

6.1.1 CredentitalsException 凭证异常

  • IncorrectCredentialsException 不正确的凭证
  • ExpiredCredentialsException 凭证过期

6.1.2 AccountException 账号异常

  • ConcurrentAccessException: 并发访问异常(多个用户同时登录时抛出)
  • UnknownAccountException: 未知的账号
  • ExcessiveAttemptsException: 认证次数超过限制
  • DisabledAccountException: 禁用的账号
  • LockedAccountException: 账号被锁定
  • UnsupportedTokenException: 使用了不支持的Token

6.2 AuthorizationException: 授权异常

Shiro在登录认证过程中,授权失败需要抛出的异常。 AuthorizationException包含以下子类:

  1. UnauthorizedException:抛出以指示请求的操作或对请求的资源的访问是不允许的。
  2. UnanthenticatedException:当尚未完成成功认证时,尝试执行授权操作时引发异常。
Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐