您现在的位置是:首页 > 正文

基于Jackson实现API接口数据脱敏

2024-02-29 11:32:05阅读 0

一、背景

用户的一些敏感数据,例如手机号、邮箱、身份证等信息,在数据库以明文存储(加密存储见《基于Mybatis-Plus拦截器实现MySQL数据加解密》), 但在接口返回数据给浏览器(或三方客户端)时,希望对这些敏感数据进行脱敏。 同时在浏览器提交数据更新到后端接口时,后端接口需要判断敏感数据是否已脱敏,如果已脱敏则需要直接丢弃。

 

二、Jackson介绍

Jackson是SpringBoot默认的Json序列化和反序列化库,点击这里查看Jackson注解官方文档.

本文通过使用Jackson的@JsonSerialize注解实现序列化时脱敏操作,通过使用Jackson的@JsonDeserialize注解实现反序列化时脱敏数据检测并丢弃操作。

三、使用方法

该脱敏拦截器功能在wutong-base-api包(公司内部包)已经实现,如果您的项目已经依赖了base-api,就可以直接使用。

另外,在码云上有Demo案例,见: spring-jackson

基于wutong-base-api包的使用步骤如下。

1、添加wutong-base-api依赖

<dependency>
    <groupId>com.talkweb</groupId>
    <artifactId>wutong-base-api</artifactId>
    <version>请使用最新版本</version>
</dependency>

2、在yaml配置开关,启用加解密

spring:
  jackson:
    sensitive:
      # 序列化时是否对手机号进行脱敏,反序列化时是否过滤脱敏数据
      mobile: true
      # 序列化时是否对邮箱进行脱敏,反序列化时是否过滤脱敏数据
      email: true
      # 序列化时是否对身份证号进行脱敏,反序列化时是否过滤脱敏数据
      identity: true

3、定义VO类,使用Jackson注解实现数据脱敏

API接口出参(Rsp),敏感数据序列化时脱敏

public class UserRspVO {
    private Long id;
    private String name;
    @JsonSerialize(using = CustomerJackSon.MobileSerialize.class)
    private String mobile;
    @JsonSerialize(using = CustomerJackSon.EmailSerialize.class)
    private String email;
    @JsonSerialize(using = CustomerJackSon.IdentitySerialize.class)
    private String identity;
}

API接口入参(Req),过滤已脱敏的数据,直接丢弃

public class UserReqVO {
    private Long id;
    private String name;
    @JsonDeserialize(using = CustomerJackSon.MobileDeSerialize.class)
    private String mobile;
    @JsonDeserialize(using = CustomerJackSon.EmailDeSerialize.class)
    private String email;
    @JsonDeserialize(using = CustomerJackSon.IdentityDeSerialize.class)
    private String identity;
}

定义Controller接口

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping
    public UserRspVO get() {
        UserRspVO rsp = new UserRspVO();
        rsp.setId(1L);
        rsp.setName("张三");
        rsp.setMobile("18866661234");
        rsp.setEmail("zhangsan@qq.com");
        rsp.setIdentity("434113199901015566");
        return rsp;
    }

    @PutMapping
    public UserRspVO put(@RequestBody UserReqVO req) {
        System.out.println(req);
        UserRspVO rsp = new UserRspVO();
        BeanUtils.copyProperties(req, rsp);
        return rsp;
    }
}

接口请求示例:

GET http://localhost:8080/user

入参:
无

出参:
{
  "id": "1",
  "name": "张三",
  "mobile": "188****1234", // 配置了mobile=true
  "email": "zhangsan@qq.com", // 配置了email=false
  "identity": "434113199901015566" // 未配置identity,默认为false
}
PUT http://127.0.0.1:8080/user

入参:
{
    "id": "12124",
    "name": "张三",
    "mobile": "188****1234",
    "email": "zh****@qq.com",
    "identity": "434***********5566"
}

Controller反序列化后接收到的数据:
{
    "id": "12124",
    "name": "张三",
    "mobile": null, // 配置了mobile=true
    "email": "zh****@qq.com", // 配置了email=false
    "identity": "434***********5566" // 未配置identity,默认为false
}

四、实现原理

1、SpringBoot定义变量实现脱敏开关

读取yaml配置

@ConfigurationProperties(prefix = "spring.jackson.sensitive")
public class JacksonProperties {
    private Boolean mobile;
    private Boolean email;
    private Boolean identity;
}

变量注入到JacksonConfig

@Configuration
@EnableConfigurationProperties(JacksonProperties.class)
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper(JacksonProperties props) {
        ObjectMapper mapper = new ObjectMapper();
        ContextAttributes attrs = ContextAttributes.getEmpty()
                .withSharedAttribute("mobile", props.getMobile())
                .withSharedAttribute("email", props.getEmail())
                .withSharedAttribute("identity", props.getIdentity());
        mapper.setDefaultAttributes(attrs);
        return mapper;
    }
}

2、实现序列化、反序列化逻辑

public class CustomerJackSon {
    /**
     * 手机号脱敏序列化
     */
    public static class MobileSerialize extends JsonSerializer<String> {
        @Override
        public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (null == value || value.length() != 11) {
                jsonGenerator.writeString(value);
                return;
            }
            Boolean mobile = (Boolean) serializerProvider.getAttribute("mobile");
            if (null == mobile || !mobile) {
                jsonGenerator.writeString(value);
                return;
            }
            jsonGenerator.writeString(value.substring(0, 3) + "****" + value.substring(7));
        }
    }

    /**
     * 手机号脱敏数据检测并丢弃
     */
    public static class MobileDeSerialize extends JsonDeserializer<String> {

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
            String value = p.getText();
            if (null == value || value.length() != 11) {
                return value;
            }
            Boolean mobile = (Boolean) ctxt.getAttribute("mobile");
            if (null == mobile || !mobile) {
                return value;
            }
            if (value.contains("*")) {
                return null;
            }
            return value;
        }
    }

    /**
     * 邮箱脱敏序列化
     */
    public static class EmailSerialize extends JsonSerializer<String> {
        @Override
        public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (null == value || value.length() < 5) {
                jsonGenerator.writeString(value);
                return;
            }
            String[] split = value.split("@");
            if (split.length != 2 || split[0].length() < 2 || split[1].length() < 2) {
                jsonGenerator.writeString(value);
                return;
            }
            Boolean email = (Boolean) serializerProvider.getAttribute("email");
            if (null == email || !email) {
                jsonGenerator.writeString(value);
                return;
            }
            jsonGenerator.writeString(split[0].substring(0, 2) + "****@" + split[1]);
        }
    }

    /**
     * 邮箱脱敏数据检测并丢弃
     */
    public static class EmailDeSerialize extends JsonDeserializer<String> {

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
            String value = p.getText();
            if (null == value || value.length() < 5) {
                return value;
            }
            Boolean email = (Boolean) ctxt.getAttribute("email");
            if (null == email || !email) {
                return value;
            }
            if (value.contains("*")) {
                return null;
            }
            return value;
        }
    }

    /**
     * 身份证脱敏序列化
     */
    public static class IdentitySerialize extends JsonSerializer<String> {
        @Override
        public void serialize(String value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (null == value || value.length() != 18) {
                jsonGenerator.writeString(value);
                return;
            }
            Boolean identity = (Boolean) serializerProvider.getAttribute("identity");
            if (null == identity || !identity) {
                jsonGenerator.writeString(value);
                return;
            }
            jsonGenerator.writeString(value.substring(0, 3) + "***********" + value.substring(14));
        }
    }

    /**
     * 身份证脱敏数据检测并丢弃
     */
    public static class IdentityDeSerialize extends JsonDeserializer<String> {

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
            String value = p.getText();
            if (null == value || value.length() != 18) {
                return value;
            }
            Boolean identity = (Boolean) ctxt.getAttribute("identity");
            if (null == identity || !identity) {
                return value;
            }
            if (value.contains("*")) {
                return null;
            }
            return value;
        }
    }
}

网站文章

  • 计算机毕设ssmAndroid的在线投票系统85mgq(开题+源码)

    计算机毕设ssmAndroid的在线投票系统85mgq(开题+源码)

    研究目的: 本研究旨在设计和开发一种高效、安全、易用的Android在线投票系统,解决现有系统存在的问题,并提供一种可行的解决方案。通过该系统,用户可以方便地进行投票操作,管理员可以实时监控投票情况,...

    2024-02-29 11:31:36
  • 内存按照接口类型分通常有下面几种

    内存按照接口类型分通常有下面几种:DIMM(Dual Inline Memory Module,双列直插内存模块).SO-DIMM(Small Outline DIMM Module)为了满足笔记本电脑对内存尺寸的要求,SO-DIMM(Small Outline DIMM Mod

    2024-02-29 11:31:29
  • 多线程爬取王者荣耀游戏壁纸

    多线程爬取王者荣耀游戏壁纸

    多线程爬取王者荣耀游戏壁纸 https://pvp.qq.com/web201605/wallpaper.shtml 王者荣耀游戏壁纸的下载页面 右键检查 但是在网页源代码里找不到壁纸的链接 这个文件...

    2024-02-29 11:31:23
  • 基于Open3D的点云处理10-三维质心

    基于Open3D的点云处理10-三维质心

    2024-02-29 11:31:16
  • java8 gc_java8中字符串常量以及GC相应处理机制

    1,常量池1.1, class文件常量池class文件常量池位于class文件中 class文件头4个字节称为魔数,魔数后面的4个字节为文件版本号,而版本号之后的就是常量池的入口。该常量池用于存放编译器生成的各种字面量和符号引用,字面量就是所谓的常量,如字符串,final修饰的常量值等。而符号引用则是用来描述引用目标的,如类和接口的全限定名,方法和字段的名称和描述符。此时符号引用并不会存储最...

    2024-02-29 11:30:48
  • MVC的验证(模型注解和非侵入式脚本的结合使用) .Net中初探Redis .net通过代码发送邮件 Log4net (Log for .net) 使用GDI技术创建ASP.NET验证码 ...

    MVC的验证(模型注解和非侵入式脚本的结合使用) .Net中初探Redis .net通过代码发送邮件 Log4net (Log for .net) 使用GDI技术创建ASP.NET验证码 ...

    MVC的验证(模型注解和非侵入式脚本的结合使用) @HtmlHrlper方式创建的标签,会自动生成一些属性,其中一些属性就是关于验证 如图示例: 模型注解 通过模型注解后,MVC的验证,包括前台客户端,后台服务器的验证,MVC统统都做了包含,即使用户在客户端禁用Javascript,服务器也会将非法操作进行验证,当前前提是针对Model实体标识了...

    2024-02-29 11:30:39
  • Android应用程序调用硬件抽象层(HAL)接口实现功能

    通过使用硬件抽象层(HAL)接口,Android应用程序可以与底层硬件进行通信,实现与硬件相关的功能。硬件抽象层(HAL)是Android系统的一部分,它提供了一个标准化的接口,用于访问底层硬件功能。...

    2024-02-29 11:30:33
  • Golang简单写文件操作的四种方法

    package mainimport ( "bufio" //缓存IO "fmt" "io" "io/ioutil" //io 工具包 "os")func check(e error) { if e ...

    2024-02-29 11:30:03
  • javascript __proto___ prototype和Function原代码狂想

    javascript __proto___ prototype和Function原代码狂想

    ----我以为的Function---- 1 function Function ( ) { 2 this.prototype = new this() ; /*这就导致了所有的函...

    2024-02-29 11:29:55
  • 线性DP-入门篇

    线性DP-入门篇

    线性动态规划的主要特点是状态转移的推导是按照问题规模 从小到大依次推导,较大规模的问题的解依赖较小规模的问题的解。

    2024-02-29 11:29:46