shiro採坑指南—基礎概念與實戰

說明

  代碼及部分相關資料根據慕課網Mark老師的視頻進行整理。java

  其餘資料:mysql

基礎概念

Authenticate/Authentication(認證)

  認證是指檢查用戶身份合法性,經過校驗用戶輸入的密碼是否正確,判斷用戶是否爲本人。git

  有幾個概念須要理解:github

  • Principals (主體標識)
    任何能夠惟一地肯定一個用戶的屬性均可以充當principal,例如:郵箱、手機號、用戶ID等,這些都是與用戶一一對應的,能夠惟一地肯定一個用戶。web

  • credentials (主體憑證)
    credentials是能確認用戶身份的東西,能夠是證書(Certificate),也能夠是密碼(password)。算法

  • token(令牌)
    這裏的token和api裏的token有一點兒差異,這裏token是principal和credential的結合體或者說容器。這裏先講一部分,剩下的放到"Subject"講解。sql

Authorize/Authorization(受權)

  shiro中的「受權」,更貼切說法是「鑑權」,即斷定用戶是否擁有某些權限,至於擁有該權限在業務上有何意義,則是由業務自己來決定。數據庫

  關於「受權」,shiro引入了兩種概念:apache

  • Role (角色)
    角色用來區分用戶的類別。角色與用戶間是多對多的關係,一個用戶能夠擁有多個角色,如Bob能夠同時是admin(管理員)和user(普通用戶)。api

  • Permission (權限)
    權限是對角色的具體的描述,用於說明角色在業務上的特殊性。如admin(管理員)能夠擁有user:delete(刪除用戶)、user:modify(修改用戶信息)等的權限。一樣的,角色與權限是多對多的數量關係。
    shiro權限能夠分級,使用":"分割,如delete、user:delete、user:info:delete。可使用"*"做通配符,例如能夠給admin賦予操做用戶的全部權限,能夠配置爲"user:*",這樣在受權時,isPermitted("user:123")、isPermitted("user:123:abc")都是返回true;若是配置爲"*:*:delete",想要返回true,則須要相似這樣的權限: isPermitted("123:abc:delete")、isPermitted("hello:321:delete")。

Subject(主體)

  Subject對象用於應用程序與shiro的相關組件進行交互,能夠把它看做應用程序中「用戶」的代理,也能夠將其視爲shiro中的「用戶」。譬如在一個應用中,User對象做爲業務上以及程序中的「用戶」,在實現shiro的認證和受權時,並不直接使用User對象與shiro組件進行交互,而是把User對象的信息(用戶名和密碼)交給Subject,Subject調用本身的方法,向shiro組件發起身份認證或受權。
  以下是Subject接口提供的方法,包括登陸(login)、退出(logout)、認證(isAuthenticated)、受權(checkPermission)等:



  接着上面繼續講Token,在圖片中能夠看到,login方法須要傳入一個AuthenticationToken類型參數,這是一個接口,點進去看是醬紫的:

這個接口有兩個方法,分別用來返回principal和credential。因而可知Token就是principal和credential的容器,用於Subject提交「登陸」請求時傳遞信息。
  須要提醒,Subject的這些方法調用SecurityManager進行實際上的認證和受權過程。Subject只是業務程序與SecurityManager通訊的門面。

SecurityManager

  顧名思義,SecurityManager是用來manage(管理)的,管理shiro認證受權的流程,管理shiro組件、管理shiro的一些數據、管理Session等等。
  以下是SecurityManager接口的繼承關係:


  SecurityManager繼承了Authorizer(受權)、Authenticator(認證)、和SessionManager(Session管理)。須要注意,此處Session是指Subject與SecurityManager通訊的Session,不能狹隘地理解爲WebSession。SecurityManager繼承了了這幾個接口後,又另外提供了login、logout和createSubject方法。

Realm(域)

  與Subject和SecurityManager同樣,Realm是shiro中的三大核心組件之一。Realm至關於DAO,用於獲取與用戶安全相關的數據(用戶密碼、角色、權限等)。當Subject發起認證和受權時,其實是調用其對應的SecurityManager的認證和受權的方法,而SecurityManager則又是調用Authenticator和Authorizer的方法,這兩個類,最後是經過Realm來獲取主體的認證和受權信息。
  shiro的認證和受權過程以下所示:


使用shiro的基本流程

shiro的使用實際上是比較簡單的,只要熟記這幾個步驟,而後在代碼中實現便可。
1. 建立Realm
  Realm是一個接口,其實現類有SimpleAccountRealm, IniRealm, JdbcRealm等,實際應用中通常須要自定義實現Realm,自定義的Realm一般繼承自抽象類AuthorizingRealm,這是一個比較完善的Realm,提供了認證和受權的方法。
2. 建立SecurityManager並配置環境
  配置SecurityManager環境其實是配置Realm、CacheManager、SessionManager等組件,最基本的要配置Realm,由於安全數據是經過Realm來獲取。用SecurityManager的setRealm(xxRealm)方法便可給SecurityManager設置Realm。能夠爲SecurityManager設置多個Realm。
3. 建立Subject
  可使用SecurityUtils建立Subject。SecurityUtils是一個抽象工具類,其提供了靜態方法getSubject(),用來建立一個與線程綁定的Subject。建立出來的Subject用ThreadContext類來存儲,該類也是一個抽象類,它包含一個Map<Object, Object>類型的ThreadLocal靜態變量,該變量存儲該線程對應的SecurityManager對象和Subject對象。在SecurityUtils調用getSubject方法時,其實是調用SecurityManager的CreateSubject()方法,既然如此,爲何還要經過SecurityUtils建立Subject?由於SecurityUtils不只僅建立了Subject還將其與當前線程綁定,並且,使用SecurityManager的CreateSubject()方法還要構建一個SubjectContext類型的參數。
4. Subject提交認證和受權
  Subject的login(Token token)方法能夠提交「登陸」(或者說認證),token就是待驗證的用戶信息(用戶名和密碼等)。登陸(認證)成功後,使用Subject的ckeckRole()、checkPermission等方法判斷主體是否擁有某些角色、權限,以達到受權的目的。再次提醒,Subject不實現實際上的認證和受權過程,而是交給SecurityManager處理。

shiro認證受權示例

  Realm用的是SimpleAccountRealm,SimpleAccountRealm直接把用戶認證數據存到實例中, SecurityManager使用DefaultSecurityManager, 使用SecurityUtils建立Subject, Token用UsernamePasswordToken。 用Junit進行測試。 maven依賴以下:

<!--單元測試-->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13-beta-3</version>
</dependency>
<!--shiro核心包-->
<dependency>
    <groupId>org.apache.shiro</groupId>
    <artifactId>shiro-core</artifactId>
    <version>1.4.0</version>
</dependency>

shiro認證示例

AuthenticationTest.java:

package com.lifeofcoding.shiro;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.SimpleAccountRealm;
import org.apache.shiro.subject.Subject;
import org.junit.Test;

public class AuthenticationTest {
    @Test
    public void testAuthentication(){
        //1.建立Realm並添加數據
        SimpleAccountRealm simpleAccountRealm = new SimpleAccountRealm();
        simpleAccountRealm.addAccount("java","123");

        //2.建立SecurityManager並配置環境
        DefaultSecurityManager defaultSecurityManager = new DefaultSecurityManager();
        defaultSecurityManager.setRealm(simpleAccountRealm);

        //3.建立subject
        SecurityUtils.setSecurityManager(defaultSecurityManager);
        Subject subject = SecurityUtils.getSubject();

        //4.Subject經過Token提交認證
        UsernamePasswordToken token = new UsernamePasswordToken("java","123");
        subject.login(token);

        //驗證認證狀況
        System.out.println("isAuthenticated: "+ subject.isAuthenticated());
        //退出登陸subject.logout();
    }
}

shiro受權示例

  SimpleAccountRealm添加用戶角色和權限的方法比較簡單,能夠本身琢磨。此處的Realm改用IniRealm,iniRealm須要編寫ini文件存儲用戶的信息,ini文件放在resource文件夾下。代碼以下:
AuthorizationTest.java

package com.lifeofcoding.shiro;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.text.IniRealm;
import org.apache.shiro.subject.Subject;
import org.junit.Test;
import java.util.ArrayList;

public class AuthorizationTest {
    @Test
    public void testAuthorization() {
        //1.建立Realm並添加數據
        IniRealm iniRealm = new IniRealm("classpath:UserData.ini");

        //2.建立SecurityManager並配置環境
        DefaultSecurityManager defaultSecurityManager = new DefaultSecurityManager();
        defaultSecurityManager.setRealm(iniRealm);

        //3.建立Subject
        SecurityUtils.setSecurityManager(defaultSecurityManager);
        Subject subject = SecurityUtils.getSubject();

        //4.主體提交認證
        UsernamePasswordToken token = new UsernamePasswordToken("java", "123");
        subject.login(token);

        /*如下爲受權的幾種方法*/
        //①.直接判斷是否有某權限,isPermitted方法返回boolean,不拋異常
        System.out.println("user:login isPermitted: " + subject.isPermitted("user:login"));

        //②.經過角色進行受權,方法有返回值,不拋異常
        subject.hasRole("user");//判斷主體是否有某角色
        subject.hasRoles(new ArrayList<String>() {//返回boolean數組,數組順序與參數Roles順序一致,接受List<String>參數
                             {
                                 add("admin");
                                 add("user");
                             }
                         });
        subject.hasAllRoles(new ArrayList<String>() {//返回一個boolean,Subject包含全部Roles時才返回true,接受Collection<String>參數
                               {
                                   add("admin");
                                   add("user");
                               }
                            });

        //③.經過角色受權,與上面大致相同,不過這裏的方法無返回值,受權失敗會拋出異常,需作好異常處理
        subject.checkRole("user");
        subject.checkRoles("user", "admin");//變參

        //④.經過權限受權,無返回值,受權失敗拋出異常
        subject.checkPermission("user:login");
        //ini文件配置了test角色擁有"prefix:*"權限,也就是全部以"prefix"開頭的權限
        subject.checkPermission("prefix:123:456:......");
        //ini文件配置了test角色擁有"*:*:suffix"權限,意味着其擁有全部以"suffix"結尾的,一共有三級的權限
        subject.checkPermission("1:2:suffix");
        subject.checkPermission("abc:123:suffix");
        subject.checkPermissions("user:login", "admin:login");//變參
        //subject.checkPermission(Permission permission); 須要Permission接口的實現類對象做參數
        //subject.checkPermissions(Collection<Permission> permissions);
    }
}

user.ini:

[users]
java = 123,user,admin,test
[roles]
user = user:login,user:modify
admin = user:delete,user:modify,admin:login
test = prefix:*,*:*:suffix
ini文件的Demo
[main]
# Objects and their properties are defined here,
# Such as the securityManager, Realms and anything
# else needed to build the SecurityManager
# 此處能夠用來配置shiro組件,不用編寫代碼,如:

##--CredentialsMatcher是用來設置加密的--##
hashedCredentialsMatcher = org.apache.shiro.authc.credential.HashedCredentialsMatcher
##--設置加密的算法--##
hashedCredentialsMatcher.hashAlgorithmName = MD5
##--設置加密次數--##
hashedCredentialsMatcher.hashIterations = 1
##--給Realm配置加密器的Matcher,"$"表引用--##
iniRealm.credentialsMatcher = $hashedCredentialsMatcher
##--配置SecurityManager--##
securityManager = com.xxx.xxxManager
securityManager.realm = $iniRealm

[users]
# The 'users' section is for simple deployments
# when you only need a small number of statically-defined
# set of User accounts.
# 此處是用戶信息,以及用戶與角色對應關係,格式爲 username=password,roleName1,roleName2,roleName3,……
Java=123,user,admin
Go=123
Python=123,user

[roles]
# The 'roles' section is for simple deployments
# when you only need a small number of statically-defined
# roles.
# 角色與權限對應關係,格式:rolename = permissionDefinition1, permissionDefinition2,……
user=user:delete,user:modify,user:login
admin=user:delete

[urls]
# The 'urls' section is used for url-based security
# in web applications.  We'll discuss this section in the
# Web documentation
#用於配置網頁過濾規則
/some/path = ssl, authc
/another/path = ssl, roles[admin]

下面介紹其餘的Realm


JdbcRealm

  JdbcRealm包含默認的數據庫查詢語句,直接使用便可,但要注意建立的表結構要跟查詢語句相對應。固然也能夠本身去自定義查詢語句和數據庫。
  mavern依賴:

<!--數據庫相關-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.15</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.6</version>
</dependency>

默認查詢語句

默認的查詢語句


默認的'users'表結構

默認的'user_roles'表結構

默認的'roles_permissions'表結構

數據庫sql語句


create database shiro;
use shiro;
SET FOREIGN_KEY_CHECKS=0;

DROP TABLE IF EXISTS roles_permissions;
CREATE TABLE roles_permissions (
id bigint(20) NOT NULL AUTO_INCREMENT,
role_name varchar(100) DEFAULT NULL,
permission varchar(100) DEFAULT NULL,
PRIMARY KEY (id),
UNIQUE KEY idx_roles_permissions (role_name,permission)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO roles_permissions VALUES (null,'admin','user:delete');

DROP TABLE IF EXISTS users;
CREATE TABLE users (
id bigint(20) NOT NULL AUTO_INCREMENT,
username varchar(100) DEFAULT NULL,
password varchar(100) DEFAULT NULL,
password_salt varchar(100) DEFAULT NULL,
PRIMARY KEY (id),
UNIQUE KEY idx_users_username (username)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

INSERT INTO users VALUES ('1', 'java', '123', null);

DROP TABLE IF EXISTS user_roles;
CREATE TABLE user_roles (
id bigint(20) NOT NULL AUTO_INCREMENT,
username varchar(100) DEFAULT NULL,
role_name varchar(100) DEFAULT NULL,
PRIMARY KEY (id),
UNIQUE KEY idx_user_roles (username,role_name)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

roles_permissionsroles_permissionsidrole_namepermissionididx_roles_permissionsrole_namepermissionroles_permissionsusersusersidusernamepasswordpassword_saltididx_users_usernameusernameusersuser_rolesuser_rolesidusernamerole_nameididx_user_rolesusernamerole_nameINSERT INTO user_roles VALUES (null,'java','admin');
user_roles

JdbcRealmTest.java:

package com.lifeofcoding.shiro;

import com.alibaba.druid.pool.DruidDataSource;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.jdbc.JdbcRealm;
import org.apache.shiro.subject.Subject;
import org.junit.Test;

public class JdbcRealmTest {

    DruidDataSource druidDataSource = new DruidDataSource();
    {
        druidDataSource.setUrl("jdbc:mysql://localhost:3306/shiro");
        druidDataSource.setUsername("root");
        druidDataSource.setPassword("0113");
    }

    @Test
    public void testJdbcRealm(){

        //1.建立Realm並添加數據
        JdbcRealm jdbcRealm = new JdbcRealm();
        jdbcRealm.setDataSource(druidDataSource);//配置數據源
        jdbcRealm.setPermissionsLookupEnabled(true);//設置容許查詢權限,不然checkPermission拋異常,默認值爲false

        //2.建立SecurityManager並配置環境
        DefaultSecurityManager defaultSecurityManager = new DefaultSecurityManager();
        defaultSecurityManager.setRealm(jdbcRealm);

        //3.建立subject
        SecurityUtils.setSecurityManager(defaultSecurityManager);
        Subject subject = SecurityUtils.getSubject();

        //4.Subject經過Token提交認證
        UsernamePasswordToken token = new UsernamePasswordToken("java","123");
        subject.login(token);//退出登陸subject.logout();

        //驗證認證與受權狀況
        System.out.println("isAuthenticated: "+ subject.isAuthenticated());
        subject.hasRole("admin");
        subject.checkPermission("user:delete");
    }
}

自定義查詢語句

自定義的查詢語句


自定義的'test_users'表結構

自定義的'test_user_roles'表結構

自定義的'test_roles_permissions'表結構

數據庫sql語句


DROP TABLE IF EXISTS test_users;
CREATE TABLE test_users (
user_name varchar(20) DEFAULT NULL,
password varchar(20) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO test_users VALUES('java','123');

DROP TABLE IF EXISTS test_user_roles;
CREATE TABLE test_user_roles (
user_name varchar(20) DEFAULT NULL,
role varchar(20) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO test_user_roles VALUES('java','admin');

DROP TABLE IF EXISTS test_roles_permissions;
CREATE TABLE test_roles_permissions (
role varchar(20) DEFAULT NULL,
permission varchar(20) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO test_roles_permissions VALUES('admin','user:delete');

MyJdbcRealmTest.java:

import com.alibaba.druid.pool.DruidDataSource;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.jdbc.JdbcRealm;
import org.apache.shiro.subject.Subject;
import org.junit.Test;

public class MyJdbcRealmTest {

    //從數據庫獲取對應用戶密碼實現認證
    protected static final String AUTHENTICATION_QUERY = "select password from test_users where user_name = ?";
    //從數據庫中獲取對應用戶的全部角色
    protected static final String USER_ROLES_QUERY = "select role from test_user_roles where user_name = ?";
    //從數據庫中獲取角色對應的全部權限
    protected static final String PERMISSIONS_QUERY = "select permission from test_roles_permissions where role = ?";

    DruidDataSource druidDataSource = new DruidDataSource();
    {
        druidDataSource.setUrl("jdbc:mysql://localhost:3306/shiro");
        druidDataSource.setUsername("root");
        druidDataSource.setPassword("0113");
    }

    @Test
    public void testMyJdbcRealm(){

        //1.建立Realm並設置數據庫查詢語句
        JdbcRealm jdbcRealm = new JdbcRealm();
        jdbcRealm.setDataSource(druidDataSource);//配置數據源
        jdbcRealm.setPermissionsLookupEnabled(true);//設置容許查詢權限,不然checkPermission拋異常,默認值爲false
        jdbcRealm.setAuthenticationQuery(AUTHENTICATION_QUERY);//設置用戶認證信息查詢語句
        jdbcRealm.setUserRolesQuery(USER_ROLES_QUERY);//設置用戶角色信息查詢語句
        jdbcRealm.setPermissionsQuery(PERMISSIONS_QUERY);//設置角色權限信息查詢語句

        //2.建立SecurityManager並配置環境
        DefaultSecurityManager defaultSecurityManager = new DefaultSecurityManager();
        defaultSecurityManager.setRealm(jdbcRealm);

        //3.建立subject
        SecurityUtils.setSecurityManager(defaultSecurityManager);
        Subject subject = SecurityUtils.getSubject();

        //4.Subject經過Token提交認證
        UsernamePasswordToken token = new UsernamePasswordToken("java","123");
        subject.login(token);//退出登陸subject.logout();

        //驗證認證與受權狀況
        System.out.println("isAuthenticated: "+ subject.isAuthenticated());
        subject.hasRole("admin");
        subject.checkPermission("user:delete");
    }
}

自定義Realm

  自定義Realm,能夠繼承抽象類AuthorizingRealm,實現其兩個方法——doGetAuthenticationInfo和doGetAuthorizationInfo,分別用來返回AuthenticationInfo(認證信息)和AuthorizationInfo(受權信息)。


如上所示,AuthenticationInfo包含principal和crendential,和token同樣,不一樣的是,前者是切切實實的在數據庫或其餘數據源中的數據,然後者是用戶輸入的,待校驗的數據。

AuthorizationInfo也是相似的,包含用戶的角色和權限信息。
能夠用SimpleAuthenticationInfo和SimpleAuthorizationInfo來實現這兩個方法:

@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
    //1.獲取主體中的用戶名
    String userName = (String) authenticationToken.getPrincipal();
    //2.經過用戶名獲取密碼,getPasswordByName自定義實現
    String password = getPasswordByUserName(userName);
    if(null == password){
        return null;
    }
    //構建AuthenticationInfo返回
    SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo(userName,password,"MyRealm");
    return authenticationInfo;
}

@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
    //1.獲取用戶名。principal爲Object類型,是用戶惟一標識,能夠是用戶名,用戶郵箱,數據庫主鍵等,能惟一肯定一個用戶的信息。
    String userName = (String) principalCollection.getPrimaryPrincipal();
    //2.獲取角色信息,getRoleByUserName自定義
    Set<String> roles = getRolesByUserName(userName);
    //3.獲取權限信息,getPermissionsByRole方法一樣自定義,也能夠經過用戶名查找權限信息
    Set<String> permissions = getPermissionsByUserName(userName);
    //4.構建認證信息並返回。
    SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo();
    simpleAuthorizationInfo.setStringPermissions(permissions);
    simpleAuthorizationInfo.setRoles(roles);
    return simpleAuthorizationInfo;
}

完整的,包含添加用戶功能的自定義Realm
MyRealm.java:

import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.util.CollectionUtils;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

public class MyRealm extends AuthorizingRealm {

    /**存儲用戶名和密碼*/
    protected final Map<String,String> userMap;
    /**存儲用戶及其對應的角色*/
    protected final Map<String, Set<String>> roleMap;
    /**存儲全部角色以及角色對應的權限*/
    protected final Map<String,Set<String>> permissionMap;

    {
        //設置Realm名
        super.setName("MyRealm")  ;
    }

    public MyRealm(){
        userMap = new ConcurrentHashMap<>(16);
        roleMap = new ConcurrentHashMap<>(16);
        permissionMap = new ConcurrentHashMap<>(16);
    }

    /**
     * 身份認證必須實現的方法
     * @param authenticationToken token
     * @return org.apache.shiro.authc.AuthenticationInfo
     */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        //1.獲取主體中的用戶名
        String userName = (String) authenticationToken.getPrincipal();
        //2.經過用戶名獲取密碼,getPasswordByName自定義實現
        String password = getPasswordByUserName(userName);
        if(null == password){
            return null;
        }
        //構建AuthenticationInfo返回
        SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo(userName,password,"MyRealm");
        return authenticationInfo;
    }

    /**
     * 用於受權
     * @return org.apache.shiro.authz.AuthorizationInfo
     */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        //1.獲取用戶名。principal爲Object類型,是用戶惟一標識,能夠是用戶名,用戶郵箱,數據庫主鍵等,能惟一肯定一個用戶的信息。
        String userName = (String) principalCollection.getPrimaryPrincipal();
        //2.獲取角色信息,getRoleByUserName自定義
        Set<String> roles = getRolesByUserName(userName);
        //3.獲取權限信息,getPermissionsByRole方法一樣自定義,也能夠經過用戶名查找權限信息
        Set<String> permissions = getPermissionsByUserName(userName);
        //4.構建認證信息並返回。
        SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo();
        simpleAuthorizationInfo.setStringPermissions(permissions);
        simpleAuthorizationInfo.setRoles(roles);
        return simpleAuthorizationInfo;
    }

    /**
     * 自定義部分,經過用戶名獲取權限信息
     * @return java.util.Set<java.lang.String>
     */
    private Set<String> getPermissionsByUserName(String userName) {
        //1.先經過用戶名獲取角色信息
        Set<String> roles = getRolesByUserName(userName);
        //2.經過角色信息獲取對應的權限
        Set<String> permissions = new HashSet<String>();
        //3.添加每一個角色對應的全部權限
        roles.forEach(role -> {
            if(null != permissionMap.get(role)) {
                permissions.addAll(permissionMap.get(role));
            }

        });
        return permissions;
    }

    /**
     * 自定義部分,經過用戶名獲取密碼,可改成數據庫操做
     * @param userName 用戶名
     * @return java.lang.String
     */
    private String getPasswordByUserName(String userName){
        return userMap.get(userName);
    }

    /**
     * 自定義部分,經過用戶名獲取角色信息,可改成數據庫操做
     * @param userName 用戶名
     * @return java.util.Set<java.lang.String>
     */
    private Set<String> getRolesByUserName(String userName){
        return roleMap.get(userName);
    }

    /**
     * 往realm添加帳號信息,變參不傳值會接收到長度爲0的數組。
     */
    public void addAccount(String userName,String password) throws UserExistException{
        addAccount(userName,password,(String[]) null);
    }

    /**
     * 往realm添加帳號信息
     * @param userName 用戶名
     * @param password 密碼
     * @param roles 角色(變參)
     */
    public void addAccount(String userName,String password,String... roles) throws UserExistException{
        if( null != userMap.get(userName) ){
            throw new UserExistException("user \""+ userName +" \" exists");
        }
        userMap.put(userName, password);
        roleMap.put(userName, CollectionUtils.asSet(roles));
    }

    /**
     * 從realm刪除帳號信息
     * @param userName 用戶名
     */
    public void delAccount(String userName){
        userMap.remove(userName);
        roleMap.remove(userName);
    }

    /**
     * 添加角色權限,變參不傳值會接收到長度爲0的數組。
     * @param roleName 角色名
     */
    public void addPermission(String roleName,String...permissions){
        permissionMap.put(roleName,CollectionUtils.asSet(permissions));
    }

    /**用戶已存在異常*/
    public class UserExistException extends Exception{
        public UserExistException(String message){super(message);}
    }
}

測試代碼
MyRealmTest.java:

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.subject.Subject;
import org.junit.Test;

public class MyRealmTest {

    @Test
    public void testMyRealm(){

        //1.建立Realm並添加數據
        MyRealm myRealm = new MyRealm();
        try {
            myRealm.addAccount("java", "123", "admin");
        }catch (Exception e){
            e.printStackTrace();
        }
        myRealm.addPermission("admin","user:delete");

        //2.建立SecurityManager並配置環境
        DefaultSecurityManager defaultSecurityManager = new DefaultSecurityManager();
        defaultSecurityManager.setRealm(myRealm);

        //3.建立subject
        SecurityUtils.setSecurityManager(defaultSecurityManager);
        Subject subject = SecurityUtils.getSubject();

        //4.Subject經過Token提交認證
        UsernamePasswordToken token = new UsernamePasswordToken("java","123");
        subject.login(token);//退出登陸subject.logout();

        //驗證認證與受權狀況
        System.out.println("isAuthenticated: "+ subject.isAuthenticated());
        subject.hasRole("admin");
        subject.checkPermission("user:delete");
    }
}

加密

  使用加密,只須要在Realm返回的AuthenticationInfo添加用戶密碼對應的鹽值:

@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
    //1.獲取主體中的用戶名
    String userName = (String) authenticationToken.getPrincipal();
    //2.經過用戶名獲取密碼,getPasswordByName自定義實現
    String password = getPasswordByUserName(userName);
    if(null == password){
        return null;
    }
    //3.構建authenticationInfo認證信息
    SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo(userName,password,"MyRealm");
    //設置鹽值
    String salt = getSaltByUserName(userName);
    authenticationInfo.setCredentialsSalt(ByteSource.Util.bytes(salt));
    return authenticationInfo;
}

  而且在測試代碼中給Realm設置加密:

//設置加密
HashedCredentialsMatcher matcher = new HashedCredentialsMatcher();
matcher.setHashAlgorithmName("MD5");//設置加密算法
matcher.setHashIterations(3);//設置加密次數
myEncryptedRealm.setCredentialsMatcher(matcher);


  CredentialMatcher用來匹配用戶密碼。shiro經過Realm獲取AuthenticationInfo,AuthenticationInfo裏面包含該用戶的principal、credential、salt。principal就是用戶名或手機號或其餘,credential就是密碼(加鹽加密後,存到數據源中的密碼),salt就是密碼對應的「鹽」。shiro獲取到這些信息以後,利用CredentialMatcher中配置的信息(加密算法,加密次數等),對token中用戶輸入的、待校驗的密碼,進行加鹽加密,而後比對結果是否和AuthenticationInfo中的credential一致,若一致,則用戶經過認證。
  「加密」算法通常用的是hash算法,hash算法並非用來加密的,而是用來生成信息摘要,該過程是不可逆的,不能從結果逆推得出用戶的密碼的原文。下文這一段話也是相對於hash算法而言,其餘算法不在考慮範圍內。shiro的CredentialMatcher並無「解密」這個概念,由於不能解密,不能把數據庫中「加密」後的密碼還原,只能對用戶輸入的密碼,進行一次相同的「加密」,而後比對數據庫的「加密」後的密碼,從而判斷用戶輸入的密碼是否正確。

  必要地,在存密碼時,要存儲加鹽加密後的密碼:

public void addAccount(String userName,String password,String... roles) throws UserExistException {
    if(null != userMap.get(userName)){
        throw new UserExistException("user \""+ userName +"\" exist");
    }
    //若是配置的加密次數大於0,則進行加密
    if(iterations > 0){
        //使用隨機數做爲密碼,可改成UUID或其它
        String salt = String.valueOf(Math.random()*10);
        saltMap.put(userName,salt);
        password = doHash(password, salt);
    }
    userMap.put(userName, password);
    roleMap.put(userName, CollectionUtils.asSet(roles));
}
MyEncryptedRealm.java
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.crypto.hash.SimpleHash;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.util.ByteSource;
import org.apache.shiro.util.CollectionUtils;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

public class MyEncryptedRealm extends AuthorizingRealm {

    /** 加密次數 */
    private int iterations;
    /** 算法名 */
    private String algorithmName;

    /** 存儲用戶名和密碼 */
    private final Map
   
   
   

  
   
  userMap; /** 存儲用戶及其對應的角色 */ private final Map 
 
   
     > roleMap; /** 存儲全部角色以及角色對應的權限 */ private final Map 
     
     
       > permissionMap; /** 存儲用戶鹽值 */ private Map 
      
        saltMap; { //設置Realm名 super.setName("MyRealm"); } public MyEncryptedRealm(){ this.iterations = 0; this.algorithmName = "MD5"; this.userMap = new ConcurrentHashMap<>(16); this.roleMap = new ConcurrentHashMap<>(16); this.permissionMap = new ConcurrentHashMap<>(16); this.saltMap = new ConcurrentHashMap<>(16); } /** * 身份認證必須實現的方法 * @param authenticationToken token * @return org.apache.shiro.authc.AuthenticationInfo */ @Override protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException { //1.獲取主體中的用戶名 String userName = (String) authenticationToken.getPrincipal(); //2.經過用戶名獲取密碼,getPasswordByName自定義實現 String password = getPasswordByUserName(userName); if(null == password){ return null; } //3.構建authenticationInfo認證信息 SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo(userName,password,"MyRealm"); //設置鹽值 String salt = getSaltByUserName(userName); authenticationInfo.setCredentialsSalt(ByteSource.Util.bytes(salt)); return authenticationInfo; } /** * 用於受權 * @return org.apache.shiro.authz.AuthorizationInfo */ @Override protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) { //1.獲取用戶名。principal爲Object類型,是用戶惟一憑證,能夠是用戶名,用戶郵箱,數據庫主鍵等,能惟一肯定一個用戶的信息。 String userName = (String) principalCollection.getPrimaryPrincipal(); //2.獲取角色信息,getRoleByUserName自定義 Set 
       
         roles = getRolesByUserName(userName); //3.獲取權限信息,getPermissionsByRole方法一樣自定義,也能夠經過用戶名查找權限信息 Set 
        
          permissions = getPermissionsByUserName(userName); //4.構建認證信息並返回。 SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo(); simpleAuthorizationInfo.setStringPermissions(permissions); simpleAuthorizationInfo.setRoles(roles); return simpleAuthorizationInfo; } /** * 自定義部分,經過用戶名獲取權限信息 * @return java.util.Set 
         
           */ private Set 
          
            getPermissionsByUserName(String userName) { //1.先經過用戶名獲取角色信息 Set 
           
             roles = getRolesByUserName(userName); //2.經過角色信息獲取對應的權限 Set 
            
              permissions = new HashSet<>(); //3.添加每一個角色對應的全部權限 roles.forEach(role -> { if (null != permissionMap.get(role)) { permissions.addAll(permissionMap.get(role)); } }); return permissions; } /** * 自定義部分,經過用戶名獲取密碼,可改成數據庫操做 * @return java.lang.String */ private String getPasswordByUserName(String userName){ return userMap.get(userName); } /** * 自定義部分,經過用戶名獲取角色信息,可改成數據庫操做 * @return java.util.Set 
             
               */ private Set 
              
                getRolesByUserName(String userName){ return roleMap.get(userName); } /** * 自定義部分,經過用戶名獲取鹽值,可改成數據庫操做 * @return java.util.Set 
               
                 */ private String getSaltByUserName(String userName) { return saltMap.get(userName); } /** * 往realm添加帳號信息,變參不傳值會接收到長度爲0的數組。 */ public void addAccount(String userName,String password) throws UserExistException { addAccount(userName,password,(String[]) null); } /** * 往realm添加帳號信息 */ public void addAccount(String userName,String password,String... roles) throws UserExistException { if(null != userMap.get(userName)){ throw new UserExistException("user \""+ userName +"\" exist"); } //若是配置的加密次數大於0,則進行加密 if(iterations > 0){ String salt = String.valueOf(Math.random()*10); saltMap.put(userName,salt); password = doHash(password, salt); } userMap.put(userName, password); roleMap.put(userName, CollectionUtils.asSet(roles)); } /** * 從realm刪除帳號信息 * @param userName 用戶名 */ public void deleteAccount(String userName){ userMap.remove(userName); roleMap.remove(userName); } /** * 添加角色權限,變參不傳值會接收到長度爲0的數組。 * @param roleName 角色名 */ public void addPermission(String roleName,String...permissions){ permissionMap.put(roleName, CollectionUtils.asSet(permissions)); } /** * 設置加密次數 * @param iterations 加密次數 */ public void setHashIterations(int iterations){ this.iterations = iterations; } /** * 設置算法名 * @param algorithmName 算法名 */ public void setAlgorithmName(String algorithmName){ this.algorithmName = algorithmName; } /** * 計算哈希值 * @param str 要進行"加密"的字符串 * @param salt 鹽 * @return String */ private String doHash(String str,String salt){ salt = null==salt ? "" : salt; return new SimpleHash(this.algorithmName,str,salt,this.iterations).toString(); } /** * 註冊時,用戶已存在的異常 */ public class UserExistException extends Exception{ public UserExistException(String message) {super(message);} } } 
                
               
              
             
            
           
          
         
        
       
      
     
    

  
MyEncryptedRealmTest.java
package com.lifeofcoding.shiro;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.authc.credential.HashedCredentialsMatcher;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.subject.Subject;
import org.junit.Test;

/**
 * @Classname MyEncryptionRealmTest
 * @Description TODO
 * @Date 2019-11-2019-11-20-17:41
 * @Created by yo
 */
public class MyEncryptedRealmTest {

    private MyEncryptedRealm myEncryptedRealm;

    @Test
    public void testShiroEncryption() {
        //1.建立Realm並添加數據
        MyEncryptedRealm myEncryptedRealm = new MyEncryptedRealm();
        myEncryptedRealm.setHashIterations(3);
        myEncryptedRealm.setAlgorithmName("MD5");
        try {
            myEncryptedRealm.addAccount("java", "123456", "admin");
        }catch (Exception e){
            e.printStackTrace();
        }
        myEncryptedRealm.addPermission("admin","user:create","user:delete");

        //2.建立SecurityManager對象
        DefaultSecurityManager defaultSecurityManager = new DefaultSecurityManager(myEncryptedRealm);

        //3.設置加密
        HashedCredentialsMatcher matcher = new HashedCredentialsMatcher();
        matcher.setHashAlgorithmName("MD5");//設置加密算法
        matcher.setHashIterations(3);//設置加密次數
        myEncryptedRealm.setCredentialsMatcher(matcher);

        //4.建立主體並提交認證
        SecurityUtils.setSecurityManager(defaultSecurityManager);
        Subject subject = SecurityUtils.getSubject();

        UsernamePasswordToken token = new UsernamePasswordToken("java","123456");
        subject.login(token);
        System.out.println(subject.getPrincipal()+" isAuthenticated: "+subject.isAuthenticated());
        subject.checkRole("admin");
        subject.checkPermission("user:delete");
    }
}

文件傳送門

github地址

相關文章
相關標籤/搜索