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

Geschlossen
  • Stimmt etwas nicht?
#3,029 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
authentication

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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).

Vorherrschende Sprache
Python
Sterne
4.7k
Forks
1k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
484

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Hat eine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus microsoft/PyRIT

Alle Issues in microsoft/PyRIT

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.