Reference
Tool options
Every option each tool accepts, with types, defaults and allowed values.
Options are passed as settings when creating a profile or a job.
Any option you leave out takes its default.
The same list is available from the API, which is useful for building your own tooling:
curl -H "Authorization: Bearer $GUARDPKG_KEY" "$GUARDPKG_URL/api/v1/tools"
The tables below are generated from the same definitions the server validates against, so they're always current.
protect #
Lift x86-64 code to IR, transform it and recompile it.
| Option | Type | Default | Description |
|---|---|---|---|
protection | string, one of the values listed | virtualize | How to protect each function. Choose between the virtual machine, mutation, or recompilation, differing in terms of complexity and performance. Can also be set per function, in a profile's function rules.
|
virtualize_strength | string, one of the values listed | balanced | How hard the protection works. Presets over the protection type, light is faster and smaller, whilst heavy is slower but stronger. Can also be set per function, in a profile's function rules.
|
on_function_error | string, one of the values listed | keep_original | If a function can't be protected. Keep a function the engine cannot protect as its original code and report an error, or fail the whole job. Can also be set per function, in a profile's function rules.
|
function_timeout | integer, 0–86400 | 0 | Time limit per function (seconds). Wall-clock limit for each function at each stage. A function that runs over keeps its original code. 0 means no limit. |
target_isa | string, one of the values listed | sse42 | What the output may assume about the machine. The instruction set the protected code may use. Plain keeps the output running anywhere the input did; SSE4.2 allows popcnt.
|