中国 帮助

API加解密

核心说明 API 加密主要用于防止传输过程被拦截(如代理劫持)。 前端必须解密后展示,因此无论公钥/私钥最终都可被用于解密。 由于 JS 环境缺少“公钥解密”的通用实现,因此前端使用私钥进行解密。 如有更优方案,欢迎反

API加解密
封面

> 本文整理自平台文档 docs/wujies/5.x/ruoyi-vue-plus/framework/extend/api_encrypt.mdx,用于站点内容演示。

(https://console.wujies.cn/remote-apps/cms-assets/doc-52026ca9fa1d-cover.svg)

  • - -

核心说明

API 加密主要用于防止传输过程被拦截(如代理劫持)。 前端必须解密后展示,因此无论公钥/私钥最终都可被用于解密。 由于 JS 环境缺少“公钥解密”的通用实现,因此前端使用私钥进行解密。

如有更优方案,欢迎反馈与共建。

1. 使用注解 @ApiEncrypt

  • 标注该注解的接口,请求参数必须加密
  • response 参数控制响应是否加密,默认 false
  • 加解密逻辑由过滤器处理:org.dromara.common.encrypt.filter.CryptoFilter

补充说明:

  • 当前项目里登录、注册、部分用户与租户相关接口已经使用了该能力。
  • 前端只有在请求头里显式携带 isEncrypt: true 时,才会对该次请求体执行加密。

2. 配置方式

后端配置:application.yml

![输入图片说明](https://foruda.gitee.com/images/1701131796468961065/83c464cd_4959041.png "屏幕截图")

前端配置:.env.development / .env.production

![输入图片说明](https://foruda.gitee.com/images/1709533252413969800/1d0dff25_1766278.png "屏幕截图")

注意事项:

  • 公私钥需前后端配对一致
  • 后端公钥对应前端私钥;后端私钥对应前端公钥

补充说明:

  • 后端配置节点为 api-decrypt,默认 headerFlag 是 encrypt-key。
  • 前端总开关是 VITE_APP_ENCRYPT,如果后端关闭该功能,前端也要同步关闭。

3. 前端开启加密

在请求头中加入 isEncrypt: true:

headers: {
  isEncrypt: true
}

![输入图片说明](https://foruda.gitee.com/images/1701137141916998346/5e839bbe_4959041.png "屏幕截图")

补充说明:

  • 当前前端实现只会对 POST、PUT 请求体进行加密,GET 请求不会走请求体加密流程。
  • 前端会随机生成 AES 密钥加密请求体,再用 RSA 处理 AES 密钥,通过 encrypt-key 请求头传给后端。
  • 响应如果带有同名响应头,前端会自动解密并还原成 JSON。

4. 请求/响应加解密说明

详见:[关于请求响应参数解密](/docs/wujies/5.x/questions/api_encrypt/)

密钥生成说明

![输入图片说明](https://foruda.gitee.com/images/1675577852271308699/9b30258e_1766278.png "屏幕截图")

本文导览

(https://console.wujies.cn/remote-apps/cms-assets/doc-52026ca9fa1d-guide.svg)

章节导览
THE END

喜欢就支持以下吧

评论区需要浏览器启用 JavaScript 才能加载。

回到内容