Shiro 极简入门,从架构到集成,30 分钟上手

作者 : 开心源码 本文共9600个字,预计阅读时间需要24分钟 发布时间: 2022-05-13 共285人阅读

一、架构

要学习如何使用Shiro必需先从它的架构谈起,作为一款安全框架Shiro的设计相当精妙。Shiro的应用不依赖任何容器,它也可以在JavaSE下使用。但是最常用的环境还是JavaEE。下面以客户登录为例:

1、使用客户的登录信息创立令牌

UsernamePasswordToken token =newUsernamePasswordToken(username, password);

token可以了解为客户令牌,登录的过程被笼统为Shiro验证令牌能否具备合法身份以及相关权限。

2、执行登陆动作

Shiro的核心部分是SecurityManager,它负责安全认证与受权。Shiro本身已经实现了所有的细节,客户可以完全把它当做一个黑盒来使用。SecurityUtils对象,本质上就是一个工厂相似Spring中的ApplicationContext。

Subject是初学者比较难于了解的对象,很多人以为它可以等同于User,其实不然。Subject中文翻译:项目,而正确的了解也恰恰如此。它是你目前所设计的需要通过Shiro保护的项目的一个笼统概念。通过令牌(token)与项目(subject)的登陆(login)关系,Shiro保证了项目整体的安全。

3、判断客户

Shiro本身无法知道所持有令牌的客户能否合法,由于除了项目的设计人员恐怕谁都无法得知。因而Realm是整个框架中为数不多的必需由设计者自行实现的模块,当然Shiro提供了多种实现的途径,本文只详情最常见也最重要的一种实现方式——数据库查询。

4、两条重要的英文

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

在解释它们前首先必需要形容一下Shiro对于安全客户的界定:和大多数操作系统一样。客户具备角色和权限两种最基本的属性。例如,我的Windows登陆名称是learnhow,它的角色是administrator,而administrator具备所有系统权限。这样learnhow自然就拥有了所有系统权限。那么其余人需要登录我的电脑怎样办,我可以开放一个guest角色,任何无法提供正确客户名与密码的未知客户都可以通过guest来登录,而系统对于guest角色开放的权限极其有限。

同理,Shiro对客户的束缚也采用了这样的方式。AuthenticationInfo代表了客户的角色信息集合,AuthorizationInfo代表了角色的权限信息集合。如此一来,当设计人员对项目中的某一个url路径设置了只允许某个角色或者具备某种权限才可以访问的控制束缚的时候,Shiro即可以通过以上两个对象来判断。说到这里,大家可能还比较困惑。先不要焦急,继续往后看就自然会明白了。

二、实现Realm

如何实现Realm是本文的重头戏,也是比较费事的部分。这里大家会接触到几个新鲜的概念:缓存机制、散列算法、加密算法。因为本文不会专门详情这些概念,所以这里仅仅抛砖引玉的谈几点,能帮助大家更好的了解Shiro就可。

1、缓存机制

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

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

2、散列算法与加密算法

md5是本文会使用的散列算法,加密算法本文不会涉及。散列和加密本质上都是将一个Object变成一串无意义的字符串,不同点是经过散列的对象无法还原,是一个单向的过程。例如,对密码的加密通常就是使用散列算法,因而客户假如不记得密码只能通过修改而无法获取原始密码。但是对于信息的加密则是正规的加密算法,经过加密的信息是可以通过秘钥解密和复原。

3、客户注册

请注意,尽管我们一直在谈论客户登录的安全性问题,但是说到客户登录首先就是客户注册。如何保证客户注册的信息不丢失,不泄密也是项目设计的重点。

publicclassPasswordHelper{

privateRandomNumberGenerator randomNumberGenerator =newSecureRandomNumberGenerator();

privateString algorithmName =”md5″;

privatefinalinthashIterations =2;

publicvoidencryptPassword(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

publicclassRetryLimitHashedCredentialsMatcherextendsHashedCredentialsMatcher{

// 公告一个缓存接口,这个接口是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就是提供这两个对象的地方。

publicclassUserRealmextendsAuthorizingRealm{

// 客户对应的角色信息与权限信息都保存在数据库中,通过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最为实现。

三、与SpringMVC集成

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

1、配置前台过滤器

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

假如希望在WEB环境中使用Shiro必需首先在web.xml文件中配置。

<?xml version=”1.0″ encoding=”UTF-8″?>

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″>

Shiro_Project

index.jsp

SpringMVC

org.springframework.web.servlet.DispatcherServlet

contextConfigLocation

classpath:springmvc.xml

1

true

SpringMVC

/

org.springframework.web.context.ContextLoaderListener

org.springframework.web.util.Log4jConfigListener

contextConfigLocation

<!– 将Shiro的配置文件交给Spring监听器初始化 –>

classpath:spring.xml,classpath:spring-shiro-web.xml

log4jConfigLoaction

classpath:log4j.properties

<!– shiro配置 开始 –>

shiroFilter

org.springframework.web.filter.DelegatingFilterProxy

true

targetFilterLifecycle

true

shiroFilter

/*

<!– shiro配置 结束 –>

熟习Spring配置的同学可以重点看有绿字注释的部分,这里是使Shiro生效的关键。因为项目通过Spring管理,因而所有的配置准则上都是交给Spring。DelegatingFilterProxy的功能是通知Spring将所有的Filter交给ShiroFilter管理。

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

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实现 –>

<!– 凭证匹配器 –>

<!– Realm实现 –>

<!– 安全管理器 –>

<!– Shiro的Web过滤器 –>

/authc/admin = roles[admin]

/authc/** = authc

/** = anon

需要注意filterChainDefinitions过滤器中对于路径的配置是有顺序的,当找到匹配的条目之后容器不会再继续寻觅。因而带有通配符的路径要放在后面。三条配置的含义是:

/authc/admin需要客户有用admin权限

/authc/**客户必需登录才能访问

/**其余所有路径任何人都可以访问

说了这么多,大家肯定关心在Spring中引入Shiro之后究竟如何编写登录代码呢。

@Controller

publicclassLoginController{

@Autowired

privateUserServiceuserService;

@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!”);

returnmv;

} catch (UnknownAccountException uae) {

//捕获未知客户名异常

ModelAndView mv = new ModelAndView(“error”);

mv.addObject(“message”,”username error!”);

returnmv;

} catch (ExcessiveAttemptsException eae) {

//捕获错误登录过多的异常

ModelAndView mv = new ModelAndView(“error”);

mv.addObject(“message”,”times error”);

returnmv;

}

User user = userService.findByUsername(username);

subject.getSession().setAttribute(“user”, user);

returnnew 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”);

  }

}

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » Shiro 极简入门,从架构到集成,30 分钟上手

发表回复