引言

上一节《DelegatingProxyFilter的作用》中详细讲解了DelegatingProxyFilter,并且引出了shiro。

Shiro是Java的一个安全框架。因为其较之于spring-security配置灵活,使用方便,越来越受到程序猿的青睐。目前,Shiro应用在各大公司的OA系统、CRM系统等具有资源权限管理的系统中。

Shiro的相关概念,请参考开涛的跟我学Shiro的第一章《Shiro简介》,如果要做相关开发,请仔细学习。

认识Shiro

【下面的内容属于开涛,我只是自学的过程中抄写一遍,加深自己的影响和理解】

Shiro框架

Shiro提供:认证、授权、加密、会话管理、与web集成、缓存等功能。因此是RBAC开发中的一件利器。

![shiro-framework][3]
shiro框架中的名词 描述
Authentication 身份认证/登录,验证用户是否持有该身份。比如用户名密码是否正确,验证码是否正确。
Authorization 授权,即权限验证,验证某个已认证的用户是否拥有某个权限;即判断用户是否能做事情,常见的如:验证某个用户是否拥有某个角色。或者细粒度的验证某个用户对某个资源是否具有某个权限。比如哪一类销售管理能看哪些客户的信息,具体能看多大粒度的数据,是否需要脱敏处理
Session Manager 会话管理,即用户登录后就是一次会话,在没有退出之前,他的所有信息都保存在会话中。
Cryptography 加密,保护数据的安全性,如密码加密存储到数据库,而不是铭文存储。
Web Support Web支持,可以非常容易的集成到Web环境
Caching 缓存,比如用户登录后,其用户信息、拥有的角色/权限不必每次去查,这样可以提高效率
Concurrency shiro支持多线程应用的并发验证,即如在一个线程中开启另一个线程,能把权限自动传播过去
Testing 提供测试支持
Run As 允许一个用户假装为另一个用户(如果他们允许)的身份进行访问
Remember Me 记住我,这个是非常常见的功能,即一次登录后,下次再来的话不用登录了。

Shiro不会去维护用户、维护权限;这些需要我们自己去设计/提供;然后通过相应的接口注入给Shiro即可。

下面,我们从外部和内部看Shiro架构和API。对于一个好的框架,从外部来看应该具有非常简单易于使用的API,且API契约明确;从内部来看的话,其应该有一个可扩展的架构,即非常容易插入用户自定义实现,因为任何框架都不能满足所有需求。

外部架构和组件

即从应用程序角度的来观察如何使用Shiro完成工作。

![Shiro外部架构][4]

可以看到:应用代码直接交互的对象时Subject,也就是说Shiro对外的核心接口就是Subject

Subject: 主体,代表了当前“用户”,这个用户不一定是一个具体的人,与当前应用交互的任何东西都是Subject,如网络爬虫,机器人等;即一个抽象概念;所有Subject都绑定到SecurityManager,与Subject的所有交互都会委托给SecurityManager;可以把Subject认为是一个门面;SecurityManager才是实际的执行者。
SecurityManager: 安全管理器;即所有与安全有关的操作都会与SecurityManager交互;且它管理着所有Subject;可以看出它是Shiro的核心,它负责与后边介绍的其他组件进行交互,如果学习过SpringMVC,你可以把它看成DispatcherServlet前端控制器;
Realm: 域,Shiro从Realm获取安全数据(如用户、角色、权限),就是说SecurityManager要验证用户身份,那么它需要从Realm获取相应的用户进行比较以确定用户身份是否合法;也需要从Realm得到用户相应的角色/权限进行验证用户是否能进行操作;可以把Realm看成DataSource,即安全数据源。

也就是说对于我们而言,最简单的一个Shiro应用:

1、应用代码通过Subject来进行认证和授权,而Subject又委托给SecurityManager;
2、我们需要给Shiro的SecurityManager注入Realm,从而让SecurityManager能得到合法的用户及其权限进行判断。

从以上也可以看出,Shiro不提供维护用户/权限,而是通过Realm让开发人员自己注入

内部架构及组件

![Shiro内部架构][5]

Subject:主体,可以看到主体可以是任何可以与应用交互的“用户”;
SecurityManager:相当于SpringMVC中的DispatcherServlet或者Struts2中的FilterDispatcher;是Shiro的心脏;所有具体的交互都通过SecurityManager进行控制;它管理着所有Subject、且负责进行认证和授权、及会话、缓存的管理。
Authenticator:认证器,负责主体认证的,这是一个扩展点,如果用户觉得Shiro默认的不好,可以自定义实现;其需要认证策略(Authentication Strategy),即什么情况下算用户认证通过了;
Authrizer:授权器,或者访问控制器,用来决定主体是否有权限进行相应的操作;即控制着用户能访问应用中的哪些功能;
Realm:可以有1个或多个Realm,可以认为是安全实体数据源,即用于获取安全实体的;可以是JDBC实现,也可以是LDAP实现,或者内存实现等等;由用户提供;注意:Shiro不知道你的用户/权限存储在哪及以何种格式存储;所以我们一般在应用中都需要实现自己的Realm;
SessionManager:如果写过Servlet就应该知道Session的概念,Session呢需要有人去管理它的生命周期,这个组件就是SessionManager;而Shiro并不仅仅可以用在Web环境,也可以用在如普通的JavaSE环境、EJB等环境;所有呢,Shiro就抽象了一个自己的Session来管理主体与应用之间交互的数据;这样的话,比如我们在Web环境用,刚开始是一台Web服务器;接着又上了台EJB服务器;这时想把两台服务器的会话数据放到一个地方,这个时候就可以实现自己的分布式会话(如把数据放到Memcached服务器);
SessionDAO:DAO大家都用过,数据访问对象,用于会话的CRUD,比如我们想把Session保存到数据库,那么可以实现自己的SessionDAO,通过如JDBC写到数据库;比如想把Session放到Memcached中,可以实现自己的Memcached SessionDAO;另外SessionDAO中可以使用Cache进行缓存,以提高性能;
CacheManager:缓存控制器,来管理如用户、角色、权限等的缓存的;因为这些数据基本上很少去改变,放到缓存中后可以提高访问的性能
Cryptography:密码模块,Shiro提高了一些常见的加密组件用于如密码加密/解密的。

Shiro依赖

在pom.xml中增加shiro的依赖,renren-security引入的包版本是1.3.2,即<shiro-version>1.3.2</shiro-version>。其中shiro-core是shiro的核心功能,shiro-spring是shiro方便spring的整合实现了部分spring的接口。shiro-spring还依赖与shiro-web包。

1
2
3
4
5
6
7
8
9
10
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-core</artifactId>
<version>${shiro-version}</version>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-spring</artifactId>
<version>${shiro-version}</version>
</dependency>

ShiroFilter的配置

实例化shiroFilter

相应的依赖导入之后,我们开始学习renren-security是如何配置shiro的,或者说是如何使用shiro做权限控制的。带着这个问题,我们开始学习shiro整合spring的第一个配置:ShiroFilter的配置。

前面DelegatingProxyFilter中说过,配置DelegatingProxyFilter时,要么filter-name是一个代理的filter的bean,要么targetBeanName参数中制定代理filter的bean。这里说的bean,在shiro中就是ShiroFilterFactoryBean的实例,该类位于org.apache.shiro.spring.web包下。

我们知道spring3.0的时候增加了一个注解@Bean,用户创建一个bean实例,该实例由springcontext管理。renren-security使用就是该注解。

在包io.renren.modules.sys.shiro下,找到ShiroConfig类,具体代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/**
* Shiro的配置文件
*
* @author chenshun
* @email sunlightcs@gmail.com
* @date 2017/9/27 22:02
*/
@Configuration
public class ShiroConfig {
// ...

@Bean("shiroFilter")
public ShiroFilterFactoryBean shirFilter(SecurityManager securityManager) {
ShiroFilterFactoryBean shiroFilter = new ShiroFilterFactoryBean();
shiroFilter.setSecurityManager(securityManager);
shiroFilter.setLoginUrl("/login.html");
shiroFilter.setUnauthorizedUrl("/");

Map<String, String> filterMap = new LinkedHashMap<>();
filterMap.put("/statics/**", "anon");
filterMap.put("/swagger/**", "anon");
filterMap.put("/login.html", "anon");
filterMap.put("/sys/login", "anon");
filterMap.put("/favicon.ico", "anon");
filterMap.put("/captcha.jpg", "anon");
filterMap.put("/**", "authc");
shiroFilter.setFilterChainDefinitionMap(filterMap);

return shiroFilter;
}

// ...
}

setSecurityManager用于设置安全管理器,这个属性是必须要配置的,所有与安全有关的操作都与SecurityManager交互,而且它管理者所有的subject。具体的概念还是看看[回顾][#回顾]里面的推荐。

setLoginUrl设置没有登录的用户请求需要登录的页面时自动跳转到登录页面,不是必须的属性,不输入地址的话会自动寻找项目web项目的根目录下的”/login.jsp”页面。此外,再说一下setSuccessUrl,该方法是设置登录成功默认跳转页面,不配置则跳转至”/”。如果登录前点击的一个需要登录的页面,则在登录自动跳转到那个需要登录的页面。不跳转到此。

setUnauthorizedUrl设置没有权限默认跳转的页面。

setFilterChainDefinitionMap用于设置filterChainDefinitions,这些filter集合配置了route的访问权限。上面配置项filterMap中的key是router,value是filter名。比如:/login.html=>anno,这一组说明访问/login.html是可以匿名访问的。

shiro默认filter列表

Shiro的默认Filter对应的类,具体看下表:

表1 shiro的filter列表
filter名称 class 说明
anon org.apache.shiro.web.filter
.authc.AnonymousFilter
例子/admins/**=anon 没有参数,表示可以匿名使用
authc org.apache.shiro.web.filter.authc
.FormAuthenticationFilter
例如/admins/user/**=authc表示需要认证(登录)才能使用,没有参数
authcBasic org.apache.shiro.web.filter.authc
.BasicHttpAuthenticationFilte
例如/admins/user/**=authcBasic没有参数表示httpBasic认证
perms org.apache.shiro.web.filter.authz
.PermissionsAuthorizationFilter
例子/admins/user/=perms[user:add:*],参数可以写多个,多个时必须加上引号,并且参数之间用逗号分割,例如/admins/user/=perms[“user:add:,user:modify:“],当有多个参数时必须每个参数都通过才通过,想当于isPermitedAll()方法。
port org.apache.shiro.web.filter
.authz.PortFilte
例子/admins/user/**=port[8081],当请求的url的端口不是8081是跳转到schemal://serverName:8081?queryString,其中schmal是协议http或https等,serverName是你访问的host,8081是url配置里port的端口,queryString是你访问的url里的?后面的参数。
rest org.apache.shiro.web.filter.authz
.HttpMethodPermissionFilter
例子/admins/user/=rest[user],根据请求的方法,相当于/admins/user/=perms[user:method] ,其中method为post,get,delete等。
roles org.apache.shiro.web.filter
.authz.RolesAuthorizationFilter
例子/admins/user/=roles[admin],参数可以写多个,多个时必须加上引号,并且参数之间用逗号分割,当有多个参数时,例如admins/user/=roles[“admin,guest”],每个参数通过才算通过,相当于hasAllRoles()方法。
ssl org.apache.shiro.web.filter
.authz.SslFilter
例子/admins/user/**=ssl没有参数,表示安全的url请求,协议为https
user org.apache.shiro.web.filter
.authc.UserFilter
例如/admins/user/**=user没有参数表示必须存在用户,当登入操作时不做检查
logout org.apache.shiro.web.filter
.authc.LogoutFilter
noSessionCreation org.apache.shiro.web.filter
.session.NoSessionCreationFilter

注:anon,authcBasic,auchc,user是认证过滤器,
perms,roles,ssl,rest,port是授权过滤器

自定义Shiro的Filter

在spring中配置相关bean,我们还是基于注解,其实这一步是不必要的,可以在LoginFilter上通过@Component或者@Service等注解,只需要该类的对象存在spring context中即可,比如:

1
2
3
4
@Bean("loginFilter")
public LoginFilter loginFilter(UserDao userDao) {
return new LoginFilter(userDao);
}

定义Shiro Filter Bean对应关系,修改renren的代码中shiroFilter的配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@Bean("shiroFilter")
public ShiroFilterFactoryBean shirFilter(SecurityManager securityManager, LoginFilter loginFilter) { // 传参增加了LoginFilter实例
ShiroFilterFactoryBean shiroFilter = new ShiroFilterFactoryBean();
shiroFilter.setSecurityManager(securityManager);
shiroFilter.setLoginUrl("/login.html");
shiroFilter.setUnauthorizedUrl("/");

// 自定义filter,请注意,自定义filter的时候先创建filter bean
Map<String, Filter> filters = new HashMap<>();
filters.put("login", loginFilter); // 对应的key为filter的别名
shiroFilter.setFilters(filters);

Map<String, String> filterMap = new LinkedHashMap<>();
filterMap.put("/statics/**", "anon");
filterMap.put("/swagger/**", "anon");
filterMap.put("/login.html", "anon");
filterMap.put("/sys/login", "anon");
filterMap.put("/favicon.ico", "anon");
filterMap.put("/captcha.jpg", "anon");
filterMap.put("/**", "authc");
shiroFilter.setFilterChainDefinitionMap(filterMap);

return shiroFilter;
}

SecurityManager配置

上面说了shiroFilter的配置必须依赖securityManager,所以要想配置shiroFilter,就必须配置securityManager,还是在ShiroConfig类里面。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

@Configuration
public class ShiroConfig {

// ...

@Bean("securityManager")
public SecurityManager securityManager(UserRealm userRealm, SessionManager sessionManager) {
DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
securityManager.setRealm(userRealm);
securityManager.setSessionManager(sessionManager);

return securityManager;
}
// ...
}

上面securityManager中UserRealm是realm的具体实现,这里是renren做的实现,放在下节详细学习具体实现。SessionManager就是会话管理器。

SessionManager的配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Bean("sessionManager")
public SessionManager sessionManager(RedisShiroSessionDAO redisShiroSessionDAO, @Value("${renren.redis.open}") boolean redisOpen,
@Value("${renren.shiro.redis}") boolean shiroRedis){
DefaultWebSessionManager sessionManager = new DefaultWebSessionManager();
//设置session过期时间为1小时(单位:毫秒),默认为30分钟
sessionManager.setGlobalSessionTimeout(60 * 60 * 1000);
sessionManager.setSessionValidationSchedulerEnabled(true);
sessionManager.setSessionIdUrlRewritingEnabled(false);

//如果开启redis缓存且renren.shiro.redis=true,则shiro session存到redis里
if(redisOpen && shiroRedis){
sessionManager.setSessionDAO(redisShiroSessionDAO);
}
return sessionManager;
}

SessionManager会话管理器配置,SessionManager是一个接口,具体可以根据场景选择其实现(DefaultSessionManager、DefaultWebSessionManager、DefaultSecurityManager、DefaultWebSecurityManager、ServletContainerSessionManager等)。此处使用了shiro的DefaultWebSessionManager来管理会话信息。sessionManager的setGlobalSessionTimeout用来设置session过期时间,默认为30分钟(private long globalSessionTimeout = 1800000L;)。setSessionValidationSchedulerEnabled是否开启自动扫描session线程,清理超时会话。setSessionIdUrlRewritingEnabled是否开启重写URL中的sessionid的名字,默认是JSESSIONID。

1
2
3
4
//如果开启redis缓存且renren.shiro.redis=true,则shiro session存到redis里
if(redisOpen && shiroRedis){
sessionManager.setSessionDAO(redisShiroSessionDAO);
}

这种设计是我喜欢的,根据实际情况,是否开启redis交给使用者自行决定,就算不开启,也不会影响使用。

文章到最后,realm、sessionDao的相关信息放在下一节继续学习和研究。等学习完shiro的相关组件,最后总结一篇如何使用xml配置的。用作对比学习的资料吧。