Skip to content

FEAT: Save converters from the Registry (part 13) - #4052

Open
varunj-msft wants to merge 197 commits into
microsoft:mainfrom
varunj-msft:varunj-msft/13178-Save-Converters-From-Registry
Open

varunj-msft wants to merge 197 commits into
microsoft:mainfrom
varunj-msft:varunj-msft/13178-Save-Converters-From-Registry

Conversation

@varunj-msft

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

Copy link
Copy Markdown
Contributor

Description

Part 13 of saving Registry entries across restarts. Stacked on part 12 (#4051); part 14 (#4066) builds on it, and so does the side branch part 18 (#4069). This PR's own changes: varunj-msft/PyRIT@varunj-msft/13178-Save-Converters-Scorers...varunj-msft/13178-Save-Converters-From-Registry

Design: 1. The contract. Where every part fits: PR map.

This is one of the changes for saving Registry entries across restarts. It builds on #4051, which saves converters and scorers created through the API. Until the earlier PRs merge, the diff here also shows their changes.

The New Converter dialog only made converters that are gone after the backend restarts, wherever it opens: the Converters tab, the converter panel in chat, and New converter in the technique editor. It now saves them by default, and the Converters and Scorers tables say which entries come back.

  • The dialog suggests a name from the type that no listed converter has, such as base64_converter. Keeping the _converter ending stays clear of the names the startup scripts register (base64, rot13), which would stop a saved converter of that name from restoring. The name field checks the backend's rule for saved names. A name the list already has, or one the backend says is taken (409), shows on the field, and focus moves there.
  • When a converter can't be saved, the button reads Create as Temporary and a warning says why: the type can't be saved, a file is uploaded, the chosen target is Temporary, or the backend refused those exact values (typed 400). Changing a refused value goes back to Save Converter. A file removed from a new converter is no longer sent. The warning uses role="status" so screen readers read it out, and target options mark Temporary targets.
  • GET /api/converters/types adds not_saveable_reason to each type, from the checks a save runs, including the one for types that need an uploaded file. The dialog keeps no copy of those rules.
  • The Converters table labels each converter Saved, From configuration or Temporary. A saved converter's Remove button is disabled, with a tooltip saying how to remove it for now. The Scorers table shows the same labels.
  • Save to registry on a converter's changed settings still makes a Temporary copy, and its dialog now says so.
  • The origin label moves from Config/TargetOriginBadge.tsx and utils/targetOrigin.ts to Registry/OriginBadge.tsx and utils/registryOrigin.ts. The target files change imports only.
  • The GUI doc covers saving converters and removing a saved one for now.

Screenshots: a new converter saves by default, a converter that uses a Temporary target is offered as Temporary with the reason, and the Converters table before and after a restart.
1_new_converter_saves_by_default
2_temporary_target_offers_temporary
4_converters_table_before_restart
5_converters_table_after_restart

Not covered:

…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
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.
Saving converters and scorers follows the same rules as saving targets now: a type that only a scan's launch script added can't be saved, a class without cached metadata is checked the way restore checks it, only a taken name is reported as a conflict, a storage failure logs its short reason, and the owner is recorded only when the entry is saved.

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