• Spring Boot 接口数据加解密，so easy!

    今天这篇文章聊一聊接口安全问题，涉及到接口的加密、解密

    和产品、前端同学对外需求后，梳理了相关技术方案， 主要的需求点如下：

    1. 尽量少改动，不影响之前的业务逻辑；

    2. 考虑到时间紧迫性，可采用对称性加密方式，服务需要对接安卓、IOS、H5三端，另外考虑到H5端存储密钥安全性相对来说会低一些，故分针对H5和安卓、IOS分配两套密钥；

    3. 要兼容低版本的接口，后面新开发的接口可不用兼容；

    4. 接口有GET和POST两种接口，需要都要进行加解密；

    需求解析：

    1. 服务端、客户端和H5统一拦截加解密，网上有成熟方案，也可以按其他服务中实现的加解密流程来搞；

    2. 使用AES放松加密，考虑到H5端存储密钥安全性相对来说会低一些，故分针对H5和安卓、IOS分配两套密钥；

    3. 本次涉及客户端和服务端的整体改造，经讨论，新接口统一加 /secret/ 前缀来区分

    按本次需求来简单还原问题，定义两个对象，后面用得着，

    用户类：

    1. @Data
    2. public class User {
    3.     private Integer id;
    4.     private String name;
    5.     private UserType userType = UserType.COMMON;
    6.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    7.     private LocalDateTime registerTime;
    8. }

    用户类型枚举类：

    1. @Getter
    2. @JsonFormat(shape = JsonFormat.Shape.OBJECT)
    3. public enum UserType {
    4.     VIP("VIP用户"),
    5.     COMMON("普通用户");
    6.     private String code;
    7.     private String type;
    8.  
    9.     UserType(String type) {
    10.         this.code = name();
    11.         this.type = type;
    12.     }
    13. }

    构造一个简单的用户列表查询示例：

    1. @RestController
    2. @RequestMapping(value = {"/user", "/secret/user"})
    3. public class UserController {
    4.     @RequestMapping("/list")
    5.     ResponseEntity<List<User>> listUser() {
    6.         List<User> users = new ArrayList<>();
    7.         User u = new User();
    8.         u.setId(1);
    9.         u.setName("boyka");
    10.         u.setRegisterTime(LocalDateTime.now());
    11.         u.setUserType(UserType.COMMON);
    12.         users.add(u);
    13.         ResponseEntity<List<User>> response = new ResponseEntity<>();
    14.         response.setCode(200);
    15.         response.setData(users);
    16.         response.setMsg("用户列表查询成功");
    17.         return response;
    18.     }
    19. }

    调用：localhost:8080/user/list

    查询结果如下，没毛病：

    1. {
    2.  "code": 200,
    3.  "data": [{
    4.   "id": 1,
    5.   "name": "boyka",
    6.   "userType": {
    7.    "code": "COMMON",
    8.    "type": "普通用户"
    9.   },
    10.   "registerTime": "2022-03-24 23:58:39"
    11.  }],
    12.  "msg": "用户列表查询成功"
    13. }

    目前主要是利用ControllerAdvice来对请求和响应体进行拦截，主要定义SecretRequestAdvice对请求进行加密和SecretResponseAdvice对响应进行加密(实际情况会稍微复杂一点，项目中又GET类型请求，自定义了一个Filter进行不同的请求解密处理)。

    好了，网上的ControllerAdvice使用示例非常多，我这把两个核心方法给大家展示看看，相信大佬们一看就晓得了，不需多言。上代码：

    SecretRequestAdvice请求解密：

    1. @ControllerAdvice
    2. @Order(Ordered.HIGHEST_PRECEDENCE)
    3. @Slf4j
    4. public class SecretRequestAdvice extends RequestBodyAdviceAdapter {
    5.     @Override
    6.     public boolean supports(MethodParameter methodParameter, Type type, Class<? extends HttpMessageConverter<?>> aClass) {
    7.         return true;
    8.     }
    9.  
    10.     @Override
    11.     public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
    12.         //如果支持加密消息，进行消息解密。
    13.         String httpBody;
    14.         if (Boolean.TRUE.equals(SecretFilter.secretThreadLocal.get())) {
    15.             httpBody = decryptBody(inputMessage);
    16.         } else {
    17.             httpBody = StreamUtils.copyToString(inputMessage.getBody(), Charset.defaultCharset());
    18.         }
    19.         //返回处理后的消息体给messageConvert
    20.         return new SecretHttpMessage(new ByteArrayInputStream(httpBody.getBytes()), inputMessage.getHeaders());
    21.     }
    22.  
    23.     /**
    24.      * 解密消息体
    25.      *
    26.      * @param inputMessage 消息体
    27.      * @return 明文
    28.      */
    29.     private String decryptBody(HttpInputMessage inputMessage) throws IOException {
    30.         InputStream encryptStream = inputMessage.getBody();
    31.         String requestBody = StreamUtils.copyToString(encryptStream, Charset.defaultCharset());
    32.         // 验签过程
    33.         HttpHeaders headers = inputMessage.getHeaders();
    34.         if (CollectionUtils.isEmpty(headers.get("clientType"))
    35.                 || CollectionUtils.isEmpty(headers.get("timestamp"))
    36.                 || CollectionUtils.isEmpty(headers.get("salt"))
    37.                 || CollectionUtils.isEmpty(headers.get("signature"))) {
    38.             throw new ResultException(SECRET_API_ERROR, "请求解密参数错误，clientType、timestamp、salt、signature等参数传递是否正确传递");
    39.         }
    40.  
    41.         String timestamp = String.valueOf(Objects.requireNonNull(headers.get("timestamp")).get(0));
    42.         String salt = String.valueOf(Objects.requireNonNull(headers.get("salt")).get(0));
    43.         String signature = String.valueOf(Objects.requireNonNull(headers.get("signature")).get(0));
    44.         String privateKey = SecretFilter.clientPrivateKeyThreadLocal.get();
    45.         ReqSecret reqSecret = JSON.parseObject(requestBody, ReqSecret.class);
    46.         String data = reqSecret.getData();
    47.         String newSignature = "";
    48.         if (!StringUtils.isEmpty(privateKey)) {
    49.             newSignature = Md5Utils.genSignature(timestamp + salt + data + privateKey);
    50.         }
    51.         if (!newSignature.equals(signature)) {
    52.             // 验签失败
    53.             throw new ResultException(SECRET_API_ERROR, "验签失败，请确认加密方式是否正确");
    54.         }
    55.  
    56.         try {
    57.             String decrypt = EncryptUtils.aesDecrypt(data, privateKey);
    58.             if (StringUtils.isEmpty(decrypt)) {
    59.                 decrypt = "{}";
    60.             }
    61.             return decrypt;
    62.         } catch (Exception e) {
    63.             log.error("error: ", e);
    64.         }
    65.         throw new ResultException(SECRET_API_ERROR, "解密失败");
    66.     }
    67. }

    SecretResponseAdvice响应加密：

    1. @ControllerAdvice
    2. public class SecretResponseAdvice implements ResponseBodyAdvice {
    3.     private Logger logger = LoggerFactory.getLogger(SecretResponseAdvice.class);
    4.  
    5.     @Override
    6.     public boolean supports(MethodParameter methodParameter, Class aClass) {
    7.         return true;
    8.     }
    9.  
    10.     @Override
    11.     public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
    12.         // 判断是否需要加密
    13.         Boolean respSecret = SecretFilter.secretThreadLocal.get();
    14.         String secretKey = SecretFilter.clientPrivateKeyThreadLocal.get();
    15.         // 清理本地缓存
    16.         SecretFilter.secretThreadLocal.remove();
    17.         SecretFilter.clientPrivateKeyThreadLocal.remove();
    18.         if (null != respSecret && respSecret) {
    19.             if (o instanceof ResponseBasic) {
    20.                 // 外层加密级异常
    21.                 if (SECRET_API_ERROR == ((ResponseBasic) o).getCode()) {
    22.                     return SecretResponseBasic.fail(((ResponseBasic) o).getCode(), ((ResponseBasic) o).getData(), ((ResponseBasic) o).getMsg());
    23.                 }
    24.                 // 业务逻辑
    25.                 try {
    26.                     String data = EncryptUtils.aesEncrypt(JSON.toJSONString(o), secretKey);
    27.                     // 增加签名
    28.                     long timestamp = System.currentTimeMillis() / 1000;
    29.                     int salt = EncryptUtils.genSalt();
    30.                     String dataNew = timestamp + "" + salt + "" + data + secretKey;
    31.                     String newSignature = Md5Utils.genSignature(dataNew);
    32.                     return SecretResponseBasic.success(data, timestamp, salt, newSignature);
    33.                 } catch (Exception e) {
    34.                     logger.error("beforeBodyWrite error:", e);
    35.                     return SecretResponseBasic.fail(SECRET_API_ERROR, "", "服务端处理结果数据异常");
    36.                 }
    37.             }
    38.         }
    39.         return o;
    40.     }
    41. }

    OK， 代码Demo撸好了，试运行一波：

    1. 请求方法：
    2. localhost:8080/secret/user/list
    3.  
    4. header:
    5. Content-Type:application/json
    6. signature:55efb04a83ca083dd1e6003cde127c45
    7. timestamp:1648308048
    8. salt:123456
    9. clientType:ANDORID
    10.  
    11. body体:
    12. // 原始请求体
    13. {
    14.  "page": 1,
    15.  "size": 10
    16. }
    17. // 加密后的请求体
    18. {
    19.  "data": "1ZBecdnDuMocxAiW9UtBrJzlvVbueP9K0MsIxQccmU3OPG92oRinVm0GxBwdlXXJ"
    20. }
    21.  
    22. // 加密响应体：
    23. {
    24.     "data": "fxHYvnIE54eAXDbErdrDryEsIYNvsOOkyEKYB1iBcre/QU1wMowHE2BNX/je6OP3NlsCtAeDqcp7J1N332el8q2FokixLvdxAPyW5Un9JiT0LQ3MB8p+nN23pTSIvh9VS92lCA8KULWg2nViSFL5X1VwKrF0K/dcVVZnpw5h227UywP6ezSHjHdA+Q0eKZFGTEv3IzNXWqq/otx5fl1gKQ==",
    25.     "code": 200,
    26.     "signature": "aa61f19da0eb5d99f13c145a40a7746b",
    27.     "msg": "",
    28.     "timestamp": 1648480034,
    29.     "salt": 632648
    30. }
    31.  
    32. // 解密后的响应体：
    33. {
    34.  "code": 200,
    35.  "data": [{
    36.   "id": 1,
    37.   "name": "boyka",
    38.   "registerTime": "2022-03-27T00:19:43.699",
    39.   "userType": "COMMON"
    40.  }],
    41.  "msg": "用户列表查询成功",
    42.  "salt": 0
    43. }

    OK，客户端请求加密-》发起请求-》服务端解密-》业务处理-》服务端响应加密-》客户端解密展示，看起来没啥问题，实际是头天下午花了2小时碰需求，差不多花1小时写好demo测试，然后对所有接口统一进行了处理，整体一下午赶脚应该行了吧，告诉H5和安卓端同学明儿上午联调（不小的大家到这个时候发现猫腻没有，当时确实疏忽了，翻了大车......）

    次日，安卓端反馈，你这个加解密有问题，解密后的数据格式和之前不一样，仔细一看，擦，这个userType和registerTime是不对劲，开始思考：这个能是哪儿的问题呢？1s之后，初步定位，应该是响应体的JSON.toJSONString的问题：

    String data = EncryptUtils.aesEncrypt(JSON.toJSONString(o)),

    Debug断点调试，果然，是JSON.toJSONString(o)这一步骤转换出了问题，那JSON转换时是不是有高级属性可以配置生成想要的序列化格式呢？FastJson在序列化时提供重载方法，找到其中一个"SerializerFeature"参数可以琢磨一下，这个参数是可以对序列化进行配置的，它提供了很多配置类型，其中感觉这几个比较沾边：

    1. WriteEnumUsingToString,
    2. WriteEnumUsingName,
    3. UseISO8601DateFormat

    对枚举类型来说，默认是使用的WriteEnumUsingName(枚举的Name)， 另一种WriteEnumUsingToString是重新toString方法，理论上可以转换成想要的样子，即这个样子：

    1. @Getter
    2. @JsonFormat(shape = JsonFormat.Shape.OBJECT)
    3. public enum UserType {
    4.     VIP("VIP用户"),
    5.     COMMON("普通用户");
    6.     private String code;
    7.     private String type;
    8.  
    9.     UserType(String type) {
    10.         this.code = name();
    11.         this.type = type;
    12.     }
    13.  
    14.     @Override
    15.     public String toString() {
    16.         return "{" +
    17.                 "\"code\":\"" + name() + '\"' +
    18.                 ", \"type\":\"" + type + '\"' +
    19.                 '}';
    20.     }
    21. }

    结果转换出来的数据是字符串类型"{"code":"COMMON", "type":"普通用户"}"，这个方法好像行不通，还有什么好办法呢？思前想后，看文章开始定义的User和UserType类，标记数据序列化格式@JsonFormat，再突然想起之前看到过的一些文章，SpringMVC底层默认是使用Jackson进行序列化的，那好了，就用Jacksong实施呗，将SecretResponseAdvice中的序列化方法替换一下：

    1. String data = EncryptUtils.aesEncrypt(JSON.toJSONString(o), secretKey);
    2.  换为：
    3. String data =EncryptUtils.aesEncrypt(new ObjectMapper().writeValueAsString(o), secretKey);

    重新运行一波，走起：

    1. {
    2.  "code": 200,
    3.  "data": [{
    4.   "id": 1,
    5.   "name": "boyka",
    6.   "userType": {
    7.    "code": "COMMON",
    8.    "type": "普通用户"
    9.   },
    10.   "registerTime": {
    11.    "month": "MARCH",
    12.    "year": 2022,
    13.    "dayOfMonth": 29,
    14.    "dayOfWeek": "TUESDAY",
    15.    "dayOfYear": 88,
    16.    "monthValue": 3,
    17.    "hour": 22,
    18.    "minute": 30,
    19.    "nano": 453000000,
    20.    "second": 36,
    21.    "chronology": {
    22.     "id": "ISO",
    23.     "calendarType": "iso8601"
    24.    }
    25.   }
    26.  }],
    27.  "msg": "用户列表查询成功"
    28. }

    解密后的userType枚举类型和非加密版本一样了，舒服了，== 好像还不对，registerTime怎么变成这个样子了？原本是"2022-03-24 23:58:39"这种格式的，网上有很多解决方案，不过用在我们目前这个需求里面，就是有损改装了啊，不太可取，遂去Jackson官网上查找一下相关文档，当然Jackson也提供了ObjectMapper的序列化配置，重新再初始化配置ObjectMpper对象：

    1. String DATE_TIME_FORMATTER = "yyyy-MM-dd HH:mm:ss";
    2. ObjectMapper objectMapper = new Jackson2ObjectMapperBuilder()
    3.                             .findModulesViaServiceLoader(true)
    4.                             .serializerByType(LocalDateTime.class, new LocalDateTimeSerializer(
    5.                                     DateTimeFormatter.ofPattern(DATE_TIME_FORMATTER)))
    6.                             .deserializerByType(LocalDateTime.class, new LocalDateTimeDeserializer(
    7.                                     DateTimeFormatter.ofPattern(DATE_TIME_FORMATTER)))
    8.                             .build();

    转换结果：

    1. {
    2.  "code": 200,
    3.  "data": [{
    4.   "id": 1,
    5.   "name": "boyka",
    6.   "userType": {
    7.    "code": "COMMON",
    8.    "type": "普通用户"
    9.   },
    10.   "registerTime": "2022-03-29 22:57:33"
    11.  }],
    12.  "msg": "用户列表查询成功"
    13. }

    OK，和非加密版的终于一致了，完了吗？感觉还是可能存在些什么问题，首先业务代码的时间序列化需求不一样，有"yyyy-MM-dd hh:mm:ss"的，也有"yyyy-MM-dd"的，还可能其他配置思考不到位的，导致和之前非加密版返回数据不一致的问题，到时候联调测出来了也麻烦，有没有一劳永逸的办法呢？哎，这个时候如果你看过 Spring 源码的话，就应该知道spring框架自身是怎么序列化的，照着配置应该就行嘛，好像有点道理，我这里不从0开始分析源码了。另外，搜索公众号顶级架构师后台回复“offer”，获取一份惊喜礼包。

    跟着执行链路，找到具体的响应序列化，重点就是RequestResponseBodyMethodProcessor，

    1. protected <T> void writeWithMessageConverters(@Nullable T value, MethodParameter returnType, ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage) throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {
    2.         // 获取响应的拦截器链并执行beforeBodyWrite方法，也就是执行了我们自定义的SecretResponseAdvice中的beforeBodyWrite啦
    3.   body = this.getAdvice().beforeBodyWrite(body, returnType, selectedMediaType, converter.getClass(), inputMessage, outputMessage);
    4.   if (body != null) {
    5.       // 执行响应体序列化工作
    6.    if (genericConverter != null) {
    7.     genericConverter.write(body, (Type)targetType, selectedMediaType, outputMessage);
    8.    } else {
    9.     converter.write(body, selectedMediaType, outputMessage);
    10.    }
    11.     }

    进而通过实例化的AbstractJackson2HttpMessageConverter对象找到执行序列化的核心方法

    1. -> AbstractGenericHttpMessageConverter:
    2.  
    3.  public final void write(T t, @Nullable Type type, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
    4.         ...
    5.   this.writeInternal(t, type, outputMessage);
    6.   outputMessage.getBody().flush();
    7.      
    8.     }
    9.  -> 找到Jackson序列化 AbstractJackson2HttpMessageConverter:
    10.  // 从spring容器中获取并设置的ObjectMapper实例
    11.  protected ObjectMapper objectMapper;
    12.  
    13.  protected void writeInternal(Object object, @Nullable Type type, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
    14.         MediaType contentType = outputMessage.getHeaders().getContentType();
    15.         JsonEncoding encoding = this.getJsonEncoding(contentType);
    16.         JsonGenerator generator = this.objectMapper.getFactory().createGenerator(outputMessage.getBody(), encoding);
    17.  
    18.   this.writePrefix(generator, object);
    19.   Object value = object;
    20.   Class<?> serializationView = null;
    21.   FilterProvider filters = null;
    22.   JavaType javaType = null;
    23.   if (object instanceof MappingJacksonValue) {
    24.    MappingJacksonValue container = (MappingJacksonValue)object;
    25.    value = container.getValue();
    26.    serializationView = container.getSerializationView();
    27.    filters = container.getFilters();
    28.   }
    29.  
    30.   if (type != null && TypeUtils.isAssignable(type, value.getClass())) {
    31.    javaType = this.getJavaType(type, (Class)null);
    32.   }
    33.  
    34.   ObjectWriter objectWriter = serializationView != null ? this.objectMapper.writerWithView(serializationView) : this.objectMapper.writer();
    35.   if (filters != null) {
    36.    objectWriter = objectWriter.with(filters);
    37.   }
    38.  
    39.   if (javaType != null && javaType.isContainerType()) {
    40.    objectWriter = objectWriter.forType(javaType);
    41.   }
    42.  
    43.   SerializationConfig config = objectWriter.getConfig();
    44.   if (contentType != null && contentType.isCompatibleWith(MediaType.TEXT_EVENT_STREAM) && config.isEnabled(SerializationFeature.INDENT_OUTPUT)) {
    45.    objectWriter = objectWriter.with(this.ssePrettyPrinter);
    46.   }
    47.         // 重点进行序列化
    48.   objectWriter.writeValue(generator, value);
    49.   this.writeSuffix(generator, object);
    50.   generator.flush();
    51.     }

    那么，可以看出SpringMVC在进行响应序列化的时候是从容器中获取的ObjectMapper实例对象，并会根据不同的默认配置条件进行序列化，那处理方法就简单了，我也可以从Spring容器拿数据进行序列化啊。SecretResponseAdvice进行如下进一步改造：

    1. @ControllerAdvice
    2. public class SecretResponseAdvice implements ResponseBodyAdvice {
    3.  
    4.     @Autowired
    5.     private ObjectMapper objectMapper;
    6.      
    7.       @Override
    8.     public Object beforeBodyWrite(....) {
    9.         .....
    10.         String dataStr =objectMapper.writeValueAsString(o);
    11.         String data = EncryptUtils.aesEncrypt(dataStr, secretKey);
    12.         .....
    13.     }
    14.  }

    经测试，响应数据和非加密版万全一致啦，还有GET部分的请求加密，以及后面加解密惨遭跨域问题，后面有空再和大家聊聊。

  • 相关阅读:
    从 MMU 看内存管理
    主成分分析法(数学建模)教授先生
    锐捷Wlan——AC三层组网旁挂实验
    MultipartFile 上传文件的踩坑点
    【Verilog】除2，正负数
    House of pig 原理详解&实战
    记录一下Java中关于引用的用法
    链表的有序构建和查找
    Azkaban (二) --------- Azkaban 入门
    stream对list数据进行多字段去重
  • 原文地址：https://blog.csdn.net/m0_71777195/article/details/126763296