pyscalpel.edit

 1"""
 2    Scalpel allows choosing between normal and binary editors,
 3    to do so, the user can apply the `editor` decorator to the `req_edit_in` / `res_edit_int` hook:
 4"""
 5from typing import Callable, Literal, get_args
 6
 7EditorMode = Literal["raw", "hex", "octal", "binary", "decimal"]
 8EDITOR_MODES: set[EditorMode] = set(get_args(EditorMode))
 9
10
11def editor(mode: EditorMode):
12    """Decorator to specify the editor type for a given hook
13
14    This can be applied to a req_edit_in / res_edit_in hook declaration to specify the editor that should be displayed in Burp
15
16    Example:
17    ```py
18        @editor("hex")
19        def req_edit_in(req: Request) -> bytes | None:
20            return bytes(req)
21    ```
22    This displays the request in an hex editor.
23
24    Currently, the only modes supported are `"raw"`, `"hex"`, `"octal"`, `"binary"` and `"decimal"`.
25
26
27    Args:
28        mode (EDITOR_MODE): The editor mode (raw, hex,...)
29    """
30
31    if mode not in EDITOR_MODES:
32        raise ValueError(f"Argument must be one of {EDITOR_MODES}")
33
34    def decorator(hook: Callable):
35        hook.__annotations__["scalpel_editor_mode"] = mode
36        return hook
37
38    return decorator