Version: Next

Shrio

  • Apche Shiro是一个Java安全（权限）框架
  • Shrio可以非常容易的开发出足够好的应用，不仅可以用在JavaSE环境，也可以用在JavaEE环境
  • Shrio可以完成，认证、授权、加密、会话管理、web集成以及缓存等
  • http://shiro.apache.org

功能

  • Authentication：身份认证、登录，验证用户是不是拥有相应身份
  • Authorization：授权，即权限验证，验证某个已认证的用户是否拥有某个权限，即判断用户能否进行某项操作
  • Session Manager：会话管理，即用户登陆后为第一次会话，在没有退出之前，它所有的信息都在会话中。会话可以存在与JaveSE或JavaEE环境
  • Cryptography：加密，保护数据的安全性，如密码加密存储到数据库中，而不是明文存储
  • Caching：缓存，比如用户登陆后，其用户信息，拥有的角色、权限不必每次都去查，可以提高效率
  • Concurrency：Shiro支持多线程应用的并发验证，即，如在一个线程中开启另一个线程，能够把权限自动的传播过去
  • Testing：提供测试支持
  • Run As：允许一个用户假装为另一个用户（如果他们允许）的身份进行访问
  • Remember Me：记住我功能

Shiro外部框架

image-20200430172715056

  • Subject：The current user 应用代码直接交互的对象是Subject，也就是Shrio的对外API核心就是Subject
    • Subject代表了当前用户，这个用户不一定是一个具体的人，与当前应用交互的任何东西都是Subject，如网络爬虫，机器人等。
    • 与Subject的所有交互这都会委托给SecurityManager
    • Subject其实是一个门面，SecurityManager才是实际的执行者
  • SecurityManager：Manages all Subjects 安全管理器
    • 即所有与安全有关的操作都会与SecurityManager交互，并且它管理者所有的Subject
    • 可以看出它是Shrio的核心，它负责与Shiro的其他组件进行交互
    • 他相当于SpringMVC中的DispatcherServlet
  • Realm：Access the security data Shiro从Realm获取安全数据(如用户，角色，权限)
    • 也就是说SecurityManager要验证用户身份，那么它需要从Realm获取相应的用户进行比较，来确定用户的身份是否合法
    • SecurityManager也需要从Realm得到用户相应的角色、权限、进行验证用户的操作是否能够进行，可以把Realm看作DataSource

Shiro内部架构

image-20200430173804485

  • Subject：任何可以与应用交互的'用户'
  • Security Manager：相当于SpringMVC中的DispatcherServlet，是Shiro的心脏，所有具体的交互都通过SecurityManager进行控制，它管理者所有的Subject，且负责认证，授权，会话，及缓存管理
  • Authenticator：负责Subject认证，可以自定义实现。可以使用认证策略(Authentication Strategy)，即什么情况下算用户认证通过了
  • Authorizer：授权器，即访问控制器，用来决定主体是否有权进行相应的操作，即控制着用户能访问应用中的哪些功能
  • Realm：可以有一个或者多个realm，可以认为是安全实体数据源，即用于获取安全实体，可以用JDBC实现，也可以是内存实现，由用户提供，因此一般需要自己实现realm
  • SessionManager：管理Session生命周期的组件，而Shrio并不仅仅可以用在web环境，也可以用在普通的JavaSE环境中
  • CacheManager：缓存控制器，来管理用户，角色，权限等缓存，因为这些数据基本上很少改变，放到缓存中可以提高访问性能
  • Cryptography：密码模块，Shiro提高了一些常见的加密组件用于密码加密和解密

环境搭建

新建springboot-06-shiro

<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-spring</artifactId>
<version>1.4.0</version>
</dependency>
  • /resources/shiro.ini (在插件页面直接搜索下载一个idea ini文件插件)
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
# =============================================================================
# Quickstart INI Realm configuration
#
# For those that might not understand the references in this file, the
# definitions are all based on the classic Mel Brooks' film "Spaceballs". ;)
# =============================================================================
# -----------------------------------------------------------------------------
# Users and their assigned roles
#
# Each line conforms to the format defined in the
# org.apache.shiro.realm.text.TextConfigurationRealm#setUserDefinitions JavaDoc
# -----------------------------------------------------------------------------
[users]
# user 'root' with password 'secret' and the 'admin' role
root = secret, admin
# user 'guest' with the password 'guest' and the 'guest' role
guest = guest, guest
# user 'presidentskroob' with password '12345' ("That's the same combination on
# my luggage!!!" ;)), and role 'president'
presidentskroob = 12345, president
# user 'darkhelmet' with password 'ludicrousspeed' and roles 'darklord' and 'schwartz'
darkhelmet = ludicrousspeed, darklord, schwartz
# user 'lonestarr' with password 'vespa' and roles 'goodguy' and 'schwartz'
lonestarr = vespa, goodguy, schwartz
# -----------------------------------------------------------------------------
# Roles with assigned permissions
#
# Each line conforms to the format defined in the
# org.apache.shiro.realm.text.TextConfigurationRealm#setRoleDefinitions JavaDoc
# -----------------------------------------------------------------------------
[roles]
# 'admin' role has all permissions, indicated by the wildcard '*'
admin = *
# The 'schwartz' role can do anything (*) with any lightsaber:
schwartz = lightsaber:*
# The 'goodguy' role is allowed to 'drive' (action) the winnebago (type) with
# license plate 'eagle5' (instance specific id)
goodguy = winnebago:drive:eagle5
  • QuickStart.java
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.config.IniSecurityManagerFactory;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.Factory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Simple Quickstart application showing how to use Shiro's API.
*
* @since 0.9 RC2
*/
public class Quickstart {
private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);
public static void main(String[] args) {
// The easiest way to create a Shiro SecurityManager with configured
// realms, users, roles and permissions is to use the simple INI config.
// We'll do that by using a factory that can ingest a .ini file and
// return a SecurityManager instance:
// Use the shiro.ini file at the root of the classpath
// (file: and url: prefixes load from files and urls respectively):
// 读取shiro.ini，获取realm，users，roles，permissions
// 工厂生产SecurityManager实例
Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
SecurityManager securityManager = factory.getInstance();
// for this simple example quickstart, make the SecurityManager
// accessible as a JVM singleton. Most applications wouldn't do this
// and instead rely on their container configuration or web.xml for
// webapps. That is outside the scope of this simple quickstart, so
// we'll just do the bare minimum so you can continue to get a feel
// for things.
SecurityUtils.setSecurityManager(securityManager);
// Now that a simple Shiro environment is set up, let's see what you can do:
// get the currently executing user:
Subject currentUser = SecurityUtils.getSubject();
// Do some stuff with a Session (no need for a web or EJB container!!!)
// 用当前用户获取Shiro session
Session session = currentUser.getSession();
session.setAttribute("someKey", "aValue");
String value = (String) session.getAttribute("someKey");
if (value.equals("aValue")) {
log.info("Retrieved the correct value! [" + value + "]");
}
// let's login the current user so we can check against roles and permissions:
// 判断用户是否被认证
if (!currentUser.isAuthenticated()) {
UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
token.setRememberMe(true);
try {
currentUser.login(token);
} catch (UnknownAccountException uae) {
log.info("There is no user with username of " + token.getPrincipal());
} catch (IncorrectCredentialsException ice) {
log.info("Password for account " + token.getPrincipal() + " was incorrect!");
} catch (LockedAccountException lae) {
log.info("The account for username " + token.getPrincipal() + " is locked. " +
"Please contact your administrator to unlock it.");
}
// ... catch more exceptions here (maybe custom ones specific to your application?
catch (AuthenticationException ae) {
//unexpected condition? error?
}
}
//say who they are:
//print their identifying principal (in this case, a username):
log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");
//test a role:
if (currentUser.hasRole("schwartz")) {
log.info("May the Schwartz be with you!");
} else {
log.info("Hello, mere mortal.");
}
//test a typed permission (not instance-level)
if (currentUser.isPermitted("lightsaber:wield")) {
log.info("You may use a lightsaber ring. Use it wisely.");
} else {
log.info("Sorry, lightsaber rings are for schwartz masters only.");
}
//a (very powerful) Instance Level permission:
if (currentUser.isPermitted("winnebago:drive:eagle5")) {
log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'. " +
"Here are the keys - have fun!");
} else {
log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
}
//all done - log out!
currentUser.logout();
System.exit(0);
}
}

  • IniSecurityManagerFactory读取shiro.ini，获取realm，users，roles，permissions

  • IniSecurityManagerFactory产生securityManager实例

  • 通过SecurityUtils，获取当前用户->Subject

Subject currentUser = SecurityUtils.getSubject();

  • 通过当前用户获取Shiro Session

    • 可以像HttpSession一样存值取值
    Session session = currentUser.getSession();

  • 判断当前用户是否被认证

    • 没认证 -> 根据账号密码生成Token
    • 设置记住我
    • 执行让当前用户登录，传入生成的token
      • 异常：UnknownAccountException 用户不存在
      • 异常：IncorrectCredentialsException 密码不正确
      • 异常：LockedAccountException 账户被锁定
    if (!currentUser.isAuthenticated()) {
    UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
    token.setRememberMe(true);
    try {
    currentUser.login(token);
    } catch (UnknownAccountException uae) {
    log.info("There is no user with username of " + token.getPrincipal());
    } catch (IncorrectCredentialsException ice) {
    log.info("Password for account " + token.getPrincipal() + " was incorrect!");
    } catch (LockedAccountException lae) {
    log.info("The account for username " + token.getPrincipal() + " is locked. " +
    "Please contact your administrator to unlock it.");
    }
    // ... catch more exceptions here (maybe custom ones specific to your application?
    catch (AuthenticationException ae) {
    //unexpected condition? error?
    }
    }

  • 判断用户是否具有身份

    currentUser.hasRole("schwartz")

  • 判断是否有权限

    if (currentUser.isPermitted("winnebago:drive:eagle5"))

  • 退出登录

    currentUser.logout();
  • 测试一下，可以跑通