Skip to content

FIX: Refuse saved converters and scorers that would use this server's credentials (part 11) - #4050

Open
varunj-msft wants to merge 180 commits into
microsoft:mainfrom
varunj-msft:varunj-msft/13178-Refuse-Saved-Converter-Scorer-Credentials
Open

varunj-msft wants to merge 180 commits into
microsoft:mainfrom
varunj-msft:varunj-msft/13178-Refuse-Saved-Converter-Scorer-Credentials

Conversation

@varunj-msft

@varunj-msft varunj-msft commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Description

Part 11 of saving Registry entries across restarts. Stacked on part 10 (#4028); part 12 (#4051) builds on it. This PR's own changes: varunj-msft/PyRIT@varunj-msft/13178-Show-Who-Saved...varunj-msft/13178-Refuse-Saved-Converter-Scorer-Credentials

Design: 4.4 Credentials. Where every part fits: PR map.

This is one of the changes for saving Registry entries across restarts. It builds on #4028. Until the earlier PRs merge, the diff here also shows their changes.

A saved converter or scorer is rebuilt at every start and shared by everyone using the app, so restore should refuse one that would sign in with this server's own credentials, as it already does for targets (#4025).

  • The Azure Speech converters (both directions) and AzureContentFilterScorer read this server's key when theirs is empty, or else sign in with its Azure identity, and no value turns that off. They now list that key in server_fallback_parameters (azure_speech_key, api_key), so the shared saved-entry check refuses them, as it does for targets.
  • AudioTrueFalseScorer and AudioFloatScaleScorer transcribe with this server's Speech settings. LocalRefusalClassifierScorer loads its model from a folder on this server, or downloads it with this server's Hugging Face sign-in. These get a not_saveable_reason, like WebSocketCopilotTarget and HuggingFaceChatTarget in FIX: Refuse saved targets that would authenticate with a key (part 7) #4025.
  • server_fallback_parameters is now on the Converter and Scorer bases, and not_saveable_reason on Scorer, as on PromptTarget.
  • A class that declares no auth modes now supports only api_key in the saved-entry check, as check_saveable_class already assumed. A recipe can no longer pass by naming an auth mode its class doesn't take.
  • Each refusal is a restore failure that names the class or parameter, never a value. pyrit_conf.md lists the converters and scorers that can't be saved yet.

Converters and scorers made without saving, and the ones the startup scripts register, aren't checked. RobloxPiiScorer and LocalViolenceClassifierScorer can still be saved: their models are fixed public ones and nothing a caller sets.

Not covered: saving converters and scorers through the API, which is #4051 (part 12). Picking a server credential, or keeping typed keys in a key vault, would let the Speech converters and the Content Safety and audio scorers be saved later.

…API input

External construction now rejects a parameter whose type includes Path unless the
calling service passes the name in allowed_path_params after making the value safe.
The converter service allows its upload parameters once they are stored, and the
target service allows the server-set upload folder and the GitHubCopilotTarget
working directory. The scorer-only check is removed, and the "Valid parameters"
list leaves out path parameters callers cannot set.
The target catalog now applies the path rule to required parameters too, so a
target that needs a disallowed path is left out instead of listed without the
field, matching the scorer catalog. allowed_path_params is typed frozenset[str]
so a bare string cannot turn the allow-list into a substring match.
The target catalog still lists a target whose required path parameter is its
server-set upload folder when the server has one, and leaves it out otherwise.
# Conflicts:
#	tests/unit/backend/test_converter_service.py
@varunj-msft varunj-msft changed the title FIX: Refuse saved converters and scorers that would use this server's credentials FIX: Refuse saved converters and scorers that would use this server's credentials (part 11) Nov 9, 2026
FileDocumentStorage now raises DocumentStorageUnavailableError when the
folder or container can't be used, and DocumentUnreadableError when one
document exists but can't be read. The message names the location, with
any SAS token hidden, and a short reason. One backend handler maps both to
503 and logs the location and reason, with the traceback at debug level,
so the per-route storage helpers are gone.

A single read, a conditional save and a delete now follow the listing's
rules: a folder, pipe or broken link named like a document is unreadable
rather than missing, and on Blob only a deleted blob counts as missing.
Blob sign-in, permission, network and missing-container errors stop the
listing instead of marking every file unreadable. Each unreadable report
keeps the real file name and the original error, and the listing's
documents are read-only.

Initializer delete removes a script that can't be read or decoded, and
registering one no longer turns a storage write failure into a 400.
Tests patch module-level aliases instead of os.
List recipes escapes the OS text it reports, such as a file name that
isn't UTF-8, and a recipe whose JSON holds an unpaired surrogate escape
is reported as invalid, so the models no longer need a JSON-only
serializer. Recipes may start with a byte-order mark. A document without
schema_version reads as version 1, and each file is checked against the
format version of the model that reads it. Validation summaries shorten
each location part and the whole message, since a location can repeat a
stored key.

Recipes and StoredRecipe are no longer frozen, since their params and
tags never were, and StoredRecipe checks that its recipe type matches its
registry. The listing's recipes are read-only, and it keeps the error
behind each recipe that couldn't be read, for the log.
Listing catches only storage errors, so a bug is raised instead of being
reported as unreadable storage, and a bug while planning is a build
error rather than an invalid recipe. Each failure is logged once, with
the error behind it and URL credentials removed. The report shows the
error's text with each URL's user name, query and fragment removed, any
SAS signature hidden, and the length capped.

A class that moved within PyRIT is restored; one now registered from
outside PyRIT still fails. A technique whose name or tag clashes is a
name clash, and anything else registration refuses is an invalid
recipe. A recipe that sets a server file or folder is refused before it
is built. Class metadata comes from the registry's cache. The class
docstring lists the steps the API's create runs that restore skips.
The runtime becomes ready even when some saved entries fail; the
failures stay in the runtime status. Each failed entry keeps its name in
its registry: looking it up, or taking the name, raises
SavedEntryUnavailableError, which the backend answers with 409, so
nothing else stands in for it. Administrators see the full message and
everyone else a fixed explanation of the reason. A folder that can't be
listed holds every unregistered name of its kind, and each entry it left
unbuilt is reported.

While a saved technique is held, a launch or estimate that picks
techniques by all, default or a tag is refused with 409 for scenarios
whose techniques come from the registry, since the broken technique's
tags may be unknown. Naming techniques still works; naming the held one
fails with its reason. Route catch-alls let the error through instead of
turning it into a 500.
A launch script that registers a name held for a saved entry that
couldn't be restored is refused, and the refusal is recorded even when
the script catches it, so the launch stops instead of running with the
script's entry in the saved one's place. A suite entry that fails on a
held entry, or on a broad technique selection, shows the reason without
the error's details.
The OpenAI SDK adds that variable's headers to every request, so a saved
OpenAI target would send whatever the server puts there, which can be a
credential. While it's set, saving an OpenAI target is refused and a
saved one isn't restored; the message names the variable, never its
value. Targets declare such variables in server_header_variables.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants