1. 程式人生 > >採用shiro實現登入認證與許可權授權管理

採用shiro實現登入認證與許可權授權管理

Shiro Shiro 是一個 Apache 下的一開源專案專案,旨在簡化身份驗證和授權。

本文中記錄的是一次使用shiro實現登入認證與許可權授權的過程。

本文中主要用的技術有:

spring,springMVC,maven,shiro

shiro的配置,通過maven加入shiro相關jar包

	<!-- shiro -->
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-core</artifactId>
			<version>1.2.1</version>
		</dependency>
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-web</artifactId>
			<version>1.2.1</version>
		</dependency>
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-ehcache</artifactId>
			<version>1.2.1</version>
		</dependency>
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-spring</artifactId>
			<version>1.2.1</version>
		</dependency>

2 在web.xml中新增shiro過濾器

<?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/j2ee" xmlns:javaee="http://java.sun.com/xml/ns/javaee"
	xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
	id="WebApp_ID" version="2.4">

	<!-- 配置spring容器監聽器 -->
<span style="color:#ff6666;">	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath:application-context-*.xml</param-value>
	</context-param>
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener></span>
	<!-- post亂碼處理 -->
	<filter>
		<filter-name>CharacterEncodingFilter</filter-name>
		<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
		<init-param>
			<param-name>encoding</param-name>
			<param-value>utf-8</param-value>
		</init-param>
	</filter>
	<filter-mapping>
		<filter-name>CharacterEncodingFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>
	<!-- 配置shiro的核心攔截器 -->
<span style="white-space:pre">	</span><filter>
		<filter-name>shiroFilter</filter-name>
		<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>shiroFilter</filter-name>
		<url-pattern>/admin/*</url-pattern>
	</filter-mapping>
	<!-- 配置後臺Springmvc 它攔截.do結尾的請求 -->
	<servlet>
		<servlet-name>back</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>
	</servlet>
	<servlet-mapping>
		<servlet-name>back</servlet-name>
		<url-pattern>*.do</url-pattern>
	</servlet-mapping>
	<display-name>Archetype Created Web Application</display-name>
</web-app>

3 spring中對shiro配置

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

	<!-- web.xml中shiro的filter對應的bean -->
	<bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">
		<!-- 管理器,必須設定 -->
		<property name="securityManager" ref="securityManager" />
		<!-- 攔截到,跳轉到的地址,通過此地址去認證 -->
		<property name="loginUrl" value="/admin/login.do" />
		<!-- 認證成功統一跳轉到/admin/index.do,建議不配置,shiro認證成功自動到上一個請求路徑 -->
		<property name="successUrl" value="/admin/index.do" />
		<!-- 通過unauthorizedUrl指定沒有許可權操作時跳轉頁面 -->
		<property name="unauthorizedUrl" value="/refuse.jsp" />
		<!-- 自定義filter,可用來更改預設的表單名稱配置 -->
		<property name="filters">
			<map>
				<!-- 將自定義 的FormAuthenticationFilter注入shiroFilter中 -->
				<entry key="authc" value-ref="formAuthenticationFilter" />
			</map>
		</property>
		<property name="filterChainDefinitions">
			<value>
				<!-- 對靜態資源設定匿名訪問 -->
				/images/** = anon
				/js/** = anon
				/styles/** = anon
				<!-- 驗證碼,可匿名訪問 -->
				/validatecode.jsp = anon
				<!-- 請求 logout.do地址,shiro去清除session -->
				/admin/logout.do = logout
				<!--商品查詢需要商品查詢許可權 ,取消url攔截配置,使用註解授權方式 -->
				<!-- /items/queryItems.action = perms[item:query] /items/editItems.action 
					= perms[item:edit] -->
				<!-- 配置記住我或認證通過可以訪問的地址 -->
				/welcome.jsp = user
				/admin/index.do = user
				<!-- /** = authc 所有url都必須認證通過才可以訪問 -->
				/** = authc
			</value>
		</property>
	</bean>

	<!-- securityManager安全管理器 -->
	<bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">
		<property name="realm" ref="customRealm" />
		<!-- 注入快取管理器 -->
		<property name="cacheManager" ref="cacheManager" />
		<!-- 注入session管理器 -->
		<!-- <property name="sessionManager" ref="sessionManager" /> -->
		<!-- 記住我 -->
		<property name="rememberMeManager" ref="rememberMeManager" />
	</bean>

	<!-- 自定義realm -->
	<bean id="customRealm" class="com.zhijianj.stucheck.shiro.CustomRealm">
		<!-- 將憑證匹配器設定到realm中,realm按照憑證匹配器的要求進行雜湊 -->
		<!-- <property name="credentialsMatcher" ref="credentialsMatcher" /> -->
	</bean>

	<!-- 憑證匹配器 -->
	<bean id="credentialsMatcher"
		class="org.apache.shiro.authc.credential.HashedCredentialsMatcher">
		<!-- 選用MD5雜湊演算法 -->
		<property name="hashAlgorithmName" value="md5" />
		<!-- 進行一次加密 -->
		<property name="hashIterations" value="1" />
	</bean>

	<!-- 自定義form認證過慮器 -->
	<!-- 基於Form表單的身份驗證過濾器,不配置將也會註冊此過慮器,表單中的使用者賬號、密碼及loginurl將採用預設值,建議配置 -->
	<!-- 可通過此配置,判斷驗證碼 -->
	<bean id="formAuthenticationFilter"
		class="com.zhijianj.stucheck.shiro.CustomFormAuthenticationFilter ">
		<!-- 表單中賬號的input名稱,預設為username -->
		<property name="usernameParam" value="username" />
		<!-- 表單中密碼的input名稱,預設為password -->
		<property name="passwordParam" value="password" />
		<!-- 記住我input的名稱,預設為rememberMe -->
		<property name="rememberMeParam" value="rememberMe" />
	</bean>
	<!-- 會話管理器 -->
	<bean id="sessionManager"
		class="org.apache.shiro.web.session.mgt.DefaultWebSessionManager">
		<!-- session的失效時長,單位毫秒 -->
		<property name="globalSessionTimeout" value="600000" />
		<!-- 刪除失效的session -->
		<property name="deleteInvalidSessions" value="true" />
	</bean>
	<!-- 快取管理器 -->
	<bean id="cacheManager" class="org.apache.shiro.cache.ehcache.EhCacheManager">
		<property name="cacheManagerConfigFile" value="classpath:shiro-ehcache.xml" />
	</bean>
	<!-- rememberMeManager管理器,寫cookie,取出cookie生成使用者資訊 -->
	<bean id="rememberMeManager" class="org.apache.shiro.web.mgt.CookieRememberMeManager">
		<property name="cookie" ref="rememberMeCookie" />
	</bean>
	<!-- 記住我cookie -->
	<bean id="rememberMeCookie" class="org.apache.shiro.web.servlet.SimpleCookie">
		<!-- rememberMe是cookie的名字 -->
		<constructor-arg value="rememberMe" />
		<!-- 記住我cookie生效時間30天 -->
		<property name="maxAge" value="2592000" />
	</bean>
</beans>
在上面的配置中每次開啟了sessionManager都會出問題在這裡將它註釋掉了。

其次,上面中的配置也是將credentialsMatcher沒有加入了,這種方式適用於沒有對密碼進行處理的情況。

其中CustomRealm的配置是重點。

4 自定義Realm編碼

CustomRealm如下:

public class CustomRealm extends AuthorizingRealm {
	// 設定realm的名稱
	@Override
	public void setName(String name) {
		super.setName("customRealm");
	}

	@Autowired
	private AdminUserService adminUserService;

	/**
	 * 認證
	 */
	@Override
	protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {

		// token中包含使用者輸入的使用者名稱和密碼
		// 第一步從token中取出使用者名稱
		String userName = (String) token.getPrincipal();
		// 第二步:根據使用者輸入的userCode從資料庫查詢
		TAdminUser adminUser = adminUserService.getAdminUserByUserName(userName);
		// 如果查詢不到返回null
		if (adminUser == null) {//
			return null;
		}
		// 獲取資料庫中的密碼
		String password = adminUser.getPassword();
		/**
		 * 認證的使用者,正確的密碼
		 */
		AuthenticationInfo authcInfo = new SimpleAuthenticationInfo(adminUser, password, this.getName());
               //MD5 加密+加鹽+多次加密
//<span style="color:#ff0000;">SimpleAuthenticationInfo authcInfo = new SimpleAuthenticationInfo(adminUser, password,ByteSource.Util.bytes(salt), this.getName());</span>
		return authcInfo;
	}

	/**
	 * 授權,只有成功通過<span style="font-family: Arial, Helvetica, sans-serif;">doGetAuthenticationInfo方法的認證後才會執行。</span>
	 */
	@Override
	protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
		// 從 principals獲取主身份資訊
		// 將getPrimaryPrincipal方法返回值轉為真實身份型別(在上邊的doGetAuthenticationInfo認證通過填充到SimpleAuthenticationInfo中身份型別),
		TAdminUser activeUser = (TAdminUser) principals.getPrimaryPrincipal();
		// 根據身份資訊獲取許可權資訊
		// 從資料庫獲取到許可權資料
		TAdminRole adminRoles = adminUserService.getAdminRoles(activeUser);
		// 單獨定一個集合物件
		List<String> permissions = new ArrayList<String>();
		if (adminRoles != null) {
			permissions.add(adminRoles.getRoleKey());
		}
		// 查到許可權資料,返回授權資訊(要包括 上邊的permissions)
		SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo();
		// 將上邊查詢到授權資訊填充到simpleAuthorizationInfo物件中
		simpleAuthorizationInfo.addStringPermissions(permissions);
		return simpleAuthorizationInfo;
	}

	// 清除快取
	public void clearCached() {
		PrincipalCollection principals = SecurityUtils.getSubject().getPrincipals();
		super.clearCache(principals);
	}
}

5 快取配置

ehcache.xml程式碼如下:

<ehcache updateCheck="false" name="shiroCache">
    <defaultCache
            maxElementsInMemory="10000"
            eternal="false"
            timeToIdleSeconds="120"
            timeToLiveSeconds="120"
            overflowToDisk="false"
            diskPersistent="false"
            diskExpiryThreadIntervalSeconds="120"
            />
</ehcache>
通過使用ehache中就避免第次都向伺服器傳送許可權授權(doGetAuthorizationInfo)的請求。

6.自定義表單編碼過濾器

CustomFormAuthenticationFilter程式碼,認證之前呼叫,可用於驗證碼校驗

public class CustomFormAuthenticationFilter extends FormAuthenticationFilter {
	// 原FormAuthenticationFilter的認證方法
	@Override
	protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {
		// 在這裡進行驗證碼的校驗

		// 從session獲取正確驗證碼
		HttpServletRequest httpServletRequest = (HttpServletRequest) request;
		HttpSession session = httpServletRequest.getSession();
		// 取出session的驗證碼(正確的驗證碼)
		String validateCode = (String) session.getAttribute("validateCode");

		// 取出頁面的驗證碼
		// 輸入的驗證和session中的驗證進行對比
		String randomcode = httpServletRequest.getParameter("randomcode");
		if (randomcode != null && validateCode != null && !randomcode.equals(validateCode)) {
			// 如果校驗失敗,將驗證碼錯誤失敗資訊,通過shiroLoginFailure設定到request中
			httpServletRequest.setAttribute("shiroLoginFailure", "randomCodeError");
			// 拒絕訪問,不再校驗賬號和密碼
			return true;
		}
		return super.onAccessDenied(request, response);
	}
}

在此符上驗證碼jsp介面的程式碼

validatecode.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ page import="java.util.Random"%>
<%@ page import="java.io.OutputStream"%>
<%@ page import="java.awt.Color"%>
<%@ page import="java.awt.Font"%>
<%@ page import="java.awt.Graphics"%>
<%@ page import="java.awt.image.BufferedImage"%>
<%@ page import="javax.imageio.ImageIO"%>
<%
	int width = 60;
	int height = 32;
	//create the image
	BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
	Graphics g = image.getGraphics();
	// set the background color
	g.setColor(new Color(0xDCDCDC));
	g.fillRect(0, 0, width, height);
	// draw the border
	g.setColor(Color.black);
	g.drawRect(0, 0, width - 1, height - 1);
	// create a random instance to generate the codes
	Random rdm = new Random();
	String hash1 = Integer.toHexString(rdm.nextInt());
	// make some confusion
	for (int i = 0; i < 50; i++) {
		int x = rdm.nextInt(width);
		int y = rdm.nextInt(height);
		g.drawOval(x, y, 0, 0);
	}
	// generate a random code
	String capstr = hash1.substring(0, 4);
	//將生成的驗證碼存入session
	session.setAttribute("validateCode", capstr);
	g.setColor(new Color(0, 100, 0));
	g.setFont(new Font("Candara", Font.BOLD, 24));
	g.drawString(capstr, 8, 24);
	g.dispose();
	//輸出圖片
	response.setContentType("image/jpeg");
	out.clear();
	out = pageContext.pushBody();
	OutputStream strm = response.getOutputStream();
	ImageIO.write(image, "jpeg", strm);
	strm.close();
%>


7.登入控制器方法

	/**
	 * 到登入介面
	 * 
	 * @return
	 * @throws Exception
	 */
	@RequestMapping("login.do")
	public String adminPage(HttpServletRequest request) throws Exception {
		// 如果登陸失敗從request中獲取認證異常資訊,shiroLoginFailure就是shiro異常類的全限定名
		String exceptionClassName = (String) request.getAttribute("shiroLoginFailure");
		// 根據shiro返回的異常類路徑判斷,丟擲指定異常資訊
		if (exceptionClassName != null) {
			if (UnknownAccountException.class.getName().equals(exceptionClassName)) {
				// 最終會拋給異常處理器
				throw new CustomJsonException("賬號不存在");
			} else if (IncorrectCredentialsException.class.getName().equals(exceptionClassName)) {
				throw new CustomJsonException("使用者名稱/密碼錯誤");
			} else if ("randomCodeError".equals(exceptionClassName)) {
				throw new CustomJsonException("驗證碼錯誤 ");
			} else {
				throw new Exception();// 最終在異常處理器生成未知錯誤
			}
		}
		// 此方法不處理登陸成功(認證成功),shiro認證成功會自動跳轉到上一個請求路徑
		// 登陸失敗還到login頁面
		return "admin/login";
	}

8.使用者回顯Controller

當用戶登入認證成功後,CustomRealm在呼叫完doGetAuthenticationInfo時,通過

	AuthenticationInfo authcInfo = new SimpleAuthenticationInfo(adminUser, password, this.getName());
		return authcInfo;
SimpleAuthenticationInfo構造引數的第一個引數傳入一個使用者的物件,之後,可通過Subject subject = SecurityUtils.getSubject();中的subject.getPrincipal()獲取到此物件。

所以需要回顯使用者資訊時,我這樣呼叫的

	@RequestMapping("index.do")
	public String index(Model model) {
		//從shiro的session中取activeUser
		Subject subject = SecurityUtils.getSubject();
		//取身份資訊
		TAdminUser adminUser = 	(TAdminUser) subject.getPrincipal();
		//通過model傳到頁面
		model.addAttribute("adminUser", adminUser);
		return "admin/index";
	}

9.在jsp頁面中控制權限

先引入shiro的標頭檔案

<!-- shiro頭引入 -->
<%@ taglib uri="http://shiro.apache.org/tags" prefix="shiro"%>

採用shiro標籤對許可權進行處理

<!-- 有curd許可權才顯示修改連結,沒有該 許可權不顯示,相當 於if(hasPermission(curd)) -->
				<shiro:hasPermission name="curd">
					<BR />
					我擁有超級的增刪改查許可權額
				</shiro:hasPermission>

10.在Controller控制權限

通過@RequiresPermissions註解,指定執行此controller中某個請求方法需要的許可權
@RequestMapping("/queryInfo.do")
	@RequiresPermissions("q")//執行需要"q"許可權
	public ModelAndView queryItems(HttpServletRequest request) throws Exception {

11.MD5加密加鹽處理

這裡以修改密碼為例,通過獲取新的密碼(明文)後通過MD5加密+加鹽+6次加密為例
@RequestMapping("updatePassword.do")
	@ResponseBody
	public String updateAdminUserPassword(String newPassword) {
		// 從shiro的session中取activeUser
		Subject subject = SecurityUtils.getSubject();
		// 取身份資訊
		TAdminUser adminUser = (TAdminUser) subject.getPrincipal();
		// 生成salt,隨機生成
		SecureRandomNumberGenerator secureRandomNumberGenerator = new SecureRandomNumberGenerator();
		String salt = secureRandomNumberGenerator.nextBytes().toHex();
		Md5Hash md5 = new Md5Hash(newPassword, salt, 6);
		String newMd5Password = md5.toHex();
		// 設定新密碼
		adminUser.setPassword(newMd5Password);
		// 設定鹽
		adminUser.setSalt(salt);
		adminUserService.updateAdminUserPassword(adminUser);
		return newPassword;
	}



ok!編碼完成後對此WEB程式跑一下,截圖符幾張:

當前使用者資訊和許可權資訊表截圖如下

系統管理員表:


許可權表:


管理員許可權關係中間表: