Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 身份验证 & Auth 鉴权指南
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 构建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境与服务
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SSE 调试
      • SOAP/WebService
      • gRPC 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试报告
      • 测试报告
    • API 测试
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Jenkins 集成
      • 与 Gitlab 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
      • Git 提交自动触发测试
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • SEO 设置
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 成员角色与权限设置
      • 团队基本操作
      • 团队成员管理
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox AI 功能
    • 总览
    • 启用 AI 功能
    • 修改数据模型
    • 常见问题
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
    • Apifox 测试步骤之间怎么传递数据?
  • 账号&应用设置
    • 账号设置
    • API 访问令牌
    • 语言设置
    • 快捷键
    • 网络代理
    • 数据备份与恢复
    • 更新 Apifox
    • 实验性功能
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • 目录链接汇总
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 身份验证 & Auth 鉴权指南

什么是 Digest Auth

Digest Auth(摘要认证),全称 Digest Access Authentication,是一种用于网络协议中的安全验证机制,它提供了比基本认证(Basic Authentication)更安全的方式来管理网页或网络服务的用户验证。这种认证机制主要用于通过 HTTP 协议进行通信的场景中,是 HTTP 认证的一种方式,该规范被定义在 RFC 7616 中。

Digest Auth 的工作原理#

1.
客户端请求访问资源: 当用户尝试访问一个受保护的资源时,客户端(通常是浏览器)会发送一个请求到服务器。
2.
服务器响应: 如果资源需要认证,服务器会返回一个 401 未授权响应,并在响应头中包含一个 WWW-Authenticate 字段,该字段提供了进行下一步加密操作所需的数据,如域(Realm)、一个随机数(Nonce),以及其他可选参数。
3.
客户端计算摘要并发送: 客户端使用用户名、密码和从服务器接收到的数据(比如:Realm、Nonce),生成一个加密的摘要(Digest)。这个过程通常涉及到哈希函数,如 MD5。客户端再次发送请求,附带 Authorization 头,其中包含摘要以及相关的认证信息。
4.
服务器验证: 服务器接收到客户端的响应后,会用同样的方法计算摘要值,如果计算结果与客户端发送的摘要值匹配,则认证成功;否则,认证失败。

WWW-Authenticate 的响应头字段#

在 HTTP Digest Auth(摘要认证)中,服务器通过 WWW-Authenticate 首部字段向客户端发出认证请求。根据 RFC 7616 规范,该字段包含若干参数,用于定义认证所需的具体细节。常见的字段及其描述如下:
realm: 指定了受保护资源所在的域(realm),客户端通常会显示该信息,以提示用户输入正确的凭据。
nonce: 一个唯一的随机字符串,用于防止重放攻击。服务器生成 nonce 值,并在每次需要进行身份验证时发送给客户端,客户端使用它来计算摘要。
algorithm: 指定用于计算消息摘要的算法。常见的包括 MD5、MD5-sess、SHA-256 等。
qop: 指定质询保护的类型(Quality of Protection),常见值为auth,表示身份验证质询。
nc (nonce count): 这是一个十六进制的计数器,表示客户端使用同一 nonce 值发送请求的次数。每次发送请求时,计数器的值都会增加。这确保了每个请求都是唯一的,从而阻止重放攻击。
cnonce (client nonce): 这是由客户端生成并发送的一个随机字符串,与服务器的 nonce 一起工作,增强了认证过程的安全性。客户端 nonce 确保了客户端生成的请求具有独特性,并可能参与生成响应中的摘要。
opaque: 一个字符串,由服务器生成,并作为一个参数提供给客户端,客户端必须将其原样返回。通常用于增加安全性,防止攻击者获取敏感信息。
domain: 指定了受保护资源的范围,即可以使用此认证机制的 URI 范围。
stale: 指示服务器之前发送的 nonce 是否过期,当设置为 true 时,表示之前提供的认证信息已过期,需要客户端重新认证。
服务器向客户端提供认证所需的各项参数,下面是一个示例WWW-Authenticate响应头字段:
在这个示例中,服务器向客户端提供了realm、qop、nonce、opaque 和 stale 这些字段,用于协助客户端进行 Digest Auth(摘要认证)。
在客户端响应服务器的WWW-Authenticate请求时,客户端将这些值包含在 Authorization 头字段中,形式大致如下:

客户端如何使用 Digest Auth?#

在客户端使用 HTTP Digest Auth(摘要认证)通常涉及几个步骤,一般情况下你需要手动处理认证过程,即需要自行处理服务器的挑战(challenge),计算响应值(response),再发起请求。以下一个基本的示例说明如何在 JavaScript 中处理摘要认证,使用 Axios 作为 HTTP 客户端库。注意,以下代码不是即插即用的完整实现,但展示了核心逻辑。

1.发送初步请求,获取 challenge 参数#

2.使用认证参数和用户信息计算响应,发起认证请求#

在实际实现中,你需要根据 RFC 7616 设定的公式和方法,正确生成 response 值。这包括使用合适的散列函数(如 MD5)计算 HA1、HA2,最后计算 response 值。还应该处理 auth-int 中的实体主体散列处理(如果使用了 qop=auth-int)。
上一页
什么是 Basic Auth
下一页
什么是 OAuth 1.0
Built with