SuperAPI AI 工具集

follow-arcgis-authentication-patterns

安全与审计

查看项目

更新于 11-16 16:12

技能介绍

用途

该技能用于在设计和实现 ArcGIS 应用时,帮助开发者理解 ArcGIS 中的身份验证,并在不同情境下选择正确的身份验证类型。应用需求、ArcGIS 产品选择和身份验证策略密切相关,设计应用时应一并考虑。受众、技术栈、服务和基础 ArcGIS 产品应被视为相关但独立的设计维度,不应仅凭平台或 SDK 推断身份验证方式。

主要能力

  • 提供 ArcGIS 身份验证与开发模式指导。
  • 按应用受众(公开、私有、个人)分类,并连接至合适的身份验证方向。
  • 提供产品选择指引,涵盖 ArcGIS Location Platform、ArcGIS Online、ArcGIS Enterprise 以及 Experience Builder、Instant Apps 等应用构建器。
  • 提供应用类型、ArcGIS 产品与身份验证矩阵,作为初始方向。
  • 提供身份验证场景,匹配应用受众与所需安全资源及操作。
  • 提供安全最佳实践,包括凭据存放、API 密钥权限与限制、服务器端处理等。
  • 提供建议格式与验证清单,用于最终确认身份验证建议或实现。

使用方式

技能建议按以下工作流程执行,并记录任何假设:

  1. 明确识别受众。询问应用面向任何人、组织成员还是仅所有者。若用户未说明或未明确记录为需求,应视为未知,并在推荐或实现身份验证前询问。
  2. 识别登录行为。询问用户是否必须登录。不要从缺少登录要求、公开 URL、公开数据或 SDK 选择推断为公开受众。
  3. 识别基础产品。ArcGIS Location Platform 面向开发者;ArcGIS Online 或 ArcGIS Enterprise 通常用于多用户私有访问、组织治理或需要受保护门户内容时。Enterprise 部署还取决于网络边界、身份提供者、许可和政策。
  4. 识别所需资源和操作。列出公开或受保护项目、数据和位置服务、用户特定内容、编辑、分析和管理操作。
  5. 验证共享和权限。确保项目共享和服务访问与受众匹配。若保密性不确定,选择更安全的服务器端或用户身份验证设计,而非削弱共享。
  6. 评估执行环境。浏览器和移动端凭据会暴露给用户,而受信任服务器可以保护机密应用凭据。
  7. 选择身份验证。对合适的公开或个人访问使用 API 密钥,对个人身份和私有用户访问使用用户身份验证,对受信任服务器端应用身份使用应用身份验证。验证服务要求和产品支持。
  8. 实现身份验证:指导用户为其选择的身份验证类型创建开发者凭据,说明开发者凭据所需的任何权限或配置,并使用适当的 ArcGIS Maps SDK 或 API 实现身份验证。使用 MCP 查找 SDK/API 文档以正确实现身份验证。

若应用开发需求不明确,可使用 gather-arcgis-application-requirements 技能审查项目上下文并澄清关键未知项,然后应用本技能的技术特定指导,复用请求或项目中已明确的需求。

适用场景

技能按受众分类应用类型:

  • 公开:任何人可匿名使用应用,无需 ArcGIS 账户登录。用例如使用位置服务或公开数据的公开地图。身份验证方向:当请求直接发往 ArcGIS(无后端服务)时使用 API 密钥身份验证,或通过自定义后端请求时使用应用身份验证。
  • 私有:用户必须使用 ArcGIS 账户登录并获得授权,通常是 ArcGIS 组织成员。用例如内部工具分析安全数据或支持编辑和用户特定工作流。身份验证方向:用户身份验证;已登录用户的用户类型、角色、权限和资源共享决定访问。
  • 个人:仅所有者使用应用,不分发。用例如本地脚本、笔记本、自动化或开发者工具/MCP 服务器为所有者执行工作。身份验证方向:必须作为所有者操作时使用用户身份验证;其他任务可能适合应用身份验证或 API 密钥。

技能还提供产品选择指引:ArcGIS Location Platform 面向开发者,常用于公开应用和位置服务;ArcGIS Online 提供托管组织身份、门户内容、群组、角色和共享控制;ArcGIS Enterprise 在组织控制的基础设施中提供门户和服务;Experience Builder、Instant Apps 等应用构建器与基础 ArcGIS 产品配合使用,而非独立基础产品。

技能提供应用类型、ArcGIS 产品与身份验证矩阵,以及按资源或操作(私有数据、ArcGIS 服务、门户管理)划分的身份验证场景,作为起点。

限制

  • 矩阵仅作为初始方向,不能替代检查产品配置、服务特定要求或当前文档。
  • 若应用未实现身份验证而尝试访问安全资源,某些产品可能提示用户使用自动身份验证流程登录;这是非标准做法,不建议用于生产应用。若用户需要登录应用,应实现 OAuth 2.0 用户身份验证。
  • 第三方登录到应用本身并不使用户通过 ArcGIS 身份验证或授予对受保护 ArcGIS 资源的访问;需验证完整身份和授权设计。
  • 公开应用不等同于公开数据。需分别决定应用是否可匿名使用以及每个项目或服务是否可与所有人共享。公开应用不得暴露机密或个人身份信息。
  • 身份验证令牌并不能使敏感数据安全暴露。针对所有者拥有项目的 API 密钥或应用身份验证不能替代用户特定授权或适当保护的后端。
  • 当模式不明确匹配时,应在推荐凭据前询问受众、身份、受保护数据、操作、运行时和产品。
  • 单独安装此技能不会配置 Esri MCP 服务器用于开发者文档。需在客户端 MCP 设置中添加 https://developers-mcp.arcgis.com/mcp,或安装完整的 ArcGIS SDKs and APIs 插件。若 MCP 服务器不可用,请查阅链接的官方 Esri 文档。

安全最佳实践

  • 切勿将应用机密或其他机密凭据放在浏览器或移动客户端代码中。客户端分发的值应视为已暴露。
  • 对于客户端应用使用的 API 密钥,使用最小必需权限,在支持时配置引用来源限制,并按需轮换密钥。
  • 对于需要机密应用凭据的操作,优先使用受信任的服务器端组件。在代理访问前保护服务器并验证请求。
  • 当访问必须反映个人用户身份、权限或私有组织内容时,使用用户身份验证。对于仅所有者的个人应用,也可使用模拟其身份的 API 密钥。
  • 使项目和服务共享与预期受众一致。不要将机密或个人身份数据放入公开应用,或作为变通方法将受保护资源设为公开。
  • 对于私有应用,账户角色和权限决定用户能做什么;不要暗示仅登录即可访问所有资源。

建议格式与验证清单

在建议应用设计时,总结:分类(公开、私有或个人及原因);身份验证方向(API 密钥、用户身份验证或服务器端应用身份验证);数据访问(哪些项目/服务必须公开、仅组织或仅所有者);凭据保护措施(凭据存放位置、适用限制以及轮换或服务器端处理)。

在最终确定身份验证建议或实现前,验证:受众已根据谁可使用应用以及是否需要 ArcGIS 登录分类为公开、私有或个人;已识别基础 ArcGIS 产品、目标运行时、访问的服务和项目以及所需操作,且未仅凭 SDK 推断身份验证;身份验证方法受所选产品、门户版本、服务和客户端库支持,并与请求必须使用的身份匹配;项目和服务的共享、用户权限和凭据权限限于预期受众和所需操作,未将受保护内容设为公开作为变通;API 密钥使用最小权限和适用的引用来源限制、过期、监控和轮换;用户身份验证对客户端使用适当的 OAuth 流程,具有注册的重定向 URI 和 SDK/库推荐的会话处理;已说明假设、未解决问题以及相关的 Enterprise 身份/版本约束。