Shiro 入门

Posted 2020-09-22

Apache Shiro（http://shiro.apache.org/） 是 Java 的一个安全（权限）框架。
Shiro 可以非常容易的开发出足够好的应用，其不仅可以用在 JavaSE 环境，也可以用在 JavaEE 环境。

Shiro 可以完成：认证、授权、加密、会话管理、与Web 集成、缓存等。

主要类介绍

Authentication：身份认证/登录，验证用户是不是拥有相应的身份；
1. Authorization：授权，即权限验证，验证某个已认证的用户是否拥有某个权限；即判断用户是否能进行什么操作，如：验证某个用户是否拥有某个角色。或者细粒度的验证某个用户
对某个资源是否具有某个权限；
2. Session Manager：会话管理，即用户登录后就是一次会话，在没有退出之前，它的所有信息都在会话中；会话可以是普通 JavaSE 环境，也可以是 Web 环境的；
3. Cryptography：加密，保护数据的安全性，如密码加密存储到数据库，而不是明文存储；
4. Web Support：Web 支持，可以非常容易的集成到Web 环境；
5. Caching：缓存，比如用户登录后，其用户信息、拥有的角色/权限不必每次去查，这样可以提高效率；
6. Concurrency：Shiro 支持多线程应用的并发验证，即如在一个线程中开启另一个线程，能
7. 把权限自动传播过去；
8. Testing：提供测试支持；
9. Run As：允许一个用户假装为另一个用户（如果他们允许）的身份进行访问；
10. Remember Me：记住我，这个是非常常见的功能，即一次登录后，下次再来的话不用登录了

Shiro 架构
Subject：应用代码直接交互的对象是 Subject，也就是说 Shiro 的对外API核心就是Subject。Subject代表了当前“用户”，这个用户不一定
是一个具体的人，与当前应用交互的任何东西都是 Subject，如网络爬虫，机器人等；与 Subject 的所有交互都会委托给 SecurityManager；
Subject 其实是一个门面，SecurityManager 才是实际的执行者；
SecurityManager：安全管理器；即所有与安全有关的操作都会与SecurityManager 交互；且其管理着所有 Subject；可以看出它是 Shiro的核心，
它负责与 Shiro 的其他组件进行交互，它相当于 SpringMVC 中DispatcherServlet 的角色
Realm：Shiro 从 Realm 获取安全数据（如用户、角色、权限），就是说SecurityManager 要验证用户身份，那么它需要从 Realm 获取相应的用户进行
比较以确定用户身份是否合法；也需要从 Realm 得到用户相应的角色/权限进行验证用户是否能进行操作；可以把 Realm 看成 DataSource

HelloWorld

1.引入jar包

 log4j-1.2.15.jar, shiro-all-1.3.2.jar, slf4j-api-1.6.1.jar, slf4j-log4j12-1.6.1.jar

2.添加shiro.ini文件。（shiro提供的例子程序中有）添加log4j.properties

root = secret, admin
guest = guest, guest
presidentskroob = 12345, president
darkhelmet = ludicrousspeed, darklord, schwartz
lonestarr = vespa, goodguy, schwartz
[roles]
admin = *
schwartz = lightsaber:*
goodguy = user:delete:zhangsan

##添加log4j.properties
log4j.rootLogger=INFO, stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m %n

# General Apache libraries
log4j.logger.org.apache=WARN

# Spring
log4j.logger.org.springframework=WARN

# Default Shiro logging
log4j.logger.org.apache.shiro=TRACE

# Disable verbose logging
log4j.logger.org.apache.shiro.util.ThreadContext=WARN
log4j.logger.org.apache.shiro.cache.ehcache.EhCache=WARN

3.QuickStart

  1 import org.apache.shiro.SecurityUtils;
  2 import org.apache.shiro.authc.*;
  3 import org.apache.shiro.config.IniSecurityManagerFactory;
  4 import org.apache.shiro.mgt.SecurityManager;
  5 import org.apache.shiro.session.Session;
  6 import org.apache.shiro.subject.Subject;
  7 import org.apache.shiro.util.Factory;
  8 import org.slf4j.Logger;
  9 import org.slf4j.LoggerFactory;
 10 
 11 
 12 /**
 13  * Simple Quickstart application showing how to use Shiro‘s API.
 14  *
 15  * @since 0.9 RC2
 16  */
 17 public class Quickstart {
 18 
 19     private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);
 20 
 21     public static void main(String[] args) {
 22         Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
 23         SecurityManager securityManager = factory.getInstance();
 24         SecurityUtils.setSecurityManager(securityManager);
 25         Subject currentUser = SecurityUtils.getSubject();
 26         // 测试使用 Session 
 27         // 获取 Session: Subject#getSession()
 28         Session session = currentUser.getSession();
 29         session.setAttribute("someKey", "aValue");
 30         String value = (String) session.getAttribute("someKey");
 31         if (value.equals("aValue")) {
 32             log.info("---> Retrieved the correct value! [" + value + "]");
 33         }
 34 
 35         // let‘s login the current user so we can check against roles and permissions:
 36         // 测试当前的用户是否已经被认证. 即是否已经登录. 
 37         // 调动 Subject 的 isAuthenticated() 
 38         if (!currentUser.isAuthenticated()) {
 39             // 把用户名和密码封装为 UsernamePasswordToken 对象
 40             UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
 41             // rememberme
 42             token.setRememberMe(true);
 43             try {
 44                 // 执行登录. 
 45                 currentUser.login(token);
 46             } 
 47             // 若没有指定的账户, 则 shiro 将会抛出 UnknownAccountException 异常. 
 48             catch (UnknownAccountException uae) {
 49                 log.info("----> There is no user with username of " + token.getPrincipal());
 50                 return; 
 51             } 
 52             // 若账户存在, 但密码不匹配, 则 shiro 会抛出 IncorrectCredentialsException 异常。 
 53             catch (IncorrectCredentialsException ice) {
 54                 log.info("----> Password for account " + token.getPrincipal() + " was incorrect!");
 55                 return; 
 56             } 
 57             // 用户被锁定的异常 LockedAccountException
 58             catch (LockedAccountException lae) {
 59                 log.info("The account for username " + token.getPrincipal() + " is locked.  " +
 60                         "Please contact your administrator to unlock it.");
 61             }
 62             // ... catch more exceptions here (maybe custom ones specific to your application?
 63             // 所有认证时异常的父类. 
 64             catch (AuthenticationException ae) {
 65                 //unexpected condition?  error?
 66             }
 67         }
 68 
 69         //say who they are:
 70         //print their identifying principal (in this case, a username):
 71         log.info("----> User [" + currentUser.getPrincipal() + "] logged in successfully.");
 72 
 73         //test a role:
 74         // 测试是否有某一个角色. 调用 Subject 的 hasRole 方法. 
 75         if (currentUser.hasRole("schwartz")) {
 76             log.info("----> May the Schwartz be with you!");
 77         } else {
 78             log.info("----> Hello, mere mortal.");
 79             return; 
 80         }
 81 
 82         //test a typed permission (not instance-level)
 83         // 测试用户是否具备某一个行为. 调用 Subject 的 isPermitted() 方法。 
 84         if (currentUser.isPermitted("lightsaber:weild")) {
 85             log.info("----> You may use a lightsaber ring.  Use it wisely.");
 86         } else {
 87             log.info("Sorry, lightsaber rings are for schwartz masters only.");
 88         }
 89 
 90         //a (very powerful) Instance Level permission:
 91         // 测试用户是否具备某一个行为. 
 92         if (currentUser.isPermitted("user:delete:zhangsan")) {
 93             log.info("----> You are permitted to ‘drive‘ the winnebago with license plate (id) ‘eagle5‘.  " +
 94                     "Here are the keys - have fun!");
 95         } else {
 96             log.info("Sorry, you aren‘t allowed to drive the ‘eagle5‘ winnebago!");
 97         }
 98 
 99         //all done - log out!
100         // 执行登出. 调用 Subject 的 Logout() 方法. 
101         System.out.println("---->" + currentUser.isAuthenticated());
102         currentUser.logout();
103         System.out.println("---->" + currentUser.isAuthenticated());
104         System.exit(0);
105     }
106 }