1、架构
hiro是一个强大的简单易用的Java安全框架,主要用来更便捷的认证,授权,加密,会话管理。Shiro首要的和最重要的目标就是容易使用并且容易理解。
Shiro是一个有许多特性的全面的安全框架,下面这幅图可以了解Shiro的特性:
可以看出shiro除了基本的认证,授权,会话管理,加密之外,还有许多额外的特性。
从大的角度来看,Shiro有三个主要的概念:Subject
,SecurityManager
,Realms
,下面这幅图可以看到这些原件之间的交互。
Subject:主体,代表了当前“用户”,这个用户不一定是一个具体的人,与当前应用交互的任何东西都是Subject,如网络爬虫,机器人等;即一个抽象概念;所有Subject都绑定到SecurityManager,与Subject的所有交互都会委托给SecurityManager;可以把Subject认为是一个门面;SecurityManager才是实际的执行者;
SecurityManager:安全管理器;即所有与安全有关的操作都会与SecurityManager交互;且它管理着所有Subject;可以看出它是Shiro的核心,它负责与后边介绍的其他组件进行交互,如果学习过SpringMVC,你可以把它看成DispatcherServlet前端控制器;
Realm:域,Shiro从从Realm获取安全数据(如用户、角色、权限),就是说SecurityManager要验证用户身份,那么它需要从Realm获取相应的用户进行比较以确定用户身份是否合法;也需要从Realm得到用户相应的角色/权限进行验证用户是否能进行操作;可以把Realm看成DataSource,即安全数据源。
2、名词解释:
Authentication:身份认证/登录,验证用户是不是拥有相应的身份;
Authorization:授权,即权限验证,验证某个已认证的用户是否拥有某个权限;即判断用户是否能做事情,常见的如:验证某个用户是否拥有某个角色。或者细粒度的验证某个用户对某个资源是否具有某个权限;
Session Manager:会话管理,即用户登录后就是一次会话,在没有退出之前,它的所有信息都在会话中;会话可以是普通JavaSE环境的,也可以是如Web环境的;
Cryptography:加密,保护数据的安全性,如密码加密存储到数据库,而不是明文存储;
Web Support:Web支持,可以非常容易的集成到Web环境;
Caching:缓存,比如用户登录后,其用户信息、拥有的角色/权限不必每次去查,这样可以提高效率;
Concurrency:shiro支持多线程应用的并发验证,即如在一个线程中开启另一个线程,能把权限自动传播过去;
Testing:提供测试支持;
Run As:允许一个用户假装为另一个用户(如果他们允许)的身份进行访问;
Remember Me:记住我,这个是非常常见的功能,即一次登录后,下次再来的话不用登录了。
记住一点,Shiro不会去维护用户、维护权限;这些需要我们自己去设计/提供;然后通过相应的接口注入给Shiro即可。
3、主要代码
public class ShiroDbRealm extends AuthorizingRealm {
private static final Logger LOGGER = LogManager.getLogger(ShiroDbRealm.class);
@Autowired
private UserService userService;
@Autowired
private IRoleService roleService;
public ShiroDbRealm(CacheManager cacheManager, CredentialsMatcher matcher) {
super(cacheManager, matcher);
}
/**
* Shiro登录认证
* 用户登陆时执行
*/
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authcToken) throws AuthenticationException {
LOGGER.info("Shiro开始登录认证");
UsernamePasswordToken token = (UsernamePasswordToken) authcToken;
UserVO user = userService.queryByLoginName(token.getUsername());
// 账号不存在
if (user == null) {
return null;
}
// 账号未启用
if (user.getStatus() == 1) {
return null;
}
// 读取用户的url和角色
Map<String, Set<String>> resourceMap = roleService.selectResourceMapByUserId(user.getId());
Set<String> urls = resourceMap.get("urls");
Set<String> roles = resourceMap.get("roles");
ShiroUser shiroUser = new ShiroUser(user.getId(), user.getLoginName(), user.getName(), urls);
shiroUser.setRoles(roles);
// 认证缓存信息
return new SimpleAuthenticationInfo(shiroUser, user.getPassword().toCharArray(), getName());
}
/**
* Shiro权限认证
*/
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
ShiroUser shiroUser = (ShiroUser) principals.getPrimaryPrincipal();
SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
info.setRoles(shiroUser.getRoles());
info.addStringPermissions(shiroUser.getUrlSet());
return info;
}
@Override
public void onLogout(PrincipalCollection principals) {
super.clearCachedAuthorizationInfo(principals);
ShiroUser shiroUser = (ShiroUser) principals.getPrimaryPrincipal();
removeUserCache(shiroUser);
}
/**
* 清除用户缓存
* @param shiroUser
*/
public void removeUserCache(ShiroUser shiroUser){
removeUserCache(shiroUser.getLoginName());
}
/**
* 清除用户缓存
* @param loginName
*/
public void removeUserCache(String loginName){
SimplePrincipalCollection principals = new SimplePrincipalCollection();
principals.add(loginName, super.getName());
super.clearCachedAuthenticationInfo(principals);
}
}
登陆的代码为:
@PostMapping("/login")
@ResponseBody
public Object loginPost(String loginName, String password) throws IOException {
if (StringUtils.isBlank(loginName)) {
throw new RuntimeException("用户名不能为空");
}
if (StringUtils.isBlank(password)) {
throw new RuntimeException("密码不能为空");
}
Subject user = SecurityUtils.getSubject();
UsernamePasswordToken token = new UsernamePasswordToken(loginName, password);
try {
logger.info("开始登录");
user.login(token);
return renderSuccess("登陆成功");
} catch (UnknownAccountException e) {
throw new RuntimeException("账号不存在!", e);
} catch (DisabledAccountException e) {
throw new RuntimeException("账号未启用!", e);
} catch (IncorrectCredentialsException e) {
throw new RuntimeException("密码错误!", e);
} catch (Throwable e) {
throw new RuntimeException(e.getMessage(), e);
}
}
4、执行流程
用户提交用户名和密码 --> shiro 封装令牌 --> realm 通过用户名将密码查询返回 --> shiro 自动去比较查询出密码和用户输入密码是否一致--> 进行登陆控制。
login方法中调用user.login(token)后就会触发protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authcToken)方法的执行。
代码中使用SecurityUtils.getSubject().isPermitted("/public/getdatalist")时,会触发protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals)
方法进行权限认证。
5、缓存
shiro.xml代码:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd"
default-lazy-init="true">
<description>Shiro安全配置</description>
<!--安全管理器-->
<bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">
<!--设置自定义Realm-->
<property name="realm" ref="shiroDbRealm"/>
<!--将缓存管理器,交给安全管理器-->
<property name="cacheManager" ref="shiroSpringCacheManager"/>
<!-- 记住密码管理 -->
<property name="rememberMeManager" ref="rememberMeManager"/>
<property name="sessionManager" ref="sessionManager"/>
</bean>
<!-- 項目自定义的Realm -->
<bean id="shiroDbRealm" class="com.mingwork.commons.shiro.ShiroDbRealm">
<constructor-arg index="0" name="cacheManager" ref="shiroSpringCacheManager"/>
<constructor-arg index="1" name="matcher" ref="credentialsMatcher"/>
<!-- 启用身份验证缓存,即缓存AuthenticationInfo信息,默认false -->
<property name="authenticationCachingEnabled" value="true"/>
<!-- 缓存AuthenticationInfo信息的缓存名称 -->
<property name="authenticationCacheName" value="authenticationCache"/>
<!-- 缓存AuthorizationInfo信息的缓存名称 -->
<property name="authorizationCacheName" value="authorizationCache"/>
</bean>
<!-- 记住密码Cookie -->
<bean id="rememberMeCookie" class="org.apache.shiro.web.servlet.SimpleCookie">
<constructor-arg value="rememberMe"/>
<property name="httpOnly" value="true"/>
<!-- 7天,采用spring el计算方便修改[细节决定成败]! -->
<property name="maxAge" value="#{7 * 24 * 60 * 60}"/>
</bean>
<!-- rememberMe管理器,cipherKey生成见{@code Base64Test.java} -->
<bean id="rememberMeManager" class="org.apache.shiro.web.mgt.CookieRememberMeManager">
<property name="cipherKey" value="#{T(org.apache.shiro.codec.Base64).decode('5aaC5qKm5oqA5pyvAAAAAA==')}"/>
<property name="cookie" ref="rememberMeCookie"/>
</bean>
<!-- Shiro Filter -->
<bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">
<!-- 安全管理器 -->
<property name="securityManager" ref="securityManager"/>
<!-- 默认的登陆访问url -->
<property name="loginUrl" value="/public/login"/>
<!-- 登陆成功后跳转的url -->
<property name="successUrl" value="/index"/>
<!-- 没有权限跳转的url -->
<property name="unauthorizedUrl" value="/unauth"/>
<property name="filterChainDefinitions">
<value>
<!--
anon 不需要认证
authc 需要认证
user 验证通过或RememberMe登录的都可以
-->
/captcha.jpg = anon
/commons/** = anon
/static/** = anon
/webhooks = anon
/login = anon
/device/** = anon <!-- 设备控制器不校验 -->
/public/login = anon
/** = user
</value>
</property>
</bean>
<!-- 用户授权信息Cache, 采用spring-cache, 具体请查看spring-ehcache.xml、spring-redis.xml -->
<bean id="shiroSpringCacheManager" class="com.mingwork.commons.shiro.cache.ShiroSpringCacheManager">
<property name="cacheManager" ref="cacheManager"/>
</bean>
<!-- 会话管理器 -->
<bean id="sessionManager" class="org.apache.shiro.web.session.mgt.DefaultWebSessionManager">
<!-- 设置全局会话超时时间 半小时 -->
<!--<property name="globalSessionTimeout" value="#{30 * 60 * 1000}"/>-->
<property name="globalSessionTimeout" value="#{1 * 60 * 1000}"/>
<!-- url上带sessionId 默认为true -->
<property name="sessionIdUrlRewritingEnabled" value="false"/>
<property name="sessionDAO" ref="sessionDAO"/>
</bean>
<!-- 会话DAO 用于会话的CRUD -->
<bean id="sessionDAO" class="org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO">
<!-- Session缓存名字,默认就是shiro-activeSessionCache -->
<property name="activeSessionsCacheName" value="activeSessionCache"/>
<property name="cacheManager" ref="shiroSpringCacheManager"/>
</bean>
<!-- 在方法中 注入 securityManager ,进行代理控制 -->
<bean class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
<property name="staticMethod" value="org.apache.shiro.SecurityUtils.setSecurityManager"/>
<property name="arguments" ref="securityManager"/>
</bean>
<!-- 密码错误5次锁定半小时 -->
<bean id="credentialsMatcher" class="com.mingwork.commons.shiro.RetryLimitCredentialsMatcher">
<constructor-arg ref="shiroSpringCacheManager"/>
<property name="retryLimitCacheName" value="halfHour"/>
<!-- 密码加密 1次md5,增强密码可修改此处 -->
<property name="hashAlgorithmName" value="md5"/>
<property name="hashIterations" value="1"/>
</bean>
</beans>
每一次给用户授权时,都是通过realm从数据库中查询权限,为了避免频繁的查询数据库,shiro给我们提供了缓存的能力
用户认证通过后:
第一次授权:通过realm从数据库中查询
第二次授权:直接从缓存中查询
sessionManager中的globalSessionTimeout会话超时时间假如设置为1分钟,则第一次调用登陆接口时,会执行doGetAuthenticationInfo方法,然后超过一分钟后,则会话失效。authenticationCache如果设置为2分钟,则第一次调用登陆接口时,会执行doGetAuthenticationInfo方法,2分钟内再次调用登陆方法,因为缓存还在,所以不会触发doGetAuthenticationInfo方法。
一般情况下,用户正常退出和非正常退出(如关闭浏览器)都会自动清空缓存,但是有时候我们需要手动清空缓存。
例如:修改了一个用户的权限,需要手动清空缓存,否则这个用户只要不退出,权限就一直不改变。