SpringBoot——Shiro

Apache Shiro是一个强大且易用的Java安全框架,执行身份验证、授权、密码和会话管理。使用Shiro的易于理解的API,您可以快速、轻松地获得任何应用程序,从最小的移动应用程序到最大的网络和企业应用程序。

主要功能

三个核心组件：Subject, SecurityManager 和 Realms.

• Subject：即“当前操作用户”。但是，在Shiro中，Subject这一概念并不仅仅指人，也可以是第三方进程、后台帐户（Daemon Account）或其他类似事物。它仅仅意味着“当前跟软件交互的东西”。
  Subject代表了当前用户的安全操作，SecurityManager则管理所有用户的安全操作。
• SecurityManager：它是Shiro框架的核心，典型的Facade模式，Shiro通过SecurityManager来管理内部组件实例，并通过它来提供安全管理的各种服务。
• Realm： Realm充当了Shiro与应用安全数据间的“桥梁”或者“连接器”。也就是说，当对用户执行认证（登录）和授权（访问控制）验证时，Shiro会从应用配置的Realm中查找用户及其权限信息。
  从这个意义上讲，Realm实质上是一个安全相关的DAO：它封装了数据源的连接细节，并在需要时将相关数据提供给Shiro。当配置Shiro时，你必须至少指定一个Realm，用于认证和（或）授权。配置多个Realm是可以的，但是至少需要一个。

Shiro内置了可以连接大量安全数据源（又名目录）的Realm，如LDAP、关系数据库（JDBC）、类似INI的文本配置资源以及属性文件等。如果系统默认的Realm不能满足需求，你还可以插入代表自定义数据源的自己的Realm实现。

QuickStart

环境搭建

去github下载源代码

1. 创建maven项目导入依赖

<dependencies>        
    <dependency>
        <groupId>org.apache.shiro</groupId>
        <artifactId>shiro-core</artifactId>
        <version>1.7.1</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-simple</artifactId>
        <version>1.7.25</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>jcl-over-slf4j</artifactId>
        <version>2.0.0-alpha5</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>2.0.0-alpha5</version>
    </dependency>
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
</dependencies>

2. 配置文件
   这两个文件都可以在源码的quickstart中找到

log4j.perproties

log4j.rootLogger=INFO, stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m %n

# General Apache libraries
log4j.logger.org.apache=WARN

# Spring
log4j.logger.org.springframework=WARN

# Default Shiro logging
log4j.logger.org.apache.shiro=INFO

# Disable verbose logging
log4j.logger.org.apache.shiro.util.ThreadContext=WARN
log4j.logger.org.apache.shiro.cache.ehcache.EhCache=WARN

shiro.ini

[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

3. 将源代码中的QuickStart.java拷贝到项目中

package com.wcy;


import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.text.IniRealm;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


public class Quickstart {

    private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);


    public static void main(String[] args) {

        
		// Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
		// SecurityManager securityManager = factory.getInstance();
		// 固定代码
        DefaultSecurityManager securityManager = new DefaultSecurityManager();
        IniRealm iniRealm = new IniRealm("classpath:shiro.ini");
        securityManager.setRealm(iniRealm);
        SecurityUtils.setSecurityManager(securityManager);

        // !!! 获取当前用户
        // get the currently executing user:
        Subject currentUser = SecurityUtils.getSubject();

        // Do some stuff with a Session (no need for a web or EJB container!!!)
        // session的操作，这里的session是shiro自带的，并不是HttpSession
        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已经过时，将原来代码中的

Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
SecurityManager securityManager = factory.getInstance();

改为

DefaultSecurityManager securityManager = new DefaultSecurityManager();
IniRealm iniRealm = new IniRealm("classpath:shiro.ini");
securityManager.setRealm(iniRealm);

即可
运行会得到以下的结果

重要的几个核心步骤

// 获取当前用户对象
Subject currentUser = SecurityUtils.getSubject();
// 获取session
Session session = currentUser.getSession();
//获取用户令牌
UsernamePasswordToken token = new UsernamePasswordToken("username", "password");
//用户登陆
currentUser.login(token);
// 验证是否授权
currentUser.isAuthenticated()
// 验证该用户是否是某个角色
currentUser.hasRole("XX")
// 用户是否有某项权限
currentUser.isPermitted("XXX")
// 注销登陆
currentUser.logout();

springboot整合shiro

1. 创建maven项目，导入依赖

<!-- https://mvnrepository.com/artifact/org.apache.shiro/shiro-spring -->
<dependency>
   <groupId>org.apache.shiro</groupId>
   <artifactId>shiro-spring</artifactId>
   <version>1.8.0</version>
</dependency>

2. 搭建基本的springboot环境
3. 创建ShiroConfig， 其中包含

• ShiroFilterFactoryBean

• DefaultWebSecurityManager

• Realm 这个需要自己创建

  • 创建Realm 需要实现AuthorizingRealm 接口

public class UserRealm extends AuthorizingRealm {

    // 授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("执行了授权->doGetAuthorizationInfo！");
        return null;
    }

    // 认证
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        System.out.println("执行了认证->doGetAuthenticationInfo！");
        return null;
    }
}

ShiroConfig .java

@Configuration
public class ShiroConfig {

    // 3 ShiroFilterFactoryBean
    @Bean
    public ShiroFilterFactoryBean shiroFilterFactoryBean(
            @Qualifier("defaultWebSecurityManager") DefaultWebSecurityManager defaultWebSecurityManager) {
        ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
        // 设置安全管理器
        shiroFilterFactoryBean.setSecurityManager(defaultWebSecurityManager); 
        return shiroFilterFactoryBean;
    }

    // 2 DefaultWebSecurityManager
    @Bean
    public DefaultWebSecurityManager defaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm) {
        DefaultWebSecurityManager defaultWebSecurityManager = new DefaultWebSecurityManager();
        // 关联Realm
        defaultWebSecurityManager.setRealm(userRealm);
        return defaultWebSecurityManager;
    }

    // 1 Realm
    // 需要自己创建
    @Bean
    public UserRealm userRealm() {
        return new UserRealm();
    }

4. 创建两个页面来测试
   add.html 和 update.html
   编写路由控制

@GetMapping("/add")
public String add(){
    return "user/add";
}

@GetMapping("/login")
public String login() {
    return "login";
}

5. 添加过滤

添加 shiro 内置的过滤器

• anon: 无需认证就可以访问
• authc: 必须认证了才能访问
• user: 必须拥有记住我功能才能访问
• perms: 必须对某个资源有权限才能访问
• role: 必须有某个角色权限才能访问

@Bean
public ShiroFilterFactoryBean shiroFilterFactoryBean(
        @Qualifier("defaultWebSecurityManager") DefaultWebSecurityManager defaultWebSecurityManager) {
    ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
    // 设置安全管理器
    shiroFilterFactoryBean.setSecurityManager(defaultWebSecurityManager);

    /*
     * 添加 shiro 内置的过滤器
     *
     * anon: 无需认证就可以访问
     * authc: 必须认证了才能访问
     * user: 必须拥有记住我功能才能访问
     * perms: 必须对某个资源有权限才能访问
     * role: 必须有某个角色权限才能访问
     */
    // 添加权限限制
    Map<String, String> filterMap = new LinkedHashMap<>();
    // 这两个页面必须认证了才能访问
    filterMap.put("/add", "authc");
    filterMap.put("/update", "authc");
    shiroFilterFactoryBean.setFilterChainDefinitionMap(filterMap);
    return shiroFilterFactoryBean;
}

现在访问这两个页面的话，会404错误，原因是我们没有写登陆页面
编写一个登陆页面

@GetMapping("/login")
public String toLogin() {
    return "login";
}

并且在ShiroFilterFactoryBean 中设置登陆界面的路由

//设置登陆的路由
shiroFilterFactoryBean.setLoginUrl("/login");

现在访问add和update页面就会权限不足而进入登陆页面

认证

实现用户认证在Realm中实现

1. 首先来编写用户提交登陆请求controller
   这里会用到subject的几个操作

@PostMapping("/login")
public String login(
       @RequestParam("username") String username,
       @RequestParam("password") String password,
       Model model){
   // 1 获取当前用户
   Subject currentUser = SecurityUtils.getSubject();
   // 2 封装用户登陆信息
   UsernamePasswordToken usernamePasswordToken = new UsernamePasswordToken(username, password);
   // 3 登陆 如果没有异常就是登陆成功
   try {
       currentUser.login(usernamePasswordToken);
       return "index";
   }catch (UnknownAccountException uae) {  // 账户不存在
       model.addAttribute("msg", "账户不存在");
       return "login";
   } catch (IncorrectCredentialsException ice) {  // 密码不正确
       model.addAttribute("msg", "密码不正确");
       return "login";
   } catch (LockedAccountException lae) {  // 账户锁定
       model.addAttribute("msg", "账户已锁定");
       return "login";
   }
}

2. 在Realm中编写认证逻辑

// 认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
    System.out.println("执行了认证->doGetAuthenticationInfo！");
    // 开始验证用户名和密码 从数据库中获取 这里没有连接数据库 伪造一个
    String username = "wcy";
    String password = "123";
    // 获取用户登陆信息 token
    UsernamePasswordToken token = (UsernamePasswordToken) authenticationToken;

    // 检查用户名
    if (!token.getUsername().equals(username)){
        // 不正确就返回null shiro会自动给我们抛出异常
        return null;
    }
    // 无需自己检查密码 shiro会自己帮我们认证 我们传入正确的密码即可
    return new SimpleAuthenticationInfo("", password, "");
}

这样就可以简单的实现用户的登陆认证
登陆时使用我们伪造的账号密码就可以登陆成功，从而访问页面

整合mybatis

首先导入相关的依赖，这里使用druid的数据源

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.25</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.6</version>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

2. 编写配置文件
   application.yaml

spring:
  datasource:
    username: root
    password: root
    url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&chracterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource  # 自定义Druid数据源

    #Spring Boot 默认是不注入这些属性值的，需要自己绑定
    #druid 数据源专有配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true

    #配置监控统计拦截的filters，stat:监控统计、log4j：日志记录、wall：防御sql注入
    #如果允许时报错  java.lang.ClassNotFoundException: org.apache.log4j.Priority
    #则导入 log4j 依赖即可，Maven 地址：https://mvnrepository.com/artifact/log4j/log4j
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    useGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

application.properties

mybatis.type-aliases-package=com.wcy.pojo
mybatis.mapper-locations=classpath:mapper/*.xml

3. 实体类，mapper， service

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private String pwd;
}

@Repository
@Mapper
public interface UserMapper {

    User queryByName(String name);

}

@Service
public class UserServiceImpl implements UserService {

    private UserMapper userMapper;

    @Autowired
    public void setUserMapper(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    public User queryByName(String name){
        return userMapper.queryByName(name);
    }
}

4. mapper配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.wcy.mapper.UserMapper">

    <select id="queryByName" resultType="User" parameterType="String">
        select * from user where name = #{name}
    </select>

</mapper>

5. 在Realm中注入UserService

private UserService userService;

@Autowired
public void setUserService(UserService userService) {
    this.userService = userService;
}

6. 将认证中的真实用户信息通过userService查询出来即可

// 认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
    System.out.println("执行了认证->doGetAuthenticationInfo！");
    // 获取用户登陆信息 token
    UsernamePasswordToken token = (UsernamePasswordToken) authenticationToken;
    // 开始验证用户名和密码 从数据库中获取真实的信息
    User user = userService.queryByName(token.getUsername());

    // 如果用户不存在，则用户名不存在 结束
    if (user == null) {
        return null;
    }

    // 无需自己检查密码 shiro会自己帮我们认证 我们传入正确的密码即可
    return new SimpleAuthenticationInfo("", user.getPwd(), "");
}

授权

目前我们只要登录就可以访问add和update页面
下面来添加权限，只有对应权限才能访问

1. 在ShiroFilterFactoryBean下添加权限过滤

// add页面和update页面必须要拥有user:add，user:update才能访问
filterMap.put("/user/add", "perms[user:add]");
filterMap.put("/user/update", "perms[user:update]");

2. 我们在数据库中添加一个字段perms， 并且给其中的两个用户授权
   

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private String pwd;
    private String perms;
}

3. 在认证中最后我们将user对象向后传递

// 认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
    System.out.println("执行了认证->doGetAuthenticationInfo！");
    // 获取用户登陆信息 token
    UsernamePasswordToken token = (UsernamePasswordToken) authenticationToken;
    // 开始验证用户名和密码 从数据库中获取真实的信息
    User user = userService.queryByName(token.getUsername());

    // 如果用户不存在，则用户名不存在 结束
    if (user == null) {
        return null;
    }

    // 无需自己检查密码 shiro会自己帮我们认证 我们传入正确的密码即可
    // 将user传入 在授权中取出
    return new SimpleAuthenticationInfo(user, user.getPwd(), "");
}

4. 在授权中接收user对象
   并将数据库中的权限赋给当前对象

// 授权
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
    System.out.println("执行了授权->doGetAuthorizationInfo！");
    SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
    // 获取当前用户
    Subject subject = SecurityUtils.getSubject();
    User currentUser = (User) subject.getPrincipal();
    // 为用户授权， 是从数据库字段中查出来的权限
    info.addStringPermission(currentUser.getPerms());
    return info;
}

5. 编写一个权限不足的路由，避免用户看到错误的界面

@RequestMapping("/unauthorized")
@ResponseBody
public String unauthorized(){
    return "权限不足，无法访问！";
}

设置权限不足跳转到该路由

//权限不足跳转路由
shiroFilterFactoryBean.setUnauthorizedUrl("/unauthorized");

这样就配置好了
现在只有有权限的两位用户可以访问对应的页面，其他的都不能访问，会跳转到权限不足的页面

整合thymeleaf

1. 导入依赖

<!-- https://mvnrepository.com/artifact/com.github.theborakompanioni/thymeleaf-extras-shiro -->
<dependency>
    <groupId>com.github.theborakompanioni</groupId>
    <artifactId>thymeleaf-extras-shiro</artifactId>
    <version>2.0.0</version>
</dependency>

2. 注册一个bean

// 用于整合thymeleaf和shiro
@Bean
public ShiroDialect shiroDialect(){
    return new ShiroDialect();
}

3. 编写一个注销路由

@GetMapping("/logout")
public String logout(){
    Subject currentUser = SecurityUtils.getSubject();
    currentUser.logout();
    return "index";
}

4. 判断权限

命名空间

xmlns:shiro="http://www.thymeleaf.org/thymeleaf-extras-shiro"

<!--没有登陆显示-->
<div shiro:notAuthenticated>
    <a th:href="@{/login}">登陆</a>
    <p th:text="${msg}"></p>
</div>

<!--登陆了显示-->
<div shiro:authenticated>
    <p th:text="${user}"></p>
    <p><a th:href="@{/logout}">注销</a></p>
</div>

<!--有对应的权限才显示-->
<div shiro:hasPermission="user:add">
    <a th:href="@{/user/add}">add</a>
</div>

<div shiro:hasPermission="user:update">
    <a th:href="@{/user/update}">update</a>
</div>