Reference / Tool options

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:

bash
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.

OptionTypeDefaultDescription
protectionstring, one of the values listedvirtualizeHow 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: Virtualize
  • mutate: Mutate
  • none: Recompile
virtualize_strengthstring, one of the values listedbalancedHow 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.
  • light: Light
  • balanced: Balanced
  • heavy: Heavy
on_function_errorstring, one of the values listedkeep_originalIf 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.
  • keep_original: Keep the original code and report an error
  • fail_job: Fail the whole job
function_timeoutinteger, 0–864000Time 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_isastring, one of the values listedsse42What 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.
  • baseline: Plain x86-64 SSE2; the output runs anywhere the input did
  • sse42: Allow SSE4.2 (popcnt), which Windows 11 24H2 requires anyway