# @auth0/auth0-checkmate 中文文档 规范地址：https://npmcn.com/package/%40auth0/auth0-checkmate/ 版本：1\.9\.3 npm 元数据更新时间：2026-10-27T04:01:33.704Z 中文译文更新时间：2026-11-07T06:00:48.724Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40auth0/auth0-checkmate 原文对照：https://npmcn.com/package/%40auth0/auth0-checkmate/?lang=original 项目主页：https://github.com/auth0/auth0-checkmate#readme 源码仓库：https://github.com/auth0/auth0-checkmate ## 关键信息（来自 npm 元数据） - 包体积（解压后）：751 kB，150 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - Node.js 要求：\>=22\.12\.0 - 运行依赖：16 个 - 首次发布：2025-09-19T21:24:05.241Z - 最新版本发布：2026-10-27T04:01:33.070Z - 近 30 天下载量：3463（2026-10-07 至 2026-11-05，npm 官方下载统计） - 已发布版本数：39（近 12 个月 36 个） ## 中文简介 用于检查您 Auth0 租户配置的命令行工具 ## 安装 ```sh npm install @auth0/auth0-checkmate ``` 也可以使用：`pnpm add @auth0/auth0-checkmate`、`yarn add @auth0/auth0-checkmate`、`bun add @auth0/auth0-checkmate` ## README # Auth0 检查对象 **Auth0 检查对象** 是一个命令行工具,用于对您的 Auth0 租户进行配置检查。 它有助于通过验证密钥设置和生成详细报告来确保您的租户安全而正确的配置. * * * ## \* 特性 - 验证您的 Auth0 租户配置 - 编制全面审计报告 - 简单而直观的 CLI 界面 * * * ## Auth0 管理 API 使用通知 该工具利用 **Auth0 管理 API**,哪个 **消费租户 [费率限额](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations)**深思熟虑地使用它来避免节奏. Auth0 的校验Mate 旨在通过您的 Auth0 租户来显示其行为 [日志事件](https://auth0.com/docs/deploy-monitor/logs)跟踪其使用情况对于监测和调试目的十分重要。 您可以以多种方式跟踪其使用情况,包括: - 这个 `User-Agent` hTTP 请求头中的字符串, 其值形式为 `${packageName}/${packageVersion}` (例如:. `@auth0/auth0-checkmate/1.4.0`) (中文(简体) ). 记住,如果 `User-Agent` 字符串会在客户端被修改,然后无法以这种方式跟踪 Auth0 的用法 . - 这个 `client_name` 财务报告和审定财务报表 `scopes` 在配置初始访问时被指定检查Mate - `seccft` auth0 日志中的事件( Access Token 成功交换客户证书赠款) 例如,CheckMate活动可能导致一个日志条目,如下文所示。 日志条目中的每个字段都为排除或审计出故障提供了宝贵的信息,例如: `client_name` 识别申请 `scope` 显示授予的权限,以及 `user_agent` 表示所使用的工具版本. ```json { "date": "2025-08-05T19:19:43.071Z", "type": "seccft", "description": "Client Credentials for Access Token", "connection_id": "", "client_id": "{CHECKMATE_CLIENT_ID}", "client_name": "{CHECKMATE_CLIENT_NAME}", "ip": "{REQUEST_IP}", "client_ip": "{REQUEST_IP}", "user_agent": "{CHECKMATE_USER_AGENT}", "hostname": "{TENANT_HOSTNAME}", "user_id": "", "user_name": "", "audience": "https://{TENANT_HOSTNAME}/api/v2/", "scope": "{CHECKMATE_SCOPES}", "$event_schema": { "version": "1.0.0" }, "environment_name": "{AUTH0_ENVIRONMENT}", "log_id": "{LOG_ID}", "tenant_name": "{AUTH0_TENANT}", "_id": "{ID}", "isMobile": false, "location_info": {}, "id": "{ID}" } ``` * * * ## · 先决条件 - [节点.js](https://nodejs.dev/) **v22.12.0或以上 (单位:千美元)** - 一个有效的 [Auth0 租户](https://auth0.com/) * * * ## QQ 安装选项 ### 备选方案1-全球安装 在全球安装 Auth0 检查Mate , 将其作为独立的 CLI 工具 : ```bash npm install -g @auth0/auth0-checkmate ``` 然后运行它与: ```bash a0checkmate ``` 跟着交互式提示启动 . 要更新检查Mate : ```bash npm update -g @auth0/auth0-checkmate ``` * * * ### 备选方案2 - 从源头运行 1. **清除仓库 :** ```bash git clone https://github.com/auth0/auth0-checkmate ``` 2. **导航到项目文件夹 :** ```bash cd auth0-checkmate ``` 3. **安装依赖性 :** ```bash npm install ``` 4. **运行工具 :** ```bash npm start ``` * * * ## QQ Auth0 设置指令 要使用 Auth0 的 CheckMate, 您需要一个 **专用 Auth0 应用程序** 授权给管理API打电话. ### 创建机器对机器应用程序 1. 在Auth0 Dashboard中,转到: **申请 − 申请** 2. 点击 **“创造性应用”** 3. 在设置形式中: - **名称 :** `Auth0 CheckMate` (或类似) - **应用程序类型 :** `Machine to Machine Applications` - 点击 **“创造”** 4. 在"授权机器到机器应用"屏幕上: - 选择 **Auth0 管理 API** - 只授予以下范围: ```text read:tenant_settings read:custom_domains read:prompts read:clients read:connections read:connections_options read:resource_servers read:client_grants read:roles read:branding read:email_provider read:email_templates read:phone_providers read:phone_templates read:shields read:attack_protection read:self_service_profiles read:guardian_factors read:mfa_policies read:actions read:log_streams read:logs read:network_acls read:event_streams read:hooks read:rules ``` 5. 点击 **“授权”** 完成设置. 6. 可选:以下环境变量可用于提供 CI 友好配置 ```text AUTH0CHECKMATE_DISABLE_PDF_REPORTING=true|false AUTH0CHECKMATE_DOMAIN=your_domain AUTH0CHECKMATE_CLIENT_ID=your_client_id AUTH0CHECKMATE_CLIENT_SECRET=your_client_secret AUTH0CHECKMATE_FILE_PATH="./reports" AUTH0CHECKMATE_SHOW_VALIDATORS=false AUTH0CHECKMATE_SKIP_APPLICATIONS=true|false RUN_VALIDATORS=checkCustomDomain,checkRules ``` > **说明:** 超过1500个应用程序的租户跳过应用程序(客户端)检查;一旦超过限制,所有其他检查仍然运行,取出停止. * * * ## 运行一个验证器子集 默认情况下, 每个验证符都会运行 。 设定 `RUN_VALIDATORS` 到逗号分隔列表 用户名中仅运行这些检查的验证符名称——用于在单个 找到或保持CI运行快. ```bash RUN_VALIDATORS=checkCustomDomain,checkRules a0checkmate ``` 要打印可用的验证符名称并退出 : ```bash RUN_VALIDATORS=list a0checkmate ``` 注释: - 名称是 **区分大小写** 并且必须完全吻合。 未识别名称 在认证前停止运行, 并推荐最接近的匹配, 相反 {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}而不是做一个默不作检查的报告. - 相邻的白空间,重复和后置逗号被忽略,所以 `RUN_VALIDATORS=" checkRules, checkCustomDomain, "` 无效. - 将变量未设置( 或为空) 以运行所有验证符 . - 租户的配置仍被完全取出. `RUN_VALIDATORS` 验证器运行的控件, _没有_ 获取哪些数据. * * * ## {\\fn华文楷体\\fs16\\1cHE0E0E0}都准备好了 配置了您的 Auth0 应用程序并安装了 CLI, 您已准备好运行 **Auth0 检查对象** 保证房客的安稳和完整. ## 常见问题 ### @auth0/auth0-checkmate 是什么？ 用于检查您 Auth0 租户配置的命令行工具 ### 如何安装 @auth0/auth0-checkmate？ 在项目目录运行 npm install @auth0/auth0-checkmate，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 a0checkmate，可以用 npx a0checkmate 直接运行。 ### @auth0/auth0-checkmate 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/auth0\_\_auth0-checkmate 是否存在。 ### @auth0/auth0-checkmate 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @auth0/auth0-checkmate 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @auth0/auth0-checkmate 可以商用吗？ @auth0/auth0-checkmate 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @auth0/auth0-checkmate 的下载量有多少？ 根据 npm 官方下载统计，@auth0/auth0-checkmate 在 2026/10/07 – 2026/11/05 这 30 天内被下载 3,463 次，日均约 115 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @auth0/auth0-checkmate 还在维护吗？ 最新版本 1\.9\.3 发布于 2026/10/27（11 天前）；至今共发布 39 个版本，其中过去 12 个月发布了 36 个；首次发布于 2025/09/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。