Shiro学习笔记 (一)：身份验证

Shiro学习笔记（一）：身份验证

简介
身份验证
登录 / 退出
身份认证流程
Realm

单 Realm 配置
多 Realm 配置
Shiro 默认提供的 Realm
JDBC Realm 使用

Authenticator 及 AuthenticationStrategy

简介

Apache Shiro 是一个强大易用的 Java 安全框架，提供了认证、授权、加密和会话管理等功能，相对于其他安全框架，Shiro 要简单的多。

身份验证

用户需要提供 principals （身份）和 credentials（证明）给 shiro，从而应用能验证用户身份：
principals：身份，可以是任何东西，如用户名、邮箱等，唯一即可。一个主体可以有多个 principals，但只有一个 Primary principals。
credentials：证明，即只有主体知道的安全值，如密码 / 数字证书等。
最常见的 principals 和 credentials 组合就是用户名 / 密码了。
另外两个相关的概念 Subject 及 Realm，分别是主体(当前用户)及验证主体的数据源。

登录 / 退出

1、首先准备一些身份 / 证明（shiro.ini）

[users] 
zhang = 123
wang = 123

此处使用 ini 配置文件，通过 [users] 指定了两个主体：zhang/123、wang/123。

2、测试用例

@Test
public void testHelloworld() {
	//1、获取SecurityManager工厂，指定该工厂使用Ini配置文件去初始化SecurityManager  
	Factory<org.apache.shiro.mgt.SecurityManager> factory =new IniSecurityManagerFactory("classpath:shiro.ini");
	//2、得到SecurityManager实例
	org.apache.shiro.mgt.SecurityManager securityManager = factory.getInstance();
	//3、把SecurityManager实例绑定给SecurityUtils 
	SecurityUtils.setSecurityManager(securityManager);
	//4、得到Subject
	Subject subject = SecurityUtils.getSubject();
	//5、创建身份验证Token（即身份/证明）
	UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");
	try {
	//6、登录，即身份验证
		subject.login(token);
	} catch (AuthenticationException e) {
	//5、身份验证失败
	}
	//6、退出
	subject.logout();
}

首先通过 new IniSecurityManagerFactory 并指定一个 ini 配置文件来创建一个 SecurityManager 工厂。
接着获取 SecurityManager 并绑定到 SecurityUtils，这是一个全局设置，设置一次即可。
通过 SecurityUtils 得到 Subject，其会自动绑定到当前线程；如果在 web 环境在请求结束时需要解除绑定。
然后获取身份验证的 Token，如用户名 / 密码。
调用 subject.login 方法进行登录，其会自动委托给 SecurityManager.login 方法进行登录。
如果身份验证失败请捕获 AuthenticationException 或其子类，常见的如：

DisabledAccountException（禁用的帐号）
LockedAccountException（锁定的帐号）
UnknownAccountException（错误的帐号）
ExcessiveAttemptsException（登录失败次数过多）
IncorrectCredentialsException （错误的凭证）
ExpiredCredentialsException（过期的凭证）等，具体请查看其继承关系；

最后可以调用 subject.logout 退出，其会自动委托给 SecurityManager.logout 方法退出。

从如上代码可总结出身份验证的步骤：

收集用户身份 / 凭证调用 Subject.login 进行登录。
如果失败将得到相应的 AuthenticationException异常，根据异常提示用户错误信息；否则登录成功。
最后调用 Subject.logout 进行退出操作。

如上测试的几个问题：

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

身份认证流程

在这里插入图片描述
流程如下：

首先调用 Subject.login(token) 进行登录，其会自动委托给 SecurityManager。
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。
org.apache.shiro.realm.Realm 接口如下：

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

单 Realm 配置

1、自定义 Realm 实现：

public class MyRealm1 implements Realm {
    @Override
    public String getName() {
        return "myrealm1";
    }
    @Override
    public boolean supports(AuthenticationToken token) {
        //仅支持UsernamePasswordToken类型的Token
        return token instanceof UsernamePasswordToken; 
    }
    @Override
    public AuthenticationInfo getAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        String username = (String)token.getPrincipal();  //得到用户名
        String password = new String((char[])token.getCredentials()); //得到密码
        if(!"zhang".equals(username)) {
            throw new UnknownAccountException(); //如果用户名错误
        }
        if(!"123".equals(password)) {
            throw new IncorrectCredentialsException(); //如果密码错误
        }
        //如果身份认证验证成功，返回一个AuthenticationInfo实现；
        return new SimpleAuthenticationInfo(username, password, getName());
    }
}

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

//声明一个realm
myRealm=com.test.MyRealm
//指定securityManager的realms实现。$name 来引入之前的 realm 定义
securityManager.realms=$myRealm

3、测试用例参考之前的就可以。

多 Realm 配置

//声明realm
myRealm1=com.test.MyRealm1
myRealm2=com.test.MyRealm2
//指定securityManager的realms实现
securityManager.realms=$myRealm1,$myRealm2

Shiro 默认提供的 Realm

在这里插入图片描述

JDBC Realm 使用

1、数据库及依赖

<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.0.9</version>
</dependency>

2、到数据库 shiro 下建一张表：users（用户名，密码），并添加一个用户记录，用户名 / 密码为 zhang/123
3、ini 配置（shiro-jdbc-realm.ini）

//创建一个JdbcRealm实例
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=123456	//设置数据库密码
//设置JdbcRealm实例的数据源为上面的数据源
jdbcRealm.dataSource=$dataSource
//把JdbcRealm配置给securityManager
securityManager.realms=$jdbcRealm

变量名 = 全限定类名会自动创建一个类实例
变量名. 属性 = 值自动调用相应的 setter 方法进行赋值
$ 变量名引用之前的一个对象实例

Authenticator 及 AuthenticationStrategy

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

public AuthenticationInfo authenticate(AuthenticationToken authenticationToken) throws AuthenticationException;

如果验证成功，将返回 AuthenticationInfo 验证信息；此信息中包含了身份及凭证；如果验证失败将抛出相应的 AuthenticationException 实现。
SecurityManager 接口继承了 Authenticator。SecurityManager有一个 ModularRealmAuthenticator 实现，其委托给多个 Realm 进行验证，验证规则通过 AuthenticationStrategy 接口指定，默认提供的实现：

FirstSuccessfulStrategy：只要有一个 Realm 验证成功即可，只返回第一个 Realm 身份验证成功的认证信息，其他的忽略。
AtLeastOneSuccessfulStrategy：只要有一个 Realm 验证成功即可，和 FirstSuccessfulStrategy 不同，返回所有 Realm 身份验证成功的认证信息。
AllSuccessfulStrategy：所有 Realm 验证成功才算成功，且返回所有 Realm 身份验证成功的认证信息，如果有一个失败就失败了。

ModularRealmAuthenticator 默认使用 AtLeastOneSuccessfulStrategy 策略。
假设我们有三个 realm：

myRealm1：用户名 / 密码为 zhang/123 时成功，且返回身份 / 凭据为 zhang/123；
myRealm2：用户名 / 密码为 wang/123 时成功，且返回身份 / 凭据为 wang/123；
myRealm3：用户名 / 密码为 zhang/123 时成功，且返回身份 / 凭据为 [email protected]/123；

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=$allSuccessfulStrategy
//指定三个Realm
myRealm1=com.github.zhangkaitao.shiro.chapter2.realm.MyRealm1
myRealm2=com.github.zhangkaitao.shiro.chapter2.realm.MyRealm2
myRealm3=com.github.zhangkaitao.shiro.chapter2.realm.MyRealm3
securityManager.realms=$myRealm1,$myRealm3

2、测试代码（com.github.zhangkaitao.shiro.chapter2.AuthenticatorTest）

@Test
public void testHelloworld() {
	//1、获取SecurityManager工厂，指定该工厂使用Ini配置文件去初始化SecurityManager  
	Factory<org.apache.shiro.mgt.SecurityManager> factory =new IniSecurityManagerFactory("classpath:shiro-authenticator-all-success.ini");
	//2、得到SecurityManager实例
	org.apache.shiro.mgt.SecurityManager securityManager = factory.getInstance();
	//3、把SecurityManager实例绑定给SecurityUtils 
	SecurityUtils.setSecurityManager(securityManager);
	//4、得到Subject
	Subject subject = SecurityUtils.getSubject();
	//5、创建身份验证Token（即身份/证明）
	UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");
	try {
	//6、登录，即身份验证
		subject.login(token);
	//得到一个身份集合，其包含了Realm验证成功的身份信息
	 	PrincipalCollection principalCollection = subject.getPrincipals();
	    	System.out.println(principalCollection.toString());
	} catch (AuthenticationException e) {
	//5、身份验证失败
	}
	//6、退出
	subject.logout();
}

可以自定义 AuthenticationStrategy 实现，首先看其 API：

//在所有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;