Auth0 检查对象

Auth0 检查对象 是一个命令行工具,用于对您的 Auth0 租户进行配置检查。 它有助于通过验证密钥设置和生成详细报告来确保您的租户安全而正确的配置.

* 特性

• 验证您的 Auth0 租户配置
• 编制全面审计报告
• 简单而直观的 CLI 界面

Auth0 管理 API 使用通知

该工具利用 Auth0 管理 API,哪个 消费租户 费率限额深思熟虑地使用它来避免节奏.

Auth0 的校验Mate 旨在通过您的 Auth0 租户来显示其行为 日志事件跟踪其使用情况对于监测和调试目的十分重要。 您可以以多种方式跟踪其使用情况,包括:

• 这个 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 表示所使用的工具版本.

{
  "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 v22.12.0或以上 (单位:千美元)
• 一个有效的 Auth0 租户

QQ 安装选项

备选方案1-全球安装

在全球安装 Auth0 检查Mate , 将其作为独立的 CLI 工具 :

npm install -g @auth0/auth0-checkmate

然后运行它与:

a0checkmate

跟着交互式提示启动 .

要更新检查Mate :

npm update -g @auth0/auth0-checkmate

备选方案2 - 从源头运行

1. 清除仓库 :

   git clone https://github.com/auth0/auth0-checkmate
   

2. 导航到项目文件夹 :

   cd auth0-checkmate
   

3. 安装依赖性 :

   npm install
   

4. 运行工具 :

   npm start
   

QQ Auth0 设置指令

要使用 Auth0 的 CheckMate, 您需要一个 专用 Auth0 应用程序 授权给管理API打电话.

创建机器对机器应用程序

1. 在Auth0 Dashboard中,转到: 申请 − 申请

2. 点击 “创造性应用”

3. 在设置形式中:

   • 名称 : Auth0 CheckMate (或类似)
   • 应用程序类型 : Machine to Machine Applications
   • 点击 “创造”

4. 在"授权机器到机器应用"屏幕上:

   • 选择 Auth0 管理 API
   • 只授予以下范围:

   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 友好配置

    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运行快.

RUN_VALIDATORS=checkCustomDomain,checkRules a0checkmate

要打印可用的验证符名称并退出 :

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 检查对象 保证房客的安稳和完整.