安全框架Shiro

时间 2019-12-09

原文原文链接

原文地址：https://www.cnblogs.com/learnhow/p/5694876.htmlhtml

1、架构前端

要学习如何使用Shiro必须先从它的架构谈起，做为一款安全框架Shiro的设计至关精妙。Shiro的应用不依赖任何容器，它也能够在JavaSE下使用。可是最经常使用的环境仍是JavaEE。下面以用户登陆为例：java

（1）使用用户的登陆信息建立令牌程序员

UsernamePasswordToken token = new UsernamePasswordToken(username, password);

token能够理解为用户令牌，登陆的过程被抽象为Shiro验证令牌是否具备合法身份以及相关权限。web

（2）执行登录动做算法

SecurityUtils.setSecurityManager(securityManager); // 注入SecurityManager
Subject subject = SecurityUtils.getSubject(); // 获取Subject单例对象
subject.login(token); // 登录

Shiro的核心部分是SecurityManager，它负责安全认证与受权。Shiro自己已经实现了全部的细节，用户能够彻底把它当作一个黑盒来使用。SecurityUtils对象，本质上就是一个工厂相似Spring中的ApplicationContext。Subject是初学者比较难于理解的对象，不少人觉得它能够等同于User，其实否则。Subject中文翻译：项目，而正确的理解也偏偏如此。它是你目前所设计的须要经过Shiro保护的项目的一个抽象概念。经过令牌（token）与项目（subject）的登录（login）关系，Shiro保证了项目总体的安全。spring

（3）判断用户数据库

Shiro自己没法知道所持有令牌的用户是否合法，由于除了项目的设计人员恐怕谁都没法得知。所以Realm是整个框架中为数很少的必须由设计者自行实现的模块，固然Shiro提供了多种实现的途径，本文只介绍最多见也最重要的一种实现方式——数据库查询。apache

（4）两条重要的英文json

我在学习Shiro的过程当中遇到的第一个障碍就是这两个对象的英文名称：AuthorizationInfo，AuthenticationInfo。不用怀疑本身的眼睛，它们确实长的很像，不但长的像，就连意思都十分近似。

在解释它们前首先必需要描述一下Shiro对于安全用户的界定：和大多数操做系统同样。用户具备角色和权限两种最基本的属性。例如，个人Windows登录名称是learnhow，它的角色是administrator，而administrator具备全部系统权限。这样learnhow天然就拥有了全部系统权限。那么其余人须要登陆个人电脑怎么办，我能够开放一个guest角色，任何没法提供正确用户名与密码的未知用户均可以经过guest来登陆，而系统对于guest角色开放的权限极其有限。

同理，Shiro对用户的约束也采用了这样的方式。AuthenticationInfo表明了用户的角色信息集合，AuthorizationInfo表明了角色的权限信息集合。如此一来，当设计人员对项目中的某一个url路径设置了只容许某个角色或具备某种权限才能够访问的控制约束的时候，Shiro就能够经过以上两个对象来判断。说到这里，你们可能还比较困惑。先不要着急，继续日后看就天然会明白了。

2、实现Realm

如何实现Realm是本文的重头戏，也是比较费事的部分。这里你们会接触到几个新鲜的概念：缓存机制、散列算法、加密算法。因为本文不会专门介绍这些概念，因此这里仅仅抛砖引玉的谈几点，能帮助你们更好的理解Shiro便可。

（1）缓存机制

Ehcache是不少Java项目中使用的缓存框架，Hibernate就是其中之一。它的本质就是将本来只能存储在内存中的数据经过算法保存到硬盘上，再根据需求依次取出。你能够把Ehcache理解为一个Map<String,Object>对象，经过put保存对象，再经过get取回对象。

<?xml version="1.0" encoding="UTF-8"?>
<ehcache name="shirocache">
    <diskStore path="java.io.tmpdir" />
    
    <cache name="passwordRetryCache"
           maxEntriesLocalHeap="2000"
           eternal="false"
           timeToIdleSeconds="1800"
           timeToLiveSeconds="0"
           overflowToDisk="false"
           statistics="true">
    </cache>
</ehcache>

以上是ehcache.xml文件的基础配置，timeToLiveSeconds为缓存的最大生存时间，timeToIdleSeconds为缓存的最大空闲时间，当eternal为false时ttl和tti才能够生效。更多配置的含义你们能够去网上查询。

（2）散列算法与加密算法

md5是本文会使用的散列算法，加密算法本文不会涉及。散列和加密本质上都是将一个Object变成一串无心义的字符串，不一样点是通过散列的对象没法复原，是一个单向的过程。例如，对密码的加密一般就是使用散列算法，所以用户若是忘记密码只能经过修改而没法获取原始密码。可是对于信息的加密则是正规的加密算法，通过加密的信息是能够经过秘钥解密和还原。

（3）用户注册

请注意，虽然咱们一直在谈论用户登陆的安全性问题，可是说到用户登陆首先就是用户注册。如何保证用户注册的信息不丢失，不泄密也是项目设计的重点。

public class PasswordHelper {
    private RandomNumberGenerator randomNumberGenerator = new SecureRandomNumberGenerator();
    private String algorithmName = "md5";
    private final int hashIterations = 2;

    public void encryptPassword(User user) {
        // User对象包含最基本的字段Username和Password
        user.setSalt(randomNumberGenerator.nextBytes().toHex());
        // 将用户的注册密码通过散列算法替换成一个不可逆的新密码保存进数据，散列过程使用了盐
        String newPassword = new SimpleHash(algorithmName, user.getPassword(),
                ByteSource.Util.bytes(user.getCredentialsSalt()), hashIterations).toHex();
        user.setPassword(newPassword);
    }
}

若是你不清楚什么叫加盐能够忽略散列的过程，只要明白存储在数据库中的密码是根据户注册时填写的密码所产生的一个新字符串就能够了。通过散列后的密码替换用户注册时的密码，而后将User保存进数据库。剩下的工做就丢给UserService来处理。

那么这样就带来了一个新问题，既然散列算法是没法复原的，当用户登陆的时候使用当初注册时的密码，咱们又应该如何判断？答案就是须要对用户密码再次以相同的算法散列运算一次，再同数据库中保存的字符串比较。

（4）匹配

CredentialsMatcher是一个接口，功能就是用来匹配用户登陆使用的令牌和数据库中保存的用户信息是否匹配。固然它的功能不只如此。本文要介绍的是这个接口的一个实现类：HashedCredentialsMatcher

public class RetryLimitHashedCredentialsMatcher extends HashedCredentialsMatcher {
    // 声明一个缓存接口，这个接口是Shiro缓存管理的一部分，它的具体实现能够经过外部容器注入
    private Cache<String, AtomicInteger> passwordRetryCache;

    public RetryLimitHashedCredentialsMatcher(CacheManager cacheManager) {
        passwordRetryCache = cacheManager.getCache("passwordRetryCache");
    }

    @Override
    public boolean doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info) {
        String username = (String) token.getPrincipal();
        AtomicInteger retryCount = passwordRetryCache.get(username);
        if (retryCount == null) {
            retryCount = new AtomicInteger(0);
            passwordRetryCache.put(username, retryCount);
        }
        // 自定义一个验证过程：当用户连续输入密码错误5次以上禁止用户登陆一段时间
        if (retryCount.incrementAndGet() > 5) {
            throw new ExcessiveAttemptsException();
        }
        boolean match = super.doCredentialsMatch(token, info);
        if (match) {
            passwordRetryCache.remove(username);
        }
        return match;
    }
}

能够看到，这个实现里设计人员仅仅是增长了一个不容许连续错误登陆的判断。真正匹配的过程仍是交给它的直接父类去完成。连续登陆错误的判断依靠Ehcache缓存来实现。显然match返回true为匹配成功。

（5）获取用户的角色和权限信息

说了这么多才到咱们的重点Realm，若是你已经理解了Shiro对于用户匹配和注册加密的全过程，真正理解Realm的实现反而比较简单。咱们还得回到上文说起的两个很是相似的对象AuthorizationInfo和AuthenticationInfo。由于Realm就是提供这两个对象的地方。

public class UserRealm extends AuthorizingRealm {
    // 用户对应的角色信息与权限信息都保存在数据库中，经过UserService获取数据
    private UserService userService = new UserServiceImpl();

    /**
     * 提供用户信息返回权限信息
     */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        String username = (String) principals.getPrimaryPrincipal();
        SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo();
        // 根据用户名查询当前用户拥有的角色
        Set<Role> roles = userService.findRoles(username);
        Set<String> roleNames = new HashSet<String>();
        for (Role role : roles) {
            roleNames.add(role.getRole());
        }
        // 将角色名称提供给info
        authorizationInfo.setRoles(roleNames);
        // 根据用户名查询当前用户权限
        Set<Permission> permissions = userService.findPermissions(username);
        Set<String> permissionNames = new HashSet<String>();
        for (Permission permission : permissions) {
            permissionNames.add(permission.getPermission());
        }
        // 将权限名称提供给info
        authorizationInfo.setStringPermissions(permissionNames);

        return authorizationInfo;
    }

    /**
     * 提供帐户信息返回认证信息
     */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        String username = (String) token.getPrincipal();
        User user = userService.findByUsername(username);
        if (user == null) {
            // 用户名不存在抛出异常
            throw new UnknownAccountException();
        }
        if (user.getLocked() == 0) {
            // 用户被管理员锁定抛出异常
            throw new LockedAccountException();
        }
        SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo(user.getUsername(),
                user.getPassword(), ByteSource.Util.bytes(user.getCredentialsSalt()), getName());
        return authenticationInfo;
    }
}

根据Shiro的设计思路，用户与角色以前的关系为多对多，角色与权限之间的关系也是多对多。在数据库中须要所以创建5张表，分别是用户表（存储用户名，密码，盐等）、角色表（角色名称，相关描述等）、权限表（权限名称，相关描述等）、用户-角色对应中间表（以用户ID和角色ID做为联合主键）、角色-权限对应中间表（以角色ID和权限ID做为联合主键）。具体dao与service的实现本文不提供。总之结论就是，Shiro须要根据用户名和密码首先判断登陆的用户是否合法，而后再对合法用户受权。而这个过程就是Realm的实现过程。

（6）会话

用户的一次登陆即为一次会话，Shiro也能够代替Tomcat等容器管理会话。目的是当用户停留在某个页面长时间无动做的时候，再次对任何连接的访问都会被重定向到登陆页面要求从新输入用户名和密码而不须要程序员在Servlet中不停的判断Session中是否包含User对象。启用Shiro会话管理的另外一个用途是能够针对不一样的模块采起不一样的会话处理。以淘宝为例，用户注册淘宝之后能够选择记住用户名和密码。以后再次访问就无需登录。可是若是你要访问支付宝或购物车等连接依然须要用户确认身份。固然，Shiro也能够建立使用容器提供的Session最为实现。

3、与SpringMVC集成

有了注册模块和Realm模块的支持，下面就是如何与SpringMVC集成开发。有过框架集成经验的同窗必定知道，所谓的集成基本都是一堆xml文件的配置，Shiro也不例外。

（1）配置前端过滤器

先说一个题外话，Filter是过滤器，interceptor是拦截器。前者基于回调函数实现，必须依靠容器支持。由于须要容器装配好整条FilterChain并逐个调用。后者基于代理实现，属于AOP的范畴。

若是但愿在WEB环境中使用Shiro必须首先在web.xml文件中配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    id="WebApp_ID" version="3.0">
    <display-name>Shiro_Project</display-name>
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
    <servlet>
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
        <async-supported>true</async-supported>
    </servlet>
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <!-- 将Shiro的配置文件交给Spring监听器初始化 -->
        <param-value>classpath:spring.xml,classpath:spring-shiro-web.xml</param-value>
    </context-param>
    <context-param>
        <param-name>log4jConfigLoaction</param-name>
        <param-value>classpath:log4j.properties</param-value>
    </context-param>
    <!-- shiro配置 开始 -->
    <filter>
        <filter-name>shiroFilter</filter-name>
        <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
        <async-supported>true</async-supported>
        <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>
    <!-- shiro配置 结束 -->
</web-app>

熟悉Spring配置的同窗能够重点看有绿字注释的部分，这里是使Shiro生效的关键。因为项目经过Spring管理，所以全部的配置原则上都是交给Spring。DelegatingFilterProxy的功能是通知Spring将全部的Filter交给ShiroFilter管理。

接着在classpath路径下配置spring-shiro-web.xml文件

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/beans    
                        http://www.springframework.org/schema/beans/spring-beans-3.1.xsd    
                        http://www.springframework.org/schema/context    
                        http://www.springframework.org/schema/context/spring-context-3.1.xsd    
                        http://www.springframework.org/schema/mvc    
                        http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">

    <!-- 缓存管理器 使用Ehcache实现 -->
    <bean id="cacheManager" class="org.apache.shiro.cache.ehcache.EhCacheManager">
        <property name="cacheManagerConfigFile" value="classpath:ehcache.xml" />
    </bean>

    <!-- 凭证匹配器 -->
    <bean id="credentialsMatcher" class="utils.RetryLimitHashedCredentialsMatcher">
        <constructor-arg ref="cacheManager" />
        <property name="hashAlgorithmName" value="md5" />
        <property name="hashIterations" value="2" />
        <property name="storedCredentialsHexEncoded" value="true" />
    </bean>

    <!-- Realm实现 -->
    <bean id="userRealm" class="utils.UserRealm">
        <property name="credentialsMatcher" ref="credentialsMatcher" />
    </bean>

    <!-- 安全管理器 -->
    <bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">
        <property name="realm" ref="userRealm" />
    </bean>

    <!-- Shiro的Web过滤器 -->
    <bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">
        <property name="securityManager" ref="securityManager" />
        <property name="loginUrl" value="/" />
        <property name="unauthorizedUrl" value="/" />
        <property name="filterChainDefinitions">
            <value>
                /authc/admin = roles[admin]
                /authc/** = authc
                /** = anon
            </value>
        </property>
    </bean>

    <bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor" />
</beans>

须要注意filterChainDefinitions过滤器中对于路径的配置是有顺序的，当找到匹配的条目以后容器不会再继续寻找。所以带有通配符的路径要放在后面。三条配置的含义是： /authc/admin须要用户有用admin权限、/authc/**用户必须登陆才能访问、/**其余全部路径任何人均可以访问。

说了这么多，你们必定关心在Spring中引入Shiro以后到底如何编写登陆代码呢。

@Controller
public class LoginController {
    @Autowired
    private UserService userService;

    @RequestMapping("login")
    public ModelAndView login(@RequestParam("username") String username, @RequestParam("password") String password) {
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        Subject subject = SecurityUtils.getSubject();
        try {
            subject.login(token);
        } catch (IncorrectCredentialsException ice) {
            // 捕获密码错误异常
            ModelAndView mv = new ModelAndView("error");
            mv.addObject("message", "password error!");
            return mv;
        } catch (UnknownAccountException uae) {
            // 捕获未知用户名异常
            ModelAndView mv = new ModelAndView("error");
            mv.addObject("message", "username error!");
            return mv;
        } catch (ExcessiveAttemptsException eae) {
            // 捕获错误登陆过多的异常
            ModelAndView mv = new ModelAndView("error");
            mv.addObject("message", "times error");
            return mv;
        }
        User user = userService.findByUsername(username);
        subject.getSession().setAttribute("user", user);
        return new ModelAndView("success");
    }
}

登陆完成之后，当前用户信息被保存进Session。这个Session是经过Shiro管理的会话对象，要获取依然必须经过Shiro。传统的Session中不存在User对象。

@Controller
@RequestMapping("authc")
public class AuthcController {
    // /authc/** = authc 任何经过表单登陆的用户均可以访问
    @RequestMapping("anyuser")
    public ModelAndView anyuser() {
        Subject subject = SecurityUtils.getSubject();
        User user = (User) subject.getSession().getAttribute("user");
        System.out.println(user);
        return new ModelAndView("inner");
    }

    // /authc/admin = user[admin] 只有具有admin角色的用户才能够访问，不然请求将被重定向至登陆界面
    @RequestMapping("admin")
    public ModelAndView admin() {
        Subject subject = SecurityUtils.getSubject();
        User user = (User) subject.getSession().getAttribute("user");
        System.out.println(user);
        return new ModelAndView("inner");
    }
}

4、总结

Shiro是一个功能很齐全的框架，使用起来也很容易，可是要想用好却有至关难度。完整项目的源码就不在这里提供了，须要交流的同窗能够给我留言或直接查阅张开涛的博客。若是你们感受我写的还能够，也但愿能给我一些反馈意见。

5、推荐

这是一个学习shiro的网站，但愿系统学习同窗能够前往。