Shiro 自定义realm授权与认证的实现

以你之姓@ 2022-07-12 16:56 378阅读 0赞

……List……

1.项目需求

2.shiro核心组件

3.自定义realm认证

4.自定义realm授权

5.思考总结

# ……1.项目需求…… #

企业项目中少不了权限管理，总的来说，权限管理就是用户认证与用户授权。用户拥有了权限即可操作权限范围内的资源，系统不知道主体是否具有访问权限需要对用户的访问进行控制。shiro是一套优秀的权限管理框架。来了解一下shiro的授权和认证。

# ……2.shiro核心组件…… #

![Center][]

关于shiro权限管理（授权和认证）离不开上面三个核心组件：subject，securitymanager，realm。

Subject：即“当前操作用户”，在Shiro中主体，可以是用户也可以是程序，主体要访问系统，系统需要对主体进行认证、授权。

Subject代表了当前用户的安全操作，SecurityManager则管理所有用户的安全操作。   
  
SecurityManager：它是Shiro框架的核心，典型的Facade模式，Shiro通过SecurityManager来管理内部组件实例，并通过它来提供安全管理的各种服务。   
  
Realm：域，领域，相当于数据源，通过realm存取认证、授权相关数据。在realm中存储授权和认证的逻辑。所以realm很重要。从这个意义上讲，Realm实质上是一个安全相关的DAO：它封装了数据源的连接细节，并在需要时将相关数据提供给Shiro。当配置Shiro时，你必须至少指定一个Realm，用于认证和（或）授权。配置多个Realm是可以的，但是至少需要一个。

明白了上面三个基本组件，在分析一下实现的流程：

# ……3.自定义realm认证…… #

![Center 1][]

1、通过ini配置文件创建securityManager

2、调用subject.login方法主体提交认证，提交的token

3、securityManager进行认证，securityManager最终由ModularRealmAuthenticator进行认证。

4、ModularRealmAuthenticator调用IniRealm(给realm传入token) 去ini配置文件中查询用户信息

5、IniRealm根据输入的token（UsernamePasswordToken）从 shiro-first.ini查询用户信息，根据账号查询用户信息（账号和密码）  
如果查询到用户信息，就给ModularRealmAuthenticator返回用户信息（账号和密码）  
如果查询不到，就给ModularRealmAuthenticator返回null

6、ModularRealmAuthenticator接收IniRealm返回Authentication认证信息  
  如果返回的认证信息是null，ModularRealmAuthenticator抛出异常（org.apache.shiro.authc.UnknownAccountException）  
         如果返回的认证信息不是null（说明inirealm找到了用户），对IniRealm返回用户密码 （在ini文件中存在）和 token中的密码 进行对比，如果不一致抛出异常（org.apache.shiro.authc.IncorrectCredentialsException）

// 自定义realm
    	@Test
    	public void testCustomRealm() {
    
    
    		// 创建securityManager工厂，通过ini配置文件创建securityManager工厂
    		Factory<SecurityManager> factory = new IniSecurityManagerFactory(
    				"classpath:shiro-realm.ini");
    
    
    		// 创建SecurityManager
    		SecurityManager securityManager = factory.getInstance();
    
    
    		// 将securityManager设置当前的运行环境中
    		SecurityUtils.setSecurityManager(securityManager);
    
    
    		// 从SecurityUtils里边创建一个subject
    		Subject subject = SecurityUtils.getSubject();
    
    
    		// 在认证提交前准备token（令牌）
    		// 这里的账号和密码 将来是由用户输入进去
    		UsernamePasswordToken token = new UsernamePasswordToken("zhouzhou",
    				"123");
    
    
    		try {
    			// 执行认证提交
    			subject.login(token);
    		} catch (AuthenticationException e) {
    			e.printStackTrace();
    		}
    
    
    		// 是否认证通过
    		boolean isAuthenticated = subject.isAuthenticated();
    
    
    		System.out.println("subject.login(token);之后，是否认证通过：" + isAuthenticated);
    		// 退出操作
    		subject.logout();
    
    
    		// 是否认证通过
    		isAuthenticated = subject.isAuthenticated();
    
    
    		System.out.println("2.subject.logout();之后是否认证通过：" + isAuthenticated);
    
    
    	}

shiro-realm.ini:

[main] #自定义 realm customRealm=cn.itcast.shiro.realm.CustomRealm #将realm设置到securitymanager，相当于spring注入  securityManager.realms=$customRealm

CumtomRealm.java （自定义类）

package cn.itcast.shiro.realm; 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.realm.AuthorizingRealm; import org.apache.shiro.subject.PrincipalCollection; public class CustomRealm extends AuthorizingRealm { // 设置realm的名称 @Override public void setName(String name) { super.setName("customRealm"); } // 用于认证 @Override protected AuthenticationInfo doGetAuthenticationInfo( AuthenticationToken token) throws AuthenticationException { // token是用户输入的 // 第一步从token中取出身份信息 String userCode = (String) token.getPrincipal(); // 第二步：根据用户输入的userCode从数据库查询 // .... // 模拟从数据库查询到密码 String password = "123"; // 如果查询到返回认证信息AuthenticationInfo SimpleAuthenticationInfo simpleAuthenticationInfo = new SimpleAuthenticationInfo( userCode, password, this.getName()); return simpleAuthenticationInfo; } // 用于授权 @Override protected AuthorizationInfo doGetAuthorizationInfo( PrincipalCollection principals) { // TODO Auto-generated method stub return null; } }

console：

![Center 2][]

真正运用到项目中，需要将数据库获取的用户身份信息存入token，subject.isAuthenticated()用这个方法来判断是否通过了认证。

# ……4.自定义realm授权…… #

![Center 3][]

授权与认证类似，是在ini文件里面定义一套授权规则，在环境中去加载。

1、执行subject.isPermitted("user:create")

2、securityManager通过ModularRealmAuthorizer进行授权

3、ModularRealmAuthorizer调用realm获取权限信息

4、ModularRealmAuthorizer再通过permissionResolver解析权限字符串，校验是否匹配

// 自定义realm进行资源授权测试
    	@Test
    	public void testAuthorizationCustomRealm() {
    
    
    		// 创建SecurityManager工厂
    		Factory<SecurityManager> factory = new IniSecurityManagerFactory(
    				"classpath:shiro-realm.ini");
    
    
    		// 创建SecurityManager
    		SecurityManager securityManager = factory.getInstance();
    
    
    		// 将SecurityManager设置到系统运行环境，和spring后将SecurityManager配置spring容器中，一般单例管理
    		SecurityUtils.setSecurityManager(securityManager);
    
    
    		// 创建subject
    		Subject subject = SecurityUtils.getSubject();
    
    
    		// 创建token令牌
    		UsernamePasswordToken token = new UsernamePasswordToken("zhouzhou",
    				"123");
    
    
    		// 执行认证
    		try {
    			subject.login(token);
    		} catch (AuthenticationException e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    		}
    
    
    		System.out.println("认证状态：" + subject.isAuthenticated());
    //		认证状态：true
    		// 认证通过后执行授权
    
    
    		// 基于资源的授权，调用isPermitted方法会调用CustomRealm从数据库查询正确权限数据
    		// isPermitted传入权限标识符，判断user:create:1是否在CustomRealm查询到权限数据之内
    		boolean isPermitted = subject.isPermitted("user:create:1");
    		System.out.println("单个权限判断" + isPermitted);
    //		单个权限判断true
    		boolean isPermittedAll = subject.isPermittedAll("user:create:1",
    				"user:create");
    		System.out.println("多个权限判断" + isPermittedAll);
    //		多个权限判断true
    		// 使用check方法进行授权，如果授权不通过会抛出异常
    		subject.checkPermission("items:add:1");
    
    
    	}

shiro-realm.ini:

[main] #自定义 realm customRealm=cn.itcast.shiro.realm.CustomRealm #将realm设置到securitymanager，相当于spring注入  securityManager.realms=$customRealm

自定义：customRealm.java

package cn.itcast.shiro.realm;
    
    import java.util.ArrayList;
    import java.util.List;
    
    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;
    
    
    public class CustomRealm extends AuthorizingRealm {
    
    	// 设置realm的名称
    	@Override
    	public void setName(String name) {
    		super.setName("customRealm");
    	}
    
    	// 用于认证
    	@Override
    	protected AuthenticationInfo doGetAuthenticationInfo(
    			AuthenticationToken token) throws AuthenticationException {
    
    		// token是用户输入的
    		// 第一步从token中取出身份信息
    		String userCode = (String) token.getPrincipal();
    
    		// 第二步：根据用户输入的userCode从数据库查询
    		// ....
    	
    		// 模拟从数据库查询到密码
    		String password = "123";
    
    		// 如果查询到返回认证信息AuthenticationInfo
    
    		SimpleAuthenticationInfo simpleAuthenticationInfo = new SimpleAuthenticationInfo(
    				userCode, password, this.getName());
    
    		return simpleAuthenticationInfo;
    	}
    
    	// 用于授权
    	@Override
    	protected AuthorizationInfo doGetAuthorizationInfo(
    			PrincipalCollection principals) {
    		
    		//从 principals获取主身份信息
    		//将getPrimaryPrincipal方法返回值转为真实身份类型（在上边的doGetAuthenticationInfo认证通过填充到SimpleAuthenticationInfo中身份类型），
    		String userCode =  (String) principals.getPrimaryPrincipal();
    		
    		//根据身份信息获取权限信息
    		//连接数据库...
    		//模拟从数据库获取到数据
    		List<String> permissions = new ArrayList<String>();
    		permissions.add("user:create");//用户的创建
    		permissions.add("items:add");//商品添加权限
    		//....
    		
    		//查到权限数据，返回授权信息(要包括 上边的permissions)
    		SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo();
    		//将上边查询到授权信息填充到simpleAuthorizationInfo对象中
    		simpleAuthorizationInfo.addStringPermissions(permissions);
    
    		return simpleAuthorizationInfo;
    	}
    
    }

console：

![Center 4][]

# ……5.思考总结…… #

Authorization 授权

Authentication 认证

（要分清楚这两个单词…）

权限管理分为粗粒度和细粒度，细粒度在数据级别没有共同语言，需要写到业务逻辑中。粗粒度权限管理比较容易将权限管理的代码抽取出来在系统架构级别统一处理。节省开发时间，提高开发效率。

多学习，多思考。

[Center]: /images/20220709/d4d6460ee6024f45aa812b75c09740ee.png
[Center 1]: /images/20220709/278f9b16bcf84c5dbb8eb66586ca3db8.png
[Center 2]: /images/20220709/5cb70f928b8d48cebec45ae267a6f372.png
[Center 3]: /images/20220709/1088b8c12311438fbb4863349d74a714.png
[Center 4]: /images/20220709/63054f0f078c4733876e239a5a428b9d.png