MyBatis数据脱敏

MyBatis数据脱敏

一、背景

在我们数据库中有些时候会保存一些用户的敏感信息,比如:手机号、银行卡等信息,如果这些信息以明文的方式保存,那么是不安全的。

假如:黑客黑进了数据库,或者离职人员导出了数据,那么就可能导致这些敏感数据的泄漏。因此我们就需要找到一种方法来解决这个问题。

二、解决方案

由于我们系统中使用了Mybatis作为数据库持久层,因此决定使用Mybatis的TypeHandler或Plugin来解决。

TypeHandler : 需要我们在某些列上手动指定 typeHandler 来选择使用那个typeHandler或者根据@MappedJdbcTypes@MappedTypes注解来自行推断。

<result column="phone" property="phone"
typeHandler="com.llp.llpmybatis.typehandler.EncryptTypeHandler"/>

Plugin : 可以拦截系统中的 select、insert、update、delete等语句,也能获取到sql执行前的参数和执行后的数据。

三、需求

我们有一张用户表tbl_user,里面有客户手机号(phone)和邮箱(email)等字段,其中客户手机号(phone)是需要加密保存到数据库中的。

1、 在添加用户信息时,自动将用户手机号加密保存到数据中;

2、 在查询用户信息时,自动解密用户手机号;

四、实现思路

1、 编写一个实体类,凡是此实体类的数据都表示需要加解密的;

public class Encrypt {
    private String value;

    public Encrypt() {
    }

    public Encrypt(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

2、编写一个加解密的TypeHandler

  • 设置参数时,加密数据。
  • 从数据库获取记录时,解密数据。
/**
 * 注意⚠️:
 *
 * @MappedTypes:表示该处理器处理的java类型是什么。
 *
 * @MappedJdbcTypes:表示处理器处理的Jdbc类型。
 */
@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes(Encrypt.class)
public class EncryptTypeHandler extends BaseTypeHandler<Encrypt> {

    private static final byte[] KEYS = "12345678abcdefgh".getBytes(StandardCharsets.UTF_8);

    /**
     * 设置参数
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Encrypt parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null || parameter.getValue() == null) {
            ps.setString(i, null);
            return;
        }
        //这里引入hutool依赖,对KEYS进行AES加密得到密钥
        AES aes = SecureUtil.aes(KEYS);
        //对Encrypt 类型的参数进行加密
        String encrypt = aes.encryptHex(parameter.getValue());
        ps.setString(i, encrypt);
    }

    /**
     * 获取值
     */
    @Override
    public Encrypt getNullableResult(ResultSet rs, String columnName) throws SQLException {
        //在获取值是对加密的数据进行解密
        return decrypt(rs.getString(columnName));
    }

    /**
     * 获取值
     */
    @Override
    public Encrypt getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return decrypt(rs.getString(columnIndex));
    }

    /**
     * 获取值
     */
    @Override
    public Encrypt getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return decrypt(cs.getString(columnIndex));
    }

    public Encrypt decrypt(String value) {
        if (null == value) {
            return null;
        }
        return new Encrypt(SecureUtil.aes(KEYS).decryptStr(value));
    }
}

3、配置文件中指定Typehandler的包路径

mybatis.type-handlers-package=com.llp.llpmybatis.typehandler
#\u914D\u7F6Emybatis
mybatis:
  configuration:
    #\u5F00\u542F\u4E0B\u5212\u7EBF\u6620\u5C04\u9A7C\u5CF0\u547D\u540D
    map-underscore-to-camel-case: true
    #mybatis\u65E5\u5FD7\u6253\u5370
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    # xml\u6587\u4EF6\u4F4D\u7F6E\u6620\u5C04
  mapper-locations: classpath*:mapper/*.xml
  type-handlers-package: com.llp.llpmybatis.typehandler

4、sql语句中写法

测试方法

@Autowired
private TblUserDao userDao;
@Test
void contextLoads() {
    Encrypt phone = new Encrypt("15023511828");
    String name = "小红";
    Encrypt email = new Encrypt("xiaohong@123.com");
    userDao.insertUser(name,phone,email);
}

userDao:需要加密的字段需要传入我们前面指定的类型

void insertUser(@Param("name") String name,@Param("phone") Encrypt phone,@Param("email") Encrypt email);

sql写法:照常写就行,没有什么特殊的地方

<insert id="insertUser">
   insert  into tbl_user (name,phone,email) values (#{name},#{phone},#{email})
</insert>

image-20220810174820300

五、测试结果

controller

@RestController
public class MyTestController {

    @Autowired
    private TblUserDao tblUserDao;

    @RequestMapping("/test")
    public UserVo mytest(){
        UserVo userVo = tblUserDao.findById(7L);
        return userVo;
    }
}

dao

UserVo findById(@Param("id") Long id);
<resultMap id="userVo" type="com.llp.llpmybatis.vo.UserVo">
  <result column="id" jdbcType="BIGINT" property="id" />
    <result column="name" jdbcType="VARCHAR" property="name" />
    <result column="nickname" jdbcType="VARCHAR" property="nickname" />
    <result column="age" jdbcType="INTEGER" property="age" />
    <result column="phone"  property="phone" />
    <result column="email"  property="email" />
    <result column="password" jdbcType="VARCHAR" property="password" />
  </resultMap>
<select id="findById" resultMap="userVo">
	select * from tbl_user where id = #{id}
</select>

vo

这里为了不影响实体类字段的类型,用vo来进行映射

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserVo {
    private Long id;

    private String name;

    private String nickname;

    private Integer age;

    //注意:针对需要解密的字段需要指定我们之前进行加密的类型,这样才能匹配到我们自定义的TypeHandler
    private Encrypt phone;

    private Encrypt email;

    private String password;

}

image-20220810175308017

  • 4
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
MyBatis 是一个流行的 Java 持久层框架,它可以将数据库中的数据映射到 Java 对象中。在某些情况下,我们需要对敏感数据进行脱敏,以保护用户隐私。以下是一个使用 MyBatis 数据脱敏的示例: 假设有一个用户表,其中包含用户的姓名、手机号和邮箱。我们需要对手机号和邮箱进行脱敏,以保护用户的隐私。可以使用 MyBatis 的类型处理器来实现数据脱敏。 首先,我们需要创建一个自定义的类型处理器,该类型处理器将对手机号和邮箱进行脱敏。例如,我们可以将手机号的中间四位替换为星号,将邮箱的前三位和后缀部分替换为星号。以下是一个示例代码: ```java public class SensitiveTypeHandler extends BaseTypeHandler<String> { @Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException { // 对手机号进行脱敏 if (parameter.matches("^1[3-9]\\d{9}$")) { parameter = parameter.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"); } // 对邮箱进行脱敏 else if (parameter.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")) { int index = parameter.indexOf("@"); String prefix = parameter.substring(0, index); String suffix = parameter.substring(index); if (prefix.length() > 3) { prefix = prefix.substring(0, 3) + "****"; } else if (prefix.length() > 0) { prefix = prefix.substring(0, 1) + "****"; } parameter = prefix + suffix; } ps.setString(i, parameter); } @Override public String getNullableResult(ResultSet rs, String columnName) throws SQLException { String result = rs.getString(columnName); if (result.matches("^1[3-9]\\d{9}$")) { result = result.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"); } else if (result.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")) { int index = result.indexOf("@"); String prefix = result.substring(0, index); String suffix = result.substring(index); if (prefix.length() > 3) { prefix = prefix.substring(0, 3) + "****"; } else if (prefix.length() > 0) { prefix = prefix.substring(0, 1) + "****"; } result = prefix + suffix; } return result; } @Override public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException { String result = rs.getString(columnIndex); if (result.matches("^1[3-9]\\d{9}$")) { result = result.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"); } else if (result.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")) { int index = result.indexOf("@"); String prefix = result.substring(0, index); String suffix = result.substring(index); if (prefix.length() > 3) { prefix = prefix.substring(0, 3) + "****"; } else if (prefix.length() > 0) { prefix = prefix.substring(0, 1) + "****"; } result = prefix + suffix; } return result; } @Override public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { String result = cs.getString(columnIndex); if (result.matches("^1[3-9]\\d{9}$")) { result = result.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"); } else if (result.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")) { int index = result.indexOf("@"); String prefix = result.substring(0, index); String suffix = result.substring(index); if (prefix.length() > 3) { prefix = prefix.substring(0, 3) + "****"; } else if (prefix.length() > 0) { prefix = prefix.substring(0, 1) + "****"; } result = prefix + suffix; } return result; } } ``` 接下来,我们需要在 MyBatis 的配置文件中注册该类型处理器。例如,在 `mybatis-config.xml` 文件中添加以下配置: ```xml <typeHandlers> <typeHandler handler="com.example.SensitiveTypeHandler"/> </typeHandlers> ``` 最后,我们可以在 MyBatis 的映射文件中使用该类型处理器。例如,以下是一个查询用户信息的示例: ```xml <select id="getUser" resultType="User"> SELECT name, phone, email FROM user WHERE id = #{id} </select> ``` 在返回结果时,MyBatis 将自动调用我们定义的类型处理器对敏感数据进行脱敏。例如,如果用户的手机号为 `13912345678`,则返回的结果将为 `139****5678`。 这是一个简单的使用 MyBatis 数据脱敏的示例。当然,实际情况可能更复杂,需要根据具体业务需求进行适当修改。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值