mirror of
https://github.com/microsoft/onefuzz.git
synced 2025-06-17 12:28:07 +00:00
32 KiB
32 KiB
Webhook Events
This document describes the basic webhook event subscriptions available in OneFuzz
Payload
Each event will be submitted via HTTP POST to the user provided URL.
Example
{
"webhook_id": "00000000-0000-0000-0000-000000000000",
"event_id": "00000000-0000-0000-0000-000000000000",
"event_type": "ping",
"event": {
"ping_id": "00000000-0000-0000-0000-000000000000"
}
}
Event Types (WebhookEventType)
task_created
Example
{
"job_id": "00000000-0000-0000-0000-000000000000",
"task_id": "00000000-0000-0000-0000-000000000000",
"config": {
"job_id": "00000000-0000-0000-0000-000000000000",
"task": {
"type": "libfuzzer_fuzz",
"duration": 1,
"target_exe": "fuzz.exe",
"target_env": {},
"target_options": [],
"check_debugger": true
},
"containers": [
{
"type": "setup",
"name": "my-setup"
},
{
"type": "inputs",
"name": "my-inputs"
},
{
"type": "crashes",
"name": "my-crashes"
}
],
"tags": {}
},
"user_info": {
"application_id": "00000000-0000-0000-0000-000000000000",
"object_id": "00000000-0000-0000-0000-000000000000",
"upn": "example@contoso.com"
}
}
Schema
{
"title": "WebhookEventTaskCreated",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"task_id": {
"title": "Task Id",
"type": "string",
"format": "uuid"
},
"config": {
"$ref": "#/definitions/TaskConfig"
},
"user_info": {
"$ref": "#/definitions/UserInfo"
}
},
"required": [
"job_id",
"task_id",
"config"
],
"definitions": {
"TaskType": {
"title": "TaskType",
"description": "An enumeration.",
"enum": [
"libfuzzer_fuzz",
"libfuzzer_coverage",
"libfuzzer_crash_report",
"libfuzzer_merge",
"generic_analysis",
"generic_supervisor",
"generic_merge",
"generic_generator",
"generic_crash_report"
]
},
"ContainerType": {
"title": "ContainerType",
"description": "An enumeration.",
"enum": [
"analysis",
"coverage",
"crashes",
"inputs",
"no_repro",
"readonly_inputs",
"reports",
"setup",
"tools",
"unique_inputs",
"unique_reports"
]
},
"StatsFormat": {
"title": "StatsFormat",
"description": "An enumeration.",
"enum": [
"AFL"
]
},
"TaskDetails": {
"title": "TaskDetails",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/TaskType"
},
"duration": {
"title": "Duration",
"type": "integer"
},
"target_exe": {
"title": "Target Exe",
"type": "string"
},
"target_env": {
"title": "Target Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"target_options": {
"title": "Target Options",
"type": "array",
"items": {
"type": "string"
}
},
"target_workers": {
"title": "Target Workers",
"type": "integer"
},
"target_options_merge": {
"title": "Target Options Merge",
"type": "boolean"
},
"check_asan_log": {
"title": "Check Asan Log",
"type": "boolean"
},
"check_debugger": {
"title": "Check Debugger",
"default": true,
"type": "boolean"
},
"check_retry_count": {
"title": "Check Retry Count",
"type": "integer"
},
"rename_output": {
"title": "Rename Output",
"type": "boolean"
},
"supervisor_exe": {
"title": "Supervisor Exe",
"type": "string"
},
"supervisor_env": {
"title": "Supervisor Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"supervisor_options": {
"title": "Supervisor Options",
"type": "array",
"items": {
"type": "string"
}
},
"supervisor_input_marker": {
"title": "Supervisor Input Marker",
"type": "string"
},
"generator_exe": {
"title": "Generator Exe",
"type": "string"
},
"generator_env": {
"title": "Generator Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"generator_options": {
"title": "Generator Options",
"type": "array",
"items": {
"type": "string"
}
},
"analyzer_exe": {
"title": "Analyzer Exe",
"type": "string"
},
"analyzer_env": {
"title": "Analyzer Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"analyzer_options": {
"title": "Analyzer Options",
"type": "array",
"items": {
"type": "string"
}
},
"wait_for_files": {
"$ref": "#/definitions/ContainerType"
},
"stats_file": {
"title": "Stats File",
"type": "string"
},
"stats_format": {
"$ref": "#/definitions/StatsFormat"
},
"reboot_after_setup": {
"title": "Reboot After Setup",
"type": "boolean"
},
"target_timeout": {
"title": "Target Timeout",
"type": "integer"
},
"ensemble_sync_delay": {
"title": "Ensemble Sync Delay",
"type": "integer"
}
},
"required": [
"type",
"duration",
"target_exe",
"target_env",
"target_options"
]
},
"TaskVm": {
"title": "TaskVm",
"type": "object",
"properties": {
"region": {
"title": "Region",
"type": "string"
},
"sku": {
"title": "Sku",
"type": "string"
},
"image": {
"title": "Image",
"type": "string"
},
"count": {
"title": "Count",
"default": 1,
"type": "integer"
},
"spot_instances": {
"title": "Spot Instances",
"default": false,
"type": "boolean"
},
"reboot_after_setup": {
"title": "Reboot After Setup",
"type": "boolean"
}
},
"required": [
"region",
"sku",
"image"
]
},
"TaskPool": {
"title": "TaskPool",
"type": "object",
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"pool_name": {
"title": "Pool Name",
"type": "string"
}
},
"required": [
"count",
"pool_name"
]
},
"TaskContainers": {
"title": "TaskContainers",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ContainerType"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"type",
"name"
]
},
"TaskDebugFlag": {
"title": "TaskDebugFlag",
"description": "An enumeration.",
"enum": [
"keep_node_on_failure",
"keep_node_on_completion"
]
},
"TaskConfig": {
"title": "TaskConfig",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"prereq_tasks": {
"title": "Prereq Tasks",
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"task": {
"$ref": "#/definitions/TaskDetails"
},
"vm": {
"$ref": "#/definitions/TaskVm"
},
"pool": {
"$ref": "#/definitions/TaskPool"
},
"containers": {
"title": "Containers",
"type": "array",
"items": {
"$ref": "#/definitions/TaskContainers"
}
},
"tags": {
"title": "Tags",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"debug": {
"title": "Debug",
"type": "array",
"items": {
"$ref": "#/definitions/TaskDebugFlag"
}
}
},
"required": [
"job_id",
"task",
"containers",
"tags"
]
},
"UserInfo": {
"title": "UserInfo",
"type": "object",
"properties": {
"application_id": {
"title": "Application Id",
"type": "string",
"format": "uuid"
},
"object_id": {
"title": "Object Id",
"type": "string",
"format": "uuid"
},
"upn": {
"title": "Upn",
"type": "string"
}
},
"required": [
"application_id"
]
}
}
}
task_stopped
Example
{
"job_id": "00000000-0000-0000-0000-000000000000",
"task_id": "00000000-0000-0000-0000-000000000000",
"user_info": {
"application_id": "00000000-0000-0000-0000-000000000000",
"object_id": "00000000-0000-0000-0000-000000000000",
"upn": "example@contoso.com"
}
}
Schema
{
"title": "WebhookEventTaskStopped",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"task_id": {
"title": "Task Id",
"type": "string",
"format": "uuid"
},
"user_info": {
"$ref": "#/definitions/UserInfo"
}
},
"required": [
"job_id",
"task_id"
],
"definitions": {
"UserInfo": {
"title": "UserInfo",
"type": "object",
"properties": {
"application_id": {
"title": "Application Id",
"type": "string",
"format": "uuid"
},
"object_id": {
"title": "Object Id",
"type": "string",
"format": "uuid"
},
"upn": {
"title": "Upn",
"type": "string"
}
},
"required": [
"application_id"
]
}
}
}
task_failed
Example
{
"job_id": "00000000-0000-0000-0000-000000000000",
"task_id": "00000000-0000-0000-0000-000000000000",
"error": {
"code": 468,
"errors": [
"example error message"
]
},
"user_info": {
"application_id": "00000000-0000-0000-0000-000000000000",
"object_id": "00000000-0000-0000-0000-000000000000",
"upn": "example@contoso.com"
}
}
Schema
{
"title": "WebhookEventTaskFailed",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"task_id": {
"title": "Task Id",
"type": "string",
"format": "uuid"
},
"error": {
"$ref": "#/definitions/Error"
},
"user_info": {
"$ref": "#/definitions/UserInfo"
}
},
"required": [
"job_id",
"task_id",
"error"
],
"definitions": {
"ErrorCode": {
"title": "ErrorCode",
"description": "An enumeration.",
"enum": [
450,
451,
452,
453,
454,
455,
456,
457,
458,
459,
460,
461,
462,
463,
464,
465,
467,
468,
469,
470,
471
]
},
"Error": {
"title": "Error",
"type": "object",
"properties": {
"code": {
"$ref": "#/definitions/ErrorCode"
},
"errors": {
"title": "Errors",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"code",
"errors"
]
},
"UserInfo": {
"title": "UserInfo",
"type": "object",
"properties": {
"application_id": {
"title": "Application Id",
"type": "string",
"format": "uuid"
},
"object_id": {
"title": "Object Id",
"type": "string",
"format": "uuid"
},
"upn": {
"title": "Upn",
"type": "string"
}
},
"required": [
"application_id"
]
}
}
}
ping
Example
{
"ping_id": "00000000-0000-0000-0000-000000000000"
}
Schema
{
"title": "WebhookEventPing",
"type": "object",
"properties": {
"ping_id": {
"title": "Ping Id",
"type": "string",
"format": "uuid"
}
}
}
Full Event Schema
{
"title": "WebhookMessage",
"type": "object",
"properties": {
"webhook_id": {
"title": "Webhook Id",
"type": "string",
"format": "uuid"
},
"event_id": {
"title": "Event Id",
"type": "string",
"format": "uuid"
},
"event_type": {
"$ref": "#/definitions/WebhookEventType"
},
"event": {
"title": "Event",
"anyOf": [
{
"$ref": "#/definitions/WebhookEventTaskCreated"
},
{
"$ref": "#/definitions/WebhookEventTaskStopped"
},
{
"$ref": "#/definitions/WebhookEventTaskFailed"
},
{
"$ref": "#/definitions/WebhookEventPing"
}
]
}
},
"required": [
"webhook_id",
"event_type",
"event"
],
"definitions": {
"WebhookEventType": {
"title": "WebhookEventType",
"description": "An enumeration.",
"enum": [
"task_created",
"task_stopped",
"task_failed",
"ping"
]
},
"TaskType": {
"title": "TaskType",
"description": "An enumeration.",
"enum": [
"libfuzzer_fuzz",
"libfuzzer_coverage",
"libfuzzer_crash_report",
"libfuzzer_merge",
"generic_analysis",
"generic_supervisor",
"generic_merge",
"generic_generator",
"generic_crash_report"
]
},
"ContainerType": {
"title": "ContainerType",
"description": "An enumeration.",
"enum": [
"analysis",
"coverage",
"crashes",
"inputs",
"no_repro",
"readonly_inputs",
"reports",
"setup",
"tools",
"unique_inputs",
"unique_reports"
]
},
"StatsFormat": {
"title": "StatsFormat",
"description": "An enumeration.",
"enum": [
"AFL"
]
},
"TaskDetails": {
"title": "TaskDetails",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/TaskType"
},
"duration": {
"title": "Duration",
"type": "integer"
},
"target_exe": {
"title": "Target Exe",
"type": "string"
},
"target_env": {
"title": "Target Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"target_options": {
"title": "Target Options",
"type": "array",
"items": {
"type": "string"
}
},
"target_workers": {
"title": "Target Workers",
"type": "integer"
},
"target_options_merge": {
"title": "Target Options Merge",
"type": "boolean"
},
"check_asan_log": {
"title": "Check Asan Log",
"type": "boolean"
},
"check_debugger": {
"title": "Check Debugger",
"default": true,
"type": "boolean"
},
"check_retry_count": {
"title": "Check Retry Count",
"type": "integer"
},
"rename_output": {
"title": "Rename Output",
"type": "boolean"
},
"supervisor_exe": {
"title": "Supervisor Exe",
"type": "string"
},
"supervisor_env": {
"title": "Supervisor Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"supervisor_options": {
"title": "Supervisor Options",
"type": "array",
"items": {
"type": "string"
}
},
"supervisor_input_marker": {
"title": "Supervisor Input Marker",
"type": "string"
},
"generator_exe": {
"title": "Generator Exe",
"type": "string"
},
"generator_env": {
"title": "Generator Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"generator_options": {
"title": "Generator Options",
"type": "array",
"items": {
"type": "string"
}
},
"analyzer_exe": {
"title": "Analyzer Exe",
"type": "string"
},
"analyzer_env": {
"title": "Analyzer Env",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"analyzer_options": {
"title": "Analyzer Options",
"type": "array",
"items": {
"type": "string"
}
},
"wait_for_files": {
"$ref": "#/definitions/ContainerType"
},
"stats_file": {
"title": "Stats File",
"type": "string"
},
"stats_format": {
"$ref": "#/definitions/StatsFormat"
},
"reboot_after_setup": {
"title": "Reboot After Setup",
"type": "boolean"
},
"target_timeout": {
"title": "Target Timeout",
"type": "integer"
},
"ensemble_sync_delay": {
"title": "Ensemble Sync Delay",
"type": "integer"
}
},
"required": [
"type",
"duration",
"target_exe",
"target_env",
"target_options"
]
},
"TaskVm": {
"title": "TaskVm",
"type": "object",
"properties": {
"region": {
"title": "Region",
"type": "string"
},
"sku": {
"title": "Sku",
"type": "string"
},
"image": {
"title": "Image",
"type": "string"
},
"count": {
"title": "Count",
"default": 1,
"type": "integer"
},
"spot_instances": {
"title": "Spot Instances",
"default": false,
"type": "boolean"
},
"reboot_after_setup": {
"title": "Reboot After Setup",
"type": "boolean"
}
},
"required": [
"region",
"sku",
"image"
]
},
"TaskPool": {
"title": "TaskPool",
"type": "object",
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"pool_name": {
"title": "Pool Name",
"type": "string"
}
},
"required": [
"count",
"pool_name"
]
},
"TaskContainers": {
"title": "TaskContainers",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ContainerType"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"type",
"name"
]
},
"TaskDebugFlag": {
"title": "TaskDebugFlag",
"description": "An enumeration.",
"enum": [
"keep_node_on_failure",
"keep_node_on_completion"
]
},
"TaskConfig": {
"title": "TaskConfig",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"prereq_tasks": {
"title": "Prereq Tasks",
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"task": {
"$ref": "#/definitions/TaskDetails"
},
"vm": {
"$ref": "#/definitions/TaskVm"
},
"pool": {
"$ref": "#/definitions/TaskPool"
},
"containers": {
"title": "Containers",
"type": "array",
"items": {
"$ref": "#/definitions/TaskContainers"
}
},
"tags": {
"title": "Tags",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"debug": {
"title": "Debug",
"type": "array",
"items": {
"$ref": "#/definitions/TaskDebugFlag"
}
}
},
"required": [
"job_id",
"task",
"containers",
"tags"
]
},
"UserInfo": {
"title": "UserInfo",
"type": "object",
"properties": {
"application_id": {
"title": "Application Id",
"type": "string",
"format": "uuid"
},
"object_id": {
"title": "Object Id",
"type": "string",
"format": "uuid"
},
"upn": {
"title": "Upn",
"type": "string"
}
},
"required": [
"application_id"
]
},
"WebhookEventTaskCreated": {
"title": "WebhookEventTaskCreated",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"task_id": {
"title": "Task Id",
"type": "string",
"format": "uuid"
},
"config": {
"$ref": "#/definitions/TaskConfig"
},
"user_info": {
"$ref": "#/definitions/UserInfo"
}
},
"required": [
"job_id",
"task_id",
"config"
]
},
"WebhookEventTaskStopped": {
"title": "WebhookEventTaskStopped",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"task_id": {
"title": "Task Id",
"type": "string",
"format": "uuid"
},
"user_info": {
"$ref": "#/definitions/UserInfo"
}
},
"required": [
"job_id",
"task_id"
]
},
"ErrorCode": {
"title": "ErrorCode",
"description": "An enumeration.",
"enum": [
450,
451,
452,
453,
454,
455,
456,
457,
458,
459,
460,
461,
462,
463,
464,
465,
467,
468,
469,
470,
471
]
},
"Error": {
"title": "Error",
"type": "object",
"properties": {
"code": {
"$ref": "#/definitions/ErrorCode"
},
"errors": {
"title": "Errors",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"code",
"errors"
]
},
"WebhookEventTaskFailed": {
"title": "WebhookEventTaskFailed",
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"type": "string",
"format": "uuid"
},
"task_id": {
"title": "Task Id",
"type": "string",
"format": "uuid"
},
"error": {
"$ref": "#/definitions/Error"
},
"user_info": {
"$ref": "#/definitions/UserInfo"
}
},
"required": [
"job_id",
"task_id",
"error"
]
},
"WebhookEventPing": {
"title": "WebhookEventPing",
"type": "object",
"properties": {
"ping_id": {
"title": "Ping Id",
"type": "string",
"format": "uuid"
}
}
}
}
}