是五月呀!

shiro开发(三)授权

授权,也叫访问控制,即在应用中控制谁能访问哪些资源(如访问页面/编辑数据/页面操作等)。
在授权中需了解的几个关键对象:主体(Subject)、资源(Resource)、权限(Permission)、角色(Role)。

  • 主体:即访问应用的用户,在Shiro中使用Subject代表该用户。用户只有授权后才允许访问相应的资源;
  • 资源:在应用中用户可以访问的任何东西,比如访问JSP页面、查看/编辑某些数据、访问某个业务方法、打印文本等等都是资源。用户只要授权后才能访问;
  • 权限:安全策略中的原子授权单位,通过权限我们可以表示在应用中用户有没有操作某个资源的权力。即权限表示在应用中用户能不能访问某个资源,如:访问用户列表页面、查看/新增/修改/删除用户数据(即很多时候都是CRUD(增查改删)式权限控制)、打印文档等等;如上可以看出,权限代表了用户有没有操作某个资源的权利,即反映在某个资源上的操作允不允许,不反映谁去执行这个操作。所以后续还需要把权限赋予给用户,即定义哪个用户允许在某个资源上做什么操作(权限),Shiro不会去做这件事情,而是由实现人员提供。Shiro支持粗粒度权限(如用户模块的所有权限)和细粒度权限(操作某个用户的权限,即实例级别的),后续部分介绍;
  • 角色:代表了操作集合,可以理解为权限的集合,一般情况下我们会赋予用户角色而不是权限,即这样用户可以拥有一组权限,赋予权限时比较方便。典型的如:项目经理、技术总监、CTO、开发工程师等都是角色,不同的角色拥有一组不同的权限。
    • 隐式角色:即直接通过角色来验证用户有没有操作权限,如在应用中CTO、技术总监、开发工程师可以使用打印机,假设某天不允许开发工程师使用打印机,此时需要从应用中删除相应代码;再如在应用中CTO、技术总监可以查看用户、查看权限;突然有一天不允许技术总监查看用户、查看权限了,需要在相关代码中把技术总监角色从判断逻辑中删除掉;即粒度是以角色为单位进行访问控制的,粒度较粗;如果进行修改可能造成多处代码修改。
    • 显示角色:在程序中通过权限控制谁能访问某个资源,角色聚合一组权限集合;这样假设哪个角色不能访问某个资源,只需要从角色代表的权限集合中移除即可;无须修改多处代码;即粒度是以资源/实例为单位的;粒度较细。

授权方式

Shiro支持三种方式的授权:

编程式:通过写if/else授权代码块完成:

1
2
3
4
5
6
Subject subject = SecurityUtils.getSubject();
if(subject.hasRole(“admin”)) {
//有权限
} else {
//无权限
}

注解式:通过在执行的Java方法上放置相应的注解完成:

1
2
3
4
@RequiresRoles("admin")
public void hello() {
//有权限
}

没有权限将抛出相应的异常;

JSP/GSP标签:在JSP/GSP页面通过相应的标签完成:

1
2
3
<shiro:hasRole name="admin">
<!— 有权限 —>
</shiro:hasRole>

授权

基于角色的访问控制(隐式角色)

在ini配置文件配置用户拥有的角色(shiro-role.ini):

1
2
3
[users]
zhang=123,role1,role2
wang=123,role1

规则即:“用户名=密码,角色1,角色2”
如果需要在应用中判断用户是否有相应角色,就需要在相应的Realm中返回角色信息。
也就是说Shiro不负责维护用户-角色信息,需要应用提供,Shiro只是提供相应的接口方便验证,后续会介绍如何动态的获取用户角色。

测试:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@Test
public void testHasRole() {
login("classpath:shiro-role.ini", "zhang", "123");
//判断拥有角色:role1
Assert.assertTrue(SecurityUtils.getSubject().hasRole("role1"));
//判断拥有角色:role1 and role2
Assert.assertTrue(SecurityUtils.getSubject().hasAllRoles(Arrays.asList("role1", "role2")));
//判断拥有角色:role1 and role2 and !role3
boolean[] result = SecurityUtils.getSubject().hasRoles(Arrays.asList("role1", "role2", "role3"));
Assert.assertTrue(result[0]);
Assert.assertTrue(result[1]);
Assert.assertFalse(result[2]);
}
@Test(expected = UnauthorizedException.class)
public void testCheckRole() {
login("classpath:shiro-role.ini", "zhang", "123");
//断言拥有角色:role1
SecurityUtils.getSubject().checkRole("role1");
//断言拥有角色:role1 and role3 失败抛出异常
SecurityUtils.getSubject().checkRoles("role1", "role3");
}
private void login(String configFile, String username, String password) {
//1、获取SecurityManager工厂,此处使用Ini配置文件初始化SecurityManager
Factory<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(username, password);
subject.login(token);
}

到此基于角色的访问控制(即隐式角色)就完成了,这种方式的缺点就是如果很多地方进行了角色判断,但是有一天不需要了那么就需要修改相应代码把所有相关的地方进行删除;这就是粗粒度造成的问题。

基于资源的访问控制(显示角色)

在ini配置文件配置用户拥有的角色及角色-权限关系(shiro-permission.ini):

1
2
3
4
5
6
[users]
zhang=123,role1,role2
wang=123,role1
[roles]
role1=user:create,user:update
role2=user:create,user:delete

规则:
“用户名=密码,角色1,角色2”“角色=权限1,权限2”,即首先根据用户名找到角色,然后根据角色再找到权限;角色是权限集合。
Shiro同样不进行权限的维护,需要我们通过Realm返回相应的权限信息。只需要维护“用户——角色”之间的关系即可。

测试用例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Test
public void testIsPermitted() {
login("classpath:shiro-permission.ini", "zhang", "123");
//判断拥有权限:user:create
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("user:create"));
//判断拥有权限:user:update and user:delete
Assert.assertTrue(SecurityUtils.getSubject().isPermittedAll("user:update", "user:delete"));
//判断没有权限:user:view
Assert.assertFalse(SecurityUtils.getSubject().isPermitted("user:view"));
}
@Test(expected = UnauthorizedException.class)
public void testCheckPermission () {
login("classpath:shiro-permission.ini", "zhang", "123");
//断言拥有权限:user:create
SecurityUtils.getSubject().checkPermission("user:create");
//断言拥有权限:user:delete and user:update
SecurityUtils.getSubject().checkPermissions("user:delete", "user:update");
//断言拥有权限:user:view 失败抛出异常
SecurityUtils.getSubject().checkPermissions("user:view");
}

到此基于资源的访问控制(显示角色)就完成了,也可以叫基于权限的访问控制,这种方式的一般规则是“资源标识符:操作”,即是资源级别的粒度。
这种方式的好处就是如果要修改基本都是一个资源级别的修改,不会对其他模块代码产生影响,粒度小。但是实现起来可能稍微复杂点,需要维护“用户——角色,角色——权限(资源:操作)”之间的关系。

Permission字符串通配符权限

规则:资源标识符:操作:对象实例ID
即对哪个资源的哪个实例可以进行什么操作。其默认支持通配符权限字符串,:表示资源/操作/实例的分割;,表示操作的分割;*表示任意资源/操作/实例。

单个资源单个权限

1
SecurityUtils.getSubject().checkPermissions("system:user:update");

用户拥有资源system:userupdate权限。

单个资源多个权限

ini配置文件:

1
role41=system:user:update,system:user:delete

然后通过如下代码判断:

1
SecurityUtils.getSubject().checkPermissions("system:user:update", "system:user:delete");

用户拥有资源system:userupdatedelete权限。如上可以简写成:
ini配置(表示角色42拥有system:user资源的update和delete权限):

1
role42="system:user:update,delete"

注意system:user:update,delete用引号包围。
接着可以通过如下代码判断:

1
2
3
4
SecurityUtils.getSubject().checkPermissions("system:user:update");
SecurityUtils.getSubject().checkPermissions("system:user:delete");
SecurityUtils.getSubject().checkPermissions("system:user:update,delete");
SecurityUtils.getSubject().checkPermissions("system:user:update","system:user:delete");

注意,如果ini配置文件没有简写:

1
role41=system:user:update,system:user:delete

那么不可以用简写判断:

1
2
// 这样是找不到的
SecurityUtils.getSubject().checkPermissions("system:user:update,delete");

单个资源全部权限

ini配置文件(表示角色5拥有system:user的所有权限)

1
role52=system:user:*

然后通过如下代码判断:

1
SecurityUtils.getSubject().checkPermissions("system:user:*");

所有资源全部权限

ini配置:

1
role61=*:view

然后通过如下代码判断

1
SecurityUtils.getSubject().checkPermissions("user:view");

用户拥有所有资源的“view”所有权限。
假设判断的权限是system:user:view,那么需要role5=*:*:view这样写才行。

实例级别的权限

单个实例单个权限

ini配置:

1
role71=user:view:1

对资源user的1实例拥有view权限。
然后通过如下代码判断:

1
SecurityUtils.getSubject().checkPermissions("user:view:1");

单个实例多个权限

ini配置:

1
role72="user:update,delete:1"

对资源user的1实例拥有update、delete权限。
然后通过如下代码判断:

1
2
SecurityUtils.getSubject().checkPermissions("user:delete,update:1");
SecurityUtils.getSubject().checkPermissions("user:update:1", "user:delete:1");

单个实例所有权限

ini配置:

1
role73=user:*:1

对资源user的1实例拥有所有权限。
然后通过如下代码判断:

1
SecurityUtils.getSubject().checkPermissions("user:update:1", "user:delete:1", "user:view:1");

所有实例单个权限

ini配置:

1
role74=user:auth:*

对资源user的1实例拥有所有权限。
然后通过如下代码判断:

1
SecurityUtils.getSubject().checkPermissions("user:auth:1", "user:auth:2");

所有实例所有权限

ini配置:

1
role75=user:*:*

对资源user的1实例拥有所有权限。
然后通过如下代码判断:

1
SecurityUtils.getSubject().checkPermissions("user:view:1", "user:auth:2");

Shiro对权限字符串缺失部分的处理

user:view等价于user:view:*
organization等价于organization:*或者organization:*:*
可以这么理解,这种方式实现了前缀匹配。
另外如user:*可以匹配如user:delete
user:delete可以匹配如user:delete:1
user:*:1可以匹配如user:view:1
*可以匹配所有,不加*可以进行前缀匹配;
但是如*:view不能匹配system:user:view,需要使用*:*:view,即后缀匹配必须指定前缀(多个冒号就需要多个*来匹配)。

性能问题

通配符匹配方式比字符串相等匹配来说是更复杂的,因此需要花费更长时间,但是一般系统的权限不会太多,且可以配合缓存来提供其性能,如果这样性能还达不到要求我们可以实现位操作算法实现性能更好的权限匹配。
另外实例级别的权限验证如果数据量太大也不建议使用,可能造成查询权限及匹配变慢。可以考虑比如在sql查询时加上权限字符串之类的方式在查询时就完成了权限匹配。

授权流程

流程如下:

  1. 首先调用Subject.isPermitted*/hasRole*接口,其会委托给SecurityManager,而SecurityManager接着会委托给Authorizer
  2. Authorizer是真正的授权者,如果我们调用如isPermitted(“user:view”),其首先会通过PermissionResolver把字符串转换成相应的Permission实例;
  3. 在进行授权之前,其会调用相应的Realm获取Subject相应的角色/权限用于匹配传入的角色/权限;
  4. Authorizer会判断Realm的角色/权限是否和传入的匹配,如果有多个Realm,会委托给ModularRealmAuthorizer进行循环判断,如果匹配如isPermitted*/hasRole*会返回true,否则返回false表示授权失败。

ModularRealmAuthorizer进行多Realm匹配流程:

  1. 首先检查相应的Realm是否实现了实现了Authorizer
  2. 如果实现了Authorizer,那么接着调用其相应的isPermitted*/hasRole*接口进行匹配;
  3. 如果有一个Realm匹配那么将返回true,否则返回false。

如果Realm进行授权的话,应该继承AuthorizingRealm,其流程是:

  1. 如果调用hasRole*,则直接获取AuthorizationInfo.getRoles()与传入的角色比较即可;
  2. 首先如果调用如isPermitted(“user:view”),首先通过PermissionResolver将权限字符串转换成相应的Permission实例,默认使用WildcardPermissionResolver,即转换为通配符的WildcardPermission
  3. 通过AuthorizationInfo.getObjectPermissions()得到Permission实例集合;通过AuthorizationInfo.getStringPermissions()得到字符串集合并通过PermissionResolver解析为Permission实例;然后获取用户的角色,并通过RolePermissionResolver解析角色对应的权限集合(默认没有实现,可以自己提供);
  4. 接着调用Permission.implies(Permission p)逐个与传入的权限比较,如果有匹配的则返回true,否则false。

Authorizer、PermissionResolver及RolePermissionResolver

  • Authorizer的职责是进行授权(访问控制),是Shiro API中授权核心的入口点,其提供了相应的角色/权限判断接口,具体请参考其Javadoc。SecurityManager继承了Authorizer接口,且提供了ModularRealmAuthorizer用于多Realm时的授权匹配;
  • PermissionResolver用于解析权限字符串到Permission实例;
  • RolePermissionResolver用于根据角色解析相应的权限集合。

下面自定义一个授权流程。

ini配置(shiro-authorizer.ini):

1
2
3
4
5
6
7
8
9
10
11
12
13
[main]
#自定义authorizer
authorizer=org.apache.shiro.authz.ModularRealmAuthorizer
#自定义permissionResolver
permissionResolver=com.maybe.shiro.resolver.BitAndWildPermissionResolver
authorizer.permissionResolver=$permissionResolver
#自定义rolePermissionResolver
rolePermissionResolver=com.maybe.shiro.resolver.MyRolePermissionResolver
authorizer.rolePermissionResolver=$rolePermissionResolver
securityManager.authorizer=$authorizer
#自定义realm 一定要放在securityManager.authorizer赋值之后(因为调用setRealms会将realms设置给authorizer,并给各个Realm设置permissionResolver和rolePermissionResolver)
realm=com.maybe.shiro.realm.MyRealm
securityManager.realms=$realm

定义BitAndWildPermissionResolverBitPermission
BitPermission用于实现位移方式的权限,如规则是:

权限字符串格式:+资源字符串+权限位+实例ID;以+开头中间通过+分割;权限:0 表示所有权限;1 新增(二进制:0001)、2 修改(二进制:0010)、4 删除(二进制:0100)、8 查看(二进制:1000);
如 +user+10 表示对资源user拥有修改/查看权限。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
public class BitPermission implements Permission {
private String resourceIdentify;
private int permissionBit;
private String instanceId;
public BitPermission(String permissionString) {
String[] array = permissionString.split("\\+");
if(array.length > 1) {
resourceIdentify = array[1];
}
if(StringUtils.isEmpty(resourceIdentify)) {
resourceIdentify = "*";
}
if(array.length > 2) {
permissionBit = Integer.valueOf(array[2]);
}
if(array.length > 3) {
instanceId = array[3];
}
if(StringUtils.isEmpty(instanceId)) {
instanceId = "*";
}
}
@Override
public boolean implies(Permission p) {
if(!(p instanceof BitPermission)) {
return false;
}
BitPermission other = (BitPermission) p;
if(!("*".equals(this.resourceIdentify) || this.resourceIdentify.equals(other.resourceIdentify))) {
return false;
}
if(!(this.permissionBit ==0 || (this.permissionBit & other.permissionBit) != 0)) {
return false;
}
if(!("*".equals(this.instanceId) || this.instanceId.equals(other.instanceId))) {
return false;
}
return true;
}
}

BitAndWildPermissionResolver实现了PermissionResolver接口,并根据权限字符串是否以+开头来解析权限字符串为BitPermissionWildcardPermission

1
2
3
4
5
6
7
8
9
public class BitAndWildPermissionResolver implements PermissionResolver {
@Override
public Permission resolvePermission(String permissionString) {
if(permissionString.startsWith("+")) {
return new BitPermission(permissionString);
}
return new WildcardPermission(permissionString);
}
}

定义MyRolePermissionResolver,用于根据角色字符串来解析得到权限集合:

1
2
3
4
5
6
7
8
9
public class MyRolePermissionResolver implements RolePermissionResolver {
@Override
public Collection<Permission> resolvePermissionsInRole(String roleString) {
if("role1".equals(roleString)) {
return Arrays.asList((Permission)new WildcardPermission("menu:*"));
}
return null;
}
}

此处的实现很简单,如果用户拥有role1,那么就返回一个menu:*的权限。

自定义Realm

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class MyRealm extends AuthorizingRealm {
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo();
authorizationInfo.addRole("role1");
authorizationInfo.addRole("role2");
authorizationInfo.addObjectPermission(new BitPermission("+user1+10"));
authorizationInfo.addObjectPermission(new WildcardPermission("user1:*"));
authorizationInfo.addStringPermission("+user2+10");
authorizationInfo.addStringPermission("user2:*");
return authorizationInfo;
}
@Override
protected AuthenticationInfo doGetAuthenticationInfo(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());
}
}

测试用例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@Test
public void testIsPermitted() {
login("classpath:shiro-authorizer.ini", "zhang", "123");
//判断拥有权限:user:create
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("user1:update"));
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("user2:update"));
//通过二进制位的方式表示权限
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("+user1+2"));//新增权限
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("+user1+8"));//查看权限
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("+user2+10"));//新增及查看
Assert.assertFalse(SecurityUtils.getSubject().isPermitted("+user1+4"));//没有删除权限
Assert.assertTrue(SecurityUtils.getSubject().isPermitted("menu:view"));//通过MyRolePermissionResolver解析得到的权限
}
private void login(String configFile, String username, String password) {
//1、获取SecurityManager工厂,此处使用Ini配置文件初始化SecurityManager
Factory<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(username, password);
subject.login(token);
}

参考:
第三章 授权——《跟我学Shiro》
Apache Shiro Reference Documentation