Shiro框架身份认证（二）

最新推荐文章于 2023-12-27 12:00:00 发布

caoyue_new

最新推荐文章于 2023-12-27 12:00:00 发布

阅读量353

点赞数

分类专栏： Shiro框架文章标签： shiro 框架

本文链接：https://blog.csdn.net/caoyue_new/article/details/75230760

版权

Shiro框架专栏收录该内容

7 篇文章 0 订阅

订阅专栏

在应用中谁能证明他就是他本人。一般提供如他们的身份ID一些标识信息来表明他就是他本人，如提供身份证，用户名/密码来证明。
在shiro中，用户需要提供principals （身份）和credentials（证明）给shiro，从而应用能验证用户身份：
principals：身份，即主体的标识属性，可以是任何东西，如用户名、邮箱等，唯一即可。一个主体可以有多个principals，但只有一个Primary principals，一般是用户名/密码/手机号。
credentials：证明/凭证，即只有主体知道的安全值，如密码/数字证书等。
最常见的principals和credentials组合就是用户名/密码了。接下来先进行一个基本的身份认证。

另外两个相关的概念是之前提到的Subject及Realm，分别是主体及验证主体的数据源。

一、环境准备

我们这里使用maven管理jar包。

<dependencies>
    <dependency>
        <groupId>junit</groupId>
         <artifactId>junit</artifactId>
         <version>4.9</version>
         <scope>test</scope>
       </dependency>
    <dependency>
        <groupId>commons-logging</groupId>
        <artifactId>commons-logging</artifactId>
        <version>1.2</version>
    </dependency>
    <dependency>
        <groupId>org.apache.shiro</groupId>
        <artifactId>shiro-core</artifactId>
        <version>1.4.0</version>
    </dependency>
</dependencies>

添加junit、common-logging及shiro-core依赖即可。

二、登陆/退出

首先准备一些用户身份/凭据（shiro.ini）

[users]
crystal=123
barry=123

测试用例

@Test
    public void testHelloworld() {
        //1、获取SecurityManager工厂，此处使用Ini配置文件初始化SecurityManager 
        @SuppressWarnings("deprecation")
        Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:chapter02/shiro.ini");
        //2、得到SecurityManager实例 并绑定给SecurityUtils  
        SecurityManager securityManager = factory.getInstance();
        SecurityUtils.setSecurityManager(securityManager);
        //3、得到Subject及创建用户名/密码身份验证Token（即用户身份/凭证）  
        Subject subject = SecurityUtils.getSubject();
        UsernamePasswordToken token = new UsernamePasswordToken("crystal", "123");
        try {  
            //4、登录，即身份验证  
            subject.login(token);  
        } catch (AuthenticationException e) {  
            //5、身份验证失败  
        }  
        Assert.assertEquals(true, subject.isAuthenticated()); //断言用户已经登录  
        //6、退出  
        subject.logout();   
        Assert.assertEquals(false, subject.isAuthenticated()); //断言用户已经退出
    }

获取SecurityManager并绑定到SecurityUtils，这是一个全局设置，设置一次即可；
通过SecurityUtils得到Subject，其会自动绑定到当前线程；如果在web环境在请求结束时需要解除绑定；然后获取身份验证的Token，如用户名/密码；
调用subject.login方法进行登录，其会自动委托给SecurityManager.login方法进行登录；
如果身份验证失败请捕获AuthenticationException或其子类，常见的如： DisabledAccountException（禁用的帐号）、LockedAccountException（锁定的帐号）、UnknownAccountException（错误的帐号）、ExcessiveAttemptsException（登录失败次数过多）、IncorrectCredentialsException （错误的凭证）、ExpiredCredentialsException（过期的凭证）等，具体请查看其继承关系；对于页面的错误消息展示，最好使用如“用户名/密码错误”而不是“用户名错误”/“密码错误”，防止一些恶意用户非法扫描帐号库；
最后可以调用subject.logout退出，其会自动委托给SecurityManager.logout方法退出。

如上测试的几个问题：

用户名/密码硬编码在ini配置文件，以后需要改成如数据库存储，且密码需要加密存储；
用户身份Token可能不仅仅是用户名/密码，也可能还有其他的，如登录时允许用户名/邮箱/手机号同时登录。

三、身份认证流程

这里写图片描述
流程如下：

首先调用Subject.login(token)进行登录，其会自动委托给Security Manager，调用之前必须通过SecurityUtils. setSecurityManager()设置；
SecurityManager负责真正的身份验证逻辑；它会委托给Authenticator进行身份验证；
Authenticator才是真正的身份验证者，Shiro API中核心的身份认证入口点，此处可以自定义插入自己的实现；
Authenticator可能会委托给相应的AuthenticationStrategy进行多Realm身份验证，默认ModularRealmAuthenticator会调用AuthenticationStrategy进行多Realm身份验证；
Authenticator会把相应的token传入Realm，从Realm获取身份验证信息，如果没有返回/抛出异常表示身份验证失败了。此处可以配置多个Realm，将按照相应的顺序及策略进行访问。

四、Realm

Realm：域，Shiro从从Realm获取安全数据（如用户、角色、权限），就是说SecurityManager要验证用户身份，那么它需要从Realm获取相应的用户进行比较以确定用户身份是否合法；也需要从Realm得到用户相应的角色/权限进行验证用户是否能进行操作；可以把Realm看成DataSource，即安全数据源。如我们之前的ini配置方式将使用org.apache.shiro.realm.text.IniRealm。
Realm接口如下：

String getName(); //返回一个唯一的Realm名字  
boolean supports(AuthenticationToken token); //判断此Realm是否支持此Token  
AuthenticationInfo getAuthenticationInfo(AuthenticationToken token) throws AuthenticationException;  //根据Token获取认证信息

4.1 单Realm配置

自定义Realm实现

package com.crystal.shiro.chapter02;

import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.IncorrectCredentialsException;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.authc.UnknownAccountException;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.realm.Realm;

public class MyRealm1 implements Realm {

    public AuthenticationInfo getAuthenticationInfo(AuthenticationToken token)
            throws AuthenticationException {
        String username = (String) token.getPrincipal();//取得用户名
        String password = new String((char[]) token.getCredentials());//取得密码
        if(!"crystal".equals(username)) {  
            throw new UnknownAccountException(); //如果用户名错误  
        }  
        if(!"123".equals(password)) {  
            throw new IncorrectCredentialsException(); //如果密码错误  
        }  
        //如果身份认证验证成功，返回一个AuthenticationInfo实现；
        return new SimpleAuthenticationInfo(username, password, getName());
    }

    public String getName() {
        return "myrealm1";
    }

    public boolean supports(AuthenticationToken token) {
        //仅支持UsernamePasswordToken类型的Token  
        return token instanceof UsernamePasswordToken;   
    }
}

ini配置文件指定自定义Realm实现(shiro-realm.ini)

#声明一个realm  
myRealm1=com.github.crystal.chapter02.realm.MyRealm1
#指定securityManager的realms实现  
securityManager.realms=$myRealm1

通过$name来引入之前的realm定义

测试用例参考上面的testHelloworld方法。

4.2 多Realm配置

ini配置文件（shiro-multi-realm.ini）

#声明一个realm  
myRealm1=com.github.crystal.chapter02.realm.MyRealm1
myRealm2=com.github.crystal.chapter02.realm.MyRealm2
#指定securityManager的realms实现  
securityManager.realms=$myRealm1,$myRealm2

securityManager会按照realms指定的顺序进行身份认证。此处我们使用显示指定顺序的方式指定了Realm的顺序，如果删除“securityManager.realms= $myRealm1,$ myRealm2”，那么securityManager会按照realm声明的顺序进行使用（即无需设置realms属性，其会自动发现），当我们显示指定realm后，其他没有指定realm将被忽略，如“securityManager.realms=$myRealm1”，那么myRealm2不会被自动设置进去。

4.3 Shiro默认的Realm

这里写图片描述
以后一般继承AuthorizingRealm（授权）即可；其继承了AuthenticatingRealm（即身份验证），而且也间接继承了CachingRealm（带有缓存实现）。其中主要默认实现如下：
org.apache.shiro.realm.text.IniRealm：[users]部分指定用户名/密码及其角色；[roles]部分指定角色即权限信息；
org.apache.shiro.realm.text.PropertiesRealm： user.username=password,role1,role2指定用户名/密码及其角色；role.role1=permission1,permission2指定角色及权限信息；
org.apache.shiro.realm.jdbc.JdbcRealm：通过sql查询相应的信息，如“select password from users where username = ?”获取用户密码，“select password, password_salt from users where username = ?”获取用户密码及盐；“select role_name from user_roles where username = ?”获取用户角色；“select permission from roles_permissions where role_name = ?”获取角色对应的权限信息；也可以调用相应的api进行自定义sql；

4.4 JDBC Realm使用

数据库及依赖

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.34</version>
    </dependency>  
    <dependency>  
        <groupId>com.alibaba</groupId>  
        <artifactId>druid</artifactId>  
        <version>0.2.23</version>  
    </dependency>

本文将使用mysql数据库及druid连接池；
2. 到数据库shiro下建三张表：users（用户名/密码）、user_roles（用户/角色）、roles_permissions（角色/权限）
3. ini配置（shiro-jdbc-realm.ini）

jdbcRealm=org.apache.shiro.realm.jdbc.JdbcRealm  
dataSource=com.alibaba.druid.pool.DruidDataSource  
dataSource.driverClassName=com.mysql.jdbc.Driver  
dataSource.url=jdbc:mysql://localhost:3306/shiro  
dataSource.username=root  
dataSource.password=12345
jdbcRealm.dataSource=$dataSource  
securityManager.realms=$jdbcRealm

测试代码同上，只需修改配置文件家在路径

4.5 Authenticator及AuthenticationStrategy

Authenticator的职责是验证用户帐号，是Shiro API中身份验证核心的入口点：

public interface Authenticator {
    public AuthenticationInfo authenticate(AuthenticationToken authenticationToken) throws AuthenticationException;
}

如果验证成功，将返回AuthenticationInfo验证信息；此信息中包含了身份及凭证；如果验证失败将抛出相应的AuthenticationException实现。

SecurityManager接口继承了Authenticator，另外还有一个ModularRealmAuthenticator实现，其委托给多个Realm进行验证，验证规则通过AuthenticationStrategy接口指定，默认提供的实现：
FirstSuccessfulStrategy：只要有一个Realm验证成功即可，只返回第一个Realm身份验证成功的认证信息，其他的忽略；
AtLeastOneSuccessfulStrategy：只要有一个Realm验证成功即可，和FirstSuccessfulStrategy不同，返回所有Realm身份验证成功的认证信息；
AllSuccessfulStrategy：所有Realm验证成功才算成功，且返回所有Realm身份验证成功的认证信息，如果有一个失败就失败了。

ModularRealmAuthenticator默认使用AtLeastOneSuccessfulStrategy策略。

假设我们有三个realm：
myRealm1：用户名/密码为crystal/123时成功，且返回身份/凭据为crystal/123；
myRealm2：用户名/密码为barry/123时成功，且返回身份/凭据为barry/123；
myRealm3：用户名/密码为crystal/123时成功，且返回身份/凭据为crystal@163.com/123，和myRealm1不同的是返回时的身份变了；

4.5.1 ini配置文件(shiro-authenticator-all-success.ini)

#指定securityManager的authenticator实现 
authenticator=org.apache.shiro.authc.pam.ModularRealmAuthenticator
securityManager.authenticator=$authenticator

#指定securityManager.authenticator的authenticationStrategy  
allSuccessfulStrategy=org.apache.shiro.authc.pam.AllSuccessfulStrategy
#securityManager.authenticator.authenticationStrategy=$authcStrategy
securityManager.authenticator.authenticationStrategy=$allSuccessfulStrategy 

myRealm1=com.github.crystal.chapter02.realm.MyRealm1
myRealm2=com.github.crystal.chapter02.realm.MyRealm2
myRealm3=com.github.crystal.chapter02.realm.MyRealm3
securityManager.realms=$myRealm1,$myRealm3

4.5.2 测试代码

通用化登录逻辑 com.github.crystal.chapter02.AuthenticatorTest

private void login(String configFile) {
    //1、获取SecurityManager工厂，此处使用Ini配置文件初始化SecurityManager  
    @SuppressWarnings("deprecation")
    Factory<SecurityManager> factory = new IniSecurityManagerFactory(configFile);  

    //2、得到SecurityManager实例 并绑定给SecurityUtils  
    SecurityManager securityManager = factory.getInstance();  
    SecurityUtils.setSecurityManager(securityManager);  

    //3、得到Subject及创建用户名/密码身份验证Token（即用户身份/凭证）  
    Subject subject = SecurityUtils.getSubject();  
    UsernamePasswordToken token = new UsernamePasswordToken("crystal", "123");  
    subject.login(token);  
}

2.测试AllSuccessfulStrategy成功

@Test
public void testAllSuccessfulStrategyWithSuccess() {
    login("classpath:chapter02/shiro-authenticator-all-success.ini");  
    Subject subject = SecurityUtils.getSubject();  

    //得到一个身份集合，其包含了Realm验证成功的身份信息  
    PrincipalCollection principalCollection = subject.getPrincipals();  
    System.out.println(principalCollection);
}

即PrincipalCollection包含了crystal和crystal@163.com身份信息。
其他测试代码参见shiro-learn

五、自定义AuthenticationStrategy实现

自定义AuthenticationStrategy需要继承AbstractAuthenticationStrategy，我们先来看一下AbstractAuthenticationStrategy类：

//在所有Realm验证之前调用  
AuthenticationInfo beforeAllAttempts(  
Collection<? extends Realm> realms, AuthenticationToken token)   
throws AuthenticationException;  
//在每个Realm之前调用  
AuthenticationInfo beforeAttempt(  
Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)   
throws AuthenticationException;  
//在每个Realm之后调用  
AuthenticationInfo afterAttempt(  
Realm realm, AuthenticationToken token,   
AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t)  
throws AuthenticationException;  
//在所有Realm之后调用  
AuthenticationInfo afterAllAttempts(  
AuthenticationToken token, AuthenticationInfo aggregate)   
throws AuthenticationException;

因为每个AuthenticationStrategy实例都是无状态的，所有每次都通过接口将相应的认证信息传入下一次流程；通过如上接口可以进行如合并/返回第一个验证成功的认证信息。
具体实现信息请参考com.github.crystal.chapter02.authenticator.strategy.AtLeastTwoAuthenticatorStrategy和com.github.crystal.chapter02.authenticator.strategy.OnlyOneAuthenticatorStrategy

参考：跟我学Shiro
Shiro官方文档
 例子位置