您的位置: 首页  >  文章  >  SHIRO框架学习-2 身份验证

SHIRO框架学习-2 身份验证

分类: 文章 • 2023-04-08 11:16:15

一、涉及的概念：

在SHIRO中，用户需要提供principals（身份）和credentials（证明）给SHIRO，从而应用能验证用户身份。

Principals:身份，即主体的标识属性，可以是任何东西，如用户名、邮箱等，唯一即可。一个主体可以有多个principals，但只有一个Primary principals，一般为用户名/密码/手机号。

Credentials:证明/凭证，即只有主体知道的安全值，如密码/数字证书等。

相关的概念为Subject和Realm，分别是主体和验证主体的数据源。

二、环境依赖：

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

Maven构建代码：

<dependencies>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.9</version>
    </dependency>
    <dependency>
        <groupId>commons-logging</groupId>
        <artifactId>commons-logging<artifactId>
        <version>1.1.3</version>
    </dependency>
    <dependency>
        <groupId>org.apache.shiro</groupId>
        <artifactId>shiro-core</artifactId>
        <version>1.2.2</version>
    </dependency>
</dependencies>

三、登录/退出：

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

[users]

zhang=123

wang=123

此处使用ini配置文件，通过[users]指定了两个主体。

2.测试用例：

@Test
public void testHelloworld() {
    //1、获取SecurityManager工厂，此处使用ini配置文件初始化SecurityManager
    Factory<org.apache.shiro.mgt.SecurityManager> factory =
            new IniSecurityManagerFactory("classpath:shiro.ini");
    //2、得到SecurityManager实例 并绑定给SecurityUtils
    org.apache.shiro.mgt.SecurityManager securityManager = factory.getInstance();
    SecurityUtils.setSecurityManager(securityManager);
    //3、得到Subject及创建用户名/密码身份验证Token（即用户身份/凭证）
    Subject subject = SecurityUtils.getSubject();
    UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");

    try {
        //4、登录，即身份验证
        subject.login(token);
    } catch (AuthenticationException e) {
        //5、身份验证失败
    }

    Assert.assertEquals(true, subject.isAuthenticated()); //断言用户已经登录

    //6、退出
    subject.logout();
}

（1）首先通过new IniSecurityManangerFactory并指定一个ini配置文件来创建一个SecurityManager工厂；

（2）接着获取SecurityManager实例并绑定到SecurityUtils，这是一个全局设置，设置一次即可；

（3）通过SecurityUtils得到Subject，其会自动绑定到当前线程；如果在web环境在请求结束时需要解除绑定；

（4）然后获取身份验证的Token，如用户名/密码；

（5）调用subject.login方法进行登录，其会自动委托给SecurityManager.login方法进行登录；

（6）如果身份验证失败请捕获AuthenticationException或其子类，如DisabledAccountException（禁用的账号）、LockedAccoutException（锁定的账号）、UnknownAccoutException（错误的账号）、ExcessiveAttemptsException（登录失败次数过多）、IncorrectCredentialsException（错误的凭证）、ExpiredCredentialsException（过期的凭证）等。页面提示使用如“用户名/密码错误”而不是“用户名错误”或“密码错误”，防止恶意用户非法扫描账号库；

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

身份验证步骤总结：

1.收集用户身份/凭证

2.调用Subject.login进行登录，如果失败将得到相应的AuthenticationException异常，根据异常提示用户错误信息，否则登录成功。

3.最后调用Subject.logout进行退出操作。

如上测试存在的几个问题：

1、用户名/密码硬编码在ini配置文件，以后需要改成如数据库存储，且密码需要加密存储；

2、用户身份Token可能不仅仅是用户名/密码，也可能还有其他的，如登录时允许用户名/邮箱/手机号同时登录。

四、身份认证流程：

SHIRO框架学习-2 身份验证

流程如下：

1.首先调用Subject.login(token)进行登录，其会自动委托给SecurityManager，调用之前必须通过SecurityUtils.setSecurtiyManager()设置；

2.SecurityManager负责真正的身份验证逻辑；它会委托给Authenticator进行身份验证；

3.Authenticator才是真正的身份验证者，SHIRO API中核心的身份认证入口点，此处可以自定义插入自己的实现；

4.Authenticator可能会委托给AuthenticationStrategy进行多Realm身份验证，默认ModularRealmAuthenticator会调用AuthenticationStrategy进行多Realm身份验证；

5.Authenticator会把相应的token传入Realm，从Realm获取身份验证信息，如果没有返回/抛出异常表示身份验证失败了。此处可以配置多个Realm，将按照相应的顺序及策略进行访问。

五、Realm:

1.Realm:域，SHIRO从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获取认证信息

2.单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
myRealm1=com.github.zhangkaitao.shiro.chapter2.realm.MyRealm1

#指定securityManager的realms实现
securityManager.realms=$myRealm1

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

3.多Realm配置

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

[main]
#声明一个realm
myRealm1=com.github.zhangkaitao.shiro.chapter2.realm.MyRealm1
myRealm2=com.github.zhangkaitao.shiro.chapter2.realm.MyRealm2

#指定securityManager的realms实现
securityManager.realms=$myRealm1,$myRealm2

（2）认证顺序和范围：

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

4.SHIRO默认提供的Realm

SHIRO框架学习-2 身份验证

以后一般继承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；

5.JDBC Realm使用

（1）数据库及依赖 （采用mysql数据库和druid连接池）：

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

（2）数据库建表：

create table users (
  id bigint auto_increment,
  username varchar(100),
  password varchar(100),
  password_salt varchar(100),
  constraint pk_users primary key(id)
) charset=utf8 ENGINE=InnoDB;
create unique index idx_users_username on users(username);

create table user_roles(
  id bigint auto_increment,
  username varchar(100),
  role_name varchar(100),
  constraint pk_user_roles primary key(id)
) charset=utf8 ENGINE=InnoDB;
create unique index idx_user_roles on user_roles(username, role_name);

create table roles_permissions(
  id bigint auto_increment,
  role_name varchar(100),
  permission varchar(100),
  constraint pk_roles_permissions primary key(id)
) charset=utf8 ENGINE=InnoDB;
create unique index idx_roles_permissions on roles_permissions(role_name, permission);

insert into users(username,password)values('zhang','123');

（3）ini配置：

jdbcRealm = org.apache.shiro.realm.jdbc.JdbcRealm  //创建JdbcRealm类实例

dataSource = com.alibaba.druid.pool.DruidDataSource  //连接池

dataSource.driverClassName = com.mysql.jdbc.Driver   //数据库驱动

dataSource.url = jdbc:myssql://localhost:3306/shiro

dataSource.username = root

#dataSource.password = 123456

jdbcRealm.dataSource = $dataSource

securityManager.realms = $jdbcRealm

①变量名 = 全限定类名 → 会自动创建一个类实例

②变量名.属性 = 值 → 自动条用相应的setter方法进行赋值

③$变量名 → 引用之前的一个对象实例

6.Authenticator及AuthenticationStrategy（验证策略）

   Authenticator的职责是验证用户账号，是SHIRO API中身份验证的核心入口。

public AuthenticationInfo authenticate(AuthenticationToken authenticationToken)
            throws AuthenticationException;

（1）如果验证成功，将返回AuthenticationInfo验证信息；此信息中包含了身份及凭证；

（2）如果验证失败将抛出相应的 AuthenticationException实现。

SecurityManager接口继承了Authenticator，另外还有一个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，和myRealm1不同的是返回时的身份变了；

myRealm4： 用户名/密码为zhang/123时成功，且返回身份/凭据为zhang/123；和myRealm1只是Realm名字不同。

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

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

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

继承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实例都是无状态的，所有每次都通过接口将相应的认证信息传入下一次流程；通过如上接口可以进行如合并/返回第一个验证成功的认证信息。

自定义实现时一般继承org.apache.shiro.authc.pam.AbstractAuthenticationStrategy即可

AtLeastTwoAuthenticatorStrategy实现：

public class AtLeastTwoAuthenticatorStrategy extends AbstractAuthenticationStrategy {

    @Override
    public AuthenticationInfo beforeAllAttempts(Collection<? extends Realm> realms, 
AuthenticationToken token) throws AuthenticationException {
        return new SimpleAuthenticationInfo();//返回一个权限的认证信息
    }

    @Override
    public AuthenticationInfo beforeAttempt(Realm realm, AuthenticationToken token, 
AuthenticationInfo aggregate) throws AuthenticationException {
        return aggregate;//返回之前合并的
    }

    @Override
    public AuthenticationInfo afterAttempt(Realm realm, AuthenticationToken token, 
AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t) throws 
AuthenticationException {
        AuthenticationInfo info;
        if (singleRealmInfo == null) {
            info = aggregateInfo;
        } else {
            if (aggregateInfo == null) {
                info = singleRealmInfo;
            } else {
                info = merge(singleRealmInfo, aggregateInfo);
            }
        }

        return info;
    }

    @Override
    public AuthenticationInfo afterAllAttempts(AuthenticationToken token, 
AuthenticationInfo aggregate) throws AuthenticationException {
        if (aggregate == null || CollectionUtils.isEmpty(aggregate.getPrincipals()) ||
            aggregate.getPrincipals().getRealmNames().size() < 2) {
                throw new AuthenticationException("Authentication token of type [" + 
            token.getClass() + "] " +
                    "could not be authenticated by any configured realms.  Please ensure 
            that at least two realm can " + "authenticate these tokens.");
        }

        return aggregate;
    }
}

测试认证策略：

@Test
public void testAtLeastTwoStrategyWithSuccess() {
    login("classpath:shiro-authenticator-atLeastTwo-success.ini");
    Subject subject = SecurityUtils.getSubject();

    //得到一个身份集合，因为myRealm1和myRealm4返回的身份一样所以输出时只返回一个
    PrincipalCollection principalCollection = subject.getPrincipals();
    Assert.assertEquals(1, principalCollection.asList().size());
}

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

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

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

    subject.login(token);
}

@After
public void tearDown() throws Exception {
    ThreadContext.unbindSubject();//退出时请解除绑定Subject到线程 否则对下次测试造成影响
}

 

相关推荐