Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Make api_key and identity auth modes disjoint by deprecating the implicit Entra fallback

已关闭
  • 哪里不对？
#3,029 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
authentication

调研方向

Start with pyrit/auth/openai_auth.py::resolve_openai_auth, then compare the inlined authentication chains in AzureMLChatTarget and PromptShieldTarget. This work is ordered after #2846, which adds explicit auth-mode support to AzureBlobStorageTarget; review that dependency and #3010 before changing behavior. Done means the implicit identity fallback warns for one release, strict modes and cleanup are addressed, and the setup and per-target notebooks plus release and migration guidance are updated.

由索引模型根据 Issue 内容生成。

描述

feature-request
Is your feature request related to a problem? Please describe.

Follow-up to review feedback on #3010 (thread).

api_key authentication mode can currently resolve to identity. The chain in pyrit/auth/openai_auth.py::resolve_openai_auth is:

  1. token-provider callable passed as api_key
  2. explicit api_key string
  3. the target's API key environment variable
  4. fallback: an Entra token, for recognized Azure endpoints only

Step 4 is why "no api_key passed" was ambiguous in the first place — it can mean "the user chose identity" or "no key is available, mint a token." #3010 fixed the user-facing symptom by adding an explicit auth_mode, but left the underlying fallback in place for backward compatibility, so the two modes still overlap rather than being disjoint.

The same inlined chain exists in AzureMLChatTarget and PromptShieldTarget.

Describe the solution you'd like

Make the two modes disjoint:

  • auth_mode="api_key" requires a key or an explicitly supplied token provider, and fails clearly when neither is present. No implicit identity fallback.
  • auth_mode="identity" uses identity and ignores keys (already true as of #3010).

This is a breaking change: OpenAIChatTarget(endpoint=<azure endpoint>) with no key plus az login works silently today and is documented that way, so it should go through a deprecation cycle rather than being removed outright:

  1. One release emitting a DeprecationWarning when the implicit fallback is taken, naming auth_mode="identity" as the replacement.
  2. Removal in the following release, called out in the release notes and migration guidance.

Two cleanups land with this:

  • TargetService._accepts_auth_mode can be deleted. It exists solely because AzureBlobStorageTarget has no auth_mode parameter; once every identity-advertising target accepts the explicit mode, a target that cannot meet that contract should fail loudly instead of being quietly skipped. This is blocked on #2846, which adds explicit auth-mode support to AzureBlobStorageTarget.
  • doc/code/setup/1_configuration.py / .ipynb and the per-target notebooks that describe keyless Azure auth need updating.
Describe alternatives you've considered, if relevant
  • Keep the fallback indefinitely. Lowest churn, but leaves api_key mode able to silently produce identity auth, which is the ambiguity #3010 set out to remove.
  • Remove it immediately in #3010. Rejected: an unannounced break buried in a bugfix, with no warning period for users relying on the documented keyless Azure path.
  • Add an explicit auto mode that keeps today's chain, leaving api_key and identity strict. Preserves the behavior under an honest name, but adds a third mode to document and reason about; only worth it if the keyless path turns out to be widely depended upon.
Additional context

Ordering: this should land after #2846, which supplies the AzureBlobStorageTarget half and unblocks removing _accepts_auth_mode. #2846 and #3010 also introduce two overlapping mechanisms for the same concern (a per-class get_auth_mode_parameters hook vs. an explicit auth_mode constructor argument); reconciling those into one belongs in the same pass.

Related: #3010, #2846, #2235 (which introduced the fallback — correctly, for its original purpose as a last resort when no key exists).

主要语言
Python
星标
4.6k
派生
944
平均合并
2 天 16 小时
30 天内合并 PR
350

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

microsoft/PyRIT 的其他 Issue

查看 microsoft/PyRIT 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。