def _define_missing_containers( self, config: JobTemplateConfig, request: JobTemplateRequest ) -> None: for container_type in config.containers: seen = False for container in request.containers: if container_type == container.type: seen = True if not seen: if not isinstance(request.user_fields["project"], str): raise TypeError if not isinstance(request.user_fields["name"], str): raise TypeError if not isinstance(request.user_fields["build"], str): raise TypeError container_name = _build_container_name( self.onefuzz, container_type, request.user_fields["project"], request.user_fields["name"], request.user_fields["build"], config.os, ) request.containers.append( TaskContainers(name=container_name, type=container_type) )
def build_tasks(self, size: int) -> List[Task]: tasks = [] for _ in range(size): task = Task( job_id=UUID(int=0), config=TaskConfig( job_id=UUID(int=0), task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], ), pool=TaskPool(pool_name=PoolName("pool"), count=1), containers=[ TaskContainers(type=ContainerType.setup, name=Container("setup")) ], tags={}, colocate=True, ), os=OS.linux, ) tasks.append(task) return tasks
def test_get_vm_count(self, mock_get_pool: MagicMock) -> None: self.assertEqual(get_vm_count([]), 0) task_config = TaskConfig( job_id=UUID("6b049d51-23e9-4f5c-a5af-ff1f73d0d9e9"), containers=[ TaskContainers(type=ContainerType.inputs, name=Container("test-container")) ], tags={}, task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=12, target_exe="fuzz.exe", target_env={}, target_options=[], ), pool=TaskPool(count=2, pool_name=PoolName("test-pool")), ) task = Task( job_id=UUID("6b049d51-23e9-4f5c-a5af-ff1f73d0d9e9"), os=OS.linux, config=task_config, ) mock_get_pool.return_value = Pool( name=PoolName("test-pool"), pool_id=UUID("6b049d51-23e9-4f5c-a5af-ff1f73d0d9e9"), os=OS.linux, managed=False, arch=Architecture.x86_64, ) self.assertEqual(get_vm_count([task]), 2)
def _convert_container_args(self, config: JobTemplateConfig, args: Dict[str, Any]) -> List[TaskContainers]: """Convert the job template into a list of containers""" containers = [] container_names = args["container_names"] if container_names is None: container_names = {} for container_type in config.containers: if container_type in container_names: container_name = container_names[container_type] containers.append( TaskContainers(name=container_name, type=container_type)) return containers
def test_user_info_filter(self) -> None: job_id = uuid4() task_id = uuid4() application_id = uuid4() object_id = uuid4() upn = "*****@*****.**" user_info = UserInfo( application_id=application_id, object_id=object_id, upn=upn ) task_config = TaskConfig( job_id=job_id, containers=[ TaskContainers( type=ContainerType.inputs, name=Container("test-container") ) ], tags={}, task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=12, target_exe="fuzz.exe", target_env={}, target_options=[], ), pool=TaskPool(count=2, pool_name=PoolName("test-pool")), ) test_event = EventTaskCreated( job_id=job_id, task_id=task_id, config=task_config, user_info=user_info, ) control_test_event = EventTaskCreated( job_id=job_id, task_id=task_id, config=task_config, user_info=None, ) test_event_type = get_event_type(test_event) scrubbed_test_event = filter_event(test_event, test_event_type) self.assertEqual(scrubbed_test_event, control_test_event)
def main(): examples = { WebhookEventType.ping: WebhookEventPing(ping_id=UUID(int=0)), WebhookEventType.task_stopped: WebhookEventTaskStopped( job_id=UUID(int=0), task_id=UUID(int=0), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), ), WebhookEventType.task_failed: WebhookEventTaskFailed( job_id=UUID(int=0), task_id=UUID(int=0), error=Error(code=ErrorCode.TASK_FAILED, errors=["example error message"]), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), ), WebhookEventType.task_created: WebhookEventTaskCreated( job_id=UUID(int=0), task_id=UUID(int=0), config=TaskConfig( job_id=UUID(int=0), task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], ), containers=[ TaskContainers(name="my-setup", type=ContainerType.setup), TaskContainers(name="my-inputs", type=ContainerType.inputs), TaskContainers(name="my-crashes", type=ContainerType.crashes), ], tags={}, ), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), ), } message = WebhookMessage( webhook_id=UUID(int=0), event_id=UUID(int=0), event_type=WebhookEventType.ping, event=examples[WebhookEventType.ping], ) layer( 1, "Webhook Events", "This document describes the basic webhook event subscriptions available in OneFuzz", ) layer( 2, "Payload", "Each event will be submitted via HTTP POST to the user provided URL.", ) typed(3, "Example", message.json(indent=4, exclude_none=True), "json") layer(2, "Event Types (WebhookEventType)") for webhook_type in WebhookEventType: example = examples[webhook_type] layer(3, webhook_type.name) typed(4, "Example", example.json(indent=4, exclude_none=True), "json") typed(4, "Schema", example.schema_json(indent=4), "json") typed(2, "Full Event Schema", message.schema_json(indent=4), "json")
TaskConfig( job_id=(UUID(int=0)), task=TaskDetails( type=TaskType.generic_supervisor, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], supervisor_exe="", supervisor_options=[], supervisor_input_marker="@@", ), pool=TaskPool(count=1, pool_name=PoolName("")), containers=[ TaskContainers( name=Container("afl-container-name"), type=ContainerType.tools ), TaskContainers(name=Container(""), type=ContainerType.setup), TaskContainers(name=Container(""), type=ContainerType.crashes), TaskContainers(name=Container(""), type=ContainerType.inputs), ], tags={}, ), TaskConfig( job_id=UUID(int=0), prereq_tasks=[UUID(int=0)], task=TaskDetails( type=TaskType.generic_crash_report, duration=1, target_exe="fuzz.exe", target_env={},
supervisor_exe="{tools_dir}/afl-fuzz", supervisor_options=[ "-d", "-i", "{input_corpus}", "-o", "{runtime_dir}", "--", "{target_exe}", "{target_options}", ], supervisor_input_marker="@@", ), pool=TaskPool(count=1, pool_name=""), containers=[ TaskContainers(name="afl-linux", type=ContainerType.tools), TaskContainers(name="", type=ContainerType.setup), TaskContainers(name="", type=ContainerType.crashes), TaskContainers(name="", type=ContainerType.inputs), ], tags={}, ), TaskConfig( job_id=UUID(int=0), prereq_tasks=[UUID(int=0)], task=TaskDetails( type=TaskType.generic_crash_report, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[],
def main() -> None: if len(sys.argv) < 2: print(f"usage: {__file__} [OUTPUT_FILE]") sys.exit(1) filename = sys.argv[1] task_config = TaskConfig( job_id=UUID(int=0), task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], ), containers=[ TaskContainers(name=Container("my-setup"), type=ContainerType.setup), TaskContainers(name=Container("my-inputs"), type=ContainerType.inputs), TaskContainers(name=Container("my-crashes"), type=ContainerType.crashes), ], tags={}, ) report = Report( input_blob=BlobRef( account="contoso-storage-account", container=Container("crashes"), name="input.txt", ), executable="fuzz.exe", crash_type="example crash report type", crash_site="example crash site", call_stack=["#0 line", "#1 line", "#2 line"], call_stack_sha256=ZERO_SHA256, input_sha256=EMPTY_SHA256, asan_log="example asan log", task_id=UUID(int=0), job_id=UUID(int=0), scariness_score=10, scariness_description="example-scariness", tool_name="libfuzzer", tool_version="1.2.3", onefuzz_version="1.2.3", ) examples: List[Event] = [ EventPing(ping_id=UUID(int=0)), EventTaskCreated( job_id=UUID(int=0), task_id=UUID(int=0), config=task_config, user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), ), EventTaskStopped( job_id=UUID(int=0), task_id=UUID(int=0), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), config=task_config, ), EventTaskFailed( job_id=UUID(int=0), task_id=UUID(int=0), error=Error(code=ErrorCode.TASK_FAILED, errors=["example error message"]), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), config=task_config, ), EventTaskStateUpdated( job_id=UUID(int=0), task_id=UUID(int=0), state=TaskState.init, config=task_config, ), EventProxyCreated(region=Region("eastus"), proxy_id=UUID(int=0)), EventProxyDeleted(region=Region("eastus"), proxy_id=UUID(int=0)), EventProxyFailed( region=Region("eastus"), proxy_id=UUID(int=0), error=Error(code=ErrorCode.PROXY_FAILED, errors=["example error message"]), ), EventProxyStateUpdated( region=Region("eastus"), proxy_id=UUID(int=0), state=VmState.init, ), EventPoolCreated( pool_name=PoolName("example"), os=OS.linux, arch=Architecture.x86_64, managed=True, ), EventPoolDeleted(pool_name=PoolName("example")), EventScalesetCreated( scaleset_id=UUID(int=0), pool_name=PoolName("example"), vm_sku="Standard_D2s_v3", image="Canonical:UbuntuServer:18.04-LTS:latest", region=Region("eastus"), size=10, ), EventScalesetFailed( scaleset_id=UUID(int=0), pool_name=PoolName("example"), error=Error(code=ErrorCode.UNABLE_TO_RESIZE, errors=["example error message"]), ), EventScalesetDeleted(scaleset_id=UUID(int=0), pool_name=PoolName("example")), EventScalesetStateUpdated( scaleset_id=UUID(int=0), pool_name=PoolName("example"), state=ScalesetState.init, ), EventScalesetResizeScheduled(scaleset_id=UUID(int=0), pool_name=PoolName("example"), size=0), EventJobCreated( job_id=UUID(int=0), config=JobConfig( project="example project", name="example name", build="build 1", duration=24, ), ), EventJobStopped( job_id=UUID(int=0), config=JobConfig( project="example project", name="example name", build="build 1", duration=24, ), task_info=[ JobTaskStopped( task_id=UUID(int=0), task_type=TaskType.libfuzzer_fuzz, error=Error(code=ErrorCode.TASK_FAILED, errors=["example error message"]), ), JobTaskStopped( task_id=UUID(int=1), task_type=TaskType.coverage, ), ], ), EventNodeCreated(machine_id=UUID(int=0), pool_name=PoolName("example")), EventNodeDeleted(machine_id=UUID(int=0), pool_name=PoolName("example")), EventNodeStateUpdated( machine_id=UUID(int=0), pool_name=PoolName("example"), state=NodeState.setting_up, ), EventRegressionReported( regression_report=RegressionReport( crash_test_result=CrashTestResult(crash_report=report), original_crash_test_result=CrashTestResult( crash_report=report), ), container=Container("container-name"), filename="example.json", ), EventCrashReported( container=Container("container-name"), filename="example.json", report=report, ), EventFileAdded(container=Container("container-name"), filename="example.txt"), EventNodeHeartbeat(machine_id=UUID(int=0), pool_name=PoolName("example")), EventTaskHeartbeat(task_id=UUID(int=0), job_id=UUID(int=0), config=task_config), EventInstanceConfigUpdated(config=InstanceConfig( admins=[UUID(int=0)], allowed_aad_tenants=[UUID(int=0)])), ] # works around `mypy` not handling that Union has `__args__` for event in getattr(Event, "__args__", []): seen = False for value in examples: if isinstance(value, event): seen = True break assert seen, "missing event type definition: %s" % event.__name__ event_types = [get_event_type(x) for x in examples] for event_type in EventType: assert event_type in event_types, ( "missing event type definition: %s" % event_type.name) message = WebhookMessage( webhook_id=UUID(int=0), event_id=UUID(int=0), event_type=EventType.ping, event=EventPing(ping_id=UUID(int=0)), instance_id=UUID(int=0), instance_name="example", ) message_event_grid = WebhookMessageEventGrid( dataVersion="1.0.0", subject="example", eventType=EventType.ping, eventTime=datetime.datetime.min, id=UUID(int=0), data=EventPing(ping_id=UUID(int=0)), ) message_event_grid_json = json.dumps( [ json.loads( message_event_grid.json( indent=4, exclude_none=True, sort_keys=True)) ], indent=4, sort_keys=True, ) result = "" result += layer( 1, "Webhook Events", "This document describes the basic webhook event subscriptions " "available in OneFuzz", ) result += layer( 2, "Payload", "Each event will be submitted via HTTP POST to the user provided URL.", ) result += typed( 3, "Example", message.json(indent=4, exclude_none=True, sort_keys=True), "json", ) result += layer( 2, "Event Grid Payload format", "If webhook is set to have Event Grid message format then " "the payload will look as follows:", ) result += typed( 3, "Example", message_event_grid_json, "json", ) result += layer(2, "Event Types (EventType)") event_map = {get_event_type(x).name: x for x in examples} for name in sorted(event_map.keys()): result += f"* [{name}](#{name})\n" result += "\n" for name in sorted(event_map.keys()): example = event_map[name] result += layer(3, name) result += typed( 4, "Example", example.json(indent=4, exclude_none=True, sort_keys=True), "json", ) result += typed(4, "Schema", example.schema_json(indent=4, sort_keys=True), "json") result += typed(2, "Full Event Schema", message.schema_json(indent=4, sort_keys=True), "json") with open(filename, "w", newline="\n", encoding="utf8") as handle: handle.write(result)
libfuzzer_linux = JobTemplate( os=OS.linux, job=JobConfig(project="", name=Container(""), build="", duration=1), tasks=[ TaskConfig( job_id=UUID(int=0), task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], ), pool=TaskPool(count=1, pool_name=PoolName("")), containers=[ TaskContainers(name=Container(""), type=ContainerType.setup), TaskContainers(name=Container(""), type=ContainerType.crashes), TaskContainers(name=Container(""), type=ContainerType.inputs), ], tags={}, ), TaskConfig( job_id=UUID(int=0), prereq_tasks=[UUID(int=0)], task=TaskDetails( type=TaskType.libfuzzer_crash_report, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], ),
def main() -> None: task_config = TaskConfig( job_id=UUID(int=0), task=TaskDetails( type=TaskType.libfuzzer_fuzz, duration=1, target_exe="fuzz.exe", target_env={}, target_options=[], ), containers=[ TaskContainers(name=Container("my-setup"), type=ContainerType.setup), TaskContainers(name=Container("my-inputs"), type=ContainerType.inputs), TaskContainers(name=Container("my-crashes"), type=ContainerType.crashes), ], tags={}, ) examples: List[Event] = [ EventPing(ping_id=UUID(int=0)), EventTaskCreated( job_id=UUID(int=0), task_id=UUID(int=0), config=task_config, user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), ), EventTaskStopped( job_id=UUID(int=0), task_id=UUID(int=0), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), config=task_config, ), EventTaskFailed( job_id=UUID(int=0), task_id=UUID(int=0), error=Error(code=ErrorCode.TASK_FAILED, errors=["example error message"]), user_info=UserInfo( application_id=UUID(int=0), object_id=UUID(int=0), upn="*****@*****.**", ), config=task_config, ), EventTaskStateUpdated( job_id=UUID(int=0), task_id=UUID(int=0), state=TaskState.init, config=task_config, ), EventProxyCreated(region=Region("eastus")), EventProxyDeleted(region=Region("eastus")), EventProxyFailed( region=Region("eastus"), error=Error(code=ErrorCode.PROXY_FAILED, errors=["example error message"]), ), EventPoolCreated( pool_name=PoolName("example"), os=OS.linux, arch=Architecture.x86_64, managed=True, ), EventPoolDeleted(pool_name=PoolName("example")), EventScalesetCreated( scaleset_id=UUID(int=0), pool_name=PoolName("example"), vm_sku="Standard_D2s_v3", image="Canonical:UbuntuServer:18.04-LTS:latest", region=Region("eastus"), size=10, ), EventScalesetFailed( scaleset_id=UUID(int=0), pool_name=PoolName("example"), error=Error( code=ErrorCode.UNABLE_TO_RESIZE, errors=["example error message"] ), ), EventScalesetDeleted(scaleset_id=UUID(int=0), pool_name=PoolName("example")), EventJobCreated( job_id=UUID(int=0), config=JobConfig( project="example project", name="example name", build="build 1", duration=24, ), ), EventJobStopped( job_id=UUID(int=0), config=JobConfig( project="example project", name="example name", build="build 1", duration=24, ), task_info=[ JobTaskStopped( task_id=UUID(int=0), task_type=TaskType.libfuzzer_fuzz, error=Error( code=ErrorCode.TASK_FAILED, errors=["example error message"] ), ), JobTaskStopped( task_id=UUID(int=1), task_type=TaskType.libfuzzer_coverage, ), ], ), EventNodeCreated(machine_id=UUID(int=0), pool_name=PoolName("example")), EventNodeDeleted(machine_id=UUID(int=0), pool_name=PoolName("example")), EventNodeStateUpdated( machine_id=UUID(int=0), pool_name=PoolName("example"), state=NodeState.setting_up, ), EventCrashReported( container=Container("container-name"), filename="example.json", report=Report( input_blob=BlobRef( account="contoso-storage-account", container=Container("crashes"), name="input.txt", ), executable="fuzz.exe", crash_type="example crash report type", crash_site="example crash site", call_stack=["#0 line", "#1 line", "#2 line"], call_stack_sha256=ZERO_SHA256, input_sha256=EMPTY_SHA256, asan_log="example asan log", task_id=UUID(int=0), job_id=UUID(int=0), scariness_score=10, scariness_description="example-scariness", ), ), EventFileAdded(container=Container("container-name"), filename="example.txt"), EventNodeHeartbeat(machine_id=UUID(int=0), pool_name=PoolName("example")), EventTaskHeartbeat(task_id=UUID(int=0), job_id=UUID(int=0), config=task_config), ] # works around `mypy` not handling that Union has `__args__` for event in getattr(Event, "__args__", []): seen = False for value in examples: if isinstance(value, event): seen = True break assert seen, "missing event type definition: %s" % event.__name__ event_types = [get_event_type(x) for x in examples] for event_type in EventType: assert event_type in event_types, ( "missing event type definition: %s" % event_type.name ) message = WebhookMessage( webhook_id=UUID(int=0), event_id=UUID(int=0), event_type=EventType.ping, event=EventPing(ping_id=UUID(int=0)), instance_id=UUID(int=0), instance_name="example", ) layer( 1, "Webhook Events", "This document describes the basic webhook event subscriptions " "available in OneFuzz", ) layer( 2, "Payload", "Each event will be submitted via HTTP POST to the user provided URL.", ) typed( 3, "Example", message.json(indent=4, exclude_none=True, sort_keys=True), "json" ) layer(2, "Event Types (EventType)") event_map = {get_event_type(x).name: x for x in examples} for name in sorted(event_map.keys()): print(f"* [{name}](#{name})") print() for name in sorted(event_map.keys()): example = event_map[name] layer(3, name) typed( 4, "Example", example.json(indent=4, exclude_none=True, sort_keys=True), "json", ) typed(4, "Schema", example.schema_json(indent=4, sort_keys=True), "json") typed(2, "Full Event Schema", message.schema_json(indent=4, sort_keys=True), "json")