Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
438 commits
Select commit Hold shift + click to select a range
8ff7bda
Merge the credential explanation
varunj-msft Nov 10, 2026
df83a94
Merge the credential explanation
varunj-msft Nov 10, 2026
8614025
Use one recipe format version, keep the auth mode, and escape failure…
varunj-msft Nov 10, 2026
5a3f18b
Merge the recipe format changes
varunj-msft Nov 10, 2026
b3c7847
Build restored entries with a builder the caller supplies
varunj-msft Nov 10, 2026
af4075f
Merge the restore builder changes
varunj-msft Nov 10, 2026
061807a
Warn that writing saved entries is administrator authority, and test …
varunj-msft Nov 10, 2026
1740964
Merge the restore builder changes
varunj-msft Nov 10, 2026
01d99d7
Merge the restore builder changes
varunj-msft Nov 10, 2026
600717f
Merge the restore builder changes
varunj-msft Nov 10, 2026
095e76b
Merge the restore builder changes
varunj-msft Nov 10, 2026
0bf773d
Merge the restore builder changes
varunj-msft Nov 10, 2026
7a547aa
Say restore can't tell who wrote a saved file
varunj-msft Nov 10, 2026
f71259b
Merge the saved file wording
varunj-msft Nov 10, 2026
8902768
Merge the saved file wording
varunj-msft Nov 10, 2026
339fd15
Merge the restore builder changes
varunj-msft Nov 10, 2026
f1dcab1
Merge the saved file wording
varunj-msft Nov 10, 2026
fa8b6cb
Merge the restore builder changes
varunj-msft Nov 10, 2026
986cc90
Test the parser's depth limit without depending on the stack size
varunj-msft Nov 10, 2026
1096925
Merge the parser depth test fix
varunj-msft Nov 10, 2026
f25b520
Merge the parser depth test fix
varunj-msft Nov 10, 2026
1845b64
Merge the parser depth test fix
varunj-msft Nov 10, 2026
bd2224b
Merge the parser depth test fix
varunj-msft Nov 10, 2026
b454e75
Merge the parser depth test fix
varunj-msft Nov 10, 2026
83a0bca
Merge the parser depth test fix
varunj-msft Nov 10, 2026
bd03690
Merge the parser depth test fix
varunj-msft Nov 10, 2026
2e9cbb0
Merge the parser depth test fix
varunj-msft Nov 10, 2026
71b8e33
Merge the parser depth test fix
varunj-msft Nov 10, 2026
fb90af8
Read saved entries in a worker thread when restore isn't given what w…
varunj-msft Nov 10, 2026
c44d2ce
Merge the worker-thread read
varunj-msft Nov 10, 2026
abd116a
Stay not ready when a saved entry can't be restored, and let apply retry
varunj-msft Nov 10, 2026
0bfa6cc
Drop the refusal of held names from launches
varunj-msft Nov 10, 2026
c62118f
Merge the not-ready restore
varunj-msft Nov 10, 2026
c0aa46d
Merge the not-ready restore
varunj-msft Nov 10, 2026
f59306e
Read saved recipes off the event loop by default, and harden URL reda…
richlundeen Nov 10, 2026
7d90d68
Merge the not-ready restore
varunj-msft Nov 10, 2026
0f0c53d
Treat a class a launch script puts in place of another as temporary
varunj-msft Nov 10, 2026
26e1d0e
Merge the not-ready restore
varunj-msft Nov 10, 2026
2ea542b
Merge the not-ready restore
varunj-msft Nov 10, 2026
9fca651
Merge the not-ready restore
varunj-msft Nov 10, 2026
0ba47e8
Merge the not-ready restore
varunj-msft Nov 10, 2026
f1ff143
Keep an "@" in a URL's path when redacting URLs in text
richlundeen Nov 10, 2026
009e761
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
21f22a4
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
e9103ff
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
57b069a
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
7c88228
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
616a7df
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
fede632
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
aaae79f
Merge the restore read and redaction fixes
varunj-msft Nov 10, 2026
cc4ae4d
Merge main
varunj-msft Nov 10, 2026
9f4c71e
Merge main
varunj-msft Nov 10, 2026
5121026
Merge main
varunj-msft Nov 10, 2026
d15f7fd
Merge main
varunj-msft Nov 11, 2026
84ad3fe
Merge main
varunj-msft Nov 11, 2026
ddfe03c
Merge main
varunj-msft Nov 11, 2026
7104a25
Merge main
varunj-msft Nov 11, 2026
b01bd1a
Merge main
varunj-msft Nov 11, 2026
be0b885
Use the dialog's save button in the new tests from main
varunj-msft Nov 11, 2026
7b08ca0
Press the hidden-targets button in the saved-by test
varunj-msft Nov 11, 2026
6c8d33a
Merge the dialog test fixes
varunj-msft Nov 11, 2026
cabb56f
Merge the dialog test fixes
varunj-msft Nov 11, 2026
b709141
Merge the dialog test fixes
varunj-msft Nov 11, 2026
187191c
Answer suite readiness storage failures through the shared storage ha…
varunj-msft Nov 11, 2026
ee8162c
Give the HTTPTarget save test the connection field a create now needs
varunj-msft Nov 11, 2026
bb2a620
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
db7451a
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
b200c92
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
4c42a6b
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
43096e8
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
22b057c
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
9909158
Merge the readiness and save test fixes
varunj-msft Nov 11, 2026
374c620
Merge main
varunj-msft Nov 11, 2026
7ac059c
Answer suite readiness storage failures through the shared storage ha…
varunj-msft Nov 11, 2026
e08b67a
Merge main
varunj-msft Nov 11, 2026
7fa4ca4
Expect storage errors from main's version-checked delete tests the wa…
varunj-msft Nov 11, 2026
9bf5886
Merge main
varunj-msft Nov 11, 2026
626d2d4
Merge main
varunj-msft Nov 11, 2026
4a86017
Merge main
varunj-msft Nov 11, 2026
9568edb
Merge main
varunj-msft Nov 11, 2026
54e4374
Merge main
varunj-msft Nov 11, 2026
0d97131
Merge main
varunj-msft Nov 11, 2026
2849ae8
Merge main
varunj-msft Nov 11, 2026
c9f0f7b
Merge main
varunj-msft Nov 11, 2026
e34258c
Fit the explicit-target E2E from main to the dialog's save button and…
varunj-msft Nov 11, 2026
bf91430
Merge the explicit-target E2E fix
varunj-msft Nov 11, 2026
a9dccb3
Merge the explicit-target E2E fix
varunj-msft Nov 11, 2026
9e96747
Merge the explicit-target E2E fix
varunj-msft Nov 11, 2026
c506195
Merge main
varunj-msft Nov 11, 2026
1ba526f
Merge main
varunj-msft Nov 11, 2026
9cdf7e7
Merge main
varunj-msft Nov 11, 2026
40d36ed
Merge main
varunj-msft Nov 11, 2026
6a52054
Merge main
varunj-msft Nov 11, 2026
23a7ec1
Merge main
varunj-msft Nov 11, 2026
70fbc3d
Merge main
varunj-msft Nov 11, 2026
a1e79d1
Merge main
varunj-msft Nov 11, 2026
a5d42d1
Merge main
varunj-msft Nov 11, 2026
2402df2
Merge main
varunj-msft Nov 11, 2026
1b2ea03
Merge main
varunj-msft Nov 11, 2026
8c517d0
Use the dialog's save button in main's endpoint tests
varunj-msft Nov 11, 2026
1137977
Merge the endpoint test fix
varunj-msft Nov 11, 2026
aaefa8f
Merge the endpoint test fix
varunj-msft Nov 11, 2026
6356a56
Merge the endpoint test fix
varunj-msft Nov 11, 2026
0e7a21f
Exempt the storage error handler from the keyword-only check
varunj-msft Nov 11, 2026
891e8d6
Make get_target's parameters keyword-only
varunj-msft Nov 11, 2026
c35fa01
Merge keyword-only fixes
varunj-msft Nov 11, 2026
953dcce
Merge keyword-only fixes
varunj-msft Nov 11, 2026
d6079a1
Merge keyword-only fixes
varunj-msft Nov 11, 2026
21556ed
Merge keyword-only fixes
varunj-msft Nov 11, 2026
14004e9
Merge keyword-only fixes
varunj-msft Nov 11, 2026
3abc824
Merge keyword-only fixes
varunj-msft Nov 11, 2026
623fd40
Merge keyword-only fixes
varunj-msft Nov 11, 2026
2d74284
Merge keyword-only fixes
varunj-msft Nov 11, 2026
1fc386a
Merge keyword-only fixes
varunj-msft Nov 11, 2026
ee0a223
Merge keyword-only fixes
varunj-msft Nov 11, 2026
bf97225
Log every problem with a saved file that isn't valid
varunj-msft Nov 11, 2026
5e6faed
Merge the full schema-validation log
varunj-msft Nov 11, 2026
7625f89
Merge the full schema-validation log
varunj-msft Nov 11, 2026
8dbd4c2
Merge the full schema-validation log
varunj-msft Nov 11, 2026
5c7223a
Merge the full schema-validation log
varunj-msft Nov 11, 2026
8676ee5
Merge the full schema-validation log
varunj-msft Nov 11, 2026
74e1310
Merge the full schema-validation log
varunj-msft Nov 11, 2026
072a560
Merge the full schema-validation log
varunj-msft Nov 11, 2026
35199cc
Leave the error behind a storage failure out of the logs
varunj-msft Nov 12, 2026
efcdfa9
Test a blob upload that fails with a transport or authentication error
varunj-msft Nov 12, 2026
0fdebdc
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
c413994
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
c057e30
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
dc97ec7
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
a9478df
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
dc0c058
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
8f27c91
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
4f2208d
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
d22d466
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
167dd8e
Merge the storage log and restore report fixes
varunj-msft Nov 12, 2026
c9b795a
Merge main
varunj-msft Nov 12, 2026
38c981c
Merge main
varunj-msft Nov 12, 2026
eb71448
Merge main
varunj-msft Nov 12, 2026
1be067e
Merge main
varunj-msft Nov 12, 2026
162fc2a
Merge main
varunj-msft Nov 12, 2026
6c0c3dd
Merge main
varunj-msft Nov 12, 2026
3d0950d
Merge main
varunj-msft Nov 12, 2026
8b59c5d
Merge main
varunj-msft Nov 12, 2026
d1504ec
Merge main
varunj-msft Nov 12, 2026
457563c
Merge main
varunj-msft Nov 12, 2026
8353569
Merge main
varunj-msft Nov 12, 2026
4e8d9c2
Return 409 when a suite's launch scripts would replace a saved entry
varunj-msft Nov 12, 2026
b1bbbe6
Merge the suite launch conflict status
varunj-msft Nov 12, 2026
9ce29cb
Merge the suite launch conflict status
varunj-msft Nov 12, 2026
4e0e640
Merge the suite launch conflict status
varunj-msft Nov 12, 2026
0b9efb3
Merge the suite launch conflict status
varunj-msft Nov 12, 2026
28c9398
Merge the suite launch conflict status
varunj-msft Nov 12, 2026
359553a
Merge the suite launch conflict status
varunj-msft Nov 12, 2026
15e00de
Merge main
varunj-msft Nov 12, 2026
0c5baa8
Merge main
varunj-msft Nov 12, 2026
a3f65ad
Merge main
varunj-msft Nov 12, 2026
dd7358b
Merge main
varunj-msft Nov 12, 2026
fc37262
Merge main
varunj-msft Nov 12, 2026
8618ce3
Merge main
varunj-msft Nov 12, 2026
d4337d8
Merge main
varunj-msft Nov 12, 2026
48bc6d1
Merge main
varunj-msft Nov 12, 2026
9789264
Merge main
varunj-msft Nov 12, 2026
42b9853
Merge main
varunj-msft Nov 12, 2026
fd7a648
Merge main
varunj-msft Nov 12, 2026
9d5293a
Merge main
varunj-msft Nov 12, 2026
805ca2a
Merge main into part 7
varunj-msft Nov 13, 2026
b9c50e1
Merge part 7 into part 8
varunj-msft Nov 13, 2026
5363c0b
Merge part 8 into part 9
varunj-msft Nov 13, 2026
d50f393
Merge part 9 into part 10
varunj-msft Nov 13, 2026
1c80cf5
Merge part 10 into part 11
varunj-msft Nov 13, 2026
84c564c
Merge part 11 into part 12
varunj-msft Nov 13, 2026
cdbe6ad
Keep the recipe storage setup apart from the saved target requirements
varunj-msft Nov 13, 2026
450b1e5
Merge part 7 into part 8
varunj-msft Nov 13, 2026
699ab5b
Move saving a target into the registry library
varunj-msft Nov 13, 2026
7d914b1
Merge part 8 into part 9
varunj-msft Nov 13, 2026
b008ce5
Merge part 9 into part 10
varunj-msft Nov 13, 2026
47ba126
Merge part 10 into part 11
varunj-msft Nov 13, 2026
59794d4
Merge part 11 into part 12
varunj-msft Nov 13, 2026
713f7d1
Merge main into part 8
varunj-msft Nov 13, 2026
793316a
Merge part 8 into part 9
varunj-msft Nov 13, 2026
4ca4f25
Merge part 9 into part 10
varunj-msft Nov 13, 2026
e4f32e3
Merge part 10 into part 11
varunj-msft Nov 13, 2026
1dbebcb
Merge part 11 into part 12
varunj-msft Nov 13, 2026
2e2e85d
Merge main into part 11
varunj-msft Nov 13, 2026
a2ce936
Merge part 11 into part 12
varunj-msft Nov 13, 2026
048283e
Merge main into part 8
varunj-msft Nov 13, 2026
6c243b6
Merge part 8 into part 9
varunj-msft Nov 13, 2026
1411c5d
Merge part 9 into part 10
varunj-msft Nov 13, 2026
b248a32
Merge part 10 into part 11
varunj-msft Nov 13, 2026
c283787
Merge part 11 into part 12
varunj-msft Nov 13, 2026
f273bff
Merge main into part 8
varunj-msft Nov 14, 2026
d692b25
Merge main into part 9
varunj-msft Nov 14, 2026
dc2a52c
Merge main into part 10
varunj-msft Nov 14, 2026
24bf3b2
Merge main into part 11
varunj-msft Nov 14, 2026
c983027
Merge main into part 12
varunj-msft Nov 14, 2026
54d9332
Check saved entries against restore's inputs and settle cancelled saves
varunj-msft Nov 14, 2026
0529525
Merge part 8 into part 9
varunj-msft Nov 14, 2026
d0bb066
Ask the backend whether a target's values can be saved
varunj-msft Nov 14, 2026
eef542d
Merge part 9 into part 10, keeping who saved a target in capability d…
varunj-msft Nov 14, 2026
3de68f9
Merge part 10 into part 11
varunj-msft Nov 14, 2026
f9d8ee6
Merge part 11 into part 12
varunj-msft Nov 14, 2026
83408f9
Expect the cause in the converter storage failure log
varunj-msft Nov 14, 2026
c05e125
Check saveability with a request that registers nothing
varunj-msft Nov 14, 2026
0d6cc7a
Merge part 9 into part 10
varunj-msft Nov 14, 2026
0310478
Merge part 10 into part 11
varunj-msft Nov 14, 2026
a2f1834
Merge part 11 into part 12
varunj-msft Nov 14, 2026
e47689c
Wrap the saveability note in the backend README
varunj-msft Nov 14, 2026
3a81a37
Merge part 10
varunj-msft Nov 14, 2026
b3af544
Merge part 11
varunj-msft Nov 14, 2026
fbaec87
Merge part 12
varunj-msft Nov 14, 2026
e6cfbd9
Answer the saveability check in the numeric controls end-to-end mocks
varunj-msft Nov 14, 2026
192552a
Merge part 10
varunj-msft Nov 14, 2026
bd98bb1
Merge part 11
varunj-msft Nov 14, 2026
941d5dc
Merge part 12
varunj-msft Nov 14, 2026
87de386
Bound the URL scheme when redacting text
varunj-msft Nov 14, 2026
96361e5
Merge part 9
varunj-msft Nov 14, 2026
e1ab38a
Merge part 10
varunj-msft Nov 14, 2026
977ad50
Merge part 11
varunj-msft Nov 14, 2026
351419b
Merge part 12
varunj-msft Nov 14, 2026
33650ff
Merge main into part 8
varunj-msft Nov 17, 2026
87a4abf
Merge main into part 9
varunj-msft Nov 17, 2026
b369843
Merge main into part 9
varunj-msft Nov 17, 2026
00adffb
Merge main into part 10
varunj-msft Nov 17, 2026
5f1871b
Merge main into part 11
varunj-msft Nov 17, 2026
0000312
Merge main into part 12
varunj-msft Nov 17, 2026
ed3141f
Merge main into part 9
varunj-msft Nov 18, 2026
f691ba6
Keep saveability available as a target name
varunj-msft Nov 18, 2026
0bba24f
Merge main into part 10
varunj-msft Nov 18, 2026
1ac1352
Merge main into part 11
varunj-msft Nov 18, 2026
a9fcd3e
Merge main into part 12
varunj-msft Nov 18, 2026
2c15d96
Merge main into part 9
varunj-msft Nov 19, 2026
d055396
Keep the class save rule in the library and answer with the cause alone
varunj-msft Nov 19, 2026
ca4324b
Create targets only you can use, or that allow credential updates, as…
varunj-msft Nov 19, 2026
d331b4a
Take out who saved each target
varunj-msft Nov 19, 2026
6a22e0d
Merge part 9 into part 11
varunj-msft Nov 19, 2026
b2ad86f
Expect a class's own reason when it can't be saved
varunj-msft Nov 19, 2026
a05c3cd
Merge part 11 into part 12
varunj-msft Nov 19, 2026
4513dcc
Answer a taken converter name with 409 whether or not it's saved
varunj-msft Nov 19, 2026
d9a66f6
Give each reason a target stays Temporary as its cause only, and drop…
varunj-msft Nov 19, 2026
8bc4161
Say the saveability check runs create's checks on the type, parameter…
varunj-msft Nov 19, 2026
9eff025
Merge part 9 into part 11
varunj-msft Nov 19, 2026
b1b9bd3
Merge part 11 into part 12
varunj-msft Nov 19, 2026
0105ade
Give the default-reference and uploaded-file refusals as their cause …
varunj-msft Nov 19, 2026
fa087b1
Merge main into part 9
varunj-msft Nov 19, 2026
0dc92aa
Merge main into part 9
varunj-msft Nov 19, 2026
d45e575
Merge part 9 into part 11
varunj-msft Nov 19, 2026
d6ec40b
Merge part 11 into part 12
varunj-msft Nov 19, 2026
77e2514
Merge main into part 11
varunj-msft Nov 19, 2026
d600c7d
Merge part 11 into part 12
varunj-msft Nov 19, 2026
4ff636f
Let saved converters and scorers use this server's credentials
varunj-msft Nov 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/getting_started/pyrit_conf.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ A SAS query string may be included; otherwise, PyRIT uses `DefaultAzureCredentia

### `registry_recipes_source`

Stores saved targets, converters, scorers, and techniques in a local directory or Azure Blob container, so they come back when the backend restarts. Targets created through `POST /api/targets` with `"persist": true` are saved here. An Azure URI may include a blob-name prefix:
Stores saved targets, converters, scorers, and techniques in a local directory or Azure Blob container, so they come back when the backend restarts. Targets, converters, and scorers created through `POST /api/targets`, `POST /api/converters`, and `POST /api/scorers` with `"persist": true` are saved here. An Azure URI may include a blob-name prefix:

```yaml
registry_recipes_source: https://account.blob.core.windows.net/pyrit-storage/registry-recipes
Expand Down
21 changes: 21 additions & 0 deletions pyrit/backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,27 @@ PUT /api/targets/my-claude/credentials
- Like other targets created through the API, private targets are gone after the backend
restarts or reinitializes.

### Converters and scorers

- `POST /api/converters` - Create a converter
- `DELETE /api/converters/{converter_id}` - Remove a converter
- `POST /api/scorers` - Create a scorer

A created converter or scorer is Temporary unless the request sets `"persist": true`, which works as it does for
targets: it needs `register` left on and a name of lowercase letters, digits, and underscores (otherwise **422**), the
entry is saved under `registry_recipes_source` with the signed-in user recorded, and it's restored at every start. A
request receives **400** with `"type": "/errors/not-saveable"`, and can be sent again without `persist`, if the entry
would save a key, use a
Temporary target, converter, or scorer, be of a type that only a scan's launch scripts added, or, for a converter, need
or keep an uploaded file. A saved converter or scorer can use this server's keys and Azure identity, as the ones from
the configuration do. A target left out of the
request and filled from the configured defaults is saved by name, so it must be registered and not Temporary. A
converter copy made with `source` can't be saved yet, and a private converter or scorer can't be saved (**422**). A
taken name receives **409**, and storage that can't
be written receives **503**. Each listed converter's and scorer's `origin` is `saved`, `configuration`, or
`temporary`, as for targets. A saved converter can't be removed through the API yet (**409**): delete its file under
`registry_recipes_source` and restart the backend.

### Dataset creation, batch mutation, and deletion

`POST /api/datasets` creates a named dataset synchronously from multipart form data.
Expand Down
5 changes: 5 additions & 0 deletions pyrit/backend/mappers/converter_mappers.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
from pyrit.backend.models import ConverterInstance
from pyrit.converter import Converter
from pyrit.models import ConverterIdentifier
from pyrit.models.catalog import RegistryEntryOrigin


def converter_object_to_instance(
Expand All @@ -21,6 +22,7 @@ def converter_object_to_instance(
converter_obj: Converter,
is_llm_based: bool,
description: str | None,
origin: RegistryEntryOrigin | None = None,
) -> ConverterInstance:
"""
Build a ConverterInstance DTO from a registry converter object.
Expand All @@ -34,6 +36,8 @@ def converter_object_to_instance(
converter_obj (Converter): The domain Converter object from the registry.
is_llm_based (bool): Whether the converter class requires an LLM target.
description (str | None): The converter class description.
origin (RegistryEntryOrigin | None): Where the registered converter comes from, or None when it isn't
registered.

Returns:
ConverterInstance DTO wrapping the converter's identifier.
Expand All @@ -43,4 +47,5 @@ def converter_object_to_instance(
identifier=ConverterIdentifier.from_component_identifier(converter_obj.get_identifier()),
is_llm_based=is_llm_based,
description=description,
origin=origin,
)
34 changes: 33 additions & 1 deletion pyrit/backend/models/converters.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
IdentifierStr,
RegistrationRequest,
)
from pyrit.models import ConverterIdentifier, Parameter, PromptDataType
from pyrit.models import ConverterIdentifier, Parameter, PromptDataType, validate_registry_name
from pyrit.models.catalog import RegistryEntryOrigin
from pyrit.models.component_spec import SourceInstanceSpec

__all__ = [
Expand Down Expand Up @@ -83,6 +84,13 @@ class ConverterInstance(BaseModel):
parameters: list[Parameter] = Field(
default_factory=list, description="Editable inputs with source-specific defaults"
)
origin: RegistryEntryOrigin | None = Field(
None,
description=(
"Where the converter comes from: 'saved' (restored at every start), 'configuration' (the server's "
"startup scripts), or 'temporary' (gone after a restart or reinitialization)"
),
)


class ConverterInstanceListResponse(BaseModel):
Expand All @@ -100,6 +108,14 @@ class CreateConverterRequest(RegistrationRequest):
pattern=REGISTRY_INSTANCE_NAME_PATTERN,
description="Unique registry name for the converter instance",
)
persist: bool = Field(
False,
description=(
"Save the converter so it comes back after the backend restarts or is reinitialized (true), or keep it "
"only until then (false). A saved converter needs a name of lowercase letters, digits, and underscores, "
"can't hold a key or use an uploaded file, and can't be a copy made with source or private."
),
)
source: SourceInstanceSpec | None = None
type: IdentifierStr = Field(..., description="Converter type (e.g., 'Base64Converter')")
params: dict[IdentifierStr, Any] = Field(
Expand All @@ -123,6 +139,22 @@ def _validate_registration(self) -> "CreateConverterRequest":
raise ValueError("Use source.params for reconstruction overrides")
return self

@model_validator(mode="after")
def _validate_persist(self) -> "CreateConverterRequest":
if not self.persist:
return self
if not self.register_instance:
raise ValueError("persist requires register=true")
if self.name is None:
raise ValueError("persist requires a name")
validate_registry_name(self.name)
if self.source is not None:
raise ValueError("persist can't be used with source: a copy of a converter can't be saved yet")
# A saved converter is restored with no caller, so it would come back shared.
if self.private:
raise ValueError("A private converter can't be saved; leave out persist or private")
return self


class UnregisteredConverter(BaseModel):
"""A constructed descriptor, without a registry ID."""
Expand Down
24 changes: 23 additions & 1 deletion pyrit/backend/models/scorers.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
PaginationInfo,
RegistrationRequest,
)
from pyrit.models import JSONValue, Parameter, ScorerIdentifier
from pyrit.models import JSONValue, Parameter, ScorerIdentifier, validate_registry_name
from pyrit.models.catalog import ScorerInstance


Expand Down Expand Up @@ -45,6 +45,14 @@ class CreateScorerRequest(RegistrationRequest):
name: str | None = Field(
None, min_length=1, pattern=REGISTRY_INSTANCE_NAME_PATTERN, description="Unique registry name"
)
persist: bool = Field(
False,
description=(
"Save the scorer so it comes back after the backend restarts or is reinitialized (true), or keep it "
"only until then (false). A saved scorer needs a name of lowercase letters, digits, and underscores, "
"and can't hold a key or be private."
),
)
type: IdentifierStr = Field(..., description="Scorer class name")
params: dict[IdentifierStr, JSONValue] = Field(
default_factory=dict, max_length=MAX_ITEMS, description="Scorer constructor parameters"
Expand All @@ -63,6 +71,20 @@ def _validate_registration(self) -> "CreateScorerRequest":
raise ValueError("name is required when register=true")
return self

@model_validator(mode="after")
def _validate_persist(self) -> "CreateScorerRequest":
if not self.persist:
return self
if not self.register_instance:
raise ValueError("persist requires register=true")
if self.name is None:
raise ValueError("persist requires a name")
validate_registry_name(self.name)
# A saved scorer is restored with no caller, so it would come back shared.
if self.private:
raise ValueError("A private scorer can't be saved; leave out persist or private")
return self


class UnregisteredScorer(BaseModel):
"""A scorer descriptor without a registry key."""
Expand Down
50 changes: 49 additions & 1 deletion pyrit/backend/routes/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@

"""Shared route helpers."""

from pyrit.backend.models.common import validate_label_filter
from fastapi import Request, status
from fastapi.responses import JSONResponse

from pyrit.backend.middleware.auth import AuthenticatedUser
from pyrit.backend.models.common import NotSaveableProblemDetail, validate_label_filter
from pyrit.models.catalog import SavedEntryOwner
from pyrit.registry import NotSaveableError

# Problem type for an entry that can't be saved as asked but can still be created without saving it.
NOT_SAVEABLE_PROBLEM_TYPE = "/errors/not-saveable"


def parse_label_query_params(label_params: list[str] | None) -> dict[str, list[str]] | None:
Expand All @@ -21,3 +30,42 @@ def parse_label_query_params(label_params: list[str] | None) -> dict[str, list[s
key, _, value = validate_label_filter(param).partition(":")
labels.setdefault(key.strip(), []).append(value.strip())
return labels or None


def saved_entry_owner_from_request(request: Request) -> SavedEntryOwner | None:
"""
Return the signed-in user to record on a saved entry.

Args:
request: The incoming FastAPI request.

Returns:
SavedEntryOwner | None: The user's object ID and name, or None when sign-in is off.
"""
user = getattr(request.state, "user", None)
if not isinstance(user, AuthenticatedUser):
return None
return SavedEntryOwner(oid=user.oid, name=user.name or user.email)


def not_saveable_response(*, error: NotSaveableError, request: Request) -> JSONResponse:
"""
Build the problem response for an entry that can't be saved as asked.

Args:
error: Why the entry can't be saved.
request: The incoming FastAPI request.

Returns:
JSONResponse: A 400 problem response of type ``NOT_SAVEABLE_PROBLEM_TYPE``, with the cause alone in
``not_saveable_reason``.
"""
problem = NotSaveableProblemDetail(
type=NOT_SAVEABLE_PROBLEM_TYPE,
title="Can't be saved",
status=status.HTTP_400_BAD_REQUEST,
detail=str(error),
not_saveable_reason=error.cause,
instance=str(request.url.path),
)
return JSONResponse(status_code=status.HTTP_400_BAD_REQUEST, content=problem.model_dump(exclude_none=True))
55 changes: 47 additions & 8 deletions pyrit/backend/routes/converters.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
Converter types are set at app startup - you cannot add new types at runtime.
"""

from fastapi import APIRouter, HTTPException, status
from fastapi import APIRouter, HTTPException, Request, status
from fastapi.responses import JSONResponse

from pyrit.backend.models import (
ConverterInstance,
Expand All @@ -19,11 +20,19 @@
CreateConverterRequest,
ProblemDetail,
)
from pyrit.backend.models.common import IdentifierStr
from pyrit.backend.models.common import IdentifierStr, NotSaveableProblemDetail
from pyrit.backend.models.converters import (
UnregisteredConverter,
)
from pyrit.backend.routes.common import (
NOT_SAVEABLE_PROBLEM_TYPE,
not_saveable_response,
saved_entry_owner_from_request,
)
from pyrit.backend.services import get_converter_service
from pyrit.backend.services.saved_entries import SavedEntryRemovalError
from pyrit.registry import NotSaveableError, SavedEntryConflictError, SavedEntryStorageError
from pyrit.registry.instance_registry import RegistryNameTakenError

router = APIRouter(prefix="/converters", tags=["converters"])

Expand Down Expand Up @@ -65,25 +74,50 @@ async def list_converter_types() -> ConverterTypeResponse: # pyrit-async-suffix
response_model=ConverterInstance | UnregisteredConverter,
status_code=status.HTTP_201_CREATED,
responses={
400: {"model": ProblemDetail, "description": "Invalid converter type or parameters"},
400: {
"model": NotSaveableProblemDetail,
"description": (
f"Invalid converter type or parameters, or (type {NOT_SAVEABLE_PROBLEM_TYPE}) a converter that "
"can't be saved as asked but can be created without saving it"
),
},
409: {
"model": ProblemDetail,
"description": "A registered converter has the name, or, for a converter to save, a saved converter has it",
},
503: {"model": ProblemDetail, "description": "Saved converters can't be written right now"},
},
)
async def create_converter(
request: CreateConverterRequest,
) -> ConverterInstance | UnregisteredConverter: # pyrit-async-suffix-exempt
*,
body: CreateConverterRequest,
request: Request,
) -> ConverterInstance | UnregisteredConverter | JSONResponse: # pyrit-async-suffix-exempt
"""
Create a new converter instance.

Instantiates a converter with the given type and parameters, with optional registration.
Supports nested converters via converter_id references in params.

Returns:
ConverterInstance | UnregisteredConverter: A named instance or an unregistered descriptor.
ConverterInstance | UnregisteredConverter | JSONResponse: A named instance or an unregistered descriptor,
or the problem response for a converter that can't be saved as asked.
"""
service = get_converter_service()

try:
return await service.create_converter_async(request=request)
return await service.create_converter_async(
request=body,
owner=saved_entry_owner_from_request(request) if body.persist else None,
recipes_source=getattr(request.app.state, "registry_recipes_source", None),
)
except NotSaveableError as e:
return not_saveable_response(error=e, request=request)
except (SavedEntryConflictError, RegistryNameTakenError) as e:
# RegistryNameTakenError is a ValueError, and a taken name is a 409 whether or not the converter is saved.
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail=str(e)) from e
except SavedEntryStorageError as e:
raise HTTPException(status_code=status.HTTP_503_SERVICE_UNAVAILABLE, detail=str(e)) from e
except PermissionError as e:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=str(e)) from e
except ValueError as e:
Expand Down Expand Up @@ -129,12 +163,17 @@ async def get_converter(converter_id: IdentifierStr) -> ConverterInstance: # py
status_code=status.HTTP_204_NO_CONTENT,
responses={
404: {"model": ProblemDetail, "description": "Converter not found"},
409: {"model": ProblemDetail, "description": "The converter is saved, so it can't be removed yet"},
},
)
async def delete_converter(converter_id: IdentifierStr) -> None: # pyrit-async-suffix-exempt
"""Delete a converter instance by registry name."""
service = get_converter_service()
if not await service.delete_converter_async(converter_id=converter_id):
try:
removed = await service.delete_converter_async(converter_id=converter_id)
except SavedEntryRemovalError as e:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail=str(e)) from e
if not removed:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Converter '{converter_id}' not found",
Expand Down
Loading
Loading