Shiro1.9学习笔记
一、Shiro概述
1、Shiro简介
1.1 介绍
Apache Shiro 是一个功能强大且易于使用的 Java 安全(权限)框架。Shiro 可以完成:认证、授权、加密、会话管理、与 Web 集成、缓存 等。借助 Shiro 您可以快速轻松地保护任何应用程序——从最小的移动应用程序到最大的 Web 和企业应用程序。
1.2 Shiro特点
- 易于使用:使用 Shiro 构建系统安全框架非常简单。就算第一次接触也可以快速掌握
- 全面:Shiro 包含系统安全框架需要的功能,满足安全需求的“一站式服务”
- 灵活:Shiro 可以在任何应用程序环境中工作。虽然它可以在 Web、EJB 和 IoC 环境中工作,但不需要依赖它们。Shiro 也没有强制要求任何规范,甚至没有很多依赖项
- 强力支持 Web:Shiro 具有出色的 Web 应用程序支持,可以基于应用程序 URL 和 Web 协议(例如 REST)创建灵活的安全策略,同时还提供一组 JSP 库来控制页面输出
- 兼容性强:Shiro 的设计模式使其易于与其他框架和应用程序集成。Shiro 与 Spring、Grails、Wicket、Tapestry、Mule、Apache Camel、Vaadin 等框架无缝集成
- 社区支持:Shiro 是 Apache 软件基金会的一个开源项目,有完备的社区支持,文档支持。如果需要,像 Katasoft 这样的商业公司也会提供专业的支持和服务
2、Shiro与SpringSecurity的对比
SpringSecurity参考:Spring Security学习笔记
- Spring Security 基于 Spring 开发,项目若使用 Spring 作为基础,配合 Spring Security 做权限更加方便,而 Shiro 需要和 Spring 进行整合开发;
- Spring Security 功能比 Shiro 更加丰富些,例如安全维护方面;
- Spring Security 社区资源相对比 Shiro 更加丰富;
- Shiro 的配置和使用比较简单,Spring Security 上手复杂些;
- Shiro 依赖性低,不需要任何框架和容器,可以独立运行。Spring Security 依赖 Spring 容器;
- shiro 不仅仅可以使用在 web 中,它可以工作在任何应用环境中。在集群会话时 Shiro 最重要的一个好处或许就是它的会话是独立于容器的
3、Shiro基本功能
- Authentication:身份认证/登录,验证用户是不是拥有相应的身份;
- Authorization:授权,即权限验证,验证某个已认证的用户是否拥有某个权限;即判断用 户是否能进行什么操作,如:验证某个用户是否拥有某个角色。或者细粒度的验证某个用户 对某个资源是否具有某个权限;
- Session Manager:会话管理,即用户登录后就是一次会话,在没有退出之前,它的所有信息都在会话中;会话可以是普通 JavaSE 环境,也可以是 Web 环境的;
- Cryptography:加密,保护数据的安全性,如密码加密存储到数据库,而不是明文存储;
- Web Support:Web 支持,可以非常容易的集成到 Web 环境;
- Caching:缓存,比如用户登录后,其用户信息、拥有的角色/权限不必每次去查,这样可以提高效率;
- Concurrency:Shiro 支持多线程应用的并发验证,即如在一个线程中开启另一个线程,能把权限自动传播过去;
- Testing:提供测试支持;
- Run As:允许一个用户假装为另一个用户(如果他们允许)的身份进行访问;
- Remember Me:记住我,这个是非常常见的功能,即一次登录后,下次再来的话不用登录了
4、Shiro原理
4.1 Shiro 架构(外部)
从外部来看 Shiro ,即从应用程序角度的来观察如何使用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
4.2 shiro架构(内部)
Subject
:任何可以与应用交互的“用户”;SecurityManager
:相当于 SpringMVC 中的 DispatcherServlet;是 Shiro 的心脏; 所有具体的交互都通过 SecurityManager 进行控制;它管理着所有 Subject、且负责进 行认证、授权、会话及缓存的管理。Authenticator
:负责 Subject 认证,是一个扩展点,可以自定义实现;可以使用认证策略(Authentication Strategy),即什么情况下算用户认证通过了;Authorizer
:授权器、即访问控制器,用来决定主体是否有权限进行相应的操作;即控制着用户能访问应用中的哪些功能;Realm
:可以有 1 个或多个 Realm,可以认为是安全实体数据源,即用于获取安全实体的;可以是 JDBC 实现,也可以是内存实现等等;由用户提供;所以一般在应用中都需要实现自己的 Realm;SessionManager
:管理 Session 生命周期的组件;而 Shiro 并不仅仅可以用在 Web环境,也可以用在如普通的 JavaSE 环境CacheManager
:缓存控制器,来管理如用户、角色、权限等的缓存的;因为这些数据 基本上很少改变,放到缓存中后可以提高访问的性能Cryptography
:密码模块,Shiro 提高了一些常见的加密组件用于如密码加密/解密。
二、Shiro基本使用
1、环境准备
引入shiro依赖
1 | <dependency> |
创建ini文件,因为Shiro获取权限相关信息可以通过数据库获取,也可以通过ini配置文件获取,后期放数据库
1 | [users] |
2、登录认证
2.1 登录认证概念
- 身份验证:一般需要提供如身份ID等一些标识信息来表明登录者的身份,如提供email,用户名/密码来证明
- 在shiro中,用户需要提供**principals(身份)**和credentials(证明)给shiro,从而应用能验证用户身份
- principals:身份,即主体的标识属性,可以是任何属性,如用户名、邮箱等,唯一即可。一个主体可以有多个principals,但只有一个Primary principals,一般是用户名/邮箱/手机号
- credentials:证明/凭证,即只有主体知道的安全值,如密码/数字证书等。
- 最常见的principals和credentials组合就是用户名/密码
2.2 登录认证基本流程
- 收集用户身份/凭证,即如用户名/密码
- 调用
Subject.login
进行登录,如果失败将得到相应 的AuthenticationException
异常,根据异常提示用户错误信息;否则登录成功 - 创建自定义的
Realm
类,继承org.apache.shiro.realm.AuthenticatingRealm
类,实现doGetAuthenticationInfo()
方法
2.3 登录认证实例
- 初始化获取SecurityManager
- 获取subject对象
- 创建token对象,web应用用户名密码从页面传递
- 完成登录
1 | public static void main(String[] args) { |
2.4 身份认证源码流程
- 首先调用
Subject.login(token)
进行登录,其会自动委托给SecurityManager
SecurityManager
负责真正的身份验证逻辑;它会委托给Authenticator
进行身份验证- Authenticator 才是真正的身份验证者,Shiro API 中核心的身份 认证入口点,此处可以自定义插入自己的实现;
- Authenticator 可能会委托给相应的
AuthenticationStrategy
进 行多 Realm 身份验证,默认ModularRealmAuthenticator
会调用AuthenticationStrategy
进行多 Realm 身份验证; - Authenticator 会把相应的 token 传入 Realm,从 Realm 获取 身份验证信息,如果没有返回/抛出异常表示身份验证失败了。此处可以配置多个Realm,将按照相应的顺序及策略进行访问。
3、角色与授权
3.1 授权概念
- 授权,也叫访问控制,即在应用中控制谁访问哪些资源(如访问页面/编辑数据/页面 操作等)。在授权中需了解的几个关键对象:
主体(Subject)
、资源(Resource)
、权限 (Permission)
、角色(Role)
- 主体(Subject):访问应用的用户,在 Shiro 中使用 Subject 代表该用户。用户只有授权 后才允许访问相应的资源
- 资源(Resource):在应用中用户可以访问的 URL,比如访问 JSP 页面、查看/编辑 某些 数据、访问某个业务方法、打印文本等等都是资源。用户只要授权后才能访问
- 权限(Permission):安全策略中的原子授权单位,通过权限我们可以表示在应用中用户 有没有操作某个资源的权力。即权限表示在应用中用户能不能访问某个资源,如:访问用 户列表页面查看/新增/修改/删除用户数据(即很多时候都是CRUD(增查改删)式权限控 制)等。权限代表了用户有没有操作某个资源的权利,即反映在某个资源上的操作允不允 许。
- Shiro 支持粗粒度权限(如用户模块的所有权限)和细粒度权限(操作某个用户的权限, 即实例级别的)
- 角色(Role):
权限的集合
,一般情况下会赋予用户角色而不是权限,即这样用户可以拥有 一组权限,赋予权限时比较方便。典型的如:项目经理、技术总监、CTO、开发工程师等 都是角色,不同的角色拥有一组不同的权限
3.2 授权方式
1 | //编程式 |
3.3 授权流程
- 首先调用Subject.isPermitted的
/hasRole
接口,其会委托给SecurityManager
,而SecurityManager接着会委托给 Authorizer; - Authorizer是真正的授权者,如果调用如isPermitted(“user:view”),其首先会通过PermissionResolver把字符串转换成相应的Permission实例;
- 在进行授权之前,其会调用相应的Realm获取Subject相应的角色/权限用于匹配传入的角色/权限;
- Authorizer会判断Realm的角色/权限是否和传入的匹配,如果有多个Realm,会委托给ModularRealmAuthorizer进行循环判断,如果匹配如isPermitted
/hasRole
会返回 true,否则返回false表示授权失败
3.4 代码实例
首先修改resource下的shiro.ini
文件
1 | [users] |
修改主函数进行测试
1 | public static void main(String[] args) { |
4、Shiro加密
实际系统开发中,一些敏感信息需要进行加密,比如说用户的密码。Shiro 内嵌很多 常用的加密算法,比如 MD5 加密。Shiro 可以很简单的使用信息加密。
1 | public static void main(String[] args) { |
5、自定义登陆认证
Shiro 默认的登录认证是不带加密的,如果想要实现加密认证需要自定义登录认证, 自定义 Realm;首先是创建自定义Realm
1 | public class MyRealm extends AuthenticatingRealm { |
第一种方法
1 | public static void main(String[] args) { |
同时在Ini文件添加
1 | [main] |
第二种方法,新的方法
1 | public static void main(String[] args) { |
三、Shiro整合Springboot
1、登录认证准备
1.1 环境准备
首先创建SpringBoot脚手架项目,导入依赖
1 | <dependency> |
Mysql脚本,配置好mysql
1 | CREATE DATABASE IF NOT EXISTS `shirodb` CHARACTER SET utf8mb4; |
配置application.yaml文件
1 | mybatis-plus: |
1.2 后端整合
创建各个模块和类
1 | // 实体类 |
创建自定义realm
1 |
|
创建配置类
1 |
|
1.3 前端thymeleaf整合
引入thymeleaf依赖后,在resource/templares
创建login.html
和main.html
1 | <!--login.html--> |
改造controller,让其返回走视图处理器,去除@ResponseBody
1 |
|
2、多 realm 认证策略
2.1 实现原理
当应用程序配置多个 Realm 时,例如:用户名密码校验、手机号验证码校验等等。 Shiro 的 ModularRealmAuthenticator
会使用内部的AuthenticationStrategy
组件判断认证是成功还是失败。
AuthenticationStrategy
是一个无状态的组件,它在身份验证尝试中被询问 4 次(这 4 次交互所需的任何必要的状态将被作为方法参数):
- 在所有 Realm 被调用之前
- 在调用 Realm 的 getAuthenticationInfo 方法之前
- 在调用 Realm 的 getAuthenticationInfo 方法之后
- 在所有 Realm 被调用之后
认证策略的另外一项工作就是聚合所有 Realm 的结果信息封装至一个AuthenticationInfo 实例中,并将此信息返回,以此作为 Subject 的身份信息。Shiro 中定义了 3 种认证策略的实现:
认证策略类 | 描述 |
---|---|
AtLeastOneSuccessfulStrategy | 只要有一个(或更多)的 Realm 验证成功,那么认证将视为成功 |
FirstSuccessfulStrategy | 第一个 Realm 验证成功,整体认证将视为成功,且后续 Realm 将被忽略 |
AllSuccessfulStrategy | 所有 Realm 成功,认证才视为成功 |
ModularRealmAuthenticator
内置的认证策略默认实现是 AtLeastOneSuccessfulStrategy
方式。可以通过配置修改策略
2.2 配置修改
1 |
|
3、remember me
3.1 实现原理
Shiro 提供了记住我(RememberMe)的功能,比如访问一些网站时,关闭了浏览器, 下次再打开时还是能记住你是谁, 下次访问时无需再登录即可访问。
基本流程
- 首先在登录页面选中 RememberMe 然后登录成功;如果是浏览器登录,一般会 把 RememberMe 的 Cookie 写到客户端并保存下来;
- 关闭浏览器再重新打开;会发现浏览器还是记住你的;
- 访问一般的网页服务器端,仍然知道你是谁,且能正常访问;
- 但是,如果我们访问电商平台时,如果要查看我的订单或进行支付时,此时还是需要再进行身份认证的,以确保当前用户还是你。
3.2 代码实现
过滤器可以参考:Shiro学习之过滤器详解
修改配置类,注意未认证的重定向在yml中进行配置
1 |
|
修改controller
1 |
|
改造login页面
1 |
|
4、用户注销
用户登录后,配套的有登出操作。直接通过Shiro过滤器即可实现登出,首先修改main.html
1 | <body> |
配置类中添加logout过滤器
1 |
|
5、授权、角色认证
用户登录后,需要验证是否具有指定角色指定权限。Shiro也提供了方便的工具进行判断。这个工具就是Realm的doGetAuthorizationInfo方法进行判断,触发权限判断的有两种方式
- 在页面中通过shiro:属性判断
- 在接口服务中通过注解@Requires进行判断
5.1 后端接口服务注解
通过给接口服务方法添加注解可以实现权限校验,可以加在控制器方法上,也可以加
在业务方法上,一般加在控制器方法上。常用注解如下:
-
@RequiresAuthentication
验证用户是否登录,等同于方法subject.isAuthenticated()
@RequiresUser
验证用户是否被记忆: 登录认证成功subject.isAuthenticated()为true ;登录后被记忆subject.isRemembered()为true
-
@RequiresGuest
验证是否是一个guest的请求,是否是游客的请求 ,此时subject.getPrincipal()为null
-
@RequiresRoles
验证subject是否有相应角色,有角色访问方法,没有则会抛出异常
AuthorizationException
。例如:@RequiresRoles("aRoleName") void someMethod();
只有subject有aRoleName角色才能访问方法someMethod() -
@RequiresPermissions
验证subject是否有相应权限,有权限访问方法,没有则会抛出异常
AuthorizationException
。例如:
@RequiresPermissions ("file:read","wite:aFile.txt") void someMethod();
subject必须同时含有file:read和wite:aFile.txt权限才能访问方someMethod()
5.2 授权验证-获取角色验证
首先添加数据库
1 | CREATE TABLE `role` ( |
mapper
1 |
|
service服务实现类
1 |
|
MyRealm 授权认证方法改造
1 |
|
最后controller添加授权方法,在mian.html添加<a href="/myController/userLoginRoles">测试授权-角色验证</a>
测试链接即可进行测试(数据库数据自行添加)
1 | //登录认证验证角色 |
5.3 授权验证-获取权限验证
创建权限数据表
1 | CREATE TABLE `permissions` ( |
创建方法
1 | //Mapper类 |
修改MyRealm配置类
1 | //自定义授权方法:获取当前登录用户权限信息,返回给 Shiro 用来进行授权对比 |
controller层
1 | //登录认证验证权限 |
修改main.html文件
1 | <body> |
5.4 权限验证异常处理类
1 |
|
5.5 前端页面授权验证
前端可以根据不同的权限显示不同的信息,首先添加依赖
1 | <dependency> |
配置类,用于解析 thymeleaf 中的 shiro:相关属性
1 |
|
Thymeleaf 中常用的 shiro:属性
1 | <!--guest 标签:用户没有身份验证时显示相应信息,即游客访问信息--> |
6、缓存管理
6.1 缓存工具EhCache
EhCache是一种广泛使用的开源Java分布式缓存。主要面向通用缓存,Java EE和轻量级容器。可以和大部分Java项目无缝整合,例如:Hibernate中的缓存就是基于EhCache实现的。EhCache支持内存和磁盘存储,默认存储在内存中,如内存不够时把缓存数据同步到磁盘中。EhCache支持基于Filter的Cache实现,也支持Gzip压缩算法。
EhCache直接在JVM虚拟机中缓存,速度快,效率高;EhCache缺点是缓存共享麻烦,集群分布式应用使用不方便
6.2 Ehcache简单搭建
引入依赖
1 | <dependency> |
创建配置文件
1 |
|
测试类
1 | public static void main(String[] args) { |
6.3 Shiro整合EhCache
1 | <!--Shiro整合EhCache--> |
然后在resources下添加配置文件ehcache/ehcache-shiro.xml
1 |
|
最后修改Shiro配置
1 |
|
最后访问权限测试,发现其成功缓存
7、会话管理
7.1 SessionManager
会话管理器,负责创建和管理用户的会话(Session)生命周期,它能够在任何环境中在本地管理用户会话,即使没有Web/Servlet/EJB容器,也一样可以保存会话。默认情况下,Shiro会检测当前环境中现有的会话机制(比如Servlet容器)进行适配,如果没有(比如独立应用程序或者非Web环境),它将会使用内置的企业会话管理器来提供相应的会话管理服务,其中还涉及一个名为SessionDAO的对象。SessionDAO负责Session的持久化操作(CRUD),允许Session数据写入到后端持久化数据库
7.2 会话管理实现
SessionManager由SecurityManager管理。Shiro提供了三种实现
- DefaultSessionManager:用于JavaSE环境
- ServletContainerSessionManager:用于web环境,直接使用Servlet容器的会话
- DefaultWebSessionManager:用于web环境,自己维护会话(不使用Servlet容器的会话管理)
7.3 获得session方式
- 实现
1 | Session session = SecurityUtils.getSubject().getSession(); |
-
说明
Controller中的request,在shiro过滤器中的doFilerInternal方法,被包装成ShiroHttpServletRequest。
SecurityManager和SessionManager会话管理器决定session来源于ServletRequest还是由Shiro管理的会话。 无论是通过request.getSession或subject.getSession获取到session,操作session,两者都是等价的。
参考: