ExternalVendorCode/onefuzz
1
0
Fork 0
mirror of https://github.com/microsoft/onefuzz.git synced 2025-06-06 15:21:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
onefuzz/docs/command-replacements.md
George Pollard aa54a15427
Add extra_output container, rename extra container (#3064) 
## Summary of the Pull Request

- **Breaking** (but as far as I know this feature is not yet in use): rename the `extra_container` to `extra_setup_container`.
- **Add**: the `extra_output_container`, which pushes its outputs continually.
  - We may also want a type of container which both pushes & pulls? See discussion below.
- **Improved**: if `onefuzz-task` fails upon launch, we will log its output for diagnosis (might close #3113)

---

Some thoughts for the future:

We might want to redesign the containers so that we have something like the following which is passed to the agent, and the agent doesn't need to know the specifics of the containers supplied:

```jsonc
{
    // ...
    "containers": {
        "extra_setup_dir": {
            "mode": "pull",
            "container_name": "yyy",
        },
        "extra_output_dir": {
            "mode": "push",
            "continuous": true, // keep pushing while job is running
            "container_name": "xxx"
        }
    }
}
```

At the moment the agent needs to know what each container is for, for each task type. A more generic and flexible method might be simpler overall.
2023-06-15 02:48:27 +00:00

3.7 KiB
Raw Permalink Blame History

Commandline Injection

The following values are replaced with the specific values at runtime.

  • {input}: Path to the input file being processed in the current event
  • {input_file_name}: the input file name with the extension (available wherever input is available)
  • {input_file_name_no_ext}: the input file name without the extension (available wherever input is available)
  • {input_file_sha256}: the SHA256 checksum of the input file (available wherever input is available)
  • {crashes}: Path to write crashes
  • {input_corpus}: Path to the input corpus directory
  • {generated_inputs}: Path to the generated inputs directory
  • {target_exe}: Path to the target binary
  • {target_options}: Target options (recursively expanded)
  • {output_dir} : Path to the output directory as defined by the task
  • {runtime_dir}: Path to the runtime directory for the task
  • {tools_dir}: Path to the task specific tools directory
  • {setup_dir} : Path to the setup directory
  • {coverage_dir}: Path to the coverage directory for the task
  • {job_id}: UUID that indicates the Job ID
  • {task_id}: UUID that indicates the Task ID
  • {reports_dir}: Path to the directory to write crash reports
  • {crashes_account}: Azure Storage Account name for the crashes container
  • {crashes_container}: Container name for the crashes container
  • {microsoft_telemetry_key}: Application Insights key used for collecting non-attributable telemetry to improve OneFuzz.
  • {instance_telemetry_key}: Application Insights key used for private, instance-owned telemetry and logging (See OneFuzz Telemetry.
  • {extra_setup_dir}: Path to the optionally provided extra_setup directory
  • {extra_output_dir}: Path to the optionally provided extra_output directory

Example

Assume the following:

  • supervisor_options is: ``"a", "{target_options}", "d"`
  • target_options is: "b", "{target_exe}"
  • target_exe is: "c"

The resulting supervisor_options is: "a", "b c", "d".

If you need supervisor_options to expand to: "a", "b", "c", "d", you should use the following values:

  • supervisor_options: "a", "b", "{target_exe}", "d"
  • target_options: "b", "{target_exe}"
  • target_exe: "c"

Uses

These are currently used in the following tasks:

  • libfuzzer_fuzz: target_exe, target_options, input_corpus, crashes, setup_dir, machine_id
  • libfuzzer_crash_report: target_exe, target_options, input, setup_dir, machine_id
  • libfuzzer_merge: target_exe, target_options, input_corpus, setup_dir, machine_id
  • libfuzzer_coverage: None
  • generic_analysis: input, target_exe, target_options, analyzer_exe, analyzer_options, output_dir, tools_dir, job_id, task_id, crashes_account, crashes_container, reports_dir, microsoft_telemetry_key, instance_telemetry_key, setup_dir, machine_id
  • generic_generator: generated_inputs, input_corpus, tools_dir, generator_exe, generator_options, target_exe, target_options, input, job_id, task_id, microsoft_telemetry_key, instance_telemetry_key, setup_dir, machine_id
  • generic_supervisor: crashes, runtime_dir, target_exe, target_options, input_corpus, input, supervisor_exe, supervisor_options, tools_dir, job_id, task_id, crashes_account, crashes_container, reports_dir, microsoft_telemetry_key, instance_telemetry_key, setup_dir, coverage_dir, machine_id
  • generic_merge: input, input_corpus, output_dir, target_exe, target_options, supervisor_exe, supervisor_options, tools_dir, job_id, task_id, microsoft_telemetry_key, instance_telemetry_key, setup_dir, machine_id