Shiro安全框架解析-优快云博客

Shiro 安全框架

一、Shiro简介

Apache Shiro是Java的一个安全框架。功能强大，使用简单的Java安全框架，它为开发人员提供一个直观而全面的认证，授权，加密及会话管理的解决方案。 
实际上，Shiro的主要功能是管理应用程序中与安全相关的全部，同时尽可能支持多种实现方法。Shiro是建立在完善的接口驱动设计和面向对象原则之上的，
支持各种自定义行为。Shiro提供的默认实现，使其能完成与其他安全框架同样的功能。
Apache Shiro相当简单，对比Spring Security，可能没有Spring Security做的功能强大，但是在实际工作时可能并不需要那么复杂的东西，
所以使用小而简单的Shiro就足够了。对于它俩到底哪个好，这个不必纠结，能更简单的解决项目问题就好了。
Shiro可以非常容易的开发出足够好的应用，其不仅可以用在JavaSE环境，也可以用在JavaEE环境。Shiro可以帮助我们完成：认证、授权、加密、会话管理、
与Web集成、缓存等。

二、Shiro原理

2.1 Shiro的API

1、内部API
    ![这里写图片描述](https://img-blog.youkuaiyun.com/20160703220347751)
    Authentication：身份认证/登录，验证用户是不是拥有相应的身份；
    Authorization：授权，即权限验证，验证某个已认证的用户是否拥有某个权限；即判断用户是否能做事情，常见的如：验证某个用户是否拥有某个角色。
        或者细粒度的验证某个用户对某个资源是否具有某个权限；
    Session Manager：会话管理，即用户登录后就是一次会话，在没有退出之前，它的所有信息都在会话中；会话可以是普通JavaSE环境的，也可以是如Web环境的；
    Cryptography：加密，保护数据的安全性，如密码加密存储到数据库，而不是明文存储；
    Web Support：Web支持，可以非常容易的集成到Web环境；
    Caching：缓存，比如用户登录后，其用户信息、拥有的角色/权限不必每次去查，这样可以提高效率；
    Concurrency：shiro支持多线程应用的并发验证，即如在一个线程中开启另一个线程，能把权限自动传播过去；
    Testing：提供测试支持；
    Run As：允许一个用户假装为另一个用户（如果他们允许）的身份进行访问；
    Remember Me：记住我，这个是非常常见的功能，即一次登录后，下次再来的话不用登录了。
    记住一点，Shiro不会去维护用户、维护权限；这些需要我们自己去设计/提供；然后通过相应的接口注入给Shiro即可。

2、外部API
    ![这里写图片描述](https://img-blog.youkuaiyun.com/20160703220408564)
    可以看到：应用代码直接交互的对象是Subject，也就是说Shiro的对外API核心就是Subject；其每个API的含义：
    Subject：主体，代表了当前“用户”，这个用户不一定是一个具体的人，与当前应用交互的任何东西都是Subject，如网络爬虫，机器人等；
    即一个抽象概念；所有Subject都绑定到SecurityManager，与Subject的所有交互都会委托给SecurityManager；可以把Subject认为是一个门面；
        SecurityManager才是实际的执行者；
    SecurityManager：安全管理器；可以看作为Shrio的核心控制器，即所有与安全有关的操作都会与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让开发人员自己注入。

2.2 Shiro的具体内部功能模块

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提高了一些常见的加密组件用于如密码加密/解密的。

2.3 Shiro过滤器权限拦截器

过滤器简称       作用                    对应的java类
Anon         匿名可以访问             org.apache.shiro.web.filter.authc.AnonymousFilter     
Authc        认证才可访问             org.apache.shiro.web.filter.authc.FormAuthenticationFilter
authcBasic                          org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
perms                               org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter
port                                org.apache.shiro.web.filter.authz.PortFilter
rest                                org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
roles                               org.apache.shiro.web.filter.authz.RolesAuthorizationFilter
ssl                                 org.apache.shiro.web.filter.authz.SslFilter
user                                org.apache.shiro.web.filter.authc.UserFilter
logout      登出过滤器               org.apache.shiro.web.filter.authc.LogoutFilter

2.4 JSP Shiro标签

使用时，需要先导入Shiro标准标签库
<%@ taglib uri="http://shiro.apache.org/tags" prefix="shiro" %>
标签名称                            标签条件（均是显示标签内容）
<shiro:authenticated>               登录之后，才显示
<shiro:notAuthenticated>            没有登录时才显示
<shiro:guest>                       用户在没有RememberMe，才显示
<shiro:user>                        用户在RememberMe时，才显示
<shiro:hasAnyRoles name="abc,123" > 在有abc或者123角色时，才显示
<shiro:hasRole name="abc">          拥有角色abc，才显示
<shiro:lacksRole name="abc">        没有角色abc，才显示
<shiro:hasPermission name="abc">    拥有权限资源abc，才显示
<shiro:lacksPermission name="abc">  没有abc权限资源，才显示
<shiro:principal>                   默认显示用户名称，才显示

2.5 Spring security 与apache shiro 差别：

shiro配置更加容易理解，容易上手；security配置相对比较难懂。
在spring的环境下，security整合性更好。Shiro对很多其他的框架兼容性更好，号称是无缝集成。
shiro 不仅仅可以使用在web中，它可以工作在任何应用环境中。
在集群会话时Shiro最重要的一个好处或许就是它的会话是独立于容器的。
Shiro提供的密码加密使用起来非常方便。

三、Shiro实现

3.1 导入Shrio依赖的jar包

shiro-all-xxx.jar
Maven工程
<dependency>
    <groupId>org.apache.shiro</groupId>
    <artifactId>shiro-all</artifactId>
    <version>1.2.3</version>
</dependency>

3.2 在web.xml中配置相应的过滤器

注意，该过滤器必须配置到struts过滤器之前，否则action都无法进行创建
<!--配置Shiro核心控制filter，DelegatingFIlterProxy
一个filter相当于10个filter；web.xml
注意：shiro的filter必须在struts2的filter之前，否则action无法创建
< Shiro Security filter  filter-name这个名字的值将来还会在spring中用到  
-->
 <filter>
    <filter-name>shiroFilter</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
    <init-param>
        <param-name>targetFilterLifecycle</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>shiroFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

3.3 配置产生过滤器的代理方式

在applicationContext.xml文件中，必须在声明式事务之前配置、
表示使用cglib生成代理
  <aop:aspectj-autoproxy proxy-target-class="true" />

3.3 Shiro的配置文件

1、准备ehcache-shiro.xml缓存配置文件，放到classpath目录下
2、配置applicationContext-shiro.xml文件
    <!--配置安全管理器  -->
    <bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">
        <!-- 注入自定义的realm类 -->
        <property name="realm" ref="authRealm"/>
        <!-- 配置二级缓存 -->
        <property name="cacheManager" ref="shiroEhcacheManager"/>
    </bean>

    <!-- 自定义权限控制，用户认证类 -->
    <bean id="authRealm" class="cn.lx.jk.shiro.AuthRealm">
        <!--注入userService用于查询用户  -->
         <property name="userService" ref="userService"/>
         <!-- 注入密码比较器 --> 
        <property name="credentialsMatcher" ref="passwordMatcher"/>  
    </bean>

    <!-- 自定义加密策略 ，密码比较器-->
    <bean id="passwordMatcher" class="cn.lx.jk.shiro.CustomCredentialsMatcher"/>
    <!--配置shiro过滤器  -->
    <bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">
        <!--注入安全管理器  -->
        <property name="securityManager" ref="securityManager"/>
        <!--登陆时跳转页面  -->
        <property name="loginUrl" value="/index.jsp"></property>
        <!-- 没有权限或者失败后跳转的页面 -->
        <property name="successUrl" value="/home.action"></property>
        <!-- 配置过滤规则 -->
        <property name="filterChainDefinitions">
            <value>
            <!--配置过滤规则 
                anon表示无需认证就可访问
                authc表示认证后才可访问
             -->
                /index.jsp* = anon
                /home* = anon
                /sysadmin/login/login.jsp* = anon
                /sysadmin/login/logout.jsp* = anon
                /login* = anon
                /logout* = anon
                /components/** = anon
                /css/** = anon
                /images/** = anon
                /js/** = anon
                /make/** = anon
                /skin/** = anon
                /stat/** = anon
                /ufiles/** = anon
                /validator/** = anon
                /resource/** = anon
                /** = authc
                /*.* = authc

            </value>
        </property>
    </bean>

    <!-- 用户授权/认证信息Cache, 采用EhCache  缓存 -->
    <bean id="shiroEhcacheManager" class="org.apache.shiro.cache.ehcache.EhCacheManager">、
        <!-- 设置ehcache配置文件 -->
        <property name="cacheManagerConfigFile" value="classpath:ehcache-shiro.xml"/>
    </bean>

    <!-- 保证实现了Shiro内部lifecycle函数的bean执行 -->
    <bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor"/>

    <!-- 生成代理，通过代理进行控制 -->
    <bean  class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator"
          depends-on="lifecycleBeanPostProcessor">
        <!-- 使用cglib代理 -->
        <property name="proxyTargetClass" value="true"/>
    </bean>

    <!-- 认证事务-->
    <bean  class="org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor">
        <property name="securityManager" ref="securityManager"/>
    </bean>
3、在applicatioContext.xml文件中导入shiro配置文件
       <import resource="classpath:spring/applicationContext-shiro.xml"></import>

3.4 编写密码比较器

/**密码比较器
 * 规范，需要继承doGetAuthenticationInfo
 * 重写doCredentialsMatch密码比较方法
 * @author liuxuan
 *
 */
public class CustomCredentialsMatcher extends SimpleCredentialsMatcher{

    /**
     * 密码比较方法
     * AuthenticationToken 里面存储了，用户登录时，填写的账号和密码
     * AuthenticationInfo 存储的是用户的原始密码
     * */
    @Override
    public boolean doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info) {
        //向下转型
        UsernamePasswordToken upToken = (UsernamePasswordToken) token;
        //获取用户输入的密码
        String password = new String(upToken.getPassword());
        //对密码进行加密   
        String newPassword = Encrypt.md5(password, upToken.getUsername());
        //获取原始密码
        Object oldPassword = info.getCredentials();
        //进行比较
        return equals(newPassword, oldPassword);
    }

}

3.5 编写认证授权relam类

/**realm作用域，主要实现用户认证和权限授权操作。
 * 规范，需要实现AuthorizingRealm类
 * 重写doGetAuthorizationInfo 权限授权方法
 * 重现doGetAuthenticationInfo 角色认证方法
 * @author liuxuan
 *
 */
public class AuthRealm extends AuthorizingRealm{
    //注入userService
    private UserService userService;

    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    /**
     * 当页面有shiro标签时，就会调用授权方法
     * */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        //1、获取登陆认证时，存入到shiro的realm域中的User对象
        //fromRealm是获取当前域中的PrincipalCollection的集合，进行迭代，获取第一个元素，就是我们存储的用户
        User user = (User) principals.fromRealm(this.getName()).iterator().next();
        //2、用于存储，用户模块的权限集合
        Set<String> userModule =  new HashSet<String>();
        //2、1获取当前用户的角色
        for(Role role:user.getRoles()){
            for(Module module:role.getModules()){
                //2、2加载用户顶端菜单
                if(module.getCtype()==0){
                    //2、3添加模块名称
                    userModule.add(module.getName());
                }

            }
        }
        //2、3 创建权限授权对象
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
        info.addStringPermissions(userModule);
        return info;
    }

    /**
     * 当用户登陆时，自动调用该方法，即为认证方法
     * 当这个方法返回Null时，就会出现异常
     * 当认证成功后，返回的对象不为null时，就会自动进入密码比较器
     * 使用密码比较器，是在配置文件中配置的
     * AuthenticationToken 封装用户输入的用户名和密码
     * */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        UsernamePasswordToken upToken = (UsernamePasswordToken) token;
        //获取用户输入的用户名
        String userName = upToken.getUsername();
        //根据用户名查询用户是否存在
        User user = userService.findByName(userName);
        //如果用户不存在返回Null
        if(user == null){
            return null;
        }
        //如果用户存在返回AuthenticationInfo  三个 参数，第一个参数为Object principal用户，第二个参数为密码getCredentials，
        //第三个参数为当前realm域的名称

        AuthenticationInfo info  = new SimpleAuthenticationInfo(user,user.getPassword(),this.getName());
        return info;
    }

}

3.6 登陆方法

    private String username;
    private String password;

    public String login() throws Exception {
        //如果没有填写用户名，就跳转到登陆页面
        if(username ==null){
            request.put("msg", "请先登陆");
            return "login";
        }
        try {
            //shrio认证
            //1 得到Subject
            Subject subject =SecurityUtils.getSubject();
            //2 实现登陆
            //2.1将用户名和密码进行封装，交给shiro安全框架，并实现登陆过程
            UsernamePasswordToken uptoken = new UsernamePasswordToken(username, password);
            //3该方法执行后，就会进入AuthRealm的用户认证方法doGetAuthenticationInfo，该方法执行会调用密码比较器
            subject.login(uptoken);
            //4当认证成功后，将shrio中的用户对象取出来，放到session域中
            User user = (User) subject.getPrincipal();
            //SysConstant用于存储项目常量，好处时，需要修改常量时，只需要修改一处即可。
            session.put(SysConstant.CURRENT_USER_INFO, user);
            //5实现页面跳转
            return SUCCESS;

        } catch (Exception e) {
            //6 当输入的用户名和密码错误，会抛出异常
            e.printStackTrace();
            request.put("msg","用户名或密码错误");
            return "login";
        }
    }

3.7 退出方法

public String logout(){
    //移除session中存储的用户
    session.remove(SysConstant.CURRENT_USER_INFO);  

    Subject subject =SecurityUtils.getSubject();
    //调用登出方法
    subject.logout();
    return "logout";
}

3.8 页面上进行权限认证

1、导入shiro标签库
<%@ taglib uri="http://shiro.apache.org/tags" prefix="shiro" %>
2、
     <!-- 当jsp页面碰到shiro标签时就执行AuthRealm中授权方法
    <shiro:hasPermission name="系统首页"> 表示有该权限才会显示下面内容
     -->
    <shiro:hasPermission name="系统首页">
    <span id="topmenu" onclick="toModule('home');">系统首页</span><span id="tm_separator"></span>
    </shiro:hasPermission>
    <shiro:hasPermission name="流程管理">
    <span id="topmenu" onclick="toModule('activiti');">流程管理</span>
    </shiro:hasPermission>

四、Shiro框架的运行流程

1、登录之后，运行loginAction 中的login()方法
2、将用户名和密码封装到UserpasswordToken 中，也即封装到shiro中
    UsernamePasswordtoken upToken = new UsernamePasswordtoken();
3、因为Shiro对外提供的接口类就是Subject，所以，调用SecurityUtis.getSubject()方法获取到Subject类
    Subject subject = SecurityUtils.getSubject();
4、调用Subkject的登陆方法subje,传入uptoken对象
    subject.login(upToken);
    4.1该方法执行后，会进入realm类中的认证方法doGetAuthenticationInfo（AuthenticationToken token）
        4.1.1 将token强转为UsernamePasswordToken 类型
            UsernamePasswordToken upToken = (UsernamePasswordToken)token;
        4.1.2 获取用户输入的用户名
            String userName = upToken.getUsername();    
        4.1.3通过用户名查询用户
            User user = userService.findByName(userName);
        4.1.4判断用户是否存在
            不存在直接返回Null
        4.1.5如果用户存在，返回AuthenticationInfo 
            //如果用户存在返回AuthenticationInfo  三个 参数，第一个参数为Object principal用户，第二个参数为密码getCredentials，
                第三个参数为当前realm域的名称

            AuthenticationInfo info  = new SimpleAuthenticationInfo(user,user.getPassword(),this.getName());
            return info;
    4.2之后会执行密码比较器CustomCredentialsMatcher中的密码比较方法
                doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)
        4.2.1将token强转为UsernbamePasswordtoken
            UsernamePasswordToken upToken = (UsernamePasswordToken)t
        4.2.2获取到用户输入的密码，并进行加密
            //获取用户输入的密码
            String password = new String(upToken.getPassword());
            //对密码进行加密，使用Md5Hash进行加密  
            String newPassword = Encrypt.md5(password, upToken.getUsername());
        4.2.3获取原始密码
            Object oldPassword = info.getCredentials();
        4.2.4比较密码是否相等,并将boolean型结果返回
            this.equals(newPassword, oldPassword)
5、登陆成功之后，获取用户信息，并存储到session中
    5.1获取用户 
    User user = (User) subject.getPrincipal();
    5.2存储到session中
    session.put(SysConstant.CURRENT_USER_INFO, user);
    5.3返回结果视图
        reruen SUCCESS;
6、当页面有shrio标签时，会自动调用realm中的权限认证方法doGetAuthorizationInfo（PrincipalCollection principals）
    6.1 获取当前登陆的用户
        //fromRealm是获取当前域中的PrincipalCollection的集合，进行迭代，获取第一个元素，就是我们存储的用户
        User user = (User) principals.fromRealm(this.getName()).iterator().next();      
    6.2获取当前用户的权限模块名称，存到集合中
        Set<String> userModule =  new HashSet<String>();
        //2、1获取当前用户的角色
        for(Role role:user.getRoles()){
            for(Module module:role.getModules()){
                //2、2加载用户顶端菜单
                if(module.getCtype()==0){
                    //2、3添加模块名称
                    userModule.add(module.getName());
                }

            }
        }
    6.3 创建权限授权对象，并添加相应的权限集合
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
        info.addStringPermissions(userModule);
        return info
7、登出方法
    //移除session中存储的用户
    session.remove(SysConstant.CURRENT_USER_INFO);  

    Subject subject =SecurityUtils.getSubject();
    //调用登出方法
    subject.logout();