1、shiro簡介
Shiro簡介
1. 什麼是shiro
shiro是apache的一個開源框架,是一個權限管理的框架,實現 用戶認證、用戶授權。
spring中有spring security (原名Acegi),是一個權限框架,它和spring依賴過於緊密,沒有shiro使用簡單。
shiro不依賴於spring,shiro不僅可以實現 web應用的權限管理,還可以實現c/s系統,
分佈式系統權限管理,shiro屬於輕量框架,越來越多企業項目開始使用shiro。
2. 在應用程序角度來觀察如何使用Shiro完成工作(圖01)
Subject:主體,代表了當前“用戶”,這個用戶不一定是一個具體的人,與當前應用交互的任何東西都是Subject,如網絡爬蟲,機器人等;即一個抽象概念;所有Subject 都綁定到SecurityManager,與Subject的所有交互都會委託給SecurityManager;可以把Subject認爲是一個門面;SecurityManager纔是實際的執行者;
SecurityManager:安全管理器;即所有與安全有關的操作都會與SecurityManager 交互;且它管理着所有Subject;可以看出它是Shiro 的核心,它負責與後邊介紹的其他組件進行交互,如果學習過SpringMVC,你可以把它看成DispatcherServlet前端控制器;
Realm:域,Shiro從從Realm獲取安全數據(如用戶、角色、權限),就是說SecurityManager要驗證用戶身份,那麼它需要從Realm獲取相應的用戶進行比較以確定用戶身份是否合法;也需要從Realm得到用戶相應的角色/權限進行驗證用戶是否能進行操作;可以把Realm看成DataSource,即安全數據源。
3. shiro架構
3.1 subject:主體,可以是用戶也可以是程序,主體要訪問系統,系統需要對主體進行認證、授權。
3.2 securityManager:安全管理器,主體進行認證和授權都是通過securityManager進行。securityManager是一個集合,真正做事的不是securityManager而是它裏面的東西。
3.3 authenticator:認證器,主體進行認證最終通過authenticator進行的。
3.4 authorizer:授權器,主體進行授權最終通過authorizer進行的。
3.5 sessionManager:web應用中一般是用web容器(中間件tomcat)對session進行管理,shiro也提供一套session管理的方式。 shiro不僅僅可以用於web管理也可以用於cs管理,所以他不用web容器的session管理。
3.6 SessionDao: 通過SessionDao管理session數據,針對個性化的session數據存儲需要使用sessionDao
(如果用tomcat管理session就不用SessionDao,如果要分佈式的統一管理session就要用到SessionDao)。
3.7 cache Manager:緩存管理器,主要對session和授權數據進行緩存(權限管理框架主要就是對認證和授權進行管理, session是在服務器緩存中的),比如將授權數據通過cacheManager進行緩存管理,和ehcache整合對緩存數據進行管理(redis是緩存框架)。
3.8 realm:域,領域,相當於數據源,通過realm存取認證、授權相關數據(原來是通過數據庫取的)。注意:authenticator認證器和authorizer授權器調用realm中存儲授權和認證的數據和邏輯。
3.9 cryptography:密碼管理,比如md5加密,提供了一套加密/解密的組件,方便開發。比如提供常用的散列、加/解密等功能。比如 md5散列算法(md5只有加密沒有解密)。
2、Shiro入門案例
Shiro入門案例
準備工作:
1、導入相關依賴
2、編寫shiro.ini文件
添加日誌文件 log4j2.xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- status : 指定log4j本身的打印日誌的級別.ALL< Trace < DEBUG < INFO < WARN < ERROR
< FATAL < OFF。 monitorInterval : 用於指定log4j自動重新配置的監測間隔時間,單位是s,最小是5s. -->
<Configuration status="WARN" monitorInterval="30">
<Properties>
<!--window配置-->
<!--配置日誌文件輸出目錄 ${sys:user.home}-->
<Property name="LOG_HOME">${sys:user.home}/logs</Property>
<property name="ERROR_LOG_FILE_NAME">${sys:user.home}/logs/error</property>
<property name="WARN_LOG_FILE_NAME">${sys:user.home}/logs/warn</property>
<!--linux ubuntu配置-->
<!--請在操作系統中配置環境變量catalina_home-->
<!--<Property name="LOG_HOME">${catalina_home}/logs</Property>-->
<!--<property name="ERROR_LOG_FILE_NAME">${catalina_home}/logs/error</property>-->
<!--<property name="WARN_LOG_FILE_NAME">${catalina_home}/logs/warn</property>-->
<!--配置日誌格式-->
<property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} [%t-%L] %-5level %logger{36} - %msg%n</property>
<!--<property name="PATTERN">%n Level: %p%n Time: %d%n Method: %l%nMessage: %m%n</property>-->
</Properties>
<Appenders>
<!--這個輸出控制檯的配置 -->
<Console name="Console" target="SYSTEM_OUT">
<!-- 控制檯只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch) -->
<ThresholdFilter level="trace" onMatch="ACCEPT"
onMismatch="DENY"/>
<!-- 輸出日誌的格式 -->
<!-- %d{yyyy-MM-dd HH:mm:ss, SSS} : 日誌生產時間 %p : 日誌輸出格式 %c : logger的名稱
%m : 日誌內容,即 logger.info("message") %n : 換行符 %C : Java類名 %L : 日誌輸出所在行數 %M
: 日誌輸出所在方法名 hostName : 本地機器名 hostAddress : 本地ip地址 -->
<PatternLayout pattern="${PATTERN}"/>
</Console>
<!--文件會打印出所有信息,這個log每次運行程序會自動清空,由append屬性決定,這個也挺有用的,適合臨時測試用 -->
<!--append爲TRUE表示消息增加到指定文件中,false表示消息覆蓋指定的文件內容,默認值是true -->
<File name="log" fileName="logs/test.log" append="false">
<PatternLayout
pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
</File>
<!-- 這個會打印出所有的info及以下級別的信息,每次大小超過size, 則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮,作爲存檔 -->
<RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/info.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制檯只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch) -->
<ThresholdFilter level="info" onMatch="ACCEPT"
onMismatch="DENY"/>
<PatternLayout
pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
<Policies>
<!-- 基於時間的滾動策略,interval屬性用來指定多久滾動一次,默認是1 hour。 modulate=true用來調整時間:比如現在是早上3am,interval是4,那麼第一次滾動是在4am,接着是8am,12am...而不是7am. -->
<!-- 關鍵點在於 filePattern後的日期格式,以及TimeBasedTriggeringPolicy的interval, 日期格式精確到哪一位,interval也精確到哪一個單位 -->
<!-- log4j2的按天分日誌文件 : info-%d{yyyy-MM-dd}-%i.log -->
<TimeBasedTriggeringPolicy interval="1"
modulate="true"/>
<!-- SizeBasedTriggeringPolicy:Policies子節點, 基於指定文件大小的滾動策略,size屬性用來定義每個日誌文件的大小. -->
<!-- <SizeBasedTriggeringPolicy size="2 kB" /> -->
</Policies>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${WARN_LOG_FILE_NAME}/warn.log"
filePattern="${WARN_LOG_FILE_NAME}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="warn" onMatch="ACCEPT"
onMismatch="DENY"/>
<PatternLayout
pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="2 kB"/>
</Policies>
<!-- DefaultRolloverStrategy屬性如不設置,則默認爲最多同一文件夾下7個文件,這裏設置了20 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${ERROR_LOG_FILE_NAME}/error.log"
filePattern="${ERROR_LOG_FILE_NAME}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd-HH-mm}-%i.log">
<ThresholdFilter level="error" onMatch="ACCEPT"
onMismatch="DENY"/>
<PatternLayout
pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
<Policies>
<!-- log4j2的按分鐘 分日誌文件 : warn-%d{yyyy-MM-dd-HH-mm}-%i.log -->
<TimeBasedTriggeringPolicy interval="1"
modulate="true"/>
<!-- <SizeBasedTriggeringPolicy size="10 MB" /> -->
</Policies>
</RollingFile>
</Appenders>
<!--然後定義logger,只有定義了logger並引入的appender,appender纔會生效 -->
<Loggers>
<!-- 第三方日誌系統 -->
<!--過濾掉spring和mybatis的一些無用的DEBUG信息 -->
<logger name="org.springframework" level="ERROR"></logger>
<logger name="org.mybatis" level="ERROR"></logger>
<logger name="org.apache.ibatis" level="ERROR"></logger>
<logger name="net.sf" level="ERROR"/>
<logger name="org.jboss" level="ERROR"/>
<logger name="org.apache.shiro" level="ERROR"/>
<!-- 配置日誌的根節點 -->
<root level="all">
<appender-ref ref="Console"/>
<!--<appender-ref ref="RollingFileInfo" />-->
<!--<appender-ref ref="RollingFileWarn" />-->
<!--<appender-ref ref="RollingFileError" />-->
</root>
</Loggers>
</Configuration>
導入的依賴 pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>mybatis</artifactId>
<groupId>com.hu</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>shiro01</artifactId>
<packaging>war</packaging>
<name>shiro01 Maven Webapp</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
<maven.compiler.plugin.version>3.7.0</maven.compiler.plugin.version>
<!-- 添加相關依賴 -->
<junit.version>4.12</junit.version>
<servlet.version>4.0.0</servlet.version>
<log4j2.version>2.9.1</log4j2.version>
<slf4j.version>1.7.7</slf4j.version>
<log4j2.disruptor.version>3.2.0</log4j2.disruptor.version>
<shiro.version>1.2.5</shiro.version>
</properties>
<dependencies>
<!-- shiro核心包 -->
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-core</artifactId>
<version>${shiro.version}</version>
</dependency>
<!-- 添加shiro web支持 -->
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-web</artifactId>
<version>${shiro.version}</version>
</dependency>
<!--**********junit**********-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<!--**********servlet**********-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>${servlet.version}</version>
<scope>provided</scope>
</dependency>
<!-- ********************** 日誌配置 ********************** -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>${slf4j.version}</version>
<scope>runtime</scope>
<exclusions>
<exclusion>
<artifactId>slf4j-api</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<!--2) 用於與slf4j保持橋接-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>${log4j2.version}</version>
<exclusions>
<exclusion>
<artifactId>slf4j-api</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<!--3) 核心log4j2jar包-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>${log4j2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>${log4j2.version}</version>
</dependency>
<!--4) web工程需要包含log4j-web,非web工程不需要-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-web</artifactId>
<version>${log4j2.version}</version>
<scope>runtime</scope>
</dependency>
<!--5) 需要使用log4j2的AsyncLogger需要包含disruptor-->
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>${log4j2.disruptor.version}</version>
</dependency>
</dependencies>
<build>
<finalName>shiro01</finalName>
<resources>
<!--解決mybatis-generator-maven-plugin運行時沒有將XxxMapper.xml文件放入target文件夾的問題 -->
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
<!--解決mybatis-generator-maven-plugin運行時沒有將jdbc.properites文件放入target文件夾的問題-->
<resource>
<directory>src/main/resources</directory>
<includes>
<include>*.properties</include>
<include>*.xml</include>
<include>*.ini</include>
</includes>
</resource>
</resources>
<pluginManagement>
<!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
<plugins>
<!-- 編碼和編譯和JDK版本 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven.compiler.plugin.version}</version>
<configuration>
<source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target>
<encoding>${project.build.sourceEncoding}</encoding>
</configuration>
</plugin>
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
</plugin>
<plugin>
<artifactId>maven-war-plugin</artifactId>
<version>3.2.2</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>2.5.2</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
靜態資源文件 shiro.ini
用戶的登錄和密碼
[users]
zs=123
ls=456
ww=789
Shiro的認證初體驗
1、讀取ini數據源文件,得到securitymanager工廠
2、獲取securitymanager實例
3、將securitymanager交給securityutil進行管理
4、通過securityutil獲取登入用戶主體subject
5、創建登入令牌token
6、利用主體subject進行登入
7、退出也使用subject
demo01.java
這裏我們是手動添加的資源文件,交給工具類和subject對象
package com.hu.shiro;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.config.IniSecurityManagerFactory;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.subject.Subject;
/**
* @author hu
* @site www.huguiyun.xzy
* @company xxx公司
* @create 2019-10-12 20:12
*/
public class Demo01 {
public static void main(String[] args) {
/*
* 1.獲取到安全管理器工廠 securityManagerFactory
* 2.獲取到安全管理器
* 3.將安全管理交給securityutil工具類
* 4.從securityutil中獲取subject
* 5.通過subject主體做登錄註冊
* 6.處理登錄結果(成功?失敗)
* */
IniSecurityManagerFactory factory = new IniSecurityManagerFactory("classpath:shiro.ini");
//拿到安全管理器
SecurityManager securityManager = factory.getInstance();
//將安全管理交給securityutil工具類管理
SecurityUtils.setSecurityManager(securityManager);
//從securityutil中獲取subject
Subject subject = SecurityUtils.getSubject();
System.out.println(subject);
//模擬接受到了jsp從前端jsp傳遞過來的值
String uname = "zs";
String pwd = "123";
UsernamePasswordToken token = new UsernamePasswordToken(uname, pwd);
System.out.println("令牌:"+token);
try {
subject.login(token);
System.out.println("登錄成功");
}catch (Exception e){
System.out.println("登錄失敗!!");
}
}
}
3、Shiro與web容器的集成
Shiro與web容器的集成
預先準備好的jsp
集成測試步驟:
1、準本一個shiro-web.ini文件
2、通過web.xml將shiro與web容器進行集成
3、編寫servlet
4、測試
shiro-web.ini
[main]
#定義身份認證失敗後的請求url映射,loginUrl是身份認證過濾器中的一個屬性
authc.loginUrl=/login
#定義角色認證失敗後的請求url映射,unauthorizedUrl是角色認證過濾器中的一個屬性
roles.unauthorizedUrl=/unauthorized.jsp
#定義權限認證失敗後請求url映射,unauthorizedUrl是角色認證過濾器中的一個屬性
perms.unauthorizedUrl=/unauthorized.jsp
[users]
zs=123,role1
ls=123,role2
ww=123,role3
zdm=123,admin
[roles]
role1=user:create
role2=user:create,user:update
role3=user:create,user:update,user:delete,user:view,user:load
admin=user:*
#定義請求的地址需要做什麼驗證
[urls]
#請求login的時候不需要權限,遊客身份即可(anon)
/login.do=anon
#請求/user/updatePwd.jsp的時候,需要身份認證(authc)
/user/updatePwd.jsp=authc
#請求/admin的時候,需要角色認證,必須是擁有admin角色的用戶纔行
/admin/*.jsp=roles[admin]
#請求/teacher的時候,需要權限認證,必須是擁有user:create權限的角色的用戶纔行
/user/teacher.jsp=perms["user:update"]
Web.xml
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<display-name>Archetype Created Web Application</display-name>
<context-param>
<param-name>shiroConfigLocations</param-name>
<param-value>classpath:shiro-web.ini</param-value>
</context-param>
<listener>
<listener-class>org.apache.shiro.web.env.EnvironmentLoaderListener</listener-class>
</listener>
<filter>
<filter-name>ShiroFilter</filter-name>
<filter-class>org.apache.shiro.web.servlet.ShiroFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>ShiroFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
LoginServlet.java
package com.hu.shiro;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.subject.Subject;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* @author hu
* @site www.huguiyun.xzy
* @company xxx公司
* @create 2019-10-12 20:39
*/
@WebServlet("/login")
public class LoginServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
Subject subject = SecurityUtils.getSubject();
String uname = req.getParameter("username");
String pwd = req.getParameter("password");
UsernamePasswordToken token = new UsernamePasswordToken(uname, pwd);
try {
subject.login(token);
req.setAttribute("username",uname);
req.getRequestDispatcher("main.jsp").forward(req,resp);
}catch (Exception e){
req.setAttribute("message","用戶名或者密碼錯誤!!");
req.getRequestDispatcher("login.jsp").forward(req,resp);
}
}
}
LogoutServlet.java
package com.hu.shiro;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.subject.Subject;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* @author hu
* @site www.huguiyun.xzy
* @company xxx公司
* @create 2019-10-12 20:39
*/
@WebServlet("/logout")
public class LogOutServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
Subject subject = SecurityUtils.getSubject();
subject.logout();
resp.sendRedirect("login.jsp");
}
}
導入前面準備好的jsp頁面進行測試
測試一下幾點
1、身份認證成功與失敗的結果
2、角色認證成功與失敗的結果
3、權限認證成功與失敗的結果