Apifox 中如何处理加密或编码过的响应数据?

2024-06-21 20:28

本文主要是介绍Apifox 中如何处理加密或编码过的响应数据?,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

接口返回的响应数据有时是经过编码或加密处理的,要转换成可读的明文,可以使用 Apifox 内置的 JS 类库、或者通过调用外部编程语言 (如 Python、JavaScript 等) 来进行处理。

例如,一个经过 Base64 编码的数据可以通过内置类库进行解码,转换成可读的明文:

图片

下面就来分享一些常见的解码、解密例子。

解码响应数据

1、Base64 解码

当接口返回的数据经过 Base64 编码时,可以通过 CryptoJS 库进行解码,Apifox 中内置了该类库,因此可以直接在脚本中引入并使用。

比如接口返回的 Base64 编码数据为:

{    "data": "5L2g5aW977yMQXBpZm94IQ=="}

使用 CryptoJS 库来解码这个 Base64 编码的字符串,其示例脚本如下:

// 引入 CryptoJS 库const CryptoJS = require("crypto-js");// Base64 编码的字符串(一般从响应数据中提取)let encodedData = {"data": "5L2g5aW977yMQXBpZm94IQ=="}// 解码 Base64 编码的数据let decodedData = CryptoJS.enc.Base64.parse(encodedData.data).toString(CryptoJS.enc.Utf8);// 输出解码后的结果console.log(decodedData); // "你好,Apifox!"

在 Apifox 中,你可以在「后置操作」中添加一个自定义脚本,将上述解码逻辑编写其中。当接口发送请求后,可在响应面板的「控制台」中查看解码后的数据。

图片

此外,解码后的数据也可以存储到环境变量中,以供后续使用。例如:

pm.environment.set("decodedData",decodedData);

如果接口返回的 JSON 数据是以 Base64 编码形式出现的,可以同样使用 CryptoJS 库进行解码,并通过 pm.response.setBody() 方法将解码后的 JSON 数据设置为响应 Body。

比如下面返回的是一个经过 Base64 编码后的 JSON 响应:

图片

要将其解码,并将解码的 JSON 数据显示在响应 Body 中,示例脚本如下:

// 引入 CryptoJS 库const CryptoJS = require("crypto-js");// Base64 编码的字符串(从返回的响应数据中获取)let encodedData = pm.response.text();// 解码 Base64 编码的数据let decodedData = CryptoJS.enc.Base64.parse(encodedData).toString(CryptoJS.enc.Utf8);// 解析解码后的 JSON 字符串let jsonData = JSON.parse(decodedData);// 将解析后的 JSON 数据设置为响应体pm.response.setBody(jsonData);

图片

2、URLEncode 解码

当接口返回的数据经过 URLEncode 编码时,可以使用 JavaScript 内置的 decodeURIComponent() 方法进行解码。

例如,一个接口返回的数据是经过 URLEncode 编码的 JSON 字符串,这个字符串包含了几个键值对,其中值是被 URLEncode 编码的。

{"name": "%E5%BC%A0%E4%B8%89","email": "qxhswppn%40gmail.com"}

我们可以使用 decodeURIComponent() 方法来解码这个 JSON 字符串中的编码值,将它们转换为正常的字符串。示例脚本如下:

// 假设这是从接口返回的编码后的 JSON 数据(一般从响应数据中获取)let response = {"name": "%E5%BC%A0%E4%B8%89","email": "qxhswppn%40gmail.com"};// 使用 decodeURIComponent 进行解码let decodedName = decodeURIComponent(response.name);let decodedEmail = decodeURIComponent(response.email);console.log(decodedName); // "张三"console.log(decodedEmail); // "qxhswppn@gmail.com"

图片

解密 响应数据

1、AES 解密

要解密 AES 加密的密文,需要提供相应的密钥或初始向量 (IV) 。AES 使用对称加密算法,这意味着同一个密钥用于加密和解密,如果没有正确的密钥或者 IV,就无法解密密文。

假设有一个经过 AES 加密的密文,其加密模式为 ECB,填充模式为 Pkcs7。要在 Apifox 中解密该密文,可以使用内置的 CryptoJS 库进行解密。其 AES 解密脚本示例如下:

// 引入 CryptoJS 库const CryptoJS = require('crypto-js');// 经过 Base64 编码的 AES 加密后的密文(一般从响应数据中提取)const ciphertext = "Gig+YJFu4fLrrexzam/vblRV3hoT25hPZn0HoNoosHQ=";// 解密所需密钥,确保是 16/24/32 字节(一般从环境变量中读取)const key = CryptoJS.enc.Utf8.parse('1234567891234567');// AES 解密const decryptedBytes = CryptoJS.AES.decrypt(ciphertext, key, {mode: CryptoJS.mode.ECB, // 解密模式padding: CryptoJS.pad.Pkcs7 // 填充方式});// 将解密后的字节数组转换为 UTF-8 字符串const originalText = decryptedBytes.toString(CryptoJS.enc.Utf8);// 输出解密后的文本console.log(originalText); // "你好,Apifox!"

解密后的数据可在响应控制台中查看:

图片

2、RSA 解密

要解密 RSA 加密的密文,需要提供相应的 RSA 私钥,因为 RSA 是一种非对称加密算法,密钥对包含公钥和私钥,没有私钥无法解密密文  仅针对 RSA 公钥加密,私钥解密的场景) 。

Apifox 内置了 jsrsasign 库 (10.3.0 版本) ,可以利用该库来解密 RSA 密文,示例如下:

// 引入 jsrsasign 库const jsrsasign = require('jsrsasign');// 定义私钥(一般从环境变量中读取)const privateKeyPEM = `-----BEGIN PRIVATE KEY-----私钥……-----END PRIVATE KEY-----`;// 定义密文(一般从响应数据中提取)const ciphertext = '';// 解密const prvKeyObj = jsrsasign.KEYUTIL.getKey(privateKeyPEM);const decrypted = jsrsasign.KJUR.crypto.Cipher.decrypt(ciphertext, prvKeyObj);console.log(decrypted);

图片

一个简单的 RSA 加密解密的完整示例参考 (注意 jsrsasign 版本为 10.3.0,其它版本语法可能会不兼容) ,你可以将其在 Node.js 环境下运行,并根据需要在 Apifox 中执行加密或解密的操作:

const rsa = require('jsrsasign');// 生成 RSA 密钥对const keypair = rsa.KEYUTIL.generateKeypair("RSA", 2048);const publicKey = rsa.KEYUTIL.getPEM(keypair.pubKeyObj);const privateKey = rsa.KEYUTIL.getPEM(keypair.prvKeyObj, "PKCS8PRV");console.log("公钥:", publicKey);console.log("私钥:", privateKey);// 用公钥加密const plaintext = "你好,Apifox!";const pubKeyObj = rsa.KEYUTIL.getKey(publicKey);const encryptedHex = rsa.KJUR.crypto.Cipher.encrypt(plaintext, pubKeyObj);console.log("加密密钥:", encryptedHex);// 用私钥解密const prvKeyObj = rsa.KEYUTIL.getKey(privateKey);const decrypted = rsa.KJUR.crypto.Cipher.decrypt(encryptedHex, prvKeyObj);console.log("解密明文:", decrypted);

图片

3、调用外部程序进行解密

除了使用 Apifox 内置的 JS 类库进行解密,还可以通过调用「外部程序」来完成解密。

有关「外部程序」的使用,你可以参考这篇文章:《如何在 Apifox 中调用其他语言(Java、PHP、Python、Go 等)》,或者访问 Apifox 的帮助文档,里面有更详细的介绍。

外部程序是保存在「外部程序目录」下的代码文件,这些文件可以是 Java 程序归档文件 .jar 包,也可以是其他编程语言的代码源文件,例如 .py、.php、.js 等后缀的文件。文件需要放到「外部程序目录」下,这个目录可以在页面右上角的「设置->外部程序」中打开。

图片

举个例子!

例如要通过 Node.js 的 node-forge 库来进行 RSA 解密,这时候就可以在「外部程序目录」中创建一个 .js 文件来编写解密逻辑,然后在 Apifox 的「后置操作」中调用这个 .js 文件,以获取解密后的明文。具体操作如下:

创建解密脚本

首先创建一个 .js 文件,在文件中编写解密逻辑,因为要用到 node-forge 库,所以还需要在该目录下使用 npm 或 yarn 安装该库,并在 .js 解密文件中引入。其它编程语言也是类似的,需要引入什么库就在本地进行安装,确保程序能够在本地运行无误即可。

图片

接下来,在 .js 文件中编写解密逻辑,示例代码如下:

// 引入 node-forge 库const forge = require('node-forge');// 获取命令行参数const args = process.argv.slice(2);// 私钥(PEM 格式)const privateKeyPem = `-----BEGIN RSA PRIVATE KEY-----私钥……-----END RSA PRIVATE KEY-----`;// 加密密文,从命令行获取const encrypted = args[0];// 将 PEM 格式的私钥转换为 forge 的私钥对象const privateKey = forge.pki.privateKeyFromPem(privateKeyPem);// 将 Base64 编码的加密数据转换为字节数组const encryptedBytes = forge.util.decode64(encrypted);// 解密数据const decrypted = privateKey.decrypt(encryptedBytes, 'RSA-OAEP');// console.log() 输出的内容会被 Apifox 捕获console.log(decrypted);

这个脚本的逻辑是:

  • 从命令行参数获取加密的密文,该密文在 Apifox 中以命令行的方式传过来 (JavaScript 中通过process.argv获取命令行参数,其它编程语言需要根据对应的语法来获取)
  • 使用 PEM 格式的私钥进行解密。
  • 将解密后的明文通过 console.log() 输出,供 Apifox 捕获并返回。

在 Apifox 中调用外部程序

编写完解密脚本后,可以在 Apifox 的「后置操作」中使用 pm.executeAsync() 方法来调用该「外部程序」。注意需确保将解密脚本放在正确的外部程序目录中,并且在 Apifox 中调用该解密脚本时,引用的路径是相对于该目录的。在 Apifox 调用「外部程序」的示例代码如下:

// 加密密文(一般从返回的响应数据中获取)const encrypted = 'iDqUyR3BpaTqpzq…………'// 外部程序路径,传递参数const result = await pm.executeAsync('./nodejs-rsa/rsa.js', [`${encrypted}`])console.log('Result:', result);

当接口发送请求后,Apifox 会自动将密文传递给定义好的外部程序,执行解密操作,并捕获外部程序通过 console.log() 输出的结果,最终返回解密后的明文,如下图所示:

图片

这种解密方式不仅限于 Node.js,其他编程语言如 Java、PHP、Python、Go 等都可以进行类似的操作和调用。

这篇关于Apifox 中如何处理加密或编码过的响应数据?的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1082245

相关文章

Linux下利用select实现串口数据读取过程

《Linux下利用select实现串口数据读取过程》文章介绍Linux中使用select、poll或epoll实现串口数据读取,通过I/O多路复用机制在数据到达时触发读取,避免持续轮询,示例代码展示设... 目录示例代码(使用select实现)代码解释总结在 linux 系统里,我们可以借助 select、

解决docker目录内存不足扩容处理方案

《解决docker目录内存不足扩容处理方案》文章介绍了Docker存储目录迁移方法:因系统盘空间不足,需将Docker数据迁移到更大磁盘(如/home/docker),通过修改daemon.json配... 目录1、查看服务器所有磁盘的使用情况2、查看docker镜像和容器存储目录的空间大小3、停止dock

5 种使用Python自动化处理PDF的实用方法介绍

《5种使用Python自动化处理PDF的实用方法介绍》自动化处理PDF文件已成为减少重复工作、提升工作效率的重要手段,本文将介绍五种实用方法,从内置工具到专业库,帮助你在Python中实现PDF任务... 目录使用内置库(os、subprocess)调用外部工具使用 PyPDF2 进行基本 PDF 操作使用

分析 Java Stream 的 peek使用实践与副作用处理方案

《分析JavaStream的peek使用实践与副作用处理方案》StreamAPI的peek操作是中间操作,用于观察元素但不终止流,其副作用风险包括线程安全、顺序混乱及性能问题,合理使用场景有限... 目录一、peek 操作的本质:有状态的中间操作二、副作用的定义与风险场景1. 并行流下的线程安全问题2. 顺

Python异常处理之避免try-except滥用的3个核心原则

《Python异常处理之避免try-except滥用的3个核心原则》在Python开发中,异常处理是保证程序健壮性的关键机制,本文结合真实案例与Python核心机制,提炼出避免异常滥用的三大原则,有需... 目录一、精准打击:只捕获可预见的异常类型1.1 通用异常捕获的陷阱1.2 精准捕获的实践方案1.3

C#使用iText获取PDF的trailer数据的代码示例

《C#使用iText获取PDF的trailer数据的代码示例》开发程序debug的时候,看到了PDF有个trailer数据,挺有意思,于是考虑用代码把它读出来,那么就用到我们常用的iText框架了,所... 目录引言iText 核心概念C# 代码示例步骤 1: 确保已安装 iText步骤 2: C# 代码程

Pandas处理缺失数据的方式汇总

《Pandas处理缺失数据的方式汇总》许多教程中的数据与现实世界中的数据有很大不同,现实世界中的数据很少是干净且同质的,本文我们将讨论处理缺失数据的一些常规注意事项,了解Pandas如何表示缺失数据,... 目录缺失数据约定的权衡Pandas 中的缺失数据None 作为哨兵值NaN:缺失的数值数据Panda

C++中处理文本数据char与string的终极对比指南

《C++中处理文本数据char与string的终极对比指南》在C++编程中char和string是两种用于处理字符数据的类型,但它们在使用方式和功能上有显著的不同,:本文主要介绍C++中处理文本数... 目录1. 基本定义与本质2. 内存管理3. 操作与功能4. 性能特点5. 使用场景6. 相互转换核心区别

Python动态处理文件编码的完整指南

《Python动态处理文件编码的完整指南》在Python文件处理的高级应用中,我们经常会遇到需要动态处理文件编码的场景,本文将深入探讨Python中动态处理文件编码的技术,有需要的小伙伴可以了解下... 目录引言一、理解python的文件编码体系1.1 Python的IO层次结构1.2 编码问题的常见场景二

python库pydantic数据验证和设置管理库的用途

《python库pydantic数据验证和设置管理库的用途》pydantic是一个用于数据验证和设置管理的Python库,它主要利用Python类型注解来定义数据模型的结构和验证规则,本文给大家介绍p... 目录主要特点和用途:Field数值验证参数总结pydantic 是一个让你能够 confidentl